Installation
Install the CPQ solution
PRE-REQUISITES TO CPQ INSTALLATION
Before starting the installation of the CPQ solution in MSCRM, check that your CRM environment matches the following prerequisites:
Before proceeding, please ensure that you are logged in as a System Administrator. To check the security roles associated to your user:
- In the main ribbon, click on the icon next to your user name and select “Options”
- In the “General” tab, scroll down and click on “View your user information”
- In the main ribbon, click on the arrow next to your user name and select the “Security Roles” entity
- In the Roles list, search for “System Administrator”
If “System Administrator” is not in the list of your roles, then you need to contact your administrator to be granted rights to install the CPQ solution.
Before proceeding, please ensure that you have deactivated your popup blocker or that you have added your CRM server to your popup blocker white list. Otherwise, you may encounter the following message during the installation process:
DOWNLOAD AND IMPORT THE SOLUTION
Available Soon: Go on the Microsoft App Source, search for the PROS Managed Solution and download it
You could send a request on the PROS Connect Portal to get a PROS managed solution and corresponding credentials. Once you are logged in MSCRM as a System Administrator, enter the Settings>Solutions section in MSCRM
New installation
If you install CPQ for the first time, click on “Import”:
- You are redirected in a popup where you have to browse to select your CPQ solution
- Once done, click on “Next”.
- Check the solution information:
- You can click on “View solution package details” to check the content of the solution to be installed. See the chapter on the post-install step for more information
- Once done, click on “Next”
- Check the import options and ensure that the “Enable any SDK message processing steps included in the solution” action is selected. Then click on “Import”
- Wait for the progress bar to complete and then check for the installed components
- At the end of the installation process, you can see PROS_Smart_CPQ in the list of solutions in your CRM
Upgrade
If you are upgrading a previous version of CPQ, the steps are very close to the ones for a new
installation:
- First, in the Settings>Solutions section, click on “Import”.
- You are redirected in a popup where you have to browse to select your CPQ solution.
- Once selected, click on “Next”.
- Check the solution information. A warning message alerts you that a CPQ solution is already installed
- You can click on “View solution package details” to check the content of the solution to be installed. See the chapter on the post-install step for more information.
- Once done, click on “Next”
- Check the import options: you can choose to maintain your unmanaged modifications or to overwrite them. If you have no unmanaged data, select “Overwrite customizations”. Else, see with your administrator which is the best option in your case.
- Ensure that the “Enable any SDK message processing steps included in the solution” action is
selected and click on “Import”.
- The rest of the installation is the same as for a new one. Wait for the progress bar to complete and then check for the installed components.
- At the end of the installation process, you can see PROS_Smart_CPQ in the list of solutions in your CRM.
To upgrade the solution, you can also decide to uninstall your CPQ solution before installing the new version. Please note that this procedure will delete all the data managed by the solution, including all your PROS Mapping Sets.
Check the installed components
At the end of the installation process, you can check the installed components in the list displayed by the installer. You can also check the installed components through the Settings menu:
- In the main ribbon, go in the Settings section
- Select the Customization entity
- Click on “Customize the system”
CUSTOM ENTITIES
- Click on Entities
You should now see the following section:
The custom CRM entities for CPQ are listed here:
| ENTITY | DESCRIPTION |
|---|---|
| PROS Custom Settings | [PROS Custom Settings] entity gathers the parameters necessary for CPQ and MSCRM to interact together. |
| PROS Mapping Set | [PROS Mapping Set] entity contains the definition of the communication between MSCRM and CPQ objects. It lists the entities and fields that can be mapped between both environments and how they are updated. |
| PROS Quote Content IN | [PROS Quote Content IN] entity contains the active quote release content from MSCRM. The XML representation of the quote content IN is attached as a Note in the entity. |
| PROS Quote Content OUT | [PROS Quote Content OUT] entity contains the active quote release content from CPQ. The XML representation of the quote content OUT is attached as a Note in the entity. |
| PROS Quote URL | [PROS Quote URL] is a technical entity embedding the call to the CPQ server by leveraging its URL |
OPTION SETS
In order to check whether the necessary Option Sets have been installed, proceed as follows:
- Click on Option Sets
You should now see the following section:
You can click on each line in the list to have more details on each option set. The option sets that have been installed are listed here:
| LABEL | FUNCTION |
|---|---|
| License Type | The list of possible values for the PROS License Type field. Default Values: named concurrent hits (empty) - named by default |
| License Role | The list of possible values for the PROS License Role field. Default Values: internalSales (default) internalReviewer externalPartmer externalCustomer |
CLIENT EXTENSIONS - SITE MAP
The Site Map is generated automatically with the CPQ solution. In order to check whether the Site
Map has been installed, proceed as follows:
- Click on Client Extension
- Search for Site Map in the list
You should now see the following section:
The Client Extensions that have been installed are listed here:
| LABEL | FUNCTION |
|---|---|
| Site Map | Standard extension of MSCRM consisting in an XML file used to control the application navigation pane. |
If you retrieve the Site Map XML file, you should be able to consult it and to control the elements from the CPQ solution.
WEB RESOURCES
In order to check whether the necessary Web Resources have been installed, proceed as follows:
- Click on Web Resources
The Web Resources that have been installed are listed below.
| PAGE | DESCRIPTION |
|---|---|
| pros_/HTML/connectFrame.html | This HTML section is necessary for the connection between the CRM and CPQ to be operational (see warning below) |
| pros_/HTML/emptyPage.html | This HTML page is necessary to display the “Content” tab iframe for CPQ. |
| pros_/MappingSet/HTML/index.html | HTML page to handle the global PROS Mapping Set form |
| pros_/MappingSet/HTML/childReference.html | HTML page managing the entities tree in the PROS Mapping Set form |
| pros_/MappingSet/HTML/productAttributes.html | HTML page managing the mapping the Product entity attributes in the PROS Mapping Set |
Style Sheet resources
The CSS files that have been installed are listed below:
| FILE | DESCRIPTION |
|---|---|
| pros_/MappingSet/Styles/themes/jstree_style.css pros_/MappingSet/Styles/MainStyle.css | CSS resources handling the PROS Mapping Set entity interface |
Images
The images are mainly icons and GIF files. 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 |
|---|---|
| pros_/Icons/PROS_CustomSettings_16.png pros _/Icons/PROS_CustomSettings_32.png | Icons for the PROS Custom Settings entity. |
| pros _/Icons/PROS_MappingSet_16.png pros _/Icons/PROS_MappingSet_32.png | Icons for the PROS Mapping Set entity. |
| pros _/MappingSet/Styles/themes/IconSet.png | Icons used in the PROS Mapping Set interface. |
| pros _/Icons/ PROS_QuoteContentIn_16.png pros _/Icons/ PROS_QuoteContentIn_32.png | Icons for the PROS Quote Content In entity. |
| pros _/Icons/ PROS_QuoteContentOut_16.png pros _/Icons/ PROS_QuoteContentOut_32.png | Icons for the PROS Quote Content Out entity. |
| pros _/Icons/PROS_Clone_16.png pros _/Icons/PROS_Clone_32.png | Icons for the Clone button in the Quote entity (Available soon) |
| pros _/Icons/ PROS_Refresh_16.png pros_/Icons/ PROS_Refresh_32.png | Icons for the Refresh button in the Quote entity |
| pros_/Icons/PROS_SmartCPQLaunch_16.png pros_/Icons/PROS_SmartCPQLaunch_32.png | Icons used on the Quote entity to call the Smart CPQ app from the Main form |
| pros_/Icons/ PROS_Add_16.png pros_/Icons/ PROS_Delete_16.png pros_/Icons/ PROS_Save_16.png | Icons for the Add/Remove/Save actions in the PROS Mapping Set entity |
Scripts
The scripts that have been installed are listed here:
| SCRIPT | DESCRIPTION |
|---|---|
| pros_/MappingSet/JS/onSave.js | Script used for the “Save Mapping” action in the PROS Mapping Set entity |
| pros_/MappingSet/JS/jstree.min.js | Script used to manage the entities tree in the PROS Mapping Set entity |
| pros_/MappingSet/JS/functions.js | Script used for the general functions of the PROS Mapping Set entity |
| pros_/MappingSet/JS/XmlBuilder.js | Script used to manage the XML flow of the PROS Mapping Set entity |
| pros_/MappingSet/JS/jquery.js | Jquery reference for the PROS Mapping Set entity |
| pros_/MappingSet/JS/SDK.Metadata.Query.vsdoc.js | SDK Metadata Query reference for the PROS Mapping Set entity |
| pros_/Scripts/Shared/Util.js | Utils library common to PROS entities |
| pros_/Scripts/Ribbon/pros_quote.js | Script used for the Ribbon PROS actions in the Quote entity |
| pros_/Scripts/Shared/pros_XrmServiceToolkit.js | XrmServiceToolkit reference for the PROS entities |
| pros_/Scripts/Shared/pros_jQuery.js | Global JQuery reference |
| pros_/Scripts/Form/pros_customsetting.js | Script gathering the methods associated to the PROS Custom Settings forms |
| pros_/MappingSet/JS/ChildFunctions.js | Script used to manage the child entities in the entities tree of the PROS Mapping Set |
PROCESSES
In order to check whether the necessary Processes have been installed, proceed as follows:
- Click on Processes
You should now see the following section:
The Processes that have been installed are listed here:
| PROCESS | DESCRIPTION |
|---|---|
| PROS Synchronization OUT | Action handling the OUT synchronization web services to request MSCRM from CPQ |
| PROS Clone Quote | Workflow handling the Quote cloning action |
| PROS Synchronization IN | Action handling the IN synchronization web services to request CPQ from MSCRM |
| PROS Retrieve Content IN | Workflow handling the init action of the CPQ Quote |
PLUGIN ASSEMBLIES
In order to check whether the necessary Plugin Assemblies have been installed, proceed as follows:
- Click on Plugin Assemblies
You should now see the following section:
The Plugin Assemblies that have been installed are listed here:
| NAME | DESCRIPTION |
|---|---|
| MsCRM.SmartCPQ.Workflows | Classes relative to all the workflows defined in the solution for CPQ |
| MsCRM.SmartCPQ.Plugins | Classes relative to all the plugins defined in the solution for CPQ |
SDK MESSAGE PROCESSING STEPS
In order to check whether the necessary SDK Message Processing Steps have been installed, proceed as follows:
- Click on SDK Message Processing Step
You should now see the following section:
The SDK Message Processing Steps that have been installed are listed here:
| NAME | DESCRIPTION |
|---|---|
| MsCRM.SmartCPQ.Plugins.SynchronizationIn | Event handler switch to the Content tab from the Quote Main form |