Document Generator Templates (Settings)

Document Generator Templates are used for creating populated MS Word documents from a template that contains customer-related placeholders.

Please refer to the Document Generator article for information about the use of this feature.

Accessing Document Generator Templates Settings

Settings > General Settings > Document Generator Templates

Add a Document Generator Template

  • Press the New Generator Template button

  • Complete the template fields:

Template Description - the name of the template as it will be seen by users who wish to generate a document.

Association - the module with which this template will be associated. Available options in the dropdown list are:

  • Customers
  • Jobs
  • Leads
  • Projects
  • Tickets
  • Workflow

Upload/Replace Template - Select the MS Word (.docx) document to use as the template. Either press the Browse button and select the required file using the file selector, or drag and drop the required file onto the Browse button.

Note that the Placeholders field is for reference only. See the later section Placeholders for more information.

Press Add to create the template or Cancel to display a list of existing templates (if any).

Modify an Existing Document Generator Template

  • Select a Document Generator Template from the Select document generator template to modify section:


If needed, use the Filter By and Order By options (visible in the previous image).


Modify the template fields as required:

Selecting a new MS Word document via the Browse button will replace (overwrite) the existing template document when the updated template is saved. This will not affect any previously-generated documents.

Press Save to confirm any changes, or Cancel to revert to the original settings for this template.

Delete an Existing Document Generator Template

  • Select a Document Generator Template from the Select document generator template to modify section
  • Press the Delete button
  • Press OK to confirm the deletion, or Cancel to retain the template.

Deleting a Document Generator Template cannot be reversed.

Placeholders

The placeholders that can be used in the MS Word (.docx) template file vary depending on which module the template will be associated with.

For example:

  • Customer and 'Common' placeholders are available to all templates, regardless of the associated module.
  • if the template is associated with the Jobs module, in addition to the Customer and Common placeholders, Job-related placeholders will be also available.

Available placeholders are displayed in the placeholder reference window...

  • When creating or modifying a Document Generator Template, select the module with which the template will be associated:

In the previous image, the Jobs module has been selected.

  • Press the Placeholders ? icon (visible in the previous image). The available placeholders will be displayed in a pop-up window:

Note that clicking on any placeholder in the pop-up window will copy the placeholder into the clipboard. The text can subsequently be pasted into the MS Word (.docx) template that will be uploaded into the Document Generator Template.

Example MS Word Template

The following image shows an extract from an MS Word (.docx) template file:

When a document is generated using the above template, the placeholders will be replaced with the relevant customer (and 'common') information.

Any text-formatting of placeholders will be retained when the document is generated. For example, the customer name placeholder (visible in the previous image) will present the customer's name in bold text in the generated document.