Configure advanced work item workflows

Jira 管理者は、ワークフロー トランジションの次の側面を制御できます。

• Triggers – transition Jira work items when certain events occur in a connected development tool, such as Bitbucket.

• 条件 – トランジションがユーザーによって実行されるべきかどうかを検査します。

• バリデーター – トランジションが実行される前にトランジションに対する入力 (ユーザーによる入力など) が有効かどうかを検査します。

• 事後操作 – トランジションの実行後に追加処理を実行します。

• プロパティ – キー値のペアで、トランジションをさらにカスタマイズするために使用できます。

• トランジションの表示方法

• グローバルトランジション

トリガー

Jira administrators can configure triggers in Jira workflows that respond to events in your linked development tools. This allows you to set up your development tools and Jira workflows so that, for example, when a developer creates a branch to start work on a work item in Bitbucket, the work item will automatically be transitioned from 'Open' to 'In progress'.

トリガーの設定

トランジションのトリガーの表示または設定や、トランジションを含むワークフローの編集を行うには、トランジションを選択してから、トランジションのプロパティパネルでトリガーをクリックします。

トリガーをトランジションに追加する方法

1. Select > Work items.

2. [ワークフロー] をクリックしてから、関連するワークフローの [編集] をクリックします。

3. ダイアグラム モードでは、トランジションの矢印を選択します。テキスト モードでは、[トランジション (id)] 列からトランジションの名前を選択します。

4. ダイアグラム モードでは、プロパティ パネルで [トリガー] をクリックして、対象のトランジション用に構成されているトリガーを表示します。テキスト モードでは、[トリガー] タブを選択します。

5. [トリガー] タブで [トリガーを追加] をクリックして、トリガーを設定します。

詳細については、ワークフローのトリガーの設定をチェックしてください。

条件

条件は、トランジションがユーザーによって実行されるべきかどうかを制御します。たとえば、次のように条件を使用できます。

• 報告者にのみトランジションの実行を許可する

• 特定の権限を持つユーザにのみトランジションの実行が許可されている

• allow execution only if code has, or has not, been committed against this work item.

If a condition fails, the user will not see the transition button on the 'View work item' page, and so will not be able to execute the transition.

条件はトランジション画面でユーザーから収集した入力パラメーターを検証できません。これを実行するには、バリデーターを使用する必要があります。

任意の条件

Jira には、トランジションに追加可能な任意の条件がいくつかあります。

条件の追加

トランジションに条件を追加して、トランジションを含むワークフローを編集するには、トランジションを選択してから、トランジションのプロパティパネルで条件をクリックします。

条件をトランジションに追加する方法

1. Select > Work items.

2. [ワークフロー] を選択します。

3. [その他] () > 関連ワークフローの横にある [編集] の順に選択します。

4. ダイアグラム モードでは、トランジションの矢印を選択します。テキスト モードでは、トランジションの名前を [トランジション (id)] 列から選択します。

5. ダイアグラム モードでは、プロパティ パネルで [条件] をクリックして、対象のトランジションの構成済みトリガーを表示します。テキスト モードでは、[条件] タブを選択します。

[条件を追加] をクリックすると、使用可能な条件から条件を選択して、その条件に必要なパラメーターを設定できます。追加の条件はインストール済みのプラグインから利用できる場合があります。または、プラグイン システムを使用して独自の条件を作成できます。詳細については、「ワークフロー プラグイン モジュール」を参照してください。

条件のグループ化

条件をグループ化し、入れ子にすることで、複雑な条件を作成できます。どのような条件でも、その条件の「グループ化された条件を追加」アイコンをクリックすることによってグループ化できます。これで、上記で説明した新しいグループにさらに条件を追加できます。

グループの条件の適用方法のロジックを、[すべて] または [いずれか] を選択して切り替えることができます。

バリデーター

バリデーターは、トランジションの実行前に、トランジションへの入力が有効であることを確認します。入力には、トランジション画面でユーザーから収集した入力が含まれます。 

If a validator fails, the work item does not progress to the destination status of the transition, and the transition's post functions are not executed. 

バリデーターの追加

トランジションにバリデーターを追加するには、トランジションが含まれるワークフローを編集して、トランジションを選択したあと、トランジションのプロパティ パネルで バリデーター をクリックします

トランジションにバリデーターを追加する方法

1. Select > Work items.

2. [ワークフロー] をクリックしてから、関連するワークフローの [編集] をクリックします。

3. ダイアグラム モードでは、トランジションの矢印を選択します。テキスト モードでは、トランジションの名前を [トランジション (id)] 列から選択します。

4. ダイアグラム モードでは、プロパティ パネルで [バリデーター] をクリックして、対象のトランジションの構成済みトリガーを表示します。テキスト モードでは、[バリデーター] タブを選択します。

[バリデーターの追加] をクリックすると、利用可能なバリデーターを選択してバリデーターに必要なパラメーターを設定できます。

事後操作

事後操作では、トランジション実行後に必要となる、以下のような追加の処理を実行します。

• updating fields in a work item

• generating change history for a work item

• adding a comment to a work item

• メール通知をトリガーするイベントの生成

基本的な事後操作

すべての Jira のトランジションで、次のような基本的な事後操作があり、この順番で実行されます。

1. Set the status of a work item to the linked status of the destination workflow status.

2. Add a comment to a work item if one is entered during a transition.

3. Update change history for a work item and store the work item in the database.

4. Re-index a work item to keep indexes in sync with the database.

5. リスナーが処理できる汎用イベントを発生させます。 

    この事後操作を編集または削除しないでください。この重要な事後操作を変更すると、自動化や Marketplace アドオンで意図しない動作が発生します。トランジションで発生する事後操作イベントをカスタマイズする場合は、カスタム事後操作を追加して既定イベントはそのままにすることを検討します。

これらの基本的な事後操作をトランジションから削除したり、並べ替えたりすることはできません。ただし、他の事後操作を間に挿入することはできます。

イベントを発生させる事後操作が、期待と異なる動作をする場合があります。Jira では、事後操作のシーケンスが終了するまで、通知リスナーの呼び出しを行いません。そのため、イベントは期待した順序で発生しますが、通知はトランジションの終了までトリガーされません。

オプションの事後操作

Jira には、トランジションに追加可能な事後操作がいくつか含まれています。

追加の事後操作はインストール済みのプラグインから利用できる場合もあります。または、プラグイン システムを使用して独自の事後操作を作成できます。詳細については、「ワークフロー プラグイン モジュール」を参照してください。

事後操作の追加

トランジションに事後操作を追加するには、対象のトランジションが含まれるワークフローを編集し、そのトランジションを選択してから、トランジションのプロパティ パネルで [事後操作] をクリックします。

トランジションに事後操作を追加する方法

1. Select > Work items.

2. [ワークフロー] をクリックしてから、関連するワークフローの [編集] をクリックします。

3. トランジションを選択します。

   • ダイアグラム モードでは、トランジションの矢印を選択します。

   • テキスト モードでは、トランジションの名前を [トランジション (id)] 列から選択します。

4. 事後操作タブを開きます。

   • ダイアグラム モードでは、プロパティ パネルで [事後操作] をクリックして、対象のトランジションの構成済みトリガーを表示します。

   • テキスト モードでは、[事後操作] タブを選択します。

5. [事後操作の追加] をクリックします。

6. 事後操作を追加し、[下書きの公開] を選択して変更を完了します。

[事後操作の追加] をクリックすると、利用可能な事後操作から事後操作を選択して必要なパラメーターを設定できます。事後操作の編集や削除を行ったり、実行順序を変更したりするオプションは、タブの右側にあります (カーソルを合わせると表示されます)。

最初のトランジションでの事後操作の使用

You can add post functions to a workflow's initial transition when you need to perform processing tasks – such as setting a particular field's value – when a work item is created. The initial transition is called 'Create' (if you created a blank workflow) or 'Create work item' (if you copied the system workflow).

Jira には、ワークフローの最初のトランジションを指定し、この順番で処理される以下の基本的な事後操作が含まれます。

1. Create the work item.

2. リスナーが処理できるイベントを発生させます。

以下のオプション事後操作は、最初のトランジション用に特別に用意されています。

Additionally, the standard optional post functions can also be added to an initial transition. Optional post functions added to the Create transition must be placed before the 'Create the work item originally' post function.

必要に応じ、ワークフローの最初のステータスを変更して、別の初回トランジションに設定できます。詳細は、「最初のステータスの構成」を参照してください。

事後操作によるフィールド設定

You can use the ‘Update Work Item Field' post function to set the value of a work item’s field after a particular transition is executed.

For example, you might want a transition that moves the work item to a closed status to automatically set the 'Resolution' field.

例：事後操作による解決状況フィールド設定

1. トランジションを持つワークフローを編集して、ステータスを他のステータスにドラッグし、新しいトランジションを作成します。

2. [なし] または、[解決状況] フィールドを含まない画面を選択します。

3. Add a new "Update Work Item Field" post function and select a resolution from the Work Item Field and Field Value lists.

To create a transition that clears the Resolution field, follow the same steps above for adding an 'Update Work Item Field' post function to your transition. However, select None from the Field Value list.

このトランジションの事後操作一覧には、次のステートメントが含まれます。

• The Resolution of the work item will be cleared.

Each time one of these transitions is executed, the Resolution of the work item is automatically set or cleared, as specified in these post functions.

事後操作によるメール通知の送信

"Fire an event that can be processed by the listeners"事後操作を使用して、組み込みの Jira イベントである "Generic Event" を発生させます。このイベントは特定のトランジションが実行された後にメール通知の送信をトリガーするために使用できます。

または、このトランジション用に作成したカスタム イベントを発生させることもできます。

トランジションが実行されると、Jira は以下の動作を行います。

• Look up the notification scheme associated with the work item’s project and identify the users associated with the fired event;

• 各ユーザーにメール通知を送信します。

例:事後操作によって一般イベントを実行し、メール通知を送信する

1. トランジションを作成または編集します。

2. 対象のトランジションの [事後操作] タブをクリックし、"Fire an event that can be processed by the listeners"事後操作を編集します。

3. イベント一覧から [Generic Event] を選択します。

事後操作を使用して Team フィールドをアップデートする

When using the Team field with advanced work item workflows, you must use the Team UUID value instead of the team name. 

Team フィールドをアップデートする事後操作を追加するには、次の手順に従います。

1. Select Update Work Item Custom Field from the Add Post Function screen.

2. 追加 を選択します 。

3. From the Work Item Custom Field dropdown, select Team.

4. [カスタム フィールド値] には、Team UUID を入力する必要があります。

Team UUID を取得するには、次の手順に従います。

1. チーム プロファイル ページに移動します。

2. URL から Team UUID の値をコピーします。例: https://yoursite.atlassian.net/people/team/[TeamUUID]

3. Team UUID を [カスタム フィールド値] に貼り付けます。

トランジション プロパティ

プロパティはキー値のペアで、トランジションをさらにカスタマイズするために使用します。たとえば、トランジション プロパティはコピーしたシステム ワークフローを拡張して、言語の翻訳を可能にします。

 トランジションのプロパティを表示、編集するには、

1. ダイヤグラムからトランジションを選択します。

2. [プロパティ] をクリックします。

3. 次のいずれかを実行します。

   • トランジションに新しいプロパティを追加する。

   • プロパティの右側にあるアイコンをクリックして、プロパティを削除する。 

「テキスト」モードでは、トランジションの編集もできます。

トランジション プロパティを使用して、トランジションに制限を実装することが可能です。詳細については、「ワークフロー プロパティ」を参照してください。

グローバルトランジション

グローバル トランジションにより、ワークフローの任意のステータスを特定のステータスにトランジションできます。

グローバル トランジションを追加するには、

• （既存のステータスを追加して）新しいステータスを作成する際に、 グローバル トランジションをステータスに追加する オプションをチェックします。

• ステータスを選択し、ステータスのプロパティ パネルで すべてのステータスがこのステータスにトランジションすることを許可する をチェックします。

同じターゲット ステップをポイントする 2 つのグローバル トランジションを作成するには、

1. ワークフロー デザイナーでステップを選択して、すべてのステータスがこのステータスにトランジションすることを許可するを選択し、最初のグローバル トランジションを標準として作成します。

2. 現在そのステップをポイントするグローバル トランジションを持たない 他の ステップで、2 番目のグローバル トランジションを作成します。

3. 次に、作成した 2 番目のグローバル トランジションをテキスト エディターから選択します。

4. 編集 をクリックし、ターゲット ステップを最初のグローバル トランジションで選択したのと同じステップに変更します。 

5. 完了したら、更新をクリックします。