User Interface
The User Interface menu is used to configure the user interface of Performance Quoting. It allows you to create a library of objects that can be used in the layout, layout structure, actions, customizable keyboard shortcuts, and themes.
The different elements are presented in a tree structure on the left. When an element is selected, you see the details on the right.
Settings
The settings section allows you to define some global preferences in the quote model.
QUOTE LINE INSERTION
Define how lines are added in the quote - the quote level settings allow to define default values and a default behavior unless this behavior is specified for each action specifically (See User Interface - Actions)
| Line insertion | Possible Values | |
| Line position | Defines where the added product/line should be inserted based on a selected product/line in the quote. If nothing is selected, the policy at the quote level is used (defined in User Interface - Settings) | "Before", "After" |
| Line position in folder/bundle | Defines where the added product should be inserted based on a selected folder/bundle line in the quote. Note: This also defines where a line is added in the grid when there is no line selected. | "Top", "Bottom" |
| Folder insertion strategy (for Folders) | Defines if the added folder line should be inserted inside the selected folder line in the quote. | "Same level", "Force Inside" |
| Folder insertion strategy (for Non Folder Lines) | Defines where the added line should be inserted based on a selected folder line in the quote. | "Force Inside", "Same Level" |
| Bundle insertion strategy | Defines if the added product should be inserted inside a selected bundle line in the quote. | "Same level", "Force Inside" |
QUOTE LAYOUT
- Number of steps visible in the process bar - define how many steps can be displayed in the process bar (if there is available space. If not, an arrow will allow the user to go to the next step).
- Show header - when set to true, displays the PROS header on the quote, restricted use for embedded UI. When the header is not displayed the close and synchronize action, the settings and the info menu will be moved to the grey header.
- Show footer - when set to true, displays the quote footer, restricted use for embedded UI.
- Navigation Mode: define the way quote steps and pages are rendered in the Process Bar:
- Select Steps to represent the quoting workflow with bullets.
- Select Tabs to represent the quoting workflow with tabs.
Library
The layout library allows you to create a library of elements that can be added to the layout structure. The library is shown in a tree structure.
Elements created from the library will be used in pages. There are 3 types of elements you can define in the library:
- Sub-headers - corresponds to the header bar of Performance Quoting. You can define tabs to display header/total fields.
- Left Part - corresponds to the left pane displayed next to a grid. From this left pane, you can display information related to lines
- Line Panel - corresponds to the panel displayed under a line. As for the left pane, from this panel you can display information related to lines
Refer to End-User Interface to see examples of the different elements of the Performance Quoting user interface.
SUB-HEADER
The sub header is defined with the following hierarchy. You can define several sub-headers and display them on different pages.
At runtime, tabs are displayed in the header bar and you can define sections in a tab. In that case, the sections are displayed in a panel.
In addition, on the sub-header definition, you can select the Close and Synchronize action defined in your model. This action will be displayed at the top right of the application.
On a tab, you will define which field will be displayed by selecting a View and a Component.
In a tab, you can define one/several section(s). For each section, you will define the title of the section and then the View/Component you want to display.
LEFT PART
The left part is defined with the following hierarchy. You can define several left part and display them on different pages.
The left part can be defined with different elements:
- Line details - this element displays line information in the left pane (several line details can be defined for a given left part)
- Long treatment report - this element displays report logs after an action taking more time to execute (after an import, for example)
- Error Browser - this element allows browsing the various technical errors and validation messages related to the current quote or to a given quote line
- Activity Tracking - this element lists the interactions from all end users on a given quote in a chronological order
Refer to End-User Interface to see examples of the different elements of the Performance Quoting user interface.
Line Details
From the left bar, you can display additional line related information in a Line Details widget.
A line details widget is defined with a description (displayed on top of the left pane) and an icon (displayed in the left bar).
A line details widget contains one/several section(s). Each section is defined with a description (displayed at the top of the section) and a a View/Component (listing the columns you want to display in the left pane).
IS NOT GRID flag
If a component is used only in a left pane (meaning this component is never used in a grid or for an export), we recommend unchecking the option Used in a grid widget / Export action on this component. This option is available on the component definition:
Indeed, without that flag, the component is not taken into account for the limit of the number of components defined in a quote model.
Additional Information
A customizable tooltip can be associated with a given column or field to give additional information. In that case, the tooltip is displayed when hovering on the label of the column or field in the left part:
The Long Treatment Report widget is meant to display logs produced during the execution of a long process.
To add a Long Treatment widget in the Left Part, respect the following hierarchy and click on Insert
Widget on a given Left Part widget:
Give the widget a Name and Description, and select Long Treatment Report as the type of widget:
Select the icon representing your widget in the Left Part:
Error Browser
The Error Browser is where you can consult both the technical and validation errors detected on the quote.
To add an Error Browser widget in the Left Part, respect the following hierarchy and click on Insert Widget on a given Left Part widget:
Give the widget a Name and Description, and select Error Browser as the type of widget:
Select the types of messages to be made available in the quote interface:
Activity Tracking
The Activity Tracking widget is where you can consult the activity from all users working on the current quote.
To add an Activity Tracking widget in the Left Part, respect the following hierarchy and click on Insert Widget on a given Left Part widget:
Give the widget a Name and Description, and select Activity Tracking as the type of widget:
LINE PANEL
The line panel is defined with the following hierarchy. You can define several line panel part and display them in different grids.
This would reflect in the UI as follow:
A line panel can contain one/several line details and one period details. The line details is defined with a description displayed in the panel as a tab. Then, the line details contains columns which contain sections.
The section is defined with a description and a View/Component defining which data are displayed.
The period details are defined with a description displayed in the panel as a tab.
IS NOT GRID flag
If a component is used only in a left pane (meaning this component is never used in a grid or for an export), we recommend to uncheck the option "Used in a grid widget / Export action" on this component. This option is available on the component definition:
Indeed, without that flag, the component is not taken into account for the limit of the number of components defined in a quote model.
Layout Structure
The layout structure menu allows you to create the quoting process and quote interface which includes the steps and pages with different views.
For more information on these elements, see End-User Interface in Connect.
STEPS
The steps define the quoting process. To create a step, select the Layout Structure line by clicking on it and click the + icon.
Give the step a name and description. You can also select the session states you want to grant the Read Permission. Once you have defined the steps of the quoting process, you can define the pages for each step.
PAGES
Pages are different views within each step and can be configured differently depending on what you want to display.
To create a page, select the Step that you want to create the page for by clicking on the line, then click the + icon. Give the page a name and description. You can also select the session states you want to grant the Read Permission. You can create as many pages for each step as you want.
To configure each page, select the page by clicking on the line.
On the right you define a sub-header and left part. These are elements that you previously created in the Library.
For each page, you must define what you want to display. Do this by clicking on the + icon. The Add widget popup opens.
Give the widget a name, description, and type. There are several types of widgets possible depending on what you want to display.
The List widget is a container allowing you to add several widgets on a page. You can also add List widgets in a List widget.
In the example above, the following structure is generated:
Leveraging the List widget will allow you to build the page layout as you want.
TYPES OF WIDGETS
| TYPE | DESCRIPTION |
|---|---|
| List | Widget used to create several places for widgets on one page. |
| Popup panel | Widget used to determine how PROS Smart CPQ Catalog and Configuration process will be displayed when opened in a popup mode. |
| Grid | Widget used to display a grid with line items data and associated actions. |
| Catalog | Widget used to display a PROS Smart CPQ Catalog UI. |
| Fields | Widget used to display a list of fields. |
| Grid comparison | Widget used to compare line items. |
| Technical info | Widget used to display some technical information. |
| External widget | Widget used to display an external UI embedded inside Smart CPQ UI. |
| Waterfall | Widget used to display a Waterfall chart. |
| Pie | Widget used to display a Pie chart |
| Gauge | Widget used to display a Gauge chart |
| Rebates | Widget used to display applicable rebates for the current quote's recipient. |
Each type of widget is configured differently. For some, you must select them by clicking on the line, then configure them on the right. For others, you must click on the + icon and create another level, which is used to further define what is displayed on the page. Some types of widget are eligible for the "Minimized by default" option. If the option is checked, the corresponding widget will be minimized when entering the quote.
List
This widget is used to create several places for widgets on one page. If you are not using this widget, then only one widget will be allowed per page. If you need more than one per page, then add a List widget to segment the page horizontally or vertically and create distinct placeholders for widgets.
Once you have created and configured a List, you can add the list of widgets directly under the List.
| SETTINGS | DESCRIPTION | FORMAT/VALUES | MANDATORY? |
|---|---|---|---|
| Name | The identifier of the widget. | Text Can't contain spaces or special characters. | Y |
| Description | The description of the widget. Is displayed in the user interface. Can be translated in the Translations space. | Text | Y |
| List Type | Indicates if the page should be divided horizontally or vertically. | "Horizontal", "Vertical" | Y |
| List Ratio | For each widget contained in the List, defines the relative size that will be occupied by this widget. If not specified, then widgets will be equally distributed. By default, the widgets will have the same size. | Numeric for each widget | N |
Popup Panel
This widget is used to determine how PROS Smart CPQ Catalog and Configuration process will be displayed when opened in a popup mode.
| SETTINGS | DESCRIPTION | FORMAT/VALUES | MANDATORY? |
|---|---|---|---|
| Name | The identifier of the widget. | Text Can't contain spaces or special characters. | Y |
| Description | The description of the widget. Is displayed in the user interface. Can be translated in the Translations space. | Text | Y |
| Layout File Name | The name of the Catalog layout file to use. | Text | Y |
Grid
This widget is used to display a grid with line items data and associated actions.
| SETTINGS | DESCRIPTION | FORMAT/VALUES | MANDATORY? |
|---|---|---|---|
| Name | The identifier of the widget. | Text Can't contain spaces or special characters. | Y |
| Description | The description of the widget. Is displayed in the user interface. Can be translated in the Translations space. | Text | Y |
| Minimized by default | Define if the widget is minimized when the quote is opened | Boolean | Y |
| View | The view to be used to determine the list of line items to display in the grid. | List of views | Y |
| Component | The component to be used to determine the list of columns to display in the grid. | List of columns components, belonging to the selected view. Only component with the Is Grid flag activated can be selected | Y |
| Line Panel | The line panel that will be displayed in the grid. | List of available line panel | N |
| Actions | The list of actions that are available in the grid action menus. | List of actions | N |
Actions
The action section defines how actions related to the grid are displayed or not.
| SETTINGS | DESCRIPTION | FORMAT/VALUES | MANDATORY? |
|---|---|---|---|
| Actions | Contains the list of actions available in the grid. | List of actions | Y |
| Display Action bar | If true, the action bar will be displayed. This action bar contains all the actions defined previously above. | Boolean | Y |
| Actions | Contains the list of actions available directly in the action bar. | List of actions | Y |
| Display Search and Add | If true, the search and add will be displayed in the action bar. | Boolean | Y |
| Show Description | Display the product description. | Boolean | Y |
| Show Price | Display the product price. By default, the following CPE is used to get the price: "CPE.currentItem.GET(CPE.Settings.Session.PricingMethod[1]).Range[1].value" | Boolean | Y |
| Show Long Text | Display the product long text from the catalog. The first RMO text with the user type "quotex" will be retrieved. | Boolean | Y |
| Show Name | Display the product name. | Boolean | Y |
| Show Image | Display the product image from the catalog.The first RMO image ON with the user type "quotex" will be retrieved. | Boolean | Y |
| Show Qty Selector | Display the quantity selector. | Boolean | Y |
| Scope | Define the scope search (from which sub collection the search must be performed). | Text (CPE format: "wks/CL/catalog.wks/CL/collection") | N |
| Search Action | The search and add action associated. | List of actions available | Y |
| View More Action | An open widget action can be associated. It will display a view more button and will redirect the user to a catalog widget to display all results. Indeed, the search and add displays only the first 10 results. | List of actions available | N |
Actions on the Grid Widget
When actions are associated to the grid widget, they are automatically displayed on the action bar and available on right click:
However, depending on the actions, they are not displayed in the same place (see Action Menus Structure)
Then, in the quote model, the administrator is able to define some actions they want to display directly in the action bar. As soon as there are more than 2 actions, they are displayed under a menu (Actions in the example above).
Actions Pinned to the Action Bar
In order to be able to display an action in the action bar, you need to also define this action on the grid widget.
Grid Custom Data
The administrator is able to define some properties on the grid widget.
Grid custom data defined on the component: A grid widget is associated to a component. This component can be reused in other grid widgets. However, all the properties defined in the Grid Custom Data section are defined on the component. That means if some of these properties are updated on a grid widget, this update will be also performed on all widgets referencing the same component.
| SETTINGS | DESCRIPTION | FORMAT/VALUES | MANDATORY? |
|---|---|---|---|
| Density | Define the grid density | Compact Normal Tight | Y |
| Default column width | Define the width of all columns | Integer | Y |
| Columns setup | From this popup, the user will be able to change: Column order Which columns are docked Which columns are hidden Columns width (which override the default width) |
If User Preferences for columns arrangement are activated, then the Columns setup described above is the default configuration, but can be overridden locally by each individual user accessing a given quote grid (view / component).
Columns Preset
The administrator is able to define some column presets. A column preset is a predefined group of columns available for the user at runtime (see Spreadsheet Grid).
A grid widget is associated to a component. This component can be reused in other grid widgets. However, all the properties defined in the Columns Preset section are defined on the component. That means if some of these properties are updated on a grid widget, this update will be also performed on all widgets referencing the same component.
The column preset is defined with a description (displayed at runtime and updatable by the administrator under the Translations section) and a column setup (same properties as Grid custom data).
Catalog
This widget is used to display a PROS Smart CPQ Catalog UI.
| SETTINGS | DESCRIPTION | FORMAT/VALUES | MANDATORY? |
|---|---|---|---|
| Name | The identifier of the widget. | Text Can't contain spaces or special characters. | Y |
| Description | The description of the widget. Is displayed in the user interface. Can be translated in the Translations space. | Text | Y |
| Minimized by default | Define if the widget is minimized when the quote is opened. | Boolean | Y |
| Layout File Name | The name of the Catalog layout file to use. | Text | Y |
| Target Type | The type of Catalog object that is targeted as the landing page when opening the Catalog UI. | "Catalog Home Page", "Collection Page", "Product Page", "Search Page", "CP Page", "Need Analysis Page" | N |
| Target CPE | The CPE of the of the object that is targeted as the landing page when opening the Catalog UI. | Text | N |
| Action | The Open Catalog action to use to open the Catalog. It will carry the data source defined on the action level. | List of Open Catalog actions | Y |
Page redirection
There is a possibility to configure a page redirection behavior in the case of adding an item from the Catalog to the Quote.
The default behavior when adding an item from the catalog to the Quote is to stay within the Catalog page.
So, if the user wants to redirect to a specific page after an "Add to cart" action, what needs to be done is to add a parameter goTo with the page ID in the "add to cart" action definition like this:
In this example, page143 is the widget ID of the target page. The prefix quotex must be added when using Performance Quoting. For the same behavior in the previous generation of Smart CPQ Quote, the prefix to use instead is cart.
Fields
This Widget is used to display a list of fields.
| SETTINGS | DESCRIPTION | FORMAT/VALUES | MANDATORY? |
|---|---|---|---|
| Name | The identifier of the widget. | Text Can't contain spaces or special characters. | Y |
| Description | The description of the widget. Is displayed in the user interface. Can be translated in the Translations space. | Text | Y |
| Minimized by default | Define if the widget is minimized when the quote is opened. | Boolean | Y |
| View | The view to be used to determine the list of line fields to be displayed. | List of views | Y |
| Component | The component to be used to determine the list of fields to display in the grid. | List of field components, belonging to the selected view. | Y |
Fields can be displayed as follows when the Field widget is set-up.
Nevertheless, sections can be defined in a Field Widget. In that case, the View and Component properties on the Field Widget are not mandatory anymore as these properties will be set on the section. The structure will be as follows:
A section is defined with the following properties:
| SETTINGS | DESCRIPTION | FORMAT/VALUES | MANDATORY? |
|---|---|---|---|
| Name | The identifier of the widget. | Text Can't contain spaces or special characters. | Y |
| Description | The description of the widget. Is displayed in the user interface. Can be translated in the Translations space. | Text | Y |
| View | The view to be used to determine the list of line fields to be displayed. | List of views | Y |
| Component | The component to be used to determine the list of fields to display in the grid. | List of field components, belonging to the selected view. | Y |
At runtime, the sections will be displayed as following
Grid Comparison
This widget is used to compare line items.
| SETTINGS | DESCRIPTION | FORMAT/VALUES | MANDATORY? |
|---|---|---|---|
| Name | The identifier of the widget. | Text Can't contain spaces or special characters. | Y |
| Description | The description of the widget. Is displayed in the user interface. Can be translated in the Translations space. | Text | Y |
| Minimized by default | Define if the widget is minimized when the quote is opened. | Boolean | Y |
| View | The view to be used to determine the view to use in the component grid. | List of views | Y |
| Component | The component to be used to determine the list of columns to display in the comparison grid. | List of columns components, belonging to the selected view. | Y |
Technical Info
This widget is used to display some technical information. It will automatically be configured and show session variables and session states values. The display of this widget should be reserved for administrators.
| SETTINGS | DESCRIPTION | FORMAT/VALUES | MANDATORY? |
|---|---|---|---|
| Name | The identifier of the widget. | Text Can't contain spaces or special characters. | Y |
| Description | The description of the widget. Is displayed in the user interface. Can be translated in the Translations space. | Text | Y |
| Minimized by default | Define if the widget is minimized when the quote is opened. | Boolean | Y |
External Widget
This widget is used to display an external UI embedded inside Smart CPQ UI.
| SETTINGS | DESCRIPTION | FORMAT/VALUES | MANDATORY? |
|---|---|---|---|
| Name | The identifier of the widget. | Text Can't contain spaces or special characters. | Y |
| Description | The description of the widget. Is displayed in the user interface. Can be translated in the Translations space. | Text | Y |
| Minimized by default | Define if the widget is minimized when the quote is opened. | Boolean | Y |
| View | The view to be used in the external widget. | List of views | Y |
| Component | The component to be used in the external widget. | List of columns components, belonging to the selected view. Only component with the Is Grid flag activated can be selected | Y |
| Actions | The External Widget action to use to open the widget. It will carry many settings defined on the action level. | List of external widget actions | N |
Waterfall
This widget is used to display a Waterfall Chart. Check the dedicated Waterfall chart documentation for more information on its behavior.
| SETTINGS | DESCRIPTION | FORMAT/VALUES | MANDATORY? |
|---|---|---|---|
| Name | The identifier of the widget. | Text Can't contain spaces or special characters. | Y |
| Description | The description of the widget. Is displayed in the user interface. Can be translated in the Translations space. | Text | Y |
| Minimized by default | Define if the widget is minimized when the quote is opened. | Boolean | Y |
Waterfall Quote
This widget is used inside a Waterfall widget to display a Waterfall chart based on quote information. Only one widget of this kind is allowed inside a Waterfall widget.
| SETTINGS | DESCRIPTION | FORMAT/VALUES | MANDATORY? |
|---|---|---|---|
| Name | The identifier of the widget. | Text Can't contain spaces or special characters. | Y |
| Description | The description of the widget. Is displayed in the user interface. Can be translated in the Translations space. | Text | Y |
| View | The view to be used to determine the view that contains the list of fields to be used. | List of views | Y |
| Component | The component to be used to determine the list of fields to use in the widget. | List of fields components, belonging to the selected view. | Y |
| Waterfall Custom Data | A waterfall widget is associated to a component. This component can be reused in other waterfall widgets. However, all the properties defined in the Waterfall Custom Data section are defined on the component. That means if some of these properties are updated on a waterfall widget, this update will be also performed on all widgets referencing the same component. | ||
| Label | The title of the widget. Is displayed in the user interface. Can be translated in the Translations space. | Text | N |
| Display Zero Element | Indicates if elements with a zero value should be displayed or skipped. | Boolean | Y |
| Display Empty Element | Indicates if elements with no value should be displayed or skipped. | Boolean | Y |
| Display Percentage Mode | Indicates if the percentage mode should be used. | Boolean | Y |
| Display Grid Mode | Indicates if the grid mode should be used. | Boolean | Y |
| Display Total | Indicates if the total should be displayed. | Boolean | Y |
Add as many waterfall items as needed, they will be displayed in the Waterfall chart, with the following settings:
| SETTINGS | DESCRIPTION | FORMAT/VALUES | MANDATORY? |
|---|---|---|---|
| Type | The type of Waterfall element to display. | "Substractor", "Adder", "Benchmark", "Computed Benchmark" | Y |
| Item | Field to use for that Waterfall item. Not used for Computed Benchmark kind of item. | List of fields in the waterfall component | Y |
| Label | The label of the item. Is displayed in the user interface. Can be translated in the waterfall items grid by using the Translations button Only used for Computed Benchmark kind of item. | Text | Y |
Add as many waterfall subtotals as needed, they will be displayed in the Waterfall chart, with the following settings:
| SETTINGS | DESCRIPTION | FORMAT/VALUES | MANDATORY? |
|---|---|---|---|
| From | The field to consider as the first value for the subtotal computation. | List of fields in the waterfall component | Y |
| To | The field to consider as the last value for the subtotal computation. | List of fields in the waterfall component | Y |
| Label | The label of the subtotal. Is displayed in the user interface. Can be translated in the waterfall subtotals grid by using the Translations button. | Text | Y |
| Expanded | Indicates if the subtotal group is expanded or collapsed by default | Boolean | Y |
Waterfall Line
This widget is used inside a Waterfall widget to display a Waterfall chart based on line item information. Only one widget of this kind is allowed inside a Waterfall widget.
| SETTINGS | DESCRIPTION | FORMAT/VALUES | MANDATORY? |
|---|---|---|---|
| Name | The identifier of the widget. | Text Can't contain spaces or special characters. | Y |
| Description | The description of the widget. Is displayed in the user interface. Can be translated in the Translations space. | Text | Y |
| View | The view to be used to determine the view that contains the list of columns to be used. | List of views | Y |
| Component | The component to be used to determine the list of columns to use in the widget. | List of column components, belonging to the selected view. | Y |
| Waterfall Custom Data | A waterfall widget is associated to a component. This component can be reused in other waterfall widgets. However, all the properties defined in the Waterfall Custom Data section are defined on the component. That means if some of these properties are updated on a waterfall widget, this update will be also performed on all widgets referencing the same component. | ||
| Label | The title of the widget. Is displayed in the user interface. Can be translated in the Translations space. | Text | N |
| Display Zero Element | Indicates if elements with a zero value should be displayed or skipped. | Boolean | Y |
| Display Empty Element | Indicates if elements with no value should be displayed or skipped. | Boolean | Y |
| Display Percentage Mode | Indicates if the percentage mode should be used. | Boolean | Y |
| Display Grid Mode | Indicates if the grid mode should be used. | Boolean | Y |
| Display Total | Indicates if the total should be displayed. | Boolean | Y |
Add as many waterfall items as needed, they will be displayed in the Waterfall chart, with the following settings:
| SETTINGS | DESCRIPTION | FORMAT/VALUES | MANDATORY? |
|---|---|---|---|
| Type | The type of Waterfall element to display. | "Substractor", "Adder", "Benchmark", "Computed Benchmark" | Y |
| Item | Field to use for that Waterfall item. Not used for Computed Benchmark kind of item. | List of fields in the waterfall component | Y |
| Label | The label of the item. Is displayed in the user interface. Can be translated in the waterfall items grid by using the Translations button Only used for Computed Benchmark kind of item. | Text | Y |
Add as many waterfall subtotals as needed, they will be displayed in the Waterfall chart, with the following settings:
| SETTINGS | DESCRIPTION | FORMAT/VALUES | MANDATORY? |
|---|---|---|---|
| From | The field to consider as the first value for the subtotal computation. | List of fields in the waterfall component | Y |
| To | The field to consider as the last value for the subtotal computation. | List of fields in the waterfall component | Y |
| Label | The label of the subtotal. Is displayed in the user interface. Can be translated in the waterfall subtotals grid by using the Translations button. | Text | Y |
| Expanded | Indicates if the subtotal group is expanded or collapsed by default | Boolean | Y |
Pie
This widget is used to display a Pie Chart. Check the dedicated Pie chart documentation for more information on its behavior.
| SETTINGS | DESCRIPTION | FORMAT/VALUES | MANDATORY? |
|---|---|---|---|
| Name | The identifier of the widget. | Text Can't contain spaces or special characters. | Y |
| Description | The description of the widget. Is displayed in the user interface. Can be translated in the Translations space. | Text | Y |
| Minimized by default | Define if the widget is minimized when the quote is opened. | Boolean | Y |
Pie Quote
This widget is used inside a Pie widget to display a Pie chart based on quote information. Only one widget of this kind is allowed inside a Pie widget.
| SETTINGS | DESCRIPTION | FORMAT/VALUES | MANDATORY? |
|---|---|---|---|
| Name | The identifier of the widget. | Text Can't contain spaces or special characters. | Y |
| Description | The description of the widget. Is displayed in the user interface. Can be translated in the Translations space. | Text | Y |
| View | The view to be used to determine the view that contains the list of fields to be used. | List of views | Y |
| Component | The component to be used to determine the list of fields to use in the widget. | List of field components, belonging to the selected view. | Y |
| **Pie Custom Data | A pie widget is associated to a component. This component can be reused in other pie widgets. However, all the properties defined in the Pie Custom Data section are defined on the component. That means if some of these properties are updated on a pie widget, this update will be also performed on all widgets referencing the same component. | ||
| Pie Format | The type of UI chart to display. | "Pie", "Donut", "Semi Circle Donut" | Y |
| Fields | The list of fields to use in the chart. | List of fields in the component | Y |
| Custom Color | Changes the default set of color to a new one based on the selected color. | Color Picker | N |
| Display Legend | Indicates if the legend should be displayed. | Boolean | Y |
| Display Data Label | Indicates if the label of data should be displayed. | Boolean | Y |
| Display Percentage | Indicates if a percentage should be displayed for each value in the chart. | Boolean | Y |
| Legend Item Click | Indicates if the legend is clickable. | Boolean | Y |
Pie Line
This widget is used inside a Pie widget to display a Pie chart based on line item information. Only one widget of this kind is allowed inside a Pie widget.
| SETTINGS | DESCRIPTION | FORMAT/VALUES | MANDATORY? |
|---|---|---|---|
| Name | The identifier of the widget. | Text Can't contain spaces or special characters. | Y |
| Description | The description of the widget. Is displayed in the user interface. Can be translated in the Translations space. | Text | Y |
| View | The view to be used to determine the view that contains the list of fields to be used. | List of views | Y |
| Component | The component to be used to determine the list of fields to use in the widget. | List of field components, belonging to the selected view. | Y |
| **Pie Custom Data | A pie widget is associated to a component. This component can be reused in other pie widgets. However, all the properties defined in the Pie Custom Data section are defined on the component. That means if some of these properties are updated on a pie widget, this update will be also performed on all widgets referencing the same component. | ||
| Pie Format | The type of UI chart to display. | "Pie", "Donut", "Semi Circle Donut" | Y |
| Fields | The list of fields to use in the chart. | List of fields in the component | Y |
| Custom Color | Changes the default set of color to a new one based on the selected color. | Color Picker | N |
| Display Legend | Indicates if the legend should be displayed. | Boolean | Y |
| Display Data Label | Indicates if the label of data should be displayed. | Boolean | Y |
| Display Percentage | Indicates if a percentage should be displayed for each value in the chart. | Boolean | Y |
| Legend Item Click | Indicates if the legend is clickable. | Boolean | Y |
Gauge
This widget is used to display a Gauge Chart. Check the dedicated Gauge chart documentation for more information on its behavior.
| SETTINGS | DESCRIPTION | FORMAT/VALUES | MANDATORY? |
|---|---|---|---|
| Name | The identifier of the widget. | Text Can't contain spaces or special characters. | Y |
| Description | The description of the widget. Is displayed in the user interface. Can be translated in the Translations space. | Text | Y |
| Minimized by default | Define if the widget is minimized when the quote is opened. | Boolean | Y |
Gauge Quote
This widget is used inside a Gauge widget to display a Gauge chart based on quote information. Only one widget of this kind is allowed inside a Gauge widget.
| SETTINGS | DESCRIPTION | FORMAT/VALUES | MANDATORY? |
|---|---|---|---|
| Name | The identifier of the widget. | Text Can't contain spaces or special characters. | Y |
| Description | The description of the widget. Is displayed in the user interface. Can be translated in the Translations space. | Text | Y |
| View | The view to be used to determine the view that contains the list of fields to be used. | List of views | Y |
| Component | The component to be used to determine the list of fields to use in the widget. | List of field components, belonging to the selected view. | Y |
| Gauge Custom Data | A gauge widget is associated to a component. This component can be reused in other gauge widgets. However, all the properties defined in the Gauge Custom Data section are defined on the component. That means if some of these properties are updated on a gauge widget, this update will be also performed on all widgets referencing the same component. | ||
| Field | The list of fields to use in the chart. | List of fields in the component | Y |
| Minimal Value | Value to use as the minimum in the chart. | Numeric | Y |
| Custom Color | Changes the default set of color to a new one based on the selected color. | Color Picker | N |
| Display Legend | Indicates if the legend should be displayed. | Boolean | Y |
| Display Data Label | Indicates if the label of data should be displayed. | Boolean | Y |
| Legend Item Click | Indicates if the legend is clickable. | Boolean | Y |
| Sector Separator | Indicates if a separator is used between sectors. | Boolean | Y |
Add as many custom data sectors as needed, they will be displayed in the Gauge chart, with the following settings:
| SETTINGS | DESCRIPTION | FORMAT/VALUES | MANDATORY? |
|---|---|---|---|
| Description | The label of the item. Is displayed in the user interface. Can be translated in the waterfall items grid by using the Translations button. Only used for Computed Benchmark kind of item. | Text | Y |
| Maximal Value | Value to use as the minimum in the sector. | Numeric | Y |
| Color | Changes the default set of color to a new one based on the selected color. | Color Picker | N |
Gauge Line
This widget is used inside a Gauge widget to display a Gauge chart based on line item information. Only one widget of this kind is allowed inside a Gauge widget.
| SETTINGS | DESCRIPTION | FORMAT/VALUES | MANDATORY? |
|---|---|---|---|
| Name | The identifier of the widget. | Text Can't contain spaces or special characters. | Y |
| Description | The description of the widget. Is displayed in the user interface. Can be translated in the Translations space. | Text | Y |
| View | The view to be used to determine the view that contains the list of fields to be used. | List of views | Y |
| Component | The component to be used to determine the list of fields to use in the widget. | List of field components, belonging to the selected view. | Y |
| Gauge Custom Data | A gauge widget is associated to a component. This component can be reused in other gauge widgets. However, all the properties defined in the Gauge Custom Data section are defined on the component. That means if some of these properties are updated on a gauge widget, this update will be also performed on all widgets referencing the same component. | ||
| Column | The list of columns to use in the chart. | List of columns in the component | Y |
| Minimal Value | Value to use as the minimum in the chart. | Numeric | Y |
| Custom Color | Changes the default set of color to a new one based on the selected color. | Color Picker | N |
| Display Legend | Indicates if the legend should be displayed. | Boolean | Y |
| Display Data Label | Indicates if the label of data should be displayed. | Boolean | Y |
| Legend Item Click | Indicates if the legend is clickable. | Boolean | Y |
| Sector Separator | Indicates if a separator is used between sectors. | Boolean | Y |
Add as many custom data sectors as needed, they will be displayed in the Gauge chart, with the following settings:
| SETTINGS | DESCRIPTION | FORMAT/VALUES | MANDATORY? |
|---|---|---|---|
| Description | The label of the item. Is displayed in the user interface. Can be translated in the waterfall items grid by using the Translations button. Only used for Computed Benchmark kind of item. | Text | Y |
| Maximal Value | Value to use as the minimum in the sector. | Numeric | Y |
| Color | Changes the default set of color to a new one based on the selected color. | Color Picker | N |
Rebates
This widget is used to display applicable rebates for the current quote's recipient. More information regarding Rebates and its functionalities can be found here.
| SETTINGS | DESCRIPTION | FORMAT / VALUES | MANDATORY |
|---|---|---|---|
| Name | The identifier of the widget. | Text Can't contain spaces or special characters. | Y |
| Description | The description of the widget. Is displayed in the user interface. Can be translated in the Translations space. | Text | Y |
| View | The view to be used to determine the view that contains the list of columns to be used. | List of available views | Y |
| Component | The component to be used to determine the list of fields to use in the widget. | List of available components for the selected view. Note: in an rebates in agreement use case the component must contain the following system fields: _SYS_START_DATE, _SYS_END_DATE, _SYS_AMENDMENT_DATE and _SYS_REF_CURRENCY. | Y |
| Recipient | The field in the quote that identifies the recipient account id must be configured. If there is no such field, a new field must be created and the value of the CRM context must be extracted. | List of fields components, belonging to the selected view. | Y |
| Agreement ID | The field in the quote that identifies the agreement id must be configured. If there is no such field, a new field must be created and the value of the CRM context must be extracted. | List of fields components, belonging to the selected view. | N |
Actions
Actions are created so that they can be added to widgets on pages in the layout structure or they can be used to define customizable keyboard shortcuts. Actions are usable in Performance Quoting on grid components and shown in either menus or dedicated buttons.
See Action Menus Structure to understand how actions are generated in the UI.
Some actions are defined as system actions. These actions are automatically available in the model and can't be modified (except Descriptions in the Translations section).
| NAME | DESCRIPTION |
|---|---|
| SYS_COPY_ROWS | Allows the user to copy a/several line(s) in the quote |
| SYS_COPY_ROWS_TO_CLIPBOARD | Allows the user to copy a/several line(s) in the clipboard (the user can paste the line in Excel for example) |
| SYS_CUT_ROWS | Allows the user to cut a/several line(s) in the quote |
| SYS_PASTE_ROWS | Allows the user to paste line(s) |
| SYS_PASTE_CELLS | Allows the user to paste cell(s) |
| SYS_DUPLICATE_ROWS | Allows the user to duplicate line(s) |
| SYS_DELETE_ROWS | Allows the user to delete line(s) |
| SYS_COPY_CELL | Allows the user to copy a cell |
| SYS_COPY_CELL_TO_CLIPBOARD | Allows the user to copy a cell in the clipboard |
| SYS_MOVE_ROWS | Allows the user to move a line in the grid |
| SYS_OPEN_ARRANGE | Allows the user to open the Arrange menu. From this menu, the runtime user will be able to hide/dock columns |
| SYS_OPEN_FILTERS | Allows the user to open the Filters menu. From this menu, the runtime user will be able to add some filters in the grid |
| SYS_OPEN_SORTS | Allows the user to open the Sort menu. From this menu, the runtime user will be able to sort columns in the grid |
| SYS_NORMAL_DENSITY | Allows the user to change the line height to normal |
| SYS_COMPACT_DENSITY | Allows the user to change the line height to compact |
| SYS_TIGHT_DENSITY | Allows the user to change the line height to tight |
| SYS_IMPORT_CSV_FILE | Allows the user to upload and import a CSV file to load lines in the grid |
| SYS_OPEN_CURRENCY_RATES | Allows the user to display the currency rates used in the quote |
| SYS_APPLY_ARRANGE | Allows the user to validate changes in the arrange menu |
| SYS_HIDE_COLUMNS | Allows the user to hide columns from the arrange menu |
| SYS_PIN_COLUMNS | Allows the user to dock columns from the arrange menu |
| SYS_APPLY_FILTERS | Allows the user to apply filters defined in the filter menu |
| SYS_APPLY_SORTS | Allows the user to apply sorts defined in the sort menu |
| SYS_MASS_UPDATE | Allows the user to massively edit some cells of a column |
| SYS_OPEN_RULES | Allows the user to define persisted rules to update some values of lines belonging to a defined scope |
| SYS_CHANGE_DISPLAY_CURRENCY | Allows the user to update the display currency |
| SYS_CHANGE_DISPLAY_LOCALE | Allows the user to update the display language |
| SYS_EXPORT_GRID_CONTENT | Allow the user to export the current grid in XLS format |
| SYS_DELETE_PERIOD | Allow the user to delete a period |
Then, additional actions can be added in the model. Actions are grouped by category.
You can add an action directly from the Actions line (in that case all available actions will be displayed and the new action will be added in the right category) or from a category (in that case, only actions available for this category can be added):
In the User Interface menu, click on Actions. The line is selected and colored yellow.
- Click on the plus symbol.
- Give the action a name and select the type of action. You can also define permissions:
| CATEGORY | ACTION | DESCRIPTION |
|---|---|---|
| Insert | ||
| Search and Add | Action used to search products in a Catalog from the quote grid header. | |
| Inline quick add | Action used to search products in a Catalog from the quote grid content. | |
| Multiple line item add product | Action used to generate PRODUCT type lines based on combinations selected by the user. | |
| Add bundle | Action used to add bundle lines in the quote. | |
| Add folder | Action used to add folder lines in the quote. | |
| Add specific | Action used to add specific lines in the quote. | |
| Multiple line item add specific | Action used to generate SPECIFIC type lines based on combinations selected by the user. | |
| Duplicate rows | Action for duplication of line items. | |
| Paste rows | Action for pasting of line items. | |
| Update | ||
| Predefined mass update | Action to define partially or fully mass edits that can be used by the user. | |
| Price goal seek | Action used to perform a Price Goal Seek in the user interface. | |
| Price guidance goal seek | Action used to perform a Price Guidance Goal Seek in the user interface. | |
| Refresh | ||
| Refresh | Action used to trigger a refresh of some lines for some data sources. | |
| Refresh External widget | Action used to trigger a refresh on external widget | |
| Import/Export/Custom Process | ||
| Import file | Action used to import some content in the quote in XSLX format. | |
| Export file | Action used to export some content from the quote in XLSX format. | |
| Custom process | Action used to trigger custom processes | |
| Doc Gen | ||
| Generate doc report | Action used to define the settings for a document generation. | |
| Generate Jasper report | Action used to define the settings for a jasper report generation. | |
| Generate Excel Report | Action used to define the settings for an excel generation. | |
| Open | ||
| Open catalog | Action used when opening a CPQ Catalog. | |
| Open configuration | Action used when reopening a CPQ Configuration Process in the user interface. | |
| Open widget | Action used to access a product page from a product search result list. | |
| Add to widget | Action used to add lines to other widgets such as charts. | |
| Open External widget | Action used to setup external widgets behavior on open. | |
| Open & Refresh Currency Rates | Action used to refresh the currency rates. | |
| On Select External widget | Action used to setup external widgets behavior on select line. | |
| Close | ||
| Close and synchronize | Action used to define what is synced with the CRM when leaving CPQ. | |
| Period | ||
| Add period | Action used to add a period in the quote | |
| Mass add period | Action used to add massively periods in the quote | |
| Mass edit end date | Action used to massively change the end date of lines | |
| Filter | ||
| Apply Aggregation Line Filter | Action used to apply the filter driving quote line aggregations |
DOC GEN FOLDER
GENERATE DOC REPORT
This action is used to define the settings for a document generation. Actions of this kind are not meant to be attached to specific elements of the UI. The purpose of this action is only to define settings for some document generations that will be then used from an outside system (example from a CRM).
This action includes the following settings:
| SETTINGS | DESCRIPTION | FORMAT/VALUES | MANDATORY? |
|---|---|---|---|
| Name | The identifier of the action. | Text Can't contain spaces or special characters. | Y |
| Description | The description of the action. Is displayed in the user interface. Can be translated in the Translations space. | Text | Y |
| Format | The expected output format of the generated document. Important: When choosing PDF as the output format, PROS is using an external library to generate the PDF document (see software dependencies of our technical requirement documentation here). PROS will do its best effort to solve any reported issue on the generated PDF but, as such, cannot guarantee to be able to find a remediation. | "DOCX" or "PDF" | Y |
| Template file name | The name of the template file that is used by the action to define the document to be generated | Text Should correspond to a valid template name. | Y |
| Generate with periods | The export mode for quote models with periods that will be used in the generated document. | List of available modes | N |
| Permissions | List of session states allowing this action | List of available session states | N |
GENERATE JASPER REPORT
This action is used to define the settings for a Jasper report generation. Actions of this kind are not meant to be attached to specific elements of the UI. The purpose of this action is only to define settings for some Jasper reports generations that will be then used from an outside system (example from a CRM).
This action includes the following settings:
| SETTINGS | DESCRIPTION | FORMAT/VALUES | MANDATORY? |
|---|---|---|---|
| Name | The identifier of the action. | Text Can't contain spaces or special characters. | Y |
| Description | The description of the action. Is displayed in the user interface. Can be translated in the Translations space. | Text | Y |
| View ID | View to be used as the data source of the report. | List of views from the Data model | Y |
| Component ID | Component to be used as the data source of the report. | List of columns components from the Data model, belonging to the selected view | Y |
| Encoding | Encoding format for the generated report. | "CP1252", "ISO_8859_1", "US_ASCII", "utf_16", "UTF_16BE", "UTF_16LE", "UTF-8" | Y |
| Format | The expected output format of the generated document. | "PDF", "HTML", " RTF", "XLS", "DOC", DOCX", "CSV", "XSLX" | Y |
| Template file name | The name of the template file that is used by the action to define the document to be generated | Text Should correspond to a valid template name. | Y |
| Select Expression | Jsonql expression to refine the scope of the data source. | JSON | N |
| Custom Configuration | List of key/value to be sent to the report | Text / Text | N |
| Permissions | List of session states allowing this action | List of available session states | N |
GENERATE EXCEL REPORT
This action is used to define the settings for an excel generation.
Actions of this kind are not meant to be attached to specific elements of the UI.
The purpose of this action is only to define settings for some excel generations that will be then used from an outside system (example from a CRM).
This action includes the following settings :
| SETTINGS | DESCRIPTION | FORMAT / VALUES | MANDATORY |
|---|---|---|---|
| Name | The identifier of the action. | Text Can't contain spaces or special characters. | Y |
| Description | The description of the action. Is displayed in the user interface. Can be translated in the Translations space. | Text | Y |
| Format | The expected output format of the generated document. | "XLSX" | Y |
| Generate with periods | The export mode for quote models with periods that will be used in the generated document. | List of available modes | N |
| Template file name | The name of the template file that is used by the action to define the document to be generated | Text Should correspond to a valid template name. | Y |
| Permissions | List of session states allowing this action | List of available session states | N |
Default Actions and Order in the CRM Widget
When Doc, Jasper, or Excel actions are added, they are by default organized alphabetically. To define their order and the default action for the CRM widget, it must be configured in the Quote Designer.
Configuration is done as follows:
- In the User Interface menu, navigate to the DocGen folder in the left bar
- Click on the Set DocGen Actions Order icon to open the dialog below
- Once there, you can reorder the list in the pop-up.
This set order of templates is then shown within the CRM Generate Report Widget.
EXPORT FILE
This action is used to export some content from the quote, in XSLX format. Actions of this kind can be attached to grid widgets in the UI, and used to trigger an excel export.
This action includes the following settings:
| SETTINGS | DESCRIPTION | FORMAT/VALUES | MANDATORY? |
|---|---|---|---|
| Name | The identifier of the action. | Text Can't contain spaces or special characters. | Y |
| Description | The description of the action. Is displayed in the user interface. Can be translated in the Translations space. | Text | Y |
| Rich Value Setting | Defines which values are exported for Rich kind of datatypes, that are composed by an Identifier and a Translatable Description | "ID", "DESCR", "ID_DESCR" | Y |
| View Id | View to be used to identify lines to be exported. | List of views from the Data model | Y |
| Component ID | Component to be used as the data source of the report. | List of columns components from the Data model, belonging to the selected view | Y |
| Export Fields | Indicates if fields from the component should be exported or not. | Boolean | Y |
| Export Hierarchy and FPK | Indicates if all necessary columns for reimporting the generated file will be exported by default and if the hierarchy is exported. | Boolean | Y |
| Use Admin View | Indicates if a potential filter on lines by a user on the view should be considered for the export of not. If = "Y", then the export will use the Admin View, which does not consider the user additional filter. | Boolean | Y |
| List of Fields | Specifies the list of fields to be exported regardless of the chosen component. | List of Fields | N |
| List of Columns | Specifies the list of columns to be exported regardless of the chosen component. | List of Columns | N |
| Permissions | List of session states allowing this action | List of available session states | N |
IMPORT FILE
This action is used to import some content in the quote, in XSLX format. Actions of this kind can be attached to grid widgets in the UI, and used to display a modal that will enables to upload an XLXS file to be imported.
This action includes the following settings:
| SETTINGS | DESCRIPTION | FORMAT/VALUES | MANDATORY? |
|---|---|---|---|
| Name | The identifier of the action. | Text Can't contain spaces or special characters. | Y |
| Description | The description of the action. Is displayed in the user interface. Can be translated in the Translations space. | Text | Y |
| Data Source | Indicates the Catalog Data Source to be used by default if none is specified in the import file. | List of Catalog Data Sources from the Data Model | N |
| Replacement Type | Indicates the policy for the supersession of products. | "Replace", "None", "Force" | Y |
| SYS_ROW_ITEM default workspace | Indicates the workspace to be used by default if none is specified in product id (ex: wksFood) | Use catalog workspace from data source Static workspace (text) | Y |
| Default Folder Line Template | Indicates the line template to be used by default if none is specified in the import file for Folder kind of lines. | List of Folder line templates from the Data Model | N |
| Default Specific Line Template | Indicates the line template to be used by default if none is specified in the import file for Specific kind of lines. | List of Specific line templates from the Data Model | N |
| Permissions | List of session states allowing this action | List of available session states | N |
| Line Insertion | |||
| Line position | Indicates whether imported lines should be inserted after the selection or before. If nothing selected, the policy at quote level is used (defined in User Interface - Settings). | “blank” (i.e. apply Quote defaults) , "Before", "After", “User Decision” | N |
| Line position in folder/bundle | Indicates whether imported lines should be created at the top or at the bottom of a the folder / bundle in which they are inserted. If nothing selected, the policy at quote level is used (defined in User Interface - Settings). | "Top", "Bottom" | N |
| Bundle insertion strategy | Defines if the added product should be inserted inside a selected bundle line in the quote. If nothing selected, the policy at quote level is used (defined in User Interface - Settings). | “blank” (i.e. apply Quote defaults) , "Same level", "Force Inside", “User Decision” | N |
| Folder insertion strategy (for Non Folder Lines) | Defines where the added line should be inserted based on a selected folder line in the quote. If nothing selected, the policy at quote level is used (defined in User Interface - Settings). | “blank” (i.e. apply Quote defaults) , "Force Inside", "Same Level", “User Decision” | N |
| Import policies | |||
| Lines with NO DUPLICATE Functional Primary Key policy | Indicates the policy when a line which is imported matched a line in the quote defined with the NO DUPLICATE function primary key policy. | Merge/Keep/Clean | Y |
| Lines with CONFLICTS Functional Primary Key policy | Indicates the policy when a line which is imported matched a line in the quote defined with the CONFLICTS function primary key policy. | Always add/Merge/Keep/Clean | Y |
| Lines with NO CONTROL Functional Primary Key policy | This parameter is not updatable but explains how lines are managed on lines where NO CONTROL policy is defined. | Not updatable | N |
PRICE GOAL SEEK
This action is used to perform a Price Goal Seek in the user interface. Actions of this kind can be attached to grid widgets in the UI, and used to display a modal that will ask the user for needed values in order to perform a Price Goal Seek.
This action includes the following settings:
| SETTINGS | DESCRIPTION | FORMAT / VALUES | MANDATORY |
|---|---|---|---|
| Name | The identifier of the action. | Text Can't contain spaces or special characters. | Y |
| Description | The description of the action. Is displayed in the user interface. Can be translated in the Translations space. | Text | Y |
| Explanation | An explanation showed to help the user when using the action | Text | N |
| Quantity Column | Indicates the column to be used as the quantity in the Price Goal Seek resolution. | List of numeric columns from the Data Model | Y |
| List Price Column | Indicates the column to be used as the list price in the Price Goal Seek resolution. | List of monetary columns from the Data Model | Y |
| Net Price Column | Indicates the column to be used as the net price in the Price Goal Seek resolution. | List of monetary columns from the Data Model | Y |
| Discount Column | Indicates the column to be used as the discount in the Price Goal Seek resolution. | List of numeric columns from the Data Model | Y |
| Exclusion Column | Indicates the column to be used as the exclusion in the Price Goal Seek resolution. | List of boolean columns from the Data Model | N |
| Weight Column | Indicates the column to be used as the weight in the Price Goal Seek resolution. | List of numeric columns from the Data Model | N |
| Application Scope | Defines the scope of application for configured products. | "ROOT", "LEAF" | Y |
| Permissions | List of session states allowing this action | List of available session states | N |
PRICE GUIDANCE GOAL SEEK
This action is used to perform a Price Guidance Goal Seek in the user interface. Actions of this kind can be attached to grid widgets in the UI, and used to display a modal that will ask the user for needed values in order to perform a Price Goal Seek.
This action includes the following settings:
| SETTINGS | DESCRIPTION | FORMAT/VALUES | MANDATORY? |
|---|---|---|---|
| Name | The identifier of the action. | Text Can't contain spaces or special characters. | Y |
| Description | The description of the action. Is displayed in the user interface. Can be translated in the Translations space. | Text | Y |
| Explanation | An explanation showed to help the user when using the action | Text | N |
| Quantity Column | Indicates the column to be used as the quantity in the Price Guidance Goal Seek resolution. | List of numeric columns from the Data Model | Y |
| List Price Column | Indicates the column to be used as the list price in the Price Guidance Goal Seek resolution. | List of monetary columns from the Data Model | Y |
| Net Price Column | Indicates the column to be used as the net price in the Price Guidance Goal Seek resolution. | List of monetary columns from the Data Model | Y |
| Discount Column | Indicates the column to be used as the discount in the Price Guidance Goal Seek resolution. | List of numeric columns from the Data Model | Y |
| Exclusion Column | Indicates the column to be used as the exclusion in the Price Guidance Goal Seek resolution. | List of boolean columns from the Data Model | N |
| List of Guidance Columns | Indicates columns to be used as the guidance thresholds in the Price Guidance Goal Seek resolution. | List of monetary columns from the Data Model | N |
| Application Scope | Defines the scope of application for configured products. | "ROOT", "LEAF" | Y |
| Permissions | List of session states allowing this action | List of available session states | N |
OPEN CATALOG
This action is used when opening a CPQ Catalog in the user interface. Actions of this kind can be attached to catalog widgets in the UI, in order to specify the data source to be used by this widget.
This action includes the following settings:
| SETTINGS | DESCRIPTION | FORMAT/VALUES | MANDATORY? |
|---|---|---|---|
| Name | The identifier of the action. | Text Can't contain spaces or special characters. | Y |
| Description | The description of the action. Is displayed in the user interface. Can be translated in the Translations space. | Text | Y |
| Data Source | Indicates the Data Source to be used by the Catalog Widget. | List of Catalog Data Sources | Y |
| Permissions | List of session states allowing this action | List of available session states | N |
OPEN WIDGET
This action is used to access to a product page from a product search result list. Actions of this kind can be attached to Search & Add widgets in the UI, in order to specify the catalog widget to be used when looking for the product page.
This action includes the following settings:
| SETTINGS | DESCRIPTION | FORMAT/VALUES | MANDATORY? |
|---|---|---|---|
| Name | The identifier of the action. | Text Can't contain spaces or special characters. | Y |
| Description | The description of the action. Is displayed in the user interface. Can be translated in the Translations space. | Text | Y |
| Widget | Indicates the catalog widget to be used when looking for the product page. | LIst of Catalog Widgets | Y |
| Permissions | List of session states allowing this action | List of available session states | N |
OPEN CONFIGURATION
This action is used when reopening a CPQ Configuration Process in the user interface. Actions of this kind can be attached to grid widgets in the UI, in order to define the catalog widget in which Configured products can be reopened.
This action includes the following settings:
| SETTINGS | DESCRIPTION | FORMAT/VALUES | MANDATORY? |
|---|---|---|---|
| Name | The identifier of the action. | Text Can't contain spaces or special characters. | Y |
| Description | The description of the action. Is displayed in the user interface. Can be translated in the Translations space. | Text | Y |
| Target ID | Indicates the catalog widget to be used when reopening Configured products. | List of Catalog Data Sources | Y |
| Initialize new configuration from existing | Defines if the reopen action should reopen the configured product or initialize a copy of it. See Opening Modes below. | Boolean | N |
| Permissions | List of session states allowing this action | List of available session states | N |
- Brand New configuration session / configured product
- Update of an existing configured product (opened from a quote line).
- New configuration session / configured product From an existing one
- This mode is configured when using "Initialize new configuration from existing" to True
- Note that ths mode needs to be used in conjunction with the Merge Configurable Product feature.In order to differentiate these three use cases, a Configurator session variable is initiated (CPE.Session.Settings.OpeningMode) with the following values:
- New
- Update
- NewFromExisting
Redirection Behavior: Note that the current version of Performance quoting does not support automated redirection when opening a configured product line. As such, it is recommended to configure the "open configuration" action to surface the configurable product UI in the current page.
"Target Id" should point to a widget that is embedded and available in the same page as the one from which the "open configuration" action is accessible.
SEARCH AND ADD
This action is used to search products in a Catalog from the quote grid header. Actions of this kind can be attached to Search & Add widgets in the UI, in order to define the source for the search and the behavior when adding a product to the quote.
This action includes the following settings:
| SETTINGS | DESCRIPTION | FORMAT/VALUES | MANDATORY? |
|---|---|---|---|
| Name | The identifier of the action. | Text Can't contain spaces or special characters. | Y |
| Description | The description of the action. Is displayed in the user interface. Can be translated in the Translations space. | Text | Y |
| Data Source | Indicates the Data Source to be used by the Search. | LIst of Catalog Data Sources | Y |
| Permissions | List of session states allowing this action | List of available session states | N |
| Line Insertion | |||
| Line Position | Defines where the added product should be inserted based on a selected product line in the quote. If nothing selected, the policy at quote level is used (defined in User Interface - Settings). | "Before", "After" | N |
| Line position in folder/bundle | Defines where the added product should be inserted based on a selected folder line in the quote. If nothing selected, the policy at quote level is used (defined in User Interface - Settings). | "Top", "Bottom" | N |
| Bundle insertion strategy | Defines if the added product should be inserted inside a selected bundle line in the quote. If nothing selected, the policy at quote level is used (defined in User Interface - Settings). | “blank” (i.e. apply Quote defaults) , "Same level", "Force Inside", “User Decision” | N |
| Folder insertion strategy (for Non Folder Lines) | Defines where the added line should be inserted based on a selected folder line in the quote. If nothing selected, the policy at quote level is used (defined in User Interface - Settings). | “blank” (i.e. apply Quote defaults) , "Force Inside", "Same Level", “User Decision” | N |
INLINE QUICK ADD
This action is used to search products in a Catalog from the quote grid content. Actions of this kind can be attached to Grid widgets in the UI, in order to define the source for the search, the way to display the result and the behavior when adding a product to the quote.
This action includes the following settings:
| SETTINGS | DESCRIPTION | FORMAT/VALUES | MANDATORY? |
|---|---|---|---|
| Name | The identifier of the action. | Text Can't contain spaces or special characters. | Y |
| Description | The description of the action. Is displayed in the user interface. Can be translated in the Translations space. | Text | Y |
| Data Source | Indicates the Data Source to be used by the Search. | LIst of Catalog Data Sources | Y |
| Scope | Provides a way to refine the search by specifying a limited scope. | CPQ CPE | N |
| Price Key | Indicates which catalog price should be displayed in the result list. | CPQ CPE | N |
| Show Description | Indicates if the Description of the product should be shown in the result list. | Boolean | Y |
| Show Name | Indicates if the Name of the product should be shown in the result list. | Boolean | Y |
| Permissions | List of session states allowing this action | List of available session states | N |
| Line Insertion | |||
| Line Position | Defines where the added product should be inserted based on a selected product line in the quote. If nothing selected, the policy at quote level is used (defined in User Interface - Settings). | "Before", "After" | N |
| Line Position in Folder/Bundle | Defines where the added product should be inserted based on a selected folder/bundle line in the quote. If nothing selected, the policy at quote level is used (defined in User Interface - Settings). | "Top", "Bottom" | N |
| Bundle insertion strategy | Defines if the added product should be inserted inside a selected bundle line in the quote. If nothing selected, the policy at quote level is used (defined in User Interface - Settings). | “blank” (i.e. apply Quote defaults) , "Same level", "Force Inside", “User Decision” | N |
| Folder insertion strategy (for Non Folder Lines) | Defines where the added line should be inserted based on a selected folder line in the quote. If nothing selected, the policy at quote level is used (defined in User Interface - Settings). | “blank” (i.e. apply Quote defaults) , "Force Inside", "Same Level", “User Decision” | N |
ADD FOLDER
This action is used to add FOLDER type lines in the quote. Actions of this kind can be attached to Grid widgets in the UI, in order to enable the end-user to add new kind of lines in the quote.
This action includes the following settings:
| SETTINGS | DESCRIPTION | FORMAT/VALUES | MANDATORY? |
|---|---|---|---|
| Name | The identifier of the action. | Text Can't contain spaces or special characters. | Y |
| Description | The description of the action. Is displayed in the user interface. Can be translated in the Translations space. | Text | Y |
| Line Template | Indicates the line template of the line to be inserted. | List of available FOLDER line templates. | Y |
| Compute Name Description | Indicates if the Name and Description of the created line should receive a default value. | Boolean | Y |
| Computed Name | Defines the label of the Folder when the Compute Name Description flag is set to true. The Computed Name Description can be translated in the Translations space. | Text | N |
| Auto Edit mode | Indicates if the system should automatically jump in an edition mode on the created line. | Boolean | Y |
| Permissions | List of session states allowing this action | List of available session states | N |
| Line Insertion | |||
| Line Position | Defines where the added line should be inserted based on a selected product line in the quote. If nothing selected, the policy at quote level is used (defined in User Interface - Settings). | “blank” (i.e. apply Quote defaults) , "Before", "After", “User Decision” | N |
| Line Position in Folder/Bundle | Defines where the added folder line should be inserted based on a selected folder line in the quote. If nothing selected, the policy at quote level is used (defined in User Interface - Settings). | "Top", "Bottom" | N |
| Folder insertion strategy (for Folders) | Defines if the added folder line should be inserted inside the selected folder line in the quote. If nothing selected, the policy at quote level is used (defined in User Interface - Settings). | “blank” (i.e. apply Quote defaults), "Same level", "Force Inside", “User Decision” | N |
ADD SPECIFIC
This action is used to add SPECIFIC type of lines in the quote. Actions of this kind can be attached to Grid widgets in the UI, in order to enable the end-user to add new SPECIFIC lines in the quote.
This action includes the following settings:
| SETTINGS | DESCRIPTION | FORMAT/VALUES | MANDATORY? |
|---|---|---|---|
| Name | The identifier of the action. | Text Can't contain spaces or special characters. | Y |
| Description | The description of the action. Is displayed in the user interface. Can be translated in the Translations space. | Text | Y |
| Line Template | Indicates the line template of the line to be inserted. | List of available SPECIFIC line templates. | Y |
| Compute Name Description | Indicates if the Name and Description of the created line should receive a default value. | Boolean | Y |
| Computed Name | Defines the label of the line when the Compute Name Description flag is set to true. The Computed name can be translated in the Translations space. | Text | N |
| Auto Edit mode | Indicates if the system should automatically jump in an edition mode on the created line. | Boolean | Y |
| Permissions | List of session states allowing this action | List of available session states | N |
| Line Insertion | |||
| Line Position | Defines where the added product should be inserted based on a selected product line in the quote. If nothing selected, the policy at quote level is used (defined in User Interface - Settings). | “blank” (i.e. apply Quote defaults) , "Before", "After", “User Decision” | N |
| Line Position in Folder/Bundle | Defines where the added product should be inserted based on a selected folder/bundle line in the quote. If nothing selected, the policy at quote level is used (defined in User Interface - Settings). | "Top", "Bottom" | N |
| Folder insertion strategy (for Non Folder Lines) | Defines where the added folder line should be inserted based on a selected folder line in the quote. If nothing selected, the policy at quote level is used (defined in User Interface - Settings). | “blank” (i.e. apply Quote defaults) , "Force Inside", "Same Level", “User Decision” | N |
| Bundle insertion strategy | Defines if the added product should be inserted inside a selected bundle line in the quote. If nothing selected, the policy at quote level is used (defined in User Interface - Settings). | “blank” (i.e. apply Quote defaults) , "Same level", "Force Inside", “User Decision” | N |
ADD BUNDLE
This action is used to add BUNDLE type of lines in the quote. Actions of this kind can be attached to Grid widgets in the UI, in order to enable the end-user to add new BUNDLE lines in the quote.
This action includes the following settings:
| SETTINGS | DESCRIPTION | FORMAT/VALUES | MANDATORY? |
|---|---|---|---|
| Name | The identifier of the action. | Text Can't contain spaces or special characters. | Y |
| Description | The description of the action. Is displayed in the user interface. Can be translated in the Translations space. | Text | Y |
| Line Template | Indicates the line template of the line to be inserted. | List of available BUNDLE line templates. | Y |
| Compute Name Description | Indicates if the Name and Description of the created line should receive a default value. | Boolean | Y |
| Computed Name | Defines the label of the line when the Compute Name Description flag is set to true. The Computed name can be translated in the Translations space. | Text | N |
| Auto Edit mode | Indicates if the system should automatically jump in an edition mode on the created line. | Boolean | Y |
| Permissions | List of session states allowing this action | List of available session states | N |
| Line Insertion | |||
| Line Position | Defines where the added product should be inserted based on a selected product line in the quote. If nothing selected, the policy at quote level is used (defined in User Interface - Settings). | “blank” (i.e. apply Quote defaults) , "Before", "After", “User Decision” | N |
| Line Position in Folder/Bundle | Defines where the added product should be inserted based on a selected folder/bundle line in the quote. If nothing selected, the policy at quote level is used (defined in User Interface - Settings). | "Top", "Bottom" | N |
| Folder insertion strategy (for Non Folder Lines) | Defines where the added folder line should be inserted based on a selected folder line in the quote. If nothing selected, the policy at quote level is used (defined in User Interface - Settings). | “blank” (i.e. apply Quote defaults) , "Force Inside", "Same Level", “User Decision” | N |
ADD TO WIDGET
This action is used to add lines to other widgets such as charts. Actions of this kind can be attached to Grid widgets in the UI, in order to select lines and send them to other widgets.
This action includes the following settings:
| SETTINGS | DESCRIPTION | FORMAT/VALUES | MANDATORY? |
|---|---|---|---|
| Name | The identifier of the action. | Text Can't contain spaces or special characters. | Y |
| Description | The description of the action. Is displayed in the user interface. Can be translated in the Translations space. | Text | Y |
| Type | Indicates the type of widget to which lines will be sent. | "Pie", "Gauge", "Waterfall", "Comparison" | Y |
| Widget | Indicates the widget to which lines will be sent. | List of available widget for the selected type. | Y |
| Permissions | List of session states allowing this action | List of available session states | N |
OPEN EXTERNAL WIDGET
This action is used to setup external widgets behavior when the page is loaded (open). Actions of this kind can be attached to External widgets in the UI.
This action includes the following settings:
| SETTINGS | DESCRIPTION | FORMAT / VALUES | MANDATORY |
|---|---|---|---|
| Name | The identifier of the action. | Text Can't contain spaces or special characters. | Y |
| Description | The description of the action. Can be translated in the Translations space. | Text | Y |
| URL | Indicates the field that contains the URL to open in the external widget. | List of fields | Y |
| Title | Label displayed on the widget at runtime | Text | Y |
| Title token | Indicates the field that can be used to display a dynamic title. (a token has to be defined in the Title to display the field. Ex: "My title $1") | List of fields | N |
| Permissions | List of session states allowing this action | List of available session states | N |
ON SELECT EXTERNAL WIDGET
This action is used to setup external widgets behavior when a line is selected (on select). Actions of this kind can be attached to External widgets in the UI.
This action includes the following settings:
| SETTINGS | DESCRIPTION | FORMAT / VALUES | MANDATORY |
|---|---|---|---|
| Name | The identifier of the action. | Text Can't contain spaces or special characters. | Y |
| Description | The description of the action. Can be translated in the Translations space. | Text | Y |
| Widget | Indicates the external widget to which the current action relates. | List of available external widgets. | Y |
| URL | Indicates the column that contains the URL to open in the external widget. | List of columns | N |
| Title | Indicates the column that can be used to display a dynamic title. | Text | N |
| Title token | Indicates the column that can be used to display a dynamic title. (a token has to be defined in the Title to display the element. Ex: "My title $1") | List of columns | N |
| Permissions | List of session states allowing this action | List of available session states | N |
OPEN & REFRESH CURRENCY RATES
This action is used to define the refresh policy for currency rates used in Performance Quoting. Actions of this kind can be attached to Grid widgets in the UI.
This action includes the following settings:
| SETTINGS | DESCRIPTION | FORMAT / VALUES | MANDATORY |
|---|---|---|---|
| Name | The identifier of the action. | Text Can't contain spaces or special characters. | Y |
| Description | The description of the action. Can be translated in the Translations space. | Text | Y |
| Refresh date field | Indicates the date field used to retrieve currency rates. Current date is used if no date is selected. | Field | N |
REFRESH EXTERNAL WIDGET
This action is used to setup external widgets behavior. Actions of this kind can be attached to External widgets in the UI.
This action includes the following settings:
| SETTINGS | DESCRIPTION | FORMAT / VALUES | MANDATORY |
|---|---|---|---|
| Name | The identifier of the action. | Text Can't contain spaces or special characters. | Y |
| Description | The description of the action. Can be translated in the Translations space. | Text | Y |
| Widget | Indicates the external widget to which the current action relates. | List of available external widgets. | Y |
| URL | Indicates the field that contains the URL to open in the external widget. | List of fields | Y |
| Title | Indicates the field that can be used to display a dynamic title. | Text | N |
| Title token | Indicates the field that can be used to display a dynamic title. (a token has to be defined in the Title to display the field. Ex: "My title $1") | List of fields | N |
| Permissions | List of session states allowing this action | List of available session states | N |
CLOSE AND SYNCHRONIZE
This action is used to define what is synced with the CRM when leaving CPQ. Actions of this kind can be attached to Headers in the UI.
This action includes the following settings:
| SETTINGS | DESCRIPTION | FORMAT/VALUES | MANDATORY? |
|---|---|---|---|
| Name | The identifier of the action. | Text Can't contain spaces or special characters. | Y |
| Description | The description of the action. Is displayed in the user interface. Can be translated in the Translations space. | Text | Y |
| View | View used to define lines included in the sync. | List of views from the Data model | Y |
| Component | Component used to define columns and fields included in the sync. | List of columns components from the Data model, belonging to the selected view | Y |
| Chunk Size | Size of the chunks sent during synchronization. Chunk size It is the role of the implementation teams to set the chunk size. Ideally, performing benchmarks to adapt this size to a given integration/project is the recommended way: A value too high would imply the Salesforce governor limit ( Heap size / CPU time ) to be hit. A value too low would cause the number of Salesforce jobs needed to manage the synchronization of a quote to be unnecessarily high, with a risk of overloading the job queue for the whole Salesforce organization. | Integer | Y |
| Data Source | Data source used for the synchronization. | List of data sources available | Y |
| Permissions | List of session states allowing this action | List of available session states | N |
| Sync with periods | The export mode for quote models with periods that will be used for the synchronization | List of available modes | N |
| Sync in System Mode | Synchronize all the data of the sync view via a system user, thus bypassing the end user access rights (see Advanced Sync Modes). | Boolean | N |
| Sync Empty Values | Force the sync of fields and / or columns that have been emptied in CPQ. All the CRM fields mapped on emptied CPQ fields / columns are thus emptied during the sync. (see Advanced Sync Modes). | Boolean | N |
| Sync Hierarchy and FPK | Force the sync of parent hierarchy when quote lines are part of a sync view in CPQ without their hierarchy (see Advanced Sync Modes). | Boolean | N |
MS Dynamics Solution for Performance Quoting
When Smart CPQ is integrated with MS Dynamics, the sync is triggered by a Close Cart & Sync action in the CRM Quote entity action bar:
This action is part of the PROS managed solution and does not need to be associated with any action as part of the CPQ Quote model. Therefore, no synchronization action has to be defined in the Quote Designer in the context of the integration with MS Dynamics CRM. See the Managed Solution Overview for more information.
REFRESH
This action is used to trigger a refresh of some lines for some data sources. Actions of this kind can be attached to Grid widgets in the UI.
This action includes the following settings:
| SETTINGS | DESCRIPTION | FORMAT/VALUES | MANDATORY? |
|---|---|---|---|
| Name | The identifier of the action. | Text Can't contain spaces or special characters. | Y |
| Description | The description of the action. Is displayed in the user interface. Can be translated in the Translations space. | Text | Y |
| Replacement Type | Indicates which mode to use to cover replacements of products during the refresh. | "None", "Replace", "Force" | Y |
| Keep User Inputs | Indicates if user inputs values should be kept when refreshing some values that are outputs of the refresh data source, and that have been overridden by the user. More details below. | Boolean | Y |
| Type | Defines what is the scope for the refresh: All - every lines and fields are included All Rows - every lines are included Fields - every fields are included Selected Rows - only selected lines are included Current View - every lines from the view used in the current grid are included View - every lines from the specified view used in the current grid are included | "All", "All Rows", "Fields", "Selected Rows", "Current View", "View" | Y |
| Refresh Bundle Mode | Indicates which mode to use to refresh bundle kind of lines. | "Reset all", "Reset non mutated only" | Y |
| Debounce time | Define the time between 2 calls (in ms). Default: 250ms. | Integer | Y |
| List of Data Sources | List of data sources to be refreshed during the process. | List of Data Sources from the Data Model | Y |
| View | View used to define lines that should be refreshed. Only valid if Type = "View". | List of views from the Data model | Y |
| Permissions | List of session states allowing this action | List of available session states | N |
Details on the Keep User Inputs setting when the list of Data Sources is defined on the refresh actions (column refresh).
The following columns are defined in the model:
- ColumnA - defined as output of a data source and user input
- ColumnB - defined with a formula (ColumnB*2) and user input
A Refresh action is defined with the setting Keep User Inputs to false. This action performs a refresh of the data source computing the ColumnA.
Step 1 - The line is added and the following data are displayed (4 is retrieved from the data source):
| NAME | COLUMNA | COLUMNB |
|---|---|---|
| Product1 | 4 | 8 |
Step 2 - The user updates the ColumnA and enters 5. ColumnB is computed again.
| NAME | COLUMNA | COLUMNB |
|---|---|---|
| Product1 | 5 | 10 |
Step 3 - The user updates the ColumnB and enters 11.
| NAME | COLUMNA | COLUMNB |
|---|---|---|
| Product1 | 5 | 11 |
Now, the user clicks on the Refresh button in order to refresh the data source computing the ColumnA.
Use Case 1: The data source returns the same value as the previous (4). After the refresh, the following data are displayed:
| NAME | COLUMNA | COLUMNB |
|---|---|---|
| Product1 | 5 | 11 |
User inputs are not cleared and the same values were returned by the data source. Use Case 2: The data source returns 5.
After the refresh, the following data are displayed:
| NAME | COLUMNA | COLUMNB |
|---|---|---|
| Product1 | 6 | 12 |
As the value returned by the data source has changed, the value set by the user is cleared and the ColumnA contains 6.
As the value computed by ColumnB has changed, the value set by the user is cleared and the ColumnB contains 12.
Line Refresh
On line refresh (when there is no data source defined), if the setting Keep User Input is FALSE, user inputs will be cleared for all use cases described above (except user inputs that don't have any computation (formula or output of a data source)).
PREDEFINED MASS ACTION
This action is to define partially or fully mass edits that can be used by the user. Actions of this kind can be attached to Grid widgets in the UI.
This action includes the following settings:
| SETTINGS | DESCRIPTION | FORMAT/VALUES | MANDATORY? |
|---|---|---|---|
| Name | The identifier of the action. | Text Can't contain spaces or special characters. | Y |
| Description | The description of the action. Is displayed in the user interface. Can be translated in the Translations space. | Text | Y |
| Label | Text | N | |
| Explanation | Text | N | |
| Scope | Indicates which lines should be the target of the mass edit: Target View - all lines in the specified view Current View - all lines in the view used in the current grid Selected Lines - all selected lines | "Current View", "Target View", "Selected Lines" | Y |
| View | View to be used to define the scope if in "Target View" mode | List of views from the Data model | Y |
| Column ID | Column to be updated. | List of columns from the Data model | N |
| Update Type | Defines how the update is done: Replace - change values to a new one. Absolute +/- - increase/decrease the value by a fixed value (only applies to numeric/monetary type columns). Reset - clear all user inputs and reset to default values. Copy From - copy the value from another column with a similar datatype. Differential +/- - increase/decrease the value by a percentage (only applies to numeric/monetary kind of columns). | "Replace", "Absolute +/-", "Reset", "Copy From", "Differential +/-" | N |
| Value | Value to be applied for Replace, Absolute +/- and Differential +/- update type | Depends on the column type | N |
| Copy Column ID | Column to be used as the source of data in a Copy From update type | List of columns from the Data model with a similar datatype than the target one. | N |
| Permissions | List of session states allowing this action | List of available session states | N |
Business Columns
When a Business column is selected, all the properties are mandatory. You can't define a partial predefined mass update with a Business column.
DUPLICATE ROWS
This action is used to duplicate lines in a grid. Actions of this kind can be attached to Grid widgets in the UI, in order to define the behavior when duplicating rows.
This action includes the following settings:
| SETTINGS | DESCRIPTION | FORMAT/VALUES | MANDATORY? |
|---|---|---|---|
| Name | The identifier of the action. | Text Can't contain spaces or special characters. | Y |
| Description | The description of the action. Is displayed in the user interface. Can be translated in the Translations space. | Text | Y |
| Permissions | List of session states allowing this action | List of available session states | N |
| Line Insertion | |||
| Line Position | Defines where the added product should be inserted based on a selected product line in the quote. If nothing selected, the policy at quote level is used (defined in User Interface - Settings). | “blank” (i.e. apply Quote defaults) , "Before", "After", “User Decision” | N |
| Line Position in Folder/Bundle | Defines where the added product should be inserted based on a selected folder/bundle line in the quote. If nothing selected, the policy at quote level is used (defined in User Interface - Settings). | "Top", "Bottom" | N |
| Folder insertion strategy (for Folders) | Defines if the added folder line should be inserted inside the selected folder line in the quote. If nothing selected, the policy at quote level is used (defined in User Interface - Settings). | “blank” (i.e. apply Quote defaults) , "Before", "After", “User Decision” | N |
| Folder insertion strategy (for Non Folder Lines) | Defines where the added line should be inserted based on a selected folder line in the quote. If nothing selected, the policy at quote level is used (defined in User Interface - Settings). | “blank” (i.e. apply Quote defaults) , "Before", "After", “User Decision” | N |
| Bundle insertion strategy | Defines if the added product should be inserted inside a selected bundle line in the quote. If nothing selected, the policy at quote level is used (defined in User Interface - Settings). | “blank” (i.e. apply Quote defaults) , "Before", "After", “User Decision” | N |
PASTE ROWS
This action is used to paste lines in a grid. Actions of this kind can be attached to Grid widgets in the UI, in order to define the behavior when pasting rows.
This action includes the following settings:
| SETTINGS | DESCRIPTION | FORMAT/VALUES | MANDATORY? |
|---|---|---|---|
| Name | The identifier of the action. | Text Can't contain spaces or special characters. | Y |
| Description | The description of the action. Is displayed in the user interface. Can be translated in the Translations space. | Text | Y |
| Permissions | List of session states allowing this action | List of available session states | N |
| Line Insertion | |||
| Line Position | Defines where the added product should be inserted based on a selected product line in the quote. If nothing selected, the policy at quote level is used (defined in User Interface - Settings). | “blank” (i.e. apply Quote defaults) , "Before", "After", “User Decision” | N |
| Line Position in Folder/Bundle | Defines where the added product should be inserted based on a selected folder/bundle line in the quote. If nothing selected, the policy at quote level is used (defined in User Interface - Settings). | "Top", "Bottom" | N |
| Folder insertion strategy (for Folders) | Defines where the added folder line should be inserted based on a selected folder line in the quote. If nothing selected, the policy at quote level is used (defined in User Interface - Settings). | “blank” (i.e. apply Quote defaults), "Same level", "Force Inside", “User Decision” | N |
| Folder insertion strategy (for Non Folder Lines) | Defines where the added line should be inserted based on a selected folder line in the quote. If nothing selected, the policy at quote level is used (defined in User Interface - Settings). | “blank” (i.e. apply Quote defaults) , "Force Inside", "Same Level", “User Decision” | N |
| Bundle insertion strategy | Defines if the added product should be inserted inside a selected bundle line in the quote. If nothing selected, the policy at quote level is used (defined in User Interface - Settings). | “blank” (i.e. apply Quote defaults) , "Same level", "Force Inside", “User Decision” | N |
CUSTOM PROCESS
This action is used to leverage Custom processes (defined in the Data Model section). This action can be attached to a grid widget in order to trigger a call to an external system. Row ids of the selected lines will be sent to the external system.
| SETTINGS | DESCRIPTION | FORMAT/VALUES | MANDATORY? |
|---|---|---|---|
| Name | The identifier of the action. | Text Can't contain spaces or special characters. | Y |
| Description | The description of the action. Is displayed in the user interface. Can be translated in the Translations space. | Text | Y |
| Custom Process | Name of the custom process to trigger when the click launch the action. | List of available custom processes | Y |
| Debounce time | Define the time between 2 calls (in ms). default: 250ms. | Integer | Y |
| Allow Multiple Selection | Define if the action is available when several lines are selected. | True/False | Y |
| Allow when No Selection | Define if the action is available when no line is selected. | True/False | Y |
MULTIPLE LINE ITEM ADD PRODUCT
This action is used to generate PRODUCT type lines based on combinations selected by the user. This action includes the following settings:
| SETTINGS | DESCRIPTION | FORMAT/VALUES | MANDATORY? |
|---|---|---|---|
| Name | The identifier of the action. | Text Can't contain spaces or special characters. | Y |
| Description | The description of the action. Is displayed in the user interface. Can be translated in the Translations space. | Text | Y |
| Data Source | Catalog Data source used for line template matching. | List of catalog data sources | Y |
| Permissions | List of session states allowing this action | List of available session states | N |
| Columns Definition | |||
| Line Template | Line template used to: retrieve the list of columns available in the columns setup (only columns flagged as User Input) retrieve the domain definition for each column selected in the columns setup | List of PRODUCT and SUBSCRIPTION line templates | Y |
| Price Key | Indicates which catalog price should be displayed in the result list. This price is display when the user selects some products at runtime in the popup. | Text | N |
| Columns Setup | Based on the selected line template, all the columns defined as "User Input" are displayed. The administrator can select the columns he wants to display in the popup at runtime for the combinations. For the selected columns, the administrator can define if Empty values are authorized (only 1 column). Columns that are flagged as "allowing an empty value" will take an empty value during line combination determination if none of its values creates a valid combination for a set of values of other columns. | List of columns | Y |
| Line Insertion | |||
| Line Position | Defines where the added product should be inserted based on a selected product line in the quote. If nothing selected, the policy at quote level is used (defined in User Interface - Settings). | “blank” (i.e. apply Quote defaults) , "Before", "After", “User Decision” | N |
| Line Position in Folder/Bundle | Defines where the added product should be inserted based on a selected folder/bundle line in the quote. If nothing selected, the policy at quote level is used (defined in User Interface - Settings). | "Top", "Bottom" | N |
| Folder insertion strategy (for Non Folder Lines) | Defines where the added line should be inserted based on a selected folder line in the quote. If nothing selected, the policy at quote level is used (defined in User Interface - Settings). | “blank” (i.e. apply Quote defaults), "Force Inside", "Same Level", “User Decision” | N |
Dynamic Filter
If a dynamic filter is associated to some columns that are selected in the Column Setup, this filter is applied during the process. In that case, if there are some incompatibilities between values, lines are not created.
For example, the following dynamic filter is associated with the line template selected on the action:
| SOLDTO | SHIPTO | ||
|---|---|---|---|
| = | Toulouse | = | Toulouse |
| = | Toulouse | = | Saint-Thibery |
| = | Saint-Thibery | = | Cugnaux |
| = | Saint-Thibery | = | Toulouse |
| = | Saint-Thibery | = | Saint-Thibery |
At runtime, the user selects Toulouse and Saint-Thibéry as SoldTo and Toulouse, Saint-Thibéry and Cugnaux as ShipTo.
Only compatible lines will be generated
| PRODUCT | SOLDTO | SHIPTO |
|---|---|---|
| myProduct | Toulouse | Toulouse |
| myProduct | Toulouse | Saint-Thibery |
| myProduct | Saint-Thibery | Saint-Thibery |
| myProduct | Saint-Thibery | Cugnaux |
| myProduct | Saint-Thibery | Toulouse |
The line below won't be added as the dynamic filter defines that Toulouse and Cugnaux are not compatible
| PRODUCT | SOLDTO | SHIPTO |
|---|---|---|
| myProduct | Toulouse | Cugnaux |
Personalize User Experience: From the Translations page, the administrator can define the title they want for the popup and and subtitle (through the parameter explanation).
MULTIPLE LINE ITEM ADD SPECIFIC
This action is used to generate SPECIFIC type lines based on combinations selected by the user. This action includes the following settings:
| SETTINGS | DESCRIPTION | FORMAT/VALUES | MANDATORY? |
|---|---|---|---|
| Name | The identifier of the action. | Text Can't contain spaces or special characters. | Y |
| Description | The description of the action. Is displayed in the user interface. Can be translated in the Translations space. | Text | Y |
| Line Template | Line template used to generate the lines. In addition, line template used to: retrieve the list of columns available in the columns setup (only columns flagged as User Input) retrieve the domain definition for each column selected in the columns setup | List of PRODUCT line templates | Y |
| Computed Name | Label of the line. Warning: the label will be the same for all the lines. That means if a Functional Primary Key is defined on the Row Item in NO DUPLICATE mode, only 1 line will be added. | Text | Y |
| Permissions | List of session states allowing this action | List of available session states | N |
| **Columns Definition | |||
| Columns Setup | Based on the selected line template, all the columns defined as "User Input" are displayed. The administrator can select the columns he wants to display in the popup at runtime for the combinations. For the selected columns, the administrator can define if Empty values are authorized (only 1 column). Columns that are flagged as "allowing an empty value" will take an empty value during line combination determination if none of its values creates a valid combination for a set of values of other columns. | List of columns | Y |
| Line Insertion | |||
| Line Position | Defines where the added product should be inserted based on a selected product line in the quote. If nothing selected, the policy at quote level is used (defined in User Interface - Settings). | “blank” (i.e. apply Quote defaults) , "Before", "After", “User Decision” | N |
| Line Position in Folder/Bundle | Defines where the added product should be inserted based on a selected folder/bundle line in the quote. If nothing selected, the policy at quote level is used (defined in User Interface - Settings). | "Top", "Bottom" | N |
| Folder insertion strategy (for Non Folder Lines) | Defines where the added line should be inserted based on a selected folder line in the quote. If nothing selected, the policy at quote level is used (defined in User Interface - Settings). | “blank” (i.e. apply Quote defaults) , "Force Inside", "Same Level", “User Decision” | N |
Dynamic Filter: See Multiple Line Item Add Product above.
Personalize User Experience: From the Translations page, the administrator can define the title they want for the popup and and subtitle (through the parameter explanation).
ADD PERIOD
This action is used to generate a new period in the quote. This action includes the following settings:
| SETTINGS | DESCRIPTION | FORMAT / VALUES | MANDATORY |
|---|---|---|---|
| Name | The identifier of the action. | Text Can't contain spaces or special characters. | Y |
| Description | The description of the action. Is displayed in the user interface. Can be translated in the Translations space. | Text | Y |
| Enable recurring period add | Allow the user to add multiple periods at once with a recurring pattern. | True/False | N |
| Permissions | List of session states allowing this action | List of available session states | N |
MASS ADD PERIOD
This action is used to generate massively periods in the quote. This action includes the following settings:
| SETTINGS | DESCRIPTION | FORMAT / VALUES | MANDATORY |
|---|---|---|---|
| Name | The identifier of the action. | Text Can't contain spaces or special characters. | Y |
| Description | The description of the action. Is displayed in the user interface. Can be translated in the Translations space. | Text | Y |
| Enable recurring period add | Allow the user to add multiple periods at once with a recurring pattern. | True/False | Y |
| Permissions | List of session states allowing this action | List of available session states | N |
Mass edit end date
This action is used to massively update the end of a line with periods in the quote. This action includes the following settings :
| SETTINGS | DESCRIPTION | FORMAT / VALUES | MANDATORY |
|---|---|---|---|
| Name | The identifier of the action. | Text Can't contain spaces or special characters. | Y |
| Description | The description of the action. Is displayed in the user interface. Can be translated in the Translations space. | Text | Y |
| Permissions | List of session states allowing this action | List of available session states | N |
Apply Aggregation Line Filter
This action is used to apply the filter driving quote line aggregations via Aggregation Lines.
This action allows you to filter the quote grid to display only the standard lines that belong to a given aggregation group.
This action includes the following settings :
| SETTINGS | DESCRIPTION | FORMAT / VALUES | MANDATORY |
|---|---|---|---|
| Name | The identifier of the action. | Text Can't contain spaces or special characters. | Y |
| Description | The description of the action. Is displayed in the user interface. Can be translated in the Translations space. | Text | Y |
| View | View containing the quote lines that will be part of the aggregation. | List of views from the Data model | Y |
| Permissions | List of session states allowing this action | List of available session states | N |
Action Menus Structure
Actions available from Performance Quoting User interface can be triggered from buttons, header menus or contextual menus depending on their types.
The following table gives an overview of how actions and menu entries are categorized and positioned in the User interface. Some actions or sections may or may not be visible depending on the quote model configuration and/or the user permissions and/or the context of the selection in the UI.
Customizable Keyboard Shortcuts
Customizable keyboard shortcuts are used to associate actions with keyboard shortcuts. These customizable shortcuts come in addition to regular keyboard shortcuts. Nine shortcuts can be customized, and they can be used in runtime by using the key combination "CTRL+1", "CTRL+2", up to "CTRL+9" (CMD instead of CTRL for MAC users). In the Designer, each shortcut can be assigned to the desired action by selecting it in the related dropdown.
Keyboard Shortcut List: All available keyboard shortcuts can be found by the end-user in the help menu at the top right of the quote runtime UI.
Insertion Before/After/Inside:
When multiple actions are generated by the user interface to let the end-user pick the way a line is inserted in the grid, the shortcut attached to the action is bound to the first button available for that particular action (First button on the left).
Themes
Themes are used to define specific adjustments to the general user interface aspect. Themes allow you to change the logo, colors, and fonts of the Performance Quoting interface. Several themes can be defined and used when opening a quote, depending on the channel or integrating system by example.
CREATE A THEME
To create a theme, select the item on the left by clicking on it, then click the + icon.
Give the element a name.
Once created, the theme is opened and you have access to all settings that can be modified. The theme will apply globally for all Locales.
For each theme, the following settings can be defined:
Logo
- A URL to an image - changes the PROS Smart CPQ logo to the new one
Title
- Changes the PROS Smart CPQ title to the text defined here
Primary Color
- Changes the main color of the user interface to the selected color
Folder Color
- Changes the folder lines background color of the user interface to the selected color
Fonts
- Several fonts can be changed in order to modify the font used in the user interface
- There are 6 different types of fonts that are used - Regular, Bold, Extra Bold, Light, Semi Bold and Italic.
- Each of them requires 3 parameters to be modified:
- A Base URL (for example, this is only an example, add your own URL: https
://fonts.gstatic.com/s/orbitron/v19/)
- Name of the font (case sensitive - yMJMMIlzdpvBhQQL_SC3X9yhF25-T1nyGy6BoWgz)
- Format of the font (case sensitive - woff2)
- The following font will then be used at runtime : https://fonts.gstatic.com/s/orbitron/v19/yMJMMIlzdpvBhQQL_SC3X9yhF25-T1nyGy6BoWgz.woff2
- A Base URL (for example, this is only an example, add your own URL: https
LOCALIZED THEME
You can also define individual settings for a specific Locale by using the + icon on the Theme line.
Settings that can be defined on the Localized level are the same than those for the root Theme level. Any setting specified on the Localized level for the current Locale will be used in runtime, then missing settings will be retrieved from the root level. Ultimately, if a setting is not defined in the customized theme, then the standard default value is used.
