Contact Us 1-800-596-4880
  1. Homepage
  2. Oracle PeopleSoft REST Connector (1.0)

  3. Oracle PeopleSoft REST Connector Reference

All Connectors

Oracle PeopleSoft REST Connector 1.0 Reference

Oracle PeopleSoft REST Connector calls PeopleSoft Component Interface REST Transport (CIRT) endpoints over HTTPS through the Integration Broker REST listener.

Configurations

Config

Configuration for the CIRT REST-over-HTTPS surface of Oracle PeopleSoft REST Connector. Set the Integration Broker REST listener base URI, TLS and HTTP settings, and either Basic authentication or OAuth 2.0 client credentials.

Parameters

Name Type Description Default Value Required

Name

String

Name for this configuration. Connectors reference the configuration with this name.

x

Connection

The connection types to provide to this configuration.

x

Response Timeout

Number

Default CIRT response timeout. A per-operation value overrides this setting.

30

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for Response Timeout.

SECONDS

Encoding

String

Charset for result payloads that the connector emits to the flow. If blank, the connector uses the runtime encoding. Request bodies sent to PSIGW are UTF-8 JSON. The response media type follows the PSIGW Content-Type.

Expiration Policy

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.

Connection Types

Basic Auth Connection

Basic authentication connection provider for the PeopleSoft CIRT surface. HTTPS is strongly recommended because CIRT carries credentials and PII. The scheme comes from Base URI. Wrong credentials cause the connectivity test to fail. An HTTP 401 is returned as UNAUTHORIZED.

Parameters
Name Type Description Default Value Required

Base URI

String

Base URI of the CIRT REST endpoint, for example https://<host>:8443/PSIGW/RESTListeningConnector/PSFT_HR.

x

Connectivity Test Path

String

CIRT route used by Test Connection. If this field is blank, the connector probes GET /CIRT_USER_PROFILE_F_GET.V1, the default route, and accepts any HTTP 200 response, including an HTML routing-error page. Set a path to require HTTP 200 with an XML or JSON body.

Component Interface List

Array of String

Optional Component Interface names that the connector validates at connect time. Each name is probed through its FIND route and must return HTTP 200 with an XML or JSON body. The list also supplies values for the Component Interface parameter on Invoke CIRT Operation. If the list is empty, the connector falls back to the single-path probe.

Username

String

PeopleSoft user ID used to authenticate CIRT requests.

x

Password

String

Password associated with Username.

x

Default Headers

Array of Default Header

Headers added to every CIRT request and connectivity test probe when the operation doesn’t set the same header name.

Query Parameters

Array of Default Query Parameter

Query parameters added to every CIRT request and connectivity test probe when the operation doesn’t set the same parameter name. On some PeopleTools gateways, query parameters on CIRT routes are treated as path keys, so prefer headers for CIRT traffic.

Max Connections

Number

Maximum number of outbound connections the client keeps open. -1 means unbounded.

-1

Connection Timeout

Number

Maximum time to establish the TCP connection to PSIGW.

30

Connection Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for Connection Timeout.

SECONDS

Connection Idle Timeout

Number

How long an idle connection is kept in the pool before being closed.

30

Connection Idle Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for Connection Idle Timeout.

SECONDS

Proxy Configuration

PeopleSoft Proxy Config

Optional HTTP proxy through which PSIGW calls are routed. If omitted, no proxy is used.

TLS Configuration

TLS

TLS context used for HTTPS connections to PSIGW. If omitted, the connector uses the JVM trust configuration.

Reconnection

Reconnection

Configures a reconnection strategy to use when a connector operation fails to connect to an external server.
OAuth 2.0 Client Credentials Connection

OAuth 2.0 client credentials connection provider for the PeopleSoft CIRT surface. Use this connection when the Integration Broker REST listener is fronted by an OAuth-secured gateway. Each PeopleSoft installation is self-hosted, so you must override the token URL, client ID, client secret, and scopes in the configuration. For example, on Microsoft Entra ID, the client credentials grant requires the resource default scope api://<client-id>/.default. A delegated scope such as readwrite is rejected with an invalid_scope error. Other identity providers use their own scope syntax. An HTTP 401 requests a new token and retries once.

Parameters
Name Type Description Default Value Required

Base URI

String

Base URI of the CIRT REST endpoint, for example https://<host>:8443/PSIGW/RESTListeningConnector/PSFT_HR.

x

Connectivity Test Path

String

CIRT route used by Test Connection. If this field is blank, the connector probes GET /CIRT_USER_PROFILE_F_GET.V1, the default route, and accepts any HTTP 200 response, including an HTML routing-error page. Set a path to require HTTP 200 with an XML or JSON body.

Component Interface List

Array of String

Optional Component Interface names that the connector validates at connect time. Each name is probed through its FIND route and must return HTTP 200 with an XML or JSON body. The list also supplies values for the Component Interface parameter on Invoke CIRT Operation. If the list is empty, the connector falls back to the single-path probe.

Default Headers

Array of Default Header

Headers added to every CIRT request and connectivity test probe when the operation doesn’t set the same header name.

Query Parameters

Array of Default Query Parameter

Query parameters added to every CIRT request and connectivity test probe when the operation doesn’t set the same parameter name. On some PeopleTools gateways, query parameters on CIRT routes are treated as path keys, so prefer headers for CIRT traffic.

Max Connections

Number

Maximum number of outbound connections the client keeps open. -1 means unbounded.

-1

Connection Timeout

Number

Maximum time to establish the TCP connection to PSIGW.

30

Connection Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for Connection Timeout.

SECONDS

Connection Idle Timeout

Number

How long an idle connection is kept in the pool before being closed.

30

Connection Idle Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for Connection Idle Timeout.

SECONDS

Proxy Configuration

PeopleSoft Proxy Config

Optional HTTP proxy through which PSIGW calls are routed. If omitted, no proxy is used.

TLS Configuration

TLS

TLS context used for HTTPS connections to PSIGW. If omitted, the connector uses the JVM trust configuration.

Reconnection

Reconnection

Configures a reconnection strategy to use when a connector operation fails to connect to an external server.

Client Id

String

OAuth client ID as registered with the service provider.

x

Client Secret

String

OAuth client secret as registered with the service provider.

x

Token Url

String

Token endpoint URL of the service provider.

https://your-idp-host/oauth2/v2.0/token

Scopes

String

OAuth scopes to request. The default is readwrite, the PeopleTools OAuth access level. Override this value for your identity provider.

readwrite

Object Store

String

Configures the object store that stores data for each resource owner. If not configured, Mule uses the default object store.

Supported Operations

Operations

Invoke CIRT Operation

<ms-peoplesoft-rest:invoke-cirt-operation>

Invokes a Component Interface method through the standard CIRT V1 contract and returns the classified response from a single request. The Component Interface must be registered and REST-enabled on a PeopleTools 8.58 or later target instance. Custom Component Interface methods, service or operation aliases, non-V1 operation versions, and customized message contracts aren’t supported.

For CREATE, SAVE_SCALAR, and SAVE_NESTED, provide an unwrapped Component Interface JSON body. The connector adds the CIRT request envelope and rejects a body that already contains one. GET and FIND don’t send a request body. Successful responses retain the PeopleSoft response envelope. Write operations can return an acknowledgement instead of a complete record, so invoke GET explicitly when the application requires the resulting record.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Component Interface

String

Component Interface name, for example USER_PROFILE or LOCATION.

x

Method

Enumeration, one of:

  • CREATE

  • GET

  • FIND

  • SAVE_SCALAR

  • SAVE_NESTED

CIRT verb. SAVE_SCALAR is the scalar update (child rowsets unchanged). SAVE_NESTED is the nested Update Data write of the full graph. Omitted child collections can delete rows on Update Data.

x

Path Keys

Array of String

Ordered URL path-key values. Leave this field empty for CREATE. This field is required for GET, FIND, SAVE_SCALAR, and SAVE_NESTED. For SAVE operations, include the level-0 key names and values in the request body.

Body

Binary

Unwrapped Component Interface JSON for CREATE, SAVE_SCALAR, and SAVE_NESTED. This field is ignored for GET and FIND.

#[payload]

Output Mime Type

String

MIME type of the payload that this operation outputs.

Output Encoding

String

Encoding of the payload that this operation outputs.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Headers

Object

Custom HTTP headers. These headers override connection defaults with the same name. The connector requests application/json when neither the operation nor the connection sets an Accept header.

