MSFT_SIPGroupExpansionSetting

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

Specifies settings of the Office Communications Server group expansion Web service. Distribution group expansion enables users to invite all or selected members of a distribution group to an instant messaging (IM) conversation without having to search for and add each one individually.

The property values for the MSFT_SIPGroupExpansionSetting class map to the settings found on the Address Book tab of the Web Components 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, and then clicking Web Component Properties. In the Web Component Properties dialog box, click the Address Book tab. Note that these settings apply only to the specified pool or server.

MSFT_SIPGroupExpansionSetting

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_SIPGroupExpansionSetting
{
  [key] string Backend;
  boolean EnableDLOperation;
  string ExternalDLExpansionWebURL;
  [key] string InstanceID;
  string InternalDLExpansionWebURL;
  uint32 MaxGroupSize;
};

Methods

This class does not define any methods.

Properties

The MSFT_SIPGroupExpansionSetting 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 must be empty when accessing data from the Edge Server or Proxy Server role.

    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.

    The Backend property is not mapped to the Web Components Properties dialog box.

    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.

  • EnableDLOperation
    Data type: boolean

    Access type: Read/Write

    Required. Controls whether clients can query for distribution list (DL) expansion.

    The default value is True when Web services for DL operations are set up.

    The default value is True.

    The EnableDLOperation property maps to the Enable distribution group expansion checkbox in the Web Components Properties dialog box.

  • ExternalDLExpansionWebURL
    Data type: string

    Access type: Read/Write

    Optional. HTTPS URL for external DL expansion Web services.

    The ExternalDLExpansionWebURL property maps to the External URL text box in the Web Components 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 is not mapped to the Web Components Properties dialog box.

  • InternalDLExpansionWebURL
    Data type: string

    Access type: Read/Write

    Optional. HTTPS URL for internal DL expansion Web services.

    The InternalDLExpansionWebURL property maps to the Internal URL text box in the Web Components Properties dialog box.

  • MaxGroupSize
    Data type: uint32

    Access type: Read/Write

    Required. Specifies the maximum number of group members that are returned to the client.

    If the group size is greater than this number, only the first set of members equal to this number are returned. For example, if the MaxGroupSize is 100, but the number of members in a group is 400, only the first 100 are returned.

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

    The default value is 100.

    The MaxGroupSize property maps to the Maximum group size text box in the Web Components Properties dialog box.

Remarks

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

Only one instance of this class can be present in the pool.

Microsoft Office Communicator 2007 R2 is limited to displaying no more than 100 members of a group, regardless of whether MaxGroupSize is set to a value greater than 100.

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, Front End Server, and Web Components Server.

Namespace: Defined in \root\cimv2.

See Also

Concepts

Office Communications Server WMI Reference