Class %CSP.UI.Portal.BackgroundTaskList

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

System Management Portal - System Operations - Background Tasks

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
4	6	11

Summary

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

Properties
%condition	%import	%includeFiles	%page
%resource	CurrentColumn	CurrentSort	ErrorPage
Filter	FirstFailed	HelpAddress	ISREADONLY
InvalidParam	IsEMSReadOnly	IsEditForm	LocatorHeader
OnclickArray	OpenDetailsPage	PID	ParentURL
StdTitle	TableMaxRows	TablePageSize	ValidationErrorMsg
aboutPage	align	aux	backgroundTimerInterval
captionLastUpdate	cellAlign	cellSize	cellStyle
cellVAlign	children	colInfo	composite
contactPage	containerStyle	cssLevel	currSortMode
currStep	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
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	DrawErrorCount	DrawLocator
DrawRibbon	DrawStatusInfoCell	DrawTitle	Encrypt
EscapeHTML	EscapeURL	EvalResult	GetCSPURL
GetContextLinks	GetDocURL	GetHomePage	GetNewURL
GetQuickLinks	HyperEventCall	HyperEventHead	Include
InsertHiddenField	InsertHiddenFields	IsPrivate	JavaInstalled
LastUpdateTime	Link	OnDrawRibbon	OnGetRibbonInfo
OnHTTPHeader	OnPage	OnPageError	OnPostHTTP
OnPostHyperEvent	OnPreHTTP	OnPreHyperEvent	Page
Purge	QuoteJS	RegisterRecent	RewriteURL
ShowError	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	doErrors	doModified	doPurge
dragFinishHandler	dragHandler	dragNotifyHandler	dragStartHandler
dropHandler	dropStartHandler	enableCommandButton	endModal
exposeComponent	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
openDetails	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
trimSpace	updateTime	updateView	validateRequired
zeroFill

Subclasses
%CSP.UI.Portal.BackgroundTaskListPopup

Parameters

• parameter AUTONS = 0;

Do not switch namespace for this page: it needs to stay in %SYS

• parameter CSPURL = "/csp/sys/%CSP.UI.Portal.BackgroundTaskList.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,Background Tasks";

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

• parameter PAGENAME = "Background Tasks";

Displayed name of this page.

Properties

• property CurrentColumn as %ZEN.Datatype.string [ InitialExpression = "ID" ];

Column the table is sorted by. Default is the "Process ID" column. User may change and the value is saved and reloaded for this page.

• property ErrorPage as %String [ InitialExpression = ..Link("%25CSP.UI.Portal.BackgroundTaskError.zen",,1) ];

• property OpenDetailsPage as %String [ InitialExpression = ..Link("%CSP.UI.Portal.Background.Dialog.TaskInfo.zen",,1) ];

• property TableMaxRows as %Integer [ InitialExpression = "1000" ];

Max rows value user entered into the "Max rows" field in the table navigator. This value is saved and reloaded for this page.

• property TablePageSize as %Integer [ InitialExpression = "0" ];

Page size value user entered into the "Page size" field in the table navigator. This value is saved and reloaded for this page.

• property colInfo as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Info") ];

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 %OnGetPageName() as %String

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

• classmethod DrawErrorCount(pTable As %ZEN.Component.tablePane, pName As %String, pSeed As %String) as %Status

• method DrawStatusInfoCell(pTable As %ZEN.Component.tablePane, pName As %String, pSeed As %String) as %Status

User override of cell-display for tablePane.

• 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 Purge() as %Status [ ZenMethod ]

• method doErrors(pid) [ Language = javascript ]

• method doPurge() [ Language = javascript ]

• method openDetails(SysBGTaskId) [ Language = javascript ]

Show information for the background job id in a dialog window

Class Reference IRIS for UNIX 2024.1.2
Documentation Search