Manually updating ClickDimensions is going to be very similar to deploying it. This article will detail the whole process, however please note that there are just a few extra steps that you should be aware of, which were not required during the initial deployment.
Update Process
You must be a System Administrator in order to manually update. It is also always a good idea to backup your CRM database and/or customizations prior to importing or updating any managed solution from a third-party like ClickDimensions into your CRM.
Please be sure to choose 'Update' and not 'Upgrade' (despite the recommendation by Microsoft), as this will cause a dependency issue and will not allow the solution update to complete.
- Dynamics 365
- Legacy
First you'll download the ClickDimensions package from the Solution Management window which can be accessed at Settings & Support > Solution Management. When open, it looks like this (if you have ClickDimensions and CDSE, you will see both solutions as in the screenshot below. However if you only have ClickDimensions you will only see the ClickDimensions solution):
Select the ClickDimentions solution and click the Update button.
Next, you'll need to navigate to Advanced Settings > Settings > Process Center > Processes and view all your Active workflows. Find the four ClickDimensions workflows in your list of Active Processes:
- ClickDimensions Execute Send
- ClickDimensions Execute Social Post
- ClickDimensions Execute Text Message Send
- ClickDimensions Individual Text Message Send (added in version 12.11)
Once you have located these workflows, assign them to your ClickDimensions Service User. If you do not know who your ClickDimensions Service User is, be sure to check with your CRM Administrator to find out.
Next, go to Advanced Settings:
Then select Settings > Solutions:
Finally, click the Import button:
Dynamics 2013/2015
First you'll download the ClickDimensions package by clicking the Download button in the Solution Management window which can be accessed at Settings > ClickDimensions > ClickDimensions Settings > Solution Management. The window looks like this (if you have ClickDimensions and CDSE, you will see both solutions as in the screenshot below. However if you only have ClickDimensions you will only see the ClickDimensions solution):
Select the ClickDimensions solution and click the Update button.
Next, you'll need to navigate to Settings > Process Center > Processes and view all your Active workflows. Find the four ClickDimensions workflows in your list of Active Processes:
- ClickDimensions Execute Send
- ClickDimensions Execute Social Post
- ClickDimensions Execute Text Message Send
- ClickDimensions Individual Text Message Send (added in version 12.11)
Once you have located these workflows, assign them to your ClickDimensions Service User. If you do not know who your ClickDimensions Service User is, be sure to check with your CRM Administrator to find out.
Next, go to Settings > Customization > Solutions and click the Import button.
Browse to locate the .zip file you saved to your computer.
Click Next and you will see an overview screen.
Click Next. On CRM versions prior to version 9, you will see the following pop-up:
Be sure to uncheck Stage for Upgrade and select Overwrite Customizations. We do not support the Stage for Upgrade function as it will not allow the solution import to complete as needed.
If your environment is on CRM version 9+, your import options will look different:
In this case, you should select:
- Update: The Update action should be selected as it ensures that the existing ClickDimensions components within your environment will be updated with the new components from the imported ClickDimensions solution. We do not support the Stage for Upgrade action as it will not allow the solution import to complete. The Upgrade action also will not properly install the ClickDimensions solution, so we do not recommend using it.
- Overwrite customizations: This option only affects the components included in the imported ClickDimensions solution and ensures that existing ClickDimensions components are updated to the latest version. This would not affect entities or components included outside of the ClickDimensions solution. If you have made customizations to components from the ClickDimensions solution in your own unmanaged solution, then maintaining customizations may prevent the customized components from updating to the latest version and may cause features to not work or errors to occur.
- Enable any SDK message processing steps included in the solution: This will enable CRM workflow processes used by our solution to ensure that the related features do not fail due to inactive workflows or processes.
NOTE: Overwriting customizations is necessary to ensure that all of our new features are enabled when your ClickDimensions solution is updated. However, if you have made customizations to entities that are included in the ClickDimensions solution using your own unmanaged solution(s), then your customizations may be overwritten. In this case, you can re-import your unmanaged solution(s) to re-apply them.
Next you will see a progress bar as the solution is imported. If the background screen shows a connection error, disregard it. This is a harmless CRM bug that will not adversely affect the import.
When the import is completed, go back to Settings > Process Center > Processes and you can reassign the three ClickDimensions workflows back that we assigned to your Service User earlier.
Want more information? Check out the Solution Update FAQs.
FAQs
What if I have added custom fields to ClickDimensions entity forms or views?
Overwriting customizations will only affect components contained within the ClickDimensions solution, so custom fields added via your own unmanaged solution(s) will not be removed from your environment nor will data be removed from those fields, although these fields may no longer appear on the Forms and Views included within the ClickDimensions solution. Learn more about how to best handle custom fields, here.
Can I get a ClickDimensions solution file aside from the current one?
No. ClickDimensions is only able to generate the most recent available version of the solution file. If you think you will need to install an older version at a later date please be sure to download it while it is available and save it. The last version available for CRM 2011 is 8.2.7.