Export (0) Print
Expand All
Expand Minimize

MSFT_SIPRgsQueueData (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 a call waiting queue. Call waiting queues can be assigned to Response Group Service workflows.

The property values for the MSFT_SIPRgsQueueData class map to the settings found in the Queue 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 Queues 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_SIPRgsQueueData
{
  [key] string Backend;
  string Description;
  string[] GroupIds;
  [key] string InstanceId;
  string Name;
  string OnOverflowActOn;
  string OnOverflowQueueId;
  string OnOverflowUri;
  string OnTimeoutQueueId;
  string OnTimeoutUri;
  string OverflowAction;
  uint32 OverflowThreshold;
  string TimeoutAction;
  uint32 TimeoutThreshold;
  string[] WorkflowIds;
};

Methods

This class does not define any methods.

Properties

The MSFT_SIPRgsQueueData 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.

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

Description

Data type: string

Access type: Read/Write

Optional. Can be used to provide information about a queue.

The value of this property is not case-sensitive.

The Description property maps to the Description text box on the General tab of the Queue Properties dialog box.

GroupIds

Data type: string[]

Access type: Read/Write

Optional. Specifies an array of agent group IDs. When a call is waiting in the queue, Office Communications Server searches the groups for an available agent. The groups are searched in the same order that they are located in the array. You can change the search order by reordering group IDs in the array.

The value of this property is not case-sensitive.

The GroupIds property maps to the Selected Groups list box on the Groups tab of the Queue Properties dialog box.

InstanceId

Data type: [key] string

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

Required.

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

Name

Data type: string

Access type: Read/Write

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

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 of the Queue Properties dialog box.

OnOverflowActOn

Data type: string

Access type: Read/Write

Optional. Specifies whether the overflow action is performed on the newest or the oldest call in the queue.

The value of this property is not case-sensitive.

Value

Description

OldestCall

Performs the overflow action on the oldest call in the queue.

NewestCall

Performs the overflow action on the newest call in the queue.

The maximum length of the string is 10 characters.

The OnOverflowActOn property maps to the Forward the dropdown list on the Overflow tab of the Queue Properties dialog box.

OnOverflowQueueId

Data type: string

Access type: Read/Write

Optional. If OverflowAction is set to TransferToQueue, this property specifies the ID for a queue to which calls are forwarded after the queue overflows.

You can leave this property set to NULL if the OverflowAction property is set to Disabled. If OverflowAction is set to any other value than Disabled, set this property to a valid queue ID.

The OnOverflowActOn property maps to the Another queue text box on the Overflow tab of the Queue Properties dialog box.

OnOverflowUri

Data type: string

Access type: Read/Write

Optional. If OverflowAction is set to TransferToUri, this property specifies a SIP URI to which calls are forwarded after the queue overflows.

Set the value for a URI in the format username@domainname. To forward a call to a telephone number, set the value in format number@domainname (for example, +14255550121@contoso.com).

The maximum length of the string is 454 characters.

The OnOverflowActOn property maps to the SIP URI and the Telephone Number text boxes on the Overflow tab of the Queue Properties dialog box.

OnTimeoutQueueId

Data type: string

Access type: Read/Write

Optional. If TimeoutAction is set to "TransferToQueue", this property specifies the ID for a queue to which calls are forwarded after they time out.

The OnTimeoutQueueID property maps to the Another queue text box on the Time Out tab of the Queue Properties dialog box.

OnTimeoutUri

Data type: string

Access type: Read/Write

Optional. If OverflowAction is set to TransferToUri, this property specifies a SIP URI to which calls are forwarded after they time out.

Set the value for a URI in the format username@domainname. To forward a call to a telephone number, set the value in format number@domainname (for example, +14255550121@contoso.com).

The maximum length of the string is 454 characters.

The OnTimeoutURI property maps to the SIP URI and the Telephone Number text boxes on the Time Out tab of the Queue Properties dialog box.

OverflowAction

Data type: string

Access type: Read/Write

Required. Defines what happens to calls specified by OnOverflowActOn when the queue overflows.

The value of this property is not case-sensitive.

Value

Description

Disabled

No limit on the number of callers in the queue.

TransferToQueue

Transfer calls to a queue specified by the OnOverflowQueueId property.

TransferToUri

Transfer calls to a SIP URI specified by the OnOverflowUri property.

The maximum length of the string is 15 characters.

The OverflowAction property maps to the No overflow checkbox on the Overflow tab of the Queue Properties dialog box.

OverflowThreshold

Data type: uint32

Access type: Read/Write

Optional. The maximum number of calls allowed in the queue when the OverflowAction property is set to TransferToQueue or TransferToURI . Any value specified here is ignored if OverflowAction is set to Disabled.

When this property is set to 0, all calls are transferred to the queue specified by OverflowAction.

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

The OverflowThreshold property maps to the Maximum number of calls box on the Overflow tab of the Queue Properties dialog box.

TimeoutAction

Data type: string

Access type: Read/Write

Required.

The value of this property is not case-sensitive.

Value

Description

"Disabled"

Calls do not time out.

"TransferToQueue"

Calls are transferred to the queue specified by the OnTimeoutQueueId property.

"TransferToUri"

Calls are transferred to the SIP URI specified by the OnTimeoutUri property.

The maximum length of the string is 15 characters.

The TimeoutAction property maps to the Never time out the call checkbox on the Time Out tab of the Queue Properties dialog box.

TimeoutThreshold

Data type: uint32

Access type: Read/Write

Optional. Specifies the maximum interval in seconds that callers wait to be connected to an available agent before they are forwarded to another destination.

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

The TimeoutThreshold property maps to the Time out period (seconds) box on the Time Out tab of the Queue Properties dialog box.

WorkflowIds

Data type: string[]

Access type: Read/Write

Optional. The array of workflow IDs for workflows that route calls to the queue.

The value of this property is not case-sensitive.

Remarks

This class gets and sets information at the following levels: 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 Server.

Namespace: Defined in \root\cimv2.

Show:
© 2015 Microsoft