A C D E F G H I K L M N O P R S T U V W X

A

abort(String) - Method in class com.testoptimal.mscript.Sys

raises Exception to cause the MBT execution to abort.

acceptAlert() - Method in class com.testoptimal.plugin.selenium.SeleniumAssist

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

activateState(String) - Method in class com.testoptimal.mscript.Sys

activates a specific state in the current model resulting in all transitions originating from the specified state to be dispatched for immediate execution.

addAction(String, Closure<Object>) - Method in class com.testoptimal.page.Element

adds an action to the element.

addAction(String, Closure<Object>) - Method in class com.testoptimal.page.Page

adds an action to the page.

addDataSet(DataSet) - Method in class com.testoptimal.dataset.DataMgr

adds dataset to this data manager.

addElement(String, Object) - Method in class com.testoptimal.page.Page

adds an element to the page.

addMCase(String) - Method in class com.testoptimal.mcase.MCaseMgr

register an MCase for later execution by MCase Sequencer.

addMCase(String) - Method in class com.testoptimal.mscript.Sys

Adds a new mcase and returns the MCase created that can be used to add navigation actions.

addPage(String) - Method in class com.testoptimal.mscript.Sys

adds an UI page.

addPage(String) - Method in class com.testoptimal.page.PageMgr

adds a page object and return the page created.

addPlugins(List<String>) - Method in class com.testoptimal.plugin.PluginMgr

addReqFailed(String, String) - Method in class com.testoptimal.mscript.Sys

adds a failed requirement check/validation message to the requirement stat.

addReqFailed(String, String, String) - Method in class com.testoptimal.mscript.Sys

adds a failed requirement check/validation message to the requirement stat.

addReqPassed(String, String) - Method in class com.testoptimal.mscript.Sys

adds a successful requirement check/validation message to the requirement stat.

addReqPassed(String, String, String) - Method in class com.testoptimal.mscript.Sys

adds a successful requirement check/validation message to the requirement stat.

addTestOutput(String) - Method in class com.testoptimal.mscript.Sys

adds a line to the test output buffer to be written out to file at the end of the execution with call to $SYS.saveTestOutput(...)

AgentPlugin - Class in com.testoptimal.plugin

remote agent plugin to allow external application to communicate with the model running on TestOptimal server to perform AUT testing.

AgentPlugin() - Constructor for class com.testoptimal.plugin.AgentPlugin

appendToMessage(String) - Method in exception com.testoptimal.exception.MBTException

AppiumPlugin - Class in com.testoptimal.plugin

Mobile plugin (in beta) provides a set of MScript methods to test web and native mobile applications in real physical device and in simulated device through Appium.

AppiumPlugin() - Constructor for class com.testoptimal.plugin.AppiumPlugin

assertFalse(String, boolean, String) - Method in class com.testoptimal.mscript.Sys

performs the assert on the condition passed in to be false.

assertFalse(String, boolean, String, String) - Method in class com.testoptimal.mscript.Sys

performs the assert on the condition passed in to be false.

assertTrue(String, boolean, String) - Method in class com.testoptimal.mscript.Sys

performs the assert on the condition passed in to be true.

assertTrue(String, boolean, String, String) - Method in class com.testoptimal.mscript.Sys

performs the assert on the condition passed in to be true.

assignAgent(String, long) - Static method in class com.testoptimal.plugin.AgentPlugin

starts model if not already running and dispatch one virtual user.

assist() - Method in class com.testoptimal.plugin.SeleniumPlugin

returns the helper class that contains helper functions for more complex ui operations.

assist() - Method in class com.testoptimal.plugin.WebDriverPlugin

returns the helper class that contains helper functions for more complex ui operations.

C

camelCase(String) - Static method in class com.testoptimal.mscript.Util

uppercase the first char of each word

clear() - Method in class com.testoptimal.dataset.DataSet

clears all records in the data set and return the # of records cleared.

click(By) - Method in class com.testoptimal.plugin.selenium.WebDriverAssist

simulate click on the first element found.

click(By, String) - Method in class com.testoptimal.plugin.selenium.WebDriverAssist

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

click(By, int, int) - Method in class com.testoptimal.plugin.selenium.WebDriverAssist

simulate click on the first element found.

click(String) - Method in class com.testoptimal.plugin.XUIAPlugin

mouse click on left, right and middle button.

clickAt(int, int, String) - Method in class com.testoptimal.plugin.XUIAPlugin

perform mouse click at the coordinates specified.

close() - Method in class com.testoptimal.plugin.AgentPlugin

INTERNAL USE ONLY

close() - Method in class com.testoptimal.plugin.AppiumPlugin

INTERNAL USE ONLY

close() - Method in class com.testoptimal.plugin.MqttPlugin

INTERNAL USE ONLY

close() - Method in class com.testoptimal.plugin.PluginAncestor

INTERNAL USE ONLY.

close() - Method in class com.testoptimal.plugin.PluginMgr

INTERNAL USE ONLY

close() - Method in class com.testoptimal.plugin.RandPlugin

INTERNAL USE ONLY

close() - Method in class com.testoptimal.plugin.RestPlugin

INTERNAL USE ONLY

close() - Method in class com.testoptimal.plugin.SeleniumPlugin

INTERNAL USE ONLY

close() - Method in class com.testoptimal.plugin.SeqOutPlugin

INTERNAL USE ONLY

close() - Method in class com.testoptimal.plugin.SikuliXPlugin

INTERNAL USE ONLY

close() - Method in class com.testoptimal.plugin.WebDriverPlugin

INTERNAL USE ONLY

close() - Method in class com.testoptimal.plugin.XUIAPlugin

INTERNAL USE ONLY

com.testoptimal.dataset - package com.testoptimal.dataset

com.testoptimal.exception - package com.testoptimal.exception

com.testoptimal.mcase - package com.testoptimal.mcase

com.testoptimal.mscript - package com.testoptimal.mscript

com.testoptimal.page - package com.testoptimal.page

com.testoptimal.plugin - package com.testoptimal.plugin

com.testoptimal.plugin.selenium - package com.testoptimal.plugin.selenium

com.testoptimal.server.model - package com.testoptimal.server.model

connectAndSubscribe() - Method in class com.testoptimal.plugin.MqttPlugin

makes connection to MQTT server and subscribe to the subTopic.

containsText(String) - Method in class com.testoptimal.plugin.selenium.SeleniumAssist

returns true if current window/frame/page contains the text specified (case insensitive).

D

DataMgr - Class in com.testoptimal.dataset

manages data sets instantiated for model execution.

DataMgr(ModelMgr, VirtualUser) - Constructor for class com.testoptimal.dataset.DataMgr

constructor

DataSet - Class in com.testoptimal.dataset

Data Set instantiated at runtime for model execution.

DataSet(String, List<Map<String, Object>>) - Constructor for class com.testoptimal.dataset.DataSet

DataSetDef - Class in com.testoptimal.dataset

dataSetExist(String) - Method in class com.testoptimal.dataset.DataMgr

describe() - Method in class com.testoptimal.dataset.DataSet

returns a string representation of this data set.

dismissAlert() - Method in class com.testoptimal.plugin.selenium.SeleniumAssist

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

doubleClick(By) - Method in class com.testoptimal.plugin.selenium.WebDriverAssist

double click on the first element found.

doubleClick(String) - Method in class com.testoptimal.plugin.XUIAPlugin

double click mouse button using the specified mouse buttons.

doubleClickAt(int, int, String) - Method in class com.testoptimal.plugin.XUIAPlugin

perform double click at the coordinates specified.

dragAndDrop(By, By) - Method in class com.testoptimal.plugin.selenium.WebDriverAssist

drag an element and drop it onto another element.

dragDrop(int, int, int, int, String) - Method in class com.testoptimal.plugin.XUIAPlugin

performs mouse drag and drop from one position to another

E

Element - Class in com.testoptimal.page

Page Element.

Element(String, Object) - Constructor for class com.testoptimal.page.Element

element(String) - Method in class com.testoptimal.page.Page

returns the element for the name specified.

enterInitialState() - Method in class com.testoptimal.plugin.PluginAncestor

entry to the model initial state and final state

enterInitialState() - Method in class com.testoptimal.plugin.SeqOutPlugin

INTERNAL USE ONLY

executeTransition(String) - Method in class com.testoptimal.mcase.MCase

execute the transition from the current state.

executeTransition(String, Closure<Object>) - Method in class com.testoptimal.mcase.MCase

execute the transition from the current state, and execute the function passed in after the default transition TRIGGER has been executed.

exitFinalState() - Method in class com.testoptimal.plugin.PluginAncestor

exitFinalState() - Method in class com.testoptimal.plugin.SeqOutPlugin

INTERNAL USE ONLY

extractFileName(String) - Static method in class com.testoptimal.mscript.Util

extracts the file name from full file path string.

F

find(String) - Method in class com.testoptimal.plugin.SikuliXPlugin

attempts to find the UI element identified by the image passed in.

findState(String) - Method in class com.testoptimal.mscript.Sys

returns the state node.

findTransition(String, String) - Method in class com.testoptimal.mscript.Sys

returns the transition node.

func - Variable in class com.testoptimal.mcase.MStep

G

genData(Strength, String) - Method in class com.testoptimal.dataset.DataSetDef

genMSC(String, String) - Method in class com.testoptimal.mscript.Sys

generate Message Sequence Chart (MSC) from the home/start state to the current state.

genMSC(String, String, String) - Method in class com.testoptimal.mscript.Sys

generate Message Sequence Chart (MSC) from the home/start state to the current state.

genMSC(String, String, String, String) - Method in class com.testoptimal.mscript.Sys

generate Message Sequence Chart (MSC) from the home/start state to the current state.

genPath(String) - Method in class com.testoptimal.mscript.Sys

generate traversal graph from home/start state to the current state.

getActionMap() - Method in class com.testoptimal.page.Element

returns the Map of all actions for the element.

getActionMap() - Method in class com.testoptimal.page.Page

returns the Map of all action functions

getAgentID() - Method in class com.testoptimal.plugin.AgentPlugin

getAlertText() - Method in class com.testoptimal.plugin.selenium.SeleniumAssist

returns the message in the alert pop-up dialog if present.

getAllPluginList() - Static method in class com.testoptimal.plugin.PluginMgr

INTERNAL USE ONLY

getAndroidDriver() - Method in class com.testoptimal.plugin.AppiumPlugin

returns Android webdriver.

getAppiumDriver() - Method in class com.testoptimal.plugin.AppiumPlugin

returns AppiumDriver <WebElement> which is used to interact with web element.

getConnectionOptions() - Method in class com.testoptimal.plugin.MqttPlugin

returns MQTT connection option object to be used to connect to MQTT server.

getCurDataSet() - Method in class com.testoptimal.mscript.Sys

returns the data set assigned to the current state / transition.

getCurrentRowIndex() - Method in class com.testoptimal.dataset.DataSet

returns the current row index.

getCurRow() - Method in class com.testoptimal.dataset.DataSet

returns the current data set row in a Map record.

getCurScreen() - Method in class com.testoptimal.plugin.SikuliXPlugin

returns the current screen.

getCurState() - Method in class com.testoptimal.mscript.Sys

returns current state object

getCurTrans() - Method in class com.testoptimal.mscript.Sys

returns current transition

getCurTravUID() - Method in class com.testoptimal.mscript.Sys

returns the UID of current traversal which can be either a transition or a state.

getData(String) - Method in class com.testoptimal.dataset.DataSet

Returns the data field value for the fieldName_p passed in at current row.

getData(int, String) - Method in class com.testoptimal.dataset.DataSet

Returns the data field at the record number passed in.

getData(String) - Method in class com.testoptimal.mscript.Sys

returns the the data for the field name specified from the dataset assigned to the current state / transition.

getDataMgr() - Method in class com.testoptimal.mscript.Sys

returns DataMgr which manages all data sets created/registered for the model execution.

getDataRows() - Method in class com.testoptimal.dataset.DataSetDef

getDataSet(String) - Method in class com.testoptimal.dataset.DataMgr

returns the data set from the cache.

getDataSet(String) - Method in class com.testoptimal.mscript.Sys

returns the data set that has been created and registered to the model execution.

getDataSetID() - Method in class com.testoptimal.dataset.DataSet

returns the data set id.

getDataSetNames() - Method in class com.testoptimal.dataset.DataMgr

return list of data set names currently registered.

getDataSetRecordList() - Method in class com.testoptimal.dataset.DataSet

return all rows in the dataset in a list.

getDesiredCapabilities() - Method in class com.testoptimal.plugin.SeleniumPlugin

returns the DesiredCapabilities object.

getDriverOptions() - Method in class com.testoptimal.plugin.SeleniumPlugin

returns the browser driver capabilities object.

getDsName() - Method in class com.testoptimal.dataset.DataSetDef

getElementMap() - Method in class com.testoptimal.page.Page

returns the Map of all elements in the page.

getEnvVar(String) - Method in class com.testoptimal.mscript.Sys

Returns the value (String) for the environment variable (global variable in current server).

getExecDir() - Method in class com.testoptimal.mscript.Sys

returns execution director object of current model execution.

getField(String) - Method in class com.testoptimal.dataset.DataSetDef

getField(int) - Method in class com.testoptimal.dataset.DataSetDef

getFieldList() - Method in class com.testoptimal.dataset.DataSetDef

getIOSDriver() - Method in class com.testoptimal.plugin.AppiumPlugin

returns IOS webdriver

getLicEmail() - Static method in class com.testoptimal.mscript.Util

returns the license email

getLocator() - Method in class com.testoptimal.page.Element

getMCaseList() - Method in class com.testoptimal.mcase.MCaseMgr

returns the Map array of all page objects.

getMCaseList(List<String>) - Method in class com.testoptimal.mcase.MCaseMgr

getMCaseMgr() - Method in class com.testoptimal.mscript.Sys

returns MCaseMgr which manages all MCases created/registered for the model execution.

getMessage() - Method in exception com.testoptimal.exception.MBTException

getModelAbsolutePath() - Method in class com.testoptimal.mscript.Sys

returns absolute file path to the model folder

getModelObj() - Method in class com.testoptimal.mscript.Sys

returns model object.

getModelRelativePath() - Method in class com.testoptimal.mscript.Sys

returns relative file path to the model folder

getModelRoot() - Static method in class com.testoptimal.mscript.Util

returns the root file folder that contains models

getName() - Method in class com.testoptimal.mcase.MCase

returns the name of this MCase

getName() - Method in class com.testoptimal.page.Element

returns the element name.

getName() - Method in class com.testoptimal.page.Page

returns the page name.

getOsName() - Static method in class com.testoptimal.mscript.Util

returns OS name of this TestOptimal server.

getOutputFormat() - Method in class com.testoptimal.plugin.SeqOutPlugin

returns the format chosen for the current plugin as specified in Model property dialog.

getOverallStrength() - Method in class com.testoptimal.dataset.DataSetDef

getPageMap() - Method in class com.testoptimal.page.PageMgr

returns the Map array of all page objects.

getPageMgr() - Method in class com.testoptimal.mscript.Sys

returns PageMgr which manages all page objects created/registered for the model execution.

getPathName() - Method in class com.testoptimal.mscript.Sys

set current test path name.

getPixelColor(int, int) - Method in class com.testoptimal.plugin.XUIAPlugin

return the pixel color at the specified coordinates.

getPlugin(String) - Method in class com.testoptimal.plugin.PluginMgr

returns the plugin object.

getPluginClass() - Method in class com.testoptimal.plugin.PluginInfo

getPluginDesc() - Method in class com.testoptimal.plugin.AgentPlugin

getPluginDesc() - Method in class com.testoptimal.plugin.AppiumPlugin

getPluginDesc() - Method in class com.testoptimal.plugin.MqttPlugin

getPluginDesc() - Method in class com.testoptimal.plugin.PluginAncestor

getPluginDesc() - Method in class com.testoptimal.plugin.PluginInfo

getPluginDesc() - Method in class com.testoptimal.plugin.RandPlugin

getPluginDesc() - Method in class com.testoptimal.plugin.RestPlugin

getPluginDesc() - Method in class com.testoptimal.plugin.SeleniumPlugin

getPluginDesc() - Method in class com.testoptimal.plugin.SeqOutPlugin

returns plugin description

getPluginDesc() - Method in class com.testoptimal.plugin.SikuliXPlugin

INTERNAL USE ONLY

getPluginDesc() - Method in class com.testoptimal.plugin.WebDriverPlugin

getPluginDesc() - Method in class com.testoptimal.plugin.XUIAPlugin

INTERNAL USE ONLY

getPluginID() - Method in class com.testoptimal.plugin.AgentPlugin

getPluginID() - Method in class com.testoptimal.plugin.AppiumPlugin

getPluginID() - Method in class com.testoptimal.plugin.MqttPlugin

INTERNAL USE ONLY

getPluginID() - Method in class com.testoptimal.plugin.PluginAncestor

getPluginID() - Method in class com.testoptimal.plugin.PluginInfo

getPluginID() - Method in class com.testoptimal.plugin.RandPlugin

INTERNAL USE ONLY

getPluginID() - Method in class com.testoptimal.plugin.RestPlugin

getPluginID() - Method in class com.testoptimal.plugin.SeleniumPlugin

getPluginID() - Method in class com.testoptimal.plugin.SeqOutPlugin

returns the pluginIDs activated for the model.

getPluginID() - Method in class com.testoptimal.plugin.SikuliXPlugin

INTERNAL USE ONLY

getPluginID() - Method in class com.testoptimal.plugin.WebDriverPlugin

getPluginID() - Method in class com.testoptimal.plugin.XUIAPlugin

INTERNAL USE ONLY

getPluginList() - Method in class com.testoptimal.plugin.PluginMgr

getPort() - Static method in class com.testoptimal.mscript.Util

returns the port number used by this TestOptimal server.

getRemoteWebDriver() - Method in class com.testoptimal.plugin.SeleniumPlugin

cast webdriver into RemoteWebDriver unless its HTMLUnit in which case it returns null.

getRowCount() - Method in class com.testoptimal.dataset.DataSet

returns the row count of the data set.

getRowCount() - Method in class com.testoptimal.dataset.DataSetDef

getServerLogger() - Static method in class com.testoptimal.mscript.Util

returns the server logger object, use it to log messages to ServerLog file.

getServerName() - Static method in class com.testoptimal.mscript.Util

returns current TestOptimal server host name

getStats() - Method in class com.testoptimal.mscript.Sys

returns the model execution stats collection object.

getStepList() - Method in class com.testoptimal.mcase.MCase

getText(int, int, int, int) - Method in class com.testoptimal.plugin.SikuliXPlugin

performs OCR on the region specified.

getThreadID() - Method in class com.testoptimal.mscript.Sys

returns current virtual user (thread) id.

getVars() - Method in class com.testoptimal.mscript.Sys

returns all user variables.

getVersionJava() - Static method in class com.testoptimal.mscript.Util

returns java version number.

getVersionTO() - Static method in class com.testoptimal.mscript.Util

returns version number of TestOptimal release build.

getWebDriver() - Method in class com.testoptimal.plugin.SeleniumPlugin

returns WebDriver object which is used to interact with web element.

getWebDriver() - Method in class com.testoptimal.plugin.WebDriverPlugin

returns the web driver object which is used to interact with AUT.

getWegDriver() - Method in class com.testoptimal.plugin.AppiumPlugin

INTERNAL USE ONLY

given() - Method in class com.testoptimal.plugin.RestPlugin

H

highlightElement(By, String, long) - Method in class com.testoptimal.plugin.selenium.SeleniumAssist

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

I

initialize(MbtScriptExecutor) - Method in class com.testoptimal.plugin.MqttPlugin

INTERNAL USE ONLY

initialize(MbtScriptExecutor) - Method in class com.testoptimal.plugin.SeleniumPlugin

INTERNAL USE ONLY

initialize(MbtScriptExecutor) - Method in class com.testoptimal.plugin.SeqOutPlugin

INTERNAL USE ONLY

initialize(MbtScriptExecutor) - Method in class com.testoptimal.plugin.SikuliXPlugin

INTERNAL USE ONLY

initialize(MbtScriptExecutor) - Method in class com.testoptimal.plugin.WebDriverPlugin

INTERNAL USE ONLY

initialize(MbtScriptExecutor) - Method in class com.testoptimal.plugin.XUIAPlugin

INTERNAL USE ONLY

initPlugins() - Static method in class com.testoptimal.plugin.PluginMgr

INTERNAL USE ONLY

isAlertPresent() - Method in class com.testoptimal.plugin.selenium.SeleniumAssist

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

isAtFirstRow() - Method in class com.testoptimal.dataset.DataSet

returns true if dataset current row is set to the first row.

isAtLastRow() - Method in class com.testoptimal.dataset.DataSet

returns true if data set current row is set at the last row.

isAutoRewind() - Method in class com.testoptimal.dataset.DataSet

returns true if data set should automatically start at the first row when it reaches the end of the dataset.

isModelRunning(String) - Method in class com.testoptimal.mscript.Sys

returns true if the model specified is also running in the same server.

isPluginActivated(String) - Method in class com.testoptimal.plugin.PluginMgr

isPrinted() - Method in exception com.testoptimal.exception.MBTException

isState - Variable in class com.testoptimal.mcase.MStep

isSubModel() - Method in class com.testoptimal.mscript.Sys

if the current model is a sub model.

K

keyDown(String...) - Method in class com.testoptimal.plugin.XUIAPlugin

send a keybord key down event as specified in the key token.

keyUp(String...) - Method in class com.testoptimal.plugin.XUIAPlugin

send a keybord event.

L

listIFrames() - Method in class com.testoptimal.plugin.selenium.SeleniumAssist

returns a list of iframes in current window

log(String) - Method in class com.testoptimal.mscript.Sys

logs a message to MScript log

M

MBTAbort - Class in com.testoptimal.exception

Signal MBT execution abort

MBTAbort(String) - Constructor for class com.testoptimal.exception.MBTAbort

MBTException - Exception in com.testoptimal.exception

MBT execution exception resulted from validation error.

MBTException(String) - Constructor for exception com.testoptimal.exception.MBTException

mbtMode - Variable in class com.testoptimal.server.model.RunRequest

For StateModel execution only.

MCase - Class in com.testoptimal.mcase

MCase - custom test case consists of a serial states and transitions.

MCase(String) - Constructor for class com.testoptimal.mcase.MCase

MCaseMgr - Class in com.testoptimal.mcase

Manages MCase objects.

MCaseMgr() - Constructor for class com.testoptimal.mcase.MCaseMgr

mergeList(List<MBTException>) - Static method in exception com.testoptimal.exception.MBTException

modelName - Variable in class com.testoptimal.server.model.RunRequest

name of the model.

mouseDown(By) - Method in class com.testoptimal.plugin.selenium.WebDriverAssist

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

mouseDown(String) - Method in class com.testoptimal.plugin.XUIAPlugin

send mouse event: mouse down.

mouseMove(int, int) - Method in class com.testoptimal.plugin.XUIAPlugin

Moves mouse pointer to given screen coordinates.

mouseOver(By) - Method in class com.testoptimal.plugin.selenium.WebDriverAssist

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

mouseUp(By) - Method in class com.testoptimal.plugin.selenium.WebDriverAssist

trigger mouse up event on the first element found locator_p.

mouseUp(String) - Method in class com.testoptimal.plugin.XUIAPlugin

send mouse event: mouse up

mouseWheel(String, int) - Method in class com.testoptimal.plugin.XUIAPlugin

Rotates the scroll wheel on wheel-equipped mice.

MqttPlugin - Class in com.testoptimal.plugin

MQTT Plugin provides a set of functions to send and receive message to/from MQTT compliant servers.

MqttPlugin() - Constructor for class com.testoptimal.plugin.MqttPlugin

MScriptInterface - Interface in com.testoptimal.plugin

MScriptInterface.IGNORE_INHERITED_METHOD - Annotation Type in com.testoptimal.plugin

MScriptInterface.NOT_MSCRIPT_METHOD - Annotation Type in com.testoptimal.plugin

MScriptInterface.TO_PLUGIN - Annotation Type in com.testoptimal.plugin

Indicates that the annotated class is a plugin implementation.

MStep - Class in com.testoptimal.mcase

MStep() - Constructor for class com.testoptimal.mcase.MStep

N

naveTo - Variable in class com.testoptimal.mcase.MStep

default to navigate to, if set to false, it will just jump to the target state/trans.

navigateToState(String) - Method in class com.testoptimal.mcase.MCase

navigate from current state to the desired state through the shortest path.

newDataSetListMap(String, List<Map<String, Object>>) - Method in class com.testoptimal.dataset.DataMgr

creates a new dataset with given data list and adds the data set to the data manager.

newDataSetTSV(String, String) - Method in class com.testoptimal.dataset.DataMgr

creates a new dataset from a tab delimited file in model's dataset folder or subfolder.

newInstance() - Method in class com.testoptimal.plugin.PluginInfo

newPlugins(List<String>) - Static method in class com.testoptimal.plugin.PluginMgr

INTERNAL USE ONLY

nextCmd(long) - Method in class com.testoptimal.plugin.AgentPlugin

returns the next cmd sent by the model mscript.

nextRow() - Method in class com.testoptimal.dataset.DataSet

Moves the record position of this data set to the next record by adding the internally maintained integer index attribute by 1.

O

options - Variable in class com.testoptimal.server.model.RunRequest

For StateModel executions: generateOnly: true/false, if true only generate test cases/paths without executing scripts stopMinute: stop condition - stop MBT execution after the specified number of minutes stopTraversal: stop condition - stop MBT execution after the specified number of trasition traversals have been reached stopTransCoveragePct: stop condition - stop MBT execution when the transition coverage has reached the specified percentage stopReqCoveragePct: stop condition - stop MBT execution when the requirement coverage has reached the specified percentage stopAtFinalOnly: stop execution at final states only seqParams: additional sequencer parameters in the format of code=value, separate multiple settings with a semi-colon threadNum: number of threads (virtual users) threadDelay: number of milliseconds to wait between threads, used for load testing to control gradual ramping up load on AUT batchID: batch id (int) to associate this execution to batchGroup: the batch group to associate this execution to seed: int to set the seed to be used by random number generator initScript: groovy script to be executed before model execution.

P

page(String) - Method in class com.testoptimal.mscript.Sys

returns page object for the page name specified.

Page - Class in com.testoptimal.page

Page object.

Page(String) - Constructor for class com.testoptimal.page.Page

page(String) - Method in class com.testoptimal.page.PageMgr

finds and returns the page object

pageCount() - Method in class com.testoptimal.page.PageMgr

returns the count of page objects.

PageMgr - Class in com.testoptimal.page

Manages page objects.

PageMgr() - Constructor for class com.testoptimal.page.PageMgr

perform(Object[]) - Method in class com.testoptimal.mcase.MStep

perform(String, Object[]) - Method in class com.testoptimal.page.Element

calls the element action.

perform(String, Object[]) - Method in class com.testoptimal.page.Page

calls the page action.

PluginAncestor - Class in com.testoptimal.plugin

Abstract class, ancestor of all MBT plugins.

PluginAncestor() - Constructor for class com.testoptimal.plugin.PluginAncestor

PluginInfo - Class in com.testoptimal.plugin

PluginInfo(String, String, Class<?>) - Constructor for class com.testoptimal.plugin.PluginInfo

PluginMgr - Class in com.testoptimal.plugin

PluginMgr() - Constructor for class com.testoptimal.plugin.PluginMgr

INTERNAL USE ONLY

PluginMgr(ModelMgr, MbtScriptExecutor) - Constructor for class com.testoptimal.plugin.PluginMgr

INTERNAL USE ONLY

previousRow() - Method in class com.testoptimal.dataset.DataSet

set current row to the previous row.

R

randBinomial(int, float, int) - Method in class com.testoptimal.plugin.RandPlugin

returns a random number from a Binomial distribution with n and p specified.

randEmail(int, int, String) - Method in class com.testoptimal.plugin.RandPlugin

return an email of the specified length from a list of email domain specified.

randExponential(float, int) - Method in class com.testoptimal.plugin.RandPlugin

returns a random number from an Exponential distribution with lambda specified.

randFromList(String) - Method in class com.testoptimal.plugin.RandPlugin

returns the value for the list of values supplied.

randFromList(String, String) - Method in class com.testoptimal.plugin.RandPlugin

returns the value for the list of values supplied.

randGamma(float, float, int) - Method in class com.testoptimal.plugin.RandPlugin

returns a random number from a Gamma distribution with alpha and lambda specified.

randNormal(float, float, int) - Method in class com.testoptimal.plugin.RandPlugin

returns a random number from a normal (gaussian) distribution with mean and stddev specified.

randNum(int, int) - Method in class com.testoptimal.plugin.RandPlugin

returns a random integer number between startInt_p (inclusive) and endInt_p (exclusive).

randPhone(String) - Method in class com.testoptimal.plugin.RandPlugin

return a phone number of specified pattern.

RandPlugin - Class in com.testoptimal.plugin

Contains a collection of data generation functions to generate various types of test data using pattern and random generator.

RandPlugin() - Constructor for class com.testoptimal.plugin.RandPlugin

randPoisson(float, int) - Method in class com.testoptimal.plugin.RandPlugin

returns a random number from a Poisson distribution with mean specified.

randState() - Method in class com.testoptimal.plugin.RandPlugin

return a US state name.

randStateCode() - Method in class com.testoptimal.plugin.RandPlugin

return a US state code.

randStreetAddr() - Method in class com.testoptimal.plugin.RandPlugin

return a street address.

randString(String) - Method in class com.testoptimal.plugin.RandPlugin

generate a random string using the pattern specified.

randString(int, int) - Method in class com.testoptimal.plugin.RandPlugin

generate a random alphanumeric (a-z, A-Z, 0-9) string with length between the ranges specified.

randWord(int, int, String) - Method in class com.testoptimal.plugin.RandPlugin

generate a random word with option of uppercase, lowercase or uppercase on a specific char.

randWordList(int, int, int) - Method in class com.testoptimal.plugin.RandPlugin

returns a list of words with each word in the specified range in length separated by space.

randZip() - Method in class com.testoptimal.plugin.RandPlugin

return a us zip code between 00000 - 99999.

randZipPlus4() - Method in class com.testoptimal.plugin.RandPlugin

return a US ZIP+4

readDataSetDef(String, String, String, String) - Static method in class com.testoptimal.dataset.DataSetDef

readIndexMap(String, String) - Method in class com.testoptimal.mscript.Sys

reads a tab delimited file from model's report folder and index it on the specified column for quick access.

readTSV(String) - Method in class com.testoptimal.mscript.Sys

reads a tab delimited file from model's dataset folder.

regenData() - Method in class com.testoptimal.dataset.DataSetDef

regenerate data and save them with this dataset

RestPlugin - Class in com.testoptimal.plugin

remote agent plugin to allow external application to communicate with the model running on TestOptimal server to perform AUT testing.

RestPlugin() - Constructor for class com.testoptimal.plugin.RestPlugin

rewind() - Method in class com.testoptimal.dataset.DataSet

Resets the current row number of this data set to 0.

rightClick(By) - Method in class com.testoptimal.plugin.selenium.WebDriverAssist

rightClick on the first element found with locator_p.

runJS(String) - Method in class com.testoptimal.plugin.selenium.SeleniumAssist

executes javascript on current window/frame.

RunRequest - Class in com.testoptimal.server.model

RunRequest(String) - Constructor for class com.testoptimal.server.model.RunRequest

RunRequest() - Constructor for class com.testoptimal.server.model.RunRequest

S

saveDS(String) - Method in class com.testoptimal.dataset.DataSetDef

saveTestOutput(String) - Method in class com.testoptimal.mscript.Sys

saves the test output accumulated during model execution to a file.

scrollBy(int, int) - Method in class com.testoptimal.plugin.selenium.SeleniumAssist

scrolls window by the x and y pixels specified.

scrollTo(int, int) - Method in class com.testoptimal.plugin.selenium.SeleniumAssist

scrolls window to the x,y coordinates specified.

selectMonitor(int) - Method in class com.testoptimal.plugin.SikuliXPlugin

set the specified monitor to be the current monitor

selectOptionByIndex(By, int) - Method in class com.testoptimal.plugin.selenium.SeleniumAssist

selects an option for the Select element by option index (0-based).

selectOptionByText(By, String) - Method in class com.testoptimal.plugin.selenium.SeleniumAssist

selects an option for the Select element by matching the option display text.

selectOptionByValue(By, String) - Method in class com.testoptimal.plugin.selenium.SeleniumAssist

selects an option for the Select element by matching the value attribute.

selectWindowByIndex(int) - Method in class com.testoptimal.plugin.selenium.SeleniumAssist

SeleniumAssist - Class in com.testoptimal.plugin.selenium

Collection of a set of assistance functions to handle some complex UI actions.

SeleniumAssist(WebDriver, MbtScriptExecutor) - Constructor for class com.testoptimal.plugin.selenium.SeleniumAssist

SeleniumPlugin - Class in com.testoptimal.plugin

Selenium plugin provides a set of MScript functions to suplement Selenium/WebDriver to test web applications using various browsers of choice.

SeleniumPlugin() - Constructor for class com.testoptimal.plugin.SeleniumPlugin

SeleniumPlugin.BrowserType - Enum in com.testoptimal.plugin

sendBytes(byte[]) - Method in class com.testoptimal.plugin.MqttPlugin

sends a message.

sendKey(By, String) - Method in class com.testoptimal.plugin.selenium.SeleniumAssist

type the string to the first element found with locator_p.

sendKey(String...) - Method in class com.testoptimal.plugin.XUIAPlugin

send a keybord event.

sendReceive(Object, long) - Method in class com.testoptimal.plugin.AgentPlugin

sends a command to remote agent.

sendReceiveBytes(byte[], long) - Method in class com.testoptimal.plugin.MqttPlugin

sends a byte[] message, wait for the result and return the results.

sendReceiveString(String, long) - Method in class com.testoptimal.plugin.MqttPlugin

sends a message, wait for the result and return the results.

sendString(String) - Method in class com.testoptimal.plugin.MqttPlugin

sends a message.

SeqOutPlugin - Class in com.testoptimal.plugin

provides mscript functions to output test sequences.

SeqOutPlugin() - Constructor for class com.testoptimal.plugin.SeqOutPlugin

setAgentID(String) - Method in class com.testoptimal.plugin.AgentPlugin

setAppiumSvrURL(String) - Method in class com.testoptimal.plugin.AppiumPlugin

sets Appium server url.

setAsyncTransThreadPoolSize(int) - Method in class com.testoptimal.mscript.Sys

overrides the default AsyncTransThreadPoolSize setting from config.properties.

setAutoConnect(boolean) - Method in class com.testoptimal.plugin.MqttPlugin

sets plugin to automatically makes connection to MQTT server on starting.

setAutoRewind(boolean) - Method in class com.testoptimal.dataset.DataSet

setAutPath(String) - Method in class com.testoptimal.plugin.AppiumPlugin

sets path to the AUT.

setBrowser(String) - Method in class com.testoptimal.plugin.SeleniumPlugin

sets browser type to test AUT.

setBrowserChrome() - Method in class com.testoptimal.plugin.SeleniumPlugin

setBrowserEdge() - Method in class com.testoptimal.plugin.SeleniumPlugin

setBrowserFirefox() - Method in class com.testoptimal.plugin.SeleniumPlugin

setBrowserHtmlunit() - Method in class com.testoptimal.plugin.SeleniumPlugin

setBrowserIE() - Method in class com.testoptimal.plugin.SeleniumPlugin

changes the browser to be used for execution.

setBrowserOpera() - Method in class com.testoptimal.plugin.SeleniumPlugin

setBrowserSafari() - Method in class com.testoptimal.plugin.SeleniumPlugin

setCheckbox(By, boolean) - Method in class com.testoptimal.plugin.selenium.SeleniumAssist

sets the checkbox.

setCmdTimeoutMillis(long) - Method in class com.testoptimal.plugin.AgentPlugin

setCurTransSatisfyingHint(String) - Method in class com.testoptimal.mscript.Sys

change the current transition's satisfying hint at runtime.

setDoubleClickMillis(int) - Method in class com.testoptimal.plugin.XUIAPlugin

sets the pause time between clicks for double click action.

setDsName(String) - Method in class com.testoptimal.dataset.DataSetDef

setEnvVar(String, String) - Method in class com.testoptimal.mscript.Sys

Set environment variable to the specified value - String only.

setImplicitWait(long) - Method in class com.testoptimal.plugin.selenium.SeleniumAssist

sets the implicitWait parameter for WebDriver.

setImplicitWait(long) - Method in class com.testoptimal.plugin.selenium.WebDriverAssist

sets implicit wait in milliseconds.

setMaxAsyncTrans(int) - Method in class com.testoptimal.mscript.Sys

overrides the default MaxAsyncTrans setting from config.properties.

setMessage(String) - Method in exception com.testoptimal.exception.MBTException

setMinSimilarity(float) - Method in class com.testoptimal.plugin.SikuliXPlugin

sets the sensitivity for matching the image.

setOCR(String) - Method in class com.testoptimal.plugin.SikuliXPlugin

turns on or off OCR feature.

setOutputFileJson(String) - Method in class com.testoptimal.plugin.SeqOutPlugin

sets the output file name and file format to json file.

setOutputFileTSV(String) - Method in class com.testoptimal.plugin.SeqOutPlugin

sets the output file name and file format to tab separated file.

setOutputFileTSV2(String) - Method in class com.testoptimal.plugin.SeqOutPlugin

sets the output file name and file format to tab separated file with model information added as a comment.

setOutputFileTXT(String) - Method in class com.testoptimal.plugin.SeqOutPlugin

sets the output file name and file format to text file.

setOutputFileXLS(String) - Method in class com.testoptimal.plugin.SeqOutPlugin

sets the output file name and file format to Excel xls file.

setPathFlag(String) - Method in class com.testoptimal.plugin.SeqOutPlugin

either to prevent the current test case (path) from being removed as duplicates or forces the current test case (path) to be removed.

setPathName(String) - Method in class com.testoptimal.mscript.Sys

returns current test path name.

setPlatformAndroid() - Method in class com.testoptimal.plugin.AppiumPlugin

setPlatformIpad() - Method in class com.testoptimal.plugin.AppiumPlugin

setPlatformIphone() - Method in class com.testoptimal.plugin.AppiumPlugin

setPrinted() - Method in exception com.testoptimal.exception.MBTException

setRequiredOptions(String, String, String, int, String, int) - Method in class com.testoptimal.plugin.MqttPlugin

setResult(Object) - Method in class com.testoptimal.plugin.AgentPlugin

INTERNAL USE ONLY

setResultTimeoutMillis(long) - Method in class com.testoptimal.plugin.AgentPlugin

setResultTimeoutMillis(long) - Method in class com.testoptimal.plugin.MqttPlugin

timeout in milliseconds to wait for the result response from the client.

setRowIndex(int) - Method in class com.testoptimal.dataset.DataSet

Returns true if the record can be set to the rowNum_p passed in.

setRowIndexRandom(float) - Method in class com.testoptimal.dataset.DataSet

moves the data set to a row randomly selected.

setSearchRegion(int, int, int, int) - Method in class com.testoptimal.plugin.SikuliXPlugin

sets the screen region on the current screen to limit Siklul's search spacce for better performance.

setSeed(String) - Method in class com.testoptimal.mscript.Sys

initialize random number generator used by the sequencer to the specific seed.

setSysProp(String, String) - Method in class com.testoptimal.plugin.SeleniumPlugin

sets System properties before browser webdriver connection is established.

setTransGuardHint(String) - Method in class com.testoptimal.mscript.Sys

change the current transition's guard hint at runtime.

setUsernamePassword(String, String) - Method in class com.testoptimal.plugin.MqttPlugin

sets user name and password to be used to connect to MQTT.

setWebDriver(RemoteWebDriver) - Method in class com.testoptimal.plugin.SeleniumPlugin

sets webDriver to be used for automation.

setWebDriver(RemoteWebDriver) - Method in class com.testoptimal.plugin.WebDriverPlugin

sets the remote web driver object to be used for interacting with AUT through RemoteWebDriver.

setWindowSize(int, int) - Method in class com.testoptimal.plugin.selenium.SeleniumAssist

sets the browser window size to the specified dimension: width and height.

shuffleRows() - Method in class com.testoptimal.dataset.DataSet

randomize the rows in the dataset.

shutdown() - Static method in class com.testoptimal.plugin.SeqOutPlugin

INTERNAL USE ONLY

SikuliXPlugin - Class in com.testoptimal.plugin

Sikulix (beta) plugin provides a set of mscript functions to perform image based automation using SikuliX (SikuliX).

SikuliXPlugin() - Constructor for class com.testoptimal.plugin.SikuliXPlugin

skipToState(String) - Method in class com.testoptimal.mcase.MCase

from current state jump/skip to the desired state without actually traversing/executing any state/trans.

snapScreen() - Method in class com.testoptimal.plugin.selenium.WebDriverAssist

Take a snapshot of current AUT window.

snapScreen(String) - Method in class com.testoptimal.plugin.SeleniumPlugin

Take a snapshot of current AUT window.

snapScreen(String) - Method in class com.testoptimal.plugin.SikuliXPlugin

takes a screen shot and saves it to the file specified.

snapScreen(int, int, int, int, String) - Method in class com.testoptimal.plugin.SikuliXPlugin

takes a screen shot of the specified region on the current screen/monitor and saves it to the file specified.

snapScreen(int, int, int, int) - Method in class com.testoptimal.plugin.XUIAPlugin

takes a snapshot of the specified rectangle region of the window screen.

snapScreen() - Method in class com.testoptimal.plugin.XUIAPlugin

takes a fullscreen snapshot of the window screen.

soundAlike(String, String) - Static method in class com.testoptimal.mscript.Util

returns true if two strings sound like each other.

soundAlike(String, String, String) - Static method in class com.testoptimal.mscript.Util

returns true if two strings sound alike with the degree of similarity specified.

spellAlike(String, String, String) - Static method in class com.testoptimal.mscript.Util

returns true if two strings are spelled alike with up to specified degree of differences allowed.

spellAlike(String, String) - Static method in class com.testoptimal.mscript.Util

returns true if two strings are spelled alike with up to specified degree of differences allowed.

splitStep() - Method in class com.testoptimal.plugin.SeqOutPlugin

to have each step instruction to be written to excel in a separate row.

start() - Method in class com.testoptimal.plugin.AgentPlugin

INTERNAL USE ONLY

start() - Method in class com.testoptimal.plugin.AppiumPlugin

INTERNAL USE ONLY

start() - Method in class com.testoptimal.plugin.MqttPlugin

Internal use, called when model execution starts (after MBT_Start trigger).

start() - Method in class com.testoptimal.plugin.PluginAncestor

INTERNAL USE ONLY.

start() - Method in class com.testoptimal.plugin.PluginMgr

INTERNAL USE ONLY

start() - Method in class com.testoptimal.plugin.RandPlugin

INTERNAL USE ONLY

start() - Method in class com.testoptimal.plugin.RestPlugin

INTERNAL USE ONLY

start() - Method in class com.testoptimal.plugin.SeleniumPlugin

INTERNAL USE ONLY

start() - Method in class com.testoptimal.plugin.SeqOutPlugin

INTERNAL USE ONLY

start() - Method in class com.testoptimal.plugin.SikuliXPlugin

INTERNAL USE ONLY

start() - Method in class com.testoptimal.plugin.WebDriverPlugin

INTERNAL USE ONLY

start() - Method in class com.testoptimal.plugin.XUIAPlugin

INTERNAL USE ONLY

startPath() - Method in class com.testoptimal.plugin.SeqOutPlugin

start a new test case/path.

startStep() - Method in class com.testoptimal.plugin.SeqOutPlugin

Starting a new test step in the current test case.

statDesc - Variable in class com.testoptimal.server.model.RunRequest

submitModelExec(String, String) - Static method in class com.testoptimal.mscript.Util

submits a model for execution on a runtime server managed by the SvrMgr configured in the current TestOptimal server.

submitModelExec(RunRequest) - Static method in class com.testoptimal.mscript.Util

submits a model for execution on a runtime server managed by the SvrMgr configured in the current TestOptimal server.

Sys - Class in com.testoptimal.mscript

Provides system functions for MScript.

Sys(MbtScriptExecutor) - Constructor for class com.testoptimal.mscript.Sys

INTERNAL USE ONLY

T

toID - Variable in class com.testoptimal.mcase.MStep

trace() - Method in class com.testoptimal.mscript.Sys

returns the trace in a string of the traversals separated by comma leading up to the current state/transition.

trace(int, String) - Method in class com.testoptimal.mscript.Sys

returns the trace in a string of last maxLogCount_p traversals leading up to the current state/transition.

type(By, String, String) - Method in class com.testoptimal.plugin.selenium.SeleniumAssist

type the string to the first element found with locator_p with the option to have shift/control/alt key pressed.

type(String) - Method in class com.testoptimal.plugin.XUIAPlugin

type a text string or a single function key.

typeWithModifier(String, String) - Method in class com.testoptimal.plugin.XUIAPlugin

type a text string into current UI element while holding down modifier keys specified.

U

Util - Class in com.testoptimal.mscript

Util() - Constructor for class com.testoptimal.mscript.Util

V

valueOf(String) - Static method in enum com.testoptimal.plugin.SeleniumPlugin.BrowserType

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.testoptimal.plugin.SeleniumPlugin.BrowserType

Returns an array containing the constants of this enum type, in the order they are declared.

W

waitFor(String, int) - Method in class com.testoptimal.plugin.SikuliXPlugin

wait for the UI element up to the timeout in milliseconds.

waitForElement(By, long) - Method in class com.testoptimal.plugin.selenium.WebDriverAssist

waits for an element to be visible up to the specified timeout in milliseconds.

waitForElementAttr(By, String, String, long) - Method in class com.testoptimal.plugin.selenium.WebDriverAssist

waits for an attribute to contain the specified value on the element.

waitForElementEnabled(By, long) - Method in class com.testoptimal.plugin.selenium.WebDriverAssist

waits for the specified element to be enabled.

waitForElementText(By, String, long) - Method in class com.testoptimal.plugin.selenium.WebDriverAssist

waits for the element up to contain the expected text.

waitForVanish(String, int) - Method in class com.testoptimal.plugin.SikuliXPlugin

wait for the UI element to vanish/disappear from the screen, up to the timeout in milliseconds specified.

waitUntil(String, long, Object...) - Method in class com.testoptimal.page.Element

wait until the action specified evaluates to boolean true or does not generate runtime error (like element not found) or until times out.

WebDriverAssist - Class in com.testoptimal.plugin.selenium

Collection of a set of assistance functions to handle some complex UI actions.

WebDriverAssist(WebDriver, MbtScriptExecutor) - Constructor for class com.testoptimal.plugin.selenium.WebDriverAssist

WebDriverPlugin - Class in com.testoptimal.plugin

WebDriver plugin provides the capability to test windows UI applications through Seelnium/WebDriver.

WebDriverPlugin() - Constructor for class com.testoptimal.plugin.WebDriverPlugin

when() - Method in class com.testoptimal.plugin.RestPlugin

writeSetup(String) - Method in class com.testoptimal.plugin.SeqOutPlugin

writes the suite setup instruction (PreAmble for entire test suite).

writeStepAction(String) - Method in class com.testoptimal.plugin.SeqOutPlugin

writes a step instruction to test case report/dataset.

writeStepAssert(String, String, String) - Method in class com.testoptimal.plugin.SeqOutPlugin

writes an assert instruction to test case report/dataset.

writeStepPrep(String) - Method in class com.testoptimal.plugin.SeqOutPlugin

writes a step instruction to test case report.

writeSuiteSetup(String) - Method in class com.testoptimal.plugin.SeqOutPlugin

adds the message to the test case setup instructions.

writeSuiteTeardown(String) - Method in class com.testoptimal.plugin.SeqOutPlugin

adds the message to the test case teardown instructions.

writeTeardown(String) - Method in class com.testoptimal.plugin.SeqOutPlugin

writes the suite tear down instruction (PostAmble for entire test suite).

X

XUIAPlugin - Class in com.testoptimal.plugin

UIA Plugin provides a set of MScript function to automate keyboard and mouse actions.

XUIAPlugin() - Constructor for class com.testoptimal.plugin.XUIAPlugin

A C D E F G H I K L M N O P R S T U V W X