In the Templates form, you can manage all template records using the corresponding XML loader objects. You can edit templates using form functions. The templates contain static text that can be edited regardless of variable data, as well as placeholders for dynamic content in the syntax of the current tool. Variables and parameters control the server-driven data import while generating. The status of a document changes according to its use (displaying or editing). In addition, the Status is influenced by the user.
Fields and concepts
Loader object
A loader object unambiguously identifies a loader procedure and saves all export or import settings present in the form. Often recurring export or import activities, that take place as documents are being created automatically, can often be combined into loader objects and managed in the database.
A template record is mostly connected with an XML loader object and a template. XML loader objects can be edited in PiSA cubes and follow the JustRelate CRM data model.
Note: Templates for the server-driven creation of documents can only be created and modified with basic knowledge of the CRM data model, the XML loader in PiSA cubes, and of XML (XSL), XPath and BIRT.
Template status
The status marks the current use of the template, which influences access to the template. You can see the respective status in the Status field of the template form. These are the same statuses you know from the document management.
Status | Meaning |
|---|---|
In development | As long as a template was not approved, it is in development. Every user who has access according to the role concept can view templates in this status, use and edit them. |
In process | The template is in process if it is currently being used by a user (temporarily checked out for processing). The in process status indicates that no direct access to the document is possible at this point. |
Not up to date | The template is not valid anymore and can no longer be selected with objects. The validity date lies before the current date. |
Approved | A template is approved if it is not processed any further. It is published then, can be used by all users, but not even the owner can change it anymore. |
Created on ... by
Creator (owner) of the template record.
See also: Concerning Created on ... by ... and the Status, especially on the status person, see Document status.
Output format
The template types indicate the format in which the created document or the report is displayed, and which application is required for displaying or editing it. These are the most important ones:
- PDF: Acrobat Reader
- DOCX: Microsoft Word
- HTM: Browser or HTML editor
- TXT: text editor
- CSS: Browser or HTML editor
- ODT: Open Office or Libre Office
More fields
Loader object
The loader object belonging to the template in which the data structure is represented. The loader object can be edited only by the administrator or developer.
Startup dialog
The dialog object (form or list) in which this template is accessed. It is usually a template for generating the standard report in the corresponding dialog object (form or list).
Note: No longer used since the Report Manager was introduced.
Max. Reports
Defines the maximum number of records to be taken into account by this report, regardless of the selected records in the list of the form.
Single report
Every selected record is presented as an individual report.
For object
Speciifies which templates are displayed in the respective module object for selection (currently only selectable for correspondences).
Tool
Selection of the report tool with which a final document is created from the template. The default is BIRT. For your own product text module templates without variables, the entry DOC/select a simple document should be chosen.
Layout
Allows you to manually overwrite the default name of the layout.
Deleting a template
If you delete a template, the system checks whether it is referenced by products. If this is the case, you will be asked whether the template should still be deleted. If you confirm this, the corresponding mark is set for all products concerned if it is the last template with this ID.
If no other template uses the loader involved and the user has delete permission for it, the system asks whether the loader should be deleted as well. Otherwise, no message is shown.
Tab: Template elements (BLOB)
Some templates contain elements that are available as a BLOB (Binary Large Object) in the database (e.g., images). These elements can be collected in the Template elements tab. A reference (wr:import ...) for the corresponding BLOB can be created in the template.
Note: Pay attention to the file types each tool supports. Windward, for example, has limited support for DOCX and HTML, BIRT supports HTML properly, but DOCX not at all. Suitable image formats are, for example, BMP, JPG and PNG.
Tab: In reports
The list shows the usage of a template in the report manager. The tab is only visible for template and report administrators.
Tab: In correspondences
You can see for which correspondences the current template was used on the In correspondences tab of the Templates form. This way, you can understand their effect on a completed correspondence.
Tab: In products
Shows the usage of a template at products (text module etc.).
Testing templates
Templates can normally only be used if they are released. To be able to test modified templates, the person concerned can be assigned to a corresponding profile.
See also: Treatment of administrators, in particular with respect to the release status templates.