Get-NavAppRuntimePackage

  • Reference
Module:
Microsoft.Dynamics.Nav.Apps.Management

Get a Business Central app runtime package

Syntax

Get-NavAppRuntimePackage
   [-Id <String>]
   [-Name <String>]
   [-Publisher <String>]
   [-Version <Version>]
   [-ShowMyCode <Boolean>]
   -Path <String>
   [-Tenant <TenantId>]
   [-ServerInstance] <String>
   [-Force]
   [<CommonParameters>]

Description

Use the Get-NAVAppRuntimePackage cmdlet to get a Business Central app runtime package.

Examples

EXAMPLE 1

Get-NAVAppRuntimePackage -ServerInstance BC -Name 'Proseware SmartApp' -Version 2.3.4.500 -Path 'Prosware SmartApp_2.3.4.500_runtime.app'

This example gets the Business Central app runtime package with the provided name and version.

Parameters

-Force

Forces the command to run without asking for user confirmation.

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

-Id

Specifies the ID of the Business Central app to be returned.

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

-Name

Specifies the name of the Business Central app to be returned.

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

-Path

Specifies the path where the binary extension will be written to.

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

-Publisher

Specifies the publisher of the Business Central app to be returned.

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

-ShowMyCode

Specifies whether to include the app's source code in the runtime package. The source code can be used for debugging and recompiling purposes. If you want to be able run the Repair-NAVApp cmdlet on on the app, you must include the source code. This parameter overwrites the ShowMyCode value in the app's manifest (app.json file). To include source code, set the parameter to $true.

This parameter is available only in Business Central April 2019 and later versions.

Type:Boolean
Aliases:AppShowMyCode
Position:Named
Default value:False
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Tenant

Specifies the ID of a specific tenant that you want to act on, such as Tenant1.

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

-Version

Specifies the exact version of the Business Central app to be returned.

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

Inputs

System.String

By property name: Id

System.String

By property name: Name

System.String

By property name: Publisher

System.Version

By property name: Version

System.String

By property name: Version

System.String

Notes

You generate runtime packages for distribution of extensions that do not contain AL code, but only the final artifacts used by the server at runtime. Runtime packages allow you to protect the intellectual property represented by your AL source code. The extension in a runtime package can be installed on servers that do not have a developer license. The license is checked on the server where the runtime package is generated.