Skip to main content
Previous sectionNext section

CallinHalt

Allow custom routines during callin close.

Synopsis

[Startup]    CallinHalt=n

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

Description

When CallinHalt is enabled (n = 1), InterSystems IRIS® data platform executes the CALLIN^%ZSTOP routine entry each time an external program ends a CALLIN. When this parameter is not enabled, the routine is not executed.

For more information about CALLIN, see Using The Callin API.

Changing This Parameter

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

Instead of using the Management Portal, you can change CallinHalt in the Config.Startup class (as described in the class reference) or by editing the CPF in a text editor (as described in the Editing the Active CPF section of the “Introduction to the Configuration Parameter File” chapter in this book).

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 in the “Customizing the InterSystem IRIS System” chapter in Specialized System Tools and Utilities.