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

# Estructura del archivo de parámetros de registro

> Referencia del archivo JSON de parámetros de registro: estructura obligatoria en UTF-8, campos como name, isRequired, isHidden, type y listValues, con un ejemplo.

Esta referencia describe el archivo JSON que define los parámetros de registro para el cliente móvil de FlexiCapture.

<div id="file-contents">
  ## Contenido del archivo
</div>

El archivo debe estar codificado en UTF-8 y contener lo siguiente:

* Los parámetros de registro de los documentos, para las Definiciones de Document utilizadas en el proyecto
* Los parámetros de registro de los lotes, para los tipos de lote utilizados en el proyecto
* Los parámetros de registro para documentos no identificados, de los tipos de lote

<Note>
  Las listas de parámetros de registro para documentos no identificados permiten a los operadores introducir parámetros sin especificar el tipo de documento.
</Note>

<Warning>
  Asegúrese de que los nombres de las Definiciones de Document y de los tipos de lote coincidan con los nombres utilizados en el proyecto de FlexiCapture.
</Warning>

<div id="parameter-fields">
  ## Campos de los parámetros
</div>

Describa cada parámetro de registro mediante los siguientes campos:

| Campo        | Descripción                                                                                                                                                                  | Valores posibles                                                    |         |
| ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- | ------- |
| `name`       | Nombre del parámetro que se muestra en la interfaz de cliente móvil. Identifica el parámetro y debe ser único dentro del grupo de parámetros de un lote o tipo de documento. | cualquier texto                                                     |         |
| `isRequired` | Marca el parámetro como obligatorio. Si el campo no está presente, el parámetro es opcional. Los parámetros obligatorios se validan antes del envío.                         | `true`                                                              | `false` |
| `isHidden`   | Los parámetros ocultos no se muestran en el dispositivo. Los parámetros completados automáticamente pueden ocultarse.                                                        | `true`                                                              | `false` |
| `type`       | Cómo se completa el parámetro en el dispositivo. Este campo es obligatorio. Consulte [Tipos de parámetros](#parameter-types).                                                | Un tipo de parámetro                                                |         |
| `listValues` | Valores de un parámetro de tipo `list`. No puede usarse con otros tipos.                                                                                                     | Los valores que se muestran en la lista desplegable del dispositivo |         |

En un parámetro `list` opcional, aparece un valor vacío al principio de la lista y se selecciona de forma predeterminada. En un parámetro `list` obligatorio, no hay ningún valor vacío predeterminado y se selecciona el primer valor en su lugar, por lo que el campo no se resalta en rojo en el dispositivo. Puede añadir manualmente un valor vacío a la lista (`""`).

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

El campo `type` acepta los siguientes valores:

| Tipo           | Cómo se completa el valor                             |
| -------------- | ----------------------------------------------------- |
| `text`         | Se introduce con el teclado o mediante entrada de voz |
| `list`         | Se selecciona en un menú desplegable                  |
| `autoGeo`      | Se completa automáticamente con coordenadas GPS       |
| `autoDate`     | Se completa automáticamente con la fecha actual       |
| `autoDeviceId` | Se completa automáticamente con el ID del dispositivo |
| `autoName`     | Se completa automáticamente con el login del Operador |

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