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

# Struktur der Datei mit Registrierungsparametern

> Referenz zur JSON-Datei mit Registrierungsparametern: erforderliche UTF-8-Struktur, Felder wie name, isRequired, isHidden, type und listValues sowie ein Beispiel.

Diese Referenz beschreibt die JSON-Datei, die Registrierungsparameter für den FlexiCapture Mobile Client definiert.

<div id="file-contents">
  ## Dateiinhalt
</div>

Die Datei muss in UTF-8 codiert sein und Folgendes enthalten:

* die Registrierungsparameter von Dokumenten für die im Projekt verwendeten Dokumentdefinitionen
* die Registrierungsparameter von Batches für die im Projekt verwendeten Batch-Typen
* die Registrierungsparameter für nicht identifizierte Dokumente aus den Batch-Typen

<Note>
  Listen mit Registrierungsparametern für nicht identifizierte Dokumente ermöglichen es Operatoren, Parameter einzugeben, ohne den Dokumenttyp anzugeben.
</Note>

<Warning>
  Stellen Sie sicher, dass die Namen der Dokumentdefinitionen und Batch-Typen mit den im FlexiCapture-Projekt verwendeten Namen übereinstimmen.
</Warning>

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

Beschreiben Sie jeden Registrierungsparameter mithilfe der folgenden Felder:

| Feld         | Beschreibung                                                                                                                                                                                        | Mögliche Werte                                                      |         |
| ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- | ------- |
| `name`       | Name des Parameters, der in der Oberfläche des mobilen Clients angezeigt wird. Er identifiziert den Parameter und muss innerhalb der Parametergruppe eines Batchs oder Dokumenttyps eindeutig sein. | Beliebiger Text                                                     |         |
| `isRequired` | Kennzeichnet den Parameter als Pflichtfeld. Wenn das Feld nicht vorhanden ist, ist der Parameter optional. Pflichtparameter werden vor dem Senden geprüft.                                          | `true`                                                              | `false` |
| `isHidden`   | Ausgeblendete Parameter werden auf dem Gerät nicht angezeigt. Automatisch ausgefüllte Parameter können ausgeblendet werden.                                                                         | `true`                                                              | `false` |
| `type`       | Gibt an, wie der Parameter auf dem Gerät ausgefüllt wird. Dieses Feld ist erforderlich. Siehe [Parametertypen](#parameter-types).                                                                   | Ein Parametertyp                                                    |         |
| `listValues` | Werte für einen Parameter vom Typ `list`. Kann nicht mit anderen Typen verwendet werden.                                                                                                            | Die Werte, die in der Dropdown-Liste auf dem Gerät angezeigt werden |         |

Bei einem nicht erforderlichen `list`-Parameter erscheint oben in der Liste ein leerer Wert, der standardmäßig ausgewählt ist. Bei einem erforderlichen `list`-Parameter gibt es keinen standardmäßigen leeren Wert; stattdessen wird der erste Wert ausgewählt, sodass das Feld auf dem Gerät nicht rot hervorgehoben wird. Sie können der Liste manuell einen leeren Wert hinzufügen (`""`).

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

Das Feld `type` unterstützt die folgenden Werte:

| Typ            | Wie der Wert festgelegt wird                       |
| -------------- | -------------------------------------------------- |
| `text`         | Per Tastatur oder Spracheingabe eingegeben         |
| `list`         | Aus einem Dropdown-Menü ausgewählt                 |
| `autoGeo`      | Automatisch mit GPS-Koordinaten ausgefüllt         |
| `autoDate`     | Automatisch mit dem aktuellen Datum ausgefüllt     |
| `autoDeviceId` | Automatisch mit der Geräte-ID ausgefüllt           |
| `autoName`     | Automatisch mit dem Login des Operators ausgefüllt |

<div id="example-file">
  ## Beispieldatei
</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"
        }
      ]
    }
  ]
}
```