PeopleTools Integration Broker - The Missing Manual

Book Status

Feedback

Please submit feedback or suggestions for content using the Feedback Form

Introduction

This book was born from real-world experience working with the PeopleSoft ™ Integration Broker module. This book is for developers written by a developer.

It takes an alternative approach to the documentation from Oracle™. The PeopleBooks on this topic:

• Is out of date and has many inconsistencies from updates to PeopleTools.
• Is scattered among a bunch of different articles.
• Has heavy emphasis on pieces that are rarely used.
• Has no clear A-to-Z examples which developers require.

This book is meant to be a reference to come back to often for PeopleSoft developers working with Integration Broker. The Integration Broker has a lot of functionality and much of the functionality is not widely used. We will focus on the most used aspects of the product and focus mainly around HTTP and REST web services. Additionally, we will spend more time on providing web services from PeopleSoft to other systems rather than PeopleSoft acting as the client or consuming web services.

My goal with this book is to pass on knowledge that I have gained over the years wrestling working with the product. I hope it will help many people that are working with the product.

Intended Audience

This book is for anyone creating or calling PeopleSoft web services. It focuses more on the development aspects than the infrastructure aspects.

• PeopleSoft Developers
• Technical Staff trying to integrate with PeopleSoft web services

Assumed Skill Level

• Familiar with PeopleCode
• Familiar with web technology
  • HTTP
  • REST
  • JSON
  • XML

Book Structure / Approach

• This book focuses mainly on Synchronous and Asynchronous HTTP web services.
• Additionally, this book currently focuses on PeopleTools as the provider of the web service and NOT PeopleSoft calling web services.
• We will build out a trivial web service of each type then build on those throughout the book to look at different configuration options like security and processing models.

Table of Contents

Below is the table of contents that can also be accessed in the side-bar.

• Getting Started
• Getting Started
• Recommended Tools
• Why Use Web Services?
• Integration Broker Terminology
• Strategies to Integrate with PeopleSoft
• Development Steps and Estimated Timelines
• Service Operations
• Sync versus Async Web Service Overview
• Asynchronous one-way
• Understanding SOAP versus REST versus HTTP web services in PeopleSoft
• Synchronous Service Operation (non-REST)
• Asynchronous to Synchronous
• Asynchronous request / response
• Common Errors and Solutions
• SOAP
• Queues
• Service Operation Routings
• REST Services
• PeopleSoft REST Services
• A Complete PeopleSoft REST GET Web Service Example
• A Complete PeopleSoft REST POST Web Service Example
• A PeopleSoft REST Delete Web Service Example
• REST Security
• Controlling HTTP Status Codes
• REST Run-time Detection and Code Samples
• REST URI Templates
• Common REST Issues
• PeopleSoft REST Caching
• Security
• Security in Service Operations
• Properly Securing the ANONYMOUS IB Node
• Monitoring & Administration
• Integration Broker Monitoring
• Integration Broker Administration & Maintenance
• Integration Broker Debugging Techniques
• IB Server Cheat Sheet
• Audit Queries for Integration Broker
• Integration Broker PeopleSoft Tables
• Example Service Operations
• HTTP Example Pre-reqs
• Synchronous HTTP Post to PeopleSoft Integration Broker
• HTTP Post to PeopleSoft Integration Broker Asynchronous
• Useful Code Snippets
• Data Encoding/Decoding
• Nodes
• All about PeopleSoft Integration Broker Nodes
• Node Best Practices
• Services Delivered by Oracle
• Application Service Framework
• Reporting Web Services: Using the REST Web Services to run a Query
• Listening Connectors
• What is a Listening Connector?
• HttpListeningConnector
• RESTListeningConnector
• PeopleSoftServiceListeningConnector
• PeopleSoftListeningConnector
• Other Listening Connectors
• Handlers
• Introduction to Handlers
• OnRequest Handler
• OnAckReceive (OnReceive)
• OnError - Non-REST
• OnNotify
• OnPostNotify
• OnPreNotify
• OnReceive
• OnRequestSend Handlers
• OnRouteReceive
• OnRouteSend
• Target Connectors
• HttpTargetConnector - HTTP Target Connector
• Syncing Data Between PeopleSoft Systems
• Knowledge Base Links
• API Gateways
• Introduction to API Gateways
• Best Practices
• Add MetaData in all Responses
• Best Practices with PeopleSoft Table Updates and Inserts
• Integration Broker Technologies to Avoid