1 of 7

<item> XML section

Each item must contain type attribute that defines a visual appearance of the form field. Available item types are:

wai_input displays an edit field:
wai_select displays a select box.
hidden does not display anything.
text does not require any user input. Its purpose is only to display CSS-styled information read from XML definition. Values of this type of item can't be set in PRX rules and are not delivered to the JCL generator.

Each of the item type requires or allows other attributes. This is described in details in the following sections.

wai_input

Required attributes:

id unique identification of the item (unique in the whole form).
type item type: 'wai_input'.
label label displayed next to the item.
size number of letters a user can enter.

Optional attributes:

help any text that should help to understand what value is required. It is displayed on the right of the item.
must set 'Y' when the value is required, 'N' otherwise.
expr predefined expression or regular expression. Predefined expressions are here for ease of use and have special meaning. Regular expressions support standard regex patterns.

Available predefined expressions are:

expr="MEMBER=[]" requires a valid member name.
expr="DSN=[]" requires a valid DSN without a member.
expr="DSNMEMBER=[]" requires a valid DSN optionally also with a member in parentheses.
expr="CUSTOM=[]" makes no validity checks when coded like this.

As you can see there are square brackets after the keyword. A test of validity of user data has two phases:

1. it checks member and/or dsn if MEMBER, DSN or DSNMEMBER is specified .

2. it also performs checks specified in square brackets. In case of member and dsn no further check is usually needed, but it is still possible. The additional check is useful primarily for CUSTOM keyword. See this example:

expr="CUSTOM=[expr='/^[a-z]+$/',maxlength=44,maxlinelength=10]"

Here are 3 additional checks (currently the only ones supported):

expr: regular expression (in this sample it allows only small letters.

maxlength: maximal number of letters entered.

Besides predefined expressions you can use standard regular expression coded in the "old style" without CUSTOM keyword: expr='/^[a-z]+$/'

The newer style for the same check is: expr="CUSTOM=[expr='/^[a-z]+$/']"

range range of allowed integer values in format from-to. For example: range="1-99"
default the default value of the item. It is used by default unless it is explicitly set by PRX rules.
disabled set 'N' if the field can't be edited. Set 'Y' if a modification is allowed.

wai_select

Required attributes:

id unique identification of the item (unique in the whole form).
type item type: 'wai_select'.
label label displayed next to the item.

Optional attributes:

help any text that should help to understand what value is required. It is displayed on the right of the item.
must set 'Y' when the value is required, 'N' otherwise.
default the default value of the item. It is used by default unless it is explicitly set by PRX rules.
disabledset 'N' if the field can't be edited. Set 'Y' if a modification is allowed.

hidden

This type of item does not render any visible field.

Required attributes:

id unique identification of the item (unique in the whole form).
type item type: 'hidden'.

Optional attributes:

default default value of the item. It is used by default unless it is explicitly set by PRX rules.

multiline

Required attributes:

id unique identification of the item (unique in the whole form).
type item type: 'multiline'.
label label displayed next to the item.
size number of letters a user can enter.
cols number of columns of the text area.
rows number of rows of the text ar ea.

Optional attributes:

help any text that should help to understand what value is required. It is displayed on the right of the item.
must set 'Y' when the value is required, 'N' otherwise.
default default value of the item. It is used by default unless it is explicitly set by PRX rules.
disabled set 'N' if the field can't be edited. Set 'Y' if a modification is allowed.

freetext

text

Required attributes:

id unique identification of the item (unique in the whole form).
typei tem type: 'multiline'.

Optional attributes:

style CSS style. In case of the blue example it is: style="color: blue;"
default value that is displayed.

wai_select

Required attributes:

id unique identification of the item (unique in the whole form).
type item type: 'wai_select'.
label label displayed next to the item.

Optional attributes:

help any text that should help to understand what value is required. It is displayed on the right of the item.
must set 'Y' when the value is required, 'N' otherwise.
options when this attribute is missing or empty the program tries to load options (values displayed in the select box) from the database. Items are loaded from FORMCONT database Table. See for more details. The items can also be specified in XML, which is preferred method when the values are constant and do not change often. Enter options separated with a semicolon and each one in Label=Value format. The Label is displayed while the Value is used. In the following example 'Yes' and 'No' is visible on the web page but 'Y' or 'N' is exported to HOSXIN dataset and stored in the database. The number of values entered in XML is unlimited. options="Yes=Y;No=N"
default the default value of the item. It is used by default unless it is explicitly set by PRX rules.
disabledset 'N' if the field can't be edited. Set 'Y' if a modification is allowed.

wai_input

Required attributes:

id unique identification of the item (unique in the whole form).
type item type: 'wai_input'.
label label displayed next to the item.
size number of letters a user can enter.

Optional attributes:

help any text that should help to understand what value is required. It is displayed on the right of the item.
must set 'Y' when the value is required, 'N' otherwise.
expr predefined expression or regular expression. Predefined expressions are here for ease of use and have special meaning. Regular expressions support standard regex patterns.

Available predefined expressions are:

expr="MEMBER=[]" requires a valid member name.
expr="DSN=[]" requires a valid DSN without a member.
expr="DSNMEMBER=[]" requires a valid DSN optionally also with a member in parentheses.
expr="CUSTOM=[]" makes no validity checks when coded like this.

As you can see there are square brackets after the keyword. A test of validity of user data has two phases:

1. it checks member and/or dsn if MEMBER, DSN or DSNMEMBER is specified .

expr="CUSTOM=[expr='/^[a-z]+$/',maxlength=44,maxlinelength=10]"

Here are 3 additional checks (currently the only ones supported):

expr: regular expression (in this sample it allows only small letters.

maxlength: maximal number of letters entered.

maxlinelength: maximal length of a line (useful for and fields only).It is possible to combine any of these additional checks, you can use one, two, all three or none.

Besides predefined expressions you can use standard regular expression coded in the "old style" without CUSTOM keyword: expr='/^[a-z]+$/'

The newer style for the same check is: expr="CUSTOM=[expr='/^[a-z]+$/']"

range range of allowed integer values in format from-to. For example: range="1-99"
default the default value of the item. It is used by default unless it is explicitly set by PRX rules.
disabled set 'N' if the field can't be edited. Set 'Y' if a modification is allowed.