Eclipse BIRT Report Object Model (ROM)

ConfigVar Structure

Structure Overview

Define a varialbe mostly for deployment-specific purpose.

Details

Display Name: Config Variable
Since:

Property Summary

name
Name of the variable.
value
Value of the configuration variable.

Description

A report can have deployment-specific dependencies. For example, report developers ofen use a test database during development, but target a production database once the report is deployed online. Or, an OEM company may use a different company name in report titiles for each of their customers.

Experiences suggest that changing the report design to reflect these changes is both tedious and error-prone. We need a simple solution. Therefore, BIRT provides configuration variables. A configuration variable is simply a name/value pair very similar to an environment variable in Unix. Indeed, configuration variables include environment variables, along with BIRT-specific values.

Property Detail

name Property

Name of the variable.

Details

Type: name
Since: 1.0
Required: No
Display Name: Name
JavaScript Type:
Default Value: None
Runtime Settable: Yes

Description

A configuration variable has a unique and required name, report use the name to references a configuration variable.


value Property

Value of the configuration variable.

Details

Type: literalString
Since: 1.0
Required: No
Display Name: Value
JavaScript Type:
Default Value: None
Runtime Settable: Yes

Description

Value of the configuration variable, report can override this value to provide a default value.