New-CsRgsAgentGroup
Topic Last Modified: 2012-03-23
Creates a new Response Group agent group. An agent group is a collection of agents assigned to a Response Group queue. Agents are the users assigned to answer calls directed to a particular queue.
Syntax
New-CsRgsAgentGroup -Parent <RgsIdentity> -Name <String> [-AgentAlertTime <Int16>] [-AgentsByUri <Collection>] [-Confirm [<SwitchParameter>]] [-Description <String>] [-DistributionGroupAddress <String>] [-Force <SwitchParameter>] [-InMemory <SwitchParameter>] [-ParticipationPolicy <Informal | Formal>] [-RoutingMethod <LongestIdle | Serial | Parallel | RoundRobin | Attendant>] [-WhatIf [<SwitchParameter>]]
Detailed Description
When someone calls a phone number associated with the Response Group application, the application first determines which workflow corresponds to the number called. Based on the configuration of that workflow, the call might be routed to a set of interactive voice response (IVR) questions (in which the caller is asked one or more questions along the lines of "Is this question about hardware support or software support?"). Alternatively, the call might be placed in a Response Group queue; there the caller will be put on hold until a designated person is available to answer the call. The people designated to answer calls are known as agents, and a collected group of agents are referred to as a Response Group agent group. Agent groups are associated with queues, and are further associated with similar job responsibilities: help desk personnel might be grouped in the Help Desk agent group while customer support agents might be grouped in the Customer Support agent group.
If multiple groups are assigned to a queue, the Response Group application will start by ringing all the available agents in the first group assigned to that queue. If none of those agents answer, the application will then start ringing all the available agents in the next group assigned to the queue.
New agent groups are created by using the New-CsRgsAgentGroup cmdlet.
Who can run this cmdlet: By default, members of the following groups are authorized to run the New-CsRgsAgentGroup cmdlet locally: RTCUniversalServerAdmins. 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 "New-CsRgsAgentGroup"}
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Name |
Required |
String |
Unique name to be assigned to the agent group. The combination of the Parent property and the Name property enables you to uniquely identify agent groups without having to refer to the group’s globally unique identifier (GUID). |
Parent |
Required |
Rgs Identity |
Service where the new agent group will be hosted. For example: -Parent "service:ApplicationServer:atl-cs-001.litwareinc.com". |
AgentAlertTime |
Optional |
Integer |
Represents the amount of time (in seconds) that a call can remain unanswered before it is automatically routed to the next agent. The AgentAlertTime can be set to any integer value between 10 and 600 seconds (10 minutes), inclusive. The default value is 20 seconds. Note: The Agent alert time setting cannot exceed 180 seconds. If it exceeds 180 seconds, the client application will reject the call due to the SIP transaction timer reaching its maximum wait time. To avoid this, set the Alert Time value to less than 180 seconds. |
AgentsByUri |
Optional |
Agents collection |
Enables you to individually add agents to an agent group. New agents are identified using their SIP addresses. |
Description |
Optional |
String |
Enables administrators to provide additional, explanatory information about the agent group. For example, the Description might contain information about who to contact if the group does not receive the expected phone calls. |
DistributionGroupAddress |
Optional |
String |
Enables you to add all the members of a distribution group to an agent group. |
ParticipationPolicy |
Optional |
PS List Modifier |
Indicates whether or not agents are required to formally sign on to the system in order to receive phone calls intended for the group. If ParticipationPolicy is set to Informal (the default value) sign-in is not required. If ParticipationPolicy is set to Formal then sign-in is required. |
RoutingMethod |
Optional |
PS List Modifier |
Specifies the method used to route new calls to agents. The RoutingMethod must be set to one of the following values: LongestIdle – Calls are routed to the agent who has been idle (that is, not involved in a Microsoft Lync 2010 activity) for the longest period of time. RoundRobin – Calls are routed to the next agent on the list. Serial – Calls are always routed to the first agent on the list, and are only routed to other agents if this person is not available or does not answer within the allotted time. Parallel – Calls are routed to all agents at the same time, except for agents whose presence status indicates that they are in a call or otherwise unavailable. Attendant – Calls are routed to all agents at the same time, even if the agent’s presence status indicates that he or she is in a call or otherwise unavailable. The only exception occurs when an agent has set his or her presence to Do Not Disturb. The default routing method is Parallel. |
Force |
Optional |
GUID |
Suppresses the display of any non-fatal error message that might occur when running the command. |
InMemory |
Optional |
Switch Parameter |
Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet’s matching Set- cmdlet. |
Input Types
None. New-CsRgsAgentGroup does not accept pipelined input.
Return Types
New-CsRgsAgentGroup creates new instances of the Microsoft.Rtc.Rgs.Management.WritableSettings.AgentGroup object.
Example
-------------------------- Example 1 ------------------------
New-CsRgsAgentGroup -Parent service:ApplicationServer:atl-cs-001.litwareinc.com -Name "Help Desk Group"
The command shown in Example 1 creates a new Response Group agent group named Help Desk Group; this new group is located on the service ApplicationServer:atl-cs-001.litwareinc.com. To create the group, the command calls New-CsRgsAgentGroup along with the Parent and Name parameters. In this example, no other group parameters are specified, meaning the group will use all the default property values. Because no agents have been assigned to this group any calls routed to the new agent group will automatically be disconnected.
-------------------------- Example 2 ------------------------
New-CsRgsAgentGroup -Parent service: ApplicationServer:atl-cs-001.litwareinc.com -Name "Help Desk Group" -AgentsByUri "sip:kenmyer@litwareinc.com","sip:pilarackerman@litwareinc.com"
In Example 2, a new Response Group agent group is created and, at the same time, a pair of agents is assigned to that group. To do this, the command calls New-CsRgsAgentGroup along with the parameters Parent and Name. In addition, this example also includes the parameter AgentsByUri, accompanied by the parameter value "sip:kenmyer@litwareinc.com","sip:pilarackerman@litwareinc.com". This value is a comma-separated list of the SIP addresses to be added to the agent group.