Pular para o conteúdo principal
Parâmetros de registro de transação e de arquivo são parâmetros compostos por pares chave-valor do tipo string, projetados para fornecer informações adicionais do usuário (por exemplo, nome do cliente, tipo de documento e informações sobre a origem do arquivo). Eles são enviados para processamento junto com a transação ou com os documentos da transação. Esses parâmetros estão disponíveis para todos os workers e podem ser usados em vários cenários de produção:
  • Um programa que usa o ABBYY Vantage marca cada transação usando um atributo do cliente final para fins de geração de relatórios e criação de procedimentos de processamento personalizados (por exemplo, filtrando catálogos de dados de contrapartes por cliente).
  • Um cliente do Scanning Station (ou outra origem de transações) pode enviar os parâmetros de registro de um lote de documentos (como um ID de correlação externo).
Os parâmetros de registro podem ser definidos usando a Vantage API:
  1. Ao criar uma transação vazia ou ao inicializar uma transação usando o método launch. Para isso, envie uma solicitação POST para o recurso transactions, como no exemplo abaixo:
POST https://seu-servidor/api/publicapi/v1/transacoes
ou 
POST https://seu-servidor/api/publicapi/v1/transactions/launch?skillId=id-da-skill
No corpo da solicitação, especifique os Parameters de registro e execute o seguinte 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"
     }
   ]
No 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. Ao enviar arquivos para uma transação ou um Document. Para isso, envie uma solicitação POST para o recurso transactions/<transaction-id>/files, como no exemplo abaixo:
POST https://seu-servidor/api/publicapi/v1/transactions/id-da-transacao/files
No corpo da requisição, especifique os parâmetros de registro e execute o seguinte comando: No 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"
No 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! Pode haver no máximo 10 parâmetros do tipo chave-valor, sendo que o parâmetro de chave pode conter até 128 caracteres e o parâmetro de valor até 256 caracteres. Os valores desses parâmetros não podem ser alterados depois de definidos.
Os valores dos parâmetros de registro podem ser lidos:
  • em scripts de Custom activity,
  • em scripts de External Export na atividade Output,
  • em regras de negócio.
Você pode obter os valores dos parâmetros de registro usando a Vantage API da seguinte forma:
  1. Chamando o método registrationParameters para o recurso transactions/<transaction-id>/registrationParameters:
GET https://your-server/api/publicapi/v1/transactions/transaction-id/registrationParameters/
A resposta será similar à seguinte: 
[
  {
    "key": "key1",
    "value": "value1"
  }
]
  1. Usando a chamada de método download para o recurso transactions/<transaction-id>/files/<file-id>/download para obter os valores em formato JSON junto com o arquivo sendo carregado:
GET https://seu-servidor/api/publicapi/v1/transactions/id-da-transação/files/id-do-arquivo/download