PIPE EDIT

• 'nnnnnn'X
• X'nnnnnn'

Before processing, the hexstring is converted to the corresponding character string.

When used as an input order operand, hexstring acts as a literal to be used as input.

Position indicates the starting character within the line. By default, position is counted from the first character of the line. For input orders, the starting point for the count can be modified by the global orders.

Position can be any positive or negative number. A negative value for position indicates that the starting position is to be counted from the end of the line, rather than from the beginning.

Length is an unsigned positive number indicating the number of characters from position to be processed. An asterisk (*) can be specified for length indicating that all characters after position are to be used. Position without length and the period (.) separator defaults length to 1.

If length is larger than the available characters, all available characters are used. The LEFT conversion order can be used to pad the resulting text if required.

PIPES CAN BE FUN!

The plus sign (+), minus sign (-), and asterisk (*) have special meanings in edit scripts. To avoid confusion, do not use these characters as /string/ delimiters in edit scripts.

EDIT 1.* 1     /* get first line and output at position 1 */
     READLINE  /* Get next line                           */
     COPY *    /* copy lines 2 through end to output      */
     WRITELINE /* write first line                        */

The WRITELINE in this example is required because COPYREST cancels the implied WRITELINE created by the output order 1. See the description of WRITELINE for more information.

READLINE
1.* 1
WRITELINE

EDIT 1.* 1     /* get first line and output at position 1 */
     COPYREST  /* copy lines 2 through end to output      */
     WRITELINE /* write first line                        */

If the number is negative, EDIT counts from the end of the message. For example, LINE -1 selects the last line of a multiline message and LINE -2 selects the next to last line. LINE 0 (zero) results in a null line.

LASTLINE is a complementary function to TOPLINE. Where LASTLINE sets the input to the last line, TOPLINE sets the input to the first line of the multiline message.

See also TOPLINE.

N

This action is for the net log.

S

This action is for the system log.

H

This action is for the hardcopy log.

*

This action is for all three log methods: net log, system log, and hardcopy log.

Lines created by NAMEBIND can be transferred to the adapter using the PPI stage. Examples of NAMEBIND can be found in Example: Sending an Alert to the NetView Alert Adapter, CNMEALUS, and CNMEMSUSCNMEALUS and CNMEMSUS. For more information about PPI, see PIPE PPI. see HELP PIPE PPI.

N

This action is for the net log.

S

This action is for the system log.

H

This action is for the hardcopy log.

*

This action is for all three log methods: net log, system log, and hardcopy log.

/string/

Indicates that the input orders consider the line to end after the given /string/. Previous SKIPTO or UPTO orders are respected. ONTO is similar to UPTO except that the target string is included in the new logical line.

PAD must be followed by one-character value. This value can be specified as a delimited string, /char/, or as a hexstring.

The default PAD character is a blank.

C

Indicates that all blank delimited tokens are counted as words.

Q

Indicates that tokens enclosed in single quotation marks are counted as words regardless of embedded blanks. The single quotation marks are removed from the parsed words. If the input data contains unbalanced quotation marks, only the data to the point where the error was discovered is returned.

/string/

Specifies how subsequent work/token orders counts words. The characters in the specified string, and only those characters, are counted as token delimiters.

Note: A parse order always cancels the effect of any previous parse order.

'PIPES ARE' 'REALLY' 'FUN'

 (space) , = ( )

 IEE114I 11.44.14 96.141 ACTIVITY 444
  JOBS  M/S  TS USER SYSAS INITS ACTIVE/MAX VTAM  OAS
 00000 00006  00001  00016 00002  00001/00300    00000

WORD 2 1
READLINE
READLINE
WORD 3 NEXTWORD

The output from this edit script is 11.44.14 00001.

If required, READLINE performs a RESET.

Executing READLINE more times that the number of lines in the input message is not an error. If READLINE attempts to retrieve lines beyond the end of the message, a null line is passed to the input order.

/string/

Indicates that the input orders consider the line to start at the given /string/. Previous SKIPTO or UPTO orders are respected. For example, if the current line is:

PIPES ARE FUN.  PIPES USING EDIT ARE EVEN BETTER!

And, the edit script is:

SKIPTO /FUN/
SKIPTO /PIPES/
WORD 6
NEXT

The line is processed as follows:

1. SKIPTO /FUN/ sets the starting point to the beginning of the word FUN.
2. SKIPTO /PIPES/ sets the starting point to the beginning of the word PIPES.
3. Retrieves the sixth word.

