Create a document package

Before you can generate a document, you or the document package designer needs to create a document package within Nintex DocGen. A document package is a customizable package that contains a document template using data that you want to generate into a document. Here you can create a new document template or upload an existing template, and add tags to that document template.

Creating a document package consists of the following:

Create a new document package in Nintex Apps

To create a new document package in Nintex Apps:

  1. Open or log into your Nintex Workflow tenant.

  2. Select the Automate tab.

  3. Select the Documents option.

  4. Click Create package.

    Note: If this is the first time you are creating a new document package then the introduction screen displays, showing you an example of how to create a document package. If you close out of the dialog using the "X" button or click Do not remind me then this dialog will not display again until you clear the cache on the browser you are using.

  5. In the Document Package preview pane, select the Settings option. This opens the Settings pane.

  6. In the Settings pane, type in the desired name for the document package in the Package name field.

    Note: The package name defaults to the name of the user currently creating the package and the date and time of creation. It is highly recommended to name this package based on the document and data contained within the package, as the package name will need to be referenced later when creating a document action flow.

  7. You can also rename the generated output file by changing the name in the Output package name field.

    8. Caution: The maximum number of characters is limited to 200. If your file name is larger than 200 characters then the name of the fie will be truncated down to reach the 200 character limit.

  8. Click Save to save the document package.

Add field tags to the document package using the Tagger

Once a document package has been created, you can start adding field tags to the document package. Tags are placeholders for data that is related to the page the document is being generated from. Tags can then be copied and pasted into your document using the Tagger.

For example, let's say you want to generate a document that contains the following information:

  • Client's name

  • Client address

  • Company name

  • Case ID number

In order to generate a document with the above data you need to add those fields to the document using tags created in the Tagger. Once the document is generated that data is filled in automatically, without the need to manually enter data each time you wanted to generate the document.

To add tags to the document package:

  1. In the document package preview pane click Tagger. This displays the Tagger pane.

  2. Left-click in the Tags field, and type in the desired name of the tag.  For example, using the desired information above you would type in "Client's Name".

  3. Click Add. Once you add the tag it appears in the Tags section, along with the ability to copy the tag.

  4. Continue to add in the desired tags to the document package.

  5. Once all of the tags have been added, click Save.

  6. Click the copy button next to the desired tag to add to the document. Only one tag can be copied at a time.

  7. Open the document that is going to be uploaded to the document package.

    Tip: If you have a screen large enough you can use the Windows functionality to display the Tagger on one side of the screen and have the document open on the other side of the screen. That way you can easily copy each tag and add it into your document.

  8. Paste each tag into the desired location of the document. For example, the clients name and address might go into the top-left hand corner of the document. See the example below to see a document with the tags added in.

  9. After adding in all of the desired tags, save the document. You will then need to upload this document to the document package.

Upload a document to the document package

After creating the document package, and adding in the desired tags, you can now upload an existing document template for the document that is going to be generated, or create a blank template that can be used to create a new template.

To upload an existing document template:

  1. Left-click drag the file from its current location onto the text box in the document package preview pane. Once the document has been loaded click Upload.

    or

  2. Click the Select file option and browse to the location of the document. Select the document and wait for the document to get added to the preview pane. Once the document has been loaded click Upload.

To create a blank template:

  1. Click +Create template from the welcome screen.

    or

  2. From the Settings menu click +Create template.

Note: The +Create template button cannot be used if a template is already uploaded to the document package.

Once a document has been uploaded you can then view that uploaded document by clicking the Settings option.  The newly uploaded document appears in the Settings pane under the Document templates section.

Once uploaded you have three options available by clicking the ellipsis icon next to the document name:

  • Replace: This replaces the document with a new document, without the need to create a new document package. This is a useful option for those who want to continue to use the same document package but need to replace the current document because some adjustments have been made to the document, or a new document has been created. By replacing the document you will not need to then change the document package in the Generate document action flow.

  • Download: Allows you to download the document to make any changes needed to the document.

  • Delete: Deletes the document from the document package.

Editing and replacing a document

Currently in order to make changes to an existing document uploaded to a document package you need to download the document and then delete the existing document. Once you have made the desired changes you can then re-upload the document.

To edit and replace a document:

  1. Locate the document you want to download from the Settings menu.

  2. Click the ellipsis icon and download the document.

  3. In the same ellipsis menu delete the current document.

  4. Make the desired changes to the document and save the document.

  5. Re-upload the document the document package.

  6. Click Save to save the document package.