1. Home
  2. Docs
  3. OpKey Help
  4. 2. Installing Supporting Components
  5. 2.1 Opkey Execution Agent

2.1 Opkey Execution Agent

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 allows for performance of 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.


Installation of the OpKey Execution Agent is very easy. You just need to follow 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 on the OpKey Execution Agent, please refer https://opkey.com/user-guide/pages.php?subid=154&accordid=16 )


Installing OpKey Execution Agent – 

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


You can customize the installation of OpKey Execution Agent features during installation. If you want to install the 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 calculates the available, required & remaining space on your machine. Click on ‘Next’ to proceed.


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.

All required information are collected by the OpKey Execution Agent setup wizard and now, it’s ready to install on your system. Click on ‘Next‘ to proceed.


Installation of OpKey Execution Agent is in progress. Please wait for a while…


Finally, OpKey Execution Agent has been installed on your system successfully. Click on ‘Finish’ to complete installation.

Click on “Click to open log” link to view the installation logs.

All New OpKey Execution Agent installer:


OpKey Execution Agent installation behavior has been improved. Now, there will be only three default plugins (OpKey Desktop, Selenium-JS, and Utility) installed with the OpKey Agent. They are 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 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 AgentData folder as described above. You need to relaunch your OpKey Execution Agent to reflect the changes regarding the newly installed plugin.

You can view all installed OpKey plugins along with their license information at the OpKey Execution Agent dashboard under 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 installation of a plugin is completed, a message of installation of 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. 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 few common scenarios:

Default Plugins (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 an 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.

Print Friendly, PDF & Email
Was this article helpful to you? Yes No