Configuring Microsoft Dynamics NAV Server

When you run Microsoft Dynamics NAV 2013 R2 Setup and install Microsoft Dynamics NAV Server, you can provide configuration information that is then used as the configuration for the default Microsoft Dynamics NAV Server instance.

After you install Microsoft Dynamics NAV Server, you can change any of the settings that you provided during Setup, or any of the Microsoft Dynamics NAV Server settings, using either the Microsoft Dynamics NAV Server Administration tool or the Microsoft Dynamics NAV Windows PowerShell cmdlets for Microsoft Dynamics NAV 2013 R2.

Dd355055.note(en-us,NAV.71).gifNote
Each Microsoft Dynamics NAV Server instance has its own settings.

Configuring Microsoft Dynamics NAV Server in Setup

You can configure the default instance of Microsoft Dynamics NAV Server when running Microsoft Dynamics NAV 2013 R2 Setup. You must first select Microsoft Dynamics NAV Server as a component to install. To do this, select one of the following Installation Options that includes Microsoft Dynamics NAV Server:

You can also customize your installation and the list of components to install. For more information, see How to: Choose Components to Install.

After you specify an installation option or customize your component list, the Specify parameters pane is displayed in Setup. The list of parameters that you see in the Specify parameters pane depends on which components you have selected for configuration. Setup provides a short description for each parameter. For a description of the most important parameters for the Microsoft Dynamics NAV Windows client, see Server Option.

Choose Apply when you have finished entering values to return to the Specify parameters page in Setup.

After you finish running Setup, you can modify Microsoft Dynamics NAV Server using any of the methods described in the following section.

Configuring Microsoft Dynamics NAV Server After Installation

After you install Microsoft Dynamics NAV Server, you can change any of the settings that you provided during Setup, or any of the Microsoft Dynamics NAV Server settings, in any of the following ways:

  • Using the Microsoft Dynamics NAV Server Administration tool. For more information, see Microsoft Dynamics NAV Server Administration Tool.

  • Using the Microsoft Dynamics NAV PowerShell cmdlets for Microsoft Dynamics NAV 2013 R2. For more information, see Microsoft Dynamics NAV Windows PowerShell Cmdlets.

  • By directly editing CustomSettings.config, the Microsoft Dynamics NAV Server configuration file. By default, this file is located in C:\Program Files\Microsoft Dynamics NAV\71\Service\Instances\<instancename>. We recommend that you do not directly edit the configuration file, because if you make any errors in typing, then you may not be able to start the instance.

Dd355055.Important(en-us,NAV.71).gifImportant
After you modify a Microsoft Dynamics NAV Server setting, you must restart the associated Microsoft Dynamics NAV Server instance before any changes can take effect.

Settings in the Microsoft Dynamics NAV Administration Console

In the following tables, Microsoft Dynamics NAV Server Administration tool setting names are used. Settings names in the CustomSettings.config file are slightly different. These names are shown in the Description column. Quotation marks are required for all values.

Dd355055.note(en-us,NAV.71).gifNote
You must choose Edit in the Microsoft Dynamics NAV Server Administration tool before you can modify any values.

The following table describes fields on the General tab in the Microsoft Dynamics NAV Server Administration tool.

Setting Description

Certificate Thumbprint

If you use security certificates to protect communications between Microsoft Dynamics NAV Server and client services or web services over an open or wide-area network, you must provide the certificate thumbprint to Microsoft Dynamics NAV Server by updating this setting. For more information, see Walkthrough: Implementing Security Certificates in a Test Environment and How to: Implement Security Certificates in a Production Environment.

Close Inactive SQL Connections

Specifies when to close inactive SQL Server connections. The value specifies the age at which to close connections. While a connection is inactive, starting from zero, the age is increased by one every 30 seconds. When the age of the inactive connection reaches the specified value, the connection is closed. A value of 0 means that inactive SQL connections will not be closed.

Default: 10

Credential Type

Specifies the authentication mechanism for Microsoft Dynamics NAV users of this Microsoft Dynamics NAV Server instance.

The options are Windows, Username, NavUserPassword, and AccessControlService. For more information, see Users and Credential Types.

If you choose AccessControlService, you must specify a token signing key for use with Windows Azure Access Control Service (ASC), or a federation metadata location for use with Windows Azure Active Directory. If you choose NavUserPassword, and you specify a token signing key, you can use both NavUserPassword and ASC for this server instance.

Default: Windows

Data Cache Size

The contextual size of the data cache.

Default: 9

Database Instance

The name of the SQL Server database instance to connect to. If the value is a null string (""), Microsoft Dynamics NAV Server connects to the default instance of SQL Server.

Default: NAVDEMO

Database Name

The name of the Microsoft Dynamics NAV database in SQL Server.

Default: "Demo Database NAV (7-1)"

