Difference between revisions of "Create a JSP Page Document Template"

From AgileApps Support Wiki
imported>Aeric
imported>Aeric
Line 1: Line 1:
==Creating the Template Page==
===Creating the Template Page===
# Start by creating a JSP/Html [[Page]] in the platform.
# Start by creating a JSP/Html [[Page]] in the platform.
#: Turn off the ''Include Headers'' option for that page.
#: Turn off the ''Include Headers'' option for that page.
Line 7: Line 7:
# Insert record-specific images and/or charts, as explained below.
# Insert record-specific images and/or charts, as explained below.


==Inserting Template Variables==
===Inserting Template Variables===
# Begin to [[Add a Print Template]] or '''[Edit]''' an existing template.<br>The [[Template Variable Tool]] appears.
# Begin to [[Add a Print Template]] or '''[Edit]''' an existing template.<br>The [[Template Variable Tool]] appears.
# Select the '''Category''' of fields to choose from.<br>(Fields in the current object or [[Related Objects]], User fields, or Company fields)
# Select the '''Category''' of fields to choose from.<br>(Fields in the current object or [[Related Objects]], User fields, or Company fields)
Line 15: Line 15:
# In the template page, paste the variable name you copied.
# In the template page, paste the variable name you copied.


==Inserting an Image Stored in an Object Record==
===Inserting an Image Stored in an Object Record===
{{:Common:HTML_IMG_Tag}}
{{:Common:HTML_IMG_Tag}}


==Inserting a Chart==
===Inserting a Chart===
{{:Common:HTML_CHART_Tag}}
{{:Common:HTML_CHART_Tag}}
===Learn More===
:* [[Print Templates#Accessing Related Records|Accessing Related Records]]
:* [[Print Templates#Sample (HTML) Print Template for an Order Invoice]]
<noinclude>
<noinclude>



Revision as of 00:03, 18 February 2012

Creating the Template Page

  1. Start by creating a JSP/Html Page in the platform.
    Turn off the Include Headers option for that page.
    (Those headers contain platform-specific Javascript that interfere with template processing.)
  2. Add boilerplate text and fixed graphics.
  3. Insert any of the Print Template Variables that are available when you Add a Print Template.
  4. Insert record-specific images and/or charts, as explained below.

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

Inserting an Image Stored in an Object Record

To insert an image into a Document Template, use the platform IMG tag in an HTML img element.

HTML Tag
<img src="...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 src="IMG{$Customer.logo_image}">

Inserting a Chart

Common:HTML CHART Tag

Learn More