Jira Service Desk: ワークフローの高度な構成

Jira Service Desk 評価用リソース

このページの内容

お困りですか?

アトラシアン コミュニティをご利用ください。

コミュニティに質問

 

 

This page describes advanced configurations for JIRA Service Desk workflows. For information about the basics of workflows – see Working with workflows. For information on Workflows and how they work in JIRA Service Desk, see - Configuring Request Types and Workflows.

As a JIRA Service Desk administrator, you can control the following aspects of a transition's behavior:

  • Triggers – transition JIRA Service Desk issues when certain events occur in a connected development tool, such as Atlassian's Bitbucket or Stash.
  • Conditions – check that a transition should be performed by the user.
  • 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.
  • Properties – are key-value pairs that can be used to further customize transitions.

このページで解説するその他の項目:

  • トランジションの表示方法のカスタマイズ
  • グローバルトランジション

    トリガー

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

    (info) If you haven't set up a trigger before or you want to learn about triggers in more detail, see our guide on triggers here: Configuring workflow triggers. The guide also shows you how to configure a workflow with triggers, similar to this sample development workflow: Development Workflow with Triggers (from Atlassian Marketplace).

    トリガーの設定

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

       方法を確認するにはこちらをクリックしてください。

     条件

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

    • 報告者にのみトランジションの実行を許可する
    • 特定の権限を持つユーザにのみトランジションの実行が許可されている
    • allow execution only if the code has, or has not,been committed against this issue.

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

    Conditions cannot validate input parameters gathered from the user on the transition's screen – you need a validator to do this.

    以降のセクションの内容

     条件の追加

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

       方法を確認するにはこちらをクリックしてください。

    条件タブでは設定済みの条件を確認できます。

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

     

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

     

    条件のグループ化

    You can construct complex conditions by grouping and nesting conditions. Change any condition into a group by clicking the 'Add grouped condition' icon for the condition. Now you can add further conditions to this new group, as described above.

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

     バリデーター

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

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

      バリデーターの追加

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

       方法を確認するにはこちらをクリックしてください。

    バリデーター タブには、設定ずみのすべてのバリデーターが表示されます。

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

     

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

     

     事後操作

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

    • 課題フィールドの更新
    • 課題の変更履歴生成
    • 課題へのコメント追加
    • メール通知をトリガーするイベントの生成

    以降のセクションの内容

     基本的な事後操作

    Every

    1. 課題のステータスをターゲット ワークフロー ステータスのリンクされたステータスに設定します。
    2. トランジション中にコメントが入力された場合、そのコメントを課題に追加します。
    3. 課題の変更履歴を更新し、データベースに課題を格納します。
    4. 課題のインデックスを再作成して、データベースとの同期を維持します。
    5. リスナーが処理できるイベントを発生させます。

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

     

    オプションの事後操作

    JIRA Service Desk includes several optional post functions that can be added to transitions.

       オプションの事後操作の一覧を表示するには、ここをクリックします。

    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.

     
     事後操作の追加

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

       方法を確認するにはこちらをクリックしてください。

    On the Post functions tab, you can see any post functions that have already been set. 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).

     

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

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

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

    JIRA Service Desk includes the following essential post functions that are specific to a workflow's initial transition and that are performed in this order:

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

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

    オプション事後操作(最初のトランジションのみ)

    説明

    コメント作成

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

    課題ステータスの更新

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

    課題の保存

    課題の更新を保存します(変更履歴は作成されません)。

    Additionally, the standard optional post functions can also be added to an initial transition,

    "Create" トランジションに追加されたオプション事後操作は、"Create issue originally" 事後操作のに配置する必要があります。

    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.

    注意

    課題を作成する際に [解決状況] フィールドを設定する必要がある場合、"Create the issue" 事後操作の後に "Update Issue Field" 事後操作を追加し、その後 "Store Issue" 事後操作を使用します。"Store Issue" 事後操作は、課題作成時に [解決状況] フィールドを設定するのに便利です。

    ただし、課題の保存事後操作には以下のような制限があるため、必要な場合にのみ使用します。

    • 変更履歴を生成しない
    • 課題と 1 対多の関係を持つフィールド(たとえば、「バージョン」や「コンポーネント」)を保持できない

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

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

    たとえば、課題を [クローズ] ステータスに移動したときに [解決状況] フィールドを自動的に設定するトランジションが必要な場合があります。

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

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

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



    3. Add a new post function of type 'Update Issue Field' and: 
      1. Select Resolution from the Issue Field list.
      2. Select a suitable resolution from the Field Value list.

    [解決状況] フィールドをクリアするトランジションを作成するには、上記の "Update Issue Field"" 事後操作をトランジションに追加する手順に従います。ただし、[フィールド値] 一覧から [なし] を選択します。

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

    • 課題の解決状況クリアされます

    これらのトランジションが実行されるたびに、課題の解決状況は事後設定で指定されたとおりに、自動的に設定されたり、クリアされたりします。

     事後操作による HipChat 通知の送信

    課題がこの事後操作をもつトランジションを通過するたびに、「HipChat 通知」事後操作を使用して、1 つ以上の HipChat ルームに通知を送信できます。また、「Hipchat 通知」事後操作に JQL クエリを追加して、HipChat 通知をトリガーする課題をフィルタリングできます。

    HipChat 通知を送信するには、

    1. トランジションを作成または編集します。
    2. Add a new post function of type 'Notify HipChat'.
    3. 「操作へのパラメーター追加」ページで、
      1. 任意で JQL クエリを指定します。クエリにマッチする課題のみが通知を送信します。
        このトランジションを通過するすべての課題に通知を送信するには、このフィールドを空欄のままにします。
      2. ワークフロー トランジションにリンクする HipChat ルームを選択します。

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

    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 Service Desk 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.

    When a transition is performed, JIRA Service Desk will:

    • Look up the notification scheme associated with the issue'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] を選択します。

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

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

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

    1. ダイヤグラムからトランジションを選択します。
    2. プローパティ パネルで プロパティ を選択します。
    3. 次のいずれかを実行します。
      • トランジションに新しいプロパティを追加する。
      • プロパティの右側にあるアイコンをクリックして、プロパティを削除する。 

    Important:

    このページではトランジションのプロパティを編集できません。プロパティのキーまたは値(あるいはその両方)を変更するには、まず変更したいプロパティを削除し、更新された新しいプロパティを追加する必要があります。

      

    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.

     トランジションの表示方法のカスタマイズ

    課題を表示しているとき、大半の操作やワークフローのトランジションは課題の上部にあるボタンの列から実行できます。 

    トランジション ボタンの順序を変更するには、

    To change the order of transition buttons, including additional transitions in the Workflow menu, add the property key opsbar-sequence to each workflow transition that you wish to reorder. Each opsbar-sequence property key requires a property value that defines the order of the transition action on issue views.

    1. Go to the transition's properties, as described in Transition properties above.
    2. [新しいプロパティの追加] の [プロパティ キー] フィールドに「opsbar-sequence」と入力します。
    3. [プロパティ値] フィールドに値を入力します。この値は課題ビューに表示されるトランジション ボタンの順序を定義し、"0" 以降の正の整数である必要があります。
      10、20、30...などの連続する opsbar-sequence プロパティー値を使用し、新しいトランジションをあとから簡単に追加できるようにします。
    4. 追加をクリックします。

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

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

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

    • (既存のステータスを追加して)新しいステータスを作成する際に、 グローバル トランジションをステータスに追加する オプションをチェックします。
    • ステータスを選択し、ステータスのプロパティ パネルで すべてのステータスがこのステータスにトランジションすることを許可する をチェックします。

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

    1. ワークフロー デザイナーでステップを選択して、"すべてのステータスがこのステータスにトランジションすることを許可する" を選択し、最初のグローバル トランジションを標準として作成します。
    2. 現在そのステップをポイントしているグローバルトランジションを持たない他のステップで、2 番目のグローバル トランジションを作成します。
    3. 次に、作成した 2 番目のグローバル トランジションをテキスト エディタから選択します。
    4. 「編集」ボタンをクリックし、「ターゲット ステップ」を最初のグローバル トランジションで選択したのと同じステップに変更し、「更新」をクリックします。

     

     

最終更新日: 2016 年 12 月 15 日

この内容はお役に立ちましたか?

はい
いいえ
この記事についてのフィードバックを送信する
Powered by Confluence and Scroll Viewport.