Retrieve Policy Data (QPDETRTV) API
Required Parameter Group:
| 1 | Receiver variable | Output | Char(*) |
| 2 | Length of receiver variable | Input | Binary(4) |
| 3 | Format name | Input | Char(8) |
| 4 | Error Code | I/O | Char(*) |
Default Public Authority: *EXCLUDE
Threadsafe: Yes
The Retrieve Policy Data (QPDETRTV) API retrieves policy data.
Authorities and Locks
- Special Authority to use the API
- *SERVICE
Required Parameter Group
- Receiver variable
- OUTPUT; CHAR(*)
The variable that will receive the policy information being retrieved. For the format, see Format of Data Returned.
- Length of receiver variable
- INPUT; BINARY(4)
The length of the receiver variable described in Format of data returned. If the length is larger than the size of the receiver variable, the results may not be predictable. The minimum length is 8 bytes.
- Format name
- INPUT; CHAR(8)
The format of the information to be returned. You must use one of the following format names:
- Error code
- I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter.
Format of Data Returned
The receiver variable holds the policy information returned.RPOL0100 - Retrieve service cleanup interval
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | Binary(4) | Bytes returned |
| 4 | 4 | Binary(4) | Bytes available |
| 8 | 8 | Binary(4) | Number of days |
RPOL0200 - Retrieve problem documentation level
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | Binary(4) | Bytes returned |
| 4 | 4 | Binary(4) | Bytes available |
| 8 | 8 | Char(10) | Problem documentation level |
RPOL0300 - Retrieve maximum PTF order size and downloading time
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | Binary(4) | Bytes returned |
| 4 | 4 | Binary(4) | Bytes available |
| 8 | 8 | Binary(4) | Maximum PTF order size over LAN |
| 12 | C | Binary(4) | Maximum PTF order size over a modem |
| 16 | 10 | Binary(4) | Maximum time for downloading a PTF order via LAN |
| 20 | 14 | Binary(4) | Maximum time for downloading a PTF order via modem |
RPOL0400 - Retrieve period of time for problem processing
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | Binary(4) | Bytes returned |
| 4 | 4 | Binary(4) | Bytes available |
| 8 | 8 | Binary(4) | Time for duplicate problem processing |
RPOL0500 - Retrieve preferred action when reporting a problem
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | Binary(4) | Bytes returned |
| 4 | 4 | Binary(4) | Bytes available |
| 8 | 8 | Binary(4) | Number of preferred actions |
| 12 | C | Array of BIN(4) | Preferred actions |
Field Descriptions
Bytes available. The number of bytes of data available to be returned. All available data is returned if enough space is provided.
Bytes returned. The number of bytes of data returned.
Maximum PTF order size over a modem. The maximum size in megabytes for a PTF order to be delivered over a modem. A value of -1 indicates PTF orders of any size are delivered over a modem. A value of 100 MB (MB equals approximately 1 000 000 bytes) is used if a lower value is retrieved.
Maximum PTF order size over LAN. The maximum size in megabytes for a PTF order to be delivered over the local area network (LAN). A value of -1 indicates PTF orders of any size are delivered over the LAN. A value of -1 is used if a value lower than 100 MB (MB equals approximately 1 000 000 bytes) is retrieved.
Maximum time for downloading a PTF order via LAN. The maximum time in minutes for downloading a PTF order via LAN. A value of -1 indicates PTF order can take any time for downloading the order. This policy is shipped with a default value of -1.
Maximum time for downloading a PTF order via Modem. The maximum time in minutes for downloading a PTF order via modem. A value of -1 indicates PTF order can take any time for downloading the order. This policy is shipped with a default value of 60.
Number of days. The number of days an object covered by this policy is allowed to exist before being deleted by the Service Monitor. Objects covered by this policy are: Service Monitor logs and Integrated File System files created by the FFDC process. This policy is shipped with a default value of 7.
Number of preferred actions. The number of preferred actions when reporting a problem.
Preferred actions. Indicates what the preferred actions when reporting a problem are. The following values are returned:
| 0 | No preferred action is selected (PTFs are downloaded). This is the defalult value. |
| 1 | Do not download PTFs. |
Problem documentation level. Indicates how much problem documentation should be included when problems are automatically reported to the service provider Only the following values are returned:
| *BASE | Minimal documentation is sent in the service request record. No additional data will be uploaded. |
| *DEFAULT | Minimal documentation will be sent in the service request record. If no fix for the problem is found, additional documentation will be automatically uploaded. Additional documentation may include information such as joblogs and service dumps. |
Time for duplicate problem processing. The number of days to check for duplicate problem to avoid creating duplicate problem log entries. If a duplicate problem occurs within the specified number of days, the existing problem log entry will be updated rather than creating a new problem log entry. If 0 is specified, duplicate problem checking will not be performed. This policy is shipped with a default value of 30. This policy cannot be set to a value more than 30 days.
Error Messages
The following messages may be sent from this function:
| Message ID | Error Message Text |
|---|---|
| CPF3CF1 | Error code parameter not valid. |
| CPF3CF2 | Error(s) occurred during running of * API. |
| CPF3C1D | Input variable length in parameter * not valid. |
| CPF3C1E | Required parameter * omitted. |
| CPF3C17 | Error occurred with input data parameter. |
| CPF3C21 | Format name * is not valid. |
| CPF3C4A | Value not valid for field *. |
| CPF3C4B | Value not valid for field *. |
| CPF3C4C | Value not valid for field *. |
| CPF9872 | Program or service program * in library * ended. Reason code *. |
API introduced: V5R4
[ Back to top | Problem Management APIs | APIs by category ]