13. Settings

The Settings module in the Data Gateway Application is a crucial component that allows users to configure schedulers and manage file replay functionality. The module provides access to the following submenu:

13.1 Scheduler Configuration

 

The Scheduler Manager allows users to configure, manage, and control scheduled tasks that automate specific processes such as data transfer, file processing. It provides flexibility to use either inbuilt scheduling configurations or define custom cron expressions for precise control over execution timing.

Schedulers help ensure that periodic tasks run automatically without manual intervention, improving efficiency and consistency across operations.

 

1. Scheduler Id: Provide any value for the id
2. Scheduler Name: Provide any value for the name
3. Scheduler Configuration: Select either Inbuilt or Custom
4. Scheduler Type: Select any value
5. Description: Provide any description 
6. Status: Select enable or disable
7. Cron Expression: 
         For Inbuilt, provide the predefined cron expression.

         For Custom, provide your own cron expression.

13.2 PGP Manager

PGP Manager is a centralized module designed to handle the complete lifecycle of PGP (Pretty Good Privacy) keys used for data encryption, decryption, signing, and verification.
It enables secure communication between systems or partners by managing both public and private key pairs and their associations with specific endpoints.

1. Generate Key Pair:

User Id: This is a unique identifier associated with the user for whom the PGP key is being generated.

User Email: This is the email address associated with the PGP key pair.
When generating a PGP key.

Key Name: A friendly name or label for the PGP key.
It can describe the purpose or ownership of the key

Endpoint Id: List of endpoints

Key Algorithm: Specifies the cryptographic algorithm used to generate the PGP key pair.

  • RSA – most widely supported and secure for general use.
  • DSA – for digital signatures (older).
  • ECDSA – modern elliptic-curve-based algorithms (smaller key size, same security).

Key Size: Defines the strength (bit-length) of the generated key.

  • 2048 bits
  •  3072 bits
  •  4096 bit
    Larger keys offer higher security but require more computational power.

Passphrase: A secret phrase or password used to protect the private key.

Key Expiry Date: Specifies the validity period of the PGP key.

After this date, the key is considered expired and should no longer be used for encryption or signing.
Setting an expiry helps enforce key rotation and security best practices.

Manage PGP:

  1. Import PGP Key:

  • Endpoint Id: List of endpoints
  • Key Name: A friendly name or label for the PGP key.
    It can describe the purpose or ownership of the key
  • Upload Key: Provide a PGP key.
  1. The public key will be assigned to the specified endpoint during key generation or import.
    To assign the private key, edit the endpoint and provide the key as shown below.

  1. Once the keys are assigned, for Pull-Push mode, if files are dropped in the dropdirectory, they will be encryptedsigned, or both.

In Pull-Push mode, if files are dropped in the pickup directory, they will be decryptedverified, or both.

Similarly, once the keys are assigned, for Push-Pull mode, if files are dropped in the pickup directory, they will be encryptedsigned, or both.
In Push-Pull mode, if files are dropped in the drop directory, they will be decryptedverified, or both.

13.3 Application Configuration

Click on the Settings menu and select the App Configuration

• Log Level Configuration
• File Transfer Chunk Size Configuration
• Display Logs Section.

13.3.1 Log Level Configuration

Easily set log levels for various backend modules directly from the UI. Choose from standard levels like DEBUG, INFO, WARN, ERROR, and FATAL to get the desired amount of detail in your logs. Changes to log levels are applied in real-time, allowing for immediate adjustments without the need to restart services.
View the latest logs right within the UI. Filter logs based on severity, search for specific events.

 

13.3.2 File Transfer Chunk Size Configuration

Optimize large file transfers by adjusting the chunk size. This setting enables the transfer of large files in smaller, manageable chunks, improving transfer efficiency and reliability.

13.4 Queue Management

Queue Management Module is present in the setting pages

The Queue Management feature is used to configure and control the internal executor pools responsible for managing endpoint processing and file transfers.

Each queue defines how many endpoints and file transfers can run concurrently based on the system’s available resources and configured limits.

The system dynamically adjusts the concurrency level according to the configured thresholds, ensuring optimal performance and efficient resource utilization.

When sufficient resources are available, the queue operates at its maximum concurrency. Under constrained conditions, it automatically scales down to the minimum configured thresholds, maintaining continued operation without overloading the system.

13.4.1 Queue Management – Field Descriptions

This section describes each field in the Create Queue Management form, including its purpose, function, and effect on queue performance.

  1. Queue Name*

Purpose:
A unique identifier for the queue configuration.

Details:

  • Used to label and reference the queue internally and in the UI.
  • Should clearly indicate the purpose of the queue.
  • Example: HighPriorityQueue, FTPProcessingQueue.
  1. Resource Allocation*

Purpose:
Specifies the percentage of total system resources allocated to this queue.

Details:

  • Determines how much CPU, memory, and processing power the queue can utilize.
  • The total Resource Allocation across all queues cannot exceed 100%.
  • When creating or updating a queue, the system validates that the combined resource allocation of all configured queues remains ≤ 100%.
  • For example, if five existing queues together consume 90%, a new queue can only be assigned a maximum of 10%.
  • This ensures that total resource distribution across all queues remains balanced and prevents overallocation.
  • When a queue reaches its allocation threshold, concurrency automatically adjusts according to Minimum Threads and Min. Thread Pool Size.
  1. Maximum Threads*

Purpose:
Defines the maximum number of endpoints that can be processed in parallel when resource allocation limits have not been reached.

Details:

  • Represents the upper bound of endpoint concurrency under normal conditions.
  • Higher values allow more endpoints to execute simultaneously when sufficient resources are available.
  1. Minimum Threads*

Purpose:
Specifies the minimum number of endpoints that continue processing in parallel even when the queue’s resource allocation limit has been exceeded.

Details:

  • Ensures endpoint processing remains active during resource constraints.
  • Prevents the queue from becoming completely idle during high load.
  1. Max. Thread Pool Size*

Purpose:
Specifies the maximum number of threads for parallel file transfers under normal resource conditions.

Details:

  • Controls concurrency for file transfer tasks.
  • Higher values allow multiple file transfers to occur simultaneously when resources permit.
  1. Min. Thread Pool Size*

Purpose:
Defines the minimum number of threads for file transfers when the queue’s resource allocation limit has been exceeded.

Details:

  • Ensures file transfers continue, though at reduced concurrency, during heavy load conditions.
  • Prevents complete halts in file transfers when system resources are limited.

13.4.2 Operational Summary

ConditionEndpoint
Processing
File
Transfers
Normal (resources available)Maximum ThreadsMax. Thread Pool Size
Resource limit exceededMinimum ThreadsMin. Thread Pool Size

13.4.3 Key Benefits 

  • Optimized utilization of system resources based on dynamic workload. 
  • Prevents system overload by intelligently throttling concurrency. 
  • Ensures high-priority queues continue functioning even during constrained conditions. 
  • Provides flexibility to fine-tune performance based on environment and endpoint type. 

After providing the required details and clicking on the Create Queue button the Queue is created. 

13.5 Priority Handling

The Priority Handling feature allows administrators to define the execution order of endpoints associated with different queues. Each endpoint can be linked to a specific queue and assigned a priority level that determines how tasks are scheduled and executed when multiple endpoints are active simultaneously. 

Higher-priority endpoints are processed before lower-priority ones within their respective queues, ensuring that time-sensitive or critical file transfers always take
precedence. 

13.5.1 Priority Handling – Field Descriptions 

1. Endpoint ID*

Purpose:
Identifies the endpoint to which the priority setting applies. 

Details:

  • The dropdown lists all configured endpoints (e.g., FTP, SFTP, API, etc.). 
  • Select the endpoint for which you want to assign or update priority handling. 
  • Each endpoint can be associated with only one queue at a time. 

2. Queue Name*

Purpose:
Specifies the queue to which the selected endpoint will belong. 

Details:

  • Displays the list of all available queues created under Queue Management
  • The selected queue determines the concurrency limits and thread pool settings applied to the endpoint. 
  • Example: FTPProcessingQueue, HighPriorityQueue. 

3. Priority*

Purpose:
Defines the execution precedence of the endpoint within its queue. 

Details:

  • Priority values range from 1 to 9, where: 
  • 1 represents the highest priority, and
  • 9 represents the lowest priority
  • Endpoints with higher priority values (closer to 1) are executed first when multiple endpoints are waiting in the queue. 
  • The priority system ensures that critical data transfers (e.g., business-critical integrations or time-bound file transfers) are processed before less important ones. 
  • The system dynamically manages the order of execution based on both queue resource availability and endpoint priority. 

Priority Handling tab can be found next to the Queue Management Tab

13.5.2 Operational Summary 

ParameterDescriptionExample
Endpoint IDName/identifier of the endpoint configured for transfer.test-sftp
Queue NameQueue under which the endpoint runs.FTPProcessingQueue
PriorityDefines order of execution (1–9, where 1 is highest).1

13.5.3 Key Benefits 

  • Provides fine-grained control over endpoint execution order. 
  • Ensures critical transfers are prioritized automatically. 
  • Balances throughput by aligning endpoint priority with queue configuration. 

13.6 Adapter Configuration 

Adapter Configurations can be found next to the Priority Handling Tab,
The default configurations can be modified upon clicking on the action button

The Adapter Configurations section defines protocol-specific session and transfer limits for different adapters such as SFTP, FTPS, and FTP. It helps control how many sessions and file transfers can occur concurrently based on system resource usage. 

When the configured resource utilization threshold (e.g., 70%) is reached, new session
requests are placed in a waiting queue. This ensures stability, prevents overload, and maintains balanced usage across all adapters. 

13.6.1 Adapter Configurations – Field Descriptions 

1. Protocol*

Purpose:
Specifies the adapter type for which configuration is being applied. 

Details:

  • Supported protocols include SFTPFTPS, and FTP
  • Each protocol can have independent limits for queuing, sessions, and thread pool size. 
  • These configurations ensure that protocol-specific traffic is isolated and managed efficiently. 

2. Start Queuing At*

Purpose:
Defines the system resource utilization percentage at which new sessions for the given protocol start getting queued. 

Details:

  • When total system resource usage reaches or exceeds this threshold (e.g., 70%), the system stops creating new live sessions for the adapter. 
  • Instead, new connection requests enter a waiting queue until resources become available. 
  • This prevents system overload due to excessive simultaneous connections. 

3. Maximum Sessions*

Purpose:
Specifies the maximum number of concurrent sessions allowed for the selected adapter when the system is operating below the configured resource threshold. 

Details:

  • Represents the upper limit of simultaneous connections for that protocol (e.g., 50 sessions). 
  • When the resource utilization exceeds the Start Queuing At limit, any new session beyond this count is queued temporarily. 
  • Queued sessions will remain pending until existing sessions complete or until the Session Timeout expires. 

4. Thread Pool Size*

Purpose:
Defines the maximum number of files that can be transferred in parallel per active session. 

Details:

  • Controls concurrency within each established session. 
  • For example, with a Thread Pool Size of 10, a single session can transfer up to 10 files simultaneously. 
  • This parameter ensures balanced file transfer performance across all active sessions, especially when resource usage exceeds the threshold. 

5. Session Timeout*

Purpose:
Specifies the duration for which queued sessions will wait before timing out if resources are unavailable. 

Details:

  • Determines how long a session request remains in the queue when the system is above the Start Queuing At threshold. 
  • For example, if Session Timeout = 5 Minutes, any session request that cannot be started within 5 minutes will be dropped automatically. 
  • Helps maintain queue health and prevents indefinite waiting conditions. 

 

13.6.2 Operational Behavior Example 

ConditionSystem Behavior
Resource utilization
< 70%
Up to 50 SFTP/FTP/FTPS sessions can be created. Each session can transfer up to 10 files concurrently.
Resource
utilization ≥ 70%
New session requests are placed in a queue for up to 5 minutes. If resources free up within this period, queued sessions begin automatically. Otherwise, they time out.

13.6.3 Key Benefits 

  • Prevents resource saturation during heavy transfer loads. 
  • Balances concurrency across multiple adapter protocols. 
  • Ensures controlled scaling of sessions and transfers based on real-time system utilization. 
  • Improves reliability and stability of large-scale file movement operations. 

13.7 License Module 

License module is present in setting:  

The License Management module allows administrators to upload and manage license files that define key application limits and subscription parameters — such as the maximum number of endpoints allowed. 

Licenses are securely validated to ensure that each client’s configuration adheres to their subscribed capacity and validity period. 

If a client requires an upgrade (for example, to increase endpoint limits or renew their subscription), they can contact the Data Gateway Team to obtain a new encrypted license file. 

13.7.1 License Management – Field Descriptions

1. Upload License*

Purpose:
Enables the administrator to upload the license file provided by the Data Gateway Team. 

Details:

  • The license file contains encrypted information such as the customer name, endpoint limit, and expiry date. 
  • To upload: 
  • Click the Attach icon to select the license file from your local system. 
  • Click Submit to apply the new license. 
  • Once uploaded successfully, the system automatically validates and updates the subscription details. 

2. Customer Name

Purpose:
Displays the registered customer name associated with the uploaded license. 

Details:

  • This name is embedded within the license file. 
  • It helps identify the client’s licensed instance of the Data Gateway. 

3. Email

Purpose:
Represents the registered contact email for the licensed customer. 

Details:

  • Typically belongs to the organization or administrator responsible for managing the Data Gateway instance. 
  • Used for official communication related to renewals or license validation. 

4. Endpoints Limit

Purpose:
Defines the maximum number of endpoints the client can configure within their Data Gateway environment. 

Details:

  • The endpoint limit is encrypted and embedded in the license file by the Data Gateway Team. 
  • Once the license is uploaded, the application automatically enforces the new limit. 
  • If the client requires more endpoints than their current limit, they can contact the Data Gateway Team to obtain an updated license file. 

5. Expiry Date

Purpose:
Indicates the validity period of the current license. 

Details:

  • Shows the date and time at which the license will expire. 
  • After expiry, endpoint creation and transfers may be restricted until a renewed license is uploaded. 

13.7.2 Operational Workflow

 
StepActionResult
1Client contacts Data Gateway Team requesting an increased endpoint limit or renewal.Team generates a new encrypted license file with updated parameters.
2Administrator uploads the license file through the Upload License section.System validates and updates the subscription details.
3Updated license details (Customer Name, Email, Endpoints Limit, Expiry Date) appear
under Your Subscription.
Application enforces new limits immediately.

13.7.3 Key Benefits

  • Ensures secure, encrypted control over licensed parameters. 
  • Simplifies endpoint scalability through easy license upgrades. 
  • Allows centralized management of subscription validity and usage limits. 
  • Prevents unauthorized expansion or use beyond licensed capacity.
 
Scroll to Top