Class Reference
%CSP.UI.Portal.EncryptionManage
Server:basexml
Instance:SOAXML
User:UnknownUser
 
-
  [BASEXML] >  [%CSP] >  [UI] >  [Portal] >  [EncryptionManage]
Private  Storage

class %CSP.UI.Portal.EncryptionManage extends %CSP.UI.Portal.Template

Manage Existing Encryption Key File. You may view existing adminstrators defined for a key file, delete or add more administrators to an existing key file.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
5 5 13


Summary

This is a Zen Page class. It belongs to the application %CSP.UI.Portal.Application.

Properties
%condition %import %includeFiles %page
%resource HelpAddress ISREADONLY LocatorHeader
ParentURL StdTitle aboutPage align
aux backgroundTimerInterval cellAlign cellSize
cellStyle cellVAlign children composite
containerStyle cssLevel currSortMode currStep
currViewMode disabled dragAndDrop dragEnabled
dropEnabled enclosingClass enclosingStyle error
groupClass groupStyle height hidden
hint hintClass hintStyle home
homePage id index label
labelClass labelDisabledClass labelPosition labelStyle
layout lblClose lblDefined lblDelete
lblDeleted lblTitle name onafterdrag
onbeforedrag onclick ondrag ondrop
onhide onrefresh onshow onupdate
pageModified parent searchKey showLabel
slice title tuple useSVG
useSoftModals valign visible width
window zenPersistentPopup

Methods
%%OIDGet %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
%Extends %ForceClientRender %GetChildIndex %GetComponent
%GetComponentById %GetComponentByName %GetEventHandlers %GetHomePage
%GetHomeParam %GetLinks %GetLocatorLinks %GetPageName
%GetParameter %GetProductName %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
AdminRemove BuildMenu CheckAllBlanks ConvertParameter
Decrypt DoLogout DrawAdmin DrawLocator
DrawRibbon DrawTitle Encrypt EscapeHTML
EscapeURL GetCSPURL GetContextLinks GetDocPage
GetHomePage GetNewURL GetQuickLinks HyperEventBody
HyperEventCall HyperEventFrame HyperEventHead Include
InsertHiddenField InsertHiddenFields IsPrivate Link
LoadFile OnDrawRibbon OnGetRibbonInfo OnHTTPHeader
OnPage OnPageError OnPostHTTP OnPostHyperEvent
OnPreHTTP OnPreHyperEvent Page QuoteJS
RegisterRecent RewriteURL ShowError StartTimer
StopTimer ThrowError UnescapeHTML UnescapeURL
XMLDTD XMLExport XMLExportToStream XMLExportToString
XMLNew XMLSchema XMLSchemaNamespace XMLSchemaType
ZStripW addChild addChildAfter addChildBefore
browseSelect cancelPopup changePassword childrenMutated
correctIELayering createComponent createComponentNS deleteComponent
doAdd doCancel doDelete doOK
dragFinishHandler dragHandler dragNotifyHandler dragStartHandler
dropHandler dropStartHandler endModal exposeComponent
findElement fireOnLoadEvent fireOnResizeEvent fireOnUnloadEvent
fireOnUpdateEvent firePopupAction getChildIndex getComponent
getComponentById getEnclosingDiv getHidden getHintElement
getLabelElement getOpener getProperty getSettings
getTitleAreaHeight getType goHome goMenu
gotoNamespace gotoPage invokeSuper isOfType
launchPopupWindow loadAdmin 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 render renderContents renderSVG
resetMsg searchBlur searchBoxHandler searchFocus
searchKeyDown searchKeyPress setComponentId setHidden
setModified setOverlayMode setProperty setPropertyAll
setSortMode setSortModeHandler setTraceOption setViewMode
setViewModeHandler showAbout showDocumentation showHelp
showMsg startModal startProgressBar stopProgressBar
switchNamespace


Parameters

• parameter AUTONS = 0;
Do not switch namespace for this page: it needs to stay in %SYS
• parameter CSPURL = "/csp/sys/sec/%CSP.UI.Portal.EncryptionManage.cls";
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 PAGENAME = "Manage Encryption Key File";
Displayed name of this page.
• parameter PARENTPAGE = "%CSP.Portal.Home.cls";
This parameter defines the parent page for this page.
If the name ends in .csp, then the parent is assumed to be an autopage-enabled CSP page.
If the name ends in .cls, then the parent is assumed to be a Zen page.
This is used to automate the construction of the locator bar for this page and to build the index between portal pages and documentation.
The %GetLocatorInfo method is used to get this information.
• parameter RESOURCE = "%Admin_Secure";
Security requirement

Properties

• property LocatorHeader as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Manage Encryption Key File") ];
The text that is shown in TitlePane above the license
• property lblClose as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Close") ];
• property lblDefined as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Administrators Defined in Key File %1") ];
• property lblDelete as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Are you sure you want to delete administrator %1 from %2?") ];
• property lblDeleted as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Deleted administrator: ") ];

Methods

• method %GetLocatorLinks(Output pLink) as %Status
Return the array of links to show in the locator bar.
pLink(n)=$LB(caption,link)
• method %OnAfterCreatePage() as %Status
Decorate the page.
• classmethod AdminRemove(KeyFile, Username) as %ZEN.proxyObject [ ZenMethod ]
• method DrawAdmin(pSeed As %String) as %Status
• classmethod LoadFile(KeyFile) as %ZEN.proxyObject [ ZenMethod ]
Load key file
• method browseSelect(name, wildcard) [ Language = javascript ]
User clicked one of the Browse buttons. Save the name of the textfield so that when you return you know which textfield to update.
• method doAdd() [ Language = javascript ]
• method doCancel() [ Language = javascript ]
End Add and return home page.
• method doDelete(deleteUser) [ Language = javascript ]
• method doOK() [ Language = javascript ]
Load key file.
• method loadAdmin() [ Language = javascript ]
Load or reload Admin table after user clicked OK for Key File, or after Add or Delete.
• method onPopupAction(popupName, action, value) [ Language = javascript ]
This client event, if present, is fired when the a popup page launched from this page fires an action.
• method onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.