ProvisionTestsRequest

A ProvisionTestsRequest element is sent in a ProvisionTests operation invocation.

Derived by

Restricting anyType

Content model

Contains elements as defined in the following table.

Component Type Occurs Nillable? Description
SEQUENCE   1..1    
Credentials anyType (restriction) 1..1 No A Credentials element contains the username and password of an account user. The element is required in all requests to the Test Management Web Service.
UserName [element Credentials] string 1..1 No The UserName of an employee for an account (and used for authentication).
Password [element Credentials] string 1..1 No A secret used as part of user credentials for authentication. Every request to the Test Management API web service must include a Credentials element. That element itself contains a UserName and a Password element.
SingleStepMonitors anyType (restriction) 0..1 No A SingleStepMonitors element appears in a ProvisionTestsRequest and is used to create one or more Backbone tests that browse a single URL.
MultiStepMonitors anyType (restriction) 0..1 No Appears in a ProvisionTestsRequest. A MultiStepMonitors is a collection of one or more MultiStepMonitor elements. See MultiStepMonitor.

Example

The following request provisions a test that browses the Google website. The test is provisioned in the Active state and runs on the single Backbone node (884). The Firefox agent server executes the test every five minutes. This test does not require creating a GSL script in the Recorder and uploading it to the Dynatrace Portal.

<prov:ProvisionTestsRequest
   xmlns:prov="http://www.gomeznetworks.com/schemas/provisioning">
   <prov:Credentials>
      <prov:UserName>erics</prov:UserName>
      <prov:Password>erics</prov:Password>
   </prov:Credentials>
   <prov:SingleStepMonitors
      <!-- SingleStepMonitor transaction. 0 to many are allowed. -->
      <prov:SingleStepMonitor agentType="FF" name="eg_2012-08-16T13:11:50.460_FF 2"
         folder="ws_provision" frequencyInMins="5" monitorStatus="Active">
         <prov:MonitorSites>
            <prov:MonitorSite siteId="884"/>
         </prov:MonitorSites>
         <prov:URL>http://www.google.com</prov:URL>
      </prov:SingleStepMonitor>
   </prov:SingleStepMonitors>
</prov:ProvisionTestsRequest>

The next example creates a browser test based on a GSL script previously created in the Recorder:

<prov:ProvisionTestsRequest
   xmlns:prov="http://www.gomeznetworks.com/schemas/provisioning">
   <prov:Credentials>
      <prov:UserName>erics</prov:UserName>
      <prov:Password>erics</prov:Password>
   </prov:Credentials>
   <prov:MultiStepMonitors>
       <!-- MultiStepMonitor transaction. 0 to many are allowed. -->
      <prov:MultiStepMonitor name="EG 10-05-2012 001  Hotmail Auth with Params"
         folder="Hotmail Authentication" agentType="IE"
         frequencyInMins="60" monitorStatus="Inactive" scriptId="326334"
         ipVersion="IPv6_preferred">
         <prov:MonitorSites>
            <prov:MonitorSite siteId="880"/>
         </prov:MonitorSites>
      </prov:MultiStepMonitor>
   </prov:MultiStepMonitors>
</prov:ProvisionTestsRequest>

The script in the previous example is identified by the scriptId 326334. This test is provisioned in the Inactive state and will not run at its hourly frequency until its state is updated to Active. Note that the SingleStepMonitor element within the first ProvisionTestsRequest does not have a scriptId attribute but it does contain a child element (URL). In contrast, the MultiStepMonitor does contain the scriptId element identifying a GSL script but it does not contain a URL element. Any URLs browsed in the second example would be defined in the GSL script.

The previous two examples each contain a single monitor order transaction. However, a ProvisionTestsRequest may also define a larger set of transactions. In the next example, two monitor orders are defined, each requesting the creation of a SingleStepMonitor:

<prov:ProvisionTestsRequest>
   <prov:Credentials>
      <prov:UserName>erics</prov:UserName>
      <prov:Password>erics</prov:Password>
   </prov:Credentials>
  <prov:SingleStepMonitors>
     <!-- The first transaction. -->
     <prov:SingleStepMonitor name="Test 11-27-2012 erics 004" agentType="IE"
         summaryFlag="Off" includeRenderTimeFlag="Off" frequencyInMins="60"
         ipVersion="IPv4_only" monitorStatus="Active">
         <prov:MonitorSites>
            <prov:MonitorSite siteId="777" siteName="TPNTS7 - MA: Boston"
               city="Lexington" state="MA" countryCode="US" ipV6Enabled="false"/>
            <prov:MonitorSite siteId="865" siteName="TPNPEKSA12 - Beijing China test"
               city="Beijing" state="" countryCode="CN" ipV6Enabled="false"/>
           </prov:MonitorSites>
         <prov:URL>http://www.dynatrace.com</prov:URL>
      </prov:SingleStepMonitor>
      <!-- The second transaction -->
      <prov:SingleStepMonitor name="Test 11-27-2012 erics 005" agentType="IE"
         summaryFlag="Off" includeRenderTimeFlag="Off" frequencyInMins="60"
         ipVersion="IPv6_only" monitorStatus="Active">
         <prov:MonitorSites>
            <prov:MonitorSite siteId="777" siteName="TPNTS7 - MA: Boston"
              city="Lexington" state="MA" countryCode="US" ipV6Enabled="false"/>
            <prov:MonitorSite siteId="865" siteName="TPNPEKSA12 - Beijing China test"
              city="Beijing" state="" countryCode="CN" ipV6Enabled="false"/>
           </prov:MonitorSites>
         <prov:URL>http://www.dynatrace.com</prov:URL>
      </prov:SingleStepMonitor>
   </prov:SingleStepMonitors>
</prov:ProvisionTestsRequest>

Each SingleStepMonitor or MultiStepMonitor in the ProvisionTestsRequest runs in its own transaction. The transactions are executed in sequence and individually committed. If at any point a transaction attempt violates a business rule, that transaction will be aborted and no further transactions attempted. The ProvisionTestsResponse accounts for the success or failure of each transaction in the payload.

A ProvisionTestsRequest may also contain a mixture of SingleStepMonitors and MultiStepMonitors.