Add Problem Log Entry (QsxAddProblemLogEntry) API

The Add Problem Log Entry (QsxAddProblemLogEntry) API adds information to an existing problem log entry.

The API supports the following data types:

• Keys 2001-2009 (field replaceable unit (FRU) entries) can be added to the problem log entry.
• Keys 4001 and 4002 (supporting data) entries can be added. Do not add duplicate information because checking is not performed.
• Key 6001 (history information) can be added.
• Key 7001 (PTF ID) can be added to a problem log entry. If the PTF entry already exists, an error is signalled.

Authorities and Locks

API Public Authority

*USE

Required Parameter Group

Handle

INPUT; BINARY(4)

An identifier that associates the problem log services started by the Start Problem Log Services API.

Key structures

INPUT; ARRAY of POINTERS

An array of pointers that has the address of each key that contains data to be written into the problem log. The number of pointers passed in the array must equal the value passed by the Number of keys parameter. Keys not supported for the Add Problem Log Entry API cause error messages to be sent to the caller.

Number of keys

INPUT; BINARY(4)

Number of keys passed to the API.

Error code

I/O; CHAR(*)

The structure in which to return error information. For the format of the structure, see Error Code Parameter.

Rules for Key Usage

Key 1 (problem log ID) is required to identify the problem log entry to process.

Data can be added to an existing problem log entry with the Add Problem Log Entry API. The types of data that may be added with this API are:

• Keys 2001-2009 (FRU entries)
• Supporting data entries (keys 4001 and 4002 (supporting data)
• Key 6001 (history information)
• Key 7001 (PTF ID)

The remaining data contained in a problem can be altered using the Change API. More information on the above keys can be found in Key Groups for Problem Log APIs.

Keys for Adding FRU Records

A FRU, field replaceable unit, entry defines an object that may have a specific machine-detected problem. FRUs have been broken into 9 types and represented by keys 2001 through 2009.

The types are:

In addition, a FRU or list of FRUs are associated with a problem based upon an analysis class. The analysis class implies the amount or type of analysis that has been done on the problem. FRUs are associated with a problem within the context of a class.

The classes of FRUs are:

To add FRUs for a class of FRUs, the problem log entry must be identified, the class must be chosen, and the data must be added. These three actions need to be done for each FRU type. FRUs may be used in any combination, to add data about individual failing elements to a maximum of 21 FRUs per class.

This API adds FRU entries to the bottom of the list. If they need to be maintained in probability order, follow these steps:

• Retrieve the group using the Retrieve Problem Log Entry API.
• Modify the FRU records or append additional FRUs to the original list.
• Delete the existing FRU entries of that class using the Delete Problem Log Entry API.
• Add the new or updated FRU list using the Add Problem Log Entry API.

Keys for Adding Supporting Data

The addition of supporting data is not restricted. Any number of spooled or data base files can be associated with a problem log entry. Duplicate records are allowed. If you add a file twice, it is listed twice.

To add supporting data, define the type of record to be added using keys 4001 and 4002 (supporting data). They can be added in any combination.

Keys for Adding History Data

The addition of history data, or events, is restricted because specific events can occur only when the problem is in a specific status. Some history data types are applicable to specific problem log types. Any number of events can be associated with a problem log entry. Duplicate records are allowed since many events can be repeated. Events are added in the sequence that you supply them on the API call. The API makes no attempt to put them in order.

To add a history entry, use key 6001 (history information) to supply the needed data to reflect the action that was taken. If you are adding supporting data, you can add it in any combination. The time the event is added is entered by the API.

The history types are:

See Getting started with iSeries for more information about SRCs.

Keys for Adding PTF Entry

PTF entries can be added to the problem log at any time. Duplicate PTF records are not allowed and signal an exception condition. To ensure uniqueness, the PTF identifier and the product data are required.

To add a PTF record, use key 7001 (PTF ID) to add the data required. The PTF entry is added to the bottom of existing text.

To get the PTF records in a specific order, the records must be retrieved, sorted and then replaced after the existing PTF records are deleted.

PTF entries can be created using *ONLY*PRODUCT** as the constant for Product ID and *ONLY as the constant for version, release, and modification level.

Error Messages