Groups
This guide covers how to create, edit, and manage Zendesk groups at GitLab. Administrators should review the Administrator tasks section.
Technical Details
- Deployment type:
Standard - Sync repos
Understanding groups
What are Zendesk groups
As per Zendesk:
Groups collect team members together based on criteria those team members have in common. Groups can only contain team members; no end users can be included. All agents must be assigned to at least one group, but they can be members of more than one. Groups can be used to support organizations. You can designate one group as the default group for your account and you can also designate a default group for each team member. All new team members you create will be added to the default group.
How we manage groups
While Zendesk offers a full way to manage groups via the UI, we turn to a more version controlled methodology. This allows for a set review process, the ability to perform rollbacks as needed, etc.
That being the case, we utilize sync repos.
How we manage group membership
For the Support team
We manage the group membership for those within the Support team via the Agent sync. As such, if you need to modify your group membership, please update your YAML file.
For everyone else
As these require the tech stack provisioner to manually perform the changes, please file an Access Request issue.
Creating a group as a non-admin
For the creation of a group, please create a Feature Request issue (as it will require manual intervention by the Customer Support Operations team).
Editing a group as a non-admin
For the modification of a group, please create a Feature Request issue (as it will require manual intervention by the Customer Support Operations team).
Deactivating a group as a non-admin
To request the deactivation of a group, please create a Feature Request issue (as it will require manual intervention by the Customer Support Operations team).
Current groups
Zendesk Global groups
Accounts ReceivableBillingBPOGeneralSupport AMERSupport APACSupport EMEASupport Focus: Authentication and AuthorizationSupport Focus: CMOCSupport Focus: L&RSupport Focus: SecureSupport ManagersSupport Ops
Zendesk US Government groups
GeneralSecuritySupport 1st ShiftSupport 2nd ShiftSupport 3rd ShiftSupport ManagersSupport OperationsSupport
Administrator tasks
Note
- All sections in this section require
Administratorlevel access to Zendesk.
Viewing groups
To view groups in Zendesk:
- Navigate to the admin dashboard for the Zendesk instance
- Go to
People > Team > Groups
You can click on the group’s name if you need to see the membership of a group.
Creating a group
Warning
- This should only be done if there is a corresponding request issue (Feature Request, Administrative, Bug, etc.). If one does not exist, you should first create one (and let it go through the standard process before working it).
- Keep in mind you may need to edit the Agent sync as well
For the creation of a group, you will need to create a MR in the sync repo. The exact changes being made will depend on the request itself. A starting template you can use would be:
---
name: 'Your group name here'
previous_name: 'Your group name here'
description: 'Your description here'
default: false # If the group is the default one for the account
deleted: false # Deleted groups get marked as such
is_public: true # If true, the group is public. If false, the group is private. You can't change a private group to a public group
After a peer reviews and approves your MR, you can merge the MR. When the next deployment occurs, it will be synced to Zendesk.
Editing a group
Warning
- This should only be done if there is a corresponding request issue (Feature Request, Administrative, Bug, etc.). If one does not exist, you should first create one (and let it go through the standard process before working it).
- Keep in mind you may need to edit the Agent sync as well
To edit a group (i.e. its name or description), you will need to create a MR in the sync repo. The exact changes being made will depend on the request itself.
After a peer reviews and approves your MR, you can merge the MR. When the next deployment occurs, it will be synced to Zendesk.
Changing the name of a group
If you need to change the title of a group, copy the current value into the previous_name attribute and then change the name attribute. This allows the sync to still locate the group in question to update.
Deleting a group
Warning
- This should only be done if there is a corresponding request issue (Feature Request, Administrative, Bug, etc.). If one does not exist, you should first create one (and let it go through the standard process before working it).
- Keep in mind you may need to edit the Agent sync as well
As the sync repos do not perform deletions, you will have to do 2 actions to delete a group.
First, you must delete the corresponding file from the sync repo. After a peer reviews and approves your MR, you can merge the MR.
After that is done, you then must delete it from Zendesk itself.
To delete a group from Zendesk:
- Navigate to the admin dashboard for the Zendesk instance
- Go to
People > Team > Groups - Click the name of the group you wish to remove the person from
- Click the
Actionsbutton at the top of the page - Click the
Delete group - Click the
Deleteto confirm the change
Adding a non-support person to a group
To add someone who is not managed by the Agent sync to a group:
- Navigate to the admin dashboard for the Zendesk instance
- Go to
People > Team > Groups - Click the name of the group you wish to add the person to
- Use the search on the far-right side to locate the person (searching by email address works best)
- Click the
+icon to the right of the person’s information - Click the
Saveicon to the bottom-right of the page.
Removing a non-support person from a group
To remove someone who is not managed by the Agent sync from a group:
- Navigate to the admin dashboard for the Zendesk instance
- Go to
People > Team > Groups - Click the name of the group you wish to remove the person from
- Use the search under the
Group memberssection to locate the person (searching by email address works best) - Click the trashcan icon to the right of the person’s information
- Click the
Saveicon to the bottom-right of the page.
Performing an exception deployment
To perform an exception deployment for groups, navigate to the groups sync project in question, go to the scheduled pipelines page, and click the play button for the sync item. This will trigger a sync job for the groups.
Common issues and troubleshooting
Not seeing group changes after a merge
As groups follow the Standard deployment type, they would only be deployed during a normal deployment cycle (or when an exception deployment has been done)
7d49549f)
