カスタムイベントを追加する

Jira はイベント リスナー メカニズムを使用して、問題が発生したことをシステムに通知し、発生したイベントにもとづいて適切なアクション (メール通知の送信など) を実行します。Jira 内のすべての課題操作は特定のイベントに関連付けられています (例: 課題が作成されたときに、Issue Created イベントが発生)。特定のイベントの発生が通知されると、リスナーは指定されたアクションを実行します。たとえば、課題が作成されるたびに、MailListener は適切な通知スキームで定義された受信者リストに Issue Created メールを送信します。

一部のイベントは Jira 内部でトリガーされます。 — 例: Issue UpdatedIssue Moved イベント。また、ワークフロー トランジションの事後操作でトリガーされるイベントもあります。 — 例: Issue Resolved イベント、カスタム イベント (下記参照)。

Jira のイベントには2種類あります。

  • システム — システム イベントは終始 Jira 内部で使用され、追加や削除をすることができません。ただし、それらを非アクティブ化することはできます(下記参照)。
  • カスタム — カスタム イベントは、特定のワークフロー トランジションの後処理から、メール通知を生成(またはリスナーの呼び出し)するのに使用されます。必要な分だけカスタム イベントを追加、削除することができます。非アクティブなカスタム イベントのみが削除可能ということに注意してください。

イベントは以下のいずれかのステータスになることができます。

  • アクティブ — イベントが少なくとも1つの通知スキームまたはワークフロー トランジションの後処理に関連付けられています。
  • 非アクティブ — イベントはいずれの通知スキームまたはワークフロー トランジションの後処理にも関連付けられていません。
    イベントの状態はイベントが発火可能かどうかを示すものではないことに注意してください。カスタム イベントは、アクティブなワークフローのトランジションの後処理に関連付けられている場合のみ発火します(「ワークフローを管理する」を参照してください)。

システム イベント

Jira の組み込みイベント

課題が作成されました

課題がプロジェクトに作られました。

課題が更新されました

課題の詳細が変更されました。

課題が割り当てられました

課題が新しいユーザに割り当てられました。

課題が解決しました

課題が解決されました(通常、取り組みと修正が終わった後)。

課題が終了しました

課題は終了しました。(課題は解決前に終了する場合がありますので注意してください。「ステータス」を参照してください)。

課題にコメントが付けられました

課題にコメントが追加されました。

課題のコメントが編集されました

課題のコメントが編集されました。

課題が再開されました

課題が再開されました。

課題が削除されました

課題が削除されました。

課題が異動されました

課題がこのプロジェクトに移動されました。

課題に作業が記録されました

課題にログインした時間がありました(すなわち作業ログが追加されました)。

課題で作業を開始しました

担当者が課題で作業を開始しました。

課題で作業が停止されました

担当者が課題で作業を停止しました。

課題の作業ログが更新されました

課題の作業ログのエントリが編集されました。

課題の作業ログが削除されました

課題の作業ログのエントリが削除されました。

汎用イベント

このイベントの正確な性質は、このイベントを呼び出すワークフロー トランジションの後処理に依存します。カスタム イベントと同様に、特定のワークフロー トランジションの後処理からメール通知を生成(またはリスナーの呼び出し)するのに汎用イベントを使用することができます(「ワークフローで作業する」を参照してください)。

カスタム イベント

カスタム ワークフローのカスタム トランジションの後処理からカスタム イベントを発火することができます。このイベントの発火によって適切なリスナーがカスタム トランジションのアラートを受けます。例えば、カスタム イベントの発火に基づくワークフロー トランジションのユーザに通知するように関連する通知スキームを設定することができます。

カスタム イベントの通知の設定

カスタム イベントは通常、カスタム ワークフロー トランジションの通知の生成に使用されます。例えば、自分の組織が「QA_検証」というワークフロー ステップを追加するようにデフォルト ワークフローの変更を必要とするとします(例:課題の解決課題のクローズの間)。また、通常、課題がワークフローの「QA_検証」ステップに進むたびにQA_検証チームへのメール通知を生成する必要があります。

これを実現するために3つの手順があります。

  1. システムにカスタム イベントを追加します(例:「QA待ち課題」)。
  2. カスタム イベントが発火した時にメールを送信するように通知スキームを設定します。
  3. カスタム イベントを発火させるようにワークフロー トランジション の後処理を設定します。

カスタムイベントを追加する

  1. Jira 管理者グローバル権限を持つユーザーとしてログインします。
  2. > [システム] を選択します。[詳細] > [イベント] を選択し、イベントの表示ページを表示します。
  3. ページ下部の新しいイベントの追加フォームに、カスタム イベントの名前と説明を追加します。
  4. テンプレート フィールドで、デフォルトのメール テンプレートを選択し、イベントと関連付けます。
  5. 追加ボタンをクリックします。

カスタム イベントはデフォルトのメール通知テンプレートと関連付ける必要があります。このイベントのユーザに通知するように設定された通知スキームは、通知の送信時にこのメール テンプレートを使用します。

カスタム イベントはシステムで定義されたイベントのリストに表示されます。最初、イベントは通知スキームやワークフローの後処理と関連付けられていないため、非アクティブとしてマークされます。

メールを送信するように通知スキームを設定する

  1. Jira 管理者グローバル権限を持つユーザーとしてログインします。
  2. > [システム] を選択します。[詳細] > [イベント] を選択し、イベントの表示ページを表示します。
  3. 通知スキームの名前か通知リンク(操作の下)をクリックして、編集する通知スキームを選択します。
  4. 必要に応じてカスタム イベントの受信者を追加します。詳細については、「通知スキームの作成」を参照してください。

カスタム イベントを発火させるように後処理を設定する

  1. Jira 管理者グローバル権限を持つユーザーとしてログインします。
  2. > [課題] を選択します。[ワークフロー] を選択し、システム内のすべてのワークフローを表示する [ワークフロー] ページを開きます。
  3. 編集するワークフロー トランジションの後処理画面に移動します。詳細については、「ワークフローで作業する」と高度なワークフローの設定」を参照してください。
  4. カスタム イベントを発火させるように後処理を更新します。
  5. ワークフロー(およびスキーム)をアクティブ化または適切なプロジェクトに関連付けます。詳細については、「ワークフローを管理する」を参照してください。
最終更新日: 2018 年 9 月 15 日

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

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