Document Templates

Designer > Presentation > Print Templates Print templates let you generate PDF documents for selected records.

About Print Templates

Print templates are powerful tools, allowing you to set up documents that pull information from a specific object and merge into an HTML or JSP page. Print templates are loaded into the platform and can be used to set up standard proposals, queries, contracts, invoices, etc., and generate PDF documents unique to specific records - any document that you can dream up.

Examples

• Create an Expense Report to be used in expense management application
• Print an Employee Benefit Form

Note: HTML print templates are created outside of the platform, using an HTML editor. The initial version of a JSP Page is created inside the platform. Once created, print templates can be downloaded, edited, and uploaded again.

Learn more: Sample Print Templates you can customize and use.

How Print Templates Work

The Print Templates feature lets you generate graphical mail-merge-style PDF documents using variables and HTML. You can use these templates to create prefilled forms, invoices, contracts, and other types of documents using data stored in your application. The platform uses the Apache Velocity templating engine to create powerful dynamic documents.

Learn more: http://velocity.apache.org/engine/releases/velocity-1.5/user-guide.html

• Before you add a print template, you first create an HTML document (on your local file system) or an HTML/JSP Page in the platform that includes all of the text, images, logic, etc. that you want to include in your template.
  Learn more: HTML Resources
• While creating this document, you should make note of the fields you want to add.
• Use the Template Variable Tool to get the field names you need to customize the HTML file.

Some features to consider when building print templates:

• CSS styles can be embedded into the HTML file, giving you a high degree of control of the final output of the file.
• Images can be placed into your document server and accessed by the template via Web access.
• Using the Velocity scripting language, you can build logic directly into the template to change the content based on data parameters.

Working with Print Templates

Add a Print Template

Add a Print Template

Edit a Print Template based on a Platform JSP/HTML Page

1. Click Designer > Logic > Pages > {page}
2. Edit the page.

   Learn more: Pages

3. If you need the names of additional variables:

   a. Click Designer > Data > Objects > {object} > Print Templates

   b. View the template to access the Template Variable Tool:

   

Edit a Print Template based on a Local HTML Page

1. Click Designer > Data > Objects > {object} > Print Templates
2. Click the Download link on the template you want to copy to your local system.
3. Make changes to the template.
4. If you need the names of additional variables, click the [New Template] button to access the Template Variable Tool:

   

5. If the New Template window is open, click [Cancel] to close it and go back to the Templates (record list) view.
6. Click the Replace link on the template to upload the modified template.

Warning: Be sure to click the right link. The existing template page will be replaced by the new one.

Use a Template

1. Open an object record.
2. Click the [Print] button.
3. Select Template based to create an HTML page using the Print Template.
4. Select the Template
5. Optionally, Select PDF format to get the results in PDF format. (Default is HTML.)
6. Click [Print].
   A new window opens to display the results.
7. Copy content from the resulting HTML page, print it, or save the page to your local system.

Inserting an Image Stored in an Object Record

To insert an image into a Print Template, 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 into a Print Template, 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)">

Accessing Related Records

In a Custom Object, fields from related records can be added to a Print Template. (That is, records in a Object that has a Lookup to the current object.)

For example, OrderItems has a lookup to Orders, so in a Print Template for Orders, related OrderItems records can be accessed. (In an object Form, related records are typically displayed in a Grid Section, although they need not be.)

When formatting a record in the current object for printing, those related records and the fields they contain can be processed in a loop.

Finding and Using Related Record Variables

Finding Related-Record Variables

Related Object variables can be found in the Template Variable Tool. Here, the related OrderItems objects are being chosen from the category list:

Here, the Tag Name field is being selected from the Many to Many relationship with the Tags object:

File:TemplateVariableToolRelatedManyToManyObject.png

The object that is directly connected to Orders is Orders_Tags -- a Junction Object that has Lookups to both Orders and Tags. In that object, the Lookup to Tags is called Related to Tags. Within that group, the Tag Name field is listed, along with other fields in the Tags object.

Once selected, the variable name will appear in the Variable area:

$Orders_Tags_record.related_to_Tags.tag_name

where:

• $Orders_Tags_record is the expected loop variable for the $Orders_Tags Junction Object records
• related_to__Tags is the name of the Lookup field in the Junction Object that references a Tags record
• tag_name is the field we want to display
• The "dot" separator (.) joins each of the segments in the variable name

Processing Related Records a Loop

Typically, you'll create a table for the related records, define its headings, and then create a row for a single record, putting the related-record variables into the cells of the row. You then enclose that row in a loop, using the #foreach instruction defined by the Velocity templating engine.

Related records are returned in an array, so the loop creates a new table row for each record in the array.

For example (with formatting attributes removed for simplicity):

<table>
<tbody>
<tr>
    <th>Quantity</th>
    <th>Product </th>               
    <th>Unit Price</th>
    <th>Amount</th>
</tr>
</tbody>

#foreach( $OrderItems_record in $OrderItems )
<tr>        
    <td>$OrderItems_record.item_quantity</td>
    <td>$OrderItems_record.related_to_ProductInventory.product_name</td>
    <td>$OrderItems_record.item_price</td>
    <td>$OrderItems_record.total</td>
</tr>
#end

...
</table>

where:

• The <tbody> element is required around the header row.

• The Velocity #foreach directive does the looping.

Learn more: http://velocity.apache.org/engine/releases/velocity-1.5/user-guide.html

