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.
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.
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:complexTypename="ArrayOfX">
<xsd:sequence>
<xsd:elementname="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:
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:complexTypename="ArrayOfDate">
<xsd:sequence>
<xsd:elementname="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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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();
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.
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.
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.
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.
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.
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.
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.
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:
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.