EYURWCOM

Note:
Unless otherwise indicated, the data fields described in this section are read-only. Fields that are not described here are reserved for CICSPlex® SM; unpredictable results may occur if these fields are changed.

The format of EYURWCOM is shown in Figure 53.

Figure 53. The EYURWCOM communication area
EYURWCOM         DSECT ,               EYU9WRAM communication area
WCOM_PREFIX     DS   0CL20              EYU9WCOM prefix
WCOM_SLENGTH    DS   AL2                Structure Length
WCOM_ARROW      DS   C                  > delimiter
WCOM_NAME       DS   CL8                EYURWCOM
WCOM_BLANK      DS   C                  Blank
WCOM_PGMNAME    DS   CL8                EYU9WRAM
WCOM_PFX_LEN   EQU  *-WCOM_PREFIX       Length of prefix
 
WCOM_CTYPE        DS   C                Call Type
 
WCOM_ERR_ROUTE    DS   C                Route Selection Error Code
 
WCOM_INIT_CTYPE   DS   C                Initial Call Type.  This field
                                          has meaning if the WCOM_CTYPE
                                          value is WCOM_CTYPE_ERR.  Its
                                          value will be the initial CTYPE
                                          value for the Transaction and
                                          will be either WCOM_CTYPE_SEL
                                         or WCOM_CTYPE_NOT
WCOM_CALLER       DS   CL1              WorkLoad Manager Caller
 
WCOM_REM_SYSID    DS   CL4              Default Remote SYSID
WCOM_REM_TRANID   DS   CL8              Default Remote TRANSID
WCOM_REM_APPLID   DS   CL8              Default Remote APPLID
WCOM_CALL_COUNT   DS   F                Invocation Count
WCOM_INP_BUFF     DS   A                Address of Input Buffer
WCOM_INP_BUFFL    DS   F                Length of Input Buffer
WCOM_TASK_PRIO    DS   H                Task Priority
WCOM_SCLASS       DS   XL4              Task Service Class
WCOM_DYRTYPE      DS   CL1              Request type
WCOM_DYRLPROG     DS   CL8              DPL Program name
WCOM_WORK_AREA    DS   A                Address of WRAM program workarea
WCOM_WORK_LNTH    DS   F                Length of Task Work Area
WCOM_STATUS       DS   C                CPSM Status
WCOM_TERM_TYPE    DS   C                Terminal Type flag
WCOM_FILL3        DS   CL2              Reserved
WCOM_DA_TOKEN     DS   XL4              API Token Value
WCOM_RET_RESP     DS   F                EYU9WRAM result indicator
WCOM_ERR_APPLID   DS   CL8              APPLID of the last selected
                                       AOR if the WCOM_CTYPE indicator
                                       is set to WCOM_CTYPE_ERR
WCOM_ERR_SYSID    DS   CL4              SYSID of the last selected
                                       AOR if the WCOM_CTYPE indicator
                                       is set to WCOM_CTYPE_ERR
WCOM_TRANSID      DS   CL8              Transaction Identifier
WCOM_USERID       DS   CL8              USERID
WCOM_LUNAME       DS   CL17             LUNAME (NETID.NETNAME) blank pad
WCOM_FILL4        DS   CL3              Reserved
WCOM_API_RESP     DS   F                API RESPONSE Code
WCOM_API_REASON   DS   F                API REASON Code
WCOM_SCOP_VECT    DS   A                Address of SCOP_VECT
WCOM_SCOP_CNT     DS   F                Count of elements in SCOP_VECT
WCOM_SEL_AOR      DS   CL8              APPLID of SM_BALANCE AOR
WCOM_SEL_SYSID    DS   CL4              SYSID of SM_BALANCE AOR and the
                                        SM_ROUTE selected target region
WCOM_AFF_STAT     DS   C                Affinity Status
WCOM_DTRTRAN_IND  DS   CL1              DTRTRAN indicator
WCOM_DTRREJ_IND   DS   CL1              DTRTRAN Reject Indicator
WCOM_AFFAOR_STAT  DS   CL1              Affinity AOR status. Defined if
                                        Affinity is active
WCOM_AFF_TYPE     DS   CL1              Transaction Group affinity type
WCOM_AFF_LIFE     DS   CL1              Transaction Group affinity life
 
WCOM_AFF_AUTO     DS   CL1              WLM Automatic affinity create
                                        status
WCOM_FILL5        DS   CL1              Reserved
WCOM_WORK_NAME    DS   CL8              WorkLoad Name
WCOM_TGRP_NAME    DS   CL8              Transaction Group name
WCOM_EVENT_NAME   DS   CL8              Event Name defined in the
                                        Trangroup for this transaction
                                        (Blanks if none)
WCOM_COMMAREA     DS   A                Address of Transaction Commarea
WCOM_COMMAREAL    DS   F                Length of Transaction Commarea
WCOM_PROCESS_NAME  DS  CL36             CICS BTS process name
WCOM_PROCESS_TYPE  DS  CL8              CICS BTS process type
WCOM_PROCESS_ID    DS  CL52             CICS BTS process id
WCOM_ACTIVITY_ID   DS  CL52             CICS BTS activity id
WCOM_ACTIVITY_NAME DS  CL16             CICS BTS activity name
WCOM_PROCESS_COMP  DS  CL1              CICS BTS process completing
WCOM_ACTIVITY_COMP DS  CL1          CICS BTS activity completing
WCOM_LENGTH      EQU  *-EYURWCOM       Length of structure

The EYURWCOM communication area fields are:

WCOM_ACTIVITY_COMP
Specifies whether or not the CICS® BTS activity is completing.
0
The activity is not completing.
1
The activity is completing.
WCOM_ACTIVITY_ID
Specifies the CICS BTS activity id.
WCOM_ACTIVITY_NAME
Specifies the CICS BTS activity name.
WCOM_AFFAOR_STAT
Specifies the status of the affinity target region. This field contains a value only if WCOM_AFF_STAT is set to C (committed) or A (active).
0
The target region is active.
1
The target region is not active.
2
The target region is active, but was shutdown and restarted since the affinity was created.
3
The target region is active, but the link between the TOR and target region is not available.
WCOM_AFF_AUTO
Specifies, as a 1-byte data-value, whether CICSPlex SM creates an affinity during SM_BALANCE.
0
CICSPlex SM does not automatically create an affinity during SM_BALANCE.
1
CICSPlex SM automatically creates an affinity during SM_BALANCE.
2
No affinity is defined for the transaction group.
WCOM_AFF_LIFE
Specifies, as a 1-byte data-value, the affinity lifetime.
0
No affinity is defined.
1
PCONV (pseudoconversational).
2
SIGNON.
3
LOGON.
4
SYSTEM.
5
PERMANENT.
6
DELIMIT.
7
ACTIVITY.
8
PROCESS.
This field corresponds to the Affinity Lifetime field on the Create WLM Specification panel. Refer to page *** for a description of each value.
WCOM_AFF_STAT
Specifies, as a 1-byte data-value, whether an affinity relationship exists.
blank
(Unknown) The affinity cannot be determined at this time.
U
(Undefined) No affinity is defined.
C
(Committed) An affinity is active and will be selected by SM_BALANCE. The affinity cannot be deleted using SM_DELAFF (it has a lifetime of SYSTEM or PERMANENT).
D
(Defined) An affinity is defined and will become active on the next SM_BALANCE call, provided that the workload specification is defined with Create Affinity YES for the transaction group. Alternatively, you can use the SM_CREAFF function to create the affinity.
A
(Active) An affinity is active and can be deleted using SM_DELAFF.
WCOM_AFF_TYPE
Specifies the type of affinity. This field corresponds to the Affinity Relation field on the Create WLM Specification panel. Refer to page Affinity Relation for a detailed description of each value.
0
No affinity is defined for this transaction group.
1
GLOBAL.
2
USERID.
3
LUNAME.
4
BAPPL.
WCOM_API_REASON
Specifies the dynamic routing API reason code. The copybook EYURWCOD contains a list of all available reason codes.
WCOM_API_RESP
Specifies the dynamic routing API response code.
0
Normal response.
1
Invalid request. Check the reason.
2
Parameter error. Check the reason.
3
SM_ROUTE warning. Check the reason.
4
Reserved for SM_ROUTE error.
5
SM_SCOPE warning. Check the reason.
6
Reserved for SM_SCOPE error.
7
SM_BALANCE warning. Check the reason.
8
Reserved for SM_BALANCE error.
9
Disaster.
10
SM_CREAFF warning. Check the reason.
11
Reserved for SM_CREAFF error.
12
Reserved for SM_DELAFF warning.
13
Reserved for SM_DELAFF error.
WCOM_ARROW
Specifies, as a 1-byte data-value, a constant of >.
WCOM_BLANK
Specifies, as a 1-byte data-value, a blank.
WCOM_BRIDGE_TOKEN
Specifies, as an 8-character data-value, the bridge facility token.
WCOM_BUFFL
Specifies the length of the input buffer.
WCOM_CALL_COUNT
Specifies the number of times EYU0WDTR has been invoked for a single transaction. This value is useful in determining when to stop trying to route a transaction or program to a specific target region.
WCOM_CALLER
Specifies the Workload Manager Caller identifier, which may be one of the following:
0
CICS/ESA Relay Program
1
External Service Program
2
Scheduler Services
WCOM_COMMAREA
For CICS/ESA 4.1 and later, provides the address of the transaction communication area. This field is zero for transactions routed by Scheduler Services.
WCOM_COMMAREAL
For CICS/ESA 4.1 and later, provides the length of the transaction communication area. This field is zero for transactions routed by Scheduler Services.
WCOM_CTYPE
Specifies, as a 1-byte data-value, the type of call, which can be:
0
Route selection.
1
Route error.
2
Route termination.
3
Route abend.
4
(Available with CICS/ESA 4.1 and later.) Route notification. Occurs when a transaction is either ATI or is defined as static.
5
Route initiate (occurs only when the caller is Scheduler Services).
6
Route complete (occurs only when the caller is Scheduler Services).
WCOM_DA_TOKEN
Identifies the dynamic routing API token value.
WCOM_DTRREJ_IND
Specifies, for a dynamically routed transaction, whether or not the transaction should be rejected. This indicator may be set by the EYU9WRAM module.
0
The transaction should not be rejected (the default).
1
The transaction should be rejected.
WCOM_DTRTRAN_IND
Specifies whether or not the transaction can be dynamically routed:
0
The transaction cannot be dynamically routed.
1
The transaction can be dynamically routed.
WCOM_DYRLPROG
Start of changeSpecifies an 8-byte data-value. For Dynamic Program Link, this field contains the name of the program to be executed. For Dynamic Transaction Routing, this field contains the name of an alternate program to be loaded if the transaction executes in the local region. For User Service Calls, the value will be returned in the User Service Program Commarea (EYURWTRA) field WTRA_DYRLPROG. This field may be modified, but the modified value will be ignored unless WCOM_CTYPE equals 0 (Route Selection) or 1 (Route Error).End of change
WCOM_DYRTYPE
Specifies the type of routing request:
0
For routing a transaction from a terminal.
1
For notification that an ATI request is to be statically routed.
2
For routing a transaction initiated by an EXEC CICS START command, where there is no data associated with the START.
3
For routing a transaction initiated by an EXEC CICS START command, where there is data associated with the START.
4
For routing, notification, or termination of a program-link request.
5
For routing a CICS BTS request.
6
For routing a non-terminal START request.
7
For routing of an IIOP request.
8
Link3270 bridge requests
Start of change9End of change
Start of changeFor routing, notification, or termination of a program-link request, where there is a channel associated with the program-link.End of change
Start of changeAEnd of change
Start of changeFor routing a transaction initiated by an EXEC CICS START command, where there is a channel associated with the START.End of change
Start of changeBEnd of change
Start of changeFor routing a non-terminal START command, where there is a channel associated with the START.End of change
WCOM_ERR_APPLID
Identifies the APPLID of the last selected target region when the WCOM_CTYPE indicator contains a 1 (for route error).
WCOM_ERR_ROUTE
Specifies, as a 1-byte data-value, the route selection error code.
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 request has timed out.
4
A queue of allocate requests has been purged.
5
Dynamically routed START commands are not supported in the target region
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.
B
The EXEC CICS LINK command returned ROLLBACK.
C
The non-terminal initiated START returned TRANSIDERR.
D
The non-terminal initiated START returned IOERR.
E
The non-terminal initiated START returned USERIDERR.
F
The non-terminal initiated START or EXEC CICS LINK command failed because the RESUNAVAIL (Resource Unavailable) condition was raised by the XICERES or XPCERES CICS Global User Exits.
WCOM_ERR_SYSID
Identifies the SYSID of the last selected target region when the WCOM_CTYPE indicator contains a 1 (for route error).
WCOM_EVENT_NAME
Specifies, as an 8-byte data-value, the event name, if any, defined for the transaction group to which the transaction is associated.
WCOM_INIT_CTYPE
Specifies, as a 1-byte data-value, the initial route selection function if a route error occurs; that is, if the WCOM_CTYPE field value is 1. The value is one of the following:
0
Route selection.
4
Route notification.
WCOM_INP_BUFF
Specifies the address of the input buffer, which contains the data entered with the transaction. The data may be in lowercase or mixed case, unless UCTRAN(YES) is specified on the TYPETERM definition.

For APPC transaction routing, the first 4 bytes of the buffer contain a value that reflects the total length of all the data sent; followed by some or all of the data itself. Note that, depending on the size of the initial TIOA, the buffer may not be big enough to contain all the data.

For non-APPC transaction routing, the buffer contains TIOA terminal data.

WCOM_LUNAME
Identifies the 8-byte logical unit name, preceded by a period (.luname).

Depending on how EYU9XLOP is called, the LUname is set from:

WCOM_NAME
Specifies, as an 8-byte data-value, a constant of EYURWCOM.
WCOM_PFX_LEN
Specifies the length of the prefix area.
WCOM_PGMNAME
Specifies, as an 8-byte data-value, the name of your program.
WCOM_PREFIX
Specifies the start of a 20-character prefix area.
WCOM_PROCESS_COMP
Specifies whether or not the CICS BTS process is completing.
0
The process is not completing.
1
The process is completing.
WCOM_PROCESS_ID
Specifies the BTS process id.
WCOM_PROCESS_NAME
Specifies the BTS process name.
WCOM_PROCESS_TYPE
Specifies the BTS process type.
WCOM_REM_APPLID
Specifies the remote application identifier.
WCOM_REM_SYSID
Specifies the name of the remote system to which the transaction is to be routed.
WCOM_REM_TRANID
Specifies the remote transaction identifier.

Depending on how EYU9XLOP is called, this transaction ID is set from:

For DPL, WCOM_REM_TRANID may be set by EYU9WRAM before the SM_SCOPE call. In this way, you can modify the transaction identifier under which the DPL runs in the target system.

WCOM_RET_RESP
Identifies the response. You can set the contents of this field to one of the following values:
0
Successful.
1
Message issued.
2
Abort.
WCOM_SCLASS
Specifies the task service class
WCOM_SCOP_CNT
Start of changeSpecifies the number of elements in SCOP_VECT that are available.End of change
WCOM_SCOP_VECT
Specifies the address of SCOP_VECT.
WCOM_SEL_AOR
Specifies the APPLID of the target region that was returned by SM_BALANCE or that you set for SM_ROUTE.
WCOM_SEL_SYSID
Specifies the SYSID of the target region that was returned by SM_BALANCE or that you set for SM_ROUTE.
WCOM_SLENGTH
Specifies, as a halfword binary data-value, the length of the EYURWTRA communication area.
WCOM_STATUS
Specifies, as a 1-byte data-value, the status of CICSPlex SM.
0
CICSPlex SM services are available.
1
CICSPlex SM services are not available.
WCOM_TASK_PRIO
Specifies the task priority.
WCOM_TERM_TYPE
Specifies, as a 1-byte data-value, the type of terminal that started the transaction occurrence.
0
LU2.
1
LU6.
2
Logical unit type is unknown.
3
Transaction has no terminal.
WCOM_TGRP_NAME
Specifies, as an 8-byte data-value, the name of the transaction group for this transaction.
WCOM_TRANSID
Specifies, as an 8-byte data-value, the local transaction identifier.

Depending on how EYU9XLOP is called, this transaction ID is set from:

WCOM_USERID
Specifies, as an 8-byte data-value, the user identifier.
WCOM_WORK_AREA
Specifies the address of the EYU9WRAM program work area.
WCOM_WORK_LNTH
Specifies the length of the task work area.
WCOM_WORK_NAME
Specifies, as an 8-byte data-value, the name of the workload specification for this transaction.

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