C Appendix: User Interface Configurations

The JSF (JavaServer Faces) technology has been removed from the Oracle Retail Xstore Office Cloud Service application. With the conversion from JSF to GWT (Google Web Toolkit), no new user-modifiable Oracle Retail Xstore Office Cloud Service settings were added to the application.However, Oracle Retail Xstore Office Cloud Service can be "personalized" by adding a background image, changing the color scheme, and configuring the panel display order and content.All menu changes are to data in the cfg_menu_config table in the Oracle Retail Xstore Office Cloud Service database. See Table C-2.

The following changes are documented in this appendix:

Reports Menu
Home Page Menu
Defining Ta b Library Properties
Security Settings

Reports Menu

The Reports menu (main menu) was restructured as follows:

Figure C-1 Reports Menu Expanded

Each report is no longer individually listed under the Reports menu. This was replaced by an All Reports option since the reports are now indexed and searchable within the reports feature. However, it is possible to place a reference to a specific report on the Reports menu. To do this, concatenate the report ID with the standard reports menu name inside of the value of the cfg_menu_config.menu_name column for the specific report option. Selecting that specific option will then open the reports feature with the specified report pre-selected and the parameter tab for that report displayed.

To Reference a Specific Report on the Reports Menu

Any report that is available within the reports feature can be configured as a specific menu option.

In the cfg_menu_config table, find the report ID for any report by looking for the record in the "REPORT_VIEWER_MENU" category with a menu_type of "ACTION". The menu_name for any record meeting those criteria is the report ID.
Concatenate the standard reports menu name with the desired report ID and separate the two with the vertical pipe symbol ( | ).

Example:

In the following example, assume you want to add the Daily Cash and Sales Report option to the Reports menu.
- The menu_name for the "All Reports" option is "REPORT_VIEWER". This opens the reports feature with nothing selected.
- The report ID for the Daily Cash and Sales Report is
  
  "DAILY_SALES_CASH_REPORT".

