Skip to main content


class %CSP.UI.Portal.Dialog.ProcessTerminate extends %CSP.UI.Portal.Dialog.WizardTemplate

This class is used internally by InterSystems IRIS. You should not make direct use of it within your applications. There is no guarantee made about either the behavior or future operation of this class.

Process Terminate dialog for Management Portal.

Property Inventory

Method Inventory


parameter APPLICATION = %CSP.UI.Portal.Application;
Class name of application this page belongs to.
parameter APPLYBUTTON = 0;
If true, then this dialog displays an Apply button.
parameter AUTONS = 0;
Inherited description: If $NAMESPACE is set, auto switch namespace
parameter CSPURL = /csp/sys/op/%CSP.UI.Portal.Dialog.ProcessTerminate.zen;
Inherited description: This parameter is used to make sure that if multiple CSP applications are mapped to the same namespace that the CSP engine can correctly identify which class corresponds with which URL. If 'LockCSPName' is true (the default, defined in the CSP application) then you can only access this page if the url exactly matches this 'CSPURL'. You can set this parameter to "" if you wish to disable this check for this class. This check is applied for all CSP urls (cls/csp/zen).
If this page was compiled from a .csp file, then this parameter is automatically set to contain the url of this file used for compilation.
parameter PAGENAME = TerminateProcess;
Displayed name of this page.
parameter RESOURCE = %Admin_Operate:USE;
Inherited description: This is a comma-delimited list of system Resources and associated permissions. A user must hold the specified permissions on at least one of the specified resources in order to view this page or invoke any of its server-side methods from the client.
The format of each item in the list should be as follows:
Permission is optional, and defaults to USE if not supplied. If it is supplied, it should be one of USE, READ or WRITE.


property DISPLAYID as %String (ZENURL = "DISPLAYID");
Property methods: DISPLAYIDDisplayToLogical(), DISPLAYIDGet(), DISPLAYIDIsValid(), DISPLAYIDLogicalToDisplay(), DISPLAYIDLogicalToOdbc(), DISPLAYIDNormalize(), DISPLAYIDSet()
property PID as %String (ZENURL = "PID");
Property methods: PIDDisplayToLogical(), PIDGet(), PIDIsValid(), PIDLogicalToDisplay(), PIDLogicalToOdbc(), PIDNormalize(), PIDSet()


method %OnGetSubtitle() as %String
Get the (localized) subtitle string for the dialog. This should be implemented in a subclass.
method %OnGetTitle() as %String
Get the (localized) title string for the dialog. This should be implemented in a subclass.
classmethod DrawPageTitle(pSeed As %String) as %Status
classmethod StartTerminate(PID, DISPLAYID, chkResjob) as %String [ ZenMethod ]
Process Termination. If failed, return error message. Otherwise, return 1.
clientmethod doTerminate() [ Language = javascript ]
Use clicked the Terminate button. Process it. If successful, close this dialog and the Process Details page, and then refresh the Process list page.
clientmethod getDialogValue() [ Language = javascript ]
Inherited description: Get the value that will be applied when the user presses the OK button. This is implemented by subclasses.
clientmethod onstartHandler() [ Language = javascript ]
This is called when the template is first displayed; This provides a chance to set focus etc.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab