Class %CSP.UI.Portal.Shadow

hidden deprecatedclass %CSP.UI.Portal.Shadow extends %CSP.UI.Portal.Template, %CSP.UI.Portal.UtilsNav

The use of Shadowing is deprecated and no longer supported on IRIS. Please refer to this overview on High Availability solutions in the IRIS documentation for more information about recommended alternatives.

Inventory

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
8	4	16

Summary

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

Properties
%condition	%import	%includeFiles	%page
%resource	Filter	FirstFailed	HelpAddress
ISREADONLY	InvalidParam	IsEMSReadOnly	IsEditForm
LocatorHeader	OnclickArray	PID	ParentURL
ShowAdvanced	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
isNew	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	CheckAllBlanks	CheckContextLinks
CheckEnterpriseManager	ConvertParameter	Decrypt	DeleteMap
DoLogout	DrawLocator	DrawRibbon	DrawTitle
Encrypt	EscapeHTML	EscapeURL	EvalResult
GetCSPURL	GetContextLinks	GetDocURL	GetHomePage
GetNewURL	GetQuickLinks	HyperEventCall	HyperEventHead
Include	InsertHiddenField	InsertHiddenFields	IsPrivate
JavaInstalled	Link	OnDrawRibbon	OnGetRibbonInfo
OnHTTPHeader	OnPage	OnPageError	OnPostHTTP
OnPostHyperEvent	OnPreHTTP	OnPreHyperEvent	Page
QuoteJS	RegisterRecent	RewriteURL	SaveData
ShowError	StartTimer	StopTimer	ThrowError
UnescapeHTML	UnescapeURL	UpdateTableNavState	XMLDTD
XMLExport	XMLExportToStream	XMLExportToString	XMLNew
XMLSchema	XMLSchemaNamespace	XMLSchemaType	addChild
addChildAfter	addChildBefore	addMapping	afterSave
afterValidate	cancelPopup	changePassword	childrenMutated
correctIELayering	createComponent	createComponentNS	deleteComponent
deleteItem	disableCommandButton	doBrowse	doCancel
doModified	doSave	dragFinishHandler	dragHandler
dragNotifyHandler	dragStartHandler	dropHandler	dropStartHandler
enableCommandButton	endModal	exposeComponent	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	removeChild
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
toggleAdvanced	trimSpace	validate	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.Shadow.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 = "System Administration, Configuration, Connectivity, Shadow Server Settings, Add Shadow Server";

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

• parameter PAGENAME = "Edit Shadow Server";

Displayed name of this page.

• parameter PARENTPAGE = "/csp/sys/mgr/%CSP.UI.Portal.Shadows.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 IsEditForm as %Boolean [ InitialExpression = 1 ];

If set to 1 then the generic Save and Cancel button will be shown on the ribbon bar.

• property PID as %String(ZENURL="PID");

Shadow for edit. Null if adding new shadow.

• property ShowAdvanced as %Boolean [ InitialExpression = 0 ];

• property isNew as %String(ZENURL="isNew") [ InitialExpression = "0" ];

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 DeleteMap(Shadow As %String, Name As %String) as %String [ ZenMethod ]

Call server delete method.

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

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

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

• method addMapping() [ Language = javascript ]

Add Database Mapping to this shadow

• method deleteItem(name) [ Language = javascript ]

Delete existing item.

• method doBrowse(fieldID) [ Language = javascript ]

Launching a file selector window.

• method doSave() [ Language = javascript ]

Save current item. Subclass to override.

• method getPageTitle() as %String [ Language = javascript ]

Get the title string to add to the locator row.

• method navMaxRowsChanged(value) [ Language = javascript ]

Overriden to add PID to the page name to distinguish the specific page.

• method navPageSizeChanged(value) [ Language = javascript ]

Overriden to add PID to the page name to distinguish the specific page.

• method onPopupAction(popupName, action, value) [ Language = javascript ]

Subclass need to include the case "switchNamespace" if it is enabling "Switch" next to namespace.

• method toggleAdvanced() [ Language = javascript ]

• method validate() as %Boolean [ Language = javascript ]

Class Reference IRIS for UNIX 2024.1.2
Documentation Search