Monitor

The monitor element appears in the output of a GetTests operation invocation.

Derived by

Extending MonitorTypeForResponse

Attributes

Name Type Required? Default Description
scriptId string Yes This field identifies the GSL script id used to create the test.
monitorStatus MonitorStatusType Yes The status of the browser test. Valid values are Active and Inactive.
folderStatus MonitorStatusType No The status of the monitor group to which the browser test belongs. Valid values are Active and Inactive.
monitorId string Yes The id uniquely identifying the browser test.
createDate dateTime Yes The date-time when the browser test was created.
modifyDate dateTime Yes The date-time when the browser test was last modified.
name string Yes The name of a browser test. This field is mapped to the description column in the monitor table.
folder string No The name of the folder containing the browser tests. This field is mapped to the description column of a monitor group in the monitor table.
agentType AgentType Yes The agent type.
summaryFlag FlagType No Off This field is false if test data is captured at the component level and true if it is captured at the summary level.
includeRenderTimeFlag FlagType No Off This field is true if render time is to be captured in the test output and false if not. The default value is false.
frequencyInMins int Yes This field captures the frequency in minutes with which a test is run on a Backbone node. The field is optional. The default frequency in minutes is 60 (one hour).
expirationDate dateTime No This field contains the xsd:dateTime at which a test is expired. This field is optional, because not all tests expire.
ipVersion IpVersionType No IPv6_preferred This field contains the ip mode of the test. The field is optional. The default value is IPv6_preferred. Valid values are IPv4_only, IPv6_only, and IPv6_preferred. Tests flagged as IPv6_only or IPv6_prefered may only be deployed to Backbone sites supporting IPv6.

Content model

Contains elements as defined in the following table.

Component Type Occurs Nillable? Description
SEQUENCE 1..1
MonitorSites anyType (restriction) 1..1 No The MonitorSites element is a container of MonitorSite elements. See MonitorSite for more information.
Steps anyType (restriction) 1..1 No A Steps element is a collection of one to many Steps. Everywhere a Step may appear, it is enclosed in such a collection.

Referenced by

Example

<GetTestsResponse
   xmlns="http://www.gomeznetworks.com/schemas/provisioning">
   <ResponseStatus>SUCCESS</ResponseStatus>
   <Monitors>
      <!-- 0 to many Monitor elements may be returned -->
      <Monitor name="MultiStepTest 7/19/2012 10:15:24 AM" agentType="IE"
               summaryFlag="Off" includeRenderTimeFlag="On" frequencyInMins="5"
               ipVersion="IPv4_only" monitorStatus="Active" monitorId="263733"
               createDate="2012-07-19T14:15:14.573"
               modifyDate="2012-08-08T18:56:16.947"
               scriptId="263733">
         <MonitorSites>
        <MonitorSite siteId="880"/>
         </MonitorSites>
         <Steps>
        <Step stepSeqNum="0">
           <URL>http://www.dynatrace.com/</URL>
           <DisplayName>Dynatrace LLC</DisplayName>
        </Step>
        <Step stepSeqNum="1">
           <URL>http://www.dynatrace.com/careers/</URL>
           <DisplayName>Dynatrace LLC</DisplayName>
        </Step>
        <Step stepSeqNum="2">
           <URL>http://www.dynatrace.com/careers/why-dynatrace.html</URL>
           <DisplayName>Step 3</DisplayName>
        </Step>
        <Step stepSeqNum="3">
           <URL>http://www.dynatrace.com/about/mission-statement.html</URL>
           <DisplayName>Mission Statement | Dynatrace</DisplayName>
        </Step>
         </Steps>
      </Monitor>
   </Monitors>
</GetTestsResponse>