Raise Alert

UiPath.Core.Activities.RaiseAlert

Description

Helps you add custom alerts in Orchestrator, with a selected severity. If you have all the necessary settings configured in Orchestrator to receive e-mail alerts, the alert raised with this activity at the Fatal or Error severity, are also included in e-mails. Please note that in order to execute this activity in Studio, the Robot has to be connected to Orchestrator and the Robot role needs to have the View, Create and Edit permissions on Alerts. The activity runs under the Robot which executes it.

Project compatibility

Windows - Legacy | Windows | Cross-platform

Windows, Cross-Platform Configuration

• Orchestrator Folder - The path of the orchestrator folder you want to use with the activity.
• Notification - The message of the alert.

• Severity - The severity of the alert. The following options are available:

  • Info
  • Success
  • Warning
  • Error
  • Fatal

Additional options

• Timeout(milliseconds) - Specifies the amount of time (in milliseconds) to wait for the activity to run before an error is thrown. The default value is 30000 milliseconds (30 seconds).
• Continue on error - Specifies if the automation should continue even when the activity throws an error. This field only supports Boolean values (true, false). The default value is false. As a result, if the field is not configured and an error is thrown, the execution of the project stops. If the value is set to true, the execution of the project continues regardless of any error.

Output

• Retrieved email - Reference to the retrieved email by the activity for use in other activities.

Windows - Legacy Configuration

Properties panel

Common

• Continue On Error - Specifies if the automation should continue even when the activity throws an error. This field only supports Boolean values (true, false). The default value is false. As a result, if the field is blank and an error is thrown, the execution of the project stops. If the value is set to true, the execution of the project continues regardless of any error.
• DisplayName - The display name of the activity.
• Timeout(milliseconds) - Specifies the amount of time (in milliseconds) to wait for the activity to run before an error is thrown. The default value is 30000 milliseconds (30 seconds).

Input

• Notification - The text that is to be sent to Orchestrator (limit of 512 characters).

• Severity - The severity of the alert. The following options are available:

  • Info
  • Success
  • Warning
  • Error
  • Fatal

Misc

• FolderPath - The path of the folder where the alert should be raised, if different from the folder where the process is running. This field only supports string values, with / as the separator to indicate subfolders. For example "Finance/Accounts Payable".

• Private - If selected, the values of variables and arguments are no longer logged at Verbose level.

  Note:

  The FolderPath parameter does not work for processes executed by robots in classic folders. Only robots in modern folders have the ability to pass data outside of their folder.

  Relative folder paths are supported in an X-UIPATH-FolderPath-Encoded header, as follows:

  -right: Path starting with / - starts from the root folder of the tree the ambient folder is part of.

  -right: Path starting with . - starts from the ambient folder.

  -right: Path starting with .. - starts one level up in the hierarchy of the ambient folder for each .. in the path (e.g. ../ for one level up, ../../ for two levels up in the hierarchy).

  Note that trailing slashes are not accepted.