Get-CsRgsWorkflow
Topic Last Modified: 2012-03-23
Returns information about Response Group workflows. Workflows determine the actions that are taken when the Response Group application receives a phone call.
Syntax
Get-CsRgsWorkflow [-Identity <RgsIdentity>] [-Name <String>]
Detailed Description
Workflows are perhaps the key element in the Response Group application. Each workflow is uniquely associated with a phone number; when someone calls that number, the workflow determines how the call will be handled. For example, the call might be routed to a series of interactive voice response (IVR) questions that prompt the caller to enter additional information ("Press 1 for hardware support. Press 2 for software support."). Alternatively, the call might be placed in a queue and the caller placed on hold until an agent is available to answer the call. The availability of agents to answer calls is also dictated by the workflow: workflows are used to configure both business hours (the days of the week and the times of day when agents are available to answer calls) and holidays (days when no agents are available to answer calls).
The Get-CsRgsWorkflow cmdlet provides a way for you to return information about the workflows configured for use in your organization.
Who can run this cmdlet: By default, members of the following groups are authorized to run the Get-CsRgsWorkflow 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 "Get-CsRgsWorkflow"}
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Identity |
Required |
Rgs Identity |
Represents either the Identity of the service where the Response Group workflow is hosted or the full Identity of the workflow itself. If you specify the service Identity (for example, service: ApplicationServer:atl-cs-001.litwareinc.com), then all the Response Group workflows hosted on that service will be returned. If you specify the Identity of the workflow, then only that one Response Group workflow will be returned. Note that the Identity of a workflow 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 Response Group workflow is to specify the service Identity, then include the Name parameter and the workflow name. That enables you to retrieve a specific workflow without having to know the GUID assigned to that workflow. If called without any parameters, Get-CsRgsWorkflow returns a collection of all the workflows configured for use in your organization. |
Name |
Optional |
String |
Unique name given to the Response Group workflow at the time the workflow was created. |
Input Types
None. Get-CsRgsWorkflow does not accept pipelined input.
Return Types
Get-CsRgsWorkflow returns instances of the Microsoft.Rtc.Rgs.Management.WritableSettings.Workflow object.
Example
-------------------------- Example 1 ------------------------
Get-CsRgsWorkflow
The preceding example returns information about all the workflows configured for use in your organization. This is done by calling Get-CsRgsWorkflow without any parameters.
-------------------------- Example 2 ------------------------
Get-CsRgsWorkflow -Identity service:ApplicationServer:atl-cs-001.litwareinc.com
Example 2 returns information about all the Response Group application workflows found on the service ApplicationServer:atl-cs-001.litwareinc.com.
-------------------------- Example 3 ------------------------
Get-CsRgsWorkflow -Identity service:ApplicationServer:atl-cs-001.litwareinc.com | Select-Object -ExpandProperty DefaultAction
The command shown in Example 3 displays detailed information about the DefaultAction property for each Response Group workflow found on the service ApplicationServer:atl-cs-001.litwareinc.com. To carry out this task, Get-CsRgsWorkflow is first used to return information about all the workflows found on ApplicationServer:atl-cs-001.litwareinc.com. This information is then piped to the Select-Object cmdlet, which "expands" the value stored in the DefaultAction property. When you expand the value of DefaultAction, you see the individual properties of the embedded object stored in the DefaultAction property.
-------------------------- Example 4 ------------------------
Get-CsRgsWorkflow -Identity service:ApplicationServer:atl-cs-001.litwareinc.com -Name "European Sales Support"
Example 4 returns information about a single Response Group workflow: the European Sales Supports workflow found on ApplicationServer:atl-cs-001.litwareinc.com.
-------------------------- Example 5 ------------------------
Get-CsRgsWorkflow -Identity service:ApplicationServer:atl-cs-001.litwareinc.com | Where-Object {$_.Language -eq "en-Us"}
The command shown in Example 5 returns information about all the Response Group workflows that use U.S. English as the primary language. To do this, the command first calls Get-CsRgsWorkflow to return a collection of all the workflows found on the service ApplicationServer:atl-cs-001.litwareinc.com. That collection is then piped to the Where-Object cmdlet, which selects only those workflows where the Language property is equal to U.S. English (en-US).
-------------------------- Example 6 ------------------------
Get-CsRgsWorkflow service:ApplicationServer:atl-cs-001.litwareinc.com | Where-Object {$_.CustomMusicOnHold -eq $Null}
The preceding command returns all the workflows on ApplicationServer:atl-cs-001.litwareinc.com where the CustomMusicOnHold property has been set to a null value. (In other words, the command returns information about the workflows that have not been assigned custom music.) To carry out this task, the command first uses Get-CsRgsWorkflow to return a collection of all the workflows found on the service ApplicationServer:atl-cs-001.litwareinc.com. The returned data is then piped to Where-Object, which picks out only those items where the CustomMusicOnHold property is equal to a null value.