# 8.3 - Test Designer JS Commands Reference
Test Designer JS Commands Reference
# General functions
###
If you cannot find the function in the Test Designer IDE, then use custom JS actions.
```
var $csvtxt = "username,password"+"\n"+"oscar,passw"+"\n"+"oscar2,passw2";
// $csvtxt could be variable with contents captured by network workbench extractor
writeText("{ds}/mycsv.csv", $csvtxt );
var data = readCSV("{ds}/mycsv.csv");
log(data.length); // includes first header row
for (var i = 1; i < data.length; i++) {
var $username = data[i][0];
var $password = data[i][1];
log("$username: "+$username+" $password: "+$password);
}
```
```
var $csvtxt = "username,password"+"\n"+"oscar,passw"+"\n"+"oscar2,passw2";
// $csvtxt could be variable with contents captured by network workbench extractor
writeText("{ds}/mycsv.csv", $csvtxt );
var data = readCSV("{ds}/mycsv.csv");
log(data.length); // includes first header row
for (var i = 1; i < data.length; i++) {
var $username = data[i][0];
var $password = data[i][1];
log("$username: "+$username+" $password: "+$password);
}
```
```
wait(30000); // pauses for 30 seconds
```
```
wait(60000, (function(){ checkSomething () }));
wait(Number.MAX_SAFE_INTEGER, ()=> checkSomething () );
```
```
wait(90000, "isVisible(textbox('username'))" );
```
```
wait(Number.MAX_SAFE_INTEGER, isVisible(Element()) );
```
```
let isVisibleResut = isVisible(Element()) ;
wait(Number.MAX_SAFE_INTEGER,isVisibleResut);
```
Some text
`
>
> `_byClassName("bigfont", "DIV")`
### \_byCss = byCss
Parameters: value
Description: This returns the element matching with the specified css
Example:
> `_navigateTo("`http://sahitest.com/`");`
> `_click(_link("demo"));`
> `_click(_byCss("a.a.x"));`
> `_click(_link("Back"));`
### \_byId = byId
Parameters: value
Description: This returns the element matching with the specified id
Example 1:
> `Add Member
`
> `_byId("s2id_autogen2") // points to the above tag. Note that the tagName "div" is not used here.`
Example 2:
> `_navigateTo("`http://sahitest.com/`demo/linkTest.htm");`
> `_click(_byCss("myLink"));`
>
### \_byName = byName
Parameters: value
Description: Finds the element with the name of the element. If more than one match, this returns the first matching element.
Example:
> `navigateTo("`http://sahitest.com/`");`
> `click(link("demo"));`
> `click(link("Form Test"));`
> `var t1 = byName("t1");`
### \_byJQuery = byJQuery
Parameters: value
Description: Returns the first match based on the input string. Input can be any of jQuery selectors
Example:
> `byJQuery("#s1Id"); // id selector since u can see # in it`
> `byJQuery("input"); // returns the first match input element`
> `byJQuery(".ac-content"); // returns the first match of element class selector`
### \_bySelenium = bySelenium
Parameters: value
Description: uses selenium locator to get the element
Example:
> `_navigateTo("`http://sahitest.com/demo/`");`
> `_click(_bySelenium("css=a.a.x"));`
> `_click(_link("Back"));`
### \_byTagName = byTagName
Parameters: value
Description: Finds the element with the tag name of the element. If more than one match, this returns the first matching element.
Example:
> `navigateTo("`http://sahitest.com/`");`
> `click(link("demo"));`
> `click(link("Form Test"));`
> `var text = byTagName("input");`
### \_byXPath = byXPath
Parameters: value
Description: This returns the element matching with the specified XPath
Example:
> `navigateTo("`http://demosite.appvance.com/`");`
> `click(byXPath('//*[@class="list-group-item"]'));`
> `click(byXPath('//*[@class="list-group-item"]'));`
# Test Designer HTTP history functions
### \_setHistory
Parameters: value
Description: sets the history file which is a zip containing all requests.
Example:
> `FileClient fs = new FileClient();`
> `fs.setHistory("test/com/appvance/ds/js/cecris/DSLog_NewPRF.zip");`
### \_replayHistory
Description: playback the history file
Example:
> `_replayHistory();`
> `_wait(2000);`
> `_navigateTo("`https://g-mmember-qa1.example.in/`");`
### \_clearHistory
Description: clears the history data
Example:
> `_clearHistory();`
> `_stopHistory();`
### \_stopHistory
Description: stops playing the history
Example:
> `FileClient fs = new FileClient();`
> `try{`
> ` fs.setHistory("test/com/appvance/ds/js/ppd/DSLog.zip");`
> ` fs.replayHistory();`
> ` fs.processJSFile("test/com/appvance/ds/js/ppd/getAttr.js");`
> `} finally {`
> ` fs.clearHistory();`
> ` fs.stopHistory();`
> `}`
### \_dontCheckForWS
Parameters: DNS, port
Description: adds the domain and host to the list of domains that should not be checked for HTTPS connection.
Example:
> `_dontCheckForWS("`g-mmember-qa1.copart.in`",443);`
> `_dontCheckForWS("`cdn.polyfill.io`",443);`
> `_dontCheckForWS("`smetrics.copart.com`",443);`
> `_wait(10000);`
> `_navigateTo("`https://g-mmember-qa1.copart.in/`");`
> `_wait(1000);`
> `_click(_div("AUCTIONS"));`
### \_printAssertions
Parameters: boolean
Description: enables logging of assertions executed. Mainly used for debugging purposes.
Example:
> `_printAssertions(true);`
# Assert Functions
### \_assertExists = assertExists
Description:
Asset Exists will log the step in the playback logs when the element exists, it will log as a failure if the element does not exist.
Note: Do not use this in an if condition as it does not return any value, and throws an exception if the assertion fails.
Example:
> `navigateTo("`http://demosite.appvance.com/`");`
> `wait(1000);`
> `focus(span("Products[1]"));`
> `assertExists(span("Products[1]"));`
### \_assertNotExists
Parameters: value
Description:
Assert Not Exists will log failures in the logs if the element does exist on the page. This assertion is to check if certain elements that we are looking for does not exist on the page.
Note: Do not use this in an if condition as it does not return any value, and throws an exception if the assertion fails.
Example:
> `navigateTo("`http://demosite.appvance.com/`");`
> `wait(1000);`
> `assertNotExists(span("Products[1]"));`
> `click(link("Clothing"));`
### \_assertTrue = assertTrue
Parameters: value
Description: Assert True will log failures in the logs if the condition evaluates to false.
Example:
> `navigateTo("`http://sahitest.com/demo/training/login.htm`");`
> `var val2=_isVisible(_bold("Sahi Training Site"));`
> `assertTrue(val2);`
### \_assertFalse = assertFalse
Parameters: value
Description:
Assert False will log failures in the logs if the condition evaluates to true.
Note: Do not use this in an if condition as it does not return any value, and throws an exception if the assertion fails.
Example:
> `navigateTo("`http://sahitest.com/demo/training/login.htm`");`
> `var val1=_getText(_bold("Sahi Training Site"));`
> `assertDoesNotContainText(log(val1);`
> `assertEqual(val1,"Sahi Training Site");`
> `assertNotEqual(val1,"abc");`
> `assertFalse("abc");`
> `var val2=_isVisible(_bold("Sahi Training Site"));`
> `assertTrue(val2);`
### \_assertNull = assertNull
Parameters: value
Description:
Assert Null will log failures to the logs if the value is not null and will continue to playback if the value is null.
Note: Do not use this in an if condition as it does not return any value, and throws an exception if the assertion fails.
Example:
> `navigateTo("`http://sahitest.com/demo/training/login.htm`");`
> `assertExists(bold("Sahi Training Site"));`
> `assertNull(null);`
### \_assertNotNull = assertNotNull
Parameters: value
Description:
Assert Not Null will log failure in the logs if the value is null.
Note: Do not use this in an if condition as it does not return any value, and throws an exception if the assertion fails.
Example:
> `navigateTo("`http://sahitest.com/demo/training/login.htm`");`
> `assertExists(bold("Sahi Training Site"));`
> `assertNotNull("Sahi Training Site");`
### \_assertEqual = assertEqual = \_assertEquals = assertEquals
Parameters: value1, value2
Description:
Assert Equal checks if the expected value is equal to the Actual value.
AssertEqual will log failures to the playback logs if the expected and actual values are not equal. It logs the step when the assertion passes in the logs section.
Note: Do not use this in an if condition as it does not return any value, and throws an exception if the assertion fails.
Example:
> `navigateTo("`http://demosite.appvance.com/`");`
> `click(span("Products[1]"));`
> `assertEqual(span("Home[1]"),"Home");`
> `click(link("Clothing"));`
### \_assertNotEqual = assertNotEqual
Parameters: value1, value2
Description:
As the name suggests, Assert not equal expects the string to be not equal and logs failures in the playback logs when the Expected string matches with the actual string.
Note: Do not use this in an if condition as it does not return any value, and throws an exception if the assertion fails.
Example:
> `navigateTo("`http://demosite.appvance.com/`");`
> `click(span("Products[1]"));`
> `assertNotEqual(span("Home[1]"),"Home");`
> `click(link("Clothing"));`
### \_assertContainsText = assertContainsText
Parameters: fullText, element
Description:
As the name suggests, assert contains text checks for a string in the target element and logs success or failure.
It will log the step details if the assertion passes else it logs as a failure if the expected string or reg-ex is not part of the text content of a given element with a proper explanation and stops the script playback.
Note: Do not use this in an if condition as it does not return any value, and throws an exception if the assertion fails.
Example:
> `navigateTo("`http://demosite.appvance.com/`");`
> `click(span("Products[1]"));`
> `assertContainsText("Home",span("Home[1]"));`
> `click(link("Clothing"));`
### \_assertDoesNotContainText = assertDoesNotContainText
Parameters: fullText, element
Description: assertContainsText will do nothing if the expected string/regex is not part of the text content of given element \_assertContainsText will log failures to the playback logs if the expected string/regex is part of the text content of given element
Example:
> `navigateTo("`http://demosite.appvance.com/`");`
> `click(span("Products[1]"));`
> `assertDoesNotContainText(click(link("Clothing"));`
# Relational accessor functions
### \_in
Parameters: accessor
Description:
Example:
> `link("delete", in(_cell("del2")))`
### **\_near | near**
Parameters: element
Description: the element should be searched near another element.
Example:
> `_navigateTo("`https://www.apple.com/`");`
> `_click(_link("ac-gn-link ac-gn-link-mac"));`
> `_click(_link("ac-gn-link ac-gn-link-iphone",_near(_link("/ipad/"))));`
> `_click(_link("/ipad/"));`
> `_click(_span("chapternav-label[1]",_near(_link("/ipad/"))));`
# HTTP-Level API Functions Reference
## Recommended guidance
HTTP-level API functions are technical reference material for tests that need direct HTTP interactions. Validate legacy examples against current Service Suite and Scenario Editor behavior before using them in new work.
## What to document
- HTTP method, URL, headers, query parameters, request body, and timeout behavior.
- Authentication, token refresh, cookies, and session handling.
- Response status, headers, body parsing, and extracted values.
- Error handling, retries, and logging expectations.
## Best practices
1. Prefer Service Suite for new API testing workflows when available.
2. Use placeholders for secrets and customer-specific endpoints.
3. Add assertions for both technical response validity and business outcome.
4. Review old Test Designer JS commands before carrying them into current AIQ assets.
*Last updated: October 6, 2026*