System Management Guide

Return to Library Contents Previous Topic Bottom of Topic Next Topic Index Help

Appendix C. Log Record Formats

 

This appendix describes the format of the records CallPath/CICS writes to the trace, traffic, and message log files.

Message Log

     

Records written to the message log have the format shown in Figure 40.

Figure 40. Message Log Record Format

DEFINE
   1 Message_Log  STRUCTURE,
     2 record_key   STRUCTURE,
       3 timestamp      CHARACTER(18),
       3 counter        SMALL INTEGER
     2 record_data  STRUCTURE,
       3 record_length  INTEGER,
       3 record_type    SMALL INTEGER,
       3 variable_data_length    SMALL INTEGER,
       3 *              CHARACTER(1),
       3 source_module  CHARACTER(8),
       3 *              CHARACTER(1),
       3 formatted_date CHARACTER(14),
       3 *              CHARACTER(1),
       3 formatted_time CHARACTER(12),
       3 *              CHARACTER(1),
       3 program_name   CHARACTER(08),
       3 *              CHARACTER(1),
       3 task_number    CHARACTER(07),
       3 *              CHARACTER(1),
       3 switch_name    CHARACTER(08),
       3 *              CHARACTER(1),
       3 message_ID     CHARACTER(07),
       3 severity       CHARACTER(1),
       3 *              CHARACTER(1),
       3 message_text   CHARACTER(69),
       3 variable_data  CHARACTER(variable_data_length) VARYING,
END DEFINE

Notes:

  1. The timestamp is in the format YYYYMMDDHHMMSS.TTT.

  2. The formatted_date and formatted_ time fields are in the format that you selected when you configured the SCT.

  3. The record_type is an internal identifier field.

Trace Log

      This section describes the format of performance and diagnostic trace records logged in the trace log files. Diagnostic trace records are of use only to your service representative.

Records written to the trace log have the format shown in Figure 41.

Figure 41. Trace Log Record Format

DEFINE
   1 Trace_Log  STRUCTURE,
     2 record_length  INTEGER,
     2 *              CHARACTER(2),
     2 record_type    SMALL INTEGER,
     2 *              CHARACTER(2),
     2 module_number  SMALL INTEGER,
     2 *              CHARACTER(2),
     2 variable_data_length    SMALL INTEGER,
     2 *              CHARACTER(1),
     2 source_module  CHARACTER(8),
     2 *              CHARACTER(1),
     2 called_module  CHARACTER(8),
     2 *              CHARACTER(1),
     2 program_name   CHARACTER(08),
     2 *              CHARACTER(1),
     2 task_number    CHARACTER(07),
     2 *              CHARACTER(1),
     2 timestamp      CHARACTER(18),
     2 *              CHARACTER(1),
     2 formatted_date CHARACTER(14),
     2 *              CHARACTER(1),
     2 formatted_time CHARACTER(12),
     2 *              CHARACTER(1),
     2 switch_name    CHARACTER(08),
     2 *              CHARACTER(1),
     2 switch_code    CHARACTER(01),
     2 *              CHARACTER(1),
     2 point_of_call  CHARACTER(02),
     2 *              CHARACTER(1),
     2 trace_type     CHARACTER(02),
     2 variable_data  CHARACTER(variable_data_length) VARYING,
END DEFINE
 

Notes:

  1. The timestamp is in the format YYYYMMDDHHMMSS.TTT.

  2. The formatted_date and formatted_time are in the format that you selected when you configured the SCT.

  3. The record_type is an internal identifier field. Its value is always 1 for trace records.

  4. The module_number is an internal module identifier field.

Identifying Performance Trace Records

   

To distinguish performance trace records from diagnostic trace records, look at the trace_type field.

Performance trace records have a trace_type value of 07 or 08:

07
A module has just started processing the message.

08
A module has just finished processing the message.

The variable_data field for performance trace records contains a two-character message type identifier for the message being processed. Use Table 18 and Table 19 to see message-type identifiers and their corresponding messages.

Messages Processed by the Request Handler

     

Table 18 lists all the identifiers of the message types the request handler processes and sends to CallPath SwitchServer/2.

Note: Table 18 lists only those messages the request handler sends to CallPath SwitchServer/2. It is not a list of all the messages that are sent to the request handler.

