カスタム イベントの追加

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

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

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

  • システム — システム イベントは終始 Jira 内部で使用され、追加や削除をすることができません。ただし、それらを非アクティブ化することはできます(下記参照)。

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

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

  • アクティブ — イベントが少なくとも1つの通知スキームまたはワークフロー トランジションの事後操作に関連付けられています。

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

システム イベント

Jira の組み込みイベント

課題が作成されました - 課題がシステムに入力されました。

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

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

課題が解決されました - 課題が解決されました (通常は作業と修正が終わった後)。

課題がクローズされました - 課題がクローズされました (課題は未解決のままクローズされる場合があることにご注意ください。「ステータス」参照)。

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

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

課題が再オープンされました - 課題が再度オープンされました。

課題が削除されました - 課題が削除されました。

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

課題の作業がログに記録されました - 課題に対する時間がログに記録されました (つまり作業ログが追加されました)。

課題の作業が開始されました - 担当者が課題の作業を開始しました。

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

課題の作業ログが更新されました - 課題の作業ログのエントリが変更されました。

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

汎用イベント - このイベントの本質は、このイベントを呼び出すワークフロー トランジションの事後操作によって異なります。カスタム イベントと同様に、汎用イベントによって特定のワークフロー トランジションの事後操作からメール通知を生成 (またはリスナーを呼び出し) できます (「ワークフローで作業する」参照)。

カスタム イベント

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

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

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

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

  1. システムにカスタム イベントを追加します (「QA 待ち課題」など)。

  2. カスタム イベントの発生時にメールを送信するように通知スキームを設定します。

  3. カスタム イベントを発生させるようにワークフロー トランジションの事後操作を設定します。

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

  1. [] > [システム] の順に選択します。

  2. [詳細] > [イベント] の順に選択します。 

  3. ページ下部の新しいイベントの追加フォームに、カスタム イベントの名前と説明を追加します。

  4. テンプレート フィールドで、デフォルトのメール テンプレートを選択し、イベントと関連付けます。

  5. [追加] ボタンを選択します。

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

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

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

  1. [] > [システム] の順に選択します。

  2. [詳細] > [イベント] の順に選択します。 

  3. 通知スキームの名前または [通知] リンク ([操作] の下) を選択して、編集する通知スキームを選択します。

  4. 必要に応じてカスタム イベントの受信者を追加します。詳細については「通知スキームの作成」をご参照ください。

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

  1. [課題] を選択します。

  2. [ワークフロー] > 関連するワークフローの隣にある [編集] の順に選択します。

  3. ワークフロー トランジション > [事後操作] の順に選択します。

  4. 完了したら、ワークフローをアクティブ化して、ワークフロー スキームを関連プロジェクトに関連付けます。詳細については「ワークフローの管理」をご確認ください。

その他のヘルプ