AgileApps Support Wiki

Difference between revisions of "Add a Document Template"

From AgileApps Support Wiki
imported>Aeric
imported>Aeric
Line 1: Line 1:
A Print Template can be added to any object, except for the built-in [[Documents]] and [[Users]] objects. It can use a [[Page]] stored in the platform, or it can be creating using an external HTML, Word, or Excel file. This section outlines the process.
A Print Template can be added to any object, except for the built-in [[Documents]] and [[Users]] objects. It can use a [[Page]] stored in the platform, or it can be creating using an external HTML, Word, or Excel file. This section outlines the process.


;A. Get the names of variables you'll be using in the template:
To add a Print Template to an Object:
Template variables can be used in HTML, Word, and Excel files. (In [[Pages]] stored in the platform, you use standard JSP programming techniques to access platform information, rather than template variables.)
#Click '''Designer > Data > Objects > {object} > Print Templates'''
#Click '''Designer > Data > Objects > {object} > Print Templates'''
#Click the '''[New Template]''' button
#Click the '''[New Template]''' button.<br>The ''New Template'' page appears.
#In the ''New Template'' page, use the [[Template Variable Tool]] to get the names of variables you can use in the template:
#:
#Use the [[Template Variable Tool]] to get the names of variables you can use in the template:
#:[[File:TemplateVariableTool.jpg]]
#:[[File:TemplateVariableTool.jpg]]
 
#:'''Note:'''<br>Template variables can be used in HTML, Word, and Excel files. (In [[Pages]] stored in the platform, you use standard JSP programming techniques to access platform information, rather than template variables.)
;B. Create an initial template:
#:
If it does not already exist, create a blank template:
# If it does not already exist, create the template:
#Create a [[Page]] in the platform.<br>Turn off the ''Include Headers'' option for that page.<br>(Those headers contain platform-specific Javascript that interfere with template processing.)<br>&nbsp;'''-or-'''
#* [[Create a JSP Page-based Print Template]]
# On your local system, create an HTML page, a Word document saved in <tt>.docx</tt> format,<br> or an Excel spreadsheet document saved in <tt>.pptx</tt> format.
#* [[Create an HTML Print Template]]
{{Note|The <tt>.docx</tt> and <tt>.pptx</tt> files are stored in an XML format the platform can parse and work with. The <tt>.doc</tt> and <tt>.ppt</tt> formats are binary formats that won't work.}}
#* [[Create a Word-based Print Template]]
 
#* [[Create an Excel-based Print Template]]
: 3. Add "boilerplate" (fixed) text and graphics to the template.
#:
: 4. Follow the instructions in [[Print Templates#Edit a Print Template]] to add variable text  and images.
 
;C. Add the Print Template to an Object:
Continuing from where you left off in the '''[New Template]''' process:
#Provide the information in the Template Information section:
#Provide the information in the Template Information section:
#:;Template Title:The template name
#:;Template Title:The template name
Line 31: Line 27:
#:::: (The list does not include pages that have the ''Include Headers'' option.)
#:::: (The list does not include pages that have the ''Include Headers'' option.)
#:::* Choose one of the JSP files stored in the platform.  
#:::* Choose one of the JSP files stored in the platform.  
#:
#Click '''[Save]'''
#Click '''[Save]'''

Revision as of 00:38, 17 February 2012

A Print Template can be added to any object, except for the built-in Documents and Users objects. It can use a Page stored in the platform, or it can be creating using an external HTML, Word, or Excel file. This section outlines the process.

To add a Print Template to an Object:

  1. Click Designer > Data > Objects > {object} > Print Templates
  2. Click the [New Template] button.
    The New Template page appears.
  3. Use the Template Variable Tool to get the names of variables you can use in the template:
    TemplateVariableTool.jpg
    Note:
    Template variables can be used in HTML, Word, and Excel files. (In Pages stored in the platform, you use standard JSP programming techniques to access platform information, rather than template variables.)
  4. If it does not already exist, create the template:
  5. Provide the information in the Template Information section:
    Template Title
    The template name
    Description
    Describe the purpose of the template or other information about it.
    Ready to Use
    The default setting for the template is Yes.
    Type
    Choose from:
    HTML
    To upload an HTML, Word, or Excel file to use as a template.
    • The [Browse] button appears.
    • Click it to locate the file to upload.
    Page
    JSP Page;
    • A list of platform Pages is displayed.
    (The list does not include pages that have the Include Headers option.)
    • Choose one of the JSP files stored in the platform.
  6. Click [Save]
Retrieved from "https://agileappscloud.info/aawiki-src/index.php?title=Add_a_Document_Template&oldid=1926"