Table 18. Identifiers for Messages Processed by the Request Handler
Identifier Message Type
X'01' Add_Party
X'02' Alternate_Call
X'03' Answer_Call
X'04' Conference_Call
X'05' Disconnect
X'06' Extend_Call
X'07' Hold_Call
X'08' Invoke_Feature
X'09' Make_Call
X'0A' Monitor
X'0C' Redirect_Call
X'0D' Send_Device_Data
X'0E' Reject_Call
X'0F' Retrieve_Call
X'10' Return_Control
X'11' Transfer_Call
X'12' Trigger
X'13' Release_Program_Name
X'16' Query_Party_Status
X'18' Immediate_Transfer
X'19' Provide_Call_Action

Messages Processed by the Event Handler

      Table 19 lists all the identifiers of the message-types the event handler processes.

Table 19. Identifiers for Messages Processed by the Event Handler
Identifier Message Type
X'FF' Call_Alerting
X'FE' Call_Connected
X'FD' Call_Held
X'FC' Call_Rejected
X'FB' Call_Routed
X'FA' Call_Transferred
X'F9' Call_Disconnected
X'F8' Feature_Invoked
X'F7' Request_Instruction
X'F6' Response
X'F5' Setup
X'F4' Call_Conferenced
X'F3' Call_Alternated
X'F2' Party_Status
X'F1' Switch_Status
X'EF' Call_Parked
X'EE' Call_Picked
X'ED' Network_Reached
X'EA' Data_Collected
X'E7' Call_Action_Provided

Traffic Log

      Records written to the traffic log have the format shown in Figure 42.

Figure 42. Traffic Log Record Format

DEFINE
   1 Traffic_Log  STRUCTURE,
     2 record_length  INTEGER,
     2 *              CHARACTER(2),
     2 record_type    SMALL INTEGER,
     2 *              CHARACTER(2),
     2 variable_data_length  SMALL INTEGER,
     2 *              CHARACTER(1),
     2 source_module  CHARACTER(8),
     2 *              CHARACTER(1),
     2 timestamp      CHARACTER(18),
     2 *              CHARACTER(1),
     2 formatted_date CHARACTER(14),
     2 *              CHARACTER(1),
     2 formatted_time CHARACTER(12),
     2 *              CHARACTER(1),
     2 switch_name    CHARACTER(08),
     2 variable_data  CHARACTER(variable_data_length) VARYING,
END DEFINE
The variable_data field contains the message counts. The structure of this field depends on the type of counts it contains: outgoing messages, CallPath SwitchServer/2 messages, or incoming messages. To find out the type of counts the log record contains, look at the value of the record_type field. Table 20 shows you where to find a description of the structure of the variable_data field for each record_type value.

Table 20. Where to Find Descriptions of Variable_Data Field Structures
Record_Type Type of Traffic Structure of Variable_Data Field
2 Outgoing messages Figure 43
4 CallPath SwitchServer/2 messages Figure 44
8 Incoming messages Figure 45

Outgoing Messages

If the record_type is 2, the record contains counts of outgoing messages. It has the structure shown in Figure 43.

Figure 43. Structure of variable_data Field for Outgoing Messages

DEFINE
   1 Outgoing_traffic  STRUCTURE,
     2 add_party_msgs             INTEGER,
     2 add_party_bytes            INTEGER,
     2 alternate_call_msgs        INTEGER,
     2 alternate_call_bytes       INTEGER,
     2 answer_call_msgs           INTEGER,
     2 answer_call_bytes          INTEGER,
     2 conference_call_msgs       INTEGER,
     2 conference_call_bytes      INTEGER,
     2 disconnect_msgs            INTEGER,
     2 disconnect_bytes           INTEGER,
     2 extend_call_msgs           INTEGER,
     2 extend_call_bytes          INTEGER,
     2 hold_call_msgs             INTEGER,
     2 hold_call_bytes            INTEGER,
     2 immediate_transfer_msgs    INTEGER,
     2 immediate_transfer_bytes   INTEGER,
     2 invoke_feature_msgs        INTEGER,
     2 invoke_feature_bytes       INTEGER,
     2 make_call_msgs             INTEGER,
     2 make_call_bytes            INTEGER,
     2 monitor_msgs               INTEGER,
     2 monitor_bytes              INTEGER,
     2  provide_call_action_msgs  INTEGER,
     2  provide_call_action_bytes INTEGER,
     2 query_party_status_msgs    INTEGER,
     2 query_party_status_bytes   INTEGER,
     2 redirect_msgs              INTEGER,
     2 redirect_bytes             INTEGER,
     2 reject_call_msgs           INTEGER,
     2 reject_call_bytes          INTEGER,
     2 release_program_name_msgs  INTEGER,
     2 release_program_name_bytes INTEGER,
     2 retrieve_call_msgs         INTEGER,
     2 retrieve_call_bytes        INTEGER,
     2 return_control_msgs        INTEGER,
     2 return_control_bytes       INTEGER,
     2 send_device_data_msgs      INTEGER,
     2 send_device_data_bytes     INTEGER,
     2 transfer_call_msgs         INTEGER,
     2 transfer_call_bytes        INTEGER,
     2 trigger_msgs               INTEGER,
     2 trigger_bytes              INTEGER,
     2 session_start_msgs         INTEGER,
     2 session_start_bytes        INTEGER,
     2 session_end_msgs           INTEGER,
     2 session_end_bytes          INTEGER,
     2 imok_msgs                  INTEGER,
     2 imok_bytes                 INTEGER,
     2 switch_code                CHARACTER(1),
     2 *                          CHARACTER(3),
END DEFINE

CallPath SwitchServer/2 Messages

If the record_type is 4, the record contains counts for CallPath SwitchServer/2 messages. The record has the structure shown in Figure 44.

Figure 44. Structure of variable_data Field for CallPath SwitchServer/2 Messages

DEFINE
   1 Gateway_traffic  STRUCTURE,
     2 version_number    INTEGER,
     2 switch_name       CHARACTER(8),
     2 timestamp         CHARACTER(18),
     2 *                 CHARACTER(2),
     2 switch_code       CHARACTER(1),
     2 start_time        CHARACTER(18),
     2 end_time          CHARACTER(18),
     2 *                 CHARACTER(3),
     2 host_to_gateway   INTEGER,
     2 gateway_to_host   INTEGER,
     2 gateway_to_switch INTEGER,
     2 switch_to_gateway INTEGER
END DEFINE

Incoming Messages

If the record_type field has a value of 8, the variable_data field contains counts of incoming messages. It has the structure shown in Figure 45.

Figure 45. Structure of variable_data Field for Incoming Messages

DEFINE
   1 Incoming_traffic  STRUCTURE,
     2 call_alerting_msgs         INTEGER,
     2 call_alerting_bytes        INTEGER,
     2 call_action_provided_msgs  INTEGER,
     2 call_action_provided_bytes INTEGER,
     2 call_alternated_msgs       INTEGER,
     2 call_alternated_bytes      INTEGER,
     2 call_conferenced_msgs      INTEGER,
     2 call_conferenced_bytes     INTEGER,
     2 call_connected_msgs        INTEGER,
     2 call_connected_bytes       INTEGER,
     2 call_held_msgs             INTEGER,
     2 call_held_bytes            INTEGER,
     2 call_parked_msgs           INTEGER,
     2 call_parked_bytes          INTEGER,
     2 call_picked_msgs           INTEGER,
     2 call_picked_bytes          INTEGER,
     2 call_rejected_msgs         INTEGER,
     2 call_rejected_bytes        INTEGER,
     2 call_routed_msgs           INTEGER,
     2 call_routed_bytes          INTEGER,
     2 call_transferred_msgs      INTEGER,
     2 call_transferred_bytes     INTEGER,
     2 call_disconnected_msgs     INTEGER,
     2 call_disconnected_bytes    INTEGER,
     2 data_collected_msgs        INTEGER,
     2 data_collected_bytes       INTEGER,
     2 feature_invoked_msgs       INTEGER,
     2 feature_invoked_bytes      INTEGER,
     2 network_reached_msgs       INTEGER,
     2 network_reached_bytes      INTEGER,
     2 party_status_msgs          INTEGER,
     2 party_status_bytes         INTEGER,
     2 request_instruction_msgs   INTEGER,
     2 request_instruction_bytes  INTEGER,
     2 response_msgs              INTEGER,
     2 response_bytes             INTEGER,
     2 setup_msgs                 INTEGER,
     2 setup_bytes                INTEGER,
     2 switch_status_msgs         INTEGER,
     2 switch_status_bytes        INTEGER,
     2 session_started_msgs       INTEGER,
     2 session_started_bytes      INTEGER,
     2 session_ended_msgs         INTEGER,
     2 session_ended_bytes        INTEGER,
     2 traffic_count_msgs         INTEGER,
     2 traffic_count_bytes        INTEGER,
     2 imok_msgs                  INTEGER,
     2 imok_bytes                 INTEGER,
     2 *                          CHARACTER(8),
     2 switch_code                CHARACTER(1),
     2 *                          CHARACTER(3),
END DEFINE

Return to Library Contents Previous Topic Top of Topic Next Topic Index Help