Saltar al contenido principal
Los parámetros de registro de transacciones y archivos son pares clave‑valor de tipo cadena diseñados para proporcionar información adicional del usuario (por ejemplo, nombre del cliente, tipo de documento e información sobre el origen del archivo). Se envían para su procesamiento junto con la transacción o con los documentos de la transacción. Estos parámetros están disponibles para todos los workers y pueden utilizarse en diversos escenarios de producción:
  • Un programa que utiliza ABBYY Vantage marca cada transacción con un atributo del cliente final con el fin de compilar informes y crear procedimientos de procesamiento personalizados (p. ej., filtrado de catálogos de datos de contrapartes por cliente).
  • Un cliente de Scanning Station (o un origen distinto para las transacciones) puede pasar los parámetros de registro de un lote de documentos (como un ID de correlación externo).
Los parámetros de registro pueden configurarse mediante la Vantage API:
  1. Al crear una transacción vacía o al inicializar una transacción mediante el método launch. Para ello, envíe una solicitud POST al recurso transactions, como en el ejemplo siguiente:
POST https://su-servidor/api/publicapi/v1/transacciones
o 
POST https://tu-servidor/api/publicapi/v1/transactions/launch?skillId=id-de-skill
En el cuerpo de la solicitud, especifique los parámetros de registro y ejecute el siguiente comando: Para 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"
     }
   ]
En 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. Al cargar archivos en una transacción o en un Document. Para ello, envíe una solicitud POST al recurso transactions/<transaction-id>/files, como en el ejemplo siguiente:
POST https://su-servidor/api/publicapi/v1/transactions/id-de-transaccion/files
En el cuerpo de la solicitud, especifique los parámetros de registro y ejecute el siguiente comando: Para 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"
En 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! Puede haber como máximo 10 parámetros de tipo clave-valor; el parámetro de clave puede contener hasta 128 caracteres y el parámetro de valor hasta 256 caracteres. Los valores de estos parámetros no se pueden cambiar una vez establecidos.
Los valores de los parámetros de registro se pueden leer:
  • en scripts de Custom activity,
  • en scripts de External Export en la actividad Output,
  • en reglas de negocio.
Puede obtener los valores de los parámetros de registro usando la Vantage API de la siguiente manera:
  1. Llamando al método registrationParameters para el recurso transactions/<transaction-id>/registrationParameters:
GET https://your-server/api/publicapi/v1/transactions/transaction-id/registrationParameters/
La respuesta tendrá el siguiente formato: 
[
  {
    "key": "key1",
    "value": "value1"
  }
]
  1. Mediante una llamada al método download del recurso transactions/<transaction-id>/files/<file-id>/download para obtener los valores en formato JSON junto con el archivo que se carga:
GET https://tu-servidor/api/publicapi/v1/transactions/transaction-id/files/file-id/download