Passer au contenu principal
Les paramètres d’enregistrement de transaction et de fichier sont des paramètres constitués de paires clé-valeur de type string, conçus pour fournir des informations supplémentaires sur l’utilisateur (par exemple le nom du client, le type de document et les informations sur la source du fichier). Ils sont transmis pour traitement avec la transaction ou les documents de la transaction. Ces paramètres sont accessibles à tous les workers et peuvent être utilisés dans divers scénarios de production :
  • Un programme qui utilise ABBYY Vantage marque chaque transaction à l’aide d’un attribut de client final afin de compiler des rapports et de créer des procédures de traitement personnalisées (p. ex. filtrer des catalogues de données de contreparties par client).
  • Un client Scanning Station (ou une autre source de transactions) peut transmettre les paramètres d’enregistrement d’un lot de documents (par exemple un ID de corrélation externe).
Les paramètres d’enregistrement peuvent être définis à l’aide de l’API Vantage :
  1. Lors de la création d’une transaction vide ou lors de l’initialisation d’une transaction à l’aide de la méthode launch. Pour ce faire, envoyez une requête POST à la ressource transactions, comme dans l’exemple ci-dessous :
POST https://votre-serveur/api/publicapi/v1/transactions
ou 
POST https://votre-serveur/api/publicapi/v1/transactions/launch?skillId=skill-id
Dans le corps de la requête, indiquez les paramètres d’enregistrement, puis exécutez la commande suivante : Pour 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"
     }
   ]
Sous 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. Lors du téléversement de fichiers dans une transaction ou un document. Pour ce faire, envoyez une requête POST à la ressource transactions/<transaction-id>/files, comme dans l’exemple ci-dessous :
POST https://votre-serveur/api/publicapi/v1/transactions/id-transaction/files
Dans le corps de la requête, indiquez les paramètres d’enregistrement et exécutez la commande suivante : Pour 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"
Sous 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'
Important ! Un maximum de 10 paramètres de type clé‑valeur est autorisé, le paramètre de clé pouvant contenir jusqu’à 128 caractères et le paramètre de valeur jusqu’à 256 caractères. Les valeurs de ces paramètres ne peuvent plus être modifiées une fois définies.
Les valeurs des paramètres d’enregistrement peuvent être lues :
  • dans les scripts d’activité personnalisée,
  • dans les scripts d’exportation externe de l’activité Output,
  • dans les règles métier.
Vous pouvez obtenir les valeurs des paramètres d’enregistrement à l’aide de l’API Vantage comme suit :
  1. En appelant la méthode registrationParameters pour la ressource transactions/<transaction-id>/registrationParameters :
GET https://your-server/api/publicapi/v1/transactions/transaction-id/registrationParameters/
La réponse sera similaire à ce qui suit : 
[
  {
    "key": "key1",
    "value": "value1"
  }
]
  1. En appelant la méthode download sur la ressource transactions/<transaction-id>/files/<file-id>/download pour obtenir les valeurs au format JSON, en plus du fichier en cours de chargement :
GET https://votre-serveur/api/publicapi/v1/transactions/transaction-id/files/file-id/download