ParameterDefinition
A complex data type that defines a report parameter.
Schema
<xsd:complexType name="ParameterDefinition">
<xsd:all>
<xsd:element name="Group" type="xsd:string" minOccurs="0"/>
<xsd:element name="CascadingParentName" type="xsd:string"
minOccurs="0"/>
<xsd:element name="Name" type="xsd:string"/>
<xsd:element name="Position" type="xsd:int" minOccurs="0"/>
<xsd:element name="DataType" type="typens:DataType"
minOccurs="0"/>
<xsd:element name="DefaultValue" type="xsd:string"
minOccurs="0"/>
<xsd:element name="DefaultValueIsNull" type="xsd:boolean"
minOccurs="0"/>
<xsd:element name="IsRequired" type="xsd:boolean"
minOccurs="0"/>
<xsd:element name="IsPassword" type="xsd:boolean"
minOccurs="0"/>
<xsd:element name="IsHidden" type="xsd:boolean"
minOccurs="0"/>
<xsd:element name="DisplayName" type="xsd:string"
minOccurs="0"/>
<xsd:element name="HelpText" type="xsd:string"
minOccurs="0"/>
<xsd:element name="IsAdHoc" type="xsd:boolean"
minOccurs="0"/>
<xsd:element name="ColumnName" type="xsd:string"
minOccurs="0"/>
<xsd:element name="ColumnType" type="typens:DataType"
minOccurs="0"/>
<xsd:element name="SelectValueList"
type="typens:ArrayOfString" minOccurs="0"/>
<xsd:element name="SelectNameValueList" type="typens:ArrayOfNameValuePair" minOccurs="0"/>
<xsd:element name="ControlType" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:enumeration value="AutoSuggest"/>
<xsd:enumeration value="ControlRadioButton"/>
<xsd:enumeration value="ControlList"/>
<xsd:enumeration value="ControlListAllowNew"/>
<xsd:enumeration value="ControlCheckBox"/>
<xsd:enumeration value="FilterSimple"/>
<xsd:enumeration value="FilterAdvanced"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="OperatorList"
type="typens:ArrayOfString" minOccurs="0"/>
<xsd:element name="RecordDefinition"
type="typens:ArrayOfFieldDefinition" minOccurs="0"/>
<xsd:element name="DefaultTableValues"
type="typens:ArrayOfRecord" minOccurs="0"/>
<xsd:element name="DataSourceType"
type="typens:DataSourceType" minOccurs="0"/>
<xsd:element name="IsViewParameter" type="xsd:boolean"
minOccurs="0"/>
<xsd:element name="AutoSuggestThreshold" type="xsd:long"
minOccurs="0"/>
<xsd:element name="IsDynamicSelectionList" type="xsd:boolean"
minOccurs="0"/>
</xsd:all>
</xsd:complexType>
Elements
Group
The parameter group.
CascadingParentName
The cascading parent name for this parameter definition.
Name
The parameter name.
Position
The index location of the parameter in the information object (.iob) or data source map (.sma) file. The index is 1‑based. If this is a regular parameter, do not specify a value or specify 0.
DataType
The data type of the parameter. Valid values are:
Currency
Date
Double
Integer
String
Boolean
Structure
Table
DefaultValue
The default value of the parameter.
DefaultValueIsNull
Flag indicating the default value is null.
IsRequired
Specifies whether the parameter is required.
IsPassword
Specifies whether a password is required.
IsHidden
Specifies whether the parameter is hidden.
DisplayName
The display name of the parameter.
HelpText
The text to display when the user holds the cursor over a parameter. For example, a value of a data column.
IsAdHoc
Specifies whether the parameter is ad hoc.
ColumnName
The name of the column on which the ad hoc parameter operates. Required for operations that include a Query element with IsAdHoc set to True, ignored otherwise.
ColumnType
The type of the column on which the ad hoc parameter operates. Required for operations that include a Query element with IsAdHoc set to True, ignored otherwise.
SelectValueList
The list of available parameter values.
SelectNameValueList
The list of available parameter names.
ControlType
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
OperatorList
Contains the operators used with ad hoc parameters.
RecordDefinition
The name and value of the field in the table. Used for a table parameter.
DefaultTableValues
The default values of table rows. Used for a table parameter.
DataSourceType
The type of file in which the parameter exists. Valid values are:
ABInfoObject
An Actuate Basic information object. This is the default value.
InfoObject
An information object.
IsViewParameter
Whether the parameter is a view parameter. The default value is False.
AutoSuggestThreshold
The minimum number of characters to be entered before the AutoSuggest selection list is displayed.
IsDynamicSelectionList
Flag indicating whether the selection list is dynamic or static.