Pipe Stages › Pipe Stage Commands

Pipe Stage Commands

The following pipe stage commands and parameters are supported:

Note: The online help in the NCCF-like facility contains more information about the pipe stage command parameters.

BETWEEN

Divides message streams into sections.

Parameters: INCL, NOINCL, number, position.length, /1st string/, /2nd string/

CASEI

Compares character strings without respect to case.

Parameters: stage_specification

CHANGE

Replaces occurrences of one string with another.

Parameters: position.length, /1st string/, /2nd string/, number

CHOP

Truncates lines after a specified character, column, or string.

Parameters: column, width, offset, /string/, AFTER, ANY, BEFORE, NOT, STRING

COLLECT

Creates a multiline message, or messages, from input lines.

Parameters: AFTER, ASBEFORE, AT, BEFORE, BREAK, MAX, number, position.length, /string/

CONSOLE

Displays the contents of the pipeline.

Parameters: DUMP, XDUMP

CORRCMD

Processes a command with correlated wait and termination stages.

Parameters: ECHO, MOE, wait, cmdlabel, commandtext

CORRWAIT

Allows asynchronous messages into the pipeline.

Parameters: MOE, *, interval

COUNT

Counts the number of messages, lines, or bytes in the input stream.

Parameters: MESSAGES, BYTES, EACHLINE, EACHMSG, FROM, number, LINES, MAXLINE, MINLINE

DELDUPES

Deletes duplicate messages.

Parameters: ALL, KEEPFIRST, KEEPLAST, PAD, position.length

DROP

Specifies the number of messages to discard from the pipeline.

Parameters: count, FIRST, LAST, LINES, MSGS

DUPLICAT

Copies messages in the input stream.

Parameters: number, *

EDIT

Creates or reformats messages.

Parameters: hexstring, position.length, number, /string

ENVDATA

Outputs environment data.

FANIN

Merges multiple input streams, in stream order, into a single output stream.

FANINANY

Merges multiple input streams, preserving the message order, into a single output stream.

FANOUT

Passes a single input stream to multiple output streams.

HOLE

Discards the contents of the pipeline.

JOINCONT

Joins consecutive messages that match a specified string.

Parameters: LEADING, NOT, /string/, TRAILING

KEEP

Defines a task global place to store messages.

Parameters: keepname, APPEND, SEIZE

LITERAL

Inserts text into the pipeline.

Parameters: /string/

LOCATE

Selects messages that match a specified character string to remain in the pipeline.

Parameters: ALL, FIRST, LAST, position.length, /string/

LOGTO

Sends a copy of the contents of the pipeline to a specific log.

Parameters: *, ALL, HCYLOG, NETLOG, SYSLOG

LOOKUP

Matches data within a pipeline

Parameters: APPEND, detail_position.length, reference_position.length, WILDCARD

MEMLIST

Creates a list of members in one or more partitioned data sets (PDS) or data definitions (DD).

Parameters: (DD), (DSN), datasetname, ddname

MVS

Runs specified MVS commands.

Parameters: commandtext

NETVIEW

Runs specified NetView REXX commands.

Parameters: commandtext, ECHO, MOE, NOPANEL

NLOCATE

Discards messages that match a specified character string.

Parameters: position.length, /string/

NM

Specifies to run a CA NetMaster command. The resulting messages are placed in the pipeline.

Parameters: commandtext

NOT

Changes the way output is treated by those stages that discard part of their output.

Parameters: stage_specification

PICK

Selects messages to remain in the pipeline based on a comparison of two strings.

Parameters: position.length, operator, position2.length2, or /string

PIPEND

Causes a pipeline to end and issues a return code.

Parameters: *, number

PRESATTR

Changes the way messages appear on the Tivoli NetView console.

Parameters: asis, color, highlighting, intensity

QSAM

Reads from and writes to dynamically allocated data definition names or data sets.

Parameters: data_set_name, data_definition_name, (DD), (DSN)

REVERSE

Changes the order of message text and message lines.

Parameters: LINE, MESSAGE, STREAM

SAFE

Reads or writes messages to a command procedure message queue.

Parameters: *, name, APPEND, SEIZE

SEPARATE

Breaks MLWTOs into multiple single-line messages.

Parameters: DATA, SEQUENCE

SORT

Sorts input stream messages.

Parameters: A, D, PAD, position.length

SPLIT

Divides a line of text into multiple lines.

Parameters: count, AT, AFTER, ANY, BEFORE, STRING, /string/

STEM

Reads or writes records to or from command procedure variables.

Parameters: (COMMON), (TASK), APPEND, COLLECT, stemRoot, FROM, number

STRIP

Removes characters from the beginning or end of a message.

Parameters: BOTH, LEADING, TRAILING, TO, NOT, BLANK, /character set/, limit

SUBSYM

Substitutes z/OS and user-defined system symbolics in messages in the pipeline.

TAKE

Specifies the number of messages to be kept in the pipeline.

Parameters: FIRST, LAST, count, LINES

TOSTRING

Ends the data stream when a specific character string is located.

Parameters: ALL|FIRST|LAST, INCL, NOINCL, position.length, /string/

VAR

Reads or writes records to or from command procedure variables.

Parameters: (COMMON), (TASK), name

VARLOAD

Sets variables to a specified value.

Parameters: (COMMON), (TASK)

VTAM

Runs specific VTAM commands in a local or remote domain.

Parameters: commandtext, ECHO, MOE, NOPANEL

XLATE

Accepts a message from its input stream, translates specified characters, and writes the message to its output stream.

Parameters: position.length, UPPER, A2E, COMMON, E2A, LOWER

<

Reads data from DASD into the pipeline.

Parameters: DSIPARM. ddname, *, member

$STEM

Same as STEM, plus reads or writes message attribute variables associated with specified data variables.

Parameters: (COMMON), (TASK), APPEND, COLLECT, stemRoot, FROM, number

$VAR

Same as VAR plus reads or writes message attribute variables associated with specified data variables.

Parameters: (COMMON), (TASK), name