Your Browser is not longer supported

Please use Google Chrome, Mozilla Firefox or Microsoft Edge to view the page correctly
Loading...

{{viewport.spaceProperty.prod}}

kc_diag_and_account_par_str - Diagnostic and accounting parameters

The data structure kc_diag_and_account_par_str is defined for the parameter type KC_DIAG_AND_ACCOUNT_PAR. kc_diag_and_account_par_str contains the kc_dump_event_str data structure, which in turn contains kc_insert_str .

In the case of KC_GET_OBJECT, UTM returns following information in kc_diag_and_account_par_str:

  • which diagnostic functions are currently enabled

  • if the UTM accounting is currently enabled.

You can enable and disable different diagnostic functions, the UTM event monitor KDCMON and UTM Accounting with KC_MODIFY_OBJECT and the KC_DIAG_AND_ACCOUNT_PAR parameter type.

mod 1

Data structure kc_diag_and_account_par_str

x(GIR)

char account;

x(GIR)

char calc;

x(IR)

char kdcmon;

-

char dump_msg_id[4];

x(GIR)

char testmode;

x(GIR)

char bcam_trace;

x(GIR)

char osi_trace;

x(GIR)

char osi_trace_records[5];

x(GA)

char sysprot_switch;

x(GIR)

struct kc_dump_event_str dump_event[3];

x(IR)

char stxit_log; (only on BS2000 systems)

x(IR)

char xa_debug;

x(IR)

char xa_debug_out;

-

curr_max_btrace_lth[5];

x(IR)

char admi_trace;

x(IR)

char cpic_trace;

x(IR)

char tx_trace;

x(IR)

char xatmi_trace;

mod 1

Data structure kc_dump_event_str

x(GIR)

char event_type[4];

x(GIR)

char event[4];

x(GIR)

struct kc_insert_str insert[3];

mod 1

Data structure kc_insert_str

x(GIR)

char insert_index[2];

x(GIR)

union kc_value value;

x(GIR)

char value_type;

x(GIR)

char comp[2];

1 Field contents can be modified with KC_MODIFY_OBJECT, see "obj_type=KC_DIAG_AND_ACCOUNT_PAR".

The fields in the data structure kc_diag_and_account_par_str have the following meanings:

account



Specifies if the accounting phase of the UTM accounting is enabled.


'Y'

The accounting phase is enabled (ON).


'N'

The accounting phase is disabled (OFF).


The accounting phase can be enabled or disabled during the application run.

For more information on UTM accounting see also the openUTM manual “Generating Applications” and the openUTM manual “Using UTM Applications”.

calc




Specifies if the calculation phase for the UTM accounting is enabled or disabled.


'Y'

The calculation phase is enabled (ON).


'N'

The calculation phase is disabled (OFF).


The calculation phase can be enabled or disabled during the application run.

kdcmon




Specifies if the UTM measurement monitor KDCMON is enabled.


'Y'

KDCMON is enabled (ON).

You can evaluate the values measured by KDCMON with the UTM tool KDCEVAL. For details on operating KDCMON please refer to the relevant openUTM manual “Using UTM Applications”.


'N'

KDCMON is disabled (OFF).


KDCMON can be enabled or disabled during the application run.

dump_msg_id


This parameter is no longer supported, but is retained in the structure as a placeholder. Use the data structure kc_dump_event_str (see dump_event).

testmode


Specifies if the test mode is enabled. 
Test mode means that additional internal UTM routines are executed to conduct plausibility tests and to record internal TRACE information.


'Y'

The test mode is enabled (ON).


'N'

The test mode is disabled (OFF).


The test mode can be enabled or disabled during the application run. For performance reasons test mode should only be enabled when requested by Systems Support in order to create diagnostic documentation.

bcam_trace


Specifies if the BCAM trace is enabled. BCAM trace is the trace function which monitors all connection-specific activities within a UTM application (for example, the BCAM trace function on BS2000 systems).


'Y'

The BCAM trace function is enabled (ON).


'S'

The BCAM trace function was explicitly enabled (SELECT) for several LTERM, LPAP, MUX partners (BS2000 systems) or USERs.
Only those activities on connections to the explicitly specified LTERM, LPAP or MUX partners or user ids are logged.


'N'

The BCAM trace function is disabled (OFF).


You can enable or disable the BCAM trace function during an application run.

osi_trace


Specifies if the OSI trace function is enabled. 
The OSI trace is needed for diagnosing problems with OSI TP connections of the application.


'Y'

The OSI trace function is enabled (ON). All record types are traced.


'N'

The OSI trace function is disable (OFF).


'S'

The OSI trace function is enabled for certain record types. Which record types will be traced and which will not is specified in the osi_trace_records field.


osi_trace is only relevant if objects for distributed processing via OSI TP have been generated in the application. 
You can enable and disable the OSI trace function during the application run. For performance reasons the OSI trace should only be enabled when requested by Systems Support in order to create diagnostic documentation.

osi_trace_records


Specifies which record types will be traced in the OSI trace.
Each field element in osi_trace_records represents a record type:

The 1st field represents the record type "SPI", 
The 2nd field represents the record type "INT"
The 3rd field represents the record type "OSS" 
The 4th field represents the record type "SERV"
The 5th field represents the record type "PROT"

The entries in the individual field elements have the following meanings:


'Y'

The trace records will be recorded for the record type corresponding to the field element.


'N'

The trace records will not be recorded for the record type corresponding to the field element.


The record types have the following meanings:


SPI

Events on the XAP-TP system programming interface


INT

Internal program flow in an XAP-TP routine


OSS

Events occurring during the processing of OSS calls (OSI session service)


SERV

Internal OSS trace records of type O_TR_SERV


PROT

Internal OSS trace records of type O_TR_PROT


You can enable the OSI trace during the application run for certain record types.

It is not possible to disable the trace for individual record types.

However, you can use the parameter osi_trace='N' disable all record types and then reactivate individual record types as required.

The contents of osi_trace_records is relevant if objects for distributed processing via OSI TP were generated in the application.

sysprot_switch


Specifies whether the log files in the UTM application are to be switched over.


'Y'

The log files are to be switched over.


'N'

The log files are not to be switched over.

stxit_log (only on BS2000 systems)


Specifies whether STXIT logging is to be enabled or disabled.


'Y'

STXIT logging is enabled.


'N'

STXIT logging is disabled.


You can enable or disable STXIT logging while the application is running.

xa_debug


Specifies whether debug information for the XA connection is to be output to the database.


'Y'

XA-DEBUG is enabled.
Calls of the XA interface are logged.


'A'

Extended XA-DEBUG is enabled (ALL).
Specific data areas are logged in addition to the calls of the XA interface.


'N'

XA-DEBUG is disabled.


You can enable or disable XA-DEBUG while the application is running.

xa_debug_out


Controls the output destinations for XA-DEBUG.


'S'

Output to SYSOUT/stderr, default value.


'F'

Output to a file.


If you use only the field xa_debug without providing a value for xa_debug_out, any value you specified in the start parameter .RMXA DEBUG= when starting the UTM application will be used (see openUTM manual “Using UTM Applications”). Otherwise, the log is written to SYSOUT/stderr.

curr_max_btrace_lth


Specifies the maximum length of data that is recorded when the BCAM trace function is enabled. See also the start parameter BTRACE.

admi_trace


Specifies whether the ADMI trace function (trace function for the KDCADMI administration program interface) is enabled. 
See also the start parameter ADMI-TRACE.


'Y'

The ADMI trace function is enabled.


'N'

The ADMI trace function is disabled.


You can enable or disable the ADMI trace function while the application is running.

cpic_trace


Specifies whether the CPI-C trace function (trace function for the X/Open interface CPI-C) is enabled. See also the start parameter CPIC-TRACE.


'T'

The CPI-C trace function is enabled with the level TRACE. For each function call, the content of the input and output parameters is output. Only the first 16 bytes are output from the data buffers. The return codes of the KDCS calls to which the CPI-C calls are mapped are output.


'B'

The CPI-C trace function is enabled with the level BUFFER. This trace level includes the TRACE level. However, the data buffers are logged in their full length.


'D'

The CPI-C trace function is enabled with the level DUMP. This trace level includes the TRACE level and also writes diagnostic information to the trace file.


'A'

The CPI-C trace function is enabled with the level ALL. This trace level includes the levels BUFFER, DUMP and TRACE.


