Share via

Install-NAVApp

  • Reference
Module:
Microsoft.BusinessCentral.Apps.Management

Installs a published Business Central app for a tenant.

Syntax

Install-NAVApp
       [-ServerInstance] <String>
       [-AppId <Guid>]
       [-Name <String>]
       [-Publisher <String>]
       [-Version <Version>]
       [-Tenant <TenantId>]
       [-Language <LanguageSetting>]
       [-PassThru]
       [-DoNotLoadData]
       [-ExclusiveAccessTicket <String>]
       [-SyncMode <NavAppSyncMode>]
       [-Force]
       [-ProgressAction <ActionPreference>]
       [<CommonParameters>]
Install-NAVApp
       [-ServerInstance] <String>
       [-Tenant <TenantId>]
       -Path <String>
       [-Language <LanguageSetting>]
       [-PassThru]
       [-DoNotLoadData]
       [-ExclusiveAccessTicket <String>]
       [-SyncMode <NavAppSyncMode>]
       [-Force]
       [-ProgressAction <ActionPreference>]
       [<CommonParameters>]

Description

Use the Install-NAVApp cmdlet to install an already published Business Central app for a tenant.

Examples

EXAMPLE 1

Install-NAVApp -ServerInstance BC -Name 'Proseware SmartApp' -Version 2.3.4.500 -Tenant 'Tenant1'

This example installs the Business Central app with the specified name and version for the tenant with the ID Tenant1. If the Business Central app includes a database schema change, the tenant database is automatically synchronized.
For V2 extensions, the Install-NAVApp cmdlet does not handle synchronization, and in this case, the Sync-NAVApp cmdlet must be used.

EXAMPLE 2

Get-NAVAppInfo -ServerInstance BC -Name 'Proseware SmartApp' -Version 2.3.4.500 | Install-NAVApp -Tenant 'Tenant1'

Description

This example installs a Business Central app that is returned from the Get-NAVAppInfo cmdlet for the tenant with the ID Tenant1. If the Business Central app contains a database schema change, the tenant database is automatically synchronized.
For V2 extensions, the Install-NAVApp cmdlet does not handle synchronization, and in this case, the Sync-NAVApp cmdlet must be used.

EXAMPLE 3

Install-NAVApp -ServerInstance BC -Path '.\Proseware SmartApp.app' -Tenant 'Tenant1'

This example installs the Business Central app at the specified path for the tenant with the ID Tenant1. The Business Central app must have already been published to the server instance before you can install it for the tenant. If the Business Central app contains a database schema change, the tenant database is automatically synchronized.
For V2 extensions, the Install-NAVApp cmdlet does not handle synchronization, and in this case, the Sync-NAVApp cmdlet must be used.

EXAMPLE 4

Install-NAVApp -ServerInstance BC -Name 'Proseware SmartApp' -Version 2.3.4.500 -Tenant 'Tenant1' -DoNotLoadData

This example installs the Business Central app with the provided name and version for the tenant with an ID of Tenant1. If the Business Central app contains a schema change, the tenant database will be synchronized but since the -DoNotLoadData switch was used any data backed up from a previous uninstall of this Business Central app will not be loaded.
For V2 extensions, the Install-NAVApp cmdlet does not handle synchronization, and in this case, the Sync-NAVApp cmdlet must be used.

EXAMPLE 5

Install-NAVApp -ServerInstance BC -Name 'Proseware SmartApp' -Version 2.3.4.500

This example installs the Business Central app with the provided name and version on a single tenant NAV server instance. If the Business Central app contains a schema change, the tenant database will be synchronized.
For V2 extensions, the Install-NAVApp cmdlet does not handle synchronization, and in this case, the Sync-NAVApp cmdlet must be used.

EXAMPLE 6

Get-NAVTenant -ServerInstance BC | Install-NAVApp -ServerInstance BC -Name 'Proseware SmartApp' -Version 2.3.4.500

EXAMPLE 7

Install-NAVApp -ServerInstance BusinessCentral -Name 'Proseware SmartApp' -Version 2.3.4.500 -Tenant 'Tenant1' -SyncMode Add

This example synchronizes and installs the Business Central App with the provided name and version for the tenant with an ID of Tenant1.

Parameters

-AppId

Specifies the ID of the Business Central App that you want to install.

Type:Guid
Position:Named
Default value:00000000-0000-0000-0000-000000000000
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-DoNotLoadData

Specifies that the installation must run without loading any Business Central app data that was saved from an earlier installation of the Business Central app.

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

-ExclusiveAccessTicket

Specifies the exclusive access ticket allowing this operation on the tenant in the exclusive access mode.

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

-Force

Forces the command to run without asking for user confirmation to install a dependent Business Central app.

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

-Language

Specifies the language version of Business Central app. The value must be a valid culture name for a language in Business Central, such as en-US or da-DK. If the specified language does not exist on the Business Central Server instance, then en-US is used.

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

-Name

Specifies the name of the Business Central app that you want to install. The results must return only one Business Central app, otherwise nothing installs.

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

-PassThru

Returns a Business Central app object for the installed Business Central app. The Business Central app object contains the properties of the Business Central app, such as name, publisher, and version.

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

-Path

Specifies the path to a Business Central app package file that you want to install for the tenant. The Business Central app must have already been published to the server instance before you can install it for the tenant.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
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

-Publisher

Specifies the publisher of the Business Central app that you want to install. The results must return only one Business Central app, otherwise nothing installs.

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

-ServerInstance

Specifies the Business Central Server instance that the Business Central app is published to, such as BC.

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

-SyncMode

Which sync mode should be executed while installing the app.

If the app is already synchronized, the installation proceeds independently of the requested sync mode.

The supported synchronization modes for install are 'Add', 'ForceSync' and 'None'. The last-mentioned is the default behavior.

Possible values: Add, Clean, Development, ForceSync, None

Type:NavAppSyncMode
Accepted values:Add, Clean, Development, ForceSync, None
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Tenant

Specifies the ID of the tenant that you want to install the Business Central app for, such as Tenant1. You can specify the value default if the specified server instance is not configured for multiple tenants. Alternatively, do not set the parameter.

Type:TenantId
Aliases:Id
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Version

Specifies the version of the Business Central app that you want to install. The results must return only one Business Central app, otherwise nothing installed.

Type:Version
Aliases:AppVersion
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

Inputs

System.String

By value and by property name: ServerInstance

System.String

By property name: Name

System.String

By property name: Publisher

System.Version

By property name: Version

Microsoft.Dynamics.Nav.Types.TenantId

By property name: Tenant

System.String

By property name: Path

System.String

By value and by property name: ExclusiveAccessTicket