Set-NAVAppManifest

Article
10/05/2015

Set-NAVAppManifest

Sets one or more available properties on an in-memory manifest for a Microsoft Dynamics NAV extension.

Syntax

Parameter Set: Default
Set-NAVAppManifest [-Manifest] <NavAppManifest> [-CompatibilityId <Version> ] [-Dependencies <String[]> ] [-Description <String> ] [-Id <Guid> ] [-Name <String> ] [-Prerequisites <String[]> ] [-Publisher <String> ] [-Version <Version> ] [ <CommonParameters>]

Detailed 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 you create the extension package file (.navx) using the New-NAVAppPackage cmdlet.

Parameters

-CompatibilityId<Version>

Specifies the compatibility ID of the extension. 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 extension.

Aliases	AppCompatibilityId
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Dependencies<String[]>

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

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Description<String>

Specifies the description for the extension.

Aliases	AppDescription
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Id<Guid>

Specifies the unique identifier for the extension. A unique identifier will be generated if a value is not provided. Use the same unique identifier for each new version of the extension.

Aliases	AppId
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Manifest<NavAppManifest>

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

Aliases	none
Required?	true
Position?	2
Default Value	none
Accept Pipeline Input?	true (ByValue)
Accept Wildcard Characters?	false

-Name<String>

Specifies the name of the extension, such as “Proseware SmartStuff".

Aliases	AppName
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Prerequisites<String[]>

Specifies the objects that must exist in order to deploy the extension to a Microsoft Dynamics NAV Server instance. List the prerequisites in a string in the format of type=ID, where type is a Microsoft Dynamics NAV object type such as Table, CodeUnit, or Page. Use a comma (,) to separate the prerequisites, such as Table=397, CodeUnit=78.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Publisher<String>

Specifies the publisher of the extension, such as your company name.

Aliases	AppPublisher
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Version<Version>

Specifies the version of the extension. The version is a string in the format of Major.Minor.Build.Revision. Increment the value for each new version of the extension.

Aliases	AppVersion
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

<CommonParameters>

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

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

Examples

-------------------------- EXAMPLE 1 --------------------------

Description

-----------

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.

PS C:\> 
          New-NavAppManifest -Name "Proseware SmartStuff" -Publisher "Proseware, Inc." -Description "First Extension by Proseware" |
          Set-NavAppManifest -Version 2.3.4.500 -CompatibilityId 2.0.0.0

          AppId              : 16f55eab-44d2-4428-8550-040b63308e72
          AppName            : Proseware SmartStuff
          AppPublisher       : Proseware, Inc.
          AppDescription     : First Extension by Proseware
          AppVersion         : 2.3.4.500
          AppCompatibilityId : 2.0.0.0
          Capabilities       : {}
          Prerequisites      : {}
          Dependencies       : {}

-------------------------- EXAMPLE 2 --------------------------

Description

-----------

This example gets a manifest from file, sets the version and compatibilityId properties and then saves the updated manifest back to file. By setting the Force parameter, the existing file is overwritten.

PS C:\> Get-NAVAppManifest -Path '.\Manifest-Proseware SmartStuff.xml' | Set-NavAppManifest -Version 2.3.4.500 -CompatibilityId 2.0.0.0 | New-NavAppManifestFile -Path ".\Manifest-Proseware SmartStuff.xml" -Force

Extending Microsoft Dynamics NAV Using Extension Packages

Set-NAVAppManifest