Installation
Install the CPQ Managed Solution
PRE-REQUISITES TO CPQ INSTALLATION
Before starting the installation of the CPQ solution, check that you have access to make.powerapps.com with sufficient privileges to install or upgrade solutions.
Before proceeding, you should also ensure that you have deactivated your popup blocker or that you have added your CRM server to your popup blocker whitelist. Otherwise, you may encounter issues during the installation process.
Prior to installing the solution, you first need to download it. To do so, you can send a request on the Connect Portal to get a Smart CPQ managed solution and corresponding credentials. You should then be able to download from SFTP and import the solution.
IMPORT THE MANAGED SOLUTION
- First step consists of logging into the make.powerapps.com portal with your credentials:
- Make sure that you are in the right environment in the top menu bar.
- Then access the Solutions section from the left panel and click on Import in the action bar:
- Browse to find your CPQ solution and click Next in the right panel:
Review the solution details:
- Click on Advanced Settings at the bottom to choose the scenario you are in (Update, Upgrade...). Click on Learn More to review the various options
- When ready, click on Import. A message indicates that the import process is in progress.
- When completed, you should see the message confirming that the solution imported successfully.Note: When installing the solution as described above, you may be prompted with a Environment Variables window. This window asks you to set a default value to some environment variables expected by the CRM (e.g. AppInsights ID).
This step is not required to install the Smart CPQ solution and you can simply click on Cancel to move forward and complete the install.
If these environment variables are expected by other elements of your environment than the Smart CPQ solution, you can simply provide the required default values and click on Save & Close.
Once installed, you can start reviewing the content of the solution.
To upgrade the solution, you can also decide to uninstall your CPQ solution before installing the new version. Please note that this procedure deletes all the data managed by the solution, including all your Smart CPQ Settings, Smart CPQ Setup and Smart CPQ Mapping Set entities.
UNINSTALL
As any other managed solution supported in the CRM, it is possible to uninstall it. As the Smart CPQ managed solution drives the integration with Smart CPQ, it means that uninstalling the solution breaks the connection between the two systems.
In that case, all admin entities like Smart CPQ Mapping Set, Smart CPQ Setup and Smart CPQ Settings are deleted and cannot be restored. In addition, CRM Quote entities are no longer updated from CPQ Quotes and this link cannot be restored either, even after a new install.
We thus recommend to directly upgrade CRM instances when necessary, instead of uninstalling the current version and reinstalling the newer one.
Check the Installed Components
At the end of the installation process, you can check the installed components by simply clicking on the label of the solution:
All objects of the solution are accessible from the Objects explorer:
APPLICATION RIBBON
In order to check whether the necessary Application Ribbons have been installed, proceed as follows:
- Click on Application Ribbons.
The Application Ribbons that have been installed are listed here:
| NAME | DESCRIPTION |
|---|---|
| Application Ribbons | Application Ribbon leveraged in the Smart CPQ solution. |
APPS
In order to check whether the necessary Apps have been installed, proceed as follows:
- Click on Apps.
The Apps that have been installed are listed here:
| NAME | DESCRIPTION |
|---|---|
| Smart CPQ Configuration | Application part of the managed solution and responsible for the solution configuration, including the management of Smart CPQ Settings, Smart CPQ Setup and Smart CPQ Mapping Set entities. |
CHOICES
- Click on Choices.
The Choices that have been installed are listed below:
| NAME | DESCRIPTION |
|---|---|
| Product Management Policies | List of the policies ruling the sync of CPQ Quote Lines with CRM Product entities. |
CUSTOM CONTROLS
In order to check whether the necessary Custom Controls have been installed, proceed as follows:
- Click on Custom Controls.
The Custom Controls that have been installed are listed here:
| NAME | DESCRIPTION |
|---|---|
| prosqtx_Qtx2.FetchXML | Custom Controls related to the FetchXML Queries. |
| prosqtx_Qtx2.MappingSet | Custom Controls related to the Smart CPQ Mapping Set. |
| prosqtx_Qtx2.QuoteBundle | Custom Controls related to the component embedding the step navigator and the document generation components. Modifying this bundle allows hiding one of the two components it embeds if necessary. |
| prosqtx_Qtx2.QuoteCart | Custom Controls related to the Quote. |
| prosqtx_Qtx2.QuoteReportGen | Custom Controls related to the Smart Document component. |
| prosqtx_Qtx2.QuoteSteps | Custom Controls related to the Quote Step Navigator. |
PLUG-IN ASSEMBLIES
In order to check whether the necessary Plugin Assemblies have been installed, proceed as follows:
- Click on Plug-in Assemblies.
The Plugin Assemblies that have been installed are listed here:
| NAME | DESCRIPTION |
|---|---|
| PROS.Qtx.Workflows | Code relative to all the workflows defined in the solution for CPQ. |
| PROS.Qtx.Plugins | Code relative to all the plugins defined in the solution for CPQ. |
PLUG-IN STEPS
In order to check whether the necessary Plug-In Steps have been installed, proceed as follows:
- Click on Plug-In Steps.
The Plug-In Steps that have been installed are listed here:
| NAME | DESCRIPTION |
|---|---|
| PROS : Create Quote Plugin PostCreate | This plugin handles the scenario of the quote creation. Its purpose is to push to CPQ any CRM value defined in the data mapping between the two systems. |
| PROS : Update PROS Settings Plugin PostCreate | This plugin handles the scenario for the creation and update of the PROS Settings values. |
| PROS : Update PROS Settings Plugin PostUpdate | This plugin handles the scenario for the creation and update of the PROS Settings values. |
| PROS.Qtx.Plugins.ActivateQuote : Update of Quote | This plugin handles the Quote activation. |
PROCESSES
In order to check whether the necessary Processes have been installed, proceed as follows:
- Click on Processes.
The actions and workflows that have been installed are listed here:
| ACTIONS | DESCRIPTION |
|---|---|
| (DEPRECATED) Smart : Create OpportunityProduct from detail | Create Opportunity Product entities based on the Quote Products entities. |
| (DEPRECATED) Smart : Delete OpportunityProduct from detail | Delete Opportunity Product entities based on the Quote Products entities. |
| Smart : Clone Quote Action | Workflow handling the Quote cloning action from the CRM. |
| Smart : Delete Opportunity Products on Quote Delete | Delete Opportunity Products based when deleting a given Primary Quote for this Opportunity. |
| Smart : Generate Report Action | Workflow handing the document generation from the CRM. |
| Smart : Get Quote Steps Action | Workflow retrieving the steps of the quoting workflow to access them from the CRM. |
| Smart : Get Reports Action | Workflow retrieving the document templates for document generation. |
| Smart : Migration Process | Workflow responsible for the migration of the PROS Mapping Sets. The migration consists in integrating the Mapping Sets JSON structure into the PROS Mapping Set Admin UI introduced in the V1.7 of the PROS managed solution. |
| Smart : Open Quote Action | Workflow responsible for the opening of the CPQ quote from the CRM. |
| Smart : Prep Cart for Launch Action | Workflow initiating the CPQ quote before switching to it from the CRM. |
| Smart : Qtx Name Update | Update the CPQ Quote name from the CRM. |
| Smart : Qtx Status Update | Update the Quote status reason between the CRM and CPQ. |
| Smart : Refresh Quote Action | Workflow handling the CPQ refresh from the CRM (Sync Quote action). |
| Smart : Synchronize Opportunity Products | Synchronize Opportunity Product entities. |
| Smart : Synchronize Quote | Workflow handling the sync between CPQ and CRM elements. |
| Smart : Synchronize Quote Details and Opportunity products | Synchronize Opportunity Product entities and Quote Products entities. |
| Smart : Update Revised Quote as non-Primary Quote | Deactivate the Primary Quote feature on Revised Quotes. |
| Smart : Update Qtx Currency | Update the CPQ Quote currency from the CRM. |
| Smart : Update Qtx Data Locale | Update the CPQ Quote Data Locale from the CRM. |
SERVICE ENDPOINTS
In order to check whether the necessary Service Endpoints have been installed, proceed as follows:
- Click on Service Endpoints.
The Service Endpoints that have been installed are listed here:
| NAME | DESCRIPTION |
|---|---|
| PROS.Qtx.QuoteSynch.WebHook | This holds the connection details for calling the Azure Durable Functions (ADF). It can be configured post-install by using the Plug-In registration tool. |
SITE MAPS
In order to check whether the necessary Site Maps have been installed, proceed as follows:
- Click on Site Maps.
The Site Maps that have been installed are listed here:
| NAME | DESCRIPTION |
|---|---|
| Smart CPQ Configuration | This represents the site map that references the Smart CPQ Configuration app. |
TABLES
- Click on Tables.
- Opportunity
- Opportunity Product
- Quote
- Quote Product
Those elements are mainly forms, relationships with custom entities, fields or business rules. Custom CRM entities for CPQ are also introduced in the solution:
| ENTITY | DESCRIPTION |
|---|---|
| Smart CPQ Settings | Smart CPQ Settings entity gathers the parameters necessary for CPQ and MSCRM to interact together. |
| Smart CPQ Setup | Smart CPQ Setup entity gathers the parameters related to the quote model and the settings for the synchronization. |
| Smart CPQ Mapping Set | Smart CPQ Mapping Set entity contains the data mapping between CPQ and MSCRM. |
WEB RESOURCES
In order to check whether the necessary Web Resources have been installed, proceed as follows:
- Click on Web Resources.
The installed web resources are listed below:
Code
| SCRIPT | DESCRIPTION |
|---|---|
| prosqtx_/js/cartAPIUtils.js | Cart API utils. |
| prosqtx_/js/quoteUtils.js | Quote form manipulation scripts. |
| prosqtx_/js/ribbonUtils.js | Ribbon utility scripts. |
| prosqtx_/js/mappingSetUtils.js | Smart CPQ Mapping Set manipulation scripts. |
| prosqtx_/js/prosSettingsUtils.js | Smart CPQ Settings manipulation scripts. |
Images
The images are mainly icons or vectors. Regarding entities or actions, icons are used for each of them in two formats:
- PNG 16x16
- PNG 32x32
The images that have been installed are listed here:
| IMAGE | DESCRIPTION |
|---|---|
| prosqtx_/imgs/PROS_Mapping_Set_16.png | 16x16 px icon of the Mapping Set entity. |
| prosqtx_/imgs/PROS_Mapping_Set_32.png | 32x32 px icon of the Mapping Set entity. |
| prosqtx_/imgs/PROS_Mapping_Set_32.svg | Svg resource for the Mapping Set entity. |
| prosqtx_/imgs/PROS_Settings_16.png | 16x16 px icon of the Smart CPQ Settings entity. |
| prosqtx_/imgs/PROS_Settings_32.png | 32x32 px icon of the Smart CPQ Settings entity. |
| prosqtx_/imgs/PROS_Settings_32.svg | Svg resource for the Smart CPQ Settings entity. |
| prosqtx_/imgs/PROS_Setup_16.png | 16x16 px icon of the Smart CPQ Setup entity. |
| prosqtx_/imgs/PROS_Setup_32.png | 32x32 px icon of the Smart CPQ Setup entity. |
| prosqtx_/imgs/PROS_Setup_32.svg | Svg resource for the Smart CPQ Setup entity. |
| prosqtx_/Icons/PROS_Add_16.png | 16x16 px icon for the Add action in the Smart CPQ Mapping Set. |
| prosqtx_/Icons/PROS_Delete_16.png | 16x16 px icon for the Delete action in the Smart CPQ Mapping Set. |
| prosqtx_/Icons/PROS_Save_16.png | 16x16 px icon for the Save action in the Smart CPQ Mapping Set. |
| prosqtx_/imgs/PROS_Clone.svg | Svg resource for the Quote Clone action. |
| prosqtx_/imgs/PROS_Clone_16.png | 16x16 px icon of the Quote Clone action in the CRM Quote. |
| prosqtx_/imgs/PROS_Clone_32.png | 32x32 px icon of the Quote Clone action in the CRM Quote. |
| prosqtx_/imgs/PROS_Refresh.svg | Svg resource for the Sync Quote action. |
| prosqtx_/imgs/PROS_Refresh_16.png | 16x16 px icon of the Sync CPQ action in the CRM Quote. |
| prosqtx_/imgs/PROS_Refresh_32.png | 32x32 px icon of the Sync CPQ action in the CRM Quote. |
| prosqtx_/imgs/PROS_Sync.svg | Svg resource for the Close Cart & Sync action. |
| prosqtx_/imgs/PROS_Sync_16.png | 16x16 px icon of the Close Cart & Sync action in the CRM Quote. |
| prosqtx_/imgs/PROS_Sync_32.png | 32x32 px icon of the Close Cart & Sync action in the CRM Quote. |
| prosqtx_/imgs/PROSSettings16.png | Those web resources are deprecated. |
| prosqtx_/imgs/PROSSettings16.png | Those web resources are deprecated. |
| prosqtx_/imgs/PROSSettings32x32.svg | Those web resources are deprecated. |
| prosqtx_/imgs/PROSSetup16.png | Those web resources are deprecated. |
| prosqtx_/imgs/PROSSetup32.png | Those web resources are deprecated. |
| prosqtx_/imgs/PROSSetup-32x32.svg | Those web resources are deprecated. |