Class Reference
IRIS for UNIX 2024.1.2
 InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [EnsPortal] >  [PurgeAll]
Private  Storage   

class EnsPortal.PurgeAll extends EnsPortal.Template.standardPage

Purge all

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
3 2 31


Summary

This is a Zen Page class. It belongs to the application EnsPortal.Application.

Properties
%condition %import %includeFiles %page
%resource HelpAddress ISREADONLY LocatorHeader
ParentURL Status StdTitle aboutPage
align aux backgroundTimerInterval canEdit
cellAlign cellSize cellStyle cellVAlign
children composite contactPage containerStyle
cssLevel currSortMode currStep currViewMode
disabled dragAndDrop dragEnabled dropEnabled
enableAutoRefresh enclosingClass enclosingStyle error
groupClass groupStyle height hidden
hint hintClass hintStyle home
homePage id index keepAliveInterval
label labelClass labelDisabledClass labelPosition
labelStyle layout lblTitle limitPopups
msgNotPermitted name onafterdrag onbeforedrag
onclick ondrag ondrop onhide
onrefresh onshow onupdate pageModified
parent searchKey showLabel slice
title tuple useSVG useSoftModals
valign visible width window
zenPersistentPopup

Methods
%AddCSPShareHyperevents %AddChild %AddChildAfter %AddChildBefore
%AddComponent %AddEnsExceptionHandler %AddImportedComponents %AddLocatorLinks
%AddToSaveSet %ApplyURLParms %Attr %BindExport
%ClassIsLatestVersion %ClassName %ConstructClone %DispatchClassMethod
%DispatchGetModified %DispatchGetProperty %DispatchMethod %DispatchSetModified
%DispatchSetMultidimProperty %DispatchSetProperty %DrawAutoLogout %DrawClassDefinitions
%DrawComponentHTML %DrawHTML %DrawHTMLPage %DrawJSStrings
%DrawObjectDefinitions %EnclosingDivId %EndBackgroundMethod %EndScript
%Eval %EvalC %Extends %ForceClientRender
%GetChildIndex %GetComponent %GetComponentById %GetComponentByName
%GetEventHandlers %GetHomePage %GetHomeParam %GetLinks
%GetLocatorLinks %GetPageName %GetParameter %GetProductName
%GetRootLink %GetValueById %GetValueByName %GetXMLName
%IsA %IsModified %Link %LinkCSS
%LinkScript %MakeId %New %NormalizeObject
%ObjectModified %OnAddToPageAfter %OnAddToPageBefore %OnAfterCreatePage
%OnBeforeCreatePage %OnCreateApplication %OnCreatePage %OnDetermineCSSLevel
%OnDrawEnclosingDiv %OnDrawHTMLBody %OnDrawHTMLHead %OnDrawHTMLMeta
%OnDrawObjectProperties %OnFinishBackgroundTask %OnGetPageName %OnGetProductName
%OnGetSmallMenu %OnGetTitle %OnMonitorBackgroundTask %OnMutateChildren
%OnObjectSynch %OnPreHTTP %OnSubmit %OnUseSoftModals
%OnZENDeserialize %OriginalNamespace %PackageName %QuoteValue
%QuoteValueL10N %Register %RemoveChild %RemoveChildren
%RemoveComponent %RemoveFromSaveSet %RunBackgroundMethod %Self
%SerializeObject %SetBackgroundMethodStatus %SetErrorById %SetErrorByName
%SetModified %SetValueById %SetValueByName %SetValuesByName
%StartScript %ValidateObject %ZENVersion BuildMenu
CallPurge CheckAllBlanks CheckContextLinks CheckEnterpriseManager
ConvertParameter Decrypt DoLogout DoPurge
DoPurgeInBackground DoSaveSettings DrawDescription DrawLocator
DrawRibbon DrawStatus DrawTitle Encrypt
EscapeHTML EscapeURL EvalResult GetCSPURL
GetCompletionValue GetContextLinks GetCounts GetDocURL
GetHomePage GetHyperEventResources GetJobStatus GetNewURL
GetPurgeSettings GetPurgeStatus GetQuickLinks GetRunningDuration
GetRunningStartTime GetRunningStatus HyperEventCall HyperEventHead
Include InsertHiddenField InsertHiddenFields IsPrivate
JavaInstalled Link OnDrawRibbon OnGetRibbonInfo
OnHTTPHeader OnPage OnPageError OnPostHTTP
OnPostHyperEvent OnPreHTTP OnPreHyperEvent Page
PurgeBodiesToo QuoteJS RegisterRecent RewriteURL
SetCompletionValue ShowError SimpleKeepAlive StartTimer
StopTimer ThrowError UnescapeHTML UnescapeURL
XMLDTD XMLExport XMLExportToStream XMLExportToString
XMLNew XMLSchema XMLSchemaNamespace XMLSchemaType
addChild addChildAfter addChildBefore addPopupSuffix
adjustSizes arrowClick cancelPopup changePassword
changeURLNamespace checkEdit childrenMutated clientKeepAlive
correctIELayering createComponent createComponentNS createTimeWarning
deleteComponent disableCommandButton displayCountDown doStatus
dragFinishHandler dragHandler dragNotifyHandler dragStartHandler
dropHandler dropStartHandler enableCommandButton endModal
exposeComponent findElement fireOnResizeEvent fireOnUnloadEvent
fireOnUpdateEvent firePopupAction getChildIndex getComponent
getComponentById getEnclosingDiv getHidden getHintElement
getLabelElement getOpener getPageTitle getProperty
getSettings getTitleAreaHeight getType goHome
goMenu gotoNamespace gotoPage hideCommandButton
hideSettingsPane hideTimeoutWarning hideWarnContinue inResizeLoop
initPopupSuffix invokeSuper isOfType launchPopupWindow
logout makeId manualKeepAlive navigate
onCreate onDelete onDisplayHandler onEndModalHandler
onPopupAction onRefreshContents onSerialize onServerMethodCall
onServerMethodError onServerMethodReturn onStartModalHandler ondisabledHandler
onhandleAutoLogoutWarn onkeydownHandler onkeyupHandler onlayoutHandler
onloadHandler onlogoutHandler onoverlayHandler onresizeHandler
onunloadHandler onupdateHandler popupActionHandler purge
refreshContents removeChild removePopupSuffix render
renderContents renderSVG saveSettings searchBlur
searchBoxHandler searchFocus searchKeyDown searchKeyPress
setComponentId setConnectivityStatusMsg setHidden setModified
setOverlayMode setPageTitle setProperty setPropertyAll
setSortMode setSortModeHandler setTraceOption setViewMode
setViewModeHandler setWarnInnerHTML showAbout showCommandButton
showContact showDocumentation showHelp showPurgeDoc
showSettingsPane showTimeoutWarning startKeepAlive startModal
startProgressBar stopKeepAlive stopProgressBar switchNamespace
timeout updatePurgeCriteria warnclickListener


