Installing Eggplant DAI on Windows

This section provides step-by-step instructions to install and license Eggplant DAI on Windows.

System Requirements

Hardware Requirements

  • Operating system: Windows Server 2019, 2016 (recommended for production use), Windows 10
  • RAM: 8 GB minimum
  • Disk Space: 4 GB minimum
  • Processor: 64-bit Intel 2.3 GHz or equivalent (4+ cores or 8+ threads recommended)

Port Availability

By default, Eggplant DAI uses 8000 for the main DAI Server. For information on changing ports after installation, see Changing the Eggplant DAI Port on Windows.

In addition, the following ports must be available:

4566-4568, 4589, 4650, 5433, 5558-5566, 5673, 9000, 15673, 15675.

Supported Browsers

  • Google Chrome 87 and later
  • Mozilla Firefox 83 and later
  • Safari 13 and later

Installing Eggplant DAI

To perform a fresh installation of Eggplant DAI 5.1, follow these steps:

Tip: You can install Eggplant DAI 5.1 without uninstalling Eggplant DAI 4.2.3.

  1. Download the Eggplant DAI installation file from the Eggplant DAI Downloads page.
  2. Double-click the downloaded installation file to launch the Setup wizard. Click Next to begin installing Eggplant DAI. Note that you may be prompted to uninstall Eggplant AI if you haven't uninstalled it previously.
  3. On the Installation Directory screen, use the default installation directory (C:\Program Files\Digital Automation Intelligence) or the Browse... button to select the desired installation directory. Then, click Next to continue your installation.
  4. On the Advanced installer Options screen, select Run Advanced Install Configuration checkbox if you want to enable the option to specify ports, change the PostgreSQL data location, or specify Suite Data Directory and click Next to continue. If you do not select this option then steps 5-8 below do not apply in which case skip to step 9 to continue with your Eggplant DAI installation.
  5. Note: If you’re upgrading from Eggplant DAI 4.1/4.0.1, this screen will not be available.

  6. On the PostgresSQL Data Directory screen, you might need to enter a path for the current installation of Eggplant DAI. Use the following information to decide whether this step is necessary for your installation:
    • If you're happy with the default path, then leave this field as-is.
    • lf you want to use a different directory, then enter your preferred directory in the Choose Directory field.
    • If you want to configure the installer to use the Postgres data directory that was left behind after uninstalling Eggplant AI 3.1, then add the path of the previous installation folder (e.g., C:\eggplantAI\pgsql) by clicking the Choose Directory field.
  7. Click Next to continue to the next screen. When prompted, set the default HTTP port as follows:
    • If port 8000 is available, the installation suggests using port 8000. Click Next to continue.
    • If port 8000 is not available, you can enter the HTTP port you want to use.
  8. Leave the Report usage statistics checkbox selected to let Eggplant collect your usage statistics. Typically, the usage report will include: Product Identifier, Product Version, Host OS, Host OS Version, and License (Serial Number) information. You can disable this option by clearing the checkbox. Note that this option is only available if the Run Advanced Install Configuration checkbox is enabled.
  9. Specify the directory to point to the folder where you'd like your suites to be stored by browsing to that location and then click Next. This is the location where the agent will upload your suites to, which is also useful when running test configurations. Note that this is a completely different location to where you may be currently storing your Eggplant Functional suites.
  10. New feature: This screen is available in Eggplant DAI 4.1 and later.

  11. On the Select Start Menu Folder screen, if you want to use a different directory, browse to select it. Click Next to continue or Back to return and make changes.
  12. Note: If you’re upgrading from Eggplant DAI 4.1/4.0.1, this screen will not be shown.

  13. On the Ready to Install screen, click Install to begin installation. This installation step might take some time to complete.
  14. Click Finish to complete the installation.

See Initial Login and Licensing on this page for information on how to initially access Eggplant DAI. Note that you need to first create an administrator account and enter your license key.

Configuring HTTPS in Eggplant DAI (Windows)

Eggplant DAI can be configured to support SSL/TLS by modifying the nginx configuration file that gets generated when you start Eggplant DAI. As the nginx configuration file gets generated each time you start Eggplant DAI, you must edit the python jinja2 template, which is used to generate the nginx.conf file itself. An example of modifying the template is described below.

Important: The modifications made directly to the python jinja2 file (nginx.conf.jinja2) will be overwritten whenever Eggplant DAI is installed or upgraded. Therefore, it is recommended to back up the copies of the changes you make to the nginx.conf.jinja2 file, the certificates, and CSR outside of installation directory.

Prerequisites:

Before configuring HTTPS, make sure you that the following prerequisites have been met:

  • Eggplant DAI is installed and running at least with one user who is able to successfully log in.
  • You should have obtained a trusted certificate and key. A trusted certificate is one that is issued by a Certificate Authority listed on the Mozilla page:
    • PEM format TLS certificate: For a list of valid certificates, see the Mozilla page.
    • PEM format TLS key: All key formats that are accepted by nginx.

Note: Eggplant DAI doesn't support self-signed certificates.

Step by Step: Configuring HTTPS in Eggplant DAI

  1. Stop the Digital Automation Intelligence service through the Windows Services manager. By default, it is set to automatically start after Eggplant DAI is installed.
  2. Locate the nginx.conf.jinja2 file in the installation directory:

    C:\Program Files\Digital Automation Intelligence\nginx.conf.jinja2

    Note: This file will be removed whenever you install, uninstall, and upgrade Eggplant DAI. Therefore, these steps will need to be repeated after each upgrade.

  3. To enable HTTPS, locate the section that starts with server {, then add the following two server blocks above the existing one:

    server {

    listen {{SERVER_PORT}};

    server_name localhost;

    return 301 https://$host$request_uri;

    }

    server {

    listen 80;

    server_name localhost;

    return 301 https://$host$request_uri;

    }

  4. In the existing server block, update the server_name, ssl_certificate, ssl_certificate_key, and ssl_password_file (optionally required based on your configuration) values as shown below:

    server {

    listen 443 default ssl;

    server_name dai.example.com;

    ssl_certificate C:Path\To\Certificate.file;

    ssl_certificate_key C:\Path\To\Certificate.key;

    # ssl_password_file C:\Path\To\Password.file # depends on your configuration

    #charset koi8-r

    #access_log logs/host.access.log main;

    root "{{WEB_ROOT}}";

    At the end of updating the nginx.conf.jinja2 file, you should be able to see three Server blocks in the file.

    Notes:

  5. Restart the Digital Automation Intelligence service with the new configuration from the Windows Services panel.

Changing the Eggplant DAI Port on Windows

Although Eggplant DAI assigns port 8000 by default during installation, you can specify a different port later:

  1. Open C:\ProgramData\Eggplant\Digital Automation Intelligence\settings.ini.
    Important: The C:\ProgramData folder might not be initially visible, as it is hidden by default.
  2. Find the [settings] section and update the line server_port=8000 to include the port you want to use.
  3. Save your work.
  4. Restart the Digital Automation Intelligence Windows service.

Note: Any port changes made here should also be reflected in the Agent Server address section in your execution environment.

Migrating Eggplant DAI Server

Follow these instructions to migrate the Eggplant DAI server from one machine to another:

  1. Install Eggplant DAI on the new server.
  2. Stop the Digital Automation Service through the Windows Services manager.
  3. From the existing location where Eggplant DAI is installed, open C:\ProgramData\Eggplant\Digital Automation Intelligence and copy the data and minio folders over to the same path in the new location.
  4. In the new location, also copy over the config.yml and settings.ini files to the same (ProgramData\Eggplant\Digital Automation Intelligence) folder.
  5. Start the Digital Automation Service.

Uninstalling Eggplant DAI on Windows

Use the following instructions for uninstalling Eggplant DAI.

  1. Locate and run the Eggplant DAI uninstall program by choosing Start > All Programs > Uninstall Eggplant DAI.
  2. Click Yes when prompted to uninstall Eggplant DAI and all its components.
  3. Click OK after the removal process is done.

Uninstalling Eggplant DAI does leave some folders intact. Note that the data that's left behind after you uninstall Eggplant DAI contains user account information, user models, and execution data. Only remove these files and folders if they are no longer required. Assuming you installed Eggplant DAI in the C:/Program Files/DAI directory, the following folders remain if you need to retain any files:

Eggplant DAI data directory files: C:\ProgramData\Eggplant\Digital Automation Intelligence\data

Server and Eggplant DAI log files: C:\ProgramData\Eggplant\Digital Automation Intelligence\logs

If you decide that you want to do a complete Eggplant DAI removal after following the above steps to uninstall Eggplant DAI, delete the following directory or folder:

C:\Program Files\Digital Automation Intelligence

Initial Login and Licensing

When Eggplant DAI is installed and running, you access the application in a browser. On your initial login, you must create an administrator account and enter your license key. Follow these steps to complete your initial login:

  1. Launch your browser from any computer that has access to the Eggplant DAI server and enter the appropriate URL:
    • To display the login prompt from the computer on which the Eggplant DAI server is running, enter http://localhost:8000
    • To display the login prompt from a remote computer, enter http://<serverIPaddress>:8000 where <serverIPaddress> is the Eggplant DAI server's IP address or fully qualified domain name
    Note: To obtain the IP address of the Eggplant DAI server, see your local IT administrator. Distribute the URLs from this step to all users requiring access to this Eggplant DAI application.
  2. Eggplant DAI prompts you to set up an administrator account. Enter an email address (username) and password for the account.
  3. On initial log in to Eggplant AI, you create an admin account and enter your license key

    Enter your initial admin credentials and license key for Eggplant DAI

    After you've configured the administrator account, you can use it to set roles for other users requesting access. See Approving New Users for more information.

  4. Enter a license key. You can generate this in the Greenhouse Licensing Web Portal.
  5. Click OK.

After your account is created, a new Login dialog box appears prompting you to log in to Eggplant DAI. After you've entered your valid credentials, the Models tab appears.

Greenhouse Licensing Web Portal

As an Eggplant customer, you have access to the Greenhouse licensing web portal, where you can review and create available license keys as well as download generated licenses for your account.

Note: When you're generating a license key in Greenhouse, copy the physical address of the machine where Eggplant DAI is installed into the Host ID field.

You can also use this portal to submit questions to support and view information about any support cases.

You should receive your initial Greenhouse login information from your account manager. If you don't have a password, you'll need to contact your account manager or sales@eggplant.io. If you need an Eggplant DAI license, contact your account manager or Eggplant Support.

Frequently Asked Questions

  • When installing Eggplant DAI on a Windows machine, why do I get the following error message?

    Remove EAI to progress with DAI

    Uninstall Eggplant AI via Windows Control Panel > Add or remove Programs.

    If that doesn't work, you need to delete the Eggplant AI (e.g., Eggplant AI 3.1 folder) registry key, which is found here:

    HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Microsoft\Windows\CurrentVersion\Uninstall
    Important: Care must be taken while accessing the registry keys, as it can cause major issues if not done correctly. In addition, you should back up the registry before making any changes.

    Restart your computer and install Eggplant DAI.

  • Where can I find the Eggplant DAI log files?
  • The log files for Eggplant DAI 4.x are located in the following path:

    Windows: C:\ProgramData\Eggplant\Digital Automation Intelligence\logs
    Linux:/var/log/eggplant/dai

    DAI Agent Log files:

    Windows: %LOCALAPPDATA%\eggplant\agent\Logs

    Mac: ~Home\Library\Logs

    Linux: ~/.cache/agent/log

  • Where are movies saved by default when the StartMovie command is used via in Eggplant DAI 4.2.3? I was able to access movies in the Results directory in Eggplant DAI 4.1 but since updating, I can't see any movies there. Has the location changed?

From Eggplant DAI 4.2.3, the movies folder is created at the root of your Eggplant Functional Suites folder when you run the StartMovie command. However, when running theStartMovie command from Eggplant Functional directly, there is no change in saved movie location. Movies are still saved to the Suite’s Results folder.

 

This topic was last updated on March 05, 2021, at 01:20:21 PM.

Eggplant icon Eggplantsoftware.com | Documentation Home | User Forums | Support | Copyright © 2021 Eggplant