Skip to main content


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

System Management Portal - System Operations - Background Tasks

Property Inventory

Method Inventory


parameter AUTONS = 0;
Do not switch namespace for this page: it needs to stay in %SYS
parameter CSPURL = /csp/sys/%CSP.UI.Portal.BackgroundTaskList.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,Background Tasks;
Inherited description: Each SMP page should set this link which points to the documentation anchor name.
parameter PAGENAME = Background Tasks;
Displayed name of this page.


property CurrentColumn as %ZEN.Datatype.string [ InitialExpression = "ID" ];
Column the table is sorted by. Default is the "Process ID" column. User may change and the value is saved and reloaded for this page.
Property methods: CurrentColumnDisplayToLogical(), CurrentColumnGet(), CurrentColumnIsValid(), CurrentColumnLogicalToDisplay(), CurrentColumnLogicalToOdbc(), CurrentColumnNormalize(), CurrentColumnSet()
property ErrorPage as %String [ InitialExpression = ..Link("%25CSP.UI.Portal.BackgroundTaskError.zen",,1) ];
Property methods: ErrorPageDisplayToLogical(), ErrorPageGet(), ErrorPageIsValid(), ErrorPageLogicalToDisplay(), ErrorPageLogicalToOdbc(), ErrorPageNormalize(), ErrorPageSet()
property OpenDetailsPage as %String [ InitialExpression = ..Link("%CSP.UI.Portal.Background.Dialog.TaskInfo.zen",,1) ];
Property methods: OpenDetailsPageDisplayToLogical(), OpenDetailsPageGet(), OpenDetailsPageIsValid(), OpenDetailsPageLogicalToDisplay(), OpenDetailsPageLogicalToOdbc(), OpenDetailsPageNormalize(), OpenDetailsPageSet()
property TableMaxRows as %Integer [ InitialExpression = "1000" ];
Max rows value user entered into the "Max rows" field in the table navigator. This value is saved and reloaded for this page.
Property methods: TableMaxRowsDisplayToLogical(), TableMaxRowsGet(), TableMaxRowsIsValid(), TableMaxRowsLogicalToDisplay(), TableMaxRowsNormalize(), TableMaxRowsSet(), TableMaxRowsXSDToLogical()
property TablePageSize as %Integer [ InitialExpression = "0" ];
Page size value user entered into the "Page size" field in the table navigator. This value is saved and reloaded for this page.
Property methods: TablePageSizeDisplayToLogical(), TablePageSizeGet(), TablePageSizeIsValid(), TablePageSizeLogicalToDisplay(), TablePageSizeNormalize(), TablePageSizeSet(), TablePageSizeXSDToLogical()
property colInfo as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Info") ];
Property methods: colInfoDisplayToLogical(), colInfoGet(), colInfoIsValid(), colInfoLogicalToDisplay(), colInfoLogicalToOdbc(), colInfoNormalize(), colInfoSet()


Return the array of links to show in the locator bar.
method %OnAfterCreatePage() as %Status
Inherited description: Be sure to do ##super() when overriding.
method %OnGetPageName() as %String
Get the (localized) name of the page. This should be implemented in a subclass.
classmethod DrawErrorCount(pTable As %ZEN.Component.tablePane, pName As %String, pSeed As %String) as %Status
method DrawStatusInfoCell(pTable As %ZEN.Component.tablePane, pName As %String, pSeed As %String) as %Status
User override of cell-display for tablePane.
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 Purge() as %Status [ ZenMethod ]
clientmethod doErrors(pid) [ Language = javascript ]
clientmethod doPurge() [ Language = javascript ]
clientmethod openDetails(SysBGTaskId) [ Language = javascript ]
Show information for the background job id in a dialog window

Inherited Members

Inherited Properties

Inherited Methods


FeedbackOpens in a new tab