Home > Class Reference > ENSLIB namespace > %CSP.UI.Portal.Shadow


class %CSP.UI.Portal.Shadow extends %CSP.UI.Portal.Template, %CSP.UI.Portal.UtilsNav

Property Inventory (Including Private)

Method Inventory (Including Private)


parameter AUTONS = 0;
Do not switch namespace for this page: it needs to stay in %SYS
parameter CSPURL = /csp/sys/mgr/%CSP.UI.Portal.Shadow.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 = System Administration, Configuration, Connectivity, Shadow Server Settings, Add Shadow Server;
Inherited description: Each SMP page should set this link which points to the documentation anchor name.
parameter PAGENAME = Edit Shadow Server;
Displayed name of this page.
parameter PARENTPAGE = /csp/sys/mgr/%CSP.UI.Portal.Shadows.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

Properties (Including Private)

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");
Shadow for edit. Null if adding new shadow.
Property methods: PIDDisplayToLogical(), PIDGet(), PIDIsValid(), PIDLogicalToDisplay(), PIDLogicalToOdbc(), PIDNormalize(), PIDSet()
property ShowAdvanced as %Boolean [ InitialExpression = 0 ];
Property methods: ShowAdvancedDisplayToLogical(), ShowAdvancedGet(), ShowAdvancedIsValid(), ShowAdvancedLogicalToDisplay(), ShowAdvancedLogicalToXSD(), ShowAdvancedNormalize(), ShowAdvancedSet(), ShowAdvancedXSDToLogical()
property isNew as %String (ZENURL = "isNew") [ InitialExpression = "0" ];
Property methods: isNewDisplayToLogical(), isNewGet(), isNewIsValid(), isNewLogicalToDisplay(), isNewLogicalToOdbc(), isNewNormalize(), isNewSet()

Methods (Including Private)

Return the array of links to show in the locator bar.
method %OnAfterCreatePage() as %Status
Subclass can override.
method %OnGetPageName() as %String
Inherited description: Get the (localized) name of the page. This should be implemented in a subclass.
classmethod DeleteMap(Shadow As %String, Name As %String) as %String [ ZenMethod ]
Call server delete method.
classmethod SaveData(pProxy As %ZEN.proxyObject) as %ZEN.proxyObject [ ZenMethod ]
classmethod UpdateTableNavState(pFilter As %String, pPageSize As %Integer, pMaxRows As %Integer, pPID As %String) [ ZenMethod ]
Used to Save tableNavBar values, add PID to the page name to distinguish the type for the page.
clientmethod addMapping() [ Language = javascript ]
Add Database Mapping to this shadow
clientmethod deleteItem(name) [ Language = javascript ]
Delete existing item.
clientmethod doBrowse(fieldID) [ Language = javascript ]
Launching a file selector window.
clientmethod doSave() [ Language = javascript ]
Save current item. Subclass to override.
Overriden to add PID to the page name to distinguish the specific page.
Overriden to add PID to the page name to distinguish the specific page.
clientmethod onPopupAction(popupName, action, value) [ Language = javascript ]
Inherited description: Subclass need to include the case "switchNamespace" if it is enabling "Switch" next to namespace.
clientmethod toggleAdvanced() [ Language = javascript ]