Configuring Business Central Server

When you run Business Central Setup and install Business Central Server, you provide information that is then used as the configuration for the default Business Central Server instance. This information is stored in a configuration file for the server instance called CustomSetting.config. The default location of the CustomSettings.config file is C:\Program Files\Microsoft Dynamics 365 Business Central\140\Service.

After you install Business Central Server, you can change any of the settings that you provided during Setup, plus several other settings that were not available to you in Setup.

Note

Each Business Central Server instance has its own CustomSettings.config file.

Configuring Business Central Server in Setup

You configure the default instance of Business Central Server by running Business Central Setup and selecting one of the following:

  • Demo Option
  • Server Option
  • Developer Option
  • Customize > Server

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.

Configuring Business Central Server After Installation

After you install Business Central Server, you can change the configuration settings in the CustomSettings.config file of a Business Central Server instance in the following ways:

Restarting Business Central Server after modifications

If you use the Business Central Server Administration tool or modify the CustomSettings.config file directly, you must restart the Business Central Server instance before any changes can take effect.

If you use the Set-NAVServerConfiguration cmdlet, whether you need to restart the server instance will depend on the configuration setting that you change. There are several settings that are dynamically updatable, which means that a server instance restart is not necessarily required after modification. For more information, see Modifying dynamically updatable settings. In the tables that follow, these settings are indicated by the text Dynamically Updatable: Yes.

This section describes all the configuration settings for a Business Central Server instance. The settings are grouped according to the tabs under which they appear in the Business Central Server Administration tool.

  • The Setting column displays the name of the setting as it appears in the Business Central Server Administration tool.
  • The Key Name column displays the name of the setting as it appears in the CustomSettings.config file, and is also the name to use for the setting when using the Set-NAVServerConfiguration cmdlet.

General Settings

The following table describes fields on the General tab in the Business Central Server Administration tool.

Setting Key Name Description
Build Restriction ClientBuildRestriction Specifies what happens when a Business Central client tries to connect to the Business Central Server instance when the client is running a different build version of Business Central than the server instance.

Values:

AlwaysConnect

WarnClient
Before connecting the client to the server instance, a message appears that informs the user that the build versions for the client and server instance are different. The user can choose to continue or cancel the connection.

DoNotAllow
A message appears that informs the user that the client and server instance build versions are different, and the client does not connect to the server instance.

Note: With the Business Central Web client and Business Central Tablet client, this setting compares the build version of the Business Central Web Server on IIS with the Business Central Server instance. It controls the connection between Business Central Web Server and the server instance.

Default: WarnClient
Dynamically Updatable: No
Certificate Thumbprint ServicesCertificateThumbprint If you use security certificates to protect communications between Business Central Server and client services or web services over an open or wide-area network, you must provide the certificate thumbprint to Business Central Server by updating this setting. For more information, see Using Security Certificates.

Default:
Dynamically Updatable: No
Compile and Load Business Application CompileBusinessApplicationAtStartup Specifies whether the Business Central Server instance compiles all the business application assemblies and loads them to cache memory when the server instance is started. The assemblies are then retrieved from memory when requested by a Business Central client.

Enabling this setting will reduce the time it takes for the server instance to load application objects the first time they are requested by a Business Central client after the server instance started. However, it will also slightly increase the memory usage by the server instance.

If you enable this setting, when the server instance starts for the first time, the business application assemblies will be compiled and loaded to the cache memory of the computer that is running the server instance. The assemblies, along with metadata such object timestamp information, are also stored to a temporary folder on the computer's file system. Whenever the server instance is restarted, it will compare the assemblies that are stored in memory with corresponding objects in the connected database to determine whether the assemblies in memory can be reused. An assembly will be reused if the following conditions are met:

- The connected database is the same as before, based on the databasemagic field in the dbproperty table.

- The object time stamp that is recorded on the compiled assembly matches the object timestamp in metadata of the connected database.

If the conditions are not met for an assembly or an assembly for an object in the database is not found in the memory, then a new assembly is built and stored for reuse to cache memory and the file system of the server instance compute for reuse.

If you disable this setting, individual assemblies will be compiled on-demand as application objects are requested by the Business Central client. The compiled assemblies will not be reused on subsequent server instance restarts.

Notes:
  • This setting does not apply to query objects.
  • Assembly compilation happens asynchronously.
  • On average, all application objects will be loaded within the first few minutes that the server instance operates.

Default: Enabled
Dynamically Updatable: No
Credential Type ClientServicesCredentialType Specifies the authentication mechanism for Business Central users of this Business Central Server instance.

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

If you choose AccessControlService, you must specify a federation metadata location for use with Azure AD. If you choose NavUserPassword, and you specify a token signing key, you can use both NavUserPassword and AccessControlService for this server instance.

Notes:
  • None is for internal use on system sessions and typically should not be used. If you choose None, then the Business Central Server instance cannot start.
  • ExchangeIdentity and TaskScheduler are for internal use only, and should not be used.

Default: Windows
Dynamically Updatable: No
Data Cache Size DataCacheSize The contextual size of the data cache. The value must be in the range 1-20.

Default: 9
Dynamically Updatable: Yes
Default Client DefaultClient 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
Dynamically Updatable: No
Default Language DefaultLanguage Specifies which of the installed Business Central languages on the server instance will be used as the default language in the clients. Set the value to a valid language culture name, such en-US or da-DK.

In the Business Central Web and Tablet clients, the Default Language setting determines the language that is used if the web browser's language setting does not match any installed language or a language in the Supported Languages setting, if used. In the Business Central Windows client, this is the language that is used if the language setting of the computer does not have a match.

If there are application-specific configuration settings, this setting will be overridden by the default language setting that is specified in application-specific configuration file. For more information, see Set-NAVServerAppConfiguration cmdlet.

Default: en-US
Dynamically Updatable: No
Diagnostic Trace Level TraceLevel Specifies the lowest severity level of custom telemetry events to be emitted and recorded in the event log for the Business Central Server instance. This includes system telemetry trace events and custom telemetry events. Telemetry events have IDs from 700-706.

The setting has the following values, which correspond to the event severity levels (listed from highest to lowest level): Critical, Error, Warning, Normal (this corresponds to the Information level), Verbose, and Off.

You use this setting to filter out lower-level events from the log. For example, if you set this setting to Error, only Error and Critical events will be logged.

Set to Off if you do not want to record telemetry events. When set to Off, events are not emitted.

Note: Telemetry trace events are recorded in the Business Central Server channel logs, which you can see in Event Viewer, under Applications and Services Logs > Microsoft > Dynamics365BusinessCentral > Common > Admin.

