Tag 010 - Text with Optional Buttons
The Text with Optional Buttons Message is used to display virtual buttons and / or fixed text onscreen. The screen may have button(s) on top and / or bottom plus labels (lines of text) in the middle.
If enabled, buttons will be colored as follows: any buttons displayed on the left half of the screen will be red and any buttons on the right half will be green.
A virtual button will only be displayed if data is entered in the descriptor field (ButtonNDesc) for the button. The maximum length of each button descriptor is 6 on the MX915 and 11 on the MX925. Note that pressing the Enter key is not required after pressing a virtual button.
The maximum number of labels is seven. The maximum length of each label is 45 for the MX915 and 60 for the MX925. Field separators must be sent for button and label fields as shown below, even if some of these fields are null.
The Text with Optional Buttons Response returns the button pressed by the customer. Fields in the Request (AllowEnter, AllowCancel) control whether the (hard) Enter and Cancel keys can be used.
Text with Optional Buttons Field 5001 Format
Request
| Field 5001 Subfield | Length | Description |
|---|---|---|
| TTT | 3 | Tag (always = 010) |
| LLL | 3 | Length of the following data |
| AllowEnter | 1 | Allow Enter hard key (0=Not allow, 1=Allow) |
| AllowCancel | 1 | Allow Cancel hard key (0=Not allow, 1=Allow) |
| Beeper | 1 | Sound tone (0=No, 1=Yes) |
| ButtonADesc | 0-8 | Descriptor for first button position (from left) on top (A) |
| FS | 1 | Field separator (Hex 1C) |
| ButtonBDesc | 0-8 | Descriptor for second button position on top (B) |
| FS | 1 | Field separator (Hex 1C) |
| ButtonCDesc | 0-8 | Descriptor for third button position on top (C) |
| FS | 1 | Field separator (Hex 1C) |
| ButtonDDesc | 0-8 | Descriptor for fourth button position on top (D) |
| FS | 1 | Field separator (Hex 1C) |
| ButtonEDesc | 0-8 | Descriptor for first button position (from left) on bottom (E) |
| FS | 1 | Field separator (Hex 1C) |
| ButtonFDesc | 0-8 | Descriptor for second button position on bottom (F) |
| FS | 1 | Field separator (Hex 1C) |
| ButtonGDesc | 0-8 | Descriptor for third button position on bottom (G) |
| FS | 1 | Field separator (Hex 1C) |
| ButtonHDesc | 0-8 | Descriptor for fourth button position on bottom (H) |
| FS | 1 | Field separator (Hex 1C) |
| Label1Just | 1 | Label 1 Justification (1=Left justify, 2=Center, 3=Right justify) |
| Label1Reverse | 1 | Reverse mode (not used). |
| Label1Text | 0-45 (MX915) 0-60 (MX925) | Label 1 Text |
| FS | 1 | Field separator (Hex 1C) |
| Label2Just | 1 | Start of Label 2 fields |
| Label2Reverse | 1 | |
| Label2Text | 0-45 (MX915) 0-60 (MX925) | |
| FS | 1 | |
| Label3Just | 1 | Start of Label 3 fields |
| Label3Reverse | 1 | |
| Label3Text | 0-45 (MX915) 0-60 (MX925) | |
| FS | 1 | |
| Label4Just | 1 | Start of Label 4 fields |
| Label4Reverse | 1 | |
| Label4Text | 0-45 (MX915) 0-60 (MX925) | |
| FS | 1 | |
| Label5Just | 1 | Start of Label 5 fields |
| Label5Reverse | 1 | |
| Label5Text | 0-45 (MX915) 0-60 (MX925) | |
| FS | 1 | |
| Label6Just | 1 | Start of Label 6 fields |
| Label6Reverse | 1 | |
| Label6Text | 0-45 (MX915) 0-60 (MX925) | |
| FS | 1 | |
| Label7Just | 1 | Start of Label 7 fields |
| Label7Reverse | 1 | |
| Label7Text | 0-45 (MX915) 0-60 (MX925) |
Response
| Field Name | Length | Description |
|---|---|---|
| TTT | 3 | Tag (always = 010) |
| LLL | 3 | Length of the following data |
| ActionButton | var | If field 11 Completion Code = 000 (success), returns code for action button or key pressed:
|
Sample Message (showing available formatting)
Request
The following request tells Simplify to display a screen showing different kinds of justification:
| API Field #, Value | Description |
|---|---|
| 0001,36 | Transaction Type |
| 0011,xxx.. | User Data. See Appendix F for the use of this field. |
| 5001,[see value below] | Non-Financial Data
|
5001,010211110FSFSFSFSFSFSFSButtonHFS10This line is left justifiedFS20This line is centeredFS30This line is right justifiedFS20This line is centeredFS10This line is left justifiedFS20This line is centeredFS30This line is right justified
Response
| API Field #, Value | Description |
|---|---|
| 0001,36 | Transaction Type |
| 0011,xxx.. | User Data. See Appendix F for the use of this field. |
| 5001,010003888 | Non-Financial Data
|
Sample Message (Eight Buttons)
Request
The following request tells Simplify to display a screen with four virtual buttons each on the top and bottom of the screen:
| API Field #, Value | Description |
|---|---|
| 0001,36 | Transaction Type |
| 0011,xxx.. | User Data. See Appendix F for the use of this field. |
| 5001,[see value below] | Non-Financial Data
|
5001,010213110ButtonAFSButtonBFSButtonCFSButtonDFSButtonEFSButtonFFSButtonGFSButtonHFS10Information Line 1 FS10Information Line 2 FS10Information Line 3 FS10Information Line 4 FS10Information Line 5 FS10Information Line 6 FS10Information Line 7
Response
| API Field #, Value | Description |
|---|---|
| 0001,36 | Transaction Type |
| 0011,xxx.. | User Data. See Appendix F for the use of this field. |
| 5001,0100011 | Non-Financial Data
|