Documentation › MXML Tag Reference (Complete)

MXML Tag Reference

Reference  The complete, schema-generated catalog of every MXML tag.

MXML (MaxTAF XML) is MaxTAF's XML test-automation language. A test file is a <testCase> containing tests, methods and activities (tags). Tags come from several XML namespaces; the core control-flow tags are unprefixed, the rest use a namespace prefix (ui:, db:, net:, sys:, time:, perf:).

Generated from the authoritative schema files maxtaf.xsd and ui.xsd (and the schemas they import: db.xsd, net.xsd, system.xsd, time.xsd, perf.xsd, tag.xsd) in maxtaf-storage/src/main/resources/mxml/xml-xsd/. Descriptions and most examples are taken directly from the schema documentation; examples marked (synthesised) are skeletons built from the tag's attributes.

Namespaces

Anatomy of a test case

Every MXML file is a <testCase> with optional lifecycle blocks and one or more <test> blocks. A typical UI test looks like this:

<testCase name="MyTest" xmlns="http://www.maxtaf.com" xmlns:ui="http://www.maxtaf.com/ui">
  <beforeTestCase>
    <initializeApi />
    <ui:createDriver><ui:timeout>20</ui:timeout></ui:createDriver>
    <ui:javaScriptExecutor />
    <addReporter type="xml" name="My Test" />
  </beforeTestCase>

  <test name="testMyTest">
    <addTestReport name="testMyTest" />
    <ui:maximizeWindow />
    <!-- activities (tags) go here -->
    <ui:click><ui:id>saveButton</ui:id></ui:click>
    <ui:assertValue value="APPR"><ui:id>status</ui:id></ui:assertValue>
    <testReportStatus>PASSED</testReportStatus>
  </test>

  <afterTestCase>
    <ui:close />
    <closeReporter />
  </afterTestCase>
</testCase>

Core / Control-Flow Tags

Structure, flow control, variables, assertions and reporting. Used without a namespace prefix (they belong to the default MXML namespace).

<testCase>

Root element of MXML. Test case is the collection of all related tests into one logical group.

Child elements: <imports>, <globals>, <var>, <set>, <include>, <afterTestCase>, <afterTest>, <test>, <method>, <beforeTestCase>, <beforeTest>

Example:

<testCase name="WOAPPRTest" xmlns="http://www.maxtaf.com" xmlns:mif="http://www.maxtaf.com/mif">

<return>

Defines the return value of a method. The type of the returned value must match the type of method's 'type' attribute</var>

Example (synthesised):

<return expression="..." />

<var>

Defines a new test variable. The value of the variable is set to the element's value. The type of the variable is one of the valid Java types.

Text content: tns:nonEmptyString

Example:

<var type="String" name="orgId">"EAGLENA"</var>

<set>

Assigns a value to a variable. The content of this element is an expression. The resulting value of this expression is assigned to the variable named in the "variable" attribute. Note: the resulting type of the expression must be compatible with the type of the variable, otherwise you will get a type mismatch.

Text content: tns:nonEmptyString

Example:

<test name="setFixedString">
  <var name="myString" type="String">""</var>
  <set variable="myString">"ABC"</set>
  <assertTrue condition='myString.equals("ABC")'/>
</test>

<test name="setExpressionString">
  <var name="myString" type="String">""</var>
  <var name="yourString" type="String">"ABC"</var>
  <set variable="myString">yourString +  "XYZ"</set>
  <assertTrue condition='myString.equals("ABCXYZ")'/>
</test>

<test name="setExpressionInt">
  <var name="myInt" type="int">0</var>
  <var name="yourInt" type="int">10</var>
  <var name="herInt" type="int">4</var>
  <set variable="myInt">yourInt +  20 / herInt</set>
  <assertTrue condition='myInt==15'/>
</test>

<include>

Use this tag when you want to insert a segment of MXML script into your test case. Typically, when the same MXML set of tags is repeated between many different test cases, you can save that segment in a file and then put the "include" tag in your scripts instead of repeating the same code over and over. This approach lets you maintain this common code in one file only.

Example:

<test name='testWOreportActuals'>
  <addTestReport name="testDuke"/>
  <ui:maximizeWindow />

  <!-- include the xml that has all the clicks and types to create and approve a standard corrective work order -->
  <include path="C:\\ibm\\SMP\\maximo\\maxtaf\\script\\create_approve_wo.xml" />
  <!-- work order is now cretaed and approved and we are on the Main tab. Now switch to the 'Actuals' tab and report actuals -->

  <!-- [ click ] tab - Actuals -->
  <ui:click>
    <ui:xpath>//a[@staticId='actuals-tab_tab_anchor']</ui:xpath>
  </ui:click>

  <ui:click>
    <ui:xpath>//div[@staticId='clientarea-clientarea_clientarea']</ui:xpath>
  </ui:click>

  <!-- [ click ] pushbutton -->
  <ui:click>
    <ui:xpath>//button[@staticId='actuals_actuals_aclabor_aclabor_table_2_3-pushbutton_pushbutton']</ui:xpath>
  </ui:click>

</testCase>

The content of the include

<segment xmlns:ui="http://www.maxtaf.com/ui">
  <ui:click>
    <ui:xpath>//img[@staticId='toolactions_button_0-toolbarbutton_image_image']</ui:xpath>
  </ui:click>
  <ui:click>
    <ui:xpath>//img[@staticId='toolactions_button_1-toolbarbutton_image_image']</ui:xpath>
  </ui:click>
  <ui:click>
    <ui:xpath>//img[@staticId='toolactions_button_14-toolbarbutton_image_image']</ui:xpath>
  </ui:click>
  <ui:click>
    <ui:xpath>//button[@staticId='changestatus_2_1-pushbutton_pushbutton']</ui:xpath>
  </ui:click>
  <ui:click>
    <ui:xpath>//span[@staticId='gotolink-gotolink_link1']/span/span[3]</ui:xpath>
  </ui:click>
  <ui:click>
    <ui:xpath>//span[@staticId='gotolink-gotolink_link1']/span/span[3]</ui:xpath>
  </ui:click>
</segment>

Note that the included xml file WILL NOT pass through the XSD validation. The invalid xml content will be ignored by the compiler. It is up to the developer of that xml file to make sure that the content is valid.

<printOut>

Prints out element's content to the System or SystemErr log. Used in printOut and printErr tags. <printOut> tag will output to System log, <printErr> will output to SystemErr log.

Text content: xsd:string

Example:

<printOut>"Company master name is "+compMasterName</printOut>
<printErr>"There is no work order with num: "+wonum</printErr>

<endTest>

Unconditionally ends the test.

Example:

<addTestReport name="endTestReport" />
<var name="a" type="int">1</var>
<if condition="a==1">
  <endTest />
</if>
<addReportLine action="ifPassed" expected="this line will never execute as the test has been previously ended" actual="" status="PASSED" />

<printErr>

Prints out element's content to the System or SystemErr log. Used in printOut and printErr tags. <printOut> tag will output to System log, <printErr> will output to SystemErr log.

Text content: xsd:string

Example:

<printOut>"Company master name is "+compMasterName</printOut>
<printErr>"There is no work order with num: "+wonum</printErr>

<isAdminModeOn>

Checks if Maximo Admin mode is ON.

Text content: xsd:string

Example (synthesised):

<isAdminModeOn>value</isAdminModeOn>

<isAdminModeOff>

Checks if Maximo Admin mode is OFF.

Text content: xsd:string

Example (synthesised):

<isAdminModeOff>value</isAdminModeOff>

<addTestReport>

Adds a new test report to the reporter. Located within the "test " tag and before any "addReportLine" tags. Since a MaxTAF test case can contain more than one MXML test tags, we can add several reports.

Example:

<addTestReport name="createCompanyMaster" />

<apiInput>

Used for exchanging values between test cases in a suite. Takes on the value of the "apiOutput" tag from the preceding test case in a test suite and assigns it to the variable specified in the "var" attribute.

Example:

1) The first test case fills the apiOutput variable with the newly created Work Order number:
          ...
          <apiOutput var="newWoNum"/>
          ...

          2) The subsequent test receives the wonum through "apiInput" mechanism and puts it in the woNum variable for later use:
          ...
          <var type="String" name="woNum">null</var>
          <apiInput var="woNum"/>
          ....

<apiOutput>

Used for exchanging values between test cases in a suite. Takes the value of the variable specified in the "var" attribute and passes it on to the next test case in the test suite.

Example:

1) The first test case fills the apiOutput variable with the newly created Work Order number:
          ...
          <apiOutput var="newWoNum"/>
          ...

          2) The subsequent test receives the wonum through "apiInput" mechanism and puts it in the woNum variable for later use:
          ...
          <var type="String" name="woNum">null</var>
          <apiInput var="woNum"/>
          ....

<addReportLine>

Adds a report line to the test report.

Example:

<addReportLine action="$titleText" expected="Company Master application is opened" actual="Company Master application is opened" status="PASSED" />

<addReporter>

Sets-up the test Reporter. The test Reporter is a mechanism in Maxtaf that produces the output run report. It must be located within the "beforeTestCase" tag.

Example:

<addReporter type="xml" name="Create Company Master" description="Testing Company Master application functionality"     class="rs.cdl.maxtaf.test.CompanyMasterTestUI" author="John" />

<initializeApi>

Initializes system service. The system service enables the test code to exchange data with the framework.

Example:

<initializeApi/>

<afterTestCase>

Contains any processing that is required to be executed after the test case is completed.

Child elements: <closeReporter>, <close>

Example (synthesised):

<afterTestCase>
    <closeReporter>...</closeReporter>
    <close>...</close>
</afterTestCase>

<closeReporter>

(no description in schema)

Text content: xsd:string

Example (synthesised):

<closeReporter>value</closeReporter>

<afterTest>

Contains any processing that is required to be executed after a <test> tag is completed.

There can only be one afterTest tag in a MaxTAF test case, and the processing within the tag will be executed/repeated after the completion of any of the test tags in the test case.

Child elements: <closeReporter>, <close>

Example:

<afterTest>
  <mif:removeListener/>
</afterTest>

<beforeTestCase>

Executes the content of this element before the test case. Content of this element can be used to prepare the test case environment (e.g. add a reporter).

Example:

<beforeTestCase>
  <ui:createDriver>
    <ui:timeout>60</ui:timeout>
  </ui:createDriver>

  <ui:javaScriptExecutor />
  <addReporter type="xml" name="Create Company Master" description="Testing Company Master application functionality" class="rs.cdl.maxtaf.test.CompanyMasterTestUI" author="Pera" />
</beforeTestCase>

<beforeTest>

Executes the content of this element before each test. This element can be used to prepare the environment for the execution of the test. Note: the processing will be repeated before every test in the test case.

Example (synthesised):

<beforeTest />

<getTestParam>

Gets a specific run parameter value of the Test and places it into the specified variable. Parameters are defined in the Maximo front-end Test application.

Example:

Parameters defined in the Test application:
          woNum='1000'
          siteId = 'BEDFORD'

          Code:
          <var name="wonum" type="String">""</var>
          <var name="siteid" type="String">""</var>
          <getTestParam name="woNum" variable="wonum" />
          <getTestParam name="siteId" variable="siteid" />
          <addReportLine action="wonum: $wonum" expected="" actual="" status="PASSED" />
          <addReportLine action="siteid: $siteid" expected="" actual="" status="PASSED" />

<setTestParam>

Sets a specific run parameter value of the Test. Parameters are defined in the Maximo front-end Test application.

Example:

Parameters defined in the Test application:
          woNum='1000'
          siteId = 'BEDFORD'

          Code:
          <setTestProperty name="woNum" value="1000" />
          <setTestProperty name="siteId" value="EAGLENA" />
          <addReportLine action="wonum: $wonum" expected="" actual="" status="PASSED" />
          <addReportLine action="siteid: $siteid" expected="" actual="" status="PASSED" />

<test>

Contains the actual test processing. This is the main test element in which you perform all of the test processing.

Example:

<test name="ifTest">
</test>

<method>

Method element.

Child elements: <var>, <set>, <include>, <return>

Example (synthesised):

<method name="..." id="..." annotation="...">
    <var>...</var>
    <set>...</set>
</method>

<testReportStatus>

Sets report status. Report status will be set to the element value.

Text content: xsd:string

Example:

<testReportStatus>PASSED</testReportStatus>

<if>

Executes content if the condition is true.

Example:

<var name="myInt" type="int">1</var>
<if condition="myInt==1">
  <addReportLine action="ifTest" expected="if Triggered" actual="if Triggered" status="PASSED" />
</if>

<else>

Used only with existing <if> tag. Executes code in case the <if> tag condition is not met. Note: This element must be positioned immediately after the </if> tag.

Example:

<var name="b" type="int">2</var>
<if condition="b==1">
  <addReportLine action="ifTest" expected="if Triggered" actual="if Triggered" status="PASSED" />
</if>
<else>
  <addReportLine action="elseTest" expected="else Triggered" actual="else Triggered" status="PASSED" />
</else>

<for>

Repeats the processing of its content until the condition is false. This loop element is based on Java "for" loop and must have the iterator, condition and iteration attributes defined.

Example:

<for iterator="int i=0" condition="i<10" iteration="i++">
  <printOut>i</printOut>
  <addReportLine action="Increasing iterator value, value is $String.valueOf(i)" expected="iterator value:" actual="value is $String.valueOf(i) " status="PASSED" />
</for>

<forEach>

Loops through elements of the given array or collection.

Example:

<var name="cars" type="String[]">{"Volvo", "BMW", "Ford", "Mazda"}</var>
                &lt;forEach var="String car" array="cars">
                    <sys:addLogLine text="Car brand: $car"/>
                &lt;/forEach>

<while>

Repeats the processing of its content until the condition becomes false.

Example:

<while condition="counter<5">
  <printOut>counter</printOut>
  <addReportLine action="Increasing counter value" expected="counter value:" actual="$String.valueOf(counter) " status="PASSED" />
  <set variable="counter">counter+1</set>
</while>

<reportGroup>

Overrides MaxTAF generated test reports with custom action, expected, actual and status messages. Actual message will be overridden by passActual attribute in case the test passes, or will be set by the failActual attribute in case the test fails. Status message will be overridden by passStatus attribute in case the test passes, otherwise will be set by the failStatus attribute in case the test fails.

Example:

<reportGroup action="Check publish channel" expected="disabled" passActual="disabled. " failActual="enabled" passStatus="GOOD" failStatus="BAD">

  <mif:publishChannelExistOnExternalSystem name="MXWOInterface" externalSystemName="EXTSYS1"/>
  <mif:publishChannelEnabled name="MXWOInterface" externalSystemName="EXTSYS1"/>
  <mif:publishChannelEventListenerEnabled name="MXWOInterface"/>

</reportGroup>

<dowhile>

Executes code conditionally until the condition is no longer met.

Example:

<var name="a" type="int">1</var>
<dowhile condition="a < 10">
  <set variable="a">a+1</set>
</dowhile>

<getMaxtafProperty>

Gets the value of MaxTAF property and puts it in variable.

Example:

<var type="String" name="prop">""</var>
<getMaxtafProperty name="propName" var="prop" />

<incrementProperty>

Increments the value of MaxTAF property in thread-safe manner.

Example (synthesised):

<incrementProperty name="..." var="..." />

<inverse>

Inverses the outcome of the contained element. Used to inverse the logic of a specified element. I.e. where the specified element fails, the inverse passes; where the specified element passes the inverse fails.

Example:

<!-- pass if www.maxtaf.com is unreachable (testing the firewall) -->
<inverse>
  <net:ping host="http://www.maxtaf.com"/>
</inverse>

<block>

Localizes variables defined within this element. The variables defined within this element will be visible to other elements in the block, but will not be visible to the rest of the test elements.

Example:

<block>
  <var name="a" type="int">0</var>
  <addReportLine action="value of a is $a" expected="" actual="" status="PASSED" />
