The non-seamless TIBCO Object Service Broker client passes the session parameter string and the data area to the session when the session is started. Using this method, the client can pass data to a session through the arguments to the RULE parameter in the session parameter string or in the data area.
Before you use any of the CICS instructions to invoke a non-seamless TIBCO Object Service Broker client, the invoking CICS program must set up a COMMAREA that meets the following requirements:
The seamless TIBCO Object Service Broker client uses the entire externally established COMMAREA as a data area to be passed to the session when the session is started, as shown in the following illustration:
Using TIBCO Object Service Broker rules, you can access only the data area portion of the COMMAREA. If the client is non-seamless, you can access only the data area following the session parameter string. If you use the seamless interface, you can access the data area consisting of the entire COMMAREA. The data area of the COMMAREA can be accessed using MAP tables or using the
$GETENVCOMMAREA tool.
$GETENVCOMMAREA returns the data portion of the COMMAREA as a syntax V string including the two byte
ll length header. The maximum length of the returned string is 31K. To avoid local variable storage overflow, consider increasing the values of the session parameters EXECLOCALSIZE and EXECSTACKSIZE. Settings of 128K for both variables are usually sufficient.
If the session terminates abnormally or if you use the ENDMSG tool to generate an error message, the message is put into the COMMAREA starting at the first byte, overlaying other data in that area. It is the responsibility of the CICS program that subsequently receives control to check for the four-byte error token HERR at the start of the COMMAREA.
If the error messages cannot fit into the COMMAREA, it is truncated. To avoid truncating error messages, the size of the COMMAREA should be at least 256 bytes. For diagnostic purposes, a message that does not fit is sent to the console by WTO and appended to the CICS joblog.