Class %CSP.UI.Portal.Config.Devices

class %CSP.UI.Portal.Config.Devices extends %CSP.UI.Portal.AdvancedSettingsTemplate

Zen page for System Management Portal - Configure Devices

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
3	1	11

Summary

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

Properties
%condition	%import	%includeFiles	%page
%resource	Category	HelpAddress	ISREADONLY
LocatorHeader	PID	ParentURL	SingleSubject
StdTitle	Subject	aboutPage	align
aux	backgroundTimerInterval	cellAlign	cellSize
cellStyle	cellVAlign	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	isNew
label	labelClass	labelDisabledClass	labelPosition
labelStyle	layout	lblTitle	msgNoSubject
name	onafterdrag	onbeforedrag	onclick
ondrag	ondrop	onhide	onrefresh
onshow	onupdate	pageModified	parent
searchKey	showLabel	slice	title
tuple	useSVG	useSoftModals	valign
valueModified	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	CheckAllBlanks	ConvertParameter	Decrypt
DeleteData	DoLogout	DrawAfterCreatePage	DrawLocator
DrawLocatorExtra	DrawRibbon	DrawTitle	Encrypt
EscapeHTML	EscapeURL	EvalResult	GetCSPURL
GetClassName	GetContextLinks	GetDocPage	GetHomePage
GetNames	GetNewURL	GetPropertyList	GetQuickLinks
HyperEventBody	HyperEventCall	HyperEventFrame	HyperEventHead
Include	InsertHiddenField	InsertHiddenFields	IsPrivate
Link	OnDrawRibbon	OnGetRibbonInfo	OnHTTPHeader
OnPage	OnPageError	OnPostHTTP	OnPostHyperEvent
OnPreHTTP	OnPreHyperEvent	Page	QuoteJS
RegisterRecent	RewriteURL	SaveData	ShowError
StartTimer	StopTimer	SubHelpPath	ThrowError
UnescapeHTML	UnescapeURL	UpdateDetails	XMLDTD
XMLExport	XMLExportToStream	XMLExportToString	XMLNew
XMLSchema	XMLSchemaNamespace	XMLSchemaType	ZStripW
addChild	addChildAfter	addChildBefore	cancelItem
cancelPopup	changePassword	childrenMutated	correctIELayering
createComponent	createComponentNS	deleteComponent	deleteItem
doNew	dragFinishHandler	dragHandler	dragNotifyHandler
dragStartHandler	dropHandler	dropStartHandler	editItem
endModal	exposeComponent	findElement	fireOnLoadEvent
fireOnResizeEvent	fireOnUnloadEvent	fireOnUpdateEvent	firePopupAction
getChildIndex	getComponent	getComponentById	getEnclosingDiv
getHidden	getHintElement	getLabelElement	getOpener
getProperty	getSettings	getTitleAreaHeight	getType
goHome	goMenu	gotoNamespace	gotoPage
helpItem	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
saveItem	searchBlur	searchBoxHandler	searchFocus
searchKeyDown	searchKeyPress	setComponentId	setHidden
setModified	setOverlayMode	setProperty	setPropertyAll
setSortMode	setSortModeHandler	setTraceOption	setViewMode
setViewModeHandler	showAbout	showDocumentation	showHelp
showMsg	startModal	startProgressBar	stopProgressBar
switchNamespace	validateRange	validateRequired	valueChanged

Parameters

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

Displayed name of this page.

• parameter PARENTPAGE = "/csp/sys/%CSP.Portal.Home.cls";

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.

Properties

• property SingleSubject as %String;

Single subject name: Device, MagTape or SubType

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

Subclass can override.

• method %OnGetPageName() as %String

Get the (localized) name of the page. This should be implemented in a subclass.

• classmethod DrawAfterCreatePage(Category, Subject, isNew)

Called as part of %OnAfterCreatePage specific for this page.

• classmethod GetPropertyList(Subject) as %String

We need to manually build these because there are properties that we do not want to include from the query %Dictionary.CompiledPropertyQuery:Summary".

• 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(Subject, PID, Name, Properties, Values) as %String [ ZenMethod ]

Call server save method. Subclass may override.

• classmethod UpdateDetails(Subject, PID) as %String [ ZenMethod ]

Load data into form.

• method deleteItem(name) [ Language = javascript ]

Delete existing item.

• method doNew() [ Language = javascript ]

User clicked the "Edit" link which is there for clearity and consistency. No need to do anything here as onselectrow is going to kick in.

• method editItem(PID) [ Language = javascript ]

User clicked the Add or Edit button.


[BASEXML] > [%CSP] > [UI] > [Portal] > [Config] > [Devices]		Private Storage