Jira Automation のアクション
ルールを実行するのがアクションです。アクションによってタスクを自動化すると、サイト内で変更を行えるようになり、課題の編集、通知の送信、サブタスクの作成など、数多くのタスクを実行できます。
サービス デスクの顧客の追加
- スマート バリューの使用: あり
- Server Lite で利用: 不能
この便利かつ簡単なアクションで、新しい顧客を Jira Service Management プロジェクトに追加できます。スマート バリューをすべてのフィールドで使用できて、既存の組織のいずれかに顧客を追加できます。
課題の割り当て
- スマート バリューの使用: あり
- Server Lite で利用: 可能
- ルール アクター権限: 課題の割り当てと割り当て可能なユーザー
このアクションは、ほとんどのシナリオで課題を割り当てるための使いやすくカスタマイズ可能な方法です。このアクションの詳細な説明については、この記事をご確認してください。
課題の割り当てには以下の 8 個のオプションを使用できます。
定義されたリストのユーザー
このオプションによって、(JQL で指定された) 制限をパスした課題は、自分が選択したメソッドで指定したリスト上のユーザーに割り当てられます。次は、選択可能なメソッドの例です。
- 均一のワークロード: リストの各ユーザーに同じ数の課題を割り当てます。
- ランダム: ユーザーのリストからランダムに割り当てる
- ラウンド ロビン - 課題をユーザー リストの順序に基づいて割り当てるため、1 人のユーザーに課題を割り当てるとリスト内の次のユーザーに移ります。
他のフィールド値またはコメント
このオプションによって、課題またはコメントのいくつかのユーザー フィールドに基づいて課題を割り当てられます。たとえば、課題履歴に基づき前担当者に割り当てたり、作成者に割り当てたりします。除外するユーザーを指定する、またはユーザーが必ず含まれる必要のあるグループを指定する場合、この要件に一致しないユーザーはスキップされて、アクションは一致するユーザーを探し続けます (担当者の課題履歴をさらに遡るなど)。
自動
課題はプロジェクトの初期設定の担当者に割り当てられます。
別の課題からコピー
このオプションによって、担当者を関連する課題からコピー、または担当者をコピーする課題を見つけるために JQL を記述できます。
スマート値
このオプションによって、任意のユーザー スマート値でスマート値に基づいて課題を割り当てます。たとえば、課題がコメントされた際は、そのコメントの作成者に課題を割り当てられます。
ユーザーを指定
このオプションによって、選択した特定のユーザーに割り当てます。
未割り当て
このオプションによって、課題を未割り当てに設定します。
イベントを起動したユーザー
このオプションによって、イベントをトリガーしたユーザーに課題を割り当てます。
課題のクローンを作成する
- スマート バリューの使用: あり
- Server Lite で利用: 不能
課題を複製すると、同じプロジェクトまたは選択したプロジェクト内に課題を素早く複製できます。これは、プロジェクト間で課題を移動する際の回避策の一環としても使用できます。
課題を複製するために利用できる API がないため、このアクションは新しい課題を作成して、可能であるすべてのフィールド全体でコピーします。その後、対応するワークフローの最初のステップにステータスが設定されて、元の課題にあるすべての解決状況が削除されます。ただし、これは純粋な複製ではないため、複製された課題は元の課題にリンクされません。
また、サポートされているフィールドを、コピーした任意の値を上書きする選択済みの値に設定できます (詳細セクションにある追加フィールドの使用については「追加フィールドを編集する」参照)。
Jira にある API の制限によって、このアクションは課題リンクとコメントを複製しません。
課題にコメントする
- スマート バリューの使用: あり
- Server Lite で利用: 可能
これを使用して、コメントを課題に追加します。スマート値によって課題フィールドを参照してメッセージをコメント表示の設定と併せてパーソナライズできます。
課題の作成
- スマート バリューの使用: あり
- Server Lite で利用: 不能
- ルール アクター権限: プロジェクトを参照して課題を作成する
この操作によって、任意のプロジェクトであらゆるタイプの課題を作成します。任意の数のフィールドを選択して、それらの値を設定できます (「その他のオプション」セクションにおける追加フィールドの使用については「追加フィールドを編集する」参照)。サブタスクで作業している場合は、ブログ投稿「必須フィールドを含むサブタスクの作成」をご参照ください。
- ルールが実行されるまでプロジェクト タイプがわからないため、トリガー課題のオプションとして同じプロジェクトを使用するグローバル ルールには注意が必要です。すべての課題タイプを利用できるので、プロジェクトには存在しない課題タイプも選択できます。
- 「リクエスト タイプ」、「リクエスト参加者」、「組織」などの Jira Service Management (旧 Jira Service Desk) 固有のフィールドは、Jira 7.3 以上と Jira Service Management 3.3 以上でのみ使用できます。
サービスデスク リクエストを作成する
- スマート バリューの使用: あり
- Server Lite で利用: 不能
新しい Jira Service Management リクエストを作成します。上記の「課題を作成」アクションと同様に、スマート値によって利用可能なフィールドを設定できるようになります。
サブタスクの作成
- スマート バリューの使用: あり
- Server Lite で利用: 不能
複数のサブ タスクを課題にすばやく追加する方法です。このアクションは要約の指定のみをサポートします。
フィールドの設定
[フィールドを追加] を選択すると、アクションから個々のサブタスクが削除されて、フィールドを指定できる新しい [課題を作成] アクションが追加されます。
変数の作成
- スマート バリューの使用: あり
- Server Lite で利用: 不能
独自のスマート値を定義します。この値は、同一ルールの他のアクションや条件で使用できます。スマート値には、他のスマート値や数学関数を含めることができます。
このアクションは常に文字列を返します。たとえば、Stakeholders
という名前で、{{issue.watchers}}
というスマート値を持つ変数を作成した場合、この変数はウォッチャーのリストを返しますが、リストは文字列としてレンダリングされます。
作成後に自動化ルールで変数を使用するには、構文 {{variable_name}}
を使用してください。次の例で、構文は {{Stakeholders}}
になります。
バージョンの作成
- スマート バリューの使用: あり
- Server Lite で利用: 不能
これによって、課題を割り当てられる新しいバージョンが作成されます。同名のバージョンがすでに存在する場合は、新しいバージョンは作成されません。
添付ファイルを削除する
- スマート バリューの使用: あり
- Server Lite で利用: 可能
このアクションによって、添付ファイルのファイル名に基づく正規表現の一致で古い添付ファイルを削除します。
コメントの削除
- スマート バリューの使用: あり
"コメントされた課題"、"移行済みの課題"、"更新された課題" などの、コメントの追加を伴うトリガーとのみ併用できます。このアクションは、ルールをトリガーするコメントを削除します。
入力に使用できるのは {{comment.id}} のみです。
課題を削除する
- スマート バリューの使用: なし
- Server Lite で利用: 可能
コンテキストにある現在の課題を削除します。このアクションは、プロジェクト間で課題の移動を自動化する場合などで、不要な課題を Jira から削除するのに最適な方法です。
課題の編集
- スマート バリューの使用: あり
- Server Lite で利用: 不能
このアクションによって、現在の課題のほとんどのフィールドを簡単に編集できます。設定するフィールドを選択して、その値を追加するだけです。値の一部は動的な場合があります。こうしたより複雑なシチュエーションでは、[その他のオプション] の追加フィールドの柔軟性も利用できます。
課題のリンク
- スマート バリューの使用: あり
- Server Lite で利用: 不能
このアクションによって、リンク タイプとリンクする課題を選択するだけで課題を簡単にリンクできます。課題ドロップダウンのオプションを使用、特定の課題のドロップダウンに課題キーを入力、詳細なユース ケースではドロップダウンにスマート バリューを入力できます。
ログ アクション
- スマート バリューの使用: あり
- Server Lite で利用: 可能
このアクションは監査ログに何かを記録します。これは、スマート値を試して何が返されるかを確認、またルールをデバッグするのに優れた方法です。
ログ
- スマート バリューの使用: あり
- Server Lite で利用: 不能
このアクションによって、課題に対する時間を記録できます。日時のスマート値によって開始日を動的に設定して、スマート値をテキスト化して説明をカスタマイズできます。
課題のルックアップ
- スマート バリューの使用: あり
- Server Lite で利用: 不能
設定可能な上限値 (既定で 100) まで、JQL クエリを使用して課題を検索します。{{lookupIssues}} スマート値を使用して、他のアクションの結果リストを含めます。課題の結果の上限値を設定する方法をご確認ください。
スマート値について詳しくは、次のリソースをご確認ください。
課題のルックアップ アクションの使用例
各課題の課題キーを箇条書き形式で表示します。
{{#lookupIssues}}
* {{key}}
{{/}}
ルックアップ アクションで見つかった課題数を表示します。
There are {{lookupIssues.size}} issues found by the lookup action.
課題リスト内のすべてのストーリー ポイントを合計します。
There are {{lookupIssues.Story Points.sum}} story points remaining.
ウォッチャーの管理
- スマート バリューの使用: あり
- Server Lite で利用: 不能
課題が更新された時に、特定のユーザーに確実に通知したい場合があります。このアクションによって、必要に応じてウォッチャーを追加または削除できます。また、{{smart values}}
をフィールドに直接入力して、追加または削除するユーザーを指定できます。
イベントを公開する
- スマート バリューの使用: あり
- Server Lite で利用: 可能
これによって、他のアドオンや統合がリッスンできる Jira イベント (システムまたはカスタム) を公開します。
課題データを再取得する
- スマート バリューの使用: なし
- Server Lite で利用: 可能
このアクションにより、スマート値が Lucene インデックスの最新の課題フィールド値で更新されます。既定では、{{issue}}
参照はルールの実行時に更新されないため、ルールが最初にトリガーされた時点の値と変わりません。なお、再取得されるのは課題フィールドのみであり、課題リンクは除外されます。
バージョンをリリースする
- スマート バリューの使用: あり
- Server Lite で利用: 不能
バージョンのリリースに使用します。初期設定では、これによって、次回リリース予定のバージョンのプロジェクトは既存のリリース日にリリースされます。「次のバージョン」は、ソフトウェア プロジェクトの [リリース] タブで設定した順序によって決まります。リリースする特定のバージョンを選択して、スマート値によって動的な名前を設定できます。
メールを送信
- スマート バリューの使用: あり
- Server Lite で利用: 不能
このアクションによって、メールを送信できます。すべてのフィールドがスマート値によるカスタマイズに対応しています。
メールの初期設定の「差出人」アドレスは、Jira の初期設定のメールです。
グループにメールを送信するようにこのルールを設定すると、グループの 100 ユーザーのみに送信されて、残りのユーザーには送信されません。これは制限であるため、この制限を回避するには小さなグループを作成する必要があります。
Hipchat メッセージを送信する
- スマート バリューの使用: あり
- Server Lite で利用: 不能
ルールが実行された際に、チームまたは個人に通知します。提供されたフィールドで、メッセージをカスタマイズできます。
Microsoft Teams のメッセージを送信する
- スマート バリューの使用: あり
- Server Lite で利用: 不能
ルールが実行された際にチームに通知します。提供されたフィールドで、メッセージをカスタマイズできます。詳細な手順については、Microsoft Teams の統合方法をご参照ください。
Slack のメッセージを送信する
- スマート バリューの使用: あり
- Server Lite で利用: 不能
ルールが実行された際に、チームまたは個人に通知します。提供されたフィールドで、メッセージをカスタマイズできます。詳細な手順については「Slack の統合方法」をご参照ください。
初期設定の URL を変更する
Webhook の URL に、接頭辞 https://hooks.slack.com/
が含まれているかどうかを検証しています。この接頭辞を変更する場合は、次のプロパティを設定して変更できます。
slack.notification.action.url.prefix
Stride メッセージを送信する
- スマート バリューの使用: あり
- Server Lite で利用: 不能
ルールが実行された際に、チームまたは個人に通知します。提供されたフィールドで、メッセージをカスタマイズできます。
Twilio (SMS) メッセージを送信する
- スマート バリューの使用: あり
- Server Lite で利用: 不能
多くのサービス チームは、オンコール シナリオで SMS に依存しています。このアクションによって、Twilio サービスで通知を送信できます。
発信用 Web リクエストを送信する
- スマート バリューの使用: あり
- Server Lite で利用: 不能
他のシステムと統合する必要がある状況は頻繁に発生します。このアクションを使用すると、ルールが実行された際に別のシステムに通知する送信 Web リクエストを送信して、必要に応じて後続のアクションで使用できる応答データを返せます。これは大変強力なアクションです。詳しくは、このブログでご確認ください。
ウェブ リクエストの送信中に、自動化ルールのためにマスクされたシークレット キーの作成/編集も行えます。シークレットの管理方法をご確認ください。
発信用 Web リクエストの初期設定のリクエスト タイムアウトは 3000 ミリ秒です。次のプロパティを設定すると変更できます。
outgoing.webhook.timeout.ms
エンティティのプロパティを設定する
- スマート バリューの使用: あり
- Server Lite で利用: 不能
これによって非表示の「エンティティ」プロパティを、ルール実行のトリガー課題に関連する課題、プロジェクト、またはユーザーに設定します。これらのプロパティはアプリで一部の機能に使用できます。エンティティのプロパティによって、プラグインでキー/値ストアを課題やプロジェクトといった Jira エンティティに追加できます。これらの値は Jira によってインデックス化して、API または JQL によってクエリできます。
サードパーティのアクション
サーバーの Automation for Jira によって、Atlassian Marketplace で他のアプリ ベンダーが提供する拡張機能が UI で自動化アクションに直接寄与できるようになります。次のアクションのサポートが必要な場合は、アクションのベンダーにお問い合わせください。
次の表には、Automation for Jira で自動化できるサードパーティのアクションが含まれています。
アプリ | 操作 | 説明 |
---|---|---|
Better Excel Automation for Jira | カスタム Excel スプレッドシートを、Jira から定期的に (スケジュールされたレポートとして) または課題の作成/更新時などにエクスポートしてメール送信する | Excel スプレッドシートを Jira 課題 (Automation Lite で利用可能) から生成、エクスポート、メール送信します。ベンダー: Midori |
Better Excel Exporter for Jira | Excel スプレッドシートのエクスポート機能を Jira で実装されたビジネス プロセスにシームレスに統合する | Microsoft Office、Google Spreadsheets、Apple Numbers、Open/Libre Office と互換性のある XLSX 形式のファイルを作成します。ベンダー: Midori |
Better PDF Exporter for Jira | Jira のカスタマイズ可能な PDF エクスポート: 課題リスト、ダッシュボード、タイムシート、請求書、リリース ノート、ストーリー カード、カスタム ドキュメント | Jira 課題を PDF ドキュメントにエクスポートして、課題を標準のビジネス ドキュメント ファイル形式で共有、印刷、メール送信、アーカイブ、レポートします。ベンダー: Midori |
Better PDF Automation for Jira | PDF ドキュメントを Jira から自動でエクスポート、メール送信、保存する | PDF ドキュメントを Jira 課題から生成、保存、メール送信します。ベンダー: Midori |
Elements Connect | 「フィード」フィールドの値を設定 | 「フィード」フィールド値を設定します。ベンダー: Elements |
ScriptRunner | ScriptRunner スクリプトを実行する | Groovy スクリプトを自動化ルールで直接作成して実行します。ベンダー: Adaptavist |
シンプル タスク リスト | タスク アクションを追加 | タスクをタスク リストに自動で追加します。ベンダー: Top Shelf Solutions |
サード パーティのアプリはイベント処理、シリアライズ、計算されたカスタム フィールド、パフォーマンスなどで問題を引き起こす可能性があることにご注意ください。問題の原因となっているアドオンには、次のようなものがあります。
パフォーマンスに関する問題がある、またはルールが正しく実行されていない、またはこれらのアドオンのいずれかがインストールされている場合は、それらを無効にして問題が解決するかどうかをご確認ください。
課題のトランジション
- スマート バリューの使用: あり
- Server Lite で利用: 可能
このアクションは、課題をワークフローを通じて移行します。また、更新するフィールドを課題のトランジションの一部として選択できます。たとえば、次を更新できます。
- 課題からコピー - 関連する課題またはブランチ ルールの課題からステータスをコピーする必要がある際に使用します。
- 親からコピー: サブタスクと併用するために、親課題からステータスを引用します。
- エピックからコピー: 課題に関連するエピックからステータスを引用します。
- トリガー課題からコピー - このルールをトリガーした課題からステータスを取得します。ブランチで最も役立ちます。
- 同じステータス (ループ) - トランジションした課題が現在のステータスに戻ってくる際に使用します。通常、ユーザーから詳細なデータを収集するために画面と併用します (例:「エスカレート」トランジション)。