Skip to content
Get Free Trial

Data Generator Functions

The Data Generator functions create random test data such as text, phone numbers, numbers, email addresses, dates, and booleans, for use anywhere in a script.

Since
Sahi Pro 12.0.0.10
Desktop Engine 12.0.0.10
Mobile Engine 12.0.0.10
SAP Engine 12.0.0.10

Modes BrowserWindowsJavaAndroidiOSSAP

_generateText([$prefix[, $minLength[, $maxLength[, $suffix[, $includeAlphabet[, $includeNumeric[, $includeSpecial[, $addTimestamp]]]]]]]])

Arguments

NameTypeDescription
$prefixstringoptionalText to prepend to the generated value
$minLengthintegeroptionalMinimum length of the generated text
$maxLengthintegeroptionalMaximum length of the generated text
$suffixstringoptionalText to append to the generated value
$includeAlphabetbooleanoptionalIf true, the generated text includes alphabet characters
$includeNumericbooleanoptionalIf true, the generated text includes numeric characters
$includeSpecialbooleanoptionalIf true, the generated text includes special characters
$addTimestampbooleanoptionalIf true, appends a timestamp to the generated value

Returns

stringThe generated text value

Generates random text data based on the given parameters.

var $text = _generateText("txt_", 5, 10, "_end", true, true, false, false);
Since
Sahi Pro 12.0.0.10
Desktop Engine 12.0.0.10
Mobile Engine 12.0.0.10
SAP Engine 12.0.0.10

Modes BrowserWindowsJavaAndroidiOSSAP

_generatePhoneNumber([$formats])

Arguments

NameTypeDescription
$formatsarrayoptionalList of phone number formats to generate from, e.g. "+xx (xxx) xxx-xxxx", "xxx-xxx-xxxx"

Returns

stringThe generated phone number

Generates a random phone number based on the given formats.

var $phone = _generatePhoneNumber(["xxx-xxx-xxxx"]);
Since
Sahi Pro 12.0.0.10
Desktop Engine 12.0.0.10
Mobile Engine 12.0.0.10
SAP Engine 12.0.0.10

Modes BrowserWindowsJavaAndroidiOSSAP

_generateNumber([$prefix[, $minValue[, $maxValue[, $decimals[, $separator[, $decimalSeparator[, $suffix]]]]]]])

Arguments

NameTypeDescription
$prefixstringoptionalText to prepend to the generated value
$minValueintegeroptionalMinimum value of the generated number
$maxValueintegeroptionalMaximum value of the generated number
$decimalsintegeroptionalNumber of decimal places in the generated number
$separatorstringoptionalThousands separator to use in the generated number
$decimalSeparatorstringoptionalDecimal separator to use in the generated number
$suffixstringoptionalText to append to the generated value

Returns

stringThe generated number

Generates a random number based on the given parameters.

var $number = _generateNumber("$", 1, 100, 2, ",", ".", "");
Since
Sahi Pro 12.0.0.10
Desktop Engine 12.0.0.10
Mobile Engine 12.0.0.10
SAP Engine 12.0.0.10

Modes BrowserWindowsJavaAndroidiOSSAP

_generateEmail([$names[, $domains[, $excludes[, $addTimestamp]]]])

Arguments

NameTypeDescription
$namesarrayoptionalList of names to use while generating the email address
$domainsarrayoptionalList of domains to use while generating the email address
$excludesarrayoptionalList of email addresses to exclude from generation
$addTimestampbooleanoptionalIf true, appends a timestamp to the generated email address

Returns

stringThe generated email address

Generates a random email address based on the given parameters.

var $email = _generateEmail(["john"], ["example.com"], [], true);
Since
Sahi Pro 12.0.0.10
Desktop Engine 12.0.0.10
Mobile Engine 12.0.0.10
SAP Engine 12.0.0.10

Modes BrowserWindowsJavaAndroidiOSSAP

_generateDate([$from[, $to[, $format]]])

Arguments

NameTypeDescription
$fromdateoptionalFrom date value for the generated date
$todateoptionalTo date value for the generated date
$formatstringoptionalFormat to use for the generated date

Returns

stringThe generated date

Generates a random date based on the given parameters.

var $date = _generateDate("2020-01-01", "2020-12-31", "yyyy/MM/dd");
Since
Sahi Pro 12.0.0.10
Desktop Engine 12.0.0.10
Mobile Engine 12.0.0.10
SAP Engine 12.0.0.10

Modes BrowserWindowsJavaAndroidiOSSAP

_generateBooleanValue([$defaultValue])

Arguments

NameTypeDescription
$defaultValuebooleanoptionalDefault value to use for the generated boolean

Returns

booleanThe generated boolean value

Generates a random boolean value based on the given default value.

var $flag = _generateBooleanValue(true);