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

​
登録パラメーターを含むファイルは UTF-8 でエンコードし、次の情報を含める必要があります。

• プロジェクトで使用される Document Definitions に対応する、ドキュメントの登録パラメーターのリスト • プロジェクトで使用されるバッチタイプに対応する、バッチの登録パラメーターのリスト • バッチタイプの未識別ドキュメント用の登録パラメーターのリスト
未識別ドキュメント用の登録パラメーターのリストは、オペレーターが型を指定せずにパラメーターを入力できるようにする場合に使用します。
Document Definitions の名前とバッチタイプの名前が、FlexiCapture プロジェクトで使用されている名前と一致していることを確認してください。

​
各登録パラメーターは、以下のフィールドで記述できます。

”name” : ""

モバイルクライアントのユーザーインターフェースに表示されるパラメーター名です。

重要！ 名前はパラメーターを識別します。バッチまたは文書タイプのパラメーターグループ内で一意である必要があります。

任意のテキスト

”isRequired” :

パラメーターを必須にします。このフィールドがない場合、パラメーターは必須ではありません。

注: 必須パラメーターは送信前にチェックされます。

true | false

”isHidden” :

非表示のパラメーターはデバイスに表示されません。自動入力されるパラメーターは非表示にできます。

true | false

”type” : ""

モバイルデバイスでのパラメーター入力の種類です。

重要！ パラメーター入力の種類は必ず指定する必要があります。

  • text - この値はキーボードまたは音声入力機能を使って入力します
  • list - この値はドロップダウンリストから選択します
  • autoGeo - この値にはGPS座標が自動的に設定されます
  • autoDate - この値には現在の日付が自動的に設定されます
  • autoDeviceId - この値にはデバイスIDが自動的に設定されます
  • autoName - この値にはOperatorのログイン名が自動的に設定されます

”listValues” : ["", "", …]

list 型のパラメーターで使用する値のリストです。

注: このフィールドは他の型では使用できません。

モバイルデバイスのドロップダウンリストに表示される値のリストです。

注: パラメーターが必須でない場合は、リストの先頭に空の値があり、これがデフォルトで選択されます。パラメーターが必須の場合、デフォルトでは空の値は含まれず、最初の値がデフォルトで選択されるため、必須パラメーターでは少なくとも1つの値を選択する必要があります。そのため、デバイスで入力する際に赤色で強調表示されることはありません。空の値は ("") として手動でリストに追加することもできます。

{
    "batchTypesInfo" : [
        {
            "batchTypeName" : "",
             "batchTypeRegParams" : [
                
            ],
            "unidentifiedDocDefinition" : [
            ]
        },
        {
            "batchTypeName" : "住宅ローン",
             "batchTypeRegParams" : [
                {
                    "name" : "物件価値（$）",
                    "type" : "text"
                },
                {
                    "name" : "ローン金額（$）",
                    "isRequired" : true,
                    "type" : "text"
                },
                {
                    "name" : "希望金利タイプ",
                    "type" : "list",
                    "listValues" : ["固定金利", "元利均等変動金利", "利息のみ変動金利"]
                },
                {
                    "name" : "不動産業者",
                    "isHidden" : false,
                    "type" : "autoname"
                },
                
                {
                    "name" : "デバイスID",
                    "type" : "autodeviceid"
                },
                {
                    "name" : "場所",
                    "type" : "autogeo"
                },
                {
                    "name" : "日付",
                    "type" : "autodate"
                }              
            ]
                    },
                   {
               "batchTypeName" : "住宅ローン補足書類",
             "batchTypeRegParams" : [
                {
                    "name" : "物件価値（$）",
                    "type" : "text"
                },
                {
                    "name" : "ローン金額（$）",
                    "isRequired" : true,
                    "type" : "text"
                },
                {
                    "name" : "希望金利タイプ",
                    "type" : "list",
                    "listValues" : ["固定金利", "元利均等変動金利", "利息のみ変動金利"]
                },
                {
                    "name" : "不動産業者",
                    "isHidden" : false,
                    "type" : "autoname"
                },
                
                {
                    "name" : "デバイスID",
                    "type" : "autodeviceid"
                },
                {
                    "name" : "場所",
                    "type" : "autogeo"
                },
                {
                    "name" : "日付",
                    "type" : "autodate"
                }              
            ],
            "unidentifiedDocDefinition" : [
               {
                    "name" : "不動産業者",
                    "isHidden" : false,
                    "type" : "autoname"
                },
                
                {
                    "name" : "デバイスID",
                    "type" : "autodeviceid"
                },
                {
                    "name" : "場所",
                    "type" : "autogeo"
                },
                {
                    "name" : "日付",
                    "type" : "autodate"
                }       
            ]
        }
    ],
    "DocDefinitionsInfo" : [
        {
            "DocDefinitionName" : "米国パスポート",
            "DocDefinitionRegParams" : [
                {
                    "name" : "物件価値（$）",
                    "type" : "text"
                },
                {
                    "name" : "ローン金額（$）",
                    "isRequired" : true,
                    "type" : "text"
                },
                {
                    "name" : "希望金利タイプ",
                    "type" : "list",
                    "listValues" : ["固定金利", "元利均等変動金利", "利息のみ変動金利"]
                },
                {
                    "name" : "不動産業者",
                    "isHidden" : false,
                    "type" : "autoname"
                },
                
                {
                    "name" : "デバイスID",
                    "type" : "autodeviceid"
                },
                {
                    "name" : "場所",
                    "type" : "autogeo"
                },
                {
                    "name" : "日付",
                    "type" : "autodate"
                }   
               
            ]
                   },
                   {
                   "DocDefinitionName" : "W-2フォーム",
            "DocDefinitionRegParams" : [
                
                              {
                    "name" : "総賃金",
                    "type" : "text"
                }
               
            ]
        }
    ]
}