Contents

Do you need a quick way to create web services?
PeopleSoft Simple Web Services (SWS)

Introducing a small but powerful PeopleSoft bolt-on that makes web services very easy. If you have a SQL statement, you can turn that into a web service in PeopleSoft in a few minutes.

Read More & Purchase

PeopleSoftServiceListeningConnector

Introduction

The PeopleSoftServiceListeningConnector is used to support SOAP. The connector URL is:

  • https://host:port/PSIGW/PeopleSoftServiceListeningConnector

If you are NOT using SOAP do not submit messages to this endpoint.

Discombobulated Notes Follow

Parameters to Listener

The parameters for the connector as the same as the HttpListeningConnector with the following exception for the name of the service operation.

  • For SOAP 1.1:
    • SOAPAction:<External_alias_name>
  • For SOAP 1.2
    • Content-type: application/soap+xml; action=<External_alias_name>

For this listening connector, I found in my testing that passing parameters in the query string seems to be best. Here is an example. You can also pass the node Password in the query string parameter. It does not seem to work with passing as a HTTP header.

POST https://ib.cedarhillsgroup.com/PSIGW/PeopleSoftServiceListeningConnector?Operation=getStudent.v1&To=PSFT_CS&From=VENDOR_X_NODE HTTP/1.1

<SOAP-ENV:Envelope 
    xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" 
    xmlns:ns1="http://soap.avowsystems.com/studentcheck/GenericStudentCheck">
    <SOAP-ENV:Header/>
    <SOAP-ENV:Body>
        <ns1:getStudent>
            <security>
                <auth>
                    <id>CMALKE</id>
                    <token>buga-boo</token>
                </auth>
                <timestamp>2018-05-23T12:42:01-07:00</timestamp>
            </security>
            <studentMatch>
                <firstName>John</firstName>
                <lastName>Smith</lastName>
            </studentMatch>
        </ns1:getStudent>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Looking through oracle support documents you find vague references to how the parameters can be passed. I found a reference that the parameter processing order is the following.

  1. SOAPAction in this format SOAPAction: http://peoplesoft.com/OperationName/RequestingNode/Password/DestinationNode
  2. Headers (In my testing headers are ignored)
  3. Query String with the same To, From, Operation and Password parameters as the HTTPListeningConnector
  4. Path (but you can’t seem to pass to and from in the path)

So if the listener finds a parameter in one of those it will stop looking. So SOAP Action will win.

Getting Schemas/WSDL and WSIL

  • To get an XSD schema use this pattern: http://host/PSIGW/PeopleSoftServiceListeningConnector?Operation=GetSchema&xsd=SERVICE_OPERATION.VERSION
  • Use the following query format to get WSDL: http://host/PSIGW/PeopleSoftServiceListeningConnector?Operation=GetWSDL&wsdl=SERVICE_OPERATION.VERSION
  • Use the following query format to get WSIL: http://host/PSIGW/PeopleSoftServiceListeningConnector?Operation=GetWSIL

If you have a shared integration gateway that serves many PeopleSoft databases each with a unique node name you can use these.

  • To get an XSD schema use this pattern: http://host/PSIGW/PeopleSoftServiceListeningConnector/<REMOTENODE>/<OperationName>.<version>.xsd
  • Use the following path format to get WSDL: http://host/PSIGW/PeopleSoftServiceListeningConnector/<REMOTENODE>/<OperationName>.<version>.wsdl
  • Use the following path format to get WSIL: http://host/PSIGW/PeopleSoftServiceListeningConnector/<REMOTENODE>/inspection.wsil

SOAP Authentication

For SOAP based services submitted over https://host:port/PSIGW/PeopleSoftServiceListeningConnector the authentication is different that both REST and a normal HTTP Post.

You can reference the PeopleBooks Section: Understanding WS-Security but it is still not very clear. ­čśĽ

No External Node Involved

If you do not have a shared gateway and you don’t have a NODE representing your external client application then this may work.

  1. Create a PeopleSoft user name with a password and permission to service operation. USER: CLIENT_X_USER, Password: secret123
  2. Add that user name and password to the SOAP HEADER.
<soapenv:Header xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">;
    <wsse:Security soap:mustUnderstand="1" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">;
      <wsse:UsernameToken>
        <wsse:Username>CLIENT_X_USER </wsse:Username>
        <wsse:Password>secret123</wsse:Password>
      </wsse:UsernameToken>
    </wsse:Security>
  </soapenv:Header>
  • In this case the service operation would have a user name and password required in the Service operation option.
  • If the <wsse:Password> element is not provided or is not a valid user then the IB will use the Default User ID on the ANONYMOUS node is used as the security context.
    • RESEARCH: Is this true? What happens if the anonymous node has full security?
    • RESEARCH: What if you do not include a password but the username is a high level account? does it just take it and run under that context? I hope not.

PeopleSoft Node and Password Involved

If there is a NODE in the configuration then you have to pass a SOAPAction HTTP Header that has encoded in it a special format.

  • Prior to tool 8.48:
    • SOAPAction: #OperationName#RequestingNode#NodePassword#DestinationNode
  • After 8.48:
    • SOAPAction: http://peoplesoft.com/OperationName/RequestingNode/Password/DestinationNode

Notes from Oracle Support

Because third-party systems do not understand the concept of a node as defined and used within the context of PeopleSoft systems, PeopleSoft assigns transactions that have no node specified to a PeopleSoft-delivered Anonymous node.

  • The PeopleSoft system first checks the SOAP message header for an external name and password set programmatically.
    • If none is found or if the system cannot validate the user ID (OPRID) password that was set programmatically, it uses the Default User ID set on the Node Definitions page on the remote Anonymous node definition.

Also see the PeopleSoftServiceListeningConnector for more information on passing values.

Example SOAP Header

Here is an example:

<?xml version="1.0"?>
<soapenv:Envelope 
  xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" 
  xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
  xmlns:wsa="http://schemas.xmlsoap.org/ws/2003/03/addressing/" 
  xmlns:xsd="http://www.w3.org/2001/XMLSchema/" 
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance/">;    
  <soapenv:Header 
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">;        
    <wsse:Security soap:mustUnderstand="1" 
      xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" 
      xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">;            
      <wsse:UsernameToken>
        <wsse:Username>PSCR </wsse:Username>
        <wsse:Password>PSCR</wsse:Password>
      </wsse:UsernameToken>
    </wsse:Security>
  </soapenv:Header>
  <SOAP-ENV:Body>
  
  
  
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Note: For non-wssecurity implementation the tags should appear as follows:

<Username>PSCR </Username>
<Password>PSCR</Password>

Additional Reading

Submitting SOAP Requests.

POST https://ib.cedarhillgroup.com/PSIGW/PeopleSoftServiceListeningConnector HTTP/1.1
SoapAction: CHG_SYNC_UTEST.v1
To: PSFT_HR
Content-Type: text/xml
From: CHG_EXTERNAL_CLIENT
Password: PASSWORD1


<?xml version="1.0"?>
<soapenv:Envelope 
  xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
  xmlns:ser="http://xmlns.oracle.com/Enterprise/HCM/services">
  <soapenv:Header 
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <wsse:Security soap:mustUnderstand="1" 
      xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" 
      xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
      <wsse:UsernameToken wsu:Id="UsernameToken-1" 
        xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
        <wsse:Username>0522004</wsse:Username>
      </wsse:UsernameToken>
    </wsse:Security>
  </soapenv:Header>
  <soapenv:Body>
    <ser:request>
      <ser:inbound1>123</ser:inbound1>
    </ser:request>
  </soapenv:Body>
</soapenv:Envelope>   

Response

HTTP/1.1 500 Internal Server Error
Connection: close
Date: Sat, 12 Oct 2019 15:53:17 GMT
Content-Length: 627
Content-Type: text/xml; charset=UTF-8

<?xml version="1.0" ?>
<SOAP-ENV:Envelope 
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Body>
    <SOAP-ENV:Fault>
      <faultcode>SOAP-ENV:Server</faultcode>
      <faultstring>null</faultstring>
      <detail>
        <IBResponse type="error" 
          xmlns="">
          <DefaultTitle>Integration Broker Response</DefaultTitle>
          <StatusCode>20</StatusCode>
          <MessageID>536</MessageID>
          <DefaultMessage>
            <![CDATA[User PS not authorized to invoke Service Operation CHG_SYNC_UTEST. (158,536)]]>
          </DefaultMessage>
          <MessageParameters>
            <Parameter>
              <![CDATA[PS]]>
            </Parameter>
            <Parameter>
              <![CDATA[CHG_SYNC_UTEST]]>
            </Parameter>
          </MessageParameters>
        </IBResponse>
      </detail>
    </SOAP-ENV:Fault>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Contents

Do you need a quick way to create web services?
PeopleSoft Simple Web Services (SWS)

Introducing a small but powerful PeopleSoft bolt-on that makes web services very easy. If you have a SQL statement, you can turn that into a web service in PeopleSoft in a few minutes.

Read More & Purchase
Author Info
Chris Malek

Chris Malek is a PeopleTools® Technical Consultant with two decades of experience working on PeopleSoft enterprise software projects. He is available for consulting engagements.

About Chris Work with Chris