Sahi Documentation

APIs used in Debugging Sahi Scripts

abstract Some APIs are good for debugging Sahi scripts. They are mostly removed once debugging is done.

_debug

Since: Sahi ProSahi OSSahi Pro StarterDesktop Add-OnMobile Add-OnSAP Add-OnAI Assist Add-On
3.527.0.17.0.07.5.09.0.0NA

Available for modes: Browser | Windows | Java | Android | iOS | SAP | AI Assist

_debug($message)

Arguments
$messagestring Message to write to Sahi console

Returns
null

Details

Debug messages are written in the Sahi console and not in the playback logs. It is useful when correlating to messages appearing on the Sahi console.

Example:

_debug("Current count is " + $i);


_debugToErr

Since: Sahi ProSahi OSSahi Pro StarterDesktop Add-OnMobile Add-OnSAP Add-OnAI Assist Add-On
3.527.0.17.0.07.5.09.0.0NA

Available for modes: Browser | Windows | Java | Android | iOS | SAP | AI Assist

_debugToErr($message)

Arguments
$messagestring Message to write to Sahi console error stream

Returns
null

Details

Same as _debug, but prints to the error stream.


_debugToFile

Since: Sahi ProSahi OSSahi Pro StarterDesktop Add-OnMobile Add-OnSAP Add-OnAI Assist Add-On
3.527.0.17.0.07.5.09.0.0NA

Available for modes: Browser | Windows | Java | Android | iOS | SAP | AI Assist

_debugToFile($message, $filePath)

Arguments
$messagestring Message to write to file
$filePathstring Path to file. Relative path resolves relative to where Sahi's process is started from.

Returns
null

Details

Prints the message into a file for debugging purposes.


_pause

Since: Sahi ProSahi OSSahi Pro StarterDesktop Add-OnMobile Add-OnSAP Add-OnAI Assist Add-On
5.1.0NA7.0.17.5.07.5.09.0.0NA

Available for modes: Browser | Windows | Java | Android | iOS | SAP | AI Assist

_pause()

Arguments
None

Returns
null

Details

Runs the script till that point and pauses execution. Acts like a debugger breakpoint. Further playback can be controlled from the Controller Playback tab via Step or Play buttons.
warningDO NOT leave this in a production script, since it needs user input to proceed and will halt execution


_alert

Since: Sahi ProSahi OSSahi Pro StarterDesktop Add-OnMobile Add-OnSAP Add-OnAI Assist Add-On
3.527.0.1NANANANA

Available for modes: Browser

_alert($message)

Arguments
$messagestring Message to be alerted on browser.

Returns
null

Details

Alerts the message on the browser. This allows a very handy, interactive way of debugging scripts.

Example:

_alert("Current count is " + $i);
warningDO NOT leave this in a production script, since it needs user input to proceed and will halt execution


_confirm

Since: Sahi ProSahi OSSahi Pro StarterDesktop Add-OnMobile Add-OnSAP Add-OnAI Assist Add-On
3.53.57.0.1NANANANA

Available for modes: Browser

_confirm($message)

Arguments
$messagestring Message to confirm

Returns
null

Details

Brings up a javascript confirm dialog with given message. Use only while debugging.


_prompt

Since: Sahi ProSahi OSSahi Pro StarterDesktop Add-OnMobile Add-OnSAP Add-OnAI Assist Add-On
3.527.0.1NANANANA

Available for modes: Browser

_prompt($message)

Arguments
$messagestring Message to prompt

Returns
null

Details

Brings up a javascript prompt with given message. Use only while debugging.


_highlight

Since: Sahi ProSahi OSSahi Pro StarterDesktop Add-OnMobile Add-OnSAP Add-OnAI Assist Add-On
3.527.0.17.0.07.5.09.0.0NA

Available for modes: Browser | Windows | Java | Android | iOS | SAP | AI Assist

_highlight($element)

Arguments
$elementHTML DOM element Element to highlight

Returns
null

Details

Highlights an element with a red border. Used for debugging purposes.