Integration Gateway Error Handling

In general, exceptions are thrown in a target connector and caught by a listening connector. As a result, a listening connector must catch these exceptions and handle them as appropriate. Typically, the listening connector generates an error message and sends it back to the requester.

Standard Exceptions

The following standard error and exception types are handled by the integration gateway, target connectors, and listening connectors:

Exception Type	Description
DuplicateMessageException	A target connector attempted to process a message that has already been processed. This is usually discovered based on an error that is attained from the external system that is being contacted. Of the connectors that are delivered with the PeopleSoft software, only the PeopleSoft 8.1 target connector (PSFT81TARGET) can generate this exception. Target connectors are not required to generate this exception.
ExternalApplicationException	The message reached its intended destination but could not be processed. Determining that the destination could not process a message requires significant knowledge of the destination system, which a target connector might not have. Whenever possible, a target connector should attempt to determine this situation; otherwise this task must be decentralized and handled outside of the integration gateway. For example, the HTTP target connector (HTTPTARGET) generates this exception when the external system returns an HTTP system code of 500.
ExternalSystemContactException	The target connector cannot establish a connection with the intended destination. This is one of the most common exceptions. When this exception is thrown during an asynchronous transaction, PeopleSoft Integration Broker tries to resend the message until successful.
GeneralFrameworkException	A general error occurred.
InvalidMessageException	A connector or the gateway manager determined that the message cannot be processed because of missing or erroneous information in a request or response.
MessageMarshallingException	A gateway service’s attempt to get information from an IBRequest or IBResponse failed. This can occur when the gateway services attempt to access a content section of a document by using an out-of-range index from one of the following methods: GetContentSectionAt(index) GetContentSectionInfoAt(index) RemoveContentSectionAt(index) If you try to access IBRequest or IBResponse with an out-of-range index by using any of these methods, this exception is thrown automatically and processing is interrupted.
MessageUnmarshallingException	A gateway service’s attempt to build an IBRequest or IBResponse failed. Failure can occur when: Instantiating an IBRequest or IBResponse from a Multipurpose Internet Mail Extensions (MIME) format where the message that was sent does not comply with the PeopleSoft MIME format. Instantiating an IBRequest by using the PS_XML format and passing an invalid PS_XML message. This is typically from the HTTP listening connector. Setting invalid values to methods, such as setTransactionID or setMessageType. These failures cause the integration gateway to generate this exception automatically and processing is interrupted.

Java Exceptions

Target connectors and listening connectors can handle miscellaneous Java exceptions, such as NullPointerException and ArrayOutOfBoundsException.

Use the Handler Tester utility to debug service operation handler PeopleCode.

The Handler Tester utility enables you to use the PeopleSoft Pure Internet Architecture to test any of the following handler types:

• OnSend.

• OnRequest

• OnRouteReceive

• OnRouteSend.

• OnAckReceive

• OnNotify.

Use this table to handle common issues in PeopleSoft Integration Broker:

Area or Suspected Issue	Debugging Suggestion
Application server exceptions.	Check the application server log: <PS_CFG_HOME>\appserv\<Domain>\LOGS\ appsrv.log
Message handlers are not running.	Check the application server domain status or queue status in the PeopleSoft Application Server Administration menu (PSAdmin). Select Domain Status, Server Status or Domain Status, Queue Status.
Integration gateway.	Check the integrationGateway.properties file and verify the property settings. The default file location is <PIA_HOME>\webserv\<DOMAIN>\applications\peoplesoft\PSIGW.war.war\WEB-INF\integrationGateway.properties.
Integration gateway.	Check the integration gateway message log. The default file location is <PIA_HOME>\webserv\<DOMAIN>\applications\peoplesoft\PSIGW.war.war\msgLog.html.
Queues are paused.	Check the Service Operations Monitor. Select PeopleTools > Integration Broker > Service Operations Monitor > Administration > Queue Status.
A node is paused.	Check the Service Operations Monitor. Select PeopleTools > Integration Broker > Service Operations Monitor > Administration > Node Status.
Incorrect gateway uniform resource locator (URL).	Check the Gateways component to verify that the integration gateway URL is correct. Select PeopleTools > Integration Broker > Configuration > Gateways.
Node inactive.	Check the node definition. Select PeopleTools > Integration Broker > Integration Setup > Nodes.
Subscription PeopleCode is missing or incorrect.	Check the Service Operations Monitor. Select PeopleTools > Integration Broker > Monitoring > Asynchronous Services > Subscription Contracts.
A service operation is inactive.	Check the service operation definition in the PeopleSoft Pure Internet Architecture. Select PeopleTools > Integration Broker > Integration Setup > Service Operations.
There are transform problems.	Check the Application Engine object in PeopleSoft Application Designer. For before and after images, check the Service Operations Monitor. For asynchronous service operations, select PeopleTools > Integration Broker > Service Operations Monitor > Monitoring > Asynchronous Details. Click the View XML link for the publication contract or subscription contract. For synchronous service operations, select PeopleTools > Integration Broker > Service Operations Monitor > Monitoring > Synchronous Details. Use the Log Type drop-down list box to select Request Transformed or Response Transformed, and then click View XML. Verify that the TraceAE flag in the following directory equals 8192: <PS_CFG_HOME>\appserv\<Domain>\psappsrv.cfg Setting the TraceAE flag in the psappsrv.cfg file instructs the application server to generate a transformation trace log with the .aet extension, written to the following directory: <PS_CFG_HOME>\appserv\<Domain>\LOGS\ <operID>_<machine name>.AET The log file contains: The original XML structure as it entered the transformation engine. The output of the XML as it passed through each step of the transform program.
Integration Broker security	Set the application server logging level to 4 or greater to capture information related to the following situations: No routing at source node. No routing at target node. User invoking a service operation has different permissions than specified on the service operation on the source node. No node password found on source node. No node password found on target node. Mismatched node password on source and target nodes. No permissions set for the service operation on the source node.