Skip to main content

Install or Upgrade Eggplant DAI on Windows

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

System Requirements​

Hardware Requirements​

  • Operating system: Windows Server 2019 or 2016 is recommended for production use but Windows 10 is also supported
  • RAM: 8 GB minimum
  • Disk Space: 5 GB minimum for trial deployments, 100 GB minimum for production deployments
  • 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 Change the Eggplant DAI Port on Windows.

In addition, the following ports must be available: 4566-4568, 4589, 4650, 5433, 5673, 9000, 15673, 15675.

Supported Browsers​

  • Google Chrome 95 and later
  • Mozilla Firefox 93 and later
  • Safari 15 and later

Standard and Advanced Installations​

You can either run a standard or advanced Windows installation for Eggplant DAI. The advanced installation allows you to do some additional configuration:

  • Update the default port setting and configure HTTPS
  • Choose the directory where PostgreSQL data is stored
  • Choose the directory where your Eggplant Functional suites are stored.

Follow the steps in Start Your Installation for both types of installation and then jump to the appropriate section.

Install Eggplant DAI​

The Eggplant DAI 6.2 Windows installation supports:

  • Fresh installations
  • Upgrades from DAI 6.1.x.
  • Downgrades are not supported.
Important

If you're upgrading, make sure that you take a backup of your files and data before you start your installation.

To take a backup:

  1. Stop the Digital Automation Intelligence Service through the Windows Services manager.
  2. Open C:\ProgramData\Eggplant\Digital Automation Intelligence and transfer the data and minio folders outside of the ProgramData directory to another machine or backup device.
  3. Restart the Digital Automation Intelligence Service.

If you need to reinstall after upgrading to DAI 6.2, do another backup and then restore your original files.

  1. Repeat steps 1 and 2 above to make a backup of the DAI 6.2 files and data, which may be useful for troubleshooting.
  2. Stop the Digital Automation Intelligence Service through the Windows Services manager.
  3. Open C:\ProgramData\Eggplant\Digital Automation Intelligence and overwrite the data and minio folders with your original backed up versions from DAI 6.1.x.
  4. Restart the Digital Automation Intelligence Service.

Start Your Installation​

Use these instructions for a fresh installation or to upgrade from DAI 6.1.x.

  1. Download the Eggplant DAI installation file.

  2. Double-click the installation file to launch the Setup wizard. Click Next to continue.

    note

    You might be asked to uninstall Eggplant AI if you haven't done so already.

  3. Keep the default installation directory: C:\Program Files\Digital Automation Intelligence or click Browse... to choose a different location.

  4. On the Advanced installer Options screen, either

Run a Standard Install​

Prerequisites: Complete all steps in Start Your Installation.

  1. On the Server & Administration Settings screen, enter the:

    • DAI Server Hostname: Hostname of your main DAI server, which will appear in the URL of your Eggplant DAI environment. Do not include the http:// or https:// prefix in the hostname.

      • If the server is your local machine, enter localhost, which means Eggplant DAI can only be accessed from this machine at http://localhost:8000.

      • If you need to access the DAI server from other, remote machines, enter a fully qualified domain name, e.g. www.serverhostname.com. This allows you to access Eggplant DAI from a browser at, e.g.http://<serverhostname>:8000.

        tip

        To find the hostname of your server, go to Settings > System > About.

    • System Administrator details: Credentials for an administrator of Eggplant's identity access management system (IAM).

      • Username: Enter only ASCII printable characters excluding both uppercase letters and these characters: < > \ / { } ".

      • Password: Enter between 12 and 128 characters using ASCII characters excluding \ { } ".

        Important

        Keep the credentials for the System Administrator account in a safe place. Under certain circumstances, an Eggplant Technical Consultant might ask you to find and use them.

    • DAI Administrator details: Credentials and personal details for the DAI administrator.

      • Username: Enter only ASCII printable characters excluding both uppercase letters and these characters: < > \ / { } ".

      • Password: Enter between 12 and 128 characters using ASCII characters excluding \ { } ".

        note

        You’ll need your DAI Administrator credentials to log into Eggplant DAI for the first time, and to create or update other users. When you've logged in, you can update your password to include the excluded characters listed above along with other languages and characters, e.g. unicode. Administrator usernames cannot be updated.

  2. Click Next to continue to the SMTP Server Settings screen.

  3. If you work in a secure environment without access to email, clear the SMTP Enabled checkbox and click Next, and then jump straight to step 5. Otherwise, leave the SMTP Enabled checkbox selected and continue to the next step.

  4. Enter details for your SMTP mail server:

    • SMTP Server Hostname: Hostname of the SMTP server that you want to use to send emails in Eggplant DAI, e.g. smtp.yourserver.com.

    • Port: Port number that Eggplant DAI can connect to on the SMTP server.

    • Username and Password: Credentials for an account on your SMTP server.

    • From Address: Email address that appears in the SMTP-header for emails sent within Eggplant DAI.

    • Enable SSL, Enable StartTLS, Enable Authentication: Select the methods by which you would like to secure the connection to your SMTP server.

      Important

      Check your SMTP settings carefully. If you enter incorrect details, you may need to contact an Eggplant Technical Consultant to complete your installation.

  5. Click Next to continue to the Select Start Menu Folder screen.

  6. Either accept the default setting or click Browse… to choose another location for the shortcut to Eggplant DAI.

  7. Click Next to continue to the Ready to Install screen, and when you’re ready, click Install to start the installation.

  8. After the installation is done, the DAI Windows Service Start-up screen will appear where the Digital Automation Intelligence service will start for the first time. This process may take up to 10 minutes and may include migration activities if applicable.

  9. A HTML DAI Windows Service Start-up Report will be opened on your default internet browser, listing the services that are started successfully. The migration process is done successfully if all DAI services are started successfully as indicated in the said Start-up Report. Any error that occurs during start-up is detailed here to aid troubleshooting.

  10. When the setup is complete, click the Finish button.

  11. (In case of DAI service start-up failure) Should the Digital Automation Intelligence service fail to start-up successfully, you may need to restart the Digital Automation Intelligence service through the Windows Services manager or even restart your PC.

  12. Continue to First Log in and Licensing.

