Zum Hauptinhalt springen
ABBYY Vantage stellt Content-IQ-Skills bereit, mit denen Sie unstrukturierte Inhalte mithilfe von Klassifizierung und Extraktion in strukturierte, verwertbare Informationen umwandeln sowie bestimmte Dokumenttypen wie Rechnungen, Bestellungen, W-2-Formulare und mehr verarbeiten können. Mit dem ABBYY Vantage Connector for UiPath können Sie ABBYY Vantage Skills in Ihren UiPath-Workflow integrieren.

​
Systemanforderungen

Sie benötigen ein Konto bei ABBYY Vantage, um Ihren Prozess zu konfigurieren und auszuführen. ABBYY Vantage Connector for UiPath kann auf den folgenden Betriebssystemen ausgeführt werden:
  • Windows 10
  • Windows Server 2016
  • Windows Server 2019
Der Connector kann nicht auf Computern mit Windows Server 2012 R2, Windows 8.1 oder älteren Betriebssystemen ausgeführt werden.
Der Connector für UiPath kann mit Folgendem verwendet werden:
  • ABBYY Vantage 2.3.2 oder höher
  • UiPath Enterprise Edition 2023.8.0
  • Community Edition 2023.4.4 oder höher
Die folgenden externen Komponenten müssen installiert sein:
  • Microsoft .NET Framework 4.8.1
  • Microsoft .NET 8
Wir empfehlen, Windows-Legacy-Projekte auf Windows-Kompatibilität umzustellen, da die Legacy-Kompatibilität nicht mehr unterstützt wird. Informationen dazu, wie Sie Windows-Legacy-Projekte auf Windows umstellen, finden Sie unter Windows-Legacy-Projekte in Windows konvertieren.

​
Installieren des Connectors

ABBYY Vantage Connector for UiPath ist eine Reihe von Aktivitäten, die auf der UiPath-Seite innerhalb des benutzerdefinierten Workflows ausgeführt werden. Die Aktivitäten werden als NuGet-Paket bereitgestellt. So installieren Sie das Paket:
  1. Führen Sie ABBYYVantageConnectorForUiPath.<version>.exe aus und folgen Sie den Anweisungen des Installationsassistenten. Geben Sie während der Installation den Installationsordner des Connectors an. Standardmäßig ist C:\Program Files\ABBYY Vantage Connector for UiPath festgelegt.
  2. Öffnen Sie in UiPath Studio ein vorhandenes Projekt oder erstellen Sie ein neues.
  3. Klicken Sie im Menüband auf der Registerkarte Design auf Manage Packages: UiPath-Menüband mit der Schaltfläche Manage Packages auf der Registerkarte Design
  4. Stellen Sie sicher, dass die Paketquelle nuget.org aktiviert ist. Diese Paketquelle ist erforderlich, um einige Abhängigkeiten für das Connector-Paket zu installieren.
    Wenn Sie bereits eine konfigurierte Paketquelle haben und diese verwenden möchten, überspringen Sie Schritt 5.
  5. Wechseln Sie im Fenster Manage Packages zur Registerkarte Settings und erstellen Sie eine neue Paketquelle: a. Geben Sie einen Namen für die neue Paketquelle ein. b. Geben Sie den Pfad zu dem Ordner an, in dem Sie die Connector-NuGet-Pakete ablegen möchten. c. Klicken Sie auf Add, um die Einstellungen zu bestätigen. UiPath-Menüband mit der Schaltfläche Manage Packages auf der Registerkarte Design Die neue Paketquelle wird im Bereich User defined package sources und im linken Bereich des Fensters Manage Packages angezeigt. Fenster Manage Packages mit Abbyy.UiPath.Vantage.Activities, ausgewählt für die Installation
  6. Kopieren Sie alle NuGet-Pakete von ABBYY Vantage Connector for UiPath aus dem Installationsordner in Ihren Paketquellenordner. Die NuGet-Pakete befinden sich im Unterordner UiPath Activities des Installationsordners, der in Schritt 1 erstellt wurde (der Standardspeicherort ist C:\Program Files\ABBYY Vantage Connector for UiPath\UiPath Activities). Nachdem die Connector-NuGet-Pakete der verfügbaren Paketquelle hinzugefügt wurden, können Sie das Connector-Paket als Projektabhängigkeit installieren.
  7. Navigieren Sie im Fenster Manage Packages zum Abschnitt All Packages und gehen Sie wie folgt vor: a. Klicken Sie auf die Kategorie der neu erstellten Paketquelle. b. Wählen Sie Abbyy.UiPath.Vantage.Activities aus der Liste der verfügbaren Pakete aus und klicken Sie auf Install. Im Fenster License Acceptance werden die Lizenzbedingungen für jedes Drittanbieterpaket angezeigt, das Sie installieren. c. Klicken Sie auf View License, um die Lizenzbedingungen zu lesen. d. Klicken Sie auf I Accept, um den Lizenzbedingungen zuzustimmen und die Pakete zu installieren. Klicken Sie abschließend auf Save. Fenster Manage Packages mit Abbyy.UiPath.Vantage.Activities, ausgewählt für die Installation
  8. Nach der Installation werden die Vantage-Aktivitäten im Abschnitt ABBYY Vantage der Liste der für Ihr Projekt verfügbaren Aktivitäten angezeigt: Bereich Aktivitäten mit dem Abschnitt ABBYY Vantage mit den Aktivitäten Vantage Scope, Use Skill, Get Results und Map Fields Ausführliche Anweisungen zum Installieren von Paketen finden Sie im UiPath Studio Guide.

​
Windows-Legacy-Projekte in Windows konvertieren

Wir empfehlen, Windows-Legacy-Projekte in Windows zu konvertieren.
Um das Projekt auf Windows-Kompatibilität umzustellen, müssen Sie die Version des ABBYY Vantage Connector for UiPath aktualisieren. Führen Sie dazu alle Schritte aus dem Abschnitt Installieren des Connectors mit Ausnahme von Schritt 5 aus.
Die Standardkompatibilität für neue Projekte ist jetzt Windows-Kompatibilität. Um Windows-Legacy-Projekte in Windows-Kompatibilität zu konvertieren, führen Sie für jedes Projekt mit Windows-Legacy-Kompatibilität die folgende Vorgehensweise aus:
  1. Öffnen Sie in UiPath Studio das Windows-Legacy-Projekt.
  2. Klicken Sie in der Meldung, die unter dem Menüband angezeigt wird, auf den Link Convert to Windows.
UiPath-Menüband mit dem Banner Convert to Windows und dem Dialogfeld Convert to Windows Das Dialogfeld Convert to Windows wird geöffnet. UiPath-Menüband mit dem Banner Convert to Windows und dem Dialogfeld Convert to Windows
  1. Geben Sie an, wie das Windows-Legacy-Projekt in Windows konvertiert werden soll:
    • Um eine Kopie des aktuellen Projekts mit Windows-Kompatibilität zu erstellen und das ursprüngliche Windows-Legacy-Projekt beizubehalten, wählen Sie Create a new project aus. Geben Sie den Projektnamen, den gewünschten Speicherort und optional eine Beschreibung für das neue Projekt ein.
    • Um das vorhandene Projekt zu aktualisieren und in Windows-Kompatibilität zu konvertieren, deaktivieren Sie die Option Create a new project. Wenn Sie diese Option deaktivieren, können die am Projekt vorgenommenen Änderungen nicht rückgängig gemacht werden.
  2. Klicken Sie auf Convert. Weitere Informationen zum Konvertieren von Windows-Legacy-Projekten in Windows-Kompatibilität finden Sie im UiPath Studio Guide.

​
Verwenden von ABBYY Vantage-Aktivitäten in UiPath-Workflows

Mit dem ABBYY Vantage Connector for UiPath kann Ihr Workflow Dokumentbilder an ABBYY Vantage senden und sie mit einem verfügbaren Skill verarbeiten. Um verfügbare Skills anzuzeigen, eigene Skills zu erstellen oder vorhandene Skills zu ändern, verwenden Sie den ABBYY Vantage Skill Catalog oder den ABBYY Vantage Skill Designer. Weitere Informationen zum Einrichten von Skills finden Sie im ABBYY Vantage Skill Designer Guide. Der ABBYY Vantage Connector for UiPath bietet die folgenden Aktivitäten für die Arbeit mit ABBYY Vantage: Um einem UiPath-Prozess eine Aktivität hinzuzufügen, ziehen Sie die Aktivität im Activities-Bereich von UiPath Studio in den Designer-Bereich. Nachdem die Aktivität zum Prozess hinzugefügt wurde, müssen Sie die Felder im Properties-Bereich ausfüllen. Einige Eigenschaften können Sie auch im Designer-Bereich ausfüllen. Weitere Informationen zu den Eigenschaften der Aktivitäten finden Sie in den folgenden Abschnitten. Der ABBYY Vantage Connector for UiPath wird mit einem Beispielprozess ausgeliefert, der zeigt, wie Sie ABBYY Vantage-Aktivitäten in Ihrem Workflow verwenden können. Weitere Informationen finden Sie unter Beispielprozess für ABBYY Vantage-Aktivitäten.

​
Vantage Scope Activity

Die Aktivität Vantage Scope übergibt die ABBYY Vantage-Verbindungseinstellungen an andere Vantage-Aktivitäten. Sie dient außerdem als Container für andere Vantage-Aktivitäten. Alle anderen ABBYY Vantage-Aktivitäten müssen innerhalb der Vantage Scope Activity platziert werden.
Mit der Vantage Scope Activity können Sie die Authentifizierung über den Resource Owner Password Credentials Flow und den Client Credentials Flow konfigurieren. Wenn Sie in Vantage einen externen Identitätsanbieter einrichten, funktioniert nur der Client Credentials Flow.

