✅ Overview
OIC supports direct file polling using the File / FTP / SFTP Adapter to automatically trigger an integration when a file arrives in a folder.
This pattern is used for real-time file integration without scheduling.
🎯 Use Case
A customer receives files (CSV/XML/TXT) in an SFTP or file server folder and needs OIC to:
- Automatically trigger integration when file arrives
- Filter files by name pattern
- Read and process each file
- Archive or delete after processing
- Avoid scheduled polling
Important Limitation:
Dynamic directory path is NOT supported in direct polling mode.
The polling folder must be a fixed path in the adapter trigger.
🧠 Key Architecture
File Source (SFTP/Folder)
⬇
OIC File Adapter (Polling Trigger)
⬇
Integration Flow
⬇
Target System (ERP/HCM/DB/API/Storage)
⚙️ Adapter Properties
📍 Directory & File Filters
| Property | Purpose |
|---|---|
| Input Directory | Folder to poll (must be fixed) |
| File Name Pattern | Wildcard match (*.csv, *.xml, Invoice_*.txt) |
| Read Files Recursively | Include subfolders |
| Rejection Directory | For non-matching files |
⏱️ Polling Behavior
| Property | Purpose |
|---|---|
| Polling Frequency | How often OIC checks for files |
| Processing Delay | Delay before reading (file write completion) |
| Maximum Files | Limit files per poll cycle |
🗃️ File Handling
| Property | Purpose |
|---|---|
| Delete Files After Successful Read | Remove file post-process |
| Ignore File-Not-Found on Delete | Avoid errors during concurrent moves |
| Archive / Error Directory | Folder to move processed/failed files |
🧩 Dynamic Directory — Clarification
| Capability | Status |
|---|---|
| Dynamic folder for polling | ❌ Not supported |
| Fixed directory required in trigger | ✅ Yes |
| Dynamic directory possible in scheduled list-read flow | ✅ Yes |
Conclusion:
Use Direct Polling only when folder path is static.
Use Scheduled Integration + List Files when folder needs to be dynamic (lookup-based).
🚀 Solution Steps
1️⃣ Create File / SFTP Adapter with Polling
- Enter Base Directory (mandatory)
- Enable Read, List, Move/Delete
- Save credentials & security config
2️⃣ Create App-Driven Orchestration
- Trigger → File Adapter
- Operation → Read File in Trigger/Polling Mode
- Configure:
- Input Directory
- File Pattern (Example:
*.csv) - Archive & Error folders
3️⃣ Build Flow Logic
- Read File → Map → Process to target
- Add logging & validation
- Move / Delete file after success
4️⃣ Error Handling
- Fault-handler block
- Move file to error folder
- Send notification (Email/Teams/SMS)
- Audit integration logs
✅ Outcome
| Benefit | Details |
|---|---|
| Real-time automation | No scheduler needed |
| Reliable file execution | Archive/error segregation |
| Controlled polling | Based on adapter properties |
| Platform aligned | Follows OIC capability & constraints |
📌 When to Use Which Model
| Requirement | Recommended |
|---|---|
| Real-time fixed folder | Direct File Polling Trigger |
| Different folders per env | Multiple connections OR deploy-wise config |
| Dynamic folder path needed | Scheduled + List Files Action |
📝 Key Takeaway
OIC File Adapter Direct Polling = Static Folder + Event-Style Trigger
Dynamic Directory = Only via Scheduled integration
No comments:
Post a Comment