Skip to main content


class %CSP.UI.Portal.Dialog.LicenseActivate extends %CSP.Portal.standardDialog, %CSP.UI.Portal.License.Utils

This class is used internally by InterSystems IRIS. You should not make direct use of it within your applications. There is no guarantee made about either the behavior or future operation of this class.

Activate New License Key dialog for Management Portal.

Property Inventory

Method Inventory


parameter APPLICATION = %CSP.UI.Portal.Application;
Class name of application this page belongs to.
parameter APPLYBUTTON = 0;
If true, then this dialog displays an Apply button.
parameter CSPURL = /csp/sys/mgr/%CSP.UI.Portal.Dialog.LicenseActivate.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 EMSSERVICE = License;
parameter PAGENAME = LicenseActivate;
Displayed name of this page.
parameter RESOURCE = %Admin_Manage;
Security requirement


property KeyFile as %String;
Property methods: KeyFileDisplayToLogical(), KeyFileGet(), KeyFileIsValid(), KeyFileLogicalToDisplay(), KeyFileLogicalToOdbc(), KeyFileNormalize(), KeyFileSet()
property NoKeyActive as %Boolean [ InitialExpression = $System.License.KeyLicenseCapacity()="Default license for configuration diagnosis." ];
Property methods: NoKeyActiveDisplayToLogical(), NoKeyActiveGet(), NoKeyActiveIsValid(), NoKeyActiveLogicalToDisplay(), NoKeyActiveLogicalToXSD(), NoKeyActiveNormalize(), NoKeyActiveSet(), NoKeyActiveXSDToLogical()
property ReturnMsg as %String;
Property methods: ReturnMsgDisplayToLogical(), ReturnMsgGet(), ReturnMsgIsValid(), ReturnMsgLogicalToDisplay(), ReturnMsgLogicalToOdbc(), ReturnMsgNormalize(), ReturnMsgSet()


method %OnAfterCreatePage() as %Status
This callback is called after the server-side page object and all of its children are created.
Subclasses can override this to add, remove, or modify items within the page object model, or to provide values for controls.
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 Activate(pFile As %String) as %ZEN.proxyObject [ ZenMethod ]
This method is called when user already confirmed to override iris.key if exists.
classmethod DrawCurrent(pSeed As %String) as %Status
method DrawFileForActivate(pFile As %String) as %Status
classmethod PrepareActivate(pFile As %String, NoKeyActive As %Boolean) as %ZEN.proxyObject [ ZenMethod ]
This method is called when user first clicked the Activate button. Evaluates the file user selected and return appropriate message. Note that this is a very basic check from the UI. Detailed check will be in the actual ##class(%SYSTEM.License).Upgrade(). When proxy.ok = 0 proxy.Message or proxy.MessageRestart indicates a confirmation is needed. proxy.ErrorMessage means Activate cannot be done.
clientmethod browseSelect(wildcard) [ Language = javascript ]
User clicked one of the Browse buttons.
clientmethod getDialogValue() [ Language = javascript ]
Inherited description: Get the value that will be applied when the user presses the OK button. This is implemented by subclasses.
clientmethod keyUp(zenEvent) [ Language = javascript ]
Check if user hit [Enter].
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 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.
clientmethod onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
clientmethod showFile(filename) [ Language = javascript ]
clientmethod validate() as %Boolean [ Language = javascript ]

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab