Add a WebDriver endpoint

WebDriver endpoints let Ranorex Studio execute tests against a Selenium or Appium WebDriver infrastructure by connecting to a running server.

Before adding the endpoint:

• Set up your WebDriver infrastructure.
• Start the server and note its address.

Selenium WebDriver

• Setting up a Selenium infrastructure is covered in Selenium WebDriver integration.

Appium WebDriver

• On Appium, Ranorex Studio currently supports only mobile web tests.
• For help with setting up an Appium infrastructure, please refer to the official Appium documentation.
• Also, make sure you set the command timeout to at least 30 seconds in the plugin settings for WebDriver.

1. Open the endpoint list.
   
2. In an empty endpoint list, click Add endpoint. Or, in the list that is not empty, click +.
   
3. Select WebDriver.

4. Enter:

   1. A name for the endpoint.
   2. The server address.

   Note: Use the server URL required by your Grid or cloud provider. Older Selenium setups may use /wd/hub, but most Selenium Grid 4 and later setups use the router root URL directly (for example, http://<host>:4444)

5. Click Test connection to see if a connection can be established. 
   If the test fails, check that your server address is correct and that the server is running.
6. Click Add endpoint and Complete setup.
7. The new WebDriver endpoint appears in the endpoint list.
   

Endpoint configurations tell a Selenium WebDriver endpoint how to behave during execution. Selenium calls these characteristics capabilities (OS, browser, browser version, etc.). In Ranorex Studio, the complete set is an endpoint configuration.

Endpoint configurations make it possible to easily execute tests in a Selenium grid on multiple different system configurations without actually needing to have any of these systems present.

To add a configuration to an endpoint:

1. Click the symbol to the right of a Selenium WebDriver endpoint.
2. Click View details.
   
    
3. Click Add new configuration.
   

1. Endpoint information showing name, connection status, and server address.
2. List of currently running browsers with browser name and URL.

1. Enter a name.
2. (Optional) Enter a description.

3. Enter the configuration, i.e., the capabilities definition, as JSON.
   Make sure it conforms to the requirements of your Selenium Grid provider. Selenium provides a list of capabilities. In the screenshot, the capabilities JSON conforms to the requirements for Sauce Labs.
   

   Note: If you are unfamiliar with JSON, use the Ranorex Studio capabilities configurator. Simply select your capabilities and provider and let the configurator put together the JSON. Then, just paste the JSON into the Capabilities JSON box of the endpoint.

4. Click Save to confirm. The configuration appears in the endpoint details.

   

Next steps

• Generate capabilities quickly: Capabilities configurator
• Execute across multiple capability sets in parallel: Ranorex Parallel Runner
• General endpoint actions (automation root, details): Endpoint settings