Document Template Configuration
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.
For more information, see the Editing a Document Template and Document Template Syntax Guide topics.
To configure document templates, navigate to Admin > Document Templates. This page displays a list of existing document templates.
To edit a template, click the Open button corresponding to the template to be edited. Or, to create a new template, click the Add New Document Template button. In either case, a page will be displayed allowing the metadata associated with the template to be edited.
To configure the document template click the Open button at the bottom of the page. The document template will open in an AceOffix window for editing.
To review an existing document template click on Preview or Edit to start editing the document template. If Preview or Edit is clicked, 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 Configure 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. |
| Security Classification | Specifies the security classification that will be assigned to the document upon generation. Options are limited to Public or Internal. Confidential or Restricted require individual owners\editors to be specified and the document may be set to one of these once it has been generated. |
| Functional Area | Indicates the functional area for the document template. 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. |
| 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. |
| Base 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. |
| 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. |
| Side Bar | |
| Active/Inactive (toggle button) | Activates or inactivates a template. Once inactive, the template can be deleted from the Document Template List, if desired. |
| View History (button) | Displays a list of changes made to the document template metadata over time. |
| Options (for documents generated from the template) | |
| Allow multiple documents to be finalized | 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. | |
| Allow security classification changes | When checked, the security classification on the generated documents may be changed. When unchecked, they are locked down to the security classification specified on the template. |
| Allow file name changes | 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. |
Editing a Document Template Using AceOffix
The AceOffix window contains the document Editor, 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:
all datasource columns for view-based Aceoffix doc templates
On this page
Sub-Topics
Related Content