orchestrator

2022.4

false

Getting started
- Introduction
- User Options
- Logging in to Orchestrator
- Resetting Your Password
- My Profile
- Robots
  - Robot Statuses
  - Robot Settings
- Auto Updating Client Components
- Orchestrator Configuration Checklist
Best practices
- Organization Modeling in Orchestrator
- Managing Large Deployments
- Automation Best Practices
- Optimizing Unattended Infrastructure Using Machine Templates
- Organizing Resources With Tags
Tenant
- About the Tenant Context
- Searching for Resources in a Tenant
- Robots
- Folders
- Monitoring
- Managing Access and Automation Capabilities
- Machines
- Packages
- Audit
- Credential Stores
- Webhooks
  - Types of Events
  - Managing Webhooks
- Licensing
  - Managing Your Licenses
- Alerts
  - Setting Up Alert Emails
- Settings
Resource Catalog Service
- About Resource Catalog Service
Folders Context
- About the Folders Context
- Home
Automations
- About Automations
Processes
- About Processes
- Managing Processes
- Managing Package Requirements
- About Recording
Jobs
- About Jobs
- Managing Jobs
- Job States
- Working with long-running workflows
Triggers
- About Triggers
- Managing Triggers
- Using Cron Expressions
Logs
- About Logs
- Managing Logs in Orchestrator
- Logging Levels
- Orchestrator Logs
Monitoring
- About Monitoring
- Machines
- Processes
- Queues
- Queues SLA
Queues
- About Queues and Transactions
- Bulk Uploading Queue Items Using a CSV File
- Managing Queues in Orchestrator
- Managing Queues in Studio
- Managing Transactions
  - Editing Transactions
  - Field Descriptions for the Transactions .csv File
- Review Requests
Assets
- About Assets
- Managing Assets in Orchestrator
- Managing Assets in Studio
- Storing Assets in Azure Key Vault (read-only)
- Storing Assets in HashiCorp Vault (read-only)
Storage Buckets
- About Storage Buckets
  - CORS/CSP Configuration
- Managing Storage Buckets
- Moving Bucket Data Between Storage Providers
Test Suite - Orchestrator
- Test Automation
- Test Cases
  - Field Descriptions for the Test Cases Page
- Test Sets
  - Field Descriptions for the Test Sets Page
- Test Executions
  - Field Descriptions for the Test Executions Page
- Test Schedules
  - Field Descriptions for the Test Schedules Page
- Test Data Queues
Other Configurations
- Increasing the Size Limit of Package Files
- Setting up Encryption Key Per Tenant
- GZIP Compression
Integrations
- About Input and Output Arguments
  - Example of Using Input and Output Arguments
Classic Robots
- Robots
- Environments
  - Managing Environments
- Jobs
- Triggers
- Monitoring
  - Robots
- Resources
Host administration
- About the host level
- Managing system administrators
- Managing tenants
- Configuring host authentication settings
- Managing your host license
  - Allocating Licenses to Tenants
  - Allocating host licenses to organizations
- Configuring system email notifications
- Configuring other host settings
- Audit logs for the host portal
- Maintenance Mode
Organization administration
- About organizations
- Managing organization administrators
- Configuring organization authentication
- Licensing
  - Activating your license
- Accounts and Groups
- Registering External Applications
  - Managing External Applications
- Overriding System Email Settings
- Audit Logs
Troubleshooting
- About Troubleshooting
- Frequently Encountered Orchestrator Errors
- Cron Expressions
- Upgrade Issues

Orchestrator User Guide

DELIVERY:

Automation Cloud Automation Cloud Public Sector Automation Suite Standalone

Last updated Oct 9, 2024

Alerts

Alerts are real-time notifications related to robots, queue items, triggers, and more. You receive alerts for all the folders to which you have access. You can view alerts quickly in the notification panel, or review them in detail on the Alerts page.

Alerts can refer to:

different severities of events (info or warning, for example)
different components (Triggers, Actions, and more).

Subscribing or Unsubscribing From Alerts

You have the possibility to subscribe or unsubscribe from alerts on the Profile page. A toggle is available for each component: Transactions, Robots, Jobs, Actions, Triggers, Queues, and Cloud Robots.

If you are subscribed to alerts, they appear in the Alerts notification panel and you can view their details on the Alerts page. If you unsubscribe, you cannot see alerts related to the components for which you unsubscribed in either place.

If you don't have at least View permissions on a component, the no alert icon is displayed next to it and you don't receive any of the corresponding alerts, even if the toggle is switched on.

Alert Notifications

When new alerts are generated, a red badge appears on the Alerts icon in the top right:

Click the icon to open the Alerts panel, where you can view the five most severe alerts:

The notification panel displays a maximum of 5 alerts ordered according to severity and creation time. Higher severity alerts are displayed first; if there are several alerts with the same severity, the latest ones are displayed first.

To remove an alert from the Alerts panel, you must mark it as read from the Alerts page.

From the notification panel, you can navigate to:

the Alerts page by clicking See All Alerts at the bottom
to your Profile page where you can subscribe or unsubscribe from alerts by clicking Open Alerts Preferences in the top right corner of the panel.

Viewing Alerts

You can view all alerts to which you have access on the Alerts page, which you can access by going to Tenant > Alerts.

Viewing Alert Details

If you want to learn more about an alert, click the info icon at the right end of the row to open the Alert Details window:

Note: By exception, alerts for the Triggers component do not have any further details so there is no info icon available for them.

Alert Classification

Alert Severity Levels

The severity levels of alerts apply to different types of notifications, as follows:

Info - Robots now available; User assigned as reviewer for failed/abandoned queue item; User assigned/unassigned/reassigned from one or multiple tasks.
Warn - Queue items that fail with business exceptions.
Error - Jobs that fail, be they scheduled or manually started; Robots not responding; queue items that fail with application exceptions, queue triggers not able to create new jobs.
Fatal - Robots that go offline or are disconnected.
Success - Alerts generated using the Raise Alert activity.

When filtering the Alerts page according to the Severity level, please note that all greater severity levels are also displayed. For example, if you select Warn, messages are going to be displayed for the Warn,Error and Fatal severity levels.

The default value of the filter is Info. This means that removing all filters displays alerts having Info severity and above.

Note:

All alerts with lower severity levels (Info,Warn,Success) are marked as read in the Alerts grid.

Only Fatal and Error alerts are sent via Error summary email reports.

Alert Severity by Component

Component	Severity	Scenario
Jobs	Error	Job faulted
Jobs	Error	Job not created
Robots	Fatal	Robot is disconnected
Robots	Error	Robot is unresponsive
Robots	Info	Robot is available
Schedules	Error	BackgroundJob trigger misfired
Schedules	Error	BackgroundJob failed to execute
Transactions	Error	Queue item failed with ApplicationException
Transactions	Warn	Queue item failed with BusinessException
Transactions	Info	User assigned as reviewer for failed/abandoned queue item
Queues	Error	A breach of the SLA is predicted for a queue.
Tasks	Info	User assigned/unassigned/reassigned from one or multiple tasks
Triggers	Info	Trigger could not create a job as the maximum number of jobs has been reached. Occurs on queue triggers.
Triggers	Error	Trigger could not create jobs as the allocated Robots already have pending jobs for this process. Occurs on time triggers.
Process	Success	Process alert - alerts generated using the Raise Alert activity
Folders	Success	"Folder <folderName> was successfully deleted."
Folders	Error	"The folder <folderName> was restored." Generated in case of a failure.
Folders	Error	"Deletion of folder <folderName> failed. The folder was restored as <folderName>." Generated in case of a failure and when a new folder with the same name is created at the same time, which means the original folder is renamed at restore.
Personal Workspaces	Info	"User <userName> started exploring your personal workspace." Sent to the owner of a personal workspace when an admin begins exploring their workspace.
Personal Workspaces	Info	"User <userName> finished exploring your personal workspace" Sent to the owner of a personal workspace when an admin stops exploring their workspace.
Personal Workspaces	Info	"Your personal workspace was converted to a folder: <folderName>" Generated when a personal workspace is converted to a folder.
Personal Workspaces	Info	"User <folderName> deleted your personal workspace. A new empty personal workspace was created for you" Sent to the owner of a personal workspace when their workspace is deleted.
Personal Workspaces	Success	"Enabling personal workspaces successfully completed" Generated when bulk enabling personal workspaces succeeds.
Personal Workspaces	Error	"Enabling personal workspaces failed" Generated when bulk enabling personal workspaces fails.

Custom Alerts

Custom alerts can be sent to Orchestrator using the Raise Alert activity, which lets you add custom messages in the Alerts page, with a selected severity.

Setup

The activity runs under the robot which executes it.

To execute this activity in Studio, the robot has to be connected to Orchestrator and the Robot role must have View,Create, and Edit permissions on Alerts.

Result

All custom alerts are raised in Orchestrator under the Process component. The string added in the activity's Notification field is the message which appears in the Orchestrator Alerts page.

Alerts having either Fatal or Error severity are also included in emails.

Permission to View Alerts

To view alerts, users require the tenant permission Alerts - View. This allows them to see all tenant-level alerts.

At the folder level, users can only see alerts for the folders to which they are assigned.

Important: Users do not inherit alert subscription settings from the parent group, nor do they receive any alerts by default. To allow users to view alerts, explicitly grant the corresponding permissions to users.

Email alerting localization

When you enable the email alerting feature, take into account the following scenarios:

Email alerts sent to an email-enabled AD or AAD group use the language you set at the Orchestrator organization level. This type of email alert disregards the recipient group's email language settings.
Email alerts sent to an individual user use the language based on the following order:
- The individual user’s language.
- The tenant's language.
- The application-level's default language.

On this page

Subscribing or Unsubscribing From Alerts
Alert Notifications
Viewing Alerts
Viewing Alert Details
Alert Classification
Alert Severity Levels
Alert Severity by Component
Custom Alerts
Setup
Result
Permission to View Alerts
Email alerting localization

Was this page helpful?

PREVIOUSManaging Your Licenses

NEXTSetting Up Alert Emails

Support and Services

Get The Help You Need

UiPath Academy

Learning RPA - Automation Courses

UiPath Forum

UiPath Community Forum

Trust and Security

Cookies Policy