Notifications

When monitoring large data loads or several different data loads, rather than frequent reviews of the Load Reporting Portal to understand the progress of the loads, email notifications can be created based on rules that query the state of data loads. Inside the email is a CSV report on files that match the criteria of the notification, this allows for easy review of recent Load Reporting activity. To configure, after selecting an asset, select Notification Configuration.

The Notifications page displays a paged summary of the current notifications for the asset.

For each notification, the key details are shown. Hover the mouse over one of the runs to see the date and time of the run. To edit a notification, select . To delete a notification, select (it will show as Pending Delete for around 15 minutes before being removed). To create a new notification, select New Notification. To return to the main page for the asset, select the Back to asset button.

Create a New Notification

1. After selecting New Notification the Notification page is displayed:

   

2. Enter a Name to describe the notification. It should be unique, contain 3 to 35 characters and only contain letters, numbers, hyphens and underscores.

3. Select a Frequency based on:

   • Monthly - the process is triggered on the first day of the month at 12AM UTC.

   • Weekly - the process is triggered on the first day of the week (Monday) at 12AM UTC.

   • Daily - the process is triggered everyday at 12AM UTC.

   • Hourly - the process is triggered every 4, 6, 8 or 12 hours starting at 12AM UTC.

4. Enter an Email List detailing those that will receive the email notifications. Only emails of users with access to the current asset are allowed. A scrolled list of all possible emails is provided. Multiple emails may be selected.

5. The Enabled toggle allows for the notification to be enabled or disabled.

6. The Send notification when no data toggle, when selected, means that if no data is generated for the processed notification then an email with no attachment will still be sent to the email list. For example, for a weekly notification, if no files were uploaded in the past week, then the email list will receive an email informing them of that. If this toggle is not selected, then no email will be sent if no data is generated.

7. Select Create rule to start creating rules. At least one rule must be created to save the notification.

8. When the notification fields have been filled out correctly, select Save to save the notification. Cancel will discard the changes.

Create Notification Rules

9. After selecting Create rule the Configure Rule page is displayed.

   

10. Enter a Rule name to describe the rule. It should be unique, contain 3 to 35 characters and only contain letters, numbers, hyphens and underscores.

11. Select a Criteria for the filter. Criteria values are:

    • File State - multiple file states may be provided, these can be selected from a list in the value field, for example, Failed, Completed.

    • File Source - text value.

    • File Name - text value.

    • Document ID - plain text value.

12. Select an Operator for the filter. Depending on the criteria selected, some of the following Operator values will be available:

    • =

    • <>

    • Contains

    • Starts With

    • Ends With

13. Provide a Value for the filter.

14. Select Add to add the filter to the rule definition. For each rule, at least one filter must be added.

    When the notification is processed, filters are combined using an AND operator and rules are combined using an OR operator. For example, if a notification has rule1 with filter1 and filter2 and has rule2 with filter3 and filter4, then the logical operation will be: (filter1 AND filter2) OR (filter3 AND filter4).

    

15. To remove a filter, select . When the filter(s) have been added, select Set rule to save the rule. Cancel will discard the changes.

    After saving a rule, the Notification page is displayed. The rules are displayed at the bottom of the page, for example:

    

    To edit a rule, select . To delete a rule, select .

    After saving a notification, the Notifications page is displayed.

    Any new notification will have a status of Pending Creation for a few minutes, and then it will change to Scheduled.

    Any edited notification will have a status of Pending Update for a few minutes and then it will change to Scheduled.

    Any deleted notification will have a status of Pending Delete for a few minutes and then it will be removed from the list.

    Note: if statuses are not updated automatically, then refresh the browser by selecting F5.