Class %CSP.UI.Portal.ProcessDetails

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

System Management Portal - System Operations - Process Details page

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
8	11	23

Summary

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

Properties
%Pane	%condition	%import	%includeFiles
%page	%resource	CanBeSuspended	CanBeTerminated
CurrentColumn	CurrentSort	DISPLAYID	Filter
FirstFailed	HelpAddress	ISREADONLY	InvalidParam
IsEMSReadOnly	IsEditForm	LocatorHeader	OnclickArray
PID	ParentURL	PrevPID	ProcessDetailsPage
ProcessesPage	SQL	StdTitle	TableMaxRows
TablePageSize	ValidationErrorMsg	aboutPage	align
aux	backgroundTimerInterval	captionLastUpdate	cellAlign
cellSize	cellStyle	cellVAlign	children
composite	contactPage	containerStyle	cssLevel
currSortMode	currStep	currTab	currViewMode
disabled	dragAndDrop	dragEnabled	dropEnabled
enableAutoRefresh	enclosingClass	enclosingStyle	error
groupClass	groupStyle	height	hidden
hint	hintClass	hintStyle	home
homePage	id	index	label
labelClass	labelDisabledClass	labelPosition	labelStyle
layout	lblTitle	limitPopups	name
onafterdrag	onbeforedrag	onclick	ondrag
ondrop	onhide	onrefresh	onshow
onupdate	pageModified	paneDone	parent
searchKey	showLabel	slice	title
tuple	useSVG	useSoftModals	valign
visible	width	window	zenPersistentPopup

Methods
%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	%EvalC
%Extends	%ForceClientRender	%GetChildIndex	%GetComponent
%GetComponentById	%GetComponentByName	%GetEventHandlers	%GetHomePage
%GetHomeParam	%GetLinks	%GetLocatorLinks	%GetNavTableState
%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	BuildMeter	CheckAllBlanks
CheckContextLinks	CheckEnterpriseManager	ConvertParameter	Decrypt
DoLogout	DrawAutoRefresh	DrawCQLink	DrawDetails
DrawLocator	DrawRibbon	DrawTitle	Encrypt
EscapeHTML	EscapeURL	EvalResult	GetCSPURL
GetContextLinks	GetDetailPane	GetDocURL	GetHomePage
GetNewURL	GetPIDOBJ	GetQuickLinks	HyperEventCall
HyperEventHead	Include	InsertHiddenField	InsertHiddenFields
IsPrivate	JavaInstalled	LastUpdateTime	Link
OnDrawRibbon	OnGetRibbonInfo	OnHTTPHeader	OnPage
OnPageError	OnPostHTTP	OnPostHyperEvent	OnPreHTTP
OnPreHyperEvent	Page	QuoteJS	RegisterRecent
RewriteURL	ShowError	StartResume	StartSuspend
StartTimer	StopTimer	ThrowError	UnescapeHTML
UnescapeURL	UpdateAutoRefreshRate	UpdateAutoRefreshState	UpdateTableNavState
UpdateTableState	XMLDTD	XMLExport	XMLExportToStream
XMLExportToString	XMLNew	XMLSchema	XMLSchemaNamespace
XMLSchemaType	addChild	addChildAfter	addChildBefore
afterSave	afterValidate	cancelPopup	changePassword
childrenMutated	columnSort	correctIELayering	createComponent
createComponentNS	deleteComponent	disableCommandButton	doCancel
doModified	doResume	doSuspend	doTerminate
dragFinishHandler	dragHandler	dragNotifyHandler	dragStartHandler
dropHandler	dropStartHandler	enableCommandButton	endModal
exposeComponent	filterChanged	findElement	fireOnResizeEvent
fireOnUnloadEvent	fireOnUpdateEvent	firePopupAction	getChildIndex
getComponent	getComponentById	getEnclosingDiv	getHidden
getHintElement	getLabelElement	getOpener	getPageTitle
getProperty	getSettings	getTime	getTitleAreaHeight
getType	goHome	goMenu	gotoNamespace
gotoPage	hideCommandButton	invokeSuper	isButtonDisabled
isOfType	launchPopupWindow	logout	makeId
navMaxRowsChanged	navPageSizeChanged	navigate	onCreate
onDelete	onDisplayHandler	onEndModalHandler	onPopupAction
onRefreshContents	onSerialize	onServerMethodCall	onServerMethodError
onServerMethodReturn	onStartModalHandler	ondisabledHandler	onhandleAutoLogoutWarn
onkeydownHandler	onkeyupHandler	onlayoutHandler	onloadHandler
onlogoutHandler	onoverlayHandler	onresizeHandler	onunloadHandler
onupdateHandler	popupActionHandler	refreshContents	refreshHandler
refreshkeyUp	removeChild	render	renderContents
renderSVG	resetMsg	searchBlur	searchBoxHandler
searchFocus	searchKeyDown	searchKeyPress	setComponentId
setConnectivityStatusMsg	setHidden	setModified	setOverlayMode
setPageTitle	setProperty	setPropertyAll	setRefreshMode
setRefreshRate	setSortMode	setSortModeHandler	setTraceOption
setViewMode	setViewModeHandler	showAbout	showCommandButton
showContact	showDocumentation	showHelp	showMsg
startModal	startProgressBar	stopProgressBar	switchNamespace
tabChanged	toggleSQL	trimSpace	updateTime
updateView	validateRequired	zeroFill

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.zen";

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,Processes";

Each SMP page should set this link which points to the documentation anchor name.

• parameter JSINCLUDES = "zenCSLM.js";

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

• parameter PAGENAME = "Process Details";

Displayed name of this page.

• parameter PARENTPAGE = "/csp/sys/op/%CSP.UI.Portal.Processes.zen";

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 RECENT = 0;

If true, register visits to this page in the recent list.

• parameter RESOURCE = "%Admin_Operate";

Security requirement

Properties

• property %Pane as %CSP.Util.Pane;

Server-side reference to the pane object so that the head and body sections can be added to the page correctly.

• 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 PID as %String(ZENURL="PID");

internal process ID

• property PrevPID as %String [ InitialExpression = "PrevPID" ];

• property ProcessDetailsPage as %String;

this page's link with PID and DISPLAYID

• property ProcessesPage as %String;

parent page link

• property SQL as %Boolean(ZENURL="SQL");

Whether to display SQL operator details

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

current tab number

• property paneDone as %Boolean;

Flag to indicate whether %Pane's OnDrawHEAD() method has been executed.

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

Be sure to do ##super() when overriding.

• method %OnDrawHTMLHead() as %Status

Add the HEAD section for %Pane and override some CSS styles if HTML5 is enabled. Without these overrides, the font size is calculated to be 0.8px and padding is calculated to be 0 for the header cells..

• method %OnGetPageName() as %String

Get the (localized) name of the page. This should be implemented in a subclass.

• method DrawCQLink(table As %ZEN.Component.tablePane, name As %ZEN.Datatype.string, seed As %ZEN.Datatype.string) as %Status

• method DrawDetails(pSeed As %String) as %Status

Draw the contents of the diagram header, in the HTMLDashboard style.

• method GetDetailPane(pInstance As %CSP.Util.PageInstance) as %CSP.Util.Pane [ Language = objectscript ]

Set properties for HTMLDashboardPane to draw details.

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

• method columnSort(currColumn, sortOrder) [ Language = javascript ]

User clicked a column header to sort. Save that so we can come back to it when page is refreshed.

• method doResume() [ Language = javascript ]

• method doSuspend() [ Language = javascript ]

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

• method toggleSQL(value) [ Language = javascript ]

When "SQL Operator Mode" is toggled, reload page

• method updateView() [ Language = javascript ]

On auto-refresh, or after Resume or Suspend, reload page with the current tab selected.


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