Dynamics 365 Application Development

To access the Site Map Designer for our Sales app, perform the following steps:

Double-clicking on it will open the Sales App Site Map on the Site Map Designer for us to edit. The Site Map Designer canvas allows us to work with Area, Group, and Subarea components:

Within the designer canvas, we can Add, Cut, Copy, Paste, Clone, and Delete.

Let us look at these components in detail.

Site map consists of three main components:

Referring to our Sales app interface:

The Sales area would have subareas specific to Sales, arranged inside what are termed as groups. Similarly, the Marketing, Settings and Training Area will have corresponding subareas inside the corresponding group. As shown in the following screenshot, the Marketing Area has Dashboards, Activities, Accounts, Contacts, Leads, Marketing Lists, Campaigns, Quick Campaigns, and so on. It also has subareas specific to the marketing module. These subareas are arranged inside the My Work, Customers, Marketing, Collateral, and Tools groups:

Now, as we have got the overview of the site map components, let us look at the different properties of each of these components in the next section.

Let us look at the different properties of these components before we start customizing our Sales app navigation.

Subarea has few more properties compared to Area and Group:

In this section, we looked at the properties of the area, group, and subarea components of Site Map Designer. In the next section, we will learn how to perform some basic operations such as updating, adding, deleting, and so on, on these components through Site Map Designer.

To edit an existing area, group, and subarea in the site map, we need to select that component in the designer and go to the properties tab of that component. Let us take a simple example to understand this. Suppose we want to rename the existing Training area to Help, we need to select the Training area on the site map, go to its Properties tab, and update its Title property.

Let us specify Help as the value for the Title property. This updates the area's title from Training to Help, as shown as follows:

We can also update the title property of the site map components through inline editing. For this, hover over the component to reveal the pencil. We can click on the pencil icon to edit the Title. Similarly, we can edit or update the corresponding properties of the group and subarea components, and as we mentioned earlier, any changes made in the designer will reflect back in the XML for the site map.

To add an area, group, or subarea to the site map, we need to click on the Add button on the Action Bar in the Sitemap Designer. Let's add an area here to understand this. Click on the Add button and select Area:

Or, drag-and-drop the Area from the Components tab.

Once added, we need to select the component (Area here), and then edit its properties in the Properties tab. For example, the Properties tab for the new Area component added is shown in the following image:

This will add a new Area named New Area in the site map.

Similarly, we can add or drag and drop new groups and subarea components in the Navigation and specify their properties.

Through Site Map Designer, we can also cut, copy, and paste site map components. Let's select our New Area and click on the Cut button on the Action Bar to cut the component. The component will be grayed out.

Similarly, we can select the component and click on the Copy button to copy the component. The Paste button gives us the option of pasting the component to the right or left in case of Area and Group components, shown as follows:

To clone or make a copy of an existing Area, Group, and Subarea to the site map, we can select the component and click the Clone button on the Action Bar in the Sitemap Designer. The clone will add the respective component to the next component being cloned with the -Copy suffix added to its Title. For example, cloning the Sales Area, as shown in the following image, will add a new area named Sales-Copy next to the Sales Area that is cloned:

To delete an Area, Group, or Subarea from the site map, select the component and either click Delete from the Action bar or press the Delete key:

Deleting an Area will also delete the Group and Subarea in it. Similarly, deleting the Group will delete the Subarea in it.

Using Drag and Drop, we can move the components around the site map before we rearrange it:

For example, we can move the Sales Area to be the last Area in the site map, My Work to be the second group within the Sales Area, Dashboard as the last Subarea inside the MyWork Group, and so on, shown as follows:

We can also move a Subarea to a different Group. For example, the Dashboards Subarea can be moved to any of the other Groups such as Customer, Sales, Collateral, and so on, and a Group to be part of a different Area. That is, we can move the My Work Group to be part of the Settings, Training, and Sales area.

To reflect any of the preceding changes for the users, such as add, clone, delete, and so on, we need to click Save and then Publish it in the Site Map Designer canvas. Here, *Draft indicates that there are unsaved changes:

On saving the changes and clicking on Publish, it changes to Published to indicate that changes have been applied and are available for the users to see:

Clicking on the Save button will also validate and show up if there are any errors in the site map. For example, if we have not provided values for any of the required fields or specified unallowed characters for any of the properties. In the following screenshot, we have not provided a value for the entity property in the Subarea and clicked on Save, which is a mandatory field:

This shows the ERROR MESSAGE notification in the designer with all the details. We will only be able to save and then publish the changes after fixing the error.

Let's take a simple scenario here to understand how we can add a new Subarea component. We realize that our Sales app users would be frequently accessing the Open Leads View inside CRM, so it would be helpful for them if we could add a Subarea for Open Leads View in the My Work Group in the Sales Area for them. To implement it, we will need to add a new Subarea inside the My Work Group of type URL. To do so, we need to click on Add in the Action bar in Sitemap Designer and add a new Subarea and drag and place it below the Activities SubArea in the My Work Group:

Here, the URL pattern for the view needs to be the following:

=/_root/homepage.aspx?etc=<entity code >&viewid=%7b<GUID value of view id>%7d"

For the etc and viewid query parameters, we need to go to the Open Leads view in CRM and click on the EMAIL A LINK| Of Current View ribbon button to get the link:

The link will have the value of etc and viewid. We will then copy the value of the etc and viewid query string parameters from the link. We can then set the properties for our new SUB AREA, shown as follows:

We will save and then publish it. After publishing, inside the Sales app the user will be able to see the new Subarea named Open Leads:

Clicking on the Open Leads Subarea will open the Open Leads view, shown as follows:

As we saw earlier, the Subarea component has a privilege property. It defines whether to show or hide the Subarea based on privileges the user has through the security roles assigned. Let us try to understand this with an example as well. Suppose we want to show the Open Leads Subarea we just added to only those users who have a Create privilege on the Lead entity. To define this, let us go back to the Properties tab of the Open Leads Subarea in Site Map Designer. There, we need to go to Privileges inside the Advanced section. Inside the Entity drop-down, we can select the Lead entity and click on the + (plus) button to add the record. We will leave all the checkboxes unchecked, except Create:

Save and publish the changes. Now, let us log in with the user that has only the Salesperson security role assigned. Here, we have updated the security role and have set None for Create Privilege on Lead Entity; that is, the first option that we see in the following screenshot:

The users who do not have the Create privilege on the Lead record, will not be able to see the Open Leads Subarea in their site map. 

As we saw earlier, the Subarea component has a Parameter Passing checkbox property. It specifies whether to pass information about the organization and language context to the URL. The property is only available for Subareas of type web resource or URL. Suppose we have the following URL defined in our URL property of Subarea:http://mydomain/mypage.aspx.Checking the Parameter Passing checkbox will pass the following parameters to it:http://mydomain/mypage.aspx/?orglcid=1033&orgname=org29d341dd&userlcid=1033.

This information could be used to create solutions that support multiple languages.

A site map, as we essentially know, is an XML file. Any XML text editor is good enough to edit site map XML files. For this, we can export the unmanaged solution that contains the site map XML, edit it either in NotePad, Visual Studio, or any other XML editor, and import it back. The important thing to remember here is, if we are importing the site map as a managed solution, it will create a new site map record with all the latest changes, and in the case of unmanaged, the existing site map XML is overwritten.

Apart from Site Map Designer, we can use one of the third-party site map editors to edit the site map. One of the most popular tools is site map editor that is included as part of the XRM Tool Box. This is how our Sales App Site Map loads up inside site map editor:

The tool makes it easy to edit the site map compared to editing the XML manually. The tool has been one of the most popular tools for editing site maps and has been available since CRM 2011. The tool has been recently updated to support multiple site maps available in Dynamics 365. The other option is programmatically updating the site map. For this, we can make use of the site map entity and update its sitemapxml property, shown as follows:

Entity siteMap = new Entity["sitemap"]; 

siteMap["sitemapxml"] = "valid site map xml"; 

service.Update(siteMap); 

PublishXmlRequest request = new PublishXmlRequest();
 request.ParameterXml = "<importexportxml><sitemaps><sitemap></sitemap></sitemaps></importexportxml>";
 service.Execute(request);

We can also create and delete app-specific site map records programmatically. However, it is recommended you use Site Map Designer instead of doing it programmatically. Another point to note is that the default site map record cannot be created or deleted.

The default site map, which is the site map for Dynamics 365 – custom app is supported for both Dynamics 365 web applications and Dynamics 365 for Outlook. The site maps for any new custom apps, or the business apps such as Sales, Customer Service, Field Service, and Project Service Automation, are only supported by Dynamics 365 web applications.