Share via

Opening a Page in the Microsoft Dynamics NAV Web Client by Using a URL

  • Article

You can open a specific page in the Microsoft Dynamics NAV Web client by typing the page's URL in the address of a web browser. You can use the URL as a hyperlink to the page, which you can include in other sources, such as emails or Word documents, or you can it send to other users.

Important

Certain data in the URL, such as company name, could be considered sensitive information. Use discretion if you distribute URLs that contain the company name, or if it is possible, exclude this information from the address.

This topic includes the following sections:

  • Example

  • Page Address Syntax

  • Building the Page Address

  • URL Parameters

  • Filtering Data on the Page

Example

The following URL displays page 9305 Sales Order List for the CRONUS International Ltd. company. The page is displayed in a Microsoft Dynamics NAV Web client that is running on port 8080 of a computer that has the name MyWebServer.

http://MyWebServer:8080/DynamicsNAV71/WebClient/list.aspx?company=CRONUS%20International%20Ltd.&page=9305

There are several parameters that define the address for the page. These parameters are described in the URL Parameters section of this topic. You can also filter the data on specific fields of the page. For information about how to filter the data, see Filtering Data on the Page.

Page Address Syntax

The address to open a page in the Microsoft Dynamics NAV Web client has the following syntax.

<http|https>://<webserver>[:<port>]/<webserverinstance>/WebClient/<card|list|blank>.aspx?<page>=<ID>&[tenant=<tenantID>]&[company=<companyname>]&[mode=<View|Edit|Create>]

The URL consists of two parts, the web server part and the Microsoft Dynamics NAV content part. The web server part targets a specific site on the computer that is running Microsoft Dynamics NAV Web Server components and includes the following syntax.

<http|https>://<webserver>[:<port>]/<webserverinstance>/WebClient

The Microsoft Dynamics NAV content part includes the rest of the address after /WebClient/. This part of the address is composed of an active server page extended (ASPX) file and a query string that specifies the page to display.

Syntax Key

The following table describes the notation that is used to indicate address syntax.

Notation Description

Text without brackets

Parameters that you must type as shown.

<>

A placeholder for values that you must supply. Do not include the brackets in the address.

[ ]

Optional parameters. Do not include the brackets in the address.

|

A set of values from which to choose. Use one of the options and do not include | in the address.

Building the Page Address

Use the following guidelines to write page URL syntax and create a URL:

  • Place parameters in any order after aspx? because the order is not important. For example, the following URLs will yield the same results.

    http://MyWebServer:8080/DynamicsNAV71/WebClient/list.aspx?company=CRONUS%20International%20Ltd.&page=9305&mode=View

http://MyWebServer:8080/DynamicsNAV71/WebClient/list.aspx?page=9305&mode=View&company=CRONUS%20International%20Ltd.

  • Separate parameters after aspx? with the ampersand symbol (&).

  • Use %20 for any spaces in values and names.

  • Enclose values in single quotation marks ('').

URL Parameters

The following table describes the parameters of the URL for displaying a page.

Parameter Description

http|https

Specifies the Internet protocol to use. Valid options are http and https.

The https protocol helps secure the Microsoft Dynamics NAV data that is transmitted over the Internet. To use https, Secure Sockets Layer (SSL) must be enabled on the connection to Microsoft Dynamics NAV Web client. For more information, see How to: Configure SSL to Secure the Connection to Microsoft Dynamics NAV Web Client.

webserver

Specifies the name of the computer that is running Microsoft Dynamics NAV Web client.

port

Specifies the server port on which the Microsoft Dynamics NAV Web client is running. The default port is 8080.

webserverinstance

Specifies the name of the web server instance for the Microsoft Dynamics NAV Web client. On IIS, this is the alias of the virtual directory of the web server instance.

When you install the Microsoft Dynamics NAV Web client using Microsoft Dynamics NAV Setup, the web server instance is given the same name as the Microsoft Dynamics NAV Server instance that it connects to. If you use the New-NAVWebServerInstance cmdlet to add Microsoft Dynamics NAV Web client instances, then you specify the web server instance name. For more information, see How to: Set Up Multiple Web Server Instances for the Microsoft Dynamics NAV Web Client.

card|list|blank

Specifies the name of the active server page file to use to display the page. You can use any of the following types, regardless what the page type is: card, list, blank.

The type that you set is not important because the Microsoft Dynamics NAV Web client will automatically redirect to the appropriate page. For example, if you use card.aspx to display a List type page, then the URL is automatically redirected to the list.aspx.

Hh997130.Important(en-us,NAV.71).gifImportant
You cannot use blank to open a RoleCenter type page. Use list or card instead.

company

The name of the company in Microsoft Dynamics NAV for which you want to display the page.

If you do not choose a company, then Microsoft Dynamics NAV Web client uses the company that is defined in its web.config file. If no company is defined in the web.config file, then the company last opened by the user is used.

bookmark

