[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]

Represents an implementation of a condition detection module type definition.

Schema Hierarchy

ManagementPack
  Monitoring
    Rules
      Rule
        ConditionDetection

Syntax

Xml 
<ConditionDetection ID=”ModuleID” Comment=”Comment” TypeID=”ModuleTypeID”>
Custom Schema Defined Parameters
</ConditionDetection>

Attributes and Elements

The following sections describe attributes, child elements, and the parent element of the ConditionDetection element.

Attributes

Attribute Description

ID

Required attribute. Represents the identity of the element.

Comment

Optional attribute. Represents commentary by the management pack author.

TypeID

Required attribute. Represents the ConditionDetection module type definition from which this ConditionDetection module inherits its configuration schema.
ID Attribute Values

Value Description

The format for the ID attribute should be UniqueElementID.

The ID string must have the following characteristics:

  • The length is less than 255 characters.

  • The ID begins with a letter (a-z) or a number (0-9).

  • The ID contains only letters, numbers, the period character (.), or the underscore (_) character.

  • The ID is unique across all elements within the scope of the ConditionDetection module’s containing workflow.

  • The ID is case-sensitive.

Child Elements

The child element of the ConditionDetection module is defined by the Configuration (ConditionDetectionModuleType) schema of its base type as referenced in the TypeID attribute.

Parent Elements

Element Description

Rule

Contains all of the modules that are used in the linear workflow of a module type definition.

Remarks

A condition detection module takes any number of input streams and outputs data based on some kind of filtering of data. Condition detection modules are also used to convert one data type to another data type in a workflow. Because a condition detection module can take multiple data input streams, it is also used to correlate or consolidate data within a workflow. The data types of its input and output data are defined in its InputTypes and OutputType elements, respectively.

A condition detection module type never alters system state. If you want your module to affect system state, you must use or implement a WriteAction (WriteActionModuleType) module.

In a rule workflow, a condition detection module is used to filter or map the data from a preceding DataSource (Rule) module so that the data can be in the appropriate format for writing.

Because a filtering condition detection module is not a data source, it always returns the same OutputType element of the preceding module in the workflow, whether that be a DataSource or a ProbeAction module.

A condition detection module’s base type must always be a descendant of a ConditionDetectionModuleType type.

See Also