DocGen Queue

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

Use the DocGen Queue option to deliver DocGen Packages A customizable package that consists of your Salesforce data, documents, and delivery configurations for documents you want to generate.. You can give users the option to send a DocGen Package output file to a custom object Salesforce says, "Custom records that allow you to store information unique to your organization.", which will send the document to a queue to be downloaded or be merged with other documents manually.

Add output documents to the DocGen Queue

You can add a DocGen Queue delivery from the DocGen Package wizard or the Delivery Options related list on a DocGen Package.

Add the DocGen Queue delivery option from the DocGen Package wizard

To add a DocGen Queue delivery option from the DocGen Package wizard:

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

  2. Click New.

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

    • DocGen Package Name

    • Type

    • DocGen Package Starting Object.

      For more information, see DocGen Packages.

  4. From Delivery Options, in Type, select DocGen Queue.

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

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

Add the DocGen Queue delivery option from the delivery option related list

To add or edit a DocGen Queue delivery option from the Delivery Option related list:

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

  2. Select a DocGen Package for which you want to add or edit a DocGen Queue 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 DocGen Queue and then click Continue.

    2. For an existing DocGen Queue delivery 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.
    For more information on the standard options, see Delivery Options.

  4. Click Save.

Use the DocGen Queue delivery option

Once you add the DocGen Queue delivery option to your DocGen Package, you can deliver documents to the DocGen Queue object.

To test the DocGen Queue delivery option:

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

  2. Select a DocGen Package that contains a DocGen Queue delivery option.

  3. Click Select Record, select the record, contact, and then select the DocGen Queue delivery option.

  4. Click Run DocGen Package.
    The app generates the document and applies any options you've specified in the DocGen Package.

    5. Note: You can download the document from the DocGen Queue object.

Access the DocGen Queue object

After you send an output document to the DocGen Queue, you must access the DocGen Queue to work with the output.

To access the DocGen Queue object:

Open Nintex DocGen, and then click DocGen Queue.

DocGen Queue object field reference

Section Field Description
Buttons Delivery Option Name Specify the name of the delivery option. The user who generates documents sees this name in the delivery option at runtime.
  Delete Deletes selected documents.
  Download 1 PDF Download selected document as PDF.
  Download by Type Merges selected documents by type and then makes merged files available for download.
  Download by Zip Downloads documents in a zip archive
Header row Selector check box Select the check box in the header row to select all documents.
  Action

Actions for managing single document requests:

  • Click Edit to work with meta data associated with a single document request.

  • Click Del to delete a single request.

  Document Request An Id generated automatically for each item in the queue.
  Document Name

Specifies the name of the output document.

 

Created Date

Specifies the date the document was generated.

Once a document in the DocGen Queue starts you can reference the progress of the document. Different statuses display depending on where in the document is in the generation process.

DocGen Queue status field reference

Status Description
Pending Job has been created but the documented has not finished being generated.
Completed Job has finished and the document has been attached to the DocGen Queue record.
Merged

One of the actions to deliver the documents has been taken to merge at least one of the files.

Example: You selected multiple Word files for sending that are now starting to merge, this status displays when at least one of the files has been merged.
Error The job encountered an error during the generation, sending, or merging processes.
Emailed The documents have been emailed from the queue.