自動化の基本
Atlassian Cloud 製品における自動化の一般的なコンセプトとベスト プラクティスを説明します。
11 月 1 日以降、Jira Cloud での自動化ルールがカウントされる方法と請求方法が変わります。これらの変更は、10 月 1 日以降に製品内でプレビューできるようになります。詳細はアトラシアン コミュニティの投稿をご確認ください。
アクションによってルールが実際に実行されます。これによって、タスクを自動化してサイト内に変更を加えられます。また、課題の編集、通知の送信、サブタスクの作成など、多数のタスクも実行できます。
Jira Automation テンプレート ライブラリで、これらすべてのアクションの使用方法をご確認ください。
スマート バリューの使用: あり
必要な権限: 課題の割り当て、割り当て可能なユーザー
課題をユーザーに割り当てます。
課題の割り当てには以下の 8 個のオプションを使用できます。
定義済みリストのユーザー: JQL で指定され制限をパスした課題は、ユーザーが選択した方法で、指定リストに掲載されているユーザーに割り当てられます。以下は選択可能なメソッドの例です。
バランスのとれたワークロード: リストの各ユーザーに同じ数の課題を割り当てます。これらの課題のスコープは JQL によって定義されます。
ランダム: ユーザーのリストからランダムに割り当てます。
ラウンドロビン: 指定ユーザー リスト内の順番に基づき課題を割り当てます。
別のフィールド値またはコメント: 課題またはコメントのユーザー フィールドの値に基づき課題を割り当てます。たとえば、課題履歴に基づき前担当者に割り当てたり、作成者に割り当てたりします。除外するユーザーを指定する場合やユーザーが必ず含まれる必要のあるグループを指定する場合、この要件に一致しないユーザーはスキップされ、アクションは一致するユーザーを探し続けます (担当者の課題履歴をさらに遡るなど)。
自動的: プロジェクトのデフォルトの担当者に課題を割り当てます。
他の課題からコピー: 関連する課題から担当者をコピーします。JQL を使って課題を見つけて、そこから担当者をコピーすることもできます。
スマート バリュー: スマート バリューに基づいて課題を割り当てます。たとえば、課題のコメントが付けられた際、そのコメントの作成者に課題を割り当てられます。ユーザー スマート バリューの詳細をご確認ください。
ユーザー指定: 指定したユーザーに割り当てます。
未割り当て: 既存のユーザーを削除して、課題を「未割り当て」に設定します。
イベントのトリガー実行者: イベントをトリガーしたユーザーに課題を割り当てます。
ロールのユーザー: チーム内の特定のロールに課題を割り当てます。
グループのユーザー: 選択したグループに属するユーザーに課題を割り当てます。
オンコール担当者: チームの Opsgenie オンコール スケジュールに基づいて、オンコールのユーザーに課題を割り当てます。
課題に 1 つ以上のフォームを添付します。このフォームの可視性も設定できます。課題ビューにおけるフォームの動作に関する詳細についてご確認ください。
スマート バリューの使用: あり
同じプロジェクトまたは選択したプロジェクト内の課題を重複作成します。
このアクションは、プロジェクト間で課題を移動する際の次善策の一環として使用できます。
このアクションでは、サポートされる課題フィールドのリストから [添付ファイル] フィールドを選択し、添付ファイルのコピー元となるソース課題を選択することで、新しい課題を作成して、添付ファイルをコピーする機能を含む、利用可能なすべてのフィールド データをコピーします。
その後、対応するワークフローの最初のステップにステータスが設定され、元の課題にあるすべての解決が削除されます。課題は純粋なクローンではないため、元の課題には紐づけされません。
また、値を設定して、サポートされるフィールドにあるすべてのコピー データを上書きできます。Jira Service Management では、Jira と [アセット] の両フィールドを設定します。Jira Service Management のアセットに関する詳細についてご確認ください。
[その他のオプション] を選択して、高度なフィールド編集を行うための追加のフィールドを表示します。
このアクションでは、課題のリンクまたはコメントのクローンは作成されません。
スマート バリューの使用: あり
課題にコメントを追加します。
スマート バリューを使用して課題フィールドを参照し、コメントをパーソナライズできます。コメントの公開範囲も設定できます。
1 つの課題から 1 つ以上のフォームを現在の課題にコピーします。
ブランチを選択したツールで作成します。現在、次の 3 つの方法があります。
ブランチを Bitbucket で作成
ブランチを GitHub で作成
ブランチを GitLab で作成
これには、自動化ルールと他のツール間の接続をセットアップする必要があります。自動化の接続に関する詳細についてご確認ください。
また、スマート値によってこれらのブランチに関連する情報にアクセスできます。作成済みブランチのスマート値に関する詳細についてご確認ください。
次はブランチの名前に使用できません。
HEAD (予約語であるため)
/ で開始または終了する名前
. で開始または終了する名前
末尾が .lock
スペースを含む名前
次の記号セットを含む名前: ..、~、^、:、?、*、[、/、\\、@{
スマート バリューの使用: あり
選択した Atlassian Cloud サイトに Confluence ページ (またはブログ) を作成します。これにより Confluence ページは作成されますが、コンテンツは入力されないことに注意してください。つまり、スマート値を使用してページ タイトルを定義することはできますが、自動化ルールではどのページ コンテンツも定義できません。
Jira プロジェクトと Confluence 間の接続が必要です。Confluence での Jira Automation の利用に関する詳細をご確認ください。
スマート バリューの使用: あり
必要な権限: プロジェクトの参照、課題の作成
任意のタイプの課題を作成してプロジェクトに追加します。設定するフィールドを選択して、その値を設定できます。サポートされる課題フィールドのリストから [添付ファイル] フィールドを選択して、添付ファイルのコピー元となるソース課題を選択することで、添付ファイルをコピーできます。
[その他のオプション] を選択して、高度なフィールド編集を行うための追加のフィールドを表示します。
Jira Service Management では、Jira と [アセット] の両フィールドを設定できます。Jira Service Management では、オブジェクトによってルールがトリガーされると、[オブジェクトを挿入] を選択して AQL 経由でトリガーされたオブジェクトを自動で追加できます。Jira Service Management のアセットに関する詳細についてご確認ください。
グローバル ルールで [プロジェクト] > [トリガーと同じプロジェクト] を使用する場合は注意が必要です。プロジェクトのタイプはルールが実行されるまで不明なため、すべての課題のタイプを構成できます。そのため、プロジェクトに存在しない課題のタイプも選択できます。
キーと値のマッピングのテーブルを作成して、それをスマート値に割り当てます。スマート値は、ルール内のその他のアクションや条件で使用できます。次に例を示します。
スマート値 {{departments.get("HR")}} は人事を返します。
キーと値のマップは、同じルール内でのみ呼び出せます。アクションがブランチで使用される場合、スマート値は同じブランチ内でのみ使用できます。キー/値のマッピングは、その他のルールやブランチには引き継がれません。
ユース ケースの例
たとえば、優先度に基づいてバグに期限を割り当てる自動化ルールを作成したいとします。優先度の高いバグは、その週内に完了する必要があります。一方、優先度の低いバグは、翌 6 か月内に完了すれば構いません。
次の値でキー/値のマップを作成できます。
その後、「課題を編集」アクションと {{dueDates.get(issue.Priority.name)}} スマート値を使用すると、バグの緊急度に基づいて、期限を自動的に割り当てることができます。
この方法でスマート値をネストする場合、ネストされたスマート値によって返される値は文字列でなければならないことに注意してください。この例では、代わりに issue.Priority.id を使用した場合、.format(“#”) を追加して出力を文字列 (つまり {{dueDates.get(issue.Priority.id.format("#"))}}) に変換しない限り機能しません
スマート バリューの使用: あり
課題のサブタスクを作成します。
このアクションは、サブタスクの要約の設定のみをサポートします。
[フィールドを追加] を選択すると [サブタスクを作成] アクションは [課題を作成] (課題タイプ: サブタスク) アクションに変換されて、追加フィールドを設定できるようになります。
スマート バリューの使用: あり
独自のスマート バリューを定義します。この値は、同一ルールの他のアクションや条件で使用できます。定義したスマート バリューには、他のスマート バリューや数学関数を含めることができます。
これは常に文字列を返します。たとえば、スマート値 {{issue.watchers.distinct}} で呼び出される変数 Stakeholders を作成した場合、その変数はウォッチャーのリストを返しますが、リストは文字列としてレンダリングされます。
スマート バリューの使用: あり
課題のコメントを削除するために使用できます。このアクションを使用するには、次の 2 つの方法があります。
トリガー コメントの削除: コメントの追加を含むトリガーがルールで使用されている場合は ([コメントされた課題]、[トランジションされた課題]、[アップデートされた課題] など)、{{comment.id}} がそのコメントを削除します。
他のコメントを削除する: {{issue.comment.first.id}} などのコメント スマート値によって、アクティブな課題のコメントを削除します。
スマート バリューの使用: なし
コンテキストにある現在の課題を削除します。
このアクションを使用すると、プロジェクト間での課題の移動を自動化する場合などに不要な課題をサイトから削除できます。
コンテキストにある現在の課題を削除します。このアクションは、プロジェクト間での課題の移動を自動化する場合などで、不要な課題を Jira から削除するのに最適です。
スマート バリューの使用: なし
この操作では現在課題にある任意の課題リンクを削除できます。特定のタイプにおけるすべての課題リンクを削除するか (たとえば、すべての「ブロックされた」課題を削除するなど)、特定の課題を選択してリンクを解除できます。
スマートの使用: あり
このアクションによって、コメントの表示やコメントの内容を編集できるようになります。利用可能なオプションは次のとおりです。
最初のコメント: 課題に関する最初のコメントを編集します。
最後のコメント: 課題に関する最新のコメントを編集します。
トリガー コメント: ルールをトリガーしたコメントを編集します。コメントされた課題や編集された課題のコメントといったトリガーで使用されます。自動化トリガーの詳細をご確認ください。
スマート値: コメント スマート値を指定して、編集するコメントを選択します。
オプションを選択したら、次のフィールドを空白のままにしてコメントを変更せずに残せます。これは、コメントの表示のみを編集して他の部分には手を付けない際に役立ちます。スマート値 {{currentComment}} を入力すると、コメントの現在のコンテンツが返されます。これは、現在のコメントを保持してその前後にコンテンツを追加する際に役立ちます。
スマート バリューの使用: あり
Jira Service Management でのみ利用できます。このアクションは、[アセット] フィールドの属性値を編集します。スマート値、文字列値、またはアセット オブジェクトの ID/キーのいずれかを入力できます。ここでフィールドを空のままにすると、オブジェクトの値がクリアされます。
アセット属性はさまざまなタイプの値 (文字列、整数、ユーザー、日付、参照オブジェクトなど) を持てるため、ここでは適切に入力する必要があります。このアクションの値が属性タイプと一致しない場合は、このルールでエラーが発生します。
スマート バリューの使用: あり
設定するフィールドと追加する値を選択して、現在の課題を編集します。Jira Service Management では、Jira と [アセット] の両フィールドを編集できます。Jira Service Management のアセットに関する詳細についてご確認ください。
一部の値は動的なものに設定できます。サポートされる課題フィールドのリストから [添付ファイル] フィールドを選択して、添付ファイルのコピー元となるソース課題を選択することで、添付ファイルもコピーできます。[その他のオプション] を選択して、高度なフィールド編集を行うための追加のフィールドを表示します。
スマート バリューの使用: あり
Jira Service Management にのみ適用されます。
オブジェクトの属性値を更新します。スマート値、文字列値、またはアセット オブジェクトの ID/キーのいずれかを入力できます。ここでフィールドを空のままにすると、オブジェクトの値がクリアされます。
アセット属性はさまざまなタイプの値 (文字列、整数、ユーザー、日付、参照オブジェクトなど) を持てるため、ここでは適切に入力する必要があります。このアクションの値が属性タイプと一致しない場合は、このルールでエラーが発生します。Jira Service Management のアセットに関する詳細についてご確認ください。
このアクションは、グローバルな自動化ルールに対してのみ使用でき、オブジェクトがルールのフォーカスになっている場合にのみ使用できます。例を次に示します。
スマート バリューの使用: あり
Jira Service Management にのみ適用されます。
課題のリクエスト タイプをアップデートします。リクエスト タイプは課題タイプに基づいていることにご注意ください。複数のリクエスト タイプが 1 つの課題タイプに対応している場合もあります。ただし、自動化ルールが課題に作用する場合は、選択したリクエスト タイプがその課題タイプに対応している必要があります。そうでない場合は、アクションが実行されると監査ログでエラーが検出されます。
スマート バリューの使用: なし
「脆弱性の検出時」トリガーとの併用時にのみ使用できます。
トリガーとなる脆弱性を課題にリンクします。
トリガーとなる脆弱性ごとに新しい課題を作成してリンクするには、次の手順に従います。
「脆弱性の検出時」トリガーと「課題を作成」アクションを使用して、自動化を作成します。
「課題を脆弱性にリンクする」アクションのドロップダウン メニューで、最近作成された課題を選択します。
トリガーとなるすべての脆弱性を 1 つの課題にリンクするには、次の手順に従います。
「脆弱性の検出時」トリガーで自動化を作成します。
「課題を脆弱性にリンクする」アクションのドロップダウン メニューに、課題キーを入力します。
このアクションで課題キーを入力した場合は、ルールの実行時に課題が存在しないと自動化が失敗します。
スマート バリューの使用: あり
リンクのタイプとリンクする課題を選択して、別の課題とリンクします。
ルールをトリガーする課題、関連する課題ブランチにある現在の課題、スマート バリュー、または課題キーにリンクできます。
スマート バリューの使用: あり
開始日を動的に設定するには日付と時間のスマート バリューを、そして説明をカスタマイズするにはテキストのスマート バリューを使用できます。
スマート バリューの使用: あり
JQL クエリを使用して最大 100 件の課題を検索します。{{lookupIssues}} スマート バリューを使用することで、他のアクションに結果リストを含めます。課題リストでスマート バリューを使用する方法の詳細をご確認ください。
LookupIssues リストから、すべてのフィールドとカスタム フィールドにアクセスできます。たとえば、各課題の課題キーを箇条書き形式で表示するには、次を実行します。
1
2
3
{{#lookupIssues}}
* {{key}}
{{/}}
以下の例では、課題リストのすべてのストーリー ポイントを集計しています。
1
There are {{lookupIssues.Story Points.sum}} story points remaining.
スマート バリューの使用: あり
Jira Service Management にのみ適用されます。
アセット AQL クエリで最大 100 件の課題を検索します。Jira Service Management のアセットに関する詳細についてご確認ください。
{{lookupObjects}} スマート値によってオブジェクトの結果リストを他のアクションに渡します。これはオブジェクトのリストにアクセスして印刷するために使用できますが、他のルールのトリガーには使用できません。JSM アセットのスマート値に関する詳細についてご確認ください。
スマート バリューの使用: あり
課題に/からウォッチャーを追加/削除します。
フィールドで直接スマート バリューを使って、ユーザーを指定して追加または削除できます。
スマート バリューの使用: あり
ワークフロー内で、課題をあるステータスから別のステータスにトランジションします。
課題のトランジションと同時に更新するフィールドを選択できます。たとえば、以下を更新できます。
課題からコピー: 関連課題やブランチ ルールの課題からステータスをコピーします。
親からコピー: サブタスクと併用するために、親課題からステータスをコピーします。
エピックからコピー: 課題に関連するエピックからステータスをコピーします。
トリガー課題からコピー: ルールをトリガーした課題からステータスをコピーします。
同じステータス (ループ): トランジションした課題が現在のステータスに戻ってくる際に使用します。画面と一緒に使用すると、ユーザーから詳細データを収集できます (エスカレーションへのトランジションなど)。
サポートされる課題フィールドのリストから [添付ファイル] フィールドを選択して、添付ファイルのコピー元となるソース課題を選択することで、添付ファイルもコピーできます。[その他のオプション] を選択して、高度なフィールド編集を行うための追加のフィールドを表示します。
Jira Service Management では、Jira と [アセット] の各フィールドを編集できます。Jira Service Management のアセットに関する詳細についてご確認ください。
「返信先」のアドレスを変更する
2021 年 6 月 28 日から、[返信先] フィールドにリストされた最初のメールのみが返信メールを受信します。これは次のことを意味します。
[メールを送信] アクションを持つ新しい自動化ルールでは、[返信先] フィールドにアドレスを 1 つだけ入力することをお勧めします。
[メールを送信] アクションを使用する既存のルールについては、[返信先] フィールドで 1 つのアドレスだけが使用されるようにルールを再構成することをお勧めします。
スマート バリューの使用: あり
メールを送信します。 このアクションのすべてのフィールドで、スマート バリューを使ったカスタマイズがサポートされています。
[宛先] フィールドから [参加しているすべての顧客] を選択すると、報告者、リクエスト参加者、課題に組織が追加された顧客、課題通知を購読している顧客に、メールが送信されるようになります。Jira Service Management の顧客と組織に関する詳細についてご確認ください。
このアクションで送信できるメールの数には制限があることにご注意ください。Automation サービスの制限に関する詳細についてご確認ください。
このアクションでは、メールのメッセージ ID が監査ログに自動的に記録されます。メールを追跡する必要がある場合は、<message-id>@automation.atlassian.com の形式で記録された情報を使用してください。
スマート バリューの使用: あり
Microsoft Teams のメッセージを送って、ルール実行時にチームに通知します
このアクションのメッセージはパーソナライズできます。Microsoft Teams で自動化を使用する方法の詳細をご確認ください。
スマート バリューの使用: あり
ルールの実行時にチームや個人に通知するために Slack のメッセージを送信します
このアクションのメッセージはパーソナライズできます。Slack で自動化を使用する方法の詳細をご確認ください。
スマート バリューの使用: あり
Twilio サービスを使用して通知を送信します。
このアクションは、オンコール シナリオで SMS を利用するサービス チームで役立ちます。
スマート バリューの使用: あり
発信 Web リクエストを送信して、ルール実行時に別のシステムに通知します。 後続のアクションで使える応答データを返すようにこのアクションを設定できます。
以下の 3 つの形式から選択できます。
課題データ (Jira 形式) - Jira Cloud のレガシー自動化機能を含む Jira Cloud の大部分で使用される形式。Jira 形式の詳細についてご確認ください。
課題データ (Automation 形式) - Jira Cloud Automation コンポーネントで使用される形式。自動化形式の詳細についてご確認ください。
カスタム形式 - 独自のデータ形式を入力するには、このオプションを選択します。
[非表示] チェックボックスを選択して、各ヘッダーを非表示にすることもできます。その場合、値はアスタリスク (*****) としてのみ表示されます。値を確認したり、ペイロードを調べたりすることはできません。
一度値を非表示にすると、元に戻すことはできません (つまり、[非表示] チェックボックスを選択解除することはできません)。ただし、ルールを編集する際に値自体を変更することはできます。
スマート バリューの使用: あり
Jira Service Management のプロジェクトに新しい顧客を追加します。
スマート バリューはすべてのフィールドで使用でき、既存組織に顧客を追加できます。
このアクションを短い間隔で複数回連続して呼び出した場合、カスタマーが存在するものの、ユーザーの検索結果にはまだ表示されないため、最初の呼び出しは成功し、後続の呼び出しは失敗します。検索結果に新しいユーザーが表示されてこの問題が解決されるまで、最大で15 秒かかります。
{{customer}} のスマート バリューでは、検索結果に表示できない既存のユーザーは返されないため、エラーが発生します。
この課題がルールに影響する場合、課題データの再取得アクションを何回かサービス プロジェクト顧客を追加アクションの直前に加えて、ルールの実行を遅らせることができます。ただし、この方法がうまくいかないケースもあります。
スマート バリューの使用: なし
Jira Service Management のリクエストを承認または却下します。ワークフローを進めるために必要な承認者の数は問いません。
このアクションを現在のワークフロー ステータスで承認が保留されている Jira Service Management の課題に使用できます。承認はワークフロー経由で管理されます。Jira Service Management での承認の詳細をご確認ください。
スマート バリューの使用: あり
選択したリクエスト タイプを使用して、Jira Service Management プロジェクトに新しい課題を作成します。
このアクションでは、サービス プロジェクトに追加したすべてのリクエスト タイプを使用できます。リクエスト タイプをポータル グループに整理する方法をご確認ください。
[課題を作成] アクションと同様に、このアクションではスマート値を使用して任意のフィールドを設定できます。
スマート バリューの使用: あり
必要な権限: プロジェクトの参照、課題の作成
このアクションが実行されると、Jira Service Management の選択したサービス プロジェクトに、選択したリクエスト タイプのインシデントが作成されます。たとえば、課題が作成され、特定の基準を満たした場合に、このアクションを使用して新しいインシデントを作成できます。
アクションによってプロジェクト内に同じタイプの未解決のインシデントがすでに作成されている場合は、新しいインシデントが作成されないようにすることもできます。
このアクションを使用するには、サービス プロジェクトとインシデントのリクエスト タイプが必要です。
スマート バリューの使用: あり
課題を割り当てられる新しいバージョンを作成します。
同じ名前のバージョンがすでに存在する場合は、新しいバージョンは作成されません。
スマート バリューの使用: あり
バージョンをリリースします。
デフォルトでは、このアクションによって、次回リリース予定のバージョンのプロジェクトは既存のリリース日にリリースされます。これは、「リリース」で設定されたバージョンの順序に基づいて決定されます。
リリースする特定のバージョンを選択し、スマート バリューを使って動的な名前を設定できます。
スマート バリューの使用: あり
添付ファイルのファイル名に基づいて、正規表現の一致を使って添付ファイルを削除します。
スマート バリューの使用: あり
監査ログに値を記録します。
このアクションは、スマート バリューのテストやルールのデバッグの際に役立ちます。
スマート バリューの使用: なし
最新のフィールド値でスマート バリューを更新します。
デフォルトでは、{{issue}} 参照値はルールの実行中には更新されず、ルールが最初にトリガーされたときと同じ値が含まれます。
スマート バリューの使用: あり
ルール実行のトリガー課題に関連する課題、プロジェクト、ユーザーにエンティティのプロパティを設定します。
これらの非表示のプロパティは、特定の機能でアプリに使用されます。エンティティのプロパティでは、プラグインから課題とプロジェクトにキー/値ストアを追加できます。これらの値は、REST API または JQL を使ってインデックス化してクエリを実行できます。
スマート バリューの使用: あり
選択したプロジェクトのリリース済みバージョンのリリースを元に戻します。初期設定ではこれはルールのプロジェクトですが、[その他のオプション] を選択して、異なるプロジェクトを選択できます。
スマート バリューの使用: あり
このアクションを実行すると、選択した Amazon Simple Notification Service トピックに JSON メッセージが送信されます。最大 10 件のキーと値のペアをアクションに追加できます。さらに追加する場合は、サポートにお問い合わせください。
アラート トリガーを使用した場合は、ID、優先度、ステータス、タグなどの "アラート" フィールドを JSON メッセージに含められます。
スマート値はすべての値タイプ (文字列、リスト、数値、ブール値、カスタム) で使用できます。ただし、カスタムはスマート値のみをサポートしています。
Amazon SNS トピックで Atlassian Automation によるメッセージの公開が許可されていることを確認してください。Amazon SNS の設定の詳細をご確認ください。
スマート バリューの使用: あり
このアクションを実行すると、選択した AWS Systems Manager ドキュメントが実行されます。ドキュメントの事前設定されたパラメータに値を追加できます。
IAM ロールに、Atlassian Automation が SSM ドキュメントにアクセスして実行することを許可する権限ポリシーがあることをご確認ください。AWS IAM の設定に関する詳細をご確認ください。
スマート バリューの使用: なし
このアクションを実行すると、Microsoft Azure で選択された仮想マシンがアトラシアン自動化によって再起動されます。
ルールの接続を認証するために、Microsoft Azure のプロファイル情報に電子メールが追加されていることを確認します。Microsoft Azure でプロファイル情報を追加または変更する方法をご確認ください。
この内容はお役に立ちましたか?