We're in the process of improving this site to make it more usable and helpful. Can't find something you're looking for? Access the old help site here.

DocGen Packages

Use DocGen PackagesA "package" consisting of data from Salesforce, your created template, and the output of where and how your documents will be delivered. to define relationshipsA link between one object and another, it also retrieves data that you can use to create documents. with your Salesforce data, create templatesA file in Salesforce Files or Libraries that is added to your document generation package. This file type is typically a Word file. When tags are added to this file, it becomes dynamic as data is merged from Salesforce and into the template. to generate documents based on that data, and determine where and how output documents will be delivered.

To create a DocGen Package, you need to complete four key steps: Data, Documents, Delivery, and Test.

Create a DocGen Package

  1. Navigate to the App Launcher by selecting the in the upper left corner, select Nintex DocGen.
  2. Select the DocGen Packages tab.
  1. Click the New button and follow the steps below.

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

1

Data configuration steps

The Data Tab holds the basic information for your DocGen Package, such as Name, Type, etc. See Data for more information.

  1. Enter in the necessary information for the Data tab:
  2. Field Description
    Name* The name of your DocGen Package.
    Type*

    The type of document you're generating. The options in this drop-down list include:

    • Quote
    • Proposal
    • Contract
    • Service Agreement
    • Legal Agreement
    • Letter
    • Account Plan Summary
    • Invoice
    • Reporting
    • Product Information
    • Other

    When the Other option is selected you can enter your custom type in a text box that appears.

    Description A field to describe your document.
    Make DocGen Packages Available On*

    The options below designates where you want your DocGen Package to be available:

    • Lists and Reports
    • Individual Records

    Select one or both of the options above.

    Starting Object*

    The starting object (e.g. Opportunity) that you are using for your DocGen Package.

    Require Contact Selection A check box that requires your user to select a contact.
    Filter

    Control the DocGen Packages that are displayed in the document generation page.

    Locale Add localesSalesforce will display the format for date and time, user names, addresses, and commas and periods in numbers based on the default currency for that country. to your DocGen Packages based on the origin of your Salesforce org.

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

  3. Click Save.

2

Documents configuration steps

The Documents tab holds information about your template details, such as template name, page range, etc. See Documents for more information.

  1. Enter in the necessary information for the Documents tab:
Field Description
Template Name* The name of your template. Although this field will automatically populate, you can make edits if necessary.

Include Template*

 

This indicates how and when you want your template to be included.

  • Always: This option will always include the template in the DocGen Package.
    • Enable or Disable the Available as Email Body for Delivery toggle if you want the file to be available in the body of the email when it is delivered.
  • Optionally: This option will allow the user to create an Alternative Document Label for End User.
  • Conditionally: This option will only include or exclude sections based on your selections.

Settings for Output

  • Start Page* - End Page*: The page range of your generated document. The default range is 1-100.
  • Pause to Edit: Select this check box to allow users to pause the document generation process and manually edit the document before delivery.
+ Add PDF Bookmark When clicked, the PDF Bookmark field appears. Add text or an image that is applied to the PDF output file (e.g. a watermark across the page).
Add Template Allows you to add additional templates from your existing files to your DocGen Package.

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

  1. Click Save.

3

Delivery configuration steps

The Delivery tab holds the information about your delivery options, such as output filename and delivery output type. See Delivery for more information.

  1. Enter in the necessary information for the Delivery tab:
Field Description
Output Filename* This is the name of the outputted document. You can insert tags in this field as well.
Convert Word Fields to Text Enable this option if you want to convert Word fields to text.

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

Select the delivery option you want your DocGen Package to be output in.

For more information, see Delivery Options.

  1. Click Save.

4

Test the DocGen package

The final step of creating your DocGen Package is to test it using the DocGen Package Tester. For more information, see Test DocGen Packages.

To view video tutorials on how to use this Nintex capability, take the Nintex Drawloop DocGen for Salesforce - Beginner course in Nintex University.

Edit a DocGen Package

  1. Navigate to the App Launcher by selecting the in the upper left corner, select Nintex DocGen.
  2. Select the DocGen Packages tab.
  1. Select the DocGen Package you want to edit and click the drop down arrow and then select Edit to make changes to any of the DocGen Package details.
  2. Click Save after you're done making edits.