Share via

Configuring Microsoft Dynamics NAV Web Client by Modifying the Web.config File

  • Article

To install the Microsoft Dynamics NAV Web client, you run Microsoft Dynamics NAV 2015 Setup. Setup installs a website with a web server instance for the Microsoft Dynamics NAV Web client on an Internet Information Services (IIS) server and configures the connection from the Microsoft Dynamics NAV Web client to Microsoft Dynamics NAV Server. After the installation, you can use Microsoft Dynamics NAV 2015 Administration Shell to add additional web server instances for the Microsoft Dynamics NAV Web client. The connection information is saved in the web.config file of the web server instance. After installation, you can change the configuration by modifying the web.config file.

About the Web.config File

The web.config file is an .xml file that you can edit with a text editor, such as Notepad.

Locating the web.config file

You can have multiple Microsoft Dynamics NAV web server instances on IIS. Each instance has its own web.config file that is stored in the physical path of the application's virtual directory. The path is %systemroot%\inetpub\wwwroot\[VirtualDirectoryName]. For example, the folder for the default Microsoft Dynamics NAV Web client instance is %systemroot%\inetpub\wwwroot\DynamicsNAV80 folder.

Note

After you modify the web.config file, if you have Microsoft Dynamics NAV Web client open in the Internet browser, the changes will not take effect until you close the browser session, and then reopen Microsoft Dynamics NAV Web client.

Microsoft Dynamics NAV Settings in the Web.config File

The Microsoft Dynamics NAV Web client settings are included in the <DynamicsNAVSettings> element in the web.config file. The following table describes the settings that are available in the <DynamicsNAVSettings> element.

Important

All values must be enclosed in quotation marks.

Setting Description

AllowNtlm

Specifies whether NT LAN Manager (NTLM) fallback is permitted for authentication.

To require Kerberos authentication, set this value to false.

Values: true, false

Default value: true

ClientServicesChunkSize

Sets the maximum size, in kilobytes, of a data chunk that is transmitted between Microsoft Dynamics NAV Web client and Microsoft Dynamics NAV Server. Data that is transmitted between Microsoft Dynamics NAV Web client and Microsoft Dynamics NAV Server is broken down into smaller units called chunks, and then reassembled when it reaches its destination.

Values: From 4 to 80.

Default value: 28

Company

Sets the company in Microsoft Dynamics NAV to connect to. If you do not define a company, then the company that was last opened by the user is used.

Values: A company defined in the Microsoft Dynamics NAV solution.

For more information about companies, see How to: Create Companies.

Default value: none

ClientServicesCompressionThreshold

Sets the threshold in memory consumption at which Microsoft Dynamics NAV Web client starts compressing data sets. This limits amount of consumed memory. The value is in kilobytes.

Default value: 64

TimeZone

Sets the time zone for Microsoft Dynamics NAV Web client. The time zone will apply to date and time data that a user views or enters in the Microsoft Dynamics NAV Web client.

Values: A time zone that is included in the registry of the computer that is running Microsoft Dynamics NAV Web client. You find the time zones in the registry under HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones. The value must match a time zone that is listed in the registry. For example, you can set the value to "Pacific Standard Time" or "Central Europe Standard Time".

Default value: UTC

Language

Sets the language version of the Microsoft Dynamics NAV Web client. For more information about languages, see Multilanguage Development and Managing Language, Regional Settings and Time Zone in the Micrsoft Dynamics NAV Web Client.

Values: A valid culture name for a language that is available for the Microsoft Dynamics NAV solution. The culture name has the format: nn-NN. nn is a lowercase two-letter code for the language and NN is an uppercase two-letter code for the country or region. For example, en-US is for English (United States) and en-GB is for English (United Kingdom), and da-DK is for Danish (Denmark). There are some languages that use a three-letter language code or a suffix to the region code. The culture name must follow the RFC 1766 standard. For a list of the most common culture names, see CultureInfo Class.

Default value: The culture name of the language version of Microsoft Dynamics NAV that was installed.

Hh168732.Important(en-us,NAV.80).gifImportant
For the Spanish version of Microsoft Dynamics NAV, you must set the value to es-ES_tradnl.

RegionFormat

Specifies the culture name that is used to format dates, times, numbers, and currency in the Microsoft Dynamics NAV Web client.

Values: A valid language culture name that has the format: nn-NN. nn is a lowercase two-letter code for the language and NN is an uppercase two-letter code for the country or region. For example, en-US is for English (United States), en-GB is for English (United Kingdom), and da-DK is for Danish (Denmark). There are some languages that use a three-letter language code or a suffix to the region code. The culture name must follow the RFC 1766 standard. For a list of the most common culture names, see CultureInfo Class.

Default value: The culture name for the language version of Microsoft Dynamics NAV that was installed.

ClientServicesProtectionLevel

Specifies the security services used to protect the data stream between the Microsoft Dynamics NAV Web client and Microsoft Dynamics NAV Server. This value must match the value that is specified in the Microsoft Dynamics NAV Server configuration file. For more information, see Configuring Microsoft Dynamics NAV Server.

Values: EncryptAndSign, Sign, None

Default value: EncryptAndSign

Server

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

Default value: localhost

ServerInstance

Specifies the name of the Microsoft Dynamics NAV Server instance that the Microsoft Dynamics NAV Web client connects to.

For more information, see Managing Microsoft Dynamics NAV Server Instances.

Default value: DynamicsNAV80

ClientServicesCredentialType

Specifies the authorization mechanism that is used to authenticate users who try to connect to the Microsoft Dynamics NAV Web client. For more information, see How to: Set Up User Authentication for the Microsoft Dynamic NAV Web Client and Users and Credential Types.

The credential type must match the credential type configured for the Microsoft Dynamics NAV Server instance that the Microsoft Dynamics NAV Web client connects to. For information about how to set up the credential type on Microsoft Dynamics NAV Server, see Configuring Microsoft Dynamics NAV Server.

Values: Windows, UserName, NavUserPassword, AccessControlService

Default value: Windows

ClientServicesPort

Specifies the TCP port for the Microsoft Dynamics NAV Server. This is part of the Microsoft Dynamics NAV Server’s URL.

Values: 1-65535

Default value: 7046

ServicePrincipalNameRequired

If this parameter is set to true, then the Microsoft Dynamics NAV Web client can only connect to a Microsoft Dynamics NAV Server instance that has been associated with a service principal name (SPN).

If this parameter is set to false, then the Microsoft Dynamics NAV Web client attempts to connect to the configured Microsoft Dynamics NAV Server service, regardless of whether that service is associated with an SPN.

For more information about SPNs, see How to: Configure Delegation for Microsoft Dynamics NAV Web Client.

Default: false

SessionTimeout

Specifies the maximum time that a connection between the Microsoft Dynamics NAV Web client and the Microsoft Dynamics NAV Server can remain idle before the session is stopped.

In the Microsoft Dynamics NAV Web client, this setting determines how long an open Microsoft Dynamics NAV page or report can remain inactive before it closes. For example, when the SessionTimeout is set to 20 minutes, if a user does not take any action on a page within 20 minutes, then the page closes and it is replaced with the following message: The page has expired and the content cannot be displayed.

The time span has the format [dd.]hh:mm:ss[.ff]:

  • dd is the number of days

  • hh is the number of hours

  • mm is the number of minutes

  • ss is the number of seconds

  • ff is fractions of a second

Default value: 00:20:00

ShowPageSearch

Specifies whether to show the Search for Page or Report icon in the ribbon pane of the Role Center. The Search for Page or Report lets users find Microsoft Dynamics NAV objects, such as pages, reports, and codeunits.

Hh168732.note(en-us,NAV.80).gifNote
The Search for Page or Report option only finds objects that are available from the Departments page in the Microsoft Dynamics NAV Windows client.

If you do not want to the Search for Page or Report icon available in the Microsoft Dynamics NAV Web client, then set the parameter to false.

Default value: true

UnknownSpnHint

Specifies whether to use a server principal name when establishing the connection between the Microsoft Dynamics NAV Web client server and Microsoft Dynamics NAV Server. This setting is used to authenticate the Microsoft Dynamics NAV Server, and it prevents the Microsoft Dynamics NAV Web client server from restarting when it connects to Microsoft Dynamics NAV Server for the first time. You set values that are based on the value of the ServicePrincipalNameRequired key.

Value: The value has the following format.

(net.tcp://NavServer:Port/ServerInstance/Service)=NoSpn|SPN

  • NavServer is the name of the computer that is running the Microsoft Dynamics NAV Server.

  • Port is the port number on which the Microsoft Dynamics NAV Server is running.

  • ServerInstance is the name of the Microsoft Dynamics NAV Server instance.

  • NoSpn|SPN specifies whether to use an SPN. If the ServicePrincipalNameRequired key is set to false, then set this value to NoSpn. If the ServicePrincipalNameRequired key is set to true, then set this value to Spn.

Default value: (net.tcp://localhost:7046/DynamicsNAV80/Service)=NoSpn

If you set this key to the incorrect value, then during startup, the Microsoft Dynamics NAV Web client will automatically determine a correct value. This will cause the Microsoft Dynamics NAV Web client to restart.

Hh168732.note(en-us,NAV.80).gifNote
For most installations, you do not have to change this value. Unlike the Microsoft Dynamics NAV Windows client, this setting is not updated automatically. If you want to change the default value, then you must change it manually.

DnsIdentity

Specifies the subject name or common name of the service certificate for Microsoft Dynamics NAV Server.

This parameter is only relevant when the ClientServicesCredentialType is set to UserName, NavUserPassword, or AccessControlService, which requires that security certificates are used on the Microsoft Dynamics NAV Web client and Microsoft Dynamics NAV Server to protect communication.

Hh168732.note(en-us,NAV.80).gifNote
You can find the subject name by opening the certificate in the Certificates snap-in for Microsoft Management Console (MMC) on the computer that is running Microsoft Dynamics NAV Web client or Microsoft Dynamics NAV Server.

For more information, see How to: Set Up User Authentication for the Microsoft Dynamic NAV Web Client.

Value: The subject name of the certificate.

Default value: none

ACSUri

This parameter is only relevant if the ClientServicesCredentialType parameter is set to AccessControlService.

With the AccessControlService setting, users are authenticated by using either Microsoft Azure Access Control service (ACS) or Microsoft Azure Active Directory (Azure AD). The value of this setting depends on whether ACS or Azure AD is used to authenticate users.

When using ACS authentication, the ACSUri parameter specifies the URI of the ACS login page for relying party applications. An example of a URI is https://CRONUSInternationalLtd.accesscontrol.windows.net/v2/wsfederation?wa=wsignin1.0%26wtrealm=https%3a%2f%2flocalhost%2f. For more information, see How to: Configure the Microsoft Dynamics NAV Web Client for ACS.

When using Azure AD authentication, the ACSUri specifies the URI of the authentication page for the Azure AD tenant where users sign in. An example of a URI is https://login.windows.net/[Tenant_ID]/wsfed?wa=wsignin1.0%26wtrealm=https%3a%2f%2flocalhost%2f. [Tenant_ID] specifies the Azure AD tenant. When the Microsoft Dynamics NAV application has external access and multiple Azure AD tenants are required, you can replace [Tenant_ID] with common. For more information, see Authenticating Users with Azure Active Directory.

Optionally, you can specify a wreply query parameter. The wreply query parameter tells the Azure AD authentication service where to send the authentication token, and the parameter must point to the SignIn.aspx page of the Microsoft Dynamics NAV Web client. If you do not specify the wreply parameter, it will be deducted from the URL in the browser. The value of the wreply parameter must correspond to a Reply-To address in the Azure AD application pointed out by the wtrealm query parameter value.

Hh168732.Important(en-us,NAV.80).gifImportant
The query string parameter must be URI-encoded. This means, for example, use "%26" instead of "&".

Default value: none

HelpServer

Specifies the name of the Microsoft Dynamics NAV Help Server that the Microsoft Dynamics NAV Web client must connect to, such as MyServer.

Default value: none

HelpServerPort

Specifies the TCP port on the specified Microsoft Dynamics NAV Help Server that the Microsoft Dynamics NAV Web client can access Help through, such as 49000.

Default value: none

See Also

Concepts

Configuring Microsoft Dynamics NAV Server

Other Resources

How to: Set up Multiple Microsoft Dynamics NAV Web Client Applications on a Website
How to: Install Microsoft Dynamics NAV Web Client
Deploying the Microsoft Dynamics NAV Web Client