Default: Normal
Dynamically Updatable: Yes
Diagnostic Trace Level for External Proxies ExternalTraceLevel Specifies the lowest severity level of telemetry events from external proxies that you want the Business Central Server instance to emit if an error related to the external system occurs on the server instance. This setting pertains to systems and components that Business Central integrates with, like Dynamics 365 for Sales (CRM/Xrm).

The server instance listens for event traces from the external proxy. If an error occurs on the server instance, it will emit the last 10 telemetry trace events from the external proxy. The trace events can then be recorded in the Windows event log or picked up by other event trace collection tools.

The setting has the following values, which correspond to the event severity levels (listed from highest to lowest level): Critical, Error, Warning, Information, Verbose, and Off.

Events that have a lower severity level than the set value will not be emitted. For example, if you set this setting to Error, only Error and Critical events will be emitted. Set to Off if you do not want to emit any of these events.

Default: Error
Dynamically Updatable: Yes
Disable Token-Signing Certificate Validation DisableTokenSigningCertificateValidation Specifies whether to enable or disable the validation of the token-signing certificate used by Active Directory Federation Services (AD FS). If the check box is cleared (or the value set to false), the validation is enabled. If the check box is selected (or the value is set to true), then validation is disabled.

You should disable token signing certificate validation when configuring Azure Active Directory authentication with single sign-on.

Default: Checkbox cleared; set to false.
Dynamically Updatable: No
Enable Certificate Validation ServicesCertificateValidationEnabled Specifies whether validation should be performed on the security certificate.

Default: Enabled
Dynamically Updatable: No
Enable Debugging EnableDebugging Specifies whether the Business Central 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 Business Central Server restarts. Application objects are compiled with debug information.

Default: Not enabled
Dynamically Updatable: No
Enable Event Logging to Windows Application Log EnableApplicationChannelLog Specifies whether to record admin and operational type events (errors, warnings, and information messages) that occur on Business Central Server instances in the Windows Application log on the computer that is running Business Central Server.

Because Business Central Server instance events are always logged to the Application and Services Logs, you can disable logging Business Central Server instance events in the Windows Application log and not lose any data. For more information, see Monitoring Business Central Server Events Using Event Viewer and Disable Logging Events to the Windows Application Log.

Important: If you are using System Center Operations Manager to monitor Business Central Server instances, do not disable logging to the Windows Application log. If you do, monitoring will not work.

Default: Enabled
Dynamically Updatable: No
Enable File Access by AL Functions EnableALServerFileAccess Specifies whether AL functions of the file data type can access files on the Business Central Server computer.

Default: Enabled
Dynamically Updatable: No
Enable Full AL Function Tracing EnableFullALFunctionTracing Specifies whether full AL function tracing is enabled on Event Tracing for Windows (ETW) sessions.

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

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

For more information, see Monitoring Business Central Server Events .

Default: Not enabled
Dynamically Updatable: Yes
Enable Incremental Company Deletion UseIncrementalCompanyDelete Specifies whether to delete companies incrementally. If you enable this setting, when you delete a company, the company record is deleted from the database immediately but the company data that is stored in the SQL tables will be deleted later by a system task in task scheduler.

You can override this setting when using the Remove-NAVCompany cmldet by setting the -ForceImmediateDataDeletion parameter.

Default: Not enabled
Dynamically Updatable: Yes
Enable Session While Sync Pending AllowSessionWhileSyncPending Specifies whether new client sessions can be created while the tenant’s state is OperationalWithSyncPending.

The OperationalWithSyncPending state occurs when changes have been made to one or more application tables, but the schema changes have not been synchronized with the tenant. In this state, unless you enable client sessions, clients trying to connect with will get an error message similar to: The tenant ‘tenantID’ is not accessible.

Default: Not enabled
Dynamically Updatable: Yes
Encryption Key Provider EncryptionProvider Specifies where the encryption key is that is used to encrypt data in the database, either LocalKeyFile or AzureKeyVault values. If you use AzureKeyVault, see the Azure Key Vault Encryption Provider tab settings.

Default: LocalKeyFile
Dynamically Updatable: No
Lockout Sign-In Attempts Count LockoutPolicyFailedAuthenticationCount Specifies the number of failed sign-in attempts on a user account (within the time window set by the Lockout Failed Sign-In Attempts Window setting) at which the user account is disabled.

Default: 0
Dynamically Updatable: No
Lockout Failed Sign-In Attempts Window LockoutPolicyFailedAuthenticationWindow Specifies time window, in seconds, during which consecutive failed authentication attempts are counted. This setting works in conjunction with the Account Lockout Max. Sign-In Attempts setting. When the number of failed sign-in attempts by a user hits the value of the Account Lockout Max. Sign-In Attempts setting within this time window, the user account is disabled.

Default: 0
Dynamically Updatable: No
Max Concurrent Calls MaxConcurrentCalls The maximum number of concurrent client calls that can be active on this Business Central Server instance.

Range: 1 - 2,147,483,647

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

Default: 40
Dynamically Updatable: No
Max Data Rows Allowed to Send to Excel MaxRowsToExportToExcel Specifies the maximum number of rows that can be included in an Excel document that is generated from data in a list type page in the client.

If you do not want to have a limit on rows, set the value to MaxValue.

Note: This setting only pertains to list type pages in the client. For other pages types, like cards, the limit on rows is configured in the client.

Default: MaxValue
Dynamically Updatable: Yes
Maximum Stream Read Size MaxStreamReadSize Specifies the maximum number of bytes that can be read from a stream (InStream object) in a single AL read operation, such a READ or InStream.READTEXT function call. This setting pertains to UTF-8 and UTF-16 text encoding; not MS-DOS encoding.

Default: 1000000
Dynamically Updatable: Yes
Multitenant Multitenant Specifies if the Business Central Server instance can be used in a multitenant environment.

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

Default: Not enabled
Dynamically Updatable: No
Network Protocol NetworkProtocol Specifies the network protocol for accessing the database.

Valid values: Default, Named, Sockets, MultiProtocol

Default: Default
Dynamically Updatable: No
Services Default Company ServicesDefaultCompany Specifies the Business Central company that the client services, OData web services, and NAS services use as the default company.

If your Business Central database contains only one company, leave the setting blank.

Default:
Dynamically Updatable: No
Services Default Time Zone ServicesDefaultTimeZone 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).

Server Time Zone
Services use the time zone of the computer that is running Business Central 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
Dynamically Updatable: No
Services Language ServicesLanguage Specifies the global language version to use for text strings with SOAP and OData web services.

The value must be valid culture name for a language that is available for the Microsoft Dynamics NAV solution, such as en-US and da-DK.

Default: en-US
Dynamically Updatable: No
Services Option Text Source ServicesOptionFormat Specifies the source of the text strings to use for the option values of an option data type field.

Values:

OptionString
Uses the text strings that are specified by the OptionString Property of a field.

OptionCaption
Uses the text strings that are specified by the OptionCaption Property of a field.

Default: OptionCaption
Dynamically Updatable: No
Session Event Table Retain Period SessionEventTableRetainPeriod Specifies the number of months that sessions in the Session Event table remain before they are deleted.

Default: 3
Dynamically Updatable: No
Non-Interactive Sessions Log Retain Period NonInteractiveSessionsLogRetainPeriod Specifies the number of days that background and web service sessions remain in the Session Event table before they are deleted.

Default: 5
Dynamically Updatable: No
Supported Languages SupportedLanguages Specifies which of the installed Business Central languages on the server instance will be available for use in the clients. If you do not specify a language, then all installed languages will be available. In the client, users can switch among the supported languages.

The setting's value is a semicolon-separated list that contains the language culture names for each language. For example, if you want client users to be able to choose among da-DK, en-US, and en-CA, set the value to da-DK;en-US;en-CA.

If you specify any languages in this setting, then you must include the language that you specified in the Default Language setting.

If there are application-specific configuration settings, this setting will be overridden by the supported language setting that is specified in application-specific configuration file. For more information, see Set-NAVServerAppConfiguration cmdlet.

Default:
Dynamically Updatable: No
Token Signing Validation Mode TokenSigningCertificateValidationMode Specifies which certificate validation mode to use for token signing validation. This setting is applicable only if the Enable Certificate Validation setting is selected. IssuerNameValidation validates tokens by verifying the issuer name (tenant) only. Peer OrChainValidation validates tokens by verifying that the certificate is either in the Trusted People store or is part of a chain trust to a certification authority in the Trusted Root store.

Default: IssuerNameValidation
Dynamically Updatable: No
UI Elements Removal UIElementRemovalOption Specifies whether UI elements are hidden when the related object is not accessible according to the license or according to user permissions or both. For more information, see Hiding UI Elements.

Default: LicenseFileandUserPermissions
Dynamically Updatable: No
Use NTLM Authentication ServicesUseNTLMAuthentication Specifies whether NTLM authentication is enabled for web services. To require Kerberos authentication, disable this option.

Default: Not enabled
Dynamically Updatable: No
not available XmlMetadataCacheSize For internal use only.

Default: 500

Database Settings

The following table describes fields on the Database tab in the Business Central Server Administration tool.

Note

If the Business Central Server instance is configured as a multitenant server instance, then except for the Database Name, Database Instance, and Database Server settings, the settings apply to both the application database and the tenant database.

Setting Key Name Description
Database Instance DatabaseInstance The name of the SQL Server database instance to connect to. If the value is a null string (""), Business Central Server instance connects to the default database instance of SQL Server.

If the Business Central Server instance is configured as a multitenant server instance, then this setting specifies the SQL Server database instance that hosts the application database.

Default: NAVDEMO
Dynamically Updatable: No
Database Name DatabaseName The name of the Business Central database in SQL Server.

If the Business Central Server instance is configured as multi-tenant server instance, then this setting specifies the application database.

Default: "Demo Database BC (14-0)"
Dynamically Updatable: No
Database Server DatabaseServer A valid network name for the computer that is running SQL Server.

If the Business Central Server instance is configured as multi-tenant server instance, then this setting specifies the computer that hosts the application database.

Default: The computer that you selected in Business Central Setup.
Dynamically Updatable: No
Disable SmartSQL DisableSmartSql Specifies whether the SmartSQL performance optimization feature is disabled.

- If the check box is selected, SmartSQL is disabled.

- If the check box is cleared, SmartSQL is enabled.

When SmartSQL is enabled, Business Central Server converts FIND calls and FlowField calculations into a single SQL statement. This can improve performance when running pages that contain FlowFields. However, it can be helpful to disable SmartSQL when troubleshooting database queries because statements are separated into more discrete statements. For more information, see Troubleshooting: Long Running SQL Queries Involving FlowFields by Disabling SmartSQL.

Default: SmartSQL performance optimization is enabled (check box is cleared)
Dynamically Updatable: Yes
Disable SQL Query Hint FORCE ORDER DisableQueryHintForceOrder Specifies whether the FORCE ORDER Query Hint is used in queries. FORCE ORDER instructs the query optimizer to preserve the join order that is indicated by the query syntax.

If you clear the check box (false), the OPTIMIZE FOR UNKNOWN hint is used in queries.

For more information, see Configuring Query Hints for Optimizing SQL Server Performance.

Default: OPTIMIZE FOR UNKNOWN hint is disabled (check box is selected)
Dynamically Updatable: Yes
Disable SQL Query Hint LOOP JOIN DisablQueryHintLoopJoin Specifies whether the LOOP JOIN Query Hint is used in queries. LOOP JOIN instructs the query optimizer to use LOOP JOIN for all join operations in the whole query.

If you clear the check box (false), the OPTIMIZE FOR UNKNOWN hint is used in queries.

For more information, see Configuring Query Hints for Optimizing SQL Server Performance.

Default: OPTIMIZE FOR UNKNOWN hint is disabled (check box is selected)
Dynamically Updatable: Yes
Disable SQL Query OPTIMIZE FOR UNKNOWN DisableQueryHintOptimizeForUnknown Specifies whether the OPTIMIZE FOR UNKNOWN Query Hint is used in queries. OPTIMIZE FOR UNKNOWN instructs the query optimizer to use statistical data instead of the initial values for all local variables when the query is compiled and optimized, including parameters created with forced parameterization.

If you clear the check box (false), the OPTIMIZE FOR UNKNOWN hint is used in queries.

For more information, see Configuring Query Hints for Optimizing SQL Server Performance.

Default: OPTIMIZE FOR UNKNOWN hint is enabled (check box is cleared)
Dynamically Updatable: Yes
Enable Buffered Insert BufferedInsertEnabled 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
Dynamically Updatable: No
Enable Encryption on SQL Server Connections EnableSqlConnectionEncryption Specifies whether the SQL connect string should request encryption when connecting to SQL Server services.

Default: Not enabled
Dynamically Updatable: No
Enable Trust of SQL Server Certificate TrustSQLServerCertificate Specifies whether Business Central Server should trust the SQL Server certificate.

Default: Not enabled
Dynamically Updatable: No
Search Timeout SearchTimeout Specifies the time (in seconds) that a search operation on lists in the client will continue until it is terminated. When the limit is reached, the following message displays in the client: Searching for rows is taking too long. Try to search or filter using different criteria.

