DocGen Packages

Use DocGen Packages A customizable package that consists of your Salesforce data, documents, and delivery configurations for documents you want to generate. to define relationships Salesforce says, "A connection between two objects, used to create related lists in page layouts and detail levels in reports." with your Salesforce data, create templates A document/file that can be added to a DocGen Package. Data can be filled into the document/file. 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 app launcher 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 locales The format of date and time, number, and currency format that's specific to a country or region. to your DocGen Packages based on the origin of your Salesforce org.

    You must complete any fields that are marked with an asterisk (*).
  2. 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:
    2. 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.
    • Filter Parameter: Use this field to filter data that is brought through on a report.
    + 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 (*).

  2. Click Save.

  1. Click Ad Hoc Files.
    • Allowed: Select this option if you want the additional documents to be optional.
    • Required: Select this option if you want the additional documents to be required.
  2. 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:
    2. 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 (*).
  2. Select the delivery option you want your DocGen Package to be output in.
  3. Click Save.
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 DocGen Package 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.

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

For more information, see Delivery Options.

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 watch video tutorials on how to use this Nintex capability, take the CERT: Nintex Document Generation Practitioner - Nintex DocGen for Salesforce in Nintex University.

Edit a DocGen Package

  1. Navigate to the App Launcher by selecting the app launcher 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.

 

Clone a DocGen Package

Duplicate an existing DocGen Package with the Clone button, and then customize the clonedDocGen Package settings to suit your needs.

  1. Navigate to the DocGen Packages tab in Salesforce.

  2. Select a DocGen Package that you want to clone.

  3. In the upper-right corner, click the drop-down arrow to access the overflow menu.

  4. In the overflow menu, click the Clone button.

The cloned DocGen Package will open in edit mode. Adjust the name of the DocGen Package and any other information as needed.

Note: Any templates selected in your DocGen Package are not cloned in this process. Just the DocGen Package will be cloned.