To create the menu option that opens the Daily Cash and Sales Report, concatenate the standard reports menu name (REPORT_VIEWER) with the desired report ID (DAILY_SALES_CASH_REPORT) and separate the two with the vertical pipe symbol ( |

The value of the menu_name column for the menu option is:

REPORT_VIEWER|DAILY_SALES_CASH_REPORT

Home Page Menu

With the removal of JSF, the Oracle Retail Xstore Office Cloud Service user interface was updated throughout to have a new look and feel to enhance the user's experience. With this update, the options available on the Home page are completely configurable. Like the main menu, the contents of the Home page are configurable via the cfg_menu_config table in the Oracle Retail Xstore Office Cloud Service database.

Home Page/Main Menu Options

The grouping and availability of options on the Home page are completely unrelated to the options on the main menu, and are not meant to be the same. The main menu contains all possible options, while the Home page is designed to contain the options that should be readily available to the user upon login.

From a technical perspective, the options that can be configured on the Home page and the main menu each share a value for menu_name and, at least in the base, a security_privilege.

Note:

Sharing a menu name is required. Sharing a privilege, while recommended, is technically optional.

To Configure the Options on the Home Page

The category for the home page options is "HOME_PAGE_MENU". Any record in the cfg_menu_config table that has a category of "HOME_PAGE_MENU" and a parent_menu_name of "ROOT" constitutes a "Home page panel" on the home page. However, simply configuring a root record is not sufficient to make it display.

Following are the requirements to make a panel display on the home page:

The record for the panel must have either no privilege or a privilege that is part of the current user's role. Each of the six panels in base data have a privilege associated with them. Those privileges are defined in Security Settings below.
At least one option must be configured as a child of the root option.
Of the child options that are configured, the user must have access (privilege) to at least one of them. Every individual menu option has a privilege associated with it.

If any of the above conditions are not met, the panel will not be displayed on the home page.

Panel Information

The menu_small_icon column on the root record controls the image on top of the panel. The value of this column is a relative path to an image that follows the port number in the URL of the application.
The title column on the root record controls the name of the panel.
The title column of each child menu option controls the text that shows for each option on a panel.

Defining Tab Library Properties

The cfg_tab_property table defines all configurable tab properties. If the tab property is not defined in this table, then it is not configurable and not displayed on the Oracle Retail Xstore Office Cloud Service Tab Library Configuration page.

Note:

To set the default URL, use the URL_NAVIGATOR property set in the Oracle Retail Xstore Point of Service TabConfig.xml. The default title on the tab is Oracle and the default URL is http://www.oracle.com.

Table C-1 cfg_tab_property

Column	Valid Values	Description
tab_id	VARCHAR	Tab ID.
property_id	VARCHAR	Property ID (tab or tabTitle).
display_component	VARCHAR	Widget used to display configurable tab property (TextBox,CompoBox and so on).
value_type	VARCHAR	Determines whether the configurable value is defined in Value or ComplexValue XML tag.
label	VARCHAR	Translation key for label that describes what configurable value is. The label is placed on the left of each display component.
create_date	DATE	Created Date.
create_user_id	VARCHAR	Created User ID.
update_date	DATE	Updated Date.
update_user_id	VARCHAR	Updated User ID.

Security Settings

The following privileges apply to the home page panels.

Table C-2 Privileges

Privilege	Description
HOME_PAGE_CONFIG	The privilege that controls access to the Configuration Manager home page panel.
HOME_PAGE_DATA	The privilege that controls access to the Data Management home page panel.
HOME_PAGE_DEPLOY	The privilege that controls access to the Deployment Manager home page panel.
HOME_PAGE_SUPPORT	The privilege that controls access to the Support Tools home page panel.
HOME_PAGE_REPORTS	The privilege that controls access to the Reports home page panel.
HOME_PAGE_SYSTEM	The privilege that controls access to the System home page panel.
RPT_GENERAL_ACCESS	The privilege that controls access to the All Reports menu option.

Table C-3 cfg_menu_config

PK	Attribute/LogicalRolename	Datatyp	NULL?	Definition
X	category	VARCHAR (60)	NO	Menu category.
X	menu_name	VARCHAR (100)	NO	Name of menu.
NA	parent_menu_n ame	VARCHAR (100)	YES	Name of parent menu.
NA	config_type	VARCHAR (120)	YES	Configuration type for menu (if applicable).
NA	title	VARCHAR (60)	YES	Translation key for display title of menu.
NA	menu_type	VARCHAR (30)	YES	Specifies the type of menu (REDIRECT_ACTI ON, LINK, ACTION, or LINK_GROUP).
NA	sort_order	INTEGER	YES	Sort order for menu display.
NA	view_id	VARCHAR (200)	YES	Relative path to view file associated with menu (only applicable to menus with menu_type of REDIRECT_ACTI ON and LINK).
NA	action_expression	VARCHAR (200)	YES	EL or method chain to execute when menu is selected.
NA	active_flag	BIT	YES	Determines whether menu is active or not.
NA	propagation	VARCHAR (30)	YES	Seam conversation propagation strategy to use when linking to another view.
NA	security_privilege	VARCHAR (30)	YES	Security privilege required to access menu.
NA	custom_datasource_class	VARCHAR (200)	YES	Custom data source to use with report associated with menu (if applicable).
NA	custom_datasource_method	VARCHAR (30)	YES	Custom data source to use with report associated with menu (if applicable).
NA	menu_small_icon	VARCHAR (254)	YES	Relative path to image file to use as an icon for menu.
NA	menu_separator	BIT	YES	Unused
NA	description	VARCHAR (MAX)	YES	Text description of Menu Item.
NA	create_date	DATETIME	YES	Date the table row was created.
NA	create_user_id	VARCHAR (30)	YES	User responsible for creating the table row.
NA	update_date	DATETIME	YES	Date the table row was most recently updated.
NA	update_user_id	VARCHAR (30)	YES	User responsible for updating the table row.