Tag 011 - Static and Scrolling Text with Optional Buttons
The Static and Scrolling Text with Optional Buttons Message can be used to display both static (non-scrolling) and scrolling user text on the same screen, as well as optional buttons. Buttons and static text and scrolling text are placed in three screen areas, whose heights can be configured (0 = do not display). These areas are, from top to bottom:
- Button area – Up to four virtual buttons can be displayed at the top of the screen. As for Tag 010, a virtual button will only be displayed if data is entered in the request descriptor field for the button (ButtonNDesc). The vertical extent of this area is defined (as a percentage of screen height) by a request field; 20(%) is recommended. Buttons are centered in the button area. Button descriptor font size is defined by a request field (see samples below). Maximum button descriptor length is device-specific.
- Static text area – The vertical extent of this area is defined (as a percentage of screen height) by a request field. Other request fields define the font size and justification of static text.
- Scrolling text area – The vertical extent of this area is whatever is left over after the first two areas. Other request fields define the font size and justification of scrolling text.
For both text areas: See below for sample font sizes. The maximum number of characters per line depends on the font size and device. The maximum number of lines in an area depends on the height of the area, the font size, and the device.
Pressing the Enter key is not required after pressing a virtual button.
The Static and Scrolling Text with Optional Buttons Response returns the button pressed by the customer. Request fields (AllowEnter, AllowCancel) control whether the (hard) Enter and Cancel keys can be used.
Field 5001 Format
Request
note
Field separators must be sent for both button and label fields as shown below, even if some of these fields are null.
| Field 5001 Subfield | Length | Description |
|---|---|---|
| TTT | 3 | Tag (always = 011) |
| 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) |
| FS | 1 | Field separator (Hex 1C) |
| ButtonAreaHeight | 2 | Height of Button area (as % of screen height) |
| FS | 1 | Field separator (Hex 1C) |
| ButtonFontSize | 1 | Button descriptor font size (0 = extra small to 6 = extra large) |
| FS | 1 | Field separator (Hex 1C) |
| ButtonADesc | Var. | Descriptor for first button position (from left) on top (A) |
| FS | 1 | Field separator (Hex 1C) |
| ButtonBDesc | Var. | Descriptor for second button position on top (B) |
| FS | 1 | Field separator (Hex 1C) |
| ButtonCDesc | Var. | Descriptor for third button position on top (C) |
| FS | 1 | Field separator (Hex 1C) |
| ButtonDDesc | Var. | Descriptor for fourth button position on top (D) |
| FS | 1 | Field separator (Hex 1C) |
| StaticTextAreaHeight | 2 | Height of Static text area (as % of screen height) |
| FS | 1 | Field separator (Hex 1C) |
| StaticTextFontSize | 1 | Static text font size (0 = extra small to 6 = extra large) |
| FS | 1 | Field separator (Hex 1C) |
| StaticTextJust | 1 | Static text justification (1=Left; 2=Center; 3=Right) |
| FS | 1 | Field separator (Hex 1C) |
| StaticText | Var. | Static text defined in semi-colon (;) delimited lines |
| FS | 1 | Field separator (Hex 1C) |
| ScrollingTextFontSize | 1 | Scrolling text font size (0 = extra small to 6 = extra large) |
| FS | 1 | Field separator (Hex 1C) |
| ScrollingTextJust | 1 | Scrolling text justification (1=Left; 2=Center; 3=Right) |
| FS | 1 | Field separator (Hex 1C) |
| ScrollingText1 | Var. | First line of scrolling text |
| FS | 1 | Field separator (Hex 1C) |
| (etc.) | ||
| ScrollingTextLast | Var. | Last line of scrolling text |
Response
| Field 5001 Subfield | Length | Description |
|---|---|---|
| TTT | 3 | Tag (always = 011) |
| 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 (Four Buttons)
Request
The following request tells Simplify to display the screen shown below (start of scrolling text is shown):
| API Field #, Value | Description |
|---|---|
| 0001,36 | Transaction Type |
| 0011,xxx.. | User Data. See Simplify-Controlled Field Definitions. |
| 5001,[see value below] | Non-Financial Data
|
5001,011934111FS20FS3FSButton1FSButton2FSButton3FSButton4FS40FS3FS2FSText 1;Text 2;Text 3;Text 4FS2FS2FSYou agree that any Services contain proprietary content, informationFS and material that is protected by intellectual property (etc.)
Response
| API Field #, Value | Description |
|---|---|
| 0001,36 | Transaction Type |
| 0011,xxx.. | User Data. See Simplify-Controlled Field Definitions. |
| 5001,0110003777 | Non-Financial Data
|
| 5002,80378002 | Device serial number (if present) |
Sample Message (Two Buttons)
Request
The following request tells Simplify to display the screen shown below (start of scrolling text is shown):
| API Field #, Value | Description |
|---|---|
| 0001,36 | Transaction Type |
| 0011,xxx.. | User Data. See Simplify-Controlled Field Definitions. |
| 5001,[see value below] | Non-Financial Data
|
5001,011899111FS20FS2FSButton1FSFSFSButton2FS10FS2FS2FSText 1FS2FS2FSYou agree that any Services contain proprietary content, information FS and material that is protected by applicable intellectual property (etc.)
Response
| API Field #, Value | Description |
|---|---|
| 0001,36 | Transaction Type |
| 0011,xxx.. | User Data. See Simplify-Controlled Field Definitions. |
| 5001,0110003888 | Non-Financial Data
|
| 5002,80378002 | Device serial number (if present) |