How to Launch the CPQ UI
Configurator
INPUT PARAMETERS
3 input parameters are required to launch the Configurator: the Layout file (see definition above), the Configuration file and a path to the Result file.
The Settings File (Configuration File) provides parameters needed to initialize the configuration session (Targeted Configurable Product and Sales Method, Session Settings…Etc.)
The Result File corresponds to the output file used to store the result of the configuration process.
$cpq_home_folder$/conf/run/settings
The standard Layout File (configuratorUIDesktop.xml) can be found on the CPQ server in the following folder:
$cpq_home_folder$/conf/run/layout
The XML layout file structure is described by a XSD schema located by default on your CPQ server:
$cpq_home_folder$/conf/xsd/configuratorUI.xsd
LAUNCHING METHODS
3 methods are available to launch the Configurator.
Method 1 – from within the Designer
Run the Configurator from the Designer.
- [In the menu toolbar]
Execute the ‘Run current’ function
- [In the popup]
Fill the three file parameters (files stored on your CPQ server (Layout/Configuration Server Files)
- Click on ‘Ok’
Method 2 – from within Quote
- Create an eConfigurator service [Possible containers for this service are eHome, eMenu] to access a model previously created in the Designer
- Fill all the following service parameters:
| PARAMETERS | DESCRIPTION | EXAMPLE |
|---|---|---|
| confType | The value of this parameter has to be "CP7" to be used with the Configurator. 3 parameters below must be filled. If "confType" is not defined, or valuated with another value than "CP7", Configurator V6 is used. Then parameters detailed in the following table have to be filled. | CP7 |
| xmlLayoutURI | Configuration XML layout file to be used by CPQ UI for the configuration UI rendering. | configuratorUI.xml |
| xmlConfigurationURI | Configuration settings XML file. | configuration.xml |
| xmlSavedConfigurationURI | Backup file of the configuration on the server. This backup is done with a SAVE action inserted in the 'xmlLayoutURI' file. | configurationsaved.xml |
Method 3 – via a Web Service
In order to ease the integration of the Configurator component into others applications, a Web service connector is distributed as part of the CPQ package.
Details on the integration via a Web Service: Please check “APPENDIX A – CPQ UI”.
Catalog
INPUT PARAMETERS
3 input parameters are required to launch the Catalog: the Layout file (see definition above), the Catalog file and a path to the Result file.
The standard Settings File (Catalog File) provides parameters needed to initialize the Catalog session as well as the embedded configuration process (Root Collection, Pricing methods, Sales Method … Etc.)
The Result File corresponds to the output file used to store the XML representing a product (when using the SAVE action).
$cpq_home_folder$/conf/run/settings
The standard Layout File (catalogUIDesktop.xml) can be found on the CPQ server in the following folder:
$cpq_home_folder$/conf/run/layout
The XML layout file structure is described by a XSD schema located by default on your CPQ server:
$cpq_home_folder$/conf/xsd/catalogUI.xsd
LAUNCHING METHODS
3 methods are available to launch the Catalog.
Method 1 – from within the Designer
Run the Catalog / Collection process from the Designer
- [In the menu toolbar]
Execute the ‘Run current’ function
- [In the popup]
Fill the three file parameters (files stored on your CPQ server (Layout/Configuration Server Files)
- Click on ‘Ok’
Method 2 – from within Quote
- Create an eConfigurator service [Possible containers for this service are eHome, eMenu] to access a model previously created in the Designer
- Fill all the following service parameters:Customization Guide
| PARAMETERS | DESCRIPTION | EXAMPLE |
|---|---|---|
| catalogType | The value of this parameter has to be "CT7" to be used with the Catalog. 3 parameters below must be filled. | CT7 |
| PARAMETERS | DESCRIPTION | EXAMPLE |
|---|---|---|
| xmlLayoutURI | Catalog XML layout file to be used by CPQ UI for the catalog UI rendering. | catalogUI.xml |
| xmlCatalogURI | Catalog settings XML file. | catalog.xml |
| xmlSavedCatalogURI | This file stores the XML exported from the current standard item when the SAVE action is triggered from the catalog. | catalogsaved.xml |
Method 3 – via a Web Service
In order to ease the integration of the Catalog component into others applications, a Web service connector is distributed as part of the CPQ package.
Details on the integration via a Web Service: Please check “APPENDIX A – CPQ UI ”.
Manufacturing Only
It is possible to launch the manufacturing engine without launching the complete configuration UI.
In that case, only the manufacturingPage of the layout file will be used to render the manufacturing results.
This way to launch the manufacturing process can be used from Designer or from Quote
INPUT PARAMETERS
3 input parameters are required to launch the Manufacturing: the Layout file (see definition above), the Setting file and a path to the Result file.
The Settings File provides parameters needed to initialize the manufacturing process. It corresponds to a configurable process file which is complete and contains all data necessary to run de manufacturing (Targeted Configurable Product and Sales Method, Session Settings…Etc.)
The Result File corresponds to the output file used to store the result of the configuration and manufacturing process.
LAUNCHING METHODS
3 methods are available to launch the Manufacturing Process (from the corresponding project).
Method 1 – from within the Designer
Run the Manufacturing process from the Designer
- [In the menu toolbar]
Execute the ‘Run current’ function
- [In the popup]
Fill the three file parameters (files stored on your CPQ server (Layout/Configuration Server Files)
- Click on ‘Ok’
Method 2 – from within CPQ
- The Configurator and the Catalog services include a parameter allowing to specify which configurator layout file has to be used to visualize the result of the manufacturing process. (when using the ViewManufacturing action of the Quote model)
| PARAMETERS | DESCRIPTION | EXAMPLE |
|---|---|---|
| confType | The value of this parameter has to be "CP7" to be used with the Configurator. 3 parameters below must be filled. If "confType" is not defined, or valuated with another value than "CP7", Configurator V6 is used. Then parameters detailed in the following table are to be filled. | CP7 |
| xmlLayoutURI | Configuration XML layout file to be used by CPQ UI for the configuration UI rendering. | configuratorUI.xml |
| xmlConfigurationURI | Configuration settings XML file (COMPLETE – with all data necessary to run the manufacturing process). | ConfigurationManufacturing.xml |
| xmlSavedConfigurationURI | Backup file of the configuration on the server. This backup is done with a SAVE action inserted in the 'xmlLayoutURI' file. | configurationsaved.xml |
| xmlManufacturingLayoutURI | Configuration XML layout file to be used by CPQ UI for the rendering of the manufacturing | configuratorUI.xml |
Method 3 – via a Web Service
In order to visualize the manufacturing results from a XML file already containing the generated manufacturing data, the ConfiguratorUI WS has to be called in ReadOnly and ManufacturingOnly
mode. (In such a case, only the manufacturing page will be displayed and accessible in the User Interface.)