Class %CSP.UI.Portal.Mappings

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

Zen page for System Management Portal - Show Databases Freespace

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
8	5	24

Summary

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

Properties
%condition	%import	%includeFiles	%page
%resource	CPFMapFile	CPFMapName	EditPage
Filter	FirstFailed	HelpAddress	ISREADONLY
InvalidParam	IsEMSReadOnly	IsEditForm	LocatorHeader
MapType	Namespace	OnclickArray	PID
ParentURL	StdTitle	TableMaxRows	TablePageSize
ValidationErrorMsg	aboutPage	align	aux
backgroundTimerInterval	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	CancelChanges	CheckAllBlanks
CheckContextLinks	CheckEnterpriseManager	ConvertParameter	Decrypt
DeleteItem	DoLogout	DrawCollation	DrawLocator
DrawRibbon	DrawTitle	Encrypt	EscapeHTML
EscapeURL	EvalResult	GetCSPURL	GetContextLinks
GetDocURL	GetHomePage	GetNewURL	GetQuickLinks
HyperEventCall	HyperEventHead	Include	Init
InsertHiddenField	InsertHiddenFields	IsPrivate	JavaInstalled
Link	OnDrawRibbon	OnGetRibbonInfo	OnHTTPHeader
OnPage	OnPageError	OnPostHTTP	OnPostHyperEvent
OnPreHTTP	OnPreHyperEvent	Page	QuoteJS
RegisterRecent	RewriteURL	SaveChanges	ShowError
StartTimer	StopTimer	ThrowError	UnescapeHTML
UnescapeURL	UpdateTableNavState	XMLDTD	XMLExport
XMLExportToStream	XMLExportToString	XMLNew	XMLSchema
XMLSchemaNamespace	XMLSchemaType	addChild	addChildAfter
addChildBefore	afterSave	afterValidate	cancelPopup
changePassword	childrenMutated	correctIELayering	createComponent
createComponentNS	deleteComponent	deleteMapping	disableCommandButton
doCancel	doDiscard	doModified	doSave
dragFinishHandler	dragHandler	dragNotifyHandler	dragStartHandler
dropHandler	dropStartHandler	editMapping	enableCommandButton
endModal	exposeComponent	filterChanged	findElement
fireOnResizeEvent	fireOnUnloadEvent	fireOnUpdateEvent	firePopupAction
getChildIndex	getComponent	getComponentById	getEnclosingDiv
getHidden	getHintElement	getLabelElement	getOpener
getPageTitle	getProperty	getSettings	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	refreshTable
removeChild	removeElement	render	renderContents
renderSVG	resetMsg	searchBlur	searchBoxHandler
searchFocus	searchKeyDown	searchKeyPress	setComponentId
setConnectivityStatusMsg	setHidden	setModified	setOverlayMode
setPageTitle	setProperty	setPropertyAll	setSortMode
setSortModeHandler	setTraceOption	setViewMode	setViewModeHandler
showAbout	showCommandButton	showContact	showDocumentation
showHelp	showMsg	startModal	startProgressBar
stopProgressBar	switchNamespace	trimSpace	validateRequired

Parameters

• parameter AUTONS = 0;

Do not switch namespace for this page: it needs to stay in %SYS

• parameter CSPURL = "/csp/sys/mgr/%CSP.UI.Portal.Mappings.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 EMSSERVICE = "Namespace";

• parameter HELPADDRESS = "Home,Configuration,Namespaces,Global Mappings";

Each SMP page should set this link which points to the documentation anchor name.

• parameter PAGENAME = "Mappings";

Displayed name of this page.

• parameter PARENTPAGE = "/csp/sys/mgr/%CSP.UI.Portal.Namespaces.zen";

This parameter defines the parent page for this page.
If the name ends in .csp, then the parent is assumed to be an autopage-enabled CSP page.
If the name ends in .cls, then the parent is assumed to be a Zen page.
This is used to automate the construction of the locator bar for this page and to build the index between portal pages and documentation.
The %GetLocatorInfo method is used to get this information.

• parameter RECENT = 0;

If true, register visits to this page in the recent list.

• parameter RESOURCE = "%Admin_Manage";

Security requirement

Properties

• property CPFMapFile as %String;

• property CPFMapName as %String;

• property EditPage as %String;

• property MapType as %ZEN.Datatype.string(ZENURL="MapType");

• property Namespace as %ZEN.Datatype.string(ZENURL="PID");

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 %OnGetTitle() as %String

Get the (localized) title string for the page. This should be implemented in a subclass.

• classmethod %OnPreHTTP() as %Boolean

Zen page notification of an HTTP request. This method can be overwritten by subclasses.
This is called before the standard Zen pre-HTTP processing occurs.

• classmethod CancelChanges(pProxy As %ZEN.proxyObject) as %String [ ZenMethod ]

Call server cancel method.

• classmethod DeleteItem(Name As %String, pProxy As %ZEN.proxyObject) as %String [ ZenMethod ]

Call server delete method.

• method DrawCollation(pTable As %ZEN.Component.tablePane, pName As %String, pSeed As %String) as %Status

• method Init(CPFName As %String) as %Status

Initialize CPF file/global

• 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 SaveChanges(pProxy As %ZEN.proxyObject) as %String [ ZenMethod ]

Call server save method.

• classmethod UpdateTableNavState(pFilter As %String, pPageSize As %Integer, pMaxRows As %Integer, pMapType As %String) [ ZenMethod ]

Used to Save tableNavBar values, add MapType to the page name to distinguish the type for the page.

• method deleteMapping(idRow) [ Language = javascript ]

Delete existing mapping.

• method doDiscard() [ Language = javascript ]

Cancel current mappings.

• method doSave() [ Language = javascript ]

Save current mappings.

• method editMapping(selectedName) [ Language = javascript ]

Process Add or Edit. Open popup window and pass in parameters.

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

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

• method navMaxRowsChanged(value) [ Language = javascript ]

Overriden to add MapType to the page name to distinguish the type for the page.

• method navPageSizeChanged(value) [ Language = javascript ]

Overriden to add MapType to the page name to distinguish the type for the page.

• method 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.

• method onloadHandler() [ Language = javascript ]

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

• method refreshTable(flag) [ Language = javascript ]

Refresh table. flag = 1: user has either Saved Changes or Canceled Changes.
flag = 0: user returned from Edit or Delete. Leave changeMade flag to be true

• method removeElement(el) [ Language = javascript ]

• method setModified(flag) [ Language = javascript ]

Set the modified flag for the page.

Class Reference IRIS for UNIX 2024.1.2
Documentation Search