Skip to main content
Version: DAI 6.5


To start using an execution environment, you need to:

Add an Execution Environment

Before you install and configure an agent to run your tests, you must add an execution environment. This process generates a unique access key (.ini file) that you’ll need to complete your agent setup.

To set up an execution environment, follow these steps:

  1. Log in to Eggplant DAI.

  2. Go to Controller > Environments. The Environments page opens showing a list of existing execution environments and their status.

  3. Click Add New +.

  4. In the Name box, enter a unique name for the execution environment with no spaces.


    The agent can run on the same machine as the Eggplant DAI server, or any local or hosted machine that can connect to the Eggplant DAI server via the network.

  5. (Optional) Enter the full path to access the .CSV files for using with code snippets in the suite. For example, for a .CSV file located on your desktop, enter C:\Users\Eggy\Desktop\.

  6. Click Save.

  7. When the Agent access key dialog box appears, click Download and store the .ini file in a secure location. The details of the new execution environment then appears on the Environments page.

  8. Continue to the next section.

Install an Agent

The agent is available as a Windows .exe file, a Mac app, and Linux binaries for CentOS/Red Hat and Ubuntu/Debian. The following OS versions are supported:

  • Windows: 64-bit Windows 7 and 10, Windows Server 2012, 2016, 2019
  • macOS: macOS 10.12, 10.13, 10.14, 10.15 (Note: Big Sur is not currently supported)
  • Linux: RedHat 7, CentOS 7, Ubuntu 16 (64-bit)
  1. On the Environments page, click Agent Tools.
  2. From the Agent Installer list, select the platform that you use.
  3. Select Download to save the installation file to your Downloads folder.
  4. Open your Downloads folder and use the following platform-specific instructions.

For Windows

Double-click eggplantAIagent.exe and follow the prompts to complete the installation.

For macOS

  1. Double-click eggplantAIagent.dmg.
  2. Drag into your Applications folder.

For Linux


The steps for extracting and running the agent are the same across different Linux platforms, although the name of the archive file may differ.

  1. Either manually extract eggplantAIagent-CentOS-RedHat.tar.gz or eggplantAIagent-Ubuntu-Debian.tar.gz to your preferred directory, or use the following script.

    cd $HOME
    mkdir eggplant
    tar -xzf eggplantAIagent-CentOS-4.2.0.tar.gz -C "$HOME/eggplant"
  2. (Optional) To run eggplantAIagent directly from the command line, add export PATH="$PATH:$HOME/eggplant" to your .bashrc or .zshrc file, or use the following commands:

    cd $HOME/eggplant

Launch Your Agent

You can launch the Eggplant DAI Agent from the Start menu on Windows or from the Applications folder on a Mac. You can also run the agent from the command line without a UI. In all cases, the Eggplant DAI Agent is launched ready for you to complete your setup.

For Windows

Open eggplantAiagent from the Start menu.

For macOS

Launch the eggplantAiagent from the Applications folder.

For Linux

Launch your Eggplant DAI Agent from the terminal.

  1. Open a command prompt.

  2. Find the directory where you extracted the .tar.gz file, e.g.:

    cd $HOME/eggplant
  3. Enter the following command to run the agent:


Configure Your Agent

To log in and start using your agent, you must:

Add Your Agent Access Key

  1. On the eggplant DAI agent dialog box, select Add New and browse to the access key (.ini file) that you downloaded in Add an Execution Environment or Regenerate Access Key.
  2. Click Open. The Execution Environment box shows the name and URL of the execution environment that you created and the details are automatically added to an environment settings file on your computer.
  3. Click Login to authenticate with your Eggplant DAI environment. A new Eggplant DAI Agent dialog box appears as soon as your access key is verified.
  4. Delete the access key from your computer.

Enter Your Connection Details

  1. From the Execution environment mode options, select either:

    • Design: To execute tests in the Modeler and Designer (Capture and Live Run). You must use this option if you're authoring in a hosted cloud SUT environment, i.e. the Cloud... button in Eggplant Functional's Connection List is only available in the Design mode.
    • Run: To execute scheduled and immediate test configuration runs from the Eggplant DAI Runner page.
  2. Update the default value in the Eggplant Functional drive executable box if the eggplant.bat is stored in a different place on your system.

  3. If necessary, update the default value in the Port box.

  4. Clear the Start Eggplant Functional GUI checkbox if you want to either:

    • Run Eggplant Functional in drive mode

    • Use Run execution mode for running several tests on the execution environment. Continuous opening and closing of SUT connections may cause problems with Eggplant Functional.


      To improve reliability in Run mode, make sure that initial state of the SUT is verified in your SenseTalk scripts before moving on to subsequent steps.

  5. Select the Extra debug messages checkbox to display more detailed messages in the Log output pane.

  6. In the Suites pane, click Choose to browse and select the folder on your system that contains your Eggplant Functional suites and SenseTalk code snippets. See Manage Suites to learn how to upload and download subfolders in this directory.

  7. Click Start to launch the agent. Both the agent and Eggplant Functional launch automatically.


Click Stop to close the agent or Logout to go back to the Agent Login screen to connect to a different server.

Regenerate an Access Key

If you want to use execution environments that were created before upgrading to Eggplant DAI 6.0, you'll need to regenerate an access key for each one and add the key to your agent. Also follow these instructions if you've regenerated your access key for security reasons.

  1. Log in to Eggplant DAI.

  2. Go to Controller > Environments. The Environments page shows a list of the existing execution environments and their status.

  3. Click on the actions menu of the execution environment that you're interested in and select Regenerate access key:

    Position of actions menu

  4. When the dialog box appears, click Regenerate and then Download. Store the .ini file in a secure location.

  5. Follow the instructions in Add Your Agent Access Key to setup your agent with the new key.