SiteMap Editor for Microsoft Dynamics CRM 2011: Troubleshooting & Optimization Guide

SiteMap Editor for Microsoft Dynamics CRM 2011: Troubleshooting & Optimization Guide

Overview

A SiteMap Editor modifies the CRM 2011 navigation (area, group, subarea) without manually editing XML. Common tools: the XrmToolBox SiteMap Editor plugin, the Dynamics CRM 2011 Solution Explorer with manual XML edits, and third-party editors. Use an editor to add/remove areas, reorder items, set entity/page links, and control privileges and visibility.

Common problems and fixes

1. Changes not appearing in UI

   • Clear browser cache and perform an IISRESET on the CRM server (if on-premises).
   • Publish customizations after saving the SiteMap.
   • Ensure user has access to the area: check security roles and Sitemap privileges.

2. Editor won’t connect / authentication errors

   • Verify correct server URL and organization name.
   • For on-premises, confirm AD credentials are accepted; for IFD, ensure claims/ADFS config is working.
   • Check HTTPS certificate validity when using SSL.

3. Invalid XML / publish errors

   • Validate XML structure: proper tags (SiteMap, Area, Group, SubArea) and attributes (Id, Title, Icon, Url).
   • Revert to a backup SiteMap and reapply changes incrementally to locate the bad fragment.
   • Use the editor’s built-in validation or paste XML into an XML validator.

4. Broken links or pages not found

   • For entity links, ensure the entity schema name is correct.
   • For web resources or external URLs, verify the path/URL and that resources are published.
   • If linking to dashboards or forms, confirm those components exist and are published.

5. Permissions / visibility problems

   • Use the SiteMap’s privilege attribute or set DisplayRule/EnableRule tied to custom privileges.
   • Confirm users’ security roles include the required privileges for linked entities.
   • Remember sitemap visibility can be cached—have users sign out/in after changes.

6. Performance or rendering issues

   • Keep SiteMap complexity reasonable—avoid deeply nested groups and very large numbers of items.
   • Minimize use of heavy custom HTML pages embedded via IFRAMEs.
   • Test on multiple browsers; CRM 2011 has known quirks with older IE versions.

Optimization best practices

• Backup before changes: Export current SiteMap XML or create a solution backup.
• Use descriptive IDs and titles: Makes maintenance and troubleshooting easier.
• Group logically: Put related entities together to reduce cognitive load.
• Limit custom links: Prefer entity links over external pages unless necessary.
• Use DisplayRules sparingly: Only when needed for role-based complexity.
• Test incrementally: Apply small changes and verify across user roles and browsers.
• Document changes: Keep a short changelog with who changed what and why.

Quick recovery steps (if UI is unusable)

1. Import the backed-up sitemap solution or restore from full solution backup.
2. Use the Organization.SavedSiteMap (if available) or retrieve default sitemap from a clean environment and import.
3. If CMS is corrupted on-premises and CRM UI fails to publish, restore SQL database backup as last resort.

Tools & commands

• XrmToolBox SiteMap Editor (plugin) — edit/publish visually.
• CRM Solution export/import — deploy SiteMap changes via solutions.
• IISRESET — clear server-side cache (on-premises).
• Browser cache clear and user sign-out/in — client-side refresh.