Get-NAVAppInfo

Gets information about a Business Central app based on the specified package file or the specified Business Central Server instance.

Syntax

Get-NAVAppInfo
   [-Id <Guid>]
   [-Name <String>]
   [-Publisher <String>]
   [-Version <Version>]
   [-CompatibilityId <Version>]
   [-SymbolsOnly]
   [-ServerInstance] <String>
   [<CommonParameters>]
Get-NAVAppInfo
   [-Id <Guid>]
   [-Name <String>]
   [-Publisher <String>]
   [-Version <Version>]
   [-CompatibilityId <Version>]
   -Tenant <TenantId>
   [-TenantSpecificProperties]
   [-ServerInstance] <String>
   [<CommonParameters>]
Get-NAVAppInfo
   -Tenant <TenantId>
   [-ServerInstance] <String>
   [<CommonParameters>]
Get-NAVAppInfo
   -Path <String>
   [<CommonParameters>]

Description

Use the Get-NAVAppInfo cmdlet to get information about a specific Business Central app, or to get a list of Business Central apps that have been deployed. The list of deployed Business Central apps can include all Business Central apps that have been published to a Business Central Server instance, filtered by Business Central app properties, or Business Central apps that are published for a specific tenant.

  • To get information about all Apps published to the application on a server instance, specify the server instance. If you want to filter the list to specific Apps, then use other parameters, like ID, publisher, and version.

  • To get information about all apps that are installed on a specific tenant, specify the server instance and the tenant. With a single tenant server instance, the tenant is named `default'. If you want to filter the list to specific Apps, then use other parameters, like Id, publisher, and version.

  • To get information about symbols published to the application on a server instance, specify the server instance and the -SymbolsOnly switch.

Note: To get a list of all tenants on which a specific app is published, you can use the Get-NAVAppTenant cmdlet.

Examples

EXAMPLE 1

Get-NAVAppInfo -ServerInstance DynamicsNAV90

                    Id                                       Name                 Version    Publisher
                    --                                       ----                 -------    ---------
                    9a47a833-e22f-4812-ade314219c53          SmartApp Base        2.0.0.300  Proseware, Inc.
                    3c88160c-e0eb-4fe1-b4f6-011e45d74b10     Proseware SmartApp   2.3.4.500  Proseware, Inc.

This example returns information about all of the Business Central apps published on the DynamicsNAV90 server instance.

EXAMPLE 2

Get-NAVAppInfo -ServerInstance DynamicsNAV90 -Name 'Proseware SmartApp' -Version 2.3.4.500

                    Id                 : 3c88160c-e0eb-4fe1-b4f6-011e45d74b10
                    Name               : Proseware SmartApp
                    Version            : 2.3.4.500
                    Publisher          : Proseware, Inc.
                    Brief              : First Proseware App
                    Description        : First Business Central app by Proseware
                    Compatibility Id   : 2.0.0.0
                    Privacy Statement  : http://www.proseware.com/SmartApp/privacypolicy.aspx
                    EULA               : http://www.proseware.com/SmartApp/EULA.aspx
                    Help               : http://www.proseware.com/SmartApp/Support.aspx
                    Url                : http://www.proseware.com/SmartApp/
                    Logo               : SmartLogo.png
                    ScreenShots        : SmartShot1.png, SmartShot2.png, SmartShot3.png
                    Capabilities       :
                    Prerequisites      :
                    Dependencies       :

This example returns information about the Business Central app with the specified name and version on the DynamicsNAV90 server instance.

EXAMPLE 3

Get-NAVAppInfo -ServerInstance DynamicsNAV90 -Publisher 'Proseware, Inc.'

                    Id                                       Name                 Version    Publisher
                    --                                       ----                 -------    ---------
                    9a47a833-e22f-4812-ade314219c53          SmartApp Base        2.0.0.300  Proseware, Inc.
                    3c88160c-e0eb-4fe1-b4f6-011e45d74b10     Proseware SmartApp   2.3.4.500  Proseware, Inc.

This example returns information about all of the Business Central apps published on the DynamicsNAV90 server instance that are published by Proseware, Inc.

EXAMPLE 4

Get-NAVAppInfo -ServerInstance DynamicsNAV90 -Tenant 'Tenant1'

                    Id                 : 3c88160c-e0eb-4fe1-b4f6-011e45d74b10
                    Name               : Proseware SmartApp
                    Version            : 2.3.4.500
                    Publisher          : Proseware, Inc.
                    Brief              : First Proseware App
                    Description        : First Business Central app by Proseware
                    Compatibility Id   : 2.0.0.0
                    Privacy Statement  : http://www.proseware.com/SmartApp/privacypolicy.aspx
                    EULA               : http://www.proseware.com/SmartApp/EULA.aspx
                    Help               : http://www.proseware.com/SmartApp/Support.aspx
                    Url                : http://www.proseware.com/SmartApp/
                    Logo               : SmartLogo.png
                    ScreenShots        : SmartShot1.png, SmartShot2.png, SmartShot3.png
                    Capabilities       :
                    Prerequisites      :
                    Dependencies       :

This example returns information about all of the Business Central apps installed for the tenant with an ID of Tenant1 on the DynamicsNAV90 server instance.

EXAMPLE 5

Get-NAVAppInfo -Path '.\Proseware SmartApp.navx'

                    Id                 : 3c88160c-e0eb-4fe1-b4f6-011e45d74b10
                    Name               : Proseware SmartApp
                    Version            : 2.3.4.500
                    Publisher          : Proseware, Inc.
                    Brief              : First Proseware App
                    Description        : First Business Central app by Proseware
                    Compatibility Id   : 2.0.0.0
                    Privacy Statement  : http://www.proseware.com/SmartApp/privacypolicy.aspx
                    EULA               : http://www.proseware.com/SmartApp/ULA.aspx
                    Help               : http://www.proseware.com/SmartApp/Support.aspx
                    Url                : http://www.proseware.com/SmartApp/
                    Logo               : SmartLogo.png
                    ScreenShots        : SmartShot1.png, SmartShot2.png, SmartShot3.png
                    Capabilities       :
                    Prerequisites      :
                    Dependencies       :

This example returns information about the Business Central app from the package file provided.

EXAMPLE 6

Get-NAVAppInfo -ServerInstance DynamicsNAV90 -Tenant default

                    Id                 : 3c88160c-e0eb-4fe1-b4f6-011e45d74b10
                    Name               : Proseware SmartApp
                    Version            : 2.3.4.500
                    Publisher          : Proseware, Inc.
                    Brief              : First Proseware App
                    Description        : First Business Central app by Proseware
                    Compatibility Id   : 2.0.0.0
                    Privacy Statement  : http://www.proseware.com/SmartApp/privacypolicy.aspx
                    EULA               : http://www.proseware.com/SmartApp/ULA.aspx
                    Help               : http://www.proseware.com/SmartApp/Support.aspx
                    Url                : http://www.proseware.com/SmartApp/
                    Logo               : SmartLogo.png
                    ScreenShots        : SmartShot1.png, SmartShot2.png, SmartShot3.png
                    Capabilities       :
                    Prerequisites      :
                    Dependencies       :

This example returns information about all of the Business Central apps installed in a single tenant NAV server instance.

Parameters

-CompatibilityId

Specifies the compatibility ID of the Business Central app. The compatibility ID is a version string in the format of Major.Minor.Build.Revision such as 1.0.0.0. The value is used to indicate if there are compatibility-related code changes between different versions of the Business Central app.

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

-Id

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

Type:Guid
Aliases:AppId
Position:Named
Default value:None
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
Accept pipeline input:True
Accept wildcard characters:False

-Path

Specifies the path to a Business Central app Package file that you want to return.

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

-ServerInstance

Specifies the Business Central Server instance to which the Business Central app is deployed, such as DynamicsNAV90.

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

-SymbolsOnly

Returns the list of apps published with SymbolsOnly

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

-Tenant

Specifies the ID of the tenant that you want to get the published Business Central apps for, such as Tenant1. Provide a value of 'default' if the specified server instance is not configured to run multiple tenants.

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

-TenantSpecificProperties

Indicates to include any properties of the Business Central apps that are specific to the provided tenant

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

-Version

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

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