Export (0) Print
Expand All
Expand Minimize

Get-CsRgsHolidaySet

 

Topic Last Modified: 2012-08-11

Returns information about the Response Group holiday sets configured for use in your organization. A Response Group holiday set is a collection of holidays. For example, you might have one holiday set for a United States (U.S.)-based queue (a set which might include a holiday for the Fourth of July) and a different set for a queue based in France. The latter queue might define a holiday for Bastille Day but not for the Fourth of July. This cmdlet was introduced in Lync Server 2010.

Get-CsRgsHolidaySet [-Identity <RgsIdentity>] [-Name <String>] [-Owner <RgsIdentity>] [-ShowAll <SwitchParameter>]

Example 1 returns information about all the holiday sets configured for use in your organization.

Get-CsRgsHolidaySet

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

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

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

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

Example 4 displays detailed information for the holidays found in the holiday set "2013 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 for each holiday in the set.

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

The command shown in Example 5 reports the Identity of each holiday set on ApplicationServer:atl-cs-001.litwareinc.com that includes a holiday named Christmas Day. To do this, 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 HolidayList property.

These two pieces of information -- Identity, and the expanded value of the HolidayList property -- are then piped to the Where-Object cmdlet; in turn, Where-Object picks out the items where the Name of the holiday is equal to 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.

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

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 A.M. to 5:00 P.M. Monday through Friday, then you would configure business hours that show that agents are available from 9:00 A.M. to 5:00 P.M. Monday through Friday (and, by extension, that agents are not available at, say, 8:00 P.M. on a Thursday or 2:30 P.M. on a Sunday).

However, in many organizations there are exceptions to the typical work week; for example, in the U.S., 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 by using the New-CsRgsHoliday cmdlet) are collected in holiday sets; for example, holidays for the U.S. might be collected in a holiday set named US_Holidays, while holidays for Japan might be collected in a holiday set named Japanese_Holidays. After they are collected, holiday sets can then be assigned to Response Group workflows.

The Get-CsRgsHolidaySet provides a way for you to return information about the Response Group holiday sets configured for use in your organization.

Who can run this cmdlet: By default, members of the following groups are authorized to run the Get-CsRgsHolidaySet cmdlet locally: RTCUniversalServerAdmins, RTCUniversalReadOnlyAdmins. To return a list of all the role-based access control (RBAC) roles this cmdlet has been assigned to (including any custom RBAC roles you have created yourself), run the following command from the Windows PowerShell prompt:

Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Get-CsRgsHolidaySet"}

 

Parameter Required Type Description

Identity

Optional

Microsoft.Rtc.Rgs.Management.RgsIdentity

Represents either the Identity of the service where the holiday set is hosted or the full Identity of the holiday set. If you specify the service Identity (for example, service:ApplicationServer:atl-cs-001.litwareinc.com), then all the holiday sets hosted on that service will be returned. If you specify the Identity of the holiday set, then only the specified set will be returned. Note that the Identity of a holiday set consists of the service Identity followed by a globally unique identifier (GUID); for example: service:ApplicationServer:atl-cs-001.litwareinc.com/1987d3c2-4544-489d-bbe3-59f79f530a83.

An alternate way to return a single holiday set is to specify the service Identity, and then include the Name parameter and the holiday set name. That enables you to retrieve a specific holiday set without having to know the GUID assigned to that set.

If called without any parameters, Get-CsRgsHolidaySet returns a collection of all the holiday sets configured for use in your organization.

Name

Optional

System.String

Unique name given to the holiday set at the time the set was created.

Owner

Optional

Microsoft.Rtc.Rgs.Management.RgsIdentity

Fully qualified domain name of the pool that "owns" the holiday set. The Owner pool ID and the Pool ID of a holiday set are typically the same. However, if a holiday set needs to temporarily be moved (perhaps in a disaster recovery procedure) then the Pool ID will change. However, the Owner ID will continue to point to the original pool.

ShowAll

Optional

System.Management.Automation.SwitchParameter

When present, shows all the Response Group holiday sets, including those sets where the Owner pool ID and the Pool ID are different. By default, Get-CsRgsHolidaySet only returns information about agent sets where the Owner pool ID and the Pool ID are identical.

None. Get-CsRgsHolidaySet does not accept pipelined input.

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

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft