<SubArea> (SiteMap)

 

Updated: November 29, 2016

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

Specifies a navigation option within an <Area> (SiteMap). Defines what will be displayed in the main pane of the application when selected.

<SubArea 
 AvailableOffline=["0" | "1" | "true" | "false"]
 CheckExtensionProperty="String"
 Client=["All" | "Outlook" | "OutlookLaptopClient" | "OutlookWorkstationClient"  | "Web" ]
 Description="String"
 DescriptionResourceId="String"
 Entity="String"
 GetStartedPanePath="String"
 GetStartedPanePathAdmin="String"
 GetStartedPanePathAdminOutlook="String"
 GetStartedPanePathOutlook="String"
 Icon="String"
 Id="String"
 License="String"
 OutlookShortcutIcon="String"
 PassParams=["0" | "1" | "true" | "false"]
 ResourceId="String"
 Sku=["All" | "OnPremise" | "Live" | "SPLA"]
 Title="String"
 Url="String">
 <Titles />
 <Descriptions />
 <Privilege/>
</SubArea>

Attributes and Elements

The following table lists the attributes, child elements, and parent elements.

Attributes

Attribute

Description

Type

Usage

AvailableOffline

Controls whether SubArea is available offline.

Boolean

Optional

CheckExtensionProperty

For internal use only.

String

Optional

Client

Specifies 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.

There is not a separate value for Microsoft Dynamics 365 for tablets. Setting this to All or Web will not filter the display of this SubArea in the Dynamics 365 for tablets client.

String

Optional

Description

Deprecated. Use the SubArea/Descriptions/Description element instead.

String

Optional

DescriptionResourceId

For internal use only. Use the SubArea/Descriptions/Description element instead.

String

Optional

DefaultDashboard

Specifies the GUID for default dashboard to be displayed for this subarea.

String

Optional

Entity

Specifies the name for the entity. A valid value has a length greater then 1. If a Url is not specified, the default view of the specified entity will be displayed.

String

Optional

GetStartedPanePath

The Get Started Pane was removed from Microsoft Dynamics CRM 2013 and the Microsoft Dynamics CRM Online Fall '13 Service Update.

String

Optional

GetStartedPanePathAdmin

The Get Started Pane was removed from Microsoft Dynamics CRM 2013 and the Microsoft Dynamics CRM Online Fall '13 Service Update.

String

Optional

GetStartedPanePathAdminOutlook

The Get Started Pane was removed from Microsoft Dynamics CRM 2013 and the Microsoft Dynamics CRM Online Fall '13 Service Update.

String

Optional

GetStartedPanePathOutlook

The Get Started Pane was removed from Microsoft Dynamics CRM 2013 and the Microsoft Dynamics CRM Online Fall '13 Service Update.

String

Optional

Icon

Specifies a URL for an 18x18 pixel image to display for the SubArea.

String

Optional

Id

A unique identifier for this SubArea element.

Valid values:

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

String

Required

License

Deprecated.

String

Optional

OutlookShortcutIcon

Specifies the icon to display in Microsoft Dynamics 365 for Outlook.

String

Optional

PassParams

Specifies whether information about the organization and language context are passed to the URL.

Boolean

Optional

ResourceId

For internal use only. Use the SubArea/Titles/Title element to set the text to display for this SubArea.

String

Optional

Sku

Specifies the versions of Microsoft Dynamics 365 that displays this SubArea.

Default: All

Valid values:

  • All

  • OnPremise

  • Live

  • SPLA

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

String

Optional

Title

Deprecated. Use the SubArea/Titles/Title element instead.

String

Optional

Url

Specifies a URL or HTML Web Resource for a page to display in the main frame of the application when this subarea is selected.

String

Optional

Child Elements

Element

Description

<Privilege> (SiteMap)

Controls whether a subarea is displayed based on privileges available in any security roles assigned to the user.

Parent Elements

Element

Description

<Group> (SiteMap)

Specifies a group of subareas. Groups can be shown or hidden as defined by the area. Groups defined within the Workplace area can be marked as a user selectable profile. These profiles are available for users to select in their personal options.

The SubArea element must contain a <Titles> (SiteMap) element or a valid Title attribute for the user language or a value for the ResourceId attribute.

For Dynamics 365 for Outlook, titles must be defined through the <Titles> (SiteMap) 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 Dynamics 365 for Outlook shortcuts and the Web client Go To menu.

The OutlookWorkstationClient Client attribute value refers to Dynamics 365 for Outlook.

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

Example

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

<SubArea Id="nav_dashboard" PassParams="1" 
 Url="$webresource:MyIsv_/navDashboard.htm" >
 <Titles>
  <Title LCID="1033" Title="Dashboard" />
 </Titles>
</SubArea>

When referring to an HTML or Image Web Resource use the web resource directive and the HTML or Image Web Resource name. “$webresource:+ Web resource name.”. This creates a dependency so the HTML or Image Web Resource cannot be removed while the SubArea is referencing it.

Element Information

Schema Name

SubArea

Validation File

SiteMapType.xsd

Number of Occurrences

0 or more

XPath

//SiteMap/Area/Group/SubArea

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright

Community Additions

ADD
Show: