ユーザーフィールド
このガイドでは、GitLab における Zendesk のユーザーフィールドの作成、編集、管理方法について説明します。管理者は管理者タスクセクションを確認してください。
技術的な詳細
- デプロイタイプ:
Standard - 同期リポジトリ
CustSuppOps Zendesk Test Suite Generatorを有効化
ユーザーフィールドを理解する
ユーザーフィールドとは
ユーザーフィールドは、Zendesk のユーザープロファイルに関連付けられたカスタムフィールドです。チケットフィールド(チケット上に表示される)とは異なり、ユーザーフィールドはユーザー自身に関する情報を保存します。
ユーザーフィールドの管理方法
Zendesk は UI を通じてユーザーフィールドを完全に管理する方法を提供していますが、私たちはよりバージョン管理されたメソドロジーを採用しています。これにより、定められたレビュープロセスや、必要に応じてロールバックを行う能力などが得られます。
そのため、同期リポジトリを利用しています。
ユーザーフィールドのタイプ
GitLab で最もよく使うタイプは以下のとおりです。
| 名前 | API type 値 | 用途 | 使用例 |
|---|---|---|---|
| Checkbox | checkbox | 単一の true/false オプション | “User on PTO” |
| Date | date | 日付選択用 | “Expiration date” |
| Decimal | decimal | 小数を含む数値用 | “ARR associated” |
| Drop-down | dropdown | 1 つの選択を許可するドロップダウン用 | “Highest plan level” |
| Multi-line | textarea | 複数行が必要なフリースタイルフィールド用 | “Account manager notes” |
| Multi-select | multiselect | 複数の選択を許可するドロップダウン用 | “Subscription levels purchased” |
| Numeric | integer | 小数を含まない数値用 | “GitLab.com user ID” |
| Regex | regexp | 正規表現の検証が必要なテキストスタイルフィールド用 | “Salesforce contact ID” |
| Text | text | フリースタイルフィールド用 | “Preferred nickname” |
完全なリストについては、Zendesk のドキュメントを参照してください。
管理者タスク
注意
- このセクションのすべての項目は、Zendesk への
Administratorレベルのアクセスが必要です。
ユーザーフィールドを表示する
Zendesk でユーザーフィールドを表示するには:
- Zendesk インスタンスの管理ダッシュボードに移動
People > Configuration > User fieldsに移動
注意: 非アクティブのユーザーフィールドを表示したい場合は、Filter ボタンをクリックしてアクティブフィルターを変更する必要がある場合があります。
ユーザーフィールドを作成する
警告
- これは対応する依頼 Issue(Feature Request、Administrative、Bug など)が存在する場合にのみ実行してください。存在しない場合は、まず作成して標準プロセスを通してから対応してください。
ユーザーフィールドを作成するには、同期リポジトリで MR を作成する必要があります。具体的な変更内容は依頼自体によって異なります。具体的な内容はユーザーフィールドのタイプによって異なる場合があります。
注意: 一般的なフィールドタイプ向けのテンプレートを示します。その他のタイプ(date、decimal、textarea、multiselect、regexp)については、type 属性をそれに応じて変更し、タイプ固有の要件については Zendesk フィールドのドキュメントを参照してください。
ヒント: 以下の各フィールドタイプをクリックすると、そのテンプレートが表示されます。
checkbox
---
title: 'Your Title Here'
previous_title: 'Your Title Here'
description: 'Your description here'
type: 'checkbox'
active: true
position: 1 # Integer representing user field position, controls display order in user profile (lower numbers appear first)
tag: 'tag_to_add_when_checked' # Added onto the user when the checkbox is checked
regexp_for_validation: null # Always null unless "regexp"
custom_field_options: null # Always null unless "dropdown" or "multiselect"
text
---
title: 'Your Title Here'
previous_title: 'Your Title Here'
description: 'Your description here'
type: 'text'
active: true
position: 1 # Integer representing user field position, controls display order in user profile (lower numbers appear first)
regexp_for_validation: null # Always null unless "regexp"
custom_field_options: null # Always null unless "dropdown" or "multiselect"
integer
---
title: 'Your Title Here'
previous_title: 'Your Title Here'
description: 'Your description here'
type: 'integer'
active: true
position: 1 # Integer representing user field position, controls display order in user profile (lower numbers appear first)
regexp_for_validation: null # Always null unless "regexp"
custom_field_options: null # Always null unless "dropdown" or "multiselect"
dropdown
---
title: 'Your Title Here'
previous_title: 'Your Title Here'
description: 'Your description here'
type: 'dropdown'
active: true
position: 1 # Integer representing user field position, controls display order in user profile (lower numbers appear first)
regexp_for_validation: null # Always null unless "regexp"
custom_field_options:
- name: 'Name of option'
value: 'tag_option_uses'
- name: 'Name of option 2'
value: 'tag_option_uses_2'
ピアによるレビューと承認後、MR をマージできます。次のデプロイ時に、Zendesk に同期されます。
ユーザーフィールドを編集する
警告
- これは対応する依頼 Issue(Feature Request、Administrative、Bug など)が存在する場合にのみ実行してください。存在しない場合は、まず作成して標準プロセスを通してから対応してください。
ユーザーフィールドを編集するには、同期リポジトリで MR を作成する必要があります。具体的な変更内容は依頼自体によって異なります。
ピアによるレビューと承認後、MR をマージできます。次のデプロイ時に、Zendesk に同期されます。
ユーザーフィールドのタイトルを変更する
ユーザーフィールドのタイトルを変更する必要がある場合、現在の値を previous_title 属性にコピーしてから title 属性を変更します。これにより、同期は更新対象のユーザーフィールドを引き続き特定できます。
ユーザーフィールドを非アクティブ化する
警告
- これは対応する依頼 Issue(Feature Request、Administrative、Bug など)が存在する場合にのみ実行してください。存在しない場合は、まず作成して標準プロセスを通してから対応してください。
ユーザーフィールドを非アクティブ化するには、同期リポジトリで MR を作成する必要があります。この MR では、対応するアクションに対して以下を行います。
- ファイルを
activeフォルダからinactiveフォルダに移動 active属性の値をfalseに変更
ピアによるレビューと承認後、MR をマージできます。次のデプロイ時に、Zendesk に同期されます。
ユーザーフィールドを削除する
警告
- これは対応する依頼 Issue(Feature Request、Administrative、Bug など)が存在する場合にのみ実行してください。存在しない場合は、まず作成して標準プロセスを通してから対応してください。
同期リポジトリは削除を実行しないため、これは Zendesk 自体経由で行う必要があります。
ユーザーフィールドを削除するには:
- Zendesk インスタンスの管理ダッシュボードに移動
People > Configuration > User fieldsに移動- 削除したいユーザーフィールドを見つけて名前をクリック
Filterボタンをクリックしてアクティブフィルターを変更する必要がある場合があります
- ページ右上の
Actionsをクリック Deleteをクリック- ポップアップの
Deleteをクリックして変更を送信
例外デプロイを実施する
ユーザーフィールドの例外デプロイを実施するには、対象のユーザーフィールド同期プロジェクトに移動し、スケジュールパイプラインのページに移動して、同期項目の再生ボタンをクリックします。これによりユーザーフィールドの同期ジョブがトリガーされます。
よくある問題とトラブルシューティング
マージ後にユーザーフィールドの変更が見えない
ユーザーフィールドは Standard デプロイタイプに従うため、通常のデプロイサイクル中(または例外デプロイが実施された場合)にのみデプロイされます。
bfd74782)