Nintex Workflow

The Start Nintex Workflow delivery option allows you to post DocGen Package output and Salesforce data to a component workflow start action in Nintex Workflow.

How it works

You add a delivery option with a component workflow URL from Nintex Workflow to retrieve a form to add 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

Note: 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 start event for documents to be sent to Nintex Workflow. The collection variable creates a drop down box with the following two options in the delivery option:

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

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

For more information, see Nintex - Component workflow in the Nintex Workflow documentation.

Add Nintex Workflow delivery

You can add the Nintex Workflow delivery option from the Delivery tab for new or existing DocGen Packages.

  1. Create a new DocGen Package by following the steps in DocGen Packages or open an existing DocGen Package.
  2. Click the Delivery tab.

  3. Click Add Delivery Option.

  4. Click Nintex Workflow

  5. In Delivery Option Name, type a name (that the user running the DocGen Package will see), add a Document Output Type and then add Delivery Option details as required.

  6. In Nintex Component Workflow URL, paste the Nintex Component Workflow URL from Nintex Workflow and click Retrieve Inputs.

  7. Add inputs for the workflow.

  8. Click Save.

Note: The wizard offers access to the most common options for deliveries, but you must complete your configuration from the related list.

  1. Open Nintex DocGen, and click DocGen Packages.

  2. Click New.

  3. Under Basics, enter the required information.

  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 add Delivery Option details as required.

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

To add the Start Nintex Workflow delivery option from the delivery option related list:

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

  2. Select a DocGen Package for 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 add Delivery Option details as required.

  4. In Swagger URL, paste the URL from Nintex Workflow and click Retrieve Inputs.

    Note: If you're editing the delivery option, the field name is URL and you must click Edit to update.

  5. Add values for inputs to the workflow. For example, the delivery below has a Name field and a drop down box with Output Files selected. When a user generates documents, the 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 component workflow in Nintex Workflow.

To test the Start Nintex Workflow delivery option:

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

  2. Select a Record, Contact, and then select Nintex Workflow delivery. For more information on testing a DocGen Package, see Test DocGen Packages.

  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.