Time format: hh:mm:ss
Default: 00:00:10
Dynamically Updatable: Yes
SQL Bulk Import Batch Size SqlBulkImportBatchSize Specifies how many SQL memory chunks that a data import must be distributed across. Lowering the value increases the number of network transfers and decreases performance, but also lowers the amount of memory that the server instance consumes. If the database is on SQL Server 2016 or later, a low value can lead to large data files. If you do not want to use batching, specify 0.

Default: 448
Dynamically Updatable: No
SQL Command Timeout SqlCommandTimeout The contextual time-out for a SQL command.

Default: 0:30:00
Dynamically Updatable: No
SQL Connection Idle Timeout SqlConnectionIdleTimeout Specifies the time that a SQL connection can remain idle before being closed. The value has the format HH:MM:SS.

Default: 00:05:00
Dynamically Updatable: Yes
SQL Connection Timeout SqlConnectionTimeout Specifies the time to wait while trying to connect to the database before terminating the attempt and generating an error. This setting also applies to begin, rollback and commit of transactions.

The value has the format HH:MM:SS.

Default: 00:01:30
Dynamically Updatable: Yes
Enable SQL Parameters by Ordinal SqlParametersByOrdinal Specifies whether parameters in SQL statements are referenced by their ordinal number.

Enabling this setting improves performance when using buffered inserts.

Default: Enabled
Dynamically Updatable: No
SQL Query Logging Threshold SqlLongRunningThreshold Specifies the amount of time (in milliseconds) that an SQL query can run before a warning event is recorded in the application log for the server instance. If this threshold is exceeded, the following event is logged: Action completed successfully, but it took longer than the given threshold.

Default: 1000
Dynamically Updatable: Yes

Client Services Settings

The following table describes fields on the Client Services tab in the Business Central Server Administration tool.

Setting Key Name Description
Allowed File Types ClientServicesAllowedFileTypes Specifies the file types that can be stored by the server when requested by the client. The value is a semicolon-separated list of the file name extensions. The server will not store other file types.

Example values:
  • Blank or empty string (""): The setting is disabled. File types will be limited based on Prohibited File Types setting instead.
  • Asterisk (*): Specifies that all file types are allowed.
  • List of file type extensions separated by semi-colons, for example txt;xml;pdf: Specifies that only .txt, .xml, and .pdf file types can be stored.
Trailing semicolons are ignored.

Default: blank
Dynamically Updatable: Yes
Chunk Size ClientServicesChunkSize The default size for a chunk of data that is transferred between Business Central Server and the Dynamics NAV Client connected to Business Central or Business Central Web Server, in kilobytes.

The range of values is from 4 to 80.

Default: 28
Dynamically Updatable: No
Compression Threshold ClientServicesCompressionThreshold The threshold in memory consumption at which Business Central Server starts compressing datasets, in kilobytes.

Default: 64
Dynamically Updatable: No
Enable Client Services ClientServicesEnabled Specifies whether client services are enabled for this Business Central Server instance.

Default: Enabled
Dynamically Updatable: No
Exchange Auth. Metadata Location ExchangeAuthenticationMetadataLocation Specifies the URLs for Microsoft Exchange authentication metadata document of the services or authorities that are trusted to sign Exchange identity tokens.

This setting is used for setting up the Office Add-Ins for Outlook. For more information about the Office Add-ins, see Setting Up the Office Add-Ins for Outlook Integration

The value is URL that is used to confirm the identity of the signing authority when using Exchange Authentication. The URL is compared to the Exchange authentication metadata document URL in the Exchange identity token. The scheme and host part of the two URLs must match to pass authentication. Paths in the URLs require only a partial match.

With a multitenant server instance, the Exchange Auth. Metadata Location setting (if any) on the tenant will overrule the value of this setting.

Value:
- One or more valid URLs. A URL must include the scheme, such as http:// or https://, and the host name.
- Separate multiple URLs with a comma.
- Wildcards (*) in URLs are supported.
Default: https://outlook.office365.com/
Dynamically Updatable: No
Idle Client Timeout ClientServicesIdleClientTimeout The interval of time that a Business Central 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

Set Idle Client Timeout to equal or lower than the Keep Alive Interval, to enable Idle Client Timeout. You can also use MaxValue as a value to indicate no time-out.

Default: MaxValue
Dynamically Updatable: Yes
Keep Alive Interval ClientServicesKeepAliveInterval Specifies the time interval between keep-alive messages that are sent from the Dynamics NAV Client connected to Business Central to the server instance. This setting is used to keep inactive sessions alive until the time that is specified by the Idle Client Timeout setting expires. You should use a time interval that is less than the Idle Client Timeout setting, to hold the session constantly alive. For more information, see Understanding Session Timeouts.

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

Default: 120
Dynamically Updatable: No
Max Concurrent Connections ClientServicesMaxConcurrentConnections Specifies the maximum number of concurrent client connections that the current Business Central Server instance accepts. You can use MaxValue as a value to indicate no limit.

Default: 500
Dynamically Updatable: No
Max Items in Object Graph ClientServicesMaxItemsInObjectGraph The maximum number of objects to serialize or deserialize.

Default: 512
Dynamically Updatable: No
Max Number of Orphaned Connections ClientServicesMaxNumberOfOrphanedConnections 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 Business Central Server.

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

Default: 20
Dynamically Updatable: No
Max Upload Size ClientServicesMaxUploadSize The maximum size of files that can be uploaded to or downloaded from Business Central Server, in megabytes. Use this setting to avoid out-of-memory errors.

Default: 150
Dynamically Updatable: No
Operation Timeout ClientServicesOperationTimeout The maximum time that Business Central 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.

Default: MaxValue
Dynamically Updatable: No
Port ClientServicesPort The listening HTTP port for client services.

Valid range: 1 - 65535
Default: 7046
Dynamically Updatable: No
Prohibited File Types ClientServicesProhibitedFileTypes Specifies the file types that cannot be stored by the server when requested by the client. The value is a semicolon-separated list of the file name extensions. This setting is ignored if the Allowed File Types setting has a value.

Example values:
  • Asterisk (*): All file types are prohibited.
  • Blank or empty string (""): The default value is used.
  • Whitespace string (" "): All file types are allowed.
  • List of file types separated by a semicolon, for example txt;xml;pdf: Prohibits the file types txt, xml and pdf.
Trailing semi-colons will be ignored.

Default: ade;adp;app;asp;bas;bat;chm;cmd;com;cpl;
csh;exe;fxp;gadget;hlp;hta;inf;ins;isp;its;js;jse;
ksh;lnk;mad;maf;mag;mam;maq;mar;mas;mat;mau;
mav;maw;mda;mdb;mde;mdt;mdw;mdz;msc;msi;
msp;mst;ops;pcd;pif;prf;prg;pst;reg;scf;scr;
sct;shb;shs;url;vb;vbe;vbs;vsmacros;vss;
vst;vsw;ws;wsc;wsf;wsh
Dynamically Updatable: Yes
Protection Level ClientServicesProtectionLevel Specifies the security services for protecting the data stream between clients and Business Central Server.

All Dynamics NAV Client connected to Business Central clients connecting to the Business Central Server instance must have the same ProtectionLevel value in their ClientUserSettings.config files. For more information, see Configuring the Windows Client in the Dev and IT Pro Help for Microsoft Dynamics NAV 2018.

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

Values: EncryptAndSign, Sign, None
Default: EncryptAndSign
Dynamically Updatable: No
Reconnect Period ClientServicesReconnectPeriod The time during which a client can reconnect to a running instance of Business Central Server.

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 limit.

Default: 00:10:00
Dynamically Updatable: No
Token Signing Key ClientServicesTokenSigningKey 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 Azure Access Control service (ACS). This parameter is relevant only when Credential Type, on the General tab, is set to AccessControlService.

Default: EncryptAndSign
Dynamically Updatable: No
Use the Simplified Filters UseSimplifiedFilters Specifies how the search on list pages behaves for plain text search filters (that is, filters that do not use search symbols like @ or *).

If you enable this setting, the search uses a case sensitive and accent sensitive search to find fields that start with the provided filter text. For example, the search on man returns all records that include a field that starts with man (with a lowercase m), and the search on Man returns all records that include a field that starts with Man (with an uppercase M). Notice that you can get the same results by entering man* and Man* respectively.

If the setting is disabled (which is default), the search on man and Man return the same results, which is all records that include fields that contain the text man, regardless of the case.

For more information about the search, see Sorting, Searching, and Filtering Lists.

Default: Not enabled
Dynamically Updatable: No
Web Client Base URL PublicWebBaseUrl Specifies the root of the URLs that are used to open hyperlinks to pages and reports in the Business Central 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]/[webserverinstance]

This field maps to the PublicWebBaseUrl setting in the CustomSettings.config file for the Business Central Server instance.

Default: The URL of the Web client
Dynamically Updatable: No
Windows Client Base URL PublicWinBaseUrl Specifies the root of the URLs that are used to open hyperlinks to pages and reports in the Dynamics NAV Client connected to Business Central. 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 Business Central Server instance.

Default: The URL of the Wndows client
Dynamically Updatable: No

SOAP Services Settings

The following table describes fields on the SOAP Services tab in the Business Central Server Administration tool.

Setting Key Name Description
Enable SOAP Services SOAPServicesEnabled Specifies whether SOAP web services are enabled for this Business Central Server instance.

Default: Not enabled
Dynamically Updatable: No
Enable SSL SOAPServicesSSLEnabled Specifies whether SSL (https) is enabled for the SOAP web service port. For more information, see Using Security Certificates with Business Central On-Premises.

Default: Not enabled
Dynamically Updatable: No
Max Message Size SOAPServicesMaxMsgSize The maximum permitted size of a SOAP web services request, in kilobytes.

Important: This setting also pertains to OData web services.

Default: 1024
Dynamically Updatable: No
Port SOAPServicesPort The listening HTTP port for SOAP web services.

Valid range: 1 - 65535
Default: 7047
Dynamically Updatable: No
SOAP Base URL PublicSOAPBaseUrl 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 Business Central Server instance.

Default: The SOAP URL for the server instance
Dynamically Updatable: No

OData Services Settings

The following table describes fields on the OData Services tab in the Business Central Server Administration tool.

Setting Key Name Description
Enable Add-in Annotations ODataEnableExcelAddInAnnotations Specifies whether Excel add-in annotations should be provided in OData metadata.

Default: Enabled
Dynamically Updatable: No
Enable API Services ApiServicesEnabled Specifies whether API web services are enabled for this server instance.

Default: Not enabled
Dynamically Updatable: No
Enable OData Services ODataServicesEnabled Specifies whether OData web services are enabled for this Business Central Server instance.

Default: Enabled
Dynamically Updatable: No
Enable SSL ODataServicesSSLEnabled Specifies whether SSL (https) is enabled for the OData web service port. For more information, see Using Security Certificates with Business Central On-Premises.

Default: Not enabled
Dynamically Updatable: No
Enable V3 Endpoint ODataServicesV3EndpointEnabled Specifies whether the ODataV3 service endpoint will be enabled.

Default: Enabled
Dynamically Updatable: No
Enable V4 Endpoint ODataServicesV4EndpointEnabled Specifies whether the ODataV4 service endpoint will be enabled.

Default: Enabled
Dynamically Updatable: No
Max Connections ODataMaxConnections Specifies the maximum number of simultaneous OData requests on the server instance (for all tenants). When the limit is exceeded, a 429 (Too Many Requests) error occurs. If you do not want a limit, set the value 0.

OData requests consume server instance resources and can affect the performance of the clients if the number of requests gets too large. This setting enables you to control the resources allocated for OData requests.

Default: 0
Dynamically Updatable: Yes
Max Connections Per Tenant ODataMaxConnectionsPerTenant Specifies the maximum number of simultaneous OData requests per tenant. When the limit is exceeded, a 429 (Too Many Requests) error occurs. If you do not want a limit, set the value 0.

If the server is not configured for multitenancy or only has a single tenant, then this setting does the same as the Max Connections (ODataMaxConnections) setting.

OData requests consume server instance resources and can affect the performance of the clients if the number of requests gets too large. This setting enables you to control the resources allocated for OData requests.

Default: 0
Dynamically Updatable: Yes
Max Page Size ODataServicesMaxPageSize 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
Dynamically Updatable: No
OData Base URL PublicODataBaseUrl 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 Business Central Server instance.

Default: The OData URL for the server instance
Dynamically Updatable: No
Port ODataServicesPort The listening HTTP port for Business Central OData web services.

Valid range: 1 - 65535
Default: 7048
Dynamically Updatable: No
Timeout ODataServicesOperationTimeout Specifies the maximum amount of time that the server instance can allocate to a single OData request. When the limit is exceeded, a 408 (Request Timeout) error occurs.

If you do not want a limit, set the value to MaxValue.

Time format: hh:mm:ss
Default: 00:05:00
Dynamically Updatable: Yes

Important

The maximum permitted size of an OData web services request is specified by the Max Message Size option on the SOAP Services tab.

