MSFT_SIPRgsWorkflowData (New)

  • Article

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 settings for Response Group Service workgroups.

MSFT_SIPRgsWorkflowData

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_SIPRgsWorkflowData
{
  boolean Active;
  [key] string Backend;
  string ContactDN;
  string DefinitionXml;
  string Description;
  [key] string InstanceId;
  uint32 LCID;
  string Name;
  string[] OwnerSIDs;
  string TemplateId;
  string Type;
};

Methods

This class does not define any methods.

Properties

The MSFT_SIPRgsWorkflowData class has the following properties.

  • Active
    Data type: boolean

    Access type: Read/Write

    Required.

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

  • ContactDN
    Data type: string

    Access type: Read/Write

    Required. The distinguished name for the contact object that represents the response group to callers.

    Important

    Office Communication Server does not update this property automatically if the Active Directory DN for the contact object changes.

    This can be the address of any Contact object that is not already in use.

    The value of this property is not case-sensitive.

  • DefinitionXml
    Data type: string

    Access type: Read/Write

    Required. Specifies XML settings (such as the welcome message, audio files, and IVR questions/answers) of the workflow in XML format. We do not support modifying the XML directly through the code.

    The value of this property is not case-sensitive.

  • Description
    Data type: string

    Access type: Read/Write

    Optional. A description for the workflow that appears on the contact card in Office Communicator.

    The value of this property is not case-sensitive.

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

  • LCID
    Data type: uint32

    Access type: Read/Write

    Required. The locale ID that defines the language for text-to-speech translation.

    Note

    The corresponding language pack must be installed and registered on the server before this property is set to a particular locale ID.

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

  • Name
    Data type: string

    Access type: Read/Write

    Required. The name for a workflow.

    The value of this property is case-sensitive. The maximum length of the string is 256 characters.

  • OwnerSIDs
    Data type: string[]

    Access type: Read/Write

    Optional. Specifies managers who can modify settings for this workflow. This property is an array of security identifiers (SIDs) associated with user accounts.

    If a user’s SID is on this list, the user is considered to be a manager for a hunt group workflow. You can use the WMI interface to set managers for IVR workflows.

    The value of this property is not case-sensitive.

  • TemplateId
    Data type: string

    Access type: Read/Write

    Required. The ID for the template associated with the workflow.

  • Type
    Data type: string

    Access type: Read/Write

    Required. Specifies how calls are routed to agents.

    The value of this property is not case-sensitive.

    Value

    Description

    Huntgroup

    Huntgroup routes callers to the specified queue without asking any questions.

    ACD

    Automatic Call Distributor (ACD) routes calls to specified queues based on an interactive voice response (IVR).

    The maximum length of the string is 9 characters.

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

Namespace: Defined in \root\cimv2.

See Also

Concepts

Office Communications Server WMI Reference