Class Reference
IRIS for UNIX 2024.1.2
InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [%CSP] >  [UI] >  [Portal] >  [Dialog] >  [ArchiveWizard]
Private  Storage   

class %CSP.UI.Portal.Dialog.ArchiveWizard extends %CSP.UI.Portal.Dialog.WizardTemplate

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
7 3 13


Summary

This is a Zen Page class. 

Properties
%condition %import %includeFiles %page
%resource FirstFailed InvalidParam IsEMSReadOnly
IsEditForm PID ValidationErrorMsg align
aux backgroundTimerInterval cellAlign cellSize
cellStyle cellVAlign children composite
containerStyle cssLevel dialogTitle disabled
disabledStyle dragAndDrop dragEnabled dropEnabled
enclosingClass enclosingStyle error groupClass
groupStyle height helpId hidden
hideApplyButton hideCancelButton hint hintClass
hintStyle id index isNew
label labelClass labelDisabledClass labelPosition
labelStyle layout name onafterdrag
onbeforedrag onclick ondrag ondrop
onhide onrefresh onshow onupdate
parent showLabel slice title
tuple useSVG useSoftModals valign
visible width window zenPersistentPopup

Methods
%AddChild %AddChildAfter %AddChildBefore %AddComponent
%AddImportedComponents %AddToSaveSet %ApplyURLParms %Attr
%BindExport %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %DrawAutoLogout
%DrawClassDefinitions %DrawComponentHTML %DrawHTML %DrawHTMLPage
%DrawJSStrings %DrawObjectDefinitions %DrawTitle %EnclosingDivId
%EndBackgroundMethod %EndScript %Eval %EvalC
%Extends %ForceClientRender %GetChildIndex %GetComponent
%GetComponentById %GetComponentByName %GetEventHandlers %GetLinks
%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 %OnGetSubtitle
%OnGetTitle %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 ConvertParameter Decrypt Encrypt
EscapeHTML EscapeURL EvalResult HyperEventCall
HyperEventHead Include InsertHiddenField InsertHiddenFields
IsEnabled IsPrivate JavaInstalled Link
OnHTTPHeader OnPage OnPageError OnPostHTTP
OnPostHyperEvent OnPreHTTP OnPreHyperEvent Page
QuoteJS RewriteURL SaveData ShowError
StartTimer StopTimer ThrowError UnescapeHTML
UnescapeURL UpdateTableNavState XMLDTD XMLExport
XMLExportToStream XMLExportToString XMLNew XMLSchema
XMLSchemaNamespace XMLSchemaType addChild addChildAfter
addChildBefore adjustSize btnApply btnOK
canFinish canGoBack canGoNext cancelPopup
changeType childrenMutated correctIELayering createComponent
createComponentNS ctrlKeyDown deleteComponent dialogApply
dialogCancel dialogFinish dialogTitleGet disableButtons
doModified doSave dragFinishHandler dragHandler
dragNotifyHandler dragStartHandler dropHandler dropStartHandler
endModal exposeComponent findElement fireOnResizeEvent
fireOnUnloadEvent fireOnUpdateEvent firePopupAction formValidationHandler
getChildIndex getComponent getComponentById getDialogValue
getEnclosingDiv getHidden getHintElement getLabelElement
getOpener getPageTitle getProperty getSettings
getType gotoPage hasMultiplePages invokeSuper
isOfType launchPopupWindow makeId navMaxRowsChanged
navPageSizeChanged nextPage onCreate onDelete
onDisplayHandler onEndModalHandler onPopupAction onRefreshContents
onSerialize onServerMethodCall onServerMethodError onServerMethodReturn
onStartModalHandler ondialogCancel ondialogFinish ondialogStart
ondisabledHandler onfinishHandler onhandleAutoLogoutWarn onkeydownHandler
onkeyupHandler onlayoutHandler onloadHandler onlogoutHandler
onoverlayHandler onresizeHandler onstartHandler onunloadHandler
onupdateHandler popupActionHandler previousPage refreshContents
removeChild render renderContents renderSVG
resetMsg setComponentId setHidden setOverlayMode
setProperty setPropertyAll setTraceOption showDocumentation
showHelp showMsg startModal startProgressBar
stopProgressBar updateState validate validateRequired


Parameters

• parameter AUTONS = 0;
Do not switch namespace for this page: it needs to stay in %SYS
• parameter CSPURL = "/csp/sys/mgr/%CSP.UI.Portal.Dialog.ArchiveWizard.zen";
This parameter is used to make sure that if multiple CSP applications are mapped to the same namespace that the CSP engine can correctly identify which class corresponds with which URL. If 'LockCSPName' is true (the default, defined in the CSP application) then you can only access this page if the url exactly matches this 'CSPURL'. You can set this parameter to "" if you wish to disable this check for this class. This check is applied for all CSP urls (cls/csp/zen).
If this page was compiled from a .csp file, then this parameter is automatically set to contain the url of this file used for compilation.
• parameter EMSSERVICE = "Namespace";
• parameter HELPADDRESS = "System Administration, Configuration, System Configuration, Archive Target Settings, Add Archive Target";
• parameter PAGENAME = "Edit Archive Target";
Displayed name of this page.
• parameter RECENT = 0;
• parameter RESOURCE = "%Admin_Manage";
Security requirement

Properties

• property IsEditForm as %Boolean [ InitialExpression = 1 ];
• property PID as %String(ZENURL="PID");
Archive for edit. Null if adding new archive.
• property isNew as %String(ZENURL="isNew") [ InitialExpression = "1" ];

Methods

• method %OnGetSubtitle() as %String
Get the (localized) subtitle string for the dialog. This should be implemented in a subclass.
• method %OnGetTitle() as %String
Get the (localized) title string for the dialog. This should be implemented in a subclass.
• classmethod SaveData(pProxy As %ZEN.proxyObject) as %ZEN.proxyObject [ ZenMethod ]
• classmethod UpdateTableNavState(pFilter As %String, pPageSize As %Integer, pMaxRows As %Integer, pPID As %String) [ ZenMethod ]
Used to Save tableNavBar values, add PID to the page name to distinguish the type for the page.
• method changeType(newvalue) [ Language = javascript ]
• method doModified(newvalue) [ Language = javascript ]
• method doSave() as %Boolean [ Language = javascript ]
Process save and create new archive. Return true if success. OW return false.
• method getDialogValue() [ Language = javascript ]
Get the value that will be applied when the user presses the OK button. This is implemented by subclasses.
• method getPageTitle() as %String [ Language = javascript ]
Get the title string to add to the locator row.
• method navMaxRowsChanged(value) [ Language = javascript ]
Overriden to add PID to the page name to distinguish the specific page.
• method navPageSizeChanged(value) [ Language = javascript ]
Overriden to add PID to the page name to distinguish the specific page.
• method ondialogFinish(action) as %Boolean [ Language = javascript ]
This callback, if defined, is called when the user presses the OK or Apply action buttons.
If this returns false, then the action is cancelled.
• method validate() as %Boolean [ Language = javascript ]


Copyright (c) 2025 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.