Export (0) Print
Expand All

SubArea Element (SiteMap)

banner art

[Applies to: Microsoft Dynamics CRM 4.0]

Specifies the elements displayed in the left navigation pane for each area.

Element Information

Number of occurrencesZero or more.
Parent elementsGroup
Child elementsTitles

Descriptions

Privilege

XPath//SiteMap/SiteMap/Area/Group/SubArea

Attributes

NameDescriptionTypeRequired
AvailableOfflineControls whether SubArea is available offline.

Valid values:

true
false

BooleanNo
ClientSpecifies the type of client

Default: All

Valid values:

All
Outlook
OutlookLaptopClient
OutlookWorkstationClient
Web

Multiple values can be used as long as they are separated by a comma and do not contain spaces. See Remarks.

StringNo
DescriptionDeprecated.

Use the Description Element.

StringNo
DescriptionResourceID For internal use onlyStringNo
EntitySpecifies the schema name for the entity.StringNo
GetStartedPanePathMicrosoft Dynamics CRM Online only

Specifies the path to the Get Started page for this subarea. See Remarks.

StringNo
GetStartedPanePathAdminMicrosoft Dynamics CRM Online only

Specifies the path to the Get Started page for this subarea if the user is logged in as an administrator. See Remarks.

StringNo
GetStartedPanePathAdminOutlookMicrosoft Dynamics CRM Online only

Specifies the path to the Get Started page for this subarea if the user is logged in as an administrator and Microsoft Dynamics CRM for Outlook is in use. See Remarks.

StringNo
GetStartedPanePathOutlookMicrosoft Dynamics CRM Online only

Specifies the path to the Get Started page for this subarea when Microsoft Dynamics CRM for Outlook is in use. See Remarks.

StringNo
IconSpecifies the icon to display.StringNo
IdSpecifies a unique identifier in ASCII, which has no spaces.

Valid values:

a-z, A-Z, 0-9, and underscore (_)

StringYes
LicenseDeprecatedString 
PassParamsSpecifies whether information about the organization and language context are passed to the URL. See Passing Parameters to a URL Using SiteMap.

Valid values:

0 = do not pass parameters [default]
1 = pass parameters

BooleanNo
OutlookShortcutIconSpecifies the icon to display in Microsoft Dynamics CRM for Microsoft Office Outlook.StringNo
ResourceIdFor internal use only.StringNo
SkuMicrosoft Dynamics CRM Online only

Specifies whether to display this subarea based on the Microsoft Dynamics CRM edition.

Valid values:

Any combination of the following:

All
OnPremise
Live
SPLA

Multiple values can be used as long as they are separated by a comma and do not contain spaces.

StringNo
TitleDeprecated.

Use the Titles and Title elements.

StringNo
UrlSpecifies the URL to load for this subarea.StringNo

Remarks

The SubArea element must contain a Titles element and a valid Title attribute for the user language or a value for the ResourceId attribute.

For Microsoft Dynamics CRM for Outlook, titles must be defined through the Titles element, the Entity, or the ResourceId attribute value and must be unique within the parent group.

More than one instance of the same pages may occur. Therefore, you must make sure that each belongs to different combinations of clients and offline modes.

These changes affect the structure of Microsoft Dynamics CRM for Outlook shortcuts and the Web client Go To menu.

The OutlookWorkstationClient Client attribute value refers to Microsoft Dynamics CRM for Microsoft Office Outlook.

The OutlookLaptopClient Client attribute value refers to Microsoft Dynamics CRM for Microsoft Office Outlook with Offline Access.

The Getting Started Pane is a new feature in Microsoft Dynamics CRM Online Service Update 4. This area shows the user steps to begin using each area of the product. The content displayed is controlled by these attributes:

  • GetStartedPanePath
  • GetStartedPanePathAdmin
  • GetStartedPanePathAdminOutlook
  • GetStartedPanePathOutlook

Before customizations, the Getting Started pane is supported on the following entities:

  • Homepage
  • Activities
  • Accounts
  • Contacts
  • Leads
  • Opportunities
  • Cases
  • Marketing Lists
  • Quick Campaigns
  • Campaigns
  • Imports
  • Workflows

All other entities with a grid page support the Get Started Pane. To enable the Getting Started Pane for other areas, you can specify the path attributes listed here. If the URL in these path attributes begins with "Http://" or "Https://", it is considered to be overridden and is treated as an absolute path. All, some, or none of the Get Started Path attributes can be used. If the content is the same for all administrator and CRM client types, the GetStartedPanePath attribute can be used to display content for all users and all client types.

Example

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

<SubArea Id="nav_dashboard" PassParams="1" 
         Url="/isv/dashboard/dashboard.aspx" >
 <Titles>
  <Title LCID="1033" Title="Dashboard" />
 </Titles>
</SubArea>

© 2010 Microsoft Corporation. All rights reserved.


Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft