Share via

New-NAVServerAppConfiguration

  • Reference
Module:
Microsoft.BusinessCentral.Management

Creates a new application-specific configuration file for the Business Central Server instance.

Syntax

New-NAVServerAppConfiguration
   -ApplicationId <String>
   [-ServerInstance] <String>
   [-Force]
   [-ProgressAction <ActionPreference>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

You can have more than one application running on a single Business Central Server instance. By default, the server instance will use the settings in the CustomSettings.config for all applications. This cmdlet enables you to create an additional configuration file that is only used by a specific application. The application-specific configuration file can be used to configure the following settings.

AppProtocolName - Specifies the protocol to use in URL links to the application, similar to the http protocol in web page links. For example, with Dynamics 365 for Financials, by setting the parameter to "ms-financials" means that "ms-financials:///?page=31" would open the items list page 31.

AppIdUri - Specifies the APP ID URI that is assigned to the Business Central application in Microsoft Entra ID (Microsoft Entra ID).

AzureActiveDirectoryClientApplicationId - Specifies the CLIENT ID that is assigned to the Business Central application in Microsoft Entra ID.

The application-specific file is saved in the same location as the CustomSettings.config file for the Business Central Server installation. For example, by default, the location is C:\Program Files\Business Central\NN\Service, where NN is the server version number.

The generated configuration file does not contain any settings. To add settings, use the Set-NAVServerAppConfiguration cmdlet.

The application-specific configuration file is used to supplement the CustomSettings.config file of the server instance. The server instance will load the correct application-specific configuration file for an application based on the application ID that is specified by the ApplicationId parameter.

Examples

EXAMPLE 1

New-NAVServerAppConfiguration -ApplicationId FIN -ServerInstance BC

This example creates a new application-specific configuration file for the FIN application. The generated file has the name CustomerSettings.FIN.config.

Parameters

-ApplicationId

Specifies the identifier that is assigned to the application to create a configuration file for. The value is used in the name of the new configuration file, which has the format: CustomSettings.ApplicationId.config.

For Business Central on-premises, the default application ID is NAV.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

Forces the command to run without asking for user confirmation.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ProgressAction

A common PowerShell parameter that determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider. Learn more.

Type:ActionPreference
Aliases:proga
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ServerInstance

Specifies the name of a Business Central Server instance, for example, BC or myinstance. You can specify either the full name of an instance, such as MicrosoftDynamicsNavServer$myinstance or the short name such as myinstance.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False