Upgrading from CRM 2011 to 2013/2015/2016?

If you are upgrading from Microsoft Dynamics CRM 2011 to 2013/2015/2016, please follow these steps to also upgrade your ClickDimensions solution:

  1. Do NOT update the ClickDimensions solution prior to upgrading CRM.
  2. In CRM 2011, if you have Update Rollup 12+ installed, prior to upgrading the 2011 org, run the OrgDBOrgSettings tool (a command line tool run on the CRM server) by running the following command:
     Crm.SE.OrgDBOrgSettingsTool.exe Update /u <UniqueOrgName> LookupNameMatchesDuringImport True

    https://support.microsoft.com/en-us/kb/2651616
    NOTE: You can also run this command after upgrading to CRM 2013. Another option is that Microsoft provides a solution you can import to CRM that provides a graphical UI to change OrgDB settings. You can find this here: http://orgdborgsettings.codeplex.com/ 

    It is up to you to determine which to use (the command line tool or the solution). The tools are not supported by ClickDimensions. If you use the downloadable tool instead of the solution file, you will find included in the zip file with the tool a config file where you can specify how the tool will connect to your CRM. This may require some trial and error depending on the settings of your CRM, such as DNS, web address properties, IFD, etc. You will then need to update the Microsoft.Crm.SE.OrgDBOrgSettingsTool.exe.config file that is in the folder. The changes that need to be made are highlighted below. Update this file according to the variables in your CRM deployment:

    orgdborgsettings-config

    One you have made the update to the .config file and saved it, you can then open a command line prompt and navigate to the folder where you saved the file.

    • Cd C:\OrgDBOrgSettingsTool

    Then you can set the LookupNameMatchesDuringImport value to True (Insert the friendly name of your Org below) by running the following command:

    • Crm.SE.OrgDbOrgSettingsTool.exe Update <ORG Friendly Name> LookupNameMatchesDuringImport True

     

    This should make the change necessary to import the ClickDimensions solution properly. (Note: If you receive an authentication error when running this command, you have either entered incorrect information in the config file or your CRM web services are not properly configured for your environment. Refer to the CRM Implementation Guide from Microsoft for more information on configuring CRM.)

    TIP: In some cases, when IFD is already configured on the CRM environment, it can be difficult to get the connection and authentication to work with the config file. Though unsupported, it is possible to manually update this setting in the CRM database. The value ‘LookupNameMatchesDuringImport’ is in the OrganizationBase table in the <YourOrgName>_MSCRM database, and is stored as an XML string in the OrgDbOrgSettings column. By default, the value is “False” (or not set at all). After being set to “True” the value looks like this:
    lookupnamematches

    (If you perform this update directly to SQL you will want to perform an IISRESET on the CRM server afterwards. Remember to backup your SQL database prior to making any changes, and that this is a technically unsupported method.)

    Using the command line, you can verify that the setting was updated by retrieving the current values using the command line prompt as well, using this command:

    • Crm.SE.OrgDbOrgSettingsTool.exe Retrieve <ORG Friendly Name>

     

  3. If continuing on to upgrade to CRM 2015 and/or CRM 2016, apply the latest Update Rollup from Microsoft after each upgrade step and before proceeding to the next version of CRM.
  4. Prior to importing the ClickDimensions solution in the upgraded CRM org, rename the security role “ClickDimensions Lock Email Blocks”. Simply give it a different name, and save it.
  5. Request the new ClickDimensions solution for your upgraded CRM. Open a support request with ClickDimensions and provide the following information:
    1. What version of CRM you have upgraded to
    2. If the URL or organization name of your CRM database has changed, please provide the old URL/org name, and the new URL/org name

Notes about the upgrade process:

  • If your CRM is unreachable during the upgrade, ClickDimensions will queue any data that would have synced to your CRM for up to 14 days, and retry the synchronization when your CRM becomes accessible again.
  • If you are upgrading from CRM 2011 to 2013/2015/2016, ClickDimensions will be able to continue synching data to your CRM even before you have imported the ClickDimensions solution for that version of CRM, provided we can connect to it. This allows some flexibility in your upgrade schedule so you can focus on upgrading CRM during off-peak hours, and update the ClickDimensions solution at a later time (although if your users will need to create templates or send emails, they may have to wait until you have updated the ClickDimensions solution).
  • When upgrading CRM 2011 to 2013, one of the things that Microsoft does is merge tables in the CRM database. In CRM 2011 and previous versions, data was stored in two tables for each entity. It has been reported that an upgrade from CRM 2011 to 2013 can fail when the table merging occurs if some of the data in the tables is unexpected. With ClickDimensions, it is possible to use Freemarker to create dynamic Subject lines (ie, ${Recipient.contact.firstname![0]}). In some cases, this placeholder for dynamic content may cause the table merge to fail during the upgrade process. This is a limitation of the stored procedure that Microsoft uses for the table merge operation. If you run into this error during an upgrade, or post-upgrade table merge, remove the placeholders from the subject line and other fields on the Email Template and/or Email Send entities and repeat the upgrade/merge process.
About Matt

Director, Technical Solutions at ClickDimensions
Microsoft Dynamics CRM MVP
Author, The Microsoft Dynamics CRM 2011 Administration Bible