Configuring Insight automation rules

このページの内容

お困りですか?

アトラシアン コミュニティをご利用ください。

コミュニティに質問

You can create automation rules that automatically perform actions (for example, notify users) based on specific events (for example, object updated) for all objects, or only a group of objects in a schema.

はじめる前に

適切な権限があることをご確認ください。

  • 自動化ルールを設定するには、少なくともスキーマに対する Insight Manager ロールが必要です。
  • Tu run and execute automation rules, the user (either the logged-in user or the user that you select for running scheduled events) needs to have at least the Insight users role for the schema. If this user has a different role for the object types affected by the rule (object type's permissions take precedence over schema's permissions), then also grant them the Insight users role for these object types. This is only needed if a rule affects such object types, otherwise permissions are inherited from the schema.

権限の詳細については「ロールと権限の設定」をご参照ください。

ルールを作成する

  1. スキーマを開いて [オブジェクト スキーマ] > [設定] の順に選択します。
  2. [Automation] タブに切り替えます。
  3. ルールを作成します。
  4. ルールの名前と説明を入力します。
  5. それぞれのボックス (WHEN、IF、THEN) を選択します。右側に表示されるパネルで、イベント、条件、アクションを追加できます。詳細については次をお読みください。

ルールへの変更は、[保存] を選択すると保存されます。誤って何かを削除した場合は、[キャンセル] を選択してこれらの変更を元に戻せます。

ルールを設定する

Configure your rule by specifying events (WHEN), conditions (IF), and actions (THEN).

1. イベントを追加する (WHEN)

  1. [WHEN] ボックスを選択します。
  2. 右側で [イベントを追加] を選択します。
  3. 目的のイベント > [追加] の順に選択します。
tip/resting Created with Sketch.

考慮事項

  • You can add up to five events for a single rule.
  • 同じアクション (メール通知など) を持つ複数のルールを作成するのではなく、同じルールにさらに複数のイベントを追加します。そうすると後でメンテナンスが容易になります。

イベント タイプ

eventType説明
ユーザー イベントMost events, except the Scheduled event are triggered when a logged-in user performs an action on an object (object updated, attachment added, etc.) These events don't require any additional configuration.
スケジュール済みのイベント

スケジュール済みのイベントは、ユーザーが実行したアクションによってトリガーされることはありません。こうしたイベントは、指定された cron 式 (1 日に 1 回、1 時間に 1 回など) と条件に従って実行されます。 

スケジュール済みのイベントに必要なパラメーター...

スケジュール済みのイベントには、次のパラメーターが必要です。

  1. 条件: IQL (Insight クエリ言語) 式です。スケジュール済みのルールがアクティブ化されると、条件に一致するすべてのオブジェクトが個々のアクションをトリガーします。
  2. Cron 式: 指定した条件が Insight オブジェクトとのマッチングを試みる日時と頻度を決定します。初期設定では、この式は「0 0 12 1/1 * ? *」、つまり 1 日 1 回、正午に設定されています。cron 式の詳細についてご確認ください。
  3. Triggered rule will run as: You need to select a specific user here because scheduled events can’t be triggered by a logged-in user. You can select the user on the top-right of the page.

2. 条件を追加する (IF)

You can add a condition if you don't want the configured action to apply to all objects in your schema, but rather a specific set of objects. 

  1. [IF] ボックスを選択します。
  2. 右側で [条件を追加] を選択します。
  3. IQL ステートメントを入力して [追加] を選択します。
tip/resting Created with Sketch.

考慮事項

  • A condition (IF) always needs a THEN box. When you add another condition, you'll be able to edit its actions.
  • You can configure up to three IF/THEN pairs.

  • A rule is triggered by an object updated event.
  • The rule has a condition: "name = Windows server".
  • The rule has an email notification action.

The rule configuration in this example means that if a user updates an object whose exact name is “Windows server”, an email notification is automatically sent. 

3. アクションを追加する (THEN)

  1. [THEN] ボックスを選択します。
  2. 右側で [アクションを追加] を選択します。
  3. Select your action and fill in the details. Every action requires different information. For example, details needed for Create a Jira issue will differ from those needed to Execute a Groovy script.
  4. 追加 を選択します。
tip/resting Created with Sketch.

考慮事項

  • You can have up to five actions for every THEN box.

利用可能なアクション

次は、選択できるアクションのリストです。

属性値

This action allows the rule to change the value of an object's attribute.

Set an attribute value of the Insight object affected by the event. Multiple values are separated by a comma (,).

フィールドSingle value exampleMultiple values example
属性名ステータスサーバー
STOPPEDサーバー 1、サーバー 2
Jira 課題を作成

このアクションによって、ルールは Jira 課題を作成できます。

tip/resting Created with Sketch.

考慮事項

  • (warning) 選択した課題タイプは、選択したプロジェクトで利用可能である必要があります。利用できない場合は Jira 課題を作成できません。
  • (info) カスタム フィールドが入力されている場合、選択したプロジェクトはこのオブジェクト タイプを処理するように設定する必要があります。設定しないと、このフィールドは無効になります。


プレースホルダーをサポートするフィールドSyntax exampleResult example
要約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 
メール通知

このアクションによって、ルールはトリガーされたイベントに関連するメール通知を送信できます。

Example: For the object updated event, an email will be sent showing the changes related to this object.

プレースホルダーをサポートするフィールド構文の例結果例
サマリ概要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 スクリプトを実行できます。

ルール エンジンが Groovy スクリプトで利用できるデータ

パラメーター説明JAVA クラス
オブジェクト

The object that was directly involved in a user action (like updating an Insight object) or matched by a scheduled rule through IQL, with an "Execute Groovy Script" as an action

object that was directly involved in a user action (for example, updating an object) or matched by a scheduled rule through IQL, with an "Execute Groovy Script" action.

com.riadalabs.Jira.plugins.insight.services.model.ObjectBean
現在のユーザー

The user who triggered the rule or a specific user chosen to run the rule.

com.atlassian.Jira.user.ApplicationUser
log

An instance of the Apache Log interface, for convenient logging in a script.

org.apache.commons.logging.Log
objectUpdateList

A list of object attributes that are affected in an object update event that includes an affected attribute in an object, as well as values added or removed for it.

List<com.riadalabs.jira.plugins.insight.services.model.ObjectUpdateBean>
HTTP リクエスト

This action allows a triggered rule to make an HTTP request. It supports the standard HTTP methods: GET / POST / PUT / DELETE.

プレースホルダーをサポートするフィールドSyntax exampleResult example
URLhttp://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. 条件とアクションをさらに追加する

A rule can only consist of one event (WHEN), but it can have up to three pairs of conditions and actions (IF/THEN). This allows you to add more conditions and actions, if the first ones aren't matched.

  1. ELSE IF/THEN ボックスを選択します。
  2. 必要に応じて、アクションと条件を追加します。
  3. 保存 を選択します。

その他の自動化

自動化ルールは特定のオブジェクト スキームに関連していますが、追加できる自動化は他にもあります。Jira 管理者は、条件、バリデーター、事後操作を Jira ワークフローに追加して、ワークフローのトランジション中に課題がオブジェクトに影響を与えるようにできます。詳細については「Insight 機能を Jira のワークフローに追加する」をご参照ください。

最終更新日 2022 年 8 月 29 日

この内容はお役に立ちましたか?

はい
いいえ
この記事についてのフィードバックを送信する
Powered by Confluence and Scroll Viewport.