Class %CSP.UI.Portal.LicenseUsage

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

Zen page for System Management Portal - License Usage

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
6	7	17

Summary

This is a Zen Page class. It belongs to the application %CSP.UI.Portal.Application.

Properties
%condition	%import	%includeFiles	%page
%resource	CurrentColumn	CurrentSort	Filter
FirstFailed	HelpAddress	ISREADONLY	InvalidParam
IsEMSReadOnly	IsEditForm	LicenseServerUsed	LocatorHeader
OnclickArray	PID	ParentURL	PrevProcessFilter
PrevUserFilter	ProcessFilter	StdTitle	TableMaxRows
TablePageSize	UserFilter	ValidationErrorMsg	aboutPage
align	aux	backgroundTimerInterval	captionLastUpdate
cellAlign	cellSize	cellStyle	cellVAlign
children	composite	contactPage	containerStyle
cssLevel	currSortMode	currStep	currViewMode
disabled	dragAndDrop	dragEnabled	dropEnabled
enableAutoRefresh	enclosingClass	enclosingStyle	error
groupClass	groupStyle	height	hidden
hint	hintClass	hintStyle	home
homePage	id	index	label
labelClass	labelDisabledClass	labelPosition	labelStyle
layout	lblTitle	limitPopups	name
onafterdrag	onbeforedrag	onclick	ondrag
ondrop	onhide	onrefresh	onshow
onupdate	pageModified	parent	searchKey
showLabel	slice	title	tuple
useSVG	useSoftModals	valign	visible
width	window	zenPersistentPopup

Methods
%AddChild	%AddChildAfter	%AddChildBefore	%AddComponent
%AddImportedComponents	%AddLocatorLinks	%AddToSaveSet	%ApplyURLParms
%Attr	%BindExport	%ClassIsLatestVersion	%ClassName
%ConstructClone	%DispatchClassMethod	%DispatchGetModified	%DispatchGetProperty
%DispatchMethod	%DispatchSetModified	%DispatchSetMultidimProperty	%DispatchSetProperty
%DrawAutoLogout	%DrawClassDefinitions	%DrawComponentHTML	%DrawHTML
%DrawHTMLPage	%DrawJSStrings	%DrawObjectDefinitions	%EnclosingDivId
%EndBackgroundMethod	%EndScript	%Eval	%EvalC
%Extends	%ForceClientRender	%GetChildIndex	%GetComponent
%GetComponentById	%GetComponentByName	%GetEventHandlers	%GetHomePage
%GetHomeParam	%GetLinks	%GetLocatorLinks	%GetNavTableState
%GetPageName	%GetParameter	%GetProductName	%GetValueById
%GetValueByName	%GetXMLName	%IsA	%IsModified
%Link	%LinkCSS	%LinkScript	%MakeId
%New	%NormalizeObject	%ObjectModified	%OnAddToPageAfter
%OnAddToPageBefore	%OnAfterCreatePage	%OnBeforeCreatePage	%OnCreateApplication
%OnCreatePage	%OnDetermineCSSLevel	%OnDrawEnclosingDiv	%OnDrawHTMLBody
%OnDrawHTMLHead	%OnDrawHTMLMeta	%OnDrawObjectProperties	%OnFinishBackgroundTask
%OnGetPageName	%OnGetProductName	%OnGetSmallMenu	%OnGetTitle
%OnMonitorBackgroundTask	%OnMutateChildren	%OnObjectSynch	%OnPreHTTP
%OnSubmit	%OnUseSoftModals	%OnZENDeserialize	%OriginalNamespace
%PackageName	%QuoteValue	%QuoteValueL10N	%Register
%RemoveChild	%RemoveChildren	%RemoveComponent	%RemoveFromSaveSet
%RunBackgroundMethod	%Self	%SerializeObject	%SetBackgroundMethodStatus
%SetErrorById	%SetErrorByName	%SetModified	%SetValueById
%SetValueByName	%SetValuesByName	%StartScript	%ValidateObject
%ZENVersion	BuildMenu	BuildMeter	CheckAllBlanks
CheckContextLinks	CheckEnterpriseManager	ConvertParameter	CreateRS2
CreateRS3	Decrypt	DoLogout	DrawAutoRefresh
DrawLocator	DrawRibbon	DrawTitle	Encrypt
EscapeHTML	EscapeURL	EvalResult	ExecuteRS2
ExecuteRS3	GetCSPURL	GetContextLinks	GetDocURL
GetHomePage	GetNewURL	GetQuickLinks	HyperEventCall
HyperEventHead	Include	InsertHiddenField	InsertHiddenFields
IsPrivate	JavaInstalled	LastUpdateTime	Link
OnDrawRibbon	OnGetRibbonInfo	OnHTTPHeader	OnPage
OnPageError	OnPostHTTP	OnPostHyperEvent	OnPreHTTP
OnPreHyperEvent	Page	QuoteJS	RegisterRecent
RewriteURL	ShowError	StartTimer	StopTimer
ThrowError	UnescapeHTML	UnescapeURL	UpdateAutoRefreshRate
UpdateAutoRefreshState	UpdateTableNavState	UpdateTableState	XMLDTD
XMLExport	XMLExportToStream	XMLExportToString	XMLNew
XMLSchema	XMLSchemaNamespace	XMLSchemaType	addChild
addChildAfter	addChildBefore	afterSave	afterValidate
cancelPopup	changePassword	childrenMutated	columnSort
correctIELayering	createComponent	createComponentNS	deleteComponent
disableCommandButton	doCancel	doDetails	doModified
dragFinishHandler	dragHandler	dragNotifyHandler	dragStartHandler
dropHandler	dropStartHandler	enableCommandButton	endModal
exposeComponent	filterChanged	findElement	fireOnResizeEvent
fireOnUnloadEvent	fireOnUpdateEvent	firePopupAction	getChildIndex
getComponent	getComponentById	getEnclosingDiv	getHidden
getHintElement	getLabelElement	getOpener	getOptionTitle
getPageTitle	getProperty	getSettings	getTime
getTitleAreaHeight	getType	goHome	goMenu
gotoNamespace	gotoPage	hideCommandButton	invokeSuper
isButtonDisabled	isOfType	launchPopupWindow	logout
makeId	navMaxRowsChanged	navPageSizeChanged	navigate
onCreate	onDelete	onDisplayHandler	onEndModalHandler
onPopupAction	onRefreshContents	onSerialize	onServerMethodCall
onServerMethodError	onServerMethodReturn	onStartModalHandler	ondisabledHandler
onhandleAutoLogoutWarn	onkeydownHandler	onkeyupHandler	onlayoutHandler
onloadHandler	onlogoutHandler	onoverlayHandler	onresizeHandler
onunloadHandler	onupdateHandler	popupActionHandler	refreshContents
refreshHandler	refreshkeyUp	removeChild	render
renderContents	renderSVG	resetMsg	searchBlur
searchBoxHandler	searchFocus	searchKeyDown	searchKeyPress
setComponentId	setConnectivityStatusMsg	setHidden	setModified
setOverlayMode	setPageTitle	setProperty	setPropertyAll
setRefreshMode	setRefreshRate	setSortMode	setSortModeHandler
setTraceOption	setViewMode	setViewModeHandler	showAbout
showCommandButton	showContact	showDocumentation	showHelp
showMsg	startModal	startProgressBar	stopProgressBar
switchNamespace	trimSpace	updateTime	updateView
validateRequired	zeroFill

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";

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";

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;

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 PrevProcessFilter as %ZEN.Datatype.string [ InitialExpression = "PrevFilter" ];

• property PrevUserFilter as %ZEN.Datatype.string [ InitialExpression = "PrevFilter" ];

• 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 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 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 UserFilter as %ZEN.Datatype.string;

Methods

• method %GetLocatorLinks(Output pLink) as %Status

Return the array of links to show in the locator bar.
pLink(n)=$LB(caption,link)

• method %OnAfterCreatePage() as %Status

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

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.

• method doDetails(index) [ Language = javascript ]

• method filterChanged(tableId, value) [ Language = javascript ]

User entered something in to the filter. Re-load the table with filter value.

• method getOptionTitle(index) [ Language = javascript ]

• method navMaxRowsChanged(value, tableId) [ Language = javascript ]

Overriden to add tabId and tableId to the page name to distinguish the type for the page.

• method navPageSizeChanged(value, tableId) [ Language = javascript ]

Overriden to add tabId and tableId to the page name to distinguish the type for the page.

• method onloadHandler() [ Language = javascript ]

This client event, if present, is fired when the page is loaded.

• method updateView() [ Language = javascript ]

On auto-refresh, or after Resume or Suspend, reload page with the current tab selected.

Class Reference IRIS for UNIX 2024.1.2
Documentation Search