Class %CSP.UI.Portal.TasksUpcoming

class %CSP.UI.Portal.TasksUpcoming extends %CSP.UI.Template.List

System Management Portal - System Administration - Task on demand

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
5	7	17

Summary

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

Properties
%condition	%import	%includeFiles	%page
%resource	BeginDate	ClassURL	CurrentColumn
CurrentSort	DocPage	EndDate	FILETYPE
Filter	FirstFailed	GlobalURL	HelpAddress
ISREADONLY	InvalidParam	IsEMSReadOnly	IsEditForm
LocatorHeader	MaxRows	NamespaceList	OnclickArray
PID	ParentURL	RoutineURL	RunTaskPage
ShowGen	ShowMap	ShowSys	StdTitle
TableMaxRows	TablePageSize	TitleText	TitleTextDate
TitleTextHour	ValidationErrorMsg	aboutPage	align
aux	backgroundTimerInterval	captionLastUpdate	cellAlign
cellSize	cellStyle	cellVAlign	children
colResume	colSuspend	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	%ChangeNS	%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	ConvertDate
ConvertParameter	Decrypt	DoLogout	DrawAutoRefresh
DrawLocator	DrawRibbon	DrawTableHeader	DrawTitle
Encrypt	EscapeHTML	EscapeURL	EvalResult
FindDBDir	FindDBName	GetCSPURL	GetContextLinks
GetDBList	GetDocURL	GetExpandState	GetHomePage
GetLastSearch	GetNSList	GetNewURL	GetQuickLinks
GetRecentList	HyperEventCall	HyperEventHead	Include
InsertHiddenField	InsertHiddenFields	IsPrivate	JavaInstalled
LastUpdateTime	Link	OnDrawRibbon	OnGetRibbonInfo
OnHTTPHeader	OnPage	OnPageError	OnPostHTTP
OnPostHyperEvent	OnPreHTTP	OnPreHyperEvent	Page
PrepareAction	QuoteJS	RegisterRecent	RewriteURL
SaveExpandState	SaveSearch	SaveSelections	ShowError
StartTimer	StopTimer	ThrowError	UnescapeHTML
UnescapeURL	UpdateAutoRefreshRate	UpdateAutoRefreshState	UpdateTableNavState
UpdateTableState	XMLDTD	XMLExport	XMLExportToStream
XMLExportToString	XMLNew	XMLSchema	XMLSchemaNamespace
XMLSchemaType	addChild	addChildAfter	addChildBefore
adjustSizes	afterSave	afterValidate	cancelPopup
changePassword	checkURLNamespace	childrenMutated	columnSort
correctIELayering	createComponent	createComponentNS	deleteComponent
disableCommandButton	doAction	doCancel	doDoc
doModified	doSearch	dragFinishHandler	dragHandler
dragNotifyHandler	dragStartHandler	dropHandler	dropStartHandler
enableCommandButton	endModal	exposeComponent	filterChanged
findElement	findNSMatch	fireOnResizeEvent	fireOnUnloadEvent
fireOnUpdateEvent	firePopupAction	getChildIndex	getComponent
getComponentById	getEnclosingDiv	getHidden	getHintElement
getLabelElement	getOpener	getPageTitle	getProperty
getSelectedNamespace	getSettings	getTime	getTitleAreaHeight
getType	goHome	goMenu	gotoNamespace
gotoPage	hideCommandButton	invokeSuper	isButtonDisabled
isOfType	keyUp	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
selectDateType	selectedDate	setComponentId	setConnectivityStatusMsg
setHidden	setModified	setOverlayMode	setPageTitle
setProperty	setPropertyAll	setRefreshMode	setRefreshRate
setSortMode	setSortModeHandler	setTraceOption	setViewMode
setViewModeHandler	showAbout	showCommandButton	showContact
showDocumentation	showExpand	showHelp	showMsg
startModal	startProgressBar	stopProgressBar	switchNamespace
toggleDetails	toggleSearch	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.TasksUpcoming.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 Upcoming Tasks";

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

• parameter PAGENAME = "Upcoming Tasks";

Displayed name of this page.

• parameter RESOURCE = "%Admin_Operate";

Security requirement

Properties

• property FILETYPE as %String [ InitialExpression = "Upcoiming Tasks" ];

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

• property TitleText as %String [ InitialExpression = $$$TextJS("The following is a list of tasks scheduled to run within the next %1 days.") ];

• property TitleTextDate as %String [ InitialExpression = $$$TextJS("The following is a list of tasks scheduled to run between now and %1.") ];

• property TitleTextHour as %String [ InitialExpression = $$$TextJS("The following is a list of tasks scheduled to run within the next 24 hours.") ];

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

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

Store translated targetCol linkCaption for

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

Subclass to override. Always include code in this method.

• method %OnGetPageName() as %String

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

• classmethod ConvertDate(pDate) as %Integer [ ZenMethod ]

Convert user selected date to $H format. If invalid entry then return "".

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

Draw the contents of the Table Header (the region between the diagram and the table).

• method GetLastSearch() as %String

HoursOffset value (default to 1 day) ^ ToDate ($H value of the date) ^ ToTime (currently not used) ^ maxRows

• 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 SaveSearch(FILETYPE, HoursOffset, ToDate, ToTime, maxRows) [ ZenMethod ]

• method doAction(action, PID) [ Language = javascript ]

• method doSearch(selection, todate) [ Language = javascript ]

User clicked Go to start search.

• method filterChanged(value, tableID) [ Language = javascript ]

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

• method keyUp(zenEvent) [ Language = javascript ]

Check if user hit [Enter].

• method onloadHandler() [ Language = javascript ]

Disable save button for EMS-managed pages. Be sure to use this.invokeSuper('onloadHandler',arguments); when overriding.

• method selectDateType() [ Language = javascript ]

• method selectedDate(ctrl) [ Language = javascript ]

User entered or selected a date.

• method updateView() [ Language = javascript ]

Update / Reload table. This overrides the one in Portal.Utils.

Class Reference IRIS for UNIX 2024.1.2
Documentation Search