This documentation is archived and is not being maintained.

Registering the Workflow Assembly

banner art

[Applies to: Microsoft Dynamics CRM 4.0]

Find the latest SDK documentation: CRM 2015 SDK

Your assembly can be registered and stored in the database or on disk. The database option is preferable because the system will handle deployment across multiple servers. If you choose the on-disk option, you must handle deployment issues.

Other tips for deploying custom workflow activities include the following:

  • Registering a custom workflow has the same requirements as registering a plug-in. For more information, see Registering Plug-ins.
  • You should have only one version of an assembly in the database. If you are making changes, make sure that you delete the old version, and then add the new version.
  • Make sure that the interface does not change between versions. If the interface changes, any workflows that refers to the old interface may break.
  • After you upload, restart IIS and then restart the asynchronous service on every server that is running the asynchronous service and on every Web server. For more information, see Stopping and Starting the Asynchronous Service.
  • Multiple versions of an assembly are not supported.
  • If you refer to any third-party DLL that is not in the GAC, it must be located in the %installdir%\server\bin\assembly folder.

While you can register a custom workflow assembly using the relevant message in the SDK, such as RegisterSolution, the source code for two easy to use registration tools is included in the SDK\Tools folder. Before you can register your workflow assembly you must build one of the tools. For information about how to build the Plug-in Developer tool, see the Build the Plug-in Developer Tool walkthrough. For information about how to build the Plug-in Registration tool, see the Build the Plug-in Registration Tool walkthrough. The difference between these tools is that the Plug-in Developer tool is a console application while the Plug-in Registration tool has a graphical user interface and supports more registration options.

Note The latest version of the Plug-in Registration tool supports command-line options and provides more capability than the Plug-in Developer tool. The Plug-in Registration tool is the preferred tool for registering plug-ins and custom workflow activities. The Plug-in Developer tool may be removed from a future SDK release.

For more information about using the Plug-in Registration tool to register a custom workflow activity, see the Readme.doc file for the SDK\Server\FullSample\CustomWorkflowActivity\CS|VB sample.

An alternative approach to registering a plug-in is to write an installer program. A sample installer can be found in the SDK\Walkthroughs\Workflow\CodeWorkflow\CreateLead\Installer folder.

See Also


Other Resources

© 2010 Microsoft Corporation. All rights reserved.