跳转到主要内容

​
使用注册参数

事务和文件注册参数是由键值字符串对组成的参数，用于提供额外的用户信息（例如客户名称、文档类型和文件来源信息）。这些参数会随事务或事务中的文档一起传递进行处理。所有 worker 都可以访问这些参数，并可在各种生产场景中使用：
  • 使用 ABBYY Vantage 的程序可以使用终端客户属性对每个事务进行标记，用于编制报表和创建自定义处理流程（例如按客户筛选交易对手数据目录）。
  • Scanning Station 客户端（或其他事务来源）可以传递文档批次的注册参数（例如外部关联 ID）。
可以使用 Vantage API 设置注册参数：
  1. 在创建空事务时，或在使用 launch 方法初始化事务时。为此，请像下面的示例一样向 transactions 资源发送 POST 请求：
或 在请求正文中指定注册参数，然后运行以下命令：
  1. 在向事务或文档上传文件时。为此，请像下面的示例一样向 transactions/<transaction-id>/files 资源发送 POST 请求：
在请求正文中指定注册参数，然后运行以下命令：
重要！ 最多可以有 10 个键值对类型参数，其中 key 参数最多可包含 128 个字符，value 参数最多可包含 256 个字符。这些参数的值一旦设置后将无法更改。
可以在以下位置读取注册参数的值：
  • 在 Custom activity 脚本中，
  • 在 Output activity 中的 External Export 脚本中，
  • 在业务规则中。
可以使用 Vantage API 按如下方式获取注册参数的值：
  1. 通过调用 transactions/<transaction-id>/registrationParameters 资源的 registrationParameters 方法：
响应将类似如下所示： 
[
  {
    "key": "key1",
    "value": "value1"
  }
]
  1. 通过调用 transactions/<transaction-id>/files/<file-id>/download 资源的 download 方法，在上传文件的同时以 JSON 格式获取相应的值：

​
使用技能参数

除了注册参数之外，在创建或启动事务时还可以传递技能参数。技能参数是由键和值组成的字符串类型键值对，用于配置技能如何处理该事务。 可以在创建事务时，或在使用 launch 方法时设置技能参数：
重要！ 每个事务最多可以包含 10 个技能参数。
可以通过调用 skillParameters 方法，使用 Vantage API 获取技能参数的值： 响应示例如下： 
[
  {
    "key": "parameterName",
    "value": "parameterValue",
    "type": "string"
  }
]