Share via

Set-NAVAddIn

Module:
Microsoft.Dynamics.Nav.Management Module

Specifies the description, category, resource or resourcefile of an add-in that is registered in the system table 2000000069 Add-ins of the Business Central database.

Syntax

AddInResource (Default) 

Set-NAVAddIn
    [-ServerInstance] <String>
    -AddInName <String>
    -PublicKeyToken <String>
    [-Version <String>]
    [-Category <AddInCategory>]
    [-Description <String>]
    [-Resource <Byte[]>]
    [-Force]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

AddInResourceFile 

Set-NAVAddIn
    [-ServerInstance] <String>
    -AddInName <String>
    -PublicKeyToken <String>
    [-Version <String>]
    [-Category <AddInCategory>]
    [-Description <String>]
    [-ResourceFile <String>]
    [-Force]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Use this cmdlet to change the settings of an existing add-in the database.

Examples

EXAMPLE 1

Set-NAVAddIn -ServerInstance BC -AddinName MyNavAddin -PublicKeyToken 31bf3856ad364e35 -ResourceFile 'c:\addins\MyNavAddin.zip'

This example changes the MyNavAddin add-in that is registered in the system table 2000000069 Add-ins. The example specifies the add-in files that are contained in the MyNavAddin.zip file that is located in the folder path c:\addin, which can be used for automatic deployment of the add-in to the Business Central Server and clients.

Parameters

-AddInName

Specifies the name of the add-in that you want to change.

Parameter properties

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

Parameter sets

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

-Category

Specifies the category of the add-in. There are four categories that you can specify: DotNet Control Add-in, DotNet Interoperability, Javascript Control Add-in, and Language Resource.

Parameter properties

Type:AddInCategory
Default value:None
Accepted values:JavaScriptControlAddIn, DotNetControlAddIn, DotNetInteroperability, LanguageResource
Supports wildcards:False
DontShow:False

Parameter sets

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

-Confirm

Prompts you for confirmation before executing the command.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:cf

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 a description of the add-in for identification purposes.

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:True
Value from remaining arguments:False

-Force

Forces the command to run without asking for user confirmation.

Parameter properties

Type:SwitchParameter
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

-PublicKeyToken

Specifies a public token key of the add-in. The public key token is a 16-character key that is given to the add-in assembly when it is built and signed in Microsoft Visual Studio.

Parameter properties

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

Parameter sets

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

-Resource

Specifies a resource file for the add-in. the resource file can be used to stream the add-in to the Business Central Server instance.

Parameter properties

Type:

Byte[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

AddInResource
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-ResourceFile

Specifies the full path to a compressed file (.zip type) that contains the add-in assembly and associated files. The full path includes the drive, folders and file name. Use this parameter to set up the automatic deployment of the add-in files to Business Central Server instances instead of manually deploying the files.

Parameter properties

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

Parameter sets

AddInResourceFile
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments: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.

Parameter properties

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

Parameter sets

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

-Version

Specifies a version number for the add-in. The version number must have the format N.N.N.N, such as 8.0.0.0. This version number must match the version number that is assigned to the assembly.

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:True
Value from remaining arguments:False

-WhatIf

Describes what would happen if you executed the command without actually executing the command.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:wi

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.