Sending Error Log Information

When calling Cleanup_TP, you can send error log information to a partner TP or system. Error log information describes errors that your scheduler finds when it tries to schedule a TP. Programmers for partner systems can use the information to help diagnose errors in their TPs. For example, Cleanup_TP can send error log information that indicates a partner TP name specified on an inbound allocate request is not acceptable to your scheduler.

The error log information is sent to all systems with TPs that have established conversations with the TP to be cleaned up. If the partner system is MVS, the partner TP can use the Error_Extract service to return the error log information (see z/OS MVS Programming: Writing Transaction Programs for APPC/MVS for information about how to use Error_Extract). If the partner system is not MVS, the partner system must determine how to obtain and use the error log information. Your can specify error log information for both basic and mapped conversations.

To send error log information to a partner TP or system, you must specify a value other than Normal on the Condition parameter for this service. APPC/MVS sends the error log information in a generalized data stream (GDS) variable, and then sends an FMH-7 to notify the partner system that an error occurred. The GDS variable has the format shown in Figure 1:

Figure 1. Format of GDS Variable for Sending Log Data

Figure 2 shows the format of the product ID subvector in the GDS variable shown in the previous figure.

Figure 2. Format of Product ID in GDS Variable

Example

In this example, assume that an alternate scheduler cannot schedule a TP because the user who ran the TP did not have access to a required data set. The scheduler calls Cleanup_TP to clean up the conversation. The scheduler sends a sense code of user_not_authorized_for_TP and error log information to the partner TP:

Condition = User_not_authorized_for_TP;
Notify_type = ATB_None;
Error_log_information = ' ';
Error_log_information = 'User does not have access to data set 'user.dsname'';
Error_log_information_length = Length(Error_log_information);
CALL ATBCTP3(TP_ID,
             Condition,
             Notify_type,
             Error_log_information_length,
             Error_log_information,
             Return_code,
             );