Document Templates
- Alecia Elia (Unlicensed)
- John Kostakos
- Balaji Narayanan
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 a variety of documents, including letters, permits, and inspection reports.
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 client computer.
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.
Editing a Document Template
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 opens on which the metadata associated with the template can be edited:Â
To edit the content of the document template, click the Edit button at the bottom of the page. The document template opens in an AceOffix window, 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.
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.Â
Previewing a Document Template
Document templates can be previewed to show how they will look when generated with real data. To preview a document template with data merged into it, do the following:
Open the document template and click the Preview button at the bottom of the Configure Document Template page. A dialog box opens, prompting you to specify an item from which to merge data into the document template. The type of item depends on the functional area in which the document template is being created. For example, if previewing a document in the Permit functional area, you will be prompted to enter a permit number. (When previewing a document, it is important to select an item–a permit, in this example–that contains data in the merge fields that are used in the document template. Otherwise, these fields will appear blank when the document is previewed.)
The Document Template Preview window opens in read-only mode and any merge fields that were added to the document template are replaced with the data in those fields.Â
Click Cancel to close the Document Template Preview 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, Authorized External Users or Internal. Documents with a classification of Public will be available to public/external users upon being published. Documents with a classification of Authorized External Users will be available to on external users based on their access to the site. Internal documents are only ever visible to internal staff. |
Functional Area | Indicates the functional area for the document template, such as Permit, Schedule, Application/Request, etc. |
Program Area | Specifies the program area(s) 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 | Specifies the nFORM submission or program component forms whose fields can be merged into the document template. The available forms depend on the document template's functional area:
|
Side Bar | |
Active/Inactive | Activates or inactivates a template. Once inactive, the template can be deleted from the Document Template List, if desired. Also, when a template is active, any edits made to the template will, upon saving, trigger a dialog box that prompts the user to describe the edits made. To avoid having to repeatedly fill out this dialog box during editing, keep the document in the Inactive status while main editing is being done, and only change it to Active when editing is complete and the document is ready to be used. |
View History | 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. |
Auto-create event upon finalization | 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 of documents generated from this template may be changed. When unchecked, documents that have been generated from this template cannot have their security classification changed. |
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. |
Standard Document Template Fields
See the Standard Document/Notification Template Merge Field List page for a complete list of fields available.
On this page
Â
Related Content