Skip to main content

xSuite Interface Windows Prism 5.x – Online-Hilfe

Connector für IRISPowerscan™ / xSuite Capture

Für die Einbindung in die Scan-Anwendung IRISPowerscan™ alias xSuite Capture Prism (nachfolgend "Powerscan" genannt) wird ein Connector mit ausgeliefert. Dieser Connector kommuniziert mit der REST-Webservice-Eingabeschnittstelle von xSuite Interface, d.h. mit dem Eingabesystem "WebServiceInput".

Technisch ist dies ein Connector für das Ausgabeziel "IRISConnect". Zur Nutzung in einem Powerscan-Projekt muss daher zunächst "IRISConnect" als primäres Ziel ausgewählt. In dem anschließenden Auswahldialog muss der Connector "xSuiteCapture" ausgewählt werden.

Mit einer Versionsänderung von Powerscan und damit ggf. auch vom enthaltenen IRISConnect ist unter Umständen auch ein Update des Connectors erforderlich, wenn sich dabei die technische Schnittstelle zu IRISConnect geändert hat. Derzeit wird der Connector in einer Version ausgeliefert, die kompatibel zum IRISConnect 2.14.3 ist, welcher in Powerscan 11.1 enthalten ist.

Die folgenden 2 Schritte müssen zur Installation manuell durchgeführt werden:

  1. Kopieren aller Connector-Dateien IRISConnect.xSuiteInterface.* und benötigter Zusatzbibliotheken .dll inklusive des Unterverzeichnisses de-DE aus dem Installationsverzeichnis von xSuite Interface (Unterordner Connectors\IRISConnect) in das Programmverzeichnis der Powerscan-Installation (Unterordner IRISConnect)

  2. Registrierung des Connectors in IRISConnect über den Kommandozeilenaufruf {Powerscan-Programmverzeichnis}\IRISConnect\IRISConnect.exe /target:IRISConnect.xSuiteInterface.dll /register

Der innerhalb des Powerscan-Projektdesigners aufrufbare Setup-Dialog des Connectors erlaubt das Setzen folgender Konfigurationsparameter:

Parameter

Beschreibung

Web Service Base URL*

Basisadresse des Ziel-Webservices, d.h. der Webservice-Eingabeschnittstelle von xSuite Interface

Diese setzt sich zusammen aus den Eigenschaften Webservice.Url[] und ggf. WebService.UrlBasePath in der globalen xSuite-Interface-Konfiguration.

Tenant*

Scenario*

Name des Mandanten und des Zielszenarios in xSuite Interface

Der Name des Mandanten ist "Default", wenn keine dedizierten Mandanten konfiguriert sind. Beide Parameter können dynamisch aus Werten der Powerscan-Indexierungsfelder generiert werden, und zwar in der Syntax %{Feldname}%.

Windows Authentication

Schalter, ob eine Authentifizierung gegenüber xSuite Interface mit dem Windows-Konto des Powerscan-Benutzer erfolgen soll

Dieses erfordert die gesetzte Eigenschaft WebService.AuthMode: "Windows" in der globalen xSuite-Interface-Konfiguration.

Timeout [s]

maximale Wartezeit in Sekunden, die auf eine Antwort des Webservices gewartet wird, bevor ein clientseitiger Timeout-Fehler ausgelöst wird

LogFile Folder

optionale Pfadangabe eines lokalen Zielordners, wenn eine clientseitige Logdatei über die Verarbeitungsschritte geschrieben wird

Der Name der Logdatei ist mit IRISConnect.xSuiteInterface.log fest vorgegeben.

Debug Logging

Schalter, ob in obige Logdatei zusätzliche Debug-Informationen für Fehleranalysen mit ausgegeben werden

Upload Files Separately

Schalter, ob bei der Übertragung eines Powerscan-Stapels die Scan-Dateien in separaten Aufrufen an den Webservice übermittelt werden

Die Datenübergabe von Powerscan an den Connector erfolgt grundsätzlich pro Dokument, während die Verarbeitungslogik von xSuite Interface die Übergabe eines kompletten Stapels vorsieht. Der Connector sammelt deshalb zunächst alle Dokumente lokal und sendet sie erst nach Erhalt des letzten Dokumentes als gemeinsamen Stapel an den Webservice.

Je nach Umfang des Stapels, also Anzahl der Dokumente und Anzahl/Größe der in ihnen enthaltenen Scan-Dateien, muss dabei in einem einzigen Aufruf ein großes Datenvolumen übertragen werden. Um mögliche Probleme mit den verfügbaren Speicherressourcen des Clients zu umgehen, können die Daten somit sukzessive gesendet werden.

Die Scan-Dateien werden dabei direkt nach der Übergabe von Powerscan an den Connector an xSuite Interface weitergeleitet, sodass die Zwischenspeicherung dieser Daten serverseitig anstatt auf dem Client erfolgt.

Wenn ein Übertragungsfehler auftritt und die finale Übergabe eines Stapels an den Webservice wiederholt werden muss, sind die einzelnen Dokumente in Powerscan schon gelöscht, wenn dort das automatische Löschen nach der Übergabe aktiviert ist. Denn wegen der dokumentweisen Übergabe an den Connector ist diese aus Sicht von Powerscan erfolgreich gewesen. Zwar prüft der Connector vor Entgegennahme des ersten Dokumentes vorsorglich noch einmal die Verbindung zum Webservice, aber dennoch wird empfohlen, die automatische Löschung in Powerscan zu deaktivieren, um die mögliche Notwendigkeit zum erneuten Einscannen derselben Dokumente zu umgehen.

Powerscan übergibt auch typisierte Feldwerte (Zahlen-, Datumsfelder etc.) immer als Textwerte an den Connector, welcher sie unverändert in dieser Form an den Webservice weiterleitet. Sind die Zielfelder im xSuite-Interface-Szenario dann allerdings typisiert, muss eine Rekonvertierung erfolgen, also ein Parsen der Textwerte in den Zieldatentyp. Bei Verwendung gängiger Syntaxvarianten für Zahlen und insbesondere Datumswerte funktioniert das in der Regel implizit. Ansonsten muss im Indexdatenleser explizit ein passendes .InputFormat definiert werden.