Structure of a file with registration parameters

The file with registration parameters must be encoded in UTF-8 and contain the following information:

• The list of registration parameters of the document for Document Definitions used in the project

• The list of registration parameters of the batch for Batch types used in the project

• The list of registration parameters for unidentified documents from the Batch types

Note: Lists of registration parameters for unidentified documents are used if you want Operators to enter parameters without specifying their types.

Important! Make sure that names of Document Definitions and names of Batch types match the names used in the FlexiCapture project.

Each registration parameter may be described using the fields below:

Name Description Possible values
"name" : ""

The name of the parameter that displays in the user interface of the mobile client.

Important! The name identifies the parameter. It should be unique within a group of parameters for a batch or document type.

Any text
"isRequired" :

Mandatory parameters. If the field is absent, the parameter is not mandatory.

Note: Mandatory parameters are checked before sending.

true | false
"isHidden" : Hidden parameters are not displayed on a device. Automatically filled parameters may be hidden. true | false
"type" : ""

The type of parameter filling on a mobile device.

Important! It is mandatory to specify the type of parameter filling.

  • text - this value is entered from a keyboard or by means of a voice input feature
  • list - this value is selected from a drop-down menu
  • autoGeo - this value is automatically populated with GPS coordinates
  • autoDate - this value is automatically populated with the current date
  • autoDeviceId - this value is automatically populated with the device ID
  • autoName - this value is automatically populated with the Operator's login
"listValues" : ["", "", ...]

The list of values for parameters of the list type.

Note: This field cannot be used with other types.

The list of values that are displayed in a drop-down list on a mobile device.

Note: If a parameter is not mandatory, it has a blank value at the top of the list that is selected by default. If a parameter is mandatory, it has no blank value by default, and the first value is selected by default, at least one value must be selected for the mandatory parameter. That's why it is not highlighted in red when filling it from a device. The blank value may be also added to the list manually ("").

Example of a file

1/14/2021 2:17:19 PM


Please leave your feedback about this article