Download

The Download Delivery method is the most common and default delivery method. For generated documents, the Download Delivery method will download the document to your computer.

Use the Download Delivery Method

  1. Create a new DocGen Package by following the steps in Generate documents from DocGen Packages
  2. Once you have created your DocGen Package, click the Delivery tab.
  3. In the Select Delivery Method or Storage Location window, click Download.

Note: You must complete any fields that are marked with an asterisk (*).

  1. Complete the required delivery option fields:
    1. Delivery Option Name*
    2. Document Output Type*
    3. Make DocGen Package Available On*
      • Lists and Reports
      • Individual Records

Note: There is a reference table below detailing the fields.

  1. Click Save.

Once the Download Delivery Method is set up, generated documents can be downloaded only by the user who ran the DocGen package, as well as authorized administrators and integration users. Other users cannot download the file, even if they have access to a DocGen download link. DocGen download links, including iFrame links are session‑ based and cannot be reused, bookmarked, or shared.

This behavior helps protect sensitive documents while continuing to support administrative and integration workflows. You may encounter error messages if you attempt to download a document without the required access or outside of the original session. See DocGen Package downloads return an error for more information.

Test the Download Delivery Method in the DocGen Package Tester

Once you add the Download delivery method to your DocGen Package, you can download your output to your computer after testing them.

  1. Navigate to the App Launcher by selecting app launcher in the upper left corner and select Nintex DocGen.
  2. Select the DocGen Packages tab.
  1. Select the DocGen Package that contains the Download Delivery Method.
  2. Select a Record to use to test run the DocGen Package.
  3. Select Download as the Delivery Option.
  4. Click Run Test or Run DocGen Package.
    • Nintex DocGen will generate the document as a PDF to download.
  1. To download the file, click it.

Delivery Options Reference fields

Field Description
Delivery Option Name* Specify the name of the delivery option. The user who generates documents sees this name in the delivery option at runtime.
Document Output Type*
  • Single PDF: Combine all documents into a single PDF so that the output will be a single PDF.
  • Separate PDF Files: Deliver separate PDFs.
  • Same as Original: Deliver individual files in the same format that the template used.
    • Track Changes in Word Docs: Enable this option to turn on the Track Changes feature in Microsoft Word.
  • Single PDF and Same as Original: Delivers a single PDF and individual files in the same format as the template used.
    • Track Changes in Word Docs: Enable this option to turn on the Track Changes feature in Microsoft Word.
Make Delivery Option Available On*

Select one or both of these options to choose where you want your DocGen Package to be available on.
Processing Options
  •  Automatically Process and Send: Send the processed DocGen Package without preview.
  •  On Screen and Auto Send: Show a process bar that displays the progress of the that is being created and then automatically send the DocGen Package.
  •  On Screen and Preview Before Sending: Show the process bar and preview the generated document.
    • Preview Step Help Text: This field appears if On Screen and Preview Before Sending is selected. The text that displays here will be a preview step during document generation.

Help Text

Type a note or hint for the delivery option you've configured and the hint will display at runtime.

Allow Document Storage Specifies that the user has the option to store documents.
Auto Send Specifies that output files should be automatically sent without a preview of the PDF output.
Display Order Specify the order in which your delivery options appear on the run DocGen Package page by putting a number in this field. The app displays delivery options in numerical order. If no number is specified, the app sorts delivery options alphabetically ahead of any other delivery option with a specified order number.
DocGen Package Specifies the name of the DocGen Package to which this delivery belongs. This field is required and only editable for new delivery options.
Limit Availability

  • Mass: Only specifies that this delivery option can be run by a user from a list view of records.

  • Non-Mass: Only specifies that this delivery option can only be run by a user from a single record.

  • Hidden: Specifies that this delivery option cannot be run from a list view or a single record.
Require Document Storage Specifies that the output files will automatically be attached to a storage solution.
Store As Specifies the storage option.
Turn Tracking On

Specifies that the Track Changes feature in Microsoft Word documents should be turned on.

Note: Turn Tracking On requires a Document Output Type set to Originals and Microsoft Word documents.
Wait for Document to Process Specifies that the users can bypass the process bar.

You must complete any fields that are marked with an asterisk (*).