Class %CSP.UI.Portal.Mappings

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

Zen page for System Management Portal - Show Databases Freespace

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
6	5	22

Summary

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

Properties
%condition	%import	%includeFiles	%page
%resource	HelpAddress	ID1	ID2
ISREADONLY	LocatorHeader	MapType	ParentURL
StdTitle	aboutPage	align	aux
backgroundTimerInterval	cellAlign	cellSize	cellStyle
cellVAlign	changesMade	children	composite
containerStyle	cssLevel	currSortMode	currStep
currViewMode	disabled	dragAndDrop	dragEnabled
dropEnabled	enclosingClass	enclosingStyle	error
groupClass	groupStyle	height	hidden
hint	hintClass	hintStyle	home
homePage	id	index	label
labelClass	labelDisabledClass	labelPosition	labelStyle
layout	lblTitle	msgLeavingPage	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
%%OIDGet	%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
%Extends	%ForceClientRender	%GetChildIndex	%GetComponent
%GetComponentById	%GetComponentByName	%GetEventHandlers	%GetHomePage
%GetHomeParam	%GetLinks	%GetLocatorLinks	%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	ConvertParameter
CreateRS	Decrypt	DeleteItem	DoLogout
DrawLocator	DrawRibbon	DrawTitle	Encrypt
EscapeHTML	EscapeURL	ExecuteRS	GetCSPURL
GetContextLinks	GetDocPage	GetHomePage	GetNewURL
GetQuickLinks	HyperEventBody	HyperEventCall	HyperEventFrame
HyperEventHead	Include	Init	InsertHiddenField
InsertHiddenFields	IsPrivate	Link	OnDrawRibbon
OnGetRibbonInfo	OnHTTPHeader	OnPage	OnPageError
OnPostHTTP	OnPostHyperEvent	OnPreHTTP	OnPreHyperEvent
Page	QuoteJS	RegisterRecent	ResetRows
RewriteURL	SaveChanges	SetTempRow	ShowError
StartTimer	StopTimer	ThrowError	UnescapeHTML
UnescapeURL	XMLDTD	XMLExport	XMLExportToStream
XMLExportToString	XMLNew	XMLSchema	XMLSchemaNamespace
XMLSchemaType	ZStripW	addChild	addChildAfter
addChildBefore	cancelMapping	cancelPopup	changePassword
childrenMutated	correctIELayering	createComponent	createComponentNS
deleteComponent	deleteMapping	dragFinishHandler	dragHandler
dragNotifyHandler	dragStartHandler	dropHandler	dropStartHandler
editMapping	editMappingD	editMappingE	endModal
exposeComponent	findElement	fireOnLoadEvent	fireOnResizeEvent
fireOnUnloadEvent	fireOnUpdateEvent	firePopupAction	getChildIndex
getComponent	getComponentById	getEnclosingDiv	getHidden
getHintElement	getLabelElement	getOpener	getProperty
getSettings	getTitleAreaHeight	getType	goHome
goMenu	gotoNamespace	gotoPage	invokeSuper
isOfType	launchPopupWindow	logout	makeId
navigate	onCreate	onDelete	onDisplayHandler
onEndModalHandler	onPopupAction	onRefreshContents	onSerialize
onServerMethodCall	onServerMethodError	onServerMethodReturn	onStartModalHandler
ondisabledHandler	onkeydownHandler	onkeyupHandler	onlayoutHandler
onloadHandler	onlogoutHandler	onoverlayHandler	onresizeHandler
onunloadHandler	onupdateHandler	popupActionHandler	refreshContents
refreshTable	removeChild	render	renderContents
renderSVG	resetMsg	saveMapping	searchBlur
searchBoxHandler	searchFocus	searchKeyDown	searchKeyPress
setComponentId	setHidden	setModified	setOverlayMode
setProperty	setPropertyAll	setSortMode	setSortModeHandler
setTraceOption	setViewMode	setViewModeHandler	showAbout
showDocumentation	showHelp	showMsg	startModal
startProgressBar	stopProgressBar	switchNamespace

Parameters

• parameter APPLICATION = "%CSP.UI.Portal.Application";

Class name of application this page belongs to.

• 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.cls";

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 PAGENAME = "Mappings";

Displayed name of this page.

• parameter PARENTPAGE = "/csp/sys/mgr/UtilSysNamespaces.csp";

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 RESOURCE = "%Admin_Manage";

Security requirement

Properties

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

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

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

• property changesMade as %ZEN.Datatype.boolean [ InitialExpression = 0 ];

• property msgLeavingPage as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Changes have not been saved permanently. If you navigate to a new page these changes will be lost!") ];

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

Decorate the page.

• 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() as %String [ ZenMethod ]

Call server cancel method.

• method CreateRS(Output tSC As %Status, pInfo As %ZEN.Auxiliary.QueryInfo) as %ResultSet

Create the result set used by the table pane. pInfo holds details on how to create the query.

• classmethod DeleteItem(Name) as %String [ ZenMethod ]

Call server delete method.

• method ExecuteRS(pRS As %Library.ResultSet, Output tSC As %Status, pInfo As %ZEN.Auxiliary.QueryInfo) as %Boolean

Method for executing the mapping query.

• method Init() as %Status

Initialize CPF file/global, return MapType

• classmethod ResetRows() [ ZenMethod ]

Reset row number to zero before table is build or re-build.

• classmethod SaveChanges() as %String [ ZenMethod ]

Call server save method.

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

Set %session.Data("t") array that holds Names for Edit and Delete to pickup later. Set %session.Data("TotalRows") so that we can use the row number to get actual Name saved in %session.Data("t"). Need to do all this so that onunload is not triggered when Edit is clicked, and we can detect if changes have not been saved.

• method cancelMapping() [ Language = javascript ]

Cancel current mappings.

• method deleteMapping(idRow) [ Language = javascript ]

Delete existing mapping.

• method editMapping(isNew, selectedName) [ Language = javascript ]

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

• method editMappingD() [ Language = javascript ]

User double clicked a row.

• method editMappingE(selectedName) [ Language = javascript ]

User clicked Edit

• 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 onunloadHandler() [ Language = javascript ]

Check if user really wants to exit if they have not saved changes

• 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 saveMapping() [ Language = javascript ]

Save current mappings.


[BASEXML] > [%CSP] > [UI] > [Portal] > [Mappings]		Private Storage