Class %CSP.UI.Portal.ProcessDetails

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

System Management Portal - System Operations - Local Databases

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
6	16	26

Summary

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

Properties
%condition	%import	%includeFiles	%page
%resource	CanBeSuspended	CanBeTerminated	DISPLAYID
DashboardPage	HelpAddress	ISREADONLY	LocatorHeader
PID	ParentURL	ProcessDetailsPage	ProcessesPage
StdTitle	TABAREAHEIGHT	TABHEIGHT	TABMAXWIDTH
TABOVERLAP	TABRADIUS	TABTEXTMARGIN	TABTOPREDUCTION
TEXTVOFFSET	aboutPage	align	aux
backgroundTimerInterval	cellAlign	cellSize	cellStyle
cellVAlign	children	composite	containerStyle
cssLevel	currSortMode	currStep	currTab
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	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	DrawRibbon	DrawTitle
Encrypt	EscapeHTML	EscapeURL	GetCSPURL
GetContextLinks	GetDocPage	GetHomePage	GetNewURL
GetPIDOBJ	GetQuickLinks	HyperEventBody	HyperEventCall
HyperEventFrame	HyperEventHead	Include	InsertHiddenField
InsertHiddenFields	IsPrivate	Link	OnDrawRibbon
OnGetRibbonInfo	OnHTTPHeader	OnPage	OnPageError
OnPostHTTP	OnPostHyperEvent	OnPreHTTP	OnPreHyperEvent
Page	QuoteJS	RegisterRecent	RewriteURL
ShowError	StartResume	StartSuspend	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	doOwnerDrawTabs	doResume	doSuspend
doTerminate	dragFinishHandler	dragHandler	dragNotifyHandler
dragStartHandler	drawOneTab	drawTabs	dropHandler
dropStartHandler	endModal	exposeComponent	filterChanged
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
tabClicked	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.ProcessDetails.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 JSINCLUDES = "zenCSLM.js";

Comma-separated list of additional JS include files for the page.

• parameter PAGENAME = "Operation ProcessDetails";

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 CanBeSuspended as %ZEN.Datatype.boolean [ InitialExpression = "1" ];

• property CanBeTerminated as %ZEN.Datatype.boolean [ InitialExpression = "1" ];

• property DISPLAYID as %String(ZENURL="DISPLAYID");

display process ID

• property DashboardPage as %String [ InitialExpression = ..Link("/csp/sys/op/UtilSysJobInfo.csp",,1) ];

• property PID as %String(ZENURL="PID");

internal process ID

• property ProcessDetailsPage as %String;

this page's link with PID and DISPLAYID

• property ProcessesPage as %String;

parent page link

• property TABAREAHEIGHT as %Integer [ InitialExpression = 32 ];

height of the total tab header

• property TABHEIGHT as %Integer [ InitialExpression = 26 ];

height of the tabs

• property TABMAXWIDTH as %Integer [ InitialExpression = 200 ];

the maximum width of the tabs (from bottom to bottom)

• property TABOVERLAP as %Integer [ InitialExpression = 12 ];

the amount the top tab covers the bottom tab

• property TABRADIUS as %Integer [ InitialExpression = 20 ];

the radius of the tab side curve

• property TABTEXTMARGIN as %Integer [ InitialExpression = 20 ];

the margin of tha tab text

• property TABTOPREDUCTION as %Integer [ InitialExpression = 28 ];

The amout the tab top width is smaller than the bottom width

• property TEXTVOFFSET as %Integer [ InitialExpression = 16 ];

distance of the vertical offset for the text y-attribute

• property currTab as %String(ZENURL="tab");

current tab number

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.

• classmethod GetPIDOBJ(PID) as %String [ ZenMethod ]

• 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 StartResume(PID) as %String [ ZenMethod ]

• classmethod StartSuspend(PID, DISPLAYID) as %String [ ZenMethod ]

• classmethod UpdateAutoRefreshRate(refreshrate As %Integer) [ ZenMethod ]

Save auto refresh rate to server.

• classmethod UpdateAutoRefreshState(refreshstate) [ ZenMethod ]

Save auto refresh state to server.

• method doOwnerDrawTabs() [ Language = javascript ]

• method doResume() [ Language = javascript ]

• method doSuspend() [ Language = javascript ]

• method doTerminate() [ Language = javascript ]

• method drawOneTab(tabData, index, tabwidth, isActive) [ Language = javascript ]

• method drawTabs() [ Language = javascript ]

• method filterChanged(value) [ Language = javascript ]

User entered something in to the filter. Re-load the table with filter value.

• method onPopupAction(popupName, action, value) [ Language = javascript ]

This client event, if present, is fired when the a popup page launched from this page fires an action.

• method onloadHandler() [ Language = javascript ]

This is called when the template is first displayed; This provides a chance to load the last filetype, etc.

• method onresizeHandler() [ Language = javascript ]

This client event, if present, is fired when the page is resized.

• 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 tabClicked(index) [ Language = javascript ]

• method updateView() [ Language = javascript ]

Update dashboard.


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