Domain manager domain’s specific gates

Table 41 summarizes the domain manager domain’s specific gates. It shows the level-1 trace point IDs of the modules providing the functions for the gates, the functions provided by the gates, and whether or not the functions are available through the exit programming interface (XPI).

Table 41. Domain manager domain’s specific gates
Gate Trace Function XPI
DMDM
DM 0001
DM 0002
ADD_DOMAIN
QUIESCE_SYSTEM
SET_PHASE
WAIT_PHASE
NO
NO
NO
NO
DMIQ
DM 0003
DM 0004
START_BROWSE
GET_NEXT
END_BROWSE
INQ_DOMAIN_BY_NAME
INQ_DOMAIN_BY_TOKEN
INQ_DOMAIN_BY_ID
NO
NO
NO
NO
NO
NO
DMEN
DM 0210
DM 0211
LISTEN
DELETE
NOTIFY_SMSVSAM_OPERATIONAL
NO
NO
NO

DMEN gate, LISTEN function

The LISTEN function of the DMEN gate is issued to register an interest in an event notification facility (ENF) event. The MVS™ event notification facility is a generalized communication facility which allows subsystems to broadcast notification of events.

If a domain wishes to be notified of particular ENF events, it must register the events that it wishes to be notified of with Domain Manager using the LISTEN interface.

When an ENF event occurs domain manager will invoke the named listen gate of all domains that registered for that event.

Input parameters

EVENT
is the event that the caller is registering an interest in, and can have any of these values:
SMSVSAM_OPERATIONAL
LISTEN_GATE
is the gate number of the gate at which the caller wishes to be notified when the event occurs.

Output parameters

RESPONSE
is DFHDMEN's response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|
PURGED
[REASON]
is returned when response is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
UNKNOWN_EVENT
DUPLICATE_LISTEN

DMEN gate, DELETE function

The DELETE function of the DMEN gate is used to deregister an interest in an ENF event.

If a domain is registered with domain manager for notification of an ENF event and that domain no longer wishes to receive notification of that event then it can deregister its interest in the event using the DELETE interface.

Input parameters

EVENT
is the event which the caller wishes to deregister its interest in. It can have any of these values:
SMSVSAM_OPERATIONAL
LISTEN_GATE
is the gate number of the gate which the caller specified as its listen gate when it registered an interest in this event.

Output parameters

RESPONSE
is DFHDMEN's response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|
PURGED
[REASON]
is returned when response is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION LISTEN_NOT_ACTIVE

DMEN gate, NOTIFY_SMSVSAM_OPERATIONAL function

Domains that have registered their interest in ENF events are invoked at their identified listen gates when the ENF event occurs. A unique DMEN notify function is provided for each event to allow event specific parameters to be specified in a meaningful way.

The NOTIFY_SMSVSAM_OPERATIONAL function of the DMEN gate is used to notify domains which have registered an interest in it of the occurrence of the SMSVSAM operational event.

Input parameters

NOTIFY_PLIST
is a parameter list specific to the ENF event being notified, which was supplied by the subsystem issuing the ENF signal.

Output parameters

RESPONSE
is DFHDMEN's response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|
PURGED
[REASON]
is returned when response is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION RESTART_RLS_FAILED

DMDM gate, ADD_DOMAIN function

The ADD_DOMAIN function of the DMDM gate adds a new domain to the DM table (on the CICS® catalog) of all domains. Because the add is placed on the catalog, it survives system failure. A delete is required to remove the entry.

Input parameters

DOMAIN_NAME
is a unique string, 1 through 8 characters, which is the name of the domain.
PROGRAM_NAME
is a unique string, 1 through 8 characters, which is the name of the initialization module for the specified domain.
DOMAIN_TOKEN
is the unique index that corresponds to the new table entry for the domain.
DOMAIN_ID
is the unique character pair, usually an abbreviated form of the domain name.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|KERNERROR|DISASTER
[REASON]
is returned when RESPONSE is DISASTER or EXCEPTION. Possible values are:
RESPONSE Possible REASON values
DISASTER LOADER_ERROR, ABEND, LOOP
EXCEPTION
DUPLICATE_DOMAIN_NAME
PROGRAM_NOT_FOUND
INSUFFICIENT_STORAGE
DUPLICATE_DOMAIN_TOKEN

DMDM gate, QUIESCE_SYSTEM function

The QUIESCE_SYSTEM function of the DMDM gate is used to call the domain manager to cause a normal shutdown of the system.

Input parameters

None.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|INVALID|KERNERROR|DISASTER
[REASON]
is returned when RESPONSE is DISASTER or INVALID. Possible values are:
RESPONSE Possible REASON values
DISASTER
INSUFFICIENT_STORAGE
ABEND
LOOP
INVALID SYSTEM_INITIALIZING

DMDM gate, SET_PHASE function

When a domain issues SET_PHASE during initialization, it is declaring that it is now prepared to support a given set of services.

When a domain issues SET_PHASE during quiesce, it is asserting that it still needs the set of services identified by that phase number.

The system phase is the minimum of all active domains’ phases during initialization, and the maximum during quiesce.

Input parameters

PHASE
specifies the set of services that are to be available.
STATUS
is either ACTIVE or INACTIVE.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|INVALID|KERNERROR|DISASTER
[REASON]
is returned when RESPONSE is DISASTER or INVALID. Possible values are:
RESPONSE Possible REASON values
DISASTER
ABEND
LOOP
INVALID
SYSTEM_NOT_INITIALIZING
SYSTEM_NOT_QUIESCING
INVALID_PHASE

DMDM gate, WAIT_PHASE function

The WAIT_PHASE function of the DMDM gate is used to wait until the services required to carry on the work are available.

A WAIT_PHASE for a given phase is understood by CICS as a SET_PHASE for at least the phase specified in the phase parameter of WAIT_PHASE.

Input parameters

PHASE
specifies the set of services that are to be available.
STATUS
specifies the required status. It is either ACTIVE or INACTIVE.
[DOMAIN_TOKEN]
specifies the domain. If this is omitted, a wait on the system phase is actioned, rather than for a particular domain.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|KERNERROR|DISASTER
[REASON]
is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible values are:
RESPONSE Possible REASON values
DISASTER
ABEND
LOOP
EXCEPTION DOMAIN_TOKEN_NOT_ACTIVE
INVALID
SYSTEM_NOT_INITIALIZING
SYSTEM_NOT_QUIESCING
INVALID_PHASE

DMIQ gate, START_BROWSE function

The START_BROWSE function of the DMIQ gate is used to create a browse thread. The GET_NEXT function request issued after this command returns the first domain in the active domain list.

Input parameters

None.

Output parameters

BROWSE_TOKEN
is the token identifying this browse session.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|INVALID|KERNERROR|DISASTER
[REASON]
is returned when RESPONSE is DISASTER. Possible values are:
RESPONSE Possible REASON values
DISASTER
ABEND
LOOP

DMIQ gate, GET_NEXT function

The GET_NEXT function of the DMIQ gate is used to return the next available record or an END indication.

Input parameters

BROWSE_TOKEN
is the token identifying this browse session.

Output parameters

DOMAIN_NAME
is a unique string, 1 through 8 characters, which is the name of the domain.
PROGRAM_NAME
is a unique string, 1 through 8 characters, which is the name of the initialization module for the specified domain.
DOMAIN_TOKEN
is the unique index that corresponds to the new table entry for the domain.
DOMAIN_ID
is the unique character pair, usually an abbreviated form of the domain name.
DOMAIN_STATUS
is ACTIVE or INACTIVE.
DOMAIN_PHASE
is the current phase level for that domain.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|KERNERROR|DISASTER
[REASON]
is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible values are:
RESPONSE Possible REASON values
DISASTER
ABEND
LOOP
EXCEPTION END_LIST
INVALID BROWSE_TOKEN_NOT_FOUND

DMIQ gate, END_BROWSE function

The END_BROWSE function of the DMIQ gate is used to release the browse thread at any time.

Input parameters

BROWSE_TOKEN
is the token identifying this browse session.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|INVALID|KERNERROR|DISASTER
[REASON]
is returned when RESPONSE is DISASTER or INVALID. Possible values are:
RESPONSE Possible REASON values
DISASTER
ABEND
LOOP
INVALID BROWSE_TOKEN_NOT_FOUND

DMIQ gate, INQ_DOMAIN_BY_NAME function

The INQ_DOMAIN_BY_NAME function of the DMIQ gate is used to get the domain’s token, ID, status, and phase for the specified domain name.

Input parameters

DOMAIN_NAME
is the unique name of an existing domain.

Output parameters

DOMAIN_TOKEN
is the unique index that corresponds to the table entry for the domain.
DOMAIN_ID
is the unique character pair, usually an abbreviated form of the domain name.
DOMAIN_STATUS
is ACTIVE or INACTIVE.
DOMAIN_PHASE
is the current phase level for that domain.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|INVALID|KERNERROR|DISASTER
[REASON]
is returned when RESPONSE is DISASTER or INVALID. Possible values are:
RESPONSE Possible REASON values
DISASTER
ABEND
LOOP
INVALID DOMAIN_NAME_NOT_FOUND

DMIQ gate, INQ_DOMAIN_BY_TOKEN function

The INQ_DOMAIN_BY_TOKEN function of the DMIQ gate is used to get the domain’s name, ID, status, and phase for the specified domain token.

Input parameters

DOMAIN_TOKEN
is the unique index that corresponds to the table entry for the domain.

Output parameters

DOMAIN_NAME
is a unique string, 1 through 8 characters, which is the name of the domain.
DOMAIN_ID
is the unique character pair, usually an abbreviated form of the domain name.
DOMAIN_STATUS
is ACTIVE or INACTIVE.
DOMAIN_PHASE
is the current phase level for that domain.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|INVALID|KERNERROR|DISASTER
[REASON]
is returned when RESPONSE is DISASTER or INVALID. Possible values are:
RESPONSE Possible REASON values
DISASTER
ABEND
LOOP
INVALID DOMAIN_TOKEN_NOT_FOUND

DMIQ gate, INQ_DOMAIN_BY_ID function

The INQ_DOMAIN_BY_ID function of the DMIQ gate is used to get the domain’s token, name, status, and phase for the specified domain ID.

Input parameters

DOMAIN_ID
is the unique character pair, usually an abbreviated form of the domain name.

Output parameters

DOMAIN_TOKEN
is the unique index that corresponds to the table entry for the domain.
DOMAIN_NAME
is a unique string, 1 through 8 characters, which is the name of the domain.
DOMAIN_STATUS
is ACTIVE or INACTIVE.
DOMAIN_PHASE
is the current phase level for that domain.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|INVALID|KERNERROR|DISASTER
[REASON]
is returned when RESPONSE is DISASTER or INVALID. Possible values are:
RESPONSE Possible REASON values
DISASTER
ABEND
LOOP
INVALID DOMAIN_ID_NOT_FOUND
[[ Contents Previous Page | Next Page Index ]]