Skip to main content

This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.Opens in a new tab

For information on migrating to InterSystems IRISOpens in a new tab, see Why Migrate to InterSystems IRIS?

This version of the product is no longer supported, and this documentation is no longer updated regularly. See the latest version of this content.Opens in a new tab

%CSP.UI.Portal.EMS

class %CSP.UI.Portal.EMS extends %CSP.UI.Portal.Utils

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/%CSP.UI.Portal.EMS.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 DOMAIN = %EMSMessages;
Localization Domain
parameter HELPADDRESS = System,Enterprise Manager;
Inherited description: Each SMP page should set this link which points to the documentation anchor name.
parameter PAGENAME = Enterprise Manager;
Displayed name of this page.
parameter RESOURCE = %Admin_Secure,%Admin_Manage;
Security requirement

Properties

property CanJoin as %Boolean;
Property methods: CanJoinDisplayToLogical(), CanJoinGet(), CanJoinIsValid(), CanJoinLogicalToDisplay(), CanJoinLogicalToXSD(), CanJoinNormalize(), CanJoinSet(), CanJoinXSDToLogical()
property CanRemove as %Boolean;
Property methods: CanRemoveDisplayToLogical(), CanRemoveGet(), CanRemoveIsValid(), CanRemoveLogicalToDisplay(), CanRemoveLogicalToXSD(), CanRemoveNormalize(), CanRemoveSet(), CanRemoveXSDToLogical()
property CanResetCredentials as %Boolean;
Property methods: CanResetCredentialsDisplayToLogical(), CanResetCredentialsGet(), CanResetCredentialsIsValid(), CanResetCredentialsLogicalToDisplay(), CanResetCredentialsLogicalToXSD(), CanResetCredentialsNormalize(), CanResetCredentialsSet(), CanResetCredentialsXSDToLogical()
property CanResume as %Boolean;
Property methods: CanResumeDisplayToLogical(), CanResumeGet(), CanResumeIsValid(), CanResumeLogicalToDisplay(), CanResumeLogicalToXSD(), CanResumeNormalize(), CanResumeSet(), CanResumeXSDToLogical()
property CanSuspend as %Boolean;
Property methods: CanSuspendDisplayToLogical(), CanSuspendGet(), CanSuspendIsValid(), CanSuspendLogicalToDisplay(), CanSuspendLogicalToXSD(), CanSuspendNormalize(), CanSuspendSet(), CanSuspendXSDToLogical()
property HasLicense as %Boolean;
Property methods: HasLicenseDisplayToLogical(), HasLicenseGet(), HasLicenseIsValid(), HasLicenseLogicalToDisplay(), HasLicenseLogicalToXSD(), HasLicenseNormalize(), HasLicenseSet(), HasLicenseXSDToLogical()
property InstanceState as %String;
Property methods: InstanceStateDisplayToLogical(), InstanceStateGet(), InstanceStateIsValid(), InstanceStateLogicalToDisplay(), InstanceStateLogicalToOdbc(), InstanceStateNormalize(), InstanceStateSet()
property IsAwaitingApproval as %Boolean;
Property methods: IsAwaitingApprovalDisplayToLogical(), IsAwaitingApprovalGet(), IsAwaitingApprovalIsValid(), IsAwaitingApprovalLogicalToDisplay(), IsAwaitingApprovalLogicalToXSD(), IsAwaitingApprovalNormalize(), IsAwaitingApprovalSet(), IsAwaitingApprovalXSDToLogical()
property IsManaged as %Boolean;
Property methods: IsManagedDisplayToLogical(), IsManagedGet(), IsManagedIsValid(), IsManagedLogicalToDisplay(), IsManagedLogicalToXSD(), IsManagedNormalize(), IsManagedSet(), IsManagedXSDToLogical()
property IsMirror as %Boolean;
Property methods: IsMirrorDisplayToLogical(), IsMirrorGet(), IsMirrorIsValid(), IsMirrorLogicalToDisplay(), IsMirrorLogicalToXSD(), IsMirrorNormalize(), IsMirrorSet(), IsMirrorXSDToLogical()

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.
classmethod %OnPreHTTP() as %Boolean
Zen page notification of an HTTP request. This method can be overwritten by subclasses.
This is called before the standard Zen pre-HTTP processing occurs.
classmethod GetServerString(endpoint As EMS.Connection.Endpoint) as %String
method InitializeForm(HideResponse As %Boolean = 1) as %Status [ ZenMethod ]
InitializeForm is called when we need to change the page's state. firstLoad = true indicates that this is on the initial page load
method OnDrawRibbon() as %Status
Add to the contents of the tool ribbon.
method OnGetRibbonInfo(Output pDisplay As %Boolean, Output pViewIcons As %List, Output pSortOptions As %List, Output pSearchBox As %Boolean, Output pRibbonTitle As %String, Output pCommands As %List) as %Status
Get information to display in the ribbon bar.
classmethod Remove() as %ZEN.proxyObject [ ZenMethod ]
classmethod Resume() as %ZEN.proxyObject [ ZenMethod ]
classmethod Suspend() as %ZEN.proxyObject [ ZenMethod ]
clientmethod disableAllButtons() [ Language = javascript ]
Toggle disable of all buttons.
clientmethod doNew() [ Language = javascript ]
clientmethod doRemove() [ Language = javascript ]
clientmethod doRenew() [ Language = javascript ]
clientmethod doResetCredentials() [ Language = javascript ]
clientmethod doResume() [ Language = javascript ]
clientmethod doSuspend() [ 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 onloadHandler() [ Language = javascript ]
Inherited description: Disable save button for EMS-managed pages. Be sure to use this.invokeSuper('onloadHandler',arguments); when overriding.
clientmethod updateButtons() [ Language = javascript ]
clientmethod updateView() [ Language = javascript ]
Update / Reload tables. This overrides the one in Portal.Utils.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab