Manually Updating ClickDimensions

Manually updating ClickDimensions is going to be very similar to deploying it. This article will detail the whole process, but if you’ve deployed ClickDimensions, please note that there are just a few extra steps that you should be aware of.

System Requirements: For on-premises deployments of CRM 2011, Update Rollup 12 or newer is required on the CRM server.
Note: You must be a System Administrator in order to manually update.

NOTE: It is always a good idea to backup your CRM database and/or customizations prior to importing any solution into your CRM.
If you have made certain customizations to system entities, importing a managed solution such as ClickDimensions can cause the customizations to revert to the default state. (For example, if you renamed the Account entity to “Company”, importing our solution will cause the entity to revert to the name “Account”.)
To recover your customizations after importing our solution, follow the steps below. If you have not made changes to the Account, Contact, Lead or Marketing List entities, you can skip this:

  1. Prior to importing the ClickDimensions solution, export the Account, Contact, Lead and Marketing List entities. You can export them as an unmanaged solution. (Read more here about solutions.) Note that if you have not made changes to these entities you do not need to do this step.
  2. After importing the ClickDimensions solution, import the solution you created with the Account, Contact, Lead and Marketing List entities. When the import process is completed, publish the customizations.

NOTE: This note applies to 2016+ solutions only. When you complete an import in CRM 2016, you will see the following pop-up screen that asks for your region, Account Key, and Token. You will only need to fill out this information if any of these details have changed in the solution. If you do not need to change anything, just close this pop-up.


This occurs to help prevent connectivity issues caused by installing a solution intended for a different environment,  and the requested information can be found in the email you receive for the new solution file as well as within ClickDimensions Settings in CRM.

When installing the solution, you will see the following pop-up:


VERY IMPORTANT: Be sure to uncheck “Stage for Upgrade” and select “Overwrite Customizations”. We do not support holding patches that will be created if “Stage for Upgrade” is selected, and this solution cannot be updated or uninstalled.

NOTE: Have you added custom fields to ClickDimensions entity forms or views? Read this article about best practices for your own custom fields.

NOTE: 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.1

First you’ll download the ClickDimensions package from the Auto Update window which can be accessed at Settings > ClickDimensions > ClickDimensions Settings > Auto Update.

Next, you’ll need to navigate to Settings > Process Center > Processes and view all your Active Processes. Please look for these five ClickDimensions Processes:

  • ClickDimensions Execute Send
  • ClickDimensions Execute Text Message Send
  • ClickDimensions Form Auto Responder
  • ClickDimensions Subscription Auto Response
  • ClickDimensions Survey Auto Responder

Once you’ve located these records you’ll need to assign them to yourself.

Activated Processes

Next, go to Settings > Customization > Solutions and click the Import button.


Solution Option

Solution Import

Once you’ve located these records you’ll need to assign them to yourself.


Next, go to Settings > Customization > Solutions and click the Import button.


Browse to locate the .zip file you saved to your computer.

Select File

Click next and you will see an overview screen.

Next Screen

Click Next. On the following dialog select Overwrite customizations. Also be sure and check the Activate any processes… box below. This will enable CRM workflow processes used by our solution.

NOTE: This 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, your customizations may be overwritten. Also, some system components, such as system views and option sets that are part of the Account, Contact and Lead entity, will be set back to their default state since these entities are included in the ClickDimensions managed solution, and Microsoft does not provide a method to exclude them from the process. See here for an option of getting around this issue.


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.

Importing Solution

When the import is completed, go back to Settings > Process Center > Processes and you can reassign the five ClickDimensions workflows back that we assigned to your User earlier.

Want more information? Check out the Auto-Update FAQs.