Report template model

A report template is defined by two files that have the same name but different extensions:

  • BIRT file (.rptemplate)
  • Properties file (.xml): describes the properties of the report template.

The BIRT report template (.rpttemplate) can reference other BIRT files:

  • libraries (.rptlibrary)
  • dictionaries (.properties)
  • styles (.css)

In the XML file, a report template is defined by:

Name Description
Name Identifies the reports that are associated with the same target type.
Label Key in the component dictionary or in the predefined dictionary called reporting used to display the report
Description Key in the component dictionary or in the predefined dictionary called reporting used to display a description of the report template
Category Grouping property used to apply permissions to a group of report templates
Multiplicity

Specifies if the report template can be used for:

  • 1 – a single selected object
  • n – a list of selected objects
Shared

Define if the generated reports can be viewed by other authorized users. The generated report gets the same shared attribute value as their template.

  • true
  • false
Target component type
  • Datastore
Type

When user-defined, it can be:

  • default
  • form
  • null
Subqueries

Queries that must be executed after the main query:

  • dir1/goToParents
  • dir1/goToChildren
Filter

Note: The <filter> section of the file is not used in Datastore!

Design filter:

  • Collection Type + version: the report template is used on instances of the given collection type
  • Collection Type: the report template can be used for any version of the collection type
  • Object Type + version: the report template can be used on instances of the given object type
  • Object Type + Version + path: the report template can be used on instances of the given object type for the give element type
  • Object Type: the report template can be used for any version of the given object type
  • Object Type + path: the report template can be used on the given element type of any version of the object type
  • Tag: the report template can be used for the types that owns the given tag
Query Name Name of the query for which the report template is applicable.
User properties

For each user parameter a new <parameter> tag must be defined inside the <userParameters> tag with the following attributes:

  • Name: the parameter name as it is defined in the report template file. It can be internationalized in the Designer by defining a key with the same name in the reporting dictionary.
  • Type: the parameter data type with possible values : STRING, INTEGER, LONG, DECIMAL, DATE, DATETIME
  • Mandatory (always visible): specifies if the parameter value is required or not with possible values true or false
  • Default value: an optional default value

Related Links