Class %CSP.UI.Portal.CSPSessions

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

System Management Portal - System Operations - CSP Sessions

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
5	3	16

Summary

This is a Zen Page class. It belongs to the application %CSP.UI.Portal.Application.

Properties
%condition	%import	%includeFiles	%page
%resource	FreespacePage	HelpAddress	ISREADONLY
LocatorHeader	ParentURL	StdTitle	aboutPage
align	aux	backgroundTimerInterval	cellAlign
cellSize	cellStyle	cellVAlign	children
composite	containerStyle	cssLevel	currSortMode
currStep	currViewMode	disabled	dragAndDrop
dragEnabled	dropEnabled	enclosingClass	enclosingStyle
error	groupClass	groupStyle	height
hidden	hint	hintClass	hintStyle
home	homePage	id	index
label	labelClass	labelDisabledClass	labelPosition
labelStyle	layout	lblTitle	msgDoneSession
msgEndSession	name	onafterdrag	onbeforedrag
onclick	ondrag	ondrop	onhide
onrefresh	onshow	onupdate	pageModified
parent	searchKey	showLabel	slice
title	tuple	useSVG	useSoftModals
valign	visible	width	window
zenPersistentPopup

Methods
%%OIDGet	%AddChild	%AddChildAfter	%AddChildBefore
%AddComponent	%AddImportedComponents	%AddLocatorLinks	%AddToSaveSet
%ApplyURLParms	%Attr	%BindExport	%ClassIsLatestVersion
%ClassName	%ConstructClone	%DispatchClassMethod	%DispatchGetModified
%DispatchGetProperty	%DispatchMethod	%DispatchSetModified	%DispatchSetMultidimProperty
%DispatchSetProperty	%DrawAutoLogout	%DrawClassDefinitions	%DrawComponentHTML
%DrawHTML	%DrawHTMLPage	%DrawJSStrings	%DrawObjectDefinitions
%EnclosingDivId	%EndBackgroundMethod	%EndScript	%Eval
%Extends	%ForceClientRender	%GetChildIndex	%GetComponent
%GetComponentById	%GetComponentByName	%GetEventHandlers	%GetHomePage
%GetHomeParam	%GetLinks	%GetLocatorLinks	%GetPageName
%GetParameter	%GetProductName	%GetValueById	%GetValueByName
%GetXMLName	%IsA	%IsModified	%Link
%LinkCSS	%LinkScript	%MakeId	%New
%NormalizeObject	%ObjectModified	%OnAddToPageAfter	%OnAddToPageBefore
%OnAfterCreatePage	%OnBeforeCreatePage	%OnCreateApplication	%OnCreatePage
%OnDetermineCSSLevel	%OnDrawEnclosingDiv	%OnDrawHTMLBody	%OnDrawHTMLHead
%OnDrawHTMLMeta	%OnDrawObjectProperties	%OnFinishBackgroundTask	%OnGetPageName
%OnGetProductName	%OnGetSmallMenu	%OnGetTitle	%OnMonitorBackgroundTask
%OnMutateChildren	%OnObjectSynch	%OnPreHTTP	%OnSubmit
%OnUseSoftModals	%OnZENDeserialize	%OriginalNamespace	%PackageName
%QuoteValue	%QuoteValueL10N	%Register	%RemoveChild
%RemoveChildren	%RemoveComponent	%RemoveFromSaveSet	%RunBackgroundMethod
%Self	%SerializeObject	%SetBackgroundMethodStatus	%SetErrorById
%SetErrorByName	%SetModified	%SetValueById	%SetValueByName
%SetValuesByName	%StartScript	%ValidateObject	%ZENVersion
BuildMenu	CheckAllBlanks	ConvertParameter	Decrypt
DoLogout	DrawLocator	DrawProcessID	DrawRibbon
DrawTitle	Encrypt	EndSession	EscapeHTML
EscapeURL	GetCSPURL	GetContextLinks	GetDocPage
GetHomePage	GetNewURL	GetQuickLinks	HyperEventBody
HyperEventCall	HyperEventFrame	HyperEventHead	Include
InsertHiddenField	InsertHiddenFields	IsPrivate	Link
OnDrawRibbon	OnGetRibbonInfo	OnHTTPHeader	OnPage
OnPageError	OnPostHTTP	OnPostHyperEvent	OnPreHTTP
OnPreHyperEvent	Page	QuoteJS	RegisterRecent
RewriteURL	ShowError	StartTimer	StopTimer
ThrowError	UnescapeHTML	UnescapeURL	UpdateAutoRefreshRate
UpdateAutoRefreshState	XMLDTD	XMLExport	XMLExportToStream
XMLExportToString	XMLNew	XMLSchema	XMLSchemaNamespace
XMLSchemaType	ZStripW	addChild	addChildAfter
addChildBefore	cancelPopup	changePassword	childrenMutated
correctIELayering	createComponent	createComponentNS	deleteComponent
doEndSession	dragFinishHandler	dragHandler	dragNotifyHandler
dragStartHandler	dropHandler	dropStartHandler	endModal
exposeComponent	findElement	fireOnLoadEvent	fireOnResizeEvent
fireOnUnloadEvent	fireOnUpdateEvent	firePopupAction	getChildIndex
getComponent	getComponentById	getEnclosingDiv	getHidden
getHintElement	getLabelElement	getOpener	getProperty
getSettings	getTitleAreaHeight	getType	goHome
goMenu	gotoNamespace	gotoPage	invokeSuper
isOfType	launchPopupWindow	logout	makeId
navigate	onCreate	onDelete	onDisplayHandler
onEndModalHandler	onPopupAction	onRefreshContents	onSerialize
onServerMethodCall	onServerMethodError	onServerMethodReturn	onStartModalHandler
ondisabledHandler	onkeydownHandler	onkeyupHandler	onlayoutHandler
onloadHandler	onlogoutHandler	onoverlayHandler	onresizeHandler
onunloadHandler	onupdateHandler	popupActionHandler	refreshContents
refreshHandler	removeChild	render	renderContents
renderSVG	resetMsg	searchBlur	searchBoxHandler
searchFocus	searchKeyDown	searchKeyPress	setComponentId
setHidden	setModified	setOverlayMode	setProperty
setPropertyAll	setRefreshMode	setRefreshRate	setSortMode
setSortModeHandler	setTraceOption	setViewMode	setViewModeHandler
showAbout	showDocumentation	showHelp	showMsg
startModal	startProgressBar	startRefresh	stopProgressBar
switchNamespace	updateView

Parameters

• 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.cls";

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 = "CSP Sessions";

Displayed name of this page.

• parameter PARENTPAGE = "/csp/sys/%CSP.Portal.Home.cls";

This parameter defines the parent page for this page.
If the name ends in .csp, then the parent is assumed to be an autopage-enabled CSP page.
If the name ends in .cls, then the parent is assumed to be a Zen page.
This is used to automate the construction of the locator bar for this page and to build the index between portal pages and documentation.
The %GetLocatorInfo method is used to get this information.

• parameter RESOURCE = "%Admin_Operate";

Security requirement

Properties

• property FreespacePage as %String;

• 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 msgEndSession as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Are you sure you want to end the selected sessions?") ];

Methods

• method %GetLocatorLinks(Output pLink) as %Status

Return the array of links to show in the locator bar.
pLink(n)=$LB(caption,link)

• method %OnAfterCreatePage() as %Status

Decorate the page.

• 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.

• method doEndSession() [ Language = javascript ]

• method onloadHandler() [ Language = javascript ]

Disable checkboxes for applications that should not allow to be terminated.

• method refreshHandler() [ Language = javascript ]

Table auto-refresh timer handler.

• method setRefreshMode(newMode, notImmediate) [ Language = javascript ]

Turn auto-refresh mode on and off.

• method setRefreshRate(newRate) [ Language = javascript ]

User changed refresh rate. Check the value and save to server.

• method startRefresh() [ Language = javascript ]

Based on user's choice, start or stop the timer.

• method updateView() [ Language = javascript ]

Update table.


[BASEXML] > [%CSP] > [UI] > [Portal] > [CSPSessions]		Private Storage