Skip to main content


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

Zen page for System Management Portal - New Namespace

Property Inventory

Method Inventory


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;
Inherited description: 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;
Inherited description: 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;
Inherited description: 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;
Inherited description: If true, register visits to this page in the recent list.
parameter RESOURCE = %Admin_Manage;
Security requirement


property CurrentNamespace as %String;
Currently set namespace name.
Property methods: CurrentNamespaceDisplayToLogical(), CurrentNamespaceGet(), CurrentNamespaceIsValid(), CurrentNamespaceLogicalToDisplay(), CurrentNamespaceLogicalToOdbc(), CurrentNamespaceNormalize(), CurrentNamespaceSet()
property IsEditForm as %Boolean [ InitialExpression = 1 ];
Inherited description: If set to 1 then the generic Save and Cancel button will be shown on the ribbon bar.
Property methods: IsEditFormDisplayToLogical(), IsEditFormGet(), IsEditFormIsValid(), IsEditFormLogicalToDisplay(), IsEditFormLogicalToXSD(), IsEditFormNormalize(), IsEditFormSet(), IsEditFormXSDToLogical()
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 methods: IsEnsembleDisplayToLogical(), IsEnsembleGet(), IsEnsembleIsValid(), IsEnsembleLogicalToDisplay(), IsEnsembleLogicalToXSD(), IsEnsembleNormalize(), IsEnsembleSet(), IsEnsembleXSDToLogical()
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 methods: ParentURLDisplayToLogical(), ParentURLGet(), ParentURLIsValid(), ParentURLLogicalToDisplay(), ParentURLLogicalToOdbc(), ParentURLNormalize(), ParentURLSet()
property ReservedNames as %String [ InitialExpression = ",BIN,BROKER,DOCUMATIC,SYS," ];
The new namespace's name cannot be in the list
Property methods: ReservedNamesDisplayToLogical(), ReservedNamesGet(), ReservedNamesIsValid(), ReservedNamesLogicalToDisplay(), ReservedNamesLogicalToOdbc(), ReservedNamesNormalize(), ReservedNamesSet()
property productLbl as %ZEN.Datatype.caption;
Label for type of namespace to make
Property methods: productLblDisplayToLogical(), productLblGet(), productLblIsValid(), productLblLogicalToDisplay(), productLblLogicalToOdbc(), productLblNormalize(), productLblSet()


Return the array of links to show in the locator bar.
method %OnAfterCreatePage() as %Status
Inherited description: 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.
clientmethod changeCopy(copyFrom) [ Language = javascript ]
clientmethod changeNamespace(Namespace) [ Language = javascript ]
clientmethod changeRemote(isRemote) [ Language = javascript ]
clientmethod changeRemoteRtns(isRemote) [ Language = javascript ]
clientmethod doEnsChange() [ Language = javascript ]
clientmethod doNew(isRemote, dbField) [ Language = javascript ]
clientmethod doSave() [ Language = javascript ]
clientmethod getPageTitle() as %String [ Language = javascript ]
Get the title string to add to the locator row.
clientmethod 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.
clientmethod validate(proxy) [ Language = javascript ]

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab