CreateResourceGroup

Creates a resource group and sets its properties. A resource group specifies a set of Factory processes reserved to run only those jobs assigned to the group. Contains a required ResourceGroupSettings element to define properties of the resource group.

DeleteResourceGroup

Deletes a resource group other than the default resource groups. If a deleted group has a scheduled job assigned to it, the job remains in a pending state. If a job is running on an BIRT iHub assigned to a deleted resource group, the job completes.

GetAllCounterValues

Retrieves the values of all counters.

GetCounterValues

Retrieves information about specific counters.

GetFactoryServiceInfo

Retrieves general information about the Factory service, such as the name of the BIRT iHub on which it is running, the number of synchronous jobs currently queued on BIRT iHub, and the maximum number of synchronous jobs that can be in the queue.

GetFactoryServiceJobs

For synchronous jobs, returns a list of either the pending jobs or the jobs running on the Encyclopedia volume specified in TargetVolume in the SOAP header.

GetFormats

Retrieves a list of locales or a list of formats that BIRT iHub supports, such as PDF, DHTML, and XML.

GetResourceGroupInfo

Retrieves the resource group’s settings. Returns an error if there is no matching resource group.

GetResourceGroupList

Returns two lists, one for synchronous resource groups, the other for asynchronous resource groups.

GetServerResourceGroup
Configuration

Returns a list of resource groups on BIRT iHub and property settings for each group.

GetSystemMDSInfo

Retrieves the names and properties of a Message Distribution service (MDS) in a cluster or stand-alone BIRT iHub without authenticating the client. In a cluster, supports routing requests to an alternate MDS if the one to which the client connects fails.

The request can indicate whether to retrieve MDS information only from BIRT iHubs that are currently online or from BIRT iHubs that are offline as well.

GetSystemPrinters

Retrieves a list of printers and printer details to which BIRT iHub connects.

GetSystemServerList

Retrieves a list of stand-alone and cluster BIRT iHubs, including the server name, state, and an error code and error description if the state is Failed.

GetSystemVolumeNames

Retrieves the names of volumes in a stand-alone BIRT iHub or cluster system without authentication. Supports placing volume names on a Login page. The request can indicate whether to retrieve only the names of volumes currently online or all volumes in the cluster.

ODBOTunnel

Opens a connection to an OLAP server for ODBO API function.

Ping

A Ping request tests whether a specific component of BIRT iHub is operational and retrieves other diagnostic information about the component. The request must specify one of the following destinations to contact:

The request also can specify an action to perform on the destination, such as echoing payload data, reading a file, writing a temporary file, or connecting to a database.

Not all actions are available for all destinations. Ping is available to an Encyclopedia volume administrator or a user in the Operator role.

ResetCounters

Resets the values of specific counters.

SetServerResourceGroup
Configuration

Configures all the resource groups on an BIRT iHub.

UpdateResourceGroup

Updates resource group properties. Resource group name, type, or the name of the BIRT iHub on which the resource group runs are not updatable.