Change System Collector Attributes (QYPSCSCA, QypsChgSysCollectorAttributes) API
Required Parameter Group:
| 1 | Collector name | Input | Char(10) |
| 2 | Default collection interval | Input | Binary(4) |
| 3 | Library | Input | Char(10) |
| 4 | Retention period | Input | Binary(4) |
| 5 | Cycle time | Input | Binary(4) |
| 6 | Cycle interval | Input | Binary(4) |
| 7 | Companion user job flag | Input | Binary(4) |
| 8 | Default collector definition | Input | Char(10) |
| 9 | Error code | I/O | Char(*) |
Default Public Authority: *USE
Service program: QYPSCOLL
Threadsafe: No
The Change System Collector Attributes (QYPSCSCA, QypsChgSysCollectorAttributes) API changes system or global collection attributes for collection services. Attributes consist of the default collection interval, 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, whether a companion job is to be started, and the default collector definition. If appropriate, system collector attributes changed while a collector is running will take effect immediately.
Authorities and Locks
- API Public Authority
- *EXCLUDE
- Job Authority
- *JOBCTL
- Library Authority
- *EXECUTE
Required Parameter Group
- Collector name
- INPUT; CHAR(10)
The name of the collector whose default values are to be altered. The special value is:
*PFR Performance collector
- Default collection interval
- INPUT; BINARY(4)
The default interval to use when collecting data for a category in seconds. This may be specified as 15, 30, 60, 300, 900, 1800, or 3600 seconds. Changes take effect immediately. The following special values are allowed:
0 Do not collect on interval -2 No change
- Library
- INPUT; CHAR(10)
The name of the library used to store the collection data. Changes take effect when the collector starts or cycles. The following special values are allowed:
*CURLIB Current library of the job calling the API *SAME No change
- Retention period
- INPUT; BINARY(4)
The retention period is used to determine how long collection data is to exist. Collection data older than the retention period is deleted.
Collection Services stores this data in Management Collection (*MGTCOL) Objects with the *PFR attribute. This retention period is used to calculate an expiration date for the object. Expired objects will be automatically deleted by the Collection Services server job (QYPSPFRCOL) the next time a collection is started or cycled. Collection objects are deleted only when they exist in the system's configured collection library.
The retention period is specified in hours. Changes take effect immediately. The value specified must be between 1 and 720 hours, or one of the following special values:
0 Permanent -2 No change
- Cycle time
- INPUT; 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. Changes take effect immediately. The following special value is allowed:
-2 No change
- Cycle interval
- INPUT; 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. Changes take effect immediately. The following special value is allowed:
-2 No change
- Companion user job flag
- INPUT; BINARY(4)
Whether to start a job to run in concert with the collector. Changes take effect when the collector is started. The possible special values are:
-2 No change. 0 No companion user job is started. 1 A companion user job is started. (For the *PFR collector, this is the CRTPFRDTA job which creates the standard performance database collection from the current *MGTCOL collection.)
- Default collector definition
- INPUT; CHAR(10)
The name of the collector definition to run. Changes take effect when the collector is started or cycled. The possible special values are:
*CURRENT
*CUSTOM
*MINIMUM
*ENHCPCPLN
*SAME
*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
| 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. |
| CPF9810 E | Library &1 not found. |
| CPF9820 E | Not authorized to use library &1. |
API introduced: V4R4
[ Back to top | Performance Management APIs | APIs by category ]