Eclipse BIRT Report Object Model (ROM)

Module Element

# Element Overview

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

### Details

Display Name: | Module
Since: | 2.0
XML Element: | `None`
Extends: | None
Extendable: | No
Abstract: | Yes
Name Space: | None
Name Requirement: | Not Supported
Allows User Properties: | No
Has Style: | No

### Property Summary

author
  The person who created the report.
comments
  Text that describes the report design.
createdBy
  Name of the tool that created the design.
description
  A description presented to the end user of report when it is deployed.
descriptionID
  The resource key for the description.
includeResource
  Resource file name which stores the externalized strings.
includeScripts
  The name(s) of JavaScript files to include into this report.
scriptLibs
title
  A short description of the report presented to the user when the report is deployed.
titleID
  The resource key for the title

### 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. It also provides a list of custom color definitions.

#### 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

# Property Detail

## author Property

The person who created the report.

### Details

Type: | string
Since: | 1.0
Required: | No
Display Name: | Author
JavaScript Type: |
Default Value: | None
Inherited: | No
Runtime Settable: | No
Property Sheet Visibility: | Visible
Property Sheet Group: | Top

### 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

## comments Property

Text that describes the report design.

### Details

Type: | html
Since: | 1.0
Required: | No
Display Name: | Comments
JavaScript Type: |
Default Value: | None
Inherited: | No
Runtime Settable: | Yes
Property Sheet Visibility: | Visible
Property Sheet Group: | Top

### 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

See the `helpGuide` and the `description` properties for a way to provide information for the users of the report.

## createdBy Property

Name of the tool that created the design.

### Details

Type: | string
Since: | 1.0
Required: | No
Display Name: | Created by
JavaScript Type: |
Default Value: | None
Inherited: | No
Runtime Settable: | No
Property Sheet Visibility: | Visible
Property Sheet Group: | Top

### 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 Property

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

### Details

Type: | html
Since: | 2.0
Required: | No
Display Name: | Description
JavaScript Type: |
Default Value: | None
Inherited: | No
Runtime Settable: | No
Property Sheet Visibility: | Visible
Property Sheet Group: | Top

### 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

`helpGuide` property

## descriptionID Property

The resource key for the description.

### Details

Type: | resourceKey
Since: | 2.0
Required: | No
Display Name: | Description key
JavaScript Type: |
Default Value: | None
Inherited: | No
Runtime Settable: | Yes
Property Sheet Visibility: | Visible
Property Sheet Group: | Top

### Description

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

### See Also

description property

## includeResource Property

Resource file name which stores the externalized strings.

### Details

Type: | list
Since: | 1.0
Required: | No
Display Name: | Include resource
JavaScript Type: |
Default Value: | None
Inherited: | No
Runtime Settable: | No
Property Sheet Visibility: | Visible
Property Sheet Group: | Top

### 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

## includeScripts Property

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

### Details

Type: | List of IncludeScript Structures
Since: | 1.0
Required: | No
Display Name: | Include scripts
JavaScript Type: |
Default Value: | None
Inherited: | No
Runtime Settable: | No
Property Sheet Visibility: | Hidden
Property Sheet Group: | Top

### 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

## scriptLibs Property

### Details

Type: | List of ScriptLib Structures
Since: | 2.1.1
Required: | No
Display Name: | Script libraries
JavaScript Type: |
Default Value: | None
Inherited: | No
Runtime Settable: | No
Property Sheet Visibility: | Hidden
Property Sheet Group: | Top

## title Property

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

### Details

Type: | string
Since: | 1.0
Required: | No
Display Name: | Title
JavaScript Type: |
Default Value: | None
Inherited: | No
Runtime Settable: | No
Property Sheet Visibility: | Visible
Property Sheet Group: | Top

### 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

`helpGuide` property

`title` property

## titleID Property

The resource key for the title

### Details

Type: | resourceKey
Since: | 1.0
Required: | No
Display Name: | Title key
JavaScript Type: |
Default Value: | None
Inherited: | No
Runtime Settable: | Yes
Property Sheet Visibility: | Visible
Property Sheet Group: | Top

### Description

Localization resource key for the title

### See Also

`title` property