# mulesoft Oracle EBS 12.2 Connector - Full Documentation --- product: Oracle EBS 12.2 Connector version: 2.3 is-latest-version: true --- # Oracle E-Business Suite 12.2 Connector 2.3 > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Oracle EBS 12.2 Connector v2.3 Anypoint Connector for Oracle E-Business Suite 12.2 (EBS 12.2 Connector) facilitates connections between Mule runtime engine (Mule) integration and Oracle E-Business Suite 12.2 applications. ## About the Connector Architecture Oracle EBS offers different technologies or products to address various types of integrations. The most widely used integrations for enterprise applications are: - Data-centric integration - Integration through Web Services using Oracle E-Business Suite Integrated SOA Gateway (ISG) The following illustration shows the integration architecture of the MuleSoft Oracle EBS connector: ![Oracle EBS 12.2 Connector Architecture](/mulesoft/current/en-us/oracle-ebs-122-connector/latest/_images/oracle-ebs122-architecture.png) ## Before You Begin To use this connector, you must be familiar with: - Oracle E-Business Suite - Web services and integration scenarios for your Oracle EBS version - Anypoint Connectors - Anypoint Studio - Mule concepts - Elements in a Mule flow and global elements You must also have: - Oracle EBS login credentials to test your connection to your target resource - Anypoint Studio - Web service configuration in Oracle EBS Configuring Oracle EBS 12.2 Connector requires configuring REST web services in Oracle EBS and exposing them via the Integration Repository. For more information about how to configure Oracle EBS, refer to [To Use the Connector](#to-use-the-connector). - FND\_WEB\_SEC PL/SQL Service The connector requires Oracle EBS to have the FND\_WEB\_SEC PL/SQL service deployed. - REST Service Locator The connector requires Oracle EBS to have the REST Service Locator deployed as a REST service. - WADL names in lower case WADLs corresponding to deployed PL/SQLs must have their internal names in lower case as an alias. For example, to deploy `PLSQL Interface : Absence Attendance Type`, which has `HR_ABSENCE_TYPE_API` as the internal name, its service alias must be `hr_absence_type_api`. For software requirements and compatibility information, see the Connector Release Notes. ## POM File Information ```xml com.mulesoft.connectors mule-oracle-ebs-122-connector x.x.x mule-plugin ``` Replace `x.x.x` with the version that corresponds to the connector you are using. To obtain the most up-to-date `pom.xml` file information, access the connector in [Anypoint Exchange](https://www.mulesoft.com/exchange/) and click **Dependency Snippets**. ## Add the Connector to a Studio Project Anypoint Studio provides two ways to add the connector to your Studio project: - From the Exchange button in the Studio taskbar - From the Mule Palette view ### Add the Connector Using Exchange 1. In Studio, create a Mule project. 2. Click the Exchange icon **(X)** in the upper-left of the Studio task bar. 3. In Exchange, click **Login** and supply your Anypoint Platform username and password. 4. In Exchange, search for "ebs". 5. Select the connector and click **Add to project**. 6. Follow the prompts to install the connector. ### Add the Connector in Studio 1. In Studio, create a Mule project. 2. In the Mule Palette view, click **(X) Search in Exchange**. 3. In **Add Modules to Project**, type "ebs" in the search field. 4. Click this connector’s name in **Available modules**. 5. Click **Add**. 6. Click **Finish**. ## To Use the Connector 1. Deploy the REST Service location so that you can later expose your PL/SQL services for the connector to consume. See the Oracle Developer’s Guide Tutorial link in the See Also section. The following steps describe the procedure to deploy the PL/SQL Adjustment API as a REST service. The same guide applies to any PL/SQL. 2. Log in to the Oracle E-Business Suite as a user who has the Integration Administrator role. 3. Select the Integrated SOA Gateway responsibility and the Integration Repository link from the navigation menu. 4. In the Integration Repository tab, click **Search** to access the main Search page. 5. Click **Show More Search Options** to display more search fields. 6. Enter the following key search values as the search criteria: - Category: `Interface Subtype` - Category Value: `PL/SQL` - Internal Name: `FA_ADJUSTMENT_PUB` ![Deploy PL/SQL Search page](/mulesoft/current/en-us/oracle-ebs-122-connector/latest/_images/oracle-ebs122-deploy-plsql-1.png) 7. Click **Go** to execute the search. 8. Click the **Adjustments API** link to see the interface details. ![Deploy PL/SQL Adjustment API page](/mulesoft/current/en-us/oracle-ebs-122-connector/latest/_images/oracle-ebs122-deploy-plsql-2.png) 9. Click the REST Service Locator interface name link to open the interface details page. 10. In the REST Web Service tab, enter the following information: ![Deploy PL/SQL Adjustment API configuration](/mulesoft/current/en-us/oracle-ebs-122-connector/latest/_images/oracle-ebs122-deploy-plsql-3.png) **Important:** The alias of the deployed Web Service MUST be: 1. The internal name. 2. In lowercase. The alias information can be found under the Service Alias label. In this example, it is fa\_adjustment\_pub. 11. Click **Deploy** to deploy the service to an Oracle E-Business Suite WebLogic environment. After the REST service successfully deploys, `Deployed` appears in the REST Service Status field along with the View WADL link. 12. Click the **View WADL** link to view the deployed service WADL description. ![Deploy PL/SQL Adjustment API deployed](/mulesoft/current/en-us/oracle-ebs-122-connector/latest/_images/oracle-ebs122-deploy-plsql-4.png) ## To Configure in Studio 1. Drag a connector operation to the Anypoint Studio canvas. 2. Configure the Global element for the connector. ![Global elements properties window](/mulesoft/current/en-us/oracle-ebs-122-connector/latest/_images/oracle-ebs122-config-studio11.png)
FieldDescription

Host

Host of the Oracle EBS instance

Port

Port of the Oracle EBS Web Services

SSL enabled

If checked, the connector makes Web Services calls using HTTPS instead of HTTP

Username

Username to log in to Oracle EBS Web Services

Password

Password for the username

Rest Service Locator alias

Name assigned to the Web Service with the internal name oracle.apps.fnd.rep.ws.service.EbsRestLocator when deployed

FND Web Sec alias

Name assigned to the PL/SQL Web Service with the internal name FND_WEB_SEC when deployed

Responsibility name

Oracle EBS responsibility name that is needed to execute the operation. This field accepts responsibility_key.

Responsibility application name

Application short name that is needed to execute the operation

Security group name

(Optional) Security group key of the Oracle EBS instance (STANDARD by default)

NLS language

(Optional) NLS language of the Oracle EBS instance (AMERICAN by default)

Org. ID

(Optional) Organization ID of the Oracle EBS instance

## Log Requests and Responses To log requests and responses when using the connector, configure a logger by adding this line to the `Loggers` element of the `log4j2.xml` configuration file for the Mule app: ```xml ``` The following example shows the `Loggers` element with the `AsyncLogger` line added: ```xml ``` You can view the app log in the following ways: - If you’re running the app from the Anypoint Platform, the output is visible in the Anypoint Studio console window. - If you’re running the app using Mule from the command line: - The app log is visible in your OS console. - Unless the log file path was customized in the app’s log file (`log4j2.xml`), you can also view the app log in this default location: `MULE_HOME/logs/.log` For more information about the app log, see [Configuring Logging](https://docs.mulesoft.com/mule-runtime/latest/logging-in-mule). ## Use Case: Create an Oracle EBS 12.2 Global Element Follow the steps below to create an Oracle EBS 12.2 global element for Web Services and PL/SQL invocation: ![Studio flow with Listener, Transform Message, and Invoke PL/SQL REST Service](/mulesoft/current/en-us/oracle-ebs-122-connector/latest/_images/oracle-ebs122-flow.png) 1. Create a new Mule Project in Studio and select an HTTP Listener as a source in the new flow. 2. Add a new HTTP Listener global element configuration. 1. Specify the **Host** and **Port** parameters with the following values:
ParameterValue

Host

0.0.0.0

Port

8081

2. Click **Save**. 3. Assign the new global configuration to your HTTP Listener. 4. Specify the HTTP Listener path as the `/start` value. 5. Drag a **Transform Message** element and add it the following code: ```dataweave %dw 2.0 output application/xml ns ns0 http://xmlns.oracle.com/apps/per/rest/hr_location_api/create_location/ --- { ns0#InputParameters: { ns0#P_VALIDATE: 0, ns0#P_EFFECTIVE_DATE: now, ns0#P_LOCATION_CODE: "HR- MuleSoft Office", ns0#P_DESCRIPTION: "Description Office" } } ``` 6. Drag a new Oracle E-Business Suite 12.2 component into the flow. 7. In the **General** tab, configure the Oracle E-Business Suite 12.2 connector global element with its environment values. 8. In the properties editor of Oracle E-Business Suite 12.2 connector, set **PL/SQL** to `hr_location_api` and **Operation** to `CREATE_LOCATION`: ![Oracle Create Location operation properties window](/mulesoft/current/en-us/oracle-ebs-122-connector/latest/_images/oracle-ebs122-operation1.png) 9. Copy the following content under the **Message > Body** section: #\[payload\] 10. Save and run the project as a Mule application. 11. Navigate to `http://127.0.0.1:8081/start` to test the application. ## Use Case: XML ```xml ``` ## See Also - [Oracle EBS 12.2 Connector Release Notes](https://docs.mulesoft.com/release-notes/connector/oracle-ebs-122-connector-release-notes-mule-4) - [Oracle EBS 12.2 Connector](https://www.mulesoft.com/exchange/com.mulesoft.connectors/mule-oracle-ebs-122-connector/) - Oracle’s Developer’s Guide tutorial in the [Deploying a REST Service](https://docs.oracle.com/cd/E26401_01/doc.122/e20927/T511473T634173.htm) section - [Oracle E-Business Suite Documentation Web Library](https://docs.oracle.com/cd/E26401_01/index.htm) - [Salesforce Help](https://help.salesforce.com) --- 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
NameTypeDescriptionDefault ValueRequired

Name

String

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

x

Connection

Connection types for this configuration.

x

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
NameTypeDescriptionDefault ValueRequired

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 connection if needed.

TCP Client Socket Properties

TCP client socket properties for the connection.

TLS Context

TLS context for secure connectivity.

Reconnection

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

### JMS Configuration #### Parameters
NameTypeDescriptionDefault ValueRequired

Name

String

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

x

Connection

Connection types for this configuration.

x

Read Receive Timeout

Number

Read timeout, in milliseconds.

30000

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
NameTypeDescriptionDefault ValueRequired

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

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

##### JMS URL ###### Parameters
NameTypeDescriptionDefault ValueRequired

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

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
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Input

Binary

#[payload]

Streaming Strategy

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

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
NameTypeDescriptionDefault ValueRequired

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

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

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Event

Attributes Type

Any

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

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
FieldTypeDescriptionDefault ValueRequired

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.
FieldTypeDescriptionDefault ValueRequired

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

Configures the TLS truststore.

Key Store

Configures the TLS keystore.

Revocation Check

Configures how to validate certificates.

### Truststore Configures the truststore for TLS.
FieldTypeDescriptionDefault ValueRequired

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.
FieldTypeDescriptionDefault ValueRequired

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.
FieldTypeDescriptionDefault ValueRequired

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.
FieldTypeDescriptionDefault ValueRequired

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.
FieldTypeDescriptionDefault ValueRequired

Path

String

Path to the CRL file.

### Reconnection Configures a reconnection strategy for an operation.
FieldTypeDescriptionDefault ValueRequired

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

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.
FieldTypeDescriptionDefault ValueRequired

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.
FieldTypeDescriptionDefault ValueRequired

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.
FieldTypeDescriptionDefault ValueRequired

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.
FieldTypeDescriptionDefault ValueRequired

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.
FieldTypeDescriptionDefault ValueRequired

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
FieldTypeDescriptionDefault ValueRequired

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 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 to which the event is sent.

### Agent
FieldTypeDescriptionDefault ValueRequired

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.
FieldTypeDescriptionDefault ValueRequired

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.