Home > Class Reference > ENSLIB namespace > EnsPortal.ArchiveManager
Private  Storage   


class EnsPortal.ArchiveManager extends EnsPortal.Template.standardPage

Zen based Archive Manager UI for Ensemble 2008.1


Parameters Properties Methods Queries Indices ForeignKeys Triggers
3 13 24


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

%condition %import %includeFiles %page
%resource HelpAddress ISREADONLY LocatorHeader
ParentURL 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 lblErrorLog lblHistory lblHistoryNone
lblNumberErrors lblStartTime lblStatus lblStopTime
lblTitle lblTotalArchived lblTotalDeletedBody lblTotalDeletedHead
lblTotalProcessed limitPopups msgConfirm msgDiscard
msgNotPermitted name onafterdrag onbeforedrag
onclick ondrag ondrop onhide
onrefresh onshow onupdate pageModified
parent searchKey showLabel slice
title tuple useSVG useSoftModals
valign visible width window

%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
CheckAllBlanks CheckContextLinks CheckEnterpriseManager ConvertParameter
Decrypt DoArchive DoConfigure DoLogout
DrawCurrent DrawErrorTitle DrawLocator DrawRibbon
DrawStatus DrawTitle Encrypt EscapeHTML
EscapeURL EvalResult GetArchiveStatus GetBackgroundMethodStatus
GetCSPURL GetContextLinks GetDocURL GetHomePage
GetHyperEventResources GetNewURL GetQuickLinks HyperEventCall
HyperEventHead Include InsertHiddenField InsertHiddenFields
IsPrivate Link OnDrawRibbon OnGetRibbonInfo
OnHTTPHeader OnPage OnPageError OnPostHTTP
OnPostHyperEvent OnPreHTTP OnPreHyperEvent Page
QuoteJS RegisterRecent RewriteURL RunBackgroundTask
SaveData ShowError SimpleKeepAlive StartTimer
StopTimer ThrowError UnescapeHTML UnescapeURL
XMLDTD XMLExport XMLExportToStream XMLExportToString
XMLNew XMLSchema XMLSchemaNamespace XMLSchemaType
addChild addChildAfter addChildBefore addPopupSuffix
arrowClick cancelPopup cancelSetting changePassword
changeURLNamespace checkEdit childrenMutated clientKeepAlive
correctIELayering createComponent createComponentNS deleteComponent
disableCommandButton doStatus dragFinishHandler dragHandler
dragNotifyHandler dragStartHandler dropHandler dropStartHandler
editSetting 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 hideTable
inResizeLoop initPopupSuffix invokeSuper isOfType
launchPopupWindow logout makeId navigate
onCreate onDelete onDisplayHandler onEndModalHandler
onPopupAction onRefreshContents onSerialize onServerMethodCall
onServerMethodError onServerMethodReturn onStartModalHandler ondisabledHandler
onkeydownHandler onkeyupHandler onlayoutHandler onloadHandler
onlogoutHandler onoverlayHandler onresizeHandler onunloadHandler
onupdateHandler popupActionHandler refreshContents removeChild
removePopupSuffix render renderContents renderSVG
saveSetting searchBlur searchBoxHandler searchFocus
searchKeyDown searchKeyPress setComponentId setConnectivityStatusMsg
setHidden setModified setOverlayMode setPageTitle
setProperty setPropertyAll setSortMode setSortModeHandler
setTraceOption setViewMode setViewModeHandler showAbout
showCommandButton showContact showDocumentation showErrors
showHelp startArchive startKeepAlive startModal
startProgressBar stopKeepAlive stopProgressBar switchNamespace
timeout writeResult


• 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 lblHistory as %ZEN.Datatype.caption [ InitialExpression = $$$TextHTML("Archive history") ];
• property lblHistoryNone as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("No history found") ];
• property lblNumberErrors as %ZEN.Datatype.caption [ InitialExpression = $$$TextHTML("Total number of errors") ];
• property lblStartTime as %ZEN.Datatype.caption [ InitialExpression = $$$TextHTML("Archive start time") ];
• property lblStatus as %ZEN.Datatype.caption [ InitialExpression = $$$TextHTML("Archive status") ];
• property lblStopTime as %ZEN.Datatype.caption [ InitialExpression = $$$TextHTML("Archive stop time") ];
• property lblTotalArchived as %ZEN.Datatype.caption [ InitialExpression = $$$TextHTML("Total messages archived") ];
• property lblTotalDeletedBody as %ZEN.Datatype.caption [ InitialExpression = $$$TextHTML("Total message bodies deleted") ];
• property lblTotalDeletedHead as %ZEN.Datatype.caption [ InitialExpression = $$$TextHTML("Total message headers deleted") ];
• property lblTotalProcessed as %ZEN.Datatype.caption [ InitialExpression = $$$TextHTML("Total messages processed") ];
• 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 msgDiscard as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Discard any setting changes you may have made?") ];


• method %OnAfterCreatePage() as %Status
Set Locator bar and determine whether to show change password option.
• method %OnGetPageName() as %String
Get the (localized) name of the page.
• method %OnGetTitle() as %String
Get the (localized) title string for the page.
• 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 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 GetHyperEventResources(pMethod As %String = "") as %String
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
Get information to display in the ribbon bar.
• 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.
• method cancelSetting() [ Language = javascript ]
User clicked Close.
• method doStatus() [ Language = javascript ]
This method calls server method to get current archive status and update the UI.
• method editSetting() [ Language = javascript ]
User clicked Configure. Allow to modify.
• method hideTable(flag) [ Language = javascript ]
User clicked Configure. Allow to modify.
• 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 an archive currently running, you will see continous update until job is finished.
• method saveSetting() [ Language = javascript ]
User clicked Save. Validate input.
• method showErrors() [ Language = javascript ]
Show or hide errors.
• method startArchive() [ Language = javascript ]
User clicked Do Archive.
• method 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)
• method writeResult(msg) [ Language = javascript ]