Consider disabling NavBar when programmatically opening entity forms or views

Category: Design, Performance

Impact potential: Medium

Symptoms

Opening up entity forms or views with a URL, could lead to slower client performance on high latency networks when the navigation bar (NavBar) is enabled.

Guidance

Determine if your users need to have the full navigation bar when creating customizations that open entity forms or views through a URL. In most cases, users click on a link to open an entity form, do some quick work, and then close the record. Disabling the navigation bar will lower the amount of resources to be loaded which lowers the number of network requests being made.

When constructing URLs to open up entity forms or views, implement navbar=off within your query string parameters for the main.aspx page. The following example opens an Account entity form with the navigation bar disabled.

function disableNavBar() {
    var globalContext = Xrm.Utility.getGlobalContext();
    return globalContext.getClientUrl() + "/main.aspx?appid=9411ee28-4310-e811-a839-000d3a33a7cb&etc=1&id={00000000-0000-0000-00AA-000010001004}&pagetype=entityrecord&navbar=off";
}

Important

The navbar=off query string parameter is only available with the main.aspx page.

Problematic patterns

Warning

These scenarios should be avoided.

Keeping the navigation bar (NavBar) enabled does not mean users will experience performance issues. However, it does mean that additional resources must be loaded on the entity form or view which does require additional network requests. It has been observed on highly latent networks this can lead to a poor user experience.

An example of a constructed URL with the NavBar enabled is as follows

function enabledNavBar() {
    var globalContext = Xrm.Utility.getGlobalContext();
    // By default, NavBar is set to true if you do not include the parameter in the query string:
    return globalContext.getClientUrl() + "/main.aspx?appid=9411ee28-4310-e811-a839-000d3a33a7cb&etc=1&id={00000000-0000-0000-00AA-000010001004}&pagetype=entityrecord";
}

function enabledNavBarExplicit() {
    var globalContext = Xrm.Utility.getGlobalContext();
    // Explicitly defining that the NavBar will be enabled
    return globalContext.getClientUrl() + "/main.aspx?appid=9411ee28-4310-e811-a839-000d3a33a7cb&etc=1&id={00000000-0000-0000-00AA-000010001004}&pagetype=entityrecord&navbar=on";
}

Additional information

When opening up other records from within model driven apps, the navigation bar is being loaded with the areas and subareas defined within the sitemap. In addition, it also renders the Office app launcher which displays the Office 365 apps the user has access to.
Comparison of NavBar being enabled and disabled

See also

Open forms, views, dialogs, and reports with a URL