n is either 1 (true) or 0 (false). The default value is 1.
When SystemHalt is enabled (n = 1), InterSystems IRIS® data platform executes the SYSTEM^%ZSTOP routine entry at instance shutdown. 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 SystemHalt row, select Edit. Select SystemHalt to enable this setting.
Instead of using the Management Portal, you can change SystemHalt 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).
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.
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.