INQUIRE WORKREQUEST

Retrieve information about work requests in the local CICS region.

Read syntax diagramSkip visual syntax diagramINQUIRE WORKREQUEST
 
>>-INQUIRE WORKREQUEST(data-value)------------------------------>
 
>--+-------------------------+---------------------------------><
   +-WORKTYPE(cvda)----------+
   +-CLIENTIPADDR(data-area)-+
   +-CORBASERVER(data-area)--+
   +-LISTENERPORT(data-area)-+
   +-OAPPLID(data-area)------+
   +-OTASK(data-area)--------+
   +-OTRANSID(data-area)-----+
   +-REQUESTID(data-area)----+
   +-STACK(data-area)--------+
   +-TASK(data-area)---------+
   +-TRANSID(data-area)------+
   '-TSYSTEM(data-area)------'
 

Conditions:  ILLOGIC, NOTAUTH, NOTFND

This command is threadsafe.

For more information about the use of CVDAs, see CICS-value data areas (CVDAs).

 

Description

The INQUIRE WORKREQUEST command allows you to track tasks that are started as a result of action by a request receiver.

A listener region in CICS is an example of a RequestReceiver. A single RequestReceiver can start one RequestProcessor which in turn can start more RequestReceivers or RequestProcessors.

The RequestReceiver and RequestProcessor relationship is not the same as any other type of transaction relationship. A RequestReceiver need not remain in the system after it has initiated a RequestProcessor; if there are no more requests to be received it terminates. A RequestProcessor may create RequestReceivers during the course of its processing - outbound and loopback requests.

INQUIRE WORKREQUEST enables you to inquire about a single work request in the local region, or to browse through all the work requests in the local region. The information returned by INQUIRE WORKREQUEST allows you to:

Work Requests are identified by tokens. Each token is unique in the local system for the lifetime of the request, but subsequently, tokens can be reused.

Browsing

You can use the browse options (START, NEXT, and END) on INQUIRE WORKREQUEST commands, to browse through all of the work requests present in the local region. See Browsing resource definitions for general information about browsing, including syntax, exception conditions, and examples.

The work requests are not returned in a defined order, so you cannot use START AT to specify a start point.

Options

CLIENTIPADDR(data-area)
specifies the TCPIP address of the client that originated the request as a 15-character value.
CORBASERVER(data-area)
specifies the name of the CorbaServer as a 4-character value.
LISTENERPORT(data-area)
returns, in fullword binary form, the host port that received the request.
OAPPLID(data-area)
specifies the applid of the originating task as an 8-character value.
OTASK(data-area)
returns, in packed decimal form, the number of the task (RequestReceiver) that received the request.
OTRANSID(data-area)
specifies as a 4-character value, the transaction id that received the request.
REQUESTID(data-area)
returns, in fullword binary form, the current request. A client can send more than one request at a time.
STACK(data-area)
returns, in fullword binary, the stack level of this call.

Each time a request receiver creates a work request it sets up a stack, and records a value of ‘1’. Then, when the request receiver issues a method request it increments the stack, and each time that a bean in this "chain of requests" issues a method request to another bean it increments this stack. There is one stack created for each request receiver, and the stack applies across the sysplex. The stack is decremented each time a bean that has incremented it terminates.

TASK(data-area)
returns, in packed decimal form, the number of the local task (RequestProcessor).
TRANSID(data-area)
specifies the local transaction id - 4 character
TSYSTEM(data-area)
specifies the applid of the target CICS system as a 21-byte field. This field may contain one of the following:
  • the dotted decimal TCPIP address and port number of the target system
  • up to eight characters followed by blanks. In this case these 8-characters, or less, are the VTAM applid of the target system
  • If the field contains only a string of blank characters (spaces), the target is not CICS over MRO
  • Another value. CICS does not know about any other possibilities. Any other value must be meaningful to other software at your installation which expects to work with the value obtained from this parameter of this CICS command
WORKREQUEST(data-value)
specifies, as an 8-character field, a token to identify the work request.Valid characters are the 16 hex digits 0-9, A-F. Start of changeThe token is generated by CICS. Normal usage begins with an INQUIRE WORKREQUEST BROWSE command, to identify the token which is of interest. Then the specific token can be used to issue INQUIRE and SET commands that relate to the task in question.End of change
WORKTYPE(cvda)
specifies the type of work being performed. CVDA values are:
Start of change
IIOP
Specifies that the work is being executed for an IIOP request.
SOAP
Specifies that the work is being executed for a Web service request.
End of change

Conditions

END
RESP2 values:
2
There are no more work requests of this type present.
ILLOGIC
RESP2 values:
1
You have issued a START command when a browse of work requests is already in progress, or you have issued a NEXT or an END command when a browse of work requests is not in progress.
NOTAUTH
RESP2 values:
100
The user associated with the issuing task is not authorized to use this command.
NOTFND
RESP2 values:
3
The specified work request is not present in the system.
[[ Contents Previous Page | Next Page Index ]]