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 desktop.  

To edit document templates, navigate to Admin > Document Templates. This page displays a list of existing document templates; 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 to configure the document template. 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).

Editing a Document Template Using AceOffix

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). 

Image Removed

Creating a document is the same as creating a document in Microsoft Word, the only change is the words or values that would change dynamically based on the Permit information, Inspection, or any other data that would be different from one document to another.

Insertable Fields Type

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

Single Insertable Fields

<<[FieldName]>>

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

Image Removed 

Multiple 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]>> Insert here fields to display <</foreach>>

 which will loop through all contacts available for that document. For more details on loops visit Document Template Syntax Guide

Image Removed

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

Image Removed

Document Template Possibilities

The Document template tool is a powerful tool which can regenerate complicated document based on logic and data sources, it 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:

1. Navigate to Admin > Document Templates.

2. 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.

Image Added

Configurable Fields on the Document Template Page

The following key fields are available when configuring a document template:

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:

1. Navigate to Admin > Document Templates.

2. Click Open next to an existing template or select Add New Document Template to create a new one.

3. Click Edit to modify the document content.

4. 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.

Image Added

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.

Standard Document Template Fields

The table lists all of the standard document template fields for view-based data sources, Image Removed the loop icon represents that the insertable field contains multiple fields and each field contains multiple data which will require a loop to display these data:

Ui expand

The view name for this data source in database is VW_SVC_DATASRC_APP_REQUEST_STDRD_NOPARSE

Core Entity Contact

 (Tag associated with this Field??)

Image Removed

The view name for this data source in database is VW_SVC_DATASRC_PERMIT_STDRD_NOPARSE

Core Entity Contact 

(Tag associated with this Field??)

The view name for this data source in database is VW_SVC_DATASRC_EVAL_STDRD_NOPARSE

Core Entity Contact

 (Tag associated with this Field??)

Image Removed

The view name for this data source in database is VW_SVC_DATASRC_CMPL_ACTN_STDRD_NOPARSE

Core Entity Contact

 (Tag associated with this Field??)