17. Alert Management

Alert Management enables you to configure/manage Alerts based on business scenarios. The notification is also sent as email/API or on the Dashboard based on the configuration.

17.1 File Not Received (FNR) Alert

The FNR alert is triggered, when the configured file/volume of file is not received within the Data Gateway. This alert lets the business know that the file/expected number of files has not been received for the endpoint.

To create a FNR Alert, follow the below steps

  • Navigate to Alert Management -> FNR Alerts

  • You can configure FNR Alerts for an Endpoint or for a Group (Collection of Endpoints)
  • Provide the details
    • File Pattern: select the patterns which needs to be checked.

      • This is the dropdown, where you can select the available File Types.
      • You can create new filetypes by going to Alert Management -> File Patterns.
    • Files Count: Number of files to be checked.Provide the details

      • Alert Name: Name of the alert.
      • Description: Alert description information.
      • EndpointId : The name of the endpoint id.
      • EndpointName : The name of the endpoint.
      • Group Name: The name of the group. (If the alert is for Group)
      • File Name: Name of the file to be checked.
  • Click on Next and Provide the Timing information

    • Expected Time: Time interval when occurred Dropdown with different time options. Refer here for more details.
    • Time Range From: Starting time in time range.
    • Time Range To: Ending time range.
    • Start Date: Start Date from when the files need to be monitored.
    • End Date: End Date till when the files need to be monitored.
  • Click on Next and Provide the Alert Content
  • Priority : Level of importance given to alert.
  • Subject : Heading for the alert.
  • Body : Details of the alert.
  • Click Next and Provide the Notification configuration.
  • Dashboard Alert: To save alerts in alert dashboard in Data Gateway UI.
  • Email Alert: Email address of the user to whom the alert notification will be sent.
  • Rest API : Invoking REST API for the notification.
  • You can click on Create to create the Alert.

17.2 File Not Received (FNR) Alert Timing Options

FNR Expected time can be selected from the values available in the dropdown, based on which the alert checks the condition on selected timings. 

17.2.1 FNR Current Day Minutes:

In this option, you can select the expected time as ‘Current day’. It will ask you to select the ‘every’ count of the minutes to consider as integers: 1, 2, …59. and then select the ‘Minute(s)’ of the hour. This will create an FNR alert, which will check the current day scenario for selected minutes also with the start and end dates provided.

17.2.2. FNR Current day Hour’s scenario:

In this scenario, you can select the expected time as ‘Current day’. After selecting it, you can select the ‘every’ count of the hour which has to be integers: 1, 2, …23. and select the ‘Hour(s)’. The FNR alert will check the current day scenario for selected hours along with the start and end dates provided.

17.2.3.FNR Daily days scenario:

In this scenario, you can select the expected time as ‘Daily’. After selecting it, you can select the ‘every’ count of the day(s) which has to be integers: 1, 2, …31. and select the ‘day(s)’. The FNR alert will check the Daily Scenario for selected days along with the start and end dates provided.

17.2.4. FNR Daily Weekdays scenario:

In this scenario, you can select the expected time as ‘Daily’. After selecting it, you can select the ‘every’ count of the day(s) which has to be integers: 1, 2, …4. and select the ‘weekday(s)’. The FNR alert will check the Daily Scenario for selected weekdays along with the start and end dates provided.

17.2.5. FNR Weekly between scenario:

In this scenario, you can select the expected time as ‘Weekly. After selecting it, you can select the Frequency of Occurrence as ‘Between’ and From Weekday, To Weekday as any days of the week e.g.:- Monday…Sunday. The FNR alert will check the Daily Scenario for selected weekdays along with the start and end dates provided.

17.2.6. FNR Weekly day of the week scenario:

In this scenario you can select the expected time as ‘weekly’ and frequency of occurrence as ‘Day of the week’. You can then select the ‘every’ count of the week as an integer: 1, 2..4. and select the days of the week The FNR will check weekly scenario for every week on the selected days also with time range provided.

The screenshot configuration below will look for the files/count on Monday, Tuesday and Wednesday of every week from 12:00 AM to 12:30 AM and raise an alert if the condition is not met.

17.2.7. FNR Monthly on specific day scenario:

In this scenario you can select the expected time as ‘monthly’ and frequency of occurrence as ‘On Day’. You can then select the ‘nth Day’ of day in month as integers: 1, 2…31 and ‘nth month’ of month count. The FNR will check the monthly scenario on the selected day of the month along with the time range provided.

The screenshot configuration below will look for the files/count on the 1st of every month from 12:00 AM to 12:30 AM and raise an alert if the condition is not met.

The screenshot configuration below will look for the files/count on the 1st of every alternate month from 12:00 AM to 12:30 AM and raise an alert if the condition is not met.

17.2.8. FNR Monthly on the scenario:

In this scenario you can select the expected time as ‘monthly’ and frequency of occurrence as ‘On The’. You can then select the occurrence of the day in month as first, second etc. and day of week of month as Sunday, Monday etc. and ‘nth month’ count of month. The FNR will check the monthly scenario on the selected day on the week of the month also with time ranges provided.

The screenshot configuration below will look for the files/count on the 1st Sunday of every month  from 12:00 AM to 12:30 AM and raise an alert if the condition is not met.

17.2.9. FNR Monthly on interval check scenario:

In this scenario you can select the expected time ‘monthly’ and frequency of occurrence as ‘Interval Check’. You can then select the ‘from Day’ and ‘To Day’ of particular day in month as integers: 1, 2 etc. and ‘nth month’ of particular month count. The FNR will check on monthly interval from the from day to today selected days on the particular month also with time range ranges provided.

The screenshot configuration below will look for the files/count on the 1st to 10th of every month  from 12:00 AM to 12:30 AM and raise an alert if the condition is not met.

17.2.10. FNR Quarterly scenario:

In this scenario you can select the expected time ‘Quarterly’. The FNR will check Quarterly scenario on quarter end day with time range provided.

The screenshot configuration below will look for the files/count on quarter end date from 12:00 AM to 12:30 AM and raise an alert if the condition is not met.

17.2.11. FNR Yearly Every Scenario:

In this scenario you can select the expected time as ‘yearly’ and frequency of occurrence as ‘Every’. You can then select the occurrence of the month as January, February etc. and ‘nth Day’ of particular day of month. The FNR will check yearly on the selected day for the particular month based on the time range provided.

The screenshot configuration below will look for the files/count on the first of every January from 12:00 AM to 12:30 AM and raise an alert if the condition is not met.

17.2.12. FNR Yearly on the Scenario:

In this scenario you can select the expected time as ‘Yearly’ and frequency of occurrence as ‘On The’. You can then select the occurrence of the day in month as first, second etc. and day of week of particular month like Sunday, Monday etc. and also select the month of the year. The FNR will check yearly on the selected day based on the particular week of month in the year along with the time range provided.

The screenshot configuration below will look for the files/count on the first Sunday of every January from 12:00 AM to 12:30 AM and raise an alert if the condition is not met.

17.3 File Load Alert (FLA Alert)

File load alert is raised whenever a file is processed from one node to other, file load alert will raise with success status if the file is transmitted in the prescribed time. Else File load alert is raised with failure status. In either of the cases the file load alert notifies the user on the file transmission.

For Every endpoint and File pattern we will be configuring ‘time to process’ value while creating it. If the files for the prescribed endpoint or endpoints in a group or file pattern, load or received within the time to process, then it’s a success condition. Similarly, if a file fails to load then it is in failure condition. This File load alert will track the success and failure condition for each file while transmitting from one node to another node and raises the notification

File load alert can be configured for Endpoint based, file pattern based, and Group based.

Creation of Endpoint based FLA:


In the Alert details please enter the alert name, description and select the configuration type endpoint based.

Then click on next.

Inserting image...


Select endpoint name and endpoint id. Similarly, select the condition of the FLA to check for the file.

If the condition is successful and the file is received within the processing time, the user receives a success notification.

If the condition fails and the file is not received within the processing time, the user receives a failure notification.


Select time to process and corresponding values.


providing the priority of the alert, subject and body will be default added with some selected alert information. Update it if required.


In notifications details dashboard alert notification is default selected for every alert and please enable the other notifications email and rest API by providing the details required as shown in above figure. If we enable the email notification, please provide an email address. Similarly, if we select the Rest API notification, please select the API from the drop down.

After providing the details click on the create button which will create a FLA alert successfully, all the pages will be redirected to manage alerts screen with a success message.


Creation of File based FLA:


In the Alert details please enter the alert name, description and select the configuration type file based.

Click on next.


and enter file pattern. please select the condition of the FLA to check for the file whether success or failure condition and select the time to process.

Click on next.


Provide the priority of the alert, subject and body will be default added with some selected alert information. Update it if required.


In notifications details dashboard alert notification is default selected for every alert and please enable the other notifications email and rest API by providing the details required as shown in below figure. If we enable the email notification, please provide an email address. Similarly, if we select the Rest API notification, please select the API from drop down. 

After providing the details click on the create button which will create a FLA alert successfully, all the pages will be redirected to manage alerts screen with a success message.

 


Creation of Group based FLA: 

 

In the Alert details please enter the alert name, description and select the configuration type group based. Similarly, select the condition of the FLA to check for the file. 

Provide the priority of the alert, subject and body will be default added with some selected alert information. Update it if required. 

In notifications details dashboard alert notification is default selected for every alert and please enable the other notifications email and rest API by providing the details required as shown in below figure. If we enable the email notification, please provide an email address. Similarly, if we select the Rest API notification, please select the API from the drop down. 

After providing the details click on the create button which will create a FLA alert successfully, all the pages will be redirected to manage alerts screen with a success message. 

17.4 Subscription Alerts

 

The Subscription Alerts feature enables users to receive notifications whenever a file transfer event occurs for a configured endpoint or group of endpoints. Alerts are generated for both successful and failed file transfers, providing real-time visibility and monitoring. 

Users can receive alerts through: 

  • Dashboard notifications 
  • Email notifications 
  • REST API (Webhook) notifications 

Each alert type can be enabled based on user requirements. 

 
Create Subscription Alert

In this screen, users define where the alert applies and basic alert identification details. 

Fields in Alert Profile 

Field  Description 
Alert Name*  Name to identify the subscription alert 
Description*  Message displayed when alert is raised 
Endpoint Id  Select a specific endpoint to monitor 
Endpoint Name  Displayed automatically after selecting Endpoint Id 
Group Name  Select a group containing multiple endpoints 
File Name  Specific file name to monitor 
File Pattern  File type or extension (e.g., txt, csv, xml) 

Mandatory Rules 

  • Alert Name and Description are mandatory 
  • Either Endpoint Id & Endpoint Name OR Group Name must be selected 
  • If a Group is selected, alerts apply to all endpoints in that group 

 

File Matching Conditions 

Alerts can be configured based on File Name and File Pattern. 

There are four possible conditions: 

Configuration  Example Input  Result 
No File Name / No File Pattern  —  All transferred files trigger alerts 
File Name = invoice  File transferred = invoice.txt  Alert is raised 
File Pattern = csv  File transferred = report.csv  Alert is raised 
File Name = report + File Pattern = pdf  File transferred = report.pdf  Alert is raised 
File Name = invoice + File Pattern = csv  File transferred = invoice.csv  Alert is raised 

After filling out the details, click Next to proceed. 

In this screen, users define alert message content and severity. 

Fields in Alert Content 

Field  Description 
Priority*  Numeric severity level (e.g., 1, 2, 3) 
Subject*  Subject used for email notification 
Body*  Email body content for notification 

Mandatory Rules 

  • Priority, Subject, and Body are mandatory fields 

Click Next to proceed to Notification settings. 

In this screen, users choose how alerts should be delivered. 

Notification Options 

☑ Dashboard Alert (Selected by default – Mandatory) 

☐ Email Alert (Optional) 

☐ REST API (Optional) 

Checkbox Behavior 

Option  Description 
Dashboard Alert  Always enabled. Stores alert in Alerts Dashboard 
Email Alert  Sends alert notification by email 
REST API  Sends alert to external system via webhook 

Dashboard Alert is always enabled and cannot be unchecked. 

17.5 Manage Alerts

The Manage Alerts can be used to manage all the alerts created. You can view/edit/delete the alerts based on various parameters.

You have search options, where you can search both FNR, FLA based on the Alert Name and Alert Type. Also clicking on the three dots will provide you with additional search criteria (Endpoint ID, Group Name) which can be selected to search based on those as well.

You can use the Edit and Delete icon at the right of each alert record, to edit and make changes to an existing alert, delete the alert respectively. 

In the Alerts Dashboard module, you can see both FNR, FLA alerts raised.
If any condition satisfies the alert will be raised and those, we can see in alerts dashboard. You can also provide the criteria below and search for the alerts raised.
Start Date: Start date of the alert.
End Date: End date of the alert.
Endpoint Id: Name of the endpoint.