_include($scriptPath)

Details

Includes the script at scriptPath in the current script. _include is dynamically evaluated since Sahi Pro V5.0.

// Suppose the current script is in
// D:/sahi/userdata/scripts/sahitests/ folder

// include lib.sah located in the current script's directory
// D:/sahi/userdata/scripts/sahitests/lib.sah
_include("lib.sah"); // using relative path

// Include using full path
_include("D:/sahi/userdata/scripts/sahitests/lib.sah"); // using absolute path

// Use of back and front slashes
_include("D:\sahi\userdata\scripts\sahitests\lib.sah"); // WRONG
_include("D:/sahi/userdata/scripts/sahitests/lib.sah"); // CORRECT
_include("D:\\sahi\\userdata\\scripts\\sahitests\\lib.sah"); // CORRECT

// Include from a subfolder
// D:/sahi/userdata/scripts/sahitests/common/lib.sah
_include("common/lib.sah");

// Include from a parent's sub folder
// D:/sahi/userdata/scripts/common/lib.sah
_include("../common/lib.sah");

_includeOnce($scriptPath)

Details

Similar to _include but _includeOnce only includes the script once even when called multiple times.

This is useful in a scenario, where during development a single flow is broken into multiple scripts and each is developed and tested independently, and then included all together into one script.

_includeOnce("lib.sah"); // includes lib.sah
_includeOnce("lib.sah"); // second call. Will do nothing.

// For more details on usage, look at _include

_dynamicInclude($scriptPath)

Details

_includeAR($ARFilePath[, $columnName])

Details

Includes Accessor Repository as CSV file. Provide the column name to be used for the script as the second argument.
This has been described in detail here.

// ArColumn1 is the column name specified in CSV file.
//AR values will be picked from the specified column name, for the current script.
_includeAR("AR_File.ar.csv", "ArColumn1");

_resource($resourcePath)

Details

In a distributed run, only the participating scripts in the suite are zipped and sent over to the nodes.
Hence if your scripts refer to any resources like CSV files (through CSV APIs) or Excel files (through Excel APIs) or images etc, they have to be explicitly included in your scripts using the _resource API.

Use relative path for resources so that they can work on all the nodes.

In summary, any resource that your script uses (other than scripts themselves), needs to be included through _resource APIs.

Some examples:

_resource("../excel/users.xlsx"); // Include excel file as resource.
var $data = _readExcelFile("../excel/users.xlsx");

/* Folder structure:
	|- a
	    |- a1.xlsx
	    |- a2.xls
	    |- b
	       |-b1.png
	       |- c
	      	  |- sample1.txt
	       |- d
	      	  |- sample2.txt
	       |
	    |
	|
*/

// To include all files and folder inside folder "a" as resource.
_resource("../a"); // Includes "../a/a1.xlsx", "../a/a2.xls", "../a/b/b1.png", "../a/b/c/sample1.txt" and "../a/b/d/sample2.txt"

// To include all files inside folder "a" as resource.
_resource("../a/*"); // Includes "../a/a1.xlsx" and "../a/a2.xls"

_resource("../a/*.xls"); // Includes "../a/a2.xls"
_resource("../a/*/*/sample1.txt"); // Includes "../a/b/c/sample1.txt"
_resource("../a/b/*/sample*.txt"); // Includes "../a/b/c/sample1.txt" and "../a/b/d/sample2.txt"

_importJava($fullyQualifiedJavaClassName)

Details

1. Creates a new instance of the Java Class and sets it into a presumed variable name. Variable name will be in this format: $<className>.<functionName>. First letter of the java class will be in lower case.
   For example: If the class name is UserModule, instance variable name will be $userModule.
2. Using "*", new instance is created for all the classes, defined inside the package.
   Methods of these classes can be invoked using the presumed variable name.

_importJava("demo.training.UserModule");
//using the instance variable, methods of that class can be invoked.
$userModule.login("test", "secret");

_importJava("demo.training.*");
//using the instance variable, methods of that class can be invoked.
$userModule.login("test", "secret");

_loadJavaInstance($fullyQualifiedJavaClassName)

Details

_loadJavaInstance returns the class instance.

$userModuleInstance = _loadJavaInstance("demo.training.UserModule");
//using this instance variable, methods of that class can be invoked.
$userModuleInstance.login("test", "secret");