Understanding Integration Gateway Configuration

This section discusses:

  • Integration gateway versions and application server versions.

  • Local gateway compatibility.

  • Types of integration gateway configuration.

  • The Gateways component.

  • Minimum integration gateway setup requirements.

Local and remote integration gateways must be at the same or higher version as the application servers with which they communicate.

Any remote gateway that you configure must be at the same version as the local-defined gateway.

Out of the box, PeopleTools 8.55 is delivered with a PeopleTools 8.55 integration gateway and a PeopleTools 8.55 application server, thus meeting this requirement.

However, situations may arise where your integration environment is comprised of PeopleSoft systems running different versions of PeopleTools, or your integration partners are running different versions of PeopleTools. When this is the case, you must ensure that the integration gateway is at the same or higher version as the application server with which it communicates or integrations will fail.

The following list describes several compatible integration gateway/application server version combinations:

  • You are using a PeopleTools 8.55 integration gateway to communicate to a PeopleTools 8.55 application server.

  • You are using a PeopleTools 8.55 integration gateway to communicate to a PeopleTools 8.54 or earlier application server.

  • You are using a PeopleTools 8.55 remote integration gateway to communicate with a PeopleTools 8.54 or earlier application server.

The following list describes several incompatible integration gateway/application server version combinations. Integrations will fail with these combinations:

  • You are using a PeopleTools 8.54 or earlier integration gateway to communicate with a PeopleTools 8.55 application server.

  • You are using a PeopleTools 8.54 remote integration gateway to communicate with a PeopleTools 8.55 application server.

Because database administrator passwords and gateway keystore passwords are encrypted in the current PeopleTools release, the local gateway specified by a node in the current release of PeopleSoft Integration Broker must be from PeopleTools 8.55 or later version to support encryption. If you upgrade PeopleTools and the integration engine is from a release earlier than PeopleTools 8.55, you must also upgrade the local gateway.

Note: The current release of the integration gateway works with nodes that use PeopleTools 8.4x or later PeopleSoft Integration Broker.

An integration gateway requires several types of configuration:

Field or Control

Definition
Security configuration

You can implement PeopleSoft Integration Broker security in several ways. At a minimum you must install digital certificates on the machine on which the gateway is installed. Complete the certificate installation before continuing with the gateway configuration in this topic.

Once the gateway's digital certificates are installed, you must enter several configuration parameters in the Integration Gateway Certificates Section of the integrationGateway.properties file. The parameters you must set are the certificate alias name, the certificate alias password, the path to the keystore, and the keystore password.

See Installing Digital Certificates on the Integration GatewayInstalling Integration Gateway-Based Digital Certificates.
General configuration

This includes settings for the gateway version, class location, general communication parameters, node connection parameters, message and error logging, and gateway type and location. Most of these settings are entries in the integrationGateway.properties file, but you set a few of them in the Gateways component.
Connector-specific configuration

The number of configuration settings and where they're applied depend on the connector. You configure most of the target connectors delivered with PeopleSoft Integration Broker by using the Gateways component, but some require settings in the integrationGateway.properties file. A few require settings in both environments.

Note: You can override some target connector properties for an individual node.

Once the gateway has been installed, you use the Gateways component (IB_GATEWAY) to make it accessible to any node that uses it for messaging. You can also use it to override the gateway's default connector properties for individual nodes without having to directly edit the integrationGateway.properties file on the gateway machine.

See Understanding Managing Integration Gateways.

The minimum setup requirement to run an integration gateway are:

  1. Specify the gateway URL.

    See Defining Integration Gateways.

  2. Specify the Oracle Jolt connection string properties to enable communication with each PeopleSoft Integration Broker node that will be involved in an integration that uses a gateway.

    See Setting Oracle Jolt Connection Properties.

  3. Set and encrypt the keystore password.

    See Configuring Security and General Properties.