'N'

The CPI-C trace function is disabled.


You can enable or disable the CPI-C trace function while the application is running.

tx_trace


Specifies whether the TX trace function (trace function for the X/Open interface TX) is enabled. See also the start parameter TX-TRACE.


'E'

The TX trace function is enabled with the level ERROR. Only errors are logged.


'I'

The TX trace function is enabled with the level INTERFACE. This trace level includes the ERROR level. TX calls are also logged.


'F'

The TX trace function is enabled with the level FULL. This trace level includes the INTERFACE level. All KDCS calls to which the TX calls are mapped are also logged.


'D'

The TX trace function is enabled with the level DEBUG. This trace level includes the FULL level and diagnostic information is also logged.


'N'

The TX trace function is disabled.


You can enable or disable the TX trace function while the application is running.

xatmi_trace


Specifies whether the XATMI trace function (trace function for the X/Open interface XATMI) is enabled. See also the start parameter XATMI-TRACE.


'E'

The XATMI trace function is enabled with the level ERROR. Only errors are logged.


'I'

The XATMI trace function is enabled with the level INTERFACE. This trace level includes the ERROR level. XATMI calls are also logged.


'F'

The XATMI trace function is enabled with the level FULL. This trace level includes the INTERFACE level. All KDCS calls to which the XATMI calls are mapped are also logged.


'D'

The XATMI trace function is enabled with the level DEBUG. This trace level includes the FULL level and diagnostic information is also logged.


'N'

The XATMI trace function is disabled.


You can enable or disable the XATMI trace function while the application is running.

dump_event 


In the data structure kc_dump_event_str, an event is specified for which a UTM dump with an event-dependent designator is generated when the event occurs. The dump is created by the process in which the event occurred. The application is not terminated. Test mode must be enabled in order to create a UTM dump (testmode='Y'). :

For detailed information, refer to section "KDCDIAG - Switch diagnostic aids on and off".

The data structure contains a message number, a KDCS return code (KDCRCCC or KDCRCDC) or a SIGNON status code. If a message with this message number is generated or if this return code or status code is returned, a corresponding UTM dump is generated.

Description of the fields in the structure dump_event:

event_type


Type of event for which a UTM dump is to be generated:


'MSG'

UTM message


'RCDC'

Incompatible KDCS return code


'RCCC'

Compatible KDCS return code


'SIGN'

SIGNON status code


'NONE'

Explicit deactivation of an individual event for a message dump. This allows the commands KDCDIAG DUMP-MESSAGE [1, 2 or 3] to be cancelled (see section "KDCDIAG - Switch diagnostic aids on and off" ).

event



Message number, KDCS return code (KDCRCCC or KDCRCDC) or SIGNON status code, depending on the event_type

event_type MSG

Four-digit internal message number, with leading "K" or "P", e.g. K009 or P001.

event_type RCDC

Incompatible KDCS return code: KCRCDC (4 bytes), e.g. "K301"

event_type RCCC

Three-digit compatible KDCS return code, e.g. "14Z"

event_type SIGN

SIGNON status code: KCRSIGN1 or KCRSIGN2 (3 bytes), e.g. "U01"

insert



The specifications in the data structure kc_insert_str only make sense for the event_type MSG. For detailed information, refer to section "KDCDIAG - Switch diagnostic aids on and off".

Description of the fields in the structure insert:

insert_index


Number of the insert to be checked, e.g. "2" for the second insert in a message. You can specify a maximum of three inserts per message (with the structures insert[0] through insert[2]).

You can find the sequence of the inserts in a UTM message in openUTM manual ”Messages, Debugging and Diagnostics”

Possible values: 1 ... 20

To generate a message dump independently of the inserts, set all three insert_index values to "0".

value



Value against which the insert is to be checked.

UTM represents the string in a union of the type kc_value.

union kc_value

char x[64];

char c[32];


For permitted values, see value_type.

value_type


value_type specifies how the contents of the value field are to be interpreted:

  • N: numeric
  • C: alphanumeric
  • X: hexadecimal

comp



Specifies whether the system is to test for equality or inequality. The following values are possible: 


EQ

Checks for equality, default.


NE

Checks for inequality.

Powered by Atlassian Confluence and Scroll Viewport.