• About Using BIRT iHub Integration Technology
•  Understanding the Information Delivery API and schema
  • About the Actuate Information Delivery API
  • About web services and WSDL
  •  Understanding the elements of iHub’s WSDL schema
    • About the definitions element
    • About data type definitions
    • About message definitions
    • About the portType definition
    • About the binding definition
    • About the service definition
  • Accessing the Actuate schema using a web browser
•  Constructing a SOAP message
  • About SOAP messaging
  • Calling an Actuate web service
  •  About SOAP message elements
    • Understanding the HTTP header
    • Understanding the SOAP envelope
    • About XML namespace declarations
    • Understanding the SOAP header
    • Understanding the SOAP message body
  • About SOAP Fault messages
•  Understanding Actuate Information Delivery API operations
  •  About Actuate Information Delivery API operations
    • Working with BIRT iHub
    • Working with channels
    • Working with Encyclopedia volumes
    • Working with files and folders
    • Working with groups
    • Working with information objects and databases
    • Working with jobs and reports
    •  Working with searches
      • Performing a search operation
      • Using special characters in searches
    • Working with users, roles, and security
•  Running, printing, and viewing a document
  • Generating or printing a document
  •  Running a synchronous report
    • Setting a time frame for an ExecuteReport response
    • Waiting for report generation
    • Running a synchronous report that uses parameters
    • Retrieving report parameter values
  •  Running or printing a job
    • Understanding SubmitJob
    •  Specifying parameters for a job
      • About hidden, required parameters
    • Scheduling report generation or printing
    •  Working with a job notification
      • About e-mail attachments
      • About notifying a channel
      • Sending an e‑mail notification using SubmitJob
      • Sending an e‑mail notification using UpdateJobSchedule
      • Notifying a channel using SubmitJob
      • Notifying a channel using UpdateJobSchedule
      • Customizing an e‑mail notification
      • Using the e‑mail template for multiple locales
    • Retrieving job properties using GetJobDetails
    • Retrieving job properties using GetNoticeJobDetails
    • Cancelling a job
  •  Working with a resource group
    • Creating an asynchronous resource group
    • Creating a synchronous resource group
    • Updating a resource group’s properties
    • Getting a list of resource groups
    • Retrieving the properties of a specific resource group
    • Retrieving properties for all resource groups on a BIRT iHub
    • Setting properties for the resource groups on a BIRT iHub
    • Deleting a resource group
    • Assigning a report to a resource group
    • Assigning a job to a resource group
    • Retrieving the resource group to which a job is assigned
  •  Retrieving and viewing data
    •  Requesting a page or range of pages using SelectPage
      • Retrieving the attachment to a SelectPage response
      • Using SelectPage to print
    • Retrieving report content
    • Retrieving embedded data and style sheets
    • Searching within a document
    • Searching for a range of pages using SearchReport
    • Getting a table of contents
    • Requesting a page count
    • Retrieving display formats
    • Retrieving a custom format
  • Managing a large list
  • Working with a large message
  • Delivering a multilingual document
•  Administering an Encyclopedia volume
  • About the Encyclopedia service
  •  Defining the data on which an operation acts
    • Defining data using Id or IdList
    • Defining data using Name or NameList
    • Defining data using Search
  •  Administering security and authentication operations
    • Logging in as a report user
    • Logging in with SystemLogin
    •  Getting an access control list
      • Requesting a file or folder’s ACL
      • Retrieving the ACL for a channel
      • Getting a user’s ACL template
      • Setting an additional condition on an ACL request
  •  About Encyclopedia-level management operations
    •  Uploading a file
      • Uploading a BIRT design
      • Uploading a third-party report
      • Copying file properties when uploading a file
    •  Attaching or embedding a file in a request
      • Uploading a file as an attachment
      • About the HTTP header
      • Writing the UploadFile request
    • Downloading a file
    • Downloading a file as an attachment
    •  Updating a file or folder
      • Updating a file’s parameters
      • Updating the privilege settings of a file or folder
    •  Selecting properties of a file or folder in an Encyclopedia volume
      • Requesting a list of files or folders in a working directory using SelectFiles
      • About the Search element in SelectFiles
      • Using a privilege filter with SelectFiles
    •  Retrieving a property list for an item in a folder
      • Retrieving properties of an item in a folder
      • Setting a condition using GetFolderItems
    •  Using GetFileDetails
      • Getting the details of an Actuate report
  •  Managing Encyclopedia volume items
    • Ignoring error conditions in an Administrate operation
    •  Creating an item in an Encyclopedia volume
      • Creating a user
      • Creating a folder
      • Creating a security role
    •  Deleting an item
      • Deleting a file or folder
      • Deleting a user
    •  Updating an item
      • Updating a job schedule
      • Updating a channel
    • Moving a file or folder
    • Copying a file or folder
  •  About composite operations and transactions
    • About sequences in composite Administrate operations
    • Working with a transaction
    • About TransactionOperation and AdminOperation
  •  Searching within an Encyclopedia volume
    • Selecting an item in an Encyclopedia volume
    • Selecting a job or job list
    •  Getting Encyclopedia volume, printer, and file type information
      • Getting Encyclopedia volume properties
      • Getting BIRT iHub System printer information
      • Retrieving a user’s printer settings
      • Retrieving parameter definitions for a file type
    • Extracting parameter definitions
    • Exporting file parameters
    • Executing a predefined Encyclopedia volume command
    •  Diagnosing reporting environment problems
      • About Ping request options
      • Sending a Ping request in Concise mode
      • Sending a Ping request in Normal mode
      • Sending a Ping request in Trace mode
  •  Monitoring BIRT iHub information
    • Getting information about BIRT iHub
    • Getting information about a running or pending job
    • Getting information about Factory service processes
  •  Monitoring or cancelling a request for a synchronous report
    • Monitoring a request for a synchronous report
    • Cancelling a request for a synchronous report
•  Developing Actuate Information Delivery API applications using Java
  •  About the Apache Axis 1.4 client
    • Generating the com.actuate.schemas library
    • About third-party code libraries
  •  About the Actuate Information Delivery API framework
    • Using a data type from a WSDL document to generate a JavaBean
    • Using metadata to map XML to a Java type
    • Mapping the portType to a Service Definition Interface
    • Using a WSDL binding to generate a Java stub
    • Implementing the Actuate API service
  •  Developing Actuate Information Delivery API applications
    •  Writing a program that logs in to an Encyclopedia volume
      • About the auxiliary classes provided by the sample application
      • Logging in to the Encyclopedia volume
    • Capturing SOAP messages using Axis TCPMonitor
    •  Writing a simple administration application
      • Creating a user
      • About ActuateControl.createUser( )
      • About ActuateControl.runAdminOperation( )
    •  Performing a search operation
      • Using com.actuate.schemas.SelectFiles
      • Using ResultDef
    •  Writing a batch or transaction application
      • About batch and transaction operations
      • Implementing a transaction-based application
    •  Uploading a file
      • About ways of uploading a file
      • Using com.actuate.schemas.UploadFile
      • How to build an application that uploads a file
    •  Downloading a file
      • Using com.actuate.schemas.DownloadFile
      • How to build an application that downloads a file
    •  Executing a report
      • Understanding the structure of an ExecuteReport application
      • Using SelectJavaReportPage
    •  Scheduling a custom event
      • How to configure a custom event web service
      • How to schedule a custom event
      • Implementing a custom event service
      • Building a custom event service
      • About the custom event web service sample
  • SOAP-based event web service operations and data types
  • ArrayOfEvent
  • ArrayOfEventStatus
  • Event
  • EventStatus
  • GetEventStatus
•  Developing Actuate Information Delivery API applications using Microsoft .NET
  • About the Microsoft .NET client
  •  About the Actuate Information Delivery API framework
    • Using a data type from a WSDL document to generate a C# class
    • Mapping the portType to a web service interface
  •  Developing Actuate Information Delivery API applications
    • Writing a program that logs in to an Encyclopedia volume
    • Writing a simple administration application
    • Performing a search operation
    •  Writing a batch or transaction application
      • About batch and transaction operations
      • Implementing a transaction-based application
    •  Uploading a file
      • About ways of uploading a file
      • Using UploadFile
      • How to build an application that uploads a file
    •  Downloading a file
      • Using DownloadFile
      • How to build an application that downloads a file
•  Actuate Information Delivery API operations
  • About the SOAP header
  • Administrate
  • AdminOperation
  • CallOpenSecurityLibrary
  • CancelJob
  • CancelReport
  • CloseInfoObject
  • CopyFile
  • CreateChannel
  • CreateDatabaseConnection
  • CreateFileType
  • CreateFolder
  • CreateGroup
  • CreateParameterValuesFile
  • CreateResourceGroup
  • CreateRole
  • CreateUser
  • DataExtraction
  • DeleteChannel
  • DeleteDatabaseConnection
  • DeleteFile
  • DeleteFileType
  • DeleteGroup
  • DeleteJob
  • DeleteJobNotices
  • DeleteJobSchedule
  • DeleteResourceGroup
  • DeleteRole
  • DeleteUser
  • DownloadFile
  • DownloadTransientFile
  • ExecuteQuery
  • ExecuteReport
  • ExecuteVolumeCommand
  • ExtractParameterDefinitionsFromFile
  • ExportParameterDefinitionsToFile
  • FetchInfoObjectData
  • GetBookmarks
  • GetChannelACL
  • GetConnectionPropertyAssignees
  • GetContent
  • GetCustomFormat
  • GetDatabaseConnectionDefinition
  • GetDatabaseConnectionParameters
  • GetDatabaseConnectionTypes
  • GetDataExtractionFormats
  • GetDocumentConversionOptions
  • GetDynamicData
  • GetEmbeddedComponent
  • GetFactoryServiceInfo
  • GetFactoryServiceJobs
  • GetFileACL
  • GetFileCreationACL
  • GetFileDetails
  • GetFileTypeParameterDefinitions
  • GetFolderItems
  • GetFormats
  • GetInfoObject
  • GetJavaReportEmbededComponent
  • GetJavaReportTOC
  • GetJobDetails
  • GetMetaData
  • GetNoticeJobDetails
  • GetPageCount
  • GetPageNumber
  • GetParameterPickList
  • GetReportParameters
  • GetResourceGroupInfo
  • GetResourceGroupList
  • GetSavedSearch
  • GetServerResourceGroupConfiguration
  • GetStaticData
  • GetStyleSheet
  • GetSyncJobInfo
  • GetSystemMDSInfo
  • GetSystemPrinters
  • GetSystemServerList
  • GetSystemVolumeNames
  • GetTOC
  • GetUserLicenseOptions
  • GetUserPrinterOptions
  • GetVolumeProperties
  • Login
  • MoveFile
  • ODBOTunnel
  • OpenInfoObject
  • Ping
  • PrintReport
  • SaveSearch
  • SaveTransientReport
  • SearchReport
  • SelectChannels
  • SelectFiles
  • SelectFileTypes
  • SelectGroups
  • SelectJavaReportPage
  • SelectJobs
  • SelectJobNotices
  • SelectJobSchedules
  • SelectPage
  • SelectRoles
  • SelectUsers
  • SetConnectionProperties
  • SetServerResourceGroupConfiguration
  • SubmitJob
  • SystemLogin
  • Transaction
  • TransactionOperation
  • UndeleteUser
  • UpdateChannel
  • UpdateChannelOperation
  • UpdateChannelOperationGroup
  • UpdateDatabaseConnection
  • UpdateFile
  • UpdateFileOperation
  • UpdateFileOperationGroup
  • UpdateFileType
  • UpdateFileTypeOperation
  • UpdateFileTypeOperationGroup
  • UpdateGroup
  • UpdateGroupOperation
  • UpdateGroupOperationGroup
  • UpdateJobSchedule
  • UpdateJobScheduleOperation
  • UpdateJobScheduleOperationGroup
  • UpdateOpenSecurityCache
  • UpdateResourceGroup
  • UpdateRole
  • UpdateRoleOperation
  • UpdateRoleOperationGroup
  • UpdateUser
  • UpdateUserOperation
  • UpdateUserOperationGroup
  • UpdateVolumeProperties
  • UpdateVolumePropertiesOperation
  • UpdateVolumePropertiesOperationGroup
  • UploadFile
  • WaitForExecuteReport
•  Actuate Information Delivery API data types
  • AbsoluteDate
  • acDouble
  • acNull
  • Aggregation
  • ArchiveRule
  • Argument
  • Arrays of data types
  • Attachment
  • BookMark
  • Boolean
  • CancelJobStatus
  • Channel
  • ChannelCondition
  • ChannelField
  • ChannelSearch
  • ColumnDefinition
  • ColumnDetail
  • ColumnSchema
  • ComponentIdentifier
  • ComponentType
  • CustomEvent
  • Daily
  • DatabaseConnectionDefinition
  • DataCell
  • DataExtractionFormat
  • DataFilterCondition
  • DataRow
  • DataSchema
  • DataSortColumn
  • DataSourceType
  • DataType
  • DocumentConversionOptions
  • Event
  • EventOptions
  • EventType
  • ExecuteReportStatus
  • ExternalTranslatedRoleNames
  • FieldDefinition
  • FieldValue
  • File
  • FileAccess
  • FileCondition
  • FileContent
  • FileEvent
  • FileField
  • FileSearch
  • FileType
  • FilterCriteria
  • FormatType
  • Group
  • GroupCondition
  • GroupField
  • Grouping
  • GroupSearch
  • Header
  • Integer
  • InfoObjectData
  • InfoObjectDataFormat
  • JobCondition
  • JobEvent
  • JobField
  • JobInputDetail
  • JobNotice
  • JobNoticeCondition
  • JobNoticeField
  • JobNoticeSearch
  • JobPrinterOptions
  • JobProperties
  • JobSchedule
  • JobScheduleCondition
  • JobScheduleDetail
  • JobScheduleField
  • JobScheduleSearch
  • JobSearch
  • LicenseOption
  • MDSInfo
  • Monthly
  • NameValuePair
  • NewFile
  • ObjectIdentifier
  • OpenServerOptions
  • PageIdentifier
  • ParameterDefinition
  • ParameterValue
  • PendingSyncJob
  • Permission
  • Printer
  • PrinterOptions
  • PrivilegeFilter
  • PropertyValue
  • Range
  • Repeat
  • Record
  • ReportParameterType
  • ResourceGroup
  • ResourceGroupSettings
  • ResultSetSchema
  • RetryOptions
  • RetryOptionType
  • Role
  • RoleCondition
  • RoleField
  • RoleSearch
  • RunningJob
  • ScalarDataType
  • SearchReportByIdList
  • SearchReportByIdNameList
  • SearchReportByNameList
  • SearchResultProperty
  • ServerInformation
  • ServerResourceGroupSetting
  • ServerState
  • ServerStatusInformation
  • ServerVersionInformation
  • Service
  • SortColumn
  • Stream
  • SupportedQueryFeatures
  • SystemType
  • TypeName
  • User
  • UserCondition
  • UserField
  • UserSearch
  • VersioningOption
  • ViewParameter
  • Volume
  • Weekly
•  Using Java Report Server Security Extension
  • About the Java Report Server Security Extension
  • Implementing the Java RSSE interface
  •  About installing a Java RSSE application
    • How to build a Java RSSE sample application
    •  Installing a Java RSSE application
      • How to install a Java RSSE application on an Encyclopedia volume
    •  Configuring and deploying an LDAP configuration file
      • How to configure and deploy an LDAP configuration file for external authentication
      • How to configure and deploy an LDAP configuration file for external registration
      • How to prepare an Encyclopedia volume to use external user registration
      • How to enable the open security web service to use the Java RSSE application
    • Installing the page-level security application
    • Migrating a Java RSSE application to a new Actuate release
  •  Using page-level security
    • How to install the Java RSSE page-level security application
    • Creating an access control list (ACL)
    • Deploying a report to an Encyclopedia volume
  • SOAP-based Report Server Security Extension (RSSE) operations
  • Authenticate
  • DoesGroupExist
  • DoesRoleExist
  • DoesUserExist
  • GetConnectionProperties
  • GetTranslatedRoleNames
  • GetTranslatedUserNames
  • GetUserACL
  • GetUserProperties
  • GetUsersToNotify
  • PassThrough
  • SelectGroups
  • SelectRoles
  • SelectUsers
  • Start
  • Stop
  • SOAP-based Report Server Security Extension (RSSE) data types
  • Arrays of data types
  • Permission
  • PropertyValue
  • TranslatedRoleNames
  • User
•  Using Actuate logging and monitoring APIs
  • About usage logging and error logging extensions
  •  Installing and using usage and error logging extensions
    • How to configure usage logging
    • How to configure error logging
  • Customizing the usage logging extension
  • Customizing the error logging extension
  •  About the usage log
    • About types of recorded events
    • Understanding a usage log entry
  •  About the error log
    • Understanding an error log entry
    • About BIRT iHub error messages
  •  About BIRT iHub usage and error log consolidator
    • How to install the log consolidator application
    • How to configure the log consolidator database
•  Actuate logging and monitoring functions
  • About Usage Logging Extension functions
  • AcIsThreadSafe
  • AcLogUsage
  • AcStartUsageLog
  • AcStopUsageLog
  • About Error Logging Extension functions
  • AcIsThreadSafe
  • AcLogError
  • AcStartErrorLog
  • AcStopErrorLog
  • About the Performance Monitoring API
  • ArrayOfCounterInfo
  • CounterInfo
  • GetAllCounterValues
  • GetCounterValues
  • ResetCounters
•  Aging and archiving Encyclopedia volume items
  •  Automating report archival and removal
    • About Actuate Online Archive Driver
    •  Configuring the Online Archive Driver
      • How to install an online archive configuration file
      • How to configure the volume archive service provider
    • Understanding aging and archiving rules for items in an Encyclopedia volume
    • Understanding precedence in archiving
  •  Aging and archiving an item using the Actuate Information Delivery API
    •  Setting and updating autoarchive rules using IDAPI
      • Setting default autoarchive rules when creating a folder
      • Setting autoarchive rules when creating a job schedule
      • Updating autoarchive rules for a file or folder
      • Updating autoarchive rules for a job output file
      • Updating the autoarchive rules for a file type in a folder or volume
      • Setting an autoarchive schedule when updating an Encyclopedia volume
    • Starting an archive process for an Encyclopedia volume
    • Retrieving autoarchive rules for a file or folder
    • Setting job notice expiration for all users
    • Setting job notice expiration for a user
•  Archiving APIs
  • SOAP-based archiving API operations
  • DeleteExpiredFiles
  • EndArchive
  • GetNextExpiredFiles
  • StartArchive
  • SOAP-based archiving data types
  • ArrayOfFileInfo
  • ArrayOfPermission
  • FileAccess
  • FileInfo
  • Permission
•  Customizing installation on Windows systems
  • Extracting an Actuate product installation package
  •  Modifying the installed files and registry entries
    • How to modify custom.ini
  •  Localizing the installation
    • How to change the image that appears during installation
    • How to change values that appear during installation
    • How to change the text of the Actuate installation dialog boxes
    • How to change InstallShield’s custom dialog boxes
  •  Creating a silent installation
    • How to modify the silent installation file
    • Specifying version information
    • Specifying license information
    • Customizing installation dialog boxes
    • Specifying dialog box information
    • Encrypting dialog box information
    •  Using acencrypt
      • How to encrypt a string with acencrypt
  •  Performing a silent installation
    • How to use acinstallinput.xml to perform a silent installation
    • How to verify a successful silent installation
  • Performing a silent installation removal
  • Performing a silent removal of Actuate Localization and Online Documentation
•  Customizing installation on UNIX and Linux systems
  • Extracting an Actuate product installation package
  • Creating a silent installation
  •  Modifying the parameter template file
    • About isinstall.cfg
    •  Modifying isinstall.cfg
      • How to modify isinstall.cfg
  •  Performing a silent installation
    • How to perform a silent installation
  •  Performing a silent installation removal
    • How to remove a silent installation
• Text string limits in Actuate operations

About Using BIRT iHub Integration Technology

Text string limits in Actuate operations