Logging

Top  Previous  Next

The XCICS/TS main logging facility is the console log, which contains all the information, warning and alert messages coming from both XCICS/TS core and user programs.

This log is normally named xcicslog.latest and it is backup on xcicslog.<datetime>. Its location, depends on the instance configuration.

It is also possible to modify, enable and disable all messages shown on the console log: by default XCICS TS loads messages from a file called 'xcicsmsg.txt', which is normally located under the directory $XFRAMEHOME/etc.

This file contains the message code and the corresponding text for each message displayed.

To redefine XCICS messages, copy the $XFRAMEHOME/etc/xcicsmsg.txt and edit it. Once done, set the environment XCICS_MESSAGES_FILE to the new file path and restart XCICS.

Message file syntax

The syntax for the xcicsmsg.txt file is simple: each message is contained in one line and is composed by an output control byte, a message code and a message text.

The first byte on each line identifies the activity status for the message :

blank message is active either on logs and console

   #    message is not active

   +    message is active only on logs

An asterisk (*) on the first byte means that the line is processed as a comment.

The output control byte is followed by a four characters message code and by the message text, separated by a comma (,). The message text, whose length may be up to 60 characters, can contain formatting sequences too (in the same way as for the C function printf) that can be updated at the moment of display with variable data (i.e. a data set name).

User messages codes should be identified by a message code beginning by the 'U' letter, and distinguished from the messages displayed by XCICS, that initiate with a 'C'.

Example.

* This is an example * and this line is a comment
C000,XCICS VERSION %s +C001,INITIALIZATION STARTED AT %s
+C002,ERROR OPENING LOGFILE +C003,LOADING TABLE FILE '%s' ß Only on logs
+C004,MEMORY ALLOCATION ERROR ß Only on logs
C005,TABLE FILE '%s' NOT AVAILABLE
C006,XCICS SHUTDOWN COMPLETED
C007,XCICS APPLICATION '%s' ALREADY RUNNING
#C008,STARTUP OF APPLICATION '%s' IN PROGRESS ß Disabled
C009,ALLOCATED SHARED MEMORY SIZE %d KBYTES
U001,USER TRANSACTION %s STARTED WITH PARAMETERS %s ß user message