2.2 - Anlage 2 zur LB - Handbuch Kofax-Konnektor.pdf

[Seite 1]

DOMEA DMS

Handbuch Materna-Kofax-Konnektor

Informationen zum vorliegenden Dokument

Projekt: DOMEA Team/Teilprojekt: DMS Thema: Handbuch Dokumenttitel: Materna-Kofax-Konnektor Dokumentnummer: 28277 Version: 1.0 Status: Geprüft Anzahl Seiten: 13 Standort: \BZR.INTERN\bfjpriv\private\UCARK\APdata\Desktop\Kofax nach BMJV\2.2 - Anlage 2 zur LB - Handbuch Kofax-Konnektor.doc Erstellt am: 20.05.2015 Erstellt von: Andreas Roglin Zuletzt bearbeitet am: 21.05.2015 Zuletzt bearbeitet von: Andreas Roglin Vorgelegt am: 29.06.2015

Geprüft am: 29.06.2015 Freigegeben am: Geprüft von: Klaus Martin Freigegeben von:

(Unterschrift) (Unterschrift)

Dieses Dokument basiert auf der Dokumentvorlage docuM2002 (Version 2.5).

Dok.-Nr. 28277 - Version 1.0 vom 29.06.2015 - Status: Geprüft MATERNA Informationen zum vorliegenden Dokument Information & Communications

[Seite 2]

DOMEA DMS

Handbuch Materna-Kofax-Konnektor

Inhaltsverzeichnis

1 Allgemeines ......................................................................................................... 1

2 Installation ........................................................................................................... 2 2.1 Installation Server ................................................................................................ 2 2.1.1 Vorraussetzungen ............................................................................................... 2 2.1.2 Installation unter Windows ................................................................................... 2 2.1.3 Test der Installation ............................................................................................. 2 2.2 Installation auf dem Kofax-Übergaberechner ....................................................... 4

3 Konfiguration ....................................................................................................... 6 3.1 Konfiguration auf dem Kofax-Übergaberechner ................................................... 6

Dok.-Nr. 28277 - Version 1.0 vom 29.06.2015 - Status: Geprüft MATERNA Inhaltsverzeichnis Information & Communications Seite i

[Seite 3]

DOMEA DMS

Handbuch Materna-Kofax-Konnektor

1 Allgemeines

Der Materna-Kofax-Konnektor ermöglicht es, mit Kofax Capture 10 gescannte Dokumente in DOMEA® abzulegen. Dabei kann ein Tiff-Dokument oder ein PDF- Dokument in DOMEA® angelegt werden. Die zugehörigen Metadaten und eine OCR-Repräsentanz können wahlweise pro Dokument in einer festzulegenden Default-PI oder in der Eingangsstelle oder DMS abgelegt werden. Dieses Handbuch beschreibt die durchzuführenden Schritte, um den Kofax- Konnektor zu installieren und zu konfigurieren.

Dok.-Nr. 28277 - Version 1.0 vom 29.06.2015 - Status: Geprüft MATERNA 1 Allgemeines Information & Communications Seite 1

[Seite 4]

DOMEA DMS

Handbuch Materna-Kofax-Konnektor

2 Installation

2.1 Installation Server

2.1.1 Voraussetzungen Die DOMEA® Komponente der Schnittstelle, der MatDomeaWebService, wird als eigenständige Komponente auf einem beliebigen Rechner installiert, der mit dem DOMEA® Zielserver kommunizieren kann. Voraussetzung ist die Installation folgender Komponenten:

• Java 2 Standard Edition Runtime Environment (JRE) 6.0 oder höher

• Web-Server Apache Tomcat 7.0.x

• DOMEA® Client 4.6 SP4

2.1.2 Installation unter Windows Die Auslieferung des MatDomeaWebService erfolgt als komprimiertes Webarchiv. Zur Installation ist die Datei MatDomeaWebService.war in das „webapps“-Verzeichnis des Tomcat abzulegen. Bei einem Start des Tomcats wird das Archiv automatisiert entpackt.

2.1.3 Test der Installation Die erfolgreiche Installation kann in einem Browser über den Aufruf der folgenden Adresse überprüft werden: http://:/MatDomeaWebService/services/MatDomeaWeb Service?wsdl

(Host und Port sind abhängig von der Konfiguration der Installation) Als Ergebnis sollte die Definition des installierten Webservices erscheinen:

Dok.-Nr. 28277 - Version 1.0 vom 29.06.2015 - Status: Geprüft MATERNA 2 Installation Information & Communications Seite 2

[Seite 5]

DOMEA DMS

Handbuch Materna-Kofax-Konnektor

Dok.-Nr. 28277 - Version 1.0 vom 29.06.2015 - Status: Geprüft MATERNA 2 Installation Information & Communications Seite 3

[Seite 6]

DOMEA DMS

Handbuch Materna-Kofax-Konnektor

2.2 Installation auf dem Kofax-Übergaberechner Der Konnektor-Client muss auf dem Rechner installiert werden, auf dem das Kofax-Übergabe-Modul läuft. Zur Installation sind folgende Schritte nötig:

1. Kopieren der Datei MatDomeaWebServiceClient.dll in das \bin- Verzeichnis der Kofax-Installation. Das Verzeichnis könnte im Falle einer Standalone-Installation von Kofax 10 beispielsweise folgendermaßen lauten: C:\Programme\Kofax\Capture\Bin

Im Falle einer verteilten Installation von Kofax 10 könnte das entsprechende Verzeichnis wie folgt sein: C:\Programme\Kofax\CaptureSS\ServLib\Bin

2. Kopieren der beiden Dateien KofaxKonnektorDomea.dll und KofaxKonnektorDomea.inf in ein Verzeichnis nach Wahl

3. Anpassen der Pfade SetupModule und ReleaseModule auf den exakten Pfad der KofaxKonnektorDOMEA.DLL in der Datei KofaxKonnektorDomea.inf.

4. Starten des Verwaltungs-Werkzeugs von Kofax-Capture 10.

5. Hier muss aus den Menüs „Extras -> Export-scripte“ der Punkt „Export Connectors“ aufgerufen werden:

6. In dem nun erscheinenden Fenster muss die Schaltfläche „Hinzufügen“ angeklickt und anschließend zu dem in Schritt 2 festgelegten Pfad navigiert werden. Dann muss die Datei KofaxKonnektorDomea.inf ausgewählt und installiert werden:

Dok.-Nr. 28277 - Version 1.0 vom 29.06.2015 - Status: Geprüft MATERNA 2 Installation Information & Communications Seite 4

[Seite 7]

DOMEA DMS

Handbuch Materna-Kofax-Konnektor

7. Die Installation des Clients ist damit abgeschlossen. Die Übergabe muss dann noch konfiguriert werden, dies wird in Kapitel 3.1 beschrieben.

Dok.-Nr. 28277 - Version 1.0 vom 29.06.2015 - Status: Geprüft MATERNA 2 Installation Information & Communications Seite 5

[Seite 8]

DOMEA DMS

Handbuch Materna-Kofax-Konnektor

3 Konfiguration

3.1 Konfiguration auf dem Kofax-Übergaberechner Nach der Installation muss der Client für jede Dokumentenklasse konfiguriert werden. Dies geschieht in mehreren Abschnitten. Zuerst müssen die an DOMEA zu übergebenden Metadaten in Kofax angelegt und dann die Übergabe eingerichtet werden.

1. Anlegen der Metadaten a. Mit der rechten Maustaste auf die Dokumentklasse klicken und „Eigenschaften“ auswählen. In dem erscheinenden Fenster kann über die Schaltfläche „Neues Indexfeld“ ein neues Metadatum angelegt werden. b. Hierbei ist zu beachten, dass der „Name“ des Metadatums exakt dem Namen entspricht, der hierfür in DOMEA vergeben ist. Der verwendete Name kann im Konfigurationsclient von DOMEA unter dem Punkt „Metadaten“ ermittelt werden. Der „Anzeigename“ ist frei wählbar, dieser wird in der Validierung angezeigt. Der „Feldtyp“ kann selbst definiert werden, denkbar wären beispielsweise Feldtypen, die nur Zahlen zulassen, etc. Der Wert „Standard“ kann dafür genutzt werden, ein Metadatum mit einer Eigenschaft der Dokumentenklasse wie beispielsweise dem Stapelnamen oder dem Benutzernamen der Scan-Person zu belegen. Eine detaillierte Beschreibung zur Konfiguration von Dokumentklassen findet sich in der zugehörigen Kofax Capture Dokumentation.
2. Einrichten der Übergabe a. Mit der rechten Maustaste auf die Dokumentklasse klicken und „Exportskripte…“ auswählen:

Dok.-Nr. 28277 - Version 1.0 vom 29.06.2015 - Status: Geprüft MATERNA 3 Konfiguration Information & Communications Seite 6

[Seite 9]

DOMEA DMS

Handbuch Materna-Kofax-Konnektor

b. In dem erscheinenden Fenster das Skript „KofaxKonnektorDomea“ auswählen und auf Hinzufügen klicken. Wurde das Skript schon einmal eingerichtet, muss das Skript nicht neu hinzugefügt werden, es reicht die Schaltfläche „Einrichten“ anzuklicken, um Änderungen an der Konfiguration vorzunehmen.

Dok.-Nr. 28277 - Version 1.0 vom 29.06.2015 - Status: Geprüft MATERNA 3 Konfiguration Information & Communications Seite 7

[Seite 10]

DOMEA DMS

Handbuch Materna-Kofax-Konnektor

c. Es öffnet sich jetzt die Konfigurationsmaske des Übergabeskripts:

Dok.-Nr. 28277 - Version 1.0 vom 29.06.2015 - Status: Geprüft MATERNA 3 Konfiguration Information & Communications Seite 8

[Seite 11]

DOMEA DMS

Handbuch Materna-Kofax-Konnektor

