> ## 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.

# Structure du fichier de paramètres d’enregistrement

> Référence du fichier JSON de paramètres d’enregistrement : structure UTF-8 requise, champs tels que name, isRequired, isHidden, type et listValues, avec un exemple.

Cette référence décrit le fichier JSON qui définit les paramètres d’enregistrement pour le client mobile FlexiCapture.

<div id="file-contents">
  ## Contenu du fichier
</div>

Le fichier doit être encodé en UTF-8 et contenir les éléments suivants :

* Les paramètres d’enregistrement des documents, pour les Document Definitions utilisées dans le projet
* Les paramètres d’enregistrement des lots, pour les types de lots utilisés dans le projet
* Les paramètres d’enregistrement des documents non identifiés, issus des types de lots

<Note>
  Les listes de paramètres d’enregistrement des documents non identifiés permettent aux opérateurs de saisir des paramètres sans préciser le type de document.
</Note>

<Warning>
  Assurez-vous que les noms des Document Definitions et des types de lots correspondent à ceux utilisés dans le projet FlexiCapture.
</Warning>

<div id="parameter-fields">
  ## Champs des paramètres
</div>

Décrivez chaque paramètre d’enregistrement à l’aide des champs suivants :

| Champ        | Description                                                                                                                                                                  | Valeurs possibles                                             |         |
| ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- | ------- |
| `name`       | Nom du paramètre affiché dans l’interface du client mobile. Il identifie le paramètre et doit être unique au sein du groupe de paramètres d’un lot ou d’un type de document. | Texte libre                                                   |         |
| `isRequired` | Indique que le paramètre est obligatoire. Si ce champ est absent, le paramètre est facultatif. Les paramètres obligatoires sont vérifiés avant l’envoi.                      | `true`                                                        | `false` |
| `isHidden`   | Les paramètres masqués ne sont pas affichés sur l’appareil. Les paramètres renseignés automatiquement peuvent être masqués.                                                  | `true`                                                        | `false` |
| `type`       | Indique comment le paramètre est renseigné sur l’appareil. Ce champ est obligatoire. Voir [Types de paramètres](#parameter-types).                                           | Un type de paramètre                                          |         |
| `listValues` | Valeurs d’un paramètre de type `list`. Ne peut pas être utilisé avec d’autres types.                                                                                         | Les valeurs affichées dans la liste déroulante sur l’appareil |         |

Pour un paramètre `list` non obligatoire, une valeur vide apparaît en haut de la liste et est sélectionnée par défaut. Pour un paramètre `list` obligatoire, il n’y a pas de valeur vide par défaut et la première valeur est sélectionnée à la place, de sorte que le champ n’est pas surligné en rouge sur l’appareil. Vous pouvez ajouter manuellement une valeur vide à la liste (`""`).

<div id="parameter-types">
  ### Types de paramètres
</div>

Le champ `type` accepte les valeurs suivantes :

| Type           | Comment la valeur est renseignée                        |
| -------------- | ------------------------------------------------------- |
| `text`         | Saisie au clavier ou par commande vocale                |
| `list`         | Sélectionnée dans un menu déroulant                     |
| `autoGeo`      | Renseignée automatiquement avec les coordonnées GPS     |
| `autoDate`     | Renseignée automatiquement avec la date du jour         |
| `autoDeviceId` | Renseignée automatiquement avec l’ID de l’appareil      |
| `autoName`     | Renseignée automatiquement avec le login de l’opérateur |

<div id="example-file">
  ## Fichier d’exemple
</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"
        }
      ]
    }
  ]
}
```