Document Templates are Microsoft Word-based documents used to merge data from specific functional areas, such as permits, evaluations and compliance actions. Document templates are used to create letters, permits, inspection reports, or just about any other document.
In order to use the Document Template editor, the AceOffix browser plugin must be installed on the client desktop browser. In addition, Microsoft Office must also be installed on the desktop.
Document templates can be previewed using the Preview button at the bottom of the screen.
To configure document templates, navigate to Admin > Document Templates. This page displays a list of existing document templates; to edit a template, click the corresponding Open button. Or, to create a new template, click the Add New Document Template button. In either case, an AceOffix window opens (as the New Document Template or Edit Document Template page).
Note that, when editing a document template in the AceOffix window, a popup window will be displayed over the main nVIRO page, indicating that AceOffix is open in another window.
The following fields are available on the New Document Template / Edit Document Template page:
Field
Description
Details
Template Name
The name of the document template
Template Description
A description for the document template. The description is not displayed outside of the Administrative screens.
Functional Area
Indicates the functional area for the document template. This cannot be changed after a new document template is created.
Template Datasource
The name of the merge field list; this determines which database fields are available to insert into the document. The available datasources are based on the selected functional area. This cannot be changed after a new document template is created.
Program Area
Lists the program areas in which the document template is available. If left blank, the template will be available across all program areas.
Form Datasources
Indicates which nFORM form's fields can be merged into the document template. This cannot be changed after a new document template is created.
Document Category
Specifies the document category into which the document template is organized. Document categories are defined by functional area and are created and modified in Admin > Lookups > Document Categories.
Additional Options
Active/Inactive
Activates or inactivates a template. Once inactive, the template can be deleted from the Document Template List, if desired.
Allow multiple finalized documents based on this Template
If unchecked, only one generated document based on this template is allowed for a given entity.
If checked, an event will be created with the Event Type "Document Generated" when a document is generated using this template.
Auto publish upon finalizing documents based on this Template
If checked, any document that has been generated by this template will automatically be published once that document is set to "Final" status.
Allow changing file name when generating documents based on this Template
If checked, users will be given the option to type a name for the generated document before it is generated. If unchecked, the name of the generated document will be the same as the template name.
View History
Displays a list of changes made to the document template metadata over time.
Editing a Document Template Using AceOffix
The bottom half of the AceOffix window contains the Editor section, which displays the document itself as an editable Word document, along with a list of merge fields available for insertion into the document. Usage of this Editor section is explained in the Editing a Document Template topic.
Standard Document Template Fields
The following link provides a spreadsheet listing all of the standard document template fields for view-based datasources:
