IDAPI data types quick reference
Table 3‑1 lists the Actuate IDAPI data types. For more information about IDAPI data type WSDL definitions, see Understanding the Information Delivery API and schema.
Table 3‑1 IDAPI data type summary
Data Type
Description
Date and run options for a job
Hexadecimal double
Null value
Controls the ability to create, delete, update, copy, and move items within a volume.
Arrays of singular data types
An attachment as binary data
Standard XML base64Binary data type
Bookmark metadata from a report document
Primitive XML boolean data type
Status of a cancel job request
User capabilities for specific tools
Type of data within a column
The schema of a column
A file or list of files to copy
A counter object
A file type to create
A folder to create
A user to create
A user group to create
Details for a custom event
Enumerated value for daily setting
Details of a database connection
Type of data within a data cell
Format of a file and its mime type
Details of a filter condition
Information from a data row
Details of a data schema by column
Details of a sorted data column
The type of file in which a parameter exists
Details of a data type
A date
A date and time
Primitive XML decimal data type
Details of a file or folder to delete
Details of a file type to delete
Details of a job to delete
Details of job notices to delete
Details of a schedule to delete
Details of a user to delete
Details of a user group to delete
Conversion options of a file
Primitive XML double data type
Describes an event and its status
Describes polling and other options for an event
A type of event
The status of a temporary report
The external name of an administrator user
The external name of the Administrators user group
A scalar parameter
Describes a file
A file’s access type
The field and condition for a file search
A list of attached files or the content of embedded files
Information about file type events
Lists file fields upon which a search can be performed
A file search object
A file type
The contents of a SOAP header
Data from a BIRT information object
An information object’s data format
Primitive XML integer data type
The field and condition to match for a job search
Information about job type events
Describes job fields
Job input and output files
A job notice
The field and condition for job notice field search
Describes notice fields
A notice search object
Describes job printer options
General job attributes
Details about a job schedule
The field and condition for schedule field search
A schedule for running a job
Describes schedule fields
A schedule search object
A file search object
A license option
Primitive XML long data type
Describes a Message Distribution service (MDS)
Enumerated value for monthly setting
Moves files or folders to a new location
A named piece of data and its value
Describes a file
Describes object identifiers
Describes page numbers
Defines a report parameter
Value of a report parameter
A job in the factory queue
A user or user group’s privileges
Describes a printer
Describes printer options
A filter based on user or user group privileges
A name-value pair
A job frequency
Describes parameter types
Defines a resource group
Describes resource group settings
The schema for a result set
Retry options after failed report generation or printing
Describes retry option types
Describes a running job
A scalar parameter type
Describes a BIRT iHub server
Describes the settings of a resource group
Describes the current state of Actuate iHub
Describes the detailed status of Actuate iHub
Describes the version of Actuate iHub
Simple XML service data type
Primitive XML short data type
A streamed image
Primitive XML string data type
Describes the network configuration of an iHub System
Standard XML Time data type
Packaging mechanism for Administrate operations
The name of a data type
Operation that reverses a DeleteUser operation
Describes an update of file or folder details
Operation to update file or folder details
Sequence of operations to update file or folder details
Describes an update of a file type
Operation to update a file type
Sequence of operations to update a file type
Describes an update of a job schedule
Operation to update a job schedule
Sequence of operations to update a job schedule
Describes a security cache refresh operation
Describes an update of a user
Describes an update of a user group
Operation to update a user group
Sequence of operations to update a user group
Operation to update a user
Sequence of operations to update a user
Describes an update of volume properties
Operation to update volume properties
Sequence of operations to update volume properties
Describes a user
The field and condition to match for a user search
Describes the fields within a user element
Describes a user group
The field and condition to match for a user group search
Lists user group fields on which a search can be performed
A user group search object
A user search object
Options for handling the latest existing version
Describes a viewing parameter
Describes a volume
Enumerated value for weekly setting
AbsoluteDate
A complex data type that includes a date and run options for a job.
Elements
RunOn
String. The date that a job is scheduled to run.
OnceADay
String. The days a job is to be run.
Repeat
Repeat. Repeats the job run during a set start and stop time.
acDouble
A simple data type that represents a hexadecimal double.
acNull
A simple data type that represents a null value.
AdminOperation
Controls the ability to create, delete, update, copy, and move items within a volume. An AdminOperation request represents a single unit of work within an Administrate operation. Only a volume administrator or a user in the Administrator user group uses these operations.
Elements
Transaction
A packaging mechanism for Administrate operations. If a failure occurs anywhere in a transaction, all operations in the transaction fail.
CreateUser
Creates a user in the volume.
DeleteUser
Deletes one or more users.
UndeleteUser
Undeletes one or more previously deleted users within the unit of work.
UpdateUser
Updates user properties.
CreateUserGroup
Creates a user group.
DeleteUserGroup
Deletes one or more user groups.
UpdateUserGroup
Updates user group properties.
CreateFileType
Creates a new file type in BIRT iHub.
DeleteFileType
Deletes file types.
UpdateFileType
Updates file type properties in the volume.
CreateFolder
Creates a folder in a volume.
DeleteFile
Deletes files or folders from the volume.
MoveFile
Moves a file or folder from the working directory to a specified target directory in the volume.
CopyFile
Copies a file or folder in the working directory to a specified target directory.
UpdateFile
Updates file or folder properties in the volume.
DeleteJob
Deletes one or more jobs.
DeleteJobNotices
Deletes one or more job notices.
DeleteJobSchedule
Deletes a job schedule.
UpdateJobSchedule
Updates a job schedule.
UpdateVolumeProperties
Updates the properties of a specific volume.
UpdateOpenSecurityCache
Flushes the volume’s open security cache and retrieves new data from an external security source.
Aggregation
Obsolete since iHub Release 2.
ArchiveRule
A complex data type that represents an archiving rule.
Elements
FileType
String. The file type. Cannot exceed 20 characters.
NeverExpire
Boolean. Optional. Specifies whether the object expires.
ExpireDependentFiles
Boolean. Optional. Specifies whether the object’s dependent files expire when the object is expired.
ArchiveOnExpiration
Boolean. Optional. Specifies whether the object is archived before it is expired.
ExpirationAge
Long. Optional. The expiration age for the object. Use either this element or ExpirationTime, but not both.
ExpirationTime
DateTime. Optional. The expiration time for the object. Use either this element or ExpirationAge, but not both.
IsInherited
Boolean. Optional. Specifies whether the rule is inherited.
InheritedFrom
Boolean. Optional. The object from which the rule is inherited.
Argument
Obsolete since iHub Release 2.
Arrays of data types
Data type definitions can be grouped into arrays. Each array has a specific definition for that data type. IDAPI supports empty arrays having no entries.
The schema for an array of a data type generally follows the following pattern:
<xsd:complexType name="ArrayOfX">
<xsd:sequence>
<xsd:element name="X" type="typens:X"
maxOccurs="unbounded" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
In the above listing, X is the data type of object the array contains. For example, the XML for an array of UserGroup objects is:
<xsd:complexType name="ArrayOfUserGroup">
<xsd:sequence>
<xsd:element name="UserGroup" type="typens:UserGroup"
maxOccurs="unbounded" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
The following data types have arrays defined in this manner:
*Aggregation
*JobProperties
*ArchiveRule
*JobScheduleCondition
*Argument
*JobScheduleDetail
*Attachment
*LicenseOption
*Capabilities
*MDSInfo
*Channel
*NameValuePair
*ChannelCondition
*ParameterDefinition
*ColumnDefinition
*ParameterValue
*ColumnSchema
*PendingSyncJob
*Component
*Permission
*ComponentIdentifier
*Printer
*CounterInfo
*PrinterOptions
*DataExtractionFormat
*PropertyValue
*DataFilterCondition
*Record
*DataRow
*ResourceGroup
*DataSortColumn
*ResourceGroupSettings
*DocumentConversionOptions
*ResultSetSchema
*FieldDefinition
*Role
*File
*RoleCondition
*FileCondition
*RunningJob
*FileContent
*ServerInformation
*FileType
*ServerResourceGroupSetting
*FilterCriteria
*Service
*Group
*SortColumn
*GroupCondition
*String
*Grouping
*Time
*IOCacheDBIndexConstraint
*User
*JobCondition
*UserCondition
*JobNotice
*UserGroup
*JobNoticeCondition
*UserGroupCondition
Some array definitions are different from the ones listed above. These arrays have a type definition for the element other than what appears in the array name. For example, the ArrayOfDate is defined as:
<xsd:complexType name="ArrayOfDate">
<xsd:sequence>
<xsd:element name="Date" type="typens:string"
maxOccurs="unbounded" minOccurs="0" />
</xsd:sequence>
</xsd:complexType>
In this definition, the element name is Date, but its type is defined as a string. The ArrayOfDate type is defined as an array of string elements. The arrays in this format are listed in Table 3‑2, along with the associated element type.
Table 3‑2 Non‑standard arrays 
Array type
Element type
Date
string
String
string
Int
int
Component
ComponentType
Long
long
ArrayOfAggregation
Obsolete since iHub Release 2.
ArrayOfArchiveRule
ArrayOfArchiveRule is a complex data type that represents an array of ArchiveRule objects.
ArrayOfArgument
Obsolete since iHub Release 2.
ArrayOfAttachment
ArrayOfAttachment is a complex data type that represents an array of Attachment objects.
ArrayOfBookMark
ArrayOfBookMark is a complex data type that represents an array of BookMark objects.
ArrayOfCapabilities
ArrayOfCapabilities is a complex data type that represents an array of Capabilities objects.
ArrayOfChannel
Obsolete since iHub Release 3.
ArrayOfChannelCondition
Obsolete since iHub Release 3.
ArrayOfColumnDefinition
Obsolete since iHub Release 2.
ArrayOfColumnSchema
ArrayOfColumnSchema is a complex data type that represents an array of ColumnSchema objects.
ArrayOfComponent
Obsolete since iHub Release 2.
ArrayOfComponentIdentifier
Obsolete since iHub Release 2.
ArrayOfCounterInfo
ArrayOfCounterInfo is a complex data type that represents an array of CounterInfo objects.
ArrayOfDataExtractionFormat
ArrayOfDataExtractionFormat is a complex data type that represents an array of DataExtractionFormat objects.
ArrayOfDataFilterCondition
ArrayOfDataFilterCondition is a complex data type that represents an array of DataFilterCondition objects.
ArrayOfDataRow
ArrayOfDataRow is a complex data type that represents an array of DataRow objects.
ArrayOfDataSortColumn
ArrayOfDataSortColumn is a complex data type that represents an array of DataSortColumn objects.
ArrayOfDate
ArrayOfDate is a complex data type that represents an array of Date objects.
ArrayOfDocumentConversionOptions
ArrayOfDocumentConversionOptions is a complex data type that represents an array of DocumentConversionOptions.
ArrayOfFieldDefinition
ArrayOfFieldDefinition is a complex data type that represents an array of FieldDefinition objects.
ArrayOfFile
ArrayOfFile is a complex data type that represents an array of File objects.
ArrayOfFileCondition
ArrayOfFileCondition is a complex data type that represents an array of FileCondition objects.
ArrayOfFileContent
ArrayOfFileContent is a complex data type that represents an array of FileContent objects.
ArrayOfFileType
ArrayOfFileType is a complex data type that represents an array of FileType objects.
ArrayOfFilterCriteria
Obsolete since iHub Release 2.
ArrayOfGroup
Obsolete since iHub Release 2.
ArrayOfGroupCondition
Obsolete since iHub Release 2.
ArrayOfGrouping
Obsolete since iHub Release 2.
ArrayOfInt
ArrayOfInt is a complex data type that represents an array of Int objects.
ArrayOfIOCacheDBIndexConstraint
Obsolete since iHub Release 2.
ArrayOfJobCondition
ArrayOfJobCondition is a complex data type that represents an array of JobCondition objects.
ArrayOfJobNotice
ArrayOfJobNotice is a complex data type that represents an array of JobNotice objects.
ArrayOfJobNoticeCondition
ArrayOfJobNoticeCondition is a complex data type that represents an array of JobNoticeCondition objects.
ArrayOfJobProperties
ArrayOfJobProperties is a complex data type that represents an array of JobProperties objects.
ArrayOfJobScheduleCondition
ArrayOfJobScheduleCondition is a complex data type that represents an array of JobScheduleCondition objects.
ArrayOfJobScheduleDetail
ArrayOfJobScheduleDetail is a complex data type that represents an array of JobScheduleDetail objects.
ArrayOfLong
ArrayOfLong is a complex data type that represents an array of Long objects.
ArrayOfLicenseOption
ArrayOfLicenseOption is a complex data type that represents an array of LicenseOption objects.
ArrayOfMDSInfo
ArrayOfMDSInfo is a complex data type that represents an array of MDSInfo objects.
ArrayOfNameValuePair
ArrayOfNameValuePair is a complex data type that represents an array of NameValuePair objects.
ArrayOfParameterDefinition
ArrayOfParameterDefinition is a complex data type that represents an array of ParameterDefinition objects.
ArrayOfParameterValue
ArrayOfParameterValue is a complex data type that represents an array of ParameterValue objects.
ArrayOfPendingSyncJob
ArrayOfPendingSyncJob is a complex data type that represents an array of PendingSyncJob objects.
ArrayOfPermission
ArrayOfPermission is a complex data type that represents an array of Permission objects.
ArrayOfPrinter
ArrayOfPrinter is a complex data type that represents an array of Printer objects.
ArrayOfPrinterOptions
ArrayOfPrinterOptions is a complex data type that represents an array of PrinterOptions objects.
ArrayOfPropertyValue
ArrayOfPropertyValue is a complex data type that represents an array of PropertyValue objects.
ArrayOfRecord
Obsolete since iHub Release 2.
ArrayOfResourceGroup
ArrayOfResourceGroup is a complex data type that represents an array of ResourceGroup objects.
ArrayOfResourceGroupSettings
ArrayOfResourceGroupSettings is a complex data type that represents an array of ResourceGroupSettings objects.
ArrayOfResultSetSchema
ArrayOfResultSetSchema is a complex data type that represents an array of ResultSetSchema objects.
ArrayOfRole
Deprecated since iHub Release 3. Replaced by ArrayOfUserGroup.
ArrayOfRoleCondition
Deprecated since iHub Release 3. Replaced by ArrayOfUserGroupCondition.
ArrayOfRunningJob
ArrayOfRunningJob is a complex data type that represents an array of RunningJob in the Factory.
ArrayOfServerInformation
ArrayOfServerInformation is a complex data type that represents an array of ServerInformation objects.
ArrayOfServerResourceGroupSetting
ArrayOfServerResourceGroupSetting is a complex data type that represents an array of ServerResourceGroupSetting objects.
ArrayOfService
ArrayOfService is a complex data type that represents an array of Service objects.
ArrayOfString
ArrayOfString is a complex data type that represents an array of String objects.
ArrayOfUser
ArrayOfUser is a complex data type that represents an array of User objects.
ArrayOfUserCondition
ArrayOfUserCondition is a complex data type that represents an array of UserCondition objects.
ArrayOfUserGroup
ArrayOfUserGroup is a complex data type that represents an array of UserGroup objects.
ArrayOfUserGroupCondition
ArrayOfUserGroupCondition is a complex data type that represents an array of UserGroupCondition objects.
Attachment
A complex data type that describes the object in the attachment and contains the attachment as binary data.
Elements
ContentId
String. Maps to the attachment’s MIME header. ContentId is required.
ContentType
String. The type of file to upload, such as binary.
ContentLength
Long. Optional. The length of the object.
ContentEncoding
String. Optional. The encoding the object uses. Cannot exceed 10 characters.
Locale
String. Optional. The object locale.
ContentData
Base64Binary. Optional. The attachment as binary data. Use ContentData to embed the file in the request.
Base64Binary
A standard XML base64Binary data type.
BookMark
A complex data type that specifies the bookmark value, display name, and element type in a report document.
Elements
BookMarkValue
String. The bookmark value, such as the page number.
DisplayName
String. The display name of the bookmark.
ElementType
String. The element or component type.
BookMarkType
String. Optional. The bookmark type.
Boolean
A standard XML Boolean data type with a value of True or False.
CancelJobStatus
A simple data type that represents the status of a request to cancel a synchronous report.
Element
String. One of the following values:
Succeeded
The synchronous report generation was successfully cancelled.
Failed
The request to cancel a synchronous report failed.
InActive
The synchronous report generation is complete and cannot be cancelled.
Capabilities
A complex data type that represents the tasks that a user is permitted to perform using a specified tool. The tasks for each tool are grouped into a category.
Elements
Category
String. The name of a category, for example InteractiveViewer.
CapabilityNames
ArrayOfString. The list of tasks that the user is permitted to perform. The available capability names differ according to the category.
Channel
Obsolete since iHub Release 3.
ChannelCondition
Obsolete since iHub Release 3.
ChannelField
Obsolete since iHub Release 3.
ChannelSearch
Obsolete since iHub Release 3.
ColumnDefinition
Obsolete since iHub Release 2.
ColumnDetail
A complex data type that describes the type of data within a column.
Elements
name
String. The name of the column.
type
TypeName. The type of data within the column.
displayName
String. The display name of the column.
ColumnSchema
A complex data type that describes the schema of a column.
Elements
Name
String. The column name.
Alias
String. Optional. User-defined name for column.
DataType
Int. Optional. The data type of the column.
TypeName
String. The name of the data type.
Label
String. Optional. The column label.
Visibility
Boolean. Optional. Specifies whether column is visible. The default value is True.
AllowExport
Boolean. Optional. Specifies whether to allow exporting the column. The default value is True.
ComponentIdentifier
Obsolete since iHub Release 2.
ComponentType
Obsolete since iHub Release 2.
CopyFile
A complex data type describes a copied file or list of files. To copy a single file or folder, specify Name or Id. To copy a list of files or folders, specify NameList or IdList. To copy files or folders that match specific conditions, specify Search.
Elements
Target
String. The new location for the file or folder. The following rules apply:
*If Target is a file, the operation fails if the source contains a folder.
*If Target is a folder that does not exist, a folder is created.
*If Target is a folder and the source contains a single folder, the contents of the source folder are copied to the target folder and merged with target folder contents.
*If Target is a folder and the source contains a single file or multiple files and folders, the source files and folders are copied to the target folders. All source folders are copied as children of the target folder.
WorkingFolderName
String. The name of the working folder of the file or folder to copy. Specify either WorkingFolderName or WorkingFolderId.
WorkingFolderId
String. The ID of the working folder of the file or folder to copy. Specify either WorkingFolderId or WorkingFolderName.
Recursive
Boolean. Specifies whether to search subfolders. If True, the search includes subfolders. The default value is False.
Search
FileSearch. The search condition that specifies which folders or files to copy.
IdList
ArrayOfString. The list of file or folder IDs to copy. Specify either IdList or NameList.
NameList
ArrayOfString. The list of file or folder names to copy. Specify either NameList or IdList.
Id
String. The ID of the single file or folder to copy. Specify either Id or Name.
Name
String. The name of the single file or folder to copy. Specify either Name or Id.
ReplaceExisting
Boolean. If True, the copied file replaces the existing file, if one exists. If the existing file has any dependencies, it is not replaced regardless of the ReplaceExisting setting. If False or if the existing file has any dependencies, a new version of the file is created. The default value is True.
MaxVersions
Long. The maximum number of versions to create. MaxVersions applies only for files and is ignored for folders.
LatestVersionOnly
Boolean. Specifies whether all versions of the file are copied or only the latest version. Used only when a Search tag is specified. If True, only the latest version of the file that matches the search criteria is copied. If False, all versions of the file are copied. The default value is False.
CounterInfo
A complex data type that describes a counter.
Elements
CounterId
Long. The ID of the counter.
CounterName
String. The name of the counter.
CounterValue
Long. The value of the counter.
CreateChannel
Obsolete since iHub Release 3.
CreateFileType
Adds a file type. Available only to users with the Administrator user group.
Elements
FileType
FileType. The properties of the file type to add. The following properties are required:
*Name
*Extension
*IsNative
*IsExecutable
*OutputType
*IsPrintable
IgnoreDup
Boolean. Specifies whether to report an error when creating the file type if one with the same name already exists. BIRT iHub always rejects a duplicate request regardless of the IgnoreDup setting. If True, BIRT iHub does not report an error. If False, BIRT iHub reports an error. The default value is False.
CreateFolder
Creates a folder in a volume into which you are currently logged in. To create a folder, you must have permission to add folders to the volume.
Elements
WorkingFolderName
String. The name of the working folder for the new folder. Specify either WorkingFolderName or WorkingFolderId.
WorkingFolderId
String. The ID of the working folder for the new folder. Specify either WorkingFolderId or WorkingFolderName.
FolderName
String. The name of the new folder, relative to the working folder, if specified. If you do not specify a working folder, you must specify a full path.
Description
String. The description of the folder.
IgnoreDup
Boolean. Specifies whether to report an error when creating the folder if one with the same name already exists. BIRT iHub always rejects a duplicate request regardless of the IgnoreDup setting. If True, BIRT iHub does not report an error. If False, BIRT iHub reports an error. The default value is False.
CreateGroup
Obsolete since iHub Release 3.
CreateRole
Deprecated since iHub Release 3. Replaced by CreateUserGroup.
CreateUser
Creates a user. Available only to users in the Administrator user group.
Elements
User
User. The properties of the user to create. Only a user name is required.
IgnoreDup
Boolean. Specifies whether to report an error when creating the user if one with the same name already exists. BIRT iHub always rejects a duplicate request regardless of the IgnoreDup setting. If True, BIRT iHub does not report an error. If False, BIRT iHub reports an error. The default value is False.
CreateUserGroup
Creates a user group. Available only to users in the Administrator user group.
Elements
UserGroup
UserGroup. The properties of the user group to create. Only a user group name is required.
ProductFamilies
ArrayOfString. The list of product families associated with this user group.
IgnoreDup
Boolean. Specifies whether to report an error when creating the user group if one with the same name already exists. BIRT iHub always rejects a duplicate request regardless of the IgnoreDup setting. If True, BIRT iHub does not report an error. If False, BIRT iHub reports an error. The default value is False.
CustomEvent
A complex data type that specifies information used within a custom event.
Element
EventParameter
String. A value used within the custom event.
Daily
A complex data type that describes daily types of job scheduling.
Elements
FrequencyInDays
Long. The number of times a job is run daily in days.
OnceADay
String. Optional. A string representing when a job is to run once a day.
Repeat
Repeat. Optional. The number of times the schedule is repeated.
DatabaseConnectionDefinition
Obsolete since iHub Release 2.
DataCell
A complex data type describing the type of data within a data cell.
Elements
One of the following elements:
int
Int. An integer value.
sht
Short. A short value.
dbl
Double. A double value.
dbn
acDouble. An Actuate double value.
cur
String. A currency value.
dtm
DateTime. An date-and-time value.
str
String. A string value.
bln
Boolean. A Boolean value.
nll
acNull. The null value.
DataExtractionFormat
A complex data type that describes the format of a file and its mime type.
Elements
OutputFormat
String. The format of the file.
MimeType
String. The file mime type.
DataFilterCondition
A complex data type that describes a filter condition.
Elements
ColumnName
String. The name of the column to filter.
Operation
String. The filtering operation.
Operand1
String. The first operand of the filter.
Operand2
String. Optional. The second operand of the filter.
Operand3
ArrayOfString. Optional. A list of operands for the filter.
DataRow
A complex data type that contains the information from a data row.
Element
Cell
DataCell. A data cell from the row. A DataRow contains as many Cell values as there are fields in the row.
DataSchema
A complex data type that describes a data schema by column.
Element
Column
ColumnDetail. The schema of the information stored within a column. A DataSchema contains as many Column values as there are fields in a row.
DataSortColumn
A complex data type that describes a sorted data column.
Elements
ColumnName
String. The name of the sorted column.
SortDirection
String. The direction of the sort. Valid values are:
*ASC - Ascending
*DES - Descending
DataSourceType
A simple data type that specifies the type of file in which a parameter exists.
Element
String. One of the following values:
InfoObject
An information object.
ABInfoObject
An Actuate Basic information object. Obsolete since iHub Release 2.
DataType
A simple data type that specifies a data type.
Element
String. One of the following values:
Currency
A Currency data type.
Date
A DateTime data type.
DateOnly
A Date data type.
Time
A Time data type.
Double
A Double data type.
Integer
An Int data type.
String
A String data type.
Boolean
A Boolean data type.
Structure
A structure. Obsolete since Actuate release 11.
Table
A table. Obsolete since Actuate release 11.
Date
Date is a standard XML Date data type that displays dates in the format CCYY‑MM-DD.
DateTime
DateTime is a standard XML TimeInstant data type that shows the date and time in the format CCYY‑MM‑DDThh:mm:ss‑sss. DateTime ignores milliseconds, if any.
Decimal
Decimal is a standard XML Decimal data type that represents a number having arbitrary precision up to a maximum of 18 digits.
DeleteChannel
Obsolete since iHub Release 3.
DeleteFile
Deletes files or folders. To delete a single file or folder, specify Name or Id. To delete several files or folders, specify NameList or IdList. To delete files or folders that match the specified conditions, specify Search.
Elements
WorkingFolderId
String. The ID of the working folder of the file or folder to delete. Specify either WorkingFolderId or WorkingFolderName.
WorkingFolderName
String. The name of the working folder of the file or folder to delete. Specify either WorkingFolderName or WorkingFolderId.
Recursive
Boolean. Specifies whether to delete subfolders. If True, subfolders are deleted. If False, only the specified folder is deleted. The default value is False.
LatestVersionOnly
Boolean. Specifies whether to delete only the latest version of the file. If True, only the latest version of the file is deleted. The default value is False.
Search
FileSearch. The search condition that specifies which folders or files to delete.
IdList
ArrayOfString. The list of file or folder IDs to delete. Specify either IdList or NameList.
NameList
ArrayOfString. The list of file or folder names to delete. Specify either NameList or IdList.
Id
String. The ID of the single file or folder to delete. Specify either Id or Name.
Name
String. The name of the single file or folder to delete. Specify either Name or Id.
IgnoreMissing
Boolean. Specifies what to do if the specified file or folder does not exist. If True, BIRT iHub ignores the request. If False, the operation reports an error and stops. The default value is True.
DeleteFileType
Deletes file types. To delete a single file type, specify Name or Id. To delete several file types, specify NameList or IdList.
Elements
NameList
ArrayOfString. The list of file types to delete.
Name
String. The name of a single file type to delete.
IgnoreMissing
Boolean. Specifies what to do if the specified file type does not exist. If True, BIRT iHub ignores the request. If False, the operation reports an error and stops. The default value is True.
DeleteGroup
Obsolete since iHub Release 3.
DeleteJob
Deletes scheduled, completed, cancelled, or failed jobs. If an instance of a scheduled report is running when the request is submitted, an exception is thrown.
To delete a single job, specify Id. To delete several jobs, specify IdList. To delete jobs that match the specified conditions, specify Search.
Elements
Search
JobSearch. The search conditions. If conditions apply to multiple fields, use ConditionArray.
IdList
ArrayOfString. The list of job IDs to delete.
Id
String. The ID of the single job to delete.
IgnoreMissing
Boolean. Specifies what to do if the specified job does not exist. If True, BIRT iHub ignores the request. If False, the operation reports an error and stops. The default value is True.
IgnoreActiveJob
Boolean. Flag indicating whether to delete a job if it is active.
DeleteJobNotices
Deletes job notices. A user in the Administrator user group can delete all job notices. To delete all job notices, do not specify the user or group.
Element
Search
JobNoticeSearch. The search conditions. If conditions apply to multiple fields, use ConditionArray.
DeleteJobSchedule
Deletes a job schedule. If an instance of a scheduled report is running when the request is submitted, an exception is thrown.
To delete a job schedule, specify Id. To delete several jobs, specify IdList. To delete jobs that match the specified conditions, specify Search.
Elements
Search
JobScheduleSearch. The search conditions. If conditions apply to multiple fields, use ConditionArray.
IdList
ArrayOfString. The list of job schedule IDs to delete.
Id
String. The ID of the single job schedule to delete.
IgnoreMissing
Boolean. Specifies what to do if the specified job does not exist. If True, BIRT iHub ignores the request. If False, the operation reports an error and stops. The default value is True.
IgnoreActiveJob
Boolean. Flag indicating whether to delete a job if it is active.
DeleteRole
Deprecated since iHub Release 3. Replaced by DeleteUserGroup.
DeleteUser
Deletes users. To delete a single user, specify Name or Id. To delete several users, specify NameList or IdList. To delete users that match the specified conditions, specify Search.
Elements
Search
UserSearch. The search condition that specifies which users to delete.
IdList
ArrayOfString. The list of user IDs to delete. Specify either IdList or NameList.
NameList
ArrayOfString. The list of user names to delete. Specify either NameList or IdList.
Id
String. The ID of the single user to delete. Specify either Id or Name.
Name
String. The name of the single user to delete. Specify either Name or Id.
IgnoreMissing
Boolean. Specifies what to do if the specified user does not exist. If True, BIRT iHub ignores the request. If False, the operation reports an error and stops. The default value is True.
PurgeUserInfo
Boolean. Purges user information from the system.
DeleteUserGroup
Deletes a user group. Available only to users with the Administrator user group.
Elements
Search
UserGroupSearch. The search condition that specifies which user groups to delete.
IdList
ArrayOfString. The list of user group IDs to delete. Specify either IdList or NameList.
NameList
ArrayOfString. The list of user group names to delete. Specify either NameList or IdList.
Id
String. The ID of the single user group to delete. Specify either Id or Name.
Name
String. The name of the single user group to delete. Specify either Name or Id.
IgnoreMissing
Boolean. Specifies what to do if the specified user group does not exist. If True, BIRT iHub ignores the request. If False, the operation reports an error and stops. The default value is True.
DocumentConversionOptions
A complex data type that describes the conversion options of a file.
Elements
FileType
String. The file type of the file.
OutputFormat
String. The output format of the file.
MimeType
String. The mime type of the file.
Options
ArrayOfParameterDefinition. The list of conversion options.
Double
Double is a standard XML double data type, which is a signed 64‑bit floating‑point number.
Event
A complex type that describes an event and its status.
Elements
FileEvent
FileEvent. Optional. Specifies information for a file event. Specify one of this value, JobEvent, or CustomEvent.
JobEvent
JobEvent. Optional. Specifies information for a job event. Specify one of this value, FileEvent, or CustomEvent.
CustomEvent
CustomEvent. Optional. Specifies information for a custom event. Specify one of this value, FileEvent, or JobEvent.
EventName
String. The name of the event.
EventType
EventType. The type of event.
PollingInterval
Long. Optional. Specifies the amount of time to wait between event status checks. The minimum value is 10 seconds.
PollingDuration
Long. Optional. Specifies the amount of time to check the event status.
LagTime
Long. Optional. Specifies lag time value for the event.
EventStatus
String. Optional. The current status of the event. Valid values are:
*Uninitialized
*Polling
*Satisfied
*Expired
EventOptions
A complex data type that describes polling and other options for an event.
Elements
DefaultEventPollingInterval
Long. Optional. The amount of time to wait between polling the event.
DefaultEventPollingDuration
Long. Optional. The duration of time to poll for an event.
DefaultEventLagTime
Long. Optional. The amount of lag time for the event.
EnableCustomEventService
Boolean. Optional. A flag indicating whether to enable the custom event service.
EventType
A simple data type that represents a type of event.
Element
String. One of the following values:
FileEvent
A file type event.
JobEvent
A job type event.
CustomEvent
A custom type event.
NoEvent
No event.
ExecuteReportStatus
A simple data type that represents the status of report execution.
Element
String. One of the following values:
Done
The report execution succeeded.
Failed
The report execution failed.
FirstPage
The first page is complete. Applies only if progressive viewing is enabled.
Pending
The job is either in the queue or in the process of generating. Applies only if WaitTime is specified.
ExternalTranslatedUserNames
A complex data type that represents a member of the Administrators user group.
Element
Administrator
String. The external name of the administrator user.
ExternalTranslatedRoleNames
Deprecated since iHub Release 3. Replaced by ExternalTranslatedUserGroupNames.
ExternalTranslatedUserGroupNames
A complex data type that represents one of the following user groups:
*Administrator
*Operator
*All
Elements
Administrator
String. The external name of the administrator user group.
Operator
String. The external name of the operator user group.
All
String. The external name of the all user group.
FieldDefinition
A complex data type that describes a scalar parameter.
Elements
Name
String. The name of the parameter.
DisplayName
String. Optional. The display name of the parameter.
DataType
ScalarDataType. Optional. The data type of the parameter. Valid values are:
*Currency
*Date
*Double
*Integer
*String
*Boolean
IsHidden
Boolean. Optional. Specifies whether the parameter is hidden.
IsRequired
Boolean. Optional. Specifies whether the parameter is required.
DefaultValue
String. Optional. The default value of the parameter.
SelectValueList
ArrayOfString. Optional. The list of available parameter values.
FieldControlType
String. Optional. The type of control used to represent the parameter. Valid values are:
*ControlListAllowNew
A text box
*ControlList
A drop-down list
SelectNameValueList
ArrayOfNameValuePair. Optional. A list of name-value pairs used within the field.
FieldValue
Obsolete since iHub Release 2.
File
A complex data type that describes a file.
Elements
Id
String. Optional. The file ID.
Name
String. Optional. The name of the file. Actuate’s internal data store imposes a fixed upper limit on the length of certain text strings.
FileType
String. Optional. The file type.
Description
String. Optional. The description of the file.
PageCount
Long. Optional. The number of pages in the file.
Size
Long. Optional. The size of the file.
TimeStamp
DateTime. Optional. The time the file was created or modified, in Coordinated Universal Time (UTC).
Version
Long. Optional. The version number.
VersionName
String. Optional. The version name.
Owner
String. Optional. The owner of the file.
UserPermissions
String. Optional. The current user permissions for the file.
AccessType
FileAccess. Optional. The file’s access type. Valid values are:
*Private
Only the owner of the file and an administrator can access the file.
*Shared
All users and user groups specified in the access control list (ACL) for the file can access the file.
FileAccess
A simple data type that specifies the file’s access type.
Element
String. One of the following values:
Private
Only the owner of the file and an administrator can access the file.
Shared
All users and user groups specified in the access control list (ACL) for the file can access the file.
FileCondition
A complex data type that represents the fields on which a search can be performed and the condition to match.
Elements
Field
FileField. File field on which to perform a search.
Match
String. The condition to match. If the condition includes special characters, for example a dash, either escape the special character with a backslash (\) or enclose it in brackets ([ ]). For example, to search for a file 05-25-04Report.rptdocument, specify one of the following:
05\-25\-04Report.rptdocument
05[-]25[-]04Report.rptdocument
FileContent
A complex data type that represents a list of attached files or the content of embedded files.
Elements
File
File. The attached file.
Content
Attachment. The content of an embedded file.
FileEvent
A complex data type that contains information pertaining to file type events.
Element
MonitoredFilePath
String. The file path of the file the event is monitoring.
FileField
A simple type that describes different fields that may exist for a file.
Element
String. One of the following values:
Name
The name of the file.
FileType
The file type.
Description
The description of the file.
PageCount
The number of pages in the file.
Size
The size of the file.
TimeStamp
The time the file was created or modified, in Coordinated Universal Time (UTC).
Version
Optional. The version number.
VersionName
The version name.
Owner
The owner of the file.
FileSearch
A complex data type that represents a file search.
Elements
Condition
FileCondition. Optional. The search condition. Specify either this parameter or ConditionArray.
ConditionArray
ArrayOfFileCondition. Optional. An array of search conditions. Use if search conditions apply to multiple fields.
Owner
String. Optional. The file owner.
DependentFileName
String. Optional. The name of the dependent file. Specify one of this parameter, DependentFileId, RequiredFileName, or RequiredFileId.
DependentFileId
String. Optional. The ID of the dependent file. Specify one of this parameter, DependentFileName, RequiredFileName, or RequiredFileId.
RequiredFileName
String. Optional. The name of the required file. Specify one of this parameter, DependentFileName, DependentFileId, or RequiredFileId.
RequiredFileId
String. Optional. The ID of the required file. Specify one of this parameter, DependentFileName, DependentFileId, or RequiredFileName.
PrivilegeFilter
PrivilegeFilter. Optional. The privileges for which to search. Use PrivilegeFilter to determine whether the specified user or user group has the specified privileges on the file.
AccessType
FileAccess. Optional. The file’s access type. Valid values are:
*Private
Only the owner of the file and an administrator can access the file.
*Shared
All users and user groups specified in the access control list (ACL) for the file can access the file.
FetchSize
Int. Optional. The maximum number of records to retrieve and return in a result set. The default value is 500.
FetchDirection
Boolean. Optional. If True, records are retrieved forward. If False, records are retrieved backward. The default value is True.
CountLimit
Int. Optional. The maximum number of records to count. By default, CountLimit is equal to FetchSize. To count all records, set CountLimit to ‑1.
FetchHandle
String. Optional. Retrieves more items from the result set. In the second and subsequent calls for data, specifies the same search criteria as in the original call.
IncludeHiddenObject
Boolean. Optional. Flag indicating if search should include hidden objects.
FileType
A complex data type that describes a file type. Specify FileType in the SOAP header for all execute, submit, and view IDAPI requests.
Elements
Name
String. Optional. The file type name.
IsNative
Boolean. Optional. Specifies whether the file is an internal Actuate type. IsNative is read‑only. Providing an input value for this attribute in CreateFileType or UpdateFileType causes SetAttributes to be ignored.
IsExecutable
Boolean. Optional. Specifies whether the file is executable. If False, the file type is set to Document file type. The OutputType and ExportBeforeViewing attributes do not apply to Document file type.
IsPrintable
Boolean. Optional. Specifies whether the file is printable. If the file type is Executable, IsPrintable refers to the output file.
IsRequired
Boolean. Optional. Specifies whether the file is required.
OutputType
String. Optional. The file type for the output file. Required if the file type is Executable.
LocalExtension
String. Optional. The local extension.
DisplayType
String. Optional. Specifies either Simple or Advanced display types.
ShortDescription
String. Optional. The short description of the file type.
LongDescription
String. Optional. The long description of the file type.
SmallImageURL
String. Optional. The URL of the small image for the file.
LargeImageURL
String. Optional. The URL of the large image for the file.
ExportBeforeViewing
Boolean. Optional. Specifies whether the file is exported before viewing.
DriverName
String. Optional. The name of the driver. Required if file type is Executable or Printable.
MutexClass
String. Optional. The mutex class name.
ContentType
String. Optional. The content type.
EnableAutoParamCollection
Boolean. Optional. True enables automatic parameter collection for the file type.
IsCompoundDoc
Boolean. Optional. Specifies whether the file is a compound document. The default value is False.
AllowViewTimeParameter
Boolean. Optional. Specifies whether to allow view-time parameters. The default value is True.
FilterCriteria
Obsolete since iHub Release 2.
Group
Obsolete since iHub Release 2.
GroupCondition
Obsolete since iHub Release 2.
GroupField
Obsolete since iHub Release 2.
Grouping
Obsolete since iHub Release 2.
GroupSearch
Obsolete since iHub Release 2.
Header
The SOAP header that contains authentication data, locale information, and other required or optional data.
Elements
AuthId
A system-generated, encrypted String. All requests except Login requests must have a valid AuthId in the SOAP header. The header passes this identifier to BIRT iHub for validation.
TargetVolume
String. Optional. The volume to which to direct the request.
Locale
String. Optional. The format of Locale is <ll>_<CC>, where <ll> is the two‑character language code and <CC> is the two-character country code of the locale. For example, fr_CA is the locale code for the French language used in Canada. Locale is used to format data using the language, date and time conventions, currency and other locale-specific conventions.
ConnectionHandle
String. Optional. Supports keeping a connection open to view a persistent report.
TargetServer
String. Optional. Refers to the BIRT iHub within a cluster to which to direct the request.
DelayFlush
Boolean. Optional. BIRT iHub writes updates to the disk when the value is False.
FileType
String. Optional. Supports specifying the file type to run, such as a BIRT design or HTML file.
TargetResourceGroup
String. Optional. Supports assigning a synchronous report generation request to a specific resource group at run time.
RequestID
String. Optional. A unique value that identifies the SOAP message.
InfoObjectData
A complex data type that describes the data from a BIRT information object.
Elements
DataSchema
The schema for the data rows.
DataRows
The data rows from the information object.
InfoObjectDataFormat
A simple data type that describes an information object’s data format.
Element
NMTOKEN. One of the following values:
XML
The file is in XML format.
CSV
The file is in comma separated values format.
Int
A standard XML Integer data type that represents a number. Int derives from the Decimal data type by fixing the value of scale at 0.
IOCacheDBIndexConstraint
Obsolete since iHub Release 2.
IOCacheDefinition
Obsolete since iHub Release 2.
IOCacheState
Obsolete since iHub Release 2.
JobCondition
A complex data type that represents the field on which to perform a search and the condition to match.
Elements
Field
JobField. An element that includes a field on which to perform a search.
Match
String. The condition to match. If the condition includes special characters, for example a dash, either escape the special character with a backslash (\) or enclose it in brackets ([ ]). For example, to search for a file 05-25-04Report.rptdocument, specify one of the following:
05\-25\-04Report.rptdocument
05[-]25[-]04Report.rptdocument
JobEvent
A complex data type that represents the information pertaining to a job type event.
Elements
JobId
String. The ID of the job.
JobName
String. Optional. The job name.
JobStatus
ArrayOfString. Optional. The job status.
JobField
A simple data type that represents the fields on which a search for jobs can be performed.
Element
String. One of the following values:
JobName
The job name.
Owner
The owner of the job.
JobType
The type of job. Valid values are:
*RunReport
*PrintReport
*RunAndPrintReport
*ConvertReport
Priority
The job priority.
RoutedToNode
The node to which the job is routed.
StartTime
The start time.
DurationSeconds
The job duration.
CompletionTime
The time the job is completed.
State
The state of the job. Valid values are:
*Succeeded
*Failed
*Cancelled
NotifyCount
The number of notifications sent about the job.
OutputFileSize
The size of the output file.
JobInputDetail
A complex data type that describes the job input and output files.
Elements
InputFileVersionName
String. Optional. The input file version.
OutputFileVersionName
String. Optional. The output file version.
ReplaceLatestVersion
Boolean. Optional. Specifies whether to replace the latest version of the file with the current version.
OutputMaxVersion
Int. Optional. The maximum number of versions to keep after a new version is generated.
ValueFileType
String. Optional. The type of a value file. If present, the value is either Temporary or Permanent.
ValueFileVersionName
String. Optional. The value file name.
IsBundled
Boolean. Optional. Specifies whether the output object is bundled with the input object.
RetryOption
RetryOptionType. Optional. The retry settings. Valid values are:
*Disabled
*VolumeDefault
*Specified
MaxRetryCount
Int. Optional. The maximum number of retry attempts.
RetryInterval
Int. Optional. The interval between retry attempts. Measured in seconds.
MaxVersions
Long. Optional. The maximum number of versions to keep in the volume.
NeverExpire
Boolean. Optional. Specifies whether the item expires.
ArchiveRuleInherited
Boolean. Optional. Specifies whether the archive rules are inherited from another object.
ExpirationAge
Int. Optional. Specifies the expiration age for the object.
ExpirationDate
DateTime. Optional. The date when the job expires.
ArchiveOnExpire
Boolean. Optional. Specifies whether the object is archived before it is expired.
KeepWorkspace
Boolean. Optional. Specifies whether to keep or remove the workspace directory after executing the job.
DriverTimeout
Int. Optional. The time for the driver to return from executing the job.
PollingInterval
Int. Optional. The time interval to get status messages. The minimum value is 10 seconds.
DebugInstruction
String. Optional. The debug instructions.
SendSuccessNotice
Boolean. Optional. Specifies whether success notices are sent if the job succeeds. Used only if OverrideRecipientPref is True.
SendFailureNotice
Boolean. Optional. Specifies whether failure notices are sent if the job fails. Used only if OverrideRecipientPref is True.
SendEmailForSuccess
Boolean. Optional. Specifies whether e-mail notifications are sent if the job succeeds. Used only if OverrideRecipientPref is True. If SendEmailForSuccess is True, e-mail notifications are sent to specified users if the job succeeds. The default value is False.
SendEmailForFailure
Boolean. Optional. Specifies whether e-mail notifications are sent if the job fails. Used only if OverrideRecipientPref is True. If SendEmailForFailure is True, e‑mail notifications are sent to specified users if the job fails. The default value is False.
AttachReportInEmail
Boolean. Optional. Specifies whether the output file is attached to the e‑mail notification for successful jobs. Used only if OverrideRecipientPref is True. If AttachReportInEmail is True, the output file is attached to the e‑mail notification. If False, only a link to the output file is sent. Specify the format for the attachment in the EmailFormat element. The default value is False.
OverrideRecipientPref
Boolean. Optional. Specifies whether e-mail notifications and output attachments are sent according to job settings or user settings. If True, e‑mail notifications and output attachments are sent according to job settings. If False, e‑mail notifications and output attachments are sent according to user settings. The default value is False. If False, the following elements are ignored:
*AttachReportInEmail
*SendEmailForSuccess
*SendEmailForFailure
*SendSuccessNotice
*SendFailureNotice
EmailFormat
String. Optional. Specifies the output format of the report attached to the e‑mail notification. Table 3‑3 lists the valid format codes.
Table 3‑3 E-mail attachment formats
Format code
File type description
DOC
Microsoft Word
DOCX
Microsoft Word 2010
PDF
Adobe PDF
PPT
Microsoft PowerPoint
PPTX
Microsoft PowerPoint 2010
PS
Adobe Postscript
XLS
Microsoft Excel
XLSX
Microsoft Excel 2010
RecordSuccessStatus
Boolean. Optional. Specifies whether to record job success notices.
RecordFailureStatus
Boolean. Optional. Specifies whether to record job failure notices.
KeepOutputFile
Boolean. Optional. Specifies whether the generated output file remains in the volume if the generation request succeeds but the printing request fails. Used if the job is to be generated and printed. If True, the output file remains in the volume. If False, the output file is deleted if the printing request fails. The default value is False.
ConversionOptions
Obsolete since iHub Release 2.
DataACL
ArrayOfString. Optional. Specifies the access control list (ACL) restricting data privileges.
JobNotice
A complex data type that describes a job notice.
Elements
JobId
String. Optional. The job ID.
JobName
String. Optional. The name of the job.
Headline
String. Optional. The job headline.
JobState
String. Optional. The state of the job. Valid values are:
*Succeeded
*Failed
*Cancelled
CompletionTime
DateTime. Optional. The time the job is completed.
ActualOutputFileName
String. Optional. The output file name that the BIRT iHub generated.
OutputFileName
String. Optional. The output file name.
OutputFileVersionName
String. Optional. The output file version name.
ActualOutputFileSize
Long. Optional. The size of the output file.
ActualOutputFileId
String. Optional. The output file ID that the BIRT iHub generated.
NotifiedUserId
String. Optional. The ID of the user who received the notice.
NotifiedUserName
String. Optional. The name of the user who received the notice.
NotifiedChannelId
Obsolete since iHub Release 3.
NotifiedChannelName
Obsolete since iHub Release 3.
OutputFileVersion
Long. Optional. The output file version number.
JobNoticeCondition
A complex data type that represents the field on which to perform a search and the condition to match.
Elements
Field
String. Optional. The field on which to perform a search. Valid values are:
*JobId
*JobName
*OutputFileName
*JobState
*HeadLine
*CompletionTime
Match
String. The condition to match. If the condition includes special characters, for example a dash, either escape the special character with a backslash (\) or enclose it in brackets ([ ]). For example, to search for a file 05‑25‑04Report.rptdocument, specify one of the following:
05\-25\-04Report.rptdocument
05[-]25[-]04Report.rptdocument
JobNoticeField
A simple data type that represents the fields on which a search can be performed.
Element
String. One of the following values:
JobId
The job ID.
JobName
The name of the job.
OutputFileName
The output file name.
JobState
The state of the job.
HeadLine
The job headline.
CompletionTime
The time the job is completed.
JobNoticeSearch
A complex data type that represents the job notice search.
Elements
Condition
JobNoticeCondition. Optional. The search condition. Specify one of this parameter or CondtionArray.
ConditionArray
ArrayOfJobNoticeCondition. Optional. An array of search conditions. Specify one of this parameter or Condition.
NotifiedUserId
String. Optional. The ID of the user who received the notice. Specify either this parameter or NotifiedUserName.
NotifiedUserName
String. Optional. The name of the user who received the notice. Specify either this parameter or NotifiedUserId.
NotifiedChannelId
Obsolete since iHub Release 3.
NotifiedChannelName
Obsolete since iHub Release 3.
FetchSize
Int. Optional. The maximum number of records to retrieve and return in a result set. The default value is 500.
FetchDirection
Boolean. Optional. If True, records are retrieved forward. If False, records are retrieved backward. The default value is True.
CountLimit
Int. Optional. The maximum number of records to count. By default, CountLimit is equal to FetchSize. To count all records, set CountLimit to ‑1.
FetchHandle
String. Optional. Retrieves more items from the result set. In the second and subsequent calls for data, specify the same search criteria as in the original call.
JobPrinterOptions
A complex data type that describes the job printer options.
Elements
PrinterName
String. The printer name.
Orientation
String. Optional. The paper orientation.
PageSize
String. Optional. The page size.
Scale
Long. Optional. The scaling factor.
Resolution
String. Optional. The resolution.
NumberOfCopies
Long. Optional. The number of copies.
CollationOption
Boolean. Optional. Specifies whether the printer’s collation property is set.
PaperTray
Boolean. Optional. Specifies whether the printer’s paper tray option is set.
Duplex
String. Optional. The value of the printer’s duplex property.
IsColor
Boolean. Optional. Specifies whether the printer can print in color.
PaperLength
Long. Optional. The paper length.
PaperWidth
Long. Optional. The paper width.
PageRange
String. Optional. The page range. Cannot exceed 20 characters.
FormName
String. Optional. The form name.
PrintToFile
String. Optional. The setting of the print to file property. Cannot exceed 256 characters.
JobProperties
A complex data type that specifies the general job attributes, such as input document file name, output file name, and job execution status.
Elements
JobId
String. Optional. The job ID.
JobName
String. Optional. The name of the job.
Priority
Long. Optional. The job priority.
ResourceGroup
String. Optional. The name of the resource group to which a job is assigned, if any.
Owner
String. Optional. The owner of the job.
JobType
String. Optional. The type of job. Valid values are:
*RunReport
*PrintReport
*RunAndPrintReport
*ConvertReport
State
String. Optional. The state of the job. Valid values are:
*Scheduled
*Pending
*Waiting
*Running
*Succeeded
*Failed
*Cancelled
*Expired
InputFileId
String. Optional. The input file ID.
InputFileName
String. Optional. The input file full name and version number.
RunLatestVersion
Boolean. Optional. Specifies whether to run the latest version of the file.
ParameterFileId
String. Optional. The parameter file ID. Exists only if the parameter file is specified.
ParameterFileName
String. Optional. The parameter file name. Exists only if the parameter file is specified.
ActualOutputFileId
String. Optional. The output file ID that the BIRT iHub generated.
ActualOutputFileName
String. Optional. The output file name that the BIRT iHub generated. This might be different from the RequestedOutputFileName.
RequestedOutputFileName
String. Optional. The requested name for the output file.
OutputFileVersionName
String. Optional. The output file version name.
SubmissionTime
DateTime. Optional. The time the job was submitted.
CompletionTime
DateTime. Optional. The time the job is completed.
PageCount
Long. Optional. The number of pages.
OutputFileSize
Long. Optional. The size of the output file.
RoutedToNode
String. Optional. The node to which the job is routed.
DurationSeconds
Long. Optional. The job duration.
StartTime
DateTime. Optional. The start time.
NextStartTime
DateTime. Optional. The next time the job is scheduled to run. Applies only to scheduled jobs.
RequestedHeadline
String. Optional. The headline for the job.
ActualHeadline
String. Optional. The headline that the BIRT iHub generated.
NotifyCount
String. Optional. The number of notifications sent about the job.
EventName
String. Optional. The name of the job event.
EventType
EventType. Optional. The job event type.
EventStatus
String. Optional. The job event status.
EventParameter
String. Optional. The parameter for the job event.
JobSchedule
A complex data type that represents details about a job schedule.
Elements
TimeZoneName
String. Optional. The time zone. Cannot exceed 32 characters.
ScheduleDetails
ArrayOfJobScheduleDetail. The schedule details.
JobScheduleCondition
A complex data type that represents the field on which to perform a search and the condition to match.
Elements
Field
JobScheduleField. Field on which to perform a search.
Match
String. The condition to match. If the condition includes special characters, for example a dash, either escape the special character with a backslash (\) or enclose it in brackets ([ ]). For example, to search for a file 05‑25‑04Report.rptdocument, specify one of the following:
05\-25\-04Report.rptdocument
05[-]25[-]04Report.rptdocument
JobScheduleDetail
A complex data type that specifies a schedule for running a job.
Elements
ScheduleType
String. The type of schedule. Valid values are:
*AbsoluteDate
*Daily
*Weekly
*Monthly
ScheduleStartDate
String. Optional. The date on which to start the schedule. The date is a standard XML String data type in the format YYYY‑MM‑DDThh:mm:ss‑sss. Milliseconds, if specified, are ignored.
ScheduleEndDate
String. Optional. The date on which to end the schedule. The date is a standard XML String data type using the format YYYY‑MM‑DDThh:mm:ss‑sss. Milliseconds, if specified, are ignored.
DatesExcluded
ArrayOfDate. Optional. An array of dates to exclude from the schedule.
AbsoluteDate
AbsoluteDate. Optional. This value applies if ScheduleType is AbsoluteDate.
Daily
Daily. Optional. This value applies if ScheduleType is Daily.
Weekly
Weekly. Optional. This value applies if ScheduleType is Weekly.
Monthly
Monthly. Optional. This value applies if ScheduleType is Monthly.
JobScheduleField
A simple data type describing job schedule fields upon which a search can be performed.
Element
String. One of the following values:
JobName
The name of the job.
Owner
The owner of the job.
JobType
The type of job. Valid values are:
*RunReport
*PrintReport
*RunAndPrintReport
*ConvertReport
Priority
The job priority.
NextStartTime
The next time the job is scheduled to run. Applies only to scheduled jobs.
State
The state of the job. Valid values are:
*Scheduled
*Pending
*Running
*Succeeded
*Failed
*Cancelled
*Expired
ParameterFileId
The parameter file ID. Exists only if the parameter file is specified.
JobScheduleSearch
A complex data type that represents a job schedule search.
Elements
Condition
JobScheduleCondition. Optional. The search condition. Specify this value or ConditionArray.
ConditionArray
ArrayOfJobScheduleCondition. Optional. The array of search conditions. Specify this value or Condition.
RequestedOutputFileName
String. Optional. The output file name.
InputFileName
String. Optional. The input file name.
InputFileId
String. Optional. The input file ID.
EventType
EventType. Optional. The event type of the job.
NotifiedUserId
String. Optional. The ID of the user to notify. Specify either this value or NotifiedUserName.
NotifiedUserName
String. Optional. The name of the user to notify. Specify either this value or NotifiedUserId.
NotifiedChannelId
Obsolete since iHub Release 3.
NotifiedChannelName
Obsolete since iHub Release 3.
FetchSize
Int. Optional. The maximum number of records to retrieve and return in a result set. The default value is 500.
FetchDirection
Boolean. Optional. If True, records are retrieved forward. If False, records are retrieved backward. The default value is True.
CountLimit
Int. Optional. The maximum number of records to count. By default, CountLimit is equal to FetchSize. To count all records, set CountLimit to ‑1.
FetchHandle
String. Optional. Retrieves more items from the result set. In the second and subsequent calls for data, specifies the same search criteria as in the original call.
JobSearch
A complex data type that represents a job search.
Elements
Condition
JobCondition. Optional. The search condition. Specify this value or ConditionArray.
ConditionArray
ArrayOfJobCondition. Optional. The array of search conditions. Specify this value or Condition.
Owner
String. Optional. The owner of the job.
ActualOutputFileName
String. Optional. The output file name that the BIRT iHub generated.
ActualOutputFileId
String. Optional. The output file ID that the BIRT iHub generated.
RequestedOutputFileName
String. Optional. The output file requested name.
InputFileName
String. Optional. The input file name.
InputFileId
String. Optional. The input file ID.
NotifiedUserId
String. Optional. The ID of the user who received notification. Specify either this value or NotifiedUserName.
NotifiedUserName
String. Optional. The name of the user who received notification. Specify either this value or NotifiedUserId.
NotifiedChannelId
Obsolete since iHub Release 3.
NotifiedChannelName
Obsolete since iHub Release 3.
FetchSize
Int. Optional. The maximum number of records to retrieve and return in a result set. The default value is 500.
FetchDirection
Boolean. Optional. If True, records are retrieved forward. If False, records are retrieved backward. The default value is True.
CountLimit
Int. Optional. The maximum number of records to count. By default, CountLimit is equal to FetchSize. To count all records, set CountLimit to ‑1.
FetchHandle
String. Optional. Retrieves more items from the result set. In the second and subsequent calls for data, specifies the same search criteria as in the original call.
LicenseOption
A complex data type that represents a license option.
Elements
Name
String. Optional. The name of the license option.
Description
String. Optional. The description of the option.
ShortDescription
String. Optional. A shorter description of the option.
Value
String. Optional. The value of the option.
Long
Long is a standard XML long data type, which supports a 64‑bit value, ranging from –9223372036854775808 to 9223372036854775807.
MDSInfo
A complex data type that describes a Message Distribution service (MDS).
Elements
ServerName
String. The server name.
MDSIPAddress
String. The IP address of the MDS.
MDSPortNumber
Int. The port number the MDS uses.
MDSSSLPortNumber
Int. Optional. The SSL port number the MDS uses.
ServerState
ServerState. Optional. The server state.
Monthly
A complex data type that describes monthly job scheduling.
Elements
FrequencyInMonths
Long. The amount of times a job is to be run, in months.
OnDay
Int. Optional. The day of the month on which to run the job.
OnWeekDay
Int. Optional. The day of the month, excluding weekends, on which to run the job.
RunOn
Optional. A complex type containing two String values. The first string, WeekDay, specifies the day of the week on which to run the job. Valid values for WeekDay are:
*Mon
*Tue
*Wed
*Thu
*Fri
*Sat
*Sun
The second string, Occurrence, specifies which occurrence in the month of that day to run the job. Valid values for Occurrence are:
*First
*Second
*Third
*Fourth
*Last
For example, the strings, Tue and Third, specify the third Tuesday of the month.
OnceADay
String. Optional. Specifies the time the job is to be run.
Repeat
Repeat. Optional. Specifies how often the schedule is to be repeated.
MoveFile
Moves files or folders to a new location. To move a single file or folder, specify Name or Id. To move a list of files or folders, specify NameList or IdList. To move files or folders that match the specified conditions, specify Search.
Elements
Target
String. The new location for the file or folder. The following rules apply:
*If Target is a file, the operation fails if the source contains a folder.
*If the source is a folder and a folder with the same name exists in the target location, the operation fails.
*If the source is a file and a file with an identical name exists in the target location, the existing file in the target location is versioned or replaced, depending on the setting of the ReplaceExisting tag. If the existing file has any dependencies, the file is not replaced regardless of the ReplaceExisting setting.
*If Target is a folder that does not exist, a folder is created.
WorkingFolderName
String. The name of the working folder of the file or folder to move. Specify either WorkingFolderName or WorkingFolderId.
WorkingFolderId
String. The ID of the working folder of the file or folder to move. Specify either WorkingFolderId or WorkingFolderName.
Recursive
Boolean. Specifies whether to search subfolders. If True, the search includes subfolders. The default value is False.
Search
FileSearch. The search condition that specifies which folders or files to move.
IdList
ArrayOfString. The list of file or folder IDs to move. Specify either IdList or NameList.
NameList
ArrayOfString. The list of file or folder names to move. Specify either NameList or IdList.
Id
String. The ID of the single file or folder to move. Specify either Id or Name.
Name
String. The name of the single file or folder to move. Specify either Name or Id.
ReplaceExisting
Boolean. If True, the existing file, if one exists, is replaced. If the existing file has any dependencies, it is not replaced. If False or the existing file has any dependencies, the file is versioned. The default value is True.
MaxVersions
Long. The maximum number of versions to create. MaxVersions applies only if a file is moved. If a folder is moved, MaxVersions is ignored.
LatestVersionOnly
Boolean. Specifies whether all versions or only the latest version of the file is moved. Used only when a Search tag is specified. If True, only the latest version of the file is moved. The default value is False.
NameValuePair
A complex data type that represents a named piece of data and its value.
Elements
Name
String. The name of the data.
Value
String. The value of the data. Value supports the null value.
NewFile
A complex data type that describes a file.
Elements
Name
String. The name of the file.
VersionName
String. Optional. The version name of the file.
ReplaceExisting
Boolean. Optional. Deprecated. Use Versioning instead of ReplaceExisting. Specifies whether to overwrite the latest existing version when uploading a file. If the existing file has any dependencies, BIRT iHub does not overwrite the file and creates a new version, regardless of the ReplaceExisting setting.
Versioning
VersioningOption. Optional. Specifies what to do with the latest existing version when uploading a file. Valid values are:
*CreateNewVersion
Always creates a new version. This is the default value.
*ReplaceLatestIfNoDependents
Replaces the latest existing version if it does not have any dependent files. If the existing version has any dependents, BIRT iHub creates a new version instead of replacing the existing version.
*ReplaceLatestDropDependency
Replaces the latest existing version if it does not have any dependent files. If the existing version has any dependents, BIRT iHub drops the dependency.
*ReplaceLatestMigrateDependency
Replaces the latest existing version if it does not have any dependent files. If the existing version has any dependents, BIRT iHub moves the dependency to the new version.
MaxVersions
Long. Optional. The maximum number of versions to keep in the volume.
Description
String. Optional. The description of the file.
ArchiveRule
ArchiveRule. Optional. The autoarchive rules for the file.
ACL
ArrayOfPermission. Optional. The access rights to the file.
AccessType
FileAccess. Optional. The file’s access type. Valid values are:
*Private
Only the owner of the file and an administrator can access the file.
*Shared
All users and user groups specified in the access control list (ACL) for the file can access the file.
ObjectIdentifier
A complex data type that describes object identifiers.
Elements
Id
String. Optional. The ID of the object.
Name
String. Optional. The name of the object.
Type
String. Optional. The object type.
Version
Long. Optional. The object version number.
OpenServerOptions
Obsolete since iHub Release 2.
PageIdentifier
A complex data type that describes page numbers.
Elements
Range
String. Optional. A page range.
PageNum
Long. Optional. A page number.
ViewMode
Int. Optional. The page viewing mode.
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
Boolean. Optional.
GroupPromptText
String. Optional.
DefaultValueIsNull
Boolean. Optional. Flag indicating that the default value is null.
ParameterValue
A complex data type that defines the value of a report parameter.
Elements
Group
String. Optional. The parameter group.
Name
String. The parameter name.
DisplayName
String. Optional. The label or display name for the parameter that appears in the user interface.
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.
Value
String. Optional. The parameter value.
ValueIsNull
Boolean. Optional. A flag indicating a null value.
PromptParameter
Boolean. Optional. Allows the user to select the parameter.
TableValue
Obsolete since iHub Release 2.
DataSourceType
Obsolete since iHub Release 2.
IsViewParameter
Boolean. Optional. Specifies whether the parameter is a view parameter.
The parameters listed in Table 3‑4 are available to set the properties of a spreadsheet file created by running a BIRT report as a job:
Table 3‑4 Excel spreadsheet output options 
Parameter Name
String value
data type
Applies to
Description
$$$AC_CONVERSION_OPTION_rptdesign_XLS_PageRange
String
Design
Pages to export to excel. Use a single value, a comma-separated list, or a range specified by two numbers separated by a hyphen.
$$$AC_CONVERSION_OPTION_rptdesign_XLS_excelRenderOption.wrappingText
Boolean
Design
Whether to wrap the text contents of cells. Use "true" to wrap, "false" to not wrap.
$$$AC_CONVERSION_OPTION_rptdesign_XLS_excelRenderOption.EnablePivotTable
Boolean
Design
Whether to export a cross tab as a pivot table. Use "true" to export a pivot table, "false" to export values in normal cells.
$$$AC_CONVERSION_OPTION_rptdesign_XLS_ChartDpi
Integer
Design
The dots per inch (dpi) used to display a chart as an image.
$$$AC_CONVERSION_OPTION_rptdocument_XLS_ChartDpi
Integer
Document
The dots per inch (dpi) used to display a chart as an image.
$$$AC_CONVERSION_OPTION_rptdesign_XLS_excelRenderOption.ExportChartsAsImages
Boolean
Design
Whether to export charts as images or live charts. Use "true" to export charts as images, "false" to export charts as live charts.
$$$AC_CONVERSION_OPTION_rptdesign_XLS_excelRenderOption.hideGridlines
Boolean
Design
Whether to hide the grid lines in the spreadsheet. Use "true" to hide the grid lines, "false" to display the grid lines.
$$$AC_CONVERSION_OPTION_rptdesign_XLS_excelRenderOption.multipleSheet
Boolean
Design
Whether to export the report in multiple sheets or a single sheet. Use "true" to create multiple sheets, "false" to create a single sheet.
$$$AC_CONVERSION_OPTION_rptdocument_XLS_excelRenderOption.multipleSheet
Boolean
Document
Whether to export the report in multiple sheets or a single sheet. Use "true" to create multiple sheets, "false" to create a single sheet.
$$$AC_CONVERSION_OPTION_rptdesign_XLS_excelRenderOption.AutoFitPivotTable
Boolean
Boolean
Whether to adjust the widths of pivot table columns to fit the content. Use "true" to adjust pivot table column widths, "false" to use the default column width.
$$$AC_CONVERSION_OPTION_rptdesign_XLS_excelRenderOption.EnableLiveFormula
Boolean
Boolean
Whether to export aggregations and computed columns as live formulas or a number. Use "true" to export these values as live formulas, "false" to export numbers only.
Use code similar to the following lines to use these options:
NewFile requestedOutputFile = new NewFile();
requestedOutputFile.setName(outputFileName);
 
ArrayOfParameterValue parameterValues = new ArrayOfParameterValue();
parameterValues.setParameterValue(new ParameterValue[] {
actuateControl.newParameterValue("$$$AC_CONVERSION_OPTION_rptdesign_XLS_PageRange", "2-3"),
actuateControl.newParameterValue("$$$AC_CONVERSION_OPTION_rptdesign_XLS_excelRenderOption.wrappingText", "false"),
actuateControl.newParameterValue("$$$AC_CONVERSION_OPTION_rptdesign_XLS_excelRenderOption.EnablePivotTable", "false"),
actuateControl.newParameterValue("$$$AC_CONVERSION_OPTION_rptdesign_XLS_ChartDpi", "96"),
actuateControl.newParameterValue("$$$AC_CONVERSION_OPTION_rptdesign_XLS_excelRenderOption.ExportChartsAsImages", "false"),
actuateControl.newParameterValue("$$$AC_CONVERSION_OPTION_rptdesign_XLS_excelRenderOption.hideGridlines", "false"),
actuateControl.newParameterValue("$$$AC_CONVERSION_OPTION_rptdesign_XLS_excelRenderOption.AutoFitPivotTable", "false"),
actuateControl.newParameterValue("$$$AC_CONVERSION_OPTION_rptdesign_XLS_excelRenderOption.multipleSheet", "true"),
});
 
