Unit 3 - Lesson 3 - Application Navigation

Question 1

Identify the parts of the Curam UI (Recognise the areas of the UI and the elements that can display in the application frame)

Answer 1

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

Question 2

Relate the UI configuration files to the navigation features

Answer 2

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.

Question 3

Outline the features for dynamically enabling or disabling menu and navigation options

Answer 3

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

Question 4

Configure navigation features in your application

Answer 4

x

Question 5

Define Application Banner

Answer 5

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.

Question 6

Define Shortcuts panel

Answer 6

Quick set of links to tabs. Be default, shortcuts panel is minimised.

Question 7

Define Applications Tabs

Answer 7

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.

Question 8

Rules for Configuring Application Navigation

Answer 8

• Values of ID attribute must match file name
• Localisable text defined in properties file
• Ensure proper namespace validation by specifying schema

Question 9

What .app defines

Answer 9

.app - application-view.xsd - Defines application banner, referenced sections and application search. Overall structure of an application view.
.sec

Question 10

What .sec defines

Answer 10

.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.

Question 11

What .ssp defines

Answer 11

.ssp - sections-shortcut-panel.xsd - Defines the contents of a sections shortcut panel
.uim

Question 12

What .tab defines

Answer 12

.tab - tab.xsd - Defines a tab, including context panel and referenced navigation and actions menu.
Lists .mnu, .nav and .uim

Question 13

What .nav defines

Answer 13

.nav - navigation.xsd - Defines the content of a tab navigation bar.
.uim

Question 14

What .mnu defines

Answer 14

.mnu - menubar.xsd - Defines the content of a tab actions menu.
.uim

Question 15

List Navigation file relationships

Answer 15

Appname.app > Sectionnames.sec > [tabname.tab > [Navbarname.nav and/or Menuname.mnu] and/or Panelname.ssp ] > UIM

Question 16

Define Application Banner

Answer 16

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.

Question 17

Configuring .app

Answer 17

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.

Question 18

Associating application with a User

Answer 18

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.

Question 19

Configuring .sec

Answer 19

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.

Question 20

Configuring .ssp

Answer 20

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.

Question 21

Configuring .tab

Answer 21

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.

Question 22

Configuring .mnu

Answer 22

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.

Question 23

Describe The Context Panel

Answer 23

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.

Question 24

How to set Tab Name

Answer 24

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.

Question 25

Tab Navigation

Answer 25

Set of tabs available in content area
Define in .nav file
Selecting a TAB in the navigation bar either opens a single UIM page or a group of related pages.
If a group of related pages are opened - the first page in the list if shown.
If a requested page cannot be located in the navigation for the application, it will be displayed in the currently opened tab.

Question 26

Configuring the .nav Navigation menu

Answer 26

Individual UIM pages are identified in this file using the navigation-page element, which can be a child of the nodes element or navigation-group element.
Navigation-page element that is a child of the nodes element - corresponds to a navigation bar tab. Once a user clicks this tab, the associated UIM page is displayed in the page content area.
Navigation-group element shares the same attributes as the navigation-page element. Only exception - page-id attribute as no UIM pages associated with it.

Question 27

Remember fucking page 248 by fucking heart

Answer 27

page 248 motherfucker

Question 28

Smart panel

Answer 28

Content specific to product being developed.
Optional
Displayed to the right of tab content page.
Components:
* Advisor - context aware recommendations and suggestions.
* Quick Notes - user can enter notes as they work.

Question 29

Development environment

Answer 29

Most SPMP OOTB configuration files are defined in:
EJBServer/components/PFMAppViews/tab. Other components also contain tab folders.
These files are validated and loaded in the database using a sub-target of build database:
build inserttabconfiguration.
This target populates APPRESOURCE table with tab and menu information.
You do not need to re-build the client.
You must restart the server and client to pick-up your changes.
The APPRESOURCE table is read at runtime to construct user interface pages.

Question 30

Defining Dynamic Menus

Answer 30

Define a loader class used on interface
* curam.util.tab.impl.DynamicMenuStateLoader
* curam.util.tab.impl.DynamicNavStateLoader
The loader must implement loadMenuState
* Decides which dynamic menu items should be disabled or hidden based on the items and page parameters.
Define the loader in the .mnu or .nav files
* loader-registry element
Specify the menu items that are dynamic
* menu-item element (dynamic=”true” visible=”true”)
Loaders are called when a tab is first opener or when a specific page is loaded. Can also be called by modal data submission. Triggering behaviour is defined in the .tab configuration file using the tab-refresh element that is defined later.

Question 31

Describe opening tabs and sections

Answer 31

Page associated with a tab based on the following elements:
* navigation element in the .tab file
* navigation-page element in the .nav file
A page can be associated with one tab only, apart from the following exceptions:
* The tabs are in different applications
* In the same tab in different page group navigation bars
The associated tab is opened when you link to a page
* Linking to modal pages will not open a new tab
* Linking in the navigation bar will always open in the same tab
A new instance of the tab is opened when the page parameter differs.
* When each person in a family opens in their own tab
If a page is not associated with a tab, it is opened in the current tab
The max. number of tabs that can be opened per section is defined by:
curam.environment.max.open.tabs - default 15.

Question 32

Describe tab refresh

Answer 32

Only the content area of a tab is refreshed when a modal dialog is submitted
Tab-refresh element allows you to refresh the following when a modal dialog is submitted:
* Tab actions menu
** Calls the loader to update the dynamic menu items
* Tab navigation
** Calls the loader to update the dynamic menu items
* Context panel
Refresh events
* unload: Event raised when a specific page is loaded
* on submit: Event raised when a specific page is submitted for a modal or content area.