AgileApps Support Wiki Pre Release

Difference between revisions of "Create a PowerPoint Document Template"

From AgileApps Support Wiki
imported>Aeric
imported>Aeric
Line 8: Line 8:
# Insert template variables, record-specific images, and/or charts, as explained below.
# Insert template variables, record-specific images, and/or charts, as explained below.
# Saved it in <tt>.pptx</tt> format.
# Saved it in <tt>.pptx</tt> format.
{{Note|<br>The <tt>.pptx</tt> file is stored in an XML format the platform can work with.<br>A <tt>.ppt</tt> file is in a binary (numeric) format that won't work.}}
{{Note|<br>The <tt>.pptx</tt> file is stored in an XML format the platform can work with.<br>A <tt>.ppt</tt> file is in a binary (numeric) format that won't work.<br>The <tt>.pptx</tt> format does not support Related record variables.}}


==Working with Template Variables==
==Working with Template Variables==

Revision as of 06:16, 19 December 2017

A PowerPoint file can also be used as a document template.

Learn more: Document Templates

Creating the Template File

  1. On your local system, create a PowerPoint presentation.
  2. Add boilerplate text and fixed graphics.
  3. Add placeholder 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. Saved it in .pptx format.

Notepad.png

Note:
The .pptx file is stored in an XML format the platform can work with.
A .ppt file is in a binary (numeric) format that won't work.
The .pptx format does not support Related record variables.

Working with Template Variables

Inserting Template Variables

  1. Begin to Add a Document Template or [Edit] an existing template.
    The Template Variable Tool appears.
    TemplateVariableTool.jpg
  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, paste the variable name you copied.

Testing Boolean Values

Boolean values are seen in Velocity as strings with the value "Yes" or "No". So a test of a boolean field looks something like this:

#if ($BooleanField == "Yes"), or
#if ($BooleanField == "No")

Or, similarly,

#if ($BooleanField != "Yes"
#if ($BooleanField != "No")

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 and Position...
  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" (.).

Warn.png

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}