Fixing Broken Dynamics CRM/365 Plug-ins

Last updated 2017-05-09 15:21:57 UTC

Installing later versions of our managed solution over previous versions can result in references to the earlier Plug-in (DLL) being maintained.  In this case, you may not see the latest expected behaviors in triggered operations and our workflow processes.  

If you have made customizations to the solution, and you are selecting to preserve customizations when upgrading our solution, you may experience this.  However, whatever random event made this occur, here you are.  You may also need to fix the Plug-in if you have mistakenly (or intentionally) deleted workflow elements of the solution or the Plug-in.

All is not lost.

It would most likely be difficult to determine that your references to the current Plug-in have not been updated after an update is applied: generally you would need to be looking for some newly introduced behavior, and you would find it does not work as expected.  

To confirm that the latest Plug-in is not being used, go to Settings>>Customizations>>Customize the System.  View the "Plug-in Assemblies" component list and take note of the Version column for the Plug-in named "AssureSignDoc_CRMPlugins".  

In the downloaded AssureSign solution zip file, extract the AssureSignDoc_CRMPlugins.dll file from the "PluginAssemblies" archive folder, and copy it to a local location on your PC.  Right click on the file to view the properties, and look at the Details tab to see the File version.  If it does not match what is shown in the Version column of the Plug-in list, manual registration may be needed so that your solution references the latest version of our Plug-in.

Manual updates of a Plug-in are possible using the latest version of the PluginRegistration.exe application made available through the CRM SDK (now the Microsoft Dynamics 365 SDK).  In the extracted directory, the executable is location in the SDKexpanded\SDK\Tools\PluginRegistration folder.

If you are not familiar with using the Plugin Registration Tool, please contact support for guidance.

Select to Create New Connection to log into your CRM instance.

You will again be able to select the AssureSignDoc_CRMPlugins file to confirm the file version.

After selecting that Assembly, click Update.

In the window that appears, in Step 1: Specify the location of the assembly to analyze browse to the location of the DLL you extracted from our solution file.  The select Load Assembly.

You may need to right click on the DLL file and select to unblock the file (a protection applied when files have been downloaded through a browser).

Click Select All so that all elements of the Plug-in are retained and updated.  Do not modify the isolation mode or assembly location.

Click on Update Selected Plugins.  If all is successful you will receive a summary of what was updated.

In the list of Registered Plugins, you should see that the version of the AssureSignDoc_CRMPlugins file is now current:

One more step is now needed for Workflow Activity items within the Plug-in.  Expand the assembly so that you can see each item labelled Workflow Activity.  Select each item individually, and after selecting click on the Save disk icon.

A success message should be displayed.

After completing these steps, you should be able to confirm that the latest version of the Plug-in is being used in all operations associated with the Plug-in.

Have more questions? Submit a request