Custom Query Parameters

Object

Custom query parameters to append to the CIRT request URL. These parameters override connection defaults with the same name. On some PeopleTools gateways, query parameters on CIRT routes are treated as path keys, so prefer headers for CIRT traffic.

Response Timeout

Number

Per-request response timeout. If unset, the operation inherits the configuration-level default of 30.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for Response Timeout. If unset, the operation inherits the configuration-level default of SECONDS.

Encoding

String

Charset for this invocation’s result payload. If unset, the operation inherits the configuration-level Encoding. Request bodies sent to PSIGW are UTF-8 JSON. The response media type follows the PSIGW Content-Type.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Binary

Attributes Type

PeopleSoft Attributes

For Configurations

Throws

Error Description

MS-PEOPLESOFT-REST:CONNECTIVITY

The connector can’t reach PSIGW, or the connectivity test fails.

MS-PEOPLESOFT-REST:UNAUTHORIZED

Authentication failed. A Basic authentication HTTP 401 raises this error. An OAuth HTTP 401 requests a new token and retries once before this error is raised.

MS-PEOPLESOFT-REST:FORBIDDEN

PSIGW returned HTTP 403.

MS-PEOPLESOFT-REST:REQUEST_FAILED

The CIRT request failed. This includes PeopleSoft Require SSL (158,551).

MS-PEOPLESOFT-REST:INVALID_COMPONENT_INTERFACE

The Component Interface name is missing or isn’t valid for a published CIRT service.

MS-PEOPLESOFT-REST:INVALID_COMPONENT_INTERFACE_ID

A Component Interface ID or required path key is missing or isn’t valid.

MS-PEOPLESOFT-REST:INVALID_OPERATION_PARAMETER

An operation parameter is missing or isn’t valid.

MS-PEOPLESOFT-REST:MAPPING_EXCEPTION

The connector can’t map the request or response.

Unauthorize

<ms-peoplesoft-rest:unauthorize>

Deletes all access token information for a given resource owner ID so that no operation can run for that user until authorization is completed again.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

For Configurations

Types

Default Header

Field Type Description Default Value Required

Key

String

Header name.

x

Value

String

Header value.

x

Default Query Parameter

Field Type Description Default Value Required

Key

String

Query parameter name.

x

Value

String

Query parameter value.

x

PeopleSoft Proxy Config

Optional HTTP proxy configuration for PSIGW calls.

Field Type Description Default Value Required

Host

String

The proxy host name or IP address.

x

Port

Number

The proxy port.

x

Username

String

Optional proxy user name for authenticating proxies.

Password

String

Optional proxy password for authenticating proxies.

Non Proxy Hosts

String

Optional comma-separated list of hosts that bypass the proxy.

TLS

Configures TLS to provide secure communications for the Mule app.

Field Type Description Default Value Required

Enabled Protocols

String

Comma-separated list of protocols enabled for this context.

Enabled Cipher Suites

String

Comma-separated list of cipher suites enabled for this context.

Trust Store

Truststore

Configures the TLS truststore.

Key Store

Keystore

Configures the TLS keystore.

Revocation Check

Configures a revocation checking mechanism.

Truststore

Configures the truststore for TLS.

Field Type Description Default Value Required

Path

String

Path to the truststore. Mule resolves the path relative to the current classpath and file system.

Password

String

Password used to protect the truststore.

Type

String

Type of store.

Algorithm

String

Encryption algorithm that the truststore uses.

Insecure

Boolean

If true, Mule stops performing certificate validations. Setting this to true can make connections vulnerable to attacks.

Keystore

Configures the keystore for the TLS protocol. The keystore you generate contains a private key and a public certificate.

Field Type Description Default Value Required

Path

String

Path to the keystore. Mule resolves the path relative to the current classpath and file system.

Type

String

Type of store.

Alias

String

Alias of the key to use when the keystore contains multiple private keys. By default, Mule uses the first key in the file.

Key Password

String

Password used to protect the private key.

Password

String

Password used to protect the keystore.

Algorithm

String

Encryption algorithm that the keystore uses.

Standard Revocation Check

Configures standard revocation checks for TLS certificates.

Field Type Description Default Value Required

Only End Entities

Boolean

Which elements to verify in the certificate chain:

  • true

Verify only the last element in the certificate chain.

  • false

Verify all elements in the certificate chain.

Prefer Crls

Boolean

How to check certificate validity:

  • true

Check the Certification Revocation List (CRL) for certificate validity.

  • false

Use the Online Certificate Status Protocol (OCSP) to check certificate validity.

No Fallback

Boolean

Whether to use the secondary method to check certificate validity:

  • true

Use the method that wasn’t specified in the Prefer Crls field (the secondary method) to check certificate validity.

  • false

Do not use the secondary method to check certificate validity.

Soft Fail

Boolean

What to do if the revocation server can’t be reached or is busy:

  • true

Avoid verification failure.

  • false

Allow the verification to fail.

Custom OCSP Responder

Configures a custom OCSP responder for certification revocation checks.

Field Type Description Default Value Required

Url

String

URL of the OCSP responder.

Cert Alias

String

Alias of the signing certificate for the OCSP response. If specified, the alias must be in the truststore.

CRL File

Specifies the location of the certification revocation list (CRL) file.

Field Type Description Default Value Required

Path

String

Path to the CRL file.

Reconnection

Configures a reconnection strategy for an operation.

Field Type Description Default Value Required

Fails Deployment

Boolean

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Reconnection Strategy

Reconnection strategy to use.

Reconnect

Configures a standard reconnection strategy, which specifies how often to reconnect and how many reconnection attempts the connector source or operation can make.

Field Type Description Default Value Required

Frequency

Number

How often to attempt to reconnect, in milliseconds.

Blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

Count

Number

How many reconnection attempts the Mule app can make.

Reconnect Forever

Configures a forever reconnection strategy by which the connector source or operation attempts to reconnect at a specified frequency for as long as the Mule app runs.

Field Type Description Default Value Required

Frequency

Number

How often to attempt to reconnect, in milliseconds.

Blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

Expiration Policy

Configures an expiration policy strategy.

Field Type Description Default Value Required

Max Idle Time

Number

Configures the maximum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Max Idle Time field.

PeopleSoft Attributes

Message attributes on every CIRT operation’s output. The attributes include the PSIGW call’s HTTP status, reason phrase, and headers.

Field Type Description Default Value Required

Headers

Object

Map of HTTP headers in the message.

Reason Phrase

String

HTTP reason phrase of the response.

Status Code

Number

HTTP status code of the response.

Repeatable In Memory Stream

Configures the in-memory streaming strategy by which the request fails if the data exceeds the MAX buffer size. Always run performance tests to find the optimal buffer size for your specific use case.

Field Type Description Default Value Required

Initial Buffer Size

Number

Initial amount of memory to allocate to the data stream. If the streamed data exceeds this value, the buffer expands by Buffer Size Increment, with an upper limit of Max Buffer Size.

Buffer Size Increment

Number

This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer shouldn’t expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full.

Max Buffer Size

Number

Maximum size of the buffer. If the buffer size exceeds this value, Mule raises a STREAM_MAXIMUM_SIZE_EXCEEDED error. A value of less than or equal to 0 means no limit.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

Unit for the Initial Buffer Size, Buffer Size Increment, and Max Buffer Size fields.

Repeatable File Store Stream

Configures the repeatable file-store streaming strategy by which Mule keeps a portion of the stream content in memory. If the stream content is larger than the configured buffer size, Mule backs up the buffer’s content to disk and then clears the memory.

Field Type Description Default Value Required

In Memory Size

Number

Maximum amount of memory that the stream can use for data. If the amount of memory exceeds this value, Mule buffers the content to disk. To optimize performance:

  • Configure a larger buffer size to avoid the number of times Mule needs to write the buffer on disk. This increases performance, but it also limits the number of concurrent requests your application can process, because it requires additional memory.

  • Configure a smaller buffer size to decrease memory load at the expense of response time.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

Unit for the In Memory Size field.

Error Mapping

Field Type Description Default Value Required

Source

Enumeration, one of:

  • ANY

  • REDELIVERY_EXHAUSTED

  • TRANSFORMATION

  • EXPRESSION

  • SECURITY

  • CLIENT_SECURITY

  • SERVER_SECURITY

  • ROUTING

  • CONNECTIVITY

  • RETRY_EXHAUSTED

  • TIMEOUT

Target

String

x
Back to top