Create an MS Word Document Template

Creating the Template File

1. On your local system, create a Word document
2. Add boilerplate text and placeholder images.
3. Add place-holder images for any record images or charts you plan to add. Size them appropriately.
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.

Inserting Template Variables

To insert a template variable:

1. Begin to Add a Print Template or [Edit] an existing template.
   The Template Variable Tool appears.

   

2. Select the Category of fields to choose from.
   (Fields in the current object or Related Objects, User fields, or Company fields)
3. Under Fields, scroll down the list to find fields in the current record or in a Lookup target record.
4. Select the field to add.
   The variable name appears.
5. Copy the variable name to the clipboard.
6. In the template file, create a field:
   • Press Ctrl+F9 (Insert > Quick Parts > Field)

7. Right click on the field
8. Select "Edit Field..."
   The Field dialog opens.
9. Specify field type:
   • Categories: Mail Merge
   • Field names: MergeField

10. Under Field Properties, specify:
    • Field name: Paste the variable name you copied in Step #5.

11. Click [OK]

Working with Template Variables

Convert Currency Variables to Numbers

When you want to do calculations on a currency field in Velocity, you need to create a number from the currency strings delivered by the platform. That string has the form $24.95. The following code converts it to a number that can be used in calculations:

<syntaxhighlight lang="html4strict" enclose="div">

1. set($n = 0.00)
2. set($s = $YourObject.currency_field.substring(2) )
3. set($n = $n.parseDouble($s)

</syntaxhighlight> where:

• $n = 0.00 creates an instance of the double-precision float class (Double)
• $YourObject.currency_field.substring(2) removes the first two characters from the currency string. (The $ sign and the space that follows it.)
• parseDouble($s) converts the resulting string into a double-precision float--a number that can be used in calculations.

Inserting an Image Stored in an Object Record

To insert an image:

1. Select a placeholder image to replace.
2. Right click on the image. Choose Size...
3. Click the Alt Text tab
4. In the Alternative Text area, type in a platform IMG tag

IMG Tag

IMG{$objectName.imageFieldName}

where:

• objectName - The name of the current object. (This variable is in 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: This syntax uses braces: {...}. 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{$Customer.logo_image}

Inserting a Chart

To insert a chart:

1. Select a placeholder image to replace.
2. Right click on the image. Choose Size...
3. Click the Alt Text tab
4. In the Alternative Text area, type in a platform CHART tag

CHART Tag

Example #1 - A chart with no optional arguments:

CHART{c5cc43653b1b49db8142bc844735c209}

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

CHART{c5cc43653b1b49db8142bc844735c209, chart-title=Orders by $Order.owner.full_name, owner_id=$Order.owner.id}

Accessing Related Records

When processing related records, you generally want to insert rows into a table. But in MS Word, there is no way to put the loop-controls

The solution is to use two special constructs that go into the first cell of the row:

• @before-row#foreach($d in $developers)
• @after-row#end

Considerations

• The constructs only need to be specified once in the row, in the first cell.
• Each construct is inserted as a field in the cell (Insert > Quick Parts > Field)
• Example:

«@before-row#foreach($d in $developers)»
«$d.Name»
«@after-row#end»

Learn more: Solution: use @before-row @after-row

Learn More

• Print Templates
• Accessing Related Records