Interview input module

With the Interview Input module, an input field can be shown on the device display in which the user can enter a value. The value is stored in a freely definable variable that can be used in the further course of the workflow (e.g. in The Decision Module or when creating a metafile, see Creating a metafile during scanning).

The module can occur several times in the workflow.

Interview modules can be called at any point in the workflow since version 4.13.

Start module

Interview input module

The Decision Module

The module can be connected to all modules (this can result in nonsensical workflows).

No restrictive modules.

Successful: In this case, the module follows that is to be executed after successful input or selection.

Cancel: In this case, the module follows that is to be executed if the user has actively terminated the interview by pressing the Cancel button.

Time-out: In this case, the module follows that is to be executed if the input has not been completed after the time-out period specified in the module settings.

Specify whether or not an entry is required in the field. If the input is not required, the dialog on the device can be skipped without having to provide any input.

If a regular expression is specified and it requires an entry, an entry must be made even if this setting is not activated.

Specify which characters may be entered during the input:

Numeric characters: Only numbers can be entered. The dialog shows a number field for the input.

Alphanumeric characters: Any characters can be entered. The entry can be made on the device via its on-screen keyboard after pressing the input field.

Here, enter the text that is to be displayed as a note in the input field (for example, Quantity of documents). Texts that are too long are cut off. The information text disappears immediately when entry is begun.

Specify the variable name in which the value entered by the user is to be stored. For example, if you enter Quantity, you can then use the variable with %Quantity% in the rest of the workflow.

The name of the variable must not contain special characters. Allowed are small and capital letters (no umlauts or similar), numbers and the dot ".".
If the variable name is used in several places, all places can influence the variable value.

Here you can set a period of time in minutes after which the module will continue with the Time-out output if the user does not make an entry in the interview. The time runs independently of keystrokes, it is considered completed when the Continue button on the device is pressed (i.e. the user must have fully completed the input in this time).

The value 0 stands for no time-out (the time for input on the device is unlimited).

You can restrict the input with a regular expression. You can restrict the allowed characters and also the length of the input. If the input does not match the specification, the device displays the message Your input does not match the specification and the workflow cannot be continued.

A regular expression always starts with ^ and ends with $.

Examples:

Printout Meaning
^[0-9]{5}$ String must have exactly 5 digits and must only contain numbers.
^[a-z]{1,}$ String must have at least one character (length not limited) and must only contain lowercase letters.
^[a-zA-Z]{1,3}$ String must have a minimum of one and a maximum of 3 characters and may contain upper- and lowercase letters.
^[a-z][1-9]$ String must have exactly two digits and start with a lower case letter, followed by a digit between 1 and 9.

The WorkflowService knows all information about a workflow (created in the Workflow Editor). It ensures that the process is adhered to and forwards information to the subsequent modules or their services in the workflow. Its log file is Logs\WorkflowService.log.