Provision a multistep browser test (ProvisionTests)

For this use case, you want to define a browser test that contains one to many steps defined in a GSL Script. The script was created using the Recorder. To do this, use a query that returns all the available Scripts stored in the Dynatrace Portal. Each script has a unique script id that must be included in the monitor order in order for the multistep browser test to be created.

As required when creating a single step browser test, first decide the IP version the test will use (IPv4_only, IPv6_only, or IPv6_preferred). You also need to know which Backbone nodes (also called sites) are available to your account and that support the chosen IP version preference. Next, decide whether the test is to run on all the available sites or only a subset of those sites. The web service provides a method to get the list of available sites for the account and indicates, for each site, whether IP version 6 is supported.

Additionally, you can set the following parameters on the browser test:

  • [test] name

  • agentType

  • summaryFlag

  • includeRenderTimeFlag

  • expirationDate

  • folder

  • frequencyInMins

  • monitorStatus

  • folderStatus

The provisioning request may contain zero to many single step browser test definitions and zero to many multistep browser test definitions.

The provisioning response shows whether processing was completely successful and provided that information both at the level of the entire request and at the level of each browser test definition submitted to the system.

Sample request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
                  xmlns:prov="http://www.gomeznetworks.com/schemas/provisioning">
   <soapenv:Header/>
   <soapenv:Body>
      <prov:ProvisionTestsRequest>
         <prov:Credentials>
            <prov:UserName>MyUser</prov:UserName>
            <prov:Password>MyPassword</prov:Password>
         </prov:Credentials>
         <prov:MultiStepMonitors>
            <prov:MultiStepMonitor name="EG 08-14-2012 002"
                                   folder=""
                                   agentType="IE"
                                   frequencyInMins="60"
                                   monitorStatus="Inactive"
                                   scriptId="260847"
                                   ipVersion="IPv6_preferred">
               <prov:MonitorSites>
                  <prov:MonitorSite siteId="880"/>
               </prov:MonitorSites>
            </prov:MultiStepMonitor>
         </prov:MultiStepMonitors>
      </prov:ProvisionTestsRequest>
   </soapenv:Body>
</soapenv:Envelope>

Sample response

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Body>
      <ProvisionTestsResponse xmlns="http://www.gomeznetworks.com/schemas/provisioning">
         <ResponseStatus>SUCCESS</ResponseStatus>
         <MonitorOrderResponses>
            <MonitorOrderResponse name="MyUser 08-14-2012 002"
                                  folder=""
                                  monitorId="260847"
                                  monitorStatus="Inactive"
                                  orderStatus="SUCCESS">
               <Message>Successfully provisioned monitor: AccountName =
                        My Account Name, MonitorName = EG 08-14-2012 002,
                        MonitorId =260847</Message>
            </MonitorOrderResponse>
         </MonitorOrderResponses>
      </ProvisionTestsResponse>
   </soap:Body>
</soap:Envelope>