Skip to main content

This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.Opens in a new tab

For information on migrating to InterSystems IRISOpens in a new tab, see Why Migrate to InterSystems IRIS?

%CSP.UI.Portal.LicenseUsage

class %CSP.UI.Portal.LicenseUsage extends %CSP.UI.Portal.Utils

Zen page for System Management Portal - License Usage

Property Inventory

Method Inventory

Parameters

parameter AUTONS = 0;
Do not switch namespace for this page: it needs to stay in %SYS
parameter CSPURL = /csp/sys/op/%CSP.UI.Portal.LicenseUsage.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 = Home,License Usage;
Inherited description: Each SMP page should set this link which points to the documentation anchor name.
parameter PAGENAME = License Usage;
Displayed name of this page.
parameter RECENT = 0;
Inherited description: If true, register visits to this page in the recent list.
parameter RESOURCE = %Admin_Operate;
Security requirement

Properties

property LicenseServerUsed as %Boolean;
Whether license server is used
Property methods: LicenseServerUsedDisplayToLogical(), LicenseServerUsedGet(), LicenseServerUsedIsValid(), LicenseServerUsedLogicalToDisplay(), LicenseServerUsedLogicalToXSD(), LicenseServerUsedNormalize(), LicenseServerUsedSet(), LicenseServerUsedXSDToLogical()
property PrevProcessFilter as %ZEN.Datatype.string [ InitialExpression = "PrevFilter" ];
Property methods: PrevProcessFilterDisplayToLogical(), PrevProcessFilterGet(), PrevProcessFilterIsValid(), PrevProcessFilterLogicalToDisplay(), PrevProcessFilterLogicalToOdbc(), PrevProcessFilterNormalize(), PrevProcessFilterSet()
property PrevUserFilter as %ZEN.Datatype.string [ InitialExpression = "PrevFilter" ];
Property methods: PrevUserFilterDisplayToLogical(), PrevUserFilterGet(), PrevUserFilterIsValid(), PrevUserFilterLogicalToDisplay(), PrevUserFilterLogicalToOdbc(), PrevUserFilterNormalize(), PrevUserFilterSet()
property ProcessFilter as %ZEN.Datatype.string;
Filter value user entered into the "Filter" field in the table navigator. This value is saved and reloaded for this page.
Property methods: ProcessFilterDisplayToLogical(), ProcessFilterGet(), ProcessFilterIsValid(), ProcessFilterLogicalToDisplay(), ProcessFilterLogicalToOdbc(), ProcessFilterNormalize(), ProcessFilterSet()
property TableMaxRows as %Integer [ InitialExpression = "1000" ];
Max rows value user entered into the "Max rows" field in the table navigator. This value is saved and reloaded for this page.
Property methods: TableMaxRowsDisplayToLogical(), TableMaxRowsGet(), TableMaxRowsIsValid(), TableMaxRowsLogicalToDisplay(), TableMaxRowsNormalize(), TableMaxRowsSet(), TableMaxRowsXSDToLogical()
property TablePageSize as %Integer [ InitialExpression = "0" ];
Page size value user entered into the "Page size" field in the table navigator. This value is saved and reloaded for this page.
Property methods: TablePageSizeDisplayToLogical(), TablePageSizeGet(), TablePageSizeIsValid(), TablePageSizeLogicalToDisplay(), TablePageSizeNormalize(), TablePageSizeSet(), TablePageSizeXSDToLogical()
property UserFilter as %ZEN.Datatype.string;
Property methods: UserFilterDisplayToLogical(), UserFilterGet(), UserFilterIsValid(), UserFilterLogicalToDisplay(), UserFilterLogicalToOdbc(), UserFilterNormalize(), UserFilterSet()

Methods

Return the array of links to show in the locator bar.
pLink(n)=$LB(caption,link)
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.
method CreateRS2(Output tSC As %Status, pInfo As %ZEN.Auxiliary.QueryInfo) as %ResultSet
pInfo holds details on how to create the query.
method CreateRS3(Output tSC As %Status, pInfo As %ZEN.Auxiliary.QueryInfo) as %ResultSet
pInfo holds details on how to create the query.
method ExecuteRS2(pRS As %Library.ResultSet, Output tSC As %Status, pInfo As %ZEN.Auxiliary.QueryInfo) as %Boolean
Method for executing the process query.
method ExecuteRS3(pRS As %Library.ResultSet, Output tSC As %Status, pInfo As %ZEN.Auxiliary.QueryInfo) as %Boolean
Method for executing the process query.
method OnDrawRibbon() as %Status
Add to the contents of the tool ribbon.
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
Inherited description: Get information to display in the ribbon bar.
classmethod UpdateTableNavState(pFilter As %String, pPageSize As %Integer, pMaxRows As %Integer, ptableId As %String) [ ZenMethod ]
Used to Save tableNavBar values, add MapType to the page name to distinguish the type for the page.
clientmethod doDetails(index) [ Language = javascript ]
clientmethod filterChanged(tableId, value) [ Language = javascript ]
User entered something in to the filter. Re-load the table with filter value.
clientmethod getOptionTitle(index) [ Language = javascript ]
Overriden to add tabId and tableId to the page name to distinguish the type for the page.
Overriden to add tabId and tableId to the page name to distinguish the type for the page.
clientmethod onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
clientmethod updateView() [ Language = javascript ]
On auto-refresh, or after Resume or Suspend, reload page with the current tab selected.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab