OSI/MHS SCF Reference Manual

OSI/MHS SCF Commands
OSI /MHS SCF Reference Manual424828-001
2-205
SUSPEND APPL Command
SUSPEND APPL Command
The SUSPEND APPL command causes the APPL object to enter the SUSPENDED
state. In the suspended state, the application is prevented from submitting messages and
probes, and the OSI/MHS subsystem treats messages arriving for the application as
being nondeliverable. Pre-existing messages can be read or deleted, however. To issue
this command, the object must be in the STARTED state. This is a sensitive command.
OUT file-spec
directs any SCF output generated for this command to the specified file.
[\psystem.]$proc.#applname
is the name of the APPL object you want to suspend.
NORMAL | FORCED
are power modifiers that you can specify with the SUSPEND APPL command.
These modifiers are valid only for MS APPL objects. The NORMAL power
modifier specifies that the APPL object is suspended only when it is logged off the
OSI/MHS subsystem. The FORCED power modifier specifies that the APPL object
is suspended regardless of whether or not it is logged on to the OSI/MHS
subsystem.
Considerations
To reverse the effects of the SUSPEND command, use the ACTIVATE command.
The SUSPENDED state disallows MS applications from transmitting or receiving
messages using this application name. Pre-existing messages can be read or deleted,
however. Suspending an MS application and processing its existing messages is
preparatory to deleting it.
When the MS APPL is in the SUSPENDED state, incoming messages for the APPL
object will be rejected with an NDN (non-delivery notification).
The SUSPENDED state is not intended to be used for reconfiguration. ALTER
APPL is not supported for this state, since applications can continue to be logged on
and to access the database while in the SUSPENDED state. Any altered retrieval
parameters will not take effect since the message retrieval parameters are retrieved
only during logon.
Example
This command causes APPL object $ZMHS.#APPL1 to enter the SUSPENDED state:
SUSPEND APPL $ZMHS.#APPL1, FORCED
SUSPEND [ / OUT file-spec / ] APPL [\psystem.]$proc.#applname
[ , { NORMAL | FORCED } ]