Document Templates are Microsoft Word-based documents used to merge data from specific entities 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 machine. More information can be found at http://www.aceoffix.com/
Document templates can be previewed using the Preview button at the bottom of the screen.
Here's a short video demonstrating how document templates can be used to generate permits and letters:
To configure document templates, navigate to Admin > Document Templates. There, you can open an existing document template by clicking the Open button for one of the listed templates or you can create a new template by clicking the Add New Document Template button.
The following fields are available on the screen:
Field
Description
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. The available datasources are based on the selected Functional Area. This cannot be changed after a new document template is created.
Program Area(s)
The list of Program Area(s) that apply to the document template. 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
Indicates a "folder" that is used to categorize templates based on context or usage
Additional Options
Active/Inactive Toggle
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 Checkbox
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 Checkbox
If checked, when a document is set to published that is generated using this template, it will automatically be set to "Final" status.
Allow changing file name when generating documents based on this Template Checkbox
If checked, users will be given the option to type a name for the generated document before it is generated. If unchecked, the template name will be the name of the generated document.
View History Button
Displays a list of changes made to the document template metadata over time.
