<Area> (SiteMap)

Article
06/29/2017

Applies To: Dynamics CRM 2013

Specifies the areas that appear in the navigation pane.

Syntax

<Area
  URL=string
  Id=string
  ShowGroups=true|false>
  <Titles>
  <Descriptions>
  <Group>
</Area>

Attributes and Elements

Attributes

Attribute	Description	Type	Usage
Description	Deprecated. Use the <Description> (SiteMap) element.	String	Optional
DescriptionResourceID	For internal use only.	String	Optional
Icon	Specifies a URL to a 16x16 pixel image that will be displayed in the Navigation pane for this area.	String	Optional
Id	Specifies a unique identifier in ASCII. Valid values are a-z, A-Z, 0-9, and underscore (_). Spaces are not allowed.	String	Required
License	Deprecated.	String	Optional
ResourceId	For internal use only.	String	Optional
ShowGroups	Controls whether groups of sub-areas are shown in the navigation pane. Valid values are true and false.	Boolean	Optional
Title	Deprecated. Use the <Titles> (SiteMap) and <Title> (SiteMap) elements.	String	Optional
Url	Specifies the CRM for Outlook URL to render for the Outlook folder that represents the Area.	String	Optional

Child Elements

Element	Description
<Titles> (SiteMap)	Contains a set of localized titles for an area.
<Descriptions> (SiteMap)	Contains a set of localized descriptions.
<Group> (SiteMap)	Specifies a group of subareas.

Parent Elements

Element	Description
<SiteMap> (SiteMap)	Specifies the root node for the site map.

Remarks

The Application Areas in Microsoft Dynamics CRM include Workplace, Sales, Marketing, Customer Service, Settings and Help. New areas can be added or existing Areas can be removed. However, removing the Settings area is not recommended. Instead, use privileges to control access to Settings.

The Navigation Pane will not display Area elements without visible SubArea elements. SubArea elements may be hidden from users based on security privileges. If all the SubArea elements in an Area are hidden, or none are defined, the Area will not display.

Example

The following shows an example of how to use the Area element.

<Area Id="Custom_Area">
 <Titles>
  <Title LCID="1033" Title="English Area Title"/>
  <Title LCID="1031" Title="German Area Title"/>
 </Titles>
 <Descriptions>
  <Description LCID="1033" Description="English Description"/>
  <Description LCID="1031" Description="German Description"/>
 </Descriptions>
 <Group Id="Custom_Group">
  <SubArea Id="Custom_SubArea" 
   Url="http://my_app/my_page.aspx" 
   AvailableOffline="false" >
   <Titles>
    <Title LCID="1033" Title="English SubArea Title"/>
    <Title LCID="1031" Title="German SubArea Title"/>
   </Titles>
  </SubArea>
 </Group>
</Area>

Element Information

Schema Name	SiteMap
Validation File	SiteMapType.xsd
Number of Occurrences	0 or More
XPath	//SiteMap/SiteMap/Area