cicsmfmt - Monitoring data formatter

Linux®
X

Use cicsmfmt to extract data from a monitoring transient data queue that CICS® creates as part of a CICS monitoring sequence. cicsmfmt formats the CICS monitoring data into a form that can easily be written to standard operating system output. You can replace cicsmfmt with your own customized program. This information describes the version that is delivered with CICS and mighty not correspond to the version that is running on your system.

Syntax

cicsmfmt fileName

cicsmfmt -?

Description

If you specify too few or too many parameters, or enter the -? option, cicsmfmt sends some explanatory text to the standard error destination, about how to use the command. Otherwise, cicsmfmt checks whether the file exists, and formats the file records.

cicsmfmt formats several fields for each transient data queue record:

  • Transaction name
  • Terminal name
  • Start and end time stamps for the task
  • Time spent waiting for file input and output, and the number of times CICS started and stopped the clock
  • Program name
  • Total number of file requests
  • Data segment memory occupancy
  • First abnormal termination code, if set

cicsmfmt is a sample program that is generated from the sample source file cicsmfmt.c. It can be built with the sample makefile in the directory prodDir/samples/mfmt by using the command make -e -f Makefile.

If you want to replace cicsmfmt with your own program, you must change the sample makefile accordingly.

The following files make up the monitoring data formatter:

Table 1. Monitoring data formatter files
File Type Contents
prodDir/bin/cicsmfmt executable The executable monitoring formatter program
prodDir/samples/mfmt/cicsmfmt.c source Sample monitoring formatter program source
prodDir/samples/mfmt/Makefile makefile Sample makefile that builds and installs the monitoring formatter
prodDir/lib/libcicsmfmtsa.a prodDir object library Library containing the functions for reading and processing a Monitoring Data file
prodDir/include/cicsmfmt.h include Definitions used by the sample monitoring formatter
prodDir/include/cicsmfmt_msg.h include English messages used by the sample monitoring formatter
prodDir/msg/en_US/cicsmfmt.cat (, Linux) message text Message catalog for cicsmfmt produced by gencat. Only required by formatter programs compiled with CICS release 2.1.1 or earlier.

Options

fileName
An operating system file that corresponds to a CICS extrapartition transient data queue that contains monitoring data from a previous run. Note that the transient data queue must have a variable length record and MaxSize as 0.
-?
Provides you with a help facility that shows the correct syntax for the command. cicsmfmt also displays this if you enter the command syntax incorrectly.

Examples

  1. To list file shut001:
        cicsmfmt shut001
  2. To obtain help:
        cicsmfmt -?