​
Aktivitätseigenschaften

GruppeEigenschaftTypBeschreibung
VerbindungseinstellungenAutorisierungs-Grant-TypIEnumerable<AuthorizationGrantType>Der für die Autorisierung verwendete Grant-Typ: ResourceOwnerPassword oder ClientCredentials
VerbindungseinstellungenKennwortStringDas Kennwort, das für die Verbindung mit ABBYY Vantage verwendet wird.
VerbindungseinstellungenSicheres KennwortSecureStringDas sichere Kennwort, das für die Verbindung mit ABBYY Vantage verwendet wird.
VerbindungseinstellungenServer-URLStringDie Serveradresse von ABBYY Vantage.
VerbindungseinstellungenTenantStringDer Tenant-Name oder die Tenant-ID von ABBYY Vantage. Wichtig! Diese Eigenschaft ist nur erforderlich, wenn der Benutzer, dessen Anmeldedaten für die Verbindung mit dem ABBYY Vantage-Server verwendet werden, auf dem Server in mehreren (mehr als einem) Tenants registriert ist. Der Tenant-Name ist auf der Vantage-Anmeldeseite in Ihrem Browser zu finden, wenn Sie das Kennwort eingeben.
VerbindungseinstellungenBenutzernameStringDie E-Mail-Adresse des Benutzers, die für die Verbindung mit ABBYY Vantage verwendet wird.
Proxy-Einstellungen (optional)Proxy aktivierenBooleanErmöglicht die Verwendung eines Proxy-Servers zum Weiterleiten von HTTP-Anfragen.
Proxy-Einstellungen (optional)Server-URLStringDie Adresse des Proxy-Servers (z. B. http://127.0.0.1:8080).
Proxy-Einstellungen (optional)BenutzernameStringDer Benutzername, der für die Verbindung mit dem Proxy-Server verwendet wird.
Proxy-Einstellungen (optional)KennwortStringDas Kennwort, das für die Verbindung mit dem Proxy-Server verwendet wird.
Proxy-Einstellungen (optional)Sicheres KennwortSecureStringDas sichere Kennwort, das für die Verbindung mit dem Proxy-Server verwendet wird.
Einstellungen des Vantage Public API Client (optional)Client-IDStringKennung der Vantage-Anwendung.
Einstellungen des Vantage Public API Client (optional)Client SecretStringSicherer Anwendungsschlüssel für Vantage.
Einstellungen des Vantage Public API Client (optional)Sicheres Client SecretSecureStringSicherer Anwendungsschlüssel für Vantage als geschützte Zeichenfolge.
Das Vantage-Benutzerkennwort, das Proxy-Kennwort und das Client Secret in den Client-Einstellungen können in der Scope Activity entweder als String-Parameter oder im entsprechenden Parameter vom Typ SecureString festgelegt werden. Ein Kennwort vom Typ String wird in der XAML-Projektdatei als Klartext gespeichert und ist nicht sicher. Ein String-Kennwort wird nur empfohlen, wenn Sie die Aktivitäten Use Skill und Map Fields konfigurieren, um eine Liste von Skills abzurufen, oder wenn Sie Ihren UiPath-Prozess debuggen. Sobald der Prozess vollständig konfiguriert ist:
  • Wenn Sie den Resource Owner Password Credentials Flow verwenden, entfernen Sie die Eigenschaft Password aus der Vantage Scope-Aktivität und richten Sie die Eigenschaft Secure Password ein.
  • Wenn Sie den Client Credentials Flow verwenden, entfernen Sie die Eigenschaft Client Secret aus der Vantage Scope-Aktivität und richten Sie die Eigenschaft Secure Client Secret ein.
Wir empfehlen, UiPath Orchestrator assets zu verwenden, um Ihre Anmeldedaten sicher zu speichern. In diesem Fall kann das Kennwort aus Orchestrator mithilfe der Aktivität Get Credential abgerufen und über eine Variable an die Aktivität Vantage Scope übergeben werden. Weitere Informationen zur Aktivität Get Credential finden Sie in den offiziellen UiPath-Anleitungen.
Für Verbindungseinstellungen, Proxy-Einstellungen und Client-Einstellungen muss derselbe Kennworttyp verwendet werden.
Wenn Sie einen Client in ABBYY Vantage erstellen, konfigurieren Sie je nach verwendetem Grant-Typ im Abschnitt OAuth 2.0 Flows Settings der Client-Einstellungen Folgendes:
  • Resource Owner Password Credentials Flow:
    • Aktivieren Sie die Option Allow Resource Owner Password Credentials Flow.
  • Client Credentials Flow:
    • Aktivieren Sie die Option Allow issuing refresh tokens to refresh access tokens.
    • Aktivieren Sie die Option Allow client credentials flow.
    • Wählen Sie die erforderlichen Rollen aus, mit denen sich die Anwendung bei Vantage anmeldet, indem Sie auf die Einstellung Manage Roles klicken.
    Wenn Sie aus der Liste eine oder mehrere mit Skills verknüpfte Rollen auswählen müssen, wählen Sie auch die für diese Rollen zulässigen Skills aus.
Auszufüllende Felder für den Resource Owner Password Credentials Flow: Felder der Vantage Scope-Aktivität für den Resource Owner Password Credentials Flow
Wenn in den Einstellungen des Vantage Public API Client alle Eigenschaften leer sind, wird der Standardclient von ABBYY Vantage verwendet.
Auszufüllende Felder für den Client Credentials Flow: Felder der Aktivität „Vantage Scope“ für den Client Credentials Flow

​
Proxy-Einstellungen

Sie können Connector-Anfragen zur Laufzeit so konfigurieren, dass sie über einen Proxyserver gesendet werden. Die folgenden Proxy-Authentifizierungstypen werden unterstützt: Basic, NTLM, IP-Authentifizierung und transparenter Proxy. Um einen Proxy zu verwenden, wählen Sie die Aktivität Vantage Scope aus. Setzen Sie in der Eigenschaftengruppe Proxy Settings (optional) den Wert der Eigenschaft Enable Proxy auf "true" und geben Sie dann in der Eigenschaft Server URL die Adresse Ihres Proxyservers an. Wenn Sie die Basic-Authentifizierung verwenden, geben Sie in den Eigenschaften Username und Password / Secure Password die Anmeldedaten für die Verbindung mit dem Proxy an. Wenn Sie die NTLM-Authentifizierung verwenden, sind die Felder Username und Password optional. Wenn die Felder Username und Password leer sind, werden die Anmeldedaten des Benutzers verwendet, unter dessen Konto der UiPath-Prozess ausgeführt wird.

​
Use-Skill-Aktivität

Die Aktivität Use Skill erstellt einen Vorgang, um ein Dokument mithilfe eines ABBYY Vantage Skill zu verarbeiten. Anschließend wird eine eindeutige Kennung des Vorgangs als Ausgabeeigenschaft Transaction Id zurückgegeben.

​
Aktivitätseigenschaften

GroupPropertyTypeDescription
VerbindungseinstellungenSkill-NameStringDer Name des Vantage-Skills.
EingabeEingabedateienIReadOnlyDictionary<String,InputFile>Eine Dictionary-Sammlung, in der String den Namen der Datei und InputFile die Klasse angibt, die die Eingabedatei beschreibt. Hinweis: Bevor Dateien zum Dictionary hinzugefügt werden, muss sichergestellt werden, dass an den Parameter String eindeutige Werte übergeben werden. Sie können dem Dictionary „Input Files“ nicht mehr als eine Datei hinzufügen, für die im Parameter String derselbe Name übergeben wird.
EingabeParameter für die VorgangsregistrierungIReadOnlyDictionary<String,String>Eine Dictionary-Sammlung mit Parametern für die Vorgangsregistrierung, über die der Schlüssel und der Wert jedes Parameters übergeben werden.
AusgabeVorgangs-IDGuidDie Kennung des erstellten Vorgangs. Diese ID wird dann als Eingabeeigenschaft Transaction Id der Aktivität Get Results verwendet, um den Status des Vorgangs und die Verarbeitungsergebnisse abzurufen.
Eigenschaften der Klasse InputFile:
NameTypeDescription
fileStreamStreamDer Inhalt der Datei, die an ABBYY Vantage übergeben wird. Es ist möglich, den Stream der Datei auf einem lokalen Datenträger als Wert dieser Eigenschaft zu übergeben (z. B. System.IO.File.OpenRead("D:\images\Invoice1.pdf")).
index (optional)IntegerDer Index der Datei im Vorgang.
fileRegistrationParameters (optional)IReadOnlyDictionary<String,String>Eine Dictionary-Sammlung mit Registrierungsparametern der Datei, über die der Schlüssel und der Wert jedes Parameters übergeben werden.
Die Aktivität Use Skill kann nur innerhalb einer konfigurierten Vantage Scope-Aktivität verwendet werden.
Gehen Sie beim Einrichten der Aktivität Use Skill je nach verwendetem Authentifizierungsablauf wie folgt vor:
  • Resource Owner Password Credentials Flow — Geben Sie die Eigenschaft Password der Vantage Scope-Aktivität an, um eine Liste der verfügbaren Skills abzurufen. Sobald Sie Ihren UiPath-Workflow konfiguriert haben, sollten Sie die Eigenschaft Password in Secure Password ändern.
  • Client Credentials Flow — Geben Sie die Eigenschaft Client Secret der Vantage Scope-Aktivität an, um eine Liste der verfügbaren Skills abzurufen. Sobald Sie Ihren UiPath-Workflow konfiguriert haben, sollten Sie die Eigenschaft Client Secret in Secure Client Secret ändern.
Weitere Informationen finden Sie im Abschnitt Vantage Scope Activity. Benutzeroberfläche der Vantage Scope-Aktivität Klicken Sie auf die Schaltfläche rechts neben der Dropdown-Liste unter Skill Name, um eine Liste der Skills abzurufen. Erweitern Sie dann die Dropdown-Liste Skill Name und wählen Sie den Skill aus, den Sie für die Dokumentverarbeitung verwenden möchten.
Wir empfehlen, die Dateigröße großer Dateien auf 30 MB oder weniger zu reduzieren, um die Dokumentverarbeitung zu beschleunigen.
Im Parameter Skill Name der Use Skill-Aktivität können Sie eine UiPath-Variable vom Typ String verwenden, um den Namen des Skills zu speichern. Wenn Sie über die Dropdown-Liste der Aktivität im Designbereich einen Skill auswählen, wird der neu ausgewählte Skill in die angegebene Variable geschrieben. Sie können den Namen des Skills direkt in der Variablen speichern. Ausdrücke oder Verweise auf andere Variablen im Wert der Variablen werden derzeit nicht unterstützt.

​
Aktivität „Get Results“

Mit der Aktivität Get Results werden die Verarbeitungsergebnisse aus ABBYY Vantage abgerufen.

​
Aktivitätseigenschaften

GruppeEigenschaftTypBeschreibung
EingabeTransaction IdGuidDie Kennung des Vorgangs. Übergeben Sie an diese Eigenschaft den Wert, der als Ausgabeeigenschaft Transaction Id der Aktivität Use Skill zurückgegeben wird.
EingabeDelete TransactionBooleanGibt an, ob der abgeschlossene Vorgang gelöscht werden soll, unabhängig davon, ob er erfolgreich war oder nicht. Der Standardwert ist FALSE; das bedeutet, dass der Vorgang nicht gelöscht wird.
AusgabeDocument ResultsIEnumerable<DocumentResult>Eine Sammlung von Ergebnisdokumenten nach der Verarbeitung.
AusgabeReview LinkStringEin Link zum ABBYY Vantage Manual Review Client, in dem die Vorgangsergebnisse überprüft werden können (dieser Link ist nur verfügbar, wenn der verwendete Process-Skill eine Review-Aktivität enthält).
AusgabeTransaction StatusTransactionStatusDer Status des Vorgangs. Folgende Status sind möglich: "New", "Processing", "Review", "Processed". Abhängig vom empfangenen Status können Sie Ihren UiPath-Prozess so konfigurieren, dass unterschiedliche Logik ausgeführt wird. Wenn der Vorgang beispielsweise den Status "Processing" hat, warten Sie einige Sekunden und rufen Sie die Aktivität erneut auf.
Bei Verwendung eines Klassifizierungs‑Skills, eines Document-Skills oder eines OCR-Skills werden alle Eingabedateien des Vorgangs zu einem Dokument zusammengefügt. Bei Verwendung eines Process-Skills können mehrere Ergebnisdokumente abgerufen werden. Standardmäßig wird im Process-Skill für jede zum Vorgang hinzugefügte Eingabedatei in ABBYY Vantage ein separates Dokument erstellt. Die Dokumente können unterschiedlichen Klassen angehören, werden aber alle innerhalb eines Vorgangs verarbeitet. Sie können die Einstellungen für die Dokumentzusammenstellung auch selbst festlegen, indem Sie die Assemble Activity im Process-Skill verwenden. Dadurch hat jedes Dokument im Vorgang eigene Verarbeitungsergebnisse. Der Ausgabeparameter Document Results der Aktivität Get Results enthält die Verarbeitungsergebnisse aller Dokumente des Vorgangs als Sammlung von Instanzen der Klasse DocumentResult. Eigenschaften der Klasse DocumentResult:
NameTypBeschreibung
DocumentIdStringDie Kennung des Dokuments.
ClassificationConfidencesIEnumerable<ClassificationConfidence>Eine Sammlung von Klassifizierungs-Konfidenzwerten. Eine Liste aller Klassen, die im auf das Dokument angewendeten Klassifizierungs‑Skill verfügbar sind, zusammen mit ihren Klassifizierungs-Konfidenzwerten.
ClassNameStringDie Dokumentklasse auf Grundlage der Klassifizierungsergebnisse.
ExtractedDataStringEin JSON-string, das die extrahierten Daten enthält. Hinweis: Bei einem Process-Skill kann die Eigenschaft abgerufen werden, wenn in der Output Activity die Option Values, metadata, and field structure for each document aktiviert ist.
IsClassificationConfidentBooleanWenn dieser Wert TRUE ist, gilt die ermittelte Klasse als mit ausreichender Konfidenz bestimmt.
ResultFilesIReadOnlyDictionary<String,Stream>Eine Sammlung von Ergebnisdateien nach der Verarbeitung.
DocumentFullTextStringDie Volltextebene eines Dokuments, die von ABBYY Vantage erfasst wurde. Hinweis: Wenn die Skill-Konfiguration keine Einstellung für den Volltextexport enthält, enthält diese Eigenschaft den folgenden Standardwert: TXT export was not configured in the ABBYY Vantage skill settings. Please enable TXT export in the skill that you have selected. TXT-Export ist nur für OCR- oder Processing-Skills verfügbar.
Alle aufgeführten Parameter werden in der Sammlung Document Results in einem separaten DocumentResult erfasst. Selbst wenn es nur ein Ausgabedokument gibt, sind dessen Ausgabeparameter über das erste DocumentResult in der Sammlung Document Results verfügbar.
Eigenschaften der Klasse ClassificationConfidence:
NameTypBeschreibung
ClassNameStringVantage-Dokumentklasse.
ConfidenceIntDer Konfidenzwert dafür, dass das Dokument zu dieser Klasse gehört. Mögliche Werte reichen von 0 bis 100.
Die Aktivität Get Results kann nur innerhalb einer konfigurierten Vantage Scope-Aktivität verwendet werden.
Wenn die Verarbeitung des Vorgangs erfolgreich abgeschlossen ist (d. h. Transaction Status = "Processed"), werden die Ergebnisse in den Ausgabeeigenschaften gespeichert. Wenn der Vorgang noch verarbeitet wird (d. h. Transaction Status = "New" / "Processing"), warten Sie einige Sekunden und rufen Sie die Aktivität Get Results erneut auf. Ein Sonderfall, bei dem Transaction Status = "Review" gilt, wird unten beschrieben. Die Ergebnisse, die die Aktivität Get Results abrufen kann, unterscheiden sich je nach dem auf das Dokument angewendeten Skill:
  • Klassifizierungs‑Skill (z. B. Vantage Classifier):
    • Vorgangsstatus
    • Document Results (für jedes DocumentResult): DocumentId, ClassificationConfidences, ClassName, IsClassificationConfident, ResultFiles (JSON-Datei mit Daten zu den Klassifizierungsergebnissen)
  • Document-Skill (z. B. Invoice US):
    • Vorgangsstatus
    • Document Results (für jedes DocumentResult): DocumentId, ExtractedData, ResultFiles (die Ergebnisse liegen in zwei JSON-Dateien vor — die erste enthält alle Dokumentdaten, die zweite die Werte der extrahierten Felder und Regelfehler und endet auf _fields.json)
  • OCR-Skill:
    • Vorgangsstatus
    • Dokumentergebnisse (für jedes DocumentResult): DocumentId, ResultFiles (diese Dateien werden in dem im OCR-Skill konfigurierten Exportformat bereitgestellt), DocumentFullText (wenn der Export nach TXT im Skill aktiviert ist)
  • Process-Skill: Wenn ein Process-Skill eine Aktivität Classify und eine Aktivität Extract umfasst, werden die oben beschriebenen Ergebnisse sowohl für einen Klassifizierungs‑Skill als auch für einen Document-Skill zurückgegeben. Wenn ein Process-Skill mehrere Aktivitäten Classify oder Extract umfasst, werden die Ergebnisse für die jeweils letzte Aktivität des betreffenden Typs zurückgegeben. Wenn ein Process-Skill mehrere Aktivitäten "Classify" oder "Extract" umfasst, werden die Ergebnisse für die jeweils letzte Aktivität des betreffenden Typs zurückgegeben. Wenn die Option PDF im Dialogfeld Exported Data Settings einer Aktivität Output eines Process-Skills aktiviert ist, enthalten die Ergebnisse die JSON-Datei mit den Extraktionsergebnissen sowie das Dokumentbild, das zusammen mit einer Textebene in eine PDF-Datei exportiert wurde. Für jedes Dokument im Vorgang wird außerdem der Parameter DocumentFullText zurückgegeben, wenn der Export nach TXT im Skill aktiviert ist. Ein Process-Skill kann auch eine Aktivität Review enthalten. Wird ein solcher Skill für die Dokumentverarbeitung verwendet, kann die Verarbeitung angehalten werden, wenn das Dokument eine manuelle Überprüfung erfordert. In diesem Fall liefert die Aktivität Get Results die folgenden Ergebnisse:
    • Vorgangsstatus = "Review"
    • Review Link
    Sobald die manuelle Überprüfung und die Vorgangsverarbeitung abgeschlossen sind, können Sie die oben genannten Ergebnisse abrufen, indem Sie die Aktivität Get Results erneut aufrufen.
Die Vorgangsverarbeitung kann aus verschiedenen Gründen fehlschlagen (zum Beispiel kann eine Eingabedatei beschädigt sein oder ein Eingabedateiformat von ABBYY Vantage nicht unterstützt werden). In diesem Fall löst die Aktivität Get Results eine Ausnahme aus.

​
Aktivität „Map Fields“

Die Aktivität Map Fields wird verwendet, um extrahierte Feldwerte in UiPath-Variablen zu speichern. Im Bereich Designer können Sie ABBYY Vantage-Felder UiPath-Variablen zuordnen.

​
Aktivitätseigenschaften

GruppeEigenschaftTypBeschreibung
VerbindungseinstellungenSkill NameStringDer Name des Vantage Document-Skills.
EingabeExtracted DataStringAkzeptiert eine JSON-Zeichenfolge mit den extrahierten Daten. Übergeben Sie dieser Eigenschaft den Wert der Eigenschaft ExtractedData des jeweiligen DocumentResult, der in der Aktivität Get Results empfangen wurde. Verwenden Sie UiPath-Variablen, um Werte zwischen Eigenschaften zu übergeben.
Die Aktivität Map Fields kann nur innerhalb einer konfigurierten Vantage Scope Activity verwendet werden.
Gehen Sie beim Einrichten der Aktivität Map Fields je nach verwendetem Authentifizierungsablauf wie folgt vor:
  • Resource Owner Password Credentials Flow — Geben Sie die Eigenschaft Password der Vantage Scope Activity an, um eine Liste der verfügbaren Skills abzurufen. Nachdem Sie Ihren UiPath-Workflow konfiguriert haben, sollten Sie die Eigenschaft Password in Secure Password ändern.
  • Client Credentials Flow — Geben Sie die Eigenschaft Client Secret der Vantage Scope Activity an, um eine Liste der verfügbaren Skills abzurufen. Nachdem Sie Ihren UiPath-Workflow konfiguriert haben, sollten Sie die Eigenschaft Client Secret in Secure Client Secret ändern.
Weitere Informationen finden Sie im Abschnitt Vantage Scope Activity.
Zur Laufzeit muss die Eigenschaft Extracted Data der Aktivität Map Fields den Wert der Eigenschaft ExtractedData des jeweiligen DocumentResult erhalten, der in der Aktivität Get Results empfangen wurde und die vom Document-Skill extrahierten Daten enthält, für den die Aktivität Map Fields konfiguriert wurde. Prüfen Sie nach dem Empfang der extrahierten Daten, ob der Name des auf das Dokument angewendeten Document-Skills mit dem Namen des Document-Skills übereinstimmt, für den die Aktivität Map Fields konfiguriert wurde. Ist dies der Fall, übergeben Sie die extrahierten Daten an Map Fields. Um den Dokumenttyp zu ermitteln, können Sie die Ausgabe-Eigenschaft ClassName des jeweiligen DocumentResult verwenden, der in der Aktivität Get Results empfangen wurde. Um den Dokumenttyp an diesen Parameter zu übergeben, konfigurieren Sie in der Extract-Aktivität des Process-Skills die Zuordnung der Klasse zu dem Document-Skill, der für die Dokumentenverarbeitung verwendet werden soll. Bei der Zuordnung muss die Bedingung eingehalten werden, dass der Klassenname mit dem Namen des ausgewählten Document-Skills übereinstimmt.
Führen Sie die folgenden Schritte aus, um ABBYY Vantage-Felder UiPath-Variablen zuzuordnen:
  1. Öffnen Sie die Aktivität Map Fields im Bereich Designer und klicken Sie auf die Schaltfläche rechts neben der Dropdown-Liste unter Skill Name, um eine Liste der verfügbaren Skills abzurufen.
  2. Erweitern Sie die Dropdown-Liste Skill Name und wählen Sie den Document-Skill aus, dessen extrahierte Feldwerte in UiPath-Variablen gespeichert werden sollen.
    Sie können nur einen Document-Skill auswählen.
  3. Klicken Sie auf die Schaltfläche Refresh. In der Spalte Vantage Extracted Field wird ein Feldbaum angezeigt.
  4. Erweitern Sie den Baum und klicken Sie neben einem Feld, das Sie zuordnen möchten, auf die Schaltfläche Plus. In der Spalte UiPath Variable werden ein UiPath-Variablenname und der Typ angezeigt. Standardmäßig entspricht der Name der Variablen dem Namen des Vantage-Felds, Sie können diesen Namen jedoch bei Bedarf ändern.
    Stellen Sie sicher, dass die in der Aktivität Map Fields angegebenen UiPath-Variablennamen mit der in Ihrem UiPath-Prozess konfigurierten Variables Naming Convention übereinstimmen. Wenn Variablennamen nicht den Benennungsregeln entsprechen, werden sie in der UiPath-Variablenliste mit einem Warnsymbol angezeigt. Weitere Informationen zur Variables Naming Convention finden Sie in der UiPath-Dokumentation.
    Aktivität Map Fields mit dem Feldbaum Vantage Extracted Field und der Spalte UiPath Variable
  5. Wiederholen Sie den vorherigen Schritt für alle anderen Felder, die Sie zuordnen müssen. Beim Einrichten der Zuordnung können Sie bereits vorhandene UiPath-Variablen angeben. Stellen Sie in diesem Fall sicher, dass der Typ Ihrer Variablen mit dem in der folgenden Tabelle empfohlenen Typ übereinstimmt.
  6. Nachdem Sie Ihre Dokumentfelder UiPath-Variablen zugeordnet haben, klicken Sie auf Apply, um die Änderungen zu speichern. Wenn die Aktivität Map Fields nun zur Laufzeit aufgerufen wird, werden die Variablenwerte mit den extrahierten Daten gefüllt.
Die angegebenen UiPath-Variablen werden in der Sequence erstellt, die der Aktivität Map Fields am nächsten liegt (zum Beispiel in Flowchart).
Im Parameter Skill Name der Aktivität Map Fields können Sie eine UiPath-Variable vom Typ String verwenden, um den Namen des Skills zu speichern. Wenn Sie einen Skill über die Dropdown-Liste der Aktivität im Designbereich auswählen, wird der neu ausgewählte Skill in die angegebene Variable geschrieben. Sie können den Namen des Skills auch direkt in der Variable speichern. Ausdrücke oder Verweise auf andere Variablen im Wert der Variable werden derzeit nicht unterstützt. Die folgende Tabelle zeigt, welcher Typ von UiPath-Variable welchem Feldtyp in ABBYY Vantage entspricht:
ABBYY Vantage Field TypeUiPath Variable Type
TextString
DateString
NumberString
MoneyString
BarcodeString
CheckmarkBoolean
Checkmark group (can be obtained as separated checkmarks)FieldList
GroupFieldList
Group (for repeatable groups)FieldList[]
TableFieldList[]
Tabellenspalten sowie wiederholbare Felder werden UiPath-Variablen vom Typ String[] zugeordnet. Alle wiederholbaren Felder und Felder, die Teil einer wiederholbaren Gruppe sind (oder andere wiederholbare Felder und wiederholbare Gruppen innerhalb wiederholbarer Gruppen), werden UiPath-Variablen vom Typ FieldList[] zugeordnet. Es ist auch möglich, untergeordnete Objekte dieser Gruppe Variablen anderer einfacher Typen zuzuordnen.
Map-Fields-Aktivität mit dem Vantage-Baum der extrahierten Felder und der UiPath-Spalte „Variable“ Eigenschaften der Klasse GroupItem: GroupItem ist eine Struktur, die eine Instanz eines wiederholbaren Objekts (Feld oder Feldgruppe) enthält.
Method/PropertyParameterTypeDescription
KeysIEnumerable<string>Schlüsselwerte. Jeder Wert ist der Name einer bestimmten Verschachtelungsebene.
ValuesIEnumerable<IReadOnlyList<FieldList>>Satz von Feldwerten der Verschachtelungsebenen.
CountIntegerAnzahl der verschachtelten Felder.
ContainsKeyKey: StringBooleanGibt an, ob ein verschachteltes Feld vorhanden ist.
TryGetValueKey: String, Value: IReadOnlyList<FieldList>BooleanGibt an, ob ein Wert vorhanden ist. Wenn ein Wert vorhanden ist, werden True und der Wert zurückgegeben, andernfalls False.
this[]Name: StringIReadOnlyList<FieldList>Gibt den Wert des angegebenen verschachtelten Felds zurück.
FindName: StringIEnumerable<FieldList>Findet alle verschachtelten Felder auf allen Verschachtelungsebenen mit dem angegebenen Namen.
FilterPredicate: (Name: String, Node: FieldList) => BooleanIEnumerable<FieldList>Findet alle verschachtelten Felder auf allen Verschachtelungsebenen, die das Prädikat erfüllen.
DescendentsNameItems: Params String[]IEnumerable<FieldList>Findet alle verschachtelten Felder auf allen Verschachtelungsebenen, deren Name dem Parameter nameItems entspricht.
Eigenschaften der Klasse FieldList: FieldList ist eine Struktur, die einem Feld oder einer Feldgruppe (wiederholbare Felder oder wiederholbare Gruppen mit demselben Namen) entspricht und die Werte der Felder oder Gruppen enthält (mehrere Instanzen sind möglich).
Method/PropertyParameterTypeDescription
ValuesIEnumerable<Object>Satz skalarer Feldwerte.
CountIntegerAnzahl der verschachtelten GroupItems.
FindName: StringIEnumerable<FieldList>Findet alle verschachtelten Felder auf allen Verschachtelungsebenen mit dem angegebenen Namen.
FilterPredicate: (Name: String, Node: FieldList) => BooleanIEnumerable<FieldList>Findet alle verschachtelten Felder auf allen Verschachtelungsebenen, die das Prädikat erfüllen.
this[]Num: IntegerGroupItemGibt das GroupItem mit verschachtelten Feldern (falls vorhanden) an der durch den Parameter num angegebenen Position zurück.
Der Sample Process enthält ein Beispiel für die Verwendung einer Variablen vom Typ FieldList[] (die Spalte Description der Tabelle LineItems wird in den Protokollmeldungen angezeigt).

​
Nächste Schritte

Schauen Sie sich den im UiPath-Connector enthaltenen Beispielprozess an oder lesen Sie die Versionshinweise.