Home > Nintex Workflow 2013 Help and How-to > Workflow Actions
Document Generation

​​​​

Generates one or more documents using selected templates, table data, and images.

The following document output formats are supported: .docx, .pptx, xlsx, pdf.

This action includes settings for Document Templates, Table Data, and Images.

Document Templates settings

Add and tag templates to dynamically generate documents based on workflow data.

Section

Field

Description

Document Templates Generation type

Format of the set of files generated by this action. Choose one of the following options.

  • (Default) Single PDF file (20 template limit): Generates and merges all document templates into a single PDF, regardless of the original template format. Supports a maximum of 20 templates.

  • Separate PDF files (5 template limit): Generates separate PDF documents based on the selected merge type. Supports maximum of 5 templates that corresponds to 5 output files.

  • Original file types (5 template limit): Generates documents based on the file type of the original document template. For example, if the template format is .docx, the generated document will be .docx. Supports maximum of 5 templates that corresponds to 5 output files.

Order The sequence in which to include the templates in the generated output.
Document template

Select or create new template: Displays the Select or create a document template dialog box for selecting an existing template or creating a new file. For more information, see Select or create new template dialog box.

Merge

(Microsoft PowerPoint and Microsoft Excel only) When enabled, combines templates together. Only available for consecutive template with the same file type.

Merge type

(Microsoft Word only.) Combines templates together. Only available for consecutive template with the same file type.

Choose one of the following options.

  • No merge (Default): Templates are individually outputted.

  • Continuous section: Templates merged with no break between documents.

  • Page break: Templates merged with a page break separating each document.

  • Section page break: Templates merged with a section break (next page) separating each document.

  • Paragraph break: Templates merged with a single line space separating each document.

  • Line break: Templates merged with a line break separating each document.

Include document template

Decide whether or not to conditionally include the template. Choose one of the following options.

  • Always: Always include the template.

  • Based on condition: Include the template only when the condition is true.

    Field descriptions

    Where: Define a condition using two values and an operator.

    • First value (unlabeled): Select Value or a lookup option, then select an item or specify a value.

      You can manually specify the value or build the value dynamically at run time using  (Insert Reference). For more information on lookups, see Using lookups and Lookups reference.

    • Operator (unlabeled): Select an operator.

      List of operators

      • equals
      • not equals
      • is empty
      • is not empty
      • begins with
      • does not begin with
      • ends with
      • does not end with
      • contains
      • does not contain
      • matches regular expression
      • equals (ignoring case)
      • contains (ignoring case)
    • Second value (unlabeled): Select Value or a lookup option, then select an item or specify a value.

      You can manually specify the value or build the value dynamically at run time using  Insert Reference. For more information on lookups, see Using lookups and Lookups reference.

    Add condition: Add a condition with one of the following logic options.

    • And: To return TRUE, both the previous evaluation result and the current condition must be TRUE. If either the previous evaluation result is FALSE or the current condition is FALSE, then FALSE is returned.
    • Or: To return TRUE, either the previous evaluation result or the current condition must be TRUE. If both the previous evaluation result is FALSE and the current condition is FALSE, then FALSE is returned.

      Note: Conditions are evaluated from top to bottom.

    Delete: Delete the indicated condition. Displayed for second and subsequent conditions.

Open and tag

Launches the Nintex Document Tagger.

 

Option to edit the specific template.

 

Option to delete the specific template.

Output file name

The file name of the indicated document to be generated by this action (corresponding to either a single template or to all templates).

Output file name depends on Generation type and Merge type. For example, if you select Original file type for Generation type and No merge for Merge type, then 5 output file names are displayed.

Add document template

Displays selections for adding another template.

Output

Output location

The location of all documents generated by this action. Choose one of the following options.

  • Document library / (selected location): Stores generated documents in the specified location. Click Select a document library or folder to display the Select a document library or folder dialog box. For more information, see Select a document library or folder dialog box.

  • Enter a URL: Stores generated documents at the absolute URL.

    You can manually specify the value or build the value dynamically at run time using  (Insert Reference). 

  • Attach to current item: Attaches generated documents to the list item on which the workflow is running. Only usable for list workflows.

Output file URL

The variable to store the URL location of all documents generated by this action.

The required variable type depends on the number of documents to be generated. A text variable is required for a single document while a collection variable is required for multiple documents.

Overwrite existing item

When enabled, for each document generated by this action, overwrites the current document. When disabled and a document of the same name exists, date and time is applied to the end of the file name.

Table Data settings

Create tables containing collection variables to dynamically replicate rows, tables, and sections

Field

Description

Table name The name of the table as it appears in the table section of the Nintex Document Tagger. Dynamically generates tables from collection variables, which can be inserted as tags into a template.
Repeated format type

The dynamic repeating format applied to tables in tagged templates. Choose one of the following options.

  • Row: Creates a new table row for reach row in the corresponding workflow collection variable. Supports template types: .docx, .pptx, and .xlsx.

  • Table: Creates a new table for the corresponding workflow collection variables. Supports template types: .docx and .pptx.

  • Section: Creates a new section for the corresponding workflow collection variables. Supports template type: .docx only.

Column (number) The collection variable to use for the specific table column in document generation.
Data type in column (number)

The format to apply to the column in documents generated from tagged templates. The following options are available.

  • String: Line of text.

  • Int​eger: Whole numbers only.

  • Number: Decimal numbers supported.

  • Date: Date only.

  • Date & Time: Date and time. Dynamic; can be changed in the Nintex Document Tagger.

  • Image URL: Displays the image from the URL in the referenced list column. The column must be of type Hyperlink or Picture. Supported file types: JPG, GIF, and PNG.

    Note: Supported repeated format types: row and table repetition for .docx,  table repetition for .pptx.

Add column

Displays selections for adding another column to the table currently being edited. The selections for each column are numbered in the sequence in which they are added. For example, the selections for the second column are labeled "Column 2" and "Data type in column 2." Add a column for every table tag you want available in your templated

 

Option to edit the specific table.

 

Option to delete the specific table.

Add table

Displays selections for adding another table.

Images settings

Define an image URL to insert into the generated document. Maximum of 10 images in the following supported file types: JPG, GIF, and PNG.

Field

Description

Image tag name The tag name of the image as it appears in the Images section of the Nintex Document Tagger.
Image URL SharePoint or publicly acceptable URL for the image file.

 

Option to edit the specific image.

 

Option to delete the specific image.

Add image

Displays selections for adding another image.

How to find, add, and configure actions

You can browse and search for actions. You can add a workflow action to a drop zone in your workflow by either dragging it from the toolbox or inserting it using the drop zone context menu. And finally, you can configure actions by either double-clicking the action or using the action context menu.

To browse actions

  • In the Actions toolbox, click the relevant tab and expand the relevant group.

To search for actions

  • In the Actions toolbox, in the Search text box at the top of the Actions toolbox, type one or more keywords.

To change configuration settings for an action, do one of the following

  • Click the arrow to the right of the action label and then select Configure.
  • Double-click the action.


​For additional information, see the Nintex for SharePoint 2016 help at the following link.
https://help.nintex.com/en-US/nintex2016/current/​#cshid=8433
​​

Document Generation