Insight の自動化ルールの設定
すべてのオブジェクト、またはスキーマにあるオブジェクトのグループに対する特定のイベント (オブジェクトの更新など) に基づいて、アクション (ユーザーへの通知など) を自動で実行する自動化ルールを作成できます。
はじめる前に
適切な権限があることをご確認ください。
- 自動化ルールを設定するには、少なくともスキーマに対する Insight Manager ロールが必要です。
- 自動化ルールを実行するには、ユーザー (ログイン ユーザーまたはスケジュールされたイベントの実行用に選択したユーザー) が、少なくともスキーマに対する Insight ユーザー ロールを付与されている必要があります。このユーザーが、ルールの影響を受けるオブジェクト タイプに対して異なるロールを持っている場合は (オブジェクト タイプの権限はスキーマの権限よりも優先されます)、これらのオブジェクト タイプに対する Insight ユーザー ロールも付与する必要があります。これは、ルールがそのようなオブジェクト タイプに影響する場合にのみ必要です。影響しない場合、権限はスキーマから継承されます。
権限の詳細については「ロールと権限の設定」をご参照ください。
ルールを作成する
- スキーマを開いて [オブジェクト スキーマ] > [設定] の順に選択します。
- [Automation] タブに切り替えます。
- ルールを作成します。
- ルールの名前と説明を入力します。
- それぞれのボックス (WHEN、IF、THEN) を選択します。右側に表示されるパネルで、イベント、条件、アクションを追加できます。詳細については次をお読みください。
ルールへの変更は、[保存] を選択すると保存されます。誤って何かを削除した場合は、[キャンセル] を選択してこれらの変更を元に戻せます。
ルールを設定する
イベント (WHEN)、条件 (IF)、アクション (THEN) を指定して、ルールを設定します。
1. イベントを追加する (WHEN)
- [WHEN] ボックスを選択します。
- 右側で [イベントを追加] を選択します。
- 目的のイベント > [追加] の順に選択します。
考慮事項
- 1 つのルールに最大 5 つのイベントを追加できます。
- 同じアクション (メール通知など) を持つ複数のルールを作成するのではなく、同じルールにさらに複数のイベントを追加します。そうすると後でメンテナンスが容易になります。
イベント タイプ
| eventType | 説明 |
|---|---|
| ユーザー イベント | スケジュール済みのイベントを除くほとんどのイベントは、ログイン ユーザーがオブジェクトに対してアクション (オブジェクトの更新、添付ファイルの追加など) を実行した際にトリガーされます。これらのイベントには追加設定が不要です。 |
| スケジュール済みのイベント | スケジュール済みのイベントは、ユーザーが実行したアクションによってトリガーされることはありません。こうしたイベントは、指定された cron 式 (1 日に 1 回、1 時間に 1 回など) と条件に従って実行されます。 |
2. 条件を追加する (IF)
構成したアクションをスキーマ内のすべてのオブジェクトに適用するのではなく、特定のオブジェクト セットに適用する場合、条件を追加できます。
- [IF] ボックスを選択します。
- 右側で [条件を追加] を選択します。
- IQL ステートメントを入力して [追加] を選択します。
考慮事項
- 条件 (IF) には常に THEN ボックスが必要です。別の条件を追加すると、そのアクションを編集できるようになります。
- 最大で 3 つの IF/THEN ペアを設定できます。
例
- オブジェクトの更新イベントによってルールがトリガーされる。
- ルールに条件「name = Windows server」がある。
- ルールにメール通知アクションがある。
この例のルール設定では、正確な名前が「Windows server」であるオブジェクトをユーザーが更新すると、メール通知が自動的に送信されます。
3. アクションを追加する (THEN)
- [THEN] ボックスを選択します。
- 右側で [アクションを追加] を選択します。
- アクションを選択して詳細を入力します。アクションごとに異なる情報が必要です。たとえば、「Jira 課題を作成」アクションに必要な詳細情報と、「Groovy スクリプトを実行」アクションに必要な詳細情報は異なります。
- 追加 を選択します。
考慮事項
- 1 つの THEN ボックスで最大 5 つのアクションを実行できます。
利用可能なアクション
次は、選択できるアクションのリストです。
このアクションによって、ルールは Jira 課題を作成できます。
考慮事項
選択した課題タイプは、選択したプロジェクトで利用可能である必要があります。利用できない場合は Jira 課題を作成できません。
カスタム フィールドが入力されている場合、選択したプロジェクトはこのオブジェクト タイプを処理するように設定する必要があります。設定しないと、このフィールドは無効になります。
| プレースホルダーをサポートするフィールド | 構文の例 | 結果の例 |
|---|---|---|
| 要約 | Server ${label} stopped! | Server ${exchange.prod.main1}stopped! |
| 説明 | Server details - name: ${label}, key: ${Key}, id: ${objectId} | Server details - name: exchange.prod.main1,key: WS-5969, id: 17400 |
このアクションによって、ルールはトリガーされたイベントに関連するメール通知を送信できます。
例: オブジェクト更新イベントの場合は、このオブジェクトに関連する変更を示すメールが送信されます。
[属性別の受信者] オプションでは、ルールの条件で [メール]、[ユーザー]、または [グループ] タイプの属性を持つオブジェクト タイプを選択する必要があります。
| プレースホルダーをサポートするフィールド | 構文の例 | 結果例 |
|---|---|---|
| サマリ概要 | Server: ${label} is stopped. | Server: exchange.prod.main1 is stopped. |
| メッセージ | Server: ${label} (${Key}) has status: ${Status}. | Server: exchange.prod.main1 (WS-5969) has status: Stopped. |
Groovy スクリプトには適切な権限が必要です。また、実行するにはホワイトリストに登録する必要があります。Groovy スクリプトをホワイトリストに追加する方法をご確認ください。
このアクションによって、トリガーされたルールは Groovy スクリプトを実行できます。
ルール エンジンが Groovy スクリプトで利用できるデータ
| パラメーター | 説明 | JAVA クラス |
|---|---|---|
| オブジェクト | ユーザー アクション (Insight オブジェクトの更新など) に直接関与した、または IQL を介してスケジュール済みのルールと一致した、アクションとして「Groovy スクリプトを実行する」を持つオブジェクト ユーザー アクションに直接関与した (オブジェクトの更新など)、または IQL を介してスケジュール済みのルールと一致した、「Groovy スクリプトを実行する」を持つオブジェクト。 | com.riadalabs.Jira.plugins.insight.services.model.ObjectBean |
| 現在のユーザー | ルールをトリガーしたユーザー、または「ルールを実行」するために選択した特定のユーザー。 | com.atlassian.Jira.user.ApplicationUser |
| log | Apache Log インターフェイスのインスタンス。スクリプトの簡単なロギング用。 | org.apache.commons.logging.Log |
| objectUpdateList | オブジェクトの影響を受ける属性と、そのオブジェクトに対して追加または削除された値を含む、オブジェクト更新イベントで影響を受けるオブジェクト属性のリスト。 | List<com.riadalabs.jira.plugins.insight.services.model.ObjectUpdateBean> |
このアクションによって、トリガーされたルールは HTTP リクエストを行えます。標準の HTTP メソッド、GET/POST/PUT/DELETE をサポートしています。
| プレースホルダーをサポートするフィールド | 構文の例 | 結果の例 |
|---|---|---|
| Url | http://company/service?id=${objectId}&name=${label} | http://company/service?id=1405&name=exchange.prod.main1 |
| データの POST (POST/PUT) | { "name":"${label}","key":"${Key}","id":"${objectId}" } | { name:exchange.prod.main1,key:WS-76100,id:76100} |
4. 条件とアクションをさらに追加する
ルールは 1 つのイベント (WHEN) のみで構成できますが、最大 3 つの条件とアクション (IF/THEN) のペアを含められます。これによって、最初の条件とアクションが一致しない場合に、さらに条件とアクションを追加できます。
- ELSE IF/THEN ボックスを選択します。
- 必要に応じて、アクションと条件を追加します。
- 保存 を選択します。
その他の自動化
自動化ルールは特定のオブジェクト スキームに関連していますが、追加できる自動化は他にもあります。Jira 管理者は、条件、バリデーター、事後操作を Jira ワークフローに追加して、ワークフローのトランジション中に課題がオブジェクトに影響を与えるようにできます。詳細については「Insight 機能を Jira のワークフローに追加する」をご参照ください。