• The looping construct defines $OrderItems_record as a loop variable.
• The loop variable iterates over the $OrderItems array.
• The $OrderItems array is automatically available in the template, because OrderItems is a Related Object. (All related objects are available. Each is an array.)

Special Considerations for Grid Section Variables

Totals and additional computation fields defined for a Grid Section are also available in the Template Variable Tool. To find them, you access the main object (not the object displayed in the grid section), because those fields are added to the object that contains the grid section.

For example, the grid section for OrderItems totals the $Amount column, and then does additional computations on it to add a surcharge. Those values are shown in the $Orders Fields category as Total $Amount and Shipping for $Amount, respectively. (The final total is shown as Net Total $Amount.)

Sample Print Template for an Order Invoice

This sample:

• Creates an invoice for an order, showing all items in it
• Gets the name and price of order items from the ProductInventory object
• Uses Velocity #foreach processing to process OrderItems records for an Order
• Uses Velocity #if conditionals to display surcharge and discount rows only if those values are present

<html><head>
<title></title>
<style>
 div {  
      padding-top: 5px;  
      padding-bottom: 5px;  
      padding-right: 5px;  
      padding-left: 30px;  
      border: 3px;  
	  margin-top: 5%;
	  margin-right: 40%;
	  margin-bottom: 5%;
	  margin-left: 5%;
    }
</style>

</head><body bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">

<div style="width:100%">

<img  width="100" height="100"  src="http://justanothermobilemonday.com/Wordpress/wp-content/uploads/2009/10/android-robot-logo2.jpg" alt="Company logo" />&nbsp;&nbsp;&nbsp; <---- Company Logo Here<br/>
<font size="5"><b>$company.name</b></font><b><br />
<br/>
$company.street&nbsp;&nbsp;<br>
$company.city, $company.state, <br>
$company.country - $company.zip
 
&nbsp;<br>
&nbsp;(Phone): $user.phone
<hr width="100%" size="1" />
<br />

<h2 align="center">Order<b> Invoice</b></h2>
<p></p>
<p align="center"><b>Invoice Date:</b> $Orders.date_created </p>

<br/><br/>
<b><u>Bill To: </u></b><br />
<font size="2">$Orders.account.name - $Orders.account.number</font></b>
<br />$Orders.account.street<br />
$Orders.account.city,&nbsp;$Orders.account.state, <br>
$Orders.account.country - $Orders.account.zip<br /> 

(Phone): $Orders.account.phone <br />
<br />
<br />
<b>Invoice #: $Orders.order_number <br />
</b>&nbsp;
</p>

<table border="1" cellpadding="5" cellspacing="0" width="600">

<!-- HEADER -->
<tbody>
<tr>
    <th>Quantity</th>
    <th>Product </th>               
    <th>Unit Price</th>
    <th>Amount</th>
</tr>
</tbody>

#foreach( $OrderItems_record in $OrderItems )
<tr>
<td width="350">$OrderItems_record.item_quantity</td>
<td width="100" align="CENTER">$OrderItems_record.related_to_ProductInventory.product_name</td>
<td width="100" align="CENTER"> $OrderItems_record.item_price</td>
<td width="100" align="CENTER"> $OrderItems_record.total    </td>
</tr>
#end

<tr>
<td colspan="2">&nbsp;</td>
<td style="border: solid 1px #000000;" align="Right">Sub Total</td>
<td style="border: solid 1px #000000;" align="center">$Order.grid_comptn_f5631e34b39f4ba39a98559c7215a3b4</td>
</tr>

#if( $Orders.grid_surcharge_031f67dd4b3946949df2da276e5c82a6 > 0 )
<tr>
<td colspan="2">&nbsp;</td>
<td style="border: solid 1px #000000;" align="Right">Surcharge</td>
<td style="border: solid 1px #000000;" align="center">$Orders.grid_surcharge_f5631e34b39f4ba39a98559c7215a3b4</td>
</tr>
#end 

#if( $Orders.grid_discount_031f67dd4b3946949df2da276e5c82a6 > 0 )
<tr>
<td colspan="2">&nbsp;</td>
<td style="border: solid 1px #000000;" align="Right">Discount</td>
<td style="border: solid 1px #000000;" align="center">$Orders.grid_discount_f5631e34b39f4ba39a98559c7215a3b4</td>
</tr>
#end 

<tr>
<td colspan="2">&nbsp;</td>
<td style="border: solid 1px #000000;" align="Right">Tax</td>
<td style="border: solid 1px #000000;" align="center">$Orders.grid_tax_f5631e34b39f4ba39a98559c7215a3b4</td>
</tr>

<tr>
<td colspan="2">&nbsp;</td>
<td style="border: solid 1px #000000;" align="Right">Shipping</td>
<td style="border: solid 1px #000000;" align="center">$Orders.grid_shipping_f5631e34b39f4ba39a98559c7215a3b4</td>
</tr>

<tr>
<td colspan="2">&nbsp;</td>
<td style="border: solid 1px #000000;" align="Right"><b>TOTAL AMOUNT DUE</b></td>
<td style="border: solid 1px #000000;" align="center"><b>$Orders.grid_net_total_f5631e34b39f4ba39a98559c7215a3b4</b></td>
</tr>     
</table>

<br /><br />
Payment Due upon reciept<br />
Thank you for your business!
</div>
       
<p></p>
</body>
</html>

The grid section part of the resulting invoice then looks something like this:

(The Order Invoice template and the Order Invoice sample file are both available in the downloads area.) [[Category:Template:Features]]