Skip to main content


Allow custom routines during foreground process shutdown.


[Startup]    ProcessHalt=n

n is either 1 (true) or 0 (false). The default value is 1.


When ProcessHalt is enabled (n = 1), InterSystems IRIS® data platform executes the LOGIN^%ZSTOP routine entry at foreground process logout (such as when a user closes the terminal). When this parameter is not enabled, the routine is not executed.

Changing This Parameter

On the Startup page of the Management Portal (System Administration > Configuration > Additional Settings > Startup), in the ProcessHalt row, select Edit. Select ProcessHalt to enable this setting.

Instead of using the Management Portal, you can change ProcessHalt in the Config.StartupOpens in a new tab class (as described in the class reference) or by editing the CPF in a text editor (as described in Editing the Active CPF).

See Also

ProcessStart and ProcessHalt correspond to foreground processes. These are processes that are started via a terminal session or are specifically set to run in the foreground.

JobStart and JobHalt correspond to background processes. This includes any processes that are started via the JOB command, plus any background server processes including ODBC or any of the object bindings.

SystemStart and SystemHalt correspond to InterSystems IRIS instance startup or shutdown.

CallinStart and CallinHalt correspond to external programs performing a CALLIN.

For more information about all these parameters, see Customizing Start and Stop Behavior with ^%ZSTART and ^%ZSTOP.

FeedbackOpens in a new tab