UI Profile

1 Introduction

This system administration guide contains key information to setup Manufacturing Sales Platform (MSP) UI Tooling effectively. The guide provides the concepts and detailed definition of the functions, aiming to enable administrator to have sufficient knowledge to setup the function with minimal supervision.

The document will be continually edited and updated based on latest product releases. Taking into the consideration of expensive effort keeping the document updated and effective usage of it, only major and complex features should be covered.

To better illustrate how to setup certain feature, some examples are given. It also contains the steps linked to relevant screens. Each step contains actions which the administrator needs to perform to complete the setup.

This administration guide is based on Manufacturing X (MX) release version 1902.

Enjoy!

The Product Engineering Team

2 UI Tooling Introduction

UI Tooling is an enhancement on top of the existing UI Profiling which can be access via Administration > Master Data > UI Profile / UI Profile Feature Base.

MSP allows administrator to customize the user interface based on customer needs using static controls’ IDs, attributes’ IDs and even dynamic IDs which could at most of time be hard for the administrator to identify the IDs that is needed to hide and/or disable the controls.

The aim of UI Tooling is to reduce the needs for administrator to be technical savvy and yet be able to do the UI changes on their own.

Things to Note About

  • New permission, UI Customizing Permission, added into schema so loading of schema is required.
Figure 1 - Load schema for new permission to be created into system
Figure 1 - Load schema for new permission to be created into system
  • The administrator’s role needs to be assigned with the UI Customizing Permission.
Figure 2 - Ensure UI Customizing Permission is given to the administrator role
Figure 2 - Ensure UI Customizing Permission is given to the administrator role
  • This does not replace the existing maintenance of UI Profile under Administration > Master Data > UI Profile / UI Profile Feature Base.
Figure 3 - Existing UI Profile editing support
Figure 3 - Existing UI Profile editing support

3 Internal Pricing Engine

Once the administration is given the UI Customizing permission and logs into MSP, he/she will able to see a “?” button located at the top right of the application.

Figure 4 - "?" button located at top right of the application
Figure 4 - "?" button located at top right of the application

Upon clicking on the button, a dialog will open showing all the available UI Profiles within the application, and these are the following actions available in order from left to right:

  • Create new UI Profile
  • Delete selected UI Profile(s)
  • Display UI Profiles in list view
  • Display UI Profiles in tree view
  • Refresh system cache (to be trigger whenever there are changes made to any UI Profile)
Figure 5 - Actions available in order from left to right
Figure 5 - Actions available in order from left to right

3.1 UI Profile Creation

Upon clicking the “+” button, a dialog will be shown whereby the administrator can specify the name of the UI Profile to create.

Figure 6 - UI Profile creation dialog
Figure 6 - UI Profile creation dialog

3.2 UI Profile(s) Deletion

Upon selecting 1 or multiple UI Profiles in the list view, the delete button will be enabled and the administrator can delete the selected UI Profile(s) from the application.

3.3 UI Profile(s) List View

Figure 7- UI Profile(s) List View
Figure 7- UI Profile(s) List View

3.4 UI Profiles(s) Tree View

Figure 8 - UI Profile(s) Tree View
Figure 8 - UI Profile(s) Tree View

3.5 Refresh Application Cache

Needs to be triggered whenever there are changes made to UI Profile.

3.6 Editing UI Profile

To edit a specific UI Profile, simply click onto the UI Profile that you wished to edit and in either the list / tree view.

3.6.1 UI Customization

Lists all the available controls for hiding and/or disabling in the view that is being displayed currently. In addition, the administrator can click on the copy button to copy the localization key to be used in customer specific messages.properties file.

Figure 9 - UI Customization view for hiding and or or disabling available controls
Figure 9 - UI Customization view for hiding and or or disabling available controls

If the UI Profile in editing has control(s) that are hidden and/or disable which it inherits from the parent(s), then the control(s) will not be editable for the UI Profile. The administrator can hover the checkboxes to see which parent UI Profile restrict the control.

Figure 10 - Control disable for editing due to inheritance from parent UI Profile(s)
Figure 10 - Control disable for editing due to inheritance from parent UI Profile(s)

3.6.2  Overview

Administrator can update the basic information of the UI Profile.

Figure 11 - UI Profile basic information
Figure 11 - UI Profile basic information

3.6.3 Has UI Profile(s)

In this view, administrator can assign the UI Profile in editing to inherit controls that are hidden and/or disabled from other UI Profile(s).

Figure 12 - Has UI Profile(s) view
Figure 12 - Has UI Profile(s) view

3.6.4 Uses Sales Document Status

In this view, administrator can indicate if the UI Profile in editing will be applicable to certain Quote’s Document Status, such as Open, Approved, Completed etc.

Figure 13 - Uses Sales Document Status view
Figure 13 - Uses Sales Document Status view

3.6.5 Uses Sales Phase

In this view, administrator can indicate if the UI Profile in editing will be applicable to certain Opportunity’s Sales Phase, such as Identify Opportunity, Quotation etc.

Figure 14 - Uses Sales Phase view
Figure 14 - Uses Sales Phase view

3.6.6 Localization

In this view, administrator can provide different label and description for the UI Profile to cater for different language. If nothing is specified, MSP will fallback the label and description to the default which is English.

Figure 15 - UI Profile Localization