End Collector (QYPSENDC, QypsEndCollector) API

Required Parameter Group:

1	Collector name	Input	Char(10)
2	Error code	I/O	Char(*)

  Default Public Authority: *EXCLUDE

  Service program: QYPSCOLL

  Threadsafe: No

The End Collector (QYPSENDC,QypsEndCollector) API ends the data collection associated with the current collection definition of the specified collector. This may also end the collector job if there are no other data requests to process.

The *PFR collector can also process data requests from the Management Central monitors and applications that are collecting performance data with the performance collector APIs (QPMWKCOL and QPMLPFRD).

Note: The QPMASERV and QPMACLCT jobs will be active if the performance collector APIs are in use.

Authorities and Locks

API Public Authority: *EXCLUDE
Job Authority: *JOBCTL

Required Parameter Group

Collector name

INPUT; CHAR(10)

The name of the collector to be ended. The special value is:

*PFR	Performance collector job QYPSPFRCOL

Error code

I/O; CHAR(*)

The structure in which to return error information. For the format of the structure, see Error Code Parameter.

Error Messages

Message ID	Error Message Text
CPF222E E	&1 special authority is required.
CPF3C1E E	Required parameter &1 omitted.
CPF3C3C E	Value for parameter &1 is not valid.
CPF3C36 E	Number of parameters, &1, entered for this API was not valid.
CPF3CF2 E	Errors occurred during running of &1 API.
CPFB94A E	Collector communications error. Reason code &1.

API introduced: V4R4

Top | Performance Management APIs | APIs by category