Invoke cmdlets in SharePoint Subscription Edition

SharePoint Subscription Edition does not support the original Nintex Workflow cmdlets. If you use the cmdlets in SharePoint Subscription Edition, you may see error messages like:

Install-NFService: The term 'Install-NFService' is not recognized as the name of a cmdlet, function, script file, or operable program.

Use cmdlets in SharePoint Subscription Edition

To use the Nintex cmdlets in SharePoint Subscription Edition:

1. Make sure you have exported the NintexForSharePointSE folder.
2. Open PowerShell in Administrator mode.
3. Type cd followed by the path to the exported NintexForSharePointSE folder.
   For example:
   cd C:\Users\nf19-administrator\Downloads\NintexForSharePointSE
4. Type the invoke command for the cmdlet you want to use. See below for a list of commands.
   For example:
   .\InvokeCmdlet.ps1 -assemblyName 'Nintex.Forms.SharePoint, Version=1.0.0.0, Culture=neutral, PublicKeyToken=C52D764DCF7EC883' -typeName 'Nintex.Forms.SharePoint.PowerShell.Commands.Install'

Export the NintexForSharePointSE folder

This process only needs to be completed once. If you have already exported the NintexForSharePointSE folder, you can skip this step.

1. Find the Nintex Workflow for SharePoint Subscription Edition installer.
2. Double-click to execute the installer.
3. Click Next.
4. Click I agree.
5. Select the Export option.
6. Click Export.
7. Wait until the installer has completed the export.
   The installer creates a folder called NintexForSharePointSE in your selected location.

Syntax

.\InvokeCmdlet.ps1 -assemblyName 'Nintex.Forms.SharePoint, Version=1.0.0.0, Culture=neutral, PublicKeyToken=C52D764DCF7EC883' -typeName 'XXXXX'

Replace XXXX with the corresponding Typename from the table below.

Example

.\InvokeCmdlet.ps1 -assemblyName 'Nintex.Forms.SharePoint, Version=1.0.0.0, Culture=neutral, PublicKeyToken=C52D764DCF7EC883' -typeName 'Nintex.Forms.SharePoint.PowerShell.Commands.Install'

Typenames

Cmdlet	TypeName
Add-FormControl	Nintex.Forms.SharePoint.PowerShell.Commands.AddFormControlCommand
Add-InlineFunction	Nintex.Forms.SharePoint.PowerShell.Commands.AddInlineFunctionCommand
Create-NFDatabase	Nintex.Forms.SharePoint.PowerShell.Commands.CreateDatabase
Deactivate-NFOrphanedLiveAndMobileForms	Nintex.Forms.SharePoint.PowerShell.Commands.DeactivateOrphanedLiveAndMobileForms
Install-NFService	Nintex.Forms.SharePoint.PowerShell.Commands.Install
Remove-FormControl	Nintex.Forms.SharePoint.PowerShell.Commands.RemoveFormControlCommand
Remove-InlineFunction	Nintex.Forms.SharePoint.PowerShell.Commands.RemoveInlineFunctionCommand
Show-InlineFunctions	Nintex.Forms.SharePoint.PowerShell.Commands.ShowInlineFunctionsCommand
Show-RuntimeFunctions	Nintex.Forms.SharePoint.PowerShell.Commands.ShowRuntimeFunctionsCommand
Update-NFLicense	Nintex.Forms.SharePoint.PowerShell.Commands.UpdateLicense
Update-NFSiteId	Nintex.Forms.SharePoint.PowerShell.Commands.UpdateSiteIdCommand
Upgrade-NFMobileRelay	Nintex.Forms.SharePoint.PowerShell.Commands.UpdateMobileRelay
Upgrade-NFService	Nintex.Forms.SharePoint.PowerShell.Commands.Upgrade

Related information

PowerShell Reference

Nintex Forms 2013 SDK Reference

Add a Custom Inline Function with SharePoint 2013 Management Shell