ParameterDefinition
A complex data type that defines a report parameter.
Elements
Group
String. Optional. The parameter group.
Name
String. The parameter name.
Position
Int. Optional. The index location of the parameter in the information object (.iob) or data source map (.sma) file. The index is 1‑based. For a regular parameter, do not specify a value or specify 0.
DataType
String. Optional. The data type of the parameter. Valid values are:
Currency
Date
Double
Integer
String
Boolean
Structure Obsolete since Actuate release 11
Table Obsolete since Actuate release 11
DefaultValue
String. Optional. The default value of the parameter.
IsRequired
Boolean. Optional. Specifies whether the parameter is required.
IsPassword
Boolean. Optional. Specifies whether a password is required.
IsHidden
Boolean. Optional. Specifies whether the parameter is hidden.
DisplayName
String. Optional. The display name of the parameter.
IsAdHoc
Boolean. Optional. Specifies whether the parameter is ad hoc.
ControlType
String. Optional. The type of control used to represent the parameter. Valid values are:
AutoSuggest
An autosuggest control
ControlRadioButton
A radio button
ControlList
A drop-down list
ControlListAllowNew
A text box
ControlCheckBox
A check box
FilterSimple
A simple filter
FilterAdvanced
An advanced filter
SelectValueList
ArrayOfString. Optional. The list of available parameter values.
OperatorList
ArrayOfString. Optional. Contains the operators used with ad hoc parameters.
ColumnName
Obsolete since iHub release 2.
ColumnType
Obsolete since iHub release 2.
RecordDefinition
Obsolete since iHub release 2.
DefaultTableValues
Obsolete since iHub release 2.
DataSourceType
Obsolete since iHub release 2.
CascadingParentName
String. Optional. The cascading parent name for this parameter definition.
SelectNameValueList
ArrayOfNameValuePair. Optional. The list of names of available parameters.
HelpText
String. Optional. The text to display when the user holds the cursor over a parameter. For example, a value of a data column.
IsViewParameter
Boolean. Optional. Whether the parameter is a view parameter. The default value is False.
IsDynamicSelectionList
Boolean. Optional. Flag indicating whether the selection list is dynamic or static.
AutoSuggestThreshold
Int. Optional. The minimum number of characters to be entered before the AutoSuggest selection list is displayed.
StartExpanded
GroupPromptText
DefaultValueIsNull
Boolean. Optional. Flag indicating that the default value is null.