The line is processed as follows:

And, the output is:

BETTER!

number

Indicates that the input orders consider the line to start at character number. Number must be a positive number. Previous SKIPTO or UPTO orders are respected. For example, if the current line is:

PIPES ARE FUN.  PIPES USING EDIT ARE EVEN BETTER!

And, the edit script is:

SKIPTO /USING/
SKIPTO 2
WORD 1
NEXT

The line is processed as follows:

1. SKIPTO /USING/ sets the starting point to the beginning of the word USING.
2. SKIPTO 2 sets the starting point to the second letter of the word USING.
3. WORD 1 selects the current word, beginning with the starting point set by the prior step.

The line is processed as follows:

And, the output is:

SING

If the /string/ is not in the input, or a number is specified which is larger than the length of the input, none of the input is available to the input orders.

UPTO is a complementary function to SKIPTO. Where SKIPTO 1 returns the entire line, UPTO 1 returns none of the line.

See also UPTO and RESET.

TOPLINE is a complementary function to LASTLINE. Where TOPLINE sets the input to the first line, LASTLINE sets the input to the last line of the multiline message.

See also LASTLINE.

See also HELP PIPE LASTLINE.

/string/

Indicates that the input orders consider the line to end at the given /string/. Previous SKIPTO or UPTO orders are respected. For example, if the current line is:

PIPES ARE FUN.  PIPES USING EDIT ARE EVEN BETTER!

And, the edit script is:

UPTO /FUN/
WORD -1
NEXT

The line is processed as follows:

1. UPTO /FUN/ sets the starting point to the beginning of the word FUN.
2. WORD -1 selects the previous word, beginning with the starting point set by the prior step.

The line is processed as follows:

And, the output is:

ARE

number

Indicates that the input orders consider the line to end at character number. Number must be an unsigned, positive number. Previous SKIPTO or UPTO orders are respected. For example, if the current line is:

PIPES ARE FUN.  PIPES USING EDIT ARE EVEN BETTER!

And, the edit script is:

UPTO 21
WORD -1
NEXT

The line is processed as follows:

1. UPTO 21 sets the starting point to the character N in the word USING.
2. WORD -1 selects the previous word, beginning with the starting point set by the prior step.

The line is processed as follows:

And, the output is:

PIPES

If the /string/ is not in the input, or a number is specified which is larger than the length of the input, all of the input is available to the input orders.

SKIPTO is a complementary function to UPTO. Where SKIPTO 1 returns the entire line, UPTO 1 returns none of the line.

See also SKIPTO and RESET.

Conversion orders, such as SUBSTR, can be used to obtain specific pieces of the AIFR.

Value

Description

D

USS persistent procedure.

The address space has a name for initiated programs, appropriate for a JOB. However, the existence of an OpenMVS address space block indicates a special purpose USS persistent procedure.

E

The address space is a system address space that is started during operating system initialization (NIP) processing, and the message was issued before NetView subsystem initialization.

J

The address space is a JOB.

N

The address space is a system address space started during operating system initialization (NIP) processing.

S

The address space is a Started Task (STC).

Note: Because of the manner in which TN3270 is started, it may appear as type S rather than type D, as might be expected.

T

The address space is a Time-Sharing User (TSO).

U

The address space is a USS forked or spawned procedure.

*

Error: the address space where the command originated has closed or else the message is not from the local LPAR.

?

Error: inconsistent data (might be a transient condition).

!

Error: inconsistent data.

>

Error: the supplied ASID is larger than the allowed ASID limit for the system

Value

Description

00

Issuer is not APF authorized.

80

Issuer is APF authorized.

CY HU IN TD

Value

Description

M

Master

I

I/O

S

System

C

Console

X

Information is not available, or conflicting data is found.

• For the CRT, returns the name of the console issuing the command.
• For the MRT, returns the destination console name.

The DELETE input order is only available for message revision.

AMRF

Returns the following status: message is to be retained in AMRF

AUTOMATE

Indicates whether the message is to be automated.

Note: Even if the value indicates that the message is not to be automated, a solicited message is still automated by the NetView program.

BROADCAST

Indicates that the message is to be sent to all active consoles

DISPLAY

Indicates that the message is to be displayed at the console.

PROG

Displays programming information

SYSLOG

Writes to the system log

Length: 16 bits

Type: Message

A NETVONLY action cannot succeed if the NetView procedural space is down, the subsystem router is down, or if the task defined by the ?MVSCmdRevision CNMSTYLE statement is inactive.

Use the C2B conversion order to view or print this field.

ROUTECODES is synonymous with IFRAUWRT.

SYSCONID is synonymous with IFRAUCON.

Startword.numwords must be specified.

Startword indicates the starting word within the current line. By default, startword is counted from the first word of the line.

Startword can be a positive or negative number. A negative value for startword indicates that the starting position is to be counted from the end of the current line, rather than from the beginning.

Numwords is an unsigned, positive number indicating the number of words from startword to be processed. An asterisk (*) can be specified for numwords indicating that all words after startword are to be used. Startword without numwords and the period (.) separator defaults numwords to 1.

If numwords is larger than the available words, all available words are used. The LEFT conversion order can be used to pad the resulting text if required.

PIPES CAN BE FUN!

For example, the WQEMCSC command response flag is not typically accessible with an edit order. From a listing, we can determine that WQEMCSC is at offset X'AC' (decimal 172) in the WQE and it is the third bit in that byte. Therefore, the edit phrase WQE SUBSTR 173.1 c2b substr 3.1 yields either a character 1 or a character 0, according to the value of the WQEMCSC flag.

The input data must be in exact multiples of eight characters. The converted data is one-eighth the length of the original.

B2C is the inverse of C2B.

C2B is especially useful in converting bit string data such as that returned from DESC (IFRAUWDS) to a readable form.

Because C2B returns a character string 8 times longer than the original, you can easily generate a message which exceeds the 32 000 character limit for NetView messages. Use C2B to convert only the substring requiring conversion. For more information, see the conversion order for SUBSTR.

C2B is the inverse of B2C.

PIPE LIT /AB/
     | EDIT 1.* C2D
     | CONS ONLY

PIPE LIT /AB/
     | EDIT PAD '00'X 1.* RIGHT 3 C2D
     | CONS ONLY

Use C2D with an input of 4 characters or less. The results of C2D are unpredictable with an input of more than 4 characters. Use C2D to convert only the substring requiring conversion.

C2D is the inverse of D2C.

A maximum of 17 decimal digits are used in the conversion with leading and trailing zeros stripped. An 18th digit is calculated and used to round the results. For example, the repeating decimal number 1.9999999... is converted to 2.

See also the conversion order for F2C and the conversion order for C2S.

C2G is the inverse of G2C.

This conversion order is particularly useful when dealing with data interacting with the SQL pipe stage.

The input string must start with a 2-byte length field containing the number of DBCS characters. The number of data bytes after the length field must be twice the value of the length field because each DBCS character is represented by two bytes of data. The length field is not copied to the converted string.

C2GV is the inverse of GV2C.

This conversion order is particularly useful when dealing with data interacting with the SQL pipe stage.

• If scale is 0 (zero), the resulting number is an integer. For example, C2P 0converts the input X'123C' to 123.
• If scale is positive, the resulting number has scale number digits after the decimal point. For example, C2P 2 converts the input X'123C' to 123.45.
• If scale is negative, the resulting number has scale zeros added to the number. For example, C2P -1 converts the input X'123C' to 120.

C2P is the inverse of P2C.

A maximum of 17 decimal digits are used in the conversion with leading and trailing zeros stripped. An 18th digit is calculated and used to round the results. For example, the repeating decimal number 1.9999999... is converted to 2.

See also the conversion order for F2C and the conversion order for C2F.

C2V is the inverse of V2C.

This conversion order is particularly useful when dealing with data interacting with the SQL pipe stage.

C2X is the inverse of X2C.

The input data is searched from the beginning of the data for a date format. For time conversion the input is searched from the end.

Use D2C with an input resulting in 4 characters or less. The results of D2C are unpredictable with an input resulting in more than 4 characters. Use D2C to convert only the substring requiring conversion. For more information, see the conversion order for SUBSTR. See HELP PIPE SUBSTR for more information.

D2C is the inverse of C2D.

To convert to Greenwich Mean Time, use ZDT.

F2C is the inverse of C2F.

G2C is the inverse of C2G.

This conversion order is particularly useful when dealing with data interacting with the SQL pipe stage.

GV2C is the inverse of C2GV.

This conversion order is particularly useful when dealing with data interacting with the SQL pipe stage.

• Converts a positive indicator into a negative.
• Converts a negative indicator into a positive.

keep

is an unsigned, positive number specifying the number of characters to keep.

discard

is an unsigned, positive number specifying the number of characters to discard.

For example, if the input is 13:15:45 and ODDBYTES 2.1 is specified, 131545 is returned. That is, two characters were kept and one was discarded. Then, another two characters were kept, and one was discarded. And so on.

For example, after the command OVERRIDE LONGDATE=YY.MM.DD, the value X'CADA6B86F34C3820' is converted to 13.01.31 10:28:11.

A typical use is to take the input provided by the IFRAUGMT msgattr input order and convert it to readable form.

• If scale is 0, the integer portion of the number is converted to packed decimal. For example, C2P 0 converts the input 123.456 to X'123C' which is the packed decimal number representing 123.
• If scale is positive, the resulting number has scale number digits included in the packed decimal. For example, C2P 2 converts the input 123.456 to X'12345C' which is the packed decimal representing 12345.
• If scale is negative, the resulting number has scale number of digits removed from the integer portion of the packed decimal. The decimal portion is ignored. For example, C2P -1 converts the input 123.456 to X'012C' which is the packed decimal number representing 12.

C2P is the inverse of P2C.

If padding is required for the data to be the required length, the characters specified by the most recent PAD global order is used.

V2C is the inverse of C2V.

This conversion order is particularly useful when dealing with data interacting with the SQL pipe stage.

X2C is the inverse of C2X.

This conversion order is particularly useful when using the IFRAUCPY, IFRAUPPT, IFRAUPRI, and IFRAUSEC msgattr input orders.

To convert to local time, use DT.

• When descriptor code bits 1, 2 and 11 are all zero (not an action message), a blank space is set.
• When the input is null, the letter N or the number 0 (designating that the issuing routine is not APF authorized), and any of the descriptor bits 1, 2 or 11 is one (designating an action message), an at character (@) is set.
• When the input is a non-null value other than the letter N or the number 0 (designating that the issuing routine is APF authorized), and any of descriptor bits 1, 2 or 11 is one (designating an action message) an asterisk character (*) is set.

1. According to MVS convention, action messages that are issued by APF authorized programs are prefixed with an asterisk character (*). MVS action messages that are issued by programs that are not APF authorized are prefixed with an at character (@). For a description of MVS message prefix characters, refer to the "Messages sent to MCS/SMCS consoles" section in the MVS System Messages documentation.
2. The AUTHISSUER and ACTIONFLAG orders can be used together to set the prefix character according to MVS convention.

AUTOTOKEN is synonymous with IFRAUTOK.

Color

CB

Blue

CR

Red

CP

Pink

CY

Yellow

CG

Green

CW

White

CT

Turquoise

CD

Default

Intensity

IN

Not intensified

IH

Intensified

ID

Output line is dark. Although the output line exists, it is not displayed.

Highlighting

HR

Reverse video

HU

Underlined

HB

Blinking

HD

Default

Line Type

TC

Control line

TL

Label line

TD

Data line

TE

End line

/CB IN HB TD/ COLOR

COLOUR, LINEATTR, and LINEATTRS are synonyms for COLOR.

• If the input is null, the letter N, or the number 0, the DELETE output order undoes a previous deletion.
• If the input is a non-null value other than the letter N or the number 0, the DELETE output order deletes the message or command. Marking a message for deletion does not prevent the message from being automated.

The DELETE output order is available only when performing a REVISE action.

AMRF

Retains the message in AMRF

AUTOMATE

Sets a flag that indicates whether automation is to be performed on the message.

Notes:

• Setting AUTOMATE to an affirmative value, such as Y, causes a foreign unsolicited message to be automated.
• The AUTOMATE order has no effect on solicited messages by the NetView program.

BROADCAST

Sets an indicator that causes the operating system to send messages to all active consoles.

DISPLAY

Sets an indicator that the message is displayable at the console.

Note: If a command response message (descriptor code 5 being the standard method for marking a message as a command response) is marked for suppression (e.g. by using 'N' DISPLAY in a Message Revision Table), it is still returned to a pipe (even when WINDOW is used) that correlates an MVS command response. To prevent a message correlated to a pipe from also being returned to the pipe, use 'Y' DELETE.

PROG

Displays programming information

SYSLOG

Writes to the system log

TC

Output line is to be a control line.

TL

Output line is to be a label line.

TD

Output line is to be a data line.

TE

Output line is to be an end line.

LINETYPE is not case-sensitive.

If the input to LINETYPE is not one of these four values, or if LINETYPE is not specified, the current line type attribute is retained.