Subscribe

UiPath Orchestrator

The UiPath Orchestrator Guide

Setting Up Email Alerts

About Email Alerts

Fatal and Error alerts can be sent via email messages to users if they meet the following criteria:

  • the Enable Alerts Email check box from the Settings page is selected.
  • the email settings are properly set up in the Settings page. For more information, see Setting Up Email Alerts page.
  • users have a valid address specified in the Users page.
  • View permissions for the Alerts page.

Notifications are sent individually, as they happen (in real time). Additionally, a daily report is sent at 7 a.m.

To enable email alerts, you have to configure multiple settings on the Mail tab, in the Settings page.

Example of Setting Up Email Alerts with Google SMTP Server

  1. Navigate to https://security.google.com/settings/security/apppasswords.
  2. Sign in using the e-mail address which is to send mail messages from Orchestrator.
  3. From the Select App drop-down list, select Mail.
  4. From the Select Device drop-down list, select Windows Computer.
  5. Click Generate. The Generated App Password window containing an app password is displayed.
  6. Copy the generated app password to the Clipboard.
  1. In Orchestrator, in the Settings page, on the Mail tab, configure the settings as follows:
    a. Select the Enable Alerts Email check box.
    b. Select the Enable SSL check box.
    c. Clear the Use Default Credentials check box.
    d. SMTP Host - smtp.gmail.com (Google SMTP server).
    e. SMTP Port - 587 (default Google SMTP port). Note that Implicit SSL is not supported.
    f. SMTP Username - the email address to send mail messages from (the same used at step 2). In this case, documentation@uipath.com.
    g. SMTP Password - the app password of the email address you want to use. It has to be the password of the account that was specified in the Default From Address field.
    h. Default From Address - the email address to send mail messages from. It has to be the same one used at step 5, in our case documentation@uipath.com.
    i. Default From Display Name - a display name for the email address.
  2. Click Save. You will be asked if you want to proceed without testing the settings:

Click Yes to proceed anyway, or click No and see here to first test your settings.

Once saved, all users that have an e-mail address configured in the Users page and an assigned role that grants them View permissions on the Alerts page receive email alerts every time a Fatal or Error alert is encountered, and a daily detailed report of all alerts.

Testing Mail Settings

After entering your settings in the Mail tab as detailed above, you can ensure alert emails are functioning properly using the Test Mail Settings feature:

  1. Click Test Mail Settings. The Test Mail Settings window appears:
  2. In the Send To field, enter the address where the test email should be sent. This field is automatically populated with the email address of the current user, if available, in this case documentation@uipath.com.
  3. Click Send. A window will appear indicating if the email was sent successfully or an error occurred.
  4. Check the test email inbox to verify the message was received as expected.

📘

Note:

Testing does not save your settings, you must still click Save to apply these settings to your setup.

Now all users that have an e-mail address configured in the Users page and an assigned role that grants them View permissions on the Alerts page receive email alerts every time a Fatal or Error alert is encountered, and a daily detailed report of all alerts.

Email Alerts Dashboard

The daily email alert report (Alerts Dashboard) is sent at 7 a.m. by default. The report contains information for the previous 24 hours, as follows:

  • Robots went offline - the total number of alerts generated by Robots that went offline.
  • Robots went online - the total number of alerts generated by Robots that became available.
  • Transactions with Application Exception - the number of transactions that failed with an Application Exception.
  • Transactions with Business Exception - the number of transactions that failed with a Business Exception.
  • Faulted Jobs - the total number of alerts generated for jobs that failed.
  • Queues with items out of SLA or at risk - the number of queues that have items whose SLA is about to expire or has expired already.

Updated 5 months ago



Setting Up Email Alerts


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.