com.actuate.schemas.SubmitJob submitJob = new com.actuate.schemas.SubmitJob();
submitJob.setJobName("Sample Report");
submitJob.setHeadline("IDAPI Course");
submitJob.setInputFileName(inputFileName);
submitJob.setRequestedOutputFile(requestedOutputFile);
submitJob.setSchedules(null);
submitJob.setParameterValues(parameterValues);
submitJob.setOperation(SubmitJobOperation.RunReport);
SubmitJobResponse submitJobResponse = null;
submitJobResponse = actuateControl.proxy.submitJob(submitJob);
PendingSyncJob
A complex data type that describes a job in the queue waiting for Factory processing.
Elements
ConnectionHandle
Base64Binary. An optional element that supports keeping a connection open to view a persistent report. If ConnectionHandle is present in the SOAP header, the system routes subsequent viewing requests to the same View service that returned the ConnectionHandle. If present, BIRT iHub System ignores the value of TargetVolume.
ObjectId
String. The ID of the synchronous report for which to retrieve information.
IsTransient
Boolean. True if the synchronous report is transient, False if the synchronous report is persistent.
Volume
String. The volume on which the job originated.
ServerName
String. Optional. The node on which the job is pending.
Owner
String. Optional. The name of the user who submitted the job.
ExecutableFileName
String. Optional. The fully qualified name of the report executable file.
ExecutableVersionNumber
Long. Optional. The fully qualified version number of the report executable file.
ExecutableVersionName
String. Optional. The fully qualified version name of the report executable file.
SubmissionTime
DateTime. Optional. The time at which the job was submitted to the server.
PendingTime
Long. Optional. The number of seconds elapsed since the job entered the queue.
QueueTimeout
Long. Optional. The number of seconds remaining before the job is deleted from the queue.
QueuePosition
Long. Optional. The job’s position in the queue.
Permission
A complex data type that describes a user or user group’s privileges.
Elements
RoleName
Deprecated since iHub Release 3. Replaced by UserGroupName.
UserGroupName
String. Optional. The user group name. Specify this value or UserName.
UserName
String. Optional. The user name. Specify this value or UserGroupName.
RoleId
Deprecated since iHub Release 3. Replaced by UserGroupId.
UserGroupId
String. Optional. The user group ID. Specify this value or UserId.
UserId
String. Optional. The user ID. Specify this value or UserGroupId.
AccessRight
String. The privileges the user or user group has on an object. One or more of the following characters representing a privilege:
*D—Delete
*E—Execute
*G—Grant
*V—Visible
*S—Secured Read
*R—Read
*W—Write
Printer
A complex data type that describes a printer.
Elements
Name
String. Optional. The name of the printer. Cannot exceed 50 characters.
Manufacturer
String. Optional. The manufacturer of the printer.
Model
String. Optional. The model of the printer.
Location
String. Optional. The location of the printer.
Description
String. Optional. The description of the printer.
SupportOrientation
Boolean. Optional. Specifies whether the printer supports setting paper orientation.
Orientation
String. Optional. The setting of the printer’s orientation property.
OrientationOptions
ArrayOfString. Optional. The setting of the printer’s orientation options.
SupportPageSize
Boolean. Optional. Specifies whether page size can be set on the printer.
PageSize
String. Optional. The setting of the printer’s page size property.
PageSizeOptions
ArrayOfString. Optional. The page sizes the printer supports.
SupportScale
Boolean. Optional. Specifies whether the printer supports setting the scaling factor.
Scale
Long. Optional. The setting of the printer’s scaling factor.
ScaleOptions
ArrayOfInt. Optional. The setting of the printer’s scaling options.
SupportResolution
Boolean. Optional. Specifies whether the printer supports setting the resolution.
Resolution
String. Optional. The setting of the printer’s resolution property.
ResolutionOptions
The setting of the printer’s resolution options.
SupportNumberOfCopies
Boolean. Optional. Specifies whether the printer supports setting the number of copies.
NumberOfCopies
Long. Optional. The setting of the number of copies property.
SupportCollation
Boolean. Optional. Specifies whether the printer supports setting the collation.
Collation
Boolean. Optional. The setting of the printer’s collation property.
SupportPaperTray
Boolean. Optional. Specifies whether the printer supports setting the paper tray.
PaperTray
String. Optional. The setting of the printer’s paper tray property.
PaperTrayOptions
ArrayOfString. Optional. The setting of the printer’s paper tray options.
SupportDuplex
Boolean. Optional. Specifies whether the printer supports duplex printing.
Duplex
String. Optional. The setting of the printer’s duplex property.
DuplexOptions
ArrayOfString. Optional. The setting of the printer’s duplex options.
SupportColorMode
Boolean. Optional. Specifies whether the printer supports printing in color.
ColorMode
String. Optional. The setting of the printer’s color mode property.
ColorModeOptions
ArrayOfString. Optional. The setting of printer’s color mode options.
Status
String. Optional. Indicates printer’s availability.
PrinterOptions
A complex data type that describes printer options.
Elements
PrinterName
String. The name of the printer.
Orientation
String. Optional. The paper orientation.
PageSize
String. Optional. The page size.
Scale
Long. Optional. The scaling factor.
Resolution
String. Optional. The resolution.
NumberOfCopies
Long. Optional. The number of copies.
CollationOption
Boolean. Optional. Turns collation on and off.
PaperTray
String. Optional. The paper tray.
Duplex
String. Optional. Sets duplex printing.
IsColor
Boolean. Optional. Specifies whether the printer can print in color.
IsDefaultPrinter
Boolean. Optional. Specifies whether the printer is the default printer.
PrivilegeFilter
A complex data type that represents a privilege filter. Use PrivilegeFilter to retrieve only the data accessible to user groups or users with the specified privileges and to determine whether a user or user group has the specified privileges on an item.
Elements
GrantedUserName
String. Optional. The name of the user privileges to retrieve. Specify one of this value, GrantedUserId, GrantedUserGroupId, or GrantedUserGroupName.
GrantedUserId
String. Optional. The ID of the user privileges to retrieve. Specify one of this value, GrantedUserName, GrantedUserGroupId, or GrantedUserGroupName.
GrantedRoleName
Deprecated since iHub Release 3. Replaced by GrantedUserGroupName.
GrantedRoleId
Deprecated since iHub Release 3. Replaced by GrantedUserGroupId.
GrantedUserGroupName
String. Optional. The name of the user group whose privileges to retrieve. Specify one of this value, GrantedUserName, GrantedUserId, or GrantedUserGroupId.
GrantedUserGroupId
String. Optional. The ID of the user group privileges to retrieve. Specify one of this value, GrantedUserName, GrantedUserId, or GrantedUserGroupName.
AccessRights
String. The privileges.
PropertyValue
A complex data type that specifies a name-value pair.
Elements
Name
String. The name of the property.
Value
String. Optional. The value of the property.
Range
Obsolete since Actuate Release 11.
Repeat
A complex data type that describes how often a job run is to be repeated.
Elements
StartTime
String. The time that the job is to start repeatedly running.
EndTime
String. The time that the job is to no longer run.
IntervalInSeconds
Long. The time to wait between job runs.
Record
Obsolete since Actuate Release 11.
ReportParameterType
A simple data type that describes parameter types.
Element
String. One of the following values:
Execution
An execution parameter
View
A view parameter.
All
An all parameter type.
ResourceGroup
A complex data type the describes a resource group.
Elements
Name
String. The name of the resource group.
Disabled
Boolean. Optional. Specifies whether the resource group can run jobs. If True, resource group does not run jobs. The default value is False.
Description
String. Optional. The description of the resource group.
Type
String. Optional. The type of jobs the resource group runs. Valid values are:
*Sync
The resource group runs synchronous jobs.
*Async
The resource group runs asynchronous jobs.
ReportType
String. Optional. The type of report the resource group creates.
Volume
String. Optional. The name of a volume to which to assign the resource group. Valid values are:
*An empty string
Assigns all volumes on the BIRT iHub
*A volume name
Assigns the specified volume
MinPriority
Long. Optional. Applies only to an asynchronous resource group. Specifies the minimum priority for the resource group. Valid values are 0–1,000, where 1, 000 is the highest priority. MinPriority must be less than MaxPriority. The default value is 0.
MaxPriority
Long. Optional. Applies only to an asynchronous resource group. Specifies the maximum priority for the resource group. Valid values are 0–1,000, where 1, 000 is the highest priority. MaxPriority must be more than MinPriority. The default value is 1,000.
Reserved
Boolean. Optional. Applies only to a synchronous resource group. True reserves the resource group to run only the jobs assigned to it. Use the TargetResourceGroup element in the SOAP header of an ExecuteReport request to assign a job.
StartArguments
String. Optional. The starting arguments for the resource group.
WorkUnitType
String. Optional. The license option type. An aggregate licensing model that defines iHub System features in terms of work units.
ResourceGroupSettings
A complex data type that describes the settings of a resource group.
Elements
TemplateName
String. The name of the BIRT iHub template on which the resource group runs.
Activate
Boolean. Optional. Specifies whether the BIRT iHub is a member of the resource group. If True, the BIRT iHub is a member of the resource group. The default value is False.
MaxFactory
Int. Optional. The maximum number of Factory processes available to the resource group.
MinFactory
Int. Optional. The minimum number of Factory processes available to the resource group.
FileTypes
ArrayOfString. Optional. The file types the resource group can run.
StartArguments
String. Optional. The starting arguments for the resource group.
ResultSetSchema
A complex data type that describes the result set schema.
Elements
ResultSetName
String. Optional. Name of the result set.
ResultSetDisplayName
String. Optional. The display name of the result set. If not specified, the value of the Name element is used. If the query is performed on an information object (.iob) or data source map (.sma) file, DisplayName is used as the group label.
ArrayOfColumnSchema
ArrayOfColumnSchema. Optional. An array of ColumnSchema objects.
RetryOptions
A complex data type that describes how to retry report generation or printing jobs that have failed.
Elements
RetryOption
RetryOptionType. The retry options.
MaxRetryCount
Long. Optional. The maximum number or retry attempts.
RetryInterval
Long. Optional. The interval between retry attempts. Measured in seconds.
RetryOptionType
A simple data type that describes a retry option for failed jobs.
Element
String. One of the following values:
Disabled
Specifies not to retry the job.
VolumeDefault
Specifies using the default retry options for the volume.
Specified
Specifies using the retry option defined on the job itself.
Role
Deprecated since iHub Release 3. Replaced by UserGroup.
RoleCondition
Deprecated since iHub Release 3. Replaced by UserGroupCondition.
RoleField
Deprecated since iHub Release 3. Replaced by UserGroupField.
RoleSearch
Deprecated since iHub Release 3. Replaced by UserGroupSearch.
RunningJob
A complex data type that describes a job the Factory is currently processing.
Elements
IsSyncJob
Boolean. Specifies whether the job is synchronous. True if the job is synchronous, False if the job is asynchronous.
ConnectionHandle
Base64Binary. Optional. An element that supports keeping a connection open to view a persistent report. If ConnectionHandle is present in the SOAP header, the system routes subsequent viewing requests to the same View service that returned the ConnectionHandle. If present, BIRT iHub System ignores the value of TargetVolume.
ObjectId
String. Optional. The ID of the synchronous report for which to retrieve information.
IsTransient
Boolean. Optional. Specifies whether the synchronous report is transient. True if the synchronous report is transient, False if the synchronous report is persistent.
IsProgressive
Boolean. Optional. Specifies whether progressive viewing is enabled. True if progressive viewing is enabled.
JobId
String. Optional. The ID of the asynchronous job.
Volume
String. Optional. The volume on which the job originated.
ServerName
String. Optional. The node on which the job is running.
Owner
String. Optional. The name of the user who submitted the job.
ExecutableFileName
String. Optional. The fully qualified name of the executable file.
ExecutableVersionNumber
Long. Optional. The version number of the executable file.
ExecutableVersionName
String. Optional. The version name of the executable file.
ResourceGroup
String. Optional. The resource group for the job.
SubmissionTime
DateTime. Optional. The time at which the job was submitted to the server.
StartTime
DateTime. Optional. The time at which job execution started.
RunningTime
Long. Optional. The time elapsed since job execution started.
ExecutionTimeout
Long. Optional. The number of seconds remaining before job execution times out. The number is always zero (infinite) for asynchronous reports.
IsSyncFactory
Boolean. Optional. Specifies whether the Factory is running synchronous jobs. True if the Factory is running synchronous jobs, False if the Factory is running asynchronous jobs.
FactoryPid
Long. Optional. The process ID of the Factory.
ScalarDataType
A simple data type that specifies a scalar parameter.
Element
String. One of the following values:
Currency
A Currency parameter.
Date
A Date parameter.
DateOnly
A DateOnly parameter.
Time
A Time parameter.
Double
A Double parameter.
Integer
An Integer parameter.
String
A String parameter.
Boolean
A Boolean parameter.
SearchReportByIdList
Obsolete since iHub Release 2.
SearchReportByIdNameList
Obsolete since iHub Release 2.
SearchReportByNameList
Obsolete since iHub Release 2.
SearchResultProperty
Obsolete since iHub Release 2.
ServerInformation
A complex data type that describes a BIRT iHub.
Elements
ServerName
String. The name of the BIRT iHub.
ServerStatusInformation
ServerStatusInformation. Optional. The status of the BIRT iHub. Valid values are:
*ServerState
*SystemType
*StatusErrorCode
*StatusErrorDescription
ServiceList
ArrayOfService. The list of available services.
OwnsVolume
Boolean. Optional. True if there are any volumes on the BIRT iHub, False otherwise.
Description
String. Optional. The description of the BIRT iHub.
ServerVersionInformation
ServerVersionInformation. The following information about the BIRT iHub version:
*ServerVersion
*ServerBuild
*OSVersion
ChangesPending
String. Optional. Server configuration has changed and the BIRT iHub or the system must be restarted for the changes to take effect.
NodeLockViolation
Boolean. Optional. Specifies whether a licensing node‑lock violation exists. The default value is False.
NodeLockViolationExpirationDate
String. Optional. The date on which the grace period for a node‑lock violation expires and the node lock takes effect. Contact Actuate Licensing about a node‑lock licensing problem.
TemplateName
String. The name of the BIRT iHub configuration template.
ServerIPAddress
String. Optional. The IP address or host name of the BIRT iHub.
PmdPortNumber
Int. Optional. The port where the Process Management Daemon (PMD) listens.
LocalServer
Boolean. Optional. Specifies whether the BIRT iHub is running on the local machine.
ServerResourceGroupSetting
A complex data type that describes the settings of a resource group available to a BIRT iHub.
Elements
ResourceGroupName
String. The name of the resource group.
Activate
Boolean. Optional. Specifies whether the BIRT iHub is a member of the resource group. If True, the BIRT iHub is a member of the resource group. The default value is False.
Type
String. Optional. The type of jobs the resource group runs. Valid values are:
*Sync
The resource group runs synchronous jobs.
*Async
The resource group runs asynchronous jobs.
MaxFactory
Int. Optional. The maximum number of Factory processes available to the resource group.
MinFactory
Int. Optional. The minimum number of Factory processes available to the resource group.
FileTypes
ArrayOfString. Optional. The file types the resource group can run.
StartArguments
String. Optional. The list of arguments used when starting a resource group process. For example, the Default Java Async resource group uses the following arguments:
-Xmx256M -Djava.awt.headless=true ‑Djava.protocol.handler.pkgs=com.actuate.javaserver.protocol com.actuate.javaserver.Server
ServerState
A simple data type that describes the state of Actuate iHub.
Element
String. One of the following values:
OFFLINE
The server is offline.
STARTING
The server is starting.
ONLINE
The server is online.
STOPPING
The server is stopping.
FAILED
The server failed.
ServerStatusInformation
A complex data type that describes the status of an Actuate iHub.
Elements
ServerState
ServerState. The state of the Actuate iHub. Valid values are:
*OFFLINE
*STARTING
*ONLINE
*STOPPING
*FAILED
SystemType
SystemType. The type of Actuate iHub, cluster or stand‑alone.
ServerStateErrorCode
Long. Optional. The code of the error if status is Failed.
ServerStateErrorDescription
String. Optional. The description of the error if status is Failed.
ServerVersionInformation
A complex data type that describes the version of an Actuate iHub.
Elements
ServerVersion
String. The version of the Actuate iHub.
ServerBuild
String. The build number of the Actuate iHub.
OSVersion
String. The version of the operating system.
Service
A simple data type that represents a service.
Element
String. One of the following values:
Request
A Message Distribution service (MDS).
Viewing
A View service.
Generation
A Factory service.
Caching
A Caching service.
Integration
An Integration service.
Short
Short is a standard XML short data type, which is a signed 16-bit integer, ranging in value from –32,768 to 32,767.
SortColumn
Obsolete since iHub Release 2.
Stream
A complex data type that represents a streamed image.
Elements
Name
The name of the image.
EmbeddedProperty
Specifies whether the image is embedded.
String
String is a standard XML String data type that represents character data.
SystemType
A simple data type that describes the type of BIRT iHub System.
Element
String. One of the following values:
Cluster
A cluster system.
Standalone
A stand-alone system.
SupportedQueryFeatures
Obsolete since iHub Release 2.
Time
Time is a standard XML Time data type that displays time in the format hh:mm:ss.sss with an optional time zone indicator. For example, 13:20:00-05:00 indicates 1:20 p.m. Eastern Standard Time, which is five hours behind Coordinated Universal Time (UTC).
Transaction
A packaging mechanism for Administrate operations. If a failure occurs anywhere in a transaction, all operations in the transaction fail.
Elements
TransactionOperation
The transaction operation.
TransactionOperation
Controls the ability to create, delete, update, copy, and move items within a volume. A TransactionOperation represents a single unit of work within a Transaction. Only a volume administrator or a user in the Administrator user group uses these operations.
Elements
One or more of the following elements:
CreateUser
Creates a user in the volume.
DeleteUser
Deletes one or more users.
UndeleteUser
Undeletes one or more users.
UpdateUser
Updates user properties in the volume.
CreateGroup
Obsolete since iHub Release 3.
DeleteGroup
Obsolete since iHub Release 3.
UpdateGroup
Obsolete since iHub Release 3.
CreateChannel
Obsolete since iHub Release 3.
DeleteChannel
Obsolete since iHub Release 3.
UpdateChannel
Obsolete since iHub Release 3.
CreateRole
Deprecated since iHub Release 3. Replaced by CreateUserGroup.
DeleteRole
Deprecated since iHub Release 3. Replaced by DeleteUserGroup.
UpdateRole
Deprecated since iHub Release 3. Replaced by UpdateUserGroup.
CreateUserGroup
Creates a user group in a volume.
DeleteUserGroup
Deletes one or more user groups.
UpdateUserGroup
Updates user group properties in the volume.
CreateFileType
Creates a new file type in the volume.
DeleteFileType
Deletes a file type from the volume.
UpdateFileType
Updates file type properties in the volume.
CreateFolder
Creates a folder in a volume.
DeleteFile
Deletes files or folders from the volume.
MoveFile
Moves a file or folder from the working directory to a specified target directory in the volume.
CopyFile
Copies a file or folder in the working directory to a specified target directory.
UpdateFile
Updates file or folder properties in the volume.
DeleteJob
Deletes one or more jobs.
DeleteJobNotices
Deletes one or more job notices.
DeleteJobSchedule
Deletes a job schedule.
UpdateJobSchedule
Updates a job schedule.
UpdateVolumeProperties
Updates the properties of a specific volume.
UpdateOpenSecurityCache
Flushes the volume’s open security cache and retrieves new data from an external security source.
TypeName
A simple data type that describes names of data types.
Element
String. One of the following values:
int
An integer value.
sht
A short value.
dbl
A double value.
dbn
An Actuate double value.
cur
A currency value.
dtm
An date-and-time value.
str
A string value.
bln
A Boolean value.
nll
The null value.
UndeleteUser
Undeletes users, reversing a DeleteUser operation within the unit of work of an AdminOperation. To undelete a single user, specify Id. To delete several users, specify IdList.
Elements
IdList
ArrayOfString. The list of user IDs to undelete.
Id
String. The ID of the single user to undelete.
IgnoreMissing
Boolean. Specifies what to do if the specified user does not exist. If True, BIRT iHub ignores the request. If False, the operation reports an error and stops. The default value is True.
UpdateChannel
Obsolete since iHub Release 3.
UpdateChannelOperation
Obsolete since iHub Release 3.
UpdateChannelOperationGroup
Obsolete since iHub Release 3.
UpdateFile
Updates files or folders. To update files or folders, specify the types of updates to make using UpdateFileOperationGroup, then specify which files or folders to update.
To update the properties of a file or folder, you must have the write privilege on the file or folder. To update privileges to the file or folder, you must have the grant privilege on the file or folder.
To update a single file or folder, specify Name or Id. To update a list of files or folders, specify NameList or IdList. To update files or folders matching the specified conditions, specify Search.
Elements
WorkingFolderId
String. The ID of the working folder of the file or folder to update. Specify either WorkingFolderId or WorkingFolderName.
WorkingFolderName
String. The name of the working folder of the file or folder to update. Specify either WorkingFolderName or WorkingFolderId.
LatestVersionOnly
Boolean. Specifies whether to search all versions of the file. If True, the search includes only the latest version. The default value is False.
Recursive
Boolean. Specifies whether to search subfolders. If True, the search includes subfolders. The default value is False.
UpdateFileOperationGroup
Specifies the group criteria used to perform the update file operation task:
*Search
FileSearch. The search conditions. If conditions apply to multiple fields, use ConditionArray.
*NameList
ArrayOfString. The list of file or folder names to update. Specify either NameList or IdList.
*IdList
ArrayOfString. The list of file or folder IDs to update. Specify either IdList or NameList.
*Id
String. The ID of the single file or folder to update. Specify either Id or Name.
*Name
String. The name of the single file or folder to update. Specify either Name or Id.
IgnoreMissing
Boolean. Specifies what to do if the specified file or folder does not exist. If True, BIRT iHub ignores the request. If False, the operation reports an error and stops. The default value is True.
UpdateFileOperation
Specifies the tasks to perform during the UpdateFile operation. To specify which files to update, use UpdateFile.
Elements
SetAttributes
File. The general attributes to update.
AddDependentFilesByName
ArrayOfString. The names of files to add as dependents. Specify either AddDependentFilesByName or AddDependentFilesById.
RemoveDependentFilesByName
ArrayOfString. The names of dependent files to remove. Specify either RemoveDependentFilesByName or RemoveDependentFilesById.
SetDependentFilesByName
ArrayOfString. The names of dependent files to update. Specify either SetDependentFilesByName or SetDependentFilesById.
AddRequiredFilesByName
ArrayOfString. The names of required files to add. Specify either AddRequiredFilesByName or AddRequiredFilesById.
RemoveRequiredFilesByName
ArrayOfString. The names of required files to remove. Specify either RemoveRequiredFilesByName or RemoveRequiredFilesById.
SetRequiredFilesByName
ArrayOfString. The names of required files to update. Specify either SetRequiredFilesByName or SetRequiredFilesById.
AddDependentFilesById
ArrayOfString. The IDs of files to add as dependents. Specify either AddDependentFilesById or AddDependentFilesByName.
RemoveDependentFilesById
ArrayOfString. The IDs of dependent files to remove. Specify either RemoveDependentFilesById or RemoveDependentFilesByName.
SetDependentFilesById
ArrayOfString. The IDs of dependent files to update. Specify either SetDependentFilesById or SetDependentFilesByName.
AddRequiredFilesById
ArrayOfString. The IDs of required files to add. Specify either AddRequiredFilesById or AddRequiredFilesByName.
RemoveRequiredFilesById
ArrayOfString. The IDs of required files to remove. Specify either RemoveRequiredFilesById or RemoveRequiredFilesByName.
SetRequiredFilesById
ArrayOfString. The IDs of required files to update. Specify either SetRequiredFilesById or SetRequiredFilesByName.
GrantPermissions
ArrayOfPermission. The new privileges to grant. You cannot grant privileges to a file with private access.
RevokePermissions
ArrayOfPermission. The privileges to revoke. You cannot revoke privileges to a file with private access.
SetPermissions
ArrayOfPermission. The privileges to update. You cannot update privileges to a file with private access.
AddArchiveRules
ArrayOfArchiveRule. The new autoarchive rules.
RemoveArchiveRules
ArrayOfArchiveRule. The autoarchive rules to remove.
SetArchiveRules
ArrayOfArchiveRule. The autoarchive rules to update.
SetParameterDefinitions
ArrayOfParameterDefinition. The dynamic report parameters for third-party executable files.
UpdateFileOperationGroup
Specifies the UpdateFileOperation element within UpdateFile.
Element
UpdateFileOperation
The UpdateFileOperation element to use during the UpdateFile operation.
UpdateFileType
Updates file types. To update file types, specify the types of updates to make using UpdateFileTypeOperationGroup, then specify which file types to update.
To update a single file type, specify Name or Id. To update a list of file types, specify NameList or IdList.
Elements
UpdateFileTypeOperationGroup
The tasks to perform.
NameList
ArrayOfString. The list of file types to update.
Name
String. The name of a single file type to update.
IgnoreMissing
Boolean. Specifies what to do if the specified file type does not exist. If True, BIRT iHub ignores the request. If False, the operation reports an error and stops. The default value is True.
IgnoreDup
Boolean. Specifies whether to report an error for a duplicate request. BIRT iHub always rejects a duplicate request regardless of the IgnoreDup setting. If True, BIRT iHub does not report an error. In a name list or ID list, True prevents BIRT iHub from performing duplicate operations. If False, BIRT iHub reports an error. The default value is False.
UpdateFileTypeOperation
Specifies the tasks to perform during the UpdateFileType operation.
Elements
SetAttributes
FileType. The general attributes to update.
SetParameterDefinitions
ArrayOfParameterDefinition. The parameters to update.
SetWindowsIcon
Base64Binary. The Windows icon to display for the file type.
SetLargeWebIcon
Base64Binary. The large icon to display for the file type in a browser.
SetSmallWebIcon
Base64Binary. The small icon to display for the file type in a browser.
UpdateFileTypeOperationGroup
Specifies the UpdateFileTypeOperation element to use during the UpdateFileType operation.
Element
UpdateFileTypeOperation
The UpdateFileTypeOperation element to use in the UpdateFileType operation.
UpdateGroup
Obsolete since iHub Release 3.
UpdateGroupOperation
Obsolete since iHub Release 3.
UpdateGroupOperationGroup
Obsolete since iHub Release 3.
UpdateJobSchedule
Updates job schedules. To update scheduled jobs, specify the types of updates to make using UpdateJobScheduleOperationGroup, then specify which jobs to update.
To update a single scheduled job, specify Id. To update a list of scheduled jobs, specify IdList. To update scheduled jobs matching the specified conditions, specify Search.
Elements
UpdateJobScheduleOperationGroup
The tasks to perform.
Search
JobScheduleSearch. The search conditions. If conditions apply to multiple fields, use ConditionArray.
IdList
ArrayOfString. The list of job IDs to update.
Id
String. The ID of a single job to update.
IgnoreMissing
Boolean. Specifies what to do if the specified job does not exist. If True, BIRT iHub ignores the request. If False, the operation reports an error and stops. The default value is True.
UpdateJobScheduleOperation
Specifies the tasks to perform during the UpdateJobSchedule operation.
Elements
SetAttributes
JobProperties. The general attributes to update.
SetParameters
JobInputDetail. The input parameters, output parameters, autoarchive settings, and distribution location settings to update.
SetPrinterOptions
JobPrinterOptions. The printer options to update.
SetSchedules
JobSchedule. The schedules to set.
AddUserNotificationByName
ArrayOfString. The name of the user to add to the notification list. Specify either AddUserNotificationByName or AddUserNotificationById.
RemoveUserNotificationByName
ArrayOfString. The name of the user to remove from the notification list. Specify either RemoveUserNotificationByName or RemoveUserNotificationById.
SetUserNotificationByName
ArrayOfString. The name of the user for whom to update notification. Specify either SetUserNotificationByName or SetUserNotificationById.
AddGroupNotificationByName
Obsolete since iHub Release 3.
RemoveGroupNotificationByName
Obsolete since iHub Release 3.
SetGroupNotificationByName
Obsolete since iHub Release 3.
AddChannelNotificationByName
Obsolete since iHub Release 3.
RemoveChannelNotificationByName
Obsolete since iHub Release 3.
SetChannelNotificationByName
Obsolete since iHub Release 3.
AddUserNotificationById
ArrayOfString. The ID of the user to add to the notification list. Specify either AddUserNotificationById or AddUserNotificationByName.
RemoveUserNotificationById
ArrayOfString. The ID of the user to remove from the notification list. Specify either RemoveUserNotificationById or RemoveUserNotificationByName.
SetUserNotificationById
ArrayOfString. The ID of the user for whom to update notification. Specify either SetUserNotificationById or SetUserNotificationByName.
AddGroupNotificationById
Obsolete since iHub Release 3.
RemoveGroupNotificationById
Obsolete since iHub Release 3.
SetGroupNotificationById
Obsolete since iHub Release 3.
AddChannelNotificationById
Obsolete since iHub Release 3.
RemoveChannelNotificationById
Obsolete since iHub Release 3.
SetChannelNotificationById
Obsolete since iHub Release 3.
AddOutputFilePermissions
ArrayOfPermission. The output file permissions to add. You cannot add file permissions to a file with private access.
RemoveOutputFilePermissions
ArrayOfPermission. The output file permissions to remove. You cannot remove file permissions from a file with private access.
SetOutputFilePermissions
ArrayOfPermission. The output file permissions to update. You cannot update file permissions of a file with private access.
SetParameterValues
ArrayOfParameterValue. The parameter values to update.
SetQuery
Obsolete since iHub Release 3.
SetOutputFileAccess
FileAccess. The access rights to the output file to update. Valid values are:
*Private
Only the owner of the file and an administrator can access the file.
*Shared
All users and user groups specified in the access control list (ACL) for the file can access the file.
SetWaitForEvent
Event. The event to set that is being waited on. When set, processes that are waiting for this event will proceed.
UpdateJobScheduleOperationGroup
Specifies the UpdateJobScheduleOperation element within the UpdateJobSchedule operation.
Element
UpdateJobScheduleOperation
The UpdateJobScheduleOperation element for use with the UpdateJobSchedule operation.
UpdateOpenSecurityCache
Flushes the volume’s open security cache and retrieves new data from the external security source. Use UpdateOpenSecurityCache when information in the external data source has changed and must be updated immediately.
In the request, specify the list of users, user groups, and translated user or user group names to update. If no users, user groups, or translated names are specified, all users, user groups, and translated names are updated. Otherwise, only the specified items are updated.
Elements
UserNameList
ArrayOfString. The list of user names to retrieve.
GroupList
Obsolete since iHub Release 3.
RoleList
Deprecated since iHub Release 3. Replaced by UserGroupList.
UserGroupList
ArrayOfString. The list of user groups to retrieve.
TranslatedUserNames
ExternalTranslatedUserNames. The translated user names to retrieve, such as Administrator.
TranslatedRoleNames
Deprecated since iHub Release 3. Replaced by TranslatedUserGroupNames.
TranslatedUserGroupNames
ExternalTranslatedUserGroupNames. The translated user group names to retrieve, such as Administrator.
UpdateRole
Deprecated since iHub Release 3. Replaced by UpdateUserGroup.
UpdateUser
Updates user properties. To update users, specify the types of updates to make using UpdateUserOperationGroup, then specify which users to update.
To update a single user, specify Name or Id. To update a list of users, specify NameList or IdList. To update users matching the specified conditions, specify Search.
Elements
UpdateUserOperationGroup
The tasks to perform. The valid value are Search, IdList, NameList, Id, and Name.
Search
UserSearch. The search conditions. If search conditions apply to multiple fields, use ConditionArray.
IdList
ArrayOfString. The list of user IDs to update. Specify either IdList or NameList.
NameList
ArrayOfString. The list of user names to update. Specify either NameList or IdList.
Id
String. The ID of a single user to update. Specify either Id or Name.
Name
String. The name of a single user to update. Specify either Name or Id.
IgnoreMissing
Boolean. Specifies what to do if the specified user does not exist. If True, BIRT iHub ignores the request. If False, the operation reports an error and stops. The default value is True.
IgnoreDup
Boolean. Specifies whether to report an error for a duplicate request. BIRT iHub always rejects a duplicate request regardless of the IgnoreDup setting. If True, BIRT iHub does not report an error. In a name list or ID list, True prevents BIRT iHub from performing duplicate operations. If False, BIRT iHub reports an error. The default value is False.
SkipPermissionError
Obsolete since iHub Release 3.
UpdateUserGroup
Updates a user group. Available only to users in the Administrator user group.
Elements
UpdateUserGroupOperationGroup
The UpdateUserGroupOperation element to use during the UpdateUserGroup operation.
Search
UserGroupSearch. The search condition that specifies which user groups to delete.
IdList
ArrayOfString. The list of user group IDs to delete. Specify either IdList or NameList.
NameList
ArrayOfString. The list of user group names to delete. Specify either NameList or IdList.
Id
String. The ID of the single user group to delete. Specify either Id or Name.
Name
String. The name of the single user group to delete. Specify either Name or Id.
IgnoreMissing
Boolean. Specifies what to do if the specified user group does not exist. If True, BIRT iHub ignores the request. If False, the operation reports an error and stops. The default value is True.
IgnoreDup
Boolean. Specifies whether to report an error when creating the user group if one with the same name already exists. BIRT iHub always rejects a duplicate request regardless of the IgnoreDup setting. If True, BIRT iHub does not report an error. If False, BIRT iHub reports an error. The default value is False.
UpdateUserGroupOperation
Specifies the tasks to perform during the UpdateUserGroup operation.
Elements
SetAttributes
UserGroup. The general attributes to update.
AssignedToUsersByName
ArrayOfString. The names of user groups to which to assign users. Specify either AssignedToUsersByName or AssignedToUsersById.
DroppedFromUsersByName
ArrayOfString. The names of user groups from which to delete users. Specify either DroppedFromUsersByName or DroppedFromUsersById.
SetBearingUsersByName
ArrayOfString. The names of user groups to which to reassign users. Specify either SetBearingUsersByName or SetBearingUsersById.
AddChildUserGroupsByName
ArrayOfString. The names of user groups to add to the user group as descendant user groups. Specify either AddChildUserGroupsByName or AddChildUserGroupsById.
RemoveChildUserGroupsByName
ArrayOfString. The names of descendant user groups to remove from the UserGroup. Specify either RemoveChildUserGroupsByName or RemoveChildUserGroupsById.
SetChildUserGroupsByName
ArrayOfString. The names of the user group’s descendant user groups. Specify either SetChildUserGroupsByName or SetChildUserGroupsById.
AddParentUserGroupsByName
ArrayOfString. The names of user groups to add to the user group as its ascendant user groups. Specify either AddParentUserGroupsByName or AddParentUserGroupsById.
RemoveParentUserGroupsByName
ArrayOfString. The name of the parent user group to remove. Specify either RemoveParentUserGroupsByName or RemoveParentUserGroupsById.
SetParentUserGroupsByName
ArrayOfString. The names of the user group’s ascendant user groups. Specify either SetParentUserGroupsByName or SetParentUserGroupsById.
AssignedToUsersById
ArrayOfString. The IDs of user groups to which to assign users. Specify either AssignedToUsersById or AssignedToUsersByName.
DroppedFromUsersById
ArrayOfString. The IDs of user groups from which to delete users. Specify either DroppedFromUsersById or DroppedFromUsersByName.
SetBearingUsersById
ArrayOfString. The IDs of user groups to which to reassign users. Specify either SetBearingUsersById or SetBearingUsersByName.
AddChildUserGroupsById
ArrayOfString. The IDs of user groups to add to the user group as descendant user groups. Specify either AddChildUserGroupsByName or AddChildUserGroupsById.
RemoveChildUserGroupsById
ArrayOfString. The IDs of descendant user groups to remove from the user group. Specify either RemoveChildUserGroupsById or RemoveChildUserGroupsByName.
SetChildUserGroupsById
ArrayOfString. The IDs of the user group’s descendant user groups. Specify either SetChildUserGroupsById or SetChildUserGroupsByName.
AddParentUserGroupsById
ArrayOfString. The IDs of user groups to add to the user group as its ascendant user groups. Specify either AddParentUserGroupsById or AddParentUserGroupsByName.
RemoveParentUserGroupsById
ArrayOfString. The IDs of the ascendant user groups to remove. Specify either RemoveParentUserGroupsByName or RemoveParentUserGroupsById.
SetParentUserGroupsById
ArrayOfString. The IDs of the user group’s ascendant user groups. Specify either SetParentUserGroupsById or SetParentUserGroupsByName.
UpdateUserGroupOperationGroup
Specifies the UpdateUserGroupOperation element to use during the UpdateUserGroup operation.
Element
UpdateUserGroupOperation
The UpdateUserGroupOperation element for use with the UpdateUserGroup operation.
UpdateUserOperation
Specifies the tasks to perform during the UpdateUser operation.
Elements
SetAttributes
User. The general attributes to update.
AddToGroupsByName
Obsolete since iHub Release 3.
RemoveFromGroupsByName
Obsolete since iHub Release 3.
SetGroupMembershipsByName
Obsolete since iHub Release 3.
AssignRolesByName
Deprecated since iHub Release 3. Replaced by AssignUserGroupsByName.
DropRolesByName
Deprecated since iHub Release 3. Replaced by DropUserGroupsByName.
SetRolesByName
Deprecated since iHub Release 3. Replaced by SetUserGroupsByName.
AssignUserGroupsByName
ArrayOfString. The names of user groups to assign to users. Specify either AssignUserGroupsByName or AssignUserGroupsById.
DropUserGroupsByName
ArrayOfString. The names of user groups from which to remove users. Specify either DropUserGroupsByName or DropUserGroupsById.
SetUserGroupsByName
ArrayOfString. The names of user groups to update. Specify either SetUserGroupsByName or SetUserGroupsById.
SubscribeToChannelsByName
Obsolete since iHub Release 3.
UnsubscribeFromChannelsByName
Obsolete since iHub Release 3.
SetChannelSubscriptionsByName
Obsolete since iHub Release 3.
AddToGroupsById
Obsolete since iHub Release 3.
RemoveFromGroupsById
Obsolete since iHub Release 3.
SetGroupMembershipsById
Obsolete since iHub Release 3.
AssignRolesById
Deprecated since iHub Release 3. Replaced by AssignUserGroupsById.
DropRolesById
Deprecated since iHub Release 3. Replaced by DropUserGroupsById.
SetRolesById
Deprecated since iHub Release 3. Replaced by SetUserGroupsById.
AssignUserGroupsByID
ArrayOfString. The IDs of user groups to assign to users. Specify either AssignUserGroupsByName or AssignUserGroupsById.
DropUserGroupsByID
ArrayOfString. The IDs of user groups from which to remove users. Specify either DropUserGroupsByName or DropUserGroupsById.
SetUserGroupsByID
ArrayOfString. The IDs of user groups to update. Specify either SetUserGroupsByName or SetUserGroupsById.
SubscribeToChannelsById
Obsolete since iHub Release 3.
UnsubscribeFromChannelsById
Obsolete since iHub Release 3.
SetChannelSubscriptionsById
Obsolete since iHub Release 3.
AddFileCreationPermissions
ArrayOfString. Grants users the permissions to add files.
RemoveFileCreationPermissions
Revokes users’ ability to add files.
SetFileCreationPermissions
ArrayOfString. Modifies users’ ability to add files.
SetPrinterOptions
ArrayOfString. The printer options to set for the users.
SetLicenseOptions
ArrayOfString. The license options to set for the users.
AddLicenseOptions
ArrayOfString. Grants users the right to add license options.
RemoveLicenseOptions
ArrayOfString. Removes the right of users to add license options.
UpdateUserOperationGroup
Specifies the UpdateUserOperation element to use during the UpdateUser operation.
Element
UpdateUserOperation
The UpdateUserOperation element for use with the UpdateUser operation.
UpdateVolumeProperties
Updates a volume. To update a volume, specify the types of updates to make using UpdateVolumeOperationGroup, then specify which volume to update.
Element
UpdateVolumePropertiesOperationGroup
The tasks to perform.
UpdateVolumePropertiesOperation
Specifies the tasks to perform during the UpdateVolumeProperties operation.
Elements
SetAttributes
Volume. Contains one or more of the following volume properties to update:
*DefaultPrinterName
*MaxJobRetryCount
*JobRetryInterval
The interval between retry attempts. Measured in seconds.
*DefaultViewingPreference
*DHTMLPageCaching
*DHTMLPageCachingExpiration
If DHTMLPageCaching is True, set the DHTMLPageCachingExpiration to a valid value. To disable DHTMLPageCaching, set DHTMLPageCachingExpiration to ‑1.
SetPrinterOptions
ArrayOfPrinterOptions. The volume printer options to update.
SetSystemPrinters
ArrayOfPrinter. The printer to set as the system printer for the volume.
ClearSystemPrinters
ArrayOfString. The printer to remove from the volume.
SetAutoArchiveSchedules
JobSchedule. The start of the autoarchive schedule for folders and files on the volume.
UpdateVolumePropertiesOperationGroup
Specifies the UpdateVolumePropertiesOperation element to use during the UpdateVolumeProperties operation.
Element
UpdateVolumePropertiesOperation
The UpdateVolumePropertiesOperation element for use with the UpdateVolumeProperties operation.
User
A complex data type that describes a user.
Elements
Id
String. Optional. The user ID.
Name
String. Optional. The user name. A user name is a string of 1 to 256 characters, including any character except a control character. A user name is not case‑sensitive. BIRT iHub stores a user name in mixed case, always displaying it exactly the way it was typed during creation.
Password
String. Optional. The user password. A password is a string of 1 to 256 characters, including any character except a control character or space. Security experts recommend using passwords of at least eight characters, including mixed‑case alphabetic and numeric characters. A password is case-sensitive. The Administrator can change any user password. Users can only change their own passwords. BIRT iHub encrypts a user password.
EncryptedPwd
String. Optional. The encrypted password of the user.
Description
String. Optional. The description of the user.
IsLoginDisabled
Boolean. Optional. Specifies whether the user can log in.
EmailAddress
String. Optional. The user e‑mail address.
HomeFolder
String. Optional. The user home folder.
ViewPreference
String. Optional. The user viewer, Default or DHTML.
MaxJobPriority
Long. Optional. The maximum priority that the user can assign to a job.
MaxNotices
Long. Optional. The maximum number of notices that the user can retain.
SendNoticeForSuccess
Boolean. Optional. Specifies whether the BIRT iHub sends success notices to the user.
SendNoticeForFailure
Boolean. Optional. Specifies whether the BIRT iHub sends failure notices to the user.
SuccessNoticeExpiration
Long. Optional. Specifies the minimum number of minutes success notices remain in the Completed folder. After this time elapses, BIRT iHub removes the notices the next time it removes requests from the volume’s Requests\Completed folder. If not set or set to 0, DefaultSuccessNoticeExpiration specified in Volume is used. To set the user success notices to never expire, set the value to 0xffffffff.
FailureNoticeExpiration
Long. Optional. Specifies the minimum number of minutes failure notices remain in the Completed folder. After this time elapses, BIRT iHub removes the notices the next time it removes requests from the volume’s Requests\Completed folder. If not set or set to 0, DefaultFailureNoticeExpiration specified in Volume is used. To set the user failure notices to never expire, set the value to 0xffffffff.
SendEmailForSuccess
Boolean. Optional. Specifies whether the BIRT iHub sends success notices in an e‑mail message to the user.
SendEmailForFailure
Boolean. Optional. Specifies whether the BIRT iHub sends failure notices in an e‑mail message to the user.
AttachReportInEmail
Boolean. Optional. Specifies whether to attach a report to an e-mail completion notice.
DefaultPrinterName
String. Optional. The name of the user default printer.
UserCondition
A complex data type that represents the field on which to perform a search and the condition to match.
Elements
Field
String. The field on which to perform a search.
Match
String. The condition to match. If the condition includes special characters, for example a dash, either escape the special character with a backslash (\) or enclose it in brackets ([ ]). For example, to search for a file 05-25-04Report.rptdocument, specify one of the following:
05\-25\-04Report.rptdocument
05[-]25[-]04Report.rptdocument
UserField
A simple data type that describes the fields within a user element.
Element
String. One of the following values:
Name
The user name.
Description
The description of the user.
IsLoginDisabled
Specifies whether the user can log in.
EmailAddress
The user e-mail address.
HomeFolder
The user home folder.
ViewPreference
The user viewer, Default or DHTML.
MaxJobPriority
The maximum priority that the user can assign to a job.
SuccessNoticeExpiration
Specifies the minimum number of minutes success notices remain in the Completed folder.
FailureNoticeExpiration
Specifies the minimum number of minutes failure notices remain in the Completed folder.
SendNoticeForSuccess
Specifies whether the BIRT iHub sends success notices to the user.
SendNoticeForFailure
Specifies whether the BIRT iHub sends failure notices to the user.
SendEmailForSuccess
Specifies whether the BIRT iHub sends success notices in an e‑mail message to the user.
SendEmailForFailure
Specifies whether the BIRT iHub sends failure notices in an e‑mail message to the user.
AttachReportInEmail
Specifies whether to attach a report to an e‑mail completion notice.
DefaultPrinterName
The name of the user default printer.
UserGroup
A complex data type that describes a user group.
Elements
Id
String. Optional. The user group ID.
Name
String. Optional. The name of the user group. Cannot exceed 50 characters.
Description
String. Optional. The description of the user group. Cannot exceed 500 characters.
UserGroupCondition
A complex data type that represents the field on which to perform a user group search and the condition to match.
Elements
Field
UserGroupField. The field on which to perform a search.
Match
String. The condition to match. If the condition includes special characters, for example a dash, either escape the special character with a backslash (\) or enclose it in brackets ([ ]). For example, to search for a file 05‑25‑04Report.rptdocument, specify one of the following:
05\-25\-04Report.rptdocument
05[-]25[-]04Report.rptdocument
UserGroupField
A simple data type that lists user group fields on which a search can be performed.
Element
String. One of the following values:
Name
The name of the user group.
Description
The description of the user group.
UserGroupSearch
A complex data type that represents a user group search.
Elements
Condition
UserGroupCondition. Optional. The search condition. Specify this value of ConditionArray.
ConditionArray
ArrayOfUserGroupCondition. Optional. An array of search conditions. Specify this value of Condition.
ParentUserGroupName
String. Optional. The name of the parent user group of which the user is a member. Specify one of this value, ChildUserGroupName, AssignedToUserName, ParentUserGroupId, ChildUserGroupId, or AssignedToUserId.
ChildUserGroupName
String. Optional. The name of the child user group to which the user belongs. Specify one of this value, ParentUserGroupName, AssignedToUserName, ParentUserGroupId, ChildUserGroupId, or AssignedToUserId.
WithRightsToChannelName
Obsolete since iHub Release 3.
AssignedToUserName
String. Optional. The user name to which the user group is assigned. Specify one of this value, ParentUserGroupName, ChildUserGroupName, ParentUserGroupId, ChildUserGroupId, or AssignedToUserId.
ParentUserGroupId
String. Optional. The ID of the parent user group to which the group belongs. Specify one of this value, ParentUserGroupName, ChildUserGroupName, AssignedToUserName, ChildUserGroupId, or AssignedToUserId.
ChildUserGroupId
String. Optional. The ID f the child user group to which the group belongs. Specify one of this value, ParentUserGroupName, ChildUserGroupName, AssignedToUserName, ParentUserGroupId, or AssignedToUserId.
WithRightsToChannelId
Obsolete since iHub Release 3.
AssignedToUserId
String. Optional. The user ID to which the user group is assigned. Specify one of this value, ParentUserGroupName, ChildUserGroupName, AssignedToUserName, ParentUserGroupId, or ChildUserGroupId.
FetchSize
Int. Optional. The maximum number of records to retrieve and return in a result set. The default value is 500.
FetchDirection
Boolean. Optional. If True, records are retrieved forward. If False, records are retrieved backward. The default value is True.
CountLimit
Int. Optional. The maximum number of records to count. By default, CountLimit is equal to FetchSize. To count all records, set CountLimit to ‑1.
FetchHandle
String. Optional. Retrieves more items from the result set. In the second and subsequent calls for data, specifies the same search criteria as in the original call.
UserSearch
A complex data type that represents a user search.
Elements
Condition
UserCondition. Optional. The search condition. Specify this value of ConditionArray.
ConditionArray
ArrayOfUserCondition. Optional. An array of search conditions. Specify this value of ConditionArray.
MemberOfGroupName
Obsolete since iHub Release 3.
WithRoleName
Deprecated since iHub Release 3. Replaced by WithUserGroupName.
WithUserGroupName
String. Optional. The name of the user group to which the user belongs. Specify one of this value, WithUserGroupId, or WithLicenseOption.
SubscribedToChannelName
Obsolete since iHub Release 3.
MemberOfGroupId
Obsolete since iHub Release 3.
WithRoleId
Deprecated since iHub Release 3. Replaced by WithUserGroupId.
WithUserGroupId
String. Optional. The ID of the user group to which the user belongs. Specify one of this value, WithUserGroupName, or WithLicenseOption.
WithLicenseOption
String. Optional. The name of the license option assigned to the user. Specify one of this value, WithUserGroupName, or WithUserGroupId.
SubscribedToChannelId
Obsolete since iHub Release 3.
FetchSize
Int. Optional. The maximum number of records to retrieve and return in a result set. The default value is 500.
FetchDirection
Boolean. Optional. If True, records are retrieved forward. If False, records are retrieved backward. The default value is True.
CountLimit
Int. Optional. The maximum number of records to count. By default, CountLimit is equal to FetchSize. To count all records, set CountLimit to ‑1.
FetchHandle
String. Optional. Retrieves more items from the result set. In the second and subsequent calls for data, specifies the same search criteria as in the original call.
VersioningOption
A simple data type that specifies the options for handling the latest existing version when uploading a file.
Element
String. One of the following values:
CreateNewVersion
Always creates a new version. This is the default value.
ReplaceLatestIfNoDependents
Replaces the latest existing version if it does not have any dependent files. If the existing version has any dependents, BIRT iHub creates a new version instead of replacing the existing version.
ReplaceLatestDropDependency
Replaces the latest existing version if it does not have any dependent files. If the existing version has any dependents, BIRT iHub drops the dependency.
ReplaceLatestMigrateDependency
Replaces the latest existing version if it does not have any dependent files. If the existing version has any dependents, BIRT iHub moves the dependency to the new version.
ViewParameter
A complex data type that describes a viewing parameter.
Elements
Format
String. Optional. The format in which the report displays. Valid formats are:
*CSS
*DHTML
*DHTMLLong
*DHTMLRaw
*ExcelData
*ExcelDisplay
*ImageMapURL
Supports users clicking a point in a chart to navigate to different report sections
*PDF
*PPT
*PPTFullyEditable
*Reportlet
Valid only if ShowInReportlet is enabled during report design
*RTF
*RTFFullyEditable
*XMLCompressedDisplay
*XMLCompressedExcel
*XMLCompressedPDF
*XMLCompressedPPT
*XMLCompressedReportlet
*XMLCompressedRTF
*XMLData
*XMLDisplay
*XMLReportlet
*XMLStyle
UserAgent
String. Optional. The browser to use for report viewing, such as Mozilla/4.0.
ScalingFactor
Long. Optional. Adapts the size of a Reportlet to the Reportlet frame.
AcceptEncoding
String. Optional. The list of encoding methods the browser supports.
ViewOperation
String. Optional. The view operation, View or Print.
PathInformation
String. Optional. The path to the report.
EmbeddedObjPath
String. Optional. The base URL to prepend to a static or dynamic object in a report. When viewing a report in a browser, the URL of an image, chart, JavaScript, or another resource refers to the volume. Use EmbeddedObjPath to change this URL.
RedirectPath
String. Optional. Maps from the current URL to a new target.
PdfQuality
Long. Optional. The viewing quality of a PDF.
Volume
A complex data type that describes a volume.
Elements
Name
String. The name of the volume.
ActuateVersion
String. Optional. The version number.
ActuateBuildNumber
String. Optional. The build number.
SecurityIntegrationOption
Long. Optional. The security integration option.
OpenSecuritySelectUsersOfRole
Deprecated since iHub Release 3. Replaced by OpenSecuritySelectUsersOfUserGroup.
OpenSecuritySelectUsersOfUserGroup
Boolean. Optional. Applies only if using external registration security level. Indicates whether the SelectUsers operation for a user group is supported. If the operation is supported, iHub enables appropriate features in iHub Visualization Platform.
OpenSecuritySelectGroupsOfUser
Obsolete since iHub Release 3.
DefaultPrinterName
String. Optional. The name of the default printer.
MaxJobRetryCount
Long. Optional. The maximum number of retry attempts.
JobRetryInterval
Long. Optional. The interval between retry attempts. Measured in seconds.
DefaultViewingPreference
Obsolete since iHub Release 2.
DHTMLPageCaching
Boolean. Optional. True enables DHTML page caching.
DHTMLPageCachingExpirationAge
Long. Optional. If DHTMLPageCaching is True, set DHTMLPageCachingExpirationAge to a valid value. To disable DHTMLPageCaching, set DHTMLPageCachingExpirationAge to ‑1.
IsAutoArchiveRunning
Boolean. Optional. Determines whether an archive pass is currently running. If True, an archive pass is running.
AuthorizationIsExternal
Boolean. Optional. Specifies whether user registration is external.
ConnectionPropertiesAreExternal
Boolean. Optional. Specifies whether connection properties are externalized using the Report Server Security Extension (RSSE).
DefaultSuccessNoticeExpiration
Long. Optional. Specifies the minimum number of minutes success notices remain in the Completed folder. After this time elapses, BIRT iHub removes the notices the next time it removes requests from the volume’s Requests\Completed folder. This time applies to all users whose SuccessNoticeExpiration time is not set or is set to 0. The default value is 0, which means notices never expire.
DefaultFailureNoticeExpiration
Long. Optional. Specifies the minimum number of minutes failure notices remain in the Completed folder. After this time elapses, BIRT iHub removes the notices the next time it removes requests from the volume’s Requests\Completed folder. This time applies to all users whose SuccessNoticeExpiration time is not set or is set to 0. The default value is 0, which means notices never expire.
ResourcePath
String. Optional. The resource path to the volume.
Weekly
A complex data type describing weekly job scheduling.
Elements
FrequencyInWeeks
Long. The number of times a job is to run, in weeks.
RunOn
String. The day to run the job.
OnceADay
String. Optional. The time to run the job.
Repeat
Repeat. Optional. The number of times to repeat the schedule.