UiPath Orchestrator - アラート機能について知ろう！

# はじめに
UiPathのOrchestratorには、RPAを安全に管理するためにコンポーネントの状態・異常を検知し必要な通知をしてくれるアラート機能があります。
地味でありながら実用に向けて大変役に立つ機能なので、本記事ではアラート機能の基礎を紹介していきたいと思います。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3302318/b5d51522-d144-2bab-deb9-517ec4761431.png)


# アラートの確認方法
Orchestratorのユーザーは、自身がアクセスできるフォルダー内にあるコンポーネントに関するアラートを4つの方法で受信できます。
| 通知方法 | アラート概要 | イメージ |
|:---|:---|:---|
| Orchestrator画面 | 発生時に表示されるバナー | ![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3302318/074e8e27-e4fa-62ab-5c07-29c042710cbb.png) |
| Orchestrator画面 | アラートパネル | ![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3302318/1e823831-6476-fb23-42b9-f7252d449e7e.png) |
| Orchestrator画面 | アラート詳細ページ | ![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3302318/51cef84f-1b02-1e72-3842-7a35f88950d1.png) |
| メール通知 | アラートメール | ~v22.4以前 <br> ![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3302318/3b3d2f23-3e7a-986a-704b-e4395417820d.png) <br> v22.10以降~ <br> ![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3302318/c3490b9a-0d59-294d-8f85-321b510c1afc.png) |


# アラート閲覧・受信に必要な準備
- アラートの通知を受けるには、表の権限設定が必要です。
- また、ユーザーがアラート通知を受けたいコンポーネントを設定して、登録されているメールアドレス宛にメール通知を受けることができます。(※)


| 権限コンテキスト | 必要な権限 |
|:---|:---|
| テナント | アラートのView権限 <br>![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3302318/b07bf95b-258d-3e5c-5b4c-e4f00c60327c.png) |
| フォルダー | アラートを受けたいコンポーネントのView権限 <br> ![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3302318/e7e150f1-76f3-07cd-1cf0-111969473af9.png) |

:::note warn
(※)アラートをメールで配信するには、Orchestratorのメールメカニズムを有効化し、SMTPサーバを設定する必要があります。
https://docs.uipath.com/orchestrator/lang-ja/docs/setting-up-alert-emails#enabling-alert-emails
https://docs.uipath.com/orchestrator/lang-ja/docs/setting-up-alert-emails#setting-up-the-email
:::

# アラート種類と重要度
### 種類
アラートには、Orchestratorコンポーネントに関する通知が自動的に生成される組み込みアラートと、Studioのアクティビティを使用してOrchestrator経由で配信可能なカスタムアラートがあります。
次の表はOrchestratorの主なコンポーネントと関連するアラートに関する主な例です。これ以外にも、SaaSの発展によりアラート通知が可能なコンポーネントがどんどん追加されています。

| コンポーネント | 概要 | 生成元 | アラート例 |
|:---|:---|:---|:---|
| ロボット | ロボットとOrchestratorの接続状態 | Orchestratorが自動生成 | ・Unattendedロボットが切断されています。 <br> ・Attendedロボットが応答しません。 |
| ジョブ | ジョブの起動・実行状態 | Orchestratorが自動生成 | ・ジョブが失敗しました。 |
| トリガー | トリガー実行状態 | Orchestratorが自動生成 | ・割り当てられたロボットにはこのプロセスの保留中のジョブが既にあるため、トリガージョブを作成できませんでした。 |
| トランザクション | トランザクションアイテムの状態 | Orchestratorが自動生成 | ・キューアイテムがアプリケーション例外で失敗しました。 |
| キュー | キューの状態 <br> キューのSLA違反状態 |  Orchestratorが自動生成 | キューのSLA違反が予測されます。 |
| フォルダー | フォルダーの状態 | Orchestratorが自動生成 | ・フォルダーは復元されました。 |
| 個人用ワークスペース | 個人用ワークスペースの作業、状態 | Orchestratorが自動生成 | ・個人用ワークスペースの有効化に失敗しました。 <br> ・ユーザーがあなたの個人用ワークスペースの探索を開始しました。 |
| プロセス | プロセスのアラート | [[アラートを生成]](https://docs.uipath.com/ja/activities/other/latest/workflow/raise-alert) アクティビティを使ってカスタム生成 | ー |

### 重要度
上述の各コンポーネントについてアラートを生成する際、Orchestratorは事象の重要度によって以下5つのレベルに分けられます。
``重要度の高い順： 
Fatal > Error > Warn > Success > info``


### 参考
各オンプレバージョンとAutomation Cloud (v23.4時点) で、具体的にどのような状況でアラートが生成されるかは以下を参照ください。
(※ プロダクトのサポートが終了している場合、リンク切れとなっている場合があります。)

:::note info
https://docs.uipath.com/ja/orchestrator/standalone/2020.10/user-guide/alerts
https://docs.uipath.com/ja/orchestrator/standalone/2021.10/user-guide/alerts
https://docs.uipath.com/ja/orchestrator/standalone/2022.4/user-guide/alerts
https://docs.uipath.com/ja/orchestrator/standalone/2022.10/user-guide/alerts
https://docs.uipath.com/ja/orchestrator/standalone/2023.4/user-guide/alerts
https://docs.uipath.com/ja/orchestrator/automation-cloud/latest/user-guide/alerts
:::


# アラートのサブスクリプション

### サブスクリプション方法
少々分かりにくい場所にありますが、**Orchestrator画面の[アラートアイコン] > [歯車アイコン]** よりアラートを受信したいコンポーネントを選択できます。これをサブスクリプションといいます。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3302318/19cee5ef-0182-a5a0-9dc2-de543040f1bd.png)


| Orchestrator バージョン | サブスクリプションイメージ |
|:---|:---|
| ~v22.4以前 | ![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3302318/bc4db6c0-1352-edeb-4b72-00a12dfe05e1.png) |
| v22.10以降 / Cloud | ![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3302318/ad05e737-311e-f8ef-9981-5e0d8aa52f14.png) |


### サブスクリプションの違い

アラートは、種類によってサブスクリプションの許可がされているものと、されていないものがあります。
| 分類 | コンポーネント | 通知方法 |
|:---|---|---|
| サブスクリプションができるアラート <br> (つまり、受信するかどうかを自由に選択できます) | ・ロボット <br> ・ジョブ <br> ・トリガー <br> ・トランザクション <br> キュー | ・バナー <br> ・アラートパネル <br> ・アラート詳細ページ <br> ・アラートメール (エラー概要レポート) <br> ・アラートメール（アラート概要レポート) |
| サブスクリプションができないアラート <br> (つまり、「通知方法」列のアラートを受信する際、必ず含まれます) | ・プロセス <br> ・フォルダー <br> ・個人用ワークスペース | ・アラート詳細ページ <br> ・アラートメール (アラート概要レポート) |

:::note info
**メール通知の種類の違い：エラー概要レポートとアラート概要レポート**

- エラー概要レポート：10 分ごとの概要として、ユーザーがアクセス権を持つすべてのフォルダーで 10 分間に発生した Fatal および Error のアラートのみが報告されます。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3302318/00200fbc-7662-975e-c1cd-67b672f6b4db.png)


- アラート概要レポート：日次概要として、テナント内の、ユーザーがアクセス権を持つ全フォルダーで発生したサブスクライブ済みのアラートがすべて報告されます。テナントのタイム ゾーンの午前 10 時に送信されます。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3302318/9c0c1ea6-7362-97d7-7637-d47468071a30.png)

詳細：https://docs.uipath.com/ja/orchestrator/automation-cloud/latest/user-guide/alert-emails
:::


# [Cloud/v22.10～] さらに詳細な設定
v22.10以降のオンプレOrchestratorやCloud版では、アラート機能が以下の点で大きく改善されています。

### 細やかなアラート受信サブスクライブ
Orchestratorのユーザーは、コンポーネントのどんな内容についてアラート通知が欲しいかを設定可能
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3302318/ad05e737-311e-f8ef-9981-5e0d8aa52f14.png)

### 分かりやすくなったアラート通知メール
フォルダー管理者は、フォルダーからアラートを受信するユーザーを制御可能
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3302318/7d4edb33-8cbc-8b3e-7a8a-42b1cba5c49b.png)

### ジョブ実行時の設定
メール通知も、アラートサマリーやエラーサマリーが分かりやすく分類されています
また、エラーサマリーメールでは、[詳細を確認] をクリックすると、Orchestratorの画面に遷移し、アラートが発生しているコンポーネントの確認が可能です
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3302318/c3490b9a-0d59-294d-8f85-321b510c1afc.png)


# おわりに
いかがでしたしょうか？
ロボットやRPAプロセスを束ねる管理センターであるOrchestratorが日々進化していることがUiPathの大きなメリットの一つでもあるので、このような基本機能を理解していただきよりRPAとその管理を楽しんでいただけたら何よりです。