NAS Services Settings

The following table describes fields on the NAS Services tab in the Business Central Server Administration tool.

Note

Instead of using NAS services, we recommend that you use the Task Scheduler (see Task Scheduler. If you decide to use NAS, and want to read more about its configuration, see Configuring NAS Services in the Dev and IT Pro Help for Microsoft Dynamics NAV 2018.

Setting Key Name Description
Enable Debugging NASServicesEnableDebugging Specifies if the Business Central Debugger must attach to the NAS Services session. When this is enabled, the NAS Services session waits 60 seconds before the first AL statement is run.

Default: Not enabled
Dynamically Updatable: No
Run NAS Services with Admin Rights NASServicesRunWithAdminRights Specifies whether NAS services run operations with administrator rights instead of the rights granted to the Business Central Server service account.

If you select this setting, NAS services will have full permissions in Business Central, similar to the permissions that are granted by the SUPER permission set. The Business Central Server service account is not required to be set up as a user in Business Central.

If you clear this setting, the Business Central Server service account must be added as a user in Business Central and assigned the permissions that are required to perform the operations.

Default: Not enabled
Dynamically Updatable: No
Startup Argument NASServicesStartupArgument 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 value:"OSYNCH"

Default:
Dynamically Updatable: No
Startup Codeunit NASServicesStartupCodeunit 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.

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

Note: 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.

Default:
Dynamically Updatable: No
Startup Method NASServicesStartupMethod 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.

Default:
Dynamically Updatable: No

Management Services Settings

The following table describes fields on the Management Services tab in the Business Central Server Administration tool.

Setting Key Name Description
Enable Management Services ManagementServicesEnabled Specifies whether Business Central Server Administration tool is enabled for this Business Central Server instance.

Default: Enabled
Dynamically Updatable: No
Port ManagementServicesPort The listening TCP port for the Business Central Server Administration tool.

Valid range: 1 - 65535
Default: 7045
Dynamically Updatable: No

Azure Key Vault Encryption Provider Tab Settings

The following table describes fields on the Azure Key Vault Encryption Provider tab in the Business Central Server Administration tool.

Note

These settings are used when you want to use Azure Key Vault to help encrypt data in the database. If you want to use Azure Key Vault to encrypt the connection between Business Central Server and an Azure SQL database, you must store that key in the database.

Setting Key Name Description
Client Certificate Store Location AzureKeyVaultClientCertificateStoreLocation Specifies the location of the certificate store for the Key Vault client certificate if you set the Encryption Key Provider field to AzureKeyVault.

LocalMachine specifies that the certificate is stored in a certificate store for the computer that the Business Central Server is running on.

CurrentUser specifies that the certificate is stored in a certificate store for your account on the computer that the Business Central Server is running on.

Default: LocalMachine
Dynamically Updatable: No
Client Certificate Store Name AzureKeyVaultClientCertificateStoreName Specifies the certificate store where the Key Vault client certificate is stored.

Default: My
Dynamically Updatable: No
Client Certificate Thumbprint AzureKeyVaultClientCertificateThumbprint Specifies the thumbprint of the Key Vault client certificate

Default: My
Dynamically Updatable: No
Client ID AzureKeyVaultClientId Specifies the unique identifier (GUID) of the Key Vault client application in Microsoft Azure.

Default: 00000000-0000-0000-0000-000000000000
Dynamically Updatable: No
Key URI AzureKeyVaultKeyUri Specifies the URI of the key in the Key Vault encryption provider setup.

Default:
Dynamically Updatable: No

Azure Active Directory (Azure AD) Settings

The following table describes fields on the Azure Active Directory (Azure AD) tab in the Business Central Server Administration tool.

The settings in this tab configure the Business Central Server instance to use Azure AD authentication. The settings are only relevant when the server instance is configured Access Control Service, that is, when the Credential Type is set to AccessControlService. For more information about authenticating using Azure AD, see Authenticating Users with Azure Active Directory.

Setting Key Name Description
Application Client Certificate Thumbprint AzureActiveDirectoryClientCertificateThumbprint Specifies the thumbprint of the x509 certificate that is used with the Azure AD application client for authentication.

A public certificate file (.cer) must be installed on the application client and associated with an Azure AD service principal.

A private certificate file (.pfx) must be installed on the computer on which the Business Central Server instance is installed. The server instance service account must have access to the private key of that certificate.

Default:
Dynamically Updatable: No
Application Client ID AzureActiveDirectoryClientId Specifies the ID of the application tenant. The ID is used when accessing data in Azure AD.

The authentication token for communicating with Azure AD should be retrieved by specifying the Application Client Certificate Thumbprint, with a fallback to use the Application Client Secret.

Default: 00000000-0000-0000-0000-000000000000
Dynamically Updatable: No
Application Client Secret AzureActiveDirectoryClientSecret Specifies the secret to use with Application Client ID for Azure AD authentication.

Default:
Dynamically Updatable: No
Azure AD App ID URI AppIdUri Specifies the App ID URI that is registered for Business Central in the Microsoft Azure Active Directory (Azure AD). You use this setting to configure Business Central web services for OAuth authentication, specifically when the Credential Type setting is AccessControlService. It is used to validate the security tokens that the server instance receives in SOAP and OData calls.

The App ID URI is a logical identifier and does not have to represent a valid location, although it is common practice to use the physical URL of the Business Central web service.

The App ID URI is typically the same as the value of wtrealm parameter of the ACSUri setting that is included in the ClientUserSettings.config file for the Dynamics NAV Client connected to Business Central.

An example of an App ID URI is https://localhost:7047/.

For more information about how to use the Azure Active Directory App ID URI with OAuth authentication, see Using OAuth to Authenticate Web Services (Odata and SOAP).

Default:
Dynamically Updatable: No
Enable Membership Entitlement EnableMembershipEntitlement Configures the server instance to use membership entitlement for controlling access the Business Central.

This setting is typically only used for software as a service (SaaS) solutions.

Default:
Dynamically Updatable: No
Excel add-in AAD client app ID ExcelAddInAzureActiveDirectoryClientId This setting is used to set up the Excel Add-in that enables users to use Excel to modify and update Business Central data.

The setting specifies the client ID of the Azure AD tenant that is used for the Excel add-in. The Excel add-in requires a separate Azure AD tenant. For more information, see Configuring the Excel Add-In.

Default:
Dynamically Updatable: No
Extended Security Token Lifetime ExtendedSecurityTokenLifetime Specifies the number of hours that are added to the lifetime of Azure AD security tokens, which are used to authenticate client users. When the lifetime expires, the client is disconnected from the server instance. An event with a message such as "The SAML2 token is invalid because its validity period ended." is recorded in the event log for the server instance. In general, the lifetime of security tokens is 1 hour.

Valid range: 0 to 24 hours
Default: 0
Dynamically Updatable: No
Valid Audiences ValidAudiences Specifies the allowed audiences for Azure AD authentication. This setting is used to authenticate other Azure AD applications that will communicate with the server instance.

The value is a semicolon-separated list of audiences. You specify an audience by using the App URI ID or App ID that is assigned to the application in Azure AD.

Default:
Dynamically Updatable: No
WS-Federation Login Endpoint WSFederationLoginEndpoint Specifies the URL for the federation sign-on page that Business Central redirects to when configured for single sign-on.

You must specify a URL in the following format:

https://login.microsoftonline.com/[AADTENANTID]/wsfed?wa=wsignin1.0%26wtrealm=...%26wreply=....

The placeholder [AADTENANTID] represents the GUID of your Azure AD tenant. If the server instance has to support multiple Azure AD tenants, then the Azure AD Tenant ID parameter that is specified when mounting a tenant replaces the placeholder.

Default:
Dynamically Updatable: No
WS-Federation Metadata Location ClientServicesFederationMetadataLocation Specifies the URL for the federation metadata document that describes the configuration information for your Azure AD tenant. The federation metadata document is used to validate the security tokens that the Business Central Web client and Business Central Tablet client receive, and to establish a trust relationship with between Business Central and an application that you have added to Azure AD.

You must specify a URL in the following format:

https://login.microsoftonline.com/[AADTENANTID]/FederationMetadata/2007-06/FederationMetadata.xml

The placeholder [AADTENANTID] represents the GUID of your Azure AD tenant. If the server instance has to support multiple Azure AD tenants, then the Azure AD Tenant ID parameter that is specified when mounting a tenant replaces the placeholder.

This parameter is relevant only when Credential Type, on the General tab, is set to AccessControlService. For more information, see Authenticating Users with Azure Active Directory.

Default:
Dynamically Updatable: No

Task Scheduler Settings

The following table describes fields on the Task Scheduler tab in the Business Central Server Administration tool.

The task scheduler processes jobs and other processes on a scheduled basis. For more information about task scheduler, see Task Scheduler.

Setting Key Name Description
Enable Task Scheduler EnableTaskScheduler Specifies whether the server instance starts with the task scheduler enabled.

If this option is enabled, the server instance will process scheduled tasks.

Default: Enabled
Dynamically Updatable: No
Maximum Concurrent Running Tasks TaskSchedulerMaximumConcurrentRunningTasks Specifies the maximum number of tasks that can run simultaneously on the server instance.

The value that you specify will depend on the hardware (CPUs) of the deployment environment and what you want to prioritize: client performance or scheduled tasks (such as job queue entries). The setting is particularly relevant when the server instance is used for both scheduled tasks and client services. If there are many jobs running at the same time, you might experience that the response time for clients gets slower. In which case, you could decrease the value. However, if the value is too low, it might take longer than desired for scheduled tasks to process. When you have a dedicated server instance for scheduled tasks, this setting is less important with respect to client performance.

Default: 10
Dynamically Updatable: Yes
System Task Start Time TaskSchedulerSystemTaskStartTime Specifies the time of day after which system tasks can start. The time is based on the time zone of the computer that is running the server instance.

The value has the format HH:MM:SS.

Default: 00:00:00
Dynamically Updatable: Yes
System Task End Time TaskSchedulerSystemTaskEndTime Specifies the time of day after which system tasks cannot start. The time is based on the time zone of the computer that is running the server instance.

The value has the format HH:MM:SS.

Default: 23:59:59
Dynamically Updatable: Yes

Reports Settings

The following table describes fields on the Reports tab in the Business Central Server Administration tool.

Setting Key Name Description
Enable Application Domain Isolation ReportAppDomainIsolation Specifies whether application domain isolation is used for rendering custom RDLC layouts. This setting pertains to on-premise installations only.

Enabling application domain isolation provides a more secure and reliable environment for processing custom RDLC layouts; however, it can considerably increase the time it takes to render reports. Disabling application domain isolation can improve the rendering time but might have a negative impact on security and reliability.

Default: Enabled
Dynamically Updatable: No
Enable Save as Excel on Request Pages of RDLC-layout Reports EnableSaveToExcelForRdlcReports Specifies whether users can open or save a report as an Microsoft Excel document if the report uses an RDLC layout.

If you clear this check box, the Excel option is removed from the Print menu on the request page.

Default: Enabled
Dynamically Updatable: No
Enable Save as Word on Request Pages of RDLC-layout Reports EnableSaveToWordForRdlcReports Specifies whether users can open or save a report as a Microsoft Word document if the report uses an RDLC layout.

If you clear this check box, the Word option is removed from the Print menu on the request page.

Default: Enabled
Dynamically Updatable: No
Enable Save from Report Preview EnableSaveFromReportPreview Specifies whether users can save a report as a PDF, Microsoft Word, or Microsoft Excel document from the report preview window.

If you clear this check box, the Save As icon is removed from the report preview window.

Default: Enabled
Dynamically Updatable: No
Report PDF Font Embedding ReportPDFFontEmbedding Specifies whether fonts are embedded in PDF files that are generated for reports when the report uses an RDLC report layout at runtime. This setting applies when reports are run and saved as PDF files on the client (from the report request page or print preview window) or on the server instance (by the SAVEAS function or SAVEASPDF function in AL code).

Note: This setting does not apply when a report uses a Word report layout at runtime.

Embedding fonts in a PDF of a report makes sure that the PDF will use the same fonts as the original file, regardless of where the PDF is opened and which fonts are installed on the computer. However, embedding fonts can significantly increase the size of the PDF files. By disabling font embedding, you can decrease the size of the report PDF files.

Note: This is a global setting for font embedding in report PDF files. You can override this setting on a report basis by the specifying the PDFFontEmbedding property.

Default: Enabled
Dynamically Updatable: No
not available CalculateBestPaperSizeForReportPrinting Determines the paper size to use when printing reports from the client.

If set to true, the system calculates which of the available paper sizes on the printer is best suited for printing, and then uses that paper size.

If set to false, the printer's default paper size is used.

Default: true

Development Settings

The following table describes fields on the Development tab in the Business Central Server Administration tool.

Setting Key Name Description
Allowed Extension Target Level ExtensionAllowedTargetLevel Specifies the allowed target level when publishing extensions. The options are Internal, Extension, Solution, and Personalization.

- If you specify the Internal option, the allowed compilation target is set to everything on-premises. The Internal setting allows using all restricted APIs. The target setting in the app.json file must also be set to Internal. For more information, see JSON Files.

- If you specify the Extension option, the allowed extension target level is set to SaaS.

- By adding the setting "target":"Extension" in the manifest enables you to submit the extension to AppSource.

The Personalization and Solution settings are currently for internal use only.

Note: It is recommended to use either Internal or Extension options to set Allowed Extension Target Level.

Default: Internal
Dynamically Updatable: No
Debugger – Long Running SQL Statements Threshold LongRunningSqlStatementsInDebuggerThreshold Specifies the amount of time (in milliseconds) that an SQL query can run before it is logged in debugger telemetry.

Default: Enabled
Dynamically Updatable: Yes
Debugger - Number of SQL Statements to Show AmountOfSqlStatementsInDebugger Specifies the amount of SQL statements used in the debugger; the higher number you choose, the more data will be sent to the debugger.

Default: Enabled
Dynamically Updatable: Yes
Debugger - Show Long Running SQL Statements EnableLongRunningSqlStatementsInDebugger Specifies whether long running SQL statements will be shown in the debugger.

Default: Enabled
Dynamically Updatable: Yes
Debugger - Show SQL Statements EnableSqlInformationDebugger Specifies whether the debugger should collect the last used SQL statements and show them in the debugger.

Default: Enabled
Dynamically Updatable: Yes
Debugging Allowed DebuggingAllowed Specifies whether AL debugging is allowed for this Business Central Server instance.

Default: Enabled
Dynamically Updatable: No
Enable Debugging EnableDebugging Specifies whether the Business Central 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 Business Central Server restarts. Application objects are compiled with debug information.

Default: Not enabled
Dynamically Updatable: No
Enable Developer Service Endpoint DeveloperServicesEnabled Specifies whether the Developer service endpoint is enabled. This setting must be enabled to publish extensions and download symbols.

- If the check box is selected, the extension can be published to the allowed extension target level.

- If the check box is not selected, the extension cannot be published.

- This setting can also be controlled from the .xml file.

Default: Not enabled (check box is cleared)
Dynamically Updatable: No
Enable Loading Application Symbol References at Server Startup EnableSymbolLoadingAtServerStartup Specifies whether application symbol references should be loaded at server startup. This setting must be enabled to allow any symbol generation. If the setting is not enabled, the generatesymbolreference setting does not have any effect. For more information, see Running C/SIDE and AL Side-by-Side.

Default: Not enabled (check box is cleared)
Dynamically Updatable: No
Enable SSL DeveloperServicesSSLEnabled Specifies whether SSL (HTTPS) is enabled for the developer web service port.

SSL (Secure Sockets Layer) secures the connection for the web services.

- If the check box is selected, then SSL is enabled.

- If the check box is not selected, the developer web service port cannot establish a secure connection.

Default: Not enabled (check box is cleared)
Dynamically Updatable: No
HttpClient AL Function Maximum Timeout NavHttpClientMaxTimeout Specifies the maximum allowed timeout value that can be set for the HttpClient Timeout AL function.

The value has the format HH:MM:SS.

Default: 00:05:00
Dynamically Updatable: Yes
HttpClient AL Function Response Size NavHttpClientMaxResponseContentSize Specifies the maximum size in megabytes of a response buffer used by the HttpClient AL function.

The maximum allowed extension size can be adjusted based on the HttpClient AL Function Maximum Timeout setting.

Default: 15
Dynamically Updatable: Yes
Port DeveloperServicesPort The listening HTTP port for Microsoft Dynamics NAV Developer web services.

Valid range: 1 - 65535
Default: 7049
Dynamically Updatable: No

Compatibility Settings

The following table describes settings that you can adjust for compatibility with other systems. In most cases, we do not recommend that you change these settings from their default values.

Setting Key Name Description
Security Protocol SecurityProtocol Specifies the default security protocol level for the server instance.

Values: Ssl3, Tls, Tls11, Tls12, SystemDefault. For more information about these values, see SecurityProtocolType Enum.

Default: Tls12
Dynamically Updatable: No
Use Client Timestamp For Report Execution Timestamp ReplaceReportExecutionTimeWithClientTime Specifies whether to replace the report execution timestamp with the client timestamp instead of the server instance timestamp.

Default: Enabled (check box is selected)
Dynamically Updatable: No
Use FIND('-') to Populate Pages Instead of FIND('=><') UseFindMinusWhenPopulatingPage Specifies whether pages are initially populated by using FIND('-') instead of FIND('=><'). This setting is relevant to pages that display lists in descending order. Enabling this setting ensures that the first record, instead of the last record, is in focus when the page opens. Pages that use the OnFindRecord trigger will ignore this setting and always use FIND('=><').

Default: Enabled (check box is selected)
Dynamically Updatable: No

Using Business Central Administration Shell to Modify Server Instance Settings

The Business Central Administration Shell includes several Set- cmdlets that enable you to create and modify Business Central Server instances.

The main cmdlet for configuring a server instance is the Set-NAVServerConfiguration cmdlet. You can use this cmdlet to change any of the configuration settings that are listed in the previous sections. To change a configuration setting, you set -KeyName parameter to the Key Name that corresponds to the setting, and set the -KeyValueparameter to the new value. 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 -ServerInstance "MyInstance" -KeyName "DatabaseServer" -KeyValue "DatabaseServer.Domain.Com"  

Modifying dynamically updatable settings

For dynamically updatable settings, use the -ApplyTo parameter to specify how to apply the change. The change can be written directly to the configuration file (CustomSettings.config) and/or applied to the current server instance state. The option you choose will determine whether a server instance restart is required for the change to take effect. The parameter has three options, as described in the following table:

Option Description
ConfigFile Saves the change to the configuration file of the server instance. The change will not take effect until the server instance is restarted.
Memory Applies the change only to the server instance's current state. The changes take effect immediately, without having to restart the server instance. The change is stored in memory, so the next time the server instance is restarted, it reverts to the setting in the configuration file.
All Applies the change to the server instance's current setting state (in memory) and to the configuration file. The changes take effect immediately, without having to restart the server instance.

For example, the following command sets the value for the MaxStreamReadSize key to 42424242, without having to restart the server instance.

Set-NAVServerConfiguration -ServerInstanceMyInstance -KeyName MaxStreamReadSize -KeyValue 42424242 -ApplyTo Memory  

For more information about running the Business Central Administration Shell, see Microsoft Dynamics NAV Windows PowerShell Cmdlets.

See Also

w
Business Central Server Administration Tool
Enhancing Business Central Server Security
Business Central Windows PowerShell Cmdlets
Configuring Help
Hiding UI Elements
Debugging