Get-CsRgsHolidaySet -Identity <RgsIdentity> [-Name <String>] [-Tenant <Nullable>]

Parameters

In order to provide callers with the best possible experience, the Response Group application makes it possible for you to clearly define when Response Group agents are available to answer calls and when they are not available to answer calls. With the Response Group application you can define business hours; these hours indicate the days of the week and hours of the day that agents are available to answer calls. For example, if your organization is typically open from 9:00 AM to 5:00 PM Monday through Friday then you would configure business hours that show that agents are available from 9:00 AM to 5:00 PM Monday through Friday (and, by extension, that agents are not available at, say, 8:00 PM on a Thursday or 2:30 PM on a Sunday).

Of course, in many organizations there are exceptions to the typical work week; for example, in the US an organization might be closed on Christmas Day or Thanksgiving Day. In order to accommodate these atypical closures, the Response Group application enables you to designate certain days as holidays: days when the organization would usually be open but, for whatever reason, is not. Individual holidays (created using the New-CsRgsHoliday cmdlet) are collected in holiday sets; for example, holidays for the US might collected in a holiday set named US_Holidays, while holidays for Japan might be collected in a holiday set named Japanese_Holidays. Once collected, holiday sets can then be assigned to Response Group service workflows.

The Get-CsRgsHolidaySet provides a way for you to return any (or all) of the Response Group holiday sets configured on a specified service. Note that this may, or may not, represent all the holiday sets in your organization; that depends on how many instances of the Response Group application have been installed. At a minimum, Get-CsRgsHoplidaySet always requires you to specify the Identity of the service where the holiday set is being hosted; for example:

Get-CsRgsHolidaySet –Identity "service:ApplicationServer:atl-cs-001.litwareinc.com"

If you have a Response Group application located on another pool (e.g., ApplicationServer:dublin-cs-001.litwareinc.com) you’ll need to run Get-CsRgsHolidaySet a second time in order to retrieve holiday set information for that service.

Get-CsRgsHolidaySet returns instances of the Microsoft.Rtc.Rgs.Management.WritableSettings.HolidaySet object.

-------------------------- Example 1 ------------------------

	Copy Code
Get-CsRgsHolidaySet -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com "

The command shown in Example 1 returns information about all the holiday sets configured for the service ApplicationServer:atl-cs-001.litwareinc.com.

-------------------------- Example 2 ------------------------

	Copy Code
Get-CsRgsHolidaySet -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com " -Name "2010 Holidays"

In Example 2, a single holiday set from the service ApplicationServer:atl-cs-001.litwareinc.com is returned: the set with the Name 2010 Holidays. Because Names must be unique for each service, this command can never return more than one item.

-------------------------- Example 3 ------------------------

	Copy Code
Get-CsRgsHolidaySet -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com " -Name "2010 Holidays"| Select-Object -ExpandProperty Holidays

Example 3 displays detailed information for the holidays found in the holiday set 2010 Holidays (located on the service ApplicationServer:atl-cs-001.litwareinc.com). To do this, the command first uses Get-CsRgsHolidaySet to retrieve the specified holiday set. This set is then passed to the Select-Object cmdlet, which uses the -ExpandProperty parameter to show detailed information (Name, StartDate, and EndDate) for each holiday in the set.

-------------------------- Example 4 ------------------------

	Copy Code
Get-CsRgsHolidaySet -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com " | Select-Object Identity, -ExpandProperty Holidays | Where-Object {$_.Name -eq "Christmas Day"} | ForEach-Object {Get-CsRgsHolidaySet -Identity $_.Identity}

The command shown in Example 4 reports back the Identity of each holiday set on ApplicationServer:atl-cs-001.litwareinc.com that includes a holiday named Christmas Day. To carry out this task the command first calls Get-CsRgsHolidaySet to return a collection of all the holiday sets found on ApplicationServer:atl-cs-001.litwareinc.com. This collection is then piped to the Select-Object, which does two things: it selects the Identity property, and it expands the Holidays property.

These two pieces of information - Identity, and the expanded value of the Holidays property - are piped to the Where-Object cmdlet; Where-Object then picks out only those items where the Name of the holiday is equal to (-eq) Christmas Day. Finally, the filtered collection is piped to the ForEach-Object cmdlet. This cmdlet takes each Identity in the collection and, one-by-one, uses Get-CsRgsHolidaySet to retrieve the corresponding holiday set. The net result is a list of all the holiday sets that include a Christmas Day holiday.