自動化

このガイドでは、GitLab における Zendesk 自動化の作成、編集、管理方法について説明します。管理者は管理者タスクセクションを確認してください。

エージェントが手動で適用するマクロや、チケットイベントで直ちに実行されるトリガーとは異なり、自動化は時間ベースのスケジュールで実行されます。

自動化を理解する

自動化とは

Zendeskによると:

自動化はトリガーと似ています。どちらも、チケットのプロパティを変更し、必要に応じて顧客とエージェントにメール通知を送信する条件とアクションを定義するためです。違いは、チケットが作成または更新された直後ではなく、チケットプロパティが設定または更新された後に時間イベントが発生した時点で自動化が実行されることです。

より簡単に考えると、自動化は即座には実行されないトリガーです。イベントベースではなく時間ベースです。

Zendesk で自動化が実行されるタイミング

公式には、Zendesk の自動化は 1 時間に 1 回実行されます。正確なタイミングは固定されていませんが、Zendesk の利用から、インスタンスのタイムゾーンで毎時開始時（およそ 5 分以内）に実行されることが分かっています。

自動化では条件ロジックを使用します

自動化では条件ロジックを使用します:

• all: 配列内のすべての条件が true でなければなりません（AND ロジック）
• any: 配列内の少なくとも 1 つの条件が true でなければなりません（OR ロジック）
• 片方のセットだけ、または両方のセットを使用できます（ただし、少なくとも 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” の同等の項目に置換できます。これには次が含まれます:

たとえば、フィールド Preferred Region for Support の値を AMER に変更する自動化を作成する場合、置換を使用するには次のようにします:

- field: 'Field: Preferred Region for Support'
  value: 'AMER'

別の例として、チケットのフォームが 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 属性の値を確認して判定します）
   • 存在しない場合は、後で使用する作成オブジェクトを変数に保存します
   • 存在するものの属性値が異なる場合は、後で使用する更新オブジェクトを変数に保存します
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 リーダーシップに報告する Issue を作成します

非管理者として自動化を作成する

自動化を作成する場合は、Feature Request Issueを作成してください（Customer Support Systems チームによる手動対応が必要になるためです）。

非管理者として自動化を編集する

自動化で使用するコメントの文言を変更する

自動化で使用するコメントの文言を編集するには、管理対象コンテンツリポジトリ内の対応するファイルを変更します。master ブランチにマージされた後、次のデプロイサイクルで取得され、Zendesk にデプロイされます。

自動化で使用するペイロードを変更する

管理対象 Webhook を使用している自動化のペイロードを編集するには、管理対象コンテンツリポジトリ内の対応するファイルを変更します。master ブランチにマージされた後、次のデプロイサイクルで取得され、Zendesk にデプロイされます。

タイトル、コメント以外の文言アクションなどを変更する

自動化のその他の項目を変更する場合は、Feature Request Issueを作成してください（Customer Support Systems チームによる手動対応が必要になるためです）。

非管理者として自動化を無効化する

自動化の無効化をリクエストする場合は、Feature Request Issueを作成してください（Customer Support Systems チームによる手動対応が必要になるためです）。

管理者タスク

自動化の使用状況情報を確認する

自動化の使用状況情報を確認するには:

1. Zendesk インスタンスの管理パネルに移動します
2. Objects and rules > Business rules > Automations に移動します
3. “Add automation” ボタンの左にあるアイコン（中に AZ がある円のように見えます）をクリックします
4. 表示する使用状況列をクリックします

自動化を作成する

自動化を作成するには、同期リポジトリで MR を作成する必要があります。正確にどの変更を行うかはリクエスト自体によって異なります。使用できる開始テンプレートは次のとおりです:

---
title: 'Your::Title::Here'
previous_title: 'Your::Title::Here'
description: 'Your description here'
active: true
position: 1 # Integer representing automation position
actions:
- field: 'the_action_to_perform'
  value: 'the_value_to_use'
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'
contains_managed_content: false
contains_managed_email: false
contains_managed_webhook: false

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

自動化を編集する

自動化を編集するには、同期リポジトリで MR を作成する必要があります。正確にどの変更を行うかはリクエスト自体によって異なります。

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

自動化のタイトルを変更する

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

自動化を無効化する

自動化を無効化するには、同期リポジトリで MR を作成する必要があります。この MR では、対応する自動化の YAML ファイルに対して次の操作を行います:

1. ファイルを active パスから inactive パスに移動します

2. active 属性の値を false に変更します

3. actions の値を次のように変更します:

   • Zendesk Global の場合:

     - field: 'current_tags'
       value: 'missing_brand'
     

   • Zendesk US Government の場合:

     - field: 'current_tags'
       value: 'missing_brand'
     

4. conditions の値を次のように変更します:

   • Zendesk Global の場合:

       all:
       - field: 'brand_id'
         operator: 'is_not'
         value: 'GitLab Support'
       - field: 'brand_id'
         operator: 'is_not'
         value: 'GitLab - Internal'
       - field: 'current_tags'
         operator: 'not_includes'
         value: 'missing_brand'
       - field: 'status'
         operator: 'is_not'
         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: 'current_tags'
         operator: 'not_includes'
         value: 'missing_brand'
       - field: 'status'
         operator: 'is_not'
         value: 'closed'
       any: []
     

5. contains_managed_content 属性の値を false に変更します

6. contains_managed_webhook 属性の値を false に変更します

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

自動化を削除する

同期リポジトリは削除を実行しないため、Zendesk 自体で実行する必要があります。

自動化を削除するには:

1. Zendesk インスタンスの管理ダッシュボードに移動します
   • Zendesk Global（本番環境）
   • Zendesk Global（サンドボックス）
   • Zendesk US Government（本番環境）
   • Zendesk US Government（サンドボックス）
2. Objects and rules > Business rules > Automations に移動します
   • Zendesk Global
   • Zendesk Global（サンドボックス）
   • Zendesk US Government
   • Zendesk US Government（サンドボックス）
3. 削除する自動化を見つけ、Inactive タブで名前をクリックします
4. ページの下部までスクロールします
5. Submit ボタンの横にあるドロップダウンをクリックします
6. Delete をクリックします
7. 変更を送信するには Submit をクリックします

例外デプロイを実行する

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

よくある問題とトラブルシューティング

マージ後に自動化の変更が表示されない

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

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