Getting information about Factory service processes
GetFactoryServiceInfo provides data about Factory processes currently running on a specific BIRT iHub. This operation supports checking the number of running and pending jobs against the capacity of BIRT iHub. It shows the percent of disk space in use, how many synchronous jobs are pending and running, the cache size, and other information useful to an administrator.
To use this operation, identify the target BIRT iHub in the SOAP envelope header and send GetFactoryServiceInfo without request parameters.
<SOAP-ENV:Header>
<AuthId>G4RhQBqSkwhYEHFr2ZcApO1AA==</AuthId>
<TargetServer>Wizard</TargetServer>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<GetFactoryServiceInfo></GetFactoryServiceInfo>
</SOAP-ENV:Body>
The response to this request indicates that there are five synchronous jobs pending on a BIRT iHub named Wizard, which can queue a maximum of 100 synchronous jobs. Four jobs are running, three of which are synchronous.
The response also shows:
SyncJobQueueWait, the length of time before the system deletes a synchronous job from the queue, expressed in seconds.
TransientReportTimeout, the maximum length of time before the system deletes a temporary report from the synchronous cache, expressed in minutes. The configuration file sets this value.
CurrentTransientReportTimeout, the actual length of time, expressed in minutes, before the system deletes a temporary report from the synchronous cache. BIRT iHub sets this value internally at run time. This value must be less than the TransientReportTimeout value.
MaxSyncJobRuntime, the maximum job execution time, expressed in seconds.
The response expresses cache sizes in megabytes. GetFactoryServiceInfo always returns all the data shown in the following example:
<SOAP-ENV:Body>
<GetFactoryServiceInfoResponse>
<ServerName>Wizard</ServerName>
<PendingSyncJobs>5</PendingSyncJobs>
<SyncJobQueueSize>100</SyncJobQueueSize>
<RunningSyncJobs>3</RunningSyncJobs>
<RunningJobs>4</RunningJobs>
<SyncFactoryProcesses>3</SyncFactoryProcesses>
<MaxFactoryProcesses>4</MaxFactoryProcesses>
<TransientReportCacheSize>500</TransientReportCacheSize>
<PercentTransientReportCacheInUse>7
</PercentTransientReportCacheInUse>
<CurrentTransientReportTimeout>900
</CurrentTransientReportTimeout>
<TransientReportTimeout>1800</TransientReportTimeout>
<SyncJobQueueWait>600</SyncJobQueueWait>
<MaxSyncJobRuntime>900</MaxSyncJobRuntime>
<GetFactoryServiceInfoResponse>
</SOAP-ENV:Body>