Install the configuration page and image files into the Layouts mapped folder

The configuration page and image files used by a custom workflow action are identified in the action definition file and are typically stored under the \NINTEXWORKFLOW\CustomActions folder, in the Layouts mapped folder for the SharePoint 2013 farm.

Typically, the folder structure is added to the workflow action adapter project in Visual Studio, when creating the configuration page for the custom workflow action. If you used the Visual Studio templates included with the Nintex Workflow 2013 SDK, the Layouts mapped folder is already included in the workflow action adapter project. Otherwise, you must manually add the Layouts mapped folder to that project. For more information about adding the Layouts mapped folder to the workflow action adapter project in Visual Studio, see How to: Add and Remove Mapped Folders.

After adding the Layouts mapped folder to your workflow action adapter project in Visual Studio, use the following recommended folder structure, replacing <Layouts> with the path to the Layouts mapped folder for the SharePoint 2013 farm and <ActionFolder> with the name of the folder for the custom workflow action:

• <Layouts>\NINTEXWORKFLOW\CustomActions\<ActionFolder>

  The ASP.NET page (.aspx) and codebehind (.aspx.cs) files for the configuration page are stored in this folder.

• <Layouts>\NINTEXWORKFLOW\CustomActions\<ActionFolder>\Images

  The image files for the custom workflow action, including the image files for the icon, toolbox icon, and warning icon, are stored in this folder.

Caution: Ensure that the folder structure used for the custom workflow action matches the relative paths specified in the ConfigurationDialogUrl, Icon, ToolboxIcon, and WarningIcon elements of the action definition file.

There are two recommended options for installing the configuration page and image files for the custom workflow action into the Layouts mapped folder in SharePoint 2013:

• Windows Installer

  You can create a Windows Installer package in Visual Studio for the custom workflow action, to create the necessary folder structure and copy the configuration page and image files into the Layouts mapped folder for the SharePoint 2013 farm.

  If you use Windows Installer, ensure that you perform both this step and the previous step with the same Windows Installer package. For more information about the previous step, see Install the assemblies into the Global Assembly Cache.

  Tip: Use this option for testing or production purposes. This option is recommended for installing assemblies into production installations.

  For more information about creating a Windows Installer package in Visual Studio, see Windows Installer Deployment.

• Manually copying files into the Layouts mapped folder

  You can use any file manipulation tool, such as Command Prompt or File Manager, to create the necessary folder structure and copy the configuration page and image files into the Layouts mapped folder for the SharePoint 2013 farm.

  Caution: Use this option for testing purposes only. This option is not recommended for installing assemblies into production installations.

See Also

Concepts

Configuration pages

Action definition files

Operations

Deploying workflow actions with Nintex Workflow Management

Working with configuration pages

Reference

Action Definition File XML Reference