Skip to content
Sahi Pro Flowcharts is retired. These pages document the last release (v12) and are no longer updated. Go to the current documentation.Flowcharts is retired. Current docs
Get Free Trial
Sahi Pro Flowcharts is retired. These pages document the last release (v12) and are no longer updated. Go to the current documentation.

Script Suite Info APIs

Modes BrowserWindowsJavaAndroidiOSSAP

Parameters

NameTypeDescription
None

Returns

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

Sahi Pro Classic API _scriptName

Modes BrowserWindowsJavaAndroidiOSSAP

Parameters

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

Returns

stringFull script file path
Raw script
// 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"

Sahi Pro Classic API _scriptPath

Modes BrowserWindowsJavaAndroidiOSSAP

Parameters

NameTypeDescription
None

Returns

objectScript start time as a Date object
Raw script
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();

Sahi Pro Classic API _scriptStartTime

Modes BrowserWindowsJavaAndroidiOSSAP

Parameters

NameTypeDescription
None

Returns

string'SUCCESS' or 'FAILURE'

Sahi Pro Classic API _scriptStatus

Modes BrowserWindowsJavaAndroidiOSSAP

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

Parameters

NameTypeDescription
None

Returns

objectScript object
Raw script
var $scriptInfo = _scriptInfo();
var $browserVersion = $scriptInfo["browserVersion"];
// or
var $name = $scriptInfo.browserVersion;

Sahi Pro Classic API _scriptInfo

Modes BrowserWindowsJavaAndroidiOSSAP

Appends the customFieldName and customFieldValue in Script Info.

Parameters

NameTypeDescription
$customFieldNamestringName of the Custom Field.
$customFieldValuestringValue of the Custom Field.
Raw script
_addToScriptInfo("summary", "Login - Regression Testing");

Sahi Pro Classic API _addToScriptInfo

Modes BrowserWindowsJavaAndroidiOSSAP

Parameters

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

Returns

stringFull file path of userdata directory
Raw script
$userDataPath = _userDataDir(); // returns "D:/sahi/userdata"
$userDataPath = _userDataDir("\\"); // returns "D:\sahi\userdata"

Sahi Pro Classic API _userDataDir

Modes BrowserWindowsJavaAndroidiOSSAP

Parameters

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
Raw script
// 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"

Sahi Pro Classic API _userDataPath

Modes BrowserWindowsJavaAndroidiOSSAP

Parameters

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
Raw script
/*
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"

Sahi Pro Classic API _resolvePath

Modes BrowserWindowsJavaAndroidiOSSAP

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()

Parameters

NameTypeDescription
None

Returns

objectCurrent session object
Raw script
var $sessionInfo = _sessionInfo();
var $sessionId = $sessionInfo["sessionId"];
// or
var $sessionId = $sessionInfo.sessionId;

Sahi Pro Classic API _sessionInfo

Modes BrowserWindowsJavaAndroidiOSSAP

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

Parameters

NameTypeDescription
None

Returns

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

Sahi Pro Classic API _suiteInfo

Modes BrowserWindowsJavaAndroidiOSSAP

Appends the customFieldName and customFieldValue in Suite Info.

Parameters

NameTypeDescription
$customFieldNamestringName of the Custom Field.
$customFieldValuestringValue of the Custom Field.
Raw script
_addToSuiteInfo("VersionNo", "6.1.1");

Sahi Pro Classic API _addToSuiteInfo

Modes BrowserWindowsJavaAndroidiOSSAP

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

Parameters

NameTypeDescription
None

Returns

array of objectsArray of testcase-property objects of the testcases in the script that have already been executed
Raw script
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 + ";");
}

Sahi Pro Classic API _testcasesInfo

Modes BrowserWindowsJavaAndroidiOSSAP

More details here

Parameters

NameTypeDescription
None

Returns

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

Sahi Pro Classic API _isDataPassed