This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see Why Migrate to InterSystems IRIS?


class %CSP.UI.Portal.CSPSessions extends %CSP.UI.Portal.Template, %CSP.UI.Portal.UtilsNav

System Management Portal - System Operations - CSP Sessions

Property Inventory (Including Private)

Method Inventory (Including Private)


parameter AUTONS = 0;
Do not switch namespace for this page: it needs to stay in %SYS
parameter CSPURL = /csp/sys/op/%CSP.UI.Portal.CSPSessions.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 HELPADDRESS = Home,CSP Sessions;
Inherited description: Each SMP page should set this link which points to the documentation anchor name.
parameter PAGENAME = CSP Sessions;
Displayed name of this page.
parameter RESOURCE = %Admin_Operate;
Security requirement


property FreespacePage as %String;
Property methods: FreespacePageDisplayToLogical(), FreespacePageGet(), FreespacePageIsValid(), FreespacePageLogicalToDisplay(), FreespacePageLogicalToOdbc(), FreespacePageNormalize(), FreespacePageSet()
property msgDoneSession as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("If yes, then click [OK] and the selected sessions will be set to end and the CSP license will be released in a few seconds.") ];
Property methods: msgDoneSessionDisplayToLogical(), msgDoneSessionGet(), msgDoneSessionIsValid(), msgDoneSessionLogicalToDisplay(), msgDoneSessionLogicalToOdbc(), msgDoneSessionNormalize(), msgDoneSessionSet()
property msgEndSession as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Are you sure you want to end the selected sessions?") ];
Property methods: msgEndSessionDisplayToLogical(), msgEndSessionGet(), msgEndSessionIsValid(), msgEndSessionLogicalToDisplay(), msgEndSessionLogicalToOdbc(), msgEndSessionNormalize(), msgEndSessionSet()


Return the array of links to show in the locator bar.
method %OnAfterCreatePage() as %Status
Inherited description: Be sure to do ##super() when overriding.
method %OnGetPageName() as %String
Get the (localized) name of the page. This should be implemented in a subclass.
method DrawProcessID(pTable As %ZEN.Component.tablePane, pName As %String, pSeed As %String) as %Status
classmethod EndSession(selectedRows) as %String [ ZenMethod ]
Delete selected classes now.
method OnDrawRibbon() as %Status
Add to the contents of the tool ribbon.
method OnGetRibbonInfo(Output pDisplay As %Boolean, Output pViewIcons As %List, Output pSortOptions As %List, Output pSearchBox As %Boolean, Output pRibbonTitle As %String, Output pCommands As %List) as %Status
Get information to display in the ribbon bar.
classmethod UpdateAutoRefreshRate(refreshrate As %Integer) [ ZenMethod ]
Save auto refresh rate to server.
classmethod UpdateAutoRefreshState(refreshstate) [ ZenMethod ]
Save auto refresh state to server.
clientmethod doEndSession() [ Language = javascript ]
clientmethod onloadHandler() [ Language = javascript ]
Disable checkboxes for applications that should not allow to be terminated.
clientmethod refreshHandler() [ Language = javascript ]
Table auto-refresh timer handler.
clientmethod setRefreshMode(newMode, notImmediate) [ Language = javascript ]
Turn auto-refresh mode on and off.
clientmethod setRefreshRate(newRate) [ Language = javascript ]
User changed refresh rate. Check the value and save to server.
clientmethod startRefresh() [ Language = javascript ]
Based on user's choice, start or stop the timer.
clientmethod updateView() [ Language = javascript ]
Update table.

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)