Class %CSP.UI.Portal.Processes

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

System Management Portal - System Operations - Local Databases

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
5	4	16

Summary

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

Properties
%condition	%import	%includeFiles	%page
%resource	CurrentColumn	CurrentSort	DetailsPage
Filter	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	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	ExecuteRS
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
UpdateTableState	XMLDTD	XMLExport	XMLExportToStream
XMLExportToString	XMLNew	XMLSchema	XMLSchemaNamespace
XMLSchemaType	ZStripW	addChild	addChildAfter
addChildBefore	cancelPopup	changePassword	childrenMutated
columnSort	correctIELayering	createComponent	createComponentNS
deleteComponent	doBroadcast	dragFinishHandler	dragHandler
dragNotifyHandler	dragStartHandler	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
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.Processes.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 = "Operation Processes";

Displayed name of this page.

• parameter PARENTPAGE = "%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 CurrentColumn as %ZEN.Datatype.string [ InitialExpression = "Pid" ];

• property CurrentSort as %ZEN.Datatype.string [ InitialExpression = "asc" ];

• property DetailsPage as %String [ InitialExpression = ..Link("/csp/sys/op/%25CSP.UI.Portal.ProcessDetails.cls",,1) ];

• property Filter as %ZEN.Datatype.string;

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 ExecuteRS(pRS As %Library.ResultSet, Output tSC As %Status, pInfo As %ZEN.Auxiliary.QueryInfo) as %Boolean

Method for executing the process query.

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

• classmethod UpdateTableState(currColumn As %String, sortOrder As %String) [ ZenMethod ]

Save auto refresh rate to server.

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

• method filterChanged(value) [ Language = javascript ]

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

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

• method updateView() [ Language = javascript ]

Update table.


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