InterSystems IRIS Data Platform 2020.4 > Class Reference > ENSLIB namespace > EnsPortal.ArchiveManager


class EnsPortal.ArchiveManager extends EnsPortal.Template.standardPage

Zen based Archive Manager UI for Ensemble 2008.1

Property Inventory

Method Inventory


parameter EDITRESOURCE = %Ens_ArchiveManager:WRITE;
User must have WRITE permissions on the "%Ens_ArchiveManager" resource to make changes on this page.
parameter PAGENAME = Archive Manager;
Displayed name of this page.
parameter RESOURCE = %Ens_ArchiveManager:READ;
User must have READ permissions on the "%Ens_ArchiveManager" resource to view this page.


property lblErrorLog as %ZEN.Datatype.caption [ InitialExpression = $$$TextHTML("Archive error log") ];
Property methods: lblErrorLogDisplayToLogical(), lblErrorLogGet(), lblErrorLogIsValid(), lblErrorLogLogicalToDisplay(), lblErrorLogLogicalToOdbc(), lblErrorLogNormalize(), lblErrorLogSet()
property lblHistory as %ZEN.Datatype.caption [ InitialExpression = $$$TextHTML("Archive history") ];
Property methods: lblHistoryDisplayToLogical(), lblHistoryGet(), lblHistoryIsValid(), lblHistoryLogicalToDisplay(), lblHistoryLogicalToOdbc(), lblHistoryNoneDisplayToLogical(), lblHistoryNoneGet(), lblHistoryNoneIsValid(), lblHistoryNoneLogicalToDisplay(), lblHistoryNoneLogicalToOdbc(), lblHistoryNoneNormalize(), lblHistoryNoneSet(), lblHistoryNormalize(), lblHistorySet()
property lblHistoryNone as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("No history found") ];
Property methods: lblHistoryNoneDisplayToLogical(), lblHistoryNoneGet(), lblHistoryNoneIsValid(), lblHistoryNoneLogicalToDisplay(), lblHistoryNoneLogicalToOdbc(), lblHistoryNoneNormalize(), lblHistoryNoneSet()
property lblNumberErrors as %ZEN.Datatype.caption [ InitialExpression = $$$TextHTML("Total number of errors") ];
Property methods: lblNumberErrorsDisplayToLogical(), lblNumberErrorsGet(), lblNumberErrorsIsValid(), lblNumberErrorsLogicalToDisplay(), lblNumberErrorsLogicalToOdbc(), lblNumberErrorsNormalize(), lblNumberErrorsSet()
property lblStartTime as %ZEN.Datatype.caption [ InitialExpression = $$$TextHTML("Archive start time") ];
Property methods: lblStartTimeDisplayToLogical(), lblStartTimeGet(), lblStartTimeIsValid(), lblStartTimeLogicalToDisplay(), lblStartTimeLogicalToOdbc(), lblStartTimeNormalize(), lblStartTimeSet()
property lblStatus as %ZEN.Datatype.caption [ InitialExpression = $$$TextHTML("Archive status") ];
Property methods: lblStatusDisplayToLogical(), lblStatusGet(), lblStatusIsValid(), lblStatusLogicalToDisplay(), lblStatusLogicalToOdbc(), lblStatusNormalize(), lblStatusSet()
property lblStopTime as %ZEN.Datatype.caption [ InitialExpression = $$$TextHTML("Archive stop time") ];
Property methods: lblStopTimeDisplayToLogical(), lblStopTimeGet(), lblStopTimeIsValid(), lblStopTimeLogicalToDisplay(), lblStopTimeLogicalToOdbc(), lblStopTimeNormalize(), lblStopTimeSet()
property lblTotalArchived as %ZEN.Datatype.caption [ InitialExpression = $$$TextHTML("Total messages archived") ];
Property methods: lblTotalArchivedDisplayToLogical(), lblTotalArchivedGet(), lblTotalArchivedIsValid(), lblTotalArchivedLogicalToDisplay(), lblTotalArchivedLogicalToOdbc(), lblTotalArchivedNormalize(), lblTotalArchivedSet()
property lblTotalDeletedBody as %ZEN.Datatype.caption [ InitialExpression = $$$TextHTML("Total message bodies deleted") ];
Property methods: lblTotalDeletedBodyDisplayToLogical(), lblTotalDeletedBodyGet(), lblTotalDeletedBodyIsValid(), lblTotalDeletedBodyLogicalToDisplay(), lblTotalDeletedBodyLogicalToOdbc(), lblTotalDeletedBodyNormalize(), lblTotalDeletedBodySet()
property lblTotalDeletedHead as %ZEN.Datatype.caption [ InitialExpression = $$$TextHTML("Total message headers deleted") ];
Property methods: lblTotalDeletedHeadDisplayToLogical(), lblTotalDeletedHeadGet(), lblTotalDeletedHeadIsValid(), lblTotalDeletedHeadLogicalToDisplay(), lblTotalDeletedHeadLogicalToOdbc(), lblTotalDeletedHeadNormalize(), lblTotalDeletedHeadSet()
property lblTotalProcessed as %ZEN.Datatype.caption [ InitialExpression = $$$TextHTML("Total messages processed") ];
Property methods: lblTotalProcessedDisplayToLogical(), lblTotalProcessedGet(), lblTotalProcessedIsValid(), lblTotalProcessedLogicalToDisplay(), lblTotalProcessedLogicalToOdbc(), lblTotalProcessedNormalize(), lblTotalProcessedSet()
property msgConfirm as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Are you sure you want to start archive now? Warning: Messages cannot be restored once archived to another namespace.") ];
Property methods: msgConfirmDisplayToLogical(), msgConfirmGet(), msgConfirmIsValid(), msgConfirmLogicalToDisplay(), msgConfirmLogicalToOdbc(), msgConfirmNormalize(), msgConfirmSet()
property msgDiscard as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Discard any setting changes you may have made?") ];
Property methods: msgDiscardDisplayToLogical(), msgDiscardGet(), msgDiscardIsValid(), msgDiscardLogicalToDisplay(), msgDiscardLogicalToOdbc(), msgDiscardNormalize(), msgDiscardSet()


method %OnAfterCreatePage() as %Status [ Language = objectscript ]
Set Locator bar and determine whether to show change password option.
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.
classmethod DoArchive() as %String [ Language = objectscript, ZenMethod ]
Initiates archiver on the server in the background.
classmethod DoConfigure() [ Language = objectscript, ZenMethod ]
Load current settings into Configure form.
method DrawCurrent(seed As %ZEN.Datatype.string) as %Status [ Language = objectscript ]
Draw Current parameters
method DrawErrorTitle(seed As %ZEN.Datatype.string) as %Status [ Language = objectscript ]
Draw error log title
method DrawStatus(seed As %ZEN.Datatype.string) as %Status [ Language = objectscript ]
Draw current archive status
classmethod GetArchiveStatus() as %ZEN.proxyObject [ Language = objectscript, ZenMethod ]
This method gets current archive status and return proxyObject to javascript caller for the caller to update the UI.
classmethod GetBackgroundMethodStatus() as %String [ Language = objectscript ]
Get background method status.
classmethod GetHyperEventResources(pMethod As %String = "") as %String [ Language = objectscript ]
Callback to return a list of resources required for a specific HyperEvent. The user must have sufficient privileges on one of the resource/permission pairs to be permitted to execute the hyperevent. An empty string implies the user already has sufficient privileges for the ZenMethod specified in pMethod.
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.
classmethod RunBackgroundTask() as %ZEN.Datatype.string [ Language = objectscript, ZenMethod ]
classmethod SaveData(pNamespace As %String, pClassname As %String, pDays As %String) as %String [ Language = objectscript, ZenMethod ]
Save settings to server.
clientmethod cancelSetting() [ Language = javascript ]
User clicked Close.
clientmethod doStatus() [ Language = javascript ]
This method calls server method to get current archive status and update the UI.
clientmethod editSetting() [ Language = javascript ]
User clicked Configure. Allow to modify.
clientmethod hideTable(flag) [ Language = javascript ]
User clicked Configure. Allow to modify.
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 an archive currently running, you will see continous update until job is finished.
clientmethod saveSetting() [ Language = javascript ]
User clicked Save. Validate input.
clientmethod showErrors() [ Language = javascript ]
Show or hide errors.
clientmethod startArchive() [ Language = javascript ]
User clicked Do Archive.
clientmethod timeout(timer) [ Language = javascript ]
Run Archive: function to control timer on updating archive progress This is called from onload as well (in case it is currently being run when the page is opened)
clientmethod writeResult(msg) [ Language = javascript ]

Inherited Members

Inherited Properties

Inherited Methods