---
schema_version: "1"
id: 067723707e9d312ddd5c182bf6276e00ac73ac87e7c8f4e4d203f6b802c0ba64
title: Oracle PeopleSoft Connector 3.1 Reference
collection: mulesoft
version: current
locale: en-us
portal_url: https://docs.salesforce.com/mulesoft/current/en-us/peoplesoft-connector/latest/peoplesoft-connector-reference.md
canonical_url: https://docs.mulesoft.com/peoplesoft-connector/latest/peoplesoft-connector-reference
source_site: docs.mulesoft.com
content_type: documentation
content_hash: 03bc48956aa6709758dc4c67d22bc2e14fa13c901e8e9e704b7c1b5c90a921be
description: MuleSoft Documentation Site
release: "3.1"
latest: true
---
---
product: Oracle PeopleSoft Connector
version: 3.1
is-latest-version: true
---

# Oracle PeopleSoft Connector 3.1 Reference

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Anypoint Connector for Oracle PeopleSoft (PeopleSoft Connector) provides real-time connectivity to
query and update all PeopleSoft modules, using a common integration interface known as the Component
Interface.

Release Notes:
[Oracle PeopleSoft Connector Release Notes](https://docs.mulesoft.com/release-notes/connector/peoplesoft-connector-release-notes-mule-4)

## Default Configuration

<table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p>Name</p></div></div></td><td><div><div><p>The name for this configuration. Connectors reference the configuration with this name.</p></div><div><p>Type: String<br>Default: None<br>Required: Yes</p></div></div></td></tr><tr><td><div><div><p>Connection</p></div></div></td><td><div><div><p>The connection types that can be provided to this configuration.</p></div><div><p>Type: Connection<br>Default: None<br>Required: Yes</p></div></div></td></tr><tr><td><div><div><p>Enable Edit History Items</p></div></div></td><td><div><div><p>Type: Boolean<br>Default: false<br>Required: No</p></div></div></td></tr><tr><td><div><div><p>Enable Get History Items</p></div></div></td><td><div><div><p>Type: Boolean<br>Default: false<br>Required: No</p></div></div></td></tr><tr><td><div><div><p>Enable Interactive Mode</p></div></div></td><td><div><div><p>Type: Boolean<br>Default: false<br>Required: No</p></div></div></td></tr><tr><td><div><div><p>Date format for the conversion</p></div></div></td><td><div><div><p>Format the connector to convert DateTime values to the PeopleSoft format. By default, the connector uses <code>MM/dd/yyyy K:mm:ssa</code> where <code>MM</code> is the month, <code>dd</code> is the day, <code>yyyy</code> is the calendar year, <code>K</code> is the hour, <code>mm</code> is minutes, <code>ss</code> is seconds, and <code>a</code> is AM or PM . This format depends on the Peoplesoft instance.</p></div><div><p>Type: String<br>Default: <code>MM/dd/yyyy K:mm:ssa</code><br>Required: No</p></div></div></td></tr><tr><td><div><div><p>Expiration Policy</p></div></div></td><td><div><div><p>Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. The runtime purges the instances as needed.</p></div><div><p>Type: ExpirationPolicy<br>Default: false<br>Required: No</p></div></div></td></tr></tbody></table>

## Connection Type

<table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p>Application Server</p></div></div></td><td><div><div><p>Type: String<br>Default: None<br>Required: Yes</p></div></div></td></tr><tr><td><div><div><p>Username</p></div></div></td><td><div><div><p>Type: String<br>Default: None<br>Required: Yes</p></div></div></td></tr><tr><td><div><div><p>Password</p></div></div></td><td><div><div><p>Type: String<br>Default: None<br>Required: No</p></div></div></td></tr><tr><td><div><div><p>Domain Connection Password</p></div></div></td><td><div><div><p>Type: String<br>Default: None<br>Required: No</p></div></div></td></tr><tr><td><div><div><p>Component Interface List</p></div></div></td><td><div><div><p>Type: Array of String<br>Default: None<br>Required: Yes</p></div></div></td></tr><tr><td><div><div><p>Reconnection</p></div></div></td><td><div><div><p>When the app 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.</p></div><div><p>Type: Reconnection<br>Default: None<br>Required: No</p></div></div></td></tr></tbody></table>

## Operations

- [Invoke Operation](#invokeoperation)

- [Update User Profile ID Type](#updateuserprofile)

## Invoke Operation

`<peoplesoft:invoke-operation>`

Invokes a PeopleSoft operation depending on the type selected. DataSense discovers the structure of
the entities in the system during design time and run time and uses the structure to perform the
operation for the type selected. This varies for Find, Get, Create, and so on.

<table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p>Configuration</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div><div><p>Type: String<br>Default: None<br>Required: Yes</p></div></div></td></tr><tr><td><div><div><p>Content</p></div></div></td><td><div><div><p>A Map with the parameters to be used in the operation.</p></div><div><p>Type: Binary<br>Default: #[payload]<br>Required: No</p></div></div></td></tr><tr><td><div><div><p>Streaming Strategy</p></div></div></td><td><div><div><p>Configure if repeatable streams should be used and their behavior.</p></div><div><p>Type: One of:</p></div><div><ul><li><p><a href="#repeatable-in-memory-stream">Repeatable In-Memory Stream</a></p></li><li><p><a href="#repeatable-file-store-stream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div><div><p>Default: #[payload]<br>Required: No</p></div></div></td></tr><tr><td><div><div><p>Component Name</p></div></div></td><td><div><div><p>Type: String<br>Default: None<br>Required: Yes</p></div></div></td></tr><tr><td><div><div><p>Operation</p></div></div></td><td><div><div><p>Type: String<br>Default: None<br>Required: Yes</p></div></div></td></tr><tr><td><div><div><p>Target Variable</p></div></div></td><td><div><div><p>The name of a variable in which the operation’s output is placed.</p></div><div><p>Type: String<br>Default: None<br>Required: No</p></div></div></td></tr><tr><td><div><div><p>Target Value</p></div></div></td><td><div><div><p>An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.</p></div><div><p>Type: String<br>Default: #[payload]<br>Required: No</p></div></div></td></tr><tr><td><div><div><p>Reconnection Strategy</p></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div><div><p>Type: One of:</p></div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div><div><p>Default: None<br>Required: No</p></div></div></td></tr></tbody></table>

### Invoke Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><div><div><p>Binary</p></div></div></td></tr></tbody></table>

#### For Configurations

- Default Configuration

#### Throws

- PEOPLESOFT:CONNECTIVITY

- PEOPLESOFT:INVALID\_COMPONENT\_INTERFACE

- PEOPLESOFT:INVALID\_COMPONENT\_INTERFACE\_ID

- PEOPLESOFT:INVALID\_OPERATION\_PARAMETER

- PEOPLESOFT:MAPPING\_EXCEPTION

- PEOPLESOFT:NO\_METADATA

- PEOPLESOFT:REQUEST\_FAILED

- PEOPLESOFT:RETRY\_EXHAUSTED

- PEOPLESOFT:STRING\_TO\_DATE\_PARSE\_ERROR

- PEOPLESOFT:UNKNOWN

## Update User Profile ID Type

`<peoplesoft:update-user-profile-id-type>`

Changes the ID type of an USER\_PROFILE record and assigns it an attribute.

<table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p>Configuration</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div><div><p>Type: String<br>Default: None<br>Required: Yes</p></div></div></td></tr><tr><td><div><div><p>User Id</p></div></div></td><td><div><div><p>The UserID of the record to update.</p></div><div><p>Type: String<br>Default: None<br>Required: Yes</p></div></div></td></tr><tr><td><div><div><p>Id Types</p></div></div></td><td><div><div><p>The list of new ID Types to assign.</p></div><div><p>Type: Array of IDType Default: None<br>Required: Yes</p></div></div></td></tr></tbody></table>

### For Configurations

- Default Configuration

### Throws

- PEOPLESOFT:CONNECTIVITY

- PEOPLESOFT:INVALID\_COMPONENT\_INTERFACE

- PEOPLESOFT:INVALID\_COMPONENT\_INTERFACE\_ID

- PEOPLESOFT:INVALID\_OPERATION\_PARAMETER

- PEOPLESOFT:MAPPING\_EXCEPTION

- PEOPLESOFT:NO\_METADATA

- PEOPLESOFT:REQUEST\_FAILED

- PEOPLESOFT:RETRY\_EXHAUSTED

- PEOPLESOFT:STRING\_TO\_DATE\_PARSE\_ERROR

- PEOPLESOFT:UNKNOWN

## Types

### Reconnection

<table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p>Fails Deployment</p></div></div></td><td><div><div><p>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.</p></div><div><p>Type: Boolean<br>Default: None<br>Required: No</p></div></div></td></tr><tr><td><div><div><p>Reconnection Strategy</p></div></div></td><td><div><div><p>The reconnection strategy to use.</p></div><div><p>Type: One of:</p></div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div><div><p>Default: None<br>Required: No</p></div></div></td></tr></tbody></table>

### Reconnect

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Frequency</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How often to reconnect (in milliseconds)</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Count</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The number of reconnection attempts to make</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>blocking</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If false, the reconnection strategy runs in a separate, non-blocking thread</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr></tbody></table>

### Reconnect Forever

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Frequency</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How often in milliseconds to reconnect</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>blocking</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If false, the reconnection strategy runs in a separate, non-blocking thread</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr></tbody></table>

### Expiration Policy

<table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p>Max Idle Time</p></div></div></td><td><div><div><p>A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration.</p></div><div><p>Type: Number<br>Default: None<br>Required: No</p></div></div></td></tr><tr><td><div><div><p>Time Unit</p></div></div></td><td><div><div><p>A time unit that qualifies the maxIdleTime attribute.</p></div><div><p>Possible values:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div><div><p>Type: Enumeration<br>Default: None<br>Required: No</p></div></div></td></tr></tbody></table>

### Repeatable In-Memory Stream

<table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p>Initial Buffer Size</p></div></div></td><td><div><div><p>This is the amount of memory to allocate to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.</p></div><div><p>Type: Number<br>Default: None<br>Required: No</p></div></div></td></tr><tr><td><div><div><p>Buffer Size Increment</p></div></div></td><td><div><div><p>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 should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full.</p></div><div><p>Type: Number<br>Default: None<br>Required: No</p></div></div></td></tr><tr><td><div><div><p>Max Buffer Size</p></div></div></td><td><div><div><p>This is the maximum amount of memory to use. If more than that is used, then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower or equal to zero means no limit.</p></div><div><p>Type: Number<br>Default: None<br>Required: No</p></div></div></td></tr><tr><td><div><div><p>Buffer Unit</p></div></div></td><td><div><div><p>The unit in which maxInMemorySize is expressed.</p></div><div><p>Possible values:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li><li><p>MB</p></li><li><p>GB</p></li></ul></div><div><p>Type: Enumeration<br>Default: None<br>Required: No</p></div></div></td></tr></tbody></table>

### Repeatable File Store Stream

<table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p>Max In Memory Size</p></div></div></td><td><div><div><p>Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed, it starts to buffer the content on disk.</p></div><div><p>Type: Number<br>Default: None<br>Required: No</p></div></div></td></tr><tr><td><div><div><p>Buffer Unit</p></div></div></td><td><div><div><p>The unit in which maxInMemorySize is expressed.</p></div><div><p>Possible values:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li><li><p>MB</p></li><li><p>GB</p></li></ul></div><div><p>Type: Enumeration<br>Default: None<br>Required: No</p></div></div></td></tr></tbody></table>

## See Also

[Salesforce Help](https://help.salesforce.com)