Share via

Set-NAVAppManifest

Module:
Microsoft.Dynamics.Nav.Apps.Tools Module

Sets one or more available properties on an in-memory manifest.

Syntax

Default (Default) 

Set-NAVAppManifest
    [-Manifest] <NavAppManifest>
    [-Id <Guid>]
    [-Name <String>]
    [-Publisher <String>]
    [-Brief <String>]
    [-Description <String>]
    [-Version <Version>]
    [-CompatibilityId <Version>]
    [-PrivacyStatement <String>]
    [-Eula <String>]
    [-Help <String>]
    [-Url <String>]
    [-Prerequisites <String[]>]
    [-Dependencies <String[]>]
    [<CommonParameters>]

Description

Use the Set-NAVAppManifest cmdlet to set properties on an in-memory manifest object. You can create the manifest object by using the New-NAVAppManifest cmdlet. You can then write the updated manifest object to disk by using the New-NAVAppManifestFile cmdlet. The manifest is required when creating the NAV App package file (.navx) using the New-NAVAppPackage cmdlet.

Examples

Example 1

New-NavAppManifest -Name "Proseware SmartApp" -Publisher "Proseware, Inc." -Description "First NAV App by Proseware" |
                    Set-NavAppManifest -Version 2.3.4.500 -CompatibilityId 2.0.0.0

                    AppId              : 00001111-aaaa-2222-bbbb-3333cccc4444
                    AppName            : Proseware SmartApp
                    AppPublisher       : Proseware, Inc.
                    AppDescription     : First NAV App by Proseware
                    AppBrief           :
                    AppVersion         : 2.3.4.500
                    AppCompatibilityId : 2.0.0.0
                    AppPrivacyStatement:
                    AppEula            :
                    AppHelp            :
                    AppUrl             :
                    AppLogo            :
                    AppScreenShots     :
                    Capabilities       : {}
                    Prerequisites      : {}
                    Dependencies       : {}

This example creates a new manifest with a few properties and then passes the created manifest to the Set-NAVAppManifest cmdlet in order to set the version and compatibilityId properties.

Example 2

Get-NAVAppManifest -Path '.\Manifest-Proseware SmartApp.xml' | Set-NavAppManifest -Version 2.3.4.500 -CompatibilityId 2.0.0.0 | New-NavAppManifestFile -Path ".\Manifest-Proseware SmartApp.xml" -Force

This example gets a manifest from file, sets the version and compatibilityId properties and then saves the updated manifest back to file. The -Force parameter overwrites the existing file.

Parameters

-Brief

Specifies the brief description for the NAV App.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AppBrief

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-CompatibilityId

Specifies the compatibility ID of the NAV App. The compatibility ID is a version string in the format of Major.Minor.Build.Revision. The value is used to indicate whether there are compatibility related code changes between different versions of the NAV App.

Parameter properties

Type:Version
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AppCompatibilityId

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Dependencies

Specifies the path to a package file (.navx) for another NAV App that this NAV App is dependent on. Use a comma (,) to separate the paths to multiple .navx files, such as in the following example: C:\Proseware\SmartAppBase.navx, C:\Proseware\ProsewareBase.navx

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Description

Specifies the description for the NAV App.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AppDescription

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Eula

Specifies a hyperlink to the NavApp End User License Agreement.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AppEula

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Help

Specifies a hyperlink to the NavApp help site.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AppHelp

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Id

Specifies the unique identifier for the NAV App. A unique identifier will be generated if a value is not provided. The same unique identifier should be used for each new version of the NAV App.

Parameter properties

Type:Guid
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AppId

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Manifest

Specifies the manifest object on which the properties are to be set by the cmdlet's parameter values.

Parameter properties

Type:NavAppManifest
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:1
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

Specifies the name of the NAV App.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AppName

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Prerequisites

Specifies the objects that must exist in order to deploy the NAV App to a NAV server instance. The prerequisites is a string in the format of type=ID, where type would include NAV object types like Table, CodeUnit, Page, etc. Use a comma (,) to separate the prerequisites. (example: Table=397, CodeUnit=78)

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PrivacyStatement

Specifies a hyperlink to the NavApp Privacy Statement.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AppPrivacyStatement

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Publisher

Specifies the publisher of the NAV App.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AppPublisher

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Url

Specifies a generic hyperlink.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AppUrl

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Version

Specifies the version of the NAV App. The version is a string in the format of Major.Minor.Build.Revision. The value should be incremented for each new version of the NAV App.

Parameter properties

Type:Version
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AppVersion

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.