Migration and Upgrade Scenarios for ClickDimensions

What you need to do with your ClickDimensions solution if you are upgrading CRM or moving your CRM deployment


Migrating or upgrading a CRM organization that includes ClickDimensions requires careful consideration. This is because each ClickDimensions account is integrated deeply with a single CRM organization database by means of an embedded Account Key that is unique to the CRM organization. This Account Key is used throughout the ClickDimensions customizations and is used to make the connection between your CRM system and your ClickDimensions account in the cloud. If you have multiple installations of ClickDimensions (for example, in a test CRM as well as in your production CRM), then each installation has a separate, unique Account Key.

In addition to the Account Key, many records that are integrated between CRM and ClickDimensions contain identifiers that maintain the correlation between the CRM record and its counterpart in the ClickDimensions cloud. For example, Email Templates use a combination of the Account Key and the record’s ID in the CRM database to link it to the corresponding HTML content and template designer in the cloud:


There are also other types of identifiers called Row Keys and Partition Keys that are stored in CRM for some ClickDimensions records, such as Domain and Form Field records. All of these records in your CRM system are integrated with a specific account in the cloud, and that specific account is identified by the Account Key.

Migration and Upgrade Scenarios: Which one are you planning?

Review the common migration and upgrade scenarios in the following PDF to define which type of upgrade and/or migration you will be conducting. Follow the instructions at the bottom of the column for your selected scenario.


NOTE: Are you upgrading from CRM 2011 to 2013/2015/2016+ ? Make sure you read this article on important steps to take before you upgrade.

NOTE: For CRM Online, where you are considering creating a Sandbox organization as a copy of your Production CRM instance, please see this article.

NOTE: Wondering about moving customizations and integrated ClickDimensions records between environments? See this article.

Frequently Asked Questions

Q: Can I use the same ClickDimensions solution in two different CRM organizations?
No, each solution has a unique account key to support the integration of a specific CRM organization.

Q: Will ClickDimensions stop working after I upgrade my CRM if I do not install a new solution right away?
No. If you are upgrading from CRM 2011 to a newer version, ClickDimensions will still be able to connect to your upgraded CRM and synchronize data (as long as the URL and org name have not changed). Your users will be able to use most functions of ClickDimensions without updating to a new solution, although they may encounter some minor issues in the UI such as iframes rendering incorrectly or script errors.

Q: Will I lose data during my upgrade if CRM is not available for a period of time?
No, ClickDimensions automatically queues data for a later synchronization if your CRM is unavailable for any reason. ClickDimensions will retry to synchronize the data every hour for up to two weeks until your CRM is available again.

Q: I want to run some tests in our upgraded environment before we turn off our current production CRM. Can I use the same ClickDimensions solution?
No, you cannot have two concurrent CRM systems using the same Account Key. You will need to register the upgraded environment separately, conduct your tests, and then, when you are ready to cut over to your new CRM, you can import the ClickDimensions solution with the original Account Key and ask ClickDimensions to update your production account to connect to your new, upgraded CRM.

Q: We are just changing the URL and/or organization name of our CRM system (perhaps moving it to new servers). We are not upgrading. Do we need a new solution file?
No, you do not need a new solution file. Please let our support team know the new URL and/or organization name, and they can update your account to point to your CRM’s new location.

Q: We are migrating our data using a migration tool to a new CRM deployment (ie, on new servers or in CRM Online). Do we need a new ClickDimensions solution?
If you plan to conduct testing on the new CRM prior to disabling the old CRM, then you will need to register for a new solution file to use temporarily during your testing. If you are just going to migrate the data and start using ClickDimensions in the new CRM once the data migration is complete, then you can use the same solution file you already have installed.

Q: Can we merge image manager data from one environment into another?
A: Yes, but merging image manager data from one environment to another will overwrite any existing data in the target environment with the data from the source environment.

PLEASE NOTE: You will not be able to move over those records that are dependent on integration with our system unless you also re-create the record GUIDs in the new CRM org. For example, Email Template records have a record in CRM but also a counterpart on our cloud application (the HTML for the body of the email itself). The record in our cloud application uses the CRM record’s GUID to match it for integration purposes. If you simply migrate the data from the CRM record, but not the GUID, the template will no longer be integrated from our cloud to your new CRM. Likewise, for those records that have Row Key and Partition Key fields, these values must also be migrated to the new environment if you wish to maintain the integration.

Have more questions? Submit a request


Article is closed for comments.