Skip to main content


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

System Management Portal - System Administration - Edit Role

Property Inventory

Method Inventory


parameter AUTONS = 0;
Do not switch namespace for this page: it needs to stay in %SYS
parameter CSPURL = /csp/sys/sec/%CSP.UI.Portal.Role.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 = Security;
parameter HELPADDRESS = System Administration,Security,Users,Edit Role;
Inherited description: Each SMP page should set this link which points to the documentation anchor name.
parameter PAGENAME = Edit Role;
Displayed name of this page.
parameter PARENTPAGE = /csp/sys/sec/%CSP.UI.Portal.Roles.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_Secure;
Security requirement


property CurrResources as %String;
Property methods: CurrResourcesDisplayToLogical(), CurrResourcesGet(), CurrResourcesIsValid(), CurrResourcesLogicalToDisplay(), CurrResourcesLogicalToOdbc(), CurrResourcesNormalize(), CurrResourcesSet()
property CurrTab as %Integer [ InitialExpression = 0 ];
Property methods: CurrTabDisplayToLogical(), CurrTabGet(), CurrTabIsValid(), CurrTabLogicalToDisplay(), CurrTabNormalize(), CurrTabSet(), CurrTabXSDToLogical()
property EditDisabled as %Boolean;
Property methods: EditDisabledDisplayToLogical(), EditDisabledGet(), EditDisabledIsValid(), EditDisabledLogicalToDisplay(), EditDisabledLogicalToXSD(), EditDisabledNormalize(), EditDisabledSet(), EditDisabledXSDToLogical()
property IsDB as %Boolean [ InitialExpression = 0 ];
Property methods: IsDBDisplayToLogical(), IsDBGet(), IsDBIsValid(), IsDBLogicalToDisplay(), IsDBLogicalToXSD(), IsDBNormalize(), IsDBSet(), IsDBXSDToLogical()
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 IsNewSave as %Integer (ZENURL = "new");
Property methods: IsNewSaveDisplayToLogical(), IsNewSaveGet(), IsNewSaveIsValid(), IsNewSaveLogicalToDisplay(), IsNewSaveNormalize(), IsNewSaveSet(), IsNewSaveXSDToLogical()
property IsSystem as %Boolean [ InitialExpression = 0 ];
Property methods: IsSystemDisplayToLogical(), IsSystemGet(), IsSystemIsValid(), IsSystemLogicalToDisplay(), IsSystemLogicalToXSD(), IsSystemNormalize(), IsSystemSet(), IsSystemXSDToLogical()
property NumTabs as %Integer [ InitialExpression = 7 ];
Property methods: NumTabsDisplayToLogical(), NumTabsGet(), NumTabsIsValid(), NumTabsLogicalToDisplay(), NumTabsNormalize(), NumTabsSet(), NumTabsXSDToLogical()


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.
method CopyRole(Role As %String) as %Status [ ZenMethod ]
classmethod DeleteResource(pProxy As %ZEN.proxyObject) as %ZEN.proxyObject [ ZenMethod ]
method DrawResources(pSeed As %String) as %Status
method DrawTabHeader(pSeed As %String) as %Status
method PopulateFields(ByRef Properties As %String) as %Status
Fill in form fields. Used when loading the page for edit or when choosing a copy from role during creation
method PopulateNSDropdown(Type As %Integer, Output displayList As %String, Output valueList As %String) as %Status
classmethod SaveData(pProxy As %ZEN.proxyObject) as %ZEN.proxyObject [ ZenMethod ]
Call server save method.
clientmethod changeNS(ns) [ Language = javascript ]
clientmethod doAddResource() [ Language = javascript ]
clientmethod doCopyRole(role) [ Language = javascript ]
clientmethod doDeleteResource(resource) [ Language = javascript ]
clientmethod doEditResource(resource, permissions) [ Language = javascript ]
clientmethod doSave() [ Language = javascript ]
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 onlayoutHandler(load) [ Language = javascript ]
Inherited description: This client event, if present, is fired when the page is first loaded or whenever it is resized.
If this is called at load time, then load will be true.
clientmethod onloadHandler() [ Language = javascript ]
Set focus to the Name or Description field, disable fields if DispatchClass is defined.
clientmethod tabChanged(index) [ Language = javascript ]
clientmethod validate() as %Boolean [ Language = javascript ]

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab