Microsoft.SystemCenter.WebApplication.OKCriteriaMatch
Updated: September 16, 2011
The Microsoft.SystemCenter.WebApplication.OKCriteriaMatch condition detection module type takes System.BaseData data as input and either passes through or halts the workflow, depending on the value of the input. This module does not alter the data in any way.
Usage
This module is commonly used to evaluate the results from Microsoft.SystemCenter.WebApplication.UrlProbe data source module which runs a sequence of browser requests to a web site. That module carries out some evaluation on the results of the URL probe before passing on its output. Certain conditions will output a result of 1 (OK), 2 (warning), or 3 (error). The purpose of the Microsoft.SystemCenter.WebApplication.OKCriteriaMatch is to determine whether the data source module returned a value of 1 indicating healthy for a specific condition. It is usually used in a group of three condition detection modules along with Microsoft.SystemCenter.WebApplication.WarningCriteriaMatch and Microsoft.SystemCenter.WebApplication.ErrorCriteriaMatch.
Type Definition
<ConditionDetectionModuleType ID="Microsoft.SystemCenter.WebApplication.OKCriteriaMatch" Accessibility="Public" Batching="true" Stateful="false" PassThrough="false">
<Configuration>
<xsd:element name="DataItemEvaluationQuery" type="xsd:string" xmlns:xsd="http://www.w3.org/2001/XMLSchema" />
</Configuration>
<ModuleImplementation Isolation="Any">
<Composite>
<MemberModules>
<ConditionDetection ID="Filter" TypeID="Microsoft.SystemCenter.WebApplication.CriteriaMatch">
<DataItemEvaluationQuery>$Config/DataItemEvaluationQuery$</DataItemEvaluationQuery>
<ExpectedResult>1</ExpectedResult>
</ConditionDetection>
</MemberModules>
<Composition>
<Node ID="Filter" />
</Composition>
</Composite>
</ModuleImplementation>
<OutputType>System!System.BaseData</OutputType>
<InputTypes>
<InputType>System!System.BaseData</InputType>
</InputTypes>
</ConditionDetectionModuleType>
Parameters
The Microsoft.SystemCenter.WebApplication.OKCriteriaMatch module supports the following configuration parameters.
| Parameter | Type | Description |
|---|---|---|
|
DataItemEvaluationQuery |
String |
Indicates the condition to be matched. |
Composition
The Microsoft.SystemCenter.WebApplication.OKCriteriaMatch module is a composite module that contains the member modules that are described in the following table.
| Workflow Run Order | Module Type | Usage |
|---|---|---|
|
1 |
Microsoft.SystemCenter.WebApplication.CriteriaMatch |
Internal module that evaluates an expression against an expected result. |
Related Modules
| Module Type | Usage |
|---|---|
|
Like Microsoft.SystemCenter.WebApplication.OKCriteriaMatch, but evaluates a single data item against a result of 2. |
|
|
Like Microsoft.SystemCenter.WebApplication.OKCriteriaMatch, but evaluates a single data item against a result of 3. |
|
|
Like Microsoft.SystemCenter.WebApplication.OKCriteriaMatch, but evaluates a single data item against a result of true. |
|
|
Microsoft.SystemCenter.WebApplication.Boolean.CriteriaDoesNotMatch |
Like Microsoft.SystemCenter.WebApplication.OKCriteriaMatch, but evaluates a single data item against a result of false. |
External Module References
None
Sample
The following unit monitor type and unit monitor demonstrate the use of the three related condition detection modules. The three condition detection modules are each used in the RegularDetection section of the unit monitor type.
<UnitMonitorType ID="MPAuthor.WebApplication.BasePage.ContentMatchCriteria" Accessibility="Public">
<MonitorTypeStates>
<MonitorTypeState ID="ContentMatchCriteriaOK" NoDetection="false" />
<MonitorTypeState ID="ContentMatchCriteriaError" NoDetection="false" />
<MonitorTypeState ID="ContentMatchCriteriaWarning" NoDetection="false" />
</MonitorTypeStates>
<Configuration>
<element name="RequestID" type="xsd:unsignedInt" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://www.w3.org/2001/XMLSchema" />
</Configuration>
<MonitorImplementation>
<MemberModules>
<DataSource ID="DS1" TypeID="MPAuthor.WebApplication.UrlDataSource" />
<ProbeAction ID="OnDemandReset" TypeID="System!System.PassThroughProbe" />
<ConditionDetection ID="CDContentMatchCriteriaOK" TypeID="MicrosoftSystemCenterWebApplicationLibrary!Microsoft.SystemCenter.WebApplication.OKCriteriaMatch">
<DataItemEvaluationQuery>RequestResults/RequestResult[@Id="$Config/RequestID$"]/BasePageData/ResponseBodyEvalResult</DataItemEvaluationQuery>
</ConditionDetection>
<ConditionDetection ID="CDContentMatchCriteriaError" TypeID="MicrosoftSystemCenterWebApplicationLibrary!Microsoft.SystemCenter.WebApplication.ErrorCriteriaMatch">
<DataItemEvaluationQuery>RequestResults/RequestResult[@Id="$Config/RequestID$"]/BasePageData/ResponseBodyEvalResult</DataItemEvaluationQuery>
</ConditionDetection>
<ConditionDetection ID="CDContentMatchCriteriaWarning" TypeID="MicrosoftSystemCenterWebApplicationLibrary!Microsoft.SystemCenter.WebApplication.WarningCriteriaMatch">
<DataItemEvaluationQuery>RequestResults/RequestResult[@Id="$Config/RequestID$"]/BasePageData/ResponseBodyEvalResult</DataItemEvaluationQuery>
</ConditionDetection>
</MemberModules>
<RegularDetections>
<RegularDetection MonitorTypeStateID="ContentMatchCriteriaOK">
<Node ID="CDContentMatchCriteriaOK">
<Node ID="DS1" />
</Node>
</RegularDetection>
<RegularDetection MonitorTypeStateID="ContentMatchCriteriaError">
<Node ID="CDContentMatchCriteriaError">
<Node ID="DS1" />
</Node>
</RegularDetection>
<RegularDetection MonitorTypeStateID="ContentMatchCriteriaWarning">
<Node ID="CDContentMatchCriteriaWarning">
<Node ID="DS1" />
</Node>
</RegularDetection>
</RegularDetections>
<OnDemandDetections>
<OnDemandDetection MonitorTypeStateID="ContentMatchCriteriaOK">
<Node ID="OnDemandReset" />
</OnDemandDetection>
</OnDemandDetections>
</MonitorImplementation>
</UnitMonitorType>
<UnitMonitor ID="MPAuthor.WebApplication.Request1.BasePage.ContentMatchCriteria.Monitor" Accessibility="Public" Enabled="true" Target="MPAuthor.WebApplication" ParentMonitorID="MPAuthor.WebApplication.Request1.BasePage" Remotable="true" Priority="Normal" TypeID="MPAuthor.WebApplication.BasePage.ContentMatchCriteria" ConfirmDelivery="false">
<Category>PerformanceHealth</Category>
<OperationalStates>
<OperationalState ID="Error" MonitorTypeStateID="ContentMatchCriteriaError" HealthState="Error" />
<OperationalState ID="Warning" MonitorTypeStateID="ContentMatchCriteriaWarning" HealthState="Warning" />
<OperationalState ID="OK" MonitorTypeStateID="ContentMatchCriteriaOK" HealthState="Success" />
</OperationalStates>
<Configuration>
<RequestID>1</RequestID>
</Configuration>
</UnitMonitor>
Information
|
Module Type |
|
|
Input Type |
|
|
Output Type |
|
|
Implementation |
Composite |
|
Library |
Microsoft.SystemCenter.WebApplication.Library |