Parameter

The base parameter element defines properties common to all types of parameters.

Description

The base parameter element defines properties common to all types of parameters. Parameters can be hidden, meaning that they will not appear in the UI. Parameters also provide additional pop-up help text that can explain the use of the parameter to the end user.

Inherited Properties

name
The internal name of the parameter, inherited from Report Element. Expressions in the report reference the parameter using this name. The name must be unique among parameters and parameter groups. The user will see this name unless the display name is defined. The name cannot be externalized.
extends
A parameter can extend a parameter defined in a library, but not another parameter defined within the report design.
displayName
The prompt text to display in the UI. The display name can be externalized. If the display name is omitted, the Requester page will display the parameter name instead.

See Also

hidden

Hides the parameter from the parameter UI.

Description

If true, the parameter will not appear in the Requester page. Allows the developer to create parameters for internal use, or for use by scripts. Parameters are visible by default.

See Also

concealValue property of the Scalar Parameter

helpText

Additional text to display for the parameter to explain how to use the parameter.

Description

Additional text to display for the parameter to explain how to use the parameter. The string can be externalized.

See Also

helpTextID

Resource key for the helpText

Description

helpText can be externalized. helpTextId is the resource key for the helpText.

See Also

validate

Validation method associated with the parameter

Description

User can implement this method to perform custom validation for a particular parameter. This method is called during report execution, to validate the parameter value.

See Also