Upgrade Notes

This page provides instructions for upgrading Eggplant DAI on Windows.

Important

Downgrades are not supported.

Before you upgrade, you should back up the database folders and configuration file from your existing DAI Server installation on Windows. If there is a problem with your upgrade, you will want to restore your DAI Server to this point. If you have any questions or would like help testing your database before you upgrade, please contact your Technical Success Manager or our Customer Support.

Backing Up or Restoring the DAI Server

Below you will find information about how to back your existing DAI Server data, as well as instructions for restoring it. Click the appropriate tab below for the information you want.

Back Up DAI

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 copy the data and minio folders, and the config.yml and settings.ini files outside the ProgramData directory to another machine or backup device.
3. Start the Digital Automation Intelligence Service.
4. Read the important upgrade notes below and then proceed to Install an Eggplant DAI Server.

Restore DAI Data

If you experience a problem with an upgrade, and you need to restore the previously working DAI version, follow the steps below:

1. Repeat steps 1 and 2 under Back Up DAI to make a backup of the DAI files and data, which may be useful for troubleshooting.
2. Uninstall DAI using the Programs and Features option in the Windows Control Panel.
3. Delete folder C:\ProgramData\Eggplant.
4. Check if folder C:\Program Files\Digital Automation Intelligence exists and delete it if it does. At this point you have fully removed DAI from the machine.
5. Install the previously working version of DAI. When you finish re-installing DAI, verify the installation by launching a browser and logging into the DAI web UI.
6. Stop the DAI service from Windows Services.
7. Go to folder C:\ProgramData\Eggplant\Digital Automation Intelligence and delete the data and minio folders.
8. Copy the data and minio folders from the DAI backup location to C:\ProgramData\Eggplant\Digital Automation Intelligence. Note that the backup files must be from exactly the same DAI version that you installed in step 5.
9. Open file config.yml from the backup location and copy the database password - the value of PG_PASSWORD in the env section. Open file config.yml in C:\ProgramData\Eggplant\Digital Automation Intelligence and replace the value of PG_PASSWORD with the backed up password.
10. Start the DAI service, and after it starts, verify you can log into the DAI web UI.

Upgrading to 26.2.1

The Release Notes on our Documentation website contain the latest information. If you are viewing this page offline, please check the website for the latest information: https://docs.eggplantsoftware.com/dai/dai-release-notes/.

• Eggplant 26.2.1 is the latest release of DAI. For improved security, the 26.2.1 release requires that you configure DAI to use secure HTTPS connections. HTTP connections are no longer supported. Please see Upgrading DAI 26.2.1 as Required for HTTPS below for important requirements related to this change. Please also see 26.2.1 Release Notes for general information about this security improvement.

• You can upgrade to 26.2.1 from 26.2.0 or 26.1.x. However, you must upgrade to Eggplant DAI 26.1 before you start your 26.2.1 or 26.2.0 upgrade. If you are currently using version 25.4 or earlier, be sure to see Upgrading from 25.4 to 26.1 on Windows in the 25.4 version of the documentation for important information about upgrading to 25.4, which involves changes to execution environments and systems under test (SUTS).

  • You must upgrade to Eggplant Functional 26.2.1.1 or 26.2.101.1 when you upgrade to DAI 26.2.1. DAI 26.2.1 is only compatible with Eggplant Functional (EPF) 26.2.1.1 or 26.2.101.1 due to the HTTPS changes.

• The upgrade may take 10-20 minutes to complete.

Upgrading HTTP Installations to 26.2.1

Important

If your existing DAI Server is configured to use HTTP, this upgrade requires you to make the following changes:

• You will need to reconfigure your DAI Server to use HTTPS, which requires making a Transport Layer Security (TLS) certificate accessible to the DAI Server. The 26.2.1 Setup program provides a Server Configuration panel where you will provide the location of an existing certificate or choose to have Eggplant generate a self-signed certificate for you. See Configuring DAI 26.2.1 as Required for HTTPS below for information.

• After you run the 26.2.1 Setup program to reconfigure your DAI Server to use HTTPS, you will need to regenerate the DAI .ini files for your environments because the .ini files contain DAI URLs. See Regenerating the DAI .ini Files with HTTPS URLs below for more information.

• Additionally, after the upgrade, your users will need to use https in the URL they use to access DAI in their browsers.

Configuring DAI 26.2.1 as Required for HTTPS

As stated above, you must reconfigure your DAI Server to use HTTPS connections. This configuration requires that you make a TLS certificate accessible to the DAI Server you are upgrading, and specify the location of the certificate when you run Setup to install the upgrade. Or, you can choose the option to have Eggplant generate a self-signed certificate for you when you run the Setup program to install the upgrade. For a high level summary, you have the following certificate options:

• An existing publicly trusted certificate authority (CA) certificate (recommended for production installations)
• A private or enterprise certificate, for example, provided by your company
• A self-signed certificate signed and generated by Eggplant, which you can select during installation

To choose the right option for your site, please see the detailed explanations of the different certificate options and their requirements in the Special Requirements section on the Installing or Upgrading DAI (DAI 26.2.1 and Higher) page.

The 26.2.1 Setup program changed to include a new Server Configuration panel (shown below) where you can either specify the location of an existing certificate that you made accessible to the DAI Server system, or choose to have Eggplant generate a self-signed certificate during installation.

The Server Configuration panel in the DAI Windows Server Setup program introduced in DAI 26.2.1

Regenerating the DAI .ini Files with HTTPS URLs

After you run the DAI 26.2.1 Setup program to reconfigure your DAI Server to use HTTPS, you will need to regenerate the DAI .ini files for your environments. This is because each .ini file contains references to the DAI Server URL, and the regeneration process updates these references to HTTPS. See Regenerate an Access key on the Environments page for instructions.

Communicate the URL Change to HTTPS to your Users

After you upgrade and reconfigure DAI to use HTTPS, be sure to communicate to your existing users that they need to use https when they enter the URL in their browser to access DAI.

Migrating Internal Data

In 26.2.1, we migrated DAI data that was stored in Minio (object storage) to the file system. This migration will occur automatically after you upgrade. You do not need to take any actions for this migration to occur.

That said, you can verify that the migration occurred by looking at the DAI Server installation directory after you upgrade. On Windows, specifically, the upgrade moves the data to C:\Program Files\Digital Automation Intelligence\files. The files folder contains two subfolders: one for storing screenshots captured during test runs and one for storing test suites if DAI internal storage for suite storage. Before, with Minio, the data was stored in C:\Program Files\Digital Automation Intelligence\minio.

If you experience any issues with your upgrade that you think might be related to this migration, please contact Customer Support and ask them to help you verify the migration.

Spaces are here

The first time you log into DAI after upgrading to DAI 26.2.1, you will see the Spaces are here! panel. This is to inform you of the Spaces feature that was introduced in DAI 26.2.0. The Spaces page became the landing page you see when you log into DAI versions 26.2.0 and higher. For more information about upgrading to a release that has the spaces feature, see Upgrading from 26.1 to 26.2.0 below.

The Spaces are here! panel calling attention to Spaces feature in DAI

Upgrading from 26.1 to 26.2.0

• You must upgrade to Eggplant DAI 26.1 before you start your 26.2.0 upgrade. If you are currently using version 25.4 or earlier, be sure to see Upgrading from 25.4 to 26.1 on Windows in the 25.4 version of the documentation for important information about upgrading to 25.4, which involves changes to execution environments and systems under test (SUTS).

• The upgrade may take 10-20 minutes to complete.

• Eggplant DAI 26.2.0 is only compatible with Eggplant Functional (EPF) 26.2. When you upgrade to Eggplant DAI 26.2.0, you must also update your version of EPF.

• When you upgrade from 26.1 to 26.2.0 or higher, you will see that the Spaces page with its one Shared space is now the landing page when you log in. Spaces are a major new feature in DAI 26.2.0. Prior to version 26.2.0, you saw the Test case dashboard when you logged in.

  All of your existing assets will be available in the Shared space when you upgrade. In a future release, you will be able to move them to the private spaces that you create. You can, however, organize any of the new assets you create in 26.2.0 in private spaces that you create. You can learn more about the Shared space on the About DAI Spaces page.

  Additionally, you will likely notice that there are fewer option on the menu on the left. You need to open a space to see more of the DAI menu options. For example, if you click the Shared space, the Test case dashboard would open, and you would see more of the DAI menu items.

  

  The new DAI Spaces feature page showing the common Shared space, which is now the landing page when you log into DAI

Upgrading Container Deployments

For information about upgrading DAI container deployments, see Upgrading on the Deploying Eggplant DAI in Containers page.

Upgrading Previous Versions of DAI

If you need information about upgrading earlier versions of DAI, please see the documentation for the specific version. You can display the documentation for different versions by selecting the version from the version selector at the top of the page.

The Documentation version selector, which you can access from every page in the documentation