Zum Hauptinhalt springen
Vorgangs- und Dateiregistrierungsparameter sind Parameter aus Schlüssel-Wert-Paaren des Typs string, die dazu dienen, zusätzliche Benutzerinformationen bereitzustellen (zum Beispiel Kundenname, Dokumenttyp und Informationen zur Dateiquelle). Sie werden zur Verarbeitung zusammen mit dem Vorgang oder den zugehörigen Vorgangsdokumenten übergeben. Diese Parameter stehen allen Workern zur Verfügung und können in verschiedenen produktiven Szenarien verwendet werden:
  • Ein Programm, das ABBYY Vantage verwendet, kennzeichnet jeden Vorgang mit einem Endkundenattribut, um Berichte zu erstellen und benutzerdefinierte Verarbeitungsabläufe zu ermöglichen (z. B. das Filtern von Datenkatalogen zu Gegenparteien nach Kunde).
  • Ein Scanning-Station-Client (oder eine andere Quelle für Vorgänge) kann die Registrierungsparameter eines Dokumentstapels übergeben (z. B. eine externe Korrelations-ID).
Registrierungsparameter können mithilfe der Vantage-API festgelegt werden:
  1. Beim Erstellen eines leeren Vorgangs oder beim Initialisieren eines Vorgangs mit der Methode launch. Senden Sie dazu eine POST-Anfrage an die Ressource transactions, wie im folgenden Beispiel:
POST https://ihr-server/api/publicapi/v1/transactions
oder 
POST https://your-server/api/publicapi/v1/transactions/launch?skillId=skill-id
Geben Sie im Anforderungstext die Registrierungsparameter an und führen Sie den folgenden Befehl aus: Für Windows: 
curl -X POST "https://your-server/api/publicapi/v1/transactions" \
-H "Authorization: Bearer token" \
-H "Content-Type: application/json" \
-d "{\"skillId\":\"123\"}" \
   "registrationParameters": [
     {
       "key": "key1",
       "value": "value1"
     }
   ]
Für Linux: 
curl -X POST 'https://your-server/api/publicapi/v1/transactions' \
-H 'Authorization: Bearer token' \
-H 'Content-Type: application/json' \
-d '{"skillId":"123"}' \
   'registrationParameters': [
     {
       'key': 'key1',
       'value': 'value1'
     }
   ]
  1. Beim Hochladen von Dateien zu einem Vorgang oder einem Document. Senden Sie dazu eine POST-Anfrage an die Ressource transactions/<transaction-id>/files, wie im folgenden Beispiel:
POST https://ihr-server/api/publicapi/v1/transactions/transaction-id/files
Geben Sie im Request-Body die Registrierungsparameter an und führen Sie den folgenden Befehl aus: Für Windows: 
curl -X POST "https://your-server/api/publicapi/v1/transactions/transaction-id/files" \
-H "accept: */*" \
-H "Authorization: Bearer token" \
-H "Content-Type: multipart/form-data" \
-F "Model={
   \"files\": [
     {
       \"index\": 0,
       \"imageProcessingOptions\": {
         \"autoCrop\": \"Default\",
         \"autoOrientation\": \"Default\"
       },
       \"registrationParameters\": [
         {
           \"key\": \"key1\",
           \"value\": \"value1\"
         }
       ]
     }
   ]
}" \
-F "Files=@testImage.tif;type=image/tiff"
Unter Linux: 
curl -X POST 'https://your-server/api/publicapi/v1/transactions/transaction-id/files' \
-H 'accept: */*' \
-H 'Authorization: Bearer token' \
-H 'Content-Type: multipart/form-data' \
-F 'Model={
   "files": [
     {
       "index": 0,
       "imageProcessingOptions": {
         "autoCrop": "Default",
         "autoOrientation": "Default"
       },
       "registrationParameters": [
         {
           "key": "key1",
           "value": "value1"
         }
       ]
     }
   ]
}' \
-F 'Files=@testImage.tif;type=image/tiff'
Wichtig! Es sind maximal 10 Parameter vom Typ Schlüssel-Wert zulässig, wobei der Schlüssel-Parameter bis zu 128 Zeichen und der Wert-Parameter bis zu 256 Zeichen enthalten kann. Die Werte dieser Parameter können nach dem Festlegen nicht mehr geändert werden.
Registrierungsparameterwerte können ausgelesen werden:
  • in Skripten für Custom Activities,
  • in External-Export-Skripten in der Output Activity,
  • in Geschäftsregeln.
Sie können Registrierungsparameterwerte mithilfe der Vantage-API wie folgt abrufen:
  1. Durch Aufruf der Methode registrationParameters für die Ressource transactions/<transaction-id>/registrationParameters:
GET https://your-server/api/publicapi/v1/transactions/transaction-id/registrationParameters/
Die Antwort sieht folgendermaßen aus: 
[
  {
    "key": "key1",
    "value": "value1"
  }
]
  1. Durch Aufruf der Methode download für die Ressource transactions/<transaction-id>/files/<file-id>/download, um die Werte im JSON-Format zusammen mit der hochgeladenen Datei zu erhalten:
GET https://Ihrer-Server/api/publicapi/v1/transactions/transaction-id/files/file-id/download