New-NAVAddIn
New-NAVAddIn
Registers an add-in the system table 2000000069 Add-ins of the Microsoft Dynamics NAV database.
Syntax
Parameter Set: AddInResource
New-NAVAddIn [-Force] [-Resource <Byte[]> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: __AllParameterSets
New-NAVAddIn [-ServerInstance] <String> -AddInName <String> -PublicKeyToken <String> [-Category <AddInCategory> ] [-Description <String> ] [-Force] [-Version <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: AddInResourceFile
New-NAVAddIn [-Force] [-ResourceFile <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
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.
Parameters
-AddInName<String>
Specifies the name of the add-in.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Category<AddInCategory>
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Description<String>
Specifies a description of the add-in for identification purposes.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Force
Forces the command to run without asking for user confirmation.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-PublicKeyToken<String>
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.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Resource<Byte[]>
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ResourceFile<String>
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ServerInstance<String>
Specifies the name of a Microsoft Dynamics NAV Server instance to connect to. The default instance name is DynamicsNAV90. You can specify either the full name of an instance (such as MicrosoftDynamicsNavServer$myinstance) or the short name (such as myinstance).
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue, ByPropertyName) |
Accept Wildcard Characters? |
false |
-Version<String>
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. 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 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.
PS C:\> New-NAVAddIn -ServerInstance DynamicsNAV90 -Category dotnetcontroladdin -PublicKeyToken 31bf3856ad364e35 -ResourceFile 'c:\addins\MyNavAddin.zip'