PAGE element
The PAGE element is the root element of a UIM document that describes the data to be included in a generated JSP page.
Attributes
The PAGE element has the following attributes:
|
Attribute Name |
Required |
Default |
Description |
||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
PAGE_ID |
Yes |
An identifier for the page used when referencing the page from LINK elements. This identifier must be unique within a project. The file name of the document must be the same as the value of this attribute and have the extension .uim. |
|||||||||||||
|
POPUP_PAGE |
No |
false |
Indicates that this page is a pop-up that will be opened from a parent page. Pop-up pages do not include the side-bar, header and footer of standard pages. The value can be set to true or false. The attribute must only be used for pages configured according to Pop-up pages (i.e., search pop-up pages). |
||||||||||||
|
SCRIPT_FILE |
No |
The name of the script file containing the JavaScript functions that are specified in the ACTION attribute of any SCRIPT elements on the page. If no SCRIPT_FILE attribute is set on a particular SCRIPT element within a FIELD or ACTION_CONTROL the PAGE script file is used by default. The script file should be added in a component. If another script file has the same name in another component, the version in the highest priority component will be used. Each SCRIPT can specify its own script file if required, or share this common script file. |
|||||||||||||
|
APPEND_COLON |
No |
Set to true to automatically append colons to FIELD and CONTAINER labels within CLUSTER elements. This overrides the value of the APPEND_COLON element in the curam-config.xml file for that individual page (see APPEND_COLON). |
|||||||||||||
|
WINDOW_OPTIONS |
No |
"width=700, height=auto-calculated" |
When the page is displayed in a modal dialog, use the parameter to configure the page. The value of the attribute is a comma-separated list of name value pairs. Width is the option that is supported. The height option is ignored, as the height is dynamically calculated. The modal content has a minimum height of 350 px. The width takes an integer value, which is converted to one of five sizes: x-small, small, default, large, and x-large. Each modal size has a responsive width that changes based on the browser size. As the browser decreases, the modal width percentage increases. This way, the modal width maintains a proper ratio between the modal and browser. Using any other parameters produces an error.
|
||||||||||||
|
TYPE |
No |
DEFAULT |
Used to define specific types of UIM pages. Two types are supported, DETAILS and SPLIT_WINDOW. SPLIT_WINDOW enables the use of frames within the page. If the attribute is not present or is set to DEFAULT then frames are not used. See Agenda Player for an example of use. DETAILS defines a UIM page that will be used as a context panel page. For more information see Context panel UIM. |
||||||||||||
|
HIDE_CONDITIONAL_LINKS |
No |
TRUE |
Set to true to hide conditional links that evaluate to false. Set to false to show a disabled conditional link that evaluate to false. This overrides the value of the HIDE_CONDITIONAL_LINKS element in the curam-config.xml file for that individual page (see APPEND_COLON). |
Child elements
The PAGE element can contain child elements as follows.
|
Element Name |
Cardinality / Description |
|---|---|
|
INCLUDE |
0..1. This element can be used before any other child element of a PAGE element. |
|
PAGE_TITLE |
0..1. This does not apply to context panel UIM pages. In this case, the PAGE_TITLE element is mandatory. See Context panel UIM for more information. |
|
DESCRIPTION |
0..1 |
|
SHORTCUT_TITLE |
0..1 |
|
SERVER_INTERFACE |
0..n. Multiple SERVER_INTERFACE elements are supported, however it is recommended that only one SERVER_INTERFACE with the PHASE attribute set to ACTION is defined per PAGE element. See SERVER_INTERFACE element for more information. |
|
INFORMATIONAL |
0..1 |
|
MENU |
0..2. The page can contain one optional static and one optional dynamic menu as well as append extra items to the navigation menu. |
|
ACTION_SET |
0..1. In this context, the action set defines the set of action controls that appear around the page's main content area. |
|
PAGE_PARAMETER |
0..n |
|
CONNECT |
0..n. In this context, the connections can copy values directly from the properties of source server interfaces to properties of the target server interfaces. Each CONNECT element should contain both a SOURCE and a TARGET element. |
|
JSP_SCRIPTLET |
0..n. JSP_SCRIPTLET, CLUSTER and LIST can be intermingled freely and the order in UIM will be preserved in the generated page. |
|
CLUSTER |
0..n. JSP_SCRIPTLET, CLUSTER and LIST can be intermingled freely and the order in UIM will be preserved in the generated page. |
|
LIST |
0..n. JSP_SCRIPTLET, CLUSTER and LIST can be intermingled freely and the order in UIM will be preserved in the generated page. |
|
SCRIPT |
0..n. A script associated with the PAGE that will be activated in response to the specified event. See SCRIPT element for more details. |
Where a page is configured to contain a large number of scrollable list and cluster elements (approximately 15), it may cause JSP compile issues in Weblogic. This is due to a Weblogic system limitation in how big a page can be rendered at run time. To overcome this restriction, arrange the display of the required scrollable lists and clusters over a number of pages.