InterPlay specific templates

The InterPlay default report templates generated by the Report Server can be used as a starting point for the creation of custom report templates. BIRT report templates can also be created from scratch, but they must use the database view created for a specific collection type or object type.

Default report templates are generated at deploy time for each collection type, object type and hierarchy of element types that has the Reporting property set to Manual. They are automatically imported in the Configuration Repository and can be used in InterPlay to generate reports without any modification.

To be able to modify the generated templates, you must export them using the exportReportTemplates command from the Repository console.

The following files are generated:

File Description
Form template File generated for each collection type, object type and element type. It contains all the visible properties and system properties of the current entity.
Default template File generated for each collection type, object type and element type that has sub-elements. It contains all the visible properties and system properties of the current entity and a table with the list of sub-elements. The first 5 visible properties are included in the table header.
Dictionary File generated for each type. It contains all the system and user properties.
Libraries

Two types of files can be generated:

  • default.rptlibrary: contains the common master page, CSS styles and AXWAY embedded logo image. All the styles used in the libraries are defined in a css stylesheet document.

  • BIRT library files for each supported database type (Oracle, MySQL and MSSQL), containing the datasource (connection parameters to the database) and datasets (SQL used to query the views).

The default templates (form and default) use some system parameters used to filter the data in the generated report:

Name Description
USERNAME(String) Identifies the name of the user that generated the request.
ID_COLLECTION(Long) Identifies the collection on which the report is generated.
ID_BOBJECT(String) Identifies the object on which the report is generated.
ID_ELEMENT(String) Identifies the element on which the report is generated.
ID_LEVELn (n=1..7) Identifies the elements on which the report is generated.

Naming conventions

In the generated libraries and the report templates, the datasets follow these naming conventions:

Dataset type Naming convention
Collection type dtBCT_[COLLECTION_TYPE_NAME]_[COLLECTION_TYPE_VERSION]
Object data dtBOT_[OBJECT_TYPE_NAME]_[OBJECT_TYPE_VERSION]
Element data dtBET_[OBJECT_TYPE_NAME]_[OBJECT_TYPE_VERSION]_[ELEMENT_PATH] dtBETform_[OBJECT_TYPE_NAME]_[OBJECT_TYPE_VERSION]_[ELEMENT_PATH]

Related Links