This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see Why Migrate to InterSystems IRIS?

%CSP.UI.Portal.TaskInfo

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

System Management Portal - System Operations - Task Details

Property Inventory

Method Inventory

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;
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 Task Schedule,Task Details;
Inherited description: 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;
Inherited description: 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 methods: %PaneGet(), %PaneGetSwizzled(), %PaneIsValid(), %PaneNewObject(), %PaneSet()
property ActionPage as %String [ InitialExpression = ..Link("UtilSysTaskAction.csp",,1) ];
Property methods: ActionPageDisplayToLogical(), ActionPageGet(), ActionPageIsValid(), ActionPageLogicalToDisplay(), ActionPageLogicalToOdbc(), ActionPageNormalize(), ActionPageSet()
property CanBeEdited as %ZEN.Datatype.boolean [ InitialExpression = "1" ];
Property methods: CanBeEditedDisplayToLogical(), CanBeEditedGet(), CanBeEditedIsValid(), CanBeEditedLogicalToDisplay(), CanBeEditedLogicalToOdbc(), CanBeEditedLogicalToXSD(), CanBeEditedNormalize(), CanBeEditedSet(), CanBeEditedXSDToLogical()
property CanBeSuspended as %ZEN.Datatype.boolean [ InitialExpression = "1" ];
Property methods: CanBeSuspendedDisplayToLogical(), CanBeSuspendedGet(), CanBeSuspendedIsValid(), CanBeSuspendedLogicalToDisplay(), CanBeSuspendedLogicalToOdbc(), CanBeSuspendedLogicalToXSD(), CanBeSuspendedNormalize(), CanBeSuspendedSet(), CanBeSuspendedXSDToLogical()
property EditPage as %String [ InitialExpression = ..Link("UtilSysTaskOption.csp",,1) ];
Property methods: EditPageDisplayToLogical(), EditPageGet(), EditPageIsValid(), EditPageLogicalToDisplay(), EditPageLogicalToOdbc(), EditPageNormalize(), EditPageSet()
property HistoryPage as %String [ InitialExpression = ..Link(..#AppContextPath _ ".TaskHistoryId.zen",,1) ];
Property methods: HistoryPageDisplayToLogical(), HistoryPageGet(), HistoryPageIsValid(), HistoryPageLogicalToDisplay(), HistoryPageLogicalToOdbc(), HistoryPageNormalize(), HistoryPageSet()
property PID as %String (ZENURL = "$ID1");
internal task ID
Property methods: PIDDisplayToLogical(), PIDGet(), PIDIsValid(), PIDLogicalToDisplay(), PIDLogicalToOdbc(), PIDNormalize(), PIDSet()
property TaskDetailsPage as %String;
this page's link with PID and DISPLAYID
Property methods: TaskDetailsPageDisplayToLogical(), TaskDetailsPageGet(), TaskDetailsPageIsValid(), TaskDetailsPageLogicalToDisplay(), TaskDetailsPageLogicalToOdbc(), TaskDetailsPageNormalize(), TaskDetailsPageSet()
property TaskSchedulePage as %String;
parent page link
Property methods: TaskSchedulePageDisplayToLogical(), TaskSchedulePageGet(), TaskSchedulePageIsValid(), TaskSchedulePageLogicalToDisplay(), TaskSchedulePageLogicalToOdbc(), TaskSchedulePageNormalize(), TaskSchedulePageSet()
property paneDone as %Boolean;
Flag to indicate whether %Pane's OnDrawHEAD() method has been executed.
Property methods: paneDoneDisplayToLogical(), paneDoneGet(), paneDoneIsValid(), paneDoneLogicalToDisplay(), paneDoneLogicalToXSD(), paneDoneNormalize(), paneDoneSet(), paneDoneXSDToLogical()

Methods

Return the array of links to show in the locator bar.
pLink(n)=$LB(caption,link)
method %OnAfterCreatePage() as %Status
Inherited description: 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
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.
clientmethod doAction(action) [ Language = javascript ]
clientmethod onloadHandler() [ Language = javascript ]
This is called when the template is first displayed; This provides a chance to load the last filetype, etc.
clientmethod updateView() [ Language = javascript ]
For auto-refresh on this page.

Inherited Members

Inherited Properties

Inherited Methods

Feedback