PeopleTools Integration - Quick Reference Guide

The Integrations & Data Management Work Group received feedback from the community through the integrations survey and one of the commonly requested items was to provide ‘better examples and documentation’ for integrations. Each integration is very unique and dependent on several factors including but not limited to the two applications involved in the integration and the technology used. Rather than focus on specific integrations, this blog provides a compilation of ‘how-to’ guides and blogs related to the various types/options of integration which are available within PeopleTools. We hope this gives you a starting point to get your feet wet and explore more in the integrations realm!

E-IB: How To Consume a Third Party Web Service in Integration Broker Version 8.48 Or Higher with Sample Code (Doc ID 661163.1)
This document provides a step by step guide to consume a sample third-party/external web service from within a PeopleSoft application.

https://support.oracle.com/epmos/faces/DocumentDisplay?id=661163.1

E-CI: How to Create or Provide CI Based Web Services in PT8.48+ with Troubleshooting Tips (Doc ID 653713.1)
This document provides a step by step guide to create a CI based web service. It uses the SDK_STOCK_DATA component interface (which exists in CS, HCM and FSCM) as an example and goes through the motions from end to end.

https://support.oracle.com/epmos/faces/DocumentDisplay?id=653713.1

Pros and Cons of Component Interface as a Service 
Talking about CI based web services, this blog written by Chris Malek from Cedar Hills Group, Inc, is a great material which enables us to understand when it might be appropriate to use CI based web services and what is the alternative? This blog beautifully describes all the challenges with a CI based web service particularly when the data structure of the component involved is complex in nature. While Chris talks about the alternative in abstract terms, really, we are referring to an App Package based Web Service where we have more control over the request/response message structures that we expose to a third-party/external consumer. By using an App Package, we naturally get a lot more options to process/handle the requests (not restricted to CI data structure and methods).

https://www.cedarhillsgroup.com/knowledge-base/kbarticles/should-you-expose-a-ci-as-a-web-service/

A Step by Step Guide to Building an Application Package Web Service 
This is a perfect segue to mention this Alliance 2010 presentation by Tony Neaton from Griffith University, Australia. That is right, we mentioned a presentation from Alliance 2010! While this may be from a while back, the detailed steps to create a simple App Package based web service are still relevant and have not changed.

https://www.heug.org/p/do/sd/topic=950&sid=9620 

E-IB: How to create a message-based web services and test with sendmaster (Doc ID 662893.1)
Similarly, this document from My Oracle Support provides a step by step guide to create a message-based web service which is basically the same as App Package based web service. The document also demonstrates how to use sendmaster a PeopleTools client to test services.

https://support.oracle.com/epmos/faces/DocumentDisplay?id=662893.1

Using soapUI for testing Web Services
Talking about testing, soapUI is another great utility that enables developers and testers to interact with web services. Here are a couple of blogs (relevant to PeopleSoft) that discuss how to get started with soapUI.

http://peoplesoft.wikidot.com/testing-web-services-with-soapui
http://peoplesoftdotnet.blogspot.com/2015/03/test-delivered-peoplesoft-ws.html

E-IB: How to Create an Async Request/Response PS Web Services (Doc ID 1561123.1)
The Asynchronous Request/Response Peoplesoft web service is not a common scenario but it is a great way to asynchronously communicate with an external system. This document provides a step by step guide including an example test case using soapUI.

https://support.oracle.com/epmos/faces/DocumentDisplay?id=1561123.1

E-IB: How To Use Asynchronous-To-Synchronous Service Operation in 8.48+ (Doc ID 872627.1)
This scenario (Asynchronous-To-Synchronous) again is a rare use case but this document is another great step by step guide!

https://support.oracle.com/epmos/faces/DocumentDisplay?id=872627.1

E-IB: How to create and access a simple REST based Web Services? (Doc ID 1454887.1)
So far we have looked at various scenarios related to SOAP based web services. Now, we move our attention to REST based web services. This document provides a step by step guide to create a simple REST based web service in PeopleTools.

https://support.oracle.com/epmos/faces/DocumentDisplay?id=1454887.1

E-IB: Example for PeopleSoft REST provider service (GET/POST methods) (Doc ID 1533318.1)
This document goes into further detail on how we can create a REST web service utilizing different methods such as GET and POST. The document also contains an app designer project which can be imported for further exploration!

https://support.oracle.com/epmos/faces/DocumentDisplay?id=1533318.1

E-IB: Example for Consuming a Third-Party RESTful Web Service (Doc ID 1592925.1)
This document provides a step by step guide on how to consume a third-party/external REST web service from a PeopleSoft application. Again, this document contains an app designer project which is very handy! The document includes details for two different methods – GET and POST. The POST example actually references the example POST service from Doc ID 1522218.1. It would be ideal to create the POST method in a PeopleSoft application (say HCM) using steps detailed in Doc ID 1522218.1 and then consume the POST method from another PeopleSoft application (say CS) using the steps detailed in this document.

https://support.oracle.com/epmos/faces/DocumentDisplay?id=1592925.1

Another REST Web Service Example 
Chris Malek from Cedar Hills Group, Inc, again has yet another step by step example of a REST web service!

https://www.cedarhillsgroup.com/knowledge-base/kbarticles/PeopleSoft-REST-web-service-start-to-finish/ 

Using POSTMAN for testing REST web services
While SendMaster (PeopleTools) and soapUI are great utilities for testing web services. POSTMAN is particularly handy when it comes to testing REST web services! The following blogs provide a glimpse of how we can use POSTMAN for testing REST.

https://community.oracle.com/docs/DOC-1006255
http://jmcmahon33.blogspot.com/2015/05/testing-rest-web-service.html

Securing the ANONYMOUS Node
Last but not the least, it is important to consider how-to properly secure the ANONYMOUS node which is used heavily in external integrations. The following PeopleBook and blog written by Chris Malek from Cedar Hills Group, Inc, explain the significance of this external node.

https://docs.oracle.com/cd/E92519_01/pt856pbr2/eng/pt/tfee/task_ConfiguringtheDefaultUseroftheANONYMOUSNode-887f6a.html
https://www.cedarhillsgroup.com/knowledge-base/kbarticles/integration-broker-anonymous-node-security/

12 Likes
Recent Stories
Did You Know you can create data sets for reporting self-service in MS PowerBI?

Did You Know you could create a Calendar view in Tableau in 8 easy steps?

What's a Chief Data Officer? An Interview with Nick Stevens, University of Kansas