CRM 2011: Editing the SIteMap

I thought I’d make not of this topic ( which is found in the CRM 2011 SDK ) because when you attempt to export the Default Solution, it seems to “want� to perform the export, but never does – AND it never gives you an error.

So, if you want to modify the SiteMap, follow these instructions. 

Editing the SiteMap

To edit the SiteMap
  1. In the Navigation Pane, click Settings, click Customization, and then click Solutions.

  2. Choose one of the following:

    1. Export the Default solution.
    2. Add the SiteMap to a new or existing solution:
      1. In the solution, select Components and then Add Existing and then select Site Map
      2. Export the solution as an unmanaged solution.
  3. Extract the files from the compressed .zip file.

    Tip

    Keep the compressed .zip file as your backup.

  4. In the customizations.xml file, locate the SiteMap node (located at ImportExportXml/SiteMap/SiteMap).

  5. Edit the SiteMap node.

    Note

    Editing XML is much easier if you use an editor that provides schema validation. See Editing with schema validation for more information.

  6. Create a new compressed zip file using all the extracted solution files including your edited customizations.xml.

    Tip

    In Windows explorer, select all the files, then right-click and select Send To and Compressed (zipped) folder.

  7. Import the new solutions file.

    1. In the Microsoft Dynamics CRM application Navigation Pane, click Settings, click Customization, and then click Solutions.
    2. Click Import.
    3. Click Browse, locate your modified solutions .zip file, click Next and then click Import.
    4. When the import completes, click Close to close the Import Solutions dialog.

Editing with schema validation

XML files are simply text so you can edit them with Notepad. But it is much easier and you are less prone to make errors if you use an application that provides schema validation. Free applications you can download and install such as Visual Web Developer 2010 Express or XML Notepad 2007 can be associated with the CustomizationsSolution.xsd file located in the SDK\Schemas folder in the SDK download package. When associated with the schema, the XML editing application will provide IntelliSense to guide you about valid XML elements and attributes.

To use schema validation with Visual Web Developer 2010 Express
  1. Open Microsoft Visual Web Developer 2010 Express and from the File menu, select Open File….

  2. In the Open File dialog, select the customizations.xml file and click Open.

  3. In the View menu, select Other Windows and then select Properties Window.

  4. In the Properties area, select the Schemas box and click the […] button.

  5. In the XML Schemas dialog, click Add… and in the Open XSD schemas dialog navigate to the [SDK install location]SDK\Schemas\CustomizationsSolution.xsd file and click Open to select the file..

  6. Click OK to close the XML Schemas dialog.

Now when you edit the SiteMap you will have IntelliSense and guidance about how to use the SiteMap elements and attributes.

 

Recovering From Errors

The import tool performs validations on the SiteMap. However, it is still possible that some errors might occur.

If errors occur, the default SiteMap will be applied and an error message will be displayed. You must fix the errors in the SiteMap and import it again.

Leave a Reply 8 comments