| 1 | Collector name | Input | Char(10) |
| 2 | Attribute change information | Input | Char(*) |
| 3 | Length of change information | Input | Binary(4) |
| 4 | Format name of information to change | Input | Char(8) |
| 5 | Error code | I/O | Char(*) |
The Change Collection Services Attributes (QypsChgColSrvAttributes) API changes system or global collection attributes. It is a replacement for and extension of the Change System Collector Attributes (QYPSCSCA, QypsChgSysCollectorAttributes) API. If appropriate, attributes changed while a collector is running will take effect immediately.
The name of the collector whose default values are to be altered. The special value is:
| *PFR | Performance collector |
The variable that supplies the changed information.
The length of the input variable. The minimum length is 8 bytes.
The content and format of the information to be changed. The format names supported by Change Collection Services Attributes are:
| SCAI0100 | Basic collection services attributes |
| SCAI0200 | Performance database file options |
| SCAI0300 | Management Central Monitor options |
These are described in the following sections.
The structure in which to return error information. For the format of the structure, see Error code parameter.
This format supports basic collection services attributes (also referred to as properties or configuration options).
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Bytes provided |
| 4 | 4 | BINARY(4) | Reserved |
| 8 | 8 | BINARY(4) | Default collection interval |
| 12 | C | BINARY(4) | Collection retention period |
| 16 | 10 | BINARY(4) | Cycle time |
| 20 | 14 | BINARY(4) | Cycle interval |
| 24 | 18 | BINARY(4) | Companion user job |
| 28 | 1C | CHAR(10) | Collection library |
| 38 | 26 | CHAR(10) | Default collector definition |
Bytes provided. The length of the data provided.
Collection library. The name of the library used to store the collection data. The following special value is allowed:
| *SAME | No change |
Collection retention period. The collection retention period indicates how long collection data is to exist.
Collection data older than the retention period may be 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. The following special values are allowed:
| -1 | Permanent |
| -2 | No change |
Companion user job. Specifies whether or not a job is started to run in concert with the collector. The following values are allowed:
| 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.) |
| -2 | No change |
Cycle interval. The elapsed 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. The following special value is allowed:
| -2 | No change |
Cycle time. 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. The following special value is allowed:
| -2 | No change |
Default collector definition. The name of the collector definition (also called a collection profile) to run. The following values are allowed:
| *CUSTOM | A profile where both the categories to collect and category interval times may be customized. |
| *ENHCPCPLN | Enhanced Capacity Planning. Same as *STANDARDP plus the PEX Data - Processor Efficiency category. |
| *MINIMUM | The minimum set of categories required to support performance reporting functions |
| *STANDARD | All categories that are typically used for performance reporting except for communications protocol related data |
| *STANDARDP | Same as *STANDARD but communications protocol categories are included. |
| *SAME | No change |
Default collection interval. The default interval to use when collecting data for a category. Valid interval values are: 15, 30, 60, 300, 900, 1800, or 3600 seconds. The following special values are allowed:
| 0 | Do not collect on interval |
| -2 | No change |
Reserved. Must be null (binary 0s).
This format contains additional attribute information regarding how collection services supports performance database file collections.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Bytes provided |
| 4 | 4 | BINARY(4) | Reserved |
| 8 | 8 | BINARY(4) | Standard file data retention |
| 12 | C | BINARY(4) | Summary data creation |
Bytes provided. The length of the data provided.
Reserved. Must be null (binary 0s).
Standard file data retention. Standard file data is that data normally collected for a collection profile on an ongoing basis that has been exported to performance data base files (QAPM*). The standard file data retention period is used to determine how long performance database file collections should be retained on the system. When standard data in the configured collection library is older than the current retention period, it will be automatically deleted by the Collection Services server job (QYPSPFRCOL) the next time the collector is started or cycled. The retention period is specified in days. The following special values are allowed:
| -1 | Permanent |
| -2 | No change |
Summary data creation. This option controls the automatic generation of additional performance database summary data as supported by the CRTPFRSUM command. This data facilitates quicker processing of the performance database data by tools such as the Performance Viewer. If this option is enabled, and the Companion user job flag is set to 1, the CRTPFRSUM function will be performed for the database collection created by the CRTPFRDTA job. The following values are allowed:
| 0 | Summary file data is not generated. |
| 1 | Summary file data is generated. |
| -2 | No change |
This format contains Management Central Monitor support options. Collection Services provides the configuration support for certain Management Central monitor functions. Those configuration options are contained in this table.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Bytes provided |
| 4 | 4 | BINARY(4) | Reserved |
| 8 | 8 | BINARY(4) | Graph data creation |
| 12 | C | BINARY(4) | Graph data retention |
| 16 | 10 | BINARY(4) | Historical data creation |
| 20 | 14 | BINARY(4) | Historical data retention |
Bytes provided. The length of the data provided.
Graph data creation. Indicates whether or not Management Central graph data is created when the collection is cycled. Graph data is created and maintained by Management Central monitors and is stored in a *MGTCOL with the *PFRDTL attribute. One of the following values are allowed:
| 0 | Graph data is not created. |
| 1 | Graph data is created. |
| -2 | No change |
Graph data retention. The graph data retention period is used to determine how long Management Central graph data is to exist. Graph data older than the retention period is deleted. The retention period is specified in days. The following special value is allowed:
| -2 | No change |
Historical data creation. Indicates whether or not Management Central historical data (also called summary data within System i™ Navigator) is created when the collection is cycled. Historical data is created and maintained by Management Central monitors. It is stored in a *MGTCOL with the *PFRHST attribute. The following values are allowed:
| 0 | Historical data is not created. |
| 1 | Historical data is created. |
| -2 | No change |
Historical data retention. The historical data retention period is used to determine how long Management Central historical data is to exist. Historical data older than the retention period is deleted. The retention period is specified in months. The following special value is allowed:
| -2 | No change |
Reserved. Must be null (binary 0s).
| Message ID | Error Message Text |
|---|---|
| CPF222E E | &1 special authority is required. |
| CPF3C1E E | Required parameter &1 omitted. |
| CPF3C21 E | Format name &1 is not valid. |
| CPF3C39 E | Value for reserved field not valid. |
| CPF3C3C E | Value for parameter &1 is not valid. |
| CPF3CF2 E | Errors occurred during running of &1 API. |
| CPFB537 E | Error found in parameter &1 at offset &2. |
| CPFB538 E | Error found in parameter &1 at offset &2. |
| CPFB94C E | Collection interval value must be one of .... |
| CPFB94F E | Could not allocate a collection services resource. |
| CPF9810 E | Library &1 not found. |
| CPF9820 E | Not authorized to use library &1. |
[ Back to top | Performance Management APIs | APIs by category ]