Important Update Information
Released May 15th, 2024
Highlights
As promised on the Aeon Product Roadmap, here are the main features/enhancements of Aeon v6.0:
There are over 15 bug fixes and several underlying component updates in this release.
Considerations Before You Update
Review Aeon v6.0 FAQ
For frequently asked questions and additional information regarding the 6.0 features and fixes, please see the Aeon 6.0 FAQ. You can also view the recording of the 6.0 pre-release webinar from May 7th, 2024, and the recorded demo for the new Staff Web Client from the February 2024 Aeon User Group meeting in the VTL. For all other questions, please contact support at support@atlas-sys.com.
Updating During Normal Working Hours
Please consider running updates and installations during standard support hours 8 am - 5 pm Eastern time (business days: Monday - Friday) so that help is readily available if any issues are encountered.
Updating Procedures
Before you begin updating, please review the Hardware and Software Requirements for Version 6.0. For specific instructions on updating, see Updating Aeon to the Newest Version.
Warning! New System Requirements
- Aeon Server 6.0 requires the Microsoft ASP.NET Core 8.0 Runtime Bundle for the Aeon API. This bundle can be installed via Microsoft's website.
- To prevent disruptions in the Aeon API after updating, please ensure that this bundle is installed on the Aeon Server before updating to Aeon 6.0.
- Once the update has been run, Microsoft .NET Core 2.2 should be manually removed from the server, if present, as .NET Core 2.2 has been deprecated by Microsoft and is no longer receiving security updates. See Microsoft's documentation for instructions on this process.
- It is recommended that the WebSocket protocol is enabled on the server prior to performing the 6.0 upgrade to improve the performance of the Aeon Web Client. For instructions on enabling this protocol, see Microsoft's documentation.
- If this component was not already installed when performing the Aeon 5.2 upgrade, please note that the IIS 6 Management Console component must be installed on Aeon Servers using Windows Server 2022 prior to performing the Aeon 6.0 server upgrade due to a known issue affecting PowerShell. For installation instructions, see Installing Required Windows Server 2022 Components for the Aeon 5.2/6.0 Update
Action Required: Changes to the Aeon API URL
The Aeon API will now be installed to a new default location in IIS during the server update and will use the following API URL: https://servername/AeonApi/. This is the new default installation path for the API and this URL cannot be customized. Previous installations of the Aeon API will be removed during the server update process. To prevent disruptions in API-based integrations after updating, please ensure that these integrations are updated to point to the new base URL for the Aeon API (https://servername/AeonApi/) during or directly after performing the Aeon 6.0 server upgrade.
Caiasoft integrations will be updated automatically during your Aeon 6.0 server upgrade. Please contact support@atlas-sys.com if you have any questions or experience issues after updating to Aeon 6.0.
Action Required: Update Addons
This update removes support for the embedded Chromium browser from the Aeon Desktop Client. To prevent compatibility issues after updating, please ensure that browser-based client addons have been updated to versions supporting WebView2. See the Addons section below for details.
Aeon 6.0 Web Page Update Information
The Aeon 6.0 default and feature-specific web pages include all the latest changes and fixes first released in the Aeon v5.2.11 and Aeon v5.2.13 default and feature-specific web pages. The Aeon 5.2.11 web page update included the removal of the jQuery UI JavaScript Library from the Aeon web pages for security purposes. It is highly recommended to update your web pages to implement this change to ensure the best possible security on the Aeon web interface.
To update your web pages:
- Download the new Aeon v6.0 default and feature-specific web pages and replace your existing pages.
- If you have customizations, find and replace the code changes noted for the Aeon 5.2.11 web page release and the Aeon 5.2.13 web page release.
Point Releases
Bug fixes and new features are added periodically as point releases. See 6.0.x point releases below:
- 03 July 2024 (6.0.10) Default & Feature-Specific Web Pages Release
- 11 July 2024 (6.0.3) Desktop Client Release
- 03 September 2024 (6.0.4) Desktop Client Release
For a list of current known issues, see UserVoice.
Aeon 6.0 Features & Fixes
Aeon API | Addons | Administrative | Appointment Scheduling | Database | Email | Installing and Updating | Staff Desktop Client | Staff Web Client | Web Interface
Aeon API
Action Required: Changes to the Aeon API URL
The Aeon API will now be installed to a new default location in IIS during the server update and will use the following API URL: https://servername/AeonApi/. This is the new default installation path for the API and this URL cannot be customized. Previous installations of the Aeon API will be removed during the server update process. To prevent disruptions in API-based integrations after updating, please ensure that these integrations are updated to point to the new base URL for the Aeon API (https://servername/AeonApi/) during or directly after performing the Aeon 6.0 server upgrade.
Caiasoft integrations will be updated automatically during your Aeon 6.0 server upgrade. Please contact support@atlas-sys.com if you have any questions or experience issues after updating to Aeon 6.0.
Action Required: New System Requirements for the Aeon API
The Microsoft ASP.NET Core 8.0 Runtime Bundle is now required for the Aeon API. This bundle can be installed via Microsoft's website:
- To prevent disruptions in the Aeon API after updating, please ensure that this bundle is installed on the Aeon Server before updating to Aeon 6.0.
- Once the update has been run, Microsoft .NET Core 2.2 should be manually removed from the server, if present, as .NET Core 2.2 has been deprecated by Microsoft and is no longer receiving security updates. See Microsoft's documentation for instructions on this process.
New |
Changed the default URL for the Aeon API from https://servername/aeon/api/ to https://servername/aeonapi/. The Aeon 6.0 API will be installed to this new default path in IIS during the 6.0 server update. This installation path is not customizable. See the Action Required: Changes to the Aeon API URL note above for for more information on the impact of this change. |
---|---|
New |
The Aeon API now uses the Microsoft .NET 8 framework in place of the deprecated Microsoft .NET Core 2.2 framework used in previous API versions for enhanced security. See the Action Required: New System Requirements for the Aeon API note above for more information on the impact of this change. |
New |
Users can now authenticate to the Aeon API with their Aeon staff accounts through the generation of staff tokens via several new Token endpoints. This method allows users to use the API directly or through a third-party application without needing an Aeon API key. When this method of authentication is used:
For more details on the new Token endpoints and the staff token authentication process, see Aeon API. The new Token endpoints replace the Token endpoint used in the Aeon 5.1 and 5.2 API which has been deprecated due to timeout issues. |
New |
In addition to the new Token endpoints noted above, significantly expanded the functionality of the Aeon API through the addition of new endpoints, including:
Developers can find the complete documentation for new and existing API endpoints in the Aeon Swagger documentation. |
New |
Expanded the number of endpoints supporting OData query options. These endpoints are listed in the odata section of the Aeon API Swagger documentation. For more information on using OData with endpoints in the Aeon API, see Aeon API. |
New |
Added support for the new ReshelvingLocation field to the Requests/<transactionNumber>/reshelved and Requests/batch/reshelved endpoints. For more information on this field, see the Database section below. The ReshelvingLocation field can be added to the request body for these endpoints using the following format:
Note that if a non-blank value is present in a request to either endpoint, it will overwrite any existing value in the ReshelvingLocation field of the affected transaction(s). |
Changed |
Removed the /api/RequestBarcodes/{barcode}/reshelved and /api/RequestBarcodes/{id}/reshelved endpoints, which were deprecated and replaced with the /api/Requests/Batch/ endpoints in the Aeon 5.0 API. Any existing implementations of the RequestBarcodes endpoints should be updated to use the /api/Requests/Batch/ endpoints. |
Changed |
Changed the data type of the Appointment ID property returned by the GET /api/Users/{username}/appointments endpoint from a string to an integer value. The new data type for this property will also be used in all new endpoints in the Aeon API in which it is included. |
Fixed |
The Aeon API will no longer log an unnecessary invalid X-AEON-API-KEY header message when the Swagger interface or other public endpoints that do not require API key authentication are accessed. Bug# 10273 |
Fixed |
Fixed an issue where new requests created via the /api/Requests/create endpoint could not be associated with an activity. Bug# 27495 |
Fixed |
Fixed an issue where calling the /api/Users/{username}/requests endpoint to retrieve a user's requests could return an HTTP 500 error when the activeOnly parameter was set to 'true'. Bug# 27501 |
Fixed |
Fixed an issue where attempting to associate a researcher with a request created via the /api/Requests/create endpoint could fail in that the RequestFor field would be set to the username associated with the request when the request was created instead of to the researcher's username. Bug# 27503 |
Fixed |
Fixed an issue where attempting to associate a request created via the /api/Requests/create endpoint with a nonexistent researcher username would return inaccurate validation messages that did not clarify why the process failed. The endpoint will now return a single validation message explicitly stating that the username is invalid. Bug# 27504 |
Addons
Changed |
Removed support for the embedded Chromium browser from the Aeon Desktop Client. Client addons that use a Chromium browser interface will now load using a WebView2 browser. To prevent potential compatibility issues, addons should be updated to versions supporting the WebView2 browser. Install Updated Addons The following Atlas-authored addons have been updated to include support for the WebView2 browser and should be installed before or after updating to Aeon 6.0 to prevent potential compatibility issues:
Addon developers should update Chromium-based addons to include support for the WebView2 browser to prevent compatibility issues with the Aeon 6.0 Desktop Client. Information on implementing the WebView2 browser is available in the addon documentation. |
---|
Administrative
Fixed |
Updated the third-party Newtonsoft dependency used by the Aeon Desktop Client, Aeon Customization Manager, Aeon Staff Manager, and Aeon System Manager to patch a security vulnerability found in the previous version of this component. |
---|
Appointment Scheduling
Fixed |
Fixed an issue where appointments with invalid data would appear on the User Information and Request forms in the Aeon Desktop Client but would throw an error when opened. These appointments can now be opened, but the invalid data must be fixed (e.g., by ensuring the appointment's stop time occurs after its start time) before the Appointment form can be saved. Bug# 17378 |
---|---|
Fixed |
Fixed an issue where the System panel on the Aeon Desktop Client dashboard did not include information for pending or failed appointment-type emails. These emails are now included in the System panel and can be managed via the Failed Email and Pending Email tabs. Bug# 26272 See Troubleshooting Email for more information on accessing and managing failed and pending emails. |
Fixed |
Fixed an issue where rescheduling an appointment in the Aeon Desktop Client could result in an error if another user edited that appointment at the same time using a different start or end time. Both the start time and end time on the Appointment form will now be saved to the database when the appointment is saved to avoid potential invalid data, even if only one of these values was changed during editing. Bug# 17181 |
Fixed |
Fixed an issue where the auto-confirm appointments setting for a reading room in the Aeon Customization Manager would not automatically confirm/re-confirm an appointment after it was edited or rescheduled on the web interface. Bug# 24074 |
Database
New |
Added a new ReshelvingLocation field to the Transactions table. This field can be added to grids and the Request form in the Aeon Desktop Client and to Transactions grids in the Aeon Web Client. It is also available as a merge field for print and email templates. Note: This field is not available on the Request form in the Aeon Desktop Client by default and must be added manually using the staff layout customization feature. For more information on this feature, see Creating and Assigning Templates to Staff Users. Aeon administrators must also manually add this field to Transactions grids in the Aeon Web Client. For more information on the web client layout customization process, see Managing Staff Accounts and Web Client Layouts Using the Staff Administration Page. Information for Developers The ReshelvingLocation field can be added as a body parameter to the Requests/<transactionNumber>/reshelved and Requests/batch/reshelved endpoints in the Aeon API. See the API section of the release notes above for more information. |
---|---|
New |
Added new tables to the database to support the Aeon Web Client features:
For details on the columns in each table, see Aeon Database Tables. |
New |
Added two new columns to the Staff database table to support Aeon Web Client features:
|
Fixed |
Added triggers to the Aeon database that will automatically adjust the casing for the username value associated with new appointment or transaction records to match the casing used for that value in the Users database table to prevent issues caused when the casing of these username values did not match. Any existing database records that were affected by the username casing mismatch issues will be automatically corrected during the Aeon 6.0 server update. |
Fixed |
Fixed an issue where an invalid BCC address on an email would be logged in the Aeon System Manager logs as an "Invalid From Address" error. The System Manager will log an "Invalid BCC Address" error message in these cases. |
---|
Installing and Updating
Warning! New System Requirements
The Aeon 6.0 release includes several new system requirements and recommendations. Please review the Updating Procedure section of the release notes above before updating to ensure the required components are in place.
Changed |
Changed the underlying third-party component libraries used to facilitate printing documents from the Aeon Desktop Client. No existing printing functionality will be affected or changed by this update, however, the files installed with the Aeon Desktop Client to support printing functionality will be modified as follows as a result of this change: Files Removed The following existing files will be removed from the Aeon Desktop Client installation directory upon updating:
Files Added The following new files will be added to the Aeon Desktop Client installation directory upon updating:
|
---|---|
Changed |
The Aeon Server Installer PowerShell Scripts will now install the Aeon API to a new default file path location on the Aeon Server (C:\Program Files (x86)\Aeon\AeonApi). The API will be moved from the previous installation location to the new default installation path upon update. |
Staff Desktop Client
Changed |
Removed support for the embedded Chromium browser. To prevent potential compatibility issues after updating, browser-based client addons should be updated to versions supporting the WebView2 browser. Please see the Addons section of the release notes above for more information on updating these addons.
|
---|---|
Fixed |
Fixed an issue where an error would occur when using the Clone to Current User option from the request list for a queue or request search results. Bug# 26834 |
Fixed |
Fixed an issue where an error would occur when using the Print Callslips option from the Activity or Appointment form if any custom fields defined in the Aeon Customization Manager's CustomFieldDefinitions table were present on the print template. Bug# 26639 |
Fixed |
Fixed an issue where the panel on the left side of the Aeon Options window did not update its color based on the client display skin selected, which could lead to poor color contrast. Bug# 22246 |
Fixed |
Fixed an issue where creating requests from an Excel spreadsheet file would fail if any custom fields defined in the Aeon Customization Manager's CustomFieldDefinitions table were included in the spreadsheet. Bug# 23597 |
Fixed |
Fixed an issue where errors could occur when applying service packages to photoduplication requests. Bug# 23473 |
Staff Web Client
New |
A lightweight web-based version of the Aeon Staff Client is now available. The Aeon Web Client is a web-based version of the existing Aeon Desktop Client application and is installed via the Aeon 6.0 server installation/update. Once installed, the web client can be accessed via the URL https://servername/aeonstaff/on any standard web browser application (e.g., Google Chrome or Safari) on the user's computer or mobile device, including macOS and iOS devices: The initial release of the Aeon Web Client includes many of the user management, reading room sign-in, and appointment scheduling features available in the desktop client application, as well as several brand-new customization options and security features exclusive to the new web application: Note on Future Updates Support for the full range of features included in the Aeon Desktop Client application, such as request and activity processing functionality, will be added to the Aeon Web Client application in future releases. For a detailed overview of the Aeon Web Client and links to relevant documentation for each of the features listed below, see Aeon Web Client Overview or click the Learn more link in one of the sections below. Navigation and Searching
Multi-Factor Authentication (MFA) Protection for Staff Accounts
Configuring the MFA Requirement on the Aeon Server Multi-factor authentication provides an important extra layer of security to your Aeon system by requiring all users to log in with two forms of authentication: their username and password credentials and a time-based one-time password (TOTP) code that is generated by an authentication application and is harder for potential attackers to obtain or duplicate. The TOTPs enforced by the MFA requirement are important in that they provide additional protection against potential security breaches to your Aeon system if a staff user’s username and password are compromised. Given these security implications, the configuration options for the MFA requirement on the Aeon Server will vary based on your hosting provider as follows:
Please see Troubleshooting Issues Configuring MFA for Staff Accounts After Web Client Installation if you are experiencing issues completing the MFA configuration process for staff accounts after the Aeon 6.0 update. Enhanced Client Customization Options
User Record Management
User Sign-In and Reading Room Management
Appointment Scheduling
Accessibility Information
Notes for Server Administrators The Aeon Web Client will be installed on the Aeon Server during the 6.0 server installation process. After the 6.0 server upgrade is completed, the web client will be accessible using the following URL: https://servername/aeonstaff/. This location is not customizable. Several additional files will be installed in the Aeon API application directory on the server to support the multi-factor authentication requirement for the web client. See Installing the Aeon Server for details. |
---|
Web Interface
New |
For increased security against potentially untrusted XML files, the expansion of XML document type definitions (DTDs) can now be prohibited during EAD processing via the new EADProhibitDTD customization key in the Aeon Customization Manager (located under Web Interface | EAD).
See Submitting Requests via EAD Finding Aids for more detailed guidance on setting the value of this key. |
---|---|
Changed |
Changed the underlying third-party component libraries used to facilitate Activity exporting from the Aeon web interface. Activity information will now be exported in the .xlsx file format. |
Fixed |
The Aeon 6.0 default and feature-specific web pages include all the latest changes and fixes first released in the Aeon v5.2.11 and Aeon v5.2.13 default and feature-specific web pages. For detailed instructions on implementing each of these changes, please see the Aeon 5.2.11 web page release implementation instructions and the Aeon 5.2.13 web page release implementation instructions:
|
Fixed |
Photoduplication status will no longer be set for requests sent to user review to fix an issue where these requests could become uneditable if the photoduplication status was set to Awaiting Order Processing by the SkipOrderEstimates parameter. Bug# 12663 |
03 July 2024 (6.0.10) Default & Feature-Specific Web Pages Release
A new version of the default and feature-specific web pages has been released to improve the user experience on the Aeon web interface.
The new default and feature-specific web pages are available for download on the Aeon Downloads page. To implement these changes:
- Download the new Aeon v6.0.10 default and feature-specific web pages and replace your existing pages.
- If you have customizations, find and replace the code changes in Implementing 6.0 Web Page Changes.
Fixed |
Fixed various issues on the default and feature-specific web pages. The list of changes can be found below. For more information on implementing each fix, see Implementing 6.0 Web Page Changes.
|
Changed |
Updated the Aeon default and feature-specific web pages to rename some of the account management-related features for clarity and to ensure naming consistency across the web pages:
For more information on implementing these changes, see Implementing 6.0 Web Page Changes. |
Changed |
The following changes have been made to the layout and style used to format the Aeon default and feature-specific web pages when they are printed from the web browser to improve the readability of the printed material and to increase focus on essential information:
For more information on implementing each change, see Implementing 6.0 Web Page Changes. |
New |
Added new minified versions of most default JavaScript and CSS files used in the Aeon web pages and updated all relevant web page files to use the new minified files in order to optimize the performance of the Aeon web interface and reduce page load times for users. The minified files will have the extension .min.js or .min.css and will be present in the js or css folder of the default and feature-specific web page downloads alongside the original un-minified version of each file. For more information on implementing these new files, see Implementing 6.0 Web Page Changes. |
11 July 2024 (6.0.3) Desktop Client Release
The Aeon 6.0 Desktop Client has been updated to a new version to fix an issue affecting the printing process in Aeon Desktop Client v6.0.1 that could lead to incorrect values printed for certain fields and to fix a separate error that occurred when the Appointments to Confirm form was opened in the desktop client.
Update Procedure
Atlas-hosted sites can see the Aeon Update Procedures and Best Practices for Atlas-Hosted Sites article for more information on minor point release update procedures.
Follow the Client Automatic Updater prompts within the Aeon Desktop Client, or download and run the 6.0.3 Desktop Client Installer from the Aeon Downloads page to install the new client application(s).
Client Application Updates
Performing the Aeon Desktop Client update process will install the following new application versions:
- Desktop Client v6.0.3
Fixed | Fixed an issue where field values containing numeric data could be improperly formatted in some cases when printed and would not match the value displayed for the field on the related record in the Aeon Desktop Client. |
Fixed | Fixed an issue that could cause an error message when opening or reloading the Appointments to Confirm form in the Aeon Desktop Client. |
Desktop Client Only Release
03 September 2024 (6.0.4.0) Desktop Client Release
The Aeon 6.0.4.0 Desktop Client has been updated to a new version to prevent a necessary DomainLogic library file from being removed during updates from Aeon 5.2.5 to 6.0.3.
Aeon users already on version 6.0 will receive a prompt indicating there is a client update available. If you wish to run the update, you can do so from the prompt. There are no associated client updates aside from the version number.
If you do not wish to update the client, you can continue to dismiss the message.
Update Procedure
Atlas-hosted sites can see the Aeon Update Procedures and Best Practices for Atlas-Hosted Sites article for more information on minor point release update procedures.
Follow the Client Automatic Updater prompts within the Aeon Desktop Client, or download and run the 6.0.4.0 Desktop Client Installer from the Aeon Downloads page to install the new client application(s).
Client Application Updates
Performing the Aeon Desktop Client update process will install the following new application versions:
- Desktop Client v6.0.4.0
- Customization Manager v6.0.2.0
- Staff Manager v6.0.2.0
Fixed | The DomainLogic library was reversioned for the Client, Customization Manager, and Staff Manager to prevent a necessary library file from being removed during some client updates. Bug# 29609 |