MSFT_SIPRgsPoolData (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.

This class defines the pool settings for the Response Group.

The properties in the MSFT_SIPRgsPoolData class do not map directly to the Office Communications Server 2007 R2 Administration Tool.

MSFT_SIPRgsPoolData

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_SIPRgsPoolData
{
  [key] string Backend;
  boolean DisableRgsCallContext;
  [key] string InstanceId;
  uint32 MatchMakingServicePort;
  uint32 MaxTransferAttempts;
};

Methods

This class does not define any methods.

Properties

The MSFT_SIPRgsPoolData class has the following properties.

• 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.

• DisableRgsCallContext
  Data type: boolean

  Access type: Read/Write

  Required. Specifies whether to send the Interactive Voice Response (IVR) context of the caller. The IVR context includes information such as answers to IVR questions and how long the caller has been waiting.

  If this property is set to False, the RGS does not send the IVR context of the caller.

  The default setting for this property is False.

• 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}".

• MatchMakingServicePort
  Data type: uint32

  Access type: Read/Write

  Required. The port used by the active Match Making service for a pool. The Match Making service is the internal service on Front End Server that is responsible for queuing calls and finding available agents.

  The recommended port is the default port, 8404. Firewalls should be configured for MTLS transversal over the selected port.

  The minimum value for this property is 1 and the maximum value is 65535.

• MaxTransferAttempts
  Data type: uint32

  Access type: Read/Write

  Required. Defines how many times the Response Group Service tries to transfer a call to an agent before it gives up.

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

Remarks

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

This is a singleton class in a pool. Only one instance of this class can be present in a pool.

Instances of this class support the following interface methods:

• 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 and Application Host.

Namespace: Defined in \root\cimv2.

See Also

Concepts

Office Communications Server WMI Reference