Nintex Automation Cloud 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 Automation Cloud.
How it works
You add the delivery option, add and invoke the Swagger URL (from Nintex Automation Cloud) 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 Automation Cloud to start the workflow.
Setting up Nintex Workflow Cloud to accept output files
If you're working with a designer who has created the workflow in Nintex Automation Cloud, 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 Automation Cloud. 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 Automation Cloud documentation.
Add Start Nintex Automation delivery
You can add 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.
-
Open Nintex DocGen, and then click DocGen Packages.
-
Click New.
-
From Basics, enter required information in these fields:
-
DocGen Package Name
-
Type
-
DocGen Package Starting Object.
-
-
From Delivery Options, in Type, select Start Nintex Workflow.
-
In Name, type a name (that the user running the DocGen Package will see) and then configure any remaining fields for standard options.
-
On DocGen Package Templates, select or upload a template and click Save.
-
Select Nintex DocGen, and then click DocGen Packages.
-
Select a DocGen Package from which you want to add or edit a Start Nintex Automation Delivery Option, and on the Delivery Option related list, take one of the following actions:
-
Click New Delivery Option, from Type of new record, select Start Nintex Workflow and then click Continue.
-
From an existing Start Nintex Workflow, click Edit.
-
-
In Name, type a name (that the user running the DocGen Package will see) and then configure any remaining fields for standard options.
-
In Swagger URL paste the External Start URL from Nintex Automation Cloud 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 Automation Cloud.
-
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 Automation Cloud designer for what types of data to send to the workflow and whether to send output files.
-
Click Save.
Use Start Nintex Automation Delivery Option
Once you add the Start Nintex Automation Delivery Option to your DocGen Package, you can deliver documents and Salesforce data to a workflow on Nintex Automation Cloud.
-
To test the Start Nintex Workflow Delivery Option:
-
Select a DocGen Package that contains a Start Nintex Workflow Delivery Option.
-
Click Select Record, select the record, contact, and then select the Start Nintex Workflow delivery.
-
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.
-
Click Send to Nintex Workflow.