MonitorFilter

A MonitorFilter is used in a GetTests or GetTestsEx operation invocation to restrict the output of the query.

Derived by

Extending FilterBase

Content model

Contains elements as defined in the following table.

Component Type Occurs Nillable? Description
SEQUENCE 1..1
AgentType [type FilterBase] AgentType 0..1 Yes If present, this element restricts the output of GetTests() or GetScripts() by agent type.
QueryByCreateDate [type FilterBase] DateFilterType 0..* Yes QueryByCreateDate is supported in both ScriptFilters and MonitorFilters. If present, this element restricts the output by create date. Multiple instances of this element are permitted so that both upper and lower bounds can be set.
QueryByModifyDate [type FilterBase] DateFilterType 0..* Yes QueryByModifyDate is supported in both ScriptFilters and MonitorFilters. If present, this element restricts the output by modify date. Multiple instances of this element are permitted so that both upper and lower bounds can be set.
MonitorId [element MonitorFilter] string 0..1 Yes If present, this element restricts the filter output to a specific browser test.
QueryByExpirationDate [element MonitorFilter] DateFilterType 0..* Yes If present, this element restricts GetTests() output by test expiration date. Multiple instances of this element are permitted so that both upper and lower bounds can be set.
MonitorStatus [element MonitorFilter] MonitorStatusType 0..1 No If present, this element restricts GetTests() output by MonitorStatus (Active or Inactive).
Group [element MonitorFilter] string 0..* Yes If present, this element restricts GetTests() output by membership in a particular monitor group (also called Folder). If multiple instances of Group are supplied, the tests in the output have to match ANY of them.

Referenced by

Example

Here is how the MonitorFilter appears in the GetTestsRequest:

<prov:GetTestsRequest>
   <prov:Credentials>
      <prov:UserName>My_Username</prov:UserName>
      <prov:Password>My_Password</prov:Password>
   </prov:Credentials>
   <prov:MonitorFilter>
      <prov:AgentType>FF</prov:AgentType>
   </prov:MonitorFilter>
</prov:GetTestsRequest>

The previous example restricts the output to Firefox tests.

The following example restricts the output by test creation date:

<prov:MonitorFilter>
   <prov:QueryByCreateDate dateQueryType="GreaterThan"
                           queryDate="2012-11-07T01:00:00"/>
   <prov:QueryByCreateDate dateQueryType="LessThanOrEqualTo"
                           queryDate="2012-11-07T23:59:00"/>
</prov:MonitorFilter>

The following example restricts the output by test modification date:

<prov:MonitorFilter>
   <prov:QueryByModifyDate dateQueryType="GreaterThan"
                           queryDate="2012-08-05T10:17:12"/>
   <prov:QueryByModifyDate dateQueryType="LessThanOrEqualTo"
                           queryDate="2012-08-10T10:17:12"/>
</prov:MonitorFilter>

The next example restricts the output by expiration date:

<prov:MonitorFilter>
   <prov:QueryByExpirationDate dateQueryType="GreaterThan"
                               queryDate="2012-08-05T10:17:12"/>
   <prov:QueryByExpirationDate dateQueryType="LessThanOrEqualTo"
                               queryDate="2012-08-10T10:17:12"/>
</prov:MonitorFilter>

The next example restricts the output by test status:

<prov:MonitorFilter>
   <prov:MonitorStatus>Active</prov:MonitorStatus>
</prov:MonitorFilter>

The next example restricts the output by containing folder (monitor group):

<prov:MonitorFilter>
   <prov:Group>TestManagement, MultiStepTests</prov:Group>
</prov:MonitorFilter>

The next example restricts the output to a specific monitor:

<prov:MonitorFilter>
   <prov:MonitorId>326334</prov:MonitorId>
</prov:MonitorFilter>