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

Defines settings for an instance of the Office Communications Server 2007 R2 Archiving Service. Archiving Service settings specify the SQL Server server database that for the archiving data and determine how long information is retained in the database. The Archiving Service is configured at the Archiving Server level.

MSFT_SIPArchivingServiceSetting

The property values for the MSFT_SIPArchivingServiceSetting class map to the settings found on the Archiving Server Settings dialog box. You can access these values in the Office Communications Server 2007 R2 Administration Tool by expanding Archiving Servers, right-clicking the fully qualified domain name (FQDN) of the Archiving Server, and then clicking Properties.

The mapping between the dialog box and the WMI properties is shown in the illustration below:

Dd130038.MSFT_SIPArchivingServiceSettings(en-us,office.13).jpg

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_SIPArchivingServiceSetting
{
  string ArchivingDBPath;
  uint32 ConcurrentThreads;
  uint32 DaysOfArchiving;
  [key] string InstanceID;
  string LogFilePath;
  uint32 MaxLogFileSize;
  uint32 PurgeTime;
  string SQLDBName;
};

Methods

This class does not define any methods.

Properties

The MSFT_SIPArchivingServiceSetting class has the following properties.

  • ArchivingDBPath
    Data type: string

    Access type: Read/Write

    Required. The instance of Microsoft SQL Server that manages the Archiving Service databases. Maps to the Server Name box in the Administration Tool user interface.

    This value specifies an instance of Microsoft SQL Server in the format computername\instancename.

    The value of this property is not case-sensitive.

  • ConcurrentThreads
    Data type: uint32

    Access type: Read/Write

    Required. The number of threads that can simultaneously service the message queue for the Archiving Service. The ConcurrentThreads value does not appear in the Administration Tool.

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

  • DaysOfArchiving
    Data type: uint32

    Access type: Read/Write

    Required. The number of days that content is archived before the previously archived data is removed from the database. Maps to the Archiving Days Logged box in the Administration Tool user interface.

    The minimum value for this property is 0 and the maximum value is 2562, where 0 means that archived data is never overwritten.

  • InstanceID
    Data type: [key] string

    Access type: Read-only

    A GUID value that uniquely identifies an instance of this class. The InstanceID value does not appear in the Administration Tool.

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

  • LogFilePath
    Data type: string

    Access type: Read/Write

    Required. The full path for the log file that contains records that could not be inserted into the database. The LogFilePath value does not appear in the Administration Tool.

    This is a local path on the computer running the Archiving Server. The default value is the Logs folder in the installation location of the Archiving Server.

    The maximum length of the string is 160 characters.

  • MaxLogFileSize
    Data type: uint32

    Access type: Read/Write

    Required. The maximum size of the Archiving Service database insertion error log in kilobytes. The default value for this property is 64 (for 64 KB). The MaxLogFileSize value does not appear in the Administration Tool.

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

  • PurgeTime
    Data type: uint32

    Access type: Read/Write

    Required. The start time for purging outdated Archiving Service records.

    Set this time to be the idle time of the server. The PurgeTime value does not appear in the Administration Tool.

    The value is based on a 24-hour clock. The default value for this property is 4 (for 4 AM).

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

  • SQLDBName
    Data type: string

    Access type: Read-only

    Required. The name of the SQL Server database where instant messages are archived on the database server specified by ArchivingDBPath. Maps to the Database Name box in the Administration Tool user interface.

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

Remarks

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

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

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 role: Archiving Server.

Namespace: Defined in \root\cimv2.

See Also

Concepts

Office Communications Server WMI Reference

Other Resources

Viewing and Changing Settings for Archiving Server