How to Work with Screens > Adding Input Objects to a Screen > Adding an "Input Keyboard" Object to a Screen

Object Purpose

This object is used to allow the operator to manually enter data (alphanumeric values) with the keyboard. This data is stored in a user variable and can, then,be further processed or stored. See Variable Definition.

A keyboard input box can be added to a screen by dragging an "Input Keyboard" object from the top section of the "Control" tab OR the "Preview" section onto the screen.

Step-by-step

1. Drag the object onto the screen:

•	If dragged from the "Control" tab, the object will assume the default style. (See Set Default.)

•	If dragged from the "Style Preview Section", it will assume that particular style.

2. Now, double-click the selected object on the screen OR the tree view to open the "Properties" window

The "General" tab is open by default.

3. In the "Variable" option, define the variable that will store the input data by clicking and creating/selecting the appropriate variable (Global or Program variable). See To Select/Create a Variable.

4. Select a minimum and maximum number of characters, for this object, that can be input by the device operator.

5. If required, check the "Auto Valid on max. length" option.

If the "Auto Valid on max. length" option is checked, an "Enter" action is executed after the device operator inputs the maximum characters allowed for that object.

6. Select the type of input ("Text"/" Secret"/ "Numeric"/" Decimal").

Input Type

Text	The input accepts all characters.
Secret	The keyed in characters are visually replaced by ******* in the device's screen.
Numeric	The input only accepts numeric values.
Decimal	The input only accepts decimal values.

7. Enter a "default value" or click to select a variable with the intended value. See Variable Definition.

8. If required, define a "Hint Text" or click to select a variable with the intended value. See Variable Definition.

The "Hint Text" is a small text that appears inside the object. This optional feature is used as a type of device operator "instruction". In this case, with an "Input Keyboard" object, the keyboard value will override the "Hint Text" and it will not appear in the device's screen.

9. Select a "Keyboard state" from the available options ("Current"/"Alpha"/"Numeric").

10. Consider whether or not to check the following options:

"Force Upper Case"

Turns every character input by the device operator into capital letters.

"Automatic SIP (Soft keypad)"

Enables a virtual keyboard to appear in the device's screen.

11. Click the "Advanced" tab

12. If required, specify a data pattern to compare with the data input.

Maintain the default value (*) which forgoes any comparison OR set a comparison value by entering it. By checking the "Check Range" box you can be more specific. This entails entering a minimum/maximum value or clicking. and selecting a variable with the intended value. See Variable Definition.

13. A keyed in value can be checked to see if it exists in a file. Select between the"Must Be In" or the "Must Not Be In" options of the "Validation" box. This requires selecting the file to be checked. To do this, click and select the file. In the next box, enter the field name where the checking should occur.

If checking is unnecessary, maintain the default option "None".

14. If required, implement formatting rules for the data that is keyed in by the device operator.

Select between "Left"/"Right" on the "Fill On" box and afterward between "Zeroes"/Blank" in the "Fill With" box.

If these formatting rules are not required, maintain the default option "None".

15. Go to the "Layout" tab.

16. Define the object's style by selecting an option from the drop-down list or by clicking . See Editing and Creating Styles and Editing and Creating the "Input Keyboard" Style.

17. Position the keyboard's default value (defined in step 7) within the object by using the alignment buttons.

18. If required, check the "Multiline" option to enable several lines on the object so it can display all the data that is being keyed in.

19. Maintain the given values or specify the object's position/size, within the screen, by providing the "X" and "Y" coordinates as well as "Width" and "Height".

Detail of Position/Size values

20. In the "Control Settings", attribute a name to the object. This name will be displayed in the tree view.

21. Consider whether or not to check the following options:

"Enable"

Activates the object's input feature.

"Tab Stop"

Must be checked to enable a "Change Tab order". This provides the possibility to change the order (between data input objects) in which the information is keyed in by the device operator. See Detail of Change Tab Order window.

"Visible"

Controls the object's visibility on the device's screen.

22. Click the "Routing" tab. This tab enables the testing of data input received through this particular object.

If testing is unnecessary, then disregard this tab and proceed to the "Actions" tab (step 26).

23. To activate the table below, check the "Enable Test" choice.

24. Fill in the 3 columns table:

