Skip to main content

%CSP.UI.Portal.Default

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

Zen page for System Management Portal

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/mgr/%CSP.UI.Portal.Default.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 HELPADDRESS = Home,Provider,Defaults;
Inherited description: Each SMP page should set this link which points to the documentation anchor name.
parameter PAGENAME = Edit Kit;
Displayed name of this page.
parameter RECENT = 0;
Parameter PARENTPAGE = "/csp/sys/mgr/%CSP.UI.Portal.Kits.zen";
parameter RESOURCE = %Admin_Manage;
Security requirement

Properties

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 PID as %String (ZENURL = "PID");
ID for edit. Null if adding new credentials.
Property methods: PIDDisplayToLogical(), PIDGet(), PIDIsValid(), PIDLogicalToDisplay(), PIDLogicalToOdbc(), PIDNormalize(), PIDSet()
property isNew as %ZEN.Datatype.boolean (ZENURL = "isNew") [ InitialExpression = "0" ];
Property methods: isNewDisplayToLogical(), isNewGet(), isNewIsValid(), isNewLogicalToDisplay(), isNewLogicalToOdbc(), isNewLogicalToXSD(), isNewNormalize(), isNewSet(), isNewXSDToLogical()

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
Inherited description: Get the (localized) name of the page. This should be implemented in a subclass.
classmethod DrawTitle1(pSeed As %String) as %Status
Used to draw title for this page. pHalpAddress is need to build the link for Help for this page.
method PopulateFields(ByRef Properties As %String) as %Status
classmethod SaveData(pProxy As %ZEN.proxyObject) as %ZEN.proxyObject [ ZenMethod ]
Save general association data to server
clientmethod doCancel() [ Language = javascript ]
Inherited description: This method resets the modified indicator and return user to the parent page.
clientmethod doSave() [ Language = javascript ]
Get user selection and send to server to save settings.
clientmethod onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab