跳转到主要内容
事务（Transaction）和文件注册参数（Parameter）是由键值字符串对组成的参数，用于提供额外的用户信息（例如客户名称、文档类型和文件来源信息）。这些参数会随处理事务或事务文档一起传递。所有工作节点都可以访问这些参数，并可在各种生产场景中使用：
  • 使用 ABBYY Vantage 的程序会利用终端客户属性对每个处理事务进行标记，以便编制报告并创建自定义处理流程（例如按客户筛选相对方数据目录（data catalog））。
  • Scanning Station 客户端（或事务的其他来源）可以传递文档批次的注册 Parameter（例如外部关联 ID）。
可以使用 Vantage API 设置 Registration Parameter：
  1. 在创建空处理事务或使用 launch 方法初始化处理事务时，请向 transactions 资源发送一个 POST 请求，如下例所示：
POST https://your-server/api/publicapi/v1/transactions
or 
POST https://your-server/api/publicapi/v1/transactions/launch?skillId=skill-id
在请求正文中,指定注册参数并运行以下命令: 适用于 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"
     }
   ]
对于 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. 要将文件上传到处理事务或文档，请按照下面的示例向 transactions/<transaction-id>/files 资源发送 POST 请求：
POST https://your-server/api/publicapi/v1/transactions/transaction-id/files
在请求正文中,指定注册参数并运行以下命令: 适用于 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"
对于 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'
重要！ 最多可以配置 10 个键值对类型的 Parameter，其中键 Parameter 最多包含 128 个字符，值 Parameter 最多包含 256 个字符。这些 Parameter 的值一旦设置后将无法更改。
可以读取注册参数的值:
  • 在自定义活动脚本中，
  • 在 Output 活动的 External Export 脚本中，
  • 在业务规则中。
您可以按以下方式使用 Vantage API 获取注册参数值:
  1. 通过调用 transactions/<transaction-id>/registrationParameters 资源上的 registrationParameters 方法：
GET https://your-server/api/publicapi/v1/transactions/transaction-id/registrationParameters/
响应将如下所示： 
[
  {
    "key": "key1",
    "value": "value1"
  }
]
  1. 通过调用 transactions/<transaction-id>/files/<file-id>/download 资源的 download 方法，可以在上传文件的同时以 JSON 格式获取这些值：
GET https://your-server/api/publicapi/v1/transactions/transaction-id/files/file-id/download