ABBYY FlexiCapture Connect - ABBYY Documentation

ABBYY FlexiCapture Connect wird als Windows-Service ausgeführt und ermöglicht es Nutzern, Dokumente in ABBYY FlexiCapture Cloud-Projekte zu importieren, Dokumente aus ABBYY FlexiCapture Cloud-Projekten zu exportieren und Datensätze zu synchronisieren.

Diagramm, das zeigt, wie ABBYY FlexiCapture Connect auf einem Windows-Server ausgeführt wird und über eine Firewall über Port 443 mit ABBYY FlexiCapture Cloud verbunden ist.

Systemanforderungen

Anforderung	Details
Betriebssystem	Windows 10, Windows 11 oder Windows Server 2012, 2012 R2, 2016, 2019, 2022 oder 2025 (jeweils mit Desktop Experience).
RAM	Für einen Datensatz mit ungefähr 500.000 Vendors werden mindestens 2,5 GB empfohlen.
Softwarekompatibilität	ABBYY FlexiCapture Application Server Release 3 oder höher; .NET Framework 4.6.1 oder höher.

ABBYY FlexiCapture Connect installieren und konfigurieren

Verwenden Sie Ihr Servicekonto, um ABBYY FlexiCapture Connect zu installieren und zu konfigurieren.

Laden Sie das Installationsprogramm herunter und führen Sie es aus

Wenn ABBYY FlexiCapture Connect bereits installiert ist und Sie eine vorhandene Version aktualisieren, erstellen Sie zunächst eine Backup-Kopie der Datei config.json, die sich unter C:\Program Files (x86)\ABBYY FlexiCapture Connect\config.json befindet.Laden Sie die Datei FlexiCapture_Connect_Installer_*.msi von https://www.abbyy.com/flexicapture-downloads/cloud/ herunter und führen Sie sie aus.

Ändern Sie die Konfigurationsdatei

Passen Sie die Datei config.json an Ihre Anforderungen an. Weitere Informationen finden Sie unter Referenz zur Konfigurationsdatei.

Testen Sie die neue Konfiguration

Pausieren Sie den ABBYY FlexiCapture Connect Service.
Führen Sie die Datei ABBYY.FlexiCapture.Connect.exe aus. Ein Konsolenfenster mit einem detaillierten Protokoll wird angezeigt.

Starten Sie den Service neu

Starten Sie ABBYY FlexiCapture Connect neu.

Referenz zur Konfigurationsdatei

Diese Beispieldatei config.json importiert Dokumente in ein Projekt, exportiert die Verarbeitungsergebnisse und synchronisiert einen Datensatz.

{
  "url": "https://europe.flexicapture.com/",
  "tenant": "testtenant",
  "user": "user1",
  "password": "password1",
  "projects": [
    {
      "name": "project1",
      "import": {
        "directory": "C:\\HotFolder\\Import",
        "fileMask": "*",
        "settings": {
          "region": "US",
          "verification_type": "NoVerification",
          "export_format": "Xml"
        },
        "createDocument": "ForEachFile",
        "period": "00:01:00",
        "schedule": [ "12:00:00", "06:00:00" ]
      },
      "export": {
        "directory": "C:\\HotFolder\\Export",
        "period": "00:01:00",
        "schedule": [ "12:00:00" ]
      },
      "templates": [
        {
          "name": "template",
          "datasets": [
            {
              "name": "DataSet",
              "file": "C:\\HotFolder\\DataSets\\DataSet.csv",
              "period": "00:01:00",
              "schedule": [ "12:00:00" ]
            }
          ]
        }
      ]
    }
  ]
}

Allgemeine Einstellungen

Die Eigenschaften der obersten Ebene identifizieren den Mandanten und das Servicekonto.

Eigenschaft	Beschreibung
`url`	Die URL des Mandanten (zum Beispiel `https://europe.flexicapture.com`).
`tenant`	Der Name des Mandanten.
`user`	Der Benutzername des Servicekontos.
`password`	Das Kennwort des Servicekontos.
`projects`	Enthält Einstellungen für einzelne Projekte, z. B. für den Dokumentimport und -export sowie für die Datensatzsynchronisierung.

