Integration der Scanphase - ABBYY Documentation

Die in diesem Abschnitt bereitgestellten Anweisungen setzen voraus, dass die Windows-Authentifizierung verwendet wird. Alternativ können Sie die FlexiCapture- oder SAML-Authentifizierung verwenden. Um die GUI und die Funktionen der Scanning Station zu laden, verwenden Sie das Element <iframe>. Die folgenden Szenarien werden unterstützt:

Erstellen eines Batchs

Um einen neuen Batch mit bestimmten Registrierungsparametern zu erstellen und zu öffnen, setzen Sie den Wert des Attributs src auf:<stationUrl>/WinAuth/Manage/Create?projectId=[project ID]&batchTypeName=[batch type name]&batchName=[batch name]&regparam=[name:value], wobei

Name	Erforderlich	Beschreibung
<stationUrl>		Die Adresse der Scanning Station, auf die das Drittsystem zugreift. Der Standardwert ist <serverName>/FlexiCapture12/Scanning.
WinAuth		Windows-Authentifizierungsparameter.
Create		Der Name des Befehls, mit dem ein neuer Batch erstellt wird.
projectId		Die ID des Projekts, in dem der Batch erstellt werden soll.
batchTypeName		Der Batch-Typ, der erstellt werden soll.
batchName		Ein Name für den neuen Batch. Wenn kein Name angegeben ist, wählt das Programm einen Namen anhand der Einstellungen des ausgewählten Batch-Typs aus.
regparam		Ein Registrierungsparameter im Format „name:value“. Der Registrierungsparameter regparam muss in den Einstellungen des Batch-Typs batchTypeName auf der Webstation angegeben werden. Andernfalls wird dieser Parameter ignoriert. Hinweis: Sie können mehrere Registrierungsparameter übergeben, indem Sie sie mit dem Symbol „&“ verknüpfen.

Öffnen eines Batches

Um einen vorhandenen Batch mit bestimmten Registrierungsparametern zu öffnen, setzen Sie den Wert des Attributs src auf:<stationUrl>/WinAuth/Manage/Open?projectId=[project ID]&batchName=[new batch name]&regparam=[name:value], wobei


		Die Adresse der Scanning Station, auf die das Drittsystem zugreift. Der Standardwert ist <serverName>/FlexiCapture12/Scanning.
		Windows-Authentifizierungsparameter.
		Der Name des Befehls, mit dem ein vorhandener Batch geöffnet wird. Wichtig! Wenn es im Projekt mehr als einen Batch gibt, wird der alphabetisch erste Batch verwendet.
		Die ID des Projekts, das den zu öffnenden Batch enthält.
		Ein neuer Name für den Batch. Verwenden Sie diesen Parameter, wenn Sie den Batch umbenennen möchten.
		Ein Registrierungsparameter im Format „name:value“. Der Registrierungsparameter regparam muss in den Einstellungen des Batch-Typs batchTypeName auf der Webstation angegeben werden. Andernfalls wird dieser Parameter ignoriert. Hinweis: Sie können mehr als einen Registrierungsparameter übergeben, indem Sie mehrere Parameter mit dem Symbol „&“ verknüpfen.

Sie können nur einen Batch öffnen, der noch nicht auf den Server hochgeladen wurde.

Öffnen eines angeforderten Batchs und Erstellen eines neuen Batchs, wenn der angeforderte Batch nicht existiert

Um einen angeforderten Batch zu öffnen und einen neuen Batch zu erstellen, falls der angeforderte Batch nicht existiert, setzen Sie den Wert des Attributs src auf:<stationUrl>/WinAuth/Manage/OpenOrCreate?projectId=[Project ID]&batchTypeName=[batch type name]&batchName=[batch name]&regparam=[name:value], wobei


		Die Adresse der Scanning Station, auf die von einem Drittsystem zugegriffen werden soll. Der Standardwert ist <serverName>/FlexiCapture12/Scanning.
		Windows-Authentifizierungsparameter.
		Der Name des Befehls, der einen angeforderten Batch öffnet oder einen neuen Batch erstellt, falls der angeforderte Batch nicht existiert.
		Die ID des Projekts, das den zu öffnenden bzw. zu erstellenden Batch enthält.
		Der Batch-Typ des zu öffnenden bzw. zu erstellenden Batchs.
		Ein neuer Name für den Batch. Verwenden Sie diesen Parameter, wenn Sie einen vorhandenen Batch umbenennen oder einem neuen Batch einen Namen zuweisen möchten. Wenn dieser Parameter beim Erstellen eines neuen Batchs nicht verwendet wird, wählt das Programm einen Namen anhand der Einstellungen des ausgewählten Batch-Typs aus.
		Ein Registrierungsparameter im Format „name:value“. Der Registrierungsparameter regparam muss in den Einstellungen des Batch-Typs batchTypeName in der Webstation angegeben werden. Andernfalls wird dieser Parameter ignoriert. Hinweis: Sie können mehrere Registrierungsparameter übergeben, indem Sie sie mit dem Symbol „&“ verknüpfen.

Sie können nur einen Batch öffnen, der noch nicht auf den Server hochgeladen wurde.

Abrufen einer Aufgabe zum erneuten Scannen

Um eine Aufgabe zum erneuten Scannen abzurufen, setzen Sie den Wert des src-Attributs auf:<stationUrl>/WinAuth/Manage/GetRescan?projectId=[project ID]&batchName=[new batch name]&regparam=[name:value], wobei

Name	Erforderlich	Beschreibung
<stationUrl>		Die Adresse der Scanning Station, auf die das Drittanbietersystem zugreift. Der Standardwert ist <serverName>/FlexiCapture12/Scanning.
WinAuth		Windows-Authentifizierungsparameter.
GetRescan		Der Name des Befehls, mit dem eine vorhandene Aufgabe zum erneuten Scannen abgerufen wird. Wichtig! Wenn es im Projekt mehr als eine Aufgabe gibt, wird die alphabetisch erste Aufgabe verwendet.
projectId		Die ID des Projekts, das den Batch enthält, der erneut gescannt werden soll.
batchName		Ein neuer Name für den Batch. Verwenden Sie diesen Parameter, wenn Sie den erneut zu scannenden Batch umbenennen möchten.
regparam		Ein Registrierungsparameter im Format „name:value“. Der Registrierungsparameter regparam muss in den Einstellungen des Batch-Typs batchTypeName auf der Webstation angegeben werden. Andernfalls wird dieser Parameter ignoriert. Hinweis: Sie können mehrere Registrierungsparameter übergeben, indem Sie sie mit dem Symbol „&“ verknüpfen.

Wenn der Benutzer die Arbeit mit dem Batch abgeschlossen hat und die integrierte Scanning Station verlässt, wird die Methode postMessage verwendet, um die Nachricht FC_Scanning_TaskClosed an das übergeordnete Element zu übergeben. Die Abschlussseite wird geöffnet. Der Developer muss den Benutzer von der Abschlussseite zurück zum Drittanbietersystem leiten.

Verwenden Sie URL-Kodierung, wenn Sie nicht englische Zeichen (z. B. japanische) als Parameterwerte in der URL übergeben müssen.