Table of Contents
Overview
A Print Process is a collection of individual print tasks (i.e. multiple documents) that will cumulatively be utilized in order to produce a single print output.
Adding a Print Document
In order to add a new document to an existing print process, simply select the Add button above the documents list. The two required properties are:
- Document Name: A friendly name that will help you identify the document in the future. This is not utilized within the system for anything.
- Document File: The Word-based document that will act as a template for the document generation. This document should include stubs if you expect to inject content dynamically in the document.
Note: The file type must be a *.DOCX file for the system to be able to process it appropriately.
What is a Document Stub?
A document stub is a specifically formatted string token that is placed inside of a Word document with the intention of acting as a placeholder for other content, which will likely be output generated by the Excel model or input entered by the user from the web interface.
A stub takes the following form: {{ HelloWorld }}
. A stub is distinguished by the double curly brackets enclosing it on either side. The document stub name
is the value inside the double curly brackets - in this example, the stub's name is HelloWorld
.
Document stubs can have the following types:
- Text: A string value with the stub format somewhere in your Word-based template document.
- Image: A string value with the stub format placed at the Alt Text property of an image in your Word-based template document.
To create a Text stub, simply add a string value with the stub format somewhere in your Word-based template document. For example, you may have a financial planning tool that should generate a document beginning with the following:
Dear Jim,
Thank you for the opportunity to assist you in assessing your financial plan [...]
However, each individual that uses your financial planning tool will not be named 'Jim'. As a result, your template will need to consider the first name as a piece of dynamic content that will be updated based on the user's first name entry. A document stub should be inserted as such:
Dear {{ FirstName }},
Thank you for the opportunity to assist you in assessing your financial plan [...]
Upon upload to the system as part of a print process, this document stub will be detected with the name FirstName
. You can also utilize the same stub numerous
times throughout your document template if you have need of showing the same value repeatedly.
Note: The name of the document stub does not need to match any named ranges in the system since you will be able to map document stubs to corresponding named ranges in the Edit Document Stubs page. However, using stubs with names corresponding to named ranges will make the mapping process easier, since the system will auto-detect corresponding names and automatically associated them.
To create an Image stub, simply add a string value with the stub format placed at the Alt Text property of an image in your Word-based template document. For example, you may have a financial planning report that should generate a document including a bar chart:
When applying formatting to a stub, you must apply the same formatting to the double curly braces for the system to recognize it. For example, this stub will not include the selected formatting of highlight, bold, and italicize:
The total cost of the goods selected is, {{ total_due }}.
This following stub will contain the applied formatting:
The total cost of the goods selected is, {{total_due}} .
Changing Document Order
The documents will be appended to the exported PDF file in the order that they appear on the Documents list, irrespective of how many pages each document occupies.
To change their order, click the handle icon in the first column and drag and drop the row into the new position.
Download Original Document
The original document used for creating print process document can be downloaded by clicking the Download button on the corresponding row.
Known Limitations
Word documents that contain shapes with an image set as a background fill are not supported and will cause the print process to fail. Please remove shapes with these settings and replace them with actual images to proceed without error.