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.Locks extends %CSP.UI.Portal.Utils

System Management Portal - System Operations - Locks

Property Inventory

Method Inventory


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


property colProcess as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Remove_all_locks_for_process") ];
Store translated targetCol linkCaption for
Property methods: colProcessDisplayToLogical(), colProcessGet(), colProcessIsValid(), colProcessLogicalToDisplay(), colProcessLogicalToOdbc(), colProcessNormalize(), colProcessSet()
property colRemoteClient as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Remove_all_locks_from_remote_client") ];
Property methods: colRemoteClientDisplayToLogical(), colRemoteClientGet(), colRemoteClientIsValid(), colRemoteClientLogicalToDisplay(), colRemoteClientLogicalToOdbc(), colRemoteClientNormalize(), colRemoteClientSet()


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.
classmethod InTransaction(DeleteID) as %String [ ZenMethod ]
This method is called to check whether a local lock is currently in an option transaction.
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 RemoveLocks(DeleteID, RemoveAllLocksForProcess) as %ZEN.proxyObject [ ZenMethod ]
Remove locks from server. If RemoveAllLocksForProcess, then DeleteID is PID. OW DeleteID contains three pieces lock reference delimited by comma.
clientmethod displayroutine(value) [ Language = javascript ]
Toggle for displaying routine information.
clientmethod doRemove(DeleteID, RemoveAll, RemoteOwner) [ Language = javascript ]
Remove a lock. If "RemoveAll" is 1 then all locks for that process is removed. If RemoveAll is 0, then DeleteID is the lock reference. If RemoveAll is 1, then DeleteID is the Pid/Client or Owner.
clientmethod doRemoveRemote(DeleteID, RemoveAll, RemoteOwner) [ Language = javascript ]
To remove all remote add "C" as preface.
clientmethod filterChanged(value) [ Language = javascript ]
User entered something in to the filter. Re-load the table with filter value.
clientmethod updateView() [ Language = javascript ]
Update table.

Inherited Members

Inherited Properties

Inherited Methods