Holiday Behavior Example

This section provides examples of how including or excluding Coverages from Site Holidays affects the behavior of notification schedules for Groups that contain those Coverages. This tutorial explains how to create a Group that includes examples of the following situations:

The example described in this section is not intended to be used in a real-world deployment, but serves to provide an example of how to create Coverages using the holiday functionality.

Note that this section uses the example Sites and Holidays described in the "Custom Holiday Example" section of the xMatters Installation and Administration Guide. That example provides a tutorial on how to add two new custom holidays, "Pro Dev Day - NY" and "Pro Dev Day - LA", and assign them to separate Sites.

Group requirements

Assume that you have a help desk with six employees divided between two Sites, one in New York and one in Los Angeles. A custom holiday was added to the Company, but it occurs on a different day for each Site. You need to create a schedule for the employees at the LA site that meets the following requirements:

Note: This tutorial is not intended to be used in a real-world deployments, but serves to provides an example of how to create Coverages using the holiday functionality.

Creating a Coverage that excludes Site holidays

The first step is to create the Group; for this example, the basic Coverage for the Group will be the weekday schedule that is not active on Site holidays.

To create the basic Coverage:
  1. Log in to the web user interface as a Group Supervisor, and click the Groups tab.
  2. On the Groups I Supervise page, click Add New.
  3. On the Add a Group page, enter the following details:
    1. Name: LA Help Desk.
    2. Time Zone: US/Pacific
    3. Schedule Type: Build a Schedule
    4. Site to Use for Holidays: Los Angeles
  4. Click Continue.
  5. On the Schedule Details page, specify the following settings:
    1. Name: Help Desk Weekdays
    2. Start Time: 09:00
    3. Duration: 8 hours
    4. On These Days: Mon, Tue, Wed, Thu, Fri
  6. In the Recurrence Pattern area, set the Start Date to today's date, repeating every week with no end date.
  7. In the Holiday Behavior area, ensure Exclude is selected for Site Holidays, and then click Continue.
  8. Use the Set the Team for Schedule and Team Details pages to create a new Team named "HD Weekdays" with three Team members.

When you are finished, you should have a Group with a single Coverage active from 9am to 5pm, Monday to Friday. Click the Monthly View button, and then click the Next button above the calendar until you reach the second week in April. The Thursday of that week should be marked as having no coverage.

Creating an evening Coverage that is active on Holidays

Once you have created a Group with a basic Coverage that is not active on Site holidays, you can create a new Coverage that is active on Site holidays in addition to its usual schedule.

To create a Coverage including holidays:
  1. On the Group Details page, in the Common Tasks pane, click Add Recurring.
  2. On the Schedule Details page, enter the following information into the form:
    1. Name: Evenings and Holidays
    2. Start Time: 17:00
    3. Duration: 3 hours
    4. On These Days: Mon, Tue, Wed, Thu, Fri
  3. In the Recurrence Pattern area, set the Start Date to today's date, repeating every week with no end date.
  4. In the Holiday Behavior area, for Site Holidays select Include, set the Start Time to 09:00, and set the Duration to 5 hours.
  5. Use the Set the Team for Schedule and Team Details pages to create a new rotation Team named "HD Evenings and Holidays" with two Team members.

When you are finished, you should have a Group with two Coverages that combine to be active from 9am to 8pm. Click the Monthly View button, and then click the Next button above the calendar until you reach the second week in April. Click the link in the first column of the row that contains the second Thursday of the month (note that this may be the link marked Week 3 if the month starts on a Friday or Saturday).

The Existing Coverages table should now display two Coverages; note how the Evenings and Holidays Coverage includes two shifts on the holiday Thursday: one from 9am to 2pm, and the other from 5pm to 8pm.

Creating a holiday-only Coverage

The final step is to create a Coverage that is active only on Holidays to bridge between the two shifts.

To create a holiday Coverage:
  1. On the Group Details page, in the Common Tasks pane, click Add Holiday Coverage.
  2. On the Schedule Details page, enter the following information into the form:
    1. Name: Holiday Afternoons
    2. Start Time: 14:00
    3. Duration: 3 hours
  3. Set the Start Date to today's date, with no end date, and then click Continue.
  4. Use the Set Team for Schedule and Team Details pages to create a new rotation Team named "Holidays Only" with three Team members.

When you are finished, click the Monthly View button, and then click the Next button above the calendar until you reach the second week in April. Click the link in the first column of the row that contains the second Thursday of the month (note that this may be the link marked Week 3 if the month starts on a Friday or Saturday).

The Existing Coverages table should now display three Coverages; note how the Coverage gap bar at the top of the table indicates the same amount of time each day as being "covered".

To see how the system automatically updates the schedule based on the holidays set for the Site and Company, try changing the Group so that the holidays are calculated based on the New York Site instead of Los Angeles. The second Thursday in April should be treated as a normal weekday while the first Thursday should now be treated as a holiday.