Application user interface overview

The application user interface contains elements that are implemented through user interface metadata. Other topics in the section describe how each of the user interface elements can be configured in an application.

Figure 1. Application user interface overviewA picture of the full layout of the Cúram user interface with key features annotated.
The following list describes the user interface elements with cross-references to the numbered annotations in the previous figure.
Application banner (1)

An application is defined to present a specific view of the data for a user or user role. The application banner provides the user with the context of the application they are currently accessing. The banner also include a number of application links, such as Help, Logout and Preferences, and an application search facility.

Application name (1.1)

A name is defined for an application.

Welcome message (1.2)

A welcome message is displayed.

Application menu (1.3)

The application menu forms part of the application banner, and allows for the optional addition of up to three links. You can add a link to the application help, a link to logout from the application and a link to open the user preferences dialog.

Application search (1.4)

The application search element provides a search function.

Application sections (2)

An application contains a number of sections that allow quick and easy access to some of the more common tasks and activities performed by a user.

Application tab (3)

Content in a section is displayed in a tab, and each section can open multiple tabs, where each tab represents a business object or logical grouping of information. A tab can also be described as a logical grouping of UIM pages.

Tab title bar (4)

The tab title bar contains text that identifies the current tab.

Tab actions menu (5)

The actions menu provides actions associated with the business object represent by the tab.

Tab context panel (6)

A tab contains a context panel, which contains context information associated with the data displayed in the tab. This context information is always available when working with the data on the tab.

Section shortcut panel (7)

Each section can optionally have a section shortcut panel, which is collapsed by default. When expanded the shortcut panel provides quick links to open content, in the form of UIM pages, and perform actions within the section. The content in the section shortcut panel is organized into categories of menu items. The section shortcut panel contains section shortcut categories (7.1), each of which contains quick links in the form of section shortcut menu items (7.1.1).

Content area tab navigation bar (8)

A tab comprises of one or more pages of information, represented by UIM pages. These pages can be navigated using a navigation bar, which contains navigation tabs linking to single pages or sets of pages. Where a navigation tab links to a set of pages, a page group navigation bar is displayed.

Page title (9)

A title can be defined for a whole UIM page.

Page action control (10)

An action control can be associated with a UIM page. See Action controls (19).

Refresh button (11)

An action control that refreshes the user interface content.

Print button (12)

An action control that can be used to print user interface content.

Help button (13)

An action control that displays help content in a new window.

In-page navigation tabs (14)

A page can contain several tabs of information.

Page content area (15)

The page content area displays the currently selected UIM page.

Page group navigation bar (16)

Where a tab links to a set of pages, the pages are displayed as a page group navigation bar, with the first one selected by default.

Fields (17)

Fields are visually organized into clusters and lists on a UIM page. There may be zero or more of each on a page. Clusters and lists can have a title which describes the type of data displayed.

Clusters (18)

A cluster is a rectangular area that displays fields in a tabular format. A cluster can have one or more columns of fields, and fields can be displayed with or without an associated label. Fields can be read-only, or they may be editable. If editable, they appear as a control such as a text area, drop-down menu, or check-box. The figure shows an example of two configured clusters in the page content area, each with a configured title.

Action controls (19)

Action controls, displayed as buttons, are used to submit form data, to link to related pages, or to open a modal dialog. Action controls can be organized into action sets which are associated with clusters, lists, or the UIM page (see element 10 in the figure). Individual action controls can also be associated with a single field in a cluster or a column in a list. When an action control is used to link to another page it can also send parameters to the target page which are normally used as keys to retrieve server data that populates the target page. By default action controls appear at the top and bottom of the widget they are associated with.

Smart panel (20)

The smart panel displays extra contextual information, such as quick notes that relate to a case, or advice that was given to a client.

Lists (21)

A list is used to display rows of repeating or indexed fields. As in clusters, fields can have associated labels which are displayed as column headings in the list. A list action menu (21.1) is displayed at the end of the row for each list item and contains all the actions that are associated with the list item.