Oracle Retail Knowledge Base

6 Application Customization

21 min read

Mirror of Oracle documentation

Converted for search and offline reading. Authoritative source: Oracle. Diagrams and some complex tables are simplified — check the PDF when in doubt.

that the link is displayed in the folder click on the up and down arrows ( ) in the Task table toolbar or click on the Move button, which will allow you to select another folder to which to move your link.

Next, you will need to configure your link using the Attributes panel. Alternatively, you can click on the View XML option and configure your link. The following attributes apply for task links:

AttributeDescription
URLThe full URL for your link. If you are adding the link using the View XML
option, the entire URL must be marked as character data (e.g. enclosed in
CDATA).
ID (id)Unique identifier for menu items. When adding your custom link, make sure
that it does not duplicate any of the base IDs.
Visible (visible)Indicates if the item should be rendered (visible) or not. Valid values are true
(default) or false. It can also be an Expression Language (EL) expression that
evaluates to true or false, such as if you want to use the application security
settings to determine the visibility of your link. For example, if you want your
link only visible to users with the Maintain Items privilege, then you can use
the ADF securityContext API isUserInRole method and set this to
#{securityContext.userInRole[‘MAINTAIN_ITEMS_PRIV’]}.
Type (type)Indicates the type of the item. Valid values are:
•
folder - indicates that the item contains additional sub-navigation items
•
link - used for URLs
An additional type (taskflow and dynamicContent) is not supported in SaaS
implementations for the Task List.
Title (title)Used to provide the user-facing title of the task item in the primary language.
Required.
Target (target)For custom links, one of the following target types can be selected:
•
_blank: renders the URL in a new browser tab
•
_self: opens the custom link on top of the Merchandising screen;
overwriting the application screen
•
_top: same behavior as _self
Access Key (accessKey)Optional. Used to specify the keyboard keystroke or a group of keystrokes
that are used to access the navigation item using the keyboard.
Short Description
(shortDesc)		Optional. Used to provide the description of the navigation item which will be
displayed when the user hovers over a menu item.

The other attributes in the Tasks Menu page do not apply for custom task menu links.

Add a New Folder

To add a new sub-folder, starting from the Tasks Menu page, select the folder in the Task table where you want your sub-folder displayed. For example, if you want to add a new subfolder under Inventory in Merchandising, highlight the Inventory row in the Task table. Then click the

Create iconic button ( ) or select Create from the Actions menu. Or, if you don’t want to add your folder in an existing folder, select the option Create On Top from the Actions menu. Both options will result in a popup being displayed like shown below.

In the popup, give your folder a unique ID and enter a user-facing title. Also, select the type folder. Then click OK. You should now see the new folder in the Task table. You can optionally also configure the attributes in the Attribute panel, or using the View XML option. The parameters for folders are similar to those described above for adding task links.

6-5

+
+

If you want to move your item to the top level so that it isn’t inside of a parent folder, then select Move On Top from the Actions menu.

If you want to modify the attributes for your custom link or folder, you can do that by highlighting the appropriate link or folder in the Task table of the Tasks Menu page and editing the attributes similar to what was described in the Add New Task Menu Items section.

You can also do some limited editing of the attributes for base task list links or folders. The attributes that can be modified for a base task link or folder are described in the table below.

AttributeDescription
Visible (visible)Indicates if the item should be rendered (visible) or not. Valid values are true
(default) or false. It can also be an Expression Language (EL) expression that
evaluates to true or false, such as if you want to use the application security
settings to determine the visibility of your link. For example, if you want your
link only visible to users with the Maintain Items privilege, then you can use
the ADFsecurityContextAPIisUserInRolemethod and set this to
#{securityContext.userInRole['MAINTAIN_ITEMS_PRIV']}.
Customizing this for base links should be done only in exceptional situations.
Best practice is to control visibility for base links and folders based on the
privileges assigned to your user’s roles, or using system options settings. For
more details on the privileges that control the base links and folders, see the
_Security Guide - Volume 2_for the applicable Merchandising solution.
Title (title)Used to provide the user-facing title of the task item in the primary language.
Required.
Default Content
(defaultContent)		Indicates whether the corresponding link is displayed by default in the content
area when the application is launched. This could be used to display one of
the base workflows by default to a user when they log into a Merchandising
solution. Valid values are true (default) or false. It can also be an Expression
Language (EL) expression that evaluates to true or false, such as if you want
to use the application security settings, similar to the Visible attribute.
This attribute is not applicable for base folders or custom links/folders.
Access Key (accessKey)Optional. Used to specify the keyboard keystroke or a group of keystrokes
that are used to access the navigation item using the keyboard.
Short Description
(shortDesc)		Optional. Used to provide the description of the navigation item which will be
displayed when the user hovers over a menu item.

The other attributes in the Tasks Menu page do not apply for modifying base task menu links.

Remove a Task

If you want to remove a custom task link or folder that you previously added, then highlight the link or folder in the Task table of the Tasks Menu page and click on the delete iconic button

( ) or select Delete from the Actions menu.

Note:

It is highly recommended that you don’t delete any of the base task links.

6-7

7. Click on the Tasks menu icon ( applied.

  • ) to validate that your changes have been re-

Reports Menu

The Reports Menu link opens the Reports Menu page that allows you to add, modify or remove the reports available in the Reports menu. For example, if you have built some custom reports using BI Publisher, you might add the links using this function.

6-9

= ORACLE’ Merchandisi Reports w Buyer Dashboard Data Steward Dashboard =n Financial Analyst Dashboard Inventory Analyst Dashboard Inventory Control! Dashboard Daily Purge nn Mass Item Change Rejection Cy Cost Change Conflicts FO3 Orders > Inventory > Import Management > Finance >

+

AttributeDescription
Default Content
(defaultContent)		Indicates whether the corresponding link is displayed by default in the content
area when the application is launched. This could be used to display one of
the base reports or dashboards by default to a user when they log into a
Merchandising solution. Valid values are true (default) or false. It can also be
an Expression Language (EL) expression that evaluates to true or false, such
as if you want to use the application security settings, similar to the Visible
attribute.
This attribute is not applicable for base folders or custom links/folders.
Access Key (accessKey)Optional. Used to specify the keyboard keystroke or a group of keystrokes
that are used to access the navigation item using the keyboard.
Short Description
(shortDesc)		Optional. Used to provide the description of the navigation item which will be
displayed when the user hovers over a menu item.

The other attributes in the Report Menu page do not apply for modifying base task menu links.

Remove a Report

If you want to remove a custom report link or folder that you previously added, then highlight the link or folder in the Report table of the Reports Menu page and click on the delete iconic

button ( ) or select Delete from the Actions menu.

Note:

It is highly recommended that you don’t delete any of the base report links.

Re-apply Report Customizations After Patching

If you have made any customizations to the Reports menu, then after a patch update, the changes will be lost. To re-apply your changes after patch updates, follow these steps:

1. From the Settings menu, select User Interface > Reports Menu .

2. Click the View XML button, and then from the XML view, select View Revisions .

3. This will open the Reports Menu Versions page.

4. From here, similar to the Tasks menu, you can view the base version, your customized version, or a comparison of the two. The comparison view highlights your additions and subtractions from the base model.

5. Note the customizations made - you may want to copy to a text editor, highlighting the changes as appropriate - and then click Back to return to the Report Menu Versions page.

6. Click Cancel to return to the Report Menu XML View page. Using the highlighted differences from the revision page, reapply your customizations. Then, click Save .

7. Click on the Reports menu icon ( ) to validate that your changes have been reapplied.

6-16

The Sidebar Menu link opens a page that allows you to modify or remove the icons available in the sidebar menu for Merchandising solutions. For example, you could hide the Quick Create option in Allocation or Pricing if you are not using that functionality.

6-17

=

Pricing |ORACLE’

til cP 5

Modify a Sidebar Icon

The base icons for Settings, Reports, Notifications, Tasks, and Favorites are not able to be modified. However, for Pricing, Invoice Matching, and Allocation, which have a Quick Create or Quick Match option, you are able to configure in the Sidebar Menu page. To modify the base settings, from the Settings menu, select User Interface > Sidebar Menu. Highlight the base icon to modify in the table on the left side of the page. Then, in the attributes on the right side of the page, you can do the following:

  • Update the title displayed when a user hovers over the icon

  • Update the visible attribute to determine whether or not it should be displayed (valid values are true or false)

Remove a Sidebar Icon

It is highly recommended that you don’t delete the base sidebar icons.

Re-apply Sidebar Customizations After Patching

If you have made any customizations to the Sidebar, then after a patch update, the changes will be lost. To re-apply your changes after patch updates, follow these steps:

1. From the Settings menu, select User Interface > Sidebar Menu .

2. Click the View XML button, and then from the XML view, select View Revisions .

3. This will open the Sidebar Menu Versions page.

4. From here, similar to the Tasks menu, you can view the base version, your customized version, or a comparison of the two. The comparison view highlights your additions and subtractions from the base model.

5. Note the customizations made - you may want to copy to a text editor, highlighting the changes as appropriate - and then click Back to return to the Sidebar Menu Versions page.

6. Click Cancel to return to the Sidebar Menu XML View page. Using the highlighted differences from the revision page, reapply your customizations. Then, click Save . The changes should be immediately applied to the sidebar menu.

Application Navigator

The Application Navigator allows users to launch different applications from the Merchandising solution they are currently using so that they can shuffle between multiple applications based on their privileges and avoid having to open a new tab and enter a new URL to launch an application. Users can instead click on the solution from a list, which will launch that application in a new tab or window based on the browser settings.

6-20

Add an Application

The Add action is enabled at all times and allows an administrator to add a new URL.

1. From the Actions menu, select Add. A new, empty entry is added to the table.

2. Enter a name, the application URL, and the role to which the URL applies. The remaining columns are populated automatically. URLs for the Merchandising solutions, or other solutions used by your user community can be included here.

3. Click Save to save your changes.

Users impacted by the new URL link you’ve added may need to log out and back in, in order to see the changes.

Modify an Application

While all the columns on a row can be modified, only the Role and URL columns of a System record can be modified by the administrators. After making updates, click Save to save your changes.

Duplicate an Application

The Duplicate action adds a copy of each selected row below its originating row. The object name or unique identifier of the duplicate row is “Copy of ” and appears in edit mode to prevent accidentally creating duplicate labels. This function may be helpful if you want to add the same link for multiple roles. After making updates, click Save to save your changes.

Delete an Application

The Delete action is enabled when an entry is selected. When the user selects an application navigator entry and clicks Delete , the user is prompted with a warning message. Click Yes and the selected entry is removed. After making updates, click Save to save your changes.

Dashboards and Reports

The Dashboard and Reports menu under Settings provides options to customize the reports displayed in Dashboards and the contextual pane in the Merchandising solutions. This can be used to add your own reports in the dashboard or in the contextual pane. Or to re-order or remove base reports from a particular dashboard or screen, or even to move base reports to different dashboards or contextual panes.

6-22

Restore Save Cancel

Restore Save Cancel

To test the configuration, open the dashboard where you added your report to validate that it is displayed as expected.

Modify a Report

If you want to modify a custom report you added previously, you can also do that in the dashboard model page (Settings > Dashboards and Reports > Dashboards) for the applicable dashboard. Also, there are some changes you can make to base reports in this view, with limitations.

Rearrange Reports

If you want to rearrange the order of the reports in a dashboard (base or custom), highlight the report to be moved in the Layout Item table of the appropriate dashboard model page. Then,

click on the up or down arrows ( ) in the Layout Item table toolbar to move the report up or down. If you want to move the report to a different column or row, then highlight the report to be moved in the Layout Item table of the dashboard model page. Then, click the Move button in the Layout Item table toolbar. This will open a popup where you can select the new column or row for your folder or link.

Add a Base Report to Another Dashboard

If you want to add one of the base reports to a different base dashboard, you can do this, provided the parameters required by the report are available in the dashboard filter where you want to add it. The easiest way to do this is to copy the XML for the base report and paste it into the new dashboard’s configuration and then update naming or remove any non-required parameters from the configuration that aren’t supported in the new dashboard. For example, if you wanted to also display the Incomplete Items report (on the Data Steward dashboard in the base configuration) in the Buyer Dashboard, then you’d do the following:

1. Click on Settings > Dashboards and Reports > Dashboards and open the configuration for the Data Steward dashboard.

2. Click on the View XML button to switch to the XML view.

3. Highlight the full configuration for the report with the ID IncompleteItems, including all the parameters and copy the text.

4. Click on Settings > Dashboards and Reports > Dashboards and open the configuration for the Buyer dashboard.

5. Click on the View XML button to switch to the XML view.

6. Paste what you copied from the Data Steward model in this view. Where you copy it will determine where it will be displayed in the dashboard - for example, if you want it displayed first, paste it above the configuration for DailySales. This can also be changed later following the instructions above in the Rearrange Reports section.

7. Remove any parameters that are not available in the new dashboard. For this report, that includes parameters 9-16 related to UDA values, location, create dates, item type, item level, transaction level, UDA, and season.

8. Click Save to save your changes.

Open the Buyer dashboard to validate that the Incomplete Items report is displayed as expected.

6-29

Modify Report Attributes

For custom icons, you can update any of the attributes that are described above under Add a Report. For base reports, it is recommended that you only modify the Visible property to hide a report if you do not want it displayed or only want it displayed for users with certain privileges.

Remove a Custom Report

If you want to remove a custom report that you previously added, then, in the appropriate dashboard model page, highlight the report in the Layout Item table and click on the delete

iconic button ( ) or select Delete from the Actions menu.

Note:

It is highly recommended that you don’t delete any of the base reports.

Re-apply Dashboard Customizations After Patching

If you have made any customizations to a dashboard, then after a patch update, the changes will be lost. To re-apply your changes after patch updates, follow these steps:

1. From the Settings menu, select Dashboards and Reports and then select the dashboard menu model you wish to update.

2. In the dashboard model page, click the View XML button, and then from the XML view, select View Revisions .

3. This will open the Dashboard Model Versions page.

4. From here, similar to the Tasks menu, you can view the base version, your customized version, or a comparison of the two. The comparison view highlights your additions and subtractions from the base model.

5. Note the customizations made - you may want to copy to a text editor, highlighting the changes as appropriate - and then click Back to return to the Dashboard Model Versions page.

6. Click Cancel to return to the Dashboard Model XML View page. Using the highlighted differences from the revision page, reapply your customizations. Then, click Save .

7. Open the dashboard that you just updated to validate that your changes have been reapplied.

Contextual Reports

Contextual reports are available in many key workflows throughout the Merchandising suite of solutions. They provide additional information to the user of a particular workflow to help in decision making. The reports are considered contextual, because they can use parameters that are published by the workflow in which it is displayed.

6-30

< Reports

Vv

Item Supplier Contextual Model

  • —<n Item Supp Country Contextual M… Item Contextual Model Pack Details Contextual Model

  • M Item Loc Contextual Model

  • Item Children Contextual Model item Children By Diff Contextu… Substitute Items Contextual Mo… AlcCustoms Order FinalizeEntry Contextual ContextualModel… Letter Of Credit Head Contextu… | attar Of Cradit Order Cantayt

AttributeDescription
reportDescriptionThis should be a description of the report to be used by a screen reader.
Required to ensure your report appears in the contextual panel.

Click OK to save your changes in the View Parameters popup. Then click Save in the contextual model page to save your settings.

To test the configuration, open the page where you added your report to validate that it is displayed as expected.

Modify a Report

If you want to modify a custom report you added previously, you can also do that in the contextual model page for the applicable workflow. Also, there are some changes you can make to base reports in this view, with limitations.

Rearrange Reports

If you want to rearrange the order of the reports in a contextual pane (base or custom), highlight the report to be moved in the Contextual Area table of the appropriate model page.

Then, click on the up or down arrows ( ) in the Contextual Area table toolbar to move the report up or down.

Add a Base Report to Another Contextual Pane

If you want to add one of the base reports to a different contextual pane, you can do this, provided the parameters required by the report are available in the workflow where you want to add it. The easiest way to do this is to copy the XML for the base report and paste it into the new contextual model configuration and then update the parameters, as needed. For example, if you wanted to display the Item Details contextual report that is in the Item Search contextual pane in the base configuration, and add it to the Franchise Order contextual pane, then you would do the following:

1. Click Settings > Dashboards and Reports > Reports and open the configuration for the Item Search Contextual Model.

2. Click the View XML button to switch to the XML view.

3. Highlight the full configuration for the report with the ID ItemDetailsContextualRegion , including all the parameters and copy the text.

4. Click Settings > Dashboards and Reports > Report and open the configuration for the Franchise Order Header Contextual Model.

5. Click the View XML button to switch to the XML view.

6. Paste what you copied from the Item Search model into this view. Where you copy it will determine where it will be displayed in the contextual pane: for example, if you want it displayed first, paste it above the configuration for FranchiseOrderHeadReport . This can also be changed later following the instructions above in the Rearrange Reports section.

7. Remove any parameters that are not available in the new workflow. In this example, none of the parameters need to be updated.

8. Click Save to save your changes.

6-36

Open the Franchise Order page to validate that the Items Details report is displayed as expected.

Modify Report Attributes

For custom reports, you can update any of the attributes that are described above under Add a Report. For base reports, it is recommended that you only modify the Visible property to hide a report if you do not want it displayed or only want it displayed for users with certain privileges.

Remove a Custom Report

If you want to remove a custom report that you previously added, then, in the appropriate contextual model page, highlight the report in the Contextual Area table and click on the delete iconic button

(

) or select Delete from the Actions menu.

Note:

It is highly recommended that you don’t delete any of the base reports.

Re-apply Contextual Report Customizations After Patching

If you have made any customizations to a contextual pane, then after a patch update, the changes will be lost. To re-apply your changes after patch updates, follow these steps:

1. From the Settings menu, select Dashboards and Reports and then select the contextual menu model you wish to update.

2. In the contextual model page, click the View XML button, and then from the XML view, select View Revisions .

This will open the Contextual Model Versions page.

3. From here, similar to the Tasks menu, you can view the base version, your customized version, or a comparison of the two. The comparison view highlights your additions and subtractions from the base model.

4. Note the customizations made: you may want to copy them to a text editor, highlighting the changes as appropriate - and then click Back to return to the Contextual Model Versions page.

5. Click Cancel to return to the Contextual Model XML View page. Using the highlighted differences from the revision page, reapply your customizations. Then, click Save .

6. Open the page for the contextual pane you just updated to validate that your changes have been re-applied.

6-37

.¢

“en”,” @OH2@”,”Chain”,”Geo-Region” ®) incorrect en,@OH2@,Chain,Geo-Region of} correct

  • 1 LANGUAGE, TOKEN, RMS_NAME, CLIENT_NAME 2 en, @0H2@, Chain, Geo-Region 3 en, @OHP2@, Chains, Geo-Regions 4 en, @MH2@, Division, Brand 5 en, @MHP2@, Divisions,Brands 6 en, @MH3@, Group, Gender 7 en, @MHP3@, Groups, Genders 8 |

In this guide

Graph View

Backlinks