跳轉到主要內容

​
使用註冊參數

交易與檔案註冊參數是由鍵值 string 配對組成的參數，用於提供額外的使用者資訊（例如：客戶名稱、文件類型以及檔案來源資訊）。這些參數會隨著交易本身或交易中的文件一同提交進行處理。所有 worker 都可以存取這些參數，並可在各種實際生產情境中使用，例如：
  • 使用 ABBYY Vantage 的程式，會利用終端客戶屬性為每個交易加上標記，以便彙製報表並建立自訂處理程序（例如：依客戶篩選相對方資料目錄）。
  • Scanning Station 用戶端（或其他處理作業來源）可以傳送文件批次的註冊參數（例如外部關聯 ID）。
可以使用 Vantage API 設定註冊參數：
  1. 在建立空的交易時，或使用 launch 方法初始化交易時。為此，請對 transactions 資源送出 POST 要求，如下例所示：
或 在要求本文中指定註冊參數，並執行以下指令：
  1. 在將檔案上傳到處理作業或文件時。為此，請對 transactions/<transaction-id>/files 資源送出 POST 要求，如下例所示：
在要求本文中指定註冊參數，並執行以下指令：
重要！ 最多只能有 10 個鍵值對類型的參數，其中 key 參數最多可包含 128 個字元，value 參數最多可包含 256 個字元。這些參數的值一旦設定後便無法變更。
註冊參數值可以在以下位置讀取：
  • 自訂活動指令碼中
  • Output 活動中的 External Export 指令碼中
  • 商業規則中
您可以依下列方式，使用 Vantage API 取得註冊參數值：
  1. 呼叫 transactions/<transaction-id>/registrationParameters 資源的 registrationParameters 方法：
回應內容將如下所示： 
[
  {
    "key": "key1",
    "value": "value1"
  }
]
  1. 透過對 transactions/<transaction-id>/files/<file-id>/download 資源呼叫 download 方法，在上傳檔案的同時以 JSON 格式取得相關值：

​
使用技能參數

除了註冊參數之外，您還可以在建立或啟動處理作業時傳遞技能參數。技能參數是鍵值 string 配對，用來設定技能如何處理該處理作業。 技能參數可以在建立處理作業時設定，或是在使用 launch 方法時設定：
重要！ 每個處理作業最多可以有 10 個技能參數。
您可以透過呼叫 skillParameters 方法，使用 Vantage API 來擷取技能參數值： 回應內容會如下所示： 
[
  {
    "key": "parameterName",
    "value": "parameterValue",
    "type": "string"
  }
]