Asset: Industries Communications Cloud - SFI CME EPC and CPQ Reports and Dashboards Unmanaged Package
Context
In SFI CME, when we are configuring data, checking, and debugging we need to analyse reports and dashboards that make a little bit better our lives helping to debug issues, detecting poor data, bad configuration, bugs...
All data configured is susceptible to be checked in the Org to see if the data is corrupted, is orphan, is well designed and implemented and so on. There are many issues at run time that are happening in Industries CME because of a bad quality of data, bugs in the configuration and other items that are impacting at run time: CPU Time Limit exceeded, exception errors, performance... and it is difficult to analyse the root cause of the problem without having a look to the managed package logs from Industries CME package.
Unfortunately, there are no so many references in the official documentation for this matter, except the known product attributes report from the Product Designer → https://docs.vlocity.com/en/Export-a-Product-Report-in-Product-Designer.html, so the creation of this asset is a good starting point.
This page will address with some of these issues that we have in our daily basis and will help you to debug configuration implemented, understand the CPQ Advanced rules and Attribute Rules and other aspects in general from the CME Industries Cloud.
The components are reports and dashboards that will help you to identify the CPQ Advanced Rules configured and number about the same, the Attribute Rules configured per products and how the configuration is done.
Some samples can be shown in the following pictures:
All Advanced Rules Activated Joined Report
All Product Attribute Rules Joined Report
Dashboard
Installing via URL for Unmanaged Package either for Production and Sandbox Orgs:
List of Components | |
|---|---|
Dashboard Folder | EPCandCPQDashboards |
Dashboard | FltzYeqBWaYRgOWlwkohQkHqlzXfje |
Fields | %vlocity_namespace%__ProductRelationship__c.Message__c |
Profiles | Admin.profile |
Custom Report Types | Entity_Filters_with_Conditions |
Custom Report Types | Product_Attributes_Assignment |
Custom Report Types | Product_Configuration_Procedures_for_Attribute_Rul |
Custom Report Types | Rule_Actions_for_Advanced_Rules |
Custom Report Types | Rule_Filter_for_Advanced_Rules |
Custom Report Types | Rule_Variable_for_Advanced_Rules |
Report Folder | EPCandCPQReports |
Reports | All_Active_Advanced_Rules_Joined |
Reports | All_Product_Attribute_Rules_Join |
Reports | Product_Attribute_Rules |
Reports | Product_Attributes_Assignment |
Reports | Rule_actions_with_Conditions |
Reports | Rule_actions_without_Conditions |
Deployment
Prerequisites
Version SFI CME
≥ 236 Spring 22 Industries CME Managed Package
Version SFI CME
≥ 236 Spring 22 Industries CME Managed Package
Deploying using Unmanaged Package URL
You will just need to install the following Unmanaged Package via these 2 URLs and follow the standard instructions from the installation of the package:
After a successful installation, You will find the reports in the EPC and CPQ Reports Folder and the Dashboard in the EPC and CPQ Dashboards Folders in your Org.
The custom reports types can be found under SETUP → Report Types.
Post-installation steps
There are a few post-installation steps that are needed here as for the Joined reports only 1 block is deployed and not the other ones. This is a known issue documented here: https://trailblazer.salesforce.com/issues_view?id=a1p3A0000003ee0QAA
Once installation of the unmanaged package is successfully installed, then go to Salesforce and access to the following Reports: All Active Advanced Rules Joined and then All Product Attribute Rules Join. Let is start with the first one.
All Active Advanced Rules Joined: Report for the CPQ Advanced Rules identifying rule filter, rule action, rule variable and the conditions used for them.
The expected behaviour as per the known issue mentioned above is to have deployed only the first block: Entity Filters with its Conditio block 1. Something like the following picture:
We would need to complete this Joined report, with the following actions:
- Adding a new Block section: clicking on the Button at the top: Add Block and selecting → All → and in the Search Report Types bar, type: "Rule Actions for Advanced Rules" → and clicking on it as showed in the below picture and finally clicking on the blue button of the right side named: Add Block.
- Add columns under the new section you just added as showed in the below picture:
Those columns are:
Rule Actions for Advanced Rules |
|---|
Rule: Rule Name |
Rule: Type |
Rule: Object Name |
Product Relationship: Product Relationship Name |
Rule Action Name |
Product Relationship: Product: Product Name |
Product Relationship: Relationship Type |
Product Relationship: Related Product: Product Name |
Product Relationship: Action Parameters |
Product Relationship: Message |
Product Relationship: AddMode |
Product Relationship: Context |
Product Relationship: Attribute Modification Context |
Of course, you can add, delete any other columns that you wish, based on your requirements and needs.
- You will need to add 2 more Block Sections, one using the custom report type → Rule Filter for Advanced Rules and another one using the custom report type → Rule Variable for Advanced Rules. Add the columns that you might need as showed in the following picture:
Those columns are:
Rule Filter for Advanced Rules | Rule Variable for Advanced Rules |
|---|---|
Rule: Rule Name | Rule: Rule Name |
Rule: Type | Rule: Type |
Rule: Object Name | Rule: Object Name |
Rule Filter Name | Variable Name |
Type | |
Object Identifier | |
Object Path | |
Field Name to Assign |
Those columns and sections depend on what you have configured in the Org, so adapt them as you need.
- Finally, on the Filters part from the report, adjust the filters as the following picture:
You are ready to go with this Joined report.
2. All Product Attribute Rules Join: Report for the Product attribute rules configured in the Org. It shows the action of the rule along with the conditions that trigger the action of the rule when the conditions are met.
The expected behaviour as per the known issue mentioned above is to have deployed only the first block: Entity Filters with its Conditio block 1. Something like the following picture:
We would need to complete this Joined report, with the following actions:
- Adding a new Block section: clicking on the Button at the top: Add Block and selecting → All → and in the Search Report Types bar, type: "Product Configuration Procedures for Attribute Rul" → and clicking on it as showed in the below picture and finally clicking on the blue button of the right side named: Add Block.
- Add columns under the new section you just added as showed in the below picture:
Product Configuration Procedures for Attribute Rul |
|---|
| Product Configuration Procedure Name |
| Product: Product Name |
| Product: Product Code |
| Action Parameters |
- Finally, on the Filters part from the report, adjust the filters as the following picture:
You are ready good to go with this Joined report.
Limitations/Considerations
- You would need to interpret your reports based on the particular configuration that you have for your advanced rules. Examples: Interpret how Entity filters of Evaluation Type are related to the Entity Filters of Qualification Type, consideration based on the type of your entity filter condition...
- The Joined report for advanced rules is not agnostic to all the possible scenarios of configuration for CPQ Advanced Rules.
- Context Rules are not in the scope of this asset.
- For product attributes report, see references from the official documentation: https://docs.vlocity.com/en/Export-a-Product-Report-in-Product-Designer.html
- Others.
Comments
Post a Comment