Skip to main content


abstract class %CSP.UI.Portal.Background.Utils

This class contains shared methods used by the systems background task UI pages.

Property Inventory

Method Inventory


parameter DOMAIN = %Utility;


property OpenDetailsPage as %String [ InitialExpression = ..Link("/csp/sys/%CSP.UI.Portal.Background.Dialog.TaskInfo.zen",,1) ];
Property methods: OpenDetailsPageDisplayToLogical(), OpenDetailsPageGet(), OpenDetailsPageIsValid(), OpenDetailsPageLogicalToDisplay(), OpenDetailsPageLogicalToOdbc(), OpenDetailsPageNormalize(), OpenDetailsPageSet()
property OutputPage as %ZEN.Datatype.string [ InitialExpression = ..Link("%25CSP.UI.Portal.Background.TaskInfoOutput.zen") ];
Property methods: OutputPageDisplayToLogical(), OutputPageGet(), OutputPageIsValid(), OutputPageLogicalToDisplay(), OutputPageLogicalToOdbc(), OutputPageNormalize(), OutputPageSet()


classmethod GetTaskInfo(ByRef pParms, Output pObject As %RegisteredObject) as %Status
classmethod GetTaskList(pDirectory, Output pTaskList) as %Status
Return on-going background tasklist (Input: database directory)
classmethod HasEnded(SysBGTaskId) as %ZEN.proxyObject [ ZenMethod ]
classmethod LogMsg(ErrMsg As %String = "", Status As %String = "ERROR")
Log error into ^|"%SYS"|IRIS.Temp.MgtPortalTask($J,"Status") and ^|"%SYS"|IRIS.Temp.MgtPortalTask($J,"Details")
clientmethod drawData() [ Language = javascript ]
clientmethod openDetails(SysBGTaskId) [ Language = javascript ]
Show information for the background job id in a dialog window
clientmethod timeout() [ Language = javascript ]
This function is executed when SaveQuery is processed to run in the background.
clientmethod updateButtons(proxy) [ Language = javascript ]


FeedbackOpens in a new tab