Difference between revisions of "Add a Document Template"

From AgileApps Support Wiki
imported>Aeric
imported>Aeric
Line 9: Line 9:
#:: -or-
#:: -or-
#:* Create an HTML page on your local system
#:* Create an HTML page on your local system
#:: -or-
#:* Create a Word document on your local system, saved in <tt>.docx</tt> format.
#:: -or-
#:* Create an Excel spreadsheet document on your local system, saved in <tt>.pptx</tt> format.
#:: '''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.
#In the ''New Template'' page, use the [[Template Variable Tool]] to get the names of variables you can use in the template:
#In the ''New Template'' page, use the [[Template Variable Tool]] to get the names of variables you can use in the template:
#:[[File:TemplateVariableTool.jpg]]
#:[[File:TemplateVariableTool.jpg]]

Revision as of 22:35, 16 February 2012

A Print Template can be added to any object, except for the built-in Documents and Users objects.

To add a Print Template to a Custom Object:

  1. Click Designer > Data > Objects > {object} > Print Templates
  2. Click the [New Template] button
  3. If the template does not already exist, create it:
    • Create a JSP/HTML Page in the platform
    • Turn off the Include Headers option for that page (explanation below)
    -or-
    • Create an HTML page on your local system
    -or-
    • Create a Word document on your local system, saved in .docx format.
    -or-
    • Create an Excel spreadsheet document on your local system, saved in .pptx format.
    Note:
    The .docx and .pptx files are stored in an XML format the platform can parse and work with. The .doc and .ppt formats are binary formats that won't work.
  4. In the New Template page, use the Template Variable Tool to get the names of variables you can use in the template:
    TemplateVariableTool.jpg
    Note: Template variables work only in HTML pages. They do not work in JSP pages.
    (In those pages, use standard JSP programming techniques to access platform information.)
  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 Template File
    This is an HTML file that provides the template structure. Click the [Browse] button to locate the HTML file
    Page
    JSP Page;
    • A list of platform Pages is displayed.
    (The list does not include pages that have the Include Headers option. Those headers contain platform-specific Javascript that interfere with template processing.)
    • Choose one of the JSP files stored in the platform.
  6. Click [Save]