Inbound Link3270 vectors

Inbound Link3270 bridge vectors all have a common header. Table Link3270 inbound vector header shows the common header. One BRIV vector is required to satisfy each input CICS® command issued by the user transaction. The following inbound vector types are supported:

Link3270 inbound vector header

This header precedes all the vectors (both inbound and outbound) in the message.

Offset
Hex
Type
Len
Name
(0)
STRUCTURE
16
BRIV-INPUT-VECTOR-HEADER
(0)
FULLWORD
4
BRIV-INPUT-VECTOR-LENGTH
(4)
CHARACTER
4
BRIV-INPUT-VECTOR-DESCRIPTOR
(8)
CHARACTER
4
BRIV-INPUT-VECTOR-TYPE
(C)
n/a
4
reserved
BRIV-INPUT-VECTOR-LENGTH
The length of the vector. This is rounded up to the next multiple of 4, to facilitate full word alignment of subsequent vectors in the message. The default is the length of the default BRIV with no data.
BRIV-INPUT-VECTOR-DESCRIPTOR
An indicator to define the CICS command associated with this vector. Valid values are:
BRIVDSC-CONVERSE (0406)
CONVERSE
BRIVDSC-RECEIVE (0402)
RECEIVE
BRIVDSC-RECEIVE- MAP (1802)
RECEIVE MAP
BRIVDSC-RETRIEVE (100A)
RETRIEVE
BRIV-INPUT-VECTOR-TYPE
This must be set to BRIVVT-INBOUND. This is the default.

Link3270 INPUT CONVERSE vector

This vector is used to supply data to an EXEC CICS CONVERSE command. See the CICS Application Programming Reference manual for details of the command options.

The default vector is BRIV-CONVERSE-DEFAULT

Offset
Hex
Type
Len
Name
(0)
STRUCTURE
36
BRIV-CONVERSE
(0)
STRUCTURE
16
INPUT header
(10)
CHARACTER
4
BRIV-CO-TRANSMIT-SEND-AREAS
(14)
CHARACTER
4
reserved
(18)
CHARACTER
4
BRIV-CO-AID
(1C)
FULLWORD
4
BRIV-CO-CPOSN
(20)
FULLWORD
4
BRIV-CO-DATA-LEN
(24)
CHARACTER

BRIV-CO-DATA
BRIV-CO-TRANSMIT-SEND-AREAS
This flag is a performance option that allows the client to limit the amount of data returned in the output message. Valid values are:
BRIVCOTSA-YES
The whole output message is returned.
BRIVCOTSA-NO
All output vectors created prior to the command that uses this vector are not returned in the output message.

The default is BRIVCOTSA-YES.

BRIV-CO-AID
The AID key used to transmit the input. This value is used to set EIBAID on completion of the RECEIVE MAP command. The first byte of this field contains equivalent values to EIBAID, as defined by DFHAID. The remaining three bytes are ignored. The default is DFHENTER.
BRIV-CO-CPOSN
The position of the cursor in the data. This value is used to set EIBCPOSN on completion of the RECEIVE MAP command. Valid values are:
BRIVCOCP-DEFAULT
top left of the screen
BRIVCOCP-MAX-CURSORPOSITION
bottom right of the screen
nn
User specified value

The default is BRIVCOCP-DEFAULT.

BRIV-CO-DATA-LEN
The length of the data provided in this vector in BRIV-CO-DATA. This value is copied into the LENGTH or FLENGTH field specified in the CONVERSE command represented by this vector.

The default is zero (no data).

BRIV-CO-DATA
Character field of length BRIV-CO-DATA-LEN to be copied into the INTO area, or referenced by the SET option, of the CONVERSE command represented by this vector.

Link3270 RECEIVE vector

This vector is used to supply data to an EXEC CICS RECEIVE command. See the CICS Application Programming Reference manual for details of the command options.

The default vector is BRIV-RECEIVE-DEFAULT

Offset
Hex
Type
Len
Name
(0)
STRUCTURE
36
BRIV-RECEIVE
(0)
STRUCTURE
16
INPUT header
(10)
CHARACTER
4
BRIV-RE-TRANSMIT-SEND-AREAS
(14)
CHARACTER
4
BRIV-RE-BUFFER-INDICATOR
(18)
CHARACTER
4
BRIV-RE-AID
(1C)
FULLWORD
4
BRIV-RE-CPOSN
(20)
FULLWORD
4
BRIV-RE-DATA-LEN
(24)
CHARACTER

BRIV-RE-DATA
BRIV-RE-TRANSMIT-SEND-AREAS
This flag is a performance option that allows the client to limit the amount of data returned in the output message. Valid values are:
BRIVRETSA-YES
The whole output message is returned.
BRIVRETSA-NO
All output vectors created prior to the command that uses this vector are not returned in the output message.

The default is BRIVRETSA-YES.

BRIV-RE-BUFFER-INDICATOR
A flag indicating whether the data provided in the inbound vector is in a format to be received by a CICS RECEIVE command with the BUFFER option. Valid values are:
BRIVREBI-YES
Data in BUFFER format.
BRIVREBI-NO
Data not in BUFFER format.

The default is BRIVREBI-NO.

BRIV-RE-AID
The AID key used to transmit the input. This value is used to set EIBAID on completion of the RECEIVE MAP command. The first byte of this field contains equivalent values to EIBAID, as defined by DFHAID. The remaining three bytes are ignored.

The default is DFHENTER.

BRIV-RE-CPOSN
The position of the cursor in the data. This value is used to set EIBCPOSN on completion of the RECEIVE MAP command. Valid values are:
BRIVRECP-DEFAULT
BRIVRECP-MAX-CURSORPOSITION
nn
User specified value

