高度な課題ワークフローの設定

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

• トリガー – Bitbucket など、接続済みの開発ツールで特定のイベントが生じたときに Jira 課題をトランジションします。

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

• Validators – check that any input to the transition (for example, by a user) is valid, before the transition is performed.

• Post functions – carry out additional processing, after a transition is performed.

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

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

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

トリガー

Jira 管理者は、リンク済みの開発ツール内のイベントに応答するトリガーを Jira ワークフローに設定できます。これにより、開発ツールと Jira ワークフローを設定できるため、たとえば、開発者がブランチを作成して Bitbucket の課題で作業を開始すると、課題は自動的にオープンから進行中にトランジションします。

トリガーの設定

To see, or to set, triggers for a transition, edit the workflow that contains the transition, select the transition, then click Triggers in the properties panel for the transition.

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

1. Select > Issues.

2. Click Workflows and then Edit for the relevant workflow.

3. In diagram mode, select the transition arrow. In text mode, select the transition's name from the Transitions (id) column.

4. In diagram mode, click Triggers in the properties panel to show the triggers configured for the transition. In text mode, select the Triggers tab.

5. Click Add trigger on the Triggers tab to configure a trigger.

For more information, check out Configuring workflow triggers.

条件

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

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

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

• コードがこの課題に対してコミットされた場合、またはコミットされなかった場合にのみ実行を許可する

条件が満たされない場合、「課題の表示」ページのトランジション ボタンが表示されず、トランジションを実行できません。

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

任意の条件

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

条件の追加

To add a condition to a transition, edit the workflow that contains the transition, select the transition, then click Conditions in the properties panel for the transition.

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

1. Select > Issues.

2. Select Workflows.

3. Select More () and then Edit next to the relevant workflow.

4. In diagram mode, select the transition arrow. In text mode, select the transition's name from the Transitions (id) column.

5. In diagram mode, click Conditions in the properties panel to show the triggers configured for the transition. In text mode, select the Conditions tab.

When you click Add condition, you can choose from the available conditions, and set any necessary parameters for the condition. Additional conditions may be available from installed plugins, or you can create your own conditions using the plugin system; see the Workflow Plugin Modules for details.

条件のグループ化

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

You can toggle the logic for how the conditions in a group are applied between All and Any.

バリデーター

Validators check that any input made to the transition is valid before the transition is performed. Input can include that gathered from the user on the transition's screen. 

検証が失敗した場合、課題はトランジションの目的のステータスに進まず、トランジションの 事後操作は実行されません。 

バリデーターの追加

To add a validator to a transition, edit the workflow that contains the transition, select the transition, then click Validators in the properties panel for the transition.

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

1. Select > Issues.

2. Click Workflows and then Edit for the relevant workflow.

3. In diagram mode, select the transition arrow. In text mode, select the transition's name from the Transitions (id) column.

4. In diagram mode, click Validators in the properties panel to show the triggers configured for the transition. In text mode, select the Validators tab.

When you click Add validator, you can choose from the available validators and set any necessary parameters for the validator.

事後操作

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

• 課題フィールドの更新

• 課題の変更履歴生成

• 課題へのコメント追加

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

基本的な事後操作

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

1. 課題のステータスをターゲット ワークフロー ステータスのリンクされたステータスに設定します。

2. トランジション中にコメントが入力された場合、そのコメントを課題に追加します。

3. 課題の変更履歴を更新し、データベースに課題を格納します。

4. 課題のインデックス再作成を行い、インデックスとデータベースを同期させます。

5. Fire a Generic event that can be processed by the listeners. 

    Do not edit or remove this post function. Changing this essential post function will cause unintended behavior for automations and Marketplace add-ons. If you wish to customize the post function events that fire on a transition, consider adding a custom post function and leave the default event alone.

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

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

オプションの事後操作

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

Additional post functions may be available from installed plugins, or you can create your own post functions using the plugin system – see the Workflow Plugin Modules for details.

事後操作の追加

To add a post function to a transition, edit the workflow that contains the transition, select the transition, then click Post functions in the properties panel for the transition.

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

1. Select > Issues.

2. Click Workflows and then Edit for the relevant workflow.

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

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

   • In text mode, select the transition's name from the Transitions (id) column.

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

   • In diagram mode, click Post functions in the properties panel to show the triggers configured for the transition.

   • In text mode, select the Post functions tab.

5. Click Add post function.

6. Add the post function and choose Publish Draft to finalize your changes.

When you click Add post function you can choose from the available post functions, and set any necessary parameters. Options for editing or deleting a post function, and for changing the execution order, are at the right of the tab (hover there to see them).

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

課題が作成されたとき、特定のフィールドの値を設定するなどの処理タスクを実行する必要がある場合、ワークフローの最初のトランジションに事後操作を追加できます。最初のトランジションは、「作成」（空白のワークフローを作成した場合）または「課題の作成」（システム ワークフローを複製した場合）と呼ばれます。

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

1. 課題を作成します。

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 issue originally' post function.

If you wish, you can configure the initial status for your workflow to go to a different initial transition. See Configuring the initial status for details.

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

特定のトランジションが実行されたあと、課題フィールドの値を設定するには、「課題フィールドの更新」事後操作を使用します。

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

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

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

2. Select either None or a screen that does not contain the Resolution field.

3. 新しい [課題フィールドの更新]事後操作を追加し、課題フィールドおよびフィールド値のリストから解決状況を選択します

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

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

• The Resolution of the issue will be cleared.

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

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

Use the 'Fire an event that can be processed by the listeners' post function to fire the 'Generic Event', which is a built-in Jira event that can be used to trigger the sending of email notifications after a particular transition is executed.

Alternatively, you could fire a custom event that you've created specifically for this transition.

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

• Look up the notification scheme associated with the issue's project and identify the users associated with the fired event;

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

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

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

2. Click the transition's Post Functions tab and edit the 'Fire an event that can be processed by the listeners' post function.

3. Select Generic Event from the list of events.

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

高度な課題ワークフローとともに Team フィールドを使用する場合は、チーム名ではなく Team UUID 値を使用する必要があります。 

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

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

2. 追加 を選択します 。

3. From the Issue Custom Field dropdown, select Team.

4. For Custom Field Value, you must enter the Team UUID.

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

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

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

3. Paste the Team UUID to Custom Field Value.

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

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

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

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

2. Click Properties.

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

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

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

Note that you can also edit the transition in 'text' mode.

It is possible to implement restrictions on transitions using transition properties. For more information, see Workflow properties.

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

Global transitions allow any status in a workflow to transition to a particular status.

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

• When creating a new status (adding an existing status) – check the Add global transition to status option.

• By selecting a status and checking Allow all statuses to transition to this one in the properties panel for the status.

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

1. From the workflow designer, create the first global transition as normal by selecting a step and checking Allow all statuses to transition to this one.

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

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

4. Click Edit and change the destination step to the same step you selected for your first global transition. 

5. When you're done, click Update.