Documentation for JIRA 5.0. Documentation for other versions of JIRA is available too.

Overview of JIRA Events

JIRA uses an event-listener mechanism to alert the system that something has happened, and to peform appropriate action (e.g. send an email notification) based on the event that has occurred. Every issue operation within JIRA is associated with a particular event - e.g. the Issue Created event is fired when an issue has been created.

A Listener can execute a specified action once it has been notified that a particular event has been fired. For example, the MailListener can send an Issue Created email to a list of recipients defined in the appropriate Notification Scheme, whenever an issue is created.

Some events are fired by JIRA internally — e.g. an Issue Updated or Issue Moved event. Other events are fired from within workflow transition post-functions — e.g. an Issue Resolved event, or a Custom Event (see below).

イベント タイプ

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

  • システム — システム イベントは終始 JIRA 内部で使用され、追加や削除をすることができません。ただし、それらを非アクティブ化することはできます(下記参照)。
  • Custom — Custom events are used to generate an email notification (or invoke a listener) from a particular workflow transition's post-function. You can add/delete as many custom events as you need. Note that only inactive custom events can be deleted.

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

  • Active — the event is associated with at least one notification scheme or workflow transition post-function.
  • Inactive — the event is not associated with any notification schemes or workflow transition post-functions.
    Note that the event state does not indicate whether the event is able to be fired. A custom event will only be fired if it is associated with a transition post-function for an active workflow (see Activating Workflow).

On this page:

System Events

JIRA の組み込みイベント

Issue Created:

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

Issue Updated:

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

Issue Assigned:

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

Issue Resolved:

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

Issue Closed:

An issue has been closed. (Note that an issue may be closed without being resolved; see Statuses ).

Issue Commented:

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

Issue Comment Edited:

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

Issue Reopened:

課題が再開されました。

Issue Deleted:

課題が削除されました。

Issue Moved:

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

Work Logged On Issue:

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

Work Started On Issue:

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

Work Stopped On Issue:

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

Issue Worklog Updated:

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

Issue Worklog Deleted:

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

Generic Event:

The exact nature of this event depends on the workflow transition post-function(s) which invoke it. As with Custom Events, you can use the Generic Event to generate an email notification (or invoke a listener) from a particular workflow transition's post-function (see Workflow and Notifications ).

Custom Events

You can fire a custom event from a custom transition post-function in a custom workflow. The appropriate listeners will be alerted of the custom transition by the firing of this event. For example, the associated notification scheme can be configured to notify users of the workflow transition based on the firing of this custom event.

Configuring Notifications for a Custom Event

Custom events are most commonly used to generate notifications for custom workflow transitions. For example, your organisation might need you to modify the default workflow by adding a workflow step called 'QA_Inspection' (e.g. between Resolve Issue and Close Issue). You would typically also need to generate an email notification to the QA team whenever an issue progresses to the 'QA_Inspection' step of the workflow.

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

  1. Add a custom event to the system (e.g. 'Issue Awaiting QA').
  2. Configure the notification scheme to send an email when the custom event is fired.
  3. Configure the workflow transition post-function to fire the custom event.

Step 1. Add a Custom Event

  1. JIRA 管理者」 グローバル権限 を持つユーザーとしてログインします
  2. Select Administration > System > Advanced > Events to open the View Events page.
    (tick) Keyboard shortcut: g + g + start typing events
  3. In the Add New Event form at the bottom of the page, add a Name and Description for the custom event by specifying them in these fields.
  4. In the Template field, select the default email template to be associated with the event.
  5. 追加ボタンをクリックします。

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

The custom event will appear in the list of events defined within the system. Initially, the event will be marked as inactive as it is not associated with a notification scheme or workflow post-function.

Step 2. Configure Notification Scheme to send mail on Custom Event

  1. In 'Administration' mode, select Issues > Notifications Schemes to open the Notification Schemes page. (info) You still need to be logged in as a user with the JIRA Administrators global permission to do this.
    (tick) Keyboard shortcut: g + g + start typing notification schemes
  2. Select the notification scheme to edit, by clicking the notification scheme's name or its Notifications link (under Operations).
  3. Add the recipients for the custom event as required. See Creating a Notification Scheme for more information.

Step 3. Configure Workflow Transition Post-Function to Fire Custom Event

  1. In 'Administration' mode, select Issues > Workflows to open the Workflows page. (info) You still need to be logged in as a user with the JIRA Administrators global permission to do this.
    (tick) Keyboard shortcut: g + g + start typing workflows
  2. Navigate to workflow transition post-function screen to be edited. See Configuring Workflow and Applying Post Functions to Transitions for more information.
  3. Update the post-function to fire the custom event.
  4. Activate or associate the workflow (and scheme) with the appropriate project. See Activating Workflow for more information.