Skip to main content


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

Zen page for System Management Portal - Edit an Object Gateway Server

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.ObjectGateway.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 Gateway;
Displayed name of this page.
parameter PARENTPAGE = /csp/sys/mgr/%CSP.UI.Portal.ObjectGateways.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


property GatewayType as %ZEN.Datatype.string;
Gateway type display string (.NET or Java)
Property methods: GatewayTypeDisplayToLogical(), GatewayTypeGet(), GatewayTypeIsValid(), GatewayTypeLogicalToDisplay(), GatewayTypeLogicalToOdbc(), GatewayTypeNormalize(), GatewayTypeSet()
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 IsEnsemble as %Boolean;
Is Ensemble-enabled
Property methods: IsEnsembleDisplayToLogical(), IsEnsembleGet(), IsEnsembleIsValid(), IsEnsembleLogicalToDisplay(), IsEnsembleLogicalToXSD(), IsEnsembleNormalize(), IsEnsembleSet(), IsEnsembleXSDToLogical()
property IsRunning as %Boolean [ InitialExpression = "0" ];
Is the current gateway running
Property methods: IsRunningDisplayToLogical(), IsRunningGet(), IsRunningIsValid(), IsRunningLogicalToDisplay(), IsRunningLogicalToXSD(), IsRunningNormalize(), IsRunningSet(), IsRunningXSDToLogical()
property IsUnix as %Boolean [ InitialExpression = "0" ];
Is this a Unix system
Property methods: IsUnixDisplayToLogical(), IsUnixGet(), IsUnixIsValid(), IsUnixLogicalToDisplay(), IsUnixLogicalToXSD(), IsUnixNormalize(), IsUnixSet(), IsUnixXSDToLogical()
property PID as %String (ZENURL = "PID");
ID for edit.
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()
property msgActionsDisplay as %String [ InitialExpression = $$$Text("None,Restart,Alert,Restart and Alert") ];
Property methods: msgActionsDisplayDisplayToLogical(), msgActionsDisplayGet(), msgActionsDisplayIsValid(), msgActionsDisplayLogicalToDisplay(), msgActionsDisplayLogicalToOdbc(), msgActionsDisplayNormalize(), msgActionsDisplaySet()
property msgActionsValue as %String [ InitialExpression = "N,R,A,RA" ];
Property methods: msgActionsValueDisplayToLogical(), msgActionsValueGet(), msgActionsValueIsValid(), msgActionsValueLogicalToDisplay(), msgActionsValueLogicalToOdbc(), msgActionsValueNormalize(), msgActionsValueSet()
property msgConfirmRunning as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Gateway is currently running! In order to save, you must stop the Gateway first.") ];
Property methods: msgConfirmRunningDisplayToLogical(), msgConfirmRunningGet(), msgConfirmRunningIsValid(), msgConfirmRunningLogicalToDisplay(), msgConfirmRunningLogicalToOdbc(), msgConfirmRunningNormalize(), msgConfirmRunningSet()


Return the array of links to show in the locator bar.
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.
method LoadData(PID As %String, IsEnsemble As %Boolean) as %String
Load values into fields. Special cases:
If Ensemble is not enabled, then
on Windows: .NET only
on Unix: Java only
classmethod SaveData(PID, Type, Name, Server, Port, UsePassphrase, LogFile, HeartbeatInterval, HeartbeatFailureTimeout, HeartbeatFailureAction, HeartbeatFailureRetry, InitializationTimeout, ConnectionTimeout, J1, J2, J3, J4) as %ZEN.proxyObject [ ZenMethod ]
Save Object Gateway Server definition to server
clientmethod browseSelect(name, wildcard) [ Language = javascript ]
User clicked one of the Browse buttons. Save the name of the textfield so that when you return you know which textfield to update.
clientmethod changeType() [ Language = javascript ]
User changed Type. Show/hide client/server credentials related fields.
clientmethod checkIsRunning() [ Language = javascript ]
Check if gateway is running.
clientmethod doSave() [ Language = javascript ]
Get user input and send to server to save settings.
clientmethod formValidationHandler() [ Language = javascript ]
Validation handler for form.
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 ]
If it is Edit, then enable/disable fields based on Type and do not show radioSet for Type because it is not clear. Show the label. For Unix, you are here only if Ensemble is enabled and Java is the only Type available. Therefore the radio buttons for Type will be hidden.
clientmethod showGatewayType() [ Language = javascript ]
Hide Type radiow buttons and show type as label
clientmethod toggleAdvancedSettings() [ Language = javascript ]

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab