Skip to main content


class %CSP.UI.Portal.LicenseServers extends %CSP.UI.Portal.Template, %CSP.UI.Portal.UtilsNav

System Management Portal - System Administration - License 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/mgr/%CSP.UI.Portal.LicenseServers.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 HELPADDRESS = Home,Licensing,License Server;
Inherited description: Each SMP page should set this link which points to the documentation anchor name.
parameter PAGENAME = License Servers;
Displayed name of this page.
parameter RESOURCE = %Admin_Manage;
Security requirement


property TitleCreate as %ZEN.Datatype.string [ InitialExpression = $$$Text("Create New License Server") ];
Property methods: TitleCreateDisplayToLogical(), TitleCreateGet(), TitleCreateIsValid(), TitleCreateLogicalToDisplay(), TitleCreateLogicalToOdbc(), TitleCreateNormalize(), TitleCreateSet()
property TitleEdit as %ZEN.Datatype.string [ InitialExpression = $$$Text("Edit License Server") ];
Property methods: TitleEditDisplayToLogical(), TitleEditGet(), TitleEditIsValid(), TitleEditLogicalToDisplay(), TitleEditLogicalToOdbc(), TitleEditNormalize(), TitleEditSet()


Return the array of links to show in the locator bar.
method %OnAfterCreatePage() as %Status
Inherited description: Be sure to do ##super() when overriding.
method %OnGetPageName() as %String
Get the (localized) name of the page. This should be implemented in a subclass.
classmethod DeleteData(Name As %String) as %ZEN.proxyObject [ ZenMethod ]
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 SaveData(pProxy As %ZEN.proxyObject) as %ZEN.proxyObject [ ZenMethod ]
Saves license server. pProxy.OldName not null indicate this is a modify.
clientmethod afterSave(result As %ZEN.proxyObject) [ Language = javascript ]
Inherited description: This method can be called by the doSave() function to handle what the ZenMethod of server Save returned. The method expects a proxy object to be passed. result.ok = 1 indicates save is successful. result.Message is a message (not an error message) that should be displayed. result.ok = 0 indicates save has failed. result.ErrorMessage should be displayed. If result.ok = 1 and result.Message is null then the edit form is closed and the ParentURL is displayed.
clientmethod browseSelect(name) [ Language = javascript ]
User clicked the Browse button.
clientmethod doCancel() [ Language = javascript ]
Cancel the current edit - hide edit form.
clientmethod doDelete(name, address, port) [ Language = javascript ]
Delete a license server.
clientmethod doEdit(name, address, port, dir) [ Language = javascript ]
Edit an existing one - load current values
clientmethod doSave() [ Language = javascript ]
Save edit
clientmethod filterChanged(value) [ Language = javascript ]
User entered something in to the filter. Re-load the table with filter value.
clientmethod onPopupAction(popupName, action, value) [ Language = javascript ]
The id of the field that needs to be updated is saved in "dialogClicked".
clientmethod validate() [ Language = javascript ]

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab