This documentation is archived and is not being maintained.

MSFT_SIPRgsGroupData (New)

This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.

Defines settings of an agent group used for a workflow.

The property values for the MSFT_SIPRgsGroupData class map to the settings found in the Group Properties dialog box. You can access these values in the Office Communications Server 2007 R2 Administration Tool by right-clicking the name of a Standard Edition server or Enterprise Edition pool, pointing to Properties, pointing to Applications, and then clicking Response Group Service Properties. In the Response Group Service snap-in, click the Groups node.

The following syntax is simplified from Managed Object Format (MOF) code and includes all inherited properties. Properties are listed in alphabetic order, not MOF order.

Syntax

class MSFT_SIPRgsGroupData
{
  string[] AgentIds;
  string AgentStatePolicy;
  [key] string Backend;
  string Description;
  string DistributionListId;
  [key] string InstanceId;
  string Name;
  uint32 RingTimeout;
  string RoutingMethod;
};

Methods

This class does not define any methods.

Properties

The MSFT_SIPRgsGroupData class has the following properties.

AgentIds

Data type: string[]

Access type: Read/Write

Optional. Specifies an ordered array of member agent IDs defined by instances of the [MSFT_SIPRgsAgentData] class. This populates the group with the listed agents.

When group members are specified using this property, set DistributionListId to NULL.

The value of this property is not case-sensitive.

The AgentIDs property maps to the Assigned Agents list box on the Agents tab in the Group Properties dialog box.

AgentStatePolicy

Data type: string

Access type: Read/Write

Required. Sets the sign-in behavior for the group.

The value of this property is not case-sensitive.

Value

Description

NeverAvailable

Specifies that calls cannot be routed to this agent group.

ConditionallyAvailable

Specifies that agents in the group must sign in and out of the group using the Office Communicator RGS Agent tab.

AlwaysAvailable

Specifies that agents in the group cannot sign in and out of the group. Agents are automatically signed in to the group when they sign in to Office Communications Server.

The maximum length of the string is 22 characters.

The AgentStatePolicy property maps to the Agent participation policy option buttons on the Policies tab in the Group Properties dialog box.

Backend

Data type: [key] string

Access type: Read-only

Required: When accessing data from any role that belongs to a pool.

This property identifies the instance of SQL Server that manages the back-end database for Office Communications Server.

The value for this property depends on the topology of Office Communications Server.

Topology

Value

Standard Edition

(local)\rtc

Enterprise Edition

(consolidated or expanded configuration)

computername\instancename

or

computername

For Enterprise Edition, computername identifies either the FQDN or the NetBIOS name of the host computer for SQL Server and instancename identifies a named instance of SQL Server on the host computer. The value computername by itself specifies the default instance of SQL Server on the host computer.

The Backend property does not map to the Group Properties dialog box.

Description

Data type: string

Access type: Read/Write

Optional. A string that provides additional information about the group.

The value of this property is not case-sensitive.

The Description property maps to the Description text box on the General tab in the Group Properties dialog box.

DistributionListId

Data type: string

Access type: Read/Write

Optional. Specifies the InstanceID for an instance of the MSFT_SIPRgsDistributionListData class.

This populates the group with members of a distribution list. When group members are specified using this property, set AgentIds to NULL.

When this property specifies a distribution list:

  • This property must only specify a single distribution list for the agent group. An agent group can only support a single distribution list.

  • If the distribution list is a nested distribution list, only the first-level members are added to the agent list.

  • If serial and round robin routing are selected, no assumption can be made about the order.

NoteNote

An e-mail distribution list must be expanded before the necessary agent information can be obtained to route calls to the agents in the group. When the Response Group Service starts, it loads the Windows Management Instrumentation (WMI) cache settings, which include the workflow, queue, and group information, before it starts to expand the distribution lists. As a result, there is a delay before the Response Group Service can route calls to groups that use an e-mail distribution list. Calls can be routed to the groups after the expansion process completes.

The DistributionListID property maps to the Use an existing e-mail distribution list checkbox on the Agents tab in the Group Properties dialog box.

InstanceId

Data type: [key] string

Access type: Read-only

Required. A GUID value that uniquely identifies an instance of this class.

The GUID must be encapsulated between the "{" and "}" braces; for example: "{01234567-0123-4567-89AB-CDEF01234567}".

The InstanceID property does not map to the Group Properties dialog box.

Name

Data type: string

Access type: Read/Write

Required. Specifies a name for the group. The name is displayed in client applications to identify the group.

The value of this property is case-sensitive.

The maximum length of the string is 256 characters.

The Name property maps to the Name text box on the General tab in the Group Properties dialog box.

RingTimeout

Data type: uint32

Access type: Read/Write

Required. Specifies in seconds how long to ring an agent before offering the call to the next available agent.

The minimum value for this property is 0 and the maximum value is 600.

The RingTimeout property maps to the Agent alert time (seconds) box on the Policies tab in the Group Properties dialog box.

RoutingMethod

Data type: string

Access type: Read/Write

Required. Specifies how calls are routed to agents in the group.

The value of this property is not case-sensitive.

Value

Description

LongestIdle

Initially offers a new call to the agent who has been idle the longest.

Serial

Offers a new call to the agents in the order in which they are ordered in the AgentIds property.

Parallel

Offers a new call to all available agents at the same time. The call is sent to the first agent who accepts it.

RoundRobin

Offers a new call to each agent in turn.

The maximum length of the string is 12 characters.

The RoutingMethod property maps to the Routing method option buttons on the Policies tab in the Group Properties dialog box.

Remarks

This class gets and sets information at the following level: SQL.

Instances of this class support the following interface methods:

  • Provider::DeleteInstance();

  • Provider::EnumerateInstances();

  • Provider::GetObject();

  • Provider::PutInstance();

    Where PutInstance() supports the following flags:

    • WBEM_FLAG_CREATE_ONLY

    • WBEM_FLAG_UPDATE_ONLY

    • WBEM_FLAG_CREATE_OR_UPDATE

Requirements

Server: Installed on computers serving the following roles: Administrative Tools Server, Application Host, and Web components.

Namespace: Defined in \root\cimv2.

Show: