Unit 3 - Lesson 3 - Application Navigation Flashcards
(32 cards)
Identify the parts of the Curam UI (Recognise the areas of the UI and the elements that can display in the application frame)
Supports the use of defined navigation hierarchies for their pages.
Application Banner and 1+ Application Sections.
Shortcuts panel
Context Panel
Tab Content Page
Application Tabs
Relate the UI configuration files to the navigation features
Application navigation is defined in configuration files - there are defined in the ‘tab’ folder.
Different types of files control each area of the page:
.app, .sec, .ssp, .tab, .nav, .mnu
Navigation files are loaded from the configuration files to the database during a build.
The files are accessed at runtime to render the page dynamically. Navigation is performed via a server call to see where the next requested page should be displayed.
Outline the features for dynamically enabling or disabling menu and navigation options
To prevent users from performing certain tasks by disabling (greying-out) or hiding particular menu actions.
You can dynamically enable or disable and hide or show entries in the following UI components:
Tab Actions Menu (.mnu)
Tab Navigation (.nav)
** Navigation bar and page group navigation bar
Configure navigation features in your application
x
Define Application Banner
Provides user with a context of the application view that they are currently accessing. Links to pages and actions that will always be available. Application view is a customised view of the application that depends on the user role.
Define Shortcuts panel
Quick set of links to tabs. Be default, shortcuts panel is minimised.
Define Applications Tabs
Typically represents a significants business object in Curam (participant or a case). Object contained in the Tab has a context of its own that does not need to be associated with another object to be understood.
May include:
* Context Panel - display summary information within the tab.
* Navigation Bar - displays navigation bar tabs and page group navigation tabs.
* Smart Panel - Display context-aware recommendations to the user and to take notes
Object contained in the tab has self explanatory context.
Large number of tabs results in buttons to allow left and right scroll.
May consist of the following 4 components:
* Tab Title Bar - tab name and close button. One tab can be an anchor tab - never closed.. Usually contains context - e.g. person name. Tab actions menu is a drop-down menu (may contain sub menus)
* Context panel - optional. Presents most important information regarding the object. Gives user context.
* Navigation bar - nav bar tabs and page group navigation tabs listed vertically.
* Smart Panel - can be used to display context-aware recommendations to the user for areas that require attention.
* Tab Content pages - UIM pages containing lists, clusters and action menus.
Rules for Configuring Application Navigation
- Values of ID attribute must match file name
- Localisable text defined in properties file
- Ensure proper namespace validation by specifying schema
What .app defines
.app - application-view.xsd - Defines application banner, referenced sections and application search. Overall structure of an application view.
.sec
What .sec defines
.sec - section.xsd - Defines the referenced tabs and section shortcut panel in a section.
.tab and optionally .ssp
Section. Collection of tabs and optional section panel. Max 5 sections allowed:
Home - Mandatory. One tab with single page as a user’s home page. Summary and quick links.
Workspace - Mandatory - majority of the user role tasks will be performed here.
Inbox - Optional and pre-defined - access the work currently allocated to user.
Calendar - Optional and pre-defined - user’s activities and schedules.
Reports - Optional - several reports relevant for the particular user.
What .ssp defines
.ssp - sections-shortcut-panel.xsd - Defines the contents of a sections shortcut panel
.uim
What .tab defines
.tab - tab.xsd - Defines a tab, including context panel and referenced navigation and actions menu.
Lists .mnu, .nav and .uim
What .nav defines
.nav - navigation.xsd - Defines the content of a tab navigation bar.
.uim
What .mnu defines
.mnu - menubar.xsd - Defines the content of a tab actions menu.
.uim
List Navigation file relationships
Appname.app > Sectionnames.sec > [tabname.tab > [Navbarname.nav and/or Menuname.mnu] and/or Panelname.ssp ] > UIM
Define Application Banner
Defined in .app, one per application.
Application view is a customised view of the application that depends on the user role. Can be divided into:
Application name, User role details, Welcome message, Application menu, Application search area (optional) with mandatory text field and search button, Application logo, Application section buttons.
App sec buttons contains links to one or more sections. Section is defined as a logical area in the curam application. At least one section must be enabled, the application sections bar for that view should not be displayed.
Supported sections are: Home, Workspace, Inbox, Calendar and Reports, names are configurable.
Configuring .app
3 UI components defined - application menu (optional), application search area (optional) and sections that will be displayed in the associated application view. 1 to 5 sections allowed, can’t be 0.
Application menu - 3 optional elements - Preference, Help, Logout
Application search - 2 attributes - default-search-page & initial-text. 2 optional elements - search-pages and further-options-link and 2 mandatory search text field and search button. User values are passed to the search page parameters - searchText and searchType.
Associating application with a User
Database username or role mapped to a specific application or .app file. Mapping defined in the users table. CT_ApplicationCode code table identified the home page for that application. Value in codetable must match the name of the .app file name used. Description field of the code table indicates the name of the UIM page for the home page.
To render home page - infrastructure looks up the associated tab for the page and associated section for the tab - hence opens page with tab and section.
Configuring .sec
default-page-id element refers to the page that will be opened when section is selected. Not to use on Home or first section of an application.
The page must be referenced within a tab so that the associated tab is always found for the section.
Hide-tab-container element indicates that there is only one tab in the section and tab bar should not be displayed.
Configuring .ssp
Shortcuts panel - optional. Associates specific shortcut panel with a section. Identified by the value of ID attribute on this element and is actually defined in another configuration file with the .ssp extension.
Rendered as accordion widget. Contains one or more shortcuts panel sections stacked vertically. Each section contains several shortcut panel items. Only those items in the currently selected section are visible.
Defined using node elements of type group & leaf. Can open page in an existing or a new tab or a modal dialog or separator.
Configuring .tab
Application tab.
Page parameters list the keys required for the details tab and any page in the navigation. Parameter names must be consistent across those pages. Infrastructure will pass this parameter between pages opened from other links.
tab-config
* page-param -
* menu - .mnu extension file reference. Optional.
* context - tab context panel, optional. If there is a context panel, page-id refers to the UIM page for the context panel. When context panel is not required, element still must be present.
* navigation - specifies ID of a .nav file which contains list of UIM pages. Even if .nav file is not needed - navigation element is still required. Instead of specifying the ID of a .nav file - it specifies the page_id for the UIM page.
* A reference to a UIM page to use as a smart panel can also be defined in the tab file.
Configuring .mnu
A menu associate with a tab. Multiple tabs can refer to the same menu.
Each submenu has a unique ID. Submenus can be texted. Lowest level sub-menu contains menu-items each with unique ID. Each menu-item refers to a UIM page.
The menu separator provides a faint grey line between menu items.
open-as=’modal’ attribute means the page opens as a pop-up - which must be closed before proceeding. menu-item can open a UIM page in the content area of a tab, open a UIM in a modal dialog, and download a file.
Describe The Context Panel
Optional component of the Tab.
Normal UIM page.
Can choose to hide or show it using the dropdown toggle.
Always available within a Tab.
Designed specifically for each object type.
* Object type represents a real-world business object (Person, Case)
* See Curam User Experience Guidelines
To identify UIM page as a context panel - PAGE element must have the attribute TYPE set to DETAILS. Name of the person displays in the TAB. This is set via TAB_NAME element. Always read-only - only DISPLAY phase SERVER_INTERFACE. No MENU, SHORTCUT_TITILE, JSP_SCRIPLET, DESCRIPTION, INFORMATIONAL, SCRIPT, INCLUDE, VIEW.
How to set Tab Name
Tab name can be defined in the context panel using TAB_NAME element.
Allows dynamic names to be constructed.
Tab title is defined using the PAGE_TITLE.
If there is no context panel - tab name and optional tab title are specified in the .tab file.
