Zum Hauptinhalt springen

​
REST API-Workflow

Der typische REST API-Workflow sieht wie folgt aus: Jedes FlexiCapture-Projekt, das mit Ihrer REST API-Anwendung verwendet werden soll, muss einen korrekt konfigurierten Workflow enthalten. Im Folgenden finden Sie eine Schritt-für-Schritt-Anleitung, 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 im Abschnitt ABBYY FlexiCapture sample projects). Bevor Sie diese Anleitung durcharbeiten, starten Sie bitte 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 zu verarbeitende Daten immer als Batch-Typ “Default”. Daher muss die gesamte Dokumentenverarbeitung im Projekt für den Batch-Typ “Default” konfiguriert werden.
  1. Klicken Sie im Menü Project auf Project Properties 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:
  1. Klicken Sie auf Verification → General und aktivieren Sie die Option Enable web stations. Hinweis: Sie können diese Einstellung weglassen, wenn Sie in Ihrem Projekt keine Verifizierungsstufe benötigen.
  2. Klicken Sie auf Verification → Entry Conditions und setzen Sie die Option Documents are admitted to stage auf Always.
Je nach Anforderungen Ihrer Lösung können Sie die Verifizierungsstufe auf der Registerkarte Entry Conditions vorübergehend oder bedingt mithilfe einer skriptbasierten Regel deaktivieren.
  1. Um den Endpunkt training/layout/{taskId}/{fileId} für Ihr Projekt zu aktivieren, müssen Sie die XML-Datei exportieren, die die Felddaten und das Layout enthält. Gehen Sie dazu wie folgt vor:
    1. Erstellen Sie eine Dokumentenverarbeitungsstufe direkt vor der Verifizierungsstufe:
  1. Wählen Sie auf der Registerkarte Entry Conditions die Option Always aus.
  1. Klicken Sie auf der Registerkarte Script auf die Schaltfläche Edit script…. : 4. Ändern Sie die Skriptsprache in C# .NET:
  1. Kopieren Sie den folgenden Codeausschnitt und fügen Sie ihn in den Skriptbereich ein:
using System;
Document.SaveXmlToFileStorage();
  1. Klicken Sie auf OK, um Ihre Änderungen zu speichern.
Die Projekteinstellungen zur Dokumentzusammenstellung (Bildverarbeitung → Dokument erstellen) 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. Auf diese Weise werden beim Exportieren von Daten aus über die REST API übermittelten Batches eindeutige Dateinamen erzeugt. Der folgende Screenshot zeigt die ursprünglichen Exporteinstellungen, die zu einer mehrstufigen Ordnerstruktur führen: Der folgende Screenshot zeigt die geänderten Exporteinstellungen, die zu einer flachen Ordnerstruktur führen:

​
Hochladen Ihres geänderten Projekts in ABBYY FlexiCapture Cloud

  1. Klicken Sie auf Datei > Projekt auf Server hochladen…, um Ihr Projekt in ABBYY FlexiCapture Cloud hochzuladen.
  2. Geben Sie im Dialogfeld die URL des Cloud-Servers ein, auf dem Ihr Tenant gehostet ist, und den Namen Ihres Tenants.
  3. Wählen Sie Serverauthentifizierung verwenden aus und geben Sie die Administrator-Anmeldedaten Ihres Tenants ein.
  4. Klicken Sie auf Verbindung testen, um Ihre Verbindungseinstellungen zu überprüfen.
  5. Klicken Sie auf OK und warten Sie, bis Ihr Projekt hochgeladen wurde.

​
Ihre nächsten Schritte

Sobald Sie Ihr Projekt in ABBYY FlexiCapture Cloud hochgeladen haben, können Sie als Nächstes Folgendes ausprobieren:
  1. Erstellen Sie eine Anwendung, die mit Ihrem Projekt verbunden ist. Weitere Informationen dazu finden Sie unter Erstellen von Anwendungen mithilfe der FlexiCapture REST API-Schnittstelle.
  2. Um zu prüfen, ob Ihre Anwendung korrekt verbunden ist, verarbeiten Sie einen Beispiel-Batch.
  3. Sollten Probleme auftreten, lesen Sie bitte Fehlerdiagnose bei der Verarbeitung.