Specifies a record in the underlying table of the page. The value of a bookmark is an alphanumeric string of characters, for example, 27%3bEgAAAAJ7CDAAMQA5ADAANQA4ADkAMw%3d%3.

For the page types Card, CardPart, and Document, the bookmark specifies the record that is shown in the page. For page types List, ListPart, and Worksheet, the bookmark specifies the record that is selected in the list on the page.

Hh997130.Important(en-us,NAV.71).gifImportant
Bookmarks are generated automatically. You can only determine a value for the bookmark by displaying the page in the Microsoft Dynamics NAV Web client and looking at its address. Therefore, a bookmark is only relevant when the address you are working with has been copied from another instance of the page in the Microsoft Dynamics NAV Web client.

ID

The ID of the page in Microsoft Dynamics NAV.

Hh997130.Important(en-us,NAV.71).gifImportant
Microsoft Dynamics NAV Web client does not support the NavigatePage page type. If you try to display a page of the type NavigatePage, then you will get an error.

mode

Specifies the mode in which to display the page.

  • View

    The page can only be viewed. The user cannot change data on the page.

    Hh997130.note(en-us,NAV.71).gifNote
    Worksheet page types only display in the edit mode, even if the value is set to View.
  • Edit

    The user can change data on the page.

    Hh997130.note(en-us,NAV.71).gifNote
    To use the edit mode, the Editable Property of the page in Page Designer must be set to Yes. This mode is not supported for pages of the type List, RoleCenter, and CardPart. If you set the value to Edit, pages of these types still display in the view mode. For List type pages, the user can modify the list by choosing Edit List in the ribbon of the page in Microsoft Dynamics NAV Web client.
  • Create

    Opens a blank page that enables the user to create a new item.

    Hh997130.note(en-us,NAV.71).gifNote
    This mode is not supported for pages of the type CardPart, List, ListPart, RoleCenter, and Worksheet. For pages of the type CardPart, List, and ListPart, the page displays in the view mode. Do not use this mode for Worksheet pages; otherwise you will get an error when you try to open the page.

showribbon

Specifies whether or not to show the ribbon when the specified page opens. The default value, if the parameter is not specified, is 1 which displays the ribbon. Use the value 0 to not show the ribbon.

Hh997130.note(en-us,NAV.71).gifNote
This parameter only works for pages of the list page type.

shownavigation

Specifies whether or not to show the navigation page when the specified page opens. The default value, if the parameter is not specified, is 1 which displays the navigation pane. Use the value 0 to not show the navigation pane.

Hh997130.note(en-us,NAV.71).gifNote
This parameter only works for pages of the list page type.

showuiparts

Specifies whether or not to show UI parts when the specified page opens. The default value, if the parameter is not specified, is 1 which displays the UI parts. Use the value 0 to not show UI parts.

Hh997130.note(en-us,NAV.71).gifNote
This parameter only works for pages of the list page type.

tenant

Specifies the ID of the tenant to connect to. You must provide this parameter when Microsoft Dynamics NAV is deployed in multitenant architecture. The tenant that you specify must be mounted on the Microsoft Dynamics NAV Server instance that the Microsoft Dynamics NAV Web client connects to. For more information, see Multitenant Deployment Architecture.

For more information about framing the Web client, see Embedding Microsoft Dynamics NAV Web Client Pages in Other Websites.

Filtering Data on the Page

You can filter the data that is displayed in the page by using the filter parameter in the address. The filter parameter enables you to display only records from the underlying table of the page that have specific values for one or more fields.

Example

The following address displays data in page 9305 only for the customer who has the Sell-to Customer No. 10000 and the Location Code Blue.

http://MyWebServer:8080/DynamicsNAV71/WebClient/list.aspx?company=CRONUS%20International%20Ltd.&page=9305&filter='Sell-to%20Customer%20No.'%20IS%20'10000'%20AND%20'Location%20Code'%20IS%20'BLUE'

Filter Syntax

The filter has the following syntax.

&filter='<field>'%20IS%20'<value>'[%20AND%20'<field>'%20IS%20'<value>']

You can add the filter anywhere in the address after .aspx?.

Tip

The filter syntax for a page in the Microsoft Dynamics NAV Web client is the same as a page in the Microsoft Dynamics NAV Windows client, which you can see by choosing the Copy Link to Page action on the Application menu in the Microsoft Dynamics NAV Windows client.

Filter Parameters

The following table describes the filter parameters.

Parameter Description

field

The name of the table field on which to filter.

%20IS%20

Specifies the equal operator.

value

The value of the table field on which to filter.

%20AND%20

Use this parameter to specify more than one filter. It specifies an “and” operator for adding additional filters. Place %20AND%20 between each additional filter.

To be included in the page data, the table record must match values for all fields in the filter.

See Also

Tasks

How to: Install the Web Server Components for the Microsoft Dynamics NAV Web Client
How to: Open the Microsoft Dynamics NAV Web Client

Concepts

Deploying the Microsoft Dynamics NAV Web Client
Developing for the Microsoft Dynamics NAV Web Client