1. Home
  2. Opkey Help
  3. 2. Installing supporting components
  4. 2.4 Downloading & Installing Opkey Execution Agent

2.4 Downloading & Installing Opkey Execution Agent

Quick Start Screencast – 

Our Opkey Execution Agent is a functional test execution engine which helps you to execute your test script. Opkey Execution is required to perform test execution with all editions of Opkey. After installing Opkey Execution Agent on your machine, review all configurations to ensure compatibility.

Opkey Execution Agent is available independently of Opkey and required for test automation.

Users are able to download Opkey Execution Agent at no additional cost from the Download Center located on the top left of the Opkey Dashboard.

Note: For on-premise Opkey Web users, you are recommended to contact the Opkey Support team to get the link for downloading the Opkey Agent, plugins, smart recorder, etc. For on-premise Opkey Web users, Download Center is not available.

  • Click on the Opkey Agent.
  • The Agent Information page opens.

  • Click on the Download Agent link.
  • Once the setup file of Opkey Agent is downloaded, install it on your Windows machine.

The installation of the Opkey Execution Agent is very easy. You just need to follow a few standard steps of installation.

noteBefore installing Opkey Execution Agent from Download Center, you must be informed that it will replace your existing Execution Agent, if any is installed on your machine.

You can execute your Test Scripts on Opkey-Desktop as well as Opkey-Web by using the same execution agent, just by applying required configuration settings.

For detailed information about the Opkey Execution Configuration, please refer: Opkey Agent Configuration


Installing Opkey Execution Agent – 

  • Installing Opkey Execution Agent is very easy. Double click the downloaded setup file and follow installation steps.


  • Click on Next to initiate the Agent installation process.


  • Here, you can read End User License Agreement. Check “I accept the terms of the License Agreement” checkbox and click on Next.

  • You can customize installation of Opkey Execution Agent features during installation. If you want to install full version of Opkey Execution Agent then select ‘Full‘ and select ‘Custom‘ if you want to customize it. Click on ‘Next‘ to proceed.

  • In this step, Opkey Execution Agent calculate the available, required & remaining space on your machine. Click on ‘Next‘ to proceed.

  • From here, you can customize usage of this Opkey Execution Agent being installed on your machine for All users of this computer or Just me. If you select All users of this computer then it will be accessible to all users working on this computer whereas if you select ‘Just me’ then it will be accessible only to the current user of this computer.
  • You can check Create Installation Logs to view installation logs on completion of Agent installation. Click on Next to proceed.

  • In this step, Agent installation is being prepared. Click Next to proceed.

  • Your installation process is going on. Please wait for a while…

  • Here, you need to enter the Agent Authentication Code. Authentication Code (a unique alphanumeric key) available on the Agent Information page under Download Center. This authentication code is required to connect Opkey domain with agent so that connection of local machine can be done with Opkey’s cloud server.
  • If you want to install Agent without entering Authentication code, mark Continue without Authentication code checkbox and click on Next.

  • Click Finish to complete the installation process.

Agent Authentication Code: 

Now, there is an authentication code (a unique alphanumeric) for Opkey Agent which is available on the Download Agent page under Download Center. This authentication code is required during the installation of Opkey Execution Agent in Web Mode (by default), you will need to enter this Agent authentication code to the specified text field and click on Finish. Once the installation has finished successfully, a shortcut icon of Opkey Agent is created on the desktop. Double click this shortcut icon to launch the Opkey Agent. Here, you can view that your Opkey Agent is configured successfully in Web Mode, and you are logged in. Thus, you need not configure the Opkey Agent manually.

All New Opkey Execution Agent installer:


Opkey Execution Agent installation behavior has been improved. Now, there will be only four default plugins (Opkey_Utility, Opkey Desktop, IE-Plugin, Selenium-JS, and Utility) installed with the Opkey Agent. They are the most commonly used plugins for executing tests with Opkey.

Earlier to this, all the supporting plugins were getting installed with the Opkey Agent. All the installed plugins were not frequently used plugins and the size of the Agent installer was a bit big which was taking more time to install them.



You should have admin privileges for installing Opkey Agent in the default location (C drive of local machine). As a Non-Admin user, you can install it to a different location (any other drive of local machine which requires no admin privileges).


Once Opkey Agent has installed successfully, you can execute your test scripts by using the default plugins or additional plugins (if you have installed) on Opkey Desktop and Web by switching Opkey Agent to Opkey Desktop & Web mode respectively.

If you need to install additional supported plugins then you need to install it externally. Once the new plugin has installed successfully, you can view a new folder with the same plugin name under the AgentData folder as described above. You need to relaunch your Opkey Execution Agent to reflect the changes regarding the newly installed plugin.

noteThere are four default plugins which get installed automatically with the Opkey Agent & they are Opkey-IE, Opkey Desktop, Web & Utility Plugin with 30 days of trail period. You can also extend and avail license by contacting to Opkey Support team.

You can view all installed Opkey plugins along with their license information at the Opkey Execution Agent dashboard under the Plugin License Information section. Default installed plugins are shown below:

You can also view installed plugins displaying under the Plugin Manager in the Opkey Agent Tools menu. Click on the Plugin Manager option displaying under the Tools menu in Opkey Execution Agent.


Default installed plugins are shown below:

Check For Updates link is available under the Help menu in the Opkey Agent as shown below:

When you click on Check For Updates link given under the About Opkey Execution Agent option in the Help menu, it starts checking for the available updates of the Opkey Agent.

If updates are available then it displays the list of all available updates as shown below:

If you want to install those updates, click on Yes & proceed. If you don’t want to update your Opkey Agent, click on No.

After clicking on Yes, it starts downloading the available updates.

Once downloading of Agent updates has completed, it prompts a message that “Do you want to allow this app to make changes to your device?” Click on Yes to install the plugin. Follow general instructions to install the plugin. Once the installation of a plugin is completed, a message of installation of the next plugin appears. Similarly, follow the general instructions to install the plugin. Thus, you need to follow the general instructions to install download updates of the Opkey Agent one by one. Once all the updates have been installed successfully, a message appears that Plugin(s) have been updated successfully. Changes will be applied after Agent restarts. Click on OK.

If the updates are available for many plugins then you are asked to install updates of the installed plugins one by one.

By default, plugins are installed at the same location where Opkey Agent is installed. The user has no option to install the plugin update to a different location, other than the installed Agent location. If updates are not available for the installed plugins, it displays a message that Opkey Agent is Up to Date.

If Check for new agent updates automatically on StartUp checkbox is checked then Agent will check for the available updates for the installed plugins as well as any other changes to the Agent. If it is not checked then you need to click on Check For Updates link manually to look for the available updates regarding your Opkey Agent.

On the basis of users (Admin & Non-Admin), there are a few common scenarios:

Default Plugins (Opkey_Utility, Opkey_Desktop, Selenium-JS & Utility):

  • Admin & Non-Admin users can use default plugins to execute their test scripts but such plugins cannot be uninstalled by any user.
  • If Opkey Agent is installed by an Admin User then updates of these default plugins will be visible to all users (Admin & Non-Admin) but they can only be installed by the Admin users.

Additional Plugins ( Selenium_WebDriver, OracleEBS, Appium, etc.):

  • If Agent has been installed by an Admin user (to be used by all users) and additional plugins have also been installed by an Admin user then they can only be uninstalled by the Admin user. However, these plugins can be used by all users (Admin & Non-Admin) for executing their test script.
  • If Agent has been installed by an Admin user (to be used by all users) & updates of additional installed plugins are available then updates will be visible to all users (Admin & Non-Admin) but updates of such additional plugins can only be installed by the admin users.
  • If Opkey Agent has been installed by a Non-Admin user on a local machine drive (which needs no admin rights) then additional plugins can be easily installed by the Non-admin users. In this case, this Agent can only be used by that Non-Admin user who has installed it. It will not be visible to any other user.

noteAfter installing an external Plugins), you need to relaunch the Opkey Agent (go to the File menu and click on Relaunch) to reflect the applied changes.

Was this article helpful to you? Yes 4 No 4