ビュー

このガイドでは、GitLab で Zendesk ビューを作成、編集、管理する方法について説明します。既存のビューを変更したいサポートエージェントは、ビューで使用するフィールド、グループ化、ソートの変更を参照してください。管理者は管理者タスクセクションを確認してください。

ビューについて

ビューとは

Zendeskによると:

ビューは、特定の条件に基づいてチケットをリストにグループ化することで、チケットを整理する方法です。たとえば、自分に割り当てられた未解決チケットのビュー、新しくトリアージする必要があるチケットのビュー、応答待ちの保留チケットのビューを作成できます。ビューを使用すると、自分またはチームが注意を払う必要があるチケットを判断し、それに応じて計画を立てるのに役立ちます。

ビューの種類

現在、Zendesk には 3 種類のビューがあります。

• デフォルト: Zendesk が作成した事前定義済みのビュー
• 共有: Zendesk Administrator（例: Customer Support Systems）が作成したビュー
• 個人用: 自分が作成し、自分のみが使用できるビュー

ビューの制限事項

現在、Zendesk ビューにはいくつかの制限があります。

• ビューでは「定義」されていない条件を使用できません。つまり、選択可能なデータである必要があります（たとえば、テキストフィールドは機能しません）。
• ビューにはアーカイブ済みチケット（つまり、120 日後の Closed チケット）は含まれません。

ビューはネストできる

ビューのタイトルで二重コロン（つまり ::）を使用すると、ビュー同士をネストできます。

たとえば、次のビューがあるとします。

• Support Agents Tier 1 Normal tickets
• Support Agents Tier 1 Escalated tickets
• Support Agents Tier 2 Normal tickets
• Support Agents Tier 2 Escalated tickets
• Support Agents Tier 3 Normal tickets
• Support Agents Tier 3 Escalated tickets

これらを次のように名前変更できます。

• Support Agents::Tier 1::Normal tickets
• Support Agents::Tier 1::Escalated tickets
• Support Agents::Tier 2::Normal tickets
• Support Agents::Tier 2::Escalated tickets
• Support Agents::Tier 3::Normal tickets
• Support Agents::Tier 3::Escalated tickets

結果として、ビューは次のように表示されます。

• Support Agents
  • Tier 1
    • Normal tickets
    • Escalated tickets
  • Tier 2
    • Normal tickets
    • Escalated tickets
  • Tier 3
    • Normal tickets
    • Escalated tickets

上記の Support Agents、Tier 1、Tier 2、Tier 3 は実際にはビューではなく（ネスト用に表示されるカテゴリです）。ファイル構造のように考えてください（カテゴリがフォルダーで、実際のビューがファイルです）。

ビューでは条件ロジックを使用する

ビューでは条件ロジックを使用します。

• all: 配列内のすべての条件が真である必要があります（AND ロジック）
• any: 配列内の少なくとも 1 つの条件が真である必要があります（OR ロジック）
• 1 つのセットのみ、または両方のセットを使用できます（ただし、少なくとも 1 つのセットを使用する必要があります）

ビューの管理方法

Zendesk では UI を通じてビューを完全に管理できますが、私たちはよりバージョン管理された手法を採用しています。これにより、設定されたレビュー手順、必要に応じたロールバックの実行などが可能になります。

そのため、同期リポジトリと管理対象コンテンツリポジトリを使用します。

同期リポジトリの仕組み

同期リポジトリのワークフローは、次のプロセスに従います。

graph TD;
  A-->C;
  B-->C;
  C-->D;
  A(Scheduled time for pipeline to run)
  B(Scheduled pipeline triggered manually)
  C(bin/sync runs)
  D(Changes synced to Zendesk)

人間が読みやすい置換

現在、同期リポジトリは、人間が読みやすい項目から Zendesk の同等の項目へのさまざまな置換を実行できます。これには次が含まれます。

制限オブジェクトでも変換を実行できます（詳細はそのセクションを参照してください）。

たとえば、チケットのフォームが SaaS フォームではないかを確認する条件がある場合は、次のようにします。

- field: 'ticket_form_id'
  operator: 'is_not'
  value: 'Form: SaaS'

同期リポジトリで MR を作成する場合

同期リポジトリで MR を作成すると、比較アクション（bin/compare スクリプト経由）が実行され、次の処理を行います。

1. 管理対象コンテンツリポジトリのクローンを実行する
2. Zendesk インスタンスからすべてのブランド、グループ、満足度理由、スケジュール、ターゲット、チケットフィールド、チケットフォーム、ビュー、Webhook を取得する
3. 同期リポジトリ内のすべての YAML ファイルをレビューして、ビューオブジェクトを生成する
   • また、同期リポジトリファイルに次の問題がないことを確認します。
     • タイトルがない
     • 位置がない
     • active 属性が false のファイルが active フォルダーにある
     • active 属性が true のファイルが inactive フォルダーにある
     • title 属性が重複して使用されている
     • contains_managed_content 属性が true のファイルに、一致する管理対象コンテンツファイルがある
     • contains_managed_webhook 属性が true のファイルに、一致する管理対象コンテンツファイルがある
4. YAML ファイルのすべてのビューオブジェクトを、一致する Zendesk 項目と比較する（属性 title と previous_title の値を確認して判定する）
   • 存在しない場合は、後で使用するために create オブジェクトを変数に格納する
   • 存在しても属性値が異なる場合は、後で使用するために update オブジェクトを変数に格納する
5. 比較レポートを出力する

Zendesk への同期

同期リポジトリは、プロジェクトのスケジュール済みパイプラインが実行されたとき（正しいタイミングまたは手動実行時）に同期タスクを実行します。

いずれかのアクションが発生すると、同期は比較アクションを実行し、その後、必要な Zendesk エンドポイントを呼び出すループを通じて、生成されたオブジェクトを使用して必要な作成と更新を行います。

• 作成
• 更新

孤立した管理対象コンテンツファイルの報告

2 月、5 月、8 月、11 月の 1 日に、スケジュール済みパイプラインによって、同期リポジトリがサポートリーダーシップチーム向けにすべての孤立した管理対象コンテンツファイルをレビューする Issue を作成します。

これは、同期リポジトリ内の bin/find_orphaned_files スクリプトによって実行され、次の処理を行います。

1. 管理対象コンテンツリポジトリのクローンを実行する
2. 管理対象コンテンツリポジトリの active フォルダーと inactive フォルダーにあるすべてのファイルをレビューし、state（つまり active または inactive）、path、title を判定する
3. 同期リポジトリ自体の active フォルダーと inactive フォルダーにあるすべてのファイルをレビューして、次を判定する
   • 管理対象コンテンツファイルを使用しているか
   • 管理対象コンテンツファイルがあるか
4. 同期リポジトリファイルがない管理対象コンテンツファイルを見つけた場合、Customer Support leadership に報告する Issue を作成する

非管理者として個人用ビューを作成する

Zendesk で個人用ビューを作成するには、次の手順に従います。

1. 新しいビューページを開く
   • Zendesk Global (production)
   • Zendesk Global (sandbox)
   • Zendesk US Government (production)
   • Zendesk US Government (sandbox)
2. ビューの名前を入力する
3. ビューの説明を入力する（任意）
4. 管理者である場合は、Who has access セクションで Only you が選択されていることを確認する
5. ビューの条件（つまり使用するフィルター）を入力する
6. 表示するフィールドを入力する
7. グループ化情報を入力する
8. ソート情報を入力する
9. ページ右下の Save ボタンをクリックする

非管理者として個人用ではないビューを作成する

ビューを作成するには、Feature Request Issueを作成してください（Customer Support Systems チームによる手動介入が必要になるためです）。

非管理者として個人用ビューを編集する

既存の個人用ビューを編集するには、次の手順に従います。

1. 対象のビューに移動する
2. ページ右上の Actions ボタンをクリックする
3. Edit view をクリックする
4. 必要な変更を行う
5. ページ右下の Save ボタンをクリックする

非管理者として個人用ではないビューを編集する

ビューで使用するフィールド、グループ化、ソートの変更

ビューで使用するフィールド、グループ化、ソートを編集するには、管理対象コンテンツリポジトリ内の対応するファイルを変更します。master ブランチにマージされると、次のデプロイサイクルで取得され、Zendesk にデプロイされます。

タイトル、位置などの変更

ビューでその他の変更を行うには、Feature Request Issueを作成してください（Customer Support Systems チームによる手動介入が必要になるためです）。

非管理者としてビューを非アクティブ化する

ビューの非アクティブ化をリクエストするには、Feature Request Issueを作成してください（Customer Support Systems チームによる手動介入が必要になるためです）。

管理者タスク

ビュー制限オブジェクト

ビューは、特定のエージェント集合にのみ表示されるよう制限できます。これは制限オブジェクトを使用して行います。

同期リポジトリでは個人用ビューを管理しないため、このオブジェクトで目にするのは null（または空白）値かグループ制限のみです。

誰に対してもビューを制限しない場合、オブジェクトの値全体は null（または空白）です。

ビューの表示をグループに制限する場合、オブジェクトの形式は次のとおりです。

restriction:
  type: Group
  id: 'Name of group 1'
  ids:
  - 'Name of group 1'
  - 'Name of group 2'
  - 'Name of group 3'

同期リポジトリでソートなどを処理するため、ids 配列の順序（または id 属性にどの正確な値が入っているか）は重要ではありません（ids に列挙されたグループのいずれか 1 つが id に存在する限り）。id 値に何を入れるべきか迷った場合は、アルファベット順で最初に来るものを使用してください。

たとえば、Support Ops グループだけがビューを表示できるよう制限するには、次を使用します。

restriction:
  type: Group
  id: 'Support Ops'
  ids:
  - 'Support Ops'

別の例として、Support AMER、Support APAC、Support EMEA のグループだけがビューを表示できるよう制限するには、次を使用します。

restriction:
  type: Group
  id: 'Support AMER'
  ids:
  - 'Support AMER'
  - 'Support APAC'
  - 'Support EMEA'

ビュー一覧の表示

Zendesk でビューの一覧を表示するには、次の手順に従います。

1. Zendesk インスタンスの管理ダッシュボードに移動する
   • Zendesk Global (production)
   • Zendesk Global (sandbox)
   • Zendesk US Government (production)
   • Zendesk US Government (sandbox)
2. Workspaces > Agent tools > Views に移動する
   • Zendesk Global
   • Zendesk Global (sandbox)
   • Zendesk US Government
   • Zendesk US Government (sandbox)

特定のビューを見つけるには、使用中のフィルターを調整する必要がある場合があります（デフォルトでは active の shared ビューが表示されます）。

ビューの作成

ビューを作成するには、同期リポジトリで MR を作成する必要があります。正確な変更内容はリクエスト自体によって異なります。開始テンプレートとして、次を使用できます。

---
title: 'Your view title here'
previous_title: 'Your view title here'
description: 'Your description here'
active: true
position: 1 # Integer representing view position
conditions:
  all:
  - field: 'the_action_to_perform'
    operator: 'the_operator_to_use'
    value: 'the_value_to_use'
  any:
  - field: 'the_action_to_perform'
    operator: 'the_operator_to_use'
    value: 'the_value_to_use'
execution:
  columns: MANAGED_CONTENT # It is always this value as it pulls from the corresponding managed content file
  group_by: MANAGED_CONTENT # It is always this value as it pulls from the corresponding managed content file
  group_order: MANAGED_CONTENT # It is always this value as it pulls from the corresponding managed content file
  sort_by: MANAGED_CONTENT # It is always this value as it pulls from the corresponding managed content file
  sort_order: MANAGED_CONTENT # It is always this value as it pulls from the corresponding managed content file
restriction: # Leave blank to make it visible to all, add a restriction object if you need to fine tune visibility

同僚が MR をレビューして承認した後、MR をマージできます。次のデプロイが行われると、Zendesk に同期されます。

ビューの編集

ビューを編集するには、同期リポジトリで MR を作成する必要があります。正確な変更内容はリクエスト自体によって異なります。

同僚が MR をレビューして承認した後、MR をマージできます。次のデプロイが行われると、Zendesk に同期されます。

ビューのタイトルの変更

ビューのタイトルを変更する必要がある場合は、現在の値を previous_title 属性にコピーしてから、title 属性を変更します。これにより、同期は更新する対象のビューを引き続き見つけることができます。

ビューの非アクティブ化

ビューを非アクティブ化するには、同期リポジトリで MR を作成する必要があります。この MR では、対応するビューの YAML ファイルに対して次の手順を実行します。

1. ファイルを active から inactive パスに移動する
2. active 属性の値を false に変更する
3. conditions の値を次のように変更する

   • Zendesk Global の場合:

       all:
       - field: 'brand_id'
         operator: 'is_not'
         value: 'GitLab Support'
       - field: 'brand_id'
         operator: 'is_not'
         value: 'GitLab - Internal'
       - field: 'status'
         operator: 'less_than'
         value: 'closed'
     any: []
     

   • Zendesk US Government の場合:

     all:
       - field: 'brand_id'
         operator: 'is_not'
         value: 'GitLab'
       - field: 'brand_id'
         operator: 'is_not'
         value: 'GitLab - Internal'
       - field: 'status'
         operator: 'less_than'
         value: 'closed'
     any: []
     

同僚が MR をレビューして承認した後、MR をマージできます。次のデプロイが行われると、Zendesk に同期されます。

ビューの削除

ビューを削除するには、次の手順に従います。

1. ビュー一覧に移動する
2. 削除するビューを見つけ、ビューの右側にある 3 つの点をクリックする
   • 特定のビューを見つけるには、使用中のフィルターを調整する必要がある場合があります（デフォルトでは active の shared ビューが表示されます）。
3. Delete をクリックする
4. 変更を送信するには Delete view をクリックする

例外デプロイの実行

ビューの例外デプロイを実行するには、対象のビュー同期プロジェクトに移動し、スケジュール済みパイプラインページに移動して、同期項目の再生ボタンをクリックします。これにより、ビューの同期ジョブがトリガーされます。

一般的な問題とトラブルシューティング

マージ後にビューの変更が表示されない

ビューは Standard デプロイタイプに従うため、通常のデプロイサイクル中（または例外デプロイが実行された場合）にのみデプロイされます。

ページのソースコードを見る - ページの編集 - please contribute.