Actuate Information Delivery API operations : GetFactoryServiceInfo
 
GetFactoryServiceInfo
Retrieves general information about a Factory service. The node name is specified in the TargetServer element of the SOAP header.
GetFactoryServiceInfo is available only to a BIRT iHub System administrator. To log in as a BIRT iHub System administrator, use SystemLogin.
To retrieve a list of servers for which you can obtain information, use GetSystemServerList.
Request schema
<xsd:complexType name="GetFactoryServiceInfo"/>
Request elements
GetFactoryServiceInfo
Information about the Factory service.
Response schema
<xsd:complexType name="GetFactoryServiceInfoResponse">
<xsd:sequence>
<xsd:element name="ServerName" type="xsd:string"/>
<xsd:element name="PendingSyncJobs" type="xsd:long"/>
<xsd:element name="SyncJobQueueSize" type="xsd:long"/>
<xsd:element name="RunningSyncJobs" type="xsd:long"/>
<xsd:element name="RunningJobs" type="xsd:long"/>
<xsd:element name="SyncFactoryProcesses" type="xsd:long"/>
<xsd:element name="MaxFactoryProcesses" type="xsd:long"/>
<xsd:element name="TransientReportCacheSize" type="xsd:long"/>
<xsd:element name="PercentTransientReportCacheInUse"
type="xsd:long"/>
<xsd:element name="CurrentTransientReportTimeout"
type="xsd:long"/>
<xsd:element name="TransientReportTimeout" type="xsd:long"/>
<xsd:element name="SyncJobQueueWait" type="xsd:long"/>
<xsd:element name="MaxSyncJobRuntime" type="xsd:long"/>
</xsd:sequence>
</xsd:complexType>
Response elements
ServerName
The node for which information is returned.
PendingSyncJobs
The number of synchronous jobs in queue.
SyncJobQueueSize
The maximum number of synchronous jobs allowed in the queue.
RunningSyncJobs
The number of synchronous jobs currently running.
RunningJobs
The total number of jobs currently running.
SyncFactoryProcesses
The number of Factories reserved for running synchronous jobs.
MaxFactoryProcesses
The maximum number of Factories that can run on the system.
TransientReportCacheSize
The maximum disk space available for transient reports, in megabytes.
PercentTransientReportCacheInUse
The currently used percentage of disk space available for transient reports.
CurrentTransientReportTimeout
The number of minutes after which transient reports are deleted from the synchronous cache adjusted according to disk space currently available in the synchronous cache.
TransientReportTimeout
Time after which transient reports are deleted from the synchronous cache, in minutes.
SyncJobQueueWait
The maximum time a job remains in the synchronous queue, in seconds.
MaxSyncJobRuntime
The maximum job execution time, in seconds.