Skip to main content


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

Database Encryption Keys. Activate, Deactivate database encryption key and configure startup options.

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


property AllowMultiDB as %Boolean [ InitialExpression = 1 ];
Wheter to allow multiple DB Encryption (restrict it in 2013.2 and allow for 2014.1+)
Property methods: AllowMultiDBDisplayToLogical(), AllowMultiDBGet(), AllowMultiDBIsValid(), AllowMultiDBLogicalToDisplay(), AllowMultiDBLogicalToXSD(), AllowMultiDBNormalize(), AllowMultiDBSet(), AllowMultiDBXSDToLogical()
property DefaultKey as %String;
Current activated default key.
Property methods: DefaultKeyDisplayToLogical(), DefaultKeyGet(), DefaultKeyIsValid(), DefaultKeyLogicalToDisplay(), DefaultKeyLogicalToOdbc(), DefaultKeyNormalize(), DefaultKeySet()
property JournalKey as %String;
Current activated key for journals.
Property methods: JournalKeyDisplayToLogical(), JournalKeyGet(), JournalKeyIsValid(), JournalKeyLogicalToDisplay(), JournalKeyLogicalToOdbc(), JournalKeyNormalize(), JournalKeySet()
property KeyFileName as %String;
Key File for Unattended.
Property methods: KeyFileNameDisplayToLogical(), KeyFileNameGet(), KeyFileNameIsValid(), KeyFileNameLogicalToDisplay(), KeyFileNameLogicalToOdbc(), KeyFileNameNormalize(), KeyFileNameSet()
property KeyLenList as %String;
List of currently activated key lengths, comma delimited.
Property methods: KeyLenListDisplayToLogical(), KeyLenListGet(), KeyLenListIsValid(), KeyLenListLogicalToDisplay(), KeyLenListLogicalToOdbc(), KeyLenListNormalize(), KeyLenListSet()
property KeyList as %String;
List of Current activated keys delimited by commas.
Property methods: KeyListDisplayToLogical(), KeyListGet(), KeyListIsValid(), KeyListLogicalToDisplay(), KeyListLogicalToOdbc(), KeyListNormalize(), KeyListSet()
property LocatorHeader as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Database Encryption") ];
Inherited description: The text that is shown in TitlePane above the license
Property methods: LocatorHeaderDisplayToLogical(), LocatorHeaderGet(), LocatorHeaderIsValid(), LocatorHeaderLogicalToDisplay(), LocatorHeaderLogicalToOdbc(), LocatorHeaderNormalize(), LocatorHeaderSet()
property PageURL as %ZEN.Datatype.string;
Property methods: PageURLDisplayToLogical(), PageURLGet(), PageURLIsValid(), PageURLLogicalToDisplay(), PageURLLogicalToOdbc(), PageURLNormalize(), PageURLSet()
property browseselect as %String;
Property methods: browseselectDisplayToLogical(), browseselectGet(), browseselectIsValid(), browseselectLogicalToDisplay(), browseselectLogicalToOdbc(), browseselectNormalize(), browseselectSet()
property lblDeactivate as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Are you sure you want to deactivate key %1?") ];
Property methods: lblDeactivateDisplayToLogical(), lblDeactivateGet(), lblDeactivateIsValid(), lblDeactivateLogicalToDisplay(), lblDeactivateLogicalToOdbc(), lblDeactivateNormalize(), lblDeactivateSet()


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 ActivateKey(pKeyFile, pUsername, pPassword) as %ZEN.proxyObject [ ZenMethod ]
Save general data to server
classmethod DeactivateKey(pKeyID) as %ZEN.proxyObject [ ZenMethod ]
Save general data to server
method DrawIDs(pSeed As %String) as %Status
Draw activated databases encryption key identifier table
method DrawWarning(pSeed As %String) as %Status
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 SaveStartup(pMode, pJournalFile, pIRISTemp, pAuditEncrypt, pKeyFile, pUsername, pPassword) as %ZEN.proxyObject [ ZenMethod ]
Save startup settings to server.
classmethod SetDefaultKey(pKeyID, use) as %ZEN.proxyObject [ ZenMethod ]
Set new default key to server.
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 doActivate() [ Language = javascript ]
User clicked the "Activate Key" button. Show the form to Activate.
clientmethod doCancel() [ Language = javascript ]
Hide edit forms.
clientmethod doConfigure() [ Language = javascript ]
User clicked the "Configure Startup Settings" button. Show the form to configure.
clientmethod doDeactivate(KeyID) [ Language = javascript ]
User clicked the "Deactivate Key" button. Process only if confirmed.
clientmethod doDefault(KeyID, use) [ Language = javascript ]
User clicked the "Set Default" button to change default key id.
clientmethod doFileChange() [ Language = javascript ]
User changed Key File. Enable fields if file name is changed.
clientmethod doOptions(option) [ Language = javascript ]
User selected a Startup option. Show or hide related fields based on selection.
clientmethod doSave() [ Language = javascript ]
Get user selection and send to server to activate key.
clientmethod doSaveStartup() [ Language = javascript ]
Get user selection and send to server to save.
clientmethod getPageTitle() as %String [ Language = javascript ]
Get the title string to add to the locator row.
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 ]
Multiple DB Encryption is allowed starting from 2014.1. And Configure Startup Settings is always allowed.
clientmethod refreshPage() [ Language = javascript ]
Reload page.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab