Sahi Documentation

Sahi Pro Desktop Add-on

abstract Getting started with Sahi Pro Desktop Add-on Automation.


  1. Java 1.8 or above is needed for running Sahi.
  2. Microsoft .NET framework v4.5+ required for Windows Desktop Automation.
    • To check version of installed Microsoft .NET framework
    • On the Start menu, choose Run.
    • In the Open box, enter regedit.exe
    • In the Registry Editor, open the following subkey: HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\NET Framework Setup\NDP\v4\Full

Download Sahi Pro Desktop Add-on

Download Sahi Pro and Sahi Pro Desktop Add-on from Sahi's download archives.
Install Sahi Pro into a folder without spaces in its path. Then install Sahi Pro Desktop Add-on into the same folder as Sahi Pro. Sahi Pro Desktop Add-on needs a separate license from Sahi Pro. You will need a valid license to run Sahi Pro Desktop Add-on. If you do not have a valid license yet, you can register here for a 30 day evaluation license.

Upgrade Sahi Pro Desktop Add-on

If you wish to upgrade from an older version of Sahi Pro Desktop Add-on, refer to Upgrade for details.

Install Sahi Pro Desktop Add-on

Installing using Configure page

  • Click on the Configure link on the Dashboard. It will open up Sahi's configuration page. Select the Update Sahi Pro link on the left panel.

  • Click on the Install Desktop Add-on link
  • info Sahi will automatically restart to make sure the changes are reflected.

    Installing using Jar

    1. Double click on install_sahi_pro_desktop_xxx.jar to start the installer. If Java is configured properly, it will launch the installer.

      info If the installer does not launch, or if the jar file is opened as if it is a zip file, cancel the unzip dialog, open a command prompt, cd to where the file is downloaded, and run
      java -jar install_sahi_pro_desktop_xxx.jar
    2. infoSahi Pro Desktop Add-on must be installed in the same folder as Sahi Pro is installed. For example, if Sahi Pro is installed at C:/<username>/tools/Sahi_Pro, then install Sahi Pro Desktop Add-on also at C:/<username>/tools/Sahi_Pro.
    3. Add Product Key directly to Sahi product key popup window. Sahi Desktop Add-on needs valid Product Key to be available inside userdata\config\productkey.txt (create if needed).
    4. If the Product Key is valid, Sahi will startup fine and you will be able to access Sahi.
      infoSince Sahi Pro v7.5.0, there is no need to have Sahi Pro license for the automation with Sahi. Sahi Pro Browser capability can be disabled by unchecking the Browser checkbox. One needs to add Product Key based on Sahi capabilities enabled.

    Start Sahi Dashboard

    Start Sahi Dashboard by any of the following methods
    1. Double click on the desktop shortcut
    2. or
    3. Start from the command line.

      Windows: - Go to <sahi_root>\userdata\bin and run start_dashboard.bat

      Linux - Go to <sahi_root>/userdata/bin and run ./
    warning Browser Icons will not be present on Sahi dashboard, if Sahi Pro Browser Capability is disabled.
    info if Sahi Pro Desktop Add-on is installed at correct location, Desktop IconandStart SahiWin exe linkwill automatically appear on Sahi dashboard.

    Automating Windows and Java applications

    Sahi Pro Desktop Add-on provides support for Windows and Java applications. Overall usage of Sahi Pro remains the same.
    The _setMode API allows switching between different modes like Browser, Desktop, Mobile etc. in a single script.

    If you are not familiar with Sahi Pro, go through the Sahi Pro Quick Tutorial.

    Click on below links for detailed use of Sahi Pro with different technologies: