ワークフローレシピ：オートアシストを使用したトラブルシューティングのJira課題の作成

アドオン

Copilot

この機能を利用するには、Copilotアドオンが必要です。

エージェントがZendeskを使用してエンドユーザーとやりとりした結果、ITやエンジニアリングチームの支援が必要になった際には、Jira課題を作成することが一般的です。

このレシピでは、プロセスの効率化を図るため、エージェントには一般的な問題のトラブルシューティングを行わせ、専門的な支援が必要な場合には、ITチーム向けのJira課題を自動的に作成させるようにガイドするオートアシストのプロシージャを作成する方法を説明します。

この記事では、以下のトピックについて説明します。

ワークフローの目標
前提条件
Jiraプロジェクトを作成する
JiraアプリとOAuthクライアントを作成する
クライアントIDとシークレットを取得する
Jira Cloud IDを見つける
Jira OAuthクライアントをZendeskに登録する
ZendeskとJara間のコネクションを作成する
Jira課題を作成するアクションを作成する
エージェントをガイドするプロシージャを作成する
ワークフローをテストする
プロシージャをカスタマイズする
問題のトラブルシューティングを行う

ワークフローの目標

オートアシストを使用して、エージェントが一般的なIT問題をトラブルシューティングできるようにし、必要に応じて、ITチームにサポートを依頼するためにJiraのチケットを作成します。

これを実現するために、以下の操作を行います。

Jiraの操作：
- Jiraの既存のプロジェクトを見つけるか、新規プロジェクトを作成し、Jiraのチケットを作成できるようにします。
- Jira OAuthクライアントを作成します。
Zendeskの操作：
- 作成したJira OAuthクライアントを登録して、OAuthトークンの作成に使用できるようにします。
- コネクションを接続を設定することで、OAuthトークンを簡単に生成し、アクションで使用するために安全に保存できます。
- コネクションを使用してJira APIにコールを実行し、Jira課題を作成するアクションを作成します。
- プロシージャを作成し、Jira課題の作成にエージェントをガイドするために必要なステップをオートアシストに指示します。
- すべてが正常に動作することをテストします。

前提条件

このワークフローを完了するには、以下のものが必要になります。

Jira Cloudインスタンス
ヒント：すべてが正常に動作するまでは、本番のJiraインスタンスではなく、新しいJiraサンドボックスまたは無料プランのインスタンスを使用する方法もあります。
プロジェクトを作成し、そのプロジェクト内に課題を作成し、Jira OAuthクライアントを作成するのに十分な権限が付与されたJiraユーザー。
ヒント：Jiraの無料プランを使用している場合は、すべてのユーザーが管理者であり、必要な権限が与えられています。
CopilotアドオンがあるZendeskアカウント。
Zendeskアカウントの管理者ユーザーのログイン情報。

Jiraプロジェクトを作成する

Jiraで使用するプロジェクトを見つけるか、新規プロジェクトを作成します。プロジェクトがスクラム型かカンバン型であるかは問いません。Jiraユーザーがプロジェクトにアクセスできることを確認します。

プロジェクトのキー（例：ENGREQ）をメモしておきます。これは後で必要になります。

JiraアプリとOAuthクライアントを作成する

JiraアプリとOAuth 2.0インテグレーションを作成するには、Jira Cloudプラットフォームのドキュメント「Enabling OAuth 2.0 (3LO)」に記載された手順を実行します。また、次の値を必ず設定してください。

アプリとOAuthクライアントを作成する際に、折り返し電話URLを次のように設定します。

https://zis.zendesk.com/api/services/zis/connections/oauth/callback

メモ：必ず上記のURLを正確に指定してください。「zis」の箇所を独自のサブドメインに変更しないでください。zisはZendeskとJira間のインタラクションを安全に処理するZendeskのサービスです。

アプリにAPIを追加する場合：

左メニューの「Permissions」を選択します。
「Jira API」を見つけたら、「Add」をクリックします。
しばらくすると、「Add」ボタンが「Configure」に変わります。
「Configure」をクリックします。
Jira platform REST APIを見つけ、「Edit Scopes」をクリックします。
「View Jira issue data」と「Create and manage issues」が選択されていることを確認します。
これにより、後で作成するアクションでJira課題の作成、読み取り、編集が可能になります。
「保存」をクリックします。

クライアントIDとシークレットを取得する

Jiraで、クライアントIDとシークレットを取得します。

「Jira Developer Console」を開きます。
「Settings」タブをクリックします。
Client ID」と「Secret」の値をメモします。

Jira Cloud IDを見つける

Jira Developer Consoleにログインした状態で、次のサイトに移動します。

https://<YOUR_JIRA_SUBDOMAIN>.atlassian.net/_edge/tenant_info

Cloud IDをメモしておいてください。後でアクションを作成する際に、このIDが必要になります。

Jira OAuthクライアントをZendeskに登録する

Jira OAuthクライアントを登録すると、APIリクエストを使用してやりとりする必要がなくなり、Zendesk内でJira OAuthクライアント使用できるようになります。

Jira OAuthクライアントをZendeskに登録するには

管理センターで、サイドバーにある「 アプリおよびインテグレーション」をクリックし、「コネクション」>「OAuthクライアント」を選択します。
「クライアントを追加」をクリックします。
以下のフィールドに入力します。
- 名前：後で簡単に見分けられるように、分かりやすいクライアント名を付けます（例：Jira_client）。
- OAuthグラントタイプ：認証コード
- クライアントID：JiraクライアントのID
- クライアントシークレット：Jiraクライアントのシークレット
- 認証URL：auth.atlassian.com/authorize Token URL: auth.atlassian.com/oauth/token
- スコープ：read:jira-work write:jira-work offline_access
「保存」をクリックします。

ZendeskとJara間のコネクションを作成する

次に、コネクションを作成して、ZendeskがJiraインスタンスにアクセスできるようにします。

ヒント：コネクションの詳細については、「ボットビルダーとオートアシストアクション用のAPIコネクションの作成」を参照してください。

コネクションを作成するには

管理センターで、サイドバーの「 アプリおよびインテグレーション」をクリックし、「コネクション」>「コネクション」を選択します。
「コネクションを作成」をクリックします。
以下のフィールドに入力します。
- コネクション名：後で簡単に見分けられるように、分かりやすいコネクション名を付けます（例：Jira_oauth_token）。
- 認証タイプを選択する：OAuth 2.0
- クライアント：Zendeskに登録したJira OAuthクライアントを選択します。
- スコープ：空白のままにしておきます。
- 許可されたドメイン：api.atlassian.com
「保存」をクリックします。
OAuth画面が表示され、ZendeskからJiraインスタンスにアクセスできるようになります。

ヒント：この画面が表示されない場合は、ブラウザでブロックされていないか確認してください。
「承諾」をクリックします。
「コネクション」ページに戻ると、新しいコネクション用の新しいエントリが表示されます。作業中の「コネクションを作成」画面がまだ開いている場合は、ここで閉じても問題ありません。

Jira課題を作成するアクションを作成する

Zendeskで、Jira課題のAPIエンドポイントを使用して新しい課題を作成するアクションを作成します。

ヒント：アクションの詳細については、「オートアシストのアクションの作成と管理」を参照してください。

アクションを作成するには

管理センターで、サイドバーにある「 アプリおよびインテグレーション」をクリックし、「アクション」>「アクション」を選択します。
「アクションを作成」をクリックします。
「名前」フィールドに「Create IT task」と入力します。
「説明」フィールドに「Creates an IT task for the team to do, and responds with the ID of the task」と入力します。

以下の3つの入力を定義します。

入力の名前	入力の説明	入力のデータ型
名前	タスクの簡潔な名前。	文字列
description	タスクの詳しい説明。200文字以内の制限があります。	文字列
priority	タスクの深刻度や緊急度を示します。1つの数字で優先度を表します。有効な値は通常、2（深刻度や緊急度が高い問題）、3（標準的な問題）、4（深刻度や緊急度が低い問題）です。	文字列

メモ：Jiraの設定によっては、優先度に使用する数値を変更する必要がある場合があります。

「API設定」を定義します。
- リクエスト方法：POST
- エンドポイントURL：https://api.atlassian.com/ex/jira/<YOUR_Jira_CLOUD_ID>/rest/api/2/issue
- 認証：上述の手順で作成したコネクションを選択します。
「本文」を定義します。
```
{
"fields": {
   "summary": "{{name}}",
   "description": "{{description}}",
   "priority": {
      "id": "{{priority}}"
      },
   "issuetype": {
      "id": "10004"
      },
   "project": {
      "key": "ENQREQ"
      }
   }
}
```
本文を定義する際には、以下の点に留意してください。
- priority、name、descriptionのプレースホルダを挿入する場合は、{+}アイコンを使用します。
- プロジェクトキーの値は、前の手順で取得したキーである必要があります。
- 10004 はJira課題タイプ「Task」のデフォルトのIDです。Jiraの設定によっては、別のIDを使用する必要がある場合があります。Jiraの課題タイプIDの確認方法については、こちらを参照してください。
出力を定義します。

出力の名前 出力の説明

task_id 人間が容易に判読できる形式の新しいタスクID。
「保存」をクリックします。

エージェントをガイドするプロシージャを作成する

次に、オートアシストがエージェントをガイドする際に使用できるプロシージャを作成します。

ヒント：プロシージャの詳細については、「オートアシストのプロシージャの作成と管理」を参照してください。

プロシージャを作成するには

ナレッジベース管理者で、サイドバーにあるプロシージャをクリックします。
「プロシージャを作成」をクリックします。
「名前」フィールドに、わかりやすいプロシージャ名（例：「ITタスクヘルパー」）を入力します。
本文フィールドに以下の内容を入力します。
あなたの仕事は、ITチームのITタスク作成を支援することです。
ステップ1：ユーザーに、どんなサポートが必要かを尋ねてください。
- 以下のような、よくあるリクエストをリストアップします。
  - 新しいアクセスカードの発行依頼
  - ドライブトレイが開かない
  - プリンターの問題
  - その他
ステップ2：タスクについて詳しい情報を収集します。
- 新しいアクセスカードの発行依頼：ユーザーに氏名、役職、目の色を尋ねる。
- ドライブトレイが開かない：ユーザーにPCタワーの前面にあるボタンを押してみたかどうかを尋ねる。右クリックして取り出すことを試してみたかどうかを尋ねる。
- プリンターの問題：ユニットの前面に表示があるプリンターの名前を尋ねる。問題についてさらに詳しい情報を尋ねる。
- その他：これには上述の問題に該当しないものが含まれる。ユーザーに問題の内容を説明してもらう。
ステップ3：優先度を決定します。
1. ユーザーに、この問題がユーザーにどのような影響を与えているか、また、どの程度緊急に解決する必要があるかを尋ねる。
2. この情報を基に、優先度を2（高）、3（通常）、4（低）のいずれかに設定する。
ステップ4：問題を要約し、ユーザーに確認します。
1. 提供された情報に基づいて、タスクの名前と説明を作成する。説明は200文字以内に制限されている。
2. ユーザーにタスク名と説明を見せて、確認してもらう。
  - ユーザーの確認が終わるまでは、タスクを作成しない。
ステップ5：ITタスクを作成します。
1. ユーザーに、これからタスクを作成するのでしばらくお待ちくださいと伝える。例：「タスクの詳細を確認していただきありがとうございます。ただ今、チームにタスクを記録しますので、しばらくお待ちください。」
2. 次に、ステップ3と4で作成した名前、説明、優先度を使用してITタスクを作成する。
ステップ6：ITタスクIDを共有します。
- ITタスクが作成されたら、ユーザーにタスクIDを伝える。
ステップ7：後処理を行います。
- ユーザーに感謝の意を伝え、会話を終了する。
「保存」をクリックします。

メモ：Jiraの設定によっては、上記のサンプルプロシージャのステップ3で優先度に使用した数値を変更する必要がある場合があります。これらの数値は、このワークフローレシピの冒頭でJiraアクションを作成した際に優先度の入力に設定した値と一致している必要があります。

ワークフローをテストする

ワークフローをテストする最も簡単な方法は、会話ボットのテスト機能を使用することです。

会話ボットでワークフローをテストするには

会話ボットで、「エージェントへの転送」ステップタイプを含む回答を開くか、作成します。
「エージェントへの転送」ステップで、タグagent_copilot_enabledを追加します。
会話ボットの編集ページで、「ボットをテスト」をクリックします。
詳しいテスト方法については、「公開前に会話ボットをテストする」を参照してください。
作成した回答に関連するフレーズを使用して、ボットとの会話を開始します。
このブラウザウィンドウでは、エンドユーザーのロールで操作します。
別のブラウザウィンドウで、Zendeskエージェントワークスペースを開きます。
ここで、あなたがエージェント役を務めます。新しい会話の通知がポップアップ表示されるはずです。
エージェントとして、オートアシストの提案に従ってエンドユーザーに返信します。
エンドユーザーとして、要求された情報を返信します。
Jira課題が作成されたら、リンクを開いて作成された課題を確認します。

プロシージャをカスタマイズする

このワークフローレシピのプロシージャとアクションは、必要に応じてさらにカスタマイズできます。以下に例を示します。

プロシージャのステップ1とステップ2では、一般的なタスクとトラブルシューティングの手順のリストを、特定の要件に合わせて変更できます。
プロシージャのステップ3では、さらに異なる優先度レベルを追加できます。優先度を追加する場合は、作成したアクションの入力も更新してください。
Jira課題の対応するフィールドに追加される追加情報（問題が発生している環境やカスタムフィールドのデータなど）を収集するためのステップを追加することもできます。ステップを追加する場合は、作成したアクションの入力と本文も更新してください。

また、同様の「ITタスクの進捗状況についてお知らせしますか？」というプロシージャを作成し、エンドユーザーがチケットの進捗状況を把握できるようにすることもできます。このプロシージャは、次のように開始します。

課題IDに基づいてJira課題を取得し、ステータスや最終更新時刻などの情報を出力として返す新しいアクションを作成する。
ユーザーに課題IDを尋ね、その課題の最新情報をユーザーに返す新しいプロシージャを作成する。

問題のトラブルシューティングを行う

Jiraでの認証に問題が発生した場合：

Jiraユーザーがプロジェクトにアクセスする適切な権限を持っていることを確認します。

アクションで問題が発生した場合：

インテグレーションのログでアクションの実行を確認します。
アクションの数値がJiraの設定と一致していること（例：優先度2/3/4、課題タイプ10004）、およびプロジェクトの正しいキー（例：ENGREQ）を使用していることを確認します。

プロシージャが期待通りに機能しない場合：

アクションの名前と説明、およびその入力と出力が、プロシージャで使用している名前と一致していることを確認してください。

チケットでオートアシストが開始しない場合：

テストしているZendeskユーザーが、オートアシストにアクセスできるグループのメンバーであることを確認してください。詳しくは「オートアシストへのアクセスの有効化と設定」を参照してください。
会話ボットの回答に、agent_copilot_enabledタグが含まれていることを確認してください。

出力の名前	出力の説明
task_id	人間が容易に判読できる形式の新しいタスクID。