Structure du fichier de paramètres d’enregistrement

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

Contenu du fichier

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

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.

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

Champs des paramètres

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.	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 ("").

Types de paramètres

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

Fichier d’exemple

{
  "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"
        }
      ]
    }
  ]
}

Verification Station

Invoice Operator's Guide

Mobile Client

Web Capture Station

Web Scanning Station

Web Verification Station

Web Data Verification

Monitoring Console

Web Authentication

Structure du fichier de paramètres d’enregistrement

Contenu du fichier

Champs des paramètres

Types de paramètres

Fichier d’exemple

​Contenu du fichier

​Champs des paramètres

​Types de paramètres

​Fichier d’exemple

Contenu du fichier

Champs des paramètres

Types de paramètres

Fichier d’exemple