Tag 050 - Check Boxes

Simplify supports a Check Boxes Message. The Request displays a screen with check boxes, up to three lines of text (Title fields). and an optional row of up to four virtual buttons on the bottom of the screen. A maximum of 11 check boxes are supported (if necessary, with scrolling). The customer can select one or more check boxes and/or one virtual button. A field in the Request (Required) determines whether the Enter key or a virtual button is accepted when no check box is selected.

Title fields should be used in order, starting with Title1. If this is insufficient, Title2 should be used for the additional text, and if necessary Title3.

A virtual button will only be displayed/active if data is entered in the descriptor field (ButtonNDesc) for the button (N = E through H, from left to right). The field separator for each button descriptor must be present even if the field is null. Note that pressing the Enter key is not required after pressing a virtual button.

With the exception of the Tag value, the format of this request is identical to that for Tag 040.

The following details are device-specific:

MX 915 – The maximum length of each check box descriptor (Choice field) is 45. The maximum length of each Title field is 38. The maximum length of each virtual button descriptor is 9. The maximum number of check boxes displayed on the screen is 10 if only Title1 is used and there are no virtual buttons. This maximum is reduced to 9 if Title2 is used and to 8 if all three Title fields are used. This maximum is reduced by 2 if any virtual buttons are present.

MX 925 – The maximum length of each check box descriptor (Choice field) is 47. The maximum length of each Title field is 40. The maximum length of each virtual button descriptor is 12. If there are no virtual buttons, the maximum number of check boxes displayed on the screen is 9. If any virtual buttons are present, this maximum is reduced to 8.

One field in the Check Boxes Response (ActionButton) will indicate whether Enter, Cancel or a virtual button was pressed. Another field (Data) indicates the check box(es) selected by the customer (if any). Note that the four virtual button positions on the bottom of the screen return values of 5, 6, 7 and 8 (from left to right) in the Response.

Check Boxes Message Format

Request

Field 5001

Field Name Length Description
TTT 3 Tag (always = 040)
LLL 3 Length of the following data
Required 1 Data is required when ENTER or a virtual button is pressed (0=No, 1=Yes)
Title1 0-38 (MX915)
0-40 (MX925)
Title 1
FS 1 Field separator (Hex 1C)
Title2 0-38 (MX915)
0-40 (MX925)
Title 2
FS 1 Field separator (Hex 1C)
Title3 0-38 (MX915)
0-40 (MX925)
Title 3
FS 1 Field separator (Hex 1C)
ButtonEDesc 0-8 Descriptor for first button position (from left) on bottom
FS 1 Field separator (Hex 1C)
ButtonFDesc 0-8 Descriptor/field separator for second button position on bottom
FS 1
ButtonGDesc 0-8 Descriptor/field separator for third button position on bottom
FS 1
ButtonHDesc 0-8 Descriptor/field separator for fourth button position on bottom
FS 1
Choice1 0-45 (MX915)
0-47 (MX925)
Choice 1
Field separator (Hex 1C)
FS 1
Choice2 0-45 (MX915)
0-47 (MX925)
radio button text/field separator for Choice 2
FS 1
Choice3 0-45 (MX915)
0-47 (MX925)
radio button text/field separator for Choice 3
FS 1
Choice4 0-45 (MX915)
0-47 (MX925)
radio button text/field separator for Choice 4
FS 1
Choice5 0-45 (MX915)
0-47 (MX925)
radio button text/field separator for Choice 5
FS 1
ChoiceMax 0-45 (MX915)
0-47 (MX925)
radio button text for last Choice.
See above for Max no greater than 11.

Response

Field 5001

Field Name Length Description
TTT 3 Tag (always = 050)
LLL 3 Length of the following data
ActionButton 3 If field 11 Completion Code = 000 (success), returns code for key pressed by customer:
5=Button E
6=Button F
7=Button G
8=Button H
777=Enter (green) key
888=Cancel (red) key
FS 1 Field separator (Hex 1C)
Data var If ActionButton = 777 (Enter), returns selected check boxes (if any).
Each check box is represented as either 0 (not selected) or 1 (selected).

Sample Check Boxes Message

Request

The following request tells Simplify to display the screen shown below.

API Field #, Value Description
0001,36 Transaction Type
0011,14125050000 User Data
5001,[see value below] Non-Financial Data
    050=Tag
    131=Length of data
    1= Data required when ENTER pressed
    Selection one or more of the following=Title1
    Button [null]=Descriptor for virtual button position E (etc.)
    Choice 1=Descriptor for check box 1 (etc.)

5001,0501311FSSelect one or more of the followingFSFSFSFSFSFSButtonHFSChoice 1FSChoice 2FSChoice 3FSChoice 4FSChoice 5FSChoice 6FSChoice 7FSChoice 8FSChoice 9

Response

API Field #, Value Description
0001,36 Transaction Type
0011,14125050000?V142.18.65_2.18.1 User Data
5001,050015777FS11001000000 Non-Financial Data
    050=Tag
    015=Length of data
    777=Enter key pressed
    11001000000=Check boxes 1, 2 and 5 selected