BRAT gate, ATTACH function

The ATTACH function of the BRAT gate is called to attach a transaction with a bridge primary client.

Input Parameters

FACILITYTOKEN
Facility token which references the BFB.
MESSAGE_TYPE
An indication that the bridge mechanism will use an architected message type. A CICS subroutine is used in place of the bridge exit.
Values for the parameter are:
  • BRIH
STATE_TOKEN
The message state token passed between the caller and the bridge subroutines responsible for the architected message.
TRANSACTION_ID
The 4 byte transaction id of the user transaction to be attached.
BRDATA
Optional Parameter
The address and length of a block of storage containing data to be passed to the bridge exit. This is used as part of the primary client data.
BREXIT
Optional Parameter
The name of the program to be used as the bridge exit. If this is not specified, DFHBRAT will get the default value from transaction manager. If there is no default bridge exit, an error is returned.
PRIORITY
Optional Parameter
Transaction manager priority of the transaction.
USERID
Optional Parameter
The USERID that should be signed-on to the terminal. This is only set when no facility token is passed.

Output Parameters

REASON
The values for the parameter are:
  • DISABLED
  • GETMAIN_FAILED
  • NO_BREXIT
  • NO_STORAGE
  • NO_XM_STORAGE
  • NOT_ENABLED_FOR_SHUTDOWN
  • NOT_FOUND
  • STATE_SYSTEM_ATTACH
  • USERID_NOT_AUTH_BREXIT
RESPONSE
Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.


dfhs3_BRATattach.html | Timestamp icon Last updated: Monday, 5 June 2017