Skip to main content


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

Zen page for System Management Portal - Object Gateways

Property Inventory

Method Inventory


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


property msgDelete as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Delete") ];
Property methods: msgDeleteDisplayToLogical(), msgDeleteGet(), msgDeleteIsValid(), msgDeleteLogicalToDisplay(), msgDeleteLogicalToOdbc(), msgDeleteNormalize(), msgDeleteSet()
property msgEdit as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Edit") ];
Property methods: msgEditDisplayToLogical(), msgEditGet(), msgEditIsValid(), msgEditLogicalToDisplay(), msgEditLogicalToOdbc(), msgEditNormalize(), msgEditSet()
property msgStart as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Start") ];
Property methods: msgStartDisplayToLogical(), msgStartGet(), msgStartIsValid(), msgStartLogicalToDisplay(), msgStartLogicalToOdbc(), msgStartNormalize(), msgStartSet()
property msgStop as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Stop") ];
Property methods: msgStopDisplayToLogical(), msgStopGet(), msgStopIsValid(), msgStopLogicalToDisplay(), msgStopLogicalToOdbc(), msgStopNormalize(), msgStopSet()


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 DeleteItem(PID) as %String [ ZenMethod ]
Call server delete method.
classmethod EnableObjectGateways() as %Boolean
Return true if Object Gateways option can be shown.
classmethod IsHealthShareInstalled() as %Boolean
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.
clientmethod doActivities(PID) [ Language = javascript ]
User clicked Activities link. Goto to Activities page.
clientmethod doDelete(PID) [ Language = javascript ]
Delete existing gateway connection.
clientmethod doEdit(PID) [ Language = javascript ]
User clicked the "Edit" link.
clientmethod doEditD() [ Language = javascript ]
User double clicked a row. Go to edit.
clientmethod doNew() [ Language = javascript ]
User clicked Start link. Goto to Start page.
clientmethod doStart(PID) [ Language = javascript ]
User clicked Start link. Goto to Start page.
clientmethod doStop(PID) [ Language = javascript ]
User clicked Stop link. Goto to Stop page.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab