Nintex Workflow Delivery

This feature is not yet supported in the Lightning Experience DocGen Designer.

The Start Nintex Workflow delivery option allows you to post DocGen Package output and Salesforce data to an external start action running in Nintex Workflow.

How it works

You add the delivery option and then add and invoke the Swagger URL (from Nintex Workflow), which retrieves a form for adding the data required to run the workflow. You configure the form and when users run the DocGen Package, any output documents or data in the delivery option is sent to Nintex Workflow to start the workflow.

Setting up Nintex Workflow to accept output files

If you're working with a designer who has created the workflow in Nintex Workflow, you can skip this section.

If you're designing the workflow, add a collection variable to the External start action to send documents to Nintex Workflow. This collection creates a drop down box in the delivery option. The drop down box has two options:

  • None specifies that no output files should be sent to the workflow.

  • Output files specifies that all output files should be sent to the workflow.

For more information, see Include files when starting external start workflows in the Nintex Workflow documentation.

Add Start Nintex Workflow delivery

You can add the Start Nintex Workflow delivery option from the DocGen Package wizard or the delivery options related list on a DocGen Package. The wizard offers access to the most common options for deliveries, but you must finish your configuration from the related list.

  1. Open Nintex DocGen, and then click DocGen Packages.

  2. Click New.

  3. From Basics, enter required information in these fields:

    1. DocGen Package Name

    2. Type

    3. DocGen Package Starting Object.

  4. From Delivery Options, in Type, select Start Nintex Workflow.

  5. In Name, type a name (that the user running the DocGen Package will see) and then configure any remaining fields for standard options.

  6. Under DocGen Package Templates, select or upload a template and click Save.

  1. Select Nintex DocGen, and then click DocGen Packages.

  2. Select a DocGen Package from which you want to add or edit a Start Nintex Workflow delivery option, and on the delivery option related list, take one of the following actions:

    1. Click New Delivery Option, from Type of new record, select Start Nintex Workflow and then click Continue.

    2. For an existing Start Nintex Workflow option, click Edit.

  3. In Name, type a name (that the user running the DocGen Package will see) and then configure any remaining fields for standard options.

  4. In Swagger URL paste the External Start URL from Nintex Workflow and click Retrieve Inputs. If you're editing the delivery option, the field name is URL and you must click Edit to update.

    You must have an External start URL from Nintex Workflow.

  5. Type values into the fields retrieved by the API call in the previous step. For example, the delivery below has a Name field and a drop down box with Output Files selected. When a user generates documents, output file and the contact name for the record will be sent to the workflow.

    Check with your Nintex Workflow designer for what types of data to send to the workflow and whether to send output files.

  6. Click Save.

Use the Start Nintex Workflow delivery option

Once you add the Start Nintex Workflow delivery option to your DocGen Package, you can deliver documents and Salesforce data to a workflow on Nintex Workflow.

To test the Start Nintex Workflow delivery option:

  1. Select a DocGen Package that contains a Start Nintex Workflow delivery option.

  2. Click Select Record, select the record, contact, and then select the Start Nintex Workflow delivery.

  3. Click Run DocGen Package.

    The app generates the document, applies any options you've specified in the DocGen Package, and gives you an opportunity to inspect the generated files before you send.

  4. Click Send to Nintex Workflow.