This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRISOpens in a new window, see the InterSystems IRIS Migration Guide and Migrating to InterSystems IRIS, both available on the WRC Distributions pageOpens in a new window (login required).

%CSP.UI.Portal.TasksUpcoming

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

System Management Portal - System Administration - Task on demand

Property Inventory (Including Private)

Method Inventory (Including Private)

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;
Inherited description: 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;
Inherited description: 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 (Including Private)

property FILETYPE as %String [ InitialExpression = "Upcoiming Tasks" ];
Property methods: FILETYPEDisplayToLogical(), FILETYPEGet(), FILETYPEIsValid(), FILETYPELogicalToDisplay(), FILETYPELogicalToOdbc(), FILETYPENormalize(), FILETYPESet()
property RunTaskPage as %String [ InitialExpression = ..Link("UtilSysTaskAction.csp",,1) ];
Property methods: RunTaskPageDisplayToLogical(), RunTaskPageGet(), RunTaskPageIsValid(), RunTaskPageLogicalToDisplay(), RunTaskPageLogicalToOdbc(), RunTaskPageNormalize(), RunTaskPageSet()
property TitleText as %String [ InitialExpression = $$$TextJS("The following is a list of tasks scheduled to run within the next %1 days.") ];
Property methods: TitleTextDateDisplayToLogical(), TitleTextDateGet(), TitleTextDateIsValid(), TitleTextDateLogicalToDisplay(), TitleTextDateLogicalToOdbc(), TitleTextDateNormalize(), TitleTextDateSet(), TitleTextDisplayToLogical(), TitleTextGet(), TitleTextHourDisplayToLogical(), TitleTextHourGet(), TitleTextHourIsValid(), TitleTextHourLogicalToDisplay(), TitleTextHourLogicalToOdbc(), TitleTextHourNormalize(), TitleTextHourSet(), TitleTextIsValid(), TitleTextLogicalToDisplay(), TitleTextLogicalToOdbc(), TitleTextNormalize(), TitleTextSet()
property TitleTextDate as %String [ InitialExpression = $$$TextJS("The following is a list of tasks scheduled to run between now and %1.") ];
Property methods: TitleTextDateDisplayToLogical(), TitleTextDateGet(), TitleTextDateIsValid(), TitleTextDateLogicalToDisplay(), TitleTextDateLogicalToOdbc(), TitleTextDateNormalize(), TitleTextDateSet()
property TitleTextHour as %String [ InitialExpression = $$$TextJS("The following is a list of tasks scheduled to run within the next 24 hours.") ];
Property methods: TitleTextHourDisplayToLogical(), TitleTextHourGet(), TitleTextHourIsValid(), TitleTextHourLogicalToDisplay(), TitleTextHourLogicalToOdbc(), TitleTextHourNormalize(), TitleTextHourSet()
property colResume as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Resume") ];
Property methods: colResumeDisplayToLogical(), colResumeGet(), colResumeIsValid(), colResumeLogicalToDisplay(), colResumeLogicalToOdbc(), colResumeNormalize(), colResumeSet()
property colSuspend as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Suspend") ];
Store translated targetCol linkCaption for
Property methods: colSuspendDisplayToLogical(), colSuspendGet(), colSuspendIsValid(), colSuspendLogicalToDisplay(), colSuspendLogicalToOdbc(), colSuspendNormalize(), colSuspendSet()

Methods (Including Private)

Return the array of links to show in the locator bar.
pLink(n)=$LB(caption,link)
method %OnAfterCreatePage() as %Status
Inherited description: 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 ]
clientmethod doAction(action, PID) [ Language = javascript ]
clientmethod doSearch(selection, todate) [ Language = javascript ]
Inherited description: User clicked Go to start search.
clientmethod filterChanged(value, tableID) [ Language = javascript ]
User entered something in to the filter. Re-load the table with filter value.
clientmethod keyUp(zenEvent) [ Language = javascript ]
Check if user hit [Enter].
clientmethod onloadHandler() [ Language = javascript ]
Disable save button for EMS-managed pages. Be sure to use this.invokeSuper('onloadHandler',arguments); when overriding.
clientmethod selectDateType() [ Language = javascript ]
clientmethod selectedDate(ctrl) [ Language = javascript ]
User entered or selected a date.
clientmethod updateView() [ Language = javascript ]
Update / Reload table. This overrides the one in Portal.Utils.

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)

FeedbackOpens in a new window