INPUT PARAMETERS

The Settings File (Quote File) provides parameters needed to initialize the quotation process The setting file points to:

• A layout Id (corresponding to the Layout File)
• A model Id & Release (corresponding to the Model File (ModelName-ReleaseNb.xml & .bin))
  Note: The standard Settings File (createcart.xml) can be found in the CPQ home in the following folder: $CPQ_home_folder$/conf/run/settings/cart The standard Model

  File(s) (CPQModel_BasicSample-1.xml and .bin) can be found in the CPQ home in the following folder: $CPQ_home_folder$/conf/run/model The standard Layout File (cpqUI.xml) can be found on the CPQ server in the following folder: $CPQ_home_folder$/conf/run/layout/cart

  All these files are encoded in UTF-8. Ensure that this encoding is not altered when you edit them.

Launching Methods

3 methods are available to launch the Configurator.

In order to define your own quote model please check the following steps:

• [Log-in into CPQ Designer]

Once logged, open the standard model.

• [From the Quote Designer]
  • Save the quote As a new quote model:
    
    
• [Implement the business Logic]
  • You have just created a new quote model. You can now implement your own computations and

    actions.

• [Adjust the quote model for specific integration]

Quote integrated to CCS, salesforce.com or any other third party software may require some adjustments.

For salesforce.com integration, please refer to the corresponding Administration and customization guides.

In order to build your own user interface, you have to create your own layout file and theme directory.

• Duplicate the standard theme directory named ‘cameleon2011’ and choose a new name for your own theme:
  • You can find the standard theme in the following folder:

    *$CPQ_JBOSS$*standalone\deployments\cameleon.ear\cart.war\Theme

• Duplicate the cpqUI.xml file in the following folder: $CPQ_home_folder$/conf/run/layout/cart
• Link the new theme to the layout file and to the model file
• Edit the new layout file and replace all the references to the former theme by the new theme name.
  • In particular and the resources: Theme/cameleon2011/img/btnHelp.png
• Open the Model xml file
  • Replace all the references to the former theme by the new theme name.
  • You should have only 1 reference to the former theme: <layoutDefthemeName="cameleon2011">
    Reference: For more details about the Quote UI, please refer to the chapter Customizing the user interface:

You can setup your own services either directly in the XML setting file or if they are common (i.e. available for all end-users), you can define them in the cartService.properties file

CONFIGURATOR SERVICE INITIALIZATION

For each Configurator service (named “CONF_XX” in the table below), provide the following properties:

In order to inject a setting (or override a given value) from the declaration of the service you have to define the CPE of the setting and its value as follows: service.CONF_XX.CPE.Settings.Session.MySetting=MySettingValue

CATALOG SERVICE INITIALIZATION

For each Catalog service (named “CAT_XX” in the table below), provide the following properties:

In order to inject a setting (or override a given value) from the declaration of the service you have to define the CPE of the setting and its value as follows: service.CAT_XX.CPE.Settings.Session.MySetting=MySettingValue

targetPage / targetCPE

In cartServices.properties, targetPage and targetCPE settings may be used to point or open a service directly on a specific object with its dedicated UI page.

These settings have to be added to an existing service. For example:

### Source Service CAT ###

service.CAT_XX.catalogType=CT7

service.CAT_XX.xmlLayoutURI=catXXUI.xml

service.CAT_XX.xmlCatalogURI=catalog.xml

service.CAT_XX.xmlSavedCatalogURI=saved-catalog.xml

service.CAT_XX.targetCPE=CPE.workspace/CL/cat.CL/col.CL/colX

service.CAT_XX.targetPage=collectionPage

service.CAT_XX.FR=Catalog

service.CAT_XX.US=Catalog

In that case, opening the catalog from the quote will display at first the collection page of collection colX.

You can point to various types of objects in the catalog tree (Collections, StandardItems, SalesProducts, GuidedSelling).

For instance:

service.CAT_XX.targetCPE=CPE.workspace/CL/cat.CL/col.CL/colX

service.CAT_XX.targetCPE=CPE.workspace/CL/cat.CL/col.CL/colX.SI/siX

service.CAT_XX.targetCPE=CPE.workspace/CL/cat.CL/colGuided.CP/guidedX

The “.workspace” in the CPE must be respected.

For each kind of object one wants to point on through the targetCPE setting, there is a dedicated UI page to specify with the targetPage setting. It can be any UI page available in the UI xml file specified in the service (xmlLayoutURI).

See below table for examples of corresponding values between targetCPE object type and targetPage:

REPORT SERVICE INITIALIZATION

For each report service (named RPT_XX in the table below), provide the following properties:

• By default, the generated file is named as follows:

serviceID_SimpleDateFormat{_Counter).pdf

The _Counter element is not included in the filename if only one file is generated during the session. As soon as at least two files are generated the same day (same SimpleDateFormat) and during the same session, the _Counter element will not be included in the filename for the first generated document, will be equal to 1 for the second generated document, will be equal to 2 for the third generated document, etc.

• If an input parameter 'reportFileName' is present in the JasperTemplate and is part of the cart session values

this parameter is used to define the name of the output file:

{reportFileName value}{_Counter).pdf

In that case, the _Counter element is not included in the filename if only one file is generated during the session. As soon as at least two files are generated during the same session,

the _Counter element will not be included in the filename for the first generated document, will be

equal to 1 for the second generated document, will be equal to 2 for the third generated document, etc.

• In case the reportFileName has invalid characters, the report name is set to be the default value for the reportFileName parameter from the report template
• In case there is not a default value for the reportFileName parameter from the report template, the format is serviceID_SimpleDateFormat{_Counter).pdf
  Note: At runtime, the used entry template for jasper is looked up into the following directory:

  {CPQ_Home}/conf/run/reports/jasper/{subDirectory}/{reportFile} Or

  {CPQ_Home}/conf/run/reports/jasper/{subDirectory}/{LanguageID}/{reportFile} if Multilanguage = ‘yes’.