Introduction to document generation
Document generation utilizes a Documents connection and document packages to allow you, the apps designer the ability to add a document generation function to a page.
For example, let's say you are using a form for case management and need to generate a document for record keeping purposes. On this case management form you can add a button that users can click and quickly generate a document related to the information on that form automatically, with no need to manually type the data into the document. This generated document can then be sent off through email or routed through a workflow.
In order to generate a document you need to do the following:
-
Create a new page or use an existing page and add a Documents connection
-
Utilize the Documents connection to add document generation actions
Important document generation concepts
Before getting started generating a document, there are some important concepts related to document generation:
Document Package
A document package is where a document used for document generation can be uploaded and managed. Inside of the document package you can upload a document that can then be tagged with fields related to information on a form or from a connected data source through a model. The document package name is referenced by the document actions when generating the document to quickly grab the uploaded document and fill in the information related to the fields tagged in the document.
Document Connections and Models
Generating a document from a page requires the use of the Documents connection. The Documents connection contains:
-
Three document actions:
-
Generate Document
-
Download
-
Wait until Generated
-
-
Two models:
-
DocGen Instance (List)
-
DocGen Instance (Detail)
-
For more information on document actions and the models related to the Documents connection, refer to Document generation actions.
Nintex Apps documentation for reference
If you are new to apps, or looking for a reference for the different components that can be used in apps page design then refer to the following topics:
Document package permissions
Permissions for document generation can be broken down into two sets:
-
Designing document packages
-
Running document packages
Permissions
Permissions for document packages use the Nintex Workflow roles with the addition of the following permissions:
Permission | Participant | Designer | Developer | Automation administrator | Global administrator |
Design | |||||
Create/Edit/Delete Document Packages | X | X | X | X | |
Run | |||||
Run any package | X | X | X | X | X |
See my document package run history | X | X | X | X | X |
See anyone's document package run history | X | X | X | X | |
View/Download my generated documents | X | X | X | X | X |
View/Download anyone's generated documents | X | X |