Debug Helper Functions
Some functions are good for debugging Sahi scripts. They are mostly removed once debugging is done.
_debug
Section titled “_debug”- Since
- Sahi Pro 3.5
- Desktop Engine 7.0.0
- Mobile Engine 7.5.0
- SAP Engine 9.0.0
Modes BrowserWindowsJavaAndroidiOSSAP
_debug($message)Arguments
| Name | Type | Description |
|---|---|---|
$message | string | Message to write to Sahi console |
Returns
null |
Debug messages are written in the Sahi console and not in the test run reports. It is useful when correlating to messages appearing on the Sahi console.
// Example:
_debug("Current count is " + $i);_debugToErr
Section titled “_debugToErr”- Since
- Sahi Pro 3.5
- Desktop Engine 7.0.0
- Mobile Engine 7.5.0
- SAP Engine 9.0.0
Modes BrowserWindowsJavaAndroidiOSSAP
_debugToErr($message)Arguments
| Name | Type | Description |
|---|---|---|
$message | string | Message to write to Sahi console error stream |
Returns
null |
Same as _debug, but prints to the error stream.
_debugToFile
Section titled “_debugToFile”- Since
- Sahi Pro 3.5
- Desktop Engine 7.0.0
- Mobile Engine 7.5.0
- SAP Engine 9.0.0
Modes BrowserWindowsJavaAndroidiOSSAP
_debugToFile($message, $filePath)Arguments
| Name | Type | Description |
|---|---|---|
$message | string | Message to write to file |
$filePath | string | Path to file. Relative path resolves relative to where Sahi's process is started from. |
Returns
null |
Prints the message into a file for debugging purposes.
_pause
Section titled “_pause”- Since
- Sahi Pro 5.1.0
- Desktop Engine 7.5.0
- Mobile Engine 7.5.0
- SAP Engine 9.0.0
Modes BrowserWindowsJavaAndroidiOSSAP
_pause()Arguments
| Name | Type | Description |
|---|---|---|
None |
Returns
null |
Runs the script till that point and pauses execution. Acts like a debugger breakpoint. The rest of the run can be controlled from the Controller with Step or Play buttons.
_alert
Section titled “_alert”- Since
- Sahi Pro 3.5
Modes Browser
_alert($message)Arguments
| Name | Type | Description |
|---|---|---|
$message | string | Message to be alerted on browser. |
Returns
null |
Alerts the message on the browser. This allows a very handy, interactive way of debugging scripts.
//Example:_alert("Current count is " + $i);_confirm
Section titled “_confirm”- Since
- Sahi Pro 3.5
Modes Browser
_confirm($message)Arguments
| Name | Type | Description |
|---|---|---|
$message | string | Message to confirm |
Returns
null |
Brings up a javascript confirm dialog with given message. Use only while debugging.
_prompt
Section titled “_prompt”- Since
- Sahi Pro 3.5
Modes Browser
_prompt($message)Arguments
| Name | Type | Description |
|---|---|---|
$message | string | Message to prompt |
Returns
null |
Brings up a javascript prompt with given message. Use only while debugging.
_highlight
Section titled “_highlight”- Since
- Sahi Pro 3.5
- Desktop Engine 7.0.0
- Mobile Engine 7.5.0
- SAP Engine 9.0.0
Modes BrowserWindowsJavaAndroidiOSSAP
_highlight($element)Arguments
| Name | Type | Description |
|---|---|---|
$element | HTML DOM element | Element to highlight |
Returns
null |
Highlights an element with a red border. Used for debugging purposes.

