Integration Broker Setup & Verification

tukwilagleefulInternet and Web Development

Oct 31, 2013 (5 years and 5 months ago)


Integration Broker

Setup & Verification

PeopleTools Release 8.48+

Last Updated 3/2009

Table of Contents

Section 1

General Setup

Section 2


Verify Environmental Setup

Section 3


Section 1

Integration Ga
teway Setup

Step 1

Create a Gateway within the Integration Broker

This procedure will create a Gateway in the Integration Broker. The Integration Broker

pub/sub requires a
Gateway definition be created before any transactions can occur using the Integ
ration Gateway.

Note: The following steps should be performed in order; each step builds upon the previous step.
For our purposes here we will be using a predefined and delivered Gateway definition.

Navigate to
Integration Broker

Click the
Find an Existing Value

tab or link


as the Gateway ID

NOTE: If you are adding a remote gateway, do not Select Local Y/N check box if there is already a
local gateway present (only one local gateway allowed per


Click the


NOTE: We deliver standard connectors with the LOCAL Gateway ID. They must be loaded to the
newly defined gateway. You must save the Gateway URL first then load the connectors.

Modify the Gateway URL. Enter

NOTE: When you click on Ping Gateway the following message should appear:

Click the


When the Save button is clicked the system will respo
nd with:

Click on the OK button.


Click the


Step 2

Modify the IntegrationGateway.Properties file to add Node information

Click on the
Link on the Gateway Page.

Enter the User ID and the Password for your gateway. By d
efault this is ‘administrator’ and
‘password’ but your system administrator may have changed this.

Nodes set in the IntegrationGateway.Properties file

A. Default Node

Within any inbound message, the only information the integration gateway requires
is the
names of the message and the sending node. If the message was sent by an Integration Broker
system, it also includes the name of the target node. The gateway searches the
IntegrationGateway.Properties file for the Jolt connect string properties for
the specified target
node, so it can properly direct the message.

However, the integration gateway can fail to determine the correct target node in the
following situations:

The sending node isn't a PeopleSoft Integration Broker system, or it doesn't
ify a target node.

The Jolt connect string settings for the specified target node are missing from
the IntegrationGateway.Properties file.

The message format doesn't allow for a target node specification.

To handle these cases, you can specify a default ta
rget node for the gateway to use if no valid
target node can be determined. Use the default Jolt connect string properties:


Default Nodes

Jolt Connection String for specified Target Node contained in messages sent through
Integration Broker.

Note: It

is the Application Server URL and the JOLT port that is entered. Enter the values in the
IntegrationGateway.Properties file with care. The Node name must be entered as it is defined in the node
definition, the APP Server URL must be preceded by two forwa
rd slashes (//), the User id and password
must be valid, and the tools release must include the patch level. If errors are made, the integration broker
will not function properly.

Section 2


Verify Environmental Setup

After any Node setup is co
mplete, the PING should be exercised and log results verified to determine if the
environmental configuration is correct. If the PING does not result in a SUCCESS status

STOP… do
not publish. Begin troubleshooting activities to correct integration iss

While in the Gateway Properties page, click on the

button against each node

Optionally, you can Ping nodes through the node definition.

Navigate to
Integration Broker
Integration Setup>Nodes

Enter the Node definition
that you want to Ping.

And then click

Click on the Connector Tab.

And the Click on


Section 3


The Log Files for the Integration Gateway, msgLog.html and ErrorLog.html, are located at
tH900G2AP/applicati ons/peoplesoft/PSIGW/

For debugging purposes, the ig.log.level in the IntegrationGateway.Properties file should be set to 5.

From the gateway properties page:

Click on the
Link. And then scroll down in the file until you locate
ig.log.level parameter Set the value = 5 and SAVE.

Each Connector processes both a request and a response. Listening Connectors receive a
request immediately, and later in processing return a synchronous response to the
requestor. Target Con
nectors generate a request, send it, and wait for a response from the
external system.

delivered Connectors conform to an implementation in which each Connector
must log the actual,” raw” request and response sent/received. Connectors also c
reate log
entries when an error condition is encountered.

Each section of the log file will be described below.

Section 1

This log entry was created when the IBListeningConnector received a request most likely from the Broker
Engine running on the
PS Application Server. Note that the format is not XML, but MIME (the internal
messaging standard for the Integration Broker).

Section 2

Mirroring the “Section 1” entry above, the IBListeningConnector has logged the actual response that it sent
to the requesting system, most likely a Broker Engine on the PS Application Server.

Section 3

An error condition has been encountered, and thus a log entry is generated. Note that this log differs from
standard message logging, such as “Section 2” ab
ove. The Java stack trace is displayed for debugging
purposes. Also, if and when possible the internal “IBRequest” or “IBResponse” is displayed to help in
tracking down why a problem has be

Common Errors:

Scenario One

If the node has no Connector I
D on the node definition

the following error will be seen:

Correction Procedure

On the Connector page of the node definition, insert a Connector ID.

Scenario Two

If the node is a PeopleSoft node and it is not defined in the
ationGateway.Properties file, a Ping will result in:

Correct by adding the node to the IntegrationGateway.Properties file.

Scenario Three: A ping will use the ANONYMOUS node of the database you are
trying to Ping. The ANONYMOUS node needs a va
lid Default UserID defined on
the node definition. If not, you will see: UserName not defined in database (158,55)

In this case PSADMIN is not a valid User ID. Once the Default User ID is changed
to a valid User ID, the ping will go to SUCCESS.

Scenario Four: At times the Ping of the gateway, the nodes or even loading the
connectors will result in a very generic error message:


: General C

Failed (158,10836)”

This error is

when there is no valid resp

Possible errors include:



Sync Service Time
out set and Service actually timed out.




Check Applicati

Server for possible Java
." (See screenshot)

When this happens, set the ig.log.level = 5 in the Integrat
file and then test again. Review the ErrorLog.html to see what the actual problem