Parameters

• parameter EDITRESOURCE = "%Ens_PurgeSettings:WRITE";
User needs WRITE permissions on the %Ens_PurgeSettigns resource to change the purge criteria
• parameter PAGENAME = "Purge Management Data";
Displayed name of this page.
• parameter RESOURCE = "%Ens_Purge:USE";
User needs USE permissions on the %Ens_Purge resource to access this page.

Properties

• property Status as %String;

Methods

• method %OnAfterCreatePage() as %Status
Decorate the page.
• method %OnGetPageName() as %String
Get the (localized) name of the page.
• method %OnGetTitle() as %String
Get the (localized) title string for the page.
• method CallPurge(pNumberDaysToKeep As %Integer) as %ZEN.Datatype.string [ ZenMethod ]
• classmethod DoPurge(pBodiesToo As %Boolean, pKeepIntegrity As %Boolean, pNumberDaysToKeep As %Integer) as %String
Designed to run in a background job using the method DoPurgeInBackground which invokes %RunBackgroundMethod(). Based on a similar method in EnsPortal.EDI.SEF.SchemaMain.
• classmethod DoPurgeInBackground(pBodiesToo As %Boolean, pKeepIntegrity As %Boolean, pNumberDaysToKeep As %Integer) as %ZEN.Datatype.string
This method is called when user clicks the Purge button. Run method DoPurge() in a background job. Return 1 if this works out ok, an error string if there is an error in running the job (regardless of the results of the method DoPurge() itself).
• method DoSaveSettings() as %String [ ZenMethod ]
• method DrawDescription(table As %ZEN.Component.tablePane, name As %ZEN.Datatype.string, seed As %ZEN.Datatype.string) as %Status
• method DrawStatus(seed As %ZEN.Datatype.string) as %Status
Draw current import status; intended for use with background purge jobs.
• classmethod GetCompletionValue() as %Boolean
• classmethod GetCounts() as %String [ ZenMethod ]
Use after the purge job has completed to check on results.
• classmethod GetJobStatus() as %String [ ZenMethod ]
Use when the purge job is running in the background to check on error status. An empty string means no error; otherwise it is an error message.
• method GetPurgeSettings() as %String [ ZenMethod ]
• classmethod GetPurgeStatus() as %String [ ZenMethod ]
Use when the purge job is running in the background to check on running status. Returns either "running" or "idle" or "done".
• classmethod GetRunningDuration() as %String
Use when the purge job is running in the background to check on status. Gets the number of seconds job has been running (or ran, if complete) and formats it nicely as a string.
• classmethod GetRunningStartTime() as %String
Use when the purge job is running in the background to check on status.
• classmethod GetRunningStatus() as %String
Use when the purge job is running in the background to check on running status. Returns either "running" or "idle" or "done".
• 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.
• method PurgeBodiesToo() as %Boolean [ ZenMethod ]
• classmethod SetCompletionValue(pValue As %Integer) as %Boolean
• method adjustSizes() [ Language = javascript ]
Adjust sizes of components on the page.
• method doStatus() [ Language = javascript ]
This method calls server method to get current background import job status and update the UI.
• method hideSettingsPane() [ Language = javascript ]
• method onlayoutHandler(load) [ Language = javascript ]
Adjust sizes of components on the page.
• method onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded. Start the timer so we can check the status. If there is a background import job currently running, you will see a periodic update until the job is finished.
• method purge() [ Language = javascript ]
• method saveSettings() [ Language = javascript ]
• method showPurgeDoc() [ Language = javascript ]
Show documentation for message purge.
• method showSettingsPane() [ Language = javascript ]
• method timeout(timer) [ Language = javascript ]
This function controls the timer on updating progress. It is called from onload as well (in case a background import job is currently being run when the page is opened).
• method updatePurgeCriteria() [ Language = javascript ]

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