3.2.4.2 IDataManager

  • Article

The IDataManager interface is used to manage data generated by the data collectors, including report generation, data retention policy, and data transfer.

The following properties MUST be implemented by the objects that implement the IDataManager interface.

Property

Read/write

Description

CheckBeforeRunning

RW

Indicates whether maximum folder count and minimum free disk space thresholds MUST be checked before running the data collector set. If set to VARIANT_TRUE and either one of the conditions is not met, the data collector set MUST fail the start. If set to VARIANT_FALSE, the thresholds will still be used after collection to determine if the resource policy will be invoked. The ResourcePolicy property is defined below.

The MaxSize threshold is never checked before running an IDataManager, irrespective of the value of this property.

Enabled

RW

Determines whether data management is enabled. If set to VARIANT_FALSE, all other settings of this object are ignored and no data management operations (such as creating a report) execute; the data manager is not run. If set to VARIANT_TRUE, all other properties of this object are used and the data manager is run. The properties that are used when the data manager runs are as follows:

  • CheckBeforeRunning

  • EventsFileName

  • FolderAction

  • MaxFolderCount

  • MaxSize

  • MinFreeDisk

  • ReportFileName

  • ReportSchema

  • ResourcePolicy

  • Rules

  • RulesTargetFileName

EventsFileName

RW

Specifies the name of the file that MUST be created by the Performance Logs and Alerts Protocol, during report generation. This file contains all the events that were collected, serialized to XML. This file differs from the report file because the events are not normalized, performance data is not included, and rules are not run against this file.

FolderActions

R

List of actions to be performed on the subfolders that match the criteria. The IFolderAction interface is specified in section 3.2.4.3.

MaxFolderCount

RW

Specifies the threshold for the maximum number of subfolders under the data collector sets root path. If this threshold is violated, the action specified by the ResourcePolicy property is invoked. If this property is set to zero, there is no maximum. The default value is zero. Any unsigned long is a valid value for this property.

MaxSize

RW

Specifies the maximum size, in megabytes, of all files under the data collector set root path. If this threshold is violated, the action specified by the ResourcePolicy property is invoked. If this property is set to zero, there is no maximum. The default value is zero. Any unsigned long is a valid value for this property.

MinFreeDisk

RW

Specifies the minimum free space, in MB, that MUST remain available in the data collector set root path volume. If this threshold is violated, the data collector set will not start collecting data. If this property is set to zero, there is no minimum. The default value is zero. Any unsigned long is a valid value for this property.

ReportFileName

RW

Specifies the name of the HTML file that results from converting the file in RuleTargetFileName from XML to HTML.

ReportSchema

RW

Specifies the XML used to customize the report generated from the data. The XSD that defines the format of the XML is specified in section 2.2.3.3 .

ResourcePolicy

RW

Specifies the action to be performed if one of the disk resource limits is violated. The limits are the maximum folder count, the maximum size and the minimum free disk space. The possible actions are described in the ResourcePolicy enumeration in section 2.2.2.9.

Rules

RW

The rules to be applied to the report file. The rules are specified in an XML format, which is specified in section 2.2.3.4.

RuleTargetFileName

RW

Specifies the name of the file where the report data is stored before rules are run against it and it is converted to HTML.

Methods in RPC Opnum Order

Method

Description

Enabled (Get)

Retrieves the Enabled property.

Opnum: 7

Enabled (Put)

Sets the Enabled property.

Opnum: 8

CheckBeforeRunning (Get)

Retrieves the CheckBeforeRunning property.

Opnum: 9

CheckBeforeRunning (Put)

Sets the CheckBeforeRunning property.

Opnum: 10

MinFreeDisk (Get)

Retrieves the MinFreeDisk property.

Opnum: 11

MinFreeDisk (Put)

Sets the MinFreeDisk property.

Opnum: 12

MaxSize (Get)

Retrieves the MaxSize property.

Opnum: 13

MaxSize (Put)

Sets the MaxSize property.

Opnum: 14

MaxFolderCount (Get)

Retrieves the MaxFolderCount property.

Opnum: 15

MaxFolderCount (Put)

Sets the MaxFolderCount property.

Opnum: 16

ResourcePolicy (Get)

Retrieves the ResourcePolicy property.

Opnum: 17

ResourcePolicy (Put)

Sets the ResourcePolicy property.

Opnum: 18

FolderActions (Get)

Retrieves the FolderAction property.

Opnum: 19

ReportSchema (Get)

Retrieves the ReportSchema property.

Opnum: 20

ReportSchema (Put)

Sets the ReportSchema property.

Opnum: 21

ReportFileName (Get)

Retrieves the ReportFileName property.

Opnum: 22

ReportFileName (Put)

Sets the ReportFileName property.

Opnum: 23

RuleTargetFileName (Get)

 Retrieves the RuleTargetFileName property.

Opnum: 24

RuleTargetFileName (Put)

Sets the RuleTargetFileName property.

Opnum: 25

EventsFileName (Get)

Retrieves the EventsFileName property.

Opnum: 26

EventsFileName (Put)

Sets the EventsFileName property.

Opnum: 27

Rules (Get)

Retrieves the Rules property.

Opnum: 28

Rules (Put)

Sets the Rules property.

Opnum: 29

Run

Manually runs the data manager.

Opnum: 30

Extract

Extracts the specified CAB file.

Opnum: 31

Opnums 0, 1, and 2 are reserved for the IUnknown interface. Opnums 3, 4, 5, and 6 are reserved for the IDispatch interface.