The default is BRIVRECP-DEFAULT.

BRIV-RE-DATA-LEN
The length of the data provided in this vector in BRIV-RE-DATA. This value is copied into the LENGTH or FLENGTH field specified in the RECEIVE command represented by this vector.

The default is zero (no data).

BRIV-RE-DATA
Character field of length BRIV-RE-DATA-LEN to be copied into the INTO area, or referenced by the SET option, of the RECEIVE command represented by this vector.

Link3270 RECEIVE MAP vector

This vector is used to supply data to an EXEC CICS RECEIVE MAP command. See the CICS Application Programming Reference manual for details of the command options.

The default vector is BRIV-RECEIVE-MAP-DEFAULT

Offset
Hex
Type
Len
Name
(0)
STRUCTURE
48
BRIV-RECEIVE-MAP
(0)
STRUCTURE
16
INPUT header
(10)
CHARACTER
4
BRIV-RM-TRANSMIT-SEND-AREAS
(14)
CHARACTER
8
BRIV-RM-MAPSET
(1C)
CHARACTER
8
BRIV-RM-MAP
(24)
CHARACTER
4
BRIV-RM-AID
(28)
FULLWORD
4
BRIV-RM-CPOSN
(2C)
FULLWORD
4
BRIV-RM-DATA-LEN
(30)
CHARACTER

BRIV-RM-DATA
BRIV-RM-TRANSMIT-SEND-AREAS
This flag is a performance option that allows the client to limit the amount of data returned in the output message. Valid values are:
BRIVRMTSA-YES
The whole output message is returned.
BRIVRMTSA-NO
All output vectors created prior to the command that uses this vector are not returned in the output message.

The default is BRIVRMTSA-YES.

BRIV-RM-MAPSET
The name of the MAPSET containing the map used to format the data, or blanks. When the user transaction issues a RECEIVE MAP command, the Link3270 bridge uses the first remaining RECEIVE MAP vector in the message in which BRIV-RM-MAPSET matches MAPSET in the command or is blank and BRIV-RM-MAP matches the MAP in the command or is blank. RECEIVE MAP vectors which do not match the command are discarded.

The default is blanks.

BRIV-RM-MAP
The name of the MAP containing the map used to format the data, or blanks. When the user transaction issues a RECEIVE MAP command, the Link3270 bridge uses the first remaining RECEIVE MAP vector in the message in which BRIV-RM-MAPSET matches MAPSET in the command or is blank and BRIV-RM-MAP matches the MAP in the command or is blank. RECEIVE MAP vectors which do not match the command are discarded

The default is blanks.

BRIV-RM-AID
The AID key used to transmit the input. This value is used to set EIBAID on completion of the RECEIVE MAP command. The first byte of this field contains equivalent values to EIBAID, as defined by DFHAID. The remaining three bytes are ignored. The default is DFHENTER.
BRIV-RM-CPOSN
The position of the cursor in the data. This value is used to set EIBCPOSN on completion of the RECEIVE MAP command. Valid values are:
BRIVRMCP-DEFAULT
BRIVRMCP-MAX-CURSORPOSITION
nn
User specified value
The default is BRIVRMCP-DEFAULT.
BRIV-RM-DATA-LEN
The length of the Application Data Structure (ADS) in BRIV-RM-DATA. This value is copied into the LENGTH or FLENGTH field specified in the RECEIVE MAP command represented by this vector.
BRIV-RM-DATA
The ADS to be copied into the INTO area, or referenced by the SET option, of the RECEIVE MAP command represented by this vector.

Link3270 RETRIEVE vector

This vector is used to supply data to an EXEC CICS RETRIEVE command. See the CICS Application Programming Reference manual for details of the command options.

The default vector is BRIV-CONVERSE-DEFAULT

Offset
Hex
Type
Len
Name
(0)
STRUCTURE
36
BRIV-RETRIEVE
(0)
STRUCTURE
16
INPUT header
(10)
CHARACTER
4
BRIV-RT-RTRANSID
(14)
CHARACTER
4
BRIV-RT-RTERMID
(18)
CHARACTER
8
BRIV-RT-QUEUE
(20)
FULLWORD
4
BRIV-RT-DATA-LEN
(24)
CHARACTER

BRIV-RT-DATA
BRIV-RT-RTRANSID
The value to be returned in the RTRANSID field to the program that issued the RETRIEVE. A blank indicates that there is no RTRANSID. The default is blank.
BRIV-RT-RTERMID
The value to be returned in the RTERMID field to the program that issued the RETRIEVE. A blank indicates that there is no RTERMID. The default is blank.
BRIV-RT-QUEUE
The value to be returned in the QUEUE field to the program that issued the RETRIEVE. A blank indicates that there is no QUEUE. The default is blank.
BRIV-RT-DATA-LEN
The length of the data provided in this vector in BRIV-RT-DATA that caused the bridge to be called. This value is copied into the LENGTH or FLENGTH field specified in the RETRIEVE command represented by this vector. The default is zero (no data).
data
Character field of length BRIV-RT-DATA-LEN to be copied into the INTO area, or referenced by the SET option of the RETRIEVE command represented by this vector.
Note:
The RETRIEVE vector is only valid in the first inbound message in session mode, or in single transaction mode. It is ignored in other messages.

Related concepts
The Link3270 bridge mechanism
Related tasks
Using the Link3270 bridge
Writing the Link3270 client
Related reference
Link3270 message formats
Link3270 message header (BRIH)
Outbound Link3270 vectors
The application data structure (ADS)
Link3270 diagnostics
[[ Contents Previous Page | Next Page Index ]]