Helper Code for ISVs

banner art

The IsvReadiness helper classes provide you with a programmatic means to modify the Microsoft CRM customization XML files. The customization XML files should not be modified by hand.

This document provides a detailed description of the IsvReadiness helper classes, their associated methods, and important data structures.

General Customizations

For all customizations except those dealing with callouts, when you write an installer application that customizes or adds new features to Microsoft CRM 3.0, you must follow these steps:

  1. Export the current customizations to a customization XML file by using the ExportAllXml message.
  2. Load the customization XML file into an XmlDocument object. For example:
    XmlDocument custXml = new XmlDocument();
    custXml.PreserveWhitespace = true;
  3. Insert new customizations into the document using the IsvReadiness helper classes.
  4. Save the modified XML document to a customization XML file, preferably under a different file name so as to preserve the original file. For example:
  5. Import the modified customization XML file into Microsoft CRM by using the ImportAllXml message.

Callout Customizations

In the case of callouts, the callout configuration file (callout.config.xml) may already exist on the computer running Microsoft CRM. If not, a new configuration file needs to be created that contains a single line of XML code:

<callout.config />

When you write an installer application that adds or removes callouts to Microsoft CRM 3.0, you must follow these steps:

  1. Create a new callout configuration file as outlined above if one does not already exist. If the file does exist, make a backup copy of the existing callout configuration file.
  2. Stop the Internet Information Services (IIS) service.
  3. Load the callout configuration file into an XmlDocument object. For example:
    XmlDocument calloutXml = new XmlDocument();
    calloutXml.PreserveWhitespace = true;
  4. Add or remove callouts in the XML document using the IsvReadiness CalloutConfigCustomizer helper class.
  5. Save the modified XML document to a callout.config.xml file. For example:
  6. Restart IIS.

Workflow Customization

Currently, the IsvReadiness classes do not support modifying the workflow configuration XML file (workflow.config). This still must be done manually as described in the Workflow Configuration File topic.

In this Topic

Microsoft.Crm.Sdk.IsvReadiness Classes

Microsoft.Crm.Sdk.IsvReadiness Structures

Microsoft.Crm.Sdk.IsvReadiness Enumerations

© 2007 Microsoft Corporation. All rights reserved.