d. Folgende Einstellungen sind vorzunehmen: i. Domea-Server: Hier muss der Name des DOMEA-Servers angegeben werden. ii. Port: Hier muss der Port, unter dem der DOMEA-Server erreichbar ist, eingetragen werden. iii. Benutzername: Hier muss der DOMEA-Benutzername eingetragen werden. Dokumente, die der Kofax-Konnektor in DOMEA anlegt, tragen diesen Namen als Ersteller.

Dok.-Nr. 28277 - Version 1.0 vom 29.06.2015 - Status: Geprüft MATERNA 3 Konfiguration Information & Communications Seite 9

[Seite 12]

DOMEA DMS

Handbuch Materna-Kofax-Konnektor

iv. Passwort: Hier muss das zum Benutzer zugehörige Passwort eingetragen werden. v. URL: Hier muss die URL des WebService eingetragen werden (siehe Kapitel 2.1.3). vi. Im Bereich Übergabe ist festzulegen, ob zu den gescannten Bilddateien auch deren OCR-Repräsentanzen übergeben werden sollen. Wichtig: Für den Fall, dass OCR-Repräsentanzen übergeben werden sollen, muss zwingend in der Kofax- Verwaltung das Modul „OCR-Volltext“ zu den ausgewählten Warteschlangen der Stapelklasse hinzugefügt werden. vii. Die Ziel-PI muss festgelegt werden, indem eine Suche nach PIs durchgeführt wird und der entsprechende Eintrag ausgewählt wird. Tipp: Dies ist auch eine Möglichkeit, um die oben eingegebenen Verbindungsdaten auf Korrektheit zu überprüfen. viii. Im Bereich „Vorlagen“ müssen die in DOMEA angelegten Vorlagen für die Dateitypen ausgewählt werden. Hierzu wird über die Schaltfläche „Aktualisieren“ eine Liste an Vorlagen geladen, die auf dem DOMEA-Server existieren. Es müssen die Vorlagen für die TIFF-Dokumente bzw. PDF-Dokumente und die OCR-Dateien auswählt werden. ix. Es muss der Dokumenttyp des Hauptdokuments (TIFF oder PDF) gewählt werden. x. Weiterhin muss ein Verzeichnis für temporäre Dateien festgelegt werden.

e. In der Registerkarte „Metadaten“ können die verfügbaren Metadaten zur Liste der ausgewählten Metadaten hinzugefügt oder von dieser entfernt werden. Nur ausgewählte Metadaten werden an DOMEA übergeben. Es kann pro Dokumentklasse festgelegt werden, welche Metadaten an DOMEA® übergeben werden. Es werden Custom-Dokumentattribute wie z.B. CS1-CS5, CD1- CD5, CC1-CC5 unterstützt. Die Liste der zusätzlich unterstützten „DOMEA-Attribute“ lautet:

Dok.-Nr. 28277 - Version 1.0 vom 29.06.2015 - Status: Geprüft MATERNA 3 Konfiguration Information & Communications Seite 10

[Seite 13]

DOMEA DMS

Handbuch Materna-Kofax-Konnektor

f. Anschließend muss die Konfiguration gespeichert werden, indem die Schaltfläche „Speichern“ betätigt wird. Die erfolgreiche Speicherung wird mit einer Meldung bestätigt und der Einstellungsdialog wird geschlossen.

3. Veröffentlichen Nach Abschluss der Konfiguration muss nun noch die Stapelklasse veröffentlicht werden, damit sie an den Scanstationen genutzt werden kann. Hierzu muss per Rechtsklick das Kontextmenü an der Stapelklasse aufgerufen und der Eintrag „Veröffentlichen“ ausgewählt werden:

Dok.-Nr. 28277 - Version 1.0 vom 29.06.2015 - Status: Geprüft MATERNA 3 Konfiguration Information & Communications Seite 11

[Seite 14]

DOMEA DMS

Handbuch Materna-Kofax-Konnektor

In dem erscheinenden Dialog kann nun die richtige Stapelklasse ausgewählt werden und per Klick auf die Schaltfläche „Veröffentlichen“ veröffentlicht werden:

Dok.-Nr. 28277 - Version 1.0 vom 29.06.2015 - Status: Geprüft MATERNA 3 Konfiguration Information & Communications Seite 12

[Seite 15]

DOMEA DMS

Handbuch Materna-Kofax-Konnektor

Überprüfung der Funktionen Wenn ein Dokument nicht erfolgreich an DOMEA übergeben werden konnte, landet der Stapel, der dieses Dokument beinhaltet, im Kofax-Modul „Qualitätskontrolle“. Der Stapel beinhaltet dann nur noch Dokumente, die nicht erfolgreich übergeben werden konnten. Die bereits korrekt übergebenen Dokumente tauchen hier nicht mehr auf. Aufgetretene Fehler werden in einer Log-Datei protokolliert, diese findet sich im Verzeichnis: C:\Dokumente und Einstellungen\All Users\Anwendungsdaten\Kofax\Capture\Logs

Dok.-Nr. 28277 - Version 1.0 vom 29.06.2015 - Status: Geprüft MATERNA 3 Konfiguration Information & Communications Seite 13