Pular para o conteúdo principal

​
Usando Parâmetros de Registro

Os parâmetros de registro de transação e arquivo são parâmetros compostos por pares de 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 os documentos da transação. Esses parâmetros ficam disponíveis para todos os workers e podem ser utilizados em diversos cenários de produção:
  • Um programa que usa ABBYY Vantage identifica cada transação com um atributo de 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 fornecer os parâmetros de registro de um lote de documentos (tais 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, envie uma requisição POST para o recurso transactions, como no exemplo abaixo:
ou No corpo da solicitação, especifique os parâmetros de registro e execute o seguinte comando:
  1. Ao enviar arquivos para uma transação ou um documento, envie uma requisição POST para o recurso transactions/<transaction-id>/files, como no exemplo abaixo:
No corpo da solicitação, especifique os parâmetros de registro e execute o seguinte comando:
Importante! Pode haver no máximo 10 parâmetros do tipo chave-valor, em que o parâmetro de chave pode conter até 128 caracteres e o parâmetro de valor pode conter até 256 caracteres. Os valores desses parâmetros não podem ser alterados após serem definidos.
Os valores dos parâmetros de registro podem ser lidos:
  • em scripts de atividades personalizadas,
  • em scripts de exportação externa na atividade Output,
  • nas regras de negócio.
Você pode obter valores de parâmetros de registro usando a Vantage API da seguinte maneira:
  1. Ao chamar o método registrationParameters para o recurso transactions/<transaction-id>/registrationParameters:
A resposta será semelhante à seguinte: 
[
  {
    "key": "key1",
    "value": "value1"
  }
]
  1. Por meio de uma chamada ao método download para o recurso transactions/<transaction-id>/files/<file-id>/download para obter os valores em formato JSON, juntamente com o arquivo enviado:

​
Usando Skill Parameters

Além dos parâmetros de registro, você pode passar Skill Parameters ao criar ou iniciar transações. Skill Parameters são pares chave-valor do tipo string que definem como uma skill processa a transação. Skill Parameters podem ser definidos ao criar uma transação ou ao usar o método launch:
Importante! É possível ter no máximo 10 parâmetros de skill por transação.
Você pode obter os valores dos parâmetros de skill usando a Vantage API chamando o método skillParameters: A resposta será semelhante à seguinte: 
[
  {
    "key": "parameterName",
    "value": "parameterValue",
    "type": "string"
  }
]