WebDriverPluginShare

calls a method in org.openqa.selenium.WebDriver class that accepts String parameter(s) or no parameters.

Example:

$WebDriver('getPageSource')

calls a method in org.openqa.selenium.WebElement class that accepts String parameter(s) or no parameters.

Example:

$WebDriverElement('id=f1','click')

calls a method in org.openqa.selenium.WebDriver.Options class that accepts String parameter(s) or no parameters.

Example:

$WebDriverManage('getCookieNamed','xyz')

calls a method in org.openqa.selenium.WebDriver.Navigation class that accepts String parameter(s) or no parameters.

Example:

$WebDriverNavigate('back')

calls a method in org.openqa.selenium.WebDriver.TargetLocator class that accepts String parameter(s) or no parameters.

Example:

$WebDriverSwitchTo('frame','ABC')

accept the alert dialog window by clicking on "OK" button.

clears the input field.

Example:

<action code="$clear('id=F1')"/> 

simulate click on the first element found. Element must supports coordinates, for example an image.

Example:

<action code="$click('id=F1','100','200')"/> 

simulate click on the first element found.

Example:

<action code="$click('id=F1')"/> 

simulate click on the first element found with option of holding down shift, ctrl or alt key.

Not available for remote testing using selenium/appium/saucelabs servers.

Example:

<action code="$click('id=F1','S')"/> 

closes a window

returns true if current page contains the text passed in. The text must be static text string only.

Example:

<log msg="Page contains text XXXX? $containsText('XXXX')"/> 

returns true if the element of the locator passed in contains the text specified. The text must be static text string only.

Example:

<log msg="Page contains text XXXX? $containsText('id=xyz', 'XXXX')"/>

returns count of number of objects for the element locator passed in.

Example:

<log msg="$found $count('name=paymentType') payment types on the screen"/>

dismiss the alert/confirm dialog by clicking on close or "cancel" button.

double click on the first element found.

Example:

<action code="$doubleClick('id=F1')"/>

drag an element and drop it onto another element. Only the first element found for both drag source and drop source locators are acted on.

Example:

<action code="$dragAndDrop('id=F1','id=f2')"/> 

return the information of all windows currently open.

Each window is described in the following format, multiple windows are separated with a semi-colon ";". :
name:title[idx]

returns a list of window handles.@return

Returns the value of HTML attribute value defined in the element.

Example:

<log msg="Field attribute: $getAttr('id=F1','class')."/>

Each type of HTML element has a set of attributes but it also allows user defined attributes. For example "table" element has these attributes "id", "name", "width", "height", "class", etc. These are standard attributes to define a table in HTML. You may add any user attributes like "customerNumber", "orderNumber", "firstName", etc. These user defined attributes are also accessible by getAttr().

returns the type of browser currently being launched. This is thread specific. That is, a model running multiple threads each thread can launch different browser.@return

returns the message in the confirm popup dialog if present. blank if not.@return

returns the value of the cookie.

returns the plugin native driver object, e.g. selenium returns selenium webdriver object. Not an MScript function. For use in java handler only.

returns the text representation of current webpage. Webapp only

Returns the text of the element. If multiple elements found, return a String with all text strung together separated by semicolon.

Example:

<log msg="$getText('id=rowTitle')"/> 

returns the title of the current window/page.

Example:

<log msg="Page title is: $getTitle()"/>

Returns the value of the first element found with the locator_p. If element does not have value attribute, it returns the text. If element still does not have text attribute, it returns blank.

Example:

<log msg="userid is: $getValue('userid')"/>

highlight element(s) by changing its border color temporarily for a duration specified in milliseconds. webapp only.

highlights the element identified the locator passe in for 1 second by drawing an orange border around the element.

retusn true if the alert dialog has been displayed(triggered).

returns true if the first element found with locator_p is checked: radio button or checkbox only.

Example:

<log msg="The checkbox F1 checked? $isChecked('id=F1')"/>

retusn true if the confirm dialog has been displayed(triggered). isConfirmPresent() must be called immediately after the action that trigger the confirm popup. optionally you can call getConfirmText().

returns true if any of the elements found is disabled.

Example:

<log msg="Field F1 disabled?: $isDisabled('id=F1')."/>

returns true if the element exists in the current page/frame/window. Invisible elements are considered present.

Example:

<if val1="$isPresent('checkbox1')" op="eq" val2="true"/> 
    <log msg="checkbox1 is present on this page">
</if>

returns true if any of the elements is visible.

Example:

<log msg="Field F1 visible?: $isVisible('id=F1')."/> 

executes javascript on current window/frame. Be sure to use "return xyz" if you wish to receive the return from the call.@return

returns a list of frame names of current window

locates the element and pass back the local locator that can be used by selenium native method. This method should only be used inside the parameter of the native method call.

Example:

$_keyPress('$locate('frame=abc;xpath=id(\'id123\')', 'A') which set the focus

trigger mouse down event on the first element found for locator_p.

Example:

<action code="$mouseDown('id=F1')"/> 

trigger mouse over event on the first element found for locator_p.

Example:

<action code="$mouseOver('id=F1')"/> 

trigger mouse up event on the first element found for locator_p.

Example:

<action code="$mouseUp('id=F1')"/>

opens a new browser window but leave existing windows open. You may use $selectWindow() to go back to other window.

click on the browser refresh button.

Example:

<action code="$refresh()"/> 

to instruct Selenium plugin to reset the current target window to the default main window or first frame if window contains frameset.

Call this method with "false" to avoid constantly resetting the current target window context for better performance, but be aware that you will need to adjust your locators accordingly and call $selectWindow('') if you need redirect current target window to the main window.

closes all browser windows if any and opens a new browser window at the url passed in.

rightClick on the first element found with locator_p.

Example:

<action code="$rightClick('id=F1')"/> 

scrolls window by the x and y pixels specified. Use negative number to scroll backwards. webapp only.

scrolls window to the x,y coordinates specified. Upper-left corner is (0,0). webapp only.

select the named frame as the current default frame.

Example:

<action code="$selectFrame('frame1')"/> 

selects an option for the Select element.

Example:

<action code="$selectOption('id=selectF1','value=2')"/> 

selects a specified window as the current target window which all future commands to be directed to. Pass empty string for the window name to reset current target window to the main window.

You may also select window by window title (rel 4.0.8).

Example:

<action code="$selectWindow('mainWin')"/> 

type the string to the first element found with locator_p. The element must be an input field. It does not clear the content/value of the element if it's not empty.

Example:

<action code="$sendKey('id=F1','abc')"/>

Use the following tokens to simulate special keyboard key:

changes the browser to be used for executing mbt. Should only be called in MBT_start trigger.

You may use a dataset to store a list of browser start cmds and randomly retrieve one to set for each virtual users to simulate multiple users using different browsers.

For example, you can use $nextDataSetRow(java.lang.String dataSetID_p, java.lang.String floatIdx_p), $rand(), and $getData('ds','field') to retrieve different browser "cmd" from a file/spreadsheet to achieve testing with virtual users with each running different browser, like
<action code="$nextDataSetRow('myDS', '$rand()')"/>
<action code="$setBrowserCmd('$getData('myDS', 'myField')')"/>

The alternative is to use DataGen plugin to randomly choose a browser from the list of browsers specified.

Example:

$setBrwoserCmd('$randFromList('internetExplorer|firefox|Chrome')')

sets a capability setting for the selected browser. Must supply the exact key and value in an appropriate format. This method is only valid in MBT_start trigger. Calling this method outside MBT_start trigger has no effect.

This method has variations for different data type. Choose the correct variation that is appropriate for the capability setting according to the browser's specific requirement.

For more information about capability setting supported by the specific browser, please visit WebDriver support page at: http://code.google.com/p/selenium/wiki

Optionally you can set capabilities by editing webdriver.properties in Config folder.

sets the checkbox.

Example:

<action code="$setCheckBox('id=F1','true')"/> 

sets the implicitWait parameter for WebDriver. Implicit wait is the maximun amount of WebDriver will wait for the element to appear in the document. This setting applies to WebDriver directly and is used for all operations that require finding an element in the document.

You may need to use other wait method to supplement this global setting to meet specific needs in different part of the model.

sets the proxy server url for webdriver

sets the first radio button found with locator_p.

Example:

<action code="$setRadioButton('id=F1','true')"/> 

maximizes the browser window.

Example:

$setWindowMaximized()

sets the window home position. Typically you would call this method in MBT_start trigger to position the browser at the desired position.

Example:

$setWindowPosition('100', '400')

sets the browser window size to the specified dimension: width and height. Inavalid width or height value will default to 1000.

Example:

$setWindowSize('1000','2000')

returns the number options in the first select element found

Take a snapshot of current AUT window.

Typical use of this method is to call it in or trigger to take a snapshot of the screen of the error.

The screen shot will be marked with the first exception (if multiple exceptions) triggered by current mScript and thus available from the exception popup.

Example:

<action code="$Selenium.snapScreen('myFileName')"/>

type the string to the first element found with locator_p with the option to have shift/control/alt key pressed. It clears the current value before issuing typing the string into the field.

Not available for remote testing using selenium/appium/saucelabs servers.

Example:

<action code="$type('id=F1','S','abc')"/> 

type the string to the first element found with locator_p. The element must be an input field. It clears the current value before issuing typing the string into the field.

Example:

<action code="$type('id=F1','abc')"/> 

type the string to the first element found with locator_p. The element must be an input field. It does not clear the content/value of the element if it's not empty. This is equivalent to sendKey().

Example:

<action code="$sendKey('id=F1','abc')"/> 

waits for a condition specified on the element up to the specified timeout in milliseconds. Returns true if the condition becomes true, false if it times out.

waits for an element to be visible up to the specified timeout in milliseconds. Returns true if the element is found, false it times out.

waits for a window to open/appear up to the specified timeout in milliseconds. Returns true if the window is found, false it times out waiting.

returns true if the window with specified name/title is found. Else return false.