Skip to content
Get Free Trial

Script and Suite Info Functions

Since
Sahi Pro 3.5
Desktop Engine 7.0.0
Mobile Engine 7.5.0
SAP Engine 9.0.0

Modes BrowserWindowsJavaAndroidiOSSAP

_scriptName()

Arguments

NameTypeDescription
None

Returns

stringScript name
// In script D:/sahi/userdata/scripts/sahitests/check.sah
var $scriptName = _scriptName(); // returns "check.sah"
Since
Sahi Pro 3.5
Desktop Engine 7.0.0
Mobile Engine 7.5.0
SAP Engine 9.0.0

Modes BrowserWindowsJavaAndroidiOSSAP

_scriptPath([$fileSeparator])

Arguments

NameTypeDescription
$fileSeparatorstringoptionalTo get full script file path with specified file separator. Can be one of "\\" or "/" Defaults to "/"

Returns

stringFull script file path
// In script D:/sahi/userdata/scripts/sahitests/check.sah
var $_scriptPath = _scriptPath(); // returns "D:/sahi/userdata/scripts/sahitests/check.sah"
var $_scriptPath = _scriptPath("\\"); // returns "D:\sahi\userdata\scripts\sahitests\check.sah"
Since
Sahi Pro 4.3
Desktop Engine 7.0.0
Mobile Engine 7.5.0
SAP Engine 9.0.0

Modes BrowserWindowsJavaAndroidiOSSAP

_scriptStartTime()

Arguments

NameTypeDescription
None

Returns

objectScript start time 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();
Since
Sahi Pro 3.5
Desktop Engine 7.0.0
Mobile Engine 7.5.0
SAP Engine 9.0.0

Modes BrowserWindowsJavaAndroidiOSSAP

_scriptStatus()

Arguments

NameTypeDescription
None

Returns

string'SUCCESS' or 'FAILURE'
Since
Sahi Pro 9.2.0
Desktop Engine 9.2.0
Mobile Engine 9.2.0
SAP Engine 9.2.0

Modes BrowserWindowsJavaAndroidiOSSAP

_scriptInfo()

Arguments

NameTypeDescription
None

Returns

objectScript object

Returns script information as an associative array. One of the properties in the array is:

  • browserVersion: Browser version on which script is running

  • userAgent: Browser User-Agent on which script is running

var $scriptInfo = _scriptInfo();
var $browserVersion = $scriptInfo["browserVersion"];
// or
var $name = $scriptInfo.browserVersion;
Since
Sahi Pro 9.2.0
Desktop Engine 9.2.0
Mobile Engine 9.2.0
SAP Engine 9.2.0

Modes BrowserWindowsJavaAndroidiOSSAP

_addToScriptInfo($customFieldName, $customFieldValue)

Arguments

NameTypeDescription
$customFieldNamestringName of the Custom Field.
$customFieldValuestringValue of the Custom Field.

Returns

null

Appends the customFieldName and customFieldValue in Script Info.

_addToScriptInfo("summary", "Login - Regression Testing");
Since
Sahi Pro 3.5
Desktop Engine 7.0.0
Mobile Engine 7.5.0
SAP Engine 9.0.0

Modes BrowserWindowsJavaAndroidiOSSAP

_userDataDir([$fileSeparator])

Arguments

NameTypeDescription
$fileSeparatorstringoptionalTo get path with specified file separator. Can be one of "\\" or "/" Defaults to "/"

Returns

stringFull file path of userdata directory
$userDataPath = _userDataDir(); // returns "D:/sahi/userdata"
$userDataPath = _userDataDir("\\"); // returns "D:\sahi\userdata"
Since
Sahi Pro 3.5
Desktop Engine 7.0.0
Mobile Engine 7.5.0
SAP Engine 9.0.0

Modes BrowserWindowsJavaAndroidiOSSAP

_userDataPath($relPath[, $fileSeparator])

Arguments

NameTypeDescription
$relPathstringPath to resolve relative to userdata path
$fileSeparatorstringoptionalTo get path with specified file separator. Can be one of "\\" or "/" Defaults to "/"

Returns

stringFull 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"
Since
Sahi Pro 3.5
Desktop Engine 7.0.0
Mobile Engine 7.5.0
SAP Engine 9.0.0

Modes BrowserWindowsJavaAndroidiOSSAP

_resolvePath($relPath[, $fileSeparator])

Arguments

NameTypeDescription
$relPathstringPath to resolve relative to current script path
$fileSeparatorstringoptionalTo get path with specified file separator. Can be one of "\\" or "/" Defaults to "/"

Returns

stringFull 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"
Since
Sahi Pro 3.5
Desktop Engine 7.0.0
Mobile Engine 7.5.0
SAP Engine 9.0.0

Modes BrowserWindowsJavaAndroidiOSSAP

_sessionInfo()

Arguments

NameTypeDescription
None

Returns

objectCurrent session object

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 the test run 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;
Since
Sahi Pro 3.5
Desktop Engine 7.0.0
Mobile Engine 7.5.0
SAP Engine 9.0.0

Modes BrowserWindowsJavaAndroidiOSSAP

_suiteInfo()

Arguments

NameTypeDescription
None

Returns

objectSuite object

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;
Since
Sahi Pro 6.2.0
Desktop Engine 7.5.0
Mobile Engine 7.5.0
SAP Engine 9.0.0

Modes BrowserWindowsJavaAndroidiOSSAP

_addToSuiteInfo($customFieldName, $customFieldValue)

Arguments

NameTypeDescription
$customFieldNamestringName of the Custom Field.
$customFieldValuestringValue of the Custom Field.

Returns

null

Appends the customFieldName and customFieldValue in Suite Info.

_addToSuiteInfo("VersionNo", "6.1.1");
Since
Sahi Pro 6.1.0
Desktop Engine 7.0.0
Mobile Engine 7.5.0
SAP Engine 9.0.0

Modes BrowserWindowsJavaAndroidiOSSAP

_testcasesInfo()

Arguments

NameTypeDescription
None

Returns

array of objectsArray 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
  • timeTaken: Time taken for testcase execution
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 + "; timeTaken = " + $tc.timeTaken + ";");
}
Since
Sahi Pro 5.1.0
Desktop Engine 7.0.0
Mobile Engine 7.5.0
SAP Engine 9.0.0

Modes BrowserWindowsJavaAndroidiOSSAP

_isDataPassed()

Arguments

NameTypeDescription
None

Returns

booleantrue if data has been passed via a dd.csv data driven suite, else false

More details here