--- schema_version: "1" id: 8512f77ff4630a979c184f7de47a55dbb613460b4e93381f6678eb555ce03bd7 title: Oracle EBS 12.2 Connector 2.3 Reference collection: mulesoft version: current locale: en-us portal_url: https://docs.salesforce.com/mulesoft/current/en-us/oracle-ebs-122-connector/latest/oracle-ebs-122-connector-reference.md canonical_url: https://docs.mulesoft.com/oracle-ebs-122-connector/latest/oracle-ebs-122-connector-reference source_site: docs.mulesoft.com content_type: documentation content_hash: 3943300b4c920d72ea773b63fd147dc4c38bc7c79de4f963c52269f8eaf4411a description: MuleSoft Documentation Site release: "2.3" latest: true --- --- product: Oracle EBS 12.2 Connector version: 2.3 is-latest-version: true --- # Oracle EBS 12.2 Connector 2.3 Reference > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint Connector for Oracle E-Business Suite (EBS) 12.2 provides real-time connectivity to query and update Oracle EBS using REST web services. ## Configurations --- ### Default Configuration Default configuration for Oracle EBS 12.2 operations. #### Parameters

Name	Type	Description	Required
Name	String	Name for this configuration. Connectors reference the configuration with this name.	x
Connection	Plsql	Connection types for this configuration.	x
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 ##### PL/SQL ###### Parameters

Name	Type	Description	Default Value	Required
Host	String	Hostname of the Oracle EBS instance.		x
Port	String	Port where the Oracle HTTP Server listens.		x
SSL enabled	Boolean	Enables SSL to securely communicate with Oracle EBS Web Services.	false
Username	String	Username to access the Oracle EBS REST service.		x
Password	String	Password to access the Oracle EBS REST service.		x
REST Service Locator alias	String	Alias assigned to the web service with internal name `oracle.apps.fnd.rep.ws.service.EbsRestLocator` when deployed.		x
FND Web Sec alias	String	Alias assigned to the PL/SQL web service with internal name `FND_WEB_SEC` when deployed.		x
Responsibility name	String	Oracle EBS application responsibility information. Accepts responsibility_key, such as SYSTEM_ADMINISTRATOR, as its value.
Responsibility application name	String	Responsibility application short name information. Accepts Application Short Name, such as FND, as its value.
Security group name	String	Accepts Security Group Key, such as STANDARD, as its value.
NLS language	String	Sets the language preferences, such as AMERICAN.
Org. ID	String	ID of the operating unit assigned to the specified responsibility. It is the only organization that the user works on.
Proxy Config	Proxy Parameter Group	Proxy connection if needed.
TCP Client Socket Properties	TCP Client Socket Parameter Group	TCP client socket properties for the connection.
TLS Context	TLS	TLS context for secure connectivity.
Reconnection	Reconnection	Configures a reconnection strategy to use when a connector operation fails to connect to an external server.

### JMS Configuration #### Parameters

Name	Type	Description	Default Value	Required
Name	String	Name for this configuration. Connectors reference the configuration with this name.		x
Connection	Jms Jms Url	Connection types for this configuration.		x
Read Receive Timeout	Number	Read timeout, in milliseconds.	30000
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 ##### JMS ###### Parameters

Name	Type	Description	Default Value	Required
Username	String	Username for the JMS connection type.		x
Password	String	Password for the JMS connection type.		x
Host	String	Hostname for the connection type.		x
Port	String	Port of the connection type.	1521
Database SID	String	Database system identifier (SID).		x
Reconnection	Reconnection	Configures a reconnection strategy to use when a connector operation fails to connect to an external server.

##### JMS URL ###### Parameters

Name	Type	Description	Required
Username	String	Username for the JMS URL connection type.	x
Password	String	Password for the JMS URL connection type.	x
URL	String	URL for the connection type.	x
Reconnection	Reconnection	Configures a reconnection strategy to use when a connector operation fails to connect to an external server.

## Associated Operations - [Invoke PL/SQL REST Service](#invokePlSqlRestService) ## Associated Sources - [Business Events Source](#BusinessEventsSource) ## Operations ### Invoke PL/SQL REST Service `` #### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use.		x
Input	Binary		#[payload]
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configures how Mule processes streams. The default is to use repeatable streams.
PL/SQL	String	PL/SQL name.		x
Operation	String	Operation to execute.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.	#[payload]
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

#### Output

Type

Binary

### For Configurations - [Default Configuration](#config) #### Throws - ORACLE-EBS122:UNKNOWN - ORACLE-EBS122:BAD\_REQUEST - ORACLE-EBS122:METADATA\_ERROR - ORACLE-EBS122:RETRY\_EXHAUSTED - ORACLE-EBS122:JMS - ORACLE-EBS122:CONNECTIVITY - ORACLE-EBS122:UNAUTHORIZED - ORACLE-EBS122:INTERNAL\_SERVER\_ERROR - ORACLE-EBS122:REQUEST\_FAILED - ORACLE-EBS122:FORBIDDEN - ORACLE-EBS122:XML\_PARSING ## Sources ### Business Events Source `` > [!NOTE] The **Business Events Source** does not filter the incoming events. The user must filter > the events after they arrive at the source. > The **Consume** operation in Oracle’s Advanced Queuing API library, which the connector uses to > connect with EBS, may override the `AQ$_WF_BPEL_QTAB_S` field in the subscriber table. The > **Business Events Source** calls the **Consume** operation internally. #### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use.		x
Durable Subscription	Boolean	Set this value to `true` to create a durable subscription for the topic.	false
Subscription Name	String	Name of the durable subscription that already exists in the EBS instance.	`muleBusinessEvents`
Filter message criteria	String	Filters messages based on SQL like criteria.
Primary Node Only	Boolean	Determines whether to execute this source on only the primary node when running Mule instances in a cluster.
Redelivery Policy	Redelivery Policy	Configures the redelivery policy for executing requests that generate errors. You can add a redelivery policy to any source in a flow.
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

#### Output

Type	Event
Attributes Type	Any

### For Configurations - [JMS Configuration](#jms-config) ## Types ### Proxy Parameter Group

Field	Type	Description
Host	String	Host for the type.
Port	Number	Port of the type.
Username	String	Username for the type.
Password	String	Password for the type.

### TCP Client Socket Parameter Group

Field	Type	Default Value
Send Buffer Size	Number
Receive Buffer Size	Number
Client Timeout	Number
Send Tcp No Delay	Boolean	true
Linger	Number
Keep Alive	Boolean	false
Connection Timeout	Number	30000

### TLS Configures TLS to provide secure communications for the Mule app.

Field	Type	Description
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	Standard Revocation Check Custom OCSP Responder CRL File	Configures how to validate certificates.

### Truststore Configures the truststore for TLS.

Field	Type	Description
Path	String	Path to the truststore. Mule resolves the path relative to the current classpath and file system, if possible.
Password	String	Password used to protect the truststore.
Type	String	Type of truststore.
Algorithm	String	Encryption algorithm that the truststore uses.
Insecure	Boolean	If `true`, Mule stops performing certificate validations. Settig 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
Path	String	Path to the keystore. Mule resolves the path relative to the current classpath and file system, if possible.
Type	String	Type of keystore used.
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
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 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	What to do if, when an app is deployed, a connectivity test does not pass after exhausting the associated reconnection strategy: `true` Allow the deployment to fail. `false` Ignore the results of the connectivity test.
Reconnection Strategy	Reconnect Reconnect Forever	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.
Count	Number	How many reconnection attempts the Mule app can make.

### Reconnect Forever Configures a forever reconnection strategy by which the connector operation 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 the Mule app attempts to reconnect to the remote service or API, in milliseconds.

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

Field	Type	Description	Default Value	Required
Max Idle Time	Number	A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it is considered eligible for expiration.
Time Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Time unit for the Max Idle Time field.

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

Field	Type	Description
Initial Buffer Size	Number	Initial amount of memory to allocate to the memory stream. If the stream data exceeds this value, the buffer expands by Buffer Size Increment, with an upper limit of Max In Memory Size value.
Buffer Size Increment	Number	Amount by which the buffer size expands if it exceeds its initial size. Setting a value of `0` or lower specifies that the buffer can’t expand.
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 Buffer Unit 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.

### Event

Field	Type	Description
Correlation Id	String	Correlation ID for a message. The value set for the correlation ID is used as the item key.
Error Message	String	Determines if errors occur when processing the event.
Error Stack	String	Locates the source of an error.
Error Subscription	Binary	Subscription that was executed when an error is thrown.
Event Data	String	Data that describes what occurs in the event.
Event Key	String	Unique identifier for the instance of the event.
Event Name	String	Name of the event.
From Agent	Agent	Agent from which the event is sent. It is initially set to `null` for locally raised events.
Parameter List	Object	List of parameters and their values.
Priority	Number	Describes the priority of the message recipient dequeuing the message. `1` corresponds to a high priority while `99` corresponds to a low priority.
Receive Date	DateTime	Shows the date and time of when the message is dequeued by an agent listener.
Send Date	DateTime	Represents the date and time when the message can be dequeued.
To Agent	Agent	Agent to which the event is sent.

### Agent

Field	Type	Description	Default Value	Required
Name	String	Name of the agent.
System	String	System where the agent is located.

### Redelivery Policy Configures the redelivery policy for executing requests that generate errors. You can add a redelivery policy to any source in a flow.

Field	Type	Description
Max Redelivery Count	Number	Maximum number of times that a delivered request can be processed unsuccessfully before returning a REDELIVERY_EXHAUSTED error.
Use Secure Hash	Boolean	If `true`, Mule uses a secure hash algorithm to identify a redelivered message.
Message Digest Algorithm	String	Secure hashing algorithm to use if the Use Secure Hash field is `true`. If the payload of the message is a Java object, Mule ignores this value and returns the value that the payload’s `hashCode()` returned.
Id Expression	String	One or more expressions that determine when a message was redelivered. This property can be set only if the Use Secure Hash field is `false`.
Object Store	Object Store	Configures the object store that stores the redelivery counter for each message.