Manage templates in DocGen Packages

Here you'll learn how to add, edit, and manage templates in your DocGen Package A customizable package that consists of your Salesforce data, documents, and delivery configurations for documents you want to generate.. By default, Nintex DocGen includes all template A document/file that can be added to a DocGen Package. Data can be filled into the document/file. files from your DocGen Package in your output document. You can configure desired templates or have files dynamically added to your output document based on the state of your Salesforce data.

To watch video tutorials on how to use this Nintex capability, take the CERT: Nintex Document Generation Expert - Nintex DocGen for Salesforce in Nintex University.
Before you start 

See Supported template file types for more information.

Add templates to a DocGen Package

There are two ways to add your template to a DocGen Package:

Option 1: Upload your template to Salesforce before adding it to a DocGen Package.

Before you add a template to a DocGen Package with option 1, you must first upload your template document to Salesforce files. Then, create a Salesforce Library to store your template documents and ensure that your users have access to it. See Upload and Share Files in the Salesforce help.

Now you're ready to perform the following in a DocGen Package:

  1. Open or Create a DocGen Package.
  2. Select the Documents tab.
  3. Click Add Template.
  4. Do one of the following methods:
    • Method 1 - Select a template by navigating through a folder structure: Under LOCATION, open the required folder, select the document, and click Select. The template is added to your DocGen Package.

      • You can also select a template from Office 365. If you don't see the Office 365 folder under Location, you'll need to configure Office 365. See Integrations.

    • Method 2 - Select a template by searching existing files: Type a file name in the Search Files field and click Search. Your file displays. Click the file that you want and click Select. The template is added to your DocGen Package.

Option 2 - Add the template directly from a DocGen Package.

Add a template without having to first upload a file to Salesforce as described in option 1.

  1. Open or Create a DocGen Package.
  2. Select the Documents tab.
  3. Click Add Template.

  4. Do one of the following:

    • Click Upload Files and select the file from your computer.
    • Drag a file from your computer and drop it into the Or drop files space or over the Upload Files button.

    The Upload Files dialog box appears and shows the upload progress.

  5. After the upload is complete, click Done. The Select Template Location dialog box appears.
  6. Select a location to add the file to and click Select Template Location. You can also store your template within sub folders.

    7. The template is added to the DocGen Package.

Edit template details in a DocGen Package

Once your template is added to your DocGen Package, you can edit the DocGen Package details:

  1. Open a DocGen Package that has a template uploaded to it.
  2. Select the Documents tab.
  3. Do one of the following to edit a DocGen Package:
    • Click Down arrow and select Edit.
    • Select Edit next to the field you want to edit in the package.
  4. Make required edits in the fields. By default, the template name is saved as the name of the document. Note that file names remain the same until changed. Renaming documents can help you better manage your DocGen Packages and understand what the template is used for.
  1. Click Save.

Remove templates from a DocGen Package

If you've added the wrong template to your DocGen Package, you can easily remove it:

  1. Open a DocGen Package that has a template uploaded to it.

  2. Select the Documents tab.
  3. Click Down arrow and select Remove.
  4. On the Remove Template message, click Remove to confirm.

Reorder templates in a DocGen Package using Sort Mode

If you have multiple templates in a DocGen Package, you can enable Sort Mode to reorder templates in the order that you want them to appear in DocGen Package run output. Follow these steps to reorder your templates using Sort Mode.

  1. Open a DocGen Package that contains multiple templates.
  2. Click the Documents tab.
  3. Do one of the following to enable Sort Mode and reorder the templates:
    • Click Down arrow > Enter Sort Mode. Then, drag and drop a template in the order that you'd like it to appear in the DocGen Run output. Once the template is dropped into place, the new template order immediately saves with message, "Item moved successfully."

    • Click Drag and drop on a template and drag and drop the template into a new order. This automatically enables Sort Mode. The new template order immediately saves with message, "Item moved successfully."
  4. (Optional) Click Exit sorting to return to a detailed view of each template and to make additional configurations and changes if needed.

 

Pause template delivery to edit the file

You can configure the Pause to Edit feature which allows you to pause the template delivery so that you can manually edit the file before Nintex DocGen sends the final output document to the recipient.

Although you can configure the pause template delivery feature in the Lightning Experience DocGen Designer, the pause template delivery is not yet supported in the DocGen Lightning Component or the Test DocGen Package feature.
  1. Open a DocGen Package that has a template uploaded to it.
  2. Click the Documents tab.
  3. Select Edit next to the Pause to Edit check box, then select the check box.
  4. Click Save.
  5. Run the DocGen Package from a button.
    Note that if you run the DocGen Package in the DocGen Lightning Component or Test DocGen Package feature, the template delivery will not pause.
  1. When prompted, download the document and make your edits.
  2. Re-upload the document to your Salesforce files and Library and ensure that your user has access to it.
  3. In the Documents tab, replace the document with the edited version by clicking New window in the File box.
    4. A new screen opens in the Classic Experience.
  4. Replace the document by clicking Replace Document.

Merge multiple template files into a single output file

You can merge Microsoft Word, Microsoft Excel, and Microsoft PowerPoint template files into one single output with a DocGen Package. By merging multiple template files into one allows you to be able to make several documents optional, but still include them in a single document.

Merge Microsoft Word documents

Merging Microsoft Word files in a DocGen Package allows you to break up a document into different sections and make them optional as needed. The output will be in Microsoft Word format.

  1. Create the Microsoft Word document on your computer.
  2. Once the documents have been created, upload them to a public folder on Salesforce.
    3. For more information on how to add files to Salesforce, see Add templates to a DocGen Package.
  1. Navigate to the App Launcher by selecting in the upper left corner and select Nintex DocGen.
  2. Select the DocGen Packages tab.
  3. Open the DocGen Package you want to merge the Microsoft Word templates with.
  4. Once the DocGen Package is open, select the Documents tab.
  5. Click Add Template.
  6. Select the .docx file from the corresponding location in your Salesforce files.
  7. Click Edit in Merge Type and select the Merge Type that you need.
  8. Click Save.
  9. Repeat steps 5 to 10 to add more .docx files to your templates.
Option Description
No Merge A merge will not occur.
Continuous Inserts a section break and starts the new section on the same page.
Page A page break will force everything after the break onto a new page.
Section Page A next page section break firstly marks a section break in the document (which are very important when working with headers, footers, and other page formatting features), and also starts a new page, just like a page break.
Paragraph Starts a new paragraph.
Line Break Breaks to the next line.
Column A column break will force everything after the break into the next column.
Even Even page inserts a section break and starts the new section on the next even-numbered page.
Odd Odd page inserts a section break and starts the new section on the next odd-numbered page.
Text Wrap Specifically for web pages and blog entries, a text wrapping break separates text around objects, such as caption text from body text.
None Insert no breaks and merges at the end of the first file.
  1. Complete one or all of these optional steps:
    • Indicate the Start Page number and End Page number for the output. The default page range is 1-100.
    • Select the Pause to Edit check box if you would like to edit the template before delivery.
      For more information on Pause to Edit, see Pause template delivery to edit the file.

  1. Click Save.

    Note: The Sort with Previous option is currently not available in the Lightning Experience.

Merge Microsoft Excel documents

  1. Create the Microsoft Excel document on your computer.
  2. Once the documents have been created, upload them to a public folder on Salesforce.
    3. For more information on how to add files to Salesforce, see Add templates to a DocGen Package. .

  1. Navigate to the App Launcher by selecting the in the upper left corner and select Nintex DocGen.

  2. Select the DocGen Packages tab.
  3. Open the DocGen Package you want to add an Excel document to.
  4. Once the DocGen Package is open, select the Documents tab.
  5. Click Add Template.
  6. Select the .xlsx file from the corresponding location in your Salesforce files.
  7. Click the Edit in Merge with Previous section.
  8. You can keep the Template Name as is or edit to change it.
  9. Indicate whether you want to include the template:
    • 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.
  10. Check the box for Merge with Previous to merge with a previous Microsoft Excel file.
    11. For merging Microsoft Excel files, you can only select the merge with previous option. This option inserts all sheets included in the newly added Microsoft Excel file with the previous Microsoft Excel file in the DocGen Package.

  1. Indicate the Start Page number and End Page number for the output. The default page range is 1-100.

  2. Insert a PDF Bookmark in the PDF output of your generated document.
  3. Check the Pause to Edit box if you would like to edit the template before delivery.
    4. For more information on Pause to Edit, see Pause template delivery to edit the file.
  1. Click Save.

Note: The Sort with Previous option is currently not available in the Lightning Experience.

Merge Microsoft PowerPoint documents

  1. Create the Microsoft PowerPoint document on your computer.

  2. Once the documents have been created, upload them to a public folder on Salesforce.

    3. For more information on how to add files to Salesforce, see Add templates to a DocGen Package.

  1. Navigate to the App Launcher by selecting the Menu in the upper left corner and select Nintex DocGen.

  2. Select the DocGen Packages tab.
  3. Open the DocGen Package you want to add an Excel document to.
  4. Once the DocGen Package is open, select the Documents tab.
  5. Click Add Template.
  6. Select the .pptx file from the corresponding location in your Salesforce files.
  7. Click the Edit in Merge with Previous section.
  8. You can keep the Template Name as is or edit to change it.
  1. Indicate whether you want to include the template:
    • Always: This option will always include the template in the DocGen Package.
    • 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.
  2. Check the box for Merge with Previous to merge with a previous Microsoft PowerPoint file.
    3. For merging Microsoft PowerPoint files, you can only select the merge with previous option. This option inserts all sheets included in the newly added Microsoft PowerPoint file with the previous Microsoft PowerPoint file in the DocGen Package.
  1. Indicate the Start Page number and End Page number for the output. The default page range is 1-100.
  2. Check the Pause to Edit box if you would like to edit the template before delivery.
    For more information on Pause to Edit, see Pause template delivery to edit the file.
  1. Click Save.

Note: The Sort with Previous option is currently not available in the Lightning Experience.