/
Template

Template

Owned by Matthew Garrett
Last updated: Aug 12, 2024
4 min read


Return to Report Management
The Template screen manages report templates that are assigned to a report category.

image-20240812-002611.png

 

Article Index

Procedures

Creating A Report Template

  1. From the Category drop-down list, select a report category.

  2. Click New. The General tab of the Report Template dialog will be displayed.

  3. Enter the details.

  4. Select the Groups tab.

  5. Enter the details.

  6. Select the Formula tab.

  7. Enter the details.

  8. Select the Notes tab.

  9. Enter the details.

  10. Click OK. The dialog will close and a new report template will be created.

Report Template Dialog - General Tab

The General tab is used to manage basic information about the report template, such as template, type, filename, and location.

 

General Group

Field

Description

Field

Description

Category

Report category to which the report template belongs. Click the Category popup button to select.

To create a report category, see Category.

Sort Template

Sort template allocated to the report template. Click the Sort Template popup button to select. Standard selections include: 

  • Client Reference Name

  • Job Address

  • Site Start, Job Address

If empty, Framework ECM will use the sort order from the report.

Report Type

Type of report allocated to the report template. Click the Report Type popup button to select.

Example

Work Flow, Activity, Chart, Bin, Document, etc.



Criteria Method

Specific criteria method selected for the report template. The criteria method refers to the data that will be displayed in the report. Click the Criteria Method popup button to select.

If the criteria method is modified for a report template, all reports based on that report template will also require updating (see Report).



Name

Name given to the report template.

Typically, the report type is used in the name, followed by a colon, and a description of what the report does. If there is a similarly-named report but using a different-size paper, it is often included in the name of the report.

Example

Work Flow: Pre_Admin Overview A4



Reference

Reference name given to the report template. Click the Reference copy button to copy the report template name or manually enter a reference name.

Folder Name

Physical location of the report template file.



File Name

Full file name of the report template, including the file extension.



Custom Location?

Is the report template located somewhere other than in the default report location?

  • No (default): The report is located in or under the default report location.

  • Yes: The report is placed in a location other than the default. The Custom Location Name field must be entered.



Custom Location Name

Custom location of the report.

Can Print?



Can Preview?



Can Export?



Force Native Engine?



Force Native SQL?



Report Template Dialog - Groups Tab

The Groups tab is used to manage groups that have been created for the report templates. By permitting the value and string values to be changed within the report template gives users some flexibility in changing report groupings.

 

Report Groups List

The information contained in this list can be edited on the Report Group dialog.

Column

Description

Column

Description

Order

Order in which the group appears in the Report Groups list.

Name

Name of the report group.

Example: Group 1, Group 2, etc.

Notes

Notes about the group.

Procedures

Adding A Report Group

  1. Click . The General tab of the Report Group dialog will be displayed.

  2. Enter the details.

  3. Select the Notes tab.

  4. Enter any notes, if required.

  5. Click OK. The dialog will close a report group will be created.

Report Template Dialog - Formula Tab

The Formula tab is used to view formulas that are applied to the report template. Formulas are added using the Report Formula dialog.

 

Report Formulas List

The information contained in this list can be edited on the Report Formula dialog.

Column

Description

Column

Description

Order

Order in which the formula appears in the Report Formulas list.

Name

Name of the report formula as it appears in the report.

Default Value

Default value of the report formula. Typically this is a Boolean or date value.

Notes

Description of the report formula.

Procedures

Adding A Report Formula

  1. Click . The Report Formula dialog will be displayed.

  2. Enter the details.

  3. Click OK. The dialog will close a report formula will be created.

Report Template Dialog - Notes Tab

The Notes tab is used to manage notes about the report template.