Class %CSP.UI.Portal.Namespace

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

Zen page for System Management Portal - New Namespace

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
8	6	15

Summary

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

Properties
%condition	%import	%includeFiles	%page
%resource	CurrentNamespace	FirstFailed	HelpAddress
ISREADONLY	InvalidParam	IsEMSReadOnly	IsEditForm
IsEnsemble	LocatorHeader	OnclickArray	PID
ParentURL	ReservedNames	StdTitle	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	productLbl
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	%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	DoLogout	DrawLocator
DrawRibbon	DrawTitle	Encrypt	EscapeHTML
EscapeURL	EvalResult	GetCSPURL	GetContextLinks
GetDBName	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	XMLDTD	XMLExport	XMLExportToStream
XMLExportToString	XMLNew	XMLSchema	XMLSchemaNamespace
XMLSchemaType	addChild	addChildAfter	addChildBefore
afterSave	afterValidate	cancelPopup	changeCopy
changeNamespace	changePassword	changeRemote	changeRemoteRtns
childrenMutated	correctIELayering	createComponent	createComponentNS
deleteComponent	disableCommandButton	doCancel	doEnsChange
doModified	doNew	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	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	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.Namespace.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,New Namespace";

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

• parameter PAGENAME = "New Namespace";

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 CurrentNamespace as %String;

Currently set namespace name.

• 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 IsEnsemble as %Boolean [ InitialExpression = $S(##class(%Library.EnsembleMgr).IsEnsembleInstalled():1,##class(%Library.EnsembleMgr).IsHealthShareInstalled():1,1:0) ];

Is this instance InterSystems IRIS or HealthShare? If so, CSP application creation is handled differently.

• property ParentURL as %ZEN.Datatype.string [ InitialExpression = ..Link($ZCVT($case($get(%request.Data("SRC",1)), "SHARD":"/csp/sys/mgr/%CSP.UI.Portal.Sharding.Configuration.zen", :..#PARENTPAGE),"O","URL")) ];

Parent URL that Cancel and Save should return to

• property ReservedNames as %String [ InitialExpression = ",BIN,BROKER,DOCUMATIC,SYS," ];

The new namespace's name cannot be in the list

• property productLbl as %ZEN.Datatype.caption;

Label for type of namespace to make

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.

• classmethod GetDBName(Namespace As %String) as %ZEN.proxyObject [ ZenMethod ]

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

Save general association data to server.
Returns proxy.ok = 1 (save successful) or 0 (error occurred)
proxy.Message (save successful, with warning message: require restart)
proxy.ErrorMessage (save failed and display this error message). If proxy.ok is 1 and no messages returned then we return to Database list page.

• method changeCopy(copyFrom) [ Language = javascript ]

• method changeNamespace(Namespace) [ Language = javascript ]

• method changeRemote(isRemote) [ Language = javascript ]

• method changeRemoteRtns(isRemote) [ Language = javascript ]

• method doEnsChange() [ Language = javascript ]

• method doNew(isRemote, dbField) [ Language = javascript ]

• method doSave() [ Language = javascript ]

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

Get the title string to add to the locator row.

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

Class Reference IRIS for UNIX 2024.1.2
Documentation Search