sfmlog utility options

sfmlog utility options

When you execute the sfmlog utility, use the options in Table 1-5 to specify actions, including input and output files used by the utility, filter behavior, and the output format of the data.

To run sfmlog, enter:

ims sfmlog options

There is no space between the option flag and the argument value. For example:

ims sfmlog -ftestfile -v2

**Table 1-5: sfmlog Display and output options**
Options	Description
-h	Displays a summary of sfmlog options and their associated functions.
-ffile	Specifies the input log file to parse. You can specify multiple log files.
-ofileName	(lowercase “o”) Specifies the file to receive sfmlog output.
-OfileName	(uppercase “O”) Specifies the output file and overwrites the existing output file if it exists.
-vlevel	Use to set the verbosity of the result display. Three levels are available: 0, 1, and 2, with 2 being the most verbose.
-Q	Quiet mode. This option suppress all output to the console.
-S	Summary mode. This option displays only the result summary to the console.
-I	Information mode. This option displays the overall transaction status and route status for each transaction.
-T	This option sorts by transaction entry time during display. sfmlog displays transactions according to timestamp rather than order within the log file.
-X	This option sorts by transaction serial number during display. sfmlog displays transactions according to their serial number rather than order within the log file.
-Z	Sets transaction and associated route status to specified status and output to file. Requires the -o option to provide the output file name to which sfmlog writes data. Valid status codes are: PENDING COMPLETE CANCELLED SKIPPED Example – ims sfmlog -fPending.log -ooutput.log -ZPENDING
-G	Extracts transaction record and outputs to a file. Requires the -o option to provide the output file name. This option retains the log file format recognized by the SFM. Example – ims sfmlog -fPending.log -ooutput.log -G
-g[h, o]pattern	Extracts transaction data and output to file. Requires the -o option to provide the output file name. You can provide an optional delimiter pattern to separate transaction data within the output file. The delimiter pattern can be hexadecimal or octal, with each byte separated by a comma. Example 1 – this sample extracts all transaction data from the Complete.log and writes to the output.log file. Each transaction data is separated by the hexidecimal pattern 41, 42, 43, 20, 31, 32, and 33: ims sfmlog -fComplete.log -ooutput.log -gh41,42,43,20,31,32,33 Example 2 – this sample performs the same operation as the previous sample. The only difference is that the data pattern is specified in octal format. Notice three digits are required for each byte, thus 040 instead of 40 are in the pattern): ims sfmlog -fComplete.log -output.log -go101,102,103,040,061,052,063
-d	Creates a summary file in plain text format. Requires the -o (output file) option.

Table 1-5: sfmlog Display and output options

Options

Description

-h

Displays a summary of sfmlog options and their associated functions.

-ffile

Specifies the input log file to parse. You can specify multiple log files.

-ofileName

(lowercase “o”) Specifies the file to receive sfmlog output.

-OfileName

(uppercase “O”) Specifies the output file and overwrites the existing output file if it exists.

-vlevel

Use to set the verbosity of the result display. Three levels are available: 0, 1, and 2, with 2 being the most verbose.

-Q

Quiet mode. This option suppress all output to the console.

-S

Summary mode. This option displays only the result summary to the console.

-I

Information mode. This option displays the overall transaction status and route status for each transaction.

-T

This option sorts by transaction entry time during display. sfmlog displays transactions according to timestamp rather than order within the log file.

-X

This option sorts by transaction serial number during display. sfmlog displays transactions according to their serial number rather than order within the log file.

-Z

Sets transaction and associated route status to specified status and output to file. Requires the -o option to provide the output file name to which sfmlog writes data. Valid status codes are:

PENDING
COMPLETE
CANCELLED
SKIPPED

Example –

ims sfmlog -fPending.log -ooutput.log 
-ZPENDING

-G

Extracts transaction record and outputs to a file. Requires the -o option to provide the output file name. This option retains the log file format recognized by the SFM.

Example –

ims sfmlog -fPending.log -ooutput.log -G

-g[h, o]pattern

Extracts transaction data and output to file. Requires the -o option to provide the output file name. You can provide an optional delimiter pattern to separate transaction data within the output file. The delimiter pattern can be hexadecimal or octal, with each byte separated by a comma.

Example 1 – this sample extracts all transaction data from the Complete.log and writes to the output.log file. Each transaction data is separated by the hexidecimal pattern 41, 42, 43, 20, 31, 32, and 33:

ims sfmlog -fComplete.log -ooutput.log 
-gh41,42,43,20,31,32,33

Example 2 – this sample performs the same operation as the previous sample. The only difference is that the data pattern is specified in octal format. Notice three digits are required for each byte, thus 040 instead of 40 are in the pattern):

ims sfmlog -fComplete.log -output.log 
-go101,102,103,040,061,052,063

-d

Creates a summary file in plain text format. Requires the -o (output file) option.