Skip to main content

Configure Notifications for Jobs

Users with the Administrator role can enable and configure email and in-app notifications to monitor the status and details of the jobs post-execution.

To configure email notifications for jobs

  1. Select Notifications in the left navigation bar.

    Note: If you encounter the following error, execute the corresponding command on the underlying database.

    For MS SQL:
    • UPDATE dbo.Settingt
    • SET [key] = 'AppSettingProduction';
    For PostgreSQL:
    • UPDATE public."Settingt"
    • SET key='AppSettingProduction';

    This error may occur if the Settingt table is not properly updated in the database during an upgrade.

  2. In the Configuration tab, toggle the Email switch and expand the configuration options.
  3. Enter the following details:
    1. Server Name: The SMTP server address for your email provider. For example, enter smtp.gmail.com for Gmail or smtp.office365.com for Microsoft 365.
    2. Port: The port used for the SMTP connection.
    3. Mail Sender: The email address that will appear as the sender for all notifications sent from the Management Console.
    4. Email Template File: Optionally, upload a custom HTML email template for notifications. Click Download Sample to download a sample template for reference.
    5. Use Secure Connection (SSL/TLS): Select this checkbox to enable a secure connection. This is required for OAuth 2.0 authentication.
  4. To enable authentication, select your authentication method:
    1. Basic Authentication: Enter your Username and Password for the email account used to send notifications.
    2. OAuth 2.0: Enter the following credentials under Google OAuth 2.0 Configuration or Microsoft OAuth 2.0 Configuration depending on your provider:
      1. Client ID: The client ID generated when registering your application in Google Cloud Console or Microsoft Entra ID.
      2. Client Secret: The client secret generated during application registration.
      3. Tenant ID (Microsoft only): The directory tenant ID from your Microsoft Entra app registration.
  5. Click Connect to authorize the OAuth 2.0 connection. For more details, see Configure OAuth 2.0 for Email Notifications in the Installer and Management Console Guide.
  6. Click Save.

  7. Click Send Test Email, select the required recipients, enter your message, and click Send to verify the configuration.

To configure in-app push notifications for jobs

  1. Select Notifications in the left navigation bar.
  2. In the Configuration tab, toggle the In-app switch and expand the configuration options.
  3. In the Retention In Days field, specify the number of days you want the notification to remain in the list accessible from the bell icon.

  4. Click Save.

To configure rules for the notifications

  1. Go to the Rules tab and click Create Rule.
  2. Enter the following details in the pop-up:
    1. Name: Enter a name for the rule.
    2. Description: Enter a brief description of the rule.
    3. Features: Select the features you want to monitor from the drop-down list.
    4. Notification Type: Select how you want to receive notifications from the drop-down list. Options are In-app, Email, or Both.
    5. Notification Level: Select the notification level from the drop-down list. Options are Success, Warning, Information, and Error.
    6. To Users: Select the users who will receive the notifications from the drop-down list.
    7. Enable Rule: Select this checkbox to activate the rule immediately on saving.
  3. Click Save. The rule appears in the rules table.

  4. To edit or delete a rule, click the more options button in the Action column and select the required option.

To view in-app notifications after running jobs

  1. Click the bell icon.

    The notifications display.

  2. Toggle the Only show unread switch to keep unread messages in the list.

Based on the configured settings, users will receive details such as job status, time stamp, job run time, and key log facts. In-app push notifications will also indicate if the job failed or partially succeeded with warnings.

Was this article helpful?

We're sorry to hear that.