</block>

<block>
  <var name="a" type="int">1</var>
  <addReportLine action="value of a is $a" expected="" actual="" status="PASSED" />
</block>

<native>

Inserts Java code contained in the content of the element into the processing logic.

Text content: xsd:string

Example (synthesised):

<native>System.out.println("Hello from Java");</native>

<execute>

Executes specified object's method using the given parameters. The executed method must not return a value. As all MXML objects are Java objects, this element can invoke any of the Java methods available for the object's class. To understand object's methods, consult the Java documentation for the object's class. Note: For methods that return a value, use "executeWithReturn" element.

Child element(s): <params> - this is an optional element which is used when we want to execute a method that contains parameters. Method parameters should be written in element content, separated by commas in the same way as they would be written in Java, as in the example below:

Child elements: <params>

Example:

<!-- equivalent to Java "String myString = "Test String"; myString.indexOf("ring", 1);
<var name="myString" type="String">"Test String"</var>
<execute object="myString" method="indexOf">
  <params>"ring", 1</params>
</execute>

<call>

Executes class method using the given parameters. The executed method must not return a value. As all MXML objects are Java objects, this element can invoke any of the Java methods available for the object's class. To understand object's methods, consult the Java documentation for the object's class. Note: For methods that return a value, use "callWithReturn" element.

Child element(s): <params> - this is an optional element which is used when we want to execute a method that contains parameters. Method parameters should be written in element content, separated by commas in the same way as they would be written in Java, as in the example below:

Child elements: <params>

Example:

<!-- equivalent to Java "printHelloWorldFrom("Peter");
<call method="printHelloWorldFrom">
  <params>"Peter"</params>
</call>

<fileToString>

Reads file content and stores it into the String variable.

Example:

<fileToString filePath="C:/temp/tmp.csv" var="myVar" />

<stringToFile>

Writes into file the content of the String variable.

Example:

<stringToFile content="$myText" filePath="C:/temp/tmp.csv" />

<stringReplace>

Replaces substring in the String variable with another substring.

Example:

<stringReplace var="myString" replace="tbl" with="table" />

<executeWithReturn>

Executes specified object's method using the given parameters and stores the return value in the specified variable. The executed method must return a value. As all MXML objects are Java objects, this element can invoke any of the Java methods available for the object's class. To understand object's methods, consult the Java documentation for the object's class. Note: For methods which do not return a value, use "execute" element.

Child elements: <params> - this is optional element which is used if we want to execute method that contains parameters. Method parameters should be written in element's content like in the example below:

Child elements: <params>

Example:

<var name="myString" type="String">"Test String"</var>
<var name="ringPos" type="int">0</var>
<executeWithReturn object="myString" method="indexOf" var="ringPos">
  <params>"ring", 1</params>
</executeWithReturn>
<addReportLine action="Result: $ringPos" expected="" actual="" status="PASSED" />

<callWithReturn>

Executes specified class method using the given parameters and stores the return value in the specified variable. The executed method must return a value. Note: For methods which do not return a value, use "call" element.

Child elements: <params> - this is optional element which is used if we want to execute method that contains parameters. Method parameters should be written in element's content like in the example below:

Child elements: <params>

Example:

<var name="result" type="int">0</var>
<callWithReturn method="multiplyTwoIntegers" var="result">
  <params>5,6</params>
</callWithReturn>
<addReportLine action="Result: $result" expected="" actual="" status="PASSED" />

<assertFail>

Unconditionally fails the test. If the optional subelement "assertMessage" is present, the value of this element will be displayed as the failure explanation.

Child elements: <assertMessage>

Example:

...
          <if condition="mboRemoteWO=null">
          <assertFail>
          <assertMessage> Work Order not found</assertMessage>
          </assertFail>
          </if>

<assertTrue>

Asserts whether the condition is true. Displays assertMessage on failure.

Child elements: <assertMessage>

Example:

<var name="a" type="String">"Test String 1"</var>
<var name="b" type="String">"Test String 1"</var>
<assertTrue condition="a.equals(b)">
  <assertMessage>Condition is not true. Test failed.</assertMessage>
</assertTrue>

<assertNull>

Checks that the object is null. Object can be of any Java type.

Child elements: <assertMessage>

Example:

<var name="myString" type="String">"Test"</var>
<assertNull object="myString">
  <assertMessage>Object is not null. Test failed.</assertMessage>
</assertNull>

<imports>

Imports additional Java classes and packages. The Java classes and packages are specified in children <import> elements.

Child elements: <import>

Example:

<imports>
  <import>
    java.lang.Exception
  </import>
  <import>
    com.codedevelopment.maxtaf.util.*
  </import>
</imports>

<globals>

Used do define global variables. Global variables are visible in all tests in test case.

Child elements: <var>

Example:

<testCase>
  <globals>
    <var type="String" name="var1">"Variable 1"</var>
    <var type="int" name="var2">1001</var>
  </globals>
  ...

<assertSame>

Checks that both variables refer to the same object. Variables can be of any Java type.

Child elements: <assertMessage>

Example:

<var name="myInt1" type="Integer">new Integer(1)</var>
<var name="myInt2" type="Integer">myInt1</var>
<var name="myInt3" type="Integer">myInt1</var>
<assertSame expected="myInt2" actual="myInt3">
  <assertMessage>Expected object is not the same as actual object. Test failed.</assertMessage>
</assertSame>

<assertNotSame>

Checks that both variables refer to different objects. Must contain both unexpected and actual attributes, then compares the two. If they are referencing different objects, returns true else returns false.

Child elements: <assertMessage>

Example:

<var name="myString1" type="String">new String("abc")</var>
<var name="myString2" type="String">new String("abc")</var>
<assertNotSame unexpected="myString1" actual="myString2">
  <assertMessage>Unexpected is same as actual. Test failed.</assertMessage>
</assertNotSame>

<assertNotNull>

Checks that the object is not null. Object can be of any Java type.

Child elements: <assertMessage>

Example:

<var name="myString" type="String">"Test"</var>
<assertNotNull object="myString">
  <assertMessage>Object is null. Test failed.</assertMessage>
</assertNotNull>

<assertFalse>

Asserts whether the condition is false. If the condition is true, the test fails.

Child elements: <assertMessage>

Example:

<assertFalse condition="1==2"/>

<assertEquals>

Checks that both variables refer to same objects.

Child elements: <assertMessage>, <delta>

Example:

<assertEquals expected="VALID" actual="myVar">
  <assertMessage></assertMessage>
</assertEquals>

UI / Selenium Tags (ui:)

Browser and web-UI automation: driver lifecycle, clicks, input, waits, asserts, frames/windows.

UI Selectors (child elements)

Most ui: action tags take exactly one selector child element that identifies the target web element. Each maps to a Selenium By locator. The same six selectors are valid inside ui:click, ui:sendKeys, ui:assertValue, ui:getText, and the other element-targeting tags.

<ui:createDriver>

Creates a connection to the web driver. When a UI test is created this is automatically inserted into the <beforeTestCase> tag.

Child elements: <ui:timeout>, <ui:extraCap>

Example (synthesised):

<ui:createDriver>
    <ui:timeout>...</ui:timeout>
    <ui:extraCap>...</ui:extraCap>
</ui:createDriver>

<ui:timeout>

Sets timeout for UI actions.

Example (synthesised):

<ui:timeout />

<ui:extraCap>

Sets extra capability for the driver. If you are entering a string as the value for the capability, you need to surround it with double quotes and single quotes. E.g. <ui:extraCap name="exampleCap" value='"exampleValue"'/>

Text content: xs:string

Example (synthesised):

<ui:extraCap name="..." value="...">value</ui:extraCap>

<ui:javaScriptExecutor>

Provides access to the mechanism for executing JavaScript. Created automatically by the UI test within the beforeTestCase tag.

Example:

<beforeTestCase>
  <ui:createDriver>
    <ui:timeout>120</ui:timeout>
  </ui:createDriver>
  <ui:javaScriptExecutor/>

  <addReporter type="xml"
  name="Test Title"
  description="Test Description"
  class="Test Class"
  author="Autor"
  ></addReporter>
</beforeTestCase>

<ui:getVerificationErrors>

Returns verification errors and prints report lines for them. Works with verify tags (for example: ui:verifyText). If a verify tag returns one or more errors, this element will list them all.

Example (synthesised):

<ui:getVerificationErrors />

<ui:openApp>

Opens the specified application. Name must be a valid Maximo application name.

Child elements: <ui:userName>, <ui:password>

Example:

<ui:openApp name="startcntr"/>

<ui:changeApp>

Opens the specified application. Name must be a valid Maximo application name.

Example:

<ui:changeApp name="startcntr"/>

<ui:executeScript>

Executes JavaScript on the test page. Can interact with existing JavaScript created by the test logic.

Example:

<ui:executeScript jsCode="warnExit=false" />

<ui:executeScriptOnTarget>

Executes JavaScript on a given target element. Can interact with existing JavaScript created by the test logic.

Child elements: <ui:xpath>, <ui:id>, <ui:cssSelector>, <ui:linkText>, <ui:name>, <ui:tagName>

Example:

<ui:executeScriptOnTarget jsCode="if(arguments[0].contentEditable === 'true')
                    {arguments[0].innerText = 'sample text'}">
                    <ui:id>dijitEditorBody</ui:id>
                    </ui:executeScriptOnTarget>

<ui:click>

Performs a click on an element. Used mostly to click link elements on the page.

Child elements: <ui:xpath>, <ui:id>, <ui:cssSelector>, <ui:linkText>, <ui:name>, <ui:tagName>

Example:

<addReportLine
action="Click Change Status button"
expected="Change Status dialogue is displayed"
actual="Change Status dialogue is displayed"
status="PASSED" />
<ui:click>
  <ui:xpath>//*[@staticId='toolactions_button_14-toolbarbutton_image_image']</ui:xpath>
</ui:click>

<ui:mouseOver>

Simulates hover over an element.

Child elements: <ui:xpath>, <ui:id>, <ui:cssSelector>, <ui:linkText>, <ui:name>, <ui:tagName>

Example:

<addReportLine action="Click Change Status button" expected="Change Status dialogue is displayed"
actual="Change Status dialogue is displayed" status="PASSED" />
<ui:mouseOver>
  <ui:id>some_id</ui:id>
</ui:mouseOver>

<ui:getElementPresent>

Element that checks if specified element is somewhere on the page and stores the result in variable. Must match only one child element that is returned by the selector.

Child elements: <ui:xpath>, <ui:id>, <ui:cssSelector>, <ui:linkText>, <ui:name>, <ui:tagName>

Example:

<var name="isElemPresent" type="Boolean">null</var>
<ui:getElementPresent var="isElemPresent">
  <ui:xpath>//span[@id='mx47']/span/span[3]</ui:xpath>
</ui:getElementPresent>

<ui:assertElementPresent>

Element that checks if specified element is somewhere on the page. Must match only one child element that is returned by the selector.

Selectors:

ui:xpath - finds web element by its xpath ui:id - finds web element by its id ui:cssSelector - finds web element by its CSS class ui:linkText - finds web element by its link text ui:name - finds web element by its name ui:tagName - finds web element by its tag name

Child elements: <ui:xpath>, <ui:id>, <ui:cssSelector>, <ui:linkText>, <ui:name>, <ui:tagName>

Example:

<ui:assertElementPresent>
  <ui:xpath>//span[@id='mx47']/span/span[3]</ui:xpath>
</ui:assertElementPresent>

<ui:assertElementError>

Element that checks if specified element has an error icon on the page. Must match only one child element that is returned by the selector.

Selectors:

ui:xpath - finds web element by its xpath ui:id - finds web element by its id ui:cssSelector - finds web element by its CSS class ui:linkText - finds web element by its link text ui:name - finds web element by its name ui:tagName - finds web element by its tag name

Child elements: <ui:xpath>, <ui:id>, <ui:cssSelector>, <ui:linkText>, <ui:name>, <ui:tagName>

Example:

<ui:assertElementError>
  <ui:xpath>//span[@id='mx47']/span/span[3]</ui:xpath>
</ui:assertElementError>

<ui:assertElementRequired>

Element that checks if specified element is marked as required on the page. Must match only one child element that is returned by the selector.

Selectors:

ui:xpath - finds web element by its xpath ui:id - finds web element by its id ui:cssSelector - finds web element by its CSS class ui:linkText - finds web element by its link text ui:name - finds web element by its name ui:tagName - finds web element by its tag name

Child elements: <ui:xpath>, <ui:id>, <ui:cssSelector>, <ui:linkText>, <ui:name>, <ui:tagName>

Example:

<ui:assertElementRequired>
  <ui:xpath>//span[@id='mx47']/span/span[3]</ui:xpath>
</ui:assertElementRequired>

<ui:assertElementReadonly>

Element that checks if specified element is marked as read only on the page. Must match only one child element that is returned by the selector.

Selectors:

ui:xpath - finds web element by its xpath ui:id - finds web element by its id ui:cssSelector - finds web element by its CSS class ui:linkText - finds web element by its link text ui:name - finds web element by its name ui:tagName - finds web element by its tag name

Child elements: <ui:xpath>, <ui:id>, <ui:cssSelector>, <ui:linkText>, <ui:name>, <ui:tagName>

Example:

<ui:assertElementReadonly>
  <ui:xpath>//span[@id='mx47']/span/span[3]</ui:xpath>
</ui:assertElementReadonly>

<ui:waitForElementPresent>

Verifies a matched element will show up on the page in the specified number of seconds. Must match only one element returned by the selector.

Child elements: <ui:xpath>, <ui:id>, <ui:cssSelector>, <ui:linkText>, <ui:name>, <ui:tagName>

Example:

<ui:waitForElementPresent time="30">
  <ui:xpath>//*[@staticId='headerA_5-multiparttextbox_label']</ui:xpath>
</ui:waitForElementPresent>

<ui:verifyElementPresent>

Verifies if specified element is somewhere on the page. Must match only one element returned by the selector.

Child elements: <ui:xpath>, <ui:id>, <ui:cssSelector>, <ui:linkText>, <ui:name>, <ui:tagName>

Example:

<ui:verifyElementPresent>
  <ui:xpath>//span[@id='mx47']/span/span[3]</ui:xpath>
</ui:verifyElementPresent>

<ui:getTextPresent>

Checks if certain text appears somewhere on the rendered page. Returned value is stored into the referenced variable.

Example:

<var type="String" name="elemTextPresent">""</var>
<ui:getTextPresent text="o To" var="elemTextPresent" />

<addReportLine action="Checking if text is present on the page" expected="Element text is present
on the page" actual="Element text is present: $elemTextPresent" status="PASSED" />

<ui:assertTextPresent>

Checks if certain text appears somewhere on the rendered page.

Example:

<ui:assertTextPresent text="Work Order Tracking"/>

<ui:waitForTextPresent>

Verifies if certain text appears somewhere on the rendered page in the specified number of seconds.

Example:

<ui:waitForTextPresent text="Originating Record:" time="30" />

<ui:verifyTextPresent>

Verifies if certain text appears somewhere on the rendered page.

Example:

<ui:verifyTextPresent text="o To" />

<ui:getTitle>

Stores the title of the current page into the specified variable.

Example:

<var type="String" name="pageTitle">""</var>
<ui:getTitle var="pageTitle" />

<ui:assertTitle>

Element that checks if certain text is equal to title of the current page.

Example:

<ui:assertTitle title="Work Order Tracking" />

<ui:waitForTitle>

Verifies if specified text will be equal to the rendered page title in the specified number of seconds.

Example:

<ui:waitForTitle title="Work Order" time="30" />

<ui:verifyTitle>

Verifies that the title of the page matches the specified title text.

Example:

<ui:verifyTitle title="Work Order" />

<ui:assertValue>

Element that checks if certain text is equal to a value of an input web element. Must have one and only one child element that is returned by the selector.

Selectors:

ui:xpath - finds web element by its xpath ui:id - finds web element by its id ui:cssSelector - finds web element by its CSS class ui:linkText - finds web element by its link text ui:name - finds web element by its name ui:tagName - finds web element by its tag name

Child elements: <ui:xpath>, <ui:id>, <ui:cssSelector>, <ui:linkText>, <ui:name>, <ui:tagName>

Example:

<!-- when a work order is created, Maximo should auto-populate the Class field with value
"WORKORDER" -->
<ui:assertValue value="WORKORDER">
  <ui:xpath>//*[@staticId='main_grid3_2-textbox_textbox']</ui:xpath>
</ui:assertValue>

<ui:waitForValue>

Verifies if the specified text will be equal to the value of an input element in the specified number of seconds.

Child elements: <ui:xpath>, <ui:id>, <ui:cssSelector>, <ui:linkText>, <ui:name>, <ui:tagName>

Example:

<ui:waitForValue value="WORKORDER" time="10">
  <ui:xpath>//*[@staticId='main_grid3_2-textbox_textbox']</ui:xpath>
</ui:waitForValue>

<ui:verifyValue>

Verifies if specified text is equal to value of input web element. Must match only one element returned by the selector.

Child elements: <ui:xpath>, <ui:id>, <ui:cssSelector>, <ui:linkText>, <ui:name>, <ui:tagName>

Example:

<ui:verifyValue value="1001">
  <ui:xpath>//*[@staticId='headerA_5-multiparttextbox_textbox_2']</ui:xpath>
</ui:verifyValue>

<ui:assertText>

Element that checks if certain text is equal to text content of web element. Must have one and only one child element that represent selector by which element will be found.

Selectors:

ui:xpath - finds web element by its xpath ui:id - finds web element by its id ui:cssSelector - finds web element by its CSS class ui:linkText - finds web element by its link text ui:name - finds web element by its name ui:tagName - finds web element by its tag name

Child elements: <ui:xpath>, <ui:id>, <ui:cssSelector>, <ui:linkText>, <ui:name>, <ui:tagName>

Example:

<ui:assertText text="Go To">
  <ui:xpath>//span[@id='mx47']/span/span[3]</ui:xpath>
</ui:assertText>

<ui:waitForText>

Verifies if specified text will be equal to text content of web element in specified number of seconds. Must match only one element returned by the selector.

Child elements: <ui:xpath>, <ui:id>, <ui:cssSelector>, <ui:linkText>, <ui:name>, <ui:tagName>

Example:

<ui:waitForText text="Originating Record:" time="30">
  <ui:xpath>//*[@staticId='main_grid9_1-textbox_label']</ui:xpath>
</ui:waitForText>

<ui:verifyText>

Verifies if certain text is equal to text content of web element. Must match only one child element that is returned by the selector.

Child elements: <ui:xpath>, <ui:id>, <ui:cssSelector>, <ui:linkText>, <ui:name>, <ui:tagName>

Example:

<ui:verifyText text="o To">
  <ui:xpath>//span[@id='mx47']/span/span[3]</ui:xpath>
</ui:verifyText>

<ui:getValue>

Gets value of text input element. Must match only one element returned by the selector.

Child elements: <ui:xpath>, <ui:id>, <ui:cssSelector>, <ui:linkText>, <ui:name>, <ui:tagName>

Example:

<var type="String" name="woNum">""</var>

<ui:getValue var="woNum">
  <ui:xpath>//*[@staticId='headerA_5-multiparttextbox_textbox_1']</ui:xpath>
</ui:getValue>

<addReportLine action="Getting work order number" expected="Work Order number can be fetched"
actual="WONUM is $woNum" status="PASSED" />

<ui:getText>

Gets text content of web element (for example a label text) and stores it into a variable. Must match only one child element returned by the selector.

Child elements: <ui:xpath>, <ui:id>, <ui:cssSelector>, <ui:linkText>, <ui:name>, <ui:tagName>

Example:

<var type="String" name="elemText">""</var>

<ui:getText var="elemText">
  <ui:xpath>//span[@id='mx47']/span/span[3]</ui:xpath>
</ui:getText>

<addReportLine action="Get element text" expected="Element text can be fetched" actual="Element
text is $elemText" status="PASSED" />

<ui:getAttribute>

Gets attribute value of web element. Must match only one child element represented by the selector.

Child elements: <ui:xpath>, <ui:id>, <ui:cssSelector>, <ui:linkText>, <ui:name>, <ui:tagName>

Example:

<var type="String" name="descAttribute">""</var>
<ui:getAttribute var="descAttribute" name="id">
  <ui:xpath>//*[@staticId='headerA_5-multiparttextbox_textbox_2']</ui:xpath>
</ui:getAttribute>

<addReportLine action="Get Description field ID" expected="ID is retrieved" actual="id:
$descAttribute" status="PASSED" />

<ui:screenshot>

Captures a screenshot of the page and stores it into the specified file.

Example (synthesised):

<ui:screenshot />

<ui:pause>

Pauses case execution and waits for "Continue to be pressed"

Example (synthesised):

<ui:pause />

<ui:wait>

Sets a time out period in the execution of the test. Will pause execution of the subsequent tag for the given period of time (expressed in seconds in the "time" attribute).

Example:

<ui:click>
  <ui:xpath>//*[@staticId='headerA_5-multiparttextbox_textbox_2']</ui:xpath>
</ui:click>

<ui:wait time="30" />

<ui:clear>
  <ui:xpath>//*[@staticId='headerA_5-multiparttextbox_textbox_2']</ui:xpath>
</ui:clear>

<ui:sendKeys>

Simulates typing into a text input web element. Must match only one child element that is returned by the selector.

Child elements: <ui:xpath>, <ui:id>, <ui:cssSelector>, <ui:linkText>, <ui:name>, <ui:tagName>

Example:

<ui:sendKeys text="test">
  <ui:xpath>//*[@staticId='headerA_5-multiparttextbox_textbox_2']</ui:xpath>
</ui:sendKeys>

<addReportLine action="Enter 'test' as description" expected="Description is populated"
actual="Description is populated" status="PASSED" />

<ui:setInnerHTML>

Sets the element's inner html. Replaces any html found in the element located.

Child elements: <ui:xpath>, <ui:id>, <ui:cssSelector>, <ui:linkText>, <ui:name>, <ui:tagName>, <ui:content>

Example:

<ui:setInnerHTML>
  <ui:id>dijitEditorBody</ui:id>
  <ui:content>
    <![CDATA[testing <span style="font-weight: bold;">setInnerHTML</span><br>using
      different <span style="font-family: monospace;">font </span><br>and <span
        style="text-decoration: underline;"><span style="font-weight: bold;">style </span></span><br><div></div>
        ]]>
      </ui:content>
    </ui:setInnerHTML>

<ui:clear>

Clears a text field.

Child elements: <ui:xpath>, <ui:id>, <ui:cssSelector>, <ui:linkText>, <ui:name>, <ui:tagName>

Example:

<ui:clear>
  <ui:xpath>//*[@staticId='changestatus_grid1_1_1_grid4_3a-textbox_textbox']</ui:xpath>
</ui:clear>

<ui:close>

Closes the connection to the web driver. Automatically added to a UI test within the <afterTestCase> tag.

Example:

<ui:close/>

<ui:login>

Log in user with specified username and password.

Child elements: <ui:userName>, <ui:password>

Example (synthesised):

<ui:login>
    <ui:userName>...</ui:userName>
    <ui:password>...</ui:password>
</ui:login>

<ui:logout>

Log out the current user.

Example:

<ui:logout />

<ui:maximizeWindow>

Maximizes the browser window.

Example:

<ui:maximizeWindow />

<ui:switchToWindow>

Switches control to different window with specified title. If closeCurrent attribute is true, current window will be closed before switching.

Example:

<ui:switchToWindow title="BIRT Report Viewer" closeCurrent="false" />

<ui:switchToMainWindow>

Switches control to the main window. Main window is the window in which the test started running.

Example:

<ui:switchToMainWindow closeCurrent="true" />

<ui:switchToFrame>

Switches focus to the specified frame. Mostly used for interaction with elements in iFrames.

Child elements: <ui:xpath>, <ui:id>, <ui:cssSelector>, <ui:linkText>, <ui:name>, <ui:tagName>

Example:

<!-- clicking on element inside iFrame with xpath "//*[@id='uploadIFrame']/span[2]/span" and
returning to default frame -->
<ui:switchToFrame>
  <ui:xpath>//*[@id='uploadIFrame']</ui:xpath>
</ui:switchToFrame>

<ui:click>
  <ui:xpath>//*[@id='uploadIFrame']/span[2]/span</ui:xpath>
</ui:click>

</ui:switchToDefaultFrame/>

<ui:switchToDefaultFrame>

Switches focus to the main frame of the page. Mostly used to return from iFrame previously focused on.

Example:

<!-- clicking on element inside iFrame with xpath "//*[@id='uploadIFrame']/span[2]/span" and
returning to default frame -->
<ui:switchToFrame>
  <ui:xpath>//*[@id='uploadIFrame']</ui:xpath>
</ui:switchToFrame>

<ui:click>
  <ui:xpath>//*[@id='uploadIFrame']/span[2]/span</ui:xpath>
</ui:click>

</ui:switchToDefaultFrame/>

<ui:clickSimple>

Clicks on element by performing native click event. Use this as an alternative to ui:click when ui:click doesn't work.

Child elements: <ui:xpath>, <ui:id>, <ui:cssSelector>, <ui:linkText>, <ui:name>, <ui:tagName>

Example:

<!-- simple click -->
<ui:clickSimple>
  <ui:xpath>//*[@staticId='plans_children_table-table_expand_contract']"</ui:xpath>
</ui:clickSimple>

<ui:doubleClick>

Double clicks on the element.

Child elements: <ui:xpath>, <ui:id>, <ui:cssSelector>, <ui:linkText>, <ui:name>, <ui:tagName>

Example:

<!-- double click -->
<ui:doubleClick>
  <ui:xpath>//*[@staticId='plans_children_table-table_expand_contract']"</ui:xpath>
</ui:doubleClick>

<ui:clickError>

Clicks on the error field inside an element.

Child elements: <ui:xpath>, <ui:id>, <ui:cssSelector>, <ui:linkText>, <ui:name>, <ui:tagName>

Example:

<!-- error click -->
<ui:clickError>
  <ui:id>mad3161b5-tb</ui:id>
</ui:clickError>

<ui:clickEvent>

Directly executes Maximo java script function sendEvent. Use this as an alternative to ui:click when ui:click doesn't work.

Child elements: <ui:xpath>, <ui:id>, <ui:cssSelector>, <ui:linkText>, <ui:name>, <ui:tagName>

Example:

<!-- sendEvent click -->
<ui:clickEvent>
  <ui:xpath>//*[@staticId='plans_children_table-table_expand_contract']"</ui:xpath>
</ui:clickEvent>

<ui:sendParam>

Sends the test parameter value to specified field.

Child elements: <ui:xpath>, <ui:id>, <ui:cssSelector>, <ui:linkText>, <ui:name>, <ui:tagName>

Example:

<!-- sendParam -->
<ui:sendParam name="paramName">
  <ui:xpath>//*[@staticId='plans_children_table-table_expand_contract']"</ui:xpath>
</ui:sendParam>

<ui:waitForUserAction>

Pauses the test execution and wait for the user action defined in the "action" sub-command. For action clickElement: user should click on the highlighted element. For action clickContinue: user should click on the continue button. This action can contain sub-command that will highlight passed element.

Child elements: <ui:shiftElementPosition>, <ui:hint>, <ui:message>, <ui:action>, <ui:clickContinue>, <ui:highlight>, <ui:xpath>, <ui:id>, <ui:cssSelector>, <ui:linkText>, <ui:name>, <ui:tagName>, <ui:clickElement>, <ui:waitForTextInput>

Example:

<ui:waitForUserAction>
  <ui:message>message to show</ui:message>
  <ui:action>
    <!-- action to execute, for test to continue -->
    <!-- use ONLY ONE of the following -->
    <ui:clickContinue>
      <!-- optional tag to highlight passed element -->
      <ui:highlight>
        <ui:id>element_to_be_highlighted_id</ui:id>
      </ui:highlight>
    </ui:clickContinue>
    <ui:clickElement>
      <ui:id>element_to_be_clicked_id</ui:id>
    </ui:clickElement>
  </ui:action>
</ui:waitForUserAction>

Database Tags (db:)

JDBC database access: connections, SQL execution, and typed reads from result sets.

<db:connection>

Creates a connection to database.

Child elements: <db:url>, <db:password>, <db:userName>

Example:

<var type="Connection" name="myConnection">

  <db:connection var="myConnection">
    <db:url>jdbc:oracle:thin:@//localhost:1521/max1</db:url>
    <db:password>maximo</db:password>
    <db:userName>maximo</db:userName>
  </db:connection>

<db:sql>

SQL to execute on specified DB connection. Returned result set is stored into variable.

Text content: string

Example:

<var type="ResultSet" name="rs">null</var>
<db:sql connection="dataLoaderConn" var="rs">
  select * from staging_asset
</db:sql>

<db:forEachResult>

Loops through given result set and fetches records. For each fetched record the nested child elements will be processed.

Child elements: <db:getStringFromResult>, <db:getIntFromResult>, <db:getDateFromResult>, <db:getTimestampFromResult>, <db:getLongFromResult>, <db:getFloatFromResult>, <db:getBooleanFromResult>, <db:getClobFromResult>, <db:getBlobFromResult>, <db:getBytesFromResult>, <db:getByteFromResult>

Example:

<db:forEachResult resultSet="rs">
            <var name="result1" type="String">
                null
            </var>
            <db:getStringFromResult fieldName="WONUM" var="result1"/>
            <printOut>
                result1
            </printOut>
    </db:forEachResult>

Within this element you can use elements which get values from the current record. Those elements are:
<getStringFromResult> - Gets string value from the record fetched by db:forEachResult. 
    Attributes: fieldName - Name of the field from which value will be fetched.
                         var - Variable which will hold fetched String value.
    Example: 
    <var name="result1" type="String">
                null
    </var>
    <db:getStringFromResult fieldName="WONUM" var="result1"/>

<getIntFromResult> - Gets integer value from the record fetched by db:forEachResult.
    Attributes: fieldName - Name of the field from which value will be fetched.
                         var - Variable which will hold fetched integer value.
    Example:
    <var name="resultInt" type="int">
                0
    </var>
    <db:getIntFromResult fieldName="ESTMATCOST" var="resultInt"/>    

<getDateFromResult> - Gets date value from the record fetched by db:forEachResult.
    Attributes: fieldName - Name of the field from which value will be fetched.
                         var - Variable which will hold fetched date value.
    Example:
    <var name="resultDate" type="int">
                0
    </var>
    <db:getIntFromResult fieldName="PMDUEDATE" var="resultDate"/>

<getTimestampFromResult> - Gets timestamp value from the record fetched by db:forEachResult.
    Attributes: fieldName - Name of the field from which value will be fetched.
                         var - Variable which will hold fetched timestamp value.
    Example:
    <var name="resultTimestamp" type="Timestamp">
                null
    </var>
    <db:getTimestampFromResult fieldName="STATUSDATE" var="resultTimestamp"/>
<getLongFromResult> - Gets long value from the record fetched by db:forEachResult.
    Attributes: fieldName - Name of the field from which value will be fetched.
                         var - Variable which will hold fetched long value.
    Example:
    <var name="resultLong" type="long">
                0
    </var>
    <db:getLongFromResult fieldName="WORKORDERID" var="resultLong"/>

<getFloatFromResult> - Gets float value from the record fetched by db:forEachResult.
    Attributes: fieldName - Name of the field from which value will be fetched.
                         var - Variable which will hold fetched float value.
    Example:
    <var name="resultFloat" type="float">
                0
    </var>            
    <db:getFloatFromResult fieldName="WOPRIORITY" var="resultFloat"/>

<getBooleanFromResult> - Gets boolean value from the record fetched by db:forEachResult.
    Attributes: fieldName - Name of the field from which value will be fetched.
                         var - Variable which will hold fetched boolean value.
    Example:
    <var name="resultBoolean" type="boolean">
                false
    </var>
    <db:getBooleanFromResult fieldName="WOACCEPTSCHARGES" var="resultBoolean"/>

<getClobFromResult> - Gets clob value from the record fetched by db:forEachResult.
    Attributes: fieldName - Name of the field from which value will be fetched.
                         var - Variable which will hold fetched clob value.
    Example:
    <var name="resultClob" type="Clob">
                null
    </var>
    <db:getClobFromResult fieldName="LDTEXT" var="resultClob"/>

<getBlobFromResult> - Gets blob value from the record fetched by db:forEachResult.
    Attributes: fieldName - Name of the field from which value will be fetched.
                         var - Variable which will hold fetched blob value.
    Example:
    <var name="resultBlob" type="Blob">
                null
    </var>
    <db:getBlobFromResult fieldName="RESOURCES" var="resultBlob"/>

<getBytesFromResult> - Gets bytes value from the record fetched by db:forEachResult.
    Attributes: fieldName - Name of the field from which value will be fetched.
                         var - Variable which will hold fetched bytes value.
    Example:
    <var name="resultBytes" type="byte[]">
                null
    </var>
    <db:getBytesFromResult fieldName="RESOURCES" var="resultBytes"/>

<getByteFromResult> - Gets byte value from the record fetched by db:forEachResult.
    Attributes: fieldName - Name of the field from which value will be fetched.
                         var - Variable which will hold fetched byte value.
    Example:
    <var name="resultByte" type="byte">
                0
    </var>
    <db:getByteFromResult fieldName="ASSETLOCPRIORITY" var="resultByte"/>

<db:getStringFromResultSet>

Gets string value from record identified by given row number from given result set.

Example:

<var name="resultString" type="String">
  null
</var>
<db:getStringFromResultSet resultSet="rs" field="WONUM" row="1" var="resultString"/>

<db:closeConnection>

Closes opened database connection defined by db:connection.

Example:

<db:closeConnection connection = "myConnection"/>

<db:getDateFromResultSet>

Gets Date value from record identified by given row number from given result set.

Example:

<var name="resultDate" type="Date">
  null
</var>
<db:getDateFromResultSet resultSet="rs" field="PMDUEDATE" row="1" var="resultDate"/>

<db:getTimestampFromResultSet>

Gets Timestamp value from record identified by given row number from given result set.

Example:

<var name="resultTimestamp" type="Timestamp">
  null
</var>
<db:getTimestampFromResultSet resultSet="rs" field="STATUSDATE" row="1" var="resultTimestamp"/>

<db:getLongFromResultSet>

Gets long value from record identified by given row number from given result set.

Example:

<var name="resultLong" type="long">
  0
</var>
<db:getLongFromResultSet resultSet="rs" field="WORKORDERID" row="1" var="resultLong"/>

<db:getFloatFromResultSet>

Gets float value from record identified by given row number from given result set.

Example:

<var name="resultFloat" type="float">
  0
</var>
<db:getFloatFromResultSet resultSet="rs" field="WOPRIORITY" row="3" var="resultFloat"/>

<db:getBooleanFromResultSet>

Gets boolean value from record identified by given row number from given result set.

Example:

<var name="resultBoolean" type="boolean">
  false
</var>
<db:getBooleanFromResultSet resultSet="rs" field="WOACCEPTSCHARGES" row="1" var="resultBoolean"/>

<db:getClobFromResultSet>

Gets CLOB value from record identified by given row number from given result set.

Example:

<var name="resultClob" type="Clob">
  null
</var>
<db:getClobFromResultSet resultSet="rs" field="LDTEXT" row="1" var="resultClob"/>

<db:getBlobFromResultSet>

Gets BLOB value from record identified by given row number from given result set.

Example:

<var name="resultBlob" type="Blob">
  null
</var>
<db:getBlobFromResultSet resultSet="rs" field="RESOURCES" row="1" var="resultBlob"/>

<db:getBytesFromResultSet>

Gets bytes value from record identified by given row number from given result set.

Example:

<var name="resultBytes" type="byte[]">
  null
</var>
<db:getBytesFromResultSet resultSet="rs" field="RESOURCES" row="1" var="resultBytes"/>

<db:getByteFromResultSet>

Gets byte value from record identified by given row number from given result set.

Example:

<var name="resultByte" type="byte">
  0
</var>
<db:getByteFromResultSet resultSet="rs" field="ASSETLOCPRIORITY" row="1" var="resultByte"/>

<db:getIntFromResultSet>

Gets integer value from record identified by given row number from given result set.

Example:

<var name="resultInt" type="int">
  0
</var>
<db:getIntFromResultSet resultSet="rs" field="ESTMATCOST" row="1" var="resultInt"/>

Network Tags (net:)

Network reachability and HTTP response-code checks.

<net:ping>

Test the reachability of a host on an Internet Protocol (IP) network.

Child elements: <net:port>

Example:

<net:ping host="192.168.1.5"/>

For testing reachability of port on a host, you can use <net:port> child element.

    Example:
    <net:ping host="192.168.1.5">
        <net:port>
            139
        </net:port>
    </net:ping>

<net:getURLResponseCode>

Returns response code from given URL.

Example:

<var name="response" type="int">
  0
</var>
<net:getURLResponseCode url="http://www.google.com" var="response"/>

<net:checkURLResponseCode>

Test response code for given URL.

Example:

<net:checkURLResponseCode url="http://www.google.com" responseCode="200"/>

System Tags (sys:)

Orchestration and parameters: run other cases/suites, read/write project & system params, share values between runs, logging.

<sys:runCase>

Runs the given case. The case is run synchronously but can be run asynchronously by controlling the value of the runType attribute.

Child elements: <sys:params>

Example:

simple synchronous test run
                <sys:runCase name="case 1"/>

                :: Example 2: asynchronous run
                <sys:runCase name="case 1" runType="asynchronous"/>

                :: Example 3: run result is returned into the "runResult1" variable
                <var name="runResult1" type="CaseRunResult">null</var>
                <sys:runCase name="case 1" var="runResult1"/>

                :: Example 4:r un the case with the specific parameters
                <sys:runCase name="case 1"/>
                    <sys:params>
                        param1=Some value
                        anotherParam=Some other value
                    </sys:params>
                 </sys:runCase>

<sys:runSuite>

Runs the given suite. The suite is run synchronously but can be run asynchronously by controlling the value of the runType attribute.

Child elements: <sys:params>

Example:

simple synchronous suite run
                <sys:runSuite name="suite 1"/>

                :: Example 2: asynchronous run
                <sys:runSuite name="suite 1" runType="asynchronous"/>

                :: Example 3: run result is returned into the "runResult1" variable
                <var name="runResult1" type="SuiteRunResult">null</var>
                <sys:runSuite name="suite 1" var="runResult1"/>

                :: Example 4:r un the suite with the specific parameters
                <sys:runSuite name="suite 1"/>
                    <sys:params>
                        param1=Some value
                        anotherParam=Some other value
                    </sys:params>
                 </sys:runSuite>

<sys:stopRun>

Stops the run for the given runid.

This is used to stop both case runs and suite runs.

Example:

- stop a run with a known id:
                <sys:stopRun runId="1256"/>

                :: Example 2 - stop a run that was started asynchronously:
                <var name="runResult1" type="CaseRunResult">null</var>
                <sys:runCase name="case 1" runType="asynchronous" var="runResult1" />
                <var name="runId1" type="Long">runResult1.getId()</var>
                <sys:stopRun runId="runId1"/>

<sys:setRunProgress>

Updates the run progress percentage in the webapp.

Example:

<sys:setRunProgress percent="50"/>

<sys:getProjectParam>

Gets project parameter value.

Example:

<var name="var1" type="String">null</var>
<sys:getProjectParam name="param.1" var="var1"/>

<sys:getParam>

Gets project parameter value.

Example:

<var name="var1" type="String">null</var>
<sys:getProjectParam name="param.1" var="var1"/>

<sys:incrementProjectParam>

Increments project parameter by 1 and retrieves the resulting value.

This helps to create unique values where needed.

Example:

<var name="var1" type="String">null</var>
<sys:incrementParam name="param.1" var="var1"/>

<sys:getSystemParam>

Gets system parameter value.

Example:

<var name="var1" type="String">null</var>
<sys:getSystemParam name="param.1" var="var1"/>

<sys:getSharedRunValue>

Gets shared run value that was set by a preceding case from within the same batch.

Shared run values are used for information exchange between cases when they are run in the same batch, e.g cases in a suite or cases whose run was initiated from within another case.

Example:

... case1 creates a purchase order and sets a shared run value with the purchase order number
                <sys:setSharedRunValue name="po.num" value="1234"/>

                ... case2 reads the purchase order number to use it to approve the PO
                <var name="poNum" type="String">null</var>
                <sys:getSharedRunValue name="po.num" var="poNum"/>

<sys:setSharedRunValue>

Sets shared run value to be used by other cases from within the same batch.

Shared run values are used for information exchange between cases when they are run in the same batch, e.g cases in a suite or cases whose run was initiated from within another case.

Example:

... case1 creates a purchase order and sets a shared run value with the purchase order number
                <sys:setSharedRunValue name="po.num" value="1234"/>

                ... case2 reads the purchase order number to use it to approve the PO
                <var name="poNum" type="String">null</var>
                <sys:getSharedRunValue name="po.num" var="poNum"/>

<sys:addLogLine>

Adds a line of text to the run log. The update happens in real time and can be observed in the webapp.

Example:

<sys:addLogLine text="some log text"/>

<sys:addLog>

Appends text to the run log. It doesn't break the line. The update happens in real time and can be observed in the webapp.

Example:

<sys:addLog text="some log text"/>

<sys:getAllProjectParams>

Gets all project parameters.

Example:

<var name="projParams1" type="List<ProjectParam>">null</var>
<sys:getProjectParams var="projParams1"/>

<sys:getAllSystemParams>

Gets all system parameters.

Example:

<var name="sysParams1" type="List<SystemParam>">null</var>
<sys:getSystemParams var="sysParams1"/>

<sys:getAllParams>

Gets all run parameters.

Example:

<var name="runParams1" type="String">null</var>
<sys:getAllParams var="runParams1"/>

Time Tags (time:)

Stopwatches, waits, and reading/formatting date-time components.

<time:stopwatchStart>

Starts a new timing session. Attribute name represents the name of variable that will hold the stopwatch instance(Variable must be created before using this element and its type must be StopWatch)

Example:

<var name="stopwatch1" type="StopWatch">
  null
</var>
<time:stopwatchStart name="stopwatch1"/>

<time:stopwatchStop>

Stop the stopwatch (ends the timing session) and returns time in millisecond.

Example:

<var name="stop1" type="long">
  0
</var>
<time:stopwatchStop name="stopwatch1" var="stop1"/>

<time:stopwatchSplit>

Returns time passed since starting stopwatch. Returned time is in milliseconds.

Example:

<var name="split1" type="long">
  0
</var>
<time:stopwatchSplit name="stopwatch1" var="split1"/>

<time:getSeconds>

Transforms milliseconds to seconds.

Example:

<var name="mills" type="long">
  2017
</var>
<var type="float" name="sec">
  0
</var>
<time:getSeconds milliseconds="mills" var="sec"/>

<time:stopwatchSuspend>

Suspend the stopwatch for later resumption.

Example:

<time:stopwatchSuspend name="stopwatch1"/>

<time:stopwatchResume>

Resume the stopwatch after a suspend. The watch will not include time between the suspend and resume calls in the total time.

Example:

<time:stopwatchResume name="stopwatch1"/>

<time:wait>

Stops the test thread for a specified number of seconds.

Example:

<time:wait period="5"/>

<time:getDayOfWeek>

Returns the day of the week. Returned value is number in interval 1-7 (starting with sunday).

Example:

<var type="int" name="dayOfWeek">
  0
</var>
<time:getDayOfWeek var="dayOfWeek"/>

<time:getDayOfMonth>

Returns the day of the month. Returned value is number.

Example:

<var type="int" name="dayOfMonth">
  0
</var>
<time:getDayOfMonth var="dayOfMonth"/>

<time:getHourOfDay>

Gets the current hour. Returned value is a number.

Example:

<var type="int" name="hourOfDay">
  0
</var>
<time:getHourOfDay var="hourOfDay"/>

<time:getCurrentMinute>

Returns the number of minutes past the hour.

Example:

<var type="int" name="minute">
  0
</var>
<time:getCurrentMinute var="minute"/>

<time:getMonth>

Returns a number representing the current month. Returned number id in interval 0-11 (starting with January).

Example:

<var type="int" name="month">
  0
</var>
<time:getMonth var="month"/>

<time:getCurrentSecond>

Returns the number of seconds past the minute.

Example:

<var type="int" name="second">
  0
</var>
<time:getCurrentSecond var="second"/>

<time:getYear>

Returns the current year.

Example:

<var type="int" name="year">
  0
</var>
<time:getYear var="year"/>

<time:getTime>

Returns a Date object representing current time value.

Example:

<var type="Date" name="time">
  null
</var>
<time:getTime var="time"/>

<time:getFormatedTime>

Formats a Date into a date/time string using the given date and time pattern. Returns date/time string. By default it use current system time.

Child elements: <time:dateVar>

Example:

<var type="String" name="formatedTime">
          null
          </var>
          <time:getFormatedTime var="formatedTime" format="dd-mm-yyyy hh:mm:ss"/>

          If you don't want to use current system time, you can pass the Date instance by using <time:dateVar> child element.

          Example:
          <time:getFormatedTime var="formatedTime1" format="dd-mm-yyyy hh:mm:ss">
          <time:dateVar>
          time
          </time:dateVar>
          </time:getFormatedTime>

<time:addTime>

Adds or subtracts the specified amount of given unit of time to the given Date variable. Variable can be negative.

Example:

<time:addTime var="currentDate" amount="15" unit="MINUTE" />

Performance Tags (perf:)

Performance measurement segments for timing parts of a test.

<perf:initialize>

Initializes the required parameters for further usage of performance tags. This tag must exist in the script before any other performance tag.

Example (synthesised):

<perf:initialize sessionid="..." />

<perf:segmentStart>

Starts a new performance segment. After this tag use perf:segmentSplit... to record split time and perf:segmentStop... to record overall time for the segment.

Example (synthesised):

<perf:segmentStart name="..." />

<perf:segmentStop>

Stops time measuring for the segment and stores the time in the database in milliseconds.

Example (synthesised):

<perf:segmentStop name="..." description="..." comment="..." />

<perf:segmentSplit>

Without stopping the segment, takes time measurement for the segment and stores in the database in milliseconds.

Example (synthesised):

<perf:segmentSplit segmentName="..." splitName="..." description="..." comment="..." />

Tag-Definition Meta Schema (tag:)

Meta-schema used to define custom MXML tags (how a tag maps to generated Java). Not used inside test cases directly.

<tag:tagDefinitions>

Root element of tag definition.

Child elements: <tag:tagDefinition>

Example (synthesised):

<tag:tagDefinitions>
    <tag:tagDefinition>...</tag:tagDefinition>
</tag:tagDefinitions>

<tag:tagDefinition>

Root element of tag definition.

Child elements: <tag:attributes>, <tag:attribute>, <tag:code>, <tag:endCode>, <tag:imports>, <tag:import>, <tag:globals>, <tag:global>, <tag:exceptions>, <tag:exception>

Example (synthesised):

<tag:tagDefinition name="..." nameSpace="...">// code / content here</tag:tagDefinition>