FTP Adapter in OIC Explained

Share

Introduction

The FTP Adapter in Oracle Integration Cloud (OIC Gen 3) is one of the most commonly used integration components in real-world enterprise projects. If you are working on Oracle Fusion implementations, you will almost always encounter file-based integrations — whether it’s loading data into HCM, ERP, or SCM, or extracting reports for downstream systems.

In practical projects, FTP/SFTP is still widely used despite APIs becoming more popular. Payroll vendors, banks, third-party logistics systems, and legacy applications often rely on file exchanges. This is where the FTP Adapter becomes critical.

This article explains the FTP Adapter in Oracle Integration Cloud from an implementation perspective — not just theory — including architecture, step-by-step configuration, real use cases, and troubleshooting tips based on real consulting experience.


What is FTP Adapter in Oracle Integration Cloud?

The FTP Adapter in OIC enables integrations to:

  • Read files from an FTP or SFTP server
  • Write files to an FTP or SFTP server
  • List files from directories
  • Delete or move files after processing

It acts as a connector between OIC and external file systems.

Supported Protocols

  • FTP (not recommended for secure environments)
  • SFTP (most commonly used in enterprise implementations)
  • FTPS (less common but supported)

Real-World Integration Use Cases

1. Payroll File Processing (HCM Integration)

A company generates payroll input files from a third-party vendor:

  • Vendor uploads file to SFTP server
  • OIC picks up the file using FTP Adapter
  • File is transformed into HDL format
  • Data is loaded into Oracle Fusion HCM

2. Bank Statement Processing (ERP)

  • Bank uploads daily statement files (BAI2/CSV)
  • OIC reads files from SFTP
  • Converts into Oracle format
  • Loads into Cash Management module in Oracle Fusion ERP

3. Product Data Sync (SCM)

  • External warehouse system exports inventory file
  • File placed on FTP server
  • OIC reads and updates inventory in Oracle Fusion SCM

Architecture / Technical Flow

A typical FTP Adapter integration flow looks like this:

  1. External system places file in SFTP location
  2. OIC scheduled integration triggers at defined intervals
  3. FTP Adapter connects to server
  4. Reads file (polling or read operation)
  5. Data is parsed (CSV/XML/Fixed format)
  6. Mapping/transformation occurs
  7. Data is sent to target system (Fusion, DB, API)
  8. File is archived or deleted

Key Design Options

Option Description
Scheduled Integration Polls FTP server at intervals
App Driven Orchestration Triggered externally
File Server (OIC Gen 3) Internal staging option

Prerequisites

Before configuring FTP Adapter, ensure:

1. SFTP Server Access

  • Host name
  • Port (default: 22)
  • Username & password OR SSH key

2. Network Configuration

  • Whitelisting OIC IPs in firewall
  • VPN or private endpoint (if required)

3. File Format Details

  • File type (CSV, XML, ZIP, etc.)
  • Structure definition
  • Delimiters

4. Security Setup

  • SSH keys (preferred over password authentication)
  • Encryption requirements

Step-by-Step Build Process

Let’s walk through a real implementation scenario: Reading a CSV file from SFTP and processing it.


Step 1 – Create FTP Connection

Navigation Path:

Integrator → Connections → Create

Steps:

  1. Select Adapter → FTP Adapter
  2. Enter:
    • Name: FTP_SFTP_CONNECTION
    • Role: Trigger/Invoke
  3. Configure:
    • Host: sftp.company.com
    • Port: 22
    • Security: SFTP
    • Authentication: Username/Password or SSH Key

Tip: Always test connection before saving.


Step 2 – Create Integration

Navigation Path:

Integrator → Integrations → Create → Scheduled Orchestration

  • Name: READ_PAYROLL_FILE

Step 3 – Configure FTP Trigger

  1. Drag FTP Adapter as trigger
  2. Configure:
    • Operation: Read File
    • Directory: /inbound/payroll
    • File Name Pattern: Payroll_*.csv

Step 4 – Define File Schema

Options available:

  • Sample file upload
  • NXSD schema
  • XML schema

Best Practice: Upload a sample CSV file and let OIC generate schema.


Step 5 – Configure Read Options

  • File Read:
    • Read Entire File
  • Stage File:
    • Enabled (recommended)
  • File Processing:
    • Move/Delete after read

Step 6 – Add Transformation

Use Mapper to:

  • Convert CSV to XML structure
  • Map fields to target system

Step 7 – Invoke Target System

Example:

  • Call REST API of Fusion
  • Load HDL file
  • Insert into database

Step 8 – Archive File

After processing:

  • Move file to /archive
  • Rename with timestamp

Step 9 – Activate Integration

  • Save
  • Activate
  • Schedule job (e.g., every 15 minutes)

Testing the Technical Component

Test Scenario

Upload sample file:

EmployeeID,Salary 1001,50000 1002,60000

Expected Behavior

  • Integration picks file
  • Parses data correctly
  • Sends data to target system
  • Moves file to archive

Validation Checks

  • Integration instance tracking
  • File moved successfully
  • No parsing errors
  • Target system updated

Common Errors and Troubleshooting

1. Connection Failure

Error: Connection Timeout
Cause: Firewall or incorrect host

Fix:

  • Check IP whitelisting
  • Verify port and host

2. Authentication Failure

Error: Login Failed
Cause: Wrong credentials or key

Fix:

  • Re-upload SSH key
  • Validate user permissions

3. File Not Found

Error: No files available
Cause: Incorrect directory or naming pattern

Fix:

  • Verify path /inbound
  • Check wildcard pattern

4. Schema Mismatch

Error: Parsing error
Cause: File structure mismatch

Fix:

  • Update sample file
  • Regenerate schema

5. Large File Processing Issues

Issue: Timeout or memory error

Fix:

  • Use chunk reading
  • Enable streaming

Best Practices (From Real Projects)

1. Always Use SFTP (Not FTP)

FTP is insecure — avoid it in enterprise environments.


2. Use File Naming Conventions

Example:

  • PAYROLL_YYYYMMDD.csv

This helps avoid duplicate processing.


3. Archive Files Properly

Never delete files immediately — move to archive.


4. Implement Error Handling

  • Use fault handlers
  • Send email alerts

5. Avoid Large File Reads in One Go

Use:

  • Chunk processing
  • Staging

6. Use OIC File Server (Gen 3 Feature)

Instead of external FTP, use:

  • Secure internal storage
  • Simplified architecture

7. Logging is Critical

Track:

  • File name
  • Record count
  • Processing status

Real Consultant Insight

In multiple Oracle Fusion implementations, FTP Adapter becomes a bottleneck if not designed properly.

Common mistakes seen:

  • Hardcoding file paths
  • Not handling duplicate files
  • No retry mechanism
  • Ignoring file locking scenarios

A well-designed integration always includes:

  • Retry logic
  • File validation
  • Duplicate detection

Summary

The FTP Adapter in Oracle Integration Cloud (OIC Gen 3) is a foundational component for file-based integrations across HCM, ERP, and SCM systems.

Key takeaways:

  • Essential for legacy and batch integrations
  • Supports secure SFTP connectivity
  • Requires careful design for scalability
  • Plays a major role in real-world Oracle implementations

Mastering FTP Adapter is critical for any OIC consultant because file-based integrations are still dominant in enterprise landscapes.


FAQs

1. Is FTP Adapter still relevant with APIs available?

Yes. Many external systems still rely on file-based communication, especially in banking, payroll, and legacy systems.


2. What is the difference between FTP Adapter and File Server in OIC?

FTP Adapter connects to external servers, while File Server (Gen 3) provides internal file storage within OIC.


3. Can FTP Adapter handle large files?

Yes, but it requires proper design like chunk processing and streaming to avoid performance issues.


Oracle Documentation Reference

For deeper technical understanding, refer to official Oracle documentation:

https://docs.oracle.com/en/cloud/paas/application-integration/integrations-user/


Share

Leave a Reply

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