Retrieves jobs in the active jobs database. Jobs are searched in the "All Jobs" collection in GUI Server memory. If the PinAllJobsCollection system parameter is turned on, the "All Jobs" collection is loaded into memory at start up of the GUI Server. If the PinAllJobsCollection is turned off, the request causes the All Jobs collection to be loaded into GUI Server memory, which may affect performance and response time.
The EMAPIActiveJobsLoadLimit system parameter controls the number of jobs in the active jobs database that are checked by the GUI Server when processing the request_act_retrieve_jobs request, and included in the request response. It is possible to limit the number of returned jobs on the client side by specifying the max_returned_nodes parameter in the request. The value of the max_returned_nodes parameter should not exceed the value of the EMAPIActiveJobsLoadLimit system parameter.
If the value of the max_returned_nodes parameter exceeds the value of the EMAPIActiveJobsLoadLimit system parameter, a fault response is returned. For more information about the PinAllJobsCollection and EMAPIActiveJobsLoadLimit system parameters, see GUI Server parameters.
The following topics describe the retrieve jobs request parameters, and the response from Control-M/EM, together with examples:
Parent Topic |