Class Reference
IRIS for UNIX 2024.1.2
InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [%CSP] >  [UI] >  [Portal] >  [Background] >  [Utils]
Private  Storage   

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

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

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 2 8


Summary

Properties
OpenDetailsPage OutputPage

Methods
GetTaskInfo GetTaskList HasEnded LogMsg drawData
openDetails timeout updateButtons

Subclasses
%CSP.UI.Portal.Background.Dialog.DatabaseCompact %CSP.UI.Portal.Background.Dialog.DatabaseDefragment %CSP.UI.Portal.Background.Dialog.DatabaseTruncate
%CSP.UI.Portal.Background.Dialog.TaskInfo

Parameters

• parameter DOMAIN = "%Utility";

Properties

• property OpenDetailsPage as %String [ InitialExpression = ..Link("/csp/sys/%CSP.UI.Portal.Background.Dialog.TaskInfo.zen",,1) ];
• property OutputPage as %ZEN.Datatype.string [ InitialExpression = ..Link("%25CSP.UI.Portal.Background.TaskInfoOutput.zen") ];

Methods

• 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")
• method drawData() [ Language = javascript ]
• method openDetails(SysBGTaskId) [ Language = javascript ]
Show information for the background job id in a dialog window
• method timeout() [ Language = javascript ]
This function is executed when SaveQuery is processed to run in the background.
• method updateButtons(proxy) [ Language = javascript ]


Copyright (c) 2025 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.