Create an MS Word Document Template

Creating the Template File

1. On your local system, create a Word document
2. Add boilerplate text and place-holder images.
3. Add place-holder images for any record images or charts you plan to add.
4. Insert template variables, record-specific images, and/or charts, as explained below.
5. Save it in .docx format.

Note: The .docx file is stored in an XML format the platform can work with. A .doc file is in a binary (numeric) format that won't work.

Adding Template Variables

To insert a template variable:

Inserting an Image Stored in an Object Record

To insert an image:

... use the platform IMG tag in an HTML img element.

Format

<img src="IMG{$objectName.imageFieldName}">

where:

• objectName - The name of the current object. (This variable is in Template:Velocity format. The object name effectively creates a namespace, ensuring that there is no conflict with another variable that might have the same name.)
• imageFieldName - The name of the field in the current record that contains the image to display, joined to the object name by a "dot" (.).

Important: The braces {...} and other underlined characters in this syntax are literals. Type them in exactly as shown.

Result

The URL for the image is inserted into the generated page. When viewed, the image is displayed.

Example

<img src=”IMG{$Customer.logo_image}”>

Inserting a Chart

To insert a chart:

...use the platform CHART tag in an HTML img element.

Format

<img src="CHART{$report_id}">

<img src="CHART{$report_id, chart-title=Your Title, field1=value, ...}">

where:

• report_id - A required argument that gives the ID of the report that generates the chart.
• chart-title - An optional argument containing text for a chart title.
• field1 - An optional record field. Only records with a matching value will be included in the generated chart. Up to three fields and values can be specified in the comma-separated list. (More can be specified, but only the first three are used.)

Important: The braces {...} and other underlined characters in this syntax are literals. Type them in exactly as shown.

Result

A URL for the generated chart is inserted into the generated page. When viewed, the chart image is displayed.

Example #1 - Inserting a chart with no optional arguments:

<img src="CHART{c5cc43653b1b49db8142bc844735c209}">

Example #2 - Inserting a chart of Orders taken by the owner of the current record:

<img src="CHART{c5cc43653b1b49db8142bc844735c209, chart-title=Orders by $Order.owner.full_name, owner_id=$Order.owner.id}">