Required Parameter Group:
| 1 | Policy data | Input | Char(*) |
| 2 | Length of policy data | Input | Binary(4) |
| 3 | Format of policy data | Input | Char(8) |
| 4 | Error Code | I/O | Char(*) |
Default Public Authority:
*USE
Threadsafe: Yes
| 1 | Policy data | Input | Char(*) |
| 2 | Length of policy data | Input | Binary(4) |
| 3 | Format of policy data | Input | Char(8) |
| 4 | Error Code | I/O | Char(*) |
*USEThe Set User Policy (QPDETPOL) API allows the changing of user policies related to service. This includes:
Information to use when setting the policy.
How long the policy data is.
Which policy to set. Only the following values are accepted.
| POLS0100 | Set service cleanup interval policy. |
| POLS0200 | Set problem documentation level. |
| POLS0300 | Set maximum PTF order size and downloading time. |
| POLS0400 | Set period of time for duplicate problem processing. |
| POLS0500 | Set preferred actions when reporting a problem. |
The structure in which to return error information. For the format of the structure, see Error code parameter.
The following information needs to be supplied in the policy data parameter (parameter 1) for the POLS0100 format.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Number of days |
The following information needs to be supplied in the policy data parameter (parameter 1) for the POLS0200 format.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | Problem documentation level |
The following information needs to be supplied in the policy data parameter (parameter 1) for the POLS0300 format.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Maximum PTF order size over LAN |
| 4 | 4 | BINARY(4) | Maximum PTF order size over a modem |
| 8 | 8 | BINARY(4) | Maximum time for downloading a PTF order over LAN |
| 12 | C | BINARY(4) | Maximum time for downloading a PTF order over modem |
The following information needs to be supplied in the policy data parameter (parameter 1) for the POLS0400 format.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Time for duplicate problem processing |
The following information needs to be supplied in the policy data parameter (parameter 1) for the POLS0500 format.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Number of preferred actions. |
| 4 | 4 | Array of BIN(4) | Preferred actions. |
Maximum PTF order size over LAN. The maximum size in megabytes for a PTF order to be delivered electronically over the local area network (LAN). If -1 is specified, PTF orders of any size are delivered over the LAN. This policy is shipped with a default value of -1. This policy cannot be set to a value less than 100 MB (MB equals approximately 1 000 000 bytes).
Maximum PTF order size over a modem. The maximum size in megabytes for a PTF order to be delivered electronically over a modem. This policy is shipped with a default value of 100 MB (MB equals approximately 1 000 000 bytes). If -1 is specified, PTF orders of any size are delivered over a modem. This policy cannot be set to a value less than 100 MB.
Maximum time for downloading a PTF order over LAN. The maximum time in minutes for downloading a PTF order over 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. This policy cannot be set to a value less than 30 minutes.
Maximum time for downloading a PTF order over Modem. The maximum time in minutes for downloading a PTF order over 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. This policy cannot be set to a value less than 30 minutes.
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 value of 7. This policy cannot be set to a value less than 1.
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 accepted:
| 0 | No preferred action is selected (PTFs are downloaded). This is the default value. |
| 1 | Do not download PTFs. |
Note: if conflicting preferred actions are encountered then the last setting found in the array determines the final setting.
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 accepted:
| *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 job logs 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 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.
The following messages may be sent from this function:
| Message ID | Error Message Text |
|---|---|
| CPFE080 | Maximum PTF order size not valid. |
| CPF0CC1 | Error initializing the XML parser. |
| CPF24B4 | Severe error while addressing parameter list. |
| CPF3CF1 | Error code parameter not valid. |
| CPF3CF2 | Error(s) occurred during running of &1 API. |
| CPF3C1E | Required parameter &1 omitted. |
| CPF3C21 | Format name &1 is not valid. |
| CPF3C3A | Value for parameter &2 for API &1 not valid. |
| CPF9872 | Program or service program &1 in library &2 ended. Reason code &3. |
[ Back to top | Problem Management APIs | APIs by category ]