カスタム イベントの追加
Jira uses an event-listener mechanism to alert the system that something has happened, and to perform appropriate action (e.g. send an email notification) based on the event that has occurred. Every work item operation within Jira is associated with a particular event - e.g. the Work Item Created
event is fired when a work item has been created.
Some events are fired by Jira internally — e.g. a Work Item Updated
or Work Item Moved
event. Other events are fired from within workflow transition post functions — e.g. a Work Item Resolved
event, or a custom event (see below).
Jira のイベントには2種類あります。
システム — システム イベントは終始 JIRA 内部で使用され、追加や削除をすることができません。ただし、それらを非アクティブ化することはできます(下記参照)。
カスタム — カスタム イベントは、特定のワークフロー トランジションの事後操作から、メール通知を生成(またはリスナーの呼び出し)するのに使用されます。必要な分だけカスタム イベントを追加、削除することができます。非アクティブなカスタム イベントのみが削除可能ということに注意してください。
イベントは以下のいずれかのステータスになることができます。
アクティブ — イベントが少なくとも1つの通知スキームまたはワークフロー トランジションの事後操作に関連付けられています。
非アクティブ — イベントはいずれの通知スキームまたはワークフロー トランジションの事後操作にも関連付けられていません。
イベントの状態はイベントが発火可能かどうかを示すものではないことに注意してください。カスタム イベントは、アクティブなワークフローのトランジションの事後操作に関連付けられている場合のみ発火します(「ワークフローを管理する」を参照してください)。
システム イベント
In system events, ‘issue’ refers to a work item. What is a work item?
Jira の組み込みイベント
Issue created - A work item has been entered into the system.
Issue updated - A work item has had its details changed.
Issue assigned - A work item has been assigned to a new user.
Issue resolved - A work item has been resolved (usually after being worked on and fixed).
Issue closed - A work item has been closed. (Note that a work item may be closed without being resolved; see statuses).
Issue commented - A work item has had a comment added to it.
Issue comment edited - A work item’s comment has been modified.
Issue reopened - A work item has been re-opened.
Issue deleted - A work item has been deleted.
Issue moved - A work item has been moved into this project.
Work logged on issue - A work item has had hours logged against it (i.e. a worklog has been added).
Work started on issue - The Assignee has started working on a work item.
Work stopped on issue - The Assignee has stopped working on a work item.
Issue worklog updated - An entry in a work item’s worklog has been modified.
Issue worklog deleted - An entry in a work item’s worklog has been deleted.
汎用イベント - このイベントの本質は、このイベントを呼び出すワークフロー トランジションの事後操作によって異なります。カスタム イベントと同様に、汎用イベントによって特定のワークフロー トランジションの事後操作からメール通知を生成 (またはリスナーを呼び出し) できます (「ワークフローで作業する」参照)。
カスタム イベント
カスタム ワークフローのカスタム トランジションの事後操作からカスタム イベントを発火することができます。このイベントの発火によって適切なリスナーがカスタム トランジションのアラートを受けます。例えば、カスタム イベントの発火に基づくワークフロー トランジションのユーザに通知するように関連する通知スキームを設定することができます。
カスタム イベントの通知の設定
Custom events are most commonly used to generate notifications for custom workflow transitions. For example, your organization might need you to modify the default workflow by adding a workflow step called 'QA_Inspection' (e.g. between Resolve work item and Close work item). You would typically also need to generate an email notification to the QA team whenever a work item progresses to the 'QA_Inspection' step of the workflow.
これを実現するために3つの手順があります。
システムにカスタム イベントを追加します (「QA 待ち課題」など)。
カスタム イベントの発生時にメールを送信するように通知スキームを設定します。
カスタム イベントを発生させるようにワークフロー トランジションの事後操作を設定します。
カスタムイベントを追加する
> [システム] の順に選択します。
[詳細] > [イベント] の順に選択します。
ページ下部の新しいイベントの追加フォームに、カスタム イベントの名前と説明を追加します。
テンプレート フィールドで、デフォルトのメール テンプレートを選択し、イベントと関連付けます。
[追加] ボタンを選択します。
カスタム イベントはデフォルトのメール通知テンプレートと関連付ける必要があります。このイベントのユーザに通知するように設定された通知スキームは、通知の送信時にこのメール テンプレートを使用します。
カスタム イベントはシステムで定義されたイベントのリストに表示されます。最初、イベントは通知スキームやワークフローの事後操作と関連付けられていないため、非アクティブとしてマークされます。
メールを送信するように通知スキームを設定する
> [システム] の順に選択します。
[詳細] > [イベント] の順に選択します。
通知スキームの名前または [通知] リンク ([操作] の下) を選択して、編集する通知スキームを選択します。
必要に応じてカスタム イベントの受信者を追加します。詳細については、「通知スキームの作成」を参照してください。
カスタム イベントを発火させるように事後操作を設定する
Select > Work items.
[ワークフロー] > 関連するワークフローの隣にある [編集] の順に選択します。
ワークフロー トランジション > [事後操作] の順に選択します。
完了したら、ワークフローをアクティブ化し、ワークフロー スキームを関連プロジェクトに関連付けます。詳細については、ワークフローを管理するを参照してください。
この内容はお役に立ちましたか?