Utility APIs
_random
| Since: | Sahi Pro | Desktop Add-On | Mobile Add-On | SAP Add-On | AI Assist Add-On |
| 3.5 | 7.0.0 | 7.5.0 | 9.0.0 | NA |
Available for modes: Browser | Windows | Java | Android | iOS | SAP
_random($maxNumber)
Arguments
| $maxNumber | integer | maximum number |
Returns
| integer | Random number between 0 and maxNumber |
Sahi Pro Flowcharts Action :Random
Details
warning
Two calls to _random() may return the same number. DO NOT use it for uniqueness.
_extract
| Since: | Sahi Pro | Desktop Add-On | Mobile Add-On | SAP Add-On | AI Assist Add-On |
| 4.3 | 7.0.0 | 7.5.0 | 9.0.0 | NA |
Available for modes: Browser | Windows | Java | Android | iOS | SAP
_extract($str, $pattern[, $onlyGroups])
Arguments
| $str | string | String to find pattern in |
| $pattern | string | Regular expression as native regex (/a/) or as a string ("/a/") |
| $onlyGroups | boolean optional | if true, returns only the groups matched. |
Returns
| string | Content from a string if there is only one matched pattern |
| array of strings | Array of matched pattern from the specified string |
Sahi Pro Flowcharts Action :Extract
Details
This API helps extract specific content from strings.
This API helps extract specific content from strings.
// Example:
// To get value "250" from "Rs. 250"
_extract("Rs. 250", "/Rs. (.*)/", true); // returns "250"
_extract("Rs. 250", "/Rs. (.*)/"); // returns an array ["Rs. 250", "250"]
// Multiple groups with and without onlyGroups
var $str = "The traffic light changed from red to green";
var $pattern = "/from (.*) to (.*)/";
var $extracted = _extract($str, $pattern);
// $extracted now has the overall match "from red to green" and the individual groups "red" and "green"
_assertEqual(["from red to green", "red", "green"], $extracted);
// Setting onlyGroups=true, we do not get back the overall match.
var $extracted = _extract($str, $pattern, true);
// $extracted now has only the individual groups "red" and "green"
_assertEqual(["red", "green"], $extracted);
_trim
| Since: | Sahi Pro | Desktop Add-On | Mobile Add-On | SAP Add-On | AI Assist Add-On |
| 5.1.0 | 7.0.0 | 7.5.0 | 9.0.0 | NA |
Available for modes: Browser | Windows | Java | Android | iOS | SAP
_trim($arg)
Arguments
| $arg | string|array of strings|two dimensional array of strings | String or 1-d or 2-d array. |
Returns
| string | trimmed string if $arg is a string |
| array of strings | trimmed array if $arg is an array |
| two dimensional array of strings | trimmed 2 dimensional array if $arg is a 2 dimensional array |
Sahi Pro Flowcharts Action :Trim
Details
var $s = " sahi pro ";
$s = _trim($s);
_assertEqual("sahi pro", $s);
var $arr = ["",,,"sahi", "pro",,,"",,];
$arr = _trim($arr);
_assertEqual("sahi", $arr[0]);
_assertEqual("pro", $arr[1]);
_assertEqual(2, $arr.length);
var $array2D = [[],[],[],["","",""],["abc", "xyz", "c"], ["1", "2", "3"], ["1", "2", "3"], ["1", "2", "3"], ["1", "2", "3"],[],[""],[]];
$array2D = _trim($array2D);
_assertEqual("xyz", $array2D[0][1]);
_assertEqual(5, $array2D.length);
_toJSON
| Since: | Sahi Pro | Desktop Add-On | Mobile Add-On | SAP Add-On | AI Assist Add-On |
| 6.0.0 | 7.0.0 | 7.5.0 | 9.0.0 | NA |
Available for modes: Browser | Windows | Java | Android | iOS | SAP
_toJSON($object)
Arguments
| $object | JSON Object | JSON to convert to string. |
Returns
| string | JSON string |
Sahi Pro Flowcharts Action :To JSON
Details
It converts a JSON object to String.
Example
It converts a JSON object to String.
Example
var $libObj = {
"name":"John Johnson",
"street":"Oslo West 16",
"age":33,
"phone":"555 1234567"};
// Gives string corresponding to json object.
var $jsonString = _toJSON($libObj);
_encrypt
| Since: | Sahi Pro | Desktop Add-On | Mobile Add-On | SAP Add-On | AI Assist Add-On |
| 7.5.0 | 7.5.0 | 7.5.0 | 9.0.0 | NA |
Available for modes: Browser | Windows | Java | Android | iOS | SAP
_encrypt($password)
Arguments
| $password | string | password to be encrypted |
Returns
| string | Encrypted password string |
Sahi Pro Flowcharts Action :Encrypt
Details
Example
Example
var $pass = _encrypt("secret");
_setPassword(_password("password"), $pass);
info
Salt is used to encrypt the password.
You can change the salt by changing the property
You can change the salt by changing the property
script.salt_for_password_encryption in userdata/config/userdata.propertiesfile.infoIf
script.salt_for_password_encryption property is present in userdata/config/userdata_hidden.properties as well, then this property will be considered only from userdata_hidden.propertiesfile.
_getSessionId
| Since: | Sahi Pro | Desktop Add-On | Mobile Add-On | SAP Add-On | AI Assist Add-On |
| 7.5.0 | NA | NA | 9.0.0 | NA |
Available for modes: Browser
_getSessionId([$windowIdentifier])
Arguments
| $windowIdentifier | string optional | the windowIdentifier can be the window name, the window title, the window url or a regular expression of any of these. |
Returns
| array of strings | Array of sessionId |
Sahi Pro Flowcharts Action :Get Session Id
Details
Example
Example
var $sessionId = _getSessionId("Sahi Start");
$sessionId = _getSessionId("/Sahi/");
$sessionId = _getSessionId("/Sahi/[0]");
$sessionId = _getSessionId();