Email notifications can be set up and used to help monitor an Set up Notifications on Critical Errors from the Ingest Instance Service.

The Ingest Instance Service is designed to run on a server without user interaction. Once your data sources have been set up and Ingest tasks are scheduled via TimeXtender Orchestration, data will automatically flow from the data sources into the configured data storage. In those cases where data sources are not changing, there may be little reason to open ingest instances.

However, there may be errors and users may not realize immediately that something is not working. To mitigate this type of delay, email notifications can be set up to notify the appropriate users when critical errors occur, which also should be prominently displayed in the management interface.

Critical errors include the following:

  1. Cannot connect to the Ingest Instance storage
    Occurs when an ongoing data storage transfer loses its connection to the storage container.
  2. Invalid ODX secret (Version 20.10)
    Occurs when authentication is invalid and attempting to do either of the following:
    1. Connecting to the instance database.
    2. Downloading data source components.
  3. Cannot connect to the ODX environment (Version 20.10)
    Occurs when authentication is valid but there is some other problem when attempting to do either of the following (process must fail 3 times in a row.):
    1. Connecting to the instance database.
    2. Downloading data source components.

Adding an Email Notification For Critical Errors

Use the following steps to configure critical error notifications for an ingest instance.

  1. In the Solution Explorer, right-click the Ingest Instance and click Notifications on Critical Errors.

     

  2. Select Notify by email when a critical error occurs and enter the recipients in the Recipients box. Separate recipients with a semicolon.

  3. Enter a Name for the notification and select the Type of notification you want to create. Continue entering the appropriate email server in the following steps.
  4. In Server name, enter the information for the SMTP server that will be used to send the email.
    • Note that on October 1st, 2022, Microsoft discontinued basic authentication for email on online SMTP servers.
    • In lieu of basic authentication, enter the an Application ID from an app created for this and the Tenant ID for your company. 
      mceclip0.png
    • In order for the App to work, it should have the following the three permissions set.
      • Mail.Send
      • SMTP.Send
      • User.Read
    • An Admin may need to grant consent for the three settings above.
    • For GMail to authenticate, it is necessary to turn on 2-step authentication for your email account and then use the App Password in the password field.
  5. Click Test Notification to test if the email server settings are working.

Here is how it can look when it has been set up.

The following is an example of a test notification email.