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 Pro | Sahi OS | Sahi Pro Starter | Desktop Add-On | Mobile Add-On | SAP Add-On | AI Assist Add-On |
3.5 | 2 | 7.0.1 | 7.0.0 | 7.5.0 | 9.0.0 | NA |
Available for modes: Browser | Windows | Java | Android | iOS | SAP | AI Assist
_debug($message)
Arguments
$message | string | 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 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 Pro | Sahi OS | Sahi Pro Starter | Desktop Add-On | Mobile Add-On | SAP Add-On | AI Assist Add-On |
3.5 | 2 | 7.0.1 | 7.0.0 | 7.5.0 | 9.0.0 | NA |
Available for modes: Browser | Windows | Java | Android | iOS | SAP | AI Assist
_debugToErr($message)
Arguments
$message | string | Message to write to Sahi console error stream |
Returns
null |
Details
Same as _debug, but prints to the error stream.
Same as _debug, but prints to the error stream.
_debugToFile
Since: | Sahi Pro | Sahi OS | Sahi Pro Starter | Desktop Add-On | Mobile Add-On | SAP Add-On | AI Assist Add-On |
3.5 | 2 | 7.0.1 | 7.0.0 | 7.5.0 | 9.0.0 | NA |
Available for modes: Browser | Windows | Java | Android | iOS | SAP | AI Assist
_debugToFile($message, $filePath)
Arguments
$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 |
Details
Prints the message into a file for debugging purposes.
Prints the message into a file for debugging purposes.
_pause
Since: | Sahi Pro | Sahi OS | Sahi Pro Starter | Desktop Add-On | Mobile Add-On | SAP Add-On | AI Assist Add-On |
5.1.0 | NA | 7.0.1 | 7.5.0 | 7.5.0 | 9.0.0 | NA |
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.
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 Pro | Sahi OS | Sahi Pro Starter | Desktop Add-On | Mobile Add-On | SAP Add-On | AI Assist Add-On |
3.5 | 2 | 7.0.1 | NA | NA | NA | NA |
Available for modes: Browser
_alert($message)
Arguments
$message | string | 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:
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 Pro | Sahi OS | Sahi Pro Starter | Desktop Add-On | Mobile Add-On | SAP Add-On | AI Assist Add-On |
3.5 | 3.5 | 7.0.1 | NA | NA | NA | NA |
Available for modes: Browser
_confirm($message)
Arguments
$message | string | Message to confirm |
Returns
null |
Details
Brings up a javascript confirm dialog with given message. Use only while debugging.
Brings up a javascript confirm dialog with given message. Use only while debugging.
_prompt
Since: | Sahi Pro | Sahi OS | Sahi Pro Starter | Desktop Add-On | Mobile Add-On | SAP Add-On | AI Assist Add-On |
3.5 | 2 | 7.0.1 | NA | NA | NA | NA |
Available for modes: Browser
_prompt($message)
Arguments
$message | string | Message to prompt |
Returns
null |
Details
Brings up a javascript prompt with given message. Use only while debugging.
Brings up a javascript prompt with given message. Use only while debugging.
_highlight
Since: | Sahi Pro | Sahi OS | Sahi Pro Starter | Desktop Add-On | Mobile Add-On | SAP Add-On | AI Assist Add-On |
3.5 | 2 | 7.0.1 | 7.0.0 | 7.5.0 | 9.0.0 | NA |
Available for modes: Browser | Windows | Java | Android | iOS | SAP | AI Assist
_highlight($element)
Arguments
$element | HTML DOM element | Element to highlight |
Returns
null |
Details
Highlights an element with a red border. Used for debugging purposes.
Highlights an element with a red border. Used for debugging purposes.