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
  • InterPlay
Type

When user-defined, it can be:

  • default
  • form
  • null
Filter

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
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
ClosedView InterPlay example:

<?xml version="1.0" encoding="UTF-8"?>

<reportProperties>

<name>defaultReport</name>

<!-- The category of the report, used for setting permissions on a group of reports -->

<category>audit</category>

 

<!-- The label of the report, will be internationalized and displayed in the grid -->

<label>report.key</label>

 

<!-- The component type for which the report is created can be: InterPlay -->

<componentType>InterPlay</componentType>

 

<!-- The label of the report, will be internationalized and displayed in the grid -->

<description>Custom report for ACCDOC</description>

 

<!-- Report created using this template will be visible to all users (shared=true) or only the creation author (shared=false) -->

<shared>true</shared>

 

<!-- Multiplicity of the report: can be 1 (current element) or n (multiple elements) -->

<multiplicity>1</multiplicity>

 

<!-- Design filter used to choose the type for which the report is applicable -->

<filter>

<objectTypeName>ACCDOC</objectTypeName>

<objectTypeVersion>1</objectTypeVersion>

<path>ACCDOC_1</path>

 

<!-- <tag>tagAudit</tag> -->

</filter>

 

<!-- User parameters that the user can specify before generating a report-->

<userParameters>

<parameter>

<!-- Name must match the parameter from the BIRT template-->

<name>CURRENCY</name>

<!-- Type must match the parameter from the BIRT template.-->

<dataType>STRING</dataType>

<defaultValue>EUR</defaultValue>

<mandatory>true</mandatory>

</parameter>

</userParameters>

</reportProperties>

Related topics

About the BIRT tool

Manage reports

Generate reports with Report Server

Manage reports with Report Server

Internationalize reports

Customize reports

Manage reports using REST services

Related Links