Module

Report design information common to report designs and libraries. This is most of the report except for the body.

Description

The module element describes the common characteristics between libraries and designs. It provides a wide variety of properties to help people understand the module, and provide lists of most components: page setup, data sources, data sets, reusable report items, and so on.

Name Spaces

ROM defines a number of name spaces within a report design. A name space holds a set of named components. Each name space is independent of the other. ROM name spaces are:

Name Space Contents
Styles Shared styles
Data Sources Data sources (database connections)
Data Sets Queries and other data sources
Master Pages Page definitions.
Layout Elements All visual elements such as lists, tables, etc.
Parameters Report parameters

The name is optional for elements that can appear in the Layout Elements name space. The name is required for all other elements.

See Also

Report Design element

Library element

author

The person who created the report.

Description

The person who created the report. The user can fill this in to keep track of the person who wrote the report, or is responsible for maintaining the report. This is purely documentation; BIRT does not use this property at runtime.

See Also

Module element createdBy Property

includeResource

Resource file name which stores the externalized strings.

Description

Report designs support externalized strings by storing the resource keys; which are stored in the resource file. This property stores the resource file name.

See Also

 

comments

Text that describes the report design.

Description

Text that describes the report design. It can contain embedded HTML. The comments are notes for the people who develop and maintain the report. Comments cannot be externalized. BIRT does not use this information at runtime, it is purely documentation for the report developer.

See Also

 

createdBy

Name of the tool that created the design.

Description

Name of the tool that created the design. Designs created by BIRT will contain the text "BIRT Version xxx". Customers or third parties who generate designs can insert their product name here. This is purely a documentation property; BIRT does not use it at runtime.

See Also

author property

description

A description presented to the end user of report when it is deployed.

Description

A description presented to the end user of report when it is deployed. Can contain HTML. Can be externalized. This is a full description, and can be shown to the user when using the report in the UI. The actual use of this property is determined by the application UI.

See Also

title property

descriptionID

The resource key for the description.

Description

Localization resource key for the description presented to the end user of report.

See Also

descriptionproperty

 

includeScripts

The name(s) of JavaScript files to include into this report.

Description

The name(s) of JavaScript files to include into this report. BIRT reads and executes these scripts before calling the initialize method for the design. The scripts can define reusable variables, functions, objects, Java imports and so on. The design can contain any number of script includes.

See Also

initialize method

title

A short description of the report presented to the user when the report is deployed.

Description

A short description of the report presented to the user when the report is deployed. The string can be externalized. The use of the string depends on the application UI used at deployment.

See Also

description property

title property

titleID

The resource key for the title

Description

Localization resource key for the title

See Also

title property