Overview

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. For more information on how to edit and format documents using Microsoft Word visit Microsoft Word Help Center.

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 desktopclient computer.  

To edit document templates, navigate to Admin > Document Templates. This page displays a list of existing document templates; to . 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, a page will display opens, allowing you to configure the document template. To review view an existing document template click on Preview or Edit to start editing the document template. If with data merged in from the database, click Preview. To edit an existing document template, click Edit. If either Preview or Edit is clicked, an AceOffix window opens (as the New Document Template or Edit Document Template page).

Editing a Document Template Using AceOffix

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 (Left Side). . These merge fields appear to the left of the document, under the heading Insertable Fields.

Creating Editing a document templates is the same as creating editing a document in Microsoft Word, ; the only change difference is the words or values that would that the document template contains the insertable fields, which act as placeholders for values that will change dynamically based on the Permit information, Inspection, or any other data that would be different from one document to anotherthe data from the database, such as permit, site, or inpection information.

Insertable Fields Type

There are two types of fields, single insertable fields (nonbold), and Looping insertable fields (bold).

Single Insertable Fields

Listed in a nonbold typeface. To insert a field in the document, double click on any nonbold insertable fields from the list, a text will be inserted in the document (at the location of cursor) in the form of

<<[FieldName]>>

 this field will be changed to its corresponding value when previewing or generating the document. 

Looping Insertable Fields

Which is listed as a bold insertable field in the list. The Bold insertable field, groups multiple fields that represent a table of values. For example, a site usually have multiple contacts associated with it, to insert in a document all contacts, double click contacts, a text will be inserted in the document (at the location of cursor) in the form of 

<<foreach [contact in contacts]>> <</foreach>>

 which will loop through all contacts available for that document. For more details on loops visit Using Loops in Document Templates.

To display the items available within a bold insertable field, single-click on any bold insertable fields which will display the available fields.

For more details on how to use loops in a document check Using Loops in Document Templates.

Document Template Possibilities

The Document template tool is a powerful tool which can regenerate complicated document 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.

Standard Document/Notification Template Fields

See page Standard Document/Notification Template Merge Field List for a list of standard merge fields.