MSFT_SIPCDRServiceSetting (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 an instance of the Call Detail Records (CDRs) Service. The Call Detail Records Service is a Monitoring Server component that collects usage information related to Voice over IP (VoIP) calls, instant messaging (IM) messages, audio/video (A/V) conversations, meetings, file transfers, application sharing, remote assistance, and file transfers. This class is configured on the Monitoring Server level.

MSFT_SIPCDRServiceSetting

The property values for the MSFT_SIPCDRServiceSetting class map to the settings found on the General tab of the monitoring server dialog box. You can access these values in the Office Communications Server 2007 R2 Administration Tool by expanding the Monitoring Servers container, right-clicking the server, and then clicking Properties.

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

Dd146623.MSFT_SIPCDRServiceSetting_generaltab(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_SIPCDRServiceSetting
{
  string CDRDBPath;
  uint32 ConcurrentThreads;
  uint32 DaysToKeepCDR;
  uint32 DaysToKeepDiagnostics;
  [key] string InstanceID;
  string LogFilePath;
  uint32 MaxLogFileSize;
  uint32 PurgeTime;
  string SQLDBName;
};

Methods

This class does not define any methods.

Properties

The MSFT_SIPCDRServiceSetting class has the following properties.

  • CDRDBPath
    Data type: string

    Access type: Read/Write

    Required. The instance of Microsoft SQL Server that manages the CDR Service database. Maps to the SQL 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 CDR 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.

  • DaysToKeepCDR
    Data type: uint32

    Access type: Read/Write

    Required. The number of days that CDR data is retained before being removed from the database. Maps to the Maximum Days Logged box in the Administration Tool user interface.

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

  • DaysToKeepDiagnostics
    Data type: uint32

    Access type: Read/Write

    Required. Days to keep diagnostic information for the CDR Service. The DaysToKeepDiagnostics value does not appear in the Administration Tool.

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

  • 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 Monitoring Server. The default value is the Logs folder in the installation location for the Monitoring Server.

    The maximum length of the string is 160 characters.

  • MaxLogFileSize
    Data type: uint32

    Access type: Read/Write

    Required. The maximum size of the database insertion error log file in kilobytes. The MaxLogFileSize value does not appear in the Administration Tool.

    When the log file size exceeds this value, a new file is created in the folder specified by LogFilePath.

    The default value for this property is 64 (for 64 KB). The minimum value is 1 and the maximum value is 64.

  • PurgeTime
    Data type: uint32

    Access type: Read/Write

    Required. The start time for purging outdated CDR records. Set this time to occur during the idle time for 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 CDR data is stored on the database server specified by CDRDBPath. 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 flag:

    • WBEM_FLAG_CREATE_ONLY

    • WBEM_FLAG_UPDATE_ONLY

    • WBEM_FLAG_CREATE_OR_UPDATE

Requirements

Server: Installed on computers serving the following role(s): Monitoring Server.

Namespace: Defined in \root\cimv2.

See Also

Concepts

Office Communications Server WMI Reference

Other Resources

Deploying Monitoring Server