Zoho DeskのGitLab拡張機能

Zoho DeskのGitLab拡張機能

GitLabは、ソフトウェア開発を統合的に管理するためのサービスです。ソースコード管理に加えて、プロジェクト管理や自動テスト（CI/CD）を行うこともできます。Zoho Deskでは、GitLabと連携することが可能です。顧客からの問い合わせの管理や顧客とのやりとりをZoho Deskで行い、不具合やエラーへの対応をGitLabで行うことができます。サポートチームと開発チーム間の共同作業を円滑に進めるのに役立ちます。

Zoho DeskのGitLab連携機能を有効にすると、Zoho Deskの問い合わせをGitLabのイシュー（Issue）に変換して関連付けることが可能です。これにより、サポートチームと開発者チームは問い合わせのデータを共有して対応を進めることができます。

たとえば、オンラインストアで決済手続きのページに移動できないという問い合わせをZoho Deskで受け付けたとします。サポート担当者は、Zoho Deskの操作画面内からこの問い合わせをGitLabのイシューに変換することが可能です。変換されたイシューには問い合わせの件名や説明などの詳細が登録され、開発チームに自動で割り当てられます。 

開発チームの開発者は、GitLabでイシューの内容を確認して不具合やエラーへの対応を進めることができます。GitLabでイシューのステータスが変更されると、Zoho Deskの問い合わせの詳細ページにコメントとして変更内容が追加されます。たとえば、開発者がGitLabで不具合やエラーが解決してイシューを完了すると、該当の問い合わせの詳細ページにイシューが完了した旨のコメントが追加されます。
情報必要な権限
この機能を利用するには、システム管理者の権限が必要です。
各プランの機能と制限を確認する

拡張機能のインストール

連携機能を設定するには、GitLabアカウントとZoho Deskアカウントの管理者権限が必要です。また、GitLabでClient ID（クライアントID）とSecret（シークレット）を生成する必要があります。
Zoho Deskから拡張機能をインストールするには
  1. ［設定］→［連携］→［マーケットプレイス］の順に移動します。
  2. 検索欄で「GitLab」と入力します。
  3. ［GitLab for Zoho Desk］を選択して、［インストールする］をクリックします。
  4. 一般設定の画面で、以下の手順を実行します。
  5. 拡張機能を追加する部門を選択します。
  6. 拡張機能の使用を許可する権限を選択します。
  7. 利用規約の内容を確認し、同意のチェックボックスにチェックを入れます。
  8. ［インストールする］をクリックします。
    認証ページに移動します。
各サービスを認証するには
  1. Zoho Sigmaの認証
    1. ［認証する］をクリックします。
    2. OAuthの拡張機能用のクライアントIDの作成画面に移動します。
    3. 表示された画面で、［作成する］をクリックします。
    4. ［承諾する］をクリックします。

  2. Zoho Deskの認証
    1. マーケットプレイスのGitLab拡張機能の詳細ページに移動します。
    2. Zoho OAuthの認証のポップアップ画面が表示されます。［認証する］をクリックします。
    3. Zoho OAuthの認証画面に移動します。
    4. ［Connect］（接続する）をクリックして対象の組織を選択し、［Submit］（送信する）をクリックします。

  3. GitLabの認証
    1. GitLabの認証のポップアップ画面で、［認証する］をクリックします。
    2. GitLabとの連携の確認画面に移動します。
    3. ［Connect］（接続する）をクリックします。GitLabのログインページに移動します。
    4. GitLabにログインします。
    5. ［Profile］（プロファイル）→［Preferences］（各種設定）→［Applications］（アプリケーション）の順に移動します。
    6. ［Add New Application］（新しいアプリケーションを追加する）をクリックします。
    7. アプリケーション名を入力します。
      1. ［Redirect URI］（移動先のURI）の項目に、説明欄に記載されているClient ID（クライアントID）をコピーして貼り付けます。
      2. ［Scopes］（スコープ）の項目で、［API］を選択します。
      3. ［Save Application］（アプリケーションを保存する）をクリックします。
    8. 以下の詳細をコピーして貼り付けます。
      1. Application ID（アプリケーションID）をコピーして、［Client ID］の項目に貼り付けます。
      2. Secret Key（シークレットキー）をコピーして、［Client Secret］（クライアントシークレット）の項目に貼り付けます。
    9. ［GitLab Host Name］（GitLabのホスト名）の項目に、GitLabのドメインを入力します（例：gitlab.com、または独自のオンプレミス版のホスト）。
    10. Zoho Deskの画面に戻り、認証情報を入力します。
    11. ［Authorize］（認証する）をクリックします。
    12. アプリケーションによるアカウントへのアクセス申請に関するアプリ内通知が表示されます。
    13. ボタンをクリックして、申請を承認します。
GitLabでクライアントIDやクライアントシークレットを生成する方法については、こちらをご参照ください。

Zoho DeskとGitLabのデータの関連付け

認証の完了後、Zoho Deskの各種設定ページに移動します。こちらから、Zoho Deskの部門とGitLabのプロジェクトを関連付ける必要があります。これにより、サービス間で問い合わせのデータを共有、確認できるようになります。 
メモ
メモ
各種設定ページの［GitLab Domain］（GitLabのドメイン）の項目の値は、GitLabの認証ページで入力したホスト名の値と同じにする必要があります。
GitLabのホスト名を更新する場合は、GitLab側で更新してから、各種設定ページで更新してください。
Zoho DeskとGitLabのデータを関連付けるには
  1. ［設定］→［連携］→［マーケットプレイス］の順に移動します。
  2. GitLab拡張機能の詳細ページに移動します。
  3. ［各種設定］タブをクリックします。
  4. GitLabのホスト名の関連付けを行います。例：xyz.com
  5. GitLabの部門の関連付けを行います。
    1. 一般設定で選択した部門が自動で入力されます。
    2. 部門に関連付けるGitLabのプロジェクトを選択します。
  6. ［保存する］をクリックします。

Zoho DeskとGitLab間でのステータスとコメントの同期

Zoho Deskの問い合わせとGitLabのイシューのデータ間においてステータスとコメントを同期するにあたって、4種類の選択肢があります。
選択肢の内容は、以下のとおりです。
  1. ステータスの設定のセクションで指定可能な選択肢
    1. 1番目の切り替えボタンを操作すると、Zoho Deskの問い合わせのステータスが変更された際に、対象のGitLabのイシューにコメントが追加されます。たとえば、サポート担当者がZoho Deskで問い合わせのステータスを「保留中」に変更すると、該当の問い合わせに関連付けられているGitLabのすべてのイシューにコメントが追加されます。
    2. 2番目の切り替えボタンを操作すると、GitLabのイシューのステータスが変更された際に、対象のZoho Deskの問い合わせにコメントが追加されます。たとえば、開発者がGitLabでイシューを完了すると、該当のイシューに関連付けられているZoho Deskのすべての問い合わせにその旨のコメントが追加されます。
  2. コメントの設定のセクションで指定可能な選択肢
    1. 1番目の切り替えボタンを操作すると、Zoho Deskの問い合わせにコメントが追加された際に、対象のGitLabのイシューにコメントが追加されます。たとえば、サポート担当者がZoho Deskで問い合わせに「顧客から進捗状況の確認あり」とコメントを追加すると、該当の問い合わせに関連付けられているGitLabのすべてのイシューにコメントが同期され、表示されます。
    2. 2番目の切り替えボタンを操作すると、GitLabのイシューにコメントが追加された際に、対象のZoho Deskの問い合わせにコメントが追加されます。たとえば、開発者がGitLabでイシューに「不具合への対応を開始」とコメントを追加すると、該当のイシューに関連付けられているZoho Deskのすべての問い合わせにコメントが同期され、表示されます。
ステータスとコメントの同期を設定するには
  1. ［設定］→［連携］→［マーケットプレイス］の順に移動します。
  2. GitLab拡張機能の詳細ページに移動します。
  3. ［各種設定］タブをクリックし、［Configure actions］（処理の設定）の欄に移動します。
  4. ステータスの設定のセクションで、必要に応じて以下の操作を実行します。
    1. ［Add a comment to the GitLab Issues when the status of the Zoho Desk Ticket changes］（Zoho Deskの問い合わせのステータスが変更された際に、対象のGitLabのイシューにコメントを追加する）の切り替えボタンを有効にできます。
    2. ［Add a comment to all linked Zoho Desk Tickets when the status of the GitLab Issue changes］（GitLabのイシューのステータスが変更された際に、対象のZoho Deskの問い合わせにコメントを追加する）の切り替えボタンを有効にできます。
  5. コメントの設定のセクションで、以下の操作を実行します。
    1. ［Add a comment to the GitLab Issue when a comment is added to the Zoho Desk Ticket］（Zoho Deskの問い合わせにコメントが追加された際に、対象のGitLabのイシューにコメントを追加する）の切り替えボタンを有効にできます。
    2. ［Add a comment to all linked Zoho Desk Tickets when a comment is added to the GitLab Issue］（GitLabのイシューにコメントが追加された際に、対象のZoho Deskの問い合わせにコメントを追加する）の切り替えボタンを有効にできます。

コメントの追加

Zoho Deskの問い合わせにコメントを追加すると、該当の問い合わせが関連付けられているGitLabのイシューに同じコメントが表示されます。たとえば、サポート担当者がZoho Deskでコメントに「顧客の確認待ち」とコメントを追加すると、該当の問い合わせが関連付けられているGitLabのイシューに同じコメントがNote（メモ）として自動で表示されます。
コメントを追加するには
  1. ［問い合わせ］タブに移動します。
  2. 対象の部門を選択します。
  3. 対象の問い合わせを開きます。
  4. 画面左側のパネルで、（GitLabのイシュー）アイコンをクリックします。
  5. 該当の問い合わせに関連付けられているGitLabのすべてのイシューが表示されます。
    1. 関連付けられているGitLabのすべてのイシューにコメントを追加するには
      1. （コメント）アイコンをクリックします。
      2. 関連付けられているGitLabのすべてのイシューに追加するコメントを入力します。
      3. ［コメントする］をクリックします。
    2. 関連付けられているGitLabの特定のイシューにのみコメントを追加するには
      1. 対象のイシューをクリックします。
      2. （コメント）アイコンをクリックします。
      3. 関連付けられているGitLabのイシューに追加するコメントを入力します。
      4. ［コメントする］をクリックします。
メモ

メモ

  • 公開、非公開の両方のコメントを関連付けられているGitLabのイシューに追加できます。

問い合わせとイシューの関連付け 

Zoho Deskの問い合わせとGitLabのIssuを関連付けるにあたって、新しいイシューを作成したり、既存のイシューを選択したりできます。

問い合わせとイシューを関連付けるには
  1. Zoho Deskの［問い合わせ］タブに移動します。
  2. 対象の部門を選択します。
  3. イシューに関連付ける問い合わせを開きます。
  4. 画面右上にある（その他の操作）アイコンをクリックします。
  5. GitLabのイシューを作成するためのメニューを選択します。
  6. GitLab拡張機能のパネルが画面左側に表示されます。以下のいずれかの操作を行います。
    1. GitLabの新しいイシューを作成する：新しいイシュー を作成するには、以下の詳細を入力し、手順を実行します。
      1. Project（プロジェクト）：選択した部門に関連付けるGitLabのProjectです。
      2. Issue Type（課題の種類）：イシューの種類を選択します。
      3. Title（件名）：問い合わせの件名がイシューの件名として自動で入力されます（必要に応じて編集できます）。
      4. Description（説明）：問い合わせの説明がイシューの説明として自動で入力されます。
      5. Assignees（担当者）：イシューの担当者を選択します。
      6. Labels（ラベル）：既存のラベルを追加し、イシューを分類します。
      7. Milestone（マイルストーン）：イシューとマイルストーンを関連付けます。
      8. Due Date（期限）：イシューの対応期限を設定します。
      9. ［作成する］をクリックし、新しいイシューを作成して問い合わせに関連付けます。
    2. 問い合わせと既存のイシューを関連付ける：問い合わせを関連付けるにあたって既存のイシューを選択するには、以下の詳細を入力し、手順を実行します。
      1. Project（プロジェクト）：関連付けるGitLabのProjectを選択します。
      2. Search By（検索方法）：検索する方法を選択します。例：イシュー、タスク
      3. Search（検索）：ID、件名、キーワードを入力し、イシューを検索します。
      4. 検索結果から、対象のイシューを選択します。
      5. ［関連付ける］をクリックします。

問い合わせに関連付けられているGitLabのイシューを確認するには 

  1. ［問い合わせ］タブに移動します。
  2. 対象の部門を選択します。
  3. 対象の問い合わせを開きます。
  4. 画面左側のパネルで、（GitLabのイシュー）アイコンをクリックします。
  5. 該当の問い合わせに関連付けられているGitLabのすべてのイシューが表示されます。いずれかのイシューをクリックすると、問い合わせの詳細ページにイシューの詳細が表示されます。

 問い合わせとイシューの関連付けを解除するには

  1. ［問い合わせ］タブに移動します。
  2. 対象の問い合わせを開きます。
  3. 画面左側のパネルからGitLabのイシューのウィジェットを開きます。
  4. 対象のイシューを開きます。
  5. アイコンをクリックし、関連付けを解除します。
  6. 確認画面で、操作を確定します。
関連付けを解除すると、問い合わせとイシューの間でコメントやステータスの同期が行われなくなります。

拡張機能の無効化

必要に応じて拡張機能をアンインストールしたり、一時的に無効にしたりできます。
拡張機能を無効にするには
  1. ［設定］→［連携］→［マーケットプレイス］の順に移動します。
  2. ［インストール済みの拡張機能］をクリックします。
  3. GitLab拡張機能の画面を開きます。
  4. 切り替えボタンを操作して、拡張機能を無効にします。
  5. 確認画面で、操作を確定します。