Vai al contenuto principale
I parametri di registrazione della transaction e dei file sono parametri costituiti da coppie chiave-valore di tipo string, progettati per fornire informazioni aggiuntive sull’utente (ad esempio, nome del cliente, tipo di documento e informazioni sull’origine del file). Vengono passati per l’elaborazione insieme alla transaction o ai documents della transaction. Questi parametri sono disponibili per tutti i worker e possono essere utilizzati in vari scenari operativi:
  • Un programma che utilizza ABBYY Vantage contrassegna ogni transaction utilizzando un attributo dell’end‑client ai fini della compilazione di report e della creazione di procedure di elaborazione personalizzate (ad es. filtrando i cataloghi di dati delle controparti per cliente).
  • Un client di Scanning Station (o un’origine diversa delle transaction) può passare i parametri di registrazione di un batch di documenti (ad esempio, un ID di correlazione esterno).
I parametri di registrazione possono essere impostati utilizzando la Vantage API:
  1. Quando si crea una transaction vuota o quando si inizializza una transaction utilizzando il metodo launch. A tal fine, inviare una richiesta POST alla risorsa transactions, come nell’esempio seguente:
POST https://your-server/api/publicapi/v1/transactions
oppure 
POST https://your-server/api/publicapi/v1/transactions/launch?skillId=skill-id
Nel body della richiesta, specifica i Parameter di registrazione ed esegui il comando seguente: Per 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"
     }
   ]
Per 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. Durante il caricamento di file in una transaction o in un document. Per farlo, invia una richiesta POST alla risorsa transactions/<transaction-id>/files, come nell’esempio seguente:
POST https://your-server/api/publicapi/v1/transactions/transaction-id/files
Nel corpo della richiesta, specifica i parametri di registrazione ed esegui il seguente comando: Per 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"
Per 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'
Importante! È possibile avere al massimo 10 Parameter di tipo chiave-valore, con il Parameter della chiave che può contenere fino a 128 caratteri e il Parameter del valore che può contenere fino a 256 caratteri. I valori di questi Parameter non possono essere modificati una volta impostati.
I valori dei Parameter di registrazione possono essere letti:
  • negli script di Custom activity,
  • negli script di External Export nell’Output activity,
  • nelle regole di business.
Puoi ottenere i valori dei Parameter di registrazione utilizzando la Vantage API come segue:
  1. Chiamando il metodo registrationParameters per la risorsa transactions/<transaction-id>/registrationParameters:
GET https://your-server/api/publicapi/v1/transactions/transaction-id/registrationParameters/
La risposta sarà simile alla seguente: 
[
  {
    "key": "key1",
    "value": "value1"
  }
]
  1. Utilizzando una chiamata al metodo download alla risorsa transactions/<transaction-id>/files/<file-id>/download per ottenere i valori in formato JSON insieme al file caricato:
GET https://your-server/api/publicapi/v1/transactions/transaction-id/files/file-id/download