- 1. Introduction
- 2. About Data Gateway
- 3. Key Features
- 4. Glossary
- 5. System Requirements
- 6. Application Access
- 7. Roles
- 8. Dashboard Reports (Statistics)
- 9. Cloud Configurations
- 10. Access Management
-
11. Endpoint Management Module
- 11.1 Create Endpoint
- 11.2 Manage Endpoint
-
11.3 Protocols
- 11.3.1 FTP (File Transfer Protocol)
- Pull-Push
- Push-Pull
- Push–Push Scenario
- 11.3.2 FTPS (FTP Secure)
- Pull-Push
- Push-Pull
- Push-Push Scenario
- 11.3.3 SFTP (SSH File Transfer Protocol)
- Pull-Push
- Push-Pull
- Push-Push Scenario
- 11.3.4 API Based File Transfers
- 11.3.4.1 Pull-Push
- 11.3.4.2 Scenario: File Transfer through API, where You connect to Remote Server
- 11.3.4.3 Scenario: File Transfer through API, where Partner connects to Your Server
- 11.3.4.4 Push-Pull
- 11.3.5 AS2 (Applicability Statement 2)
- 11.3.5.1 AS2 Organizations
- 11.3.5.2 AS2 Endpoints
- 11.3.5.3 AS2 Relationships
- 11.4 GUID
- 12. File Management Module
-
13. Settings
- 13.1 Scheduler Configuration
- 13.2 PGP Manager
- 13.3 Application Configuration
- 13.4 Queue Management
- 13.4.1 Queue Management – Field Descriptions
- 13.4.2 Operational Summary
- 13.4.3 Key Benefits
- 13.5 Priority Handling
- 13.5.1 Priority Handling – Field Descriptions
- 13.5.2 Operational Summary
- 13.5.3 Key Benefits
- 13.6 Adapter Configuration
- 13.6.1 Adapter Configurations – Field Descriptions
- 13.6.2 Operational Behavior Example
- 13.6.3 Key Benefits
- 13.7 License Module
- 13.7.1 License Management – Field Descriptions
- 13.7.2 Operational Workflow
- 13.7.3 Key Benefits
- 14. Data Gateway Components
-
15. Connectivity and Authentication
- 15.1 Scenario: File Transfer through File Client, where Partner Connects to Your Server
- 15.2 Scenario: File Transfer through File Client, where You connect to Partner’s Remote Server
- 15.3 Push-Push Scenario
- 15.4 Scenario: File Transfer through AS2, push to partner and push to gateway
- 15.5 IP Allowlist & Rate Limiting
- 15.5.1 IP allowlisting
- 15.5.2 Rate Limiting
-
16. SAML Authentication and Authorization with Okta
- 16.1 What is SAML?
- 16.2 What is SAML Used For?
- 16.3 How SAML Works
- 16.4 Configuring SAML Authentication and Authorization in Okta
- 16.4.1 Prerequisites
- 16.4.2 Steps to Configure SAML in Okta
- 16.4.3 Download Identity Provider Metadata
- 16.4.4 Application Configuration (application.yml)
- 16.5 User Management for IDP Users
- 16.6 Common Troubleshooting Issues
-
17. Alert Management
- 17.1 File Not Received (FNR) Alert
- 17.2 File Not Received (FNR) Alert Timing Options
- 17.2.1 FNR Current Day Minutes
- 17.2.2 FNR Current Day Hours Scenario
- 17.2.3 FNR Daily Days Scenario
- 17.2.4 FNR Daily Weekdays Scenario
- 17.2.5 FNR Weekly Between Scenario
- 17.2.6 FNR Weekly Day of Week Scenario
- 17.2.7 FNR Monthly Specific Day Scenario
- 17.2.8 FNR Monthly On Scenario
- 17.2.9 FNR Monthly Interval Check Scenario
- 17.2.10 FNR Quarterly Scenario
- 17.2.11 FNR Yearly Every Scenario
- 17.2.12 FNR Yearly On The Scenario
- 17.3 File Load Alert (FLA Alert)
- 17.4 Manage Alerts
- 18. Cloud-Cloud File Transfer
- 19. OAuth 2.0 Authentication
- 20. ICAP Integration
- 21. Data Gateway APIs
20. ICAP Integration
The ICAP module in the Data Gateway application integrates Clam AV virus scanning for files uploaded via:
Scan Behavior
Example Logging in Data Gateway:
If we enable the Scan and the file contains virus then the following will be the output will get an error like the below.
- SFTP, FTP, FTPS for P2H Scenarios
- Internal uploads through File Operator Upload and File Manager Upload
- Chunk-wise scanning for optimized performance
- Full and preview scan modes based on file size
- Logs all scan events in both standard and secure logs
- Error display supported for FTP/FTPS and UI uploads; SFTP errors are logged only
- Dual-token validation system supports both internal users and external OAuth/ICAP users
20.1 Configuration
The ICAP module is configured in the Data Gateway application.yml. Example: clamav: scan-enabled: true host: 192.168.0.53 port: 3310 read-timeout: 90000 connection-timeout: 9000 preview-scan: 1024576 Parameter Descriptions| Parameter | Description |
| scan-enabled | Enables or disables file scanning. Set false to disable scanning. |
| host | IP address of the ClamAV server. |
| port | Port for ClamAV connection (default: 3310). |
| read-timeout | Maximum wait time for a scan response (milliseconds). |
| connection-timeout | Maximum connection time to ClamAV server (milliseconds). |
| preview-scan | Maximum file size for full scan (in bytes). Files larger than this use preview scan. |
- Full Scan: For files ≤ preview-scan size
- Preview Scan: For files > preview-scan size
- Chunk-wise Scanning: Large files are scanned in smaller chunks for efficiency
20.2 Virus Scan Status Handling
The ICAP module validates files using the following statuses:| Status | Description |
| FAILED | Upload blocked; logs recorded |
| PASSED | Upload proceeds; logs recorded |
20.3 Supported Upload Methods
| Upload Method | Error Display | Notes |
| SFTP | Server/Proxy logs | UI error not displayed due to limitations |
| FTP | WISCP | |
| FTPS | WISCP | |
| File Operator Upload | Application UI | |
| File Manager Upload | Application UI |
20.4 Logging
- Standard Logger: Logs operational information
- Secure Logger: Logs sensitive information (username, file path) for auditing

