メインコンテンツへスキップ

​
登録パラメータの使用

トランザクションおよびファイル登録Parameterは、追加のユーザー情報（例：クライアント名、ドキュメントタイプ、ファイルソース情報）を提供するために設計された、キーと値の文字列ペアで構成されるParameterです。これらはトランザクションまたはトランザクション内のdocumentsと共に処理のために渡されます。これらのParameterはすべてのワーカーで利用可能であり、さまざまな本番環境のシナリオで使用できます：
  • ABBYY Vantage を使用するプログラムは、レポート作成やカスタム処理手順の作成（例: 顧客ごとに取引先データ カタログをフィルタリングするなど）の目的で、各トランザクションにエンドクライアント属性を付与します。
  • Scanning Station クライアント（またはトランザクションの別の送信元）は、Document バッチの登録用 Parameter（外部相関 ID など）を渡すことができます。
登録パラメータは Vantage API を使用して設定できます。
  1. 空のトランザクションを作成する場合や launch メソッドを使用してトランザクションを初期化する場合は、以下の例のように transactions リソースに POST リクエストを送信します。
or リクエストボディで登録パラメータを指定し、次のコマンドを実行します:
  1. トランザクションまたは Document にファイルをアップロードするには、以下の例のように transactions/<transaction-id>/files リソースに POST リクエストを送信します。
リクエストボディで登録パラメータを指定し、次のコマンドを実行します:
重要: key-value 型の Parameter は最大 10 個まで設定でき、key の Parameter には最大 128 文字、value の Parameter には最大 256 文字まで指定できます。これらの Parameter の値は、一度設定すると変更できません。
登録Parameterの値を読み取ることができます:
  • カスタム アクティビティ スクリプト内では、
  • Output アクティビティの External Export スクリプトで、
  • ビジネス ルール内で
Vantage APIを使用して、登録Parameterの値を次のように取得できます:
  1. transactions/<transaction-id>/registrationParameters リソースの registrationParameters メソッドを呼び出すことで：
レスポンスは以下のようになります。 
[
  {
    "key": "key1",
    "value": "value1"
  }
]
  1. transactions/<transaction-id>/files/<file-id>/download リソースに対して download メソッド呼び出しを使用し、アップロードされるファイルと共に JSON 形式で値を取得する方法:

​
Skill Parameter の使用

登録用 Parameter に加えて、トランザクションを作成または起動する際に Skill Parameter を渡すことができます。Skill Parameter は、Skill がトランザクションをどのように処理するかを設定する、キーと値からなる string 型のペアです。 Skill Parameter は、トランザクションの作成時、または launch メソッドを使用する際に設定できます。
重要！ 1つのトランザクションにつき Skill Parameter は最大 10 個までです。
Vantage API で skillParameters メソッドを呼び出すと、Skill Parameter の値を取得できます。 レスポンスは次のとおりです。 
[
  {
    "key": "parameterName",
    "value": "parameterValue",
    "type": "string"
  }
]