This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see Why Migrate to InterSystems IRIS?

%CSP.UI.Portal.Applications.PrivRoutine

class %CSP.UI.Portal.Applications.PrivRoutine extends %CSP.UI.Portal.Applications.EditTemplate

System Management Portal - System Administration - Edit Privileged Routine Application

Property Inventory

Method Inventory

Parameters

parameter AUTONS = 0;
Do not switch namespace for this page: it needs to stay in %SYS
parameter CSPURL = /csp/sys/sec/%CSP.UI.Portal.Applications.PrivRoutine.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,Applications,Privileged Routine Applications;
Inherited description: Each SMP page should set this link which points to the documentation anchor name.
parameter PAGENAME = Edit Privileged Routine Application;
Displayed name of this page.
parameter PARENTPAGE = /csp/sys/sec/%CSP.UI.Portal.Applications.PrivRoutineList.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 RESOURCE = %Admin_Secure;
Security requirement

Properties

property ApplicationType as %Integer [ InitialExpression = $$$AppTypePrivRoutine ];
Property methods: ApplicationTypeDisplayToLogical(), ApplicationTypeGet(), ApplicationTypeIsValid(), ApplicationTypeLogicalToDisplay(), ApplicationTypeNormalize(), ApplicationTypeSet(), ApplicationTypeXSDToLogical()
property EditHeader as %String;
Property methods: EditHeaderDisplayToLogical(), EditHeaderGet(), EditHeaderIsValid(), EditHeaderLogicalToDisplay(), EditHeaderLogicalToOdbc(), EditHeaderNormalize(), EditHeaderSet()
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 NumTabs as %Integer [ InitialExpression = 4 ];
Property methods: NumTabsDisplayToLogical(), NumTabsGet(), NumTabsIsValid(), NumTabsLogicalToDisplay(), NumTabsNormalize(), NumTabsSet(), NumTabsXSDToLogical()
property RolesHeader as %String;
Property methods: RolesHeaderDisplayToLogical(), RolesHeaderGet(), RolesHeaderIsValid(), RolesHeaderLogicalToDisplay(), RolesHeaderLogicalToOdbc(), RolesHeaderNormalize(), RolesHeaderSet()
property RoutinesHeader as %String;
Property methods: RoutinesHeaderDisplayToLogical(), RoutinesHeaderGet(), RoutinesHeaderIsValid(), RoutinesHeaderLogicalToDisplay(), RoutinesHeaderLogicalToOdbc(), RoutinesHeaderNormalize(), RoutinesHeaderSet()

Methods

Return the array of links to show in the locator bar.
pLink(n)=$LB(caption,link)
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 AddRoutine(PID As %String, Element As %String) as %String [ ZenMethod ]
method DrawRoutineTab(pSeed As %String) as %Status
method RemoveRoutine(PID As %String, Element As %String) as %String [ ZenMethod ]
classmethod SaveData(pProxy As %ZEN.proxyObject) as %ZEN.proxyObject [ ZenMethod ]
Call server save method.
clientmethod doAddRoutine() [ Language = javascript ]
clientmethod doRemoveRoutine(element) [ Language = javascript ]
clientmethod doSave() [ Language = javascript ]
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

Feedback