Application Navigation Configuration

Application Navigation Configuration

Microsoft Dynamics CRM 4.0 includes a navigation model that lets you integrate other Web applications or modify the default navigation. This is called the SiteMap.

With the SiteMap, you can control the navigation structure and precise placement and order of sub areas within the application navigation structure.

 

SiteMap Overview

SiteMap Overview

You can add custom entities into the navigation structure by using the Customize Entities area in the application by selecting the Areas that display this entity on the general tab for the entity. However, this does not let you control the precise placement within the area. For example, by using the customization tools, you cannot control the order that the new entity will appear under Sales. An example of the navigation structure is shown in the following diagrams.

The application navigation is created as an in-memory representation of the SiteMap by combining the three data sources shown in the following diagram.

The user interface for the Microsoft Dynamics CRM application is constructed from the following elements:

• The sitemapxml attribute of the organization entity.
• Client extension controls configured using ISV.Config.
• Custom entity information that is contained in the metadata database.

Note   The additions to the application navigation structure described in the entity metadata is automatically appended to the end of the appropriate areas defined in the Sitemap XML Reference. These additions lack the precise control of placement.

You can access the sitemapxml attribute by exporting the SiteMap. After you configure this XML file, you must import it to apply the customizations.

The SiteMap defines the areas represented in the Web client's Navigation Pane as well as in Microsoft Dynamics CRM for Microsoft Office Outlook.

SiteMap also defines Workplace profiles. These are groups of subareas that end-users can add or remove from the Workplace area by using the User Settings for Workplace. The Go To menu and User Settings for the Start Page (Web client only) automatically reflect the navigation areas and subareas defined in the site map.

The site map does not provide configuration support for the entity form left navigation pane, nor does it make the functionality in ISV.Config obsolete. Continue to use ISV.Config to add such items as menus and buttons to the application and navigation areas to entity forms.

The site map can be exported and imported to move your customizations between development and production environments.

Workplace Profiles

The Workplace is a user-configurable area that lets the user select from a set of profiles defined in the site map. These profiles typically will be configured to contain the most frequently used areas of the application. This enables users to create a workspace that is customized for their job responsibilities.

There are two groups that are always shown in the Workplace: My Work and Customers. These contain the pages of the application that are typically used by all users of the system. Technically, these are not profiles. For more information, see Sitemap XML and SiteMap Schema.

The user can decide to add groups by selecting from a list of profiles in using the Personalize Workplace… area of the Workplace. The default profiles include the following:

• Sales
• Marketing
• Service
• Scheduling

These groups and profiles are customizable by using the site map. You can add, remove, modify, and rename profiles to best meet the needs of the users.

Microsoft Dynamics CRM for Outlook

The areas, Workplace Groups, and subareas defined in the site map are reflected in the Outlook folder hierarchy under the Microsoft Dynamics CRM folder. However, Microsoft Dynamics CRM for Microsoft Office Outlook represents the folders alphabetically. The order defined in the site map does not apply.

Example Scenarios

The following list contains examples of what you can do with the site map:

• Integrate other applications into the Microsoft Dynamics CRM application.
• Customize Workplace profiles to better match with user responsibilities.
• Add custom entities in the navigation where you want them.
• Remove an unused top level Area.
• Add a new top level Area.

 

See Also

Concepts

• Adding Client Extension Controls
• Editing the SiteMap
• Passing Parameters to a URL using SiteMap

Reference

• SiteMap XML Reference

Other Resources

• Application Navigation Configuration

Editing the SiteMap

Editing the SiteMap

To configure the SiteMap, do the following:

1. Export the SiteMap by using the Export Customizations feature.
   1. In the Navigation Pane, click Settings, click Customization, and then click Export Customizations.
   2. Select SiteMap, then on the Actions toolbar click Export Selected Customizations.
2. Create a backup copy of the exported customizations.zip file. Use this file to recover from errors if necessary.
3. Extract the customizations.xml file from the customizations.zip file.
4. Make your changes to the exported XML file.
5. Import the updated XML file by using the Import Customizations feature.
   1. In the Navigation Pane, click Settings, click Customization, and then click Import Customizations.
   2. Click Browse, locate your modified XML file, and then click Upload.
   3. On the Actions toolbar, click Import Selected Customizations.

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.

 

Passing Parameters to a URL Using SiteMap

Passing Parameters to a URL Using SiteMap

Passing parameters to the target URL for a subArea element in Sitemap is a way to provide the target application with information about the organization and the language context of the user and the organization. All the parameters are passed if the subArea element is configured by using the PassParams attribute.

You can indicate whether a subArea passes the following parameters:

Parameter	Name	Description
orgname	Organization Name	The unique name of the Organization.
userlcid	User Language Code	Represents the language code identifier that is used by the current user.
orglcid	Organization Language Code	The language code identifier representing the base language for the organization.

Language codes are a four digit Locale ID. Valid Locale ID values can be found at msdn2.microsoft.com/en-us/library/0h88fahh.aspx

Example

Without parameters:

http://myserver/mypage.aspx

With parameters:

http://myserver/mypage.aspx?orgname=AdventureWorksCycle&userlcid=1033&orglcid=1033

Reading Passed Parameters

Passed parameters are usually read in the target .aspx page by using the HttpRequest.QueryString property. For more information, see: msdn2.microsoft.com/en-us/library/system.web.httprequest.querystring.aspx.