Run an Advanced Install​

Prerequisites:

  • Complete all steps in Start Your Installation.
  • To configure HTTPS for your Eggplant DAI server, you'll need a trusted certificate and key. A trusted certificate 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 SSL key: All key formats that are accepted by nginx.
note

In a Windows environment, the certificate can be signed by another Certificate Authority providing it is installed as a Trusted Root Certification Authority on the machine that is running the browser or agent.

If you choose to use a self-signed SSL certificate, you must update your configuration after installation. Set the:

  • Issuer to the organisation that is issuing the certificate, e.g. "yourcompanyname"
  • Subject to the hostname that the certificate has been generated for, e.g. "local.dai.com", which must match the hostname that you entered during installation.

To be accepted by Chrome and Firefox, the end entity certificate must set the Subject Alternative Name and Authority Key Identifier fields. Use a hash function that is cryptographically strong enough. sha512 is currently acceptable.

  1. On the PostgresSQL Data Directory screen, either:

    • Click Next to accept the default path.
    • Click Browse to to choose a different directory. For example, go to C:\eggplantAI\pgsql to use the Postgres data directory that was left behind after uninstalling Eggplant AI 3.1.
  2. Click Next to continue to the Server Port & HTTPS screen.

  3. Keep the default port value: 8000 unless this port is unavailable and you need to use an alternative. You can always update your configuration after your installation.

    note

    Port 80 is not currently supported for either HTTP or HTTPS configurations.

  4. If you don’t want to configure HTTPS to secure your DAI server, clear the Use HTTPS checkbox, click Next, and then jump straight to step 6. Otherwise, leave the Use HTTPS checkbox selected and continue to the next step.

    • If port 8000 is available, leave the default value.
    • If port 8000 is not available, enter the HTTP port you want to use.
  5. Add your certificate details:

    • HTTPS Certificate: Browse to and select your HTTPS certificate.
    • HTTPS Private Key: Browse to and select your HTTPS key file.
    • (Optional) Private key requires password: Select this option if your private key needs a password to unlock it, and then browse to and select your password file.
  6. Click Next to continue to the Usage Statistics screen. Leave the checkbox selected to allow Eggplant to collect these metrics for a usage report:

    • Product Identifier
    • Product Version
    • Host OS
    • Host OS Version
    • License (Serial Number) information.
  7. Click Next to continue to the Suites Data Directory screen, either:

    • Click Next again to accept the default path.
    • Click Browse to choose a different directory for your Eggplant Functional suites. This is the directory that the agent uploads your suites to and might be different from where you’re currently storing them.
  8. Complete all the steps in the standard installation.

First Login and Licensing​

When Eggplant DAI is installed and running, you must access the application from a browser. Follow these steps to log in, license and start to use Eggplant DAI.

  1. Enter the appropriate URL from a browser to display the login screen:

    • If you added the hostname localhost during installation, launch the browser from the computer on which the Eggplant DAI server is running and enter http://localhost:8000.
    • If you added a fully qualified hostname during installation, you can access the Eggplant DAI server from a remote machine. Launch a browser and enter http://<serverhostname>:8000.
  2. Eggplant DAI prompts you to log in. Enter the username and password for the DAI Administrator account that you setup during installation, and click OK.

  3. In the License page that opens, enter your License Key and click Agree. A copy of the Eggplant Software License agreement can be read and downloaded before clicking Agree. You can generate your license in the Keysight Software Manager (KSM). After your license is accepted, the Access page is displayed for you to make updates to user accounts.

  4. Click Manage users to open the Admin Console in a new browser tab.

  5. Search for your username and then select the ID of the correct record to edit it.

  6. Enter your email address and select Save.

  7. Go to the Managing Users section to learn more about the new administration environment for DAI 6.0 and above or Getting Started if you're using the application for the first time.