Skip to main content


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

System Management Portal - System Administration - Connectivity - JDBC Gateway Server Settings & Status

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.JDBCGatewayServer.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,Configuration,JDBC Gateway Server;
Inherited description: Each SMP page should set this link which points to the documentation anchor name.
parameter PAGENAME = JDBC Gateway Server;
Displayed name of this page.
parameter RECENT = 0;
Inherited description: If true, register visits to this page in the recent list.
parameter RESOURCE = %Admin_Manage;
Security requirement


property JDBCGatewayJVMArgs as %String;
Property methods: JDBCGatewayJVMArgsDisplayToLogical(), JDBCGatewayJVMArgsGet(), JDBCGatewayJVMArgsIsValid(), JDBCGatewayJVMArgsLogicalToDisplay(), JDBCGatewayJVMArgsLogicalToOdbc(), JDBCGatewayJVMArgsNormalize(), JDBCGatewayJVMArgsSet()
property JDBCGatewayLog as %String;
Property methods: JDBCGatewayLogDisplayToLogical(), JDBCGatewayLogGet(), JDBCGatewayLogIsValid(), JDBCGatewayLogLogicalToDisplay(), JDBCGatewayLogLogicalToOdbc(), JDBCGatewayLogNormalize(), JDBCGatewayLogSet()
property JDBCGatewayPort as %String;
Property methods: JDBCGatewayPortDisplayToLogical(), JDBCGatewayPortGet(), JDBCGatewayPortIsValid(), JDBCGatewayPortLogicalToDisplay(), JDBCGatewayPortLogicalToOdbc(), JDBCGatewayPortNormalize(), JDBCGatewayPortSet()
property JDBCGatewayUsePassphrase as %Boolean [ InitialExpression = 0 ];
Default UsePassphrase
Property methods: JDBCGatewayUsePassphraseDisplayToLogical(), JDBCGatewayUsePassphraseGet(), JDBCGatewayUsePassphraseIsValid(), JDBCGatewayUsePassphraseLogicalToDisplay(), JDBCGatewayUsePassphraseLogicalToXSD(), JDBCGatewayUsePassphraseNormalize(), JDBCGatewayUsePassphraseSet(), JDBCGatewayUsePassphraseXSDToLogical()
property JavaHome as %String;
Property methods: JavaHomeDisplayToLogical(), JavaHomeGet(), JavaHomeIsValid(), JavaHomeLogicalToDisplay(), JavaHomeLogicalToOdbc(), JavaHomeNormalize(), JavaHomeSet()
property refreshRate as %Integer [ InitialExpression = 30 ];
Property methods: refreshRateDisplayToLogical(), refreshRateGet(), refreshRateIsValid(), refreshRateLogicalToDisplay(), refreshRateNormalize(), refreshRateSet(), refreshRateXSDToLogical()
property refreshState as %Boolean [ InitialExpression = 1 ];
Property methods: refreshStateDisplayToLogical(), refreshStateGet(), refreshStateIsValid(), refreshStateLogicalToDisplay(), refreshStateLogicalToXSD(), refreshStateNormalize(), refreshStateSet(), refreshStateXSDToLogical()
property settingsExpanded as %Boolean [ InitialExpression = 1 ];
Property methods: settingsExpandedDisplayToLogical(), settingsExpandedGet(), settingsExpandedIsValid(), settingsExpandedLogicalToDisplay(), settingsExpandedLogicalToXSD(), settingsExpandedNormalize(), settingsExpandedSet(), settingsExpandedXSDToLogical()


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 CheckForChanges(pOnlyPort As %Boolean = 0, pPort As %String = "", pLogFile As %String = "", pJavaHome As %String = "", pUsePassphrase As %String) as %Boolean [ ZenMethod ]
Return 1 (true) if settings have been modified by another process, or 0 otherwise
method DrawAutoRefresh(pSeed As %String) as %Status
classmethod GetGatewayState() as %Boolean [ ZenMethod ]
Find out whether the JDBC Gateway is active or inactive
classmethod LastUpdateTime() as %String [ ZenMethod ]
Return server time in format HH:MM:SS
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 SaveJDBCSettings(pProxy As %ZEN.proxyObject) as %String [ ZenMethod ]
Save settings on the server
classmethod StartJDBCGateway(pHost As %String, pPort As %String, pUsePassphrase As %String) as %String [ ZenMethod ]
classmethod StopJDBCGateway(pHost As %String, pPort As %String) as %String [ ZenMethod ]
clientmethod adjustSizes() [ Language = javascript ]
Adjust sizes of components on the page.
clientmethod browseSelect(name, wildcard) [ Language = javascript ]
User clicked one of the Browse buttons. Save the name of the text field so that when you return you know which text field to update.
clientmethod enableOrDisableSettingsForm(enable) [ 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 ]
This client event, if present, is fired when the page is loaded.
clientmethod onunloadHandler() [ Language = javascript ]
Inherited description: This client event, if present, is fired when the page is unloaded. If this method returns a string value, then that is used as the return value of the HTML page's onbeforeunload handler (if more than one component returns a string, the first one encountered is used).
clientmethod refreshHandler() [ Language = javascript ]
Auto-refresh timer handler.
clientmethod refreshStatus() [ Language = javascript ]
Update Status panel, refreshing time of update, state and recent activity table
clientmethod reloadPage() [ Language = javascript ]
clientmethod saveSettings() [ Language = javascript ]
clientmethod setRefreshMode(auto) [ Language = javascript ]
clientmethod setRefreshRate(seconds) [ Language = javascript ]
clientmethod settingsModified(isMod) [ Language = javascript ]
clientmethod showExpand() [ Language = javascript ]
clientmethod startGateway() [ Language = javascript ]
Start the JDBC Gateway server.
clientmethod startGatewayMessage(ret) [ Language = javascript ]
clientmethod stopGateway() [ Language = javascript ]
Stop the JDBC Gateway server.
clientmethod stopGatewayMessage(ret) [ Language = javascript ]
clientmethod toggleSettings() [ Language = javascript ]
Toggle display of settings pane.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab