PeopleSoft Connector User Guide


The PeopleSoft Connector is a closed source connector that uses the Component Interface (CI) to communicate in real-time with the service. This is a component provided by Oracle’s People Tools.

Read more about Oracle’s PeopleTools.

Before You Begin

Because of how closely the connector is coupled with PeopleSoft, this document assumes you have:

  • A working knowledge of PeopleSoft.

  • Read the relevant documentation on Component Interfaces and Integration Scenarios for your PeopleTools version.

The definition and detailed explanation of the PeopleSoft terms and concepts used here are freely available in the PeopleBooks documentation set of your PeopleSoft installation.

This document assumes you are familiar with Mule, Anypoint Connectors, and Anypoint Studio.

To use the PeopleSoft connector, you must have the following:

  • Anypoint Studio: if you don’t use Anypoint Studio for development, follow the instructions to install the PeopleSoft Maven dependencies into your pom.xml file .

  • Java 7: PeopleSoft connector does not work unless you are using JRE 1.7. Download JRE 1.7.

  • Component Interface: at least one Component Interface must be created and exposed within the PeopleSoft instance using the Application Designer.

  • PeopleSoft Java Object Adapter JAR File: the psjoa.jar library is compiled and provided by a PeopleSoft administrator, and is unique to each installation of PeopleSoft.

Component Interfaces (CI)

PeopleSoft’s Component Interfaces are a “one-way”, real-time interface to your PeopleSoft database instance. A component in PeopleSoft is a logical grouping of PeopleSoft pages representing a complete business transaction, such as Employee Onboarding. Component Interfaces expose the underlying APIs used by PeopleSoft Components and, therefore, ensure that validations, defaults, and business logic are preserved from the original definition of those components.

The Component Interfaces allow you to query PeopleSoft for specific records, update data, and create new instances of the records.

Attributes and Architecture

A component interface has the following four main attributes:

  • Component Interface Name: each component interface requires a unique name. The programs calling a component use the name of the component interface to access properties and methods.

  • Keys (Get keys, Create keys, and Find keys): keys are special properties containing values that retrieve an instance (get keys) or a list of instances (find keys) of the component interface. You can add, remove, or change keys in PeopleSoft Application Designer. Keys are created automatically when you create a component interface.

    • Get keys: map to fields marked as search keys in the Components Search record.

    • Create keys: generated in CI when the Use tab on the Component Properties dialog allows the Add action.

    • Find keys: map to fields marked as both Alternate Search keys and Search Key in the Component Search Record.

  • Properties and Collections (Fields and Records): properties provide access to both component data and component interface settings. A property can correspond to a field or a scroll (collection). A component interface collection is a special type of property that corresponds to a scroll and contains fields and subordinate scrolls as defined in its underlying component. There are two types of properties:

    • Standard properties are assigned automatically when a component interface is created.

    • User-defined properties map to record fields on the PeopleSoft component and are displayed in the PeopleSoft Application Designer.

  • Methods: a method is a function that performs a specific task on a component interface at run time. There are two main types of methods: standard and user-defined.

    • Standard methods are those that are available for all component interfaces. The following are the standard methods that the connector supports:

      Method Description


      Add a new instance of the Component Interface to the PeopleSoft database. This is similar to clicking Add and entering the relevant keys through the PeopleSoft Web UI.


      Cancel an instance of the Component Interface. This is equivalent of the Cancel operation in the Web UI when working on a particular component.


      Search for any instances of the component that match the provided Search Keys. This returns a list of possible matches.


      Retrieve instances that match the specific keys you provide. This returns a single record or none at all.


      Save changes made to the component, new, or existing.

      The Save operation tries to update an existing record before creating a new one. For new records, the connector automatically populates the keys with default values provided by the PeopleSoft instance, thereby reducing the need for the user to provide the default key/values pairs.
    • User-defined methods are created in PeopleSoft Application Designer to provide added functionality to the component interface.

Read more about Oracle’s Component Interfaces.


For Hardware and software requirements, please visit MuleSoft.com.


The PeopleSoft connector requires the following dependencies:

Application/Service Version

Mule Runtime

3.6.x or higher




8.53.02 or higher



Anypoint Studio

5.2 or higher

PeopleSoft 9.2 includes several modules, such as: Human Capital Management (HCM), Financial Management (FM), Enterprise Services Automation (ESA), Supplier Relationship Management (SRM), Customer Relationship Management (CRM) and Campus Solution (CS).

Installing and Configuring

To use the PeopleSoft connector in a production environment, you must have either:

  • An Enterprise license to use Mule.

  • A CloudHub Starter, Professional, or Enterprise account.

Contact the MuleSoft Sales Team to obtain either of these. Read more about Installing an Enterprise License.


To install PeopleSoft connector in Anypoint Studio, follow the steps below:

Anypoint Studio Install Window
  • Click Next and accept the License Agreement.

  • Restart Studio when prompted.

  • Now, the PeopleSoft connector should appear in your Studio Palette:

    Anypoint Studio palette - PeopleSoft Connector
Read more about Installing Connectors.


To use the PeopleSoft connector in your Mule application, you must configure a global PeopleSoft element that can be used by all the PeopleSoft connectors in the application.

Read more about Global Elements.

Setting up the Global Configuration

Studio Visual Editor

  1. Click the Global Elements tab at the base of the canvas.

  2. On the Global Mule Configuration Elements screen, click Create.

  3. In the Choose Global Type wizard, expand Connector Configuration and select PeopleSoft: Configuration and click Ok.

    Global Element Configuration Wizard
  4. Configure the parameters according to instructions below.

    Global Element Configuration
    Field Description


    Enter a name for the configuration with which it can be referenced later.


    Enter the URL of the server from where to access the services. It must comply with the form of HOST:PORT.


    Enter a username to log in to the PeopleSoft instance.


    Enter the password to log in to the PeopleSoft instance.

    Required dependencies

    Click Add File to attach the psjoa.jar file that is compiled from your PeopleSoft instance to your project’s Build path. Learn how to compile the psjoa.jar file.

    Global Element - Required dependencies

    After the psjoa.jar file is attached, the file will appear in the lib/peoplesoft directory of your project’s root folder.

    Dependencies folder

    If you provide the wrong file (either an invalid psjoa.jar or a completely different library), Studio displays the following error message:

    Global Element - Invalid dependencies

    The psjoa.jar file is unique to each installation of PeopleSoft. It is compiled and provided by your PeopleSoft administrator. If the psjoa.jar isn’t provided to you, follow the steps below to build the component interface bindings:

  5. Start PeopleSoft Application Designer and open any Component Interface definition.

  6. Select Build > PeopleSoft APIs to launch the Build PeopleSoft API Bindings dialog box.

  7. Under the Java Classes group box, select the Build check box. Specify the target directory in which you want the Java class source files to be created.

  8. Click OK to build the selected bindings. The files that constitute the bindings are built in the location that you specify. If the operation is successful, a Done message appears in the PeopleSoft Application Designer Build window.

  9. Compile the generated APIs using the following commands:

For Windows:

cd %PS_HOME%\class\PeopleSoft\Generated\CompIntfc
javac −classpath %PS_HOME%\class\psjoa.jar *.java

cd c:\pt8\class\PeopleSoft\ Generated\ PeopleSoft
javac −classpath %PS_HOME%\class\psjoa.jar *.java

For Mac/Linux:

cd $PS_HOME/class/PeopleSoft/Generated/CompIntfc
javac classpath $PS_HOME/class/psjoa.jar *.java

cd $PS_HOME/class/PeopleSoft/Generated/PeopleSoft
javac classpath $PS_HOME/class/psjoa.jar *.java

+ NOTE: Read more about compiling the PeopleSoft API in Building APIs in Java.

+ . Keep the Pooling Profile and the Reconnection tabs with their default entries. Click Test Connection to receive a Connection Successful message. If you receive an error, try the following resolutions based on the error message: .. Unsupported major/minor version 51.0: Indicates that you are running with a 1.6 JRE. To resolve this, ensure that you are running with Java 1.7 and restart Studio. .. java.lang.NoClassDefFoundError: psft/pt8/joa/ISession and java.lang.ClassNotFoundException: psft.pt8.joa.ISession: This exception indicates that you haven’t installed the psjoa.jar file. To access PeopleSoft Component Interface in your Mule flows, you must add the PeopleSoft Component Interface API to your project. Compile the API using the PeopleSoft Application Designer Build Window and provide the archive name as psjoa.jar. To resolve the issue, go back to the Required dependencies panel and select the corresponding JAR file. . Configure your Component Interface White List according to the steps below: .. Click Create Object manually and click the button next to it.


General properties with Enable DataSense and Create Object manually options selected

+ .. In the pop-up window, select the (+) plus button to set the names of your component interfaces.


Global Element - Object Builder

+ .. Right-click a metadata item and select Edit the selected metadata field to set the values. You can also double-click each item to modify the value inline.


Global Element - Object Builder Item

+ .. Click OK to save the list.

+ . Click OK to save the global connector configurations.

XML Editor

  1. Ensure you have included the PeopleSoft namespaces in your configuration file.

    <mule xmlns="http://www.mulesoft.org/schema/mule/core"
          <!-- here go your flows and configuration elements -->
  2. Create a global element for PeopleSoft configuration using the following global configuration code:

    <peoplesoft:config name="PeopleSoft" server="${mule.peoplesoft.server}" username="${mule.peoplesoft.username}" password="${mule.peoplesoft.password}" doc:name="PeopleSoft">
    Parameter Description


    Enter a name for the configuration with which it can be referenced later.


    Enter the URL of the PeopleSoft instance.


    Enter a username to log into PeopleSoft.


    Enter the password.


    The default value is PeopleSoft.

  3. Configure your Component Interface. Find the internal tag <peoplesoft:component-interface-ids-white-list ref="#[payload]"/> and replace it with the following code snippet:

  4. Save the changes made to the XML file.

Upgrading From an Older Version

From 1.x.x to 2.0.0

Inside your flow, identify the peoplesoft:invoke-operation tag. It should look similar to the following snippet:

<peoplesoft:invoke-operation config-ref="PeopleSoft" doc:name="Find" type="CI_PERSONAL_DATA##Find"/>
  • Replace the parameter type with key.

  • Replace the operation symbol ## (double hash) with || (double pipe).

The final result should look like the following snippet:

<peoplesoft:invoke-operation config-ref="PeopleSoft" doc:name="Find" key="CI_PERSONAL_DATA||Find"/>

Using The Connector

PeopleSoft connector is an operation-based connector, which means that when you add the connector to your flow, you need to configure a specific operation, Invoke Component Interface, for the connector to perform. After you call the Invoke Component Interface, you can use the Component Name field to select a particular Component Interface and the Operation field to specify the method that you want it to execute. PeopleSoft connector allows you to perform five standard operations (Create, Find, Get, Save, Cancel) on each Component Interface (if available in your PeopleSoft instance), along with any CI-specific custom operations.

Use Cases and Demos

Listed below are the most common use cases for the PeopleSoft connector:

Find Employees

Retrieves one or more Employee records by invoking the Find operation of CI_PERSONAL_DATA

Get Employee

Retrieves the complete information of a single Employee Personal Data record by invoking the Get operation of CI_PERSONAL_DATA.

Save Employee

Updates the fields of a single Employee Personal Data record by invoking the Save operation of CI_PERSONAL_DATA Component Interface.

Save Employee From CSV File

Updates a single Employee Personal Data record by invoking the Save operation of CI_PERSONAL_DATA Component Interface.

Save Position From CSV File

Updates a single Position Data record by invoking the Save operation of CI_POSITION_DATA Component Interface.


Test the Connection

Use the Test Connection feature to validate not only the connection to the PeopleSoft instance, but also the Component Interfaces defined in the allowlist.

  1. Open the PeopleSoft Global Element Configuration.

  2. Click the Test Connection button. If one ore more Component Interfaces names are invalid, you will get an error message.

  3. To solve this issue, just click the […​] button next to the Create Object manually option and provide the correct name for the Component.

DataSense Timeout

Avoid DataSense Timeout

The metadata retrieval for the Save operation takes longer than the rest of the operations. Therefore, Studio might throw a timeout exception with the message: "Problem while fetching metadata. The operation timed out and was not successful. You can configure this timeout in the Studio Preferences dialog."

DataSense Timeout
  1. Go to Windows > Preferences.

  2. Expand the Anypoint Studio menu and select DataSense.

  3. Set the option DataSense Connection Timeout (in seconds) to 120.

  4. Click Apply.

  5. Click OK.

DataSense Timeout Config
If you click the Refresh metadata link in your flow settings and wait a few moments, the metadata for the Save operation should now be correctly populated.
DataSense Timeout Fix

Adding to a Flow

  1. Create a new Mule Project in Anypoint Studio.

  2. Add a suitable Mule Inbound Endpoint, such as the HTTP listener or File endpoint, to begin the flow.

  3. Drag and drop the PeopleSoft Connector onto the canvas.

  4. Click on the connector component to open the Properties Editor.

    Flow Settings
  5. Configure the following parameters:

    Field Description

    Basic Settings

    Display Name

    Enter a unique label for the connector in your application.

    Connector Configuration

    Connect to a global element linked to this connector. Global elements encapsulate reusable data about the connection to the target resource or service. Select the global PeopleSoft connector element that you just created.


    Select Invoke Component Interface from the drop-down menu.


    Component Name

    Select the ID of the Components Interface you want to work with.


    Select the operation you want to perform on the Component Interface previously defined. The PeopleSoft Connector lets you execute five standard operations on each Component Interface along with any CI-specific custom operations: Cancel, Create, Find, Get, Save.


    • None: Select this option if the input parameters are not required for the operation.

    • From Message: Select this option to define the operation based on the incoming payload.

    • Create Object manually: Select this option to define the search values manually. Mule provides an editor to facilitate this task.

  6. Save your configurations.

Example Use Case

Retrieve a collection of employee records.

Find Employees Flow

Studio Visual Editor

  1. Create a new Mule Project in Anypoint Studio.

  2. Create a peoplesoft.properties file to hold your PeopleSoft credentials and place it in src/main/resources.

  3. Configure a Property Placeholder component and set the path to your credentials file.

    <context:property-placeholder location="peoplesoft.properties"/>
  4. Drag a HTTP endpoint onto the canvas and configure the following parameters:

    Parameter Value

    Display Name


    Connector Configuration

    If no HTTP element has been created yet, click the plus sign to add a new HTTP Listener Configuration and click OK (leave the values to its defaults).



  5. Drag the PeopleSoft connector next to the HTTP endpoint component and configure it according to the steps below:

    1. Add a new PeopleSoft Global Element by clicking the plus sign plus icon next to the Connector Configuration field.

    2. Configure the global element according to the table below:

      Parameter Description Value


      Enter a name for the configuration with which it can be referenced later.



      The URL of the PeopleSoft instance



      The username credential to log into the PeopleSoft instance



      The password credential to log into the PeopleSoft instance


      Required dependencies

      Click Add File to attach the psjoa.jar file that is compiled from your PeopleSoft instance to your project’s Build path. Learn how to compile the psjoa.jar file.

      Server, Username and Password use property placeholder syntax to load the credentials in a simple and reusable way. Read more about this practice at Configuring Properties.
      <peoplesoft:config name="PeopleSoft" server="${config.server}" username="${config.username}" password="${config.password}" doc:name="PeopleSoft">
  6. Click Test Connection to confirm that Mule can connect with the PeopleSoft instance. If the connection is successful, click OK to save the configurations. Otherwise, review or correct any incorrect parameters, then test again.

  7. Back in the properties editor of the PeopleSoft connector, configure the remaining parameters:

    Parameter Value

    Basic Settings

    Display Name

    Find Employees (or any other name you prefer).

    Connector Configuration

    PeopleSoft (the reference name to the global element you have created).


    Invoke Component Interface


    Component Name

    CI_PERSONAL_DATA (the component interface name that holds the employee data).



  8. Check that your XML looks as follows:

    <peoplesoft:invoke-operation config-ref="PeopleSoft" key="CI_PERSONAL_DATA||Find" doc:name="Find Employees" />
    Attribute Value







  9. Add a Transform Message (DataWeave) element between the HTTP endpoint and the PeopleSoft endpoint to map the structure required by the FIND method. (Alternatively, you may use a DataMapper element in place of a DataWeave element.) If DataSense is enabled, the input fields should be automatically populated:

    DataWeave - Input
  10. The input parameters expected by the FIND operation are:

    PeopleSoft Field Query Param Optional?













  11. Inside the DataWeave code, you can use a MEL expression to define a HTTP Query Param for all the fields. This way, each value can be dynamically set from the URL.

    DataWeave - Map To CI_PERSONAL_DATA
    %dw 1.0
    %output application/java
    	KEYPROP_EMPLID: inboundProperties['http.query.params'].id,
    	PROP_NAME: inboundProperties['http.query.params'].name,
    	PROP_LAST_NAME_SRCH: inboundProperties['http.query.params'].lastname,
    	PROP_NAME_AC: inboundProperties['http.query.params'].nameac
    Read more about MEL notation in Mule Expression Language Examples.
  12. Add an Object to JSON transformer after the PeopleSoft element to display the response in the browser.

  13. Add a Logger scope after the JSON transformer to print the data that is being passed to the PeopleSoft connector in the Mule Console. Configure the Logger according to the table below.

    Parameter Value

    Display Name

    Employee List (or any other name you prefer)


    #[payload] (the output from DataWeave)



XML Editor

Example Use Case Code

Paste this code into your XML Editor to quickly load the flow for this example use case into your Mule application.

<?xml version="1.0" encoding="UTF-8"?>
<mule xmlns:dw="http://www.mulesoft.org/schema/mule/ee/dw" xmlns:context="http://www.springframework.org/schema/context"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.mulesoft.org/schema/mule/core"
      xsi:schemaLocation="http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-current.xsd
http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-current.xsd
http://www.mulesoft.org/schema/mule/core http://www.mulesoft.org/schema/mule/core/current/mule.xsd
http://www.mulesoft.org/schema/mule/peoplesoft http://www.mulesoft.org/schema/mule/peoplesoft/current/mule-peoplesoft.xsd
http://www.mulesoft.org/schema/mule/file http://www.mulesoft.org/schema/mule/file/current/mule-file.xsd
http://www.mulesoft.org/schema/mule/json http://www.mulesoft.org/schema/mule/json/current/mule-json.xsd
http://www.mulesoft.org/schema/mule/ee/data-mapper http://www.mulesoft.org/schema/mule/ee/data-mapper/current/mule-data-mapper.xsd
http://www.mulesoft.org/schema/mule/http http://www.mulesoft.org/schema/mule/http/current/mule-http.xsd
http://www.mulesoft.org/schema/mule/ee/dw http://www.mulesoft.org/schema/mule/ee/dw/current/dw.xsd">
	<context:property-placeholder location="peoplesoft.properties"/>
        <spring:import resource="classpath:DemoSpringBeans.xml"/>
    <peoplesoft:config name="PeopleSoft" server="${config.server}" username="${config.username}" password="${config.password}" doc:name="PeopleSoft">
        <reconnect count="3"/>
    <asynchronous-processing-strategy name="Asynchronous_Processing_Strategy" maxThreads="5" minThreads="2" threadTTL="10" poolExhaustedAction="WAIT"
                                      doc:name="Asynchronous Processing Strategy"/>
    <http:listener-config name="HTTP_Listener" host="" port="8081" doc:name="HTTP Listener Configuration"/>
    <file:connector name="File" autoDelete="true" streaming="true" validateConnections="true" doc:name="File"/>
    <data-mapper:config name="Employee_Position_Data_to_CI_POSITION_DATA" transformationGraphPath="employee_position_data_to_ci_position_data.grf"
    <data-mapper:config name="Employee_Data_to_CI_PERSONAL_DATA" transformationGraphPath="employee_data_to_ci_personal_data.grf"

    <flow name="Find_Employee_Flow">
        <http:listener config-ref="HTTP_Listener" path="/find" doc:name="HTTP"/>
        <dw:transform-message doc:name="Map To CI_PERSONAL_DATA">
            <dw:set-payload><![CDATA[%dw 1.0
%output application/java
	KEYPROP_EMPLID: inboundProperties['http.query.params'].id,
	PROP_NAME: inboundProperties['http.query.params'].name,
	PROP_LAST_NAME_SRCH: inboundProperties['http.query.params'].lastname,
	PROP_NAME_AC: inboundProperties['http.query.params'].nameac
        <peoplesoft:invoke-operation config-ref="PeopleSoft" key="CI_PERSONAL_DATA||Find" doc:name="PeopleSoft"/>
        <json:object-to-json-transformer doc:name="List&lt;CI_PERSONAL_DATA&gt; To JSON"/>
        <logger level="INFO" doc:name="Employee List" message="#[payload]"/>

Run Time

  1. Save and run the project as a Mule Application.

  2. Open a web browser and check the response after entering the URL http://localhost:8081/find?id=MULE&name=&last_name=&name_ac=. If in your PeopleSoft database there are records whose KEYPROP_EMPLID contains the value "MULE", you should get a JSON collection with those records. Otherwise, you receive an empty collection.

    "PROP_NAME": "Muley",
    "PROP_LAST_NAME_SRCH": "The Mule",
    "PROP_NAME_AC": ""
    "PROP_NAME": "Second Muley",
    "PROP_LAST_NAME_SRCH": "The Backup Mule",
    "PROP_NAME_AC": ""
In this example, all input parameters for the FIND operation are optional. If none of them defined (http://localhost:8081/find?id=&name=&last_name=&name_ac=), then PeopleSoft will retrieve the first 300 records available (the maximum limited by the server).


You can download a fully functional example from this link.

See Also

Was this article helpful?

💙 Thanks for your feedback!

Edit on GitHub
Submit your feedback!
Share your thoughts to help us build the best documentation experience for you!
Take our latest survey!