Home > Class Reference > ENSLIB namespace > EnsPortal.PurgeAll

EnsPortal.PurgeAll

class EnsPortal.PurgeAll extends EnsPortal.Template.standardPage

Purge all

Property Inventory

Method Inventory

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;
Inherited description: 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;
Property methods: StatusDisplayToLogical(), StatusGet(), StatusIsValid(), StatusLogicalToDisplay(), StatusLogicalToOdbc(), StatusNormalize(), StatusSet()

Methods

method %OnAfterCreatePage() as %Status [ Language = objectscript ]
Inherited description: Decorate the page.
method %OnGetPageName() as %String [ Language = objectscript ]
Get the (localized) name of the page.
method %OnGetTitle() as %String [ Language = objectscript ]
Get the (localized) title string for the page.
method CallPurge(pNumberDaysToKeep As %Integer) as %ZEN.Datatype.string [ Language = objectscript, ZenMethod ]
classmethod DoPurge(pBodiesToo As %Boolean, pKeepIntegrity As %Boolean, pNumberDaysToKeep As %Integer) as %String [ Language = objectscript ]
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 [ Language = objectscript ]
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 [ Language = objectscript, ZenMethod ]
method DrawDescription(table As %ZEN.Component.tablePane, name As %ZEN.Datatype.string, seed As %ZEN.Datatype.string) as %Status [ Language = objectscript ]
method DrawStatus(seed As %ZEN.Datatype.string) as %Status [ Language = objectscript ]
Draw current import status; intended for use with background purge jobs.
classmethod GetCompletionValue() as %Boolean [ Language = objectscript ]
classmethod GetCounts() as %String [ Language = objectscript, ZenMethod ]
Use after the purge job has completed to check on results.
classmethod GetJobStatus() as %String [ Language = objectscript, 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 [ Language = objectscript, ZenMethod ]
classmethod GetPurgeStatus() as %String [ Language = objectscript, 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 [ Language = objectscript ]
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 [ Language = objectscript ]
Use when the purge job is running in the background to check on status.
classmethod GetRunningStatus() as %String [ Language = objectscript ]
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 [ Language = objectscript ]
Get information to display in the ribbon bar.
method PurgeBodiesToo() as %Boolean [ Language = objectscript, ZenMethod ]
classmethod SetCompletionValue(pValue As %Integer) as %Boolean [ Language = objectscript ]
clientmethod adjustSizes() [ Language = javascript ]
Adjust sizes of components on the page.
clientmethod doStatus() [ Language = javascript ]
This method calls server method to get current background import job status and update the UI.
clientmethod hideSettingsPane() [ Language = javascript ]
clientmethod onlayoutHandler(load) [ Language = javascript ]
Adjust sizes of components on the page.
clientmethod 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.
clientmethod purge() [ Language = javascript ]
clientmethod saveSettings() [ Language = javascript ]
clientmethod showPurgeDoc() [ Language = javascript ]
Show documentation for message purge.
clientmethod showSettingsPane() [ Language = javascript ]
clientmethod 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).
clientmethod updatePurgeCriteria() [ Language = javascript ]

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new window