If column	Select a method of comparison ("Data Length"/"Data Value"/"Pattern").
Equal column	Set a comparison value ("Data Length">numeric value/"Data Value">numeric value/"Pattern">alphanumeric value.
Go to column	Select a target location, in case the "If Condition" is true from the drop-down or list. See Detail of a window below.

Use the editing icons to the right of the table to move the rows up and down and to delete or add more rows.

25. Select another location, in case the "If Condition" is false, in the "Otherwise Go To" box. Use the drop-down list OR click . See Detail of a window below.

Detail of a window

This window is an alternative to the drop-down list of destinations. Select a destination screen or routine within the same program as this object, in the left table. Specify the target even more by selecting from the table to the right. The available options are a consequence of your choice in the left table.

If you want to add more processes, select the <Action> option.

Finish this operation by clicking .

Use the right click in MCL-Designer's input boxes to access certain features regarding the input box's option as well as general actions such as "Copy"; "Paste"; "Search".

Ex: If you right-click the "Text Data" input box (included in a "Display Text" properties window), you are provided with the "Paste", "Search..." and "Variable Select" options.

If you right-click any other input box, it will provide other possibilities.

26. Click the "Actions" tab.

Keep in mind that there is always a default event (ex: "On Change"; "On Timer"; "On Hotkey"; etc.) attached to the object (in this case, it is an "On Change" event). If you want the event to trigger an action, you must add processes to it (ex: "Go To"; "Check File"; "Set Focus"; etc.).

27. To edit the default event, double-click the event row ("On Change") OR right-click the event row and select "Edit..." in the resulting menu. Either of these choices opens an "Edit Event" window.

28. Select from the drop-down or list:

This event, performed by the device operator, is the "trigger" that enables an action to advance the application. It cannot be modified.

Default event: "On Change" - Is triggered when the operator enters data via the "Input Keyboard" object.

Provides targets for a "Go to" action (see Working with the Branch Processes Group). After the device operator has fulfilled the "On Change" event, the workflow will proceed to the selected destination. If you want to add processes other than a "Go to", select the <Action> option.

Provides quick links for a "Go to" action ("Next Screen"; "Exit"; etc.) to be executed when the event is fulfilled.

See Detail of a window below.

Detail of a window

If you want to add more processes, select the <Action> option.

Finish this operation by clicking .

29. If required, add processes. See Adding and Editing Processes.

This object has predefined local variables (only available in event context). See Input Keyboard's Predefined Local Variables.

30. If there is no need to add more events, click to conclude the operation. If the project requires more events, proceed to step 31.

At this stage, the processes are being added to the default event (in this case, an "On Change"). The default event can, however, be ignored/overridden by adding other events (step 31).

31. Click (at the bottom of the "Actions" tab)to add an event.

32. Select one of the available events (A) for this object ("On Timer" or "On Hotkey") and edit it (B or C,D and E).

	On Timer	On HotKey
A	This event is an exception. The device operator does NOT trigger an action, it is his lack of activity, associated to a pre-determined period of time that triggers the action/process.	This event is used to attribute a keystroke function (in a virtual or hardware keyboard) to the Input Keyboard.
B	Define the objective/action to be executed once the event is triggered. Select one of the available destinations OR <Action> if you want to add other processes.	Define the objective/action to be executed once the event is triggered. Select one of the available destinations OR <Action> if you want to add other processes.
C	This alternative to B provides quick links for a "Go to" action ("Next Screen"; "Exit"; etc.) to be executed when the event is fulfilled.If you want to add other processes, select <Action>. See Detail of a window below.	This alternative to B provides quick links of a "Go to" action (ex: "Next Screen"; "Exit"; etc.) to be executed when the event is fulfilled. If you want to add other processes, select <Action>. See Detail of a window below.
D	Set the time interval, after which, the objective/action (B or C) is executed.	Select the keystroke function that the "Input Keyboard" object will represent.
E	If required,check this option to set a repetition cycle.	N/A

Detail of a window

If you want to add more processes, select the <Action> option.

Finish this operation by clicking .

It is possible to add as many of the available events as required by the project (repeat steps 31 and 32).

33. Edit the new event(s). Double-click the event row to be edited and open the "Edit Event" window.

(Repeat steps 27 and 28).

Ex: The editing of an added "On Hotkey" event.

Define which keystroke function(in a virtual or hardware keyboard) the object represents.

Define the objective/action to be executed after the event is triggered. Select one of the available destinations from the drop-down or list OR <Action> if you want to add other processes.

34. These new events can include processes. See Adding and Editing Processes.

If you have more than one event, remember to select the event row you want to add processes to.

If you use the drag-and-drop method to add processes, make sure to drop the process on the row below the intended event.

Before concluding the addition operation, check the following:

Remember that the "Enable" option (located in the "Layout" tab) must be checked so that the added actions/processes run.

If required, use the icons located on the upper right corner of the "properties" window:

Click this icon to create a new data file. It opens an "Edit New Data File" window. Go to Creating a Data File to see how to fill in the options available.

Click this icon to open a "Localization" window where you can edit the text element within that object or add translations to it. See Localization.

Click this icon to attach any relevant notes to this object. Enter your text in the resulting window. This information is displayed in the "Developer report". See Report.

35. Click in the "Actions" tab to apply the choices made.

The "Input keyboard" object has been successfully added to the screen.

If any subsequent edition of the object's properties is required, double-click the "Input Keyboard" OR select " 'Input Keyboard' Properties" (in its right-click menu) to open the properties window.

"Input Keyboard" Predefined Local Variables

This object has predefined local variables (only available in event context).

Event	On Change
Variable Name	L_Control_Name	L_Unformated_Value	L_Formated_Value
Variable ID	&0a	&1a	&2a
Description	Stores the object's name (*)	Stores keyed value	Stores formatted value (**)

* Defined in the object's "properties" window ("Layout" tab).

** According to the format rules defined in the object's "properties" window ("Advanced" tab).

Event	On Hotkey		On Timer
Variable Name	L_Object_Name	L_Keycode	L_Object_Name
Variable ID	&0a	&1a	&0a
Description	Stores the object's name (*)	Stores defined hotkey code	Stores the object's name (*)

* Defined in the object's "properties" window ("Layout" tab).