Designed to run in a background job using the method DoPurgeInBackground which invokes %RunBackgroundMethod().
Based on a similar method in EnsPortal.EDI.SEF.SchemaMain.
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 ]
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.
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 ]