Eggplant Functional 23 Release Notes
The notes below provide descriptions of the new features and changes introduced with each release of Eggplant Functional (EPF). You are strongly encouraged to read about the relevant changes whenever you upgrade from an earlier version.
Compatibility
Beginning with EPF 23.1.1, you can find the EPF-supported software, operating systems, and system recommendations on the Prerequisites page.
Notes
-
Beginning with EPF 23.2.0 and 23.2.1, a Japanese version of the EPF documentation is available. Note that the Japanese documentation version is 23.0.0. But the versions should be in sync in a future release. You can find the Japanese documentation here, which is the English EPF documentation url with the "/ja" extension.
-
Eggplant Functional no longer supports the classic iOS and Android Gateways. We recommend moving to the Mobile Device connections in Eggplant Functional. See Connecting to Mobile Devices for more information.
-
Eggplant Functional will remove the auto-classification of elements in Autoscan feature in an upcoming release.
-
Tables functionality will be removed in a future release.
For the latest information about Eggplant Functional releases, see the Release Notes in the online documentation at: https://docs.eggplantsoftware.com/studio/epf-release-notes/
EPF 23.5.2 (January 2025)
Eggplant Functional will remove the auto-classification of elements in Autoscan feature in a future release.
Features
- Adds support for MySQL ODBC driver version 9.1.
- Adds the ability to handle screen rotation during movie recording with an exception handler.
- Updates to Keysight branding.
Defect Fixes
- Fixes an issue where Image Search behaved differently on Linux than other operating systems. (CRD-1738)
- Resolves a crash when using previously unsupported MySQL ODBC Drivers. (CRD-1724)
- Resolves a crash when adjusting the capture area on Ubuntu 22. (CRD-1712)
- Resolves a crash when the screen size changes during movie capture. (CRD -1453)
- Fixes the “index 0 beyond bounds of empty array” exception shown when stepping through code in Eggplant Studio (VS Code Extension) debugger.
Sensetalk
Includes SenseTalk 2.21.
Features
- Improves logging in the case that the units.txt file is missing.
Defect Fixes
- Fixes an issue with patterns causing crashes when some elements of the pattern are empty. (CRD-1515)
Eggplant Gateway
Includes Eggplant Gateway version 25.1.4-0013.
For information on Eggplant Gateway, please see the Eggplant Gateway Documentation.
Included OCR Version
The EPF 23.5.2 release includes the following OCR version:
- Mac and Windows OCR version:
12.4
, which we recommend for best results with Eastern language recognition on Mac and Windows. For best results with Western language recognition, we recommend release 23.5.102. - Linux OCR version:
12.3
, which provides best results for recognition of all languages on Red Hat, CentOS, and Ubuntu.
You can verify what version of OCR your EPF instance is running with using the following SenseTalk function:
ocrversion()
put ocrversion() --> 12.4
EPF 23.5.102 (January 2025)
The EPF 23.5.102 release is available for Mac and Windows only. It contains the same updates and bug fixes as the 23.5.2 release described above, except that it includes a different version of the Optical Character Recognition (OCR) component, which is the EPF component that reads text.
Included OCR Version
The EPF 23.5.102 release includes the following OCR version:
- Mac and Windows OCR version:
12.2
, which we recommend for best results with Western language recognition on Mac and Windows. For best results with Eastern language recognition, we recommend release 23.5.2 as described below.
You can verify what version of OCR your EPF instance is running with using the following SenseTalk function:
ocrversion()
put ocrversion() --> 12.2
EPF 23.5.1 (December 2024)
This release of Eggplant Functional features API Testing Bug Fixes and an updated version of Eggplant Gateway.
This will be the last release of Eggplant Functional for Ubuntu 16.04. Existing releases of EPF will continue to work and be supported on Ubuntu 16.04, but we will not be releasing new versions of Eggplant Functional for Ubuntu 16.04 as this version of Ubuntu has been out of standard support since April 2021 (for more details see Ubuntu 16.04 LTS (Xenial Xerus) | Ubuntu).
We will continue to release Eggplant Functional for Ubuntu 22.04 and have plans to offer an Ubuntu 24.04 version of Eggplant Functional in the near future.
Eggplant Functional no longer supports the classic iOS and Android Gateways. We recommend moving to the Mobile Device connections in Eggplant Functional. See Connecting to Mobile Devices for more information.
Features
- Includes a new release of Eggplant Gateway, version 4.25.40.
- Adds support for displaying arrays in the VSCode debugger when used with the Eggplant Studio VSCode Extension.
Defect Fixes
- The inclusion of EPGW 4.25.40 fixes an issue with
RemoteClipboard()
when using Single System. (CRD-1669)
Note: This fix is for Windows only. Fixes for macOS and Linux are in development. - The inclusion of EPGW 4.25.40 fixes an an issue with copying Hebrew characters with
RemoteClipboard()
. (CRD-1628) - Fixes two issues with parsing API Request Headers. (CRD-1348, CRD-651)
Sensetalk
Includes SenseTalk 2.20 (this is the same version as was available in the previous release, 23.5.0).
The SenseTalk reference manual now includes a page of Demonstration Videos covering a variety of topics related to SenseTalk and its functionality.
Eggplant Gateway
Includes Eggplant Gateway version 4.25.40.
Included OCR Version
The EPF 23.5.1 release includes the following OCR version:
- Mac and Windows OCR version:
12.4
, which we recommend for best results with Eastern language recognition on Mac and Windows. For best results with Western language recognition, we recommend release 23.5.101. - Linux OCR version:
12.3
, which provides best results for recognition of all languages on Red Hat, CentOS, and Ubuntu.
You can verify what version of OCR your EPF instance is running with using the following SenseTalk function:
ocrversion()
put ocrversion() --> 12.4
EPF 23.5.101 (December 2024)
The EPF 23.5.101 release is available for Mac and Windows only. It contains the same updates and bug fixes as the 23.5.1 release described above, except that it includes a different version of the Optical Character Recognition (OCR) component, which is the EPF component that reads text.
Included OCR Version
The EPF 23.5.101 release includes the following OCR version:
- Mac and Windows OCR version:
12.2
, which we recommend for best results with Western language recognition on Mac and Windows. For best results with Eastern language recognition, we recommend release 23.5.1 as described below.
You can verify what version of OCR your EPF instance is running with using the following SenseTalk function:
ocrversion()
put ocrversion() --> 12.2
EPF 23.5 and 23.5.100 (November 2024)
EPF versions 23.5.0 and 23.5.100 do not include any new updates but bundle the updates of EPF 23.4.1 and 23.4.102, 23.4.2 and 23.4.103, and 23.4.3 and 23.4.104, and are verified to work with DAI 7.5:
- 23.4.1 (August 2024) release notes
- 23.4.2 (September 2024) release notes
- 23.4.3 (October 2024) release notes
EPF 23.4.104 (October 2024)
The EPF 23.4.104 release is available for Mac and Windows only. It contains the same updates and bug fixes as the 23.4.3 release described below, except that it includes a different version of the Optical Character Recognition (OCR) component, which is the EPF component that reads text.
Included OCR Version
The EPF 23.4.104 release includes the following OCR version:
- Mac and Windows OCR version:
12.2
, which we recommend for best results with Western language recognition on Mac and Windows. For best results with Eastern language recognition, we recommend release 23.4.3 as described below.
You can verify what version of OCR your EPF instance is running with using the following SenseTalk function:
ocrversion()
put ocrversion() --> 12.2
EPF 23.4.3 (October 2024)
Included OCR Version
The EPF 23.4.3 release includes the following OCR version:
- Mac and Windows OCR version:
12.4
, which we recommend for best results with Eastern language recognition on Mac and Windows. For best results with Western language recognition, we recommend release 23.4.104. - Linux OCR version:
12.3
, which provides best results for recognition of all languages on Red Hat, CentOS, and Ubuntu.
You can verify what version of OCR your EPF instance is running with using the following SenseTalk function:
ocrversion()
put ocrversion() --> 12.2
Features
The 23.4.3 release of EPF contains the new SenseTalk version 2.20 which includes:
- New Excel color and Worksheet functionality
- Property list performance improvements
Defects
- Improves SenseTalk Performance when modifying nested Property Lists (CRD-1662)
- Fixes an issue with RDP Beta not respecting
DefaultWidth
andDefaultHeight
parameters (CRD-1675) - Fixes the Contrast Slider in RHEL8 version of EPF (CRD-1679)
- Updates the macOS installation drive icon (CRD-1506)
- Fixes an issue with API Tests not returning all cookies from HTTP requests (CRD-1658 - partial)
- Fixes an EPF crash when running SenseTalk Scripts from DAI
Security and Dependency Updates
- Updates LibTIFF to the latest version
- Updates 3rd Party Dependencies
SenseTalk Enhancements
The 23.4.3 release of EPF contains the new SenseTalk version 2.20, including new Excel color and Worksheet functionality, and property list performance improvements.
Additional Excel Functionality
- Adds the ability to set the
HeaderRow
to any arbitrary row when accessing worksheets as a Database - Adds the ability to override
ColumnNames
when accessing worksheets as a Database - The
CellRange
function now allows for accessing non-contiguous rows and columns - New Worksheets can now be created in an existing Workbook from SenseTalk
- Many new worksheet properties can now be accessed and modified from SenseTalk. For example:
FillPattern
,BorderStyle
,RowHeight
, etc. For a full list see Excel File Interaction
Performance Improvements
- Addresses a subtle bug where modifying nested property lists (property lists containing property lists of property lists containing property lists…) would slow down execution for large lists. Such operations are on the order of two orders of magnitude faster in SenseTalk 2.20.
Defect Fixes
- Fixes a subtle issue when comparing a list within a list when there was only a single nested list. When two lists were compared, only the first element of the nested lists were compared. This has been addressed in SenseTalk 2.20.
Example:
# In the case that a list contains a single nested list \{#in-the-case-that-a-list-contains-a-single-nested-list}
# only the first element in each nested list is checked \{#only-the-first-element-in-each-nested-list-is-checked}
# when checking for equality... \{#when-checking-for-equality}
if [["ice", "t"]] is equal to [["ice", "cube"]]
put "The list comparison is bugged!" # is printed every time in SenseTalk < 2.20
else
put "This works as expected" # is printed every time in SenseTalk >= 2.20
end if
# If there is more than one nested list, the comparison has always worked... \{#if-there-is-more-than-one-nested-list-the-comparison-has-always-worked}
if [["ice", "t"], ["vanilla", "ice"]] is equal to [["ice", "cube"], ["eazy", "e"]]
put "The list comparison is bugged!"
else
put "This works as expected" # is printed every time for all versions of SenseTalk
end if
# If there is more than one nested list, the comparison has always worked, \{#if-there-is-more-than-one-nested-list-the-comparison-has-always-worked-1}
# even when the other nested list is the same (so we know that the second item \{#even-when-the-other-nested-list-is-the-same-so-we-know-that-the-second-item}
# in the first nested list is checked) \{#in-the-first-nested-list-is-checked}
if [["ice", "t"], ["biz", "markie"]] is equal to [["ice", "cube"], ["biz", "markie"]]
put "The list comparison is bugged!"
else
put "This works as expected" # is printed every time for all versions of SenseTalk
end if
EPF 23.4.103 (September 2024)
The EPF 23.4.103 release is available for Mac and Windows only. It contains the same updates and bug fixes as the 23.4.2 release described below, except that it includes a different version of the Optical Character Recognition (OCR) component, which is the EPF component that reads text.
Included OCR Version
The EPF 23.4.103 release includes the following OCR version:
- Mac and Windows OCR version:
12.2
, which we recommend for best results with Western language recognition on Mac and Windows. For best results with Eastern language recognition, we recommend release 23.4.2 as described below.
You can verify what version of OCR your EPF instance is running with using the following SenseTalk function:
ocrversion()
put ocrversion() --> 12.2
EPF 23.4.2 (September 2024)
The EPF 23.4.2 release includes new iOS support as well as a number of fixes described below.
Eggplant Functional will no longer support the classic iOS and Android Gateways starting in the fall of 2024. Users are encouraged to migrate to the Eggplant Gateway embedded in Eggplant Functional.
Eggplant Functional will remove the auto-classification of elements in Autoscan feature in an upcoming release.
Included OCR Version
The EPF 23.4.2 release includes the following OCR version:
- Mac and Windows OCR version:
12.4
, which we recommend for best results with Eastern language recognition on Mac and Windows. For best results with Western language recognition, we recommend release 23.4.103. - Linux OCR version:
12.3
, which provides best results for recognition of all languages on Red Hat and Ubuntu.
You can verify what version of OCR your EPF instance is running with using the following SenseTalk function:
ocrversion()
put ocrversion() --> 12.2
Features
- All security settings set for RDP connections are now honored by the new RDP Beta connection type
- Adds support for iOS 17 and beta iOS 18 via Eggplant Gateway
Defect Fixes
- Addresses a hang that would occur when image search failed on RHEL8. (CRD-1638)
- Fixes an issue where Eggplant Functional would incorrectly modify search rectangle coordinates while rounding non-integer values. (CRD-1595)
- Fixes a parsing failure from Git during Test Config. (CRD-1640)
- Fixes a problem where a "WARNING: Secure coding is not enabled" message would display when launching the DAI 7.3 Run Agent. (CRD-1622)
- Fixes an issue where RDP Beta wouldn't show the hostname and port in the connection list.
- Fixes the root cause of TypeText Mobile Commands breaking, enabling rotateMobile and Search Button to return correct results.
- Fixes an issue with keyboard mapping of the Alt key on Single System SUTs. (CRD-1650)
Security and Dependency Updates
- Addresses a known instance of CVE-2023-45853 with a LibXL dependency update.
- Updates FFmpeg, libtiff, and ImageMagick dependencies.
EPF 23.4.102 (August 2024)
The EPF 23.4.102 release is available for Mac and Windows only. It contains the same updates and bug fixes as the 23.4.1 release described below, except that it includes a different version of the Optical Character Recognition (OCR) component, which is the EPF component that reads text.
Included OCR Version
The EPF 23.4.102 release includes the following OCR version:
- Mac and Windows OCR version:
12.2
, which we recommend for best results with Western language recognition on Mac and Windows. For best results with Eastern language recognition, we recommend release 23.3.2 as described below.
You can verify what version of OCR your EPF instance is running with using the following SenseTalk function:
ocrversion()
put ocrversion() --> 12.2
Sensetalk Enhancements
This release contains SenseTalk version 2.19. This is the same version included with the 23.4.1 Release of EPF.
EPF 23.4.1 (August 2024)
Included OCR Version
The EPF 23.4.1 release includes the following OCR version:
- Mac and Windows OCR version:
12.4
, which we recommend for best results with Eastern language recognition on Mac and Windows. For best results with Western language recognition, we recommend release 23.4.103 as described below. - Linux OCR version:
12.3
, which provides best results for recognition of all languages on Red Hat and Ubuntu.
You can verify what version of OCR your EPF instance is running with using the following SenseTalk function:
ocrversion()
put ocrversion() --> 12.4
Features
EPF is now available in the Iron Bank marketplace, Platform One's hardened container image repository. This enables a secure software supply chain for all software engineers in the greater Department of Defense (DoD) community. For more information, visit Platform One and the Eggplant Fusion Engine container image.
Defect Fixes
-
Fixes an issue where running multiple instances of Eggplant Functional would cause it to launch the “Submit Support Request” dialog box on subsequent launches. (CRD-924)
-
Fixes an issue where the PC could not be shut down after disconnecting from a Single System SUT.
-
Fixes an issue where calling an API test from a script or handler would cause a confusing error that said “Load Script … Not a valid suite” and would fail to run. (CRD-1300)
-
Addresses a hang that would occur when running Gherkin feature files in some situations. (CRD-1601)
-
Fixes a problem where checkboxes for API Headers in the API Test dialog box were not functional. (CRD-1554)
-
Fixes a bug where after disconnecting from a selenium connection, Eggplant Functional was unaware of the disconnection and attempted to use selenium, causing the script to fail in error. (CRD-1509)
-
Corrects documentation links under the Connection List, which are now updated and accurate. (CRD-1517)
-
Improves notification that Single System SUT is only supported on 64 bit.
-
Improves login restrictions of Single System SUTs in that Admin access is limited to the Admin account and User access is limited to the User account.
-
Provides performance improvements to the Single System SUT connection type.
Sensetalk Enhancements
The EPF 23.4.1 release contains SenseTalk version 2.19 + 5323.956, which includes the following improvements:
Added support for 11 higher-level math functions
acos
(arc cosine),asin
(arc sine),atanPt
(arc tangent given a point),cosh
(hyperbolic cosine),sinh
(hyperbolic sine),tanh
(hyperbolic tangent),acosh
(inverse hyperbolic cosine),asinh
(inverse hyperbolic sine),atanh
(inverse hyperbolic tangent),log10
(base 10 logarithm),cbrt
(cube root).
SenseTalk Defect Fixes
-
Addresses an issue where use of
Wait Until
orWait While
would cause a memory spike and eventual crash. (CRD-1594) -
Addresses an issue on Windows systems when using the
put
or similar commands would cause a crash in some situations. (CRD-1635)
EPF 23.4.0 and 23.4.100 (August 2024)
EPF versions 23.4.0 and 23.4.100 do not include any new updates but bundle the updates of EPF 23.3.1, 23.3.2 and 23.3.3 and are verified to work with DAI 7.4:
EPF 23.3.3 and 23.3.104 (July 2024)
EPF versions 23.3.3 and 23.3.104 contain the following CVE Fixes:
Otherwise, they provide the same functionality as their previous releases:
- EPF 23.3.3 contains the same functionality as 23.3.2.
- EPF 23.3.104 contains the same functionality as 23.3.103.
EPF 23.3.103 (June 2024)
The EPF 23.3.103 release is available for Mac and Windows only. It contains the same updates and bug fixes as the 23.3.2 release described below, except that it includes a different version of the Optical Character Recognition (OCR) component, which is the EPF component that reads text.
Included OCR Version
The EPF 23.3.103 release includes the following OCR version:
- Mac and Windows OCR version:
12.2
, which we recommend for best results with Western language recognition on Mac and Windows. For best results with Eastern language recognition, we recommend release 23.3.2 as described below.
You can verify what version of OCR your EPF instance is running with using the following SenseTalk function:
ocrversion()
put ocrversion() --> 12.2
EPF 23.3.2 (June 2024)
The EPF 23.3.2 release is for all supported EPF platforms: Mac, Windows, and linux. The linux support consists of two installation packages for Ubuntu (one for Ubuntu 16.04 and one for 22.04) and two installation packages for RHEL (one for RHEL 7 and CentOS 7, and one for RHEL 8.)
On June 30, 2024, CentOS Linux 7 reached End of Life (EOL). EPF 23.3.2 is the final release for CentOS 7.
Included OCR Versions
The EPF 23.3.2 release includes the following OCR versions:
- Mac and Windows OCR version:
12.4
, which we recommend for best results with Eastern language recognition. For best results with Western language recognition on Mac and Windows, we recommend EPF 23.3.103 as described above. - Linux OCR version:
12.3
, which provides best results for recognition of all languages on Red Hat, CentOS, and Ubuntu.
Features
The EPF 23.3.2 release includes a new SenseTalk GatherNamespaces
command (and function) and _namespaces
special property, as well as EPF and SenseTalk defect fixes. See SenseTalk Improvements for more information about the SenseTalk updates.