Copyright © TIBCO Software Inc. All Rights Reserved
Copyright © TIBCO Software Inc. All Rights Reserved


Chapter 16 Call Level Interface Functions : Starting or Locating the Execution Environment – STARTEE

Starting or Locating the Execution Environment – STARTEE
Syntax
For the syntax of all Call Level Interface functions, see Call Level Interface Specification and HRNHLLTM Module Parameters.
Calling Parameters
After preparing to start the Execution Environment, your client program starts or locates the Execution Environment by specifying STARTEE as the OPERATION.
For TSO, batch, and CICS, if an Execution Environment is already active in the address space, the STARTEE operation locates the Execution Environment and copies a handle to it into the HRNHLLWA workarea.
For TSO and batch Execution Environments, if no Execution Environment exists, a same-address space Execution Environment is started.
Starting an Execution Environment
You start either a TSO or batch Execution Environment by specifying TSO or BATCH as the OPERAND parameter. Overrides to the Execution Environment parameters are supplied through the variable length PARM parameter.
Obtaining Execution Environment Startup Parameters
When starting an Execution Environment, the PARM parameter contains the Execution Environment startup parameter. This information is obtained according to the following order of precedence:
1.
2.
3.
On successful execution, the value of RETURN-CODE is 0, and the first eight characters of RETURN-DATA are the name of the Table Data Store (TDS) to which your Execution Environment is connected, ‘HCDL1000’ in our example.
See Also
TIBCO Object Service Broker Parameters about Execution Environment parameters.
Locating an Execution Environment
You locate an Execution Environment by specifying its type as the OPERAND (BATCH, TSO, or CICS). Overrides to the Execution Environment parameters supplied through the variable length PARM are ignored when locating an Execution Environment.
Sample COBOL Call

 
.
COPY HRNHLWAC.
COPY HRNHLLIST.
.
01 HRN-RGNPARM.
05 RGNPARMLEN PIC 9(4) USAGE COMP-4 VALUE 12.
05 RGNPARMDAT PIC X(12) VALUE 'TDS=HCDL1000'.
 
.
.
.
 
CALL 'HRNHLLTM' USING HRNHLLWA 'STARTEE' 'BATCH'
HRN-RGNPARM HRN-NULL-LIST HRN-NULL-LIST
HRN-RETURN-DATA HRN-RETURN-CODE.
.

 
Sample Non Re-entrant Assembler Call

 
.
CALL HRNHLLTM,(HRNHLLWA,C'STARTEE',C'BATCH', x
PARM,0,0,DATA,CODE),VL
.
.
.
PARM DC AL2(12),C'TDS=HCDL1000'
DATA DS CL159 REASON CODE FROM HRNHLLTM
CODE DS F RETURN CODE FROM HRNHLLTM
.

 
Returned Values
 
STARTEE request succeeded. The first eight bytes of RETURN-DATA are set to the name of the TDS to which your Execution Environment is connected (in the example it would be set to HCDL1000).
Note  The first eight bytes of the RETURN-DATA parameter could be different from what you specified in the TDS parameter—they contain the name of the Data Object Broker to which the active Execution Environment is currently connected.
Advanced STARTEE Batch Usage
To interface with certain kinds of third-party environments, you can create a multiple-session non-blocking batch Execution Environment by specifying an environmental wait routine specific to the third-party environment. Using the assembler interface, you can pass the address of the environmental wait routine to the Execution Environment by specifying an exit descriptor as the ninth parameter to HRNHLLTM. The exit descriptor is mapped by the assembler DSECT called HRNXD and distributed in the MACRO distribution data set. It is of Exit type SESENVWT. In addition, you can pass in an environmental anchor block that can be subsequently accessed by other sessions executing in the Execution Environment.
Additional Information
For an example of setting up an environmental wait routine, refer to the member S6BCAPID, in the ASM data set distributed with TIBCO Object Service Broker. For a complete description of this facility, refer to Chapter 17, Multiple-Session Execution Environments in Batch.

Copyright © TIBCO Software Inc. All Rights Reserved
Copyright © TIBCO Software Inc. All Rights Reserved