Skip to main content


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

Data Element Encryption Key. You may activate or deactivate a data element encryption key.

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


property CurrentlyActivated as %ZEN.Datatype.integer;
This is the actual number already activated.
Property methods: CurrentlyActivatedDisplayToLogical(), CurrentlyActivatedGet(), CurrentlyActivatedIsValid(), CurrentlyActivatedLogicalToDisplay(), CurrentlyActivatedLogicalToOdbc(), CurrentlyActivatedNormalize(), CurrentlyActivatedSet()
property LocatorHeader as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Data Element Encryption") ];
Inherited description: The text that is shown in TitlePane above the license
Property methods: LocatorHeaderDisplayToLogical(), LocatorHeaderGet(), LocatorHeaderIsValid(), LocatorHeaderLogicalToDisplay(), LocatorHeaderLogicalToOdbc(), LocatorHeaderNormalize(), LocatorHeaderSet()
property MaxAllowed as %ZEN.Datatype.integer;
This is the max number allowed to be activated.
Property methods: MaxAllowedDisplayToLogical(), MaxAllowedGet(), MaxAllowedIsValid(), MaxAllowedLogicalToDisplay(), MaxAllowedLogicalToOdbc(), MaxAllowedNormalize(), MaxAllowedSet()
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(KeyFile, Username, Password) as %ZEN.proxyObject [ ZenMethod ]
Save general data to server
classmethod DeactivateKey(MKEncKeyID) as %ZEN.proxyObject [ ZenMethod ]
Save general data to server
method DrawIDs(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.
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 doDeactivate(MKEncKeyID) [ Language = javascript ]
User clicked the "Deactivate". Process only if confirmed.
clientmethod doSave() [ Language = javascript ]
Get user selection and send to server to activate key.
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 ]
Inherited description: Disable save button for EMS-managed pages. Be sure to use this.invokeSuper('onloadHandler',arguments); when overriding.
clientmethod refreshPage() [ Language = javascript ]
clientmethod validate() as %Boolean [ Language = javascript ]

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab