Alphabetic (Master) Listing of All Commands
| A | B | C | D | E | F | G | H | I | J | K | L | M | N | O | P | Q | R | S | T | U | V | W | X | Y | Z |
If you already know the specific commands you want to use within your automated tests but want to know more about those commands, then you can use this article. Just click on the alphabet your command starts with and find and click on the hyperlinked command name in the grid that corresponds to the alphabet of interest.
If you know the specific UI element (form control) that you trying to develop automation against (or attempting to debug/fix an issue you are facing) and you either do not know which Worksoft SaaS commands to use OR want to look for better alternatives to the Worksoft SaaS command that is currently used within your automated tests, you can access another article that lists commands by User Interface (UI) element.
A
| Command | Purpose |
|---|---|
| addLocationStrategy | Defines a new function to locate elements on the page. For example, if you define the strategy "foo", and someone runs click("foo=blah"), we'll run your function, passing you the string "blah", and click on the element that your function returns, or throw an "Element not found" error if your function returns null. We'll pass three arguments to your function: locator: the string the user passed in inWindow: the currently selected window inDocument: the currently selected document |
| addLocationStrategyAndWait | Defines a new function to locate elements on the page. For example, if you define the strategy "foo", and someone runs click("foo=blah"), we'll run your function, passing you the string "blah", and click on the element that your function returns, or throw an "Element not found" error if your function returns null. We'll pass three arguments to your function: locator: the string the user passed in inWindow: the currently selected window inDocument: the currently selected document |
| addScript | This command loads script content into a new script tag. This differs from the runScript command in that runScript adds the script tag to the document of the AUT. The following entities in the script content are replaced by the characters they represent: < > & The corresponding remove command is removeScript. |
| addScriptAndWait | This command loads script content into a new script tag. This differs from the runScript command in that runScript adds the script tag to the document of the AUT. The following entities in the script content are replaced by the characters they represent: < > & The corresponding remove command is removeScript. |
| addSelection | This command adds a selection to the set of selected options in a multi-select element using an option locator. |
| addSelectionAndWait | This command adds a selection to the set of selected options in a multi-select element using an option locator. |
| allowNativeXpath | Specifies whether Selenium should use the native in-browser implementation of XPath (if any native version is available); if you pass "false" to this function, we will always use our pure-JavaScript xpath library. Using the pure-JS xpath library can improve the consistency of xpath element locators between different browser vendors, but the pure-JS version is much slower than the native implementations. |
| allowNativeXpathAndWait | Specifies whether Selenium should use the native in-browser implementation of XPath (if any native version is available); if you pass "false" to this function, we will always use our pure-JavaScript XPath library. Using the pure-JS XPath library can improve the consistency of XPath element locators between different browser vendors, but the pure-JS version is much slower than the native implementations. |
| altKeyDown | Press the alt key and hold it down until doAltUp() is called or a new page is loaded. |
| altKeyDownAndWait | Generated from altKeyDown() Press the alt key and hold it down until doAltUp() is called or a new page is loaded. |
| altKeyUp | Release the alt key. |
| altKeyUpAndWait | This command is used to release the alt key. |
| angularRotate | Rotates the mobile in three dimensions. |
| answerOnNextPrompt | Instructs to return the specified answer string in response to the next JavaScript prompt [window.prompt()]. |
| assertAlert | This command is used to check if the application under test (AUT) has thrown an alert with the text supplied (in the Target field) and then accept it. If no alert is shown by the application, the command fails and the execution of the test is stopped.. |
| assertAlertPresent | This command is used to check if the application under test(AUT) has thrown an alert with the text supplied(in the Target field) and then accept it. The command will be executed without any error if there is any alert message present on web application page, else the command fails and the execution of the test is stopped. |
| assertAlertNotPresent | Has an alert occurred? This function never throws an exception. |
| assertAllButtons | Generated from getAllButtons(). If a given button has no ID, it will appear as "" in this array. |
| assertAllFields | If a given field has no ID, it will appear as "" in this array. |
| assertAllLinks | If a given link has no ID, it will appear as "" in this array. |
| assertAllWindowNames | Names of all windows that the browser knows about. |
| assertAllWindowTitles | Titles of all windows that the browser knows about. |
| assertAttribute | Gets the value of an element attribute. The value of the attribute may differ across browsers (this is the case for the 'style' attribute, for example). |
| assertAttribute | Generated from getBackgroundPosition(locator). Retrieves the CSS background-position attribute value applied to that element. |
| assertBackgroundColor | Retrieves the css background-color attribute value applied to that element |
| assertBackgroundImage | Retrieves the css background-image attribute value applied to that element. |
| assertBackgroundPosition | Generated from getBackgroundPosition(locator). Retrieves the CSS background-position attribute value applied to that element. |
| assertBackgroundRepeat | Generated from getBackgroundRepeat(locator). Retrieves the CSS background-repeat attribute value applied to that element. |
| assertBodyText | Generated from getBodyText(). This command is used to get the entire text in the body tag, of the webpage. |
| assertBorderColor | Retrieves the CSS border-color attribute value applied to that element. |
| assertBorderRadius | Generated from getBorderRadius(locator) Retrieves the CSS border-radius attribute value applied to that element |
| assertBorderStyle | Generated from getBorderStyle(locator) Retrieves the CSS border style attribute value applied to that element. |
| assertBorderWidth | Generated from getBorderWidth(locator) Retrieves the CSS border-width attribute value applied to that element |
| assertChecked | Gets whether a toggle-button (checkbox/radio) is checked. Fails if the specified element doesn't exist or isn't a toggle-button. |
| assertColor | Retrieves the css color attribute value applied to that element |
| assertConfirmation | Retrieves the message of a JavaScript confirmation dialog generated during the previous action. By default, the confirm function will return true, having the same effect as manually clicking OK. This can be changed by prior execution of the chooseCancelOnNextConfirmation command. If an confirmation is generated but you do not consume it with getConfirmation, the next QaSCRIBE action will fail. NOTE: under QaSCRIBE, JavaScript confirmations will NOT pop up a visible dialog. NOTE: QaSCRIBE does NOT support JavaScript confirmations that are generated in a page's onload() event handler. In this case a visible dialog WILL be generated and QaSCRIBE will hang until you manually click OK. |
| assertContentDescription | Verifies the content-desc pattern of an element. Stops the execution if pattern did not match. |
| assertCookie | Generated from getCookie() Return all cookies of the current page under test. |
| assertCookieByName | Generated from getCookieByName(name) >If the cookie is present it returns the value of the cookie with the specified name. |
| assertCookieNotPresent | Generated from isCookieNotPresent(name) Cheks whether the cookie is not present or not. |
| assertCookiePresent | Generated from isCookiePresent(name) Checks whether the cookie is present or not. |
| assertCurrentActivity | Verifies current activity's details. This command is supported only for Android Devices. On failure, execution stops. |
| assertCurrentPackage | Verifies current package's details. This command stops the execution if the package name doesn't match.This command is supported only for Android Devices. |
| assertDeviceSettings | Verifies the current settings on the device. On failure, the execution stops. |
| assertEditable | Determines whether the specified input element is editable, ie hasn't been disabled. This method will fail if the specified element isn't an input element. |
| assertElementLocation | Verifies the location of an element. Stops the execution if pattern did not match. |
| assertElementSize | Verifies the Size of an element. Stops the execution if pattern did not match. |
| assertElementNotPresent | Generated from isElementNotPresent(locator) It will check whether the element is present or not and returns corresponding boolean value. |
| assertElementPresent | Generated from isElementPresent(locator) his command will check whether the particular element is present or not. |
| assertEval | Generated from getEval(script) script - the JavaScript snippet to run It will check whether the script is present or not. |
| assertExpression | This command is useful for JavaScript preprocessing. It compares two expressions and returns the value whether it is true or false. If the pattern does not match with the pattern which we get from the UI, it aborts the execution. |
| assertFontFamily | This command is useful for verifying the css font-family attribute value applied to that element. If the pattern does not match with the pattern which we get from the UI, it aborts the execution. |
| assertFontSize | This command is useful for verifying the css font-size attribute value applied to that element. If the value does not match with the attribute value which we get from the UI, it aborts the execution. |
| assertFontStyle | This command is useful for retrieving the css font-style attribute value applied to that element and asserts the value. If the value does not match with the attribute value which we get from the UI, it aborts the execution. |
| assertFontWeight | This command is useful for retrieving the css font-weight attribute value applied to that element and asserts the value. If the value does not match with the attribute value which we get from the UI, it aborts the execution. |
| assertKeyboardVisible | Pass, if the keyboard is visible else fail. Execution stops if the command fails. |
| assertLocation | This command is useful for verifying the absolute URL of the current page. |
| assertNotAllButtons | This command is used to verify the ID's of all buttons given are not present on the web page. If there are any buttons of the specified ID's present on the UI, it aborts the execution. |
| assertNotAllFields | This command is used to verify the ID's of all fileds given are not present on the web page. If there are any ID's of the fields present on the UI, it aborts the execution. |
| assertNotAllLinks | This command is used to verify the ID's of all links given are not present on the web page. If there are any links present on the UI, it aborts the execution. |
| assertNotAttribute | This command checkes for the specified attribute of an element. Here the specified attribute should not be present. If the attribute is present on the UI this coomand returns that particular attribute value and aborts the execution. |
| assertNotChecked | This command checkes for the checkbox/radio button is checked or not on the UI. If the checkbox/radio button is checked on the UI, the execution gets aborted. |
| assertNotColor | This command is used to verify the css color of an element applied is not equals to given value. It gives the color in rgb format.If the specifed rgb format is present on the UI, the execution gets aborted. It checks for the color code which is not be present. |
| assertNotConfirmation | This command checks for the JavaScript confirmation dialogs. Pass if there is no JavaScript confirmation dialog generated during the previous action. By default, the confirm function will return true, having the same effect as manually clicking OK. This can be changed by prior execution of the chooseCancelOnNextConfirmation command. |
| assertNotCookie | This command verifies all cookies of the current page under test. There should not be any cookies present under the test. If there are any, the execution gets aborted. |
| assertNotCookieByName | This command verifies the value of the cookie with the specified name given is not present under test.. If there are any specified cookies present, the execution gets aborted. |
| assertNotCursorPosition | This command retrieves the text cursor position in the given input element or text area; beware, this may not work perfectly on all browsers. Specifically, if the cursor/selection has been cleared by JavaScript, this command will tend to return the position of the last location of the cursor, even though the cursor is now gone from the page. This is filed as SEL-243. This method will fail if the specified element isn't an input element or text area, or there is no cursor in the element. |
| assertNotCurrentActivity | Verifies current activity's details and stops execution if the command fails. This command fails if activity name matches.This command is supported only for Android Devices. |
| assertNotCurrentPackage | Verifies current package's details. This command stops the execution if the package name matches.This command is supported only for Android Devices. |
| assertNotDisplay | Generated from getDisplay(locator) Retrieves the CSS display attribute value applied to that element and passes if contents of the display attribute do not match. |
| assertNotDeviceSettings | Verifies the current settings on the device. This command passes when the actual settings and settings mentioned on target do not match. On failure, it stops the command execution. |
| assertNotEditable | It checkes for the specified input element is not editable, ie has been disabled. If the element is not disabled, the execution gets aborted. |
| assertNotElementHeight | This command retrieves the height of an element, passes if the height does not match. |
| assertNotElementIndex | Get the relative index of an element to its parent (starting from 0). The comment node and empty text node will be ignored. This command passes when the index to be verified does not match. |
| assertNotElementPositionLeft | Asserts the horizontal position of an element but fails if the position is true. |
| assertNotElementPositionTop | This command asserts the vertical position of an element but fails if the position is true. |
| assertNotElementWidth | Retrieves the width of an element, passes if the width to be verified does not match the actual width. |
| assertNotEval | This command is used to verify the result of specified JavaScript snippet doesnot match with given value. The snippet may have multiple lines, but the result of the last line will be returned. |
| assertNotExpression | This is useful because of JavaScript preprocessing. It is used to generate commands like assertExpression and waitForExpression. It returns true if the target is not an expression. |
| assertNotFloat | Generated from getFloat(locator) This command retrieves the CSS float attribute value applied to that element, this command passes when the pattern value doesn't match the actual value. |
| assertNotFontFamily | Generated from getFontFamily(locator). Retrieves the CSS font-family attribute value applied to that element. It returns true if the font-style of text at the locator provided in the target is not the same as the value. |
| assertNotFontSize | Generated from getFontSize(locator). Retrieves the CSS font-size attribute value applied to that element It returns true if the font size of text at the locator provided the target is not the same as the value. |
| assertNotFontStyle | Generated from getFontStyle(locator) Retrieves the CSS font-style attribute value applied to that element. It returns true if the font-style of text at the locator in the target is not the same as the value. |
| assertNotFontWeight | It returns true if the font weight of text at the locator in target is not the same in the value. |
| assertNotHeight | Generated from getHeight(locator). Retrieves the CSS height attribute value applied to that element It returns true if the height of element at the locator in target is not the same in the value. |
| assertNotHtmlSource | Generated from getHtmlSource() This command returns the entire HTML source between the opening and closing 'HTML' tags, this commands passes when the contents of the pattern do not match the actual value. |
| assertNotKeyboardVisible | Fails, if the keyboard is visible else pass. Execution stops if the command fails. |
| assertNotLocation | This command is used to verify the absolute URL of the current page doesnot match with the specified URL. If the given URL matches with current web page URL, the execution will get aborted. |
| assertNotMarginBottom | Generated from getMarginBottom(locator) This command retrieves the CSS margin-bottom attribute value applied to that element. |
| assertNotMarginLeft | Generated from getMarginLeft(locator) Retrieves the CSS margin-left attribute value applied to that element. |
| assertNotMarginRight | Generated from getMarginRight(locator) Retrieves the CSS margin-right attribute value applied to that element. |
| assertNotMarginTop | Generated from getMarginTop(locator) Retrieves the CSS margin-top attribute value applied to that element. |
| assertNotMouseSpeed | Generated from getMouseSpeed() This command returns the number of pixels between \"mousemove\" events during dragAndDrop commands (default=10). |
| assertNotOpacity | Generated from getOpacity(locator) This command retrieves the CSS opacity attribute value applied to that element. |
| assertNotOverflow | Generated from getOverflow(locator) This command retrieves the CSS overflow attribute value applied to that element |
| assertNotPaddingBottom | Generated from getPaddingBottom(locator) This command retrieves the CSS padding-bottom attribute value applied to that element |
| assertNotPaddingLeft | Generated from getPaddingLeft(locator) Retrieves the CSS padding-left attribute value applied to that element |
| assertNotPaddingRight | Generated from getPaddingRight(locator) Retrieves the CSS padding-right attribute value applied to that element |
| assertNotPaddingTop | Generated from getPaddingTop(locator) Retrieves the CSS padding-top attribute value applied to that element |
| assertNotPosition | Generated from getPosition(locator) This command retrieves the CSS position attribute value applied to that element |
| assertNotPrompt | Generated from getPrompt() Successful handling of the prompt requires prior execution of the answerOnNextPrompt command. If a prompt is generated but you do not get/verify it, the next Selenium action will pass. |
| assertNotRandomNumber | Generated from getRandomNumber(Integer) This command is used to generate(verify) random Number with a specified length. assertNotRandomNumber(Integer, pattern) |
| assertNotSelectedId | Gets option element ID for selected option in the specified select element. It returns true when the selected ID(in Target) is not same as the value. |
| assertNotSelectedIds | Gets all option element IDs for selected options in the specified select or multi-select element. It returns true when the IDs(in Target) is not same as the value. |
| assertNotSelectedIndex | This command gets option index (option number, starting at 0) for selected option in the specified select element. It returns true when the index of the selected item in the Drop-Down menu (in Target) is not same as the value. |
| assertNotSelectedIndexes | This command gets all option indexes (option number, starting at 0) for selected options in the specified select or multi-select element. It returns true when the indexes of the items in the Drop-Down menu (in Target) is not same as the value. |
| assertNotPerformanceData | Verifies the resource usage information of the application. the resource is one of the system states which means CPU Info, Memory Info, Network Info, and Battery Info. This command is supported only for Android Devices. Execution stops if the command fails. This command fails if the value matches. |
| assertNotSelectedLabel | This command is used to verify the label (visible text) for selected option in the specified select element doesn't match with the specified value. |
| assertNotSelectedLabels | This command is used to verify the labels (visible text) for selected options in the specified select dropdown doesn't match with the specified value. |
| assertNotSelectedValue | This command is used to verify the value of value attribute for selected option in the specified select element doesn't match with the specified value. |
| assertNotSelectedValues | Gets all option values (value attributes) for selected options in the specified select or multi-select element. It returns true when the values (attribute) of the elements(in Target) is not same as the value(field). |
| assertNotSelectOptions | Gets all option labels in the specified select drop-down. It returns true when the option labels of the elements(in Target) is not same as the value. |
| assertNotSomethingSelected | This command determines whether some option in a drop-down menu is selected, this command passes when the pattern does not match the actual value. |
| assertNotSpeed | This command is used to verify that the execution speed doesn't match with the speed the execution is currently setup with. |
| assertNotTable | Gets the text from a cell of a table. The cellAddress syntax tableLocator.row.column, where row and column start at 0. |
| assertNotSystemTime | Verifies system's current time with the target. On failure, it stops the execution. This command passes if the time does not match. |
| assertNotText | This command is used to verify the text of an element doesn't match with the specified text. This works for any element that contains text. This command uses either the textContent (Mozilla-like browsers) or the innerText (IE-like browsers) of the element, which is the rendered text shown to the user. |
| assertNotTextAlign | Generated from getTextAlign(locator) This command retrieves the text-align - CSS attribute value applied to that element, the command passes when the pattern and actual value do not match. |
| assertNotTextDecoration | Generated from getTextDecoration(locator) This command retrieves the CSS text-decoration attribute value applied to that element, the command passes when the pattern and actual value do not match. |
| assertNotTextOrientation | Generated from getTextOrientation(locator) This command retrieves the CSS text-orientation attribute value applied to that element, the command passes when the pattern and actual value do not match. |
| assertNotTitle | This command is used to verify the title of the page doesn't match with the given title. If the title matches, the execution gets aborted. |
| assertNotValue | This command is used to verify that the input field doesn't contain the specified value in the page. |
| assertNotVerticalAlign | Generated from getVerticalAlign(locator) This command retrieves the CSS vertical-align attribute value applied to that element, the command passes when the pattern and actual value do not match. |
| assertNotVisible | This command is used to determine if the specified element is not visible on UI. An element can be rendered invisible by setting the CSS "visibility" property to "hidden", or the "display" property to "none", either for the element itself or one if its ancestors. |
| assertNotWidth | Generated from getWidth(locator) This command retrieves the CSS width attribute value applied to that element. |
| assertNotXpathCount | Generated from getXpathCount(XPath) This command returns the number of nodes that match the specified XPath, eg. '//table' would give the number of tables. This command passes when the number of XPaths does not match the actual value |
| assertOpacity | Generated from getOpacity(locator) This command retrieves the CSS opacity attribute value applied to that element. |
| assertOverflow | Generated from getOverflow(locator) Retrieves the CSS overflow attribute value applied to that element. |
| assertPaddingBottom | Generated from getPaddingBottom(locator) Retrieves the CSS padding-bottom attribute value applied to that element. |
| assertPaddingLeft | Generated from getPaddingLeft(locator) Retrieves the CSS padding-left attribute value applied to that element. |
| assertPaddingRight | Generated from getPaddingRight(locator) Retrieves the CSS padding-right attribute value applied to that element. |
| assertPaddingTop | Generated from getPaddingTop (locator) Retrieves the CSS padding-top attribute value applied to that element. |
| assertPaddingTop | Generated from getPaddingTop (locator) Retrieves the CSS padding-top attribute value applied to that element. |
| assertPosition | This command is used to verify the css position attribute value applied to that element. |
| assertPerformanceData | Verifies the resource usage information of the application. the resource is one of the system states which means CPU Info, Memory Info, Network Info, and Battery Info. This command is supported only for Android Devices. Execution stops if the command fails. |
| assertPrompt | This command is used to verify the message of a JavaScript question prompt dialog generated during the previous action. Successful handling of the prompts requires prior execution of the answerOnNextPrompt command. |
| assertPromptNotPresent | Generated from isPromptNotPresent() Has a prompt occurred? This function never throws an exception. |
| assertPromptPresent | Generated from isPromptNotPresent() Has a prompt occurred? This function never throws an exception. |
| assertSelectedIndex | Generated from getSelectedIndex(selectLocator). This command gets option index (option number, starting at 0) for selected option in the specified select element. |
| assertSelectedLabel | This command is used to verify the label (visible text) for selected option in the specified select element. If the label of option doesnot match with given value, the execution gets aborted. |
| assertSelectedLabels | This command is used to verify all the labels (visible text) for selected options in the specified select or multi-select element. |
| assertSelectedValue | This command is used to verify the value of value attribute for selected option in the specified select element. |
| assertSelectOptions | This command is used to verify all the option labels in the specified select drop-down. The execution get aborted if the options didnot match. |
| assertSomethingSelected | This command is used to verify whether some option in a drop-down menu is selected or not. |
| assertSpeed | This command is used to verify that the execution speed with the execution speed is currently setup with. See also setSpeed command. |
| assertStyleAttribute | This command is used to gets the CSS attributes values of an element attribute. Syntax |
| assertSystemTime | Verifies system's current time with the target. On failure, it stops the execution. |
| assertTable | his command is used to verify the text from the specified cell in the table. In this command the cell Address must be mentioned. Syntax for cellAddress is tableLocator.row.column, where row and column start at 0. |
| assertTextNotPresent | Generated from isTextPresent(pattern). This command verifies that the specified text pattern appears somewhere on the rendered page visible to the user. |
| assertTextOrientation | Generated from getTextOrientation(locator) Retrieves the CSS text-orientation attribute value applied to that element. |
| assertText | This command is used to verify the text of an element. This works for any element that contains text. This command uses either the textContent (Mozilla-like browsers) or the innerText (IE-like browsers) of the element, which is the rendered text shown to the user. |
| assertTextAlign | This command is used to retrieves the text-align - css attribute applied on that element. |
| assertTextPresent | This command is used to verify the specified text pattern appears somewhere on the rendered page shown to the user. |
| assertTimeStamp | Generated from getTimeStamp() This command is used to get the current time in (yyyymmddhhmiss) format. |
| assertTitle | This command is used to verify the title of the current page. |
| assertValue | This command is used to verify the (whitespace-trimmed) value of an input field (or anything else with a value parameter). For checkbox/radio elements, the value will be "on" or "off" depending on whether the element is checked or not. |
| assertVerticalAlign | Generated from getVerticalAlign(locator) Retrieves the CSS vertical-align attribute value applied to that element |
| assertVisible | Determines if the specified element is visible on the web page. An element can be rendered invisible by setting the CSS "visibility" property to "hidden", or the "display" property to "none", either for the element itself or one if its ancestors. This method will fail if the element is not present. |
| assertWidth | Generated from getWidth(locator) Retrieves the CSS width attribute value applied to that element. |
| assertXpathCount | This command is used to verify the number of nodes that match with the specified xpath given, eg. "//table/tbody/tr" would give the number of rows in a table. |
| assignId | This command temporarily sets the "id" attribute of the specified element, so you can locate it in the future using its ID rather than a slow/complicated XPath. This ID will disappear once the page is reloaded. |
| assignIdAndWait | This command temporarily sets the "id" attribute of the specified element, so you can locate it in the future using its ID rather than a slow/complicated XPath. This ID will disappear once the page is reloaded. |
| average | This command is used to do average on the list of values provided.This is similar to arithmetical average which performs average on the list of values provided. |
| appendBodyPartToBody | This command appends a 'body part' to the email body defined using the command 'createBody' (and identified with a email body name). The email body may contain one or more 'bodyparts' if this command was executed previously within the same script in the context of the same email body (identified by the email body name). |
B
| Command | Purpose |
|---|---|
| break | Causes execution of test to exit the loop immediately. "break" command must be used within a loop. |
| buildHTMLAnchorTagToAccessTestExectionDetail | This command returns the complete HTML anchor tag that contains the testRunId along with the hyperlink to access the execution detail page within the Worksoft SaaS application for that testRunId. The returned value will be of the format " <a href="<hyperlink"><testRunId></a> ". |
C
| Command | Purpose |
|---|---|
| captureEntirePageScreenshot | Saves the entire contents of the current window canvas to a PNG file. Contrast this with the captureScreenshot command, which captures the contents of the OS viewport (i.e. whatever is currently being displayed on the monitor), and is implemented in the RC only. Currently this only works in Firefox when running in chrome mode, and in IE non-HTA using the EXPERIMENTAL 'Snapsie' utility. The Firefox implementation is mostly borrowed from the Screengrab! Firefox extension. Please see http://www.screengrab.org and http://snapsie.sourceforge.net/ for details. |
| captureEntirePageScreenshotAndWait | Saves the entire contents of the current window canvas to a PNG file. Contrast this with the captureScreenshot command, which captures the contents of the OS viewport (i.e. whatever is currently being displayed on the monitor), and is implemented in the RC only. Currently this only works in Firefox when running in chrome mode, and in IE non-HTA using the EXPERIMENTAL "Snapsie" utility. The Firefox implementation is mostly borrowed from the Screengrab! Firefox extension. Please see http://www.screengrab.org and http://snapsie.sourceforge.net/ for details. |
| capturePageScreenshot | Takes the screenshot of the page |
| check | This command is used to check the toggle-button(checkbox/radio) |
| checkAndWait | This command is used to check the toggle-button(checkbox/radio) |
| checkWiondowPopupCount | This command is used to get the number of, the number of windows currently opened and verify the count with the value provided in the target field, if both are equal "true" will be saved in the value variable else "false" will be saved. |
| chooseCancelOnNextConfirmation | This command,by default, QaSCRIBE's overridden window.confirm() function will return true, as if the user had manually clicked OK; after running this command, the next call to confirm() will return false, as if the user had clicked Cancel. QaSCRIBE will then resume using the default behavior for future confirmations, automatically returning true (OK) unless/until you explicitly call this command for each confirmation. |
| chooseOkOnNextConfirmation | This command, undo the effect of calling chooseCancelOnNextConfirmation.QaSCRIBE's overridden window.confirm() function will normally automatically return true, as if the user had manually clicked OK, so you shouldn't need to use this command unless for some reason you need to change your mind prior to the next confirmation. After any confirmation, QaSCRIBE will resume using the default behavior for future confirmations, automatically returning true (OK) unless/until you explicitly call chooseCancelOnNextConfirmation for each confirmation. |
| clear | This command is used to clear the input field. |
| clearAndWait | This command is used to clear the input field. |
| click | This command is used to click on a link, button, checkbox or radio button. If the click action causes a new page to load (like a link usually does), call waitForPageToLoad. |
| clickAndWait | This command is used to click on a link, button, checkbox or radio button. If the click action causes a new page to load (like a link usually does), call waitForPageToLoad. |
| clickAt | Clicks on a link, button, checkbox or radio button. If the click action causes a new page to load (like a link usually does), call waitForPageToLoad. |
| clickAtAndWait | This command is used to click on a link, button, checkbox or radio button. If the click action causes a new page to load (like a link usually does), call waitForPageToLoad. |
| close | Simulates the user clicking the "close" button in the titlebar of a popup window or tab. |
| closeApp | Close an app on the device. |
| concatenate | This command concatenates the values given as part of expression. The list to be concatenated must be passed with ',' as the delimiter. Numeric values must be given directly whereas alphanumeric string values can be given directly or enclosed in double quotes(""). Values stored in variables using store commands must be accessed using $ enclosed with curly braces. Example: 12345, "Sam", "4,500", ${testValue}. |
| contextMenu | It Simulates opening the context menu for the specified element (as might happen if the user "right-clicked" on the element). |
| contextMenuAndWait | Generated from contextMenu(locator) Simulates opening the context menu for the specified element (as might happen if the user 'right-clicked' on the element). After performing the action the command waits for a specified amount of time (which can be configured). |
| contextMenuAt | It simulates opening the context menu for the specified element (as might happen if the user "right-clicked" on the element). |
| contextMenuAtAndWait | Generated from contextMenuAt(locator, coordString) Simulates opening the context menu for the specified element (as might happen if the user 'right-clicked' on the element) at the specific location provided.After performing the action the command waits for a specified amount of time (which can be configured). |
| continue | This command will force the execution to skip the current iteration (within the loop) and jump to the next iteration. "continue" command must be used within a loop. |
| controlKeyDown | This command is used to press the control key and hold it down until doControlUp() is called or a new page is loaded. |
| controlKeyDownAndWait | Generated from controlKeyDown() Press the control key and hold it down until doControlUp() is called or a new page is loaded, and wait for the implicit time provided. |
| controlKeyUp | This command is used to release the control key. It is used after controlKeyDown command to release the control key. |
| controlKeyUpAndWait | Generated from controlKeyUp() Release the control key, and wait for the implicit timeout. |
| createBody | This command is used to create (or define/initialize) an email body and assign it a 'name'. This 'name' is referred to in this article and other articles related to these commands as 'email body name'. |
| createBodyFromDataFile | This command is used to create an 'email body part' from the 'Data File' passed as input. |
| createBodyPartFromDataSet | This command is used to create an 'email body part' from the 'Dataset' passed as input.
|
| createBodyPartFromScreenshot | This command is used to create an 'email body part' from a screenshot that is captured within the test run that this test script is executing within. |
| createBodyPartFromTextOrHTML | This command is used to create an 'email body part' from the 'Text String' or 'HTML String' passed as input. |
| createStyleForDataTablesInBody | This command is used to create (define) the 'style' for the data tables that you will append to the email body (name) using the command 'createBodyPartFromDataFile' and/or the command 'createBodyPartFromDataSet'. |
| createCookie | This command creates a new cookie whose path and domain are same with those of current page under test, unless you specified a path for this cookie explicitly. |
| createCookieAndWait | Generated from createCookie(nameValuePair, optionsString) Create a new cookie whose path and domain are same with those of current page under test unless you specified a path for this cookie explicitly. |
| createStyleForDataTablesInBody | This command is used to create (define) the 'style' for the data tables that you will append to the email body (name) using the command 'createBodyPartFromDataFile' and/or the command 'createBodyPartFromDataSet'. |
D
| Command | Purpose |
|---|---|
| dbBlockEnd | This command signifies the end of a dbCONNECT Block within a Test Script. Each dbBlockEnd must be accompanied by a matching dbBlockOpen that exists before it within the same Test Script. There can be more than one dbCONNECT Blocks within a single Test Script. dbCONNECT Blocks are also referred to as dbBlocks for simplicity. |
| dbBlockOpen | This command signifies the beginning of a dbCONNECT Block within a Test Script. Each dbBlockOpen must be accompanied by a matching dbBlockEnd that exists after it within the same Test Script. There can be more than one dbCONNECT Blocks within a single Test Script. dbCONNECT Blocks are also referred to as dbBlocks for simplicity. |
| dbExecuteQuery | This command is the main query that is responsible for getting the SQL query, identified by a label, executed by the appropriate dbCONNECT Tunnel operating on one of your company's servers. |
| dbgetQueryExecutionErrorCode | This command is used to retrieve (read) the SQL Error Text that corresponds to a failed SQL query that was executed by dbCONNECT. This command must be used usually immediately after a dbExecuteQuery and within the same dbBlock. |
| dbgetQueryExecutionErrorText | This command is used to retrieve (read) the SQL Error Text that corresponds to a failed SQL query that was executed by dbCONNECT. This command must be used usually immediately after a dbExecuteQuery and within the same dbBlock. |
| dbLabelQuery | This command is used to "label" a SQL query in the context of a particular dbBlock. Once used, you can refer to the SQL query within the current dbBlock using that label (instead of using the SQL query itself). The SQL query could have variables (as placeholders) which then could be populated (replaced/filled) using the dbSetQueryValue command that follows this command but before the dbExecuteQuery command within the current dbBlock. The variables within the SQL Query have to be of the format ${variableName}. |
| dbSetContext | This command is used to specify to Worksoft SaaS the "database" within which the SQL queries within the current dbBlock must be executed AND the "dbCONNECT tunnel" (that is operating within your company's firewalls) that will service the execution of those queries. |
| dbSetMaxResultSetCount | This command is used to specify the maximum size of the result set for all queries that get executed within the current dbBlock. This is to prevent poorly written queries that could potentially bring back into Worksoft SaaS large result set that have negative consequences of depleting the capacity within your domain by unnecessarily running data driven tests on the result set returned by such bad queries. If this command is not explicitly used within a dbBlock, a default value will be used. Default value is X records (rows). |
| dbSetQueryValue | This command is used to set the "value(s)" for a particular variable (parameter) within the SQL query. A variable/parameter within your SQL Query has to be identified by a namestring in the format ${variableName}. For each variable (parameter) within your SQL query, you must use this command separately, to set its value. |
| dbSetTimeout | This command can be used to set the "timeout" for all DB Queries that get executed in the context of a dbBlock. Test execution gets aborted if no response comes back from Worksoft SaaS dbCONNECT tunnel within the value set. If this command is NOT used within a dbBlock, a default value will be applied for the timeout. Default value is X seconds. |
| ddAddRows | This command can be used to add a specified number of rows to the dataset in memory.Number of Rows to be added to the Dataset can be optionally passed in the 'Value'. Default value is 1. |
| ddAppendInstructionBlockTimingToDataSet | This command appends to a Data Set (previously defined within the automated test) the cumulative execution time of test instructions within the timerForTestInstructionsBlockStart and timerForTestInstructionsBlockEnd block. . |
| ddAppendKeyEventTimingToDataSet | This command appends to a Data Set (previously defined within the automated test) the key event timing captured by use of either the command 'runScript' followed by the command 'setEventTiming' OR the command 'runEventTimingFunction' within the timerForKeyEventBlockStart and timerForKeyEventBlockEnd block. |
| ddCreateDataset | This command can be used to create a new Dataset in memory with a name as provided in 'Target' with structure that follows the Data Definition named in 'Value'.Status of the Data Definition can be optionally passed along with the name of the Data Definition. Allowed values for Status are 'W' and 'A'.If not passed, status of the Data Definition is assumed to be W for WIP. |
| ddCreateDatasetFromJSONObject | This command is used to create a DataSet from a JSON Object that is given at the target field and the DataSet name is declared in the value field. This DataSet is created using ddCreateDataSet command which has to be executed before ddCreateDatasetFromJSONObject command anywhere in run time. This DataSet can be persisted by using ddPersistDatasetToDataFile command. |
| ddCreateDatasetFromXMLDocument | This command is used to create a DataSet from an XML Document that is given at the target field and the DataSet name is declared in the value field. This DataSet is created using ddCreateDataSet command which has to be executed before ddCreateDatasetFromXMLDocument command anywhere in run time. This DataSet can be persisted by using ddPersistDatasetToDataFile command. |
| ddGetCellValueByIndex | This command can be used to copy a specific cell's value from one Dataset in memory as specified in the 'Target' field to a Variable in memory that is provided in the 'Value' field. The 'Variable' must exist in the scope of the current Test Run (of a Run Definition or a Scenario Validation). |
| ddGetCellValueByName | This command can be used to copy a specific cell's value from one Dataset in memory as represented by the rowNumber and attribute name from the Datafile from the source Dataset as specified in the 'Target' field to a Variable in memory that is provided in the 'Value' field.The 'Variable' must exist in the scope of the current Test Run (of a Run Definition or a Scenario Validation). |
| ddGetColumnCount | This command can be used to copy a specific column count for Dataset in memory specified in the 'Target' field to a Variable in memory that is provided in the 'Value' field. The 'Variable' must exist in the scope of the current Test Run (of a Run Definition or a Scenario Validation). |
| ddGetRowCount | This command can be used to copy a specific row count for Dataset in memory specified in the 'Target' field to a Variable in memory that is provided in the 'Value' field. The 'Variable' must exist in the scope of the current Test Run (of a Run Definition or a Scenario Validation). |
| ddGetRowValues | This command can be used to copy a specific row from one Dataset in memory as specified in the 'Target' field to a variable in the value field. |
| ddPersistDatasetToDataFile | This command can be used to persist a Dataset in memory into a Data File. If the Data File does NOT currently exist in the scope of the Project, a new Data File will be created in 'Active' status with the name provided. If a Data File exists with the name provided, the entire content of that Data File will be replaced with the data from the Dataset. of the Data File can be optionally passed along with the name of the Data File. Allowed values for are 'W' and 'A'. |
| ddPersistDatasetToDataFileTemporary | This command can be used to temporarily replace the existing data file with the new data dynamically returned from the query/created specifically in the context of the run being executed. The data file will not be persisted to the database and it can be used in dynamic binding within the run that is being executed. This prevents creating dummy data files, where the data file is persisted only to replace with dynamic binding within that run. |
| ddSetCellValueByIndex | This command can be used to copy a specific cell's value from a Variable in memory that is provided in the 'Value' field to one Dataset in memory as specified in the 'Target' field. The 'Variable' must exist in the scope of the current Test Run (of a Run Definition or a Scenario Validation). |
| ddSetCellValueByName | This command can be used to copy a specific cell's value from a Variable in memory that is provided in the 'Value' field to one Dataset in memory as represented by the rowNumber and attribute name from the Datafile from the source Dataset as specified in the 'Target' field.The 'Variable' must exist in the scope of the current Test Run (of a Run Definition or a Scenario Validation). |
| ddSetRowValues | This command can be used to copy a specific row from one Dataset in memory as specified in the 'Target' field to another row of a 2nd Dataset in memory that is provided in the 'Value' field. |
| deleteAllVisibleCookies | This command calls deleteCookie with recurse=true on all cookies visible to the current page, recurse=true can be much slower than simply deleting the cookies using a known domain/path. |
| deleteAllVisibleCookiesAndWait | This command calls deleteCookie with recurse=true on all cookies visible to the current page, recurse=true can be much slower than simply deleting the cookies using a known domain/path. It is similar to deleteAllVisibleCookies command and additionally waits till all the cookies are deleted. |
| deleteCookie | Delete a named cookie with specified path and domain. Be careful; to delete a cookie, you need to delete it using the exact same path and domain that were used to create the cookie. If the path is wrong, or the domain is wrong, the cookie simply won't be deleted. Also note that specifying a domain that isn't a subset of the current domain will usually fail. Since there's no way to discover at runtime the original path and domain of a given cookie, we've added an option called 'recurse' to try all sub-domains of the current domain with all paths that are a subset of the current path. Beware; this option can be slow. In big-O notation, it operates in O(n*m) time, where n is the number of dots in the domain name and m is the number of slashes in the path. |
| deleteCookieAndWait | Delete a named cookie with specified path and domain. Be careful; to delete a cookie, you need to delete it using the exact same path and domain that were used to create the cookie. If the path is wrong, or the domain is wrong, the cookie simply won't be deleted. Also note that specifying a domain that isn't a subset of the current domain will usually fail. Since there's no way to discover at runtime the original path and domain of a given cookie, we've added an option called 'recurse' to try all sub-domains of the current domain with all paths that are a subset of the current path. Beware; this option can be slow. In big-O notation, it operates in O(n*m) time, where n is the number of dots in the domain name and m is the number of slashes in the path. It will wait untill the specified cookie is deleted. |
| deselectPopUp | This command is used to move the focus out of the popup selected earlier, selects the main window. Functionally equivalent to using selectWindow() and specifying no value for windowID. |
| doubleClick | TDouble clicks on a link, button, checkbox or radio button. If the double click action causes a new page to load (like a link usually does), call waitForPageToLoad. |
| doubleClickAndWait | To double click on a link, button, checkbox or radio button. If the double click action causes a new page to load (like a link usually does), call waitForPageToLoad. |
| doubleClickAt | Doubleclicks on a link, button, checkbox or radio button. If the action causes a new page to load (like a link usually does), call waitForPageToLoad. |
| doubleClickAtAndWait | Generated from doubleClickAt(locator, coordString) Doubleclicks on a link, button, checkbox or radio button. If the action causes a new page to load (like a link usually does), call waitForPageToLoad. |
| doubleClickType | Can also be used to set the value of combo boxes, check boxes, etc. In these cases, value should be the value of the option selected, not the visible text. |
| doubleClickTypeAndWait | Generated from doubleClickType(locator, value) Can also be used to set the value of combo boxes, check boxes, etc. In these cases, the value should be the value of the option selected, not the visible text. |
| doubleTap | This command is used to perform the double-click operation. |
| doubleTapAt | This command is used to perform the double-click operation using the x,y coordinates. Coordinates should be in integer format. |
| dragAndDrop | Drags an element a certain distance and then drops it. |
| dragAndDropAt | drag and drop to an element. Coordinates should be in integer format. |
| dragAndDropAndWait | To drag an element to a certain distance and then drop it |
| dragAndDropToObject | Drags an element and drops it on another element. |
| dragdrop | deprecated - use dragAndDrop instead |
| dragdropAndWait | Generated from dragdrop(locator, movementsString) deprecated - use dragAndDropAndWait instead |
E
| Command | Purpose |
|---|---|
| echo | Prints the specified message into the third table cell in your Selenese tables. Useful for debugging. |
| else | When conditional in 'if' command evaluates to false then series of commands listed below this command will be executed until it encounters 'endIf' command. |
| elseIf | If the conditional evaluates to true then the series of commands listed in 'elseIf' block will be executed. If the expression evaluates to false it jumps to 'else block' and execute commands below the 'else' command until 'endIf' command is encountered. Every 'elseIf' command should end with 'endIf' command (whereas 'else' command is optional) |
| emailBlockEnd | This command signifies the End of a email service Block within a Test Script. Each emailBlockEnd must be accompanied by a matching emailBlockStart that exists before it within the same Test Script. There can be more than one emailBlocks within a single Test Script. |
| emailBlockStart | This command signifies the beginning of a email service block within a Test Script. Each emailBlockStart must be accompanied by a matching emailBlockEnd that exists after it within the same Test Script. There can be more than one email service blocks within a single Test Script. |
| endForeach | This command marks the end of a "foreach" block. |
| endFor | This command marks the end of a "for" block |
| endIf | Marks the end of a if block. |
| endWhile | Marks the end of a while block. |
| exitTest | Causes the current test to immediately end. |
F
| Command | Purpose |
|---|---|
| fireEvent | Opens an URL in the test frame. This accepts both relative and absolute URLs. The open command waits for the page to load before proceeding, ie. the AndWait suffix is implicit. Note: The URL must be on the same domain as the runner HTML due to security restrictions in the browser (Same Origin Policy). If you need to open an URL on another domain, use the Selenium Server to start a new browser session on that domain. |
| fireEventAndWait | Generated from fireEvent(locator, eventName) Explicitly simulate an event, to trigger the corresponding "onevent" handler. |
| focus | To move the focus to the specified element; for example, if the element is an input field, move the cursor to that field. |
| focusAndWait | To move the focus to the specified element; for example, if the element is an input field, move the cursor to that field. |
| for | Perform the 'initializer'. Then iterate over the block of code until the 'conditional' evaluates to false, performing the 'incrementer' after each iteration. 'for' command must always have 'endFor' at the end of the block. |
| foreach | Iterate a block of code, once for each value. 'foreach' command must always have 'endForeach' at the end of the block. |
G
| Command | Purpose |
|---|---|
| getDOMPageHtmlSource | This command is used to get the HTML Source of the current window and store in file system.To view the source the command "persistFileObjectToFile" has to be used, which saves the file in .txt format |
| getDirectHyperlinkToAccessTestExecutionDetail | This command returns the hyperlink to the acces the execution detail page within the Worksoft SaaS application for a specific testRunId. The testRunId is optional in the first command. If not passed, the command will return the hyperlink for the test run id in context. This command can be used along with the command 'replaceSubstringOccurrencesWithinAString' to dynamically include testRunIds (into the emails composed and distributed from within automated tests) that are hyperlinked (s) to the test execution detail page(s) within the Worksoft SaaS application |
| getErrorTextForLastFailedInstruction | This command allows to retrieve the error text of the last failed instruction and also optionally pass command name in the value field. If command name is passed then it returns the error text of the last failed command |
| getFailedInstructionId | This command is used to get the Instruction Id of the last failed command within the exception block. |
| getFailedInstructionCommand | This command is used to get the last failed command in a Test Run within the exception block. |
| getFailedInstructionTarget | This command is used to get the target of the last failed command in a Test Run within the exception block. |
| getFailedInstructionValue | This command is used to get the value of the failed command in a Test Run within the exception block. |
| getInnerHtmlSourceOfElement | This command is used to get the innerHTML of a specific element.For a specific locator, it returns the Html source between the opening and closing tags. |
| getIdentifierForFirstFailedInstruction | This command gets the test instruction identifier for the first failed test instruction within the test run that this command is executing as part of. |
| getIdentifierForLastFailedInstruction | This command gets the test instruction identifier for the last failed test instruction within the test run that this command is executing as part of. |
| getIdentifierForLastExecutedInstruction | This command gets the test instruction identifier for the last executed test instruction within the test run that this command is executing as part of. |
| getOuterHtmlSourceofElement | This command is used to get the outerHTML of a specific element.For a specific locator, it returns the Html source including the opening and closing tags. |
| getOverlappingUserInterfaceElements |
This command is used to identify the list of UI elements/locators that overlap. Input is the element locators given in a dataset. The response of this command is the dataset with the list of UI elements/locators that overlap with any other element/locator in the input/request dataset. |
| goBack | Simulates the user clicking the 'back' button on their browser. |
| goBackAndWait | Simulates the user clicking the 'back' button on their browser. |
| goto | Jump to the given label. 'label' is optional field. |
| gotoIf | If the conditional evaluates to true, jump to the given label. 'label' is optional field. |
H
| Command | Purpose |
|---|---|
| hideKeyboard | Hide soft keyboard. |
| highlight | This command is used to highlight the specified element in yellow color. Useful for debugging. |
| highlightOverlappingElements | This command is used to highlight all the UI elements on the page using the dataset of elements provided in the 'Target' field. The input is the return value dataset from either of the two commands:
|
| holdAt | simulates the user click & hold on an element without lifting finger using the x,y coordinates. Coordinates should be in integer format. |
I
| Command | Purpose |
|---|---|
| if | If the conditional evaluates to true then the series of commands listed in 'if block' will be executed. If the expression evaluates to false it jumps to 'else block' and execute commands below the 'else' command until 'endIf' command is encountered. Every 'if' command should end with 'endIf' command (whereas 'else' command is optional). |
| ignoreAttributesWithoutValue | To Specify whether QaSCRIBE will ignore XPath attributes that have no value, i.e. are the empty string, when using the non-native XPath evaluation engine. You'd want to do this for performance reasons in IE. However, this could break certain xpaths, for example, an XPath that looks for an attribute whose value is NOT the empty string. The hope is that such xpaths are relatively rare, but the user should have the option of using them. Note that this only influences xpath evaluation when using the ajaxslt engine (i.e. not "javascript-xpath"). This command waits to complete it's action for a default timeout. The default timeout differs in QaSCRIBE and Worksoft SaaS Cloud Platform. |
| ignoreAttributesWithoutValueAndWait | To Specify whether QaSCRIBE will ignore xpath attributes that have no value, i.e. are the empty string, when using the non-native xpath evaluation engine. You'd want to do this for performance reasons in IE. However, this could break certain xpaths, for example an xpath that looks for an attribute whose value is NOT the empty string. The hope is that such xpaths are relatively rare, but the user should have the option of using them. Note that this only influences xpath evaluation when using the ajaxslt engine (i.e. not "javascript-xpath"). |
J
| Command | Purpose |
|---|---|
| jsonAppendToObject | This command is used to append values to the end of the indicated arrays within a JSON document. If the JSON document supplied in input is invalid, command fails with error "INVALID_JSON". If the path mentioned is not part of the JSON document, command fails with error "INVALID_JSON_PATH" |
| jsonAssertPathExists | This command is used to check if the given path exists within a JSON document. If the JSON document supplied in input is invalid, command fails with error "INVALID_JSON". If the path mentioned is not part of the JSON document, command fails with error "INVALID_JSON_PATH" |
| jsonAssertValidity | This command is used to check if the input provided is a valid JSON document. If the input is not a valid JSON document, the command fails with error "INVALID_JSON". |
| jsonCompare | This command is used to compare the JSON documents. If the JSON document supplied in input is invalid, command fails with error "INVALID_JSON". If the path mentioned is not part of the JSON document, command fails with error "INVALID_JSON_PATH" |
| jsonCreateObjectFromDataFile | This command is used to create a JSON Object from the contents of a data file. If the mentioned data file is not avaialble run fails with error "Datafile name provided in the 'Target' field field does NOT exist in the scope of the project". In Worksoft SaaS a data file is always associated to a data definition. Attributes/Fields in the data definition are converted to "Key" in the JSON document while the contents of the data file make up for "Value" in the JSON document. |
| jsonCreateObjectFromDataSet | This command is used to create a JSON document from the contents of a data set. If the dataset mentioned in the variable is not created in the same run, then run fails with error "For one or more Instructions within the Test Run that use the "ddCreateDataset" command, the Dataset name provided in the 'Target' field does NOT exist in the scope of the " In Worksoft SaaS data set is a temporary storage area that consists of columns & rows. Column names makes up "Key" while row values make up "Value" in the JSON document |
| jsonExtractValuesByPaths | This command is used to retrieve data selected from the parts of the document matched by the path arguments. If the number of values returned are more than the columns in the dataset, command fails with error "The Number of columns returned are more than the number of attributes in the data definition |
| jsonGetDepth | This command is used to return maximum depth of the JSON document. If the JSON document supplied in input is invalid, command fails with error "INVALID_JSON". |
| jsonGetLength | This command is used to get number of elements present in the JSON document. If the JSON document supplied in input is invalid, command fails with error "INVALID_JSON". If the path mentioned is not part of the JSON document, command fails with error "INVALID_JSON_PATH" |
| jsonInsertIntoObject | This command is used to insert data into a JSON document. If the JSON document supplied in input is invalid, command fails with error "INVALID_JSON" If the path indicates a nonexistent path in the JSON, it adds the value to the JSON if:: 1) A member is not present in an existing object. The member is added to the object and associated with the new value. 2) A position past the end of an existing array. The array is extended with the new value. If the existing value is not an array, it is auto wrapped as an array, then extended with the new value. Otherwise, a path/value pair for a nonexistent path in the document is ignored and has no effect. |
| jsonMergeObjects | This command is used to merge two or more JSON documents to a single document. If the JSON document supplied in input is invalid, command fails with error "INVALID_JSON" Merging takes place according to the following rules 1) Adjacent arrays are merged to a single array. 2) Adjacent objects are merged to a single object. 3) A scalar value is autowrapped as an array and merged as an array. 4) An adjacent array and object are merged by autowrapping the object as an array and merging the two arrays. |
| jsonRemoveFromObject | This command is used to remove data from a JSON document. If the JSON document supplied in input is invalid, command fails with error "INVALID_JSON" The document produced by evaluating one path becomes the new value against which the next path is evaluated. It is not an error if the element to be removed does not exist in the document; in that case, the path does not affect the JSON. If the path is "$" or contain wildcard characters, command fails with error "One of the JSON Path is either Null or having wild card characters" |
| jsonReplaceKeysByPaths | This command is used to replace existing keys in the JSON document. If the JSON document supplied in input is invalid, command fails with error "INVALID_JSON". If the path mentioned is not part of the JSON document, command fails with error "INVALID_JSON_PATH" The document produced by evaluating one pair becomes the new value against which the next pair is evaluated. A path/value pair for an existing path in the document overwrites the existing document value with the new value. If the path is "$" or contain wildcard characters, command fails with error "One of the JSON Path is either Null or having wild card characters" |
| jsonReplaceValuesByPaths | This command is used to replace existing values in the JSON document. If the JSON document supplied in input is invalid, command fails with error "INVALID_JSON". If the path mentioned is not part of the JSON document, command fails with error "INVALID_JSON_PATH".The document produced by evaluating one pair becomes the new value against which the next pair is evaluated. A path/value pair for an existing path in the document overwrites the existing document value with the new value. If the path is "$" or contain wildcard characters, command fails with error "One of the JSON Path is either Null or having wild card characters" |
| jsonSearchValueOccurrence | JSONSearchValueOccurrence({Json/VariableName} || "val"(, path),VariableName) [path is OPTIONAL] If path is not given, then the search_string should be on the first level of JSON. The search_string "val" should be enclosed in Double quotes if the search_string is an Object or an Array. |
| jsonStoreArrayByIndex | This command retrieves values from JSON document using "index" as reference. [If the JSON document supplied in input is invalid, command fails with error "INVALID_JSON". If index mentioned is not part of the JSON document, command fails with error "INDEX_NOT_PRESENT". If the found value is not an array type, then command fails with error "INCOMPATIBLE_TYPE" |
| jsonStoreArrayByName | This command retrieves values from JSON document using "name" as reference. If the JSON document supplied in input is invalid, command fails with error "INVALID_JSON". If arrayName mentioned is not part of the JSON document, command fails with error "KEY_NOT_PRESENT". If the found value is not an array type, then command fails with error "INCOMPATIBLE_TYPE" |
| jsonStoreObjectByIndex | This command retrieves object from JSON document using "index" as a reference. If the JSON document supplied in input is invalid, command fails with error "INVALID_JSON". If index mentioned is not part of the JSON document, command fails with error "INDEX_NOT_PRESENT". If the found value is not an object type, then command fails with error "INCOMPATIBLE_TYPE" |
| jsonUnquoteValue | This command is used to remove escape characters within the string. Escape Sequence Character Represented by Sequence \" A double quote (") character \b A backspace character \f A formfeed character \n A newline (linefeed) character \r A carriage return character \t A tab character \\ A backslash (\) character \uXXXX UTF-8 bytes for Unicode value XXXX |
K
| Command | Purpose |
|---|---|
| keyDown | To Simulate a user pressing a key (without releasing it yet). |
| keyDownAndWait | Generated from keyDown(locator, keySequence) Simulates a user pressing a key (without releasing it yet). |
| keyPress | To Simulate a user pressing and releasing a key. |
| keyPressAndWait | Generated from keyPress(locator, keySequence) This command simulates the action of pressing and releasing a key. |
| keyUp | To Simulate a user releasing a key. |
| keyUpAndWait | Generated from keyUp(locator, keySequence) Simulates a user releasing a key. |
L
| Command | Purpose |
|---|---|
| label | Serves as the target for goto/gotoIf statements. 'label' command must always have 'goto/gotoIf' statements. |
| locateSubstringPosition | Returns the position of the first occurrence of the <substring> within the <string> string starting from the position <startingPosition> within all occurrences of the <substring> .This command performs a case-sensitive match when searching for <substring>. It returns 0 if the <substring> is not in the <string>. . |
| lock | Lock the device. |
| longPressKeyCode | Press and hold a particular key code on the device. |
M
<| Command | Purpose |
|---|---|
| mergeValuesIntoBodyPartVariables | This command is used to merge the values from dataset into 'variables for substitution' that exist within either the:
|
| metaKeyDown | Press the meta key and hold it down until doMetaUp() is called or a new page is loaded. |
| metaKeyDownAndWait | Press the meta key and hold it down until doMetaUp() is called or a new page is loaded. |
| metaKeyUp | Release the meta key. |
| metaKeyUpAndWait | Release the meta key. |
| mouseDown | This command is used to simulate a user pressing the left mouse button (without releasing it yet) on the specified element. |
| mouseDownAndWait | Generated from mouseDown(locator) Simulates a user pressing the left mouse button (without releasing it yet) on the specified element. |
| mouseDownAt | This command is used to simulates a user pressing the left mouse button (without releasing it yet) at the specified location. |
| mouseDownAtAndWait | Generated from mouseDownAt(locator) Simulates a user pressing the left mouse button (without releasing it yet) at the specified locator and wait. |
| mouseDownRight | This command is used to simulates a user pressing the right mouse button (without releasing it yet) on the specified element. |
| mouseDownRightAndWait | This command is used to simulates a user pressing the right mouse button (without releasing it yet) on the specified element. This command generated from mouseDownRight(locator) |
| mouseDownRightAt | This command is used to simulates a user pressing the right mouse button (without releasing it yet) at the specified location. |
| mouseDownRightAtAndWait | Generated from mouseDownRightAt (locator,coord) Simulates a user pressing the right mouse button (without releasing it yet) at the specified location. |
| mouseMove | This command is used to simulates a user pressing the mouse button (without releasing it yet) on the specified element. |
| mouseMoveAndWait | This command is used to simulates a user pressing the mouse button (without releasing it yet) on the specified element.This command generated from mouseMove(locator). |
| mouseMoveAt | This command is used to simulates a user pressing the mouse button (without releasing it yet) on the specified element. |
| Generated from mouseMoveAt(locator,coord) Simulates a user moving the cursor to the specified location and wait. | |
| mouseOut | This command is used to simulates a user moving the mouse pointer away from the specified element. |
| mouseOutAndWait | Generated from mouseOut(locator) Simulates a user moving the mouse pointer away from the specified element. |
| mouseOver | This command is used to simulates a user hovering a mouse over the specified element. |
| mouseOverAndWait | This command is used to simulates a user hovering a mouse over the specified element. This command generated from mouseOver(locator). |
| mouseUp | This command is used to simulates the event that occurs when the user releases the mouse button (i.e., stops holding the button down) on the specified element. |
| mouseUpAndWait | Generated from mouseUp(locator) Simulates the event that occurs when the user releases the mouse button (i.e., stops holding the button down) on the specified element. |
| mouseUpRight | This command is used to simulates the event that occurs when the user releases the right mouse button (i.e., stops holding the button down) on the specified element. |
| mouseUpRightAndWait | Generated from mouseUpRight(locator) Simulates the event that occurs when the user releases the right mouse button (i.e., stops holding the button down) on the specified element and wait for implicit timeout provided. |
| mouseUpRightAt | This command simulates the event that occurs when the user releases the right mouse button (i.e., stops holding the button down) at the specified location. |
| mouseUpRightAtAndWait | This command is used to simulates the event that occurs when the user releases the right mouse button (i.e., stops holding the button down) at the specified location.This command Generated from mouseUpRightAt(locator, coordString). |
| moveTo | Finger move on the screen. |
| moveToAt | Finger move on the screen using the x,y coordinates. Coordinates should be in integer format. |
| multiFingerTapAt | Tap on a touch screen at a time with multiple fingers. Coordinates should be in integer format. |
O
| Command | Purpose |
|---|---|
| open | Opens an URL in the test frame. This accepts both relative and absolute URLs. The open command waits for the page to load before proceeding, ie. the AndWait suffix is implicit. Note: The URL must be on the same domain as the runner HTML due to security restrictions in the browser (Same Origin Policy). If you need to open an URL on another domain, use the Selenium Server to start a new browser session on that domain. |
| openNotifications | Open Android notifications (Emulator only). |
| openWindow | Opens a popup window (if a window with that ID isn't already open). After opening the window, you'll need to select it using the selectWindow command.This command can also be a useful workaround for bug SEL-339. In some cases, Selenium will be unable to intercept a call to window.open (if the call occurs during or before the onLoad event, for example). In those cases, you can force Selenium to notice the open window's name by using the Selenium openWindow command, using an empty (blank) url, like this: openWindow(, myFunnyWindow). Care must be taken while giving Window URL because Window URL should not contain any spaces or special characters in Internet Explorer Browser. It is a good practice to use Window URL without spaces and special characters across all browsers. |
| openWindowAndWait | Generated from openWindow(url, windowID) Opens a popup window (if a window with that ID isn't already open). After opening the window, you'll need to select it using the selectWindow command. This command can also be a useful workaround for bug SEL-339. In some cases, QaSCRIBE will be unable to intercept a call to window.open (for example, if the call occurs during or before the 'onLoad' event, ). In those cases, you can force QaSCRIBE to notice the open window's name by using the QaSCRIBE openWindow command, using an empty (blank) url, like this: openWindow('', 'myFunnyWindow'). Being an AndWait command, it waits for the page to load for duration mentioned in timeout (2 minutes by default). |
P
| Command | Purpose |
|---|---|
| pause | This command is Used for giving explicit Pause between the execution (Wait for the specified amount of time (in milliseconds)). |
| persistFileObjectToFile | This command can be used to save the HTML Source in a text file (.txt format). The Source is fetched from the command " getDOMPageHtmlSource ". The .txt file is saved in "Files" module of Worksoft SaaS under "More" drop down |
| preciseTap | This command is used to perform the click operation on the specified locator at the given x,y co-ordinates. Coordinates should be in integer format. |
| pressKeyCode | Press a particular key code on the device. |
| product | This command does multiplication for the list of values provided.This is similar to arithmetic multiplication which performs multiplication on the list of values provided. |
R
| Command | Purpose |
|---|---|
| refresh | This command is used to refresh/reload the page after performaing certain actions.Simulates the user clicking the "Refresh" button on their browser. |
| refreshAndWait | This command is used to refresh/reload and wait till the page loads after performaing certain actions on the page. The default wait time in Worksoft SaaS is 120 seconds.Simulates the user clicking the "Refresh" button on their browser. |
| removeAllSelections | This command unselects all of the selected options in a multi-select element. |
| removeAllSelectionsAndWait | Generated from removeAllSelections(locator) This command unselects all of the selected options in a multi-select element. |
| removeApp | Remove an app from the device. |
| removeSelection | This command removes a selection from the set of selected options in a multi-select element using an option locator. |
| removeScript | This command removes a script tag from the QaSCRIBE document identified by the given id. Does nothing if the referenced tag doesn't exist. |
| removeScriptAndWait | Generated from removeScript(scriptTagId) This command removes a script tag from the QaSCRIBE document identified by the given id. Does nothing if the referenced tag doesn't exist. |
| replaceSubstringOccurrencesWithinAString | Returns the string <string> with all occurrences of the <fromSubstring> within the <string> replaced by the <toSubstring>. This command performs a case-sensitive match when searching for <fromString> ock the device. |
| resetApp | Reset the currently running app for this session. |
| resetSession | This command quits the existing session and create a new session in CE Service. |
| rotate | Rotates the mobile screen to portrait or landscape. |
| runScript | This command creates a new "script" tag in the body of the current test window, and adds the specified text into the body of the command. Scripts run in this way can often be debugged more easily than scripts executed using QaSCRIBE's "getEval" command. Beware that JS exceptions thrown in these script tags aren't managed by QaSCRIBE, so you should probably wrap your script in try/catch blocks if there is any chance that the script will throw an exception. |
| runScriptAndWait | This command creates a new "script" tag in the body of the current test window, and adds the specified text into the body of the command. Scripts run in this way can often be debugged more easily than scripts executed using QaSCRIBE's "getEval" command. Beware that JS exceptions thrown in these script tags aren't managed by QaSCRIBE, so you should probably wrap your script in try/catch blocks if there is any chance that the script will throw an exception. |
| runEventTimingFunction | This command is used to get the performance timing metric for key events like DOMLoad, PageLoad, etc. using pre-built (Worksoft SaaS natively supported) javscript functions based on Resource Timing API that many browsers support. If you want to use your own JavaScript functions instead use the command 'runScript' to execute your custom JavaScript function and then log the return value from those functions by using the 'setEventTiming' command. . |
S
| Command | Purpose |
|---|---|
| scrollToView | This command is used to get required locator into view port. |
| scrollToViewAndWait | This command is used to get required locator into view port. |
| select |
Select an option from a drop-down using an option locator. Option locators provide different ways of specifying options of an HTML Select element (e.g. for selecting a specific option, or for asserting that the selected option satisfies a specification). There are several forms of Select Option Locator. * label=labelPattern: matches options based on their labels, i.e. the visible text. (This is the default.) If no option locator prefix is provided, the default behaviour is to match on label. |
| selectAndWait |
Select an option from a drop-down using an option locator. Option locators provide different ways of specifying options of an HTML Select element (e.g. for selecting a specific option, or for asserting that the selected option satisfies a specification). There are several forms of Select Option Locator. * label=labelPattern: matches options based on their labels, i.e. the visible text. (This is the default.) If no option locator prefix is provided, the default behaviour is to match on label. |
| selectFrame | Selects a frame within the current window. (You may invoke this command multiple times to select nested frames.) To select the parent frame, use relative=parent as a locator; to select the top frame, use relative=top. You can also select a frame by its 0-based index number; select the first frame with index=0, or the third frame with index=2. |
| selectPopUp | Simplifies the process of selecting a popup window (and does not offer functionality beyond what selectWindow() already provides).
|
| selectPopUpAndWait | Simplifies the process of selecting a popup window (and does not offer functionality beyond what selectWindow() already provides).
|
| selectWindow | Window locators provide different ways of specifying the window object: by title, by internal JavaScript "name," or by JavaScript variable. |
| sendKeys | Simulates keystroke events on the specified element, as though you typed the value key-by-key. This simulates a real user typing every character in the specified string; it is also bound by the limitations of a real user, like not being able to type into a invisible or read only elements. This is useful for dynamic UI widgets (like auto-completing combo boxes) that require explicit key events. Unlike the simple type command, which forces the specified value into the page directly, this command will not replace the existing content. If you want to replace the existing contents, you need to use the simple type command to set the value of the field to empty string to clear the field and then the sendKeys command to send the keystroke for what you want to type. This command is experimental. It may replace the typeKeys command in the future. For those who are interested in the details, unlike the typeKeys command, which tries to fire the keyDown, the keyUp and the keyPress events, this command is backed by the atoms from Selenium 2 and provides a much more robust implementation that will be maintained in the future. |
| sendEmail | This command is used to send (distribute) the email composed (contents of the 'email body name' created with the 'createBody' command and populated with the use of one or more calls to 'appendBodyPartToBody' command) to the recipient list specified in the To, and if specified in the Cc and Bcc. The sender will be either the default sender or the sender explicitly specified with the 'setSender' command. |
| sendKeysEnter | This command is used to get required locator into view port. |
| sendKeysTabOut | Simulates keystroke events on the specified element, as though you typed the value key-by-key. This simulates a real user typing every character in the specified string and simulating TAB key; it is also bound by the limitations of a real user, like not being able to type into a invisible or read only elements. This is useful for dynamic UI widgets (like auto-completing combo boxes) that require explicit key events. Unlike the simple "type" command, which forces the specified value into the page directly, this command will not replace the existing content. If you want to replace the existing contents, you need to use the simple "type" command to set the value of the field to empty string to clear the field and then the "sendKeysAndFocus" command to send the keystroke for what you want to type. This command is experimental. It may replace the typeKeys command in the future. For those who are interested in the details, unlike the typeKeys command, which tries to fire the keyDown, the keyUp and the keyPress events, this command is backed by the atoms from QaSCRIBE 2 and provides a much more robust implementation that will be maintained in the future. |
| setAttachmentDataFile | This command is used to set a 'Data File' as an attachment to the email. The data file has to be within the same project the test script belongs to. |
| setAttachmentFile | This command is used to set a 'File' as an attachment to the email. The file has to be within the same project the test script belongs to. |
| setAttachmentScreenshot | This command is used to set a 'Screenshot' captured during the automated test run (within which the script containing this command executes within) as an attachment to the email. The screenshot is a screenshot that is captured within the same test run (not necessarily within the same test script) within which the email is being composed and has to correspond to a test instruction that is executed before the test instruction that executes this command. |
| setBrowserLogLevel | Sets the threshold for browser-side logging messages; log messages beneath this threshold will be discarded. Valid logLevel strings are: "debug", "info", "warn", "error" or "off". To see the browser logs, you need to either show the log window in GUI mode, or enable browser-side logging in QaSCRIBE RC. |
| setBrowserLogLevelAndWait | Sets the threshold for browser-side logging messages; log messages beneath this threshold will be discarded. Valid logLevel strings are: "debug", "info", "warn", "error" or "off". To see the browser logs, you need to either show the log window in GUI mode, or enable browser-side logging in QaSCRIBE RC. |
| setContextForKeyEvent | This command is used within the timerForKeyEventBlockStart and timerForKeyEventBlockEnd to set the context of the key event. |
| setCursorPosition | This command moves the text cursor to the specified position in the given input element or textarea. This method will fail if the specified element isn't an input element or textarea. |
| setCursorPositionAndWait | Generated from setCursorPosition(locator, position) This command moves the text cursor to the specified position in the given input element or text area. This method will fail if the specified element isn't an input element or text area. |
| setExceptionHandlerContext | This command is used to set the Test script to handle any exceptions during the Test Run. In case of any exceptions (failures), the Test Script pertaining to the exception handling will be executed as part of the Test Run within Exception Handler Code. Status of the Test Script can be optionally passed. Allowed values for Status are 'W' and 'A'.If not passed, the status of the Data File is assumed to be W for WIP. |
| setIdentifierForKeyEvent | This command is used within the timerForTestInstructionsBlockStart and timerForTestInstructionsBlockEnd block to assign an identifier for the key event. |
| setMouseSpeed | Setting this value to 0 means that we'll send a \"mousemove\" event to every single pixel in between the start location and the end location; that can be very slow and may cause some browsers to force the JavaScript to timeout. If the mouse speed is greater than the distance between the two dragged objects, we'll just send one \"mousemove\" at the start location and then one final one at the end location. |
| setEventTiming | This command is used within the timerForKeyEventBlockStart and timerForKeyEventBlockEnd to log the return value from a javascript function you execute using the 'runScript' command. |
| setMouseSpeedAndWait | Generated from setMouseSpeed(pixels) Setting this value to 0 means that we'll send a \"mousemove\" event to every single pixel in between the start location and the end location; that can be very slow and may cause some browsers to force the JavaScript to timeout. If the mouse speed is greater than the distance between the two dragged objects, we'll just send one \"mousemove\" at the start location and then one final one at the end location. |
| setLabelsWithCreationEnabled | This command is used to create labels and assign the label to a specific "test run" that is in the scope of the automated test in execution You can create root level (top level) labels as well as child labels. |
| setLabelsWithoutCreationEnabled | This command is used to only "assign" one or more label(s), that "already exist" at the root (or any other level) to a specific "test run" that is in the scope of the automated test in execution. This command will NOT create labels that do not exist already. |
| setRecipientBCCList | This command is used to. set the 'Bcc' recipient list that the composed email will be distributed to. Each email address in the list must be valid and must be separated from the one before with a comma (with our without a space before or after the comma). |
| setRecipientCCList | This command is used to. set the 'Cc' recipient list that the composed email will be distributed to. Each email address in the list must be valid and must be separated from the one before with a comma (with our without a space before or after the comma). |
| setRecipientToList | This command is used to. set the 'To' recipient list that the composed email will be distributed to. Each email address in the list must be valid and must be separated from the one before with a comma (with our without a space before or after the comma). |
| setSender | This command is used to set the 'Sender' for the email being composed. Currently, the full Email address of the sender is supported and not the full name or alias name Default sender will be set to Worksoft SaaS ['info@eureqatest.com'] |
| setSubject | This command is used to set the 'Subject' for the email being composed. It is recommended that the subject line not contain more than 70 characters. Even though Worksoft SaaS can support more characters than that, industry best practices indicate that people prefer shorter subject lines. |
| setSpeed | Set execution speed (i.e., set the millisecond length of a delay which will follow each QaSCRIBE operation). By default, there is no such delay, i.e., the delay is 0 milliseconds. |
| setSpeedAndWait | Generated from setSpeed(value) Set execution speed (i.e., set the millisecond length of a delay which will follow each QaSCRIBE operation). By default, there is no such delay, i.e., the delay is 0 milliseconds. |
| setTimeout | This command is used to specify the amount of time that selenium will wait for actions to complete.This time can be increased or decreased. The default timeout is 120 seconds.
|
| setUserVariable | This command can be used to dynamically change or set the value of a user-defined variable that has type 'Dynamic'. Manually editable data file cannot be updated by this command run-time.The value passed in 'Value' field of the Command will be stored in the user-defined variable mentioned in the 'Target' field of the Command for the 'Environment' that is contained in the Testing Context. |
| shake | Perform a shake operation on the device. Supported only on iOS devices. |
| shiftKeyDown | This command presses the shift key and hold it down until doShiftUp() is called or a new page is loaded. |
| shiftKeyDownAndWait | Generated from shiftKeyDown() This command presses the shift key and hold it down until doShiftUp() is called or a new page is loaded. |
| shiftKeyUp | Release the shift key. |
| shiftKeyUpAndWait | Generated from shiftKeyUp() This command releases the shift key. |
| skipNext | This command forces the execution to skip over the specified number of commands. |
| startActivity | Start an Android activity by providing package name and activity name |
| store | This command loads the value in variable and is a synonym for storeExpression. |
| storeFloat | Generated from getFloat(locator) Retrieves the CSS float attribute value applied to that element. |
| storeFontFamily | Generated from getFontFamily(locator) Retrieves the CSS font-family attribute value applied to that element. |
| storeAlert | Generated from getAlert().The command will read the alert text and store it in specified variable. |
| storeAlertPresent | Generated from isAlertPresent() This command will check and verify If there Is any alert message on current page. |
| storeAllButtons | Generated from getAllButtons() This command will store all buttons ids of webpages in given variable. |
| storeAllFields | Generated from getAllFields() This Command will store ids of all input fields of page in variable. |
| storeAllLinks | Generated from getAllLinks() This command used for storing ids of all available links on page. |
| storeAllWindowNames | Generated from getAllWindowNames() This command returns the names of all windows that the browser knows about in an array. |
| storeAllWindowTitles | Generated from getAllWindowTitles() This command used for storing title of all windows. |
| storeAttribute | Gets the value of an element attribute. |
| storeAttributeFromAllWindows | The command returns the titles of all windows that the browser knows about in an array. |
| storeBackgroundColor | The command stores the background color in rgb format. |
| storeBackgroundImage | Generated from getBackgroundImage(locator) This commands retrieves the CSS background-image attribute value applied to that element. |
| storeBackgroundPosition | Generated from getBackgroundPosition(locator) This command retrieves the CSS background-position attribute value applied to that element. |
| storeBackgroundRepeat | Generated from getBackgroundRepeat(locator) This command retrieves the CSS background-repeat attribute value applied to that element. |
| storeBodyText | Generated from getBodyText() This command gets the entire text of the page. |
| storeBorderColor | Generated from getBorderColor(locator) Retrieves the CSS border-colour attribute value applied to that element. |
| storeBorderRadius | Generated from getBorderRadius(locator) Retrieves the CSS border-radius attribute value applied to that element |
| storeBorderStyle | Generated from getBorderStyle(locator) Retrieves the CSS border-style attribute value applied to that element. |
| storeBorderWidth | Generated from getBorderWidth(locator) Retrieves the CSS border-width attribute value applied to that element. |
| storeChecked | The command gets the result whether a toggle-button (checkbox/radio) is checked. Fails if the specified element doesn't exist or isn't a toggle-button. |
| storeColor | The command stores the color in rgb format. |
| storeConfirmation | The command will store confirmation(Generated by "click" command) in to variable. |
| storeContentDescription | Gets the content-desc of an element. |
| storeCookie | The command will store all cookies of the current page. |
| storeCookieByName | The command will store cookies with the name stored in variable. |
| storeCookiePresent | The command will store cookies availability in variable. |
| storeCurrentActivity | Store current activity's details. |
| storeCurrentPackage | Store current package's details. |
| storeCssCount | The command is useful to calculate and store number of matching nodes for the given csspath in target field. |
| storeCursorPosition | This command stores numerical position of the cursor in the field. |
| storeDisplay | Generated from getDisplay(locator) Retrieves the CSS display attribute value applied to that element. |
| storeDeviceSettings | Store the current settings on the device |
| storeEditable | This command determines whether the specified input element is editable, i.e. hasn't been disabled. |
| storeElementIndex | This command is used to get the relative index of an element to its parent (starting from 0). The comment node and empty text node will be ignored. It returns relative index of the element to its parent (starting from 0) |
| storeElementHeight | Generated from getElementHeight(locator) Retrieves the height of an element. |
| storeElementLocation | Gets the location of an element. |
| storeElementSize | Stores the Size of an element. |
| storeElementPositionLeft | This command is used to retrieve the horizontal position of an element.It returns pixels from the edge of the frame. |
| storeElementPositionTop | This command is used to retrieve the retrieves the vertical position of an element.It returns pixels from the edge of the frame. |
| storeElementPresent | This command is used to verifiy that the specified element is somewhere on the page.It returns true if the element is present, false otherwise |
| storeEval | This command is used to get the result of evaluating the specified JavaScript snippet. The snippet may have multiple lines, but only the result of the last line will be returned. |
| storeExpression | Generated from getExpression(expression) This is useful because of JavaScript preprocessing. It is used to generate commands like assertExpression and waitForExpression. |
| storeFontSize | This command is used to retrieve the css font-size attribute value applied to that element.It returns font-size in pixels. |
| storeFontStyle | Generated from getFontStyle(locator) Retrieves the CSS font-style attribute value applied to that element |
| storeFontWeight | Generated from getFontWeight(locator) Retrieves the CSS font-weight attribute value applied to that element |
| storeHeight | This command is used to retrieve the css height attribute value applied to that element.It returns height in pixels. |
| storeHtmlSource | This command returns the entire HTML source between the opening and closing "html" tags.It returns the entire HTML source. |
| storeKeyboardVisible | True, if keyboard is visible else false. |
| storeLocation | This command gets the absolute URL of the current page. |
| storeMarginBottom | Generated from getMarginBottom(locator) Retrieves the CSS margin-bottom attribute value applied to that element |
| storeMarginLeft | Generated from getMarginLeft(locator) Retrieves the CSS margin-left attribute value applied to that element. |
| storeMarginRight | Generated from getMarginRight(locator) Retrieves the CSS margin-right attribute value applied to that element. |
| storeMarginTop | Generated from getMarginTop(locator) Retrieves the CSS margin-top attribute value applied to that element. |
| storeMouseSpeed | Generated from getMouseSpeed() Returns the number of pixels between \"mousemove\" events during dragAndDrop commands (default=10). |
| storeOpacity | Generated from getOpacity(locator) Retrieves the CSS opacity attribute value applied to that element. |
| storeOverflow | Generated from getOverflow(locator) Retrieves the CSS overflow attribute value applied to that element. |
| storePaddingBottom | Generated from getPaddingBottom(locator) Retrieves the CSS padding-bottom attribute value applied to that element. |
| storePaddingLeft | Generated from getPaddingLeft(locator) Retrieves the CSS padding-left attribute value applied to that element. |
| storePaddingRight | Generated from getPaddingRight(locator) Retrieves the CSS padding-Right attribute value applied to that element. |
| storePaddingTop | Generated from getPaddingTop(locator) Retrieves the CSS padding-top attribute value applied to that element. |
| storePerformanceData | returns the resource usage information of the application. the resource is one of the system states which means cpuinfo, memoryinfo, networkinfo, and batteryinfo. |
| storePosition | Generated from getPosition(locator) Retrieves the CSS position attribute value applied to that element. |
| storePrompt | Generated from getPrompt(locator) This command is used to store the message of a JavaScript question prompt dialog generated during the previous action. Successful handling of the prompts requires prior execution of the answerOnNextPrompt command. If a prompt is generated but you do not get/verify it, the next QaSCRIBE action will fail. NOTE: under QaSCRIBE, JavaScript prompts will NOT pop up a visible dialog. NOTE: QaSCRIBE does NOT support JavaScript prompts that are generated in a page's onload() event handler. In this case, a visible dialog WILL be generated and QaSCRIBE will hang until someone manually clicks OK. |
| storePromptPresent | Generated from isPromptPresent() This command is used to store the visibility of a JavaScript Prompt. |
| storeRandomNumber | This command is used to generate a random number with the specified integer. It also accepts a range of integers (hyphen separated with or without spaces before and after the hyphen). |
| storeSelectedId | Generated from getSelectedId(selectLocator) Gets option element ID for selected option in the specified select element. |
| storeSelectedIds | Generated from getSelectedIds(selectLocator) Gets all option element IDs for selected options in the specified select or multi-select element. |
| storeSelectedIndex | This command gets option index (option number, starting at 0) for selected option in the specified select element.It returns selected option index in the specified select drop-down. |
| storeSelectedIndexes | Generated from getSelectedIndexes(selectLocator) This command gets all option indexes (option number, starting at 0) for selected options in the specified select or multi-select element. |
| storeSelectedLabel | This command gets option label (visible text) for selected option in the specified select element. It returns selected option label in the specified select drop-down |
| storeSelectedLabels | This command gets all option labels (visible text) for selected options in the specified select or multi-select element. It returns an array of all selected option labels in the specified select drop-down |
| storeSelectedValue | This command gets option value (value attribute) for selected option in the specified select element.It returns the selected option value in the specified select drop-down. |
| storeSelectedValues | Generated from getSelectedValues(selectLocator). This command gets all option values (value attributes) for selected options in the specified select or multi-select element. |
| storeSelectOptions | This command gets all option labels in the specified select drop-down.It returns an array of all option labels in the specified select drop-down. |
| storeSomethingSelected | Generated from isSomethingSelected(selectLocator) This command stores the selected option in a drop-down menu. |
| storeSpeed | This command is used to get execution speed (i.e., get the millisecond length of the delay following each QaSCRIBE operation). By default, there is no such delay, i.e., the delay is 0 milliseconds. |
| storeSystemTime | Stores the time on the device |
| storeTable | This command is used to store the text from the specified cell in a variable. |
| storeTableToDatsset | This command is used to store entire table content into a dataset and also to fetch the content for specfied columns. This command's target may require startColumnIndex and endColumnIndex which are optional and if not provided the entire table contents is retrieved and saved to the dataset. |
| storeText | This command gets the text of an element. This works for any element that contains text. This command uses either the textContent (Mozilla-like browsers) or the innerText (IE-like browsers) of the element, which is the rendered text shown to the user. |
| storeTextAlign | Generated from getTextAlign(locator) This command retrieves the text-align - CSS attribute value applied to that element |
| storeTextDecoration | Generated from getTextDecoration(locator) This command retrieves the CSS text-decoration attribute value applied to that element. |
| storeTextOrientation | Generated from getTextOrientation(locator) This command retrieves the CSS text-orientation attribute value applied to that element. |
| storeTimeStamp | This command is used to get current time in (yyyymmddhhmiss) format. |
| storeTitle | This command gets the title of the current page. |
| storeValue | Gets the (whitespace-trimmed) value of an input field (or anything else with a value parameter). For checkbox/radio elements, the value will be "on" or "off" depending on whether the element is checked or not.. 'ON' means selected and 'OFF' means not selected. |
| storeVerticalAlign | This command is used to retrieve the css vertical-align attribute value applied to that element |
| storeVisible | This command determines if the specified element is visible. An element can be rendered invisible by setting the CSS "visibility" property to "hidden", or the "display" property to "none", either for the element itself or one if its ancestors. This method will fail if the element is not present. if the specified element is visible, false otherwise |
| storeWidth | This command is used to retrieve the css width attribute value applied to that element. It returns width in pixels. |
| storeXpathCount | This command returns the number of nodes that match the specified xpath, eg. "//table" would give the number of tables. |
| submit | Submit the specified form. This is particularly useful for forms without submit buttons, e.g. single-input \" Search\" forms. |
| submitAndWait | Generated from submit (formLocator) Submit the specified form. This is particularly useful for forms without submit buttons, e.g. single-input \" Search\" forms. |
| sum |
|
| swipe | Simulates the user swiping the mobile screen up or down.Coordinates should be in integer format. |
T
| Command | Purpose |
|---|---|
| tap | This command is used to perform the click operation on the specified locator. Similar to SingleTap. |
| timerForKeyEventBlockStart | This command is used to indicate the start of the block. Please note it is mandatory to have a User Defined Variable with the name "LogLevel". |
| timerForKeyEventBlockEnd | This command is to indicate the end of the block . |
| timerForTestInstructionsBlockStart | This command is mandatory to start the block of commands for calculating the time it took to execute the commands until the timerForTestInstructionsBlockEnd is encountered. The log level values that are supported are ALL,DEBUG,INFO,WARN,ERROR,FATAL,OFF. |
| timerForTestInstructionsBlockEnd | This command is to indicate the end of the block. |
| toggleLocationServices | Toggles the location Icon. |
| touchDown | Finger down on the screen. |
| touchDownAt | Finger down on the screen using the x,y coordinates. Coordinates should be in integer format. |
| touchUp | Finger up on the screen. |
| type | Sets the value of an input field, as though you typed it in. Can also be used to set the value of combo boxes, check boxes, etc. In these cases, value should be the value of the option selected, not the visible text. |
| typeAndWait | Sets the value of an input field, as though you typed it in. Can also be used to set the value of combo boxes, check boxes, etc. In these cases, value should be the value of the option selected, not the visible text. |
U
| Command | Purpose |
|---|---|
| uncheck | Uncheck a toggle-button (checkbox/radio) |
| uncheckAndWait | Unchecks a toggle-button (checkbox/radio) and waits |
| unlock | Unlock the device.. |
V
Verifies the resource usage information of the application. The resource is one of the system states which means CPU Info, Memory Info, Network Info, and Battery Info. This command is supported only for Android Devices. This command fails if the value matches.| Command | Purpose |
|---|---|
| verifyAlert | This command is used to verify the most recent javascript alert is present on the page or not. |
| verifyAlertNotPresent | This command is used to verify, If an alert is generated and it is handled, is no longer present on the page. |
| verifyAlertPresent | If an alert is generated, you would want to verify the alert is present. |
| verifyAllButtons | This Command is used to Verify the IDs of all buttons in that page |
| verifyAllFields | This Command is used to Verify the IDs of all fields on the page |
| verifyAllLinks | This Command is used to Verify the IDs of all links on the page |
| verifyAllWindowNames | Generated from getAllWindowNames() Returns the names of all windows that the browser knows about in an array. |
| verifyAllWindowTitles | Generated from getAllWindowTitles() Returns the titles of all windows that the browser knows about in an array. |
| verifyAttribute | This Command is used to Verify the value of an element attribute. The value of the attribute may differ across browsers (this is the case for the "style" attribute, for example). |
| verifyAttributeFromAllWindows | Generated from getAttributeFromAllWindows(attributeName) Returns an array of JavaScript property values from all known windows having one. |
| verifyBackgroundColor | This Command is used to Verify the css background-color attribute value applied to that element. |
| verifyBackgroundImage | Generated from getBackgroundImage(locator) Retrieves the CSS background-image attribute value applied to that element and compares the pattern given in Value. Fails if the specified element doesn't exist or doesn't match the pattern. |
| verifyBackgroundPosition | Generated from getBackgroundPosition(locator). Retrieves the CSS background-position attribute value applied to that element. |
| verifyBackgroundRepeat | Generated from getBackgroundRepeat(locator). Retrieves the CSS background-repeat attribute value applied to that element. |
| verifyBodyText | Generated from getBodyText(). This command is used to get the entire text in the body tag, of the webpage. |
| verifyBorderColor | Generated from getBorderColor(locator) Retrieves the CSS border-color attribute value applied to that element. |
| verifyBorderRadius | Generated from getBorderRadius(locator) Retrieves the CSS border-radius attribute value applied to that element |
| verifyBorderStyle | Generated from getBorderStyle(locator)) Retrieves the CSS border style attribute value applied to that element. |
| verifyBorderWidth | Generated from getBorderWidth(locator) Retrieves the CSS border-width attribute value applied to that element |
| verifyChecked | This Command is used to Verify the whether the toggle-buttons (checkbox/Radi buttons) is checked or not |
| verifyColor | This Command is used to Verify the css color of an element on the web page. |
| verifyConfirmation | This Command is used to Verify the confirmation messages of the most recent JavaScript confirmation dialogs. |
| verifyConfirmationNotPresent | Generated from isConfirmationNotPresent() This function never throws an exception. |
| verifyConfirmationPresent | Generated from isConfirmationNotPresent() This function never throws an exception. |
| verifyContentDescription | Verifies the content-desc pattern of an element. |
| verifyCookie | This Command is used to Verify whether there are any cookies present in that particular page |
| verifyCookieByName | This Command is used to Verify the cookie is present in the page by its name |
| verifycookienotpresent | This Command is used to Verify whether the cookie is not present in the page. |
| verifyCookiePresent | This Command is used to Verify whether the cookie is present in the page. |
| verifyCursorPosition | Generated from getCursorPosition(locator) Retrieves the text cursor position in the given input element or text area beware, this may not work perfectly on all browsers. Specifically, if the cursor/selection has been cleared by JavaScript, this command will tend to return the position of the last location of the cursor, even though the cursor is now gone from the page. This method will fail if the specified element isn't an input element or text area, or there is no cursor in the element. |
| verifyDisplay | Generated from getDisplay(locator). Retrieves the CSS display attribute value applied to that element. |
| verifyCurrentActivity | Verifies current activity's details. This command is supported only for Android Devices. |
| verifyCurrentPackage | Verifies current package's details. This command is supported only for Android Devices. |
| verifyDeviceSettings | Verifies the current settings on the device. |
| verifyEditable | This Command is used to Verify whether the particular input field is editable or not |
| verifyElementHeight | This Command is used to Verify the height of an element |
| verifyElementIndex | This Command is used to verify relative index of the element to its parent (starting from 0).The comment node and empty text node will be ignored. |
| verifyElementLocation | Verifies the location of an element. |
| verifyElementSize | Verifies the Size of an element. |
| verifyElementNotPresent | This Command is used to Verify whether the element is present in the page or not |
| verifyElementPositionLeft | Retrieves and verifies the horizontal position of an element,pixels from the edge of the frame. |
| verifyElementPositionTop | Retrieves and verifies the vertical position of an element, pixels from the edge of the frame. |
| verifyElementPresent | Verifies that the specified element is somewhere on the page. |
| verifyElementWidth | Retrieves the width of an element |
| verifyEval | Gets the result of evaluating the specified JavaScript snippet. The snippet may have multiple lines, but only the result of the last line will be returned.Note that, by default, the snippet will run in the context of the "QaSCRIBE" object itself, so this will refer to the QaSCRIBE object. Use window to refer to the window of your application, e.g. window.document.getElementById('foo')If you need to use a locator to refer to a single element in your application page, you can use this.browserbot.findElement("id=foo") where "id=foo" is your locator. |
| verifyExpression | This is useful because of JavaScript preprocessing. It is used to generate commands like assertExpression and waitForExpression.Returns the specified expression in true or false and continues with execution. |
| verifyFloat | Retrieves the CSS float attribute value applied to that element. |
| verifyFontFamily | Retrieves the css font-family attribute value applied to that element.Returns the font-family with true or false and continues with execution. |
| verifyFontSize | Retrieves the css font-size attribute value applied to that element.Returns the font-family with true or false and continues with execution. |
| verifyFontStyle | This command is used to verify the css font style attribute value applied to that element |
| verifyFontWeight | Retrieves the css font-weight attribute value applied to that element.Returns the font-family with true or false and continues with execution. |
| verifyHeight | Retrieves and verifies the css height attribute value applied to that element , height in pixels. |
| verifyHtmlSource | Returns the entire HTML source between the opening and closing 'HTML' tags. |
| verifyKeyboardVisible | Pass, if the keyboard is visible else fail. |
| verifyLocation | Gets the absolute URL of the current page. |
| verifyMarginBottom | Generated from getMarginBottom(locator). This command retrieves the CSS margin-bottom attribute value applied to that element |
| verifyMarginLeft | Generated from getMarginLeft(locator). This command retrieves the CSS margin-left attribute value applied to that element |
| verifyMarginRight | Generated from getMarginRight(locator). This command retrieves the CSS margin-right attribute value applied to that element |
| verifyMarginTop | Generated from getMarginTop(locator). This command retrieves the CSS margin-top attribute value applied to that element |
| verifyMouseSpeed | Generated from getMouseSpeed() This command returns the number of pixels between 'mousemove' events during dragAndDrop commands (default=10). |
| verifyNotAlert | This command verifies the absence of an Alert, or fail if there are any alerts. Getting an alert has the same effect as manually clicking OK. If an alert is generated but you do not consume it with getAlert, the next Selenium action will fail. Under Selenium, JavaScript alerts will NOT pop up a visible alert dialog. Selenium does NOT support JavaScript alerts that are generated in a page's onload() event handler. In this case, a visible dialog WILL be generated and Selenium will hang until someone manually clicks OK. |
| verifyNotAllButtons | |
| verifyNotAllFields | |
| verifyNotAllLinks | |
| verifyNotAllWindowNames | This command returns the names of all windows that the browser knows about in an array. |
| verifyNotAllLinks | |
| verifyNotAllWindowNames | This command returns the names of all windows that the browser knows about in an array. |
| verifyNotAllWindowTitles | This command returns the titles of all windows that the browser knows about in an array. |
| verifyNotAttribute | Retrieves and verifies if the value of the specified element is not an attribute. The value of the attribute may differ across browsers (this is the case for the "style" attribute, for example).Returns true or false and continues execution. |
| verifyNotAttributeFromAllWindows | This command is used not to verify the attributes from all windows. |
| verifyNotBackgroundColor | This command is used to verify the element color is not similar to background color. |
| verifyNotBackgroundImage | Generated from getBackgroundColor(locator) This command retrieves the CSS background-image attribute value applied to that element. |
| verifyNotBackgroundPosition | Generated from getBackgroundPosition(locator) This command retrieves the CSS background-position attribute value applied to that element. |
| verifyNotBackgroundRepeat | Generated from getBackgroundRepeat(locator) This command retrieves the CSS background-repeat attribute value applied to that element. |
| verifyNotBodyText | Generated from getBodyText() This command verifies the entire text of the page. and fails if the pattern matches. |
| verifyNotBorderColor | Generated from getBorderColor(locator) This command retrieves the CSS border-color attribute value applied to that element, passes if the color does not match. |
| verifyNotBorderRadius | Generated from getBorderRadius(locator) This command retrieves the CSS border-radius attribute value applied to that element, passes if the radius doesn't match. |
| verifyNotBorderWidth | Generated from getBorderWidth(locator) This command retrieves the CSS border-width attribute value applied to that element and fails if the width matches verification value. |
| verifyNotChecked | Gets whether a toggle-button (checkbox/radio) is checked. Fails if the specified element doesn't exist or isn't a toggle-button. |
| verifyNotColor | Generated from getColor(locator). This command retrieves the CSS color attribute value applied to that element and compares with the pattern in Value. This command verifies the CSS color of an element retrieved doesn't match with the pattern given in value. If the specified RGB format is present on the UI; the execution gets aborted. |
| verifyNotConfirmation | Generated from getColor(locator). This command checks for the JavaScript confirmation dialogs. Pass if there is no JavaScript confirmation dialog generated during the previous action. By default, the confirm function will return true, having the same effect as manually clicking OK. This can be changed by prior execution of the chooseCancelOnNextConfirmation command. |
| verifyNotCookie | To check all cookies of the current page under test. |
| verifyNotCookieByName | To verify the value of the cookie with the specified name, or throws an error if the cookie is not present. |
| verifyNotCursorPosition | This command retrieves the text cursor position in the given input element or text area; beware, this may not work perfectly on all browsers. Specifically, if the cursor/selection has been cleared by JavaScript, this command will tend to return the position of the last location of the cursor, even though the cursor is now gone from the page. This is filed as SEL-243. This method will fail if the specified element isn't an input element or text area, or there is no cursor in the element |
| verifyNotCurrentActivity | Verifies current activity's details. This command fails if the activity name matches This command is supported only for Android Devices. |
| verifyNotCurrentPackage | Verifies current package's details, it fails when the package name matches This command is supported only for Android Devices. |
| verifyNotDeviceSettings | Verifies the current settings on the device. This command passes when the actual settings and settings mentioned on target do not match. |
| verifyNotDisplay | To Retrieves the css display attribute value applied to that element. |
| verifyNotEditable | To determine whether the specified input element is editable, ie hasn't been disabled. |
| verifyNotElementHeight | This command retrieves the height of an element passes if the height does not match. |
| verifyNotElementPositionLeft | Generated from getElementPositionLeft(locator) This command verifies the horizontal position of an element but fails if the position is true. |
| verifyNotElementWidth | Retrieves the width of an element, passes if the width to be verified does not match the actual width. |
| verifyNotEval | To verify the result of evaluating the specified JavaScript snippet. |
| verifyNotExpression | This is useful because of JavaScript preprocessing. It is used to generate commands like assertExpression and waitForExpression. It returns true if the target is not an expression. |
| verifyNotFloat | Generated from getFloat(locator) This command retrieves the CSS float attribute value applied to that element, this command passes when the pattern value doesn't match the actual value. |
| verifyNotFontFamily | Generated from getFontFamily(locator) Retrieves the CSS font-family attribute value applied to that element. It returns true if the font-family of text at the locator in the target is not the same as the value. |
| verifyNotFontSize | Generated from getFontSize(locator) Retrieves the CSS font-size attribute value applied to that element. It returns true if the font-size of text at the locator in the target is not the same as the value. |
| verifyNotFontStyle | Generated from getFontStyle(locator) Retrieves the CSS font-style attribute value applied to that element It returns true if the font-style of text at the locator in the target is not the same as the value. |
| verifyNotFontWeight | Generated from getFontWeight(locator) Retrieves the CSS font-weight attribute value applied to that element. It returns true if the font-weight of text at the locator in the target is not the same as the value. |
| verifyNotHtmlSource | Generated from getHtmlSource() This command returns the entire HTML source between the opening and closing 'HTML' tags, this commands passes when the contents of the pattern do not match the actual value. |
| verifyNotKeyboardVisible | Fails, if the keyboard is visible else pass. |
| verifyNotLocation | To verify the absolute URL of the current page. |
| verifyNotMarginBottom | Generated from getMarginBottom(locator) This command retrieves the CSS margin-bottom attribute value applied to that element. |
| verifyNotMarginLeft | Generated from getMarginLeft(locator) This command retrieves the CSS margin-bottom attribute value applied to that element. |
| verifyNotMarginRight | Generated from getMarginRight(locator) This command retrieves the CSS margin-bottom attribute value applied to that element. |
| verifyNotMarginTop | Generated from getMarginTop(locator) This command retrieves the CSS margin-top attribute value applied to that element. |
| verifyNotMouseSpeed | Generated from getMouseSpeed() This command returns the number of pixels between \"mousemove\" events during dragAndDrop commands (default=10). |
| verifyNotOpacity | Generated from getOpacity(locator) This command retrieves the CSS opacity attribute value applied to that element. |
| verifyNotOverflow | Generated from getOverflow(locator) This command retrieves the CSS overflow attribute value applied to that element |
| verifyNotPaddingBottom | Generated from getPaddingBottom(locator) This command retrieves the CSS padding-bottom attribute value applied to that element |
| verifyNotPaddingLeft | Generated from getPaddingLeft(locator) This command retrieves the CSS padding-left attribute value applied to that element |
| verifyNotPaddingRight | Generated from getPaddingRight(locator) This command retrieves the CSS padding-right attribute value applied to that element |
| verifyNotPaddingTop | Generated from getPaddingRight(locator) This command retrieves the CSS padding-top attribute value applied to that element |
| verifyNotPosition | Generated from getPosition(locator) This command retrieves the CSS position attribute value applied to that element |
| verifyNotPrompt | Generated from getPrompt() Successful handling of the prompt requires prior execution of the answerOnNextPrompt command. If a prompt is generated but you do not get/verify it, the next Selenium action will pass. |
| verifyNotSelectedId | Gets option element ID for selected option in the specified select element. It returns true when the selected ID(in Target) is not same as the value |
| verifyNotSelectedIds | Gets all option element IDs for selected options in the specified select or multi-select element. It returns true when the IDs(in Target) is not same as the value. |
| verifyNotSelectedIndex | This command gets option index (option number, starting at 0) for selected option in the specified select element. It returns true when the index of the selected item in the Drop-Down menu (in Target) is not same as the value |
| verifiedNotSelectedIndexes | This command gets all option indexes (option number, starting at 0) for selected options in the specified select or multi-select element. It returns true when the indexes of the items in the Drop-Down menu (in Target) is not same as the value. |
| verifyNotSelectedValue | Generated from getSelectedValue(selectLocator) Gets option value (value attribute) for selected option in the specified select element. This command is used to verify if the pattern in Value attribute for selected option in the specified select element doesn't match with the specified pattern given in Value. |
| verifyNotSelectedValues | Gets all option values (value attributes) for selected options in the specified select or multi-select element. It returns true when the values (attribute) of the elements(in Target) is not same as the value(field) |
| verifyNotSelectOptions | Gets all option labels in the specified select drop-down. It returns true when the option labels of the elements(in Target) is not same as the value. |
| verifyNotPerformanceData | Verifies the resource usage information of the application. The resource is one of the system states which means CPU Info, Memory Info, Network Info, and Battery Info. This command is supported only for Android Devices. This command fails if the value matches. |
| verifyNotSelectedLabel | To verify the option label (visible text) for selected option is not in the specified select element. |
| verifyNotSelectedLabels | To verify all the option labels (visible text) for selected options is not in the specified select or multi-select element. |
| verifyNotSpeed | To Get execution speed. |
| verifyNotSomethingSelected | This command determines whether some option in a drop-down menu is selected, this command passes when the pattern does not match the actual value. |
| verifyNotSystemTime | Verifies system's current time with the target. This command passes if the time does not match. |
| verifyNotTable | Gets the text from a cell of a table. The cellAddress syntax tableLocator.row.column, where row and column start at 0. |
| verifyNotText | To Gets the text of an element. |
| verifyNotTextAlign | Generated from getTextAlign(locator) This command retrieves the text-align - CSS attribute value applied to that element, the command passes when the pattern and actual value do not match. |
| verifyNotTextDecoration | Generated from getTextDecoration(locator) This command retrieves the CSS text-decoration attribute value applied to that element, the command passes when the pattern and actual value do not match. |
| verifyNotTextOrientation | Generated from getTextOrientation(locator) This command retrieves the CSS text-orientation attribute value applied to that element, the command passes when the pattern and actual value do not match. |
| verifyNotTitle | To verify the title of selected window is not equals to given title. |
| verifyNotValue | To verify checkbox/radio elements, the value will be "on" or "off" depending on whether the element is checked or not. |
| verifyNotVerticalAlign | Generated from getVerticalAlign(locator) This command retrieves the CSS vertical-align attribute value applied to that element, the command passes when the pattern and actual value do not match. |
| verifyNotVisible | To verify checkbox/radio elements, the value will be "on" or "off" depending on whether the element is checked or not. |
| verifyNotWidth | Generated from getWidth(locator) This command retrieves the CSS width attribute value applied to that element. |
| verifyNotXpathCount | Generated from getXpathCount(XPath) This command returns the number of nodes that match the specified XPath, eg. '//table' would give the number of tables. This command passes when the number of XPaths does not match the actual value. |
| verifyOpacity | Generated from getOpacity(locator) This command retrieves the CSS opacity attribute value applied to that element. |
| verifyOverflow | This command is useful to verify the css overflow attribute value applied to that element. |
| verifyPaddingBottom | Generated from getPaddingBottom(locator) This command retrieves the CSS padding-bottom attribute value applied to that element. |
| verifyPaddingLeft | Generated from getPaddingLeft(locator) This command retrieves the CSS padding-left attribute value applied to that element. |
| verifyPaddingRight | Generated from getPaddingRight(locator) This command retrieves the CSS padding-right attribute value applied to that element. |
| verifyPaddingTop | Generated from getPaddingTop(locator) This command retrieves the CSS padding-top attribute value applied to that element. |
| verifyOverlappingUserInterfaceElements | This command is used to know whether or not each UI element/locator in the input data set overlaps with at least one other UI element/locator in the input dataset. The response Data Set will have the true or false values against the locator. For that details on which element overlaps, the command 'getOverlappingUserInterfaceElements' has to be used. Note: Data Definition that defines the request data set must contain the following column names: Element, ElementGroup, GroupParentIndicator, CoordinateRight, CoordinateLeft, CoordinateTop, CoordinateBottom. The response dataset contains 2 columns.
|
| verifyPerformanceData | Verifies the resource usage information of the application. The resource is one of the system states which means CPU Info, Memory Info, Network Info, and Battery Info. This command is supported only for Android Devices. |
| verifyPosition | This command is useful to Verify the css position attribute value applied to that element. |
| verifyPrompt | Generated from getPrompt() This command is used to verify the message of a JavaScript question prompt dialog generated during the previous action. Successful handling of the prompts requires prior execution of the answerOnNextPrompt command. |
| verifyPromptNotPresent | This command returns true if there is no pending prompt and never throws an exception |
| verifyPromptPresent | Generated from isPromptNotPresent() Has a prompt occurred? This function never throws an exception. |
| verifyRandomNumber | Generated from getRandomNumber(Integer) This command is used to generate randomNumber with the specified length. |
| verifySelectedId | Generated from getSelectedId(selectLocator). This command gets option element ID for selected option in the specified select element. |
| verifySelectedIds | Generated from getSelectedIds(selectLocator). This command gets option element ID for selected option in the specified select element. |
| verifySelectedIndex | Generated from getSelectedIndex(selectLocator). This command gets option index (option number, starting at 0) for selected option in the specified select element. |
| verifySelectedIndexes | Generated from getSelectedIndex(selectLocator). This command gets all option indexes (option number, starting at 0) for selected options in the specified select or multi-select element. |
| verifySelectedLabel | Verifies option label (visible text) for selected option in the specified select element. |
| verifySelectedLabels | Verifies all option labels (visible text) for selected options in the specified select or multi-select element. |
| verifySelectedValue | Generated from getSelectedValue(selectLocator) This command is used to verify if the pattern of value attribute for selected option in the specified select element matches the pattern given in the Value. |
| verifySelectedValues | Generated from getSelectedValues(selectLocator). This command gets all option values (value attributes) for selected options in the specified select or multi-select element. |
| verifySelectOptions | Gets all option labels in the specified select drop-down. |
| verifySomethingSelected | Generated from isSomethingSelected(selectLocator) This command is used to verify whether some option in a drop-down menu is selected or not. |
| verifySpeed | Get execution speed (i.e., get the millisecond length of the delay following each QaSCRIBE operation). By default, there is no such delay, i.e., the delay is 0 milliseconds. See also setSpeed. |
| verifySystemTime | Verifies system's current time with the target provided. |
| verifyTable | Gets the text from a cell of a table. The cellAddress syntax tableLocator.row.column, where row and column start at 0. |
| verifyText | Gets the text of an element. This works for any element that contains text. This command uses either the textContent (Mozilla-like browsers) or the innerText (IE-like browsers) of the element, which is the rendered text shown to the user. |
| verifyTextAlign | Retrieves the text-align - css attribute applied on that element |
| verifyTextDecoration | Generated from getTextDecoration(locator) This command retrieves the CSS text-decoration attribute value applied to that element. |
| verifyTextNotPresent | Generated from isTextPresent(pattern). This command verifies that the specified text pattern appears somewhere on the rendered page visible to the user |
| verifyTextPresent | Verifies that the specified text pattern appears somewhere on the rendered page shown to the user. |
| verifyTextOrientation | Generated from getTextOrientation(locator) This command retrieves the CSS text-orientation attribute value applied to that element |
| verifyTitle | To verify the title of the current page. |
| verifyTimeStamp | Generated from getTimeStamp() This command is used to get the current time in (yyyymmddhhmiss) format |
| verifyValue | This command verifies the (whitespace-trimmed) value of an input field (or anything else with a value parameter). For checkbox/radio elements, the value will be "on" or "off" depending on whether the element is checked or not. |
| verifyVisible | Verifies the specified element is visible. An element can be rendered invisible by setting the CSS "visibility" property to "hidden", or the "display" property to "none", either for the element itself or one if its ancestors. This method will fail if the element is not present. |
| verifyWidth | Verifies the css width (width in pixels.) attribute value applied to that element. |
| verifyXpathCount | Verifies the number of nodes that match the specified xpath, eg. "//table" would give the number of tables. |
W
| Command | Purpose |
|---|---|
| waitForAlert | This command is used to wait for alert if the alert is occuring after performing actions on the web page.Getting an alert has the same effect as manually clicking OK. If an alert is generated but you do not consume it with getAlert, the next QaSCRIBE action will fail. Under QaSCRIBE, JavaScript alerts will NOT pop up a visible alert dialog. QaSCRIBE does NOT support JavaScript alerts that are generated in a page's onload() event handler. In this case a visible dialog WILL be generated and QaSCRIBE will hang until someone manually clicks OK. |
| waitForAlertNotPresent | This command is used to check whether the alert is present or not. This function never throws an exception. |
| waitForAlertPresent | This command is used to check whether the alert is present or not. This function never throws an exception. |
| waitForAllButtons | This command is used to return the IDs of all buttons present on the page. If a given button has no ID, it will appear as "" in this array. |
| waitForAllFields | This command is used to return the IDs of all input fields on the page. If a given field has no ID, it will appear as "" in this array. |
| waitForAllLinks | This command is used to return the IDs of all links on the page. If a given link has no ID, it will appear as "" in this array. |
| waitForAllWindowNames | This command waits for the names of all windows that the browser knows about in an array. |
| waitForAllWindowTitles | This command is used to returns the titles of all windows that the browser knows about in an array. |
| waitForAttribute | This command is used to wait for the value of an attribute of particular element. The value of the attribute may differ across browsers (this is the case for the "style" attribute, for example). |
| waitForAttributeFromAllWindows | TGenerated from getAttributeFromAllWindows(attributeName) This command waits for an array of JavaScript property values from all known windows having one. |
| waitForBackgroundColor | This command is used to wait for the css background color of particular element/locator. |
| waitForBackgroundImage | Generated from getBackgroundImage(locator) This command waits for the CSS background-image attribute value applied to that element |
| waitForBackgroundPosition | Generated from getBackgroundPosition(locator) This command waits for the CSS background-position attribute value applied to that element. |
| waitForBackgroundRepeat | Generated from getBackgroundRepeat(locator) This command waits for the CSS background-repeat attribute value applied to that element. |
| waitForBodyText | Generated from Generated from getBodyText() This command waits for the entire text of the page |
| waitForBorderColor | Generated from Generated from getBorderColor(locator) This command waits for the CSS border-color attribute value applied to that element |
| waitForBorderRadius | Generated from Generated from getBorderRadius(locator) This command waits for the CSS border-radius attribute value applied to that element |
| waitForBorderStyle | Generated from Generated from getBorderStyle(locator) This command waits for the CSS border-style attribute value applied to that element |
| waitForBorderWidth | Generated from Generated from getBorderWidth(locator) This command waits for the CSS border-width attribute value applied to that element |
| waitForChecked | This command is used to wait to check a toggle-button (checkbox/radio). Fails if the specified element doesn't exist or isn't a toggle-button. |
| waitForColor | This command is used to wait for the css color of specified element. |
| waitForCondition | Runs the specified JavaScript snippet repeatedly until it evaluates to \"true\". The snippet may have multiple lines, but only the result of the last line will be considered. Note that, by default, the snippet will be run in the runner's test window, not in the window of your application. To get the window of your application, you can use the JavaScript snippet selenium.browserbot.getCurrentWindow(), and then run your JavaScript in there |
| waitForConfirmation | This command is used to wait till the most recent JavaScript alert has confirmed. Retrieves the message of a JavaScript confirmation dialog generated during the previous action. By default, the confirm function will return true, having the same effect as manually clicking OK. This can be changed by prior execution of the chooseCancelOnNextConfirmation command. If an confirmation is generated but you do not consume it with getConfirmation, the next Selenium action will fail. NOTE: under Selenium, JavaScript confirmations will NOT pop up a visible dialog. NOTE: Selenium does NOT support JavaScript confirmations that are generated in a page's onload() event handler. In this case a visible dialog WILL be generated and Selenium will hang until you manually click OK. |
| waitForConfirmationNotPresent | Generated from isConfirmationNotPresent() This command waits for the absence of a Confirmation window to appear. |
| waitForConfirmationPresent | This command is used to wait till the JavaScript confirmation is present. This function never throws an exception. |
| waitForContentDescription | wait for the content-desc pattern of an element. |
| waitForCookie | This command is used to wait till all cookies of the current page under test are present. |
| waitForCookieByName | \95This command is used to wait till the value of the cookie with the specified name present. Throws an error if the cookie is not present. |
| waitForCookieNotPresent | This command is used to wait till the cookie with the specified name is present. This command waits by default 120 seconds. |
| waitForCookiePresent | It waits for the specified cookie name on the Screen. |
| waitForCursorPosition | Generated from getCursorPosition(locator) This command waits for the text cursor position in the given input element or text area; beware, this may not work perfectly on all browsers. Specifically, if the cursor/selection has been cleared by JavaScript, this command will tend to return the position of the last location of the cursor, even though the cursor is now gone from the page. This is filed as SEL-243. This method will fail if the specified element isn't an input element or text area, or there is no cursor in the element. |
| waitForDisplay | Generated from getDisplay(locator) This command waits for the CSS display attribute value applied to that element |
| waitForCurrentActivity | Waits for current activity's details. This command is supported only for Android Devices. |
| waitForCurrentPackage | Waits for current package's details. This command is supported only for Android Devices. |
| waitForDeviceSettings | Waits for the current settings on the device. |
| waitForEditable | Determines whether the specified input element is editable, ie hasn't been disabled. This method will fail if the specified element isn't an input element. |
| waitForElementHeight | Generated from getHeight(locator) This command waits for the height of an element. |
| waitForElementIndex | This command waits for the relative index of an element to its parent (starting from 0). The comment node and empty text node will be ignored. |
| waitForElementLocation | wait for location of an element. |
| waitForElementNotPresent | Verifies that the specified element is not present on the page. |
| waitForElementPositionLeft | This command waits for the horizontal position of an element. waitForElementPositionLeft(locator, pattern) |
| waitForElementPositionTop | This command waits for the vertical position of an element. waitForElementPositionTop(locator, pattern) |
| waitForElementSize | wait for Size of an element. |
| waitForElementPresent | Verifies that the specified element is somewhere on the page. |
| waitForElementWidth | This command waits for the width of an element. waitForElementWidth(locator, pattern) |
| waitForEval | Gets the result of evaluating the specified JavaScript snippet. The snippet may have multiple lines, but only the result of the last line will be returned. |
| waitForExpression | Generated from getExpression(expression) This command waits for JavaScript preprocessing. It is used to generate commands like assertExpression. waitForExpression(expression, pattern) |
| waitForFloat | Generated from getFloat(locator) This command waits for the CSS float attribute value applied to that element waitForFloat(locator, pattern) |
| waitForFontFamily | Retrieves the css font-family attribute value applied to that element. |
| waitForFontSize | Retrieves the css font-size attribute value applied to that element. |
| waitForFontStyle | Generated from getFontStyle(locator) This command waits for the CSS font-style attribute value applied to that element. waitForFontStyle(locator, pattern) |
| waitForFontWeight | Generated from getFontWeight(locator) This command waits for the CSS font-weight attribute value applied to that element waitForFontWeight(locator, pattern) |
| waitForFrameToLoad | Waits for a new frame to load. QaSCRIBE constantly keeps track of new pages and frames loading, and sets a "newPageLoaded" flag when it first notices a page load. See waitForPageToLoad for more information. |
| waitForHeight | Generated from getHeight(locator) This command waits for the CSS height attribute value applied to that element waitForHeight(locator, pattern) |
| waitForHtmlSource | Generated from getHtmlSource() This command waits for the entire HTML source between the opening and closing \"html\" tags. waitForHtmlSource(pattern) |
| waitForKeyboardVisible | Waits for the keyboard to be visible. Pass, if the keyboard is visible else fail. |
| waitForLocation | Waits for a URL of the current page. |
| waitForMarginBottom | Generated from getMarginBottom(locator) This command waits for the CSS margin-bottom attribute value applied to that element. waitForMarginBottom(locator, pattern) |
| waitForMarginLeft | Generated from getMarginLeft(locator) This command waits for the CSS margin-left attribute value applied to that element. waitForMarginLeft(locator, pattern) |
| waitForMarginRight | Generated from getMarginRight(locator) This command waits for the CSS margin-right attribute value applied to that element. waitForMarginRight(locator, pattern) |
| waitForMarginTop | Generated from getMarginTop(locator) This command waits for the CSS margin-top attribute value applied to that element. waitForMarginTop(locator, pattern) |
| waitForMouseSpeed | Generated from getMouseSpeed() This command waits for the number of pixels between \"mousemove\" events during dragAndDrop commands (default=10). waitForMouseSpeed(pattern) |
| waitForNotAlert | Generated from getNotAlert() This command waits for an Alert, getting an alert has the same effect as manually clicking OK. If an alert is generated but you do not consume it with getAlert, the next QaSCRIBE action will fail. Under QaSCRIBE, JavaScript alerts will NOT pop up a visible alert dialog. QaSCRIBE does NOT support JavaScript alerts that are generated in a page's onload() event handler. In this case, a visible dialog WILL be generated and QaSCRIBE will hang until someone manually clicks OK. waitForNotAlert(pattern) |
| waitForNotAllButtons | If a given button has no ID, it will appear as "" in this array. |
| waitForNotAllFields | If a given button has no ID, it will appear as "" in this array. |
| waitForNotAllLinks | If a given button has no ID, it will appear as "" in this array. |
| waitForNotAllWindowNames | Generated from getAllWindowNames() This command waits for the names of all windows that the browser knows about in an array. waitForNotAllWindowNames(pattern) |
| waitForNotAllWindowTitles | Generated from getAllWindowNames() This command waits for the titles of all windows that the browser knows about in an array. waitForNotAllWindowTitles(pattern) |
| waitForNotAttribute | Generated from getAttribute(attributeLocator) This command waits for the value of an element attribute. The value of the attribute may differ across browsers (this is the case for the \"style\" attribute, for example). waitForNotAttribute(attributeLocator, pattern) |
| waitForNotAttributeFromAllWindows | Generated from getAttributeFromAllWindows(attributeName) This command waits for an array of JavaScript property values from all known windows having one. |
| waitForNotBackgroundColor | Generated from getBackgroundColor(locator) This command waits for an array of JavaScript property values from all known windows having one. |
| waitForNotBackgroundImage | Generated from getBackgroundImage(locator) This command waits for the CSS background-image attribute value applied to that element |
| waitForNotBackgroundColor | Generated from getBackgroundColor(locator) This command waits for an array of JavaScript property values from all known windows having one. |
| waitForNotBackgroundPosition | Generated from getBackgroundPosition(locator) This command waits for the CSS background-position attribute value applied to that element. |
| waitForNotBackgroundPosition | Generated from getBodyText() This command waits for the entire text of the page. |
| waitForNotBorderColor | Generated from getBorderColor(locator) This command waits for the CSS border-color attribute value applied to that element |
| waitForNotBorderRadius | Generated from getBorderStyle(locator) This command waits for the CSS border style attribute value applied to that element. |
| waitForNotBorderWidth | Generated from getBorderWidth(locator) This command waits for the CSS border-width attribute value applied to that element. |
| waitForNotBorderStyle | Generated from getBorderRadius(locator) This command waits for the CSS border-radius attribute value applied to that element. |
| waitForNotBackgroundRepeat | Retrieves the css background-repeat attribute value applied to that element. |
| waitForNotChecked | Gets whether a toggle-button (checkbox/radio) is checked. Fails if the specified element doesn't exist or isn't a toggle-button. |
| waitForNotColor | Generated from getColor(locator) This command waits for the CSS color attribute value applied to that element. |
| waitForNotConfirmation | Retrieves the message of a JavaScript confirmation dialog generated during the previous action. By default, the confirm function will return true, having the same effect as manually clicking OK. This can be changed by prior execution of the chooseCancelOnNextConfirmation command. If an confirmation is generated but you do not consume it with getConfirmation, the next Selenium action will fail. |
| waitForNotCookie | It waits for a cookie not to be present on current page. |
| waitForNotCookieByName | It waits until the value of the cookie with the specified name,or throws an error if the cookie is not present. |
| waitForNotCursorPosition | Generated from getCursorPosition(locator) This command waits for the text cursor position in the given input element or text area; beware, this may not work perfectly on all browsers. Specifically, if the cursor/selection has been cleared by JavaScript, this command will tend to return the position of the last location of the cursor, even though the cursor is now gone from the page. This method will fail if the specified element isn't an input element or text area, or there is no cursor in the element. |
| waitForNotDisplay | Generated from getDisplay(locator) This command waits for the CSS display attribute value applied to that element. |
| waitForNotCurrentActivity | Waits for current activity's details.This command fails if the activity details load. This command is supported only for Android Devices. |
| waitForNotCurrentPackage | Waits for the current package. This command fails if the package details load.This command is supported only for Android Devices. |
| waitForNotDeviceSettings | Waits for the current settings on the device. This command passes when the actual settings and settings mentioned on target do not match. |
| waitForNotEditable | Determines whether the specified input element is editable, ie hasn't been disabled. This method will fail if the specified element isn't an input element. |
| waitForNotElementHeight | Generated from getElementHeight(locator) This command waits for the height of an element. |
| waitForNotElementIndex | Generated from getElementIndex(locator) This command waits for the relative index of an element to its parent (starting from 0). The comment node and empty text node will be ignored. |
| waitForNotElementPositionLeft | Generated from getElementPositionLeft(locator) This command waits for the horizontal position of an element. |
| waitForNotElementPositionTop | Generated from getElementPositionTop(locator) This command waits for the vertical position of an element. |
| waitForNotElementWidth | Generated from getElementWidth(locator) This command waits for the width of an element. |
| waitForNotEval | Gets the result of evaluating the specified JavaScript snippet. The snippet may have multiple lines, but only the result of the last line will be returned. |
| waitForNotExpression | Generated from getExpression(expression) This command is useful because of JavaScript preprocessing. It is used to generate commands like assertExpression and waitForExpression. |
| waitForNotFloat | Generated from getFloat(locator) This command waits for the CSS float attribute value applied to that element |
| waitForNotHeight | Generated from getHeight(locator) This command waits for the CSS height attribute value applied to that element. |
| waitForNotHtmlSource | Generated from getHtmlSource() This command waits for the entire HTML source between the opening and closing "" tags. |
| waitForNotKeyboardVisible | Waits for the keyboard to be visible. Fails, if the keyboard is visible else pass. |
| waitForNotLocation | Gets the absolute URL of the current page. |
| waitForNotMarginBottom | Generated from getMarginBottom(locator) This command waits for the CSS margin-bottom attribute value applied to that element |
| waitForNotMarginLeft | Generated from getMarginLeft(locator) This command waits for the CSS margin-left attribute value applied to that element |
| waitForNotMarginRight | Generated from getMarginRight(locator) This command waits for the CSS margin-right attribute value applied to that element |
| waitForNotMarginTop | Generated from getMarginTop(locator) This command waits for the CSS margin-top attribute value applied to that element |
| waitForNotMouseSpeed | Generated from getMouseSpeed() This command waits for the number of pixels between \"mousemove\" events during dragAndDrop commands (default=10). |
| waitForNotOpacity | Generated from getMouseSpeed() This command waits for the CSS opacity attribute value applied to that element. |
| waitForNotOverflow | Generated from getOverflow(locator) This command waits for the CSS overflow attribute value applied to that element. |
| waitForNotPaddingBottom | Generated from getOverflow(locator) This command waits for the CSS padding-bottom attribute value applied to that element. |
| waitForNotMarginLeft | Generated from getMarginLeft(locator) This command waits for the CSS margin-left attribute value applied to that element |
| waitForNotMarginRight | Generated from getMarginRight(locator) This command waits for the CSS margin-right attribute value applied to that element |
| waitForNotMarginTop | Generated from getMarginTop(locator) This command waits for the CSS margin-top attribute value applied to that element |
| waitForNotPosition | Generated from getPosition(locator) This command waits for the CSS position attribute value applied to that element. |
| waitForNotSomethingSelected | Generated from isNotSomethingSelected(selectLocator) This command waits for the determination of some option in a drop-down menu being selected. |
| waitForNotPerformanceData | Waits for the resource usage information of the application. Tthe resource is one of the system states which means CPU Info, Memory Info, Network Info, and Battery Info. This command is supported only for Android Devices. Execution stops if the command fails. This command fails if the performance data is returned. |
| waitForNotSelectedLabel | Purpose of this command is to make sure that the so and so option is not the selected one in the select drop-down. |
| waitForNotSelectedLabels | Purpose of this command is to make sure that the so and so options are not the selected one in the select drop-down. |
| waitForNotSpeed | Get execution speed (i.e., get the millisecond length of the delay following each QaSCRIBE operation). By default, there is no such delay, i.e., the delay is 0 milliseconds. See also setSpeed. |
| waitForNotTable | Generated from getTable(tableCellAddress) This command waits for the text from a cell of a table. The cellAddress syntax tableLocator.row.column, where row and column start at 0. |
| waitForNotSystemTime | Waits for system's current time to appear. This command fails if the system time doesn't appear. |
| waitForNotText | The purpose of the Command is to wait untill the specified text to be not present on targeted element. |
| waitForNotTextAlign | Generated from getTextAlign(locator) This command waits for the text-align - CSS attribute value applied to that element |
| waitForNotTextDecoration | Generated from getTextDecoration(locator) This command waits for the CSS text-decoration attribute value applied to that element. |
| waitForNotTextOrientation | Generated from getTextOrientation(locator) This command waits for the CSS text-orientation attribute value applied to that element. |
| waitForNotTitle | The purpose of the Command is to wait untill the specified title to be not present on particular page. |
| waitForNotValue | The purpose of the Command is to wait untill the specified value to be not present on targeted element. |
| waitForNotVerticalAlign | Generated from getVerticalAlign(locator). This command waits for the CSS vertical-align attribute value applied to that element. |
| waitForNotVisible | The purpose of the command is to wait untill the specified element is not visible. |
| waitForNotWidth | Generated from getWidth(locator) This command waits for the CSS width attribute value applied to that element. |
| waitForNotXpathCount | Generated from getXpathCount(XPath) This command waits for the number of nodes that match the specified XPath, eg. \"//table\" would give the number of tables. |
| waitForOpacity | Generated from getOpacity(locator) This command waits for the CSS opacity attribute value applied to that element. |
| waitForOverflow | Generated from getOverflow(locator) This command waits for the CSS overflow attribute value applied to that element |
| waitForPaddingBottom | Generated from getPaddingBottom(locator) This command waits for the CSS padding-bottom attribute value applied to that element. |
| waitForPaddingLeft | Generated from getPaddingLeft(locator) This command waits for the CSS padding-bottom attribute value applied to that element. |
| waitForPageToLoad | Waits for a new page to load. |
| waitForPromptNotPresent | Generated from isPromptNotPresent() This command waits for a Prompt to be present. |
| waitForPromptPresent | Generated from isPromptNotPresent() This command waits for a Prompt to be present. |
| waitForPerformanceData | Waits for the resource usage information of the application. Tthe resource is one of the system states which means CPU Info, Memory Info, Network Info, and Battery Info. This command is supported only for Android Devices. |
| waitForPopUp | Waits for a popup window to appear and load up. |
| waitForSelectedId | Generated from getSelectedId(selectLocator) Waits for the page to load and get option element ID for selected option in the specified select element. |
| waitForSelectedIds | Generated from getSelectedIds(selectLocator) This command waits for the implicit time period when the page loads, gets all options' element IDs for selected options in the specified select or multi-select element. |
| waitForSelectedIndex | Generated from getSelectedIndex(selectLocator) This command waits for the implicit time period when the page loads, gets option index (option number, starting at 0) for selected option in the specified select element. |
| waitForSelectedIndexes | Generated from getSelectedIndexes(selectLocator) This command waits for the implicit time period when the page loads, gets all option indexes (option number, starting at 0) for selected options in the specified select or multi-select element. |
| waitForSelectedLabel | The purpose of this command is to make sure that the so and so option is the selected one in the select drop-down. |
| waitForSelectedLabel | The purpose of this command is to make sure that the so and so option is the selected one in the select drop-down. |
| waitForSelectedLabels | This command wait's for the labels selected in the drop-down. |
| waitForSelectedValue | Generated from getSelectedValue(selectLocator) This command waits for the implicit time period when the page loads, Gets option value (value attribute) for selected option in the specified select element. |
| waitForSelectedValues | Generated from getSelectedValues(selectLocator) This command waits for the implicit time period when the page loads, gets all option values (value attributes) for selected options in the specified select or multi-select element. |
| waitForSelectOptions | The purpose of the command is to wait untill the desired options are populated in drop-down or not. |
| waitForSpeed | Get execution speed (i.e., get the millisecond length of the delay following each QaSCRIBE operation). By default, there is no such delay, i.e., the delay is 0 milliseconds. See also setSpeed. |
| waitForSomethingSelected | Generated from isSomethingSelected(selectLocator) This command waits for the selection of some option in a drop-down menu. |
| waitForSystemTime | Waits for system's current time to appear. |
| waitForTable | This command is used to wait for the text from the specified cell in the table matches the pattern given in Value. |
| waitForText | The purpose of the Command is to wait untill the specified text to be present on targeted element. |
| waitForTextAlign | Retrieves the text-align - css attribute applied on that element. |
| waitForTextDecoration | Generated from getTextDecoration(locator) This command waits for the CSS text-decoration attribute value applied to that element. |
| waitForTextNotPresent | The purpose of the command is to verify that the specified text pattern does not appears somewhere on the rendered page shown to the user. |
| waitForTextOrientation | Generated from getTextDecoration(locator) This command waits for the CSS text-decoration attribute value applied to that element. |
| waitForTextPresent | The purpose of the command is to Verify that the specified text pattern appears somewhere on the rendered page shown to the user. |
| waitForTimeStamp | This command is used to get current time in (yyyymmddhhmiss) format. |
| waitForTitle | The purpose of the command is to wait until expected title appears. |
| waitForValue | \95The purpose of the Command is to wait untill the specified value to be present on targeted element. |
| waitForVisible | The purpose of the command is to wait untill the specified element is visible. |
| waitForVerticalAlign | Generated from getVerticalAlign(locator) This command waits for the CSS vertical-align attribute value applied to that element. |
| waitForWidth | Generated from getWidth(locator) This command waits for the CSS width attribute value applied to that element |
| waitForXpathCount | The purpose of this command is to wait untill the number of nodes that match the specified xpath. |
| while | Iterate a block of code written under the condition until the conditional evaluates to false. 'while' command must always have 'endWhile' at the end of the block. |
| windowFocus | Gives focus to the currently selected window. |
| windowFocusAndWait | Generated from windowFocus() This command gives focus to the currently selected window. |
| windowMaximize | Resize currently selected window to take up the entire screen. |
| windowMaximizeAndWait | Generated from windowMaximize() This command Maximizes the current window. |
| wsAuthenticationType | This command is used to set authentication type for the service under test. At present only two types of authentication mode are supported i.e. Basic and Digest. This command is to be used only when the service under test is public facing. For services that are behind the firewall and for the runs wsCONNECT component is used, this command is ignored. |
| wsBlockEnd | This command signifies the End of a Web service Block within a Test Script. Each wsBlockEnd must be accompanied by a matching wsBlockOpen that exists before it within the same Test Script. There can be more than one wsBlocks within a single Test Script. |
| wsBlockOpen | This command signifies the beginning of a web service block within a Test Script. Each wsBlockOpen must be accompanied by a matching wsBlockEnd that exists after it within the same Test Script. There can be more than one web service blocks within a single Test Script. Web service blocks are referred to as wsBlocks for simplicity. |
| wsExecuteRequest | This command is the main command that is responsible for getting the URL identified by a wsSetRequestURL, executed by the appropriate wsCONNECT Tunnel operating on one of your company's servers (If the service under test is public facing, then invoking of the service is done from within the run) For services behind the firewall,Worksoft SaaS does NOT call the service from/on its cloud but sends the information to the appropriate wsCONNECT on your end along with the request parameters and the payload. When wsCONNECT Tunnel receives this execution request from Worksoft SaaS, in the context of a test being executed within your domain, wsCONNECT reads from ws .json (that drives your wsCONNECT tunnel) the base URL, authentication credentials to trigger the service call. Since it may take some time for the wsCONNECT and/or your service to respond, Worksoft SaaS waits asynchronously for the service result to be sent back from wsCONNECT. When the service provides a response, wsCONNECT sends the result set back to Worksoft SaaS, and the test that is executing in Worksoft SaaS, that was waiting for the execution results, proceeds with the test execution. If the response does NOT go back to Worksoft SaaS within the maximum time allowed for a query (as specified explicitly by the use of wsSetRequestTimeOut command or implicitly applied with a default value if that command is not used), the test that in Worksoft SaaS that was waiting for the results of the service call, will automatically abort the test. |
| wsSetAlgorithm | This command is used to set the algorithm type. This is only for DIGEST authentication mechanism. It only accepts MD5 or MD5-sess. |
| wsSetContext | This command is used to specify to Worksoft SaaS the "wsCONNECT tunnel" (that is operating within your company's firewall) that will service the triggering of services mentiond within the current wsBlock. As a security best practice, Worksoft SaaS does NOT need to know any more information (IP addresses, host names , usernames , passwords, etc) of the services (behind your company's applications (AUTs) and behind your firewalls) beyond the alias name(s) you give to those web server. The " ws .json" file that drives the wsCONNECT tunnel (operating within your company's infrastructure) is where you can specify the all the agove details and assign a ' ws alias name' which then you'd use safely in Worksoft SaaS. Since ws .json is on your company's network, Worksoft SaaS cannot access these settings. The "wsCONNECT Tunnel Name" is a name you give to your wsCONNECT Tunnel when you start the Tunnel. The name you give must be unique. |
| wsSetPassword | This command is used to specify the password to be used for authentication in the service under test. This command is to be used only when the service under test is public facing. For services that are behind the firewall and for the runs wsCONNECT component is used, this command is ignored. |
| wsSetProtocol | This command is used to identify the Protocol of the service under test. Keyword "REST" is to be used for identifying RESTful service and keyword "SOAP" to be used for identifying a SOAP service. |
| wsSetRequestHeaderParam | This command is used to set the request header parameters for the service under test. The most common params are Content-Type & Content-Length. This command can be repeated with multiple header parameters. |
| wsSetRequestHeaderParamsFromDataFile | This command can be used in replacement with wsSetResponeHeaderParam command where multiple wsSetResponeHeaderParam instructions are required to set the header params within an wsBlock. Instead of creating separate instructions with the command "wsSetResponeHeaderParam" within the test script, a better alternative is to dynamically load the header parameters for the request from a Data File, optionally passing a Data Filter. In the Data File all header request fields that are common across all services can be set. A filter on the data file, if passed, should filter the data file that contains the header request field params based on the filter. |
| wsSetRequestMethod | This command is used to set the request method. Request methods supported are GET, POST, PUT, DELETE.for REST Services.In case of SOAP we need to pass the 'Operation Name' present in the Web Services Description Language(wsdl). |
| wsSetRequestPayload | This command is used to set the input payload to the service under test. The payload should match the type of the data that is mentioned in the "Content-Type" request header parameter. |
| wsSetRequestTimeOut | This command can be used to set the "timeout" for all service requests that get executed in the context of a wsBlock. Test execution gets aborted if no response comes back from Worksoft SaaS wsCONNECT tunnel within the value set. If this command is NOT used within a wsBlock, a default value will be applied for the timeout. |
| wsSetRequestURL | This command must be present at least once for Block. If it appears more than once within a wsBlock the URL that corresponds to the last used command will be used to execute the services test. A variable could be used for the entire URL or portions there of. For public facing service under test full URL should be mentioned. For example to schedule a test in Worksoft SaaS using REST api : While invoking services behind the firewall, base URL is not be mentioned. URL mentioned here should consist of Resource and Action. For example:/${domainname}/executions/ |
| wsSetRequestURLParam | This command is used when some data needs to be sent to the service within the url as params for executing the serivce. This command takes input parameters from URL send this data to the specific service.This command can be repeated. The order in which the params are set using this command is the order in which the parameterized URL will be constructed when wsExecuteRequest instruction is executed within CE. |
| wsSetResponeHeaderParam | This command is used to set the MIME types.Some of them are application/JSON, application/XML, text/plain, text/HTML, text/javascript etc. |
| wsSetResponseHeaderParamsFromDataFile | This command can be used instead of OR in addition to the use of one or more 'wsSetResponseHeaderParam' commands within wsBlock. In the Data File all header response fields that are common across all services can be set. A filter on the data file, if passed, should filter the data file that contains the header response field presets based on the filter. |
| wsSetUsername | This command is used to specify the username to be used for authentication in the service under test. This command is to be used only when the service under test is public facing. For services that are behind the firewall and for the runs wsCONNECT component is used, this command is ignored. |
X
| Command | Purpose |
|---|---|
| xmlAddCDATA | This command is used to add CDATA within an XML document at the given path. |
| xmlAppendToNodeList | This command is used to append values to the end of the indicated NodeList within an XML document. If the given path is not a valid in an XML document, the command fails with error "PATH _DOES_NOT_EXIST". |
| xmlAssertPathExists | This command is used to check if the given path exists in the input 'XML_STRING'. If the mentioned path does not exist the run returns the value as "0" or "1" if the path exists. |
| xmlAssertValidityGetParserError | This command is used to check if the XML string is well formed.If the XML document supplied in the input is invalid, the command fails with error "INVALID_XML" or the relevant error message.If the XML document is valid the variable will return "1". |
| xmlComment | This command is used to add a comment to an XML string in the given path.If the given path is not a valid in XML document, the command fails with error "PATH _DOES_NOT_EXIST". |
| xmlCompare | This command is used to compare two XML strings.If the mentioned XML Strings do not match then the run returns the value as "0" if strings do not match or "1" if the strings match. |
| xmlCreateDocumentFromDataFile | This command is used to convert a Data File into a XML Node structure.Converts a Data File into a XML node structure. The Keys will be set equal to Attributes of the Data Definition linked to the Data File. The Values will be set using data from the Data File. |
| xmlCreateDocumentFromDataSet | This command is used to convert a DataSet into an XML document.The Keys will be set equal to Attributes of the Data Definition mapped to the DataSet. The Values will be set using data from the DataSet.To create a DataSet, Array Creation & Manipulation commands has to be used before this command. |
| xmlExtractValuesByPaths | This command is used to extract the values from the given path in a XML string. If the XML document supplied in input is invalid, command fails with error "INVALID_XML". If the path supplied in input is invalid, command fails with error "PATH _DOES_NOT_EXIST". |
| xmlGetDepth | This command is used to get the depth of a XML string. If the XML document supplied in input is invalid, command fails with error "INVALID_XML". |
| xmlGetLength | This command is used to get the length of a XML String. If the XML document supplied in input is invalid, command fails with error "INVALID_XML". Returns the length of XML document or if a path argument is given, the length of the value within the document identified by the path. Returns NULL if any argument is EMPTY or the path argument does not identify a value in the document. An error occurs if the xml_string argument is not valid xml document or the path argument is not a valid path expression or contains a * or ** wildcard. The length of a document is determined as follows: 1. The length of a scalar is 1. 2. The length of an nodelist is the number of elements. 3. The length does not count the length of nested nodes. |
| xmlInsertIntoDocument | This command is used to insert data in the XML document. If the XML document supplied in input is invalid, command fails with error "INVALID_XML". If the path mentioned is not part of the XML document, command fails with error "PATH _DOES_NOT_EXIST" . The path/value pairs are evaluated left to right.The document produced by evaluating one pair becomes the new value against which the next pair is evaluated. A path/value pair for an existing path in the document is ignored and does not overwrite the existing document value.A path/value pair for a non existing path in the document adds the value to the document if the path identifies one of these types of values: 1) A member not present in an existing object.the member is added to the object and associated with the new value. |
| xmlNodeListByIndex | This command retrieves Node List from XML document using "index" as reference. If index mentioned is not part of the XML document, command fails with error "INDEX_DOES_NOT_EXISTS_IN_XML_STRING". |
| xmlNodeListByPath | This command retrieves Node List from XML document using "path" as reference. If path mentioned is not part of the XML document, command fails with error "PATH _DOES_NOT_EXIST". |
| xmlRemoveFromDocument | This command removes data from XML document using "path" as reference. Removes data from a xml document and returns the result.Returns NULL if any argument is EMPTY.An error occurs if the XML document argument is not valid or any path argument is not valid path expression or is $ or contains a * or ** wildcard. The path arguments are evaluating left to right.The document produced by evaluating one path becomes the new value against which the next path is evaluated. It is not an error if the element to be removed does not exist in the document; in that case, the path does not affect the document. |
| xmlReplaceNodesByPaths | This command is used to replace Nodes of XML document using "path" as a reference. Replaces existing keys in a XML document and returns the result. Returns NULL if any argument is EMPTY. An error occurs if the XML_string argument is not a valid XML document or any path argument is not a valid path expression or contains a * or ** wildcard. The path/key pairs are evaluated left to right. The document produced by evaluating one pair becomes the new value against which the next pair is evaluated. A path/key pair for an existing path in the document overwrites the existing document value with the new key. A path/key pair for a non existing path in the document is ignored and has no effect. |
| xmlReplaceValuesByPaths | This command is used to replace values of XML document using "path" as a reference. Replaces existing values in a XML document and returns the result. Returns NULL if any argument is EMPTY. An error occurs if the XML_string argument is not valid or any path argument is not a valid path expression or contains a * or ** wildcard. The path/value pairs are evaluated left to right. The document produced by evaluating one pair becomes the new value against which the next pair is evaluated. A path/value pair for an existing path in the document overwrites the existing document value with the new value. A path/value pair for a non existing path in the document is ignored and has no effect. |
| xmlSearchValueOccurrence | This command looks for a specific value in the target XML string using "path"as a reference. Returns 0 or 1 to indicate whether a specific value is contained in a target 'xml_string', or, if a path argument is given, at a specific path within the target 'xml_string'. Returns NULL if any argument is NULL or the 'path' argument does not identify a section of the target 'xml_string'. An error occurs if either 'xml_string' argument is not valid or the 'path' argument is not a valid path expression or contains a * or ** wildcard. |
| xmlSetNodeAttributes | This command sets the "attributename" and "attributevalue" in given nodes of an XML document. If the XML document supplied in input is invalid, command fails with error "INVALID_XML". If path mentioned is not part of the XML document, command fails with error "PATH _DOES_NOT_EXIST ". |