AgileApps Support Wiki

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

From AgileApps Support Wiki
imported>Aeric
imported>Aeric
Line 18: Line 18:
To insert an image into a Print Template, use the platform <tt>IMG</tt> tag in an HTML <tt>img</tt> element.  
To insert an image into a Print Template, use the platform <tt>IMG</tt> tag in an HTML <tt>img</tt> element.  


;Format:
;HTML Tag:
:<tt><nowiki><img src="IMG</nowiki></tt><u><b>{$</b></u>''objectName''<u>.</u>''imageFieldName''<u><b>}</b></u><tt>"></tt>
:<tt><nowiki><img src="...IMG tag..."></nowiki></tt>
where:
{{:IMG tag}}
:* '''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|The braces <u>{</u>...<u>}</u> 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:
;Example:
Line 35: Line 28:
To insert a chart into a Print Template, use the platform <tt>CHART</tt> tag in an HTML <tt>img</tt> element.  
To insert a chart into a Print Template, use the platform <tt>CHART</tt> tag in an HTML <tt>img</tt> element.  


;Format:
;HTML Tag:
:<tt><nowiki><img src="CHART</nowiki></tt><u><b>{$</b></u>''report_id''<u><b>}</b></u><tt>"></tt>
:<tt><nowiki><img src="...CHART tag..."></nowiki></tt>
:<tt><nowiki><img src="CHART</nowiki></tt><u><b>{$</b></u>''report_id'', <u>chart-title=</u>''Your Title'', ''field1''<u>=</u>''value'', ...<u><b>}</b></u><tt>"></tt>
{{:CHART Tag}}
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 <u>{</u>...<u>}</u> 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:  
'''Example #1 -''' Inserting a chart with no optional arguments:  
:<tt><nowiki><img src="CHART{c5cc43653b1b49db8142bc844735c209}"></nowiki></tt>
:<tt><nowiki><img src="CHART{c5cc43653b1b49db8142bc844735c209}"></nowiki></tt>

Revision as of 22:34, 17 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 Print Template, use the platform IMG tag in an HTML img element.

HTML Tag
<img src="...IMG tag...">

IMG tag

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.

HTML Tag
<img src="...CHART tag...">

CHART Tag 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}">
Retrieved from "https://agileappscloud.info/aawiki-src/index.php?title=Create_a_JSP_Page_Document_Template&oldid=16810"