Retrieve System Collector Attributes (QYPSRSCA, QypsRtvSysCollectorAttributes) API

The Retrieve System Collector Attributes (QYPSRSCA, QypsRtvSysCollectorAttributes) API retrieves system or global collection attributes. Attributes consist of the default collector state, the default collection interval in seconds, the library used to store the collection data, the retention period for the data, the time the initial cycle is to occur, the interval between cycles, the companion user job flag, the default collection definition, and the currently running collection definition.

Authorities and Locks

API Public Authority

*EXCLUDE

Required Parameter Group

Collector name

INPUT; CHAR(10)

The name of the collector whose default values are to be retrieved. The special value is:

*PFR	Performance collector

Default collection interval

OUTPUT; BINARY(4)

The default interval used when collecting data for a category in seconds. The interval is 15, 30, 60, 300, 900, 1800, or 3600 seconds. The following special value may be returned:

0	Do not collect on interval

Library

OUTPUT; CHAR(10)

The name of the library used to store the collection data.

Retention period

OUTPUT; BINARY(4)

The retention period indicates how long collection data is to exist. Collection data older than the retention period is deleted. The retention period is specified in hours. The maximum value that will be returned is 720 hours, or 30 days. The following special value may be returned:

0

Permanent

Cycle time

OUTPUT; BINARY(4)

The time at which the first cycle is to occur. The cycle time is specified in minutes past midnight. The maximum allowed value is 1439 minutes, which is one minute less than 24 hours.

Cycle interval

OUTPUT; BINARY(4)

The lapse time between cycles. The cycle time is specified in hours, and can range from a minimum value of one hour to a maximum value of 24 hours.

Companion user job flag

OUTPUT; BINARY(4)

Whether a job is started to run in concert with the collector. One of the following values will be returned:

0	No companion user job is started.
1	A companion user job is started. (For the *PFR collector, this is the database transfer job CVTPFRDTA.)

Default collector definition

OUTPUT; CHAR(10)

The name of the collector definition to run. The possible special values are:

*CURRENT
*CUSTOM
*ENHCPCPLN
*MINIMUM
*STANDARD
*STANDARDP

Current collector definition

OUTPUT; CHAR(10)

The name of the currently running collector definition. The possible special values are:

*CUSTOM
*ENHCPCPLN
*MINIMUM
*NONE
*STANDARD
*STANDARDP

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