Saltar al contenido principal
Los parámetros de registro de transacción y archivo son parámetros que consisten en pares clave-valor de cadenas 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 pasan para procesamiento junto con la transacción o los documentos de la transacción. Estos parámetros están disponibles para todos los workers y se pueden utilizar en diversos escenarios de producción:
  • Un programa que utiliza ABBYY Vantage marca cada transacción con un atributo del cliente final para compilar informes y crear procedimientos de procesamiento personalizados (por ejemplo, filtrando catálogos de datos de contrapartes por cliente).
  • Un cliente de Scanning Station (u otro origen de transacciones) puede proporcionar los parámetros de registro de un lote de documentos (como un ID de correlación externo).
Los parámetros de registro se pueden configurar mediante 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 siguiente ejemplo:
POST https://your-server/api/publicapi/v1/transactions
o 
POST https://your-server/api/publicapi/v1/transactions/launch?skillId=skill-id
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"
     }
   ]
Para 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, envíe una solicitud POST al recurso transactions/<transaction-id>/files, como se muestra en el siguiente ejemplo:
POST https://your-server/api/publicapi/v1/transactions/transaction-id/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 "[email protected];type=image/tiff"
Para 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'
¡Importante! Puede haber como máximo 10 Parameters de tipo clave-valor, donde el Parameter de clave puede contener hasta 128 caracteres y el Parameter de valor, hasta 256 caracteres. Los valores de estos Parameters no se pueden modificar una vez establecidos.
Los valores de los parámetros de registro se pueden leer:
  • en scripts de actividades personalizadas,
  • en los scripts de exportación externa de la actividad Output,
  • en las reglas de negocio.
Puede obtener los valores de los parámetros de registro mediante la API de Vantage de la siguiente manera:
  1. Llamando al método registrationParameters del recurso transactions/&lt;transaction-id&gt;/registrationParameters:
GET https://your-server/api/publicapi/v1/transactions/transaction-id/registrationParameters/
La respuesta se verá de la siguiente manera: 
[
  {
    "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 está cargando:
GET https://your-server/api/publicapi/v1/transactions/transaction-id/files/file-id/download