Create a PowerPoint Print Template

From LongJump Support Wiki
Revision as of 00:03, 18 February 2012 by imported>Aeric

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.

Inserting Template Variables

  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, paste the variable name you copied.

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}

Inserting a Chart

To insert a chart:

  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 CHART tag
CHART Tag
CHART{report_id}
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.)

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
A URL for the generated chart is inserted into the generated page. When viewed, the chart image is displayed.

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}

Learn More