Add-ins must be registered in table 2000000069 Add-ins before they can be used in a Microsoft Dynamics NAV client or on the Microsoft Dynamics NAV Server instance. The New-NAVAddin cmdlet creates an entry for the add-in in the table.
An add-in typically consists of one or more .NET Framework assemblies and support files.
These files must be installed either on the computer running the Microsoft Dynamics NAV Server or client. Instead of manually installing the add-in files, you can use the -ResourceFile parameter of the cmdlet to set up the system to automatically deploy the add-in the first time that it is requested. To do this, before you run the New-NAVAddin cmdlet, create a compressed (.zip type) file that contains the files (in the desired folder structure) that are associated with the add-in.
For an add-in to be deployed automatically, it must have the same name as the assembly that contains it.
This example registers an add-in of the DotNet Control Add-in category in the system table 2000000069 Add-ins.
The example also uploads the add-in files that are contained in the MyNavAddin.zip file that is located in the folder path c:\addin.
Parameters
-AddInName
Specifies the name of the add-in.
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
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 Microsoft Dynamics NAV 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 Microsoft Dynamics NAV 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 Dynamics NAV Server instance, for example, DynamicsNAV 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:
1
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.