Um Dokumente zu importieren und zu exportieren, richten Sie das Mandantenkonto als External User ein. Für die Synchronisierung von Datensätzen benötigt das Mandantenkonto entweder die Rolle Administrator oder sowohl Project Settings Editor als auch External User. Standardmäßig hat das Mandantenkonto Zugriff auf alle Projekte. Um dies zu ändern, passen Sie die Zugriffsrechte für bestimmte Benutzerrollen an. Weitere Informationen finden Sie unter Benutzerrollen und Zugriffsrechte einrichten.

Projekteinstellungen

Jedes Objekt im Array projects definiert ein Projekt.

Eigenschaft	Beschreibung
`name`	Projektname.
`import`	Einstellungen für den Dokumentimport.
`export`	Einstellungen für den Dokumentexport.
`templates`	Einstellungen für die Synchronisierung von Datensätzen.

Importeinstellungen

Das import-Objekt eines Projekts legt fest, wie und wann Dokumente importiert werden.

Eigenschaft	Beschreibung
`directory`	Der Pfad zum Ordner, aus dem Dokumente importiert werden.
`fileMask`	Ein Datei- und Ordnerfilter. Die Platzhalter `*` und `?` werden unterstützt.
`settings`	Registrierungsparameter auf Batch-Ebene.
`createDocument`	Mögliche Werte sind `ForEachFile` (erstellt für jede importierte Datei ein eigenes Dokument) oder `Automatically` (verwendet die Projektparameter). Um `Automatically` zu verwenden, aktivieren Sie zunächst im ABBYY FlexiCapture-Projekt die Option Automatically when Document Definition is applied.
`period`	Gibt an, wie oft die Aufgabe gestartet wird. Beispielsweise startet `"period": "00:02:30"` die Aufgabe alle zweieinhalb Minuten. `period` und `schedule` lassen sich unabhängig voneinander festlegen.
`schedule`	Die Zeitpunkte, zu denen die Aufgabe gestartet wird. Beispielsweise startet `"schedule": [ "09:00:00", "19:00:00" ]` die Aufgabe täglich um 9:00 und um 19:00 Uhr.

Bei jedem Dateiimport wird ein neuer Batch erstellt. Der Batchname enthält das aktuelle Datum und die aktuelle Uhrzeit.

Exporteinstellungen

Das Objekt export eines Projekts legt fest, wohin und wann Verarbeitungsergebnisse exportiert werden.

Eigenschaft	Beschreibung
`directory`	Der Pfad zum Ordner, in dem exportierte Dateien gespeichert werden.
`period`	Wie oft die Exportaufgabe gestartet wird, im selben Format wie beim Import. Sie können `period` und `schedule` unabhängig voneinander festlegen.
`schedule`	Die Zeitpunkte, zu denen die Exportaufgabe gestartet wird, im selben Format wie beim Import.

Wenn Dokumente exportiert werden, wird für jeden Batch im Projekt, der sich derzeit in der Stufe Processed befindet, ein Ordner erstellt. Diese Zielordner tragen dieselben Namen wie die jeweiligen Batches und enthalten alle Verarbeitungsergebnisse. Wenn ein Zielordner gelöscht wird, erstellt das Programm einen neuen Ordner mit demselben Namen und legt die Verarbeitungsergebnisse dort ab.

Einstellungen der Dokumentdefinition

Jedes Objekt im Array templates identifiziert eine Dokumentdefinition und die zugehörigen Datensätze.

Eigenschaft	Beschreibung
`name`	Der Name der Dokumentdefinition, auf die sich der jeweilige Abschnitt bezieht.
`datasets`	Die Parameter für die Datensatzsynchronisierung der Dokumentdefinition.

Einstellungen für die Datensatzsynchronisierung

Jedes Objekt im Array datasets definiert einen zu synchronisierenden Datensatz.

Eigenschaft	Beschreibung
`name`	Der Name des Datensatzes.
`file`	Der Pfad zur CSV-Datei, die die aus dem ERP-System exportierten Stammdaten enthält. Die erste Zeile der CSV-Datei muss die durch Kommas getrennten Namen der Datensatzfelder enthalten. Alle Werte, die Kommas enthalten, müssen in doppelte Anführungszeichen gesetzt werden.
`period`	Wie oft die Synchronisierungsaufgabe gestartet wird, im gleichen Format wie beim Import. Sie können `period` und `schedule` unabhängig voneinander festlegen.
`schedule`	Die Zeitpunkte, zu denen die Synchronisierungsaufgabe gestartet wird, im gleichen Format wie beim Import.

Bei der Synchronisierung werden die aktuellen Datensätze durch die neuen ersetzt. Vorhandene Datensätze, die von einem Verifizierungsoperator geändert wurden (durch Bearbeiten, Hinzufügen oder Löschen von Werten), werden gespeichert und synchronisiert. Manuell hinzugefügte neue Datensätze werden gelöscht und nicht synchronisiert. Bei sehr großen Datensätzen kann die Synchronisierung mehrere Stunden dauern. In dieser Beispiel-CSV-Datei für einen Vendors-Datensatz hat der erste Vendor mehrere IBANs.

Id,Name,Street,City,ZIP,CountryCode,VATID,IBAN,IBAN,BusinessUnitId
1,MacWay,9 Route d'Eschau,Illkirch-Graffenstaden,67411,FR,1A345678901,FR1420041010050500012M02606,FR7630006000011234567890189,1
2,Bottled Water Ltd,Mary Ann St,Cardiff,CF102EN,GB,123456789,GB29NWBK60161331926819,,2
3,CCcompany Ltd.,2 Wilkins Grove,Welwyn Garden City,AL86JS,GB,234567890,GB27BOFI90212729823529,,3
4,MANZANA solutions,"Calle de la Botanica, 15",Madrid,28000,ES,E73895722,ES9121000418450200051332,,4

Anmeldedaten des Servicekontos im Windows Vault speichern

Die Anmeldedaten des Servicekontos können entweder in der Datei config.json im Service-Verzeichnis von ABBYY FlexiCapture Connect oder, sicherer, im Windows Vault gespeichert werden. Weitere Informationen finden Sie in der Microsoft-Dokumentation zu Credential Manager und cmdkey.

Anmeldedaten zum Windows Vault hinzufügen

Damit ABBYY FlexiCapture Connect die Anmeldedaten des Servicekontos aus dem Windows Vault abrufen kann, registrieren Sie diese mit cmdkey und führen Sie den Service unter demselben Windows-Konto aus.

Ein Windows-Konto erstellen oder auswählen

Erstellen Sie ein neues Windows-Konto oder wählen Sie ein vorhandenes Windows-Konto aus.

Die Anmeldedaten mit cmdkey registrieren

Führen Sie cmd.exe unter diesem Windows-Konto aus und führen Sie den folgenden cmdkey-Befehl aus. Im Befehl ist https://europe.flexicapture.com#tenant eine Kombination aus der ABBYY FlexiCapture-URL und dem Mandantennamen.

cmdkey /generic:https://europe.flexicapture.com#tenant /user:userName /password:p@ssword

Die Anmeldedaten aus der Konfigurationsdatei entfernen

Löschen Sie den Benutzernamen und das Kennwort aus der Datei config.json, die sich im Service-Verzeichnis von ABBYY FlexiCapture Connect befindet.

Den Service unter dem Windows-Konto ausführen

Konfigurieren Sie ABBYY FlexiCapture Connect so, dass es unter demselben Windows-Konto gestartet wird, unter dem Sie cmdkey ausgeführt haben.

Starten Sie Windows Service Manager (services.msc).
Öffnen Sie in den Eigenschaften von Services ABBYY FlexiCapture Connect.
Wählen Sie auf der Registerkarte Log On This account aus und geben Sie die Anmeldedaten Ihres Windows-Kontos ein.

Screenshot der Registerkarte „Log On“ in den Eigenschaften des Service ABBYY FlexiCapture Connect, wobei „This account“ ausgewählt ist und die Anmeldedaten des Windows-Kontos eingegeben wurden.

Anmeldedaten aus dem Windows Vault entfernen

Credential Manager öffnen

Öffnen Sie Credential Manager.

Die Anmeldedaten entfernen

Erweitern Sie auf der Registerkarte Windows Credentials die Anmeldedaten, die Sie entfernen möchten, und klicken Sie auf Remove.

Screenshot der Registerkarte „Windows Credentials“ im Credential Manager, mit erweiterten Anmeldedaten und verfügbarer Option „Remove“.

Exportpfade für das Projekt einrichten

Um ABBYY FlexiCapture Connect zum Exportieren von Dateien aus ABBYY FlexiCapture Cloud zu verwenden, passen Sie die Exportpfade in Ihrem Projekt an.

Den Export-Stammpfad leeren

Stellen Sie auf der Registerkarte Allgemein im Dialogfeld <project> Properties sicher, dass das Feld Export root path leer ist. Weitere Informationen finden Sie unter Projekteigenschaften.

Screenshot der Registerkarte „Allgemein“ im Dialogfeld „<project> Properties“, in dem das Feld „Export root path“ leer ist.

Einen relativen Exportpfad angeben

Geben Sie im Dialogfeld Export Settings den Exportpfad relativ zum Stammpfad an, der auf der Registerkarte Allgemein im Dialogfeld <project> Properties angegeben ist. Da Sie diesen Stammpfad leer gelassen haben, geben Sie das Verzeichnis ohne den exakten Stammpfad an.

Screenshot des Dialogfelds „Export Settings“, in dem der Exportpfad relativ zu einem leeren Stammpfad angegeben ist.

Die Option If file exists wird ignoriert. Wenn Dateien aus ABBYY FlexiCapture Cloud über ABBYY FlexiCapture Connect exportiert werden, wird für jedes neue Dokument eine neue Datei erstellt.

Einschränkungen von ABBYY FlexiCapture Connect

Es können nur Datensätze mit bis zu etwa 500.000 Datensätzen synchronisiert werden.
Während ein Datensatz aktualisiert wird, können Benutzer auf den Webstationen keine Vendors nachschlagen.
ABBYY FlexiCapture Connect erkennt keine Hot Folder-Importprofile, die auf Projekteinstellungen basieren.
ABBYY FlexiCapture Connect exportiert Dokumente aus allen auf dem Server verfügbaren Batches. Die Projekteinstellungen wirken sich nicht auf den Namen des Zielverzeichnisses aus, das immer denselben Namen wie der ursprüngliche Batch trägt.
ABBYY FlexiCapture Connect kann nur einen Batch als Ganzes exportieren. Auch wenn Sie in den Workflow-Einstellungen des Projekts die Option Auf alle Dokumente in einem Batch warten deaktivieren, werden die Dokumente nicht separat exportiert.
ABBYY FlexiCapture Connect kann die Ergebnisse aller Dokumente in einem Batch nicht in eine einzige Datei exportieren. Für jedes Dokument aus dem Batch wird im Exportverzeichnis eine separate Datei erstellt.
ABBYY FlexiCapture Connect kann die Ergebnisse aller Batches nicht in eine einzige Datei exportieren. Für jedes Dokument aus jedem Batch wird im Exportverzeichnis eine separate Datei erstellt.
Die Größe importierter und exportierter Dateien ist auf 199 MB begrenzt.
Proxyserver werden nicht unterstützt.

Fehlerbehebung für ABBYY FlexiCapture Connect

Wenn ein Fehler auftritt, überprüfen Sie zunächst die Protokolldatei, die Sie unter %LocalAppData%\ABBYY\FlexiCapture\Connect\Logs finden. Fehler können auch durch falsche oder unvollständige Einstellungen in der Konfigurationsdatei verursacht werden. Prüfen Sie daher die Datei config.json auf Unstimmigkeiten oder fehlende Angaben. Wenn der Fehler weiterhin besteht, wenden Sie sich an den ABBYY Support. Der Support benötigt möglicherweise sowohl Ihre Datei config.json als auch die Protokolldatei.

​Systemanforderungen

​ABBYY FlexiCapture Connect installieren und konfigurieren

​Referenz zur Konfigurationsdatei

​Allgemeine Einstellungen

​Projekteinstellungen

​Importeinstellungen

​Exporteinstellungen

​Einstellungen der Dokumentdefinition

​Einstellungen für die Datensatzsynchronisierung

​Anmeldedaten des Servicekontos im Windows Vault speichern

​Anmeldedaten zum Windows Vault hinzufügen

​Anmeldedaten aus dem Windows Vault entfernen

​Exportpfade für das Projekt einrichten

​Einschränkungen von ABBYY FlexiCapture Connect

​Fehlerbehebung für ABBYY FlexiCapture Connect