_scriptName()

Details

Returns the script name.

// In script D:/sahi/userdata/scripts/demo/check.sah
var $scriptName = _scriptName(); // returns "check.sah"

_scriptPath([$fileSeparator])

Details

Returns the full script file path.

// In script D:/sahi/userdata/scripts/demo/check.sah
var $_scriptPath = _scriptPath(); // returns "D:/sahi/userdata/scripts/demo/check.sah"
var $_scriptPath = _scriptPath("\\"); // returns "D:\\sahi\\userdata\\scripts\\demo\\check.sah"

_scriptStartTime()

Details

Returns script startTime as a Date object

var $dateObj = _scriptStartTime();
# Detailed usage:
var $date = $dateObj.toString();
var $year = $dateObj.getFullYear();
var $month = $dateObj.getMonth(); // Month range 0-11
var $month = $dateObj.getMonth2(); // Month range 1-12
var $day = $dateObj.getDay();
var $hours = $dateObj.getHours();
var $minutes = $dateObj.getMinutes();
var $seconds = $dateObj.getSeconds();

_scriptStatus()

Details

Returns "SUCCESS" or "FAILURE"

_userDataDir([$fileSeparator])

Details

Returns full file path of userdata directory

$userDataPath = _userDataDir(); // returns "D:/sahi/userdata"
$userDataPath = _userDataPath("\\"); // returns "D:\\sahi\\userdata"

_userDataPath($relPath[, $fileSeparator])

Details

Returns full file path of file resolved relative to userdata directory

// If you have a data/excelsheets folder in sahi/userdata folder,
// you can access it using
$excelDataPath = _userDataPath("data/excelsheets"); // returns "D:/sahi/userdata/data/excelsheets"
$excelDataPath = _userDataPath("data/excelsheets", "\\"); // returns "D:\\sahi\\userdata\\data\\excelsheets"

_resolvePath($relPath[, $fileSeparator])

Details

Returns full file path of file resolved relative to current script path

/*
If the current script is
D:/sahi/userdata/scripts/user/login.sah
If you have common csv file in
D:/sahi/userdata/scripts/common/user.csv
*/
// using
$csvPath = _resolvePath("../common/user.csv"); // returns "D:/sahi/userdata/scripts/common/user.csv"
$csvPath = _resolvePath("../common/user.csv", "\\"); // returns "D:\\sahi\\userdata\\scripts\\common\\user.csv"

_sessionInfo()

Details

Returns information about the current session as an associative array.
The object has attributes:

• isRecording: returns true if recording
• isPlaying: returns true if playingback
• isPaused: returns true if playback is paused
• sessionId: returns Sahi's sessionId
• threadNumber: returns the threadNumber of browser instance running
• scriptPath: returns script path of current script. Same as _scriptPath()

var $sessionInfo = _sessionInfo();
var $sessionId = $sessionInfo["sessionId"];
// or
var $sessionId = $sessionInfo.sessionId;

_suiteInfo()

Details

Returns suite information as an associative array.
Some of the properties in the array are:

• suiteReportId: The suite report id for the suite/script run
• suiteName: Name of suite/script
• suitePath: Path of suite/script
• baseURL: Base url for suite/script run
• browserType: Browser that the suite/script was run on

var $suiteInfo = _suiteInfo();
var $name = $suiteInfo["suiteName"];
// or
var $name = $suiteInfo.suiteName;

_addToSuiteInfo($customFieldName, $customFieldValue)

Details

Appends the customFieldName and customFieldValue in Suite Info.

_addToSuiteInfo("VersionNo", "6.1.1");

_testcasesInfo()

Details

Returns an array of testcase-property objects of the testcases in the script that have already been executed.
A testcase-property is an associative array with the following attributes:

• id: testcase Id, Unique identifier for testcase
• description: Description for testcase
• status: Execution status of the testcase

var $tcs = _testcasesInfo();
for(var $i=0; $i<$tcs.length; $i++){
  var $tc = $tcs[$i];
  _log("id = " + $tc.id + "; description = " + $tc.description + "; status = " + $tc.status + ";");
}

_isDataPassed()

Details

Returns true if data has been passed via a dd.csv data driven suite.
More details here