This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > ENSLIB namespace > CSPX.Portal.ArchiveManager


class CSPX.Portal.ArchiveManager extends CSPX.Portal.Template

Zen based Archive Manager UI for Ensemble 2008.1

Property Inventory

Method Inventory


parameter APPLICATION = CSPX.Portal.Application;
Class name of application this page belongs to.
parameter PAGENAME = Archive Manager;
Displayed name of 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
Set Locator bar and determine whether to show change password option.
classmethod CheckAllBlanks(string) as %Boolean [ ZenMethod ]
classmethod DoArchive() as %String [ ZenMethod ]
Initiates archiver on the server in the background.
classmethod DoConfigure() [ ZenMethod ]
Load current settings into Configure form.
method DrawCurrent(seed As %ZEN.Datatype.string) as %Status
Draw Current parameters
method DrawErrorTitle(seed As %ZEN.Datatype.string) as %Status
Draw error log title
method DrawStatus(seed As %ZEN.Datatype.string) as %Status
Draw current archive status
classmethod DrawTitle(pSeed As %String) as %Status
Used to draw title for this page. pHalpAddress is need to build the link for Help for this page.
classmethod GetArchiveStatus() as %ZEN.proxyObject [ ZenMethod ]
This method gets current archive status and return proxyObject to javascript caller for the caller to update the UI.
classmethod GetBackgroundMethodStatus() as %String
Get background method status.
classmethod RunBackgroundTask() as %ZEN.Datatype.string [ ZenMethod ]
classmethod SaveData(pNamespace As %String, pClassname As %String, pDays As %String) as %String [ 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