Inbound BRIH message header
The fields that are used in an input message are listed. You can supply values in these fields; other fields are ignored on input. A BRIH structure primed with input default values (BRIH-DEFAULT) is supplied in the DFHBRICx copybooks. If a default value is not specified, the field is initialized to nulls.
Fields are valid on all calls, except where indicated. See also Using Link3270 single transaction mode and Using Link3270 session mode.
- BRIH-STRUCID
- The identifier for the header structure. You must set this to BRIH-STRUC-ID, which is the default.
- BRIH-VERSION
- The version number for the header structure. You must set this to BRIH-CURRENT-VERSION, which is the default. Refer to Link3270 bridge basic and extended support for a description of the different levels of support for the Link3270 bridge.
- BRIH-STRUCLENGTH
- The length of the header structure. You must set this to BRIH-CURRENT-LENGTH, which is the default.
- BRIH-DATALENGTH
- The length of the input message, including the BRIH. The default is BRIH-CURRENT-LENGTH.
- BRIH-TRANSACTIONID
- The transaction identifier of the user transaction, as defined
in the routing region. In session mode, this can also specify the
following request values:
- BRIHT-ALLOCATE-FACILITY
- Allocate a new bridge facility
- BRIHT-DELETE-FACILITY
- Delete an existing bridge facility
- BRIHT-CONTINUE-CONVERSATION
- Reply to a conversational request message
- BRIHT-GET-MORE-MESSAGE
- Obtain the remainder (or next section) of the Link3270 message. This applies if the COMMAREA in the original request was too small to accommodate the output message.
- BRIHT-RESEND-MESSAGE
- Resend the previous saved Link3270 message. This is used if the
communications connection is broken in executing the previous request.
See Recovery from connection failure for further information. Note: A message is not saved if an error occurs before the message starts the user transaction. The BRIH-SEQNO can be used to determine whether a message returned by the RESEND-MESSAGE command is from the last Link3270 request issued, or the previous request.
- BRIH-FACILITY
- The facilitytoken of the bridge facility. For single transaction
mode this must be set to BRIHFACT-NEW. For session mode, on allocation,
this is set to BRIHFACT-NEW. For subsequent requests, this must be
set to the value returned on the allocate.
The default is BRIHFACT-NEW.
- BRIH-FACILITYLIKE
- (Single transaction mode and allocation of a bridge facility
in session mode)
The name of an installed terminal that is to be used as a model for the bridge facility. If no value is supplied in single-transaction mode, and a FACILITYLIKE value has been specified in the PROFILE definition of the user transaction, this value is used. Otherwise, or if no value is specified in session mode, a CICS-supplied definition, CBRF, is used.
The default BRIHFACL-DEFAULT means that no value is specified.
- BRIH-NETNAME
- (Single transaction mode and allocation of a bridge facility
in session mode)
The NETNAME to be assigned to the bridge facility.
The default value, BRIHNN-DEFAULT, causes CICS® to generate a name. The name is subject to change or rejection by the autoinstall URM whether specified by the user or generated by CICS. The name, as modified, is returned in this field in the response from the Link3270 bridge.
If you are specifying your own BRIH-NETNAME, the valid character set is the same as that for the NETNAME attribute of the CICS TERMINAL definition. See TERMINAL attributes.
- BRIH-TERMINAL
- (Single transaction mode and allocation of a bridge facility in session mode)
The TERMID to be assigned to the bridge facility.
The default value, BRIHTN-DEFAULT, causes CICS to generate a name. The name is subject to change or rejection by the autoinstall URM whether specified by the user or generated by CICS. The name, as modified, is returned in this field in the response from the Link3270 bridge.
If you are specifying your own BRIH-TERMINAL, the valid character set is the same as that for the TERMINAL attribute of the CICS TERMINAL definition. See TERMINAL attributes.
If you plan to specify your own BRIH-TERMINAL and to allow BRIH-NETNAME to default to this, you must use the BRIH-NETNAME character set, which is more restricted.
- BRIH-FACILITYKEEPTIME
- (Allocation of a bridge facility in session mode)
The length of time that the bridge facility is kept after the user transaction has ended (in seconds). The value used is the smaller of this value, and the value specified in the router region's SIT parameter BRMAXKEEPTIME.
The default is BRIHKT-DEFAULT.
- BRIH-CONVERSATIONALTASK
- (Run transaction in session mode) An indicator specifying what the Link3270 bridge should do if the user transaction issues an input command for which no input vector has been provided. Possible values are:
- BRIHCT-YES
- The Link3270 bridge suspends the transaction and adds a request vector to the end of the output message. The client is expected to send a CONTINUE-CONVERSATION message containing the requested vector.
- BRIHCT-NO
- The Link3270 bridge abends the user transaction.
The default is BRIHCT-NO.
- BRIH-GETWAITINTERVAL
- (Run transaction in session mode)
The maximum wait interval for message input (in milliseconds). The value used is the smaller of the BRIH-GETWAITINTERVAL and the RTIMEOUT value for the transaction.
This value is used only when BRIH-CONVERSATIONALTASK is BRIHCT-YES
The default is BRIHGWI-MAXWAIT.
- BRIH-CANCELCODE
- (Session mode - continue conversation only)
The abend code with which the Link3270 bridge is to terminate a user transaction. This value is meaningful only in CONTINUE-CONVERSATION messages. If it is non-blank, Link3270 l abends the suspended user transaction with an abend code of BRIH-CANCELCODE. It should be used only when the client wants to terminate the transaction rather than supply the requested vector.
- BRIH-ADSDESCRIPTOR
- (Single transaction mode and run transaction in session mode) An indicator specifying whether ADS descriptors are sent on outbound SEND MAP and RECEIVE MAP messages. Possible values are:
- BRIHADSD-YES
- ADS descriptors are sent.
- BRIHADSD-NO
- ADS descriptors are not sent.
The default is BRIHADSD-YES.
- BRIH-ATTENTIONID
- (Single transaction mode and run transaction in session mode)
The initial value of the AID key (EIBAID) when the user transaction is started. This is a 1-byte value, left justified. EIBAID is reset after each RECEIVE, RECEIVE, or CONVERSE command from the AID value in the input vector
The default is DFHENTER (The enter key).
- BRIH-STARTCODE
- (Single transaction mode and first run transaction in a session) An indicator available to the first transaction in a session to show the type of start that the request is emulating. The value generated depends on whether there is a RETRIEVE vector present in the input. Possible values are:
- BRIHSC-START
- START command
- BRIHSC-TERMINPUT
- Terminal input
The default is BRIHSC-TERMINPUT.
- BRIH-CURSORPOSITION
- (Single transaction mode and run transaction in session mode)
The initial cursor position, EIBCPOSN, when the transaction is started. EIBCPOSN is reset from the value in the input vector after every RECEIVE, RECEIVE MAP or CONVERSE command.
The default is BRIHCP-DEFAULT, the top left of the screen.