Installing and using the Out of Office app

62082233

The Out of Office app is a tool for managing the availability of an agent in Zendesk Support, and ensuring that tickets assigned to unavailable agents are properly handled if updated by a customer.

This article covers the following topics to help you install, use, and extend the app:

• How the app works
• Installing the app
• Changing the app settings
• Using the app
• Understanding the 'agent_ooo' tag
• Known limitations
• Troubleshooting

How the app works

The Out of Office app displays the availability status of the agent assigned to tickets in Zendesk Support.

For administrators, it also displays a list of agents and their availability.

The app prevents tickets from being accidentally assigned to an agent who is unavailable. When this occurs, a pop-up notification is displayed to the agent.

Installing the app

To install the Out of Office app

1. In the Zendesk App Marketplace search bar, search for Out of Office, and select the app from the results list.
2. Click Install in the upper-right corner.
   
3. Select or unselect the Confirm status change checkbox. Unselecting this option disables the status change confirmation message. As a result, you cannot choose to unassign an agent's open tickets when marking them as unavailable.
   
   
4. Select or unselect the Force unassign tickets checkbox. Enabling this setting unassigns an agent's open tickets automatically when their status is changed to unavailable. This option is disabled by default, allowing the unassign action to be run on a case-by-case basis.
5. Select or unselect the Prevent assignment checkbox. Disabling this option allows tickets to be saved if they're assigned to an agent who's unavailable. A warning is still displayed that the assignee is unavailable, and agents can assign tickets to themselves regardless of their status.
6. Select or unselect the  Surface errors encountered  when bulk updating tickets? checkbox. Enabling this option causes the unassign process to take longer. Some tickets may still not get updated by Out of Office even with this setting turned on. This setting simply verifies the ticket updates and surfaces any errors encountered whilst updating tickets.
7. If required, select and configure role restrictions and group restrictions.
8. Click Install to complete the setup.

Changing the app settings

You can modify the app's default behavior by changing the app settings.

To change the app settings

1. In Support, click Admin (), then select Apps > Manage.
2. In the Out of Office app icon, select Change Settings from the dropdown options menu.
   
3. Modify your settings and click Update.

Using the app

An agent can modify their status using the app in the ticket sidebar or accessing their user profile.

To modify your availability

1. In Support, click View, and double click on a ticket to open it. Alternatively, select your user profile icon the upper right, and then click View Profile.
2. In the ticket app sidebar, under the Out of Office app, select the Availability toggle button. A confirmation dialog box opens to confirm the change.
3. Click Set as Available to enable availability, or Set as Unavailable to set your status as unavailable.
   
   

An administrator can access the Out of Office dashboard to view the availability of agents and modify an agent's status.

To view and modify an agent's availability

1. In Support, select the Out of Office icon in the left navigation bar. The dashboard opens.
   
2. Click on the Availability toggle button next to agent. A confirmation dialog box opens to confirm the change.
3. Click Set as Available to enable availability, or Set as Unavailable to set an agent's status as unavailable.

Changing the availability status either adds or removes a tag on tickets with a Pending, On-Hold, or Solved  status, and optionally for all tickets with an Open status. For more information, see Understanding the agent_ooo tag below.

When a pending or on-hold ticket is reopened by an end user and the assignee is unavailable, a trigger fires that returns the ticket to the unassigned ticket queue. 

The app checks the status of the assignee each time a ticket is saved. If the assignee is unavailable, the app warns the updater that the assignee is unavailable. If the Prevent assignment setting is enabled, it also prevents tickets from being saved if the new assignee is unavailable.

The following functions and behavior can occur when using the Out of Office app in Zendesk Support:

• An agent can assign a ticket to themselves if they are unavailable. The following warning is displayed after the ticket is saved:
  
  
• An agent can update a ticket if they're not the assignee and the assignee is unavailable. A warning notification is displayed that the current assignee is unavailable:
  
• Tickets that are assigned to an unavailable agent with a Pending and On-Hold status, but are updated to Open, are reassigned to the respective ticket's parent group. However, the Assignee field becomes empty. Status changes from Pending or On-Hold occurs when an end-user replies to an email notification.

Understanding the agent_ooo tag

When the Out of Office app is installed, it automatically creates in Zendesk Support the following items:

• A user field that applies an agent_ooo tag to users marked as unavailable
• A trigger to handle the unassign action on a ticket based on the agent_ooo tag
• A trigger to remove the agent_ooo tag from a ticket when it's assigned to a different agent

Note: These items are required for the app to work. Don't delete or modify them.

Changing the availability status either adds or removes an agent_ooo tag on tickets based on the following rules:

• When an agent marks themselves as unavailable, the agent_ooo tag is added to the agent's user profile in the Agent Out? user field
• When the agent changes their status to unavailable, the tag is added to all tickets with a Pending, On-Hold, or Solved status. When the agent changes their status to available, the tag is removed from these tickets
• Any open tickets with the tag are unassigned on update
• If the ticket assignee is changed, then the tag is removed
• If the tag is removed from a ticket, no other tags are removed

Limitations

The Out of Office app has the following limitations:

• The app does not reassign tickets if the agent's out of office status is changed outside of the Out of Office app
• The app does not work on Side Conversations
• The app does not prevent assigning tickets unless the ticket is updated individually through the Zendesk interface. Triggers, Mail API, REST API, and bulk editing will be able to bypass the assignment restrictions
• Agents can still self assign/take ownership of tickets while they are out of office. The app will not prevent this. The app also can't prevent tickets being assigned to agents while they are out of office when done through outside the Zendesk interface.
• Agents without administrator rights can't change their status using the app dashboard in the left navigation bar of the agent interface. They can still change their status in their user profile or from one of their assigned tickets
• Agent statuses doesn't affect Out of Office app functionality.
• If the Prevent assignment setting is disabled and a ticket is assigned from one unavailable agent to another unavailable agent, the agent_ooo tag will be lost. This means that the ticket will not be unassigned if it is reopened
• Groups with only one agent:
  • Agents are able to assign a ticket to a group with only one agent even if the sole agent in that group is unavailable.
  • If an agent is the only agent in a group and the agent goes out of office, the assigned tickets will not be re-assigned back to the group. This is due to the inborn system ticket rules.

    If there is only one agent in a group that can be assigned tickets, all tickets assigned to that group will automatically be assigned to that one agent. Some agents in groups, such as light agents, do not have permission to be assigned tickets.

• The agent_ooo tag is added to solved tickets. If the ticket is closed while the tag is applied, however, the tag will not be removable because Tickets in the closed status cannot be updated. This may be undesirable for reporting purposes. If so, the system automation that closes solved tickets should be modified to remove the agent_ooo tag before closing the ticket.
• When a ticket assigned to an out of office agent gets updated, the ticket is assigned back to the parent group with a null Assignee value. The trigger working in the background during this action does not currently send an email notification to the agents in the group
• In some instances, if an agent is downgraded to an end user while unavailable, they will retain the agent_ooo tag until it is removed manually. Any tickets that the end user creates also inherits the agent_ooo tag
• API Limits:
  • When updating a large amount of tickets API rate limits can be encountered causing the update process to take longer than usual. Please be patient and allow the app to finish the update process. The update process is finished when the app no longer displays "Updating..." in lieu of the agent's OOO status
  • The volume of tickets associated with an Agent will impact app performance and updating a large amount of assigned tickets can fail resulting in the agent_ooo tag not being added to all the tickets resulting in tickets not being assigned back to the parent group
  • When marking an agent as OOO and un-assigning all open tickets, only some of the tickets will actually get unassigned
  • If an agent closes the browser tab in the midst of an update or if there is a network issue, OOO updates may be lost causing incomplete updates to tickets.
• The framework within which the Out of Office app is built in has inherent limitations in terms of resolving errors and retrying. In cases where it encounters errors updating tickets or API limits can result in issues such as: some or all of the assigned tickets missing the agent_ooo tag when an agent changes their status to "Unavailable". The following workarounds can be tried to resolve such issues.
  • Enable the Surface errors encountered when bulk updating tickets app setting. This will notify if any errors were encountered when updating the assigned tickets - either removing or adding the agent_ooo tag. By default this setting is disabled.
  • Toggle the status in the app to "Available" and toggle the status to "Unavailable" (again) - or vice versa.
  • Bulk update all tickets and add the agent_ooo tag if the agent is going to be "Unavailable" or remove the agent_ooo tag if the agent is going to be "Available"

Troubleshooting

If you cannot install the Out of Office app, and get and error "agent_ooo has already been taken", please review the following steps:

• Remove the user field that has the field key agent_ooo - most likely named "[Out of Office] Agent Out" or the user field is in inactive state
• If you get an error while removing the user field, check your triggers or automations and remove any references to this user field

Release notes

Version 2.8.5 — 2020-12-03

• Fixed an issue where it was possible to assign tickets to OOO agents.

 Version 2.8.4 — 2020-09-01

• Allows only one installation of the App on an account
• Fixed an issue with the confirm change setting(dialog) not working
• Fixed some translations

Version 2.8.3 - 2020-02-18

• Breaking changes:  Removed support for IE11. For more information, see  Removal of support for Internet Explorer 11 

• Bug fixes:
  • Fixed an issue where open tickets not un-assigning when the status is toggled from the ticket sidebar
  • Fixed issues where a ticket prevented assignment
  • Fixed an issue that now allows an update of tickets assigned to OOO agents
  • Fixed an issue that prevented updates if changing ticket assignee to an agent that's OOO
  • Fixed an issue that prevented assigning new or existing tickets to agents that are OOO
  • Fixed an issue with a frozen availability toggle button upon error in changing an agent's status
• Improvements:
  • Tickets are updated based on recent updated tickets assigned to the agent
  • Light agents aren't displayed in the navigation bar since they can't be assigned tickets
  • When "Surface errors encountered when bulk updating tickets?" is selected, it can take up to one minute to validate ticket updates. If validation takes longer than one minute, a warning is shown asking the agent to try again.
  • Improved error handling and notifications. Notifications upon error will last for 10 seconds
  • Minor CSS and user interface updates
• Known issues: There will occasionally be an issue where an agent's ticket may not get tagged properly.  In such cases, the app will show an error. To resolve the error, toggle the agent's status back to the previous state, and then toggle the agent's status to the desired state.

Version 2.8.1 — 2019-11-11

• Fixed an issue with the navbar location not sorting agents in alphabetical order by default
• Fixed an issue where searching for agents is case sensitive
• Fixed an issue where the Out of Office toggle button was showing up in the sidebar for end user profiles
• Fixed an issue where the new ticket screen allowed an agent to assign a ticket to someone who was set to Out of Office
• Fixed an issue with the "Surface errors encountered  when bulk updating tickets?" feature and app setting, where tickets were not properly checked for successful updates or not.