Zum Hauptinhalt springen

​
Die Datei mit den Registrierungsparametern muss in UTF-8 kodiert sein und die folgenden Informationen enthalten:

• Die Liste der Registrierungsparameter des Dokuments für die im Projekt verwendeten Dokumentdefinitionen • Die Liste der Registrierungsparameter des Batches für die im Projekt verwendeten Batch-Typen • Die Liste der Registrierungsparameter für nicht identifizierte Dokumente aus den Batch-Typen
Listen mit Registrierungsparametern für nicht identifizierte Dokumente werden verwendet, wenn Operatoren Parameter eingeben sollen, ohne ihren Typ anzugeben.
Stellen Sie sicher, dass die Namen der Dokumentdefinitionen und der Batch-Typen mit den im FlexiCapture-Projekt verwendeten Namen übereinstimmen.

​
Jeder Registrierungsparameter kann mit den folgenden Feldern beschrieben werden:

”name” : ""

Der Name des Parameters, der in der Benutzeroberfläche des mobilen Clients angezeigt wird.

Wichtig! Der Name identifiziert den Parameter. Er sollte innerhalb einer Parametergruppe für einen Batch oder Dokumenttyp eindeutig sein.

Beliebiger Text

”isRequired” :

Erforderliche Parameter. Wenn das Feld fehlt, ist der Parameter nicht erforderlich.

Hinweis: Erforderliche Parameter 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” : ""

Die Art der Parametereingabe auf einem Mobilgerät.

Wichtig! Die Art der Parametereingabe muss angegeben werden.

  • text - dieser Wert wird über die Tastatur oder mithilfe der Spracheingabe eingegeben
  • list - dieser Wert wird aus einer Dropdown-Liste ausgewählt
  • autoGeo - dieser Wert wird automatisch mit GPS-Koordinaten gefüllt
  • autoDate - dieser Wert wird automatisch mit dem aktuellen Datum gefüllt
  • autoDeviceId - dieser Wert wird automatisch mit der Geräte-ID gefüllt
  • autoName - dieser Wert wird automatisch mit dem Login des Operators gefüllt

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

Die Werteliste für Parameter vom Typ list.

Hinweis: Dieses Feld kann nicht mit anderen Typen verwendet werden.

Die Liste der Werte, die auf einem Mobilgerät in einer Dropdown-Liste angezeigt werden.

Hinweis: Wenn ein Parameter nicht erforderlich ist, steht oben in der Liste ein leerer Wert, der standardmäßig ausgewählt ist. Wenn ein Parameter erforderlich ist, gibt es standardmäßig keinen leeren Wert, und der erste Wert ist standardmäßig ausgewählt. Für einen erforderlichen Parameter muss mindestens ein Wert ausgewählt werden. Deshalb wird er beim Ausfüllen auf dem Gerät nicht rot hervorgehoben. Der leere Wert kann auch manuell zur Liste hinzugefügt werden ("").

{
    "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" : ["Festzinsen", "Amortisierende variable Zinsen", "Nur-Zinsen variable Zinsen"]
                },
                {
                    "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" : ["Festzinsen", "Amortisierende variable Zinsen", "Nur-Zinsen variable Zinsen"]
                },
                {
                    "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" : ["Festzinsen", "Amortisierende variable Zinsen", "Nur-Zinsen variable Zinsen"]
                },
                {
                    "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"
                }
               
            ]
        }
    ]
}