Class %CSP.UI.Portal.TaskInfo

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

System Management Portal - System Operations - Task Details

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
7	11	12

Summary

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

Properties
%Pane	%condition	%import	%includeFiles
%page	%resource	ActionPage	CanBeDeleted
CanBeEdited	CanBeSuspended	CurrentColumn	CurrentSort
EditPage	Filter	FirstFailed	HelpAddress
HistoryPage	ISREADONLY	InvalidParam	IsEMSReadOnly
IsEditForm	LocatorHeader	OnclickArray	PID
ParentURL	StdTitle	TableMaxRows	TablePageSize
TaskDetailsPage	TaskSchedulePage	ValidationErrorMsg	aboutPage
align	aux	backgroundTimerInterval	captionLastUpdate
cellAlign	cellSize	cellStyle	cellVAlign
children	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	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	DrawDetails	DrawLocator
DrawRibbon	DrawTitle	Encrypt	EscapeHTML
EscapeURL	EvalResult	GetCSPURL	GetContextLinks
GetDetailPane	GetDocURL	GetHomePage	GetNewURL
GetQuickLinks	GetTaskName	HyperEventCall	HyperEventHead
Include	InsertHiddenField	InsertHiddenFields	IsPrivate
JavaInstalled	LastUpdateTime	Link	OnDrawRibbon
OnGetRibbonInfo	OnHTTPHeader	OnPage	OnPageError
OnPostHTTP	OnPostHyperEvent	OnPreHTTP	OnPreHyperEvent
Page	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
doAction	doCancel	doModified	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	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

Parameters

• parameter AUTONS = 0;

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

• parameter AppContextPath = "%25CSP.UI.Portal";

• parameter CSPURL = "/csp/sys/op/%CSP.UI.Portal.TaskInfo.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,Task Manager,View Task Schedule,Task Details";

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

• parameter PAGENAME = "Operation TaskInfo";

Displayed name of this page.

• parameter PARENTPAGE = "/csp/sys/op/%CSP.UI.Portal.TaskSchedule.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 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 ActionPage as %String [ InitialExpression = ..Link("UtilSysTaskAction.csp",,1) ];

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

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

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

• property EditPage as %String [ InitialExpression = ..Link("UtilSysTaskOption.csp",,1) ];

• property HistoryPage as %String [ InitialExpression = ..Link(..#AppContextPath _ ".TaskHistoryId.zen",,1) ];

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

internal task ID

• property TaskDetailsPage as %String;

this page's link with PID and DISPLAYID

• property TaskSchedulePage as %String;

parent page link

• 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 DrawDetails(pSeed As %String) as %Status

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

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

Set properties for HTMLDashboardPane to draw details.

• classmethod GetTaskName(pTaskId, Output pMessage="", Output pIsRunning=0) as %String

Given a Task Id, return the Task Name. This method is used by other task pages. As the returned values is being set into Zen component, it needs no extra escaping as the Zen component will escape it.

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

• method doAction(action) [ Language = javascript ]

• method onloadHandler() [ Language = javascript ]

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

• method updateView() [ Language = javascript ]

For auto-refresh on this page.

Class Reference IRIS for UNIX 2024.1.2
Documentation Search