Data Sources
Data sources allow Performance Quoting to retrieve data from different sources as needed. You can define the following types of data sources:
- Catalog and Enterprise Catalog
- Pricing (RTPE)
- Dimension
- External
- CRM
- Subscription
Rebates
For each type, the data sources are listed on the left and you configure the selected data source on the right.
Each data source type has the same screen structure:
- Action bar - create, duplicate, and delete data sources.
- Left pane - shows the data source list.
- Configure the data source on the right: define General Settings, Column Mapping, and Field Mapping. Use the buttons on the top of the right window to switch between these options.
Settings Common to All Data Source Types
This section describes the settings and mapping that are common to all types of data sources.
GENERAL SETTINGS
Each type of data source has a section in General Settings that allows you to define static or variable settings that are sent from the quote to the data source.
These settings are sent each time a call to the data source is triggered. You need to use these settings to send the needed information and request the data source (e.g. locale, currency).
To add a setting:
- Click Add Setting.
- Define if the setting is a static value or a quote field and fill in the information.
- Click Add to save.Note: Static settings are not available for Pricing, Dimension, and CRM data sources.
More information on required settings, depending on the type of data source, can be found in Connect.
GET COLUMN MAPPING / GET FIELD MAPPING
Each type of data source has a Get Column Mapping and/or Get Field Mapping button. Column/field mapping is used to retrieve data on lines and/or fields. The mapping definition relies on a map using quote columns and keys.
To add a map:
- click on Add a Map.
- Give the map a name and select a policy:
- None: no policy defined.
- Once: the query to the data source is triggered only once at quote opening.
- Each Input: the query to the data source is performed every time a change is made on the inputs of the map.
- Reload: the query to the data source is performed every time the quote is reloaded.
- Each Input and Reload: Combination of the two policies above.
- The map is added next to the action buttons. The example below has 2 maps. Select the map by clicking on the corresponding tab.Note: You can add, duplicate, and delete a map using the action buttons.
In addition, you can associate line templates to this map directly from this screen
- Once selected, you can add input keys and output keys using the corresponding actions.
Mapping Types
Input mapping elements can be columns and/or fields. Output mapping elements can only be columns.
Default Settings
A catalog data source has 2 settings by default - locale and currency. A dimension data source has one setting by default: locale.
Settings for Specific Data Source Types
CATALOG
In the General Settings window, the specific settings for a catalog data source are:
- Definition
- Catalog Search Definition
Definition
This section allows you to define a server. If you use only 1 Smart CPQ instance, which is the standard and most common setup, this parameter is not necessary. However, if several catalog instances (Smart CPQ servers) are provisioned for your quote environment, you need to define the server name. The server name is created during the setup of your platform. Please reach out to your PROS representative to get this information. Check the Inherited context box if you want to inherit a defined context. If checked, select the context from the list and click Done.
Catalog Search Policy Definition
Define the search policy settings (the equivalent of the search policy definition in the catalog layout).
Depending on the selected type, some settings must be defined:
Standard
- Operator: equal or like (equal means that text must be an exact match, like means that text can be similar but not an exact match.)
Case sensitive: true or false
- Scope: criteria included in the search (name and/or description and/or Rich Media Object (RMO) Text)
- RMO User Type: define if the search is performed on a specific user type (empty means the search is performed on all user types)
Full Text
- Search mode: defines the granularity of the search (Sentence or Across fields or Single field).
- Scope: criteria included in the search (Name / Description / RMO, Business Properties / PDF
/ Product Link). The scope can be ordered to define the search order.
Settings
Some settings are necessary for the catalog to be launched.
For a catalog data source, there are 2 settings by default: locale and currency. These settings are
mapped by default to the Data Locale and system variables.
Advanced
- Server Name: The name of the Smart CPQ server hosting the Catalog instance can be forced here.
- UI Server Name: The name of the Catalog UI server can be forced here. The goal is to be able to use a Catalog UI from a different endpoint than the data operations (getData, translate, etc) , within the same Data Provider. By default, the access to this option is disabled and requires a ticket to be enabled.
ENTERPRISE CATALOG
Enterprise Catalog is new generation of catalog for Smart CPQ. For now, this type of catalog is not available per se. However, Conga is deploying backend bricks to prepare the delivery of this new module.
Today, the Enterprise Catalog Data Source is only useful if you configured our Collaboration Portal.
Navigate to Data Model in the main menu bar and select the Enterprise Catalog Data Source.
- In the quote designer, there is a wizard to help you copy the settings from an existing Catalog Data Provider to an Enterprise Catalog Data Provider. Select the existing data source currently in use for the Collaboration Portal.
- Save
PRICING
Two types of Pricing Data Sources can be defined: one leveraging PROS Real-Time Pricing Engine and the other one leveraging the CPQ pricing.
Only one can be made available at the same time for a given quote model (depending on feature flags).
The settings for each Pricing data provider are different (see below).
Real-Time Pricing Engine (RTPE)
In the General Settings window, set the name of the pricing method (mandatory), component name (used for scale pricing), and any overrides using the Add button.
DIMENSION Business Values (BVAL) are authorized in the output mapping of a Pricing (RTPE) data provider. They avoid using a string column as output and mapping that string value to another Business Value column. It thus prevents from using too many columns in the quote model when trying to retrieve dimensions from RTPE.
The principle consists of defining a DIMENSION Business Value as the output of a Pricing data provider solely based on its name and ensuring that the corresponding output column is plugged into a Dimension data provider. As a result, the value returned by RTPE is automatically transformed into a DIMENSION Business Value in the quote.
For example:
- Create a Dimension data provider (see below).
On a given line template, define a Business cell driven by the Dimension data provider you created.
In the RTPE Pricing data provider, add the newly created business value as an output and map it with a dimension defined in RTPE.
- In a quote created from this model, add a product corresponding to the above line template.
- The cell value should be a complete Dimension Business Value, including its description and path.
Multi-Select value
When mapping a multi-select value as an input in an RTPE data source definition, the value of the related Cell or Field will be automatically concatenated prior to being sent to RTPE.
The separator of this concatenated string can be defined in General Settings > Multiple Value Separator:
CPQ Pricing
In the General Settings window,
- set the CPE of the pricing method (mandatory). For example, wksMyWorkspace/PRGM/defaultPM
- the model version (mandatory). It can be defined either via a static value (e.g. WORKING) or a dynamic value based on a quote field.
- the application date to drive the validity of the prices.
The Advanced section allows you to define the Smart CPQ instance where prices are stored. If you use only 1 Smart CPQ instance, which is the standard and most common setup, this parameter is not necessary. However, if several instances of Smart CPQ are provisioned for your quote environment, you need to define the server name. The server name is created during the setup of your platform.
Please reach out to your PROS representative to get this information. In the Get Column Mapping tab,
- The _SYS_ROW_ITEM is mandatory as input. Other dimensions can be mapped on pricing aliases.
- Regarding outputs, the CPQ Pricing allows several price ranges for each product. Each one is accessible in the output section with the output key Range[n]. For instance:
DIMENSION
For the dimension data source, in the General Settings window, define the dimension name.
EXTERNAL
In the General Settings window, define the service name and if the context is inherited or not by checking the check box.
CRM
For a CRM data source, add settings and field mapping (as explained above in the section on settings common to all data sources).
Multi-Select value
When mapping a multi-select value as an input in a CRM data source definition, the value of the related Cell or Field will be automatically concatenated prior to being sent to the CRM.
The separator of this concatenated string is a "," (comma).
SUBSCRIPTION
You can only have one subscription data source. In the General Settings, you can select what fields to use for the quote default renewal policy and default cancellation policy. These are optional settings.
When a subscription product is added to the quote, Smart CPQ assigns its renewal policy. The
assigned value is:
- The quote default renewal policy IF that policy is eligible for the rate plan,
otherwise
- The first eligible renewal policy for the rate plan
The same is done for the cancellation policy.
REBATES ESTIMATES
In addition to the Rebates widget that you can add to the quoting workflow to visualize and manage rebates, you can also associate the Rebates service with a column in the quote model to assess the impact of rebates on quote lines.
You need to have Rebates activated on your instance and to define a Rebates data source to address the latter.
General Settings
| Input Key | Input name | Input description | Mandatory |
|---|---|---|---|
| Dimension keys | The names of the dimension that will be used to perform item match. There can be several, but there must be at least one | Yes (at least one) | |
| REBATE_AGREEMENT_ID | Agreement Id | The agreement ID field defined in the Quote Model | Yes |
Column or Field Input Mapping
It is possible to add inputs with custom keys that are not in this list. They will be ignored by the data provider and can be used to force the trigger of the DP call for instance.
| Key | Name | Description | Mandatory? | Allowed data type(s) |
|---|---|---|---|---|
| REBATE_EXPECTED_REVENUE | Expected Revenue | Expected Revenue for the item. | Yes | MonetaryValue |
| REBATE_EXPECTED_VOLUME_AMOUNT | Expected Volume Amount | Expected Volume for the item. | Yes | Numerical value: Integer, Long or Big DecimalOr Measure |
| REBATE_UNIT_OF_MEASURE | Expected Unit of Measure | Expected unit of measure for the item. | It must be present if volume is numerical.It must be empty if Volume is of type measure. | Unit Of Measure |
| REBATE_ESTIMATION_DATE | Estimation date | The date for which we want to estimate rebates impact. | Yes | LocalDate |
| Dimension key among the ones defined in the general settings | Dimension keys | Set of dimension keys that will be used to match the item in the agreement. Each dimension key represents the name of a dimension, and we need to associate a value for each of those keys | At least one | Any |
Column or Field Output Mapping
It is not possible to add any other outputs.
| Key | Name | Description | Mandatory? | Allowed data type(s) |
|---|---|---|---|---|
| REBATE_IMPACT | Rebate impact | The rebate impact amount tied to the line based on existing rebates. | Yes | MonetaryValue |