Database Server

A valid network name for the computer that is running SQL Server.

Default: The computer that you selected in Microsoft Dynamics NAV Setup.

Debugging Allowed

Specifies whether C/AL debugging is allowed for this Microsoft Dynamics NAV Server instance.

Default: Enabled

Default Client

Specifies the client type that is used to generate URLs when the client type is set to Default.

The options are Current, Windows, Web, SOAP, and OData.

Default: Current

Enable Buffered Insert

Specifies whether to buffer rows that are being inserted into a SQL Server database table.

When this parameter is enabled, up to 5 rows will be buffered in the table queue before they are inserted into the table.

To optimize performance in a production environment, you should enable this parameter. In a test environment, you can disable this parameter to help debug failures that occur when you insert rows in an SQL database table. For more information, see Bulk Inserts.

Default: Enabled

Enable Certificate Validation

Specifies whether validation should be performed on the security certificate.

Default: Enabled

Enable Debugging

Specifies whether the Microsoft Dynamics NAV Server instance starts with debugging enabled.

If this option is enabled, the following occurs:

  • When the client first connects, all C# files for the application are generated.

  • C# files persist between Microsoft Dynamics NAV Server restarts.

  • Application objects are compiled with debug information.

    Default: Not enabled

Enable Encryption on SQL Server Connections

Specifies whether the SQL connect string should request encryption when connecting to SQL Server services.

Enable Full C/AL Function Tracing

Specifies whether full C/AL function tracing is enabled on Event Tracing for Windows (ETW) sessions.

When this setting is enabled, all C/AL function calls and statements are traced.

When this setting is disabled, only root C/AL function calls are traced. Statements and functions that are called from a function are not traced.

For more information, see Monitoring Microsoft Dynamics NAV Server Events.

Default: Not enabled

Enable trust of SQL Server Certificate

Specifies whether Microsoft Dynamics NAV Server should trust the SQL Server certificate.

Max Concurrent Calls

The maximum number of concurrent client calls that can be active on this Microsoft Dynamics NAV Server instance.

Default: 40

Range: 1 - 2,147,483,647

You can also use MaxValue as a value to indicate no limit.

Metadata Provider Cache Size

Specifies the number of objects that can be cached. Set this value to 0 to disable caching.

Default: 150

Multitenant

Specifies if the Microsoft Dynamics NAV Server instance can be used in a multitenant environment.

Tenant databases can only be mounted on the Microsoft Dynamics NAV Server instance if this setting is selected. For more information, see Multitenant Deployment Architecture.

Network Protocol

Specifies the network protocol for accessing the database.

Valid values: Default, Named, Sockets, MultiProtocol

Default: Default

Remove Unlicensed UI Elements

Specifies if UI elements that are not covered by the license should be removed. For more information, see How to: Remove Unlicensed UI Elements.

Send Feedback

When this setting is enabled, the Microsoft Dynamics NAV Server instance collects basic information about your hardware configuration and about how you use Microsoft Dynamics NAV Server, and sends it to Microsoft. Microsoft uses this information to identify trends and usage patterns and to improve its software.

Default: Not enabled

For more information, see Customer Experience Improvement Program and Microsoft Dynamics NAV Server.

Services Default Company

Specifies the Microsoft Dynamics NAV company that the client services, OData web services, and NAS services use as the default company.

If your Microsoft Dynamics NAV database contains only one company, leave the setting blank.

Services Default Time Zone

Specifies the time zone in which web service and NAS services calls are run.

Values:

  • UTC

    All business logic for web services and NAS services on the server instance runs in Coordinated Universal Time (UTC). This is how all web services business logic was handled in Microsoft Dynamics NAV 2009 and Microsoft Dynamics NAV 2009 SP1.

  • Server Time Zone

    Services use the time zone of the computer that is running Microsoft Dynamics NAV Server.

  • <ID of any time zone recognized by the current version of Windows>

    Specifies any Windows time zone as defined in the system registry under HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones. For example, Romance Standard Time.

Default: UTC

Session Event Table Retain Period

An integer value that specifies how many months events in the Session Events table are retained.

Default: 3

SQL Command Timeout

The contextual time-out for a SQL command.

Default: 0:30:00

Use NTLM Authentication

Specifies whether NTLM authentication is enabled for web services. To require Kerberos authentication, disable this option.

Default: Not enabled

The following table describes fields on the Client Services tab in the Microsoft Dynamics NAV Server Administration tool.

Setting Description

Chunk Size

The default size for a chunk of data that is transferred between Microsoft Dynamics NAV Server and the Microsoft Dynamics NAV Windows client or Microsoft Dynamics NAV Web client, in kilobytes.

Default: 28

The range of values is from 4 to 80.

Compression Threshold

The threshold in memory consumption at which Microsoft Dynamics NAV Server starts compressing datasets, in kilobytes.

Default: 64

Enable Client Services

Specifies whether client services are enabled for this Microsoft Dynamics NAV Server instance.

Default: Enabled

Federation Metadata Location

Specifies the location of the federation metadata that is used to establish a trust relationship with between Microsoft Dynamics NAV and an application that you have added to Windows Azure Active Directory, such as https://login.windows.net/<tenant>/FederationMetadata/2007-06/FederationMetadata.xml. For more information, see Authenticate Users with Windows Azure Active Directory.

This parameter is relevant only when Credential Type, on the General tab, is set to AccessControlService.

Idle Client Timeout

The interval of time that a Microsoft Dynamics NAV Server client session can remain inactive before the session is dropped.

Time interval format: [dd.]hh:mm:ss[.ff]

Where:

  • dd: days

  • hh: hours

  • mm: minutes

  • ss: seconds

  • ff: hundredths of a second

You can also use MaxValue as a value to indicate no time-out. This is the default value.

Max Concurrent Connections

Specifies the maximum number of concurrent client connections that the current Microsoft Dynamics NAV Server instance accepts.

Default: 150

You can also use MaxValue as a value to indicate no limit.

Max Items in Object Graph

The maximum number of objects to serialize or deserialize.

Default: 512

Max Number of Orphaned Connections

Specifies the maximum number of orphaned connections to be kept alive at the same time for the time that is specified by ReconnectPeriod.

A connection is orphaned when the client is involuntarily disconnected from Microsoft Dynamics NAV Server.

Default: 20

You can also use MaxValue as a value to indicate no limit.

Max Upload Size

The maximum size of files that can be uploaded to or downloaded from Microsoft Dynamics NAV Server, in megabytes. Use this setting to avoid out-of-memory errors.

Default: 5

Operation Timeout

The maximum time that Microsoft Dynamics NAV Server can take to return a call from the client.

Time span format: [dd.]hh:mm:ss[.ff]

Where:

  • dd: days

  • hh: hours

  • mm: minutes

  • ss: seconds

  • ff: hundredths of a second

You can also use MaxValue as a value to indicate no time-out. This is the default value.

Port

The listening HTTP port for client services.

Default: 704

Valid range: 1 - 65535

Prohibited File Types

Specifies a series of file name extensions, delimited by semi-colons. Microsoft Dynamics NAV Server will not store files of any of the specified types when requested by clients.

Example values:

* (asterisk) All file types are prohibited.
Empty string ("") All file types are allowed.
List of file types separated by semi-colons. For example, "txt;xml;pdf". Microsoft Dynamics NAV Server will not store files of any of the specified types when requested by clients.

Protection Level

Specifies the security services for protecting the data stream between RoleTailored clients and Microsoft Dynamics NAV Server.

All RoleTailored clients connecting to the Microsoft Dynamics NAV Server instance must have the same ProtectionLevel value in their ClientUserSettings.config files. For more information, see Configuring the Windows Client.

For background information about transport security, see Understanding Protection Level (links to MSDN Library).

Default: EncryptAndSign

Values: EncryptAndSign, Sign, None

Reconnect Period

The time during which a client can reconnect to a running instance of Microsoft Dynamics NAV Server.

Time span format: [dd.]hh:mm:ss[.ff]

Where:

  • dd: days

  • hh: hours

  • mm: minutes

  • ss: seconds

  • ff: hundredths of a second

Default: 00:10:00

You can also use MaxValue as a value to indicate no time limit.

Token Signing Key

Specifies the signing information that you obtain from the Azure Management Portal. The parameter value is a 256-bit symmetric token signing key for use with Windows Azure Access Control Service (ASC). This parameter is relevant only when Credential Type, on the General tab, is set to AccessControlService.

Web Client Base URL

Specifies the root of the URLs that are used to open hyperlinks to pages and reports in the Microsoft Dynamics NAV Web client. For example, you can change the value if you want to change the externally facing endpoint.

The base URL must have the following syntax:

http[s]://hostname:port/instance/WebClient/

This field maps to the PublicWebBaseUrl setting in the CustomSettings.config file for the Microsoft Dynamics NAV Server instance.

For more information, see How to: Copy the URL to Open a Page or Report.

Windows Client Base URL

Specifies the root of the URLs that are used to open hyperlinks to pages and reports in the Microsoft Dynamics NAV Windows client. For example, you can change the value if you want to change the externally facing endpoint.

The base URL must have the following syntax:

DynamicsNAV://hostname:port/instance/

This field maps to the PublicWinBaseUrl setting in the CustomSettings.config file for the Microsoft Dynamics NAV Server instance.

For more information, see How to: Copy the URL to Open a Page or Report.

The following table describes fields on the SOAP Services tab in the Microsoft Dynamics NAV Server Administration tool.

Setting Description

Enable SOAP Services

Specifies whether SOAP web services are enabled for this Microsoft Dynamics NAV Server instance.

Default: Enabled

Enable SSL

Specifies whether SSL (https) is enabled for the SOAP web service port. For more information, see Walkthrough: Configuring Web Services to Use SSL (SOAP and OData).

Default: Not enabled

Max Message Size

The maximum permitted size of a SOAP web services request, in kilobytes.

Default: 1024

Port

The listening HTTP port for Microsoft Dynamics NAV SOAP web services.

Default: 7047

Valid range: 1 - 65535

SOAP Base URL

Specifies the root of the URLs that are used to access SOAP web services. For example, you can change the value if you want to change the externally facing endpoint.

The base URL must have the following syntax:

http[s]://hostname:port/instance/WS/

This field maps to the PublicSOAPBaseUrl setting in the CustomSettings.config file for the Microsoft Dynamics NAV Server instance.

For more information, see How to: Copy the URL to Open a Page or Report.

The following table describes fields on the OData Services tab in the Microsoft Dynamics NAV Server Administration tool.

Setting Description

Enable OData Services

Specifies whether OData web services are enabled for this Microsoft Dynamics NAV Server instance.

Default: Enabled

Enable SSL

Specifies whether SSL (https) is enabled for the OData web service port. For more information, see Walkthrough: Configuring Web Services to Use SSL (SOAP and OData).

Default: Not enabled

Max Page Size

Specifies the maximum number of entities returned per page of OData results. For more information, see Server-Driven Paging in OData Web Services.

Default: 1000

OData Base URL

Specifies the root of the URLs that are used to access OData web services. For example, you can change the value if you want to change the externally facing endpoint.

The base URL must have the following syntax:

http[s]://hostname:port/instance/OData/

This field maps to the PublicODataBaseUrl setting in the CustomSettings.config file for the Microsoft Dynamics NAV Server instance.

For more information, see How to: Copy the URL to Open a Page or Report.

Port

The listening HTTP port for Microsoft Dynamics NAV OData web services.

Default: 7048

Valid range: 1 - 65535

The following table describes fields on the NAS Services tab in the Microsoft Dynamics NAV Server Administration tool.

Setting Description

Enable Debugging

Specifies if the Microsoft Dynamics NAV Debugger must attach to the NAS Services session. When this is enabled, the NAS Services session waits 60 seconds before the first C/AL statement is run.

Retry Attempts per Day

Specifies the maximum number of times that a Microsoft Dynamics NAV NAS Service session can restart after a failure. After the next failure, the NAS Service session stops.

Startup Argument

Specifies a string argument that will be used when NAS services start. The argument typically specifies an application type, sometimes with additional configuration information.

Example values:

  • "OSYNCH"

  • "JOBQUEUE"

Startup Codeunit

Specifies the codeunit that contains the method that will be called by the NASStartupMethod setting.

Example values:

  • 0

    When NASStartupCodeunit is set to 0, NAS Services do not start. This is the default value.

  • 1

    When NAS services start, they run the trigger specified by the NAS Startup Method in codeunit 1.

  • 450

    When NAS services start, they run codeunit 450 (Job Queue – NAS Start Up), and call the method specified by NASStartupMethod.

    Dd355055.note(en-us,NAV.71).gifNote
    When the codeunit specified by NASStartupCodeunit is a single instance codeunit, the NAS service session will remain alive even after you run all code in the specified NASStartupMethod. For information about single instance codeunits, see Using Codeunits.

Startup Method

Specifies the method that will be called in the NASStartupCodeunit.

Example values:

  • ""

    If no start method is specified (null string), the OnRun trigger is called.

  • StartNAS

    NAS services runs the StartNAS method in the NAS Startup Codeunit.

The following table describes fields on the Management Services tab in the Microsoft Dynamics NAV Server Administration tool.

Setting Description

Enable Management Services

Specifies whether Microsoft Dynamics NAV Server Administration tool is enabled for this Microsoft Dynamics NAV Server instance.

Default: Enabled

Port

The listening TCP port for the Microsoft Dynamics NAV Server Administration tool.

Default: 7045

Valid range: 1 - 65535

Using the Microsoft Dynamics NAV PowerShell Cmdlets to Modify Settings

Use the Set- cmdlets to modify a setting with the Microsoft Dynamics NAV PowerShell API. For example, you can change the value for DatabaseServer to DatabaseServer.Domain.Com for the server instance named MyInstance by executing this cmdlet:

Set-NAVServerConfiguration MyInstance -KeyName DatabaseServer -KeyValue DatabaseServer.Domain.Com

To display all the Set- cmdlets on the Windows PowerShell console, use the following command:

Get-Help Set-NAVServer*

See Also

Show: