Upgrade Notes

This section provides instructions to upgrade Eggplant DAI on Windows.

note

Downgrades are not supported.

Upgrading from Eggplant DAI 7.3 to Eggplant DAI 7.4 on Windows

• When you upgrade from Eggplant DAI 7.3, make sure that you take a backup of your files (config.yml) and database folders (data and minio) before you start. If there is a problem with your upgrade, you'll need to restore to this point.
• Find the System Administrator credentials from your previous upgrade. You'll need to enter them to authenticate with Eggplant's identity and access management (IAM) system during the upgrade.
• Eggplant DAI 7.4 is only compatible with Eggplant Functional 23.4 and later. When upgrading to Eggplant DAI 7.4, you must also update your version of Eggplant Functional.

Read the Release Notes for full details of the changes introduced in Eggplant DAI 7.4.

Upgrading from Eggplant DAI 7.2 to Eggplant DAI 7.3 on Windows

• When you upgrade from Eggplant DAI 7.2, make sure that you take a backup of your files (config.yml) and database folders (data and minio) before you start. If there is a problem with your upgrade, you'll need to restore to this point.
• Find the System Administrator credentials from your previous upgrade. You'll need to enter them to authenticate with Eggplant's identity and access management (IAM) system during the upgrade.
• Eggplant DAI 7.3 is only compatible with Eggplant Functional 23.3 and later. When upgrading to Eggplant DAI 7.3, you must also update your version of Eggplant Functional.

Read the Release Notes for full details of the changes introduced in Eggplant DAI 7.3.

Upgrading from Eggplant DAI 7.1 to Eggplant DAI 7.2 on Windows

• When you upgrade from Eggplant DAI 7.1, make sure that you take a backup of your files and database before you start. If there is a problem with your upgrade, you'll need to restore to this point.
• Find the System Administrator credentials from your previous upgrade. You'll need to enter them to authenticate with Eggplant's identity and access management (IAM) system during the upgrade.
• Eggplant DAI 7.2 is only compatible with Eggplant Functional 23.2 and later. When upgrading to Eggplant DAI 7.2, you must also update your version of Eggplant Functional.
• If any indexes were manually added to the DAI database, remove them before upgrading. Contact our Customer Support for assistance if needed.

Read the Release Notes for full details of the changes introduced in Eggplant DAI 7.2.

Upgrading from Eggplant DAI 7.0 to Eggplant DAI 7.1 on Windows

• When you upgrade from Eggplant DAI 7.0, make sure that you take a backup of your files and database before you start. If there is a problem with your upgrade, you'll need to restore to this point.
• Find the System Administrator credentials from your previous upgrade. You'll need to enter them to authenticate with Eggplant's identity and access management (IAM) system during the upgrade.
• Eggplant DAI 7.1 is only compatible with Eggplant Functional 23.1 and later. When upgrading to Eggplant DAI 7.1, you must also update your version of Eggplant Functional.

Read the Release Notes for full details of the changes introduced in Eggplant DAI 7.1.

Upgrading from Eggplant DAI 6.5 to Eggplant DAI 7.0 on Windows

• When you upgrade from Eggplant DAI 6.5, make sure that you take a backup of your files and database before you start. If there is a problem with your upgrade, you'll need to restore to this point.

• Find the System Administrator credentials from your previous upgrade. You'll need to enter them to authenticate with Eggplant's identity and access management (IAM) system during the upgrade.

• Eggplant DAI 7.0 is only compatible with Eggplant Functional 23.0 and later. When upgrading to Eggplant DAI 7.0, you must also update your version of Eggplant Functional.

• An upgrade has been made to the latest stable release of MinIO. Upgrading an existing installation of DAI 6.5 to DAI 7.0 will bring about a migration of MinIO assets(mainly suites and screenshots) which may take up to an hour.

• The agent has been redesigned into separate dedicated agents for design and run. There are two types of agents, namely Eggplant DAI Design Agent for uploading suites to DAI and executing tests in the designer, and Eggplant DAI Run Agent and for executing test configuration runs. Both agents must be updated when upgrading.

• If you had DAI 6.5 installed on Windows Server 2019 or later, or Windows 11 or later, you may get the following error when trying to upgrade to DAI 7.0 due to a command line utility getting removed and a subprocess is not being killed successfully:

  

  • To resolve the issue, launch Task Manager and end the "OpenJDK Platform binary" process, then press Try Again in the installer.

  

Read the Release Notes for full details of the changes introduced in Eggplant DAI 7.0.

Upgrading from Eggplant DAI 6.4 to Eggplant DAI 6.5 on Windows

• When you upgrade from Eggplant DAI 6.4, make sure that you take a backup of your files and database before you start. If there is a problem with your upgrade, you'll need to restore to this point.
• Find the System Administrator credentials from your previous upgrade. You'll need to enter them to authenticate with Eggplant's identity and access management (IAM) system during the upgrade.
• Eggplant DAI 6.5 is only compatible with Eggplant Functional 22.5 and later. When upgrading to Eggplant DAI 6.5, you must also update your version of Eggplant Functional.

Read the Release Notes for full details of the changes introduced in Eggplant DAI 6.5.

Upgrading from Eggplant DAI 6.3 to Eggplant DAI 6.4 on Windows

• When you upgrade from Eggplant DAI 6.3, make sure that you take a backup of your files and database before you start. If there is a problem with your upgrade, you'll need to restore to this point.
• Find the System Administrator credentials from your previous upgrade. You'll need to enter them to authenticate with Eggplant's identity and access management (IAM) system during the upgrade.
• Eggplant DAI 6.4 is only compatible with Eggplant Functional 22.4 and later. When upgrading to Eggplant DAI 6.4, you must also update your version of Eggplant Functional.
• All scripts that were referenced from within Test Configurations will be migrated to Test Cases and these will be automatically included within the original Test Configuration. See the Release Notes for further details.

Read the Release Notes for full details of the changes introduced in Eggplant DAI 6.4.

Upgrading from Eggplant DAI 6.2 to Eggplant DAI 6.3 on Windows

• When you upgrade from Eggplant DAI 6.2, make sure that you take a backup of your files and database before you start. If there is a problem with your upgrade, you'll need to restore to this point.
• Find the System Administrator credentials from your previous upgrade. You'll need to enter them to authenticate with Eggplant's identity and access management (IAM) system during the upgrade.
• Eggplant DAI 6.3 is only compatible with Eggplant Functional 22.3 and later. When upgrading to Eggplant DAI 6.3, you must also update your version of Eggplant Functional.

Read the Release Notes for full details of the changes introduced in Eggplant DAI 6.3.

Upgrading from Eggplant DAI 6.1 to Eggplant DAI 6.2 on Windows

• When you upgrade from Eggplant DAI 6.1, make sure that you take a backup of your files and database before you start. If there is a problem with your upgrade, you'll need to restore to this point.
• Find the System Administrator credentials from your previous upgrade. You'll need to enter them to authenticate with Eggplant's identity and access management (IAM) system during the upgrade.
• Eggplant DAI 6.2 is only compatible with Eggplant Functional 22.2 and later. When upgrading to Eggplant DAI 6.2, you must also update your version of Eggplant Functional.

Read the Release Notes for full details of the changes introduced in Eggplant DAI 6.2.

Upgrading from Eggplant DAI 6.0 or 6.01 to Eggplant DAI 6.1 on Windows

• When you upgrade from Eggplant DAI 6.0 or 6.0.1, make sure that you take a backup of your files and database before you start. If there is a problem with your upgrade, you'll need to restore to this point.
• Find the System Administrator credentials from your previous upgrade. You'll need to enter them to authenticate with Eggplant's identity and access management (IAM) system during the upgrade.
• Eggplant DAI 6.1 is only compatible with Eggplant Functional 22.1 and later. When upgrading to Eggplant DAI 6.1, you must also update your version of Eggplant Functional.

Read the Release Notes for full details of the changes introduced in Eggplant DAI 6.1.

Upgrading from Eggplant DAI 5.3 to Eggplant 6.0.1 on Windows

• When you upgrade from Eggplant DAI 5.3, make sure that you take a backup of your files and database before you start. If there is a problem with your upgrade, you will need to restore to this point.
• Eggplant DAI 6.0.1 is only compatible with Eggplant Functional 22.0 and later. When upgrading to Eggplant DAI 6.0.1, you must also update your version of Eggplant Functional.
• To continue to use the API execution endpoints in Eggplant DAI, you must update your code to use the new authentication method.
• Eggplant Accelerators that use the authentication method in Eggplant DAI 6.0.1 and above are not compatible with environments where DAI 5.3 and below are in use.
• You must upgrade all existing agents for use with Eggplant DAI 6.0.1, and regenerate agent access keys for existing execution environments.
• As part of the migration to a new identity and access management system, all users must reset their passwords. For environments with email enabled, this is an automatic process. Before upgrading, check that all users have a valid email address.
• For secure environments without access to email, the Windows Installer allows you skip the configuration of an SMTP mail server.

Important

When you install or upgrade to Eggplant DAI 6.0.1, you need to enter credentials for a System Administrator account. Keep these credentials in a safe place. Under certain circumstances, an Eggplant Technical Consultant might ask you to find and use them.

Upgrading from Eggplant DAI 4.1/4.0.1 to Eggplant DAI 5.3 on Windows

The upgrade steps for Eggplant DAI 5.3 are similar to installing Eggplant DAI 5.3 except you'll be presented with fewer screens. Note that you must uninstall the previous agent and install the agent that's valid for Eggplant DAI 5.3.

note

When upgrading Eggplant DAI, remember to update your version of Eggplant Functional to version 21.1.

Upgrading from Eggplant AI 3.1 to Eggplant DAI 4.1 on Windows

Important

• If you're trying to install Eggplant DAI on a machine that has Eggplant AI 3.1 installed, you'll be prompted to uninstall Eggplant AI first. Make sure to uninstall Eggplant AI from Windows Control Panel > Add or remove Programs.
• Make sure to back up your data before uninstalling Eggplant AI, especially if you want to migrate data across to Eggplant DAI by using the existing location as specified in step 5 of Installing.
• If you want to upgrade to a latest version of Eggplant DAI and if you are still on Eggplant AI 3.1, it's recommended to upgrade to DAI version 4.1 first and then to the latest version.

If you're upgrading from Eggplant AI 3.1, then follow these steps after installing Eggplant DAI 4.1:

1. Locate the Digital Automation Intelligence service in the Windows Services panel and stop it.

2. Copy over all the Postgres data files and folders from your original location (e.g. C:\eggplantAI\pgsql\data) to the Eggplant DAI location (e.g. C:\ProgramData\Eggplant\Digital Automation Intelligence\data).

   Important

   • The C:\ProgramData folder might not initially be visible because it is a hidden folder by default.
   • Copy all files and subfolders. When prompted, overwrite the existing files in the destination.

3. From the Windows Services panel, start the Digital Automation Intelligence service.

note

To configure the Eggplant DAI installer to use the Postgres data directory that was left behind after uninstalling Eggplant AI 3.1, choose C:\eggplantAI\pgsql when installing Eggplant DAI 4.1.

Frequently Asked Questions

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

  

  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 the StartMovie command from Eggplant Functional directly, there is no change in saved movie location. Movies are still saved to the Suite’s Results folder.