Diagnostic dump on messages/events

You can cause a diagnostic dump, known as a message dump, to be generated when a certain event occurs. The dump ID depends on the event type.

A message dump is created by the task in which the event occurs. The UTM application is not terminated. In order to take such a message dump, you have to activate test mode for the application and define the event at which the message dump is to be taken. Both of these things can be done by means of start parameters or using the administration functions.

You can specify the following events:

• the output of a specific K message

• the occurrence of a specific KDCS return code (CC or DC) in a program unit run

• the occurrence of a specific SIGN status when a user signs on

Activating test mode

• using the relevant start Parameter
  .UTM TESTMODE = ON

• using the relevant administration command
  KDCDIAG TESTMODE = ON

• using the administration program interface (e.g. via WinAdmin or WebAdmin)

  In the object type KC_DIAG_AND_ACCOUNT, specify:

  testmode=’Y’ (data structure kc_diag_and_account_par_str)

Activating and resetting the message dump function

You can activate and reset the message dump function by means of a start parameter or using the administration functions. The function is deactivated by default at application startup.

Activating the message dump function

• using the relevant start parameter

  .UTM START DUMP-MESSAGE = (event-type,event)

  This causes a message dump to be created as soon as the event occurs.

  You can only specify one event when you activate the function using a start parameter. It is not possible to specify inserts for a message.

• using the relevant administration command

  KDCDIAG DUMP-MESSAGE = (event-type,event)

  In the same way, you can use the parameters DUMP-MESSAGEx (where x = 1, 2, 3) to specify up to three different events for generating a message dump. DUMP-MESSAGE is synonymous with DUMP-MESSAGE1.

  You can specify up to three inserts as additional constraints for the event "output of a specific K message" (parameter INSERTx where x = 1,2,3). For further details, see KDCDIAG in the openUTM manual "Administering Applications".

• using the administration program Interface
  In object type KC_DIAG_AND_ACCOUNT, specify the event and the event type in the event and event_type fields (data structure kc_diag_and_account_par_str with the corresponding substructures). You can also specify up to three inserts as a condition. At the program interface, you can specify one event per call. For further details, see the description of KC_DIAG_AND_ACCOUNT in the openUTM manual "Administering Applications".

• using WinAdmin or WebAdmin
  Open the Message Dump tab of the Application Properties dialog and select the event type and the event for the corresponding dump event, see WinAdmin/WebAdmin online help.

event-type specifies the event type and event specifies a particular event for which the message dump is to be generated. You can specify the following events:

• Output of a specific K message (event-type = MSG)
  Specify the UTM message number Knnn as the event.
  A dump is generated each time the message number occurs until such time as you reset the message number. Only one dump is generated for the message numbers K043, K061, K062. The message number is then automatically reset.

• Occurrence of a particular compatible KDCS return code (event-type = RCCC) Specify the number of the compatible KDCS return code (KCRCCC) as the event e.g. 14Z.
  If the return code occurs during a KDCS call, only one dump is generated and the parameter DUMP-MESSAGE[x] is reset to *NONE.

• Occurrence of a particular incompatible KDCS return code (event-type = RCDC) Specify an incompatible KDCS return code (KCRCDC) as the event, e.g. KD10. If the return code occurs during a KDCS call, only one dump is generated and the parameter DUMP-MESSAGE[x] is reset to *NONE.
  Note
  In the case of all KDCS return codes >= 70Z and the associated incompatible KDCS return codes, when no PENDER dump is written (e.g. 70Z/K316), no message dump is created.

• Occurrence of a particular sign-on status (event-type = SIGN) 
  Specify the SIGNON status code in the form xyy as the event (e.g. U05):

  • x corresponds to the value in KCRSIGN1, with U, I, A or R being possible values.

  • yy corresponds to the value in KCRSIGN2

  If the status code occurs during a SIGN call, only one dump is generated and the parameter DUMP-MESSAGE[x] is reset to *NONE. This happens regardless of whether or not a sign-on service is generated in the application.

Deactivating the message dump function

• using the relevant start parameter
  .UTM START DUMP-MESSAGE = *NONE

• using the relevant administration command

  KDCDIAG DUMP-MESSAGE = *NONE

  The relevant parameter must be set to *NONE for events activated using the parameter DUMP-MESSAGEx.

• using the administration program Interface
  In the object type KC_DIAG_AND_ACCOUNT, reset all the events by specifying event_type=NONE for each event.

• using WinAdmin or WebAdmin
  Open the Message Dump tab of the Application Properties dialog and select the event type <none> for the corresponding dump event, see WinAdmin/WebAdmin online help.