Skip to main content
Version: DAI 7.1


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 agents 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. See the Prerequisites page for information about supported operating systems.

  1. On the Environments page, click Agent Tools.
    Separate installers are available for the DAI Design Agent and the DAI Run Agent. You can choose to download either or both. For each installer that you require carry out the following steps 2 to 4:
  2. From the Design/Run 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.
New Feature

[Windows Only] From version 7.0.0-0 onwards, if you have an older agent installed i.e. eggplantAIagent, it will be removed during the installation of either the newer DAI Design Agent or the newer DAI Run Agent.

For Windows

Double-click eggplantDAIDesignAgent.exe or eggplantDAIRunAgent.exe and follow the prompts to complete the installation.

For macOS

  1. Double-click eggplantDAIDesignAgent.dmg or eggplantDAIRunAgent.dmg.
  2. Drag or into your Applications folder.

For Linux


The steps for extracting and running the agent are the same across different Linux platforms.

  1. Manually extract eggplantDAIDesignAgent-Linux.tar.gz or eggplantDAIRunAgent-Linux.tar.gz to your preferred directory, or use the following script:

    cd $HOME
    mkdir eggplant
    tar -xzf eggplantDAIDesignAgent-Linux-7.0.0-0.tar.gz -C "$HOME/eggplant"
  2. (Optional) To run eggplantDAIDesignAgent or eggplantDAIRunAgent 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 DAI Design Agent

You can launch the DAI Design Agent from the Start menu on Windows or from the Applications folder on a Mac.

For Windows

Open eggplantDAIDesignAgent from the Start menu.

For macOS

Launch the eggplantDAIDesignAgent from the Applications folder.

For Linux

Launch your DAI Design 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 DAI Design Agent:


Configure Your DAI Design Agent

To log in and start using your DAI Design Agent, you must:

Add Your Agent Access Key

  1. On the DAI Design 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 DAI Design 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. Update the default value in the Eggplant Functional drive executable box if the eggplant.bat is stored in a different place on your system.
  2. If necessary, update the default value in the Port box.
  3. Select the Extra debug messages checkbox to display more detailed messages in the Log output pane.
  4. 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.
  5. Click Start to launch the DAI Design Agent. Both the DAI Design Agent and Eggplant Functional launch automatically.

Click Stop to close the DAI Design Agent or Logout to go back to the DAI Design 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.

Launch Your DAI Run Agent

The DAI Run Agent is a lightweight command-line application (no user interface) used solely to run tests without needing the other features that the DAI Design Agent offers such as managing suites.

The DAI Run Agent configuration is set via its command-line arguments. More details in the DAI Run Agent page.