CICS implementation of control operator verbs

CICS® supports control operator verbs in a variety of ways.

Some verbs are supported by the CICS master terminal transaction CEMT. The relevant CEMT commands are:

CEMT is normally entered by an operator at a display device. It is described in the CICS Supplied Transactions manual.

The inquire and set operations for connections and modenames are also available at the CICS API, using the following commands:

Programming information about these commands is given in the CICS System Programming Reference manual.

Some control operator verbs are supported by CICS resource definition. The definition of APPC links is described in Defining APPC links. Details of the resource-definition syntax are given in the CICS Resource Definition Guide.

With resource definition online, the CEDA transaction can be used to change some CONNECTION and SESSION options while CICS is running. With macro-level definition, the corresponding options are fixed for the duration of the CICS run.

Control operator verbs

The following tables show how APPC control operator verbs are implemented by CICS. See Return codes for control operator verbs for details of the corresponding return-code mapping.

Note:
Wherever CEMT is shown, the equivalent form of EXEC CICS command can be used.

Table 22. CHANGE_SESSION_LIMIT
CHANGE_SESSION_LIMIT CEMT SET MODENAME
LU_NAME(vble) CONNECTION( )
MODE_NAME(vble) MODENAME( )
LU_MODE_SESSION_LIMIT(vble) AVAILABLE( )
MIN_CONWINNERS_SOURCE(vble) CICS negotiates a revised value, based on the AVAILABLE request and the MAXIMUM value on the DEFINE SESSIONS for the group.
MIN_CONWINNERS_TARGET(vnle) Not supported.
RESPONSIBLE(source) Yes.
RESPONSIBLE(target) Not supported. CICS does not support receipt of RESP(TARGET).
RETURN_CODE Supported.
Table 23. INITIALIZE_SESSION_LIMIT
INITIALIZE_SESSION_LIMIT DEFINE SESSIONS (CICS resource definition)
LU_NAME(vble) CONNECTION( )
MODE_NAME(vble) MODENAME( )
LU_MODE_SESSION_LIMIT(vble) MAXIMUM(value1,)
MIN_CONWINNERS_SOURCE(vble) MAXIMUM( ,value2)
MIN_CONWINNERS_TARGET(vnle) Not supported.
RETURN_CODE Supported.
Table 24. PROCESS_SESSION_LIMIT
PROCESS_SESSION_LIMIT Automatic action by CICS-supplied transaction CLS1 when CNOS is received by a target CICS system.
RESOURCE(vble) Connection RDO.
LU_NAME(vble) Passed internally.
MODE_NAME(vble1,vble2) Passed internally.
RETURN_CODE Supported.
Table 25. RESET_SESSION_LIMIT
RESET_SESSION_LIMIT CEMT SET MODENAME (for individual modegroups) or CEMT SET CONNECTION RELEASED (to reset all modegroups)
LU_NAME(vble) CONNECTION( )
MODE_NAME(ALL) SET CONNECTION( ) RELEASED
MODE_NAME(ONE(vble)) MODENAME( ) AVAILABLE(0)
MODE_NAME(ONE('SNASVCMG')) SET CONNECTION( ) RELEASED
RESPONSIBLE(SOURCE) Yes.
RESPONSIBLE(TARGET) Not supported.
DRAIN_SOURCE(NO|YES) CICS supports YES.
DRAIN_TARGET(NO|YES) CICS supports YES.
FORCE(NO|YES) Not supported.
RETURN_CODE Supported.
Table 26. ACTIVATE_SESSION
ACTIVATE_SESSION CEMT SET MODENAME ACQUIRED (for individual modegroups) or CEMT SET CONNECTION ACQUIRED (for SNASVCMG sessions)
LU_NAME(vble) CONNECTION( )
MODE_NAME(vble) MODENAME( ) ACQUIRED
MODE_NAME('SNASVCMG') Activated when CEMT SET CONNECTION ACQUIRED is issued.
RETURN_CODE Supported.
Table 27. DEACTIVATE_CONVERSATION_GROUP
DEACTIVATE_CONVERSATION_GROUP Not supported.
Table 28. DEACTIVATE_SESSION
DEACTIVATE_SESSION Not supported.
Table 29. DEFINE_LOCAL_LU
DEFINE_LOCAL_LU DEFINE SESSIONS + DFHSIT macro (CICS resource definitions)
FULLY_QUALIFIED_LU_NAME(vble) Cannot be specified. CICS uses the network LU name (APPLID on DFHSIT).
LU_SESSION_LIMIT(NONE) Not supported.
LU_SESSION_LIMIT(VALUE(vble)) Total of MAX(nn) on all sessions.
SECURITY(ADD USER_ID(vble)) In an external security manager (ESM).
SECURITY(ADD PASSWORD(vble)) Not supported; defined in an ESM.
SECURITY(ADD PROFILE(vble)) Not supported; defined in an ESM.
SECURITY(DELETE USER_ID(vble)) Supported in an ESM.
SECURITY(DELETE PASSWORD(vble)) Not supported; defined in an ESM.
MAP_NAME(ADD(vble)) Not supported.
MAP_NAME(DELETE(vble)) Not supported.
BIND_RSP_QUEUE_CAPACITY(YES|NO) Not supported.
Table 30. DEFINE_MODE
DEFINE_MODE EXEC CICS CONNECT PROCESS + MODEENT macro (ACF/VTAM systems definition) + DEFINE SESSIONS (CICS resource definition)
FULLY_QUALIFIED_LU_NAME(vble) Cannot be specified. LU identified via CONNECTION on SESSIONS.
MODE_NAME(vble) MODENAME on SESSIONS is mapped to LOGMODE on MODEENT.
SEND_MAX_RU_SIZE_LOWER_BOUND (vble) Fixed at 8.
SEND_MAX_RU_SIZE_UPPER_BOUND (vble) SENDSIZE on SESSIONS.
PREFERRED_RECEIVE_RU_SIZE (vble) Not supported.
PREFERRED_SEND_RU_SIZE (vble) Not supported.
RECEIVE_MAX_RU_SIZE_LOWER _BOUND (vble) Fixed at 256.
RECEIVE_MAX_RU_SIZE_UPPER _BOUND (vble) RECEIVESIZE on SESSIONS.
SINGLE_SESSION_REINITIATION OPERATOR Not supported.
SINGLE_SESSION_REINITIATION PLU Not supported.
SINGLE_SESSION_REINITIATION SLU Not supported.
SINGLE_SESSION_REINITIATION PLU_OR_SLU Not supported.
SESSION_LEVEL_CRYPTOGRAPHY (NOT_SUPPORTED) Default.
SESSION_LEVEL_CRYPTOGRAPHY (MANDATORY) Not supported.
SESSION_LEVEL_CRYPTOGRAPHY (SELECTIVE) Not supported.
CONWINNER_AUTO_ACTIVATE_LIMIT (vble) MAXIMUM(,value2) on SESSIONS.
SESSION_DEACTIVATED_TP_NAME (vble) Not supported.
LOCAL_MAX_SESSION_LIMIT (vble) MAXIMUM(nn,) on SESSIONS.
Table 31. DEFINE_REMOTE_LU
DEFINE_REMOTE_LU DEFINE CONNECTION (CICS resource definition)
FULLY_QUALIFIED_LU_NAME(vble) Cannot be specified.
LOCALLY_KNOWN_LU_NAME(NONE) Not supported.
LOCALLY_KNOWN_LU_NAME (NAME(vble)) CONNECTION(name)
UNINTERPRETED_LU_NAME(NONE) Defaults to CONNECTION(name).
UNINTERPRETED_LU_NAME (NAME(vble)) NETNAME on CONNECTION.
INITIATE_TYPE(INITIATE_ONLY) Not supported.
INITIATE_TYPE(INITIATE_OR_QUEUE) Not supported.
PARALLEL_SESSION_SUPPORT(YES|NO) SINGLESESS(NO|YES) on CONNECTION.
CNOS_SUPPORT(YES|NO) Always YES.
LU_LU_PASSWORD(NONE) Default on CONNECTION.
LU_LU_PASSWORD(VALUE(vble)) BINDPASSWORD on CONNECTION, or SESSKEY in RACF® APPCLU profile.
SECURITY_ACCEPTANCE(NONE) ATTACHSEC(LOCAL)
SECURITY_ACCEPTANCE (CONVERSATION) ATTACHSEC(VERIFY)
SECURITY_ACCEPTANCE (ALREADY_VERIFIED) ATTACHSEC(IDENTIFY) or ATTACHSEC(PERSISTENT).
Table 32. DEFINE_TP
DEFINE_TP DEFINE TRANSACTION (CICS resource definition)
TP_NAME(vble) TRANSACTION(name)
STATUS(ENABLED) STATUS(ENABLED)
STATUS(TEMP_DISABLED) Not supported.
STATUS(PERM_DISABLED) STATUS(DISABLED)
CONVERSATION_TYPE(MAPPED|BASIC) Supported for all TPs (determined by choice of command).
SYNC_LEVEL(NONE|CONFIRM|SYNCPT) SYNCPT for all TPs (actual level specified on CONNECT PROCESS).
SECURITY_REQUIRED(NONE) Not supported; defined in an ESM.
SECURITY_REQUIRED(CONVERSATION) Not supported; defined in an ESM.
SECURITY_REQUIRED (ACCESS(PROFILE)) Not supported.
SECURITY_REQUIRED (ACCESS(USER_ID)) Not supported; defined in an ESM.
SECURITY_REQUIRED (ACCESS(USER_ID_PROFILE)) Not supported.
SECURITY_ACCESS(ADD(USER_ID(vble))) Transaction can be redefined.
SECURITY_ACCESS(ADD(PROFILE(vble))) Transaction can be redefined.
SECURITY_ACCESS (DELETE(USER_ID(vble))) Transaction can be redefined.
SECURITY_ACCESS (DELETE(PROFILE(vble))) Transaction can be redefined.
PIP(NO) Specified for all TPs.
PIP(YES(vble)) Specified on CONNECT PROCESS.
PIP(NO_LU_VERIFICATION) Default for all PIP data.
DATA_MAPPING(NO|YES) DATA_MAPPING(NO) for all TPs.
FMH_DATA(NO|YES) FMH_DATA(YES) for all TPs.
PRIVILEGE(NONE) Not supported.
PRIVILEGE(CNOS) Not supported.
PRIVILEGE(SESSION_CONTROL) Not supported.
PRIVILEGE(DEFINE) Not supported.
PRIVILEGE(DISPLAY) Not supported.
PRIVILEGE(ALLOCATE_SERVICE_TP) Not supported.
INSTANCE_LIMIT(vble) Not supported.
RETURN_CODE Supported.
Table 33. DELETE
DELETE EXEC CICS DISCARD
LOCAL_LU_NAME(vble) Not supported.
REMOTE_LU_NAME Not supported.
MODE_NAME Not supported.
TP_NAME DISCARD TRANSACTION( )
RETURN_CODE Supported.
Table 34. DISPLAY_LOCAL_LU
DISPLAY_LOCAL_LU CEMT INQUIRE CONNECTION + CEMT INQUIRE MODENAME + CEMT INQUIRE TRANSACTION
FULLY_QUALIFIED_LU_NAME(vble) Cannot be specified in CICS. The APPLID on DFHSIT serves as identifier for the local LU. Specific information can be had by identifying the remote LU. Otherwise, the universal ID * can be used.
LU_SESSION_LIMIT(vble) MAXIMUM on INQ MODENAME.
LU_SESSION_COUNT(vble) ACTIVE on INQ MODENAME
SECURITY(vble) Not available.
MAP_NAMES(vble) Not supported.
REMOTE_LU_NAMES(vble) INQ CONNECTION(*)
TP_NAMES(vble) INQ TRANSACTION(*)
BIND_RSP_QUEUE_CAPABILITY(vble) Not supported.
RETURN_CODE Supported.
Table 35. DISPLAY_REMOTE_LU
DISPLAY_REMOTE_LU CEMT INQUIRE CONNECTION + CEMT INQUIRE MODENAME
FULLY_QUALIFIED_LU_NAME(vble) Cannot be specified; CONNECTION or MODENAME may be used.
LOCALLY_KNOWN_LU_NAME(vble) CONNECTION name.
UNINTERPRETED_LU_NAME(vble) NETNAME on INQ CONNECTION.
INITIATE_TYPE(vble) Not supported.
PARALLEL_SESSION_SUPPORT(vble) SINGLESESS(Y|N) on CEDA VIEW.
CNOS_SUPPORT(vble) Always YES.
SECURITY_ACCEPTANCE_LOCAL_LU (vble) Not available.
SECURITY_ACCEPTANCE_REMOTE_LU (vble) Not available.
MODE_NAMES(vble) CEDA VIEW SESSIONS with locally-known LU name.
RETURN_CODE Supported.
Table 36. DISPLAY_MODE
DISPLAY_MODE CEMT INQUIRE MODENAME + CEMT INQUIRE TERMINAL
FULLY_QUALIFIED_LU_NAME(vble) Cannot be specified.
MODE_NAME(vble) MODENAME.
LOCAL_MAX_SESSION_LIMIT(vble) AVA on CEMT INQ MODENAME.
CONVERSATION_GROUP_IDS(vble) Not supported.
SEND_MAX_RU_SIZE_LOWER_BOUND (vble) Fixed at 8.
SEND_MAX_RU_SIZE_UPPER_BOUND (vble) Not available.
RECEIVE_MAX_RU_SIZE_LOWER_BOUND (vble) Fixed at 256.
RECEIVE_MAX_RU_SIZE_UPPER_BOUND (vble) Not available.
PREFERRED_SEND_RU_SIZE(vble) Not supported.
PREFERRED_RECEIVE_RU_SIZE(vble) Not supported.
SINGLE_SESSION_REINITIATION(vble) Not supported.
SESSION_LEVEL_CRYPTOGRAPHY(vble) Not available.
SESSION_DEACTIVATED_TP_NAME Not supported.
CONWINNER_AUTO_ACTIVATE_LIMIT (vble) Not available.
LU_MODE_SESSION_LIMIT(vble) MAXIMUM on INQ MODENAME.
MIN_CONWINNERS(vble) Not supported.
MIN_CONLOSERS(vble) Not supported.
TERMINATION_COUNT(vble) Not supported.
DRAIN_LOCAL_LU(vble) Not supported.
DRAIN_REMOTE_LU(vble) Not supported.
LU_MODE_SESSION_COUNT(vble) ACTIVE on INQ MODENAME.
CONWINNERS_SESSION_COUNT(vble) Not available.
CONLOSERS_SESSION_COUNT(vble) Not available.
SESSION_IDS(vble) INQ TERMINAL(*).
RETURN_CODE Supported.
Table 37. DISPLAY_TP
DISPLAY_TP CEMT INQUIRE TRANSACTION
TP_NAME(vble) TRANSACTION(tranid)
STATUS(vble) ENABLED/DISABLED.
CONVERSATION_TYPE(vble) CICS TPs allow both types.
SYNC_LEVEL(vble) CICS TPs allow all sync levels.
SECURITY_REQUIRED(vble) Not available.
SECURITY_ACCESS(vble) Not available.
PIP(vble) CICS TPs allow PIP YES and NO.
DATA_MAPPING(vble) Always NO.
FMH_DATA(vble) Always YES.
PRIVILEGE(vble) Not supported.
INSTANCE_LIMIT(vble) Not supported.
INSTANCE_COUNT(vble) CEMT INQ TRAN( )
RETURN_CODE Supported.

Return codes for control operator verbs

The CEMT INQUIRE and SET CONNECTION or MODENAME, and the equivalent EXEC CICS commands, cause CICS to start up the LU services manager asynchronously.

Some of the errors that may occur are detected by CEMT, or the CICS API, and are passed back immediately. Other errors are not detected until a later time, when the LU services manager transaction (CLS1) actually runs.

If CLS1 detects errors, it causes messages to be written to the CSMT log, as shown in Table 38. In normal operation, the CICS master terminal operator may not wish to inspect the CSMT log when a command has been issued. So in general, the operator, after issuing a command to change parameters (for example, SET MODENAME( ) ... ) should wait for a few seconds for the request to be carried out and then reissue the INQUIRE version of the command to check that the requested change has been made. In the few cases when an error actually occurs, the master terminal control operator can refer to the CSMT log.

If CEMT is driven from the menu panel, it is very simple to perform the above sequence of operations.

The message used to report the results of CLS1 execution is DFHZC4900. The explanatory text that accompanies the message varies and is summarized in Table 38. Refer to the CICS Messages and Codes manual for a full description of the message. In certain cases, DFHZC4901 is also issued to give further information.

Table 38. Messages triggered by CLS1
APPC RETURN CODE CICS MESSAGE
OK DFHZC4900 result = SUCCESSFUL
ACTIVATION_FAILURE_RETRY DFHZC4900 result = VALUES AMENDED + DFHZC4901 MAX = 0
ACTIVATION_FAILURE_NO_RETRY DFHZC4900 result = VALUES AMENDED + DFHZC4901 MAX = 0
ALLOCATION_ERROR Checked by CEMT. If allocation fails, SYSTEM NOT ACQUIRED is returned to the operator.
COMMAND_RACE_REJECT DFHZC4900 result = RACE DETECTED
LU_MODE_SESSION_LIMIT_CLOSED DFHZC4900 result = VALUES AMENDED + DFHZC4901 MAX = 0
LU_MODE_SESSION_LIMIT_EXCEEDED DFHZC4900 result = VALUES AMENDED + DFHZC4901 MAX = (negotiated value)
LU_MODE_SESSION_LIMIT_NOT_ZERO DFHZC4900 result = VALUES AMENDED + DFHZC4901 MAX = (negotiated value)
LU_MODE_SESSION_LIMIT_ZERO DFHZC4900 result = VALUES AMENDED + DFHZC4901 MAX = 0
LU_SESSION_LIMIT_EXCEEDED DFHZC4900 result = VALUES AMENDED + DFHZC4901 MAX = (negotiated value)
PARAMETER_ERROR Checked by CEMT.
REQUEST_EXCEEDS_MAX_ALLOWED Checked by CEMT.
RESOURCE_FAILURE_NO_RETRY The LU services manager transaction (CLS1) abends with abend code ATNI.
UNRECOGNIZED_MODE_NAME DFHZC4900 result = MODENAME NOT RECOGNIZED

Related reference
Supported option sets
CICS deviations from APPC architecture
[[ Contents Previous Page | Next Page Index ]]