Passer au contenu principal

Le fichier contenant les paramètres d’enregistrement doit être encodé en UTF-8 et contenir les informations suivantes :

• La liste des paramètres d’enregistrement du document pour les Définitions de document utilisées dans le projet • La liste des paramètres d’enregistrement du lot pour les Types de lots utilisés dans le projet • La liste des paramètres d’enregistrement pour les documents non identifiés des Types de lots
Les listes de paramètres d’enregistrement pour les documents non identifiés sont utilisées si vous souhaitez que les Opérateurs saisissent des paramètres sans en préciser le type.
Assurez-vous que les noms des Définitions de document et des Types de lots correspondent aux noms utilisés dans le projet FlexiCapture.

Chaque paramètre d’enregistrement peut être décrit à l’aide des champs ci-dessous :

”name” : ""

Nom du paramètre affiché dans l’interface utilisateur du client mobile.

Important ! Le nom identifie le paramètre. Il doit être unique au sein d’un groupe de paramètres pour un lot ou un type de document.

Texte libre

”isRequired” :

Indique si le paramètre est obligatoire. Si le champ est absent, le paramètre n’est pas obligatoire.

Remarque : 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” : ""

Le type de saisie du paramètre sur un appareil mobile.

Important ! Il est obligatoire de spécifier le type de saisie du paramètre.

  • text - cette valeur est saisie au clavier ou à l’aide d’une fonctionnalité de saisie vocale
  • list - cette valeur est sélectionnée dans une liste déroulante
  • autoGeo - cette valeur est automatiquement renseignée avec les coordonnées GPS
  • autoDate - cette valeur est automatiquement renseignée avec la date du jour
  • autoDeviceId - cette valeur est automatiquement renseignée avec l’ID de l’appareil
  • autoName - cette valeur est automatiquement renseignée avec l’identifiant de l’Operator

”listValues” : ["", "", …]

Liste des valeurs pour les paramètres de type list.

Remarque : Ce champ ne peut pas être utilisé avec d’autres types.

Liste des valeurs affichées dans une liste déroulante sur un appareil mobile.

Remarque : Si un paramètre n’est pas obligatoire, une valeur vide est placée en tête de liste et sélectionnée par défaut. Si un paramètre est obligatoire, aucune valeur vide n’est définie par défaut et la première valeur est sélectionnée par défaut. Au moins une valeur doit être sélectionnée pour un paramètre obligatoire. C’est pourquoi il n’est pas surligné en rouge lors de la saisie sur l’appareil. La valeur vide peut également être ajoutée manuellement à la liste ("").

{
    "batchTypesInfo" : [
        {
            "batchTypeName" : "",
             "batchTypeRegParams" : [
                
            ],
            "unidentifiedDocDefinition" : [
            ]
        },
        {
            "batchTypeName" : "Hypothèque",
             "batchTypeRegParams" : [
                {
                    "name" : "Valeur de la propriété ($)",
                    "type" : "text"
                },
                {
                    "name" : "Montant du prêt ($)",
                    "isRequired" : true,
                    "type" : "text"
                },
                {
                    "name" : "Preferred rate type",
                    "type" : "list",
                    "listValues" : ["Fixed rates", "Amortized adjustable rates", "Interest-only adjustable rates"]
                },
                {
                    "name" : "Agent immobilier",
                    "isHidden" : false,
                    "type" : "autoname"
                },
                
                {
                    "name" : "Identifiant de l'appareil",
                    "type" : "autodeviceid"
                },
                {
                    "name" : "Emplacement",
                    "type" : "autogeo"
                },
                {
                    "name" : "Date",
                    "type" : "autodate"
                }              
            ]
                    },
                   {
               "batchTypeName" : "Documents justificatifs hypothécaires",
             "batchTypeRegParams" : [
                {
                    "name" : "Valeur de la propriété ($)",
                    "type" : "text"
                },
                {
                    "name" : "Montant du prêt ($)",
                    "isRequired" : true,
                    "type" : "text"
                },
                {
                    "name" : "Preferred rate type",
                    "type" : "list",
                    "listValues" : ["Fixed rates", "Amortized adjustable rates", "Interest-only adjustable rates"]
                },
                {
                    "name" : "Agent immobilier",
                    "isHidden" : false,
                    "type" : "autoname"
                },
                
                {
                    "name" : "Identifiant de l'appareil",
                    "type" : "autodeviceid"
                },
                {
                    "name" : "Emplacement",
                    "type" : "autogeo"
                },
                {
                    "name" : "Date",
                    "type" : "autodate"
                }              
            ],
            "unidentifiedDocDefinition" : [
               {
                    "name" : "Agent immobilier",
                    "isHidden" : false,
                    "type" : "autoname"
                },
                
                {
                    "name" : "Identifiant de l'appareil",
                    "type" : "autodeviceid"
                },
                {
                    "name" : "Emplacement",
                    "type" : "autogeo"
                },
                {
                    "name" : "Date",
                    "type" : "autodate"
                }       
            ]
        }
    ],
    "DocDefinitionsInfo" : [
        {
            "DocDefinitionName" : "Passeport américain",
            "DocDefinitionRegParams" : [
                {
                    "name" : "Valeur de la propriété ($)",
                    "type" : "text"
                },
                {
                    "name" : "Montant du prêt ($)",
                    "isRequired" : true,
                    "type" : "text"
                },
                {
                    "name" : "Preferred rate type",
                    "type" : "list",
                    "listValues" : ["Fixed rates", "Amortized adjustable rates", "Interest-only adjustable rates"]
                },
                {
                    "name" : "Agent immobilier",
                    "isHidden" : false,
                    "type" : "autoname"
                },
                
                {
                    "name" : "Identifiant de l'appareil",
                    "type" : "autodeviceid"
                },
                {
                    "name" : "Emplacement",
                    "type" : "autogeo"
                },
                {
                    "name" : "Date",
                    "type" : "autodate"
                }   
               
            ]
                   },
                   {
                   "DocDefinitionName" : "Formulaire W-2",
            "DocDefinitionRegParams" : [
                
                              {
                    "name" : "Salaire total",
                    "type" : "text"
                }
               
            ]
        }
    ]
}