ALLOCATE (MRO)

Description

ALLOCATE acquires an alternate facility. CICS® makes available to the application program one of the sessions associated with the system named in the SYSID option. The name of this session can be obtained from EIBRSRCE in the EIB.

If the session requested is not available, the application is suspended until the session does become available. In such a case, the suspension of the application can be prevented by specifying the NOQUEUE option.

For more information about MRO and IRC, see Introduction to CICS intercommunication.

Options

NOQUEUE

overrides the default action when a SYSBUSY condition arises. This condition indicates that the session requested is not immediately available. The default action is to suspend application execution until the session is available. NOQUEUE inhibits this waiting; control returns immediately to the application program instruction following the command.

Note, however, that if a HANDLE CONDITION for SYSBUSY is active when the command is executed, this also overrides the default action, and control is passed to the user label supplied in the HANDLE CONDITION. This takes precedence over the NOQUEUE option but is, of course, negated by either NOHANDLE or RESP.

PROFILE(name)

specifies the name (1–8 characters) of a set of session-processing options that are to be used during execution of terminal control commands for the session specified in the SYSID option. If the PROFILE option is omitted, a default profile (DFHCICSA) is selected.

STATE(cvda)

gets the state of the current conversation. The cvda value returned by CICS is ALLOCATED.

SYSID(systemname)

specifies the name (1–4 characters) of a system TCTSE. This option specifies that one of the sessions to the named system is to be allocated.

Conditions

16 INVREQ

occurs if an incorrect command has been issued for the LU or terminal in use.

Default action: terminate the task abnormally.

59 SYSBUSY

occurs if the request for a session cannot be serviced immediately. This is only possible if the NOQUEUE option is set, or a HANDLE CONDITION for SYSBUSY is active.

Default action: ignore the condition.

53 SYSIDERR

occurs if CICS is unable to provide the application program with a suitable session, for one of the following reasons:

• The name specified in the SYSID option is not recognized by CICS.
• All sessions are out of service.
• The AID (automatic initiate descriptor) representing your ALLOCATE has been canceled.
• All the sessions are busy and the (queued) allocates have been purged or rejected.

Default action: terminate the task abnormally.