Zum Hauptinhalt springen

​
Verwendung von Registration Parameters

Transaction- und Dateiregistrierungsparameter sind Parameter, die aus Schlüssel-Wert-String-Paaren bestehen und dazu dienen, zusätzliche Benutzerinformationen bereitzustellen (z. B. Kundenname, Dokumenttyp und Informationen zur Dateiquelle). Sie werden zusammen mit der Transaction oder den Transaction-Documents zur Verarbeitung übergeben. Diese Parameter stehen allen Workern zur Verfügung und können in verschiedenen Produktionsszenarien verwendet werden:
  • Ein Programm, das ABBYY Vantage verwendet, versieht jeden Vorgang mit einem Endkundenattribut, um Berichte zu erstellen und benutzerdefinierte Verarbeitungsabläufe zu definieren (z. B. zum Filtern von Datenkatalogen von Geschäftspartnern nach Kunden).
  • Ein Scanning-Station-Client (oder eine andere Quelle für Vorgänge) kann die Registrierungsparameter eines Dokumentstapels (z. B. eine externe Korrelations-ID) übermitteln.
Registrierungsparameter können über die Vantage-API festgelegt werden:
  1. Beim Erstellen eines leeren Vorgangs oder beim Initialisieren eines Vorgangs mithilfe der Methode launch. Senden Sie dazu eine POST-Anfrage an die Ressource transactions, wie im folgenden Beispiel gezeigt:
oder Geben Sie im Anforderungstext die Registrierungsparameter an und führen Sie folgenden Befehl aus:
  1. Wenn Sie Dateien zu einem Vorgang oder einem Document hochladen, senden Sie dazu eine POST-Anfrage an die Ressource transactions/<transaction-id>/files, wie im folgenden Beispiel:
Geben Sie im Anforderungstext die Registrierungsparameter an und führen Sie folgenden Befehl aus:
Wichtig! Es können höchstens 10 Parameter vom Typ Schlüssel-Wert vorhanden sein, wobei der Schlüssel-Parameter bis zu 128 Zeichen und der Wert-Parameter bis zu 256 Zeichen haben darf. Die Werte dieser Parameter können nicht mehr geändert werden, nachdem sie festgelegt wurden.
Werte von Registrierungsparametern können gelesen werden:
  • in benutzerdefinierten Aktivitätsskripten,
  • in externen Exportskripten in der Ausgabeaktivität,
  • in Geschäftsregeln.
Sie können Registrierungsparameterwerte mithilfe der Vantage-API wie folgt abrufen:
  1. Indem Sie die Methode registrationParameters für die Ressource transactions/<transaction-id>/registrationParameters aufrufen:
Die Antwort sieht wie folgt aus: 
[
  {
    "key": "key1",
    "value": "value1"
  }
]
  1. Indem Sie die Methode download für die Ressource transactions/<transaction-id>/files/<file-id>/download aufrufen, um die Werte im JSON-Format zusammen mit der hochgeladenen Datei zu erhalten:

​
Verwenden von Skill-Parametern

Zusätzlich zu Registrierungsparametern können Sie Skill-Parameter beim Erstellen oder Starten von Vorgängen übergeben. Skill-Parameter sind Schlüssel-Wert-Paare vom Typ string, mit denen Sie festlegen, wie ein Skill den Vorgang verarbeitet. Skill-Parameter können beim Erstellen eines Vorgangs oder mithilfe der Methode launch festgelegt werden:
Wichtig! Pro Vorgang sind maximal 10 Skill-Parameter zulässig.
Sie können die Werte von Skill-Parametern mit der Vantage-API abrufen, indem Sie die Methode skillParameters aufrufen: Die Antwort sieht wie folgt aus: 
[
  {
    "key": "parameterName",
    "value": "parameterValue",
    "type": "string"
  }
]