abs.ussd.lib-ussd.1.0.1.source-code.ussd-app.xsd Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of lib-ussd Show documentation
Show all versions of lib-ussd Show documentation
A lightweight USSD application framework
The newest version!
Screen Type
The available screen types.
Options
Standard USSD menu with a numbered list of options.
Text Input
USSD screen that asks the user to input a text e.g bank account number.
Display
Screen that only displays a result and does not accept any input. A display screen is considered the end of
a flow and therefore terminates the user session.
Validation Constraint
The available validation constraints. If not specified, the default is "free".
Numeric Constraint
Only numeric input is permitted. The input can be of any length but it must only contain characters 0 to 9.
Alphanumeric Constraint
Any number of alphanumeric characters (a-z, A-Z and 0-9) are permitted.
Regular Expression Constraint
Input must conform to the regular expression specified as attribute "regex". If the "regex" attribute is not
specified, the validation is ignored.
Free (No Constraint)
No validation is performed.
USSD App
The user interface model.
Screen
A page of data. This can represent a list of USSD options, a page that requests for input or a page that
simply displays a message. Occurrences of %s in any of the child elements will be sequentially
interpolated with the elements of the result of the callback of the previous screen.
Header
The text at the top of the page.
Options
A list of options to be displayed (for screens with type "option").
Trigger
The user input that will trigger this option. This is usually a number and it is rendered in
the UI so the user knows what to press.
Next Screen
The screen that this option leads to.
Body
The text at the center of the page.
Footer
The text displayed at the bottom of the page.
Error Message
Identifies a screen. Other screens or menus leading to this screen reference this id.
Screen Type
The type of the screen.
Validation
The validation constraint applied to the input received by this screen (this only applies to screens
of type "textInput").
Regular Expression
The regular expression used for validating the input from a screen (this only applies to "textInput"
screens with validation "regex").
Error Message
The operation invoked when the user completes this screen. All the data and results gathered so far in
the user's session is passed along with the callback name to the callback handler for execution.
Next Screen
The screen that this screen leads to. Please note that this attribute is ignored for screens of type
"display" because they represent the end of a flow and terminate the active user session.
Name
The name of the USSD application.
Line Separator
THe line separator required by the specific telco. If not specified a tilde (~) is used by default.
Error Message
The message returned when an error occurs while invoking a callback. Such errors terminate the user session.
Maximum Response Length
The maximum length of a USSD response acceptable by the telco. If the intended response (whether a rendered
screen or an error message) is longer than the max length, it is truncated (with a trailing ellipsis
indicating the truncation). If this attribute is not specified, 140 is used by default.