FIELDS Format

For the FIELDS format, each field, protected or unprotected, is returned individually. There can be one field or hundreds of fields. These fields are presented in the order they are returned to VET by the application running on the VOST. VET FIELDS also provides the 3270 data stream attributes for each field.

Each line following the BNH150I message header line, which describes a field, is formatted as follows:

row.col Fx Iy RESERVED %data

If COLOR was specified on the ATTACH command, color and highlighting information are also available:

row.col Fx Iy Cz Ha RESERVED %data

The individual parts of each line are:

row.col

The starting row and column of the field. For example, if you have a field that is from row 3 column 10 through row 3 column 15, row.col is 3.10 and 6 characters are in data. Fields can be contained in one row or can be multiple rows deep.

Fx

Indicates whether the field is protected. FA indicates that the field is protected. FI indicates that it is not protected.

Iy

Indicates whether the field is intensified; Iy can have one of these three values:

IN: The field is not intensified.
IH: The field is intensified.
ID: The field is not visible on the panel.

Cz

The color of the field; Cz indicates that the field is one of the following colors:

CB: Blue
CR: Red
CP: Pink
CY: Yellow
CG: Green
CW: White
CT: Turquoise
CD: Default

Ha

The highlighting of the field; Ha indicates that the field has one of the following highlights:

HR: Reverse Video
HU: Underlined
HB: Blinking
HD: Default

RESERVED

Additional information can be included in the reserved area. Information contained in the reserved area is subject to change and must not be used for automation purposes.

%

Is a delimiter separating the field attributes from the actual data contained within the field. The % delimiter immediately precedes the field data and must be used when parsing the message line.

data

Contains the data within the field. The first character is the data position of the field order, if any, from the 3270 data stream. This character is presented as a blank.

The first line following the BNH150I header line has the following format:

write-type row.col option

The individual parts of this line are:

write-type: The write-type is either WRITE or ERASE-WRITE. Write-type indicates the action taken by the application running on the VOST when updating the panel. WRITE indicates that changes were made to the panel, but the panel was not totally rewritten. ERASE-WRITE indicates that the panel was erased and rewritten.
row.col: The starting row and column of the options. This is also the current cursor position on the virtual screen.
options: Can be BEEP, LOCK, or both. Options indicates whether the terminal beep is sounded or the panel is locked from input.

Reference: For more information about 3270 data stream attributes, refer to the 3270 Information Display System library.

For example, if you use the following code in your full-screen automation application:

  ATTACH NPDA

  PIPE (NAME BADCOM)
      |VET NEXT FIELDS
      ...
  Stages to process returned panel
      ...

      NETVIEW VET /BAD COMMAND/

  PIPE (NAME GETPANEL)
      |VET NEXT FIELDS
      |CONSOLE

A VOST starts running NPDA. BAD COMMAND is entered on the command line. Because BAD COMMAND is not a valid command, NPDA returns an error. VET NEXT FIELDS returns only those fields that have changed. In this example, the following text is displayed on the console:

Figure 1. Example Screen for VET NEXT FIELDS

BNH150I FIELDS/NEXT OUTPUT FOR 'NPDA' RECEIVED FROM NPDA
WRITE 24.8 BEEP
22.1 FA IN % BNJ905I INVALID COMMAND ENTERED OR INCORRECT OPERANDS
23.1 FA IN %
23.80 FA IH % CMD==>
24.8 FI IH % BAD COMMAND

The BNH150I message header line indicates that the message results from VET NEXT FIELDS from a VOST running NPDA. WRITE 24.8 BEEP shows that the panel was updated without first being erased and that the 3270 data stream BEEP command was issued. The next four messages show the fields that were changed by NPDA. The field beginning at row 22 column 1 shows the message that was displayed on the virtual screen as a result of the command. The other fields show the changed fields resulting from VET /BAD COMMAND/.

The following example shows a BNH150I message after an ATTACH command with the COLOR option. Note that the Cz and Ha information is included indicating color and highlighting for each field:

* NTV7E    TOM      ATTACH (ACTION='PIPE VET CURRENT FIELDS|CONS',COLOR) HELP
* NTV7E    TOM      PIPE VET CURRENT FIELDS|CONS
' NTV7E    TOM
BNH150I FIELDS/CURRENT  OUTPUT FOR 'HELP' RECEIVED FROM HELP.
BEEP  24.13
1.1 FA IN CB HD % CNMKNCCF
1.28 FA IH CW HD % COMMAND FACILITY HELP MENU
2.1 FA IN CT HD %
3.1 FA IN CT HD %
4.1 FA IH CT HU % Select
4.8 FA IN CB HD %  To get information about
5.1 FA IN CT HD %
6.1 FA IN CT HD %
6.4 FA IH CW HD % 1
6.9 FA IN CT HD % Operator's overview of the command facility
7.1 FA IN CT HD %
7.4 FA IH CW HD % 2
7.9 FA IN CT HD % Using the terminal access facility (TAF)
8.1 FA IN CT HD %
9.1 FA IN CT HD %
9.4 FA IH CW HD % 3
9.9 FA IN CT HD % The command facility screen
10.1 FA IN CT HD %
10.4 FA IH CW HD % 4
10.9 FA IN CT HD % Command facility commands and command lists

In this case, line 4 shows that the word Select is in turquoise and underscored.