EYURWTRA

The format of EYURWTRA is shown in Figure 55.

Start of changeFigure 55. The EYURWTRA communication area
EYURWTRA       DSECT ,                 Workload MGR DR COMM area			
WTRA_PREFIX    DS   0CL20              WTRA  prefix								I
WTRA_SLENGTH   DS   AL2                Structure Length
WTRA_ARROW     DS   C                  > delimiter
WTRA_NAME      DS   CL8                EYURWTRA
WTRA_BLANK     DS   C                  Blanks
WTRA_PGMNAME   DS   CL8                name of calling service pgm.
WTRA_PFX_LEN   EQU  *-WTRA_PREFIX      Length of prefix
WTRA_FUNC      DS   C                  Function ID								I
WTRA_DYRTYPE   DS   C                  Request type								I
WTRA_DYRLPROG  DS   CL8                DPL program name						IO
WTRA_ERR       DS   C                  Error type if Route Error			I
WTRA_OPTER     DS   C                  Call Back Option.						O
               DS   C                  Reserved.
WTRA_RESPONSE  DS   F                  Response									O
*                                      0 = Normal
*                                      8 = ABORT
WTRA_BUFFADDR  DS   F                  Address of input buffer				I
WTRA_BUFFLNTH  DS   F                  Length of input buffer				I
WTRA_TRANID    DS   CL8                Transaction Identifier				IO
WTRA_USERID    DS   CL8                USERID										I
WTRA_TERMID    DS   CL4                Principal Facility ID				I
                                       - normally obtained from
                                         EIBTRMID
WTRA_APPLID    DS   CL8                APPLID of default/	
														selected target region				IO
WTRA_SYSID     DS   CL4                SYSID of default/
														selected target region				IO
WTRA_LUNAME    DS   CL17               LUNAME to use							I
               DS   CL3                Reserved
WTRA_NEXTTRAN  DS   CL8                The Identifier of the				I
                                       Transaction which will be
                                       executed after the current one
                                       completes.  This should be set
                                       prior to calling using the	
                                       Route Termination Function.
WTRA_API_RESP  DS   F                  Last API RESPONSE to WRAM			O
WTRA_API_REAS  DS   F                  Last API REASON to WRAM				O
WTRA_COMMAREA  DS   A                  COMMAREA address (0 if none)		I
WTRA_COMMAREAL DS   F                  COMMAREA length (0 if none)		I
               DS   XL16               Reserved.
WTRA_USERAREA  DS   CL128              128 byte user area for use by 	IO
                                       routing exit.
WTRA_LENGTH   EQU  *-EYURWTRA          Length of communication area
Note:
I indicates that a field is used for input, O indicates that a field is used for output, and IO indicates the field can be used for input and output. Fields that are not described here are reserved for CICSPlex® SM. Unpredictable results may occur if these fields are changed.
End of change

WTRA_API_REAS
Specifies a value of zero (0).
Notes:
  1. The WTRA_TRANID, WTRA_USERID, and WTRA_LUNAME fields are used by CICSPlex SM workload management to identify an appropriate transaction group and target scope list for the unit of work. The scope list identifies the set of target regions to which the unit of work can be routed. These fields (TRANID, USERID, and LUNAME) are passed to the CICSPlex SM workload management routing action module (EYU9WRAM) along with an indication that the caller is an external program. The default route action processing does not make use of the fields, but a customized version of EYU9WRAM may.
  2. If the transaction group identified for the unit of work defines an affinity, the values in the WTRA_USERID, WTRA_TERMID, and WTRA_LUNAME fields may appear as part of an affinity key on the WLMATAFF view. For this reason, you may want to specify values that are readable on a display terminal.

OR

Specifies, as a fullword binary data-value, the last reason code returned to the EYU9WRAM routing action process. You should inspect this field when the WTRA_RESPONSE field does not contain a return code of zero (0). This field, in conjunction with the WTRA_API_RESP field, describes why the function failed.

WTRA_API_RESP
Specifies a value of zero (0).

OR

Specifies, as a fullword binary data-area, the last response code returned to the EYU9WRAM routing action process. You should inspect this field when the WTRA_RESPONSE field does not contain a return code of zero (0). This field, in conjunction with the WTRA_API_REAS field, describes why the function failed.

WTRA_APPLID
Specifies, as an 8-byte data-value, the application ID of the selected target region, provided that the WTRA_RESPONSE field contains a return code of zero (0).
WTRA_ARROW
Specifies, as a one-byte data-value, a constant of >. This field must be set before calling EYU9XLOP,
WTRA_BLANK
Specifies, as a one-byte data-value, a blank space. This field must be set before calling EYU9XLOP,
WTRA_BRIDGE_TOKEN
Specifies, as an 8-character data-value, the bridge facility token.
WTRA_BUFFADDR
Specifies, as a fullword binary data-value, the address of the buffer to be passed to the starting transaction.
WTRA_BUFFLNTH
Specifies, as a fullword binary data-value, the length of the buffer to be passed to the starting transaction.
WTRA_DYRLPROG
Specifies, as an 8-character data-value, the name of the DPL program.
WTRA_DYRTYPE
This field, which must be set before calling EYU9XLOP, specifies, as a 1-byte data-value, the request type:
0
The request type is dynamic transaction routing.
1
The request type is Notify,
2
The request type is a dynamic START command.
3
The request type is a dynamic START command with data.
4
The request type is a dynamic program link.
5
The request type is CICS® BTS request routing.
6
The request type is a non-terminal START command.
7
The request type is an IIOP request.
8
Link3270 bridge requests
Start of change9End of change
Start of changeThe request type is a dynamic program link with channel.End of change
Start of changeAEnd of change
Start of changeThe request type is a dynamic START command with channel.End of change
Start of changeBEnd of change
Start of changeThe request type is a non-terminal START command with channel.End of change
WTRA_ERR
Specifies, as a one-byte data-value, the reason for the error. This field is valid when the WTRA_FUNC field indicates a routing error (1(. This field may be one of the following:
0
The selected sysid is unknown.
1
The selected sysid is not in service.
2
The selected system is in service, but no sessions are available.
3
The allocate sessions request was rejected.
4
A queue of allocate requests has been purged.
5
The selected system does not support this function.
6
The EXEC CICS LINK command returned LENGERR.
7
The EXEC CICS LINK command returned PGMIDERR.
8
The EXEC CICS LINK command returned INVREQ.
9
The EXEC CICS LINK command returned NOTAUTH.
A
The EXEC CICS LINK command returned TERMERR.
WTRA_FUNC
Specifies, as a one-byte data-value, the routing function, which identifies the reason CICSPlex SM workload management is being invoked. This field may be one of the following:
0
For route selection.
1
When an error occurs in route selection or a previous route error.
2
For route termination.
3
To notify CICSPlex SM workload management that the transaction should be routed to the named APPLID.
4
To notify CICSPlex SM workload management that the routed transaction abended.
WTRA_LUNAME
Specifies a logical unit name that CICSPlex SM workload management should use to classify the unit of work. This LUNAME might also be used to construct workload affinities.

An LUNAME usually consists of a period (.) followed by the netname of the terminal from which the transaction was initiated. Since there may be no terminal associated with the transaction that is invoking CICSPlex SM workload management (or if there is, it may not be one you want to use), you can initialize this field with any string of characters. Be careful, however, not to include a question mark (?), plus sign (+), or asterisk (*) in the string; these characters indicate a generic name, which is not supported.

WTRA_NAME
Specifies, as an 8-byte data-value, a constant of EYURWTRA.
WTRA_NEXTTRAN
Specifies, as an 8-btye data-value, the name of a transaction to be invoked after the current transaction is complete. If there is no next transaction, set the field to all blanks.
WTRA_OPTER
Specifies, as a one-byte data-value, the call back option, as one of the following:
0
Call CICSPlex SM workload management back with a route termination function (WTRA_FUNCTRM).
1
Do not call CICSPlex SM workload management back with a route termination function.
WTRA_PREFIX
Specifies the start of a 20-character prefix area.
WTRA_PFX_LEN
Specifies the length of the prefix area.
WTRA_PGMNAME
Specifies, as an 8-byte data-value, the name of the program invoking EYU9XLOP.
WTRA_RESPONSE
Specifies, as a fullword binary data-value, the return code, as one of the following:
0
Continue processing.
8
Terminate processing.
WTRA_SLENGTH
Specifies, as a halfword binary data-value, the length of the EYURWTRA communication area. This field must be set before calling EYU9XLOP,
WTRA_SYSID
Specifies the system ID of the CICS system that will serve as the default target region.

OR

Specifies, as a 1-byte data-value, the system ID of the selected target region, provided that the WTRA_RESPONSE field contains a return code of zero (0).

WTRA_TERMID
Specifies a terminal ID that can be used to construct workload affinities. This terminal ID need not be defined to CICS.

This field usually contains the CICS facility ID. Since this may not be appropriate for your use, you should initialize the field to your own value.

WTRA_TRANID
Specifies, as a 4-byte data-ref, a transaction ID that CICSPlex SM workload management should use to classify the unit of work. This transaction ID need not be defined to CICS.
WTRA_USERID
Specifies a user ID that CICSPlex SM workload management should use to classify the unit of work. This user ID might also be used to construct workload affinities. It need not be defined to CICS.

For a list of the possible response and reason code values that can be returned in WTRA_API_RESP and WTRA_API_REAS, refer to the assembler copy book member EYURWCOD.

Related concepts
Sample source programs and copy books
Related reference
EYURWCOM
EYURWSVE
[[ Contents Previous Page | Next Page Index ]]