- 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
5. System Requirements
The Data Gateway Application is supported with the following System configurations:
| Minimal | Recommended | |
|---|---|---|
| Operating System | Linux (RHEL) 8 | Linux (RHEL) 9 |
| RAM | 8 GB | 8 GB |
| Disk | 50 GB | 100 GB |
| CPU | 4 cores | 8 cores |
6. Application Access
The Data Gateway UI URL can be accessed once the deployment is complete using the hostname provided in the deployment configuration. It prompts you for the login credentials. Upon first login, the Administrator can login with the factory credentials [Expl0re@123], which must be changed through Access Management after the initial login. This is the process of the local authentication, where the credentials are stored within the Data Gateway.
The application can also be deployed using a SAML profile, allowing authentication to be handled via SAML. In this process, the credentials are stored in Identity Provider (IDP) (Example: OKTA) and not in the Data Gateway.
6.1 Authentication Process
The Data Gateway Application employs a robust two-factor authentication system, in case the application is deployed without SAML for enhanced security. Users need to follow these steps for secure access:
- Enter a valid registered Username and Password in the Data Gateway UI.
- Upon successful login, a unique one-time password (OTP) is sent to the user’s registered email address.
- Input the received OTP to complete the authentication process.
6.2 Application Swagger UI
Once the Data Gateway Application is deployed, users can access the application APIs through Swagger UI, providing a convenient and interactive interface for exploring and interacting with the application’s endpoints. Swagger UI simplifies the process of understanding and testing different functionalities through the APIs available.
The APIs are enabled with both basic authentication and Token Authentication.
