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


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

Zen based Archive Manager UI for Ensemble 2008.1


Parameters Properties Methods Queries Indices ForeignKeys Triggers
2 13 22


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

%condition %import %includeFiles %page
%resource StdTitle align aux
backgroundTimerInterval cellAlign cellSize cellStyle
cellVAlign children composite containerStyle
cssLevel disabled dragAndDrop dragEnabled
dropEnabled enclosingClass enclosingStyle error
groupClass groupStyle height hidden
hint hintClass hintStyle id
index label labelClass labelDisabledClass
labelPosition labelStyle layout lblErrorLog
lblHistory lblHistoryNone lblNumberErrors lblStartTime
lblStatus lblStopTime lblTotalArchived lblTotalDeletedBody
lblTotalDeletedHead lblTotalProcessed msgConfirm msgDiscard
name onafterdrag onbeforedrag onclick
ondrag ondrop onhide onrefresh
onshow onupdate parent showLabel
slice title tuple useSVG
useSoftModals valign visible width
window zenPersistentPopup

%AddChild %AddChildAfter %AddChildBefore %AddComponent
%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 %GetLinks
%GetNamespaces %GetPageName %GetParameter %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
%OnMonitorBackgroundTask %OnMutateChildren %OnObjectSynch %OnPreHTTP
%OnSubmit %OnUseSoftModals %OnZENDeserialize %OriginalNamespace
%PackageName %QuoteValue %QuoteValueL10N %RemoveChild
%RemoveChildren %RemoveComponent %RemoveFromSaveSet %RunBackgroundMethod
%Self %SerializeObject %SetBackgroundMethodStatus %SetErrorById
%SetErrorByName %SetModified %SetValueById %SetValueByName
%SetValuesByName %StartScript %ValidateObject %ZENVersion
CheckAllBlanks ConvertParameter Decrypt DoArchive
DoConfigure DrawCurrent DrawErrorTitle DrawStatus
DrawTitle Encrypt EscapeHTML EscapeURL
GetArchiveStatus GetBackgroundMethodStatus GetQuickLinks HyperEventCall
HyperEventHead Include InsertHiddenField InsertHiddenFields
IsPrivate Link OnHTTPHeader OnPage
OnPageError OnPostHTTP OnPostHyperEvent OnPreHTTP
OnPreHyperEvent Page QuoteJS RewriteURL
RunBackgroundTask SaveData ShowError StartTimer
StopTimer ThrowError UnescapeHTML UnescapeURL
XMLDTD XMLExport XMLExportToStream XMLExportToString
XMLNew XMLSchema XMLSchemaNamespace XMLSchemaType
addChild addChildAfter addChildBefore arrowClick
cancelPopup cancelSetting childrenMutated correctIELayering
createComponent createComponentNS deleteComponent doStatus
dragFinishHandler dragHandler dragNotifyHandler dragStartHandler
dropHandler dropStartHandler editSetting endModal
exposeComponent findElement fireOnResizeEvent fireOnUnloadEvent
fireOnUpdateEvent firePopupAction getChildIndex getComponent
getComponentById getEnclosingDiv getHidden getHintElement
getLabelElement getOpener getProperty getSettings
getType gotoPage hideTable invokeSuper
isOfType launchPopupWindow makeId onCreate
onDelete onDisplayHandler onEndModalHandler onPopupAction
onRefreshContents onSerialize onServerMethodCall onServerMethodError
onServerMethodReturn onStartModalHandler ondisabledHandler onkeydownHandler
onkeyupHandler onlayoutHandler onloadHandler onlogoutHandler
onoverlayHandler onresizeHandler onunloadHandler onupdateHandler
popupActionHandler refreshContents removeChild render
renderContents renderSVG saveSetting setComponentId
setHidden setOverlayMode setProperty setPropertyAll
setTraceOption showDocumentation showErrors startArchive
startModal startProgressBar stopProgressBar timeout


• 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 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.
• 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.
• 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 ]