Passer au contenu principal
Les paramètres de Transaction et d’enregistrement de fichier sont des paramètres constitués de paires clé-valeur de type string conçus pour fournir des informations utilisateur supplémentaires (par exemple, nom du client, type de document et informations sur la source du fichier). Ils sont transmis pour traitement avec la Transaction ou les documents de la Transaction. Ces paramètres sont disponibles pour tous les workers et peuvent être utilisés dans divers scénarios de production :
  • Un programme qui utilise ABBYY Vantage signe chaque transaction à l’aide d’un attribut de client final afin de générer des rapports et de définir des procédures de traitement personnalisées (par exemple pour filtrer les catalogues de données des contreparties par client).
  • Un client Scanning Station (ou une autre origine de transactions) peut transmettre les paramètres d’enregistrement d’un lot de documents (par exemple un identifiant 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 de l’initialisation d’une transaction à l’aide de la méthode launch, envoyez une requête POST à la ressource transactions comme dans l’exemple ci-dessous :
POST https://your-server/api/publicapi/v1/transactions
ou 
POST https://your-server/api/publicapi/v1/transactions/launch?skillId=skill-id
Dans le corps de la requête, spécifiez les Parameter d’enregistrement et 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"
     }
   ]
Pour 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. Lorsque vous chargez des fichiers dans une transaction ou un document, envoyez une requête POST à la ressource transactions/<transaction-id>/files, comme dans l’exemple ci-dessous :
POST https://your-server/api/publicapi/v1/transactions/transaction-id/files
Dans le corps de la requête, spécifiez les Parameter 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 "[email protected];type=image/tiff"
Pour 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 '[email protected];type=image/tiff'
Important ! Il peut y avoir au maximum 10 Parameters de type clé-valeur, le Parameter de clé pouvant contenir jusqu’à 128 caractères et le Parameter de valeur jusqu’à 256 caractères. Les valeurs de ces Parameters ne peuvent plus être modifiées une fois qu’elles ont été définies.
Les valeurs des paramètres d’enregistrement peuvent être lues :
  • dans les scripts d’activités personnalisées,
  • dans les scripts d’export 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 sur la ressource transactions/<transaction-id>/registrationParameters :
GET https://your-server/api/publicapi/v1/transactions/transaction-id/registrationParameters/
La réponse se présentera comme suit : 
[
  {
    "key": "key1",
    "value": "valeur1"
  }
]
  1. En appelant la méthode download sur la ressource transactions/<transaction-id>/files/<file-id>/download afin d’obtenir les valeurs au format JSON lors du téléversement du fichier :
GET https://your-server/api/publicapi/v1/transactions/transaction-id/files/file-id/download