Viewing and Editing Document Templates
- Emad Shaat
- Will Rensmith
- Will Rensmith (Unlicensed)
Overview
This section provides details on how to view, edit, and configure document template metadata and content. Document template contents are edited using the AceOffix editor.
Editing Document Template Metadata
To edit template metadata:
Navigate to Admin > Document Templates.
Click Open next to an existing template or select Add New Document Template to create a new one.
The document template metadata editor page is displayed.
Configurable Fields on the Document Template Page
The following key fields are available when configuring a document template:
Field | Description |
|---|---|
Template Name | The name of the document template. |
Template Description | An internal description of the template. |
Security Classification | Defines visibility (Public, Internal, Authorized Users). |
Functional Area | Specifies the category of the document (Permit, Compliance Action, etc.). |
Document Category | Groups templates based on predefined categories. |
Program Area | Determines applicable programs for the template. This value is derived from the selected Document Category. |
Base Datasource | Defines the merge field list available for the template. |
Dynamic Datasources | Specifies the forms and reports whose fields can be merged. The available forms depend on the document template's functional area:
|
Right Sidebar |
|
Active/Inactive | Controls whether the template is available for use. When saving changes to an active document template in a production environment, a dialog box that prompts the user to provide a description of the edits made. |
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. Notifications can also be configured to be sent when an event is created. A System Action will need to be created for the corresponding Functional Area Event. |
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. |
Prefix Generated File Name with Record Identifier | Prefixes the generated document name with the current record’s business identifier (e.g. Permit Number, Compliance Action Number, Site Number, etc). |
View History | Displays metadata changes over time. |
Previewing a Document with Merged Data
Clicking Preview opens a read-only version of the document with actual data merged from the selected source.
Editing Document Template Content using AceOffix
To edit template content:
Navigate to Admin > Document Templates.
Click Open next to an existing template or select Add New Document Template to create a new one.
Click Edit to modify the document content.
The template opens in an AceOffix window, displaying the document as an editable Word file along with a list of available merge fields.
When the AceOffix editor is open, a popup window will indicate that AceOffix is running separately from the main application.
Insertable Fields
Templates contain insertable fields that dynamically merge data from the system:
Single Insertable Fields: Appear in non-bold text and are inserted as placeholders (e.g.,
<<[FieldName]>>).Looping Insertable Fields: Appear in bold text and represent repeating data structures (e.g., a list of contacts). These use
<<foreach [item in items]>> … <</foreach>>syntax.
The available fields are driven by the selected datasources on the document template metadata page (see above).
To insert a field:
Double-click a non-bold field to insert it at the cursor location.
Double-click a bold field to insert a loop structure.
Click a bold field once to display its available subfields.
For more information on looping and advanced syntax, see Using Loops in Document Templates.
Variables, Formulas, Formatting Content and Controlling Logic
The Document Template editor is a powerful tool that can regenerate complicated documents based on logic and data sources. It can also perform data manipulation and calculations. Some of the codes that could be used in a document template can be found at Document Template Syntax Guide page
On this page
Related Content