Create SOAP Service in OIC

Share

Introduction

Creating a SOAP Service in Oracle Integration Cloud (OIC) is a common requirement when integrating enterprise applications in the Oracle Fusion ecosystem. Even though REST APIs dominate modern integrations, SOAP-based services remain widely used in enterprise systems such as Oracle Fusion Applications, legacy ERP systems, payroll platforms, and third-party HR solutions.

In many real implementation projects, consultants must expose integrations as SOAP services so that external systems can securely invoke business logic within OIC. For example, a payroll vendor might send employee payroll data through a SOAP request, or an external HR system might invoke a service to create employee records in Oracle Fusion.

This guide explains how to create a SOAP Service in OIC Gen 3, including architecture, prerequisites, step-by-step implementation, testing, and best practices used by integration consultants in production environments.

By the end of this article, you will understand how SOAP services are designed and exposed from OIC and how they are consumed by external enterprise systems.


What is a SOAP Service in Oracle Integration Cloud?

A SOAP Service in OIC is an integration endpoint exposed through a SOAP Web Service interface that allows external systems to invoke integration logic using XML-based messages.

SOAP stands for Simple Object Access Protocol, which is a protocol that uses XML messaging over HTTP or HTTPS to exchange structured information between systems.

In Oracle Integration Cloud, SOAP services are typically created using the SOAP Adapter as a trigger connection in an integration flow.

Key Characteristics of SOAP Services in OIC

FeatureDescription
XML MessagingSOAP messages use structured XML payloads
WSDL BasedSOAP services are defined using WSDL contracts
Strong TypingData structure is strictly defined
Enterprise CompatibilityWorks with legacy enterprise applications
SecuritySupports WS-Security standards

SOAP services are frequently used in integrations involving:

  • Oracle Fusion Applications

  • Legacy ERP systems

  • Banking systems

  • HR or payroll platforms

  • Middleware orchestration layers


Real-World Integration Use Cases

In real projects, SOAP services created in OIC often support complex enterprise workflows. Below are three typical implementation scenarios.

1. Employee Creation Integration

A global organization uses an external HR system. When a new employee is hired, the HR system invokes a SOAP service in OIC to create the worker in Oracle Fusion HCM.

Flow:

External HR System → SOAP Service in OIC → HCM REST API

This allows centralized integration logic and validation within OIC.


2. Payroll Data Integration

Many companies outsource payroll processing to third-party vendors.

Flow:

Payroll Vendor → SOAP Request → OIC Integration → Fusion Payroll

The SOAP service receives payroll information such as:

  • Employee ID

  • Salary

  • Tax deductions

  • Benefits

OIC validates the payload and sends it to Fusion using REST APIs.


3. Finance Invoice Import

An external procurement system may send invoice data through a SOAP service.

Integration flow:

External Procurement System → SOAP Service → OIC Mapping → Fusion Financials Invoice API

This allows seamless automated invoice processing.


Architecture and Technical Flow

Understanding the architecture of SOAP services in OIC helps consultants design scalable integrations.

Typical Architecture

External Application

SOAP Web Service Request

OIC SOAP Trigger Integration

Data Transformation

Fusion REST APIs / DB / SaaS Applications

SOAP Response to Caller

Technical Components

ComponentRole
SOAP AdapterExposes SOAP endpoint
Integration FlowProcesses request
MapperTransforms XML data
ConnectionCommunicates with target system
Fault HandlerHandles errors

The SOAP endpoint created in OIC exposes a WSDL URL that client applications use to invoke the service.


Prerequisites

Before creating a SOAP service in Oracle Integration Cloud, ensure the following prerequisites are met.

Environment Requirements

  • OIC Gen 3 instance

  • Integration Developer role

  • Access to Integration Designer

Technical Requirements

RequirementDescription
SOAP AdapterMust be configured
WSDLRequired for service contract
Target APIREST or SOAP endpoint
Security ConfigurationBasic Auth or OAuth

Access Roles

Users typically need:

  • Service Developer

  • Integration Developer

  • Integration Administrator


Step-by-Step: Create SOAP Service in OIC

This section explains the complete implementation process used by integration consultants.


Step 1 – Create SOAP Adapter Connection

First, create a SOAP connection that will expose the service.

Navigation Path

Navigator → Integrations → Connections → Create

Configuration

Select Adapter:

SOAP Adapter

Enter connection details.

FieldExample Value
NameEmployee_SOAP_Service
RoleTrigger
DescriptionSOAP service for employee creation

Security

Configure security depending on requirements.

Common options:

  • Basic Authentication

  • OAuth

  • No Security (testing environments)

Click Test to validate the connection.

Save the connection.


Step 2 – Create Integration

Next, create an integration flow that will expose the SOAP service.

Navigation

Navigator → Integrations → Integrations → Create

Select:

App Driven Orchestration

This type of integration starts when an external application invokes the SOAP endpoint.

Integration Details

FieldExample
NameEmployeeCreationSOAP
PatternApp Driven Orchestration
Version01.00.0000

Click Create.


Step 3 – Configure SOAP Trigger

Drag the SOAP Adapter into the trigger area.

Configure the following:

Service Configuration

FieldExample
Service NameEmployeeService
Operation NameCreateEmployee
Request TypeStructured

Define Request Payload

Example request structure:

 
EmployeeRequest
EmployeeName
Email
Department
Salary
 

This XML schema defines the structure of incoming SOAP messages.

OIC automatically generates the WSDL file based on this definition.


Step 4 – Configure Target System Connection

Now configure the system where data will be sent.

Example target:

Oracle Fusion HCM REST API

Create a REST adapter connection.

Then drag it into the integration flow.

Configure:

  • REST endpoint

  • HTTP method

  • Authentication

Example endpoint:

 
POST /hcmRestApi/resources/latest/workers
 

Step 5 – Data Mapping

Data mapping transforms the SOAP request payload into the format required by the target system.

Open Mapper.

Example mapping:

SOAP FieldTarget Field
EmployeeNameDisplayName
EmailEmailAddress
DepartmentDepartmentName
SalarySalaryAmount

Mapping ensures proper transformation between SOAP XML and REST JSON structures.


Step 6 – Configure Response

SOAP services must send a response back to the caller.

Define response structure:

Example:

 
EmployeeResponse
EmployeeID
Status
Message
 

Populate response fields after successful execution.

Example:

FieldValue
EmployeeIDWorkerNumber
StatusSUCCESS
MessageEmployee created successfully

Step 7 – Activate Integration

After configuration:

Click Validate

Resolve any errors.

Click Activate.

OIC now generates a SOAP Endpoint URL and WSDL.

Example:

 
https://oic-instance/integration/soap/EmployeeService
 

External applications will use this WSDL to invoke the service.


Testing the SOAP Service

Testing is essential before deploying integrations in production.

Method 1 – Use SOAP UI

Testing tools:

  • SOAP UI

  • Postman

  • Integration test client

Import the WSDL file.

Create a request.

Example SOAP request:

 
<soapenv:Envelope>
<soapenv:Body>
<EmployeeRequest>
<EmployeeName>John Smith</EmployeeName>
<Email>john.smith@test.com</Email>
<Department>Finance</Department>
<Salary>80000</Salary>
</EmployeeRequest>
</soapenv:Body>
</soapenv:Envelope>
 

Expected Response

 
<EmployeeResponse>
<EmployeeID>100123</EmployeeID>
<Status>SUCCESS</Status>
<Message>Employee created successfully</Message>
</EmployeeResponse>
 

Common Errors and Troubleshooting

During SOAP integration implementations, several issues commonly occur.

1. Invalid WSDL

Cause:

Schema mismatch between request payload and WSDL.

Solution:

Regenerate schema and redeploy integration.


2. Authentication Failure

Cause:

Incorrect credentials or security configuration.

Solution:

Verify SOAP adapter security configuration.


3. Mapping Errors

Cause:

Incorrect XML structure.

Solution:

Validate mapping between source and target fields.


4. Payload Validation Errors

Cause:

Missing mandatory fields.

Solution:

Add validation logic before sending payload.


Best Practices for SOAP Integrations in OIC

Experienced consultants follow several best practices when exposing SOAP services.

Use Strong Data Validation

Always validate payload fields before processing requests.

Example validations:

  • Required fields

  • Data format checks

  • Business rule validation


Implement Fault Handling

Use Global Fault Handler to manage errors.

Return meaningful SOAP fault messages.

Example:

 
Invalid employee data
Department not found
 

Enable Tracking

Enable business identifiers to track transactions.

Example tracking field:

Employee ID


Use Versioning

Always version integrations.

Example:

 
EmployeeService_v1
EmployeeService_v2
 

This prevents breaking existing integrations.


Secure SOAP Endpoints

Use secure authentication methods:

  • OAuth

  • WS Security

  • API Gateway

Never expose public SOAP services without authentication.


Summary

Creating a SOAP Service in Oracle Integration Cloud is an essential skill for integration consultants working with enterprise systems. Although REST APIs are widely used today, SOAP services remain critical for integrating with legacy platforms and enterprise applications.

In this guide, we explored:

  • The concept of SOAP services in OIC

  • Real-world enterprise integration scenarios

  • Architecture and technical flow

  • Step-by-step implementation in OIC Gen 3

  • Testing using SOAP UI

  • Troubleshooting common integration issues

  • Best practices used in real projects

Understanding how to expose SOAP services through OIC allows organizations to integrate systems efficiently while maintaining standardized communication protocols.

For deeper technical reference and updated documentation, consult the official Oracle documentation portal:

https://docs.oracle.com/en/cloud/saas/index.html


Frequently Asked Questions (FAQ)

1. When should we use SOAP services in OIC instead of REST?

SOAP services are preferred when integrating with legacy enterprise applications or systems that require strict XML-based communication using WSDL contracts.


2. Does OIC automatically generate WSDL for SOAP services?

Yes. When a SOAP trigger is configured in an integration, OIC automatically generates the WSDL definition that client applications can use to invoke the service.


3. Can SOAP services in OIC call REST APIs?

Yes. This is a common integration pattern. The SOAP request is received by OIC, transformed into REST format, and then sent to a REST API such as Oracle Fusion HCM.


Share

Leave a Reply

Your email address will not be published. Required fields are marked *