> ## Documentation Index
> Fetch the complete documentation index at: https://docs.abbyy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 登録パラメーターファイルの構造

> JSON登録パラメーターファイルのリファレンス。必須のUTF-8形式の構造、name、isRequired、isHidden、type、listValues などの項目と、その例を示します。

このリファレンスでは、FlexiCapture モバイルクライアント の登録パラメーターを定義する JSON ファイルについて説明します。

<div id="file-contents">
  ## ファイルの内容
</div>

ファイルは UTF-8 でエンコードされ、次の内容を含んでいる必要があります。

* プロジェクトで使用される Document Definitions に対応する、文書の登録パラメーター
* プロジェクトで使用されるバッチタイプに対応する、バッチの登録パラメーター
* バッチタイプで使用される、未識別文書の登録パラメーター

<Note>
  未識別文書の登録パラメーターの一覧を使用すると、Operators は文書タイプを指定せずにパラメーターを入力できます。
</Note>

<Warning>
  Document Definition の名前とバッチタイプの名前が、FlexiCapture プロジェクトで使用されている名前と一致していることを確認してください。
</Warning>

<div id="parameter-fields">
  ## Parameter fields
</div>

各登録パラメーターは、次の field で説明します。

| Field        | 説明                                                                                         | 取り得る値                  |         |
| ------------ | ------------------------------------------------------------------------------------------ | ---------------------- | ------- |
| `name`       | モバイルクライアントのインターフェイスに表示されるパラメーター名です。パラメーターを識別するためのもので、バッチまたは文書タイプのパラメーターグループ内で一意である必要があります。 | 任意のテキスト                |         |
| `isRequired` | パラメーターを必須としてマークします。この field がない場合、そのパラメーターは任意になります。必須パラメーターは送信前にチェックされます。                  | `true`                 | `false` |
| `isHidden`   | 非表示のパラメーターはデバイスに表示されません。自動入力されるパラメーターは非表示にできます。                                            | `true`                 | `false` |
| `type`       | デバイス上でパラメーターをどのように入力するかを示します。この field は必須です。[Parameterの型](#parameter-types) を参照してください。     | パラメーターの型               |         |
| `listValues` | `list` 型パラメーターの値です。他の型と併用することはできません。                                                       | デバイスのドロップダウンリストに表示される値 |         |

必須ではない `list` パラメーターの場合、空の値がリストの先頭に表示され、既定で選択されます。必須の `list` パラメーターの場合、既定の空の値はなく、代わりに最初の値が選択されるため、デバイス上で field が赤く強調表示されることはありません。空の値は手動でリストに追加できます (`""`) 。

<div id="parameter-types">
  ### Parameterの型
</div>

`type` fieldでは、次の値を指定できます。

| 型              | 値の設定方法                    |
| -------------- | ------------------------- |
| `text`         | キーボードまたは音声で入力             |
| `list`         | ドロップダウンメニューから選択           |
| `autoGeo`      | GPS座標が自動的に設定されます          |
| `autoDate`     | 現在の日付が自動的に設定されます          |
| `autoDeviceId` | デバイスIDが自動的に設定されます         |
| `autoName`     | Operatorのログイン名が自動的に設定されます |

<div id="example-file">
  ## サンプルファイル
</div>

```json theme={null}
{
  "batchTypesInfo": [
    {
      "batchTypeName": "",
      "batchTypeRegParams": [],
      "unidentifiedDocDefinition": []
    },
    {
      "batchTypeName": "Mortgage",
      "batchTypeRegParams": [
        {
          "name": "Property value ($)",
          "type": "text"
        },
        {
          "name": "Loan amount ($)",
          "isRequired": true,
          "type": "text"
        },
        {
          "name": "Preferred rate type",
          "type": "list",
          "listValues": ["Fixed rates", "Amortized adjustable rates", "Interest-only adjustable rates"]
        },
        {
          "name": "Real estate agent",
          "isHidden": false,
          "type": "autoname"
        },
        {
          "name": "Device id",
          "type": "autodeviceid"
        },
        {
          "name": "Location",
          "type": "autogeo"
        },
        {
          "name": "Date",
          "type": "autodate"
        }
      ]
    },
    {
      "batchTypeName": "Mortgage Supporting Documents",
      "batchTypeRegParams": [
        {
          "name": "Property value ($)",
          "type": "text"
        },
        {
          "name": "Loan amount ($)",
          "isRequired": true,
          "type": "text"
        },
        {
          "name": "Preferred rate type",
          "type": "list",
          "listValues": ["Fixed rates", "Amortized adjustable rates", "Interest-only adjustable rates"]
        },
        {
          "name": "Real estate agent",
          "isHidden": false,
          "type": "autoname"
        },
        {
          "name": "Device id",
          "type": "autodeviceid"
        },
        {
          "name": "Location",
          "type": "autogeo"
        },
        {
          "name": "Date",
          "type": "autodate"
        }
      ],
      "unidentifiedDocDefinition": [
        {
          "name": "Real estate agent",
          "isHidden": false,
          "type": "autoname"
        },
        {
          "name": "Device id",
          "type": "autodeviceid"
        },
        {
          "name": "Location",
          "type": "autogeo"
        },
        {
          "name": "Date",
          "type": "autodate"
        }
      ]
    }
  ],
  "DocDefinitionsInfo": [
    {
      "DocDefinitionName": "US Passport",
      "DocDefinitionRegParams": [
        {
          "name": "Property value ($)",
          "type": "text"
        },
        {
          "name": "Loan amount ($)",
          "isRequired": true,
          "type": "text"
        },
        {
          "name": "Preferred rate type",
          "type": "list",
          "listValues": ["Fixed rates", "Amortized adjustable rates", "Interest-only adjustable rates"]
        },
        {
          "name": "Real estate agent",
          "isHidden": false,
          "type": "autoname"
        },
        {
          "name": "Device id",
          "type": "autodeviceid"
        },
        {
          "name": "Location",
          "type": "autogeo"
        },
        {
          "name": "Date",
          "type": "autodate"
        }
      ]
    },
    {
      "DocDefinitionName": "W-2 Form",
      "DocDefinitionRegParams": [
        {
          "name": "Total wages",
          "type": "text"
        }
      ]
    }
  ]
}
```