Skip to main content


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.

Property Inventory

Method Inventory


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.zen;
Inherited description: 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 HELPADDRESS = System Administration,Encryption,Manage Encryption Key File;
Inherited description: Each SMP page should set this link which points to the documentation anchor name.
parameter PAGENAME = Manage Encryption Key File;
Displayed name of this page.
parameter RESOURCE = %Admin_Secure;
Security requirement


property CurrentKeyFile as %String;
This is the current key file name after user clicked the OK button.
Property methods: CurrentKeyFileDisplayToLogical(), CurrentKeyFileGet(), CurrentKeyFileIsValid(), CurrentKeyFileLogicalToDisplay(), CurrentKeyFileLogicalToOdbc(), CurrentKeyFileNormalize(), CurrentKeyFileSet()
property CurrentKeyList as %String;
This is the current key list from the current key file.
Property methods: CurrentKeyListDisplayToLogical(), CurrentKeyListGet(), CurrentKeyListIsValid(), CurrentKeyListLogicalToDisplay(), CurrentKeyListLogicalToOdbc(), CurrentKeyListNormalize(), CurrentKeyListSet()
property LocatorHeader as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Manage Encryption Key File") ];
Inherited description: The text that is shown in TitlePane above the license
Property methods: LocatorHeaderDisplayToLogical(), LocatorHeaderGet(), LocatorHeaderIsValid(), LocatorHeaderLogicalToDisplay(), LocatorHeaderLogicalToOdbc(), LocatorHeaderNormalize(), LocatorHeaderSet()
property lblDefined as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Administrators Defined in Key File %1") ];
Property methods: lblDefinedDisplayToLogical(), lblDefinedGet(), lblDefinedIsValid(), lblDefinedLogicalToDisplay(), lblDefinedLogicalToOdbc(), lblDefinedNormalize(), lblDefinedSet()
property lblDelete as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Are you sure you want to delete administrator %1 from %2?") ];
Property methods: lblDeleteDisplayToLogical(), lblDeleteGet(), lblDeleteIsValid(), lblDeleteLogicalToDisplay(), lblDeleteLogicalToOdbc(), lblDeleteNormalize(), lblDeleteSet()
property lblDeleted as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Deleted administrator: ") ];
Property methods: lblDeletedDisplayToLogical(), lblDeletedGet(), lblDeletedIsValid(), lblDeletedLogicalToDisplay(), lblDeletedLogicalToOdbc(), lblDeletedNormalize(), lblDeletedSet()
property lblKeyTable as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Encryption Keys Defined in Key File %1") ];
Property methods: lblKeyTableDisplayToLogical(), lblKeyTableGet(), lblKeyTableIsValid(), lblKeyTableLogicalToDisplay(), lblKeyTableLogicalToOdbc(), lblKeyTableNormalize(), lblKeyTableSet()


Return the array of links to show in the locator bar.
method %OnAfterCreatePage() as %Status
Inherited description: Be sure to do ##super() when overriding.
classmethod AdminRemove(KeyFile, Username) as %ZEN.proxyObject [ ZenMethod ]
method DrawAdmin(pSeed As %String) as %Status
method DrawKeys(pSeed As %String) as %Status
classmethod KeyRemove(KeyFile, KeyID) as %ZEN.proxyObject [ ZenMethod ]
classmethod LoadFile(KeyFile) as %ZEN.proxyObject [ ZenMethod ]
Load key file
clientmethod 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.
clientmethod doAdd(what) [ Language = javascript ]
clientmethod doDelete(deleteUser) [ Language = javascript ]
clientmethod doDeleteKey(deleteKey) [ Language = javascript ]
clientmethod doOK() [ Language = javascript ]
Load key file.
clientmethod loadAdmin() [ Language = javascript ]
Load or reload Key and Admin tables after user clicked OK for Key File, or after Add or Delete.
clientmethod 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.
clientmethod onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab