This topic describes the [Gateways] section of the CPF, which contains entries for each gateway configured on the InterSystems IRIS® data platform instance and its host system. Gateways, which are also known as external language serversOpens in a new tab, provide fully integrated bi-directional connections between InterSystems IRIS and external language platforms.
Each definition consists of a name followed by = and then a comma-separated list of values defining the gateway; some fields are required, and others can be left blank, in which case default values are used. As shown in the following, there are seven types of gateways defined in the default CPF of a newly installed instance: .NET, IntegratedML, JDBC, Java, Python, R, and XSLT. In addition to these local gateway types, you can define a remote gateway on a remote system.
[Gateways] %DotNet Server=.NET,53398,%Gateway_Object,N6.0 %IntegratedML Server=ML,53598,%Gateway_ML %JDBC Server=JDBC,53798,%Gateway_SQL %Java Server=Java,53298,%Gateway_Object %Python Server=Python,53498,%Gateway_Object %R Server=R,53898,%Gateway_Object %XSLT Server=XSLT,53698,%Gateway_Object
JDBC, Java, IntegratedML, XSLT, and R gateways are all Java-based and use the same fields in their definitions.
The Type and Port fields are required for all gateway types. The third field, Resource, specifies the gateway resourceOpens in a new tab a user must have USE permission on to use the gateway; for example, the default %JDBC Server definition above specifies that a user must have the %Gateway_SQL:USE privilege to use the JDBC gateway. InterSystems strongly recommends protecting all gateways by specifying an appropriate resource.
If you have the %Admin_ExternalLanguageServerEdit:USE privilegeOpens in a new tab, which by default is held by the %Manager role, you can use the following methods to create a new gateway of any type or to edit or delete an existing gateway:
The External Language Servers pageOpens in a new tab of the Management Portal (System Administration > Configuration > Connectivity > External Language Servers).
The Config.Gateway API.
Modifying the CPF of the instance using the iris merge commandOpens in a new tab or by editing it directlyOpens in a new tab.
You can start or start a gateway and display its activity log using the External Language Servers page or the $system.external interfaceOpens in a new tab.
Once a gateway has been defined, either in the default CPF or by a user, its name cannot be changed.
- %DotNet Server – Define a .NET gateway.
- %IntegratedML Server – Define an IntegratedML gateway.
- %JDBC Server – Define a JDBC gateway.
- %Java Server – Define a Java gateway.
- %Python Server – Define a Python gateway.
- %R Server – Define an R gateway.
- %XSLT Server – Define an XSLT gateway.
- Remote Server – Define a remote gateway.