OVERVIEW

This bar gives a legend of the different pictograms used in the pages.

ATTRIBUTES DETAILS

Example:

XML Sample

<legendBar mode="on" cssName="legendBar" titleTranslationName="legendBarTranslationName" autosize="off" widthPercent="35" heightPercent="100" hzAlignment="right" vtAlignment="up" columnCount="3">

<status statusName="UNCOMPLETED" statusResourceName="legendBar.status.uncompleted" statusTranslationName="status.uncompleted" />

<status … />

</legendBar>

VISUAL IDENTITY

OVERVIEW

The informationFlyer display messages coming from the Configurator Engine. It can be execution messages, BRC explanations, runtime exceptions.

These messages are classified in several categories:

• engineMessages_model
• engineMessages_warning
• engineMessages_error
• engineMessages_fatal
• businessMessages_businessExplanations
• businessMessages_blockingBusinessExplanations
• businessMessages_informativeBusinessExplanations
• businessMessages_domainExplanations
• businessMessages_domainValidation
• quoteMessages_error (messages returned by Quote when adding an item to the quote for example)
• uiMessages_info
• uiMessages_warning
• uiMessages_error
• uiMessages_fatal

Each category of message gathers a set of IDs (one per message) that can be raised by the Configurator engine.

This classification can be found in the 'message category file'. The description and translation of the messages can be found (depending on the language) in the 'translated message resource files'

Warning:

The message categories file (messageCategories.xml) and the translated message resources files (messagesResource.properties, messagesResource_en.properties...) .can be found on the CPQ server in the following folder: $cpq_home_folder$/conf/messages

In the information Flyer (as well as in the informationBox), it is possible to activate/deactivate a category of messages in order to allow/prevent them from being raised in the Configurator UI.

Warning:

The way information messages are consumed by the userInterface depends whether the message persistence is activated (common.message.persistence=true in cameleon.properties).

If the persistence is not active, messages are consumed on the fly by the user interface. There is no way to display the list of current messages.

If the persistence is active, all the businessExplanations are stacked and the flyer can be called on demand via the OPEN_FLYER action.

Tip:

When using Rich Business Explanation messages, CPQ UI is able to display the message associated to the business explanation, as well as its criticality. Moreover, if a redirection Form Property has been associated to the message, an action allows the user to be redirected to the specified FP.

Example:

In the case of a Configurable Bundle, the informationFlyer behaves a bit differently, in the sense that it primarily focuses on businessMessages_blockingBusinessExplanations and businessMessages_informativeBusinessExplanations categories. Also, the redirection points at a Selection Group or a Selection.

Example

1. How to modify a default error message?
   1. Identify the message you want to modify (MyModifiedMessageID) thanks to its category/default translation in the 'message category file'.
   2. Depending on the language, in the <localizedTranslations> section, create a new translation for the message: MyModifiedMessageID

      My custom error message

When an error message is raised by the engine, the Configurator will first check if some translation is present in the confUI.xml file; if not, it takes the default translation in the messagesResource.properties file.

1. What is a statusFlyer?

The statusFlyer is a kind of the informationFlyer which is by default activated

• when the message persistence is activated
• And when the businessMessages_businessExplanations type of message is activated on the informationFlyer of the current configurationPage

It has no XML description in the layout file.

Its goal is to display all businessExplanations related to the currently selected formProperty (if any) when the end-user clicks on the status icon of the formPropertyBox.

ATTRIBUTES DETAILS

Example:

XML Sample

<informationFlyer name="home.infoFlyer" cssName="flyer" mode="on" hzPosition="right" vtPosition="down" resizable="on" hzSize="290" vtSize="160" titleResourceName="" titleTranslationName="infoFlyer.title" displayType="description" subSectionsMode="off" autoOpen="on" collapsible="off">

<messageCategory mode="on" name="engineMessages_model"/>

<messageCategory mode="on" name="engineMessages_warning"/>

<messageCategory mode="on" name="engineMessages_error"/>

<messageCategory mode="on" name="engineMessages_fatal"/>

<messageCategory mode="on" name="businessMessages_businessExplanations"/>

<messageCategory mode="on" name="businessMessages_informativeBusinessExplanations"/>

<messageCategory mode="on" name="businessMessages_blockingBusinessExplanations"/>

<messageCategory mode="on" name="businessMessages_domainExplanations"/>

<messageCategory mode="on" name="businessMessages_domainValidation"/>

<messageCategory mode="on" name="uiMessages_info"/>

<messageCategory mode="on" name="uiMessages_warning"/>

<messageCategory mode="on" name="uiMessages_error"/>

<messageCategory mode="on" name="uiMessages_fatal"/>

</informationFlyer>

Tip:

When collapsible="on" on an informationFlyercontaining buttons redirecting to CP/FO (“GOTO”),

When a selector bar name is filled in the subSectionsMode attribute, the FO and CP are grouped in the informationFlyer following the same structure as in the selector bar.

For instance:

VISUAL IDENTITY

The informationFlyer is associated to a main CSS class. Mapping between CSS Classes and component structure

Tip:

A CSS class is generated per type of message. The name of the CSS Class corresponds to the name of the message category.

A CSS class is generated per criticality of the business explanation. The name of the CSS Class corresponds to the criticality label and allows displaying a warning/error picto in the ‘level’ column of the flyer.

Tip:

Translations are associated to the informationFlyer

<translation name="informationFlyer.subSection.defaultTitle">Other messages</translation>

<translation name="informationFlyer.message.level">Level</translation>

<translation name="informationFlyer.message.description">Message</translation>

<translation name="informationFlyer.message.activate">Action</translation>

OVERVIEW

The informationBox displays the same information as the infomationFlyer but is integrated to the page itself.

Tip:

When used in the context of the errorPage, the informationBox is the container displaying the predefined error message (The service is temporarily unavailable. Please try again later.)

ATTRIBUTES DETAILS

VISUAL IDENTITY