Skip to main content

​
REST-API-Workflow

Der typische REST-API-Workflow sieht wie folgt aus:
Diagramm des typischen FlexiCapture Cloud REST-API-Workflows, das die Schritte vom Hochladen von Dateien und Erstellen einer Aufgabe über das Abfragen des Status, das Abrufen von Ergebnissen zur Verifizierung, die optionale benutzerdefinierte Verifizierung und das Training bis hin zum Entfernen von Eingabe- und Ausgabedateien zeigt.
Jedes FlexiCapture-Projekt, das mit Ihrer REST API-Anwendung verwendet werden soll, muss einen korrekt konfigurierten Workflow enthalten. Die nachstehenden Anweisungen zeigen, wie Sie den Workflow des Beispielprojekts Banking Card Application für die Verwendung mit der REST API anpassen können. Weitere Informationen zu den Beispielprojekten finden Sie unter ABBYY FlexiCapture sample projects. Bevor Sie diese Anleitung durcharbeiten, starten Sie die Project Setup Station und öffnen Sie das Beispielprojekt Banking Card Application (der Standardspeicherort ist C:\Users\Public\ABBYY\FlexiCapture\12.0\Samples\FlexiCapture\English\Banking_eng\banking_eng.fcproj).

​
Workflow-Stufen anpassen

Die REST API übermittelt Daten zur Verarbeitung immer als Batch-Typ „Default“. Daher muss die gesamte Dokumentverarbeitung im Projekt für den Batch-Typ „Default“ konfiguriert werden.
1

Das Advanced-Workflow-Schema auswählen

Klicken Sie im Menü Project auf Projekteigenschaften und dann auf die Registerkarte Workflow. Wählen Sie in der Schema-Dropdown-Liste Advanced aus und ändern Sie die Workflow-Einstellungen wie unten gezeigt.
Screenshot der Registerkarte Workflow im Dialogfeld Projekteigenschaften der ABBYY FlexiCapture Project Setup Station mit ausgewähltem Advanced-Schema und den zugehörigen Workflow-Stufen.
2

Webstationen für die Verifizierung aktivieren

Klicken Sie auf Verifizierung → General und aktivieren Sie die Option Enable web stations.Hinweis: Sie können diese Einstellung auslassen, wenn Sie in Ihrem Projekt keine Verifizierungsstufe benötigen.
3

Die Eingangsbedingung für die Verifizierung festlegen

Klicken Sie auf Verifizierung → Entry Conditions und setzen Sie die Option Documents are admitted to stage auf Immer.
Je nach den Anforderungen Ihrer Lösung möchten Sie die Verifizierungsstufe möglicherweise vorübergehend oder bedingt deaktivieren, indem Sie auf der Registerkarte Entry Conditions eine skriptbasierte Regel verwenden.
Screenshot der Registerkarte Entry Conditions einer Verifizierungsstufe in der ABBYY FlexiCapture Project Setup Station, auf dem die Option Documents are admitted to stage auf Immer gesetzt ist.
4

Eine Stufe zum Exportieren des XML-Layouts hinzufügen

Um den endpoint training/layout/{taskId}/{fileId} für Ihr Projekt zu aktivieren, exportieren Sie die XML-Datei mit den Felddaten und dem Layout. Erstellen Sie direkt vor der Verifizierungsstufe eine Dokumentverarbeitungsstufe.
Screenshot der Workflow-Stufen in der ABBYY FlexiCapture Project Setup Station mit einer neuen Dokumentverarbeitungsstufe direkt vor der Verifizierungsstufe.
5

Die Eingangsbedingung der neuen Stufe festlegen

Wählen Sie auf der Registerkarte Entry Conditions Immer aus.
Screenshot der Registerkarte Entry Conditions der neuen Verarbeitungsstufe in der ABBYY FlexiCapture Project Setup Station, bei der die Eingangsbedingung auf Immer gesetzt ist.
6

Den Skripteditor öffnen

Klicken Sie auf der Registerkarte Script auf Edit script….
Screenshot der Registerkarte Script einer Verarbeitungsstufe in der ABBYY FlexiCapture Project Setup Station mit der Schaltfläche Edit script.
7

Die Skriptsprache festlegen

Ändern Sie die Skriptsprache zu C# .NET.
Screenshot des Skripteditors in der ABBYY FlexiCapture Project Setup Station, in dem C# .NET als Skriptsprache eingestellt ist.
8

Das Exportskript hinzufügen

Kopieren Sie den folgenden Codeausschnitt und fügen Sie ihn in den Skript-Bereich ein:
9

Ihre Änderungen speichern

Klicken Sie auf OK, um Ihre Änderungen zu speichern.
Die Projekteinstellungen für die Dokumentzusammenstellung (Image processing → Create document) werden beim Hochladen von Dateien über die REST API ignoriert. Für jede Datei wird ein separates Dokument erstellt.

​
Datenexporteinstellungen anpassen

Sobald ein über die REST API übermittelter Batch verarbeitet wurde, erfasst die REST API alle exportierten Dateien und stellt sie dem Client zum Herunterladen zur Verfügung.
ABBYY FlexiCapture Cloud speichert exportierte Dateien im Objektspeicher. Daher dürfen Sie in Ihrem REST API-Projekt keine absoluten Exportpfade verwenden.
REST API-Projekte erfordern keine spezielle Ordnerstruktur. Sie können eine flache Ordnerstruktur verwenden, indem Sie für jeden Batch den Namen des Stammordners und Dokument-IDs als Teil der Dateinamen verwenden. Die REST API-Services weisen jedem über die REST API übermittelten Batch einen eindeutigen zufälligen Batch-Namen zu, sodass beim Exportieren von Daten aus diesen Batches eindeutige Dateinamen erzeugt werden. Der folgende Screenshot zeigt die ursprünglichen Exporteinstellungen, die zu einer mehrstufigen Ordnerstruktur führen:
Screenshot der Exporteinstellungen in der ABBYY FlexiCapture Project Setup Station mit der ursprünglichen Dateibenennung, die eine mehrstufige Ordnerstruktur erzeugt.
Der folgende Screenshot zeigt die geänderten Exporteinstellungen, die zu einer flachen Ordnerstruktur führen:
Screenshot der Exporteinstellungen in der ABBYY FlexiCapture Project Setup Station mit der geänderten Dateibenennung, die eine flache Ordnerstruktur erzeugt.

​
Laden Sie Ihr geändertes Projekt in ABBYY FlexiCapture Cloud hoch

1

Öffnen Sie den Upload-Dialog

Klicken Sie auf Datei > Projekt auf Server hochladen…, um Ihr Projekt in ABBYY FlexiCapture Cloud hochzuladen.
2

Geben Sie Server und Mandant ein

Geben Sie im Dialogfeld die URL des Cloud-Servers ein, auf dem Ihr Mandant gehostet ist, und geben Sie den Namen Ihres Mandanten an.
3

Geben Sie Ihre Zugangsdaten ein

Wählen Sie Serverauthentifizierung verwenden aus und geben Sie die Zugangsdaten Ihres Mandantenadministrators ein.
4

Testen Sie die Verbindung

Klicken Sie auf Verbindung testen, um Ihre Verbindungseinstellungen zu prüfen.
5

Laden Sie das Projekt hoch

Klicken Sie auf OK und warten Sie, bis Ihr Projekt hochgeladen ist.

​
Ihre nächsten Schritte

Sobald Sie Ihr Projekt in ABBYY FlexiCapture Cloud hochgeladen haben, können Sie als Nächstes Folgendes ausprobieren: