The release of Aeon 5.2 comes with several changes to the default web pages. To implement these changes, you can either:
- Download the 5.2 web pages and replace your existing pages.
- If you have customizations, find and replace the following code changes mentioned below. Any code highlighted in yellow needs to be removed and any code highlighted in blue needs to be added.
5.2 Release (Appointment Scheduling Pages)
The Appointment Scheduling web pages have been significantly overhauled in Aeon 5.2. Please follow the instructions below to update your 5.1 Appointment Scheduling web pages to the new Appointment Scheduling web pages available for 5.2.
Files to Remove | Files to Add | Files to Overwrite | Files to Overwrite or Modify | Updating the EAD Request Form
Files to Remove
The following files should be removed from the Aeon web directory:
- CSS folder:
- css/icons/dxicons.ttf
- css/icons/dxicons.woff
- css/icons/dxicons.woff2
- css/appointments.css
- css/dx.common.css
- css/dx.light.css
- JS folder:
- js/dx.all.js
Files to Add
The following files are new in Aeon 5.2 and should be added to your web directory. Please download the latest default and feature-specific web pages for Aeon 5.2 and add the new files:
- Feature-Specific Web Pages (AppointmentScheduling folder):
- ArchivalRequest.html
- include_appointment_info_ead.html
- include_appointment_info_no_site.html
- Default Web Pages:
- Templates folder:
- templates\DataRow_ArchivalRequestContainer.html
- CSS folder:
-
css\images\fa-calendar.svg
Note: This file should be added to the images subfolder inside the CSS folder - css\datepicker.min.css
-
- JS folder:
- Copy over the entire 'lang' subfolder containing:
- js\lang\en-US.js
- js\ArchivalRequest.js
- js\datepicker.min.js
- Copy over the entire 'lang' subfolder containing:
- Templates folder:
Files to Overwrite
The following files have been substantially updated in Aeon 5.2. Please download the latest default and feature-specific web pages and overwrite these files with the updated files:
- include_appointment_info.html
- include_appointment_scripts.html
- EditAppointment.html
-
ViewAppointments.html
If you have made customizations to your ViewAppointments.html file that you do not want to lose, please move your customizations to the new 5.2 file before copying the file to your web directory. - CSS folder:
- css\cookieconsent.min.css*
- JS folder:
- js\appointment.js
- js\atlasCookieConsent.js*
- js\atlasUtility.js*
- js\cookieconsent.min.js*
- js\KeepInReview.js*
- js\scheduled-date.js*
*Included in the 5.2 Default Web Pages download
Files to Overwrite or Modify
It is strongly recommended to also overwrite the following web page files with the new updated files released for Aeon 5.2. However, if any of these files have been extensively modified for your institution, then the required code changes for each file can be made manually to your existing files following the instructions in the expandable section below:
- include_head.html*
- include_head_request.html*
- ViewAppointment.html
- CSS folder:
- css\aeon.css*
- Templates folder:
- templates\DataRow_DefaultAppointment.html
*Included in the 5.2 Default Web Pages download
css\aeon.css
Change this (default lines 321-330):
|
To this:
|
Then add this code to the end of the aeon.css file:
|
include_head_request.html
Add this code to the end of the file:
|
include_head.html
Change this (default lines 7-12):
|
To this:
|
templates\DataRow_DefaultAppointment.html
Change this (default lines 6-10):
|
To this:
|
And change this (default line 27):
|
To this:
|
ViewAppointment.html
Change this (default lines 66-75):
|
To this:
|
Updating the EAD Request Form
The EAD Request form (EADRequest.html) has been updated with the new appointment scheduling fields and functionality. This file should be updated differently based on whether or not you are using a photoduplication toggle and how the 5.1 appointment scheduling fields were implemented on this form.
Update Instructions for Appointment Scheduling Fields Implemented via Include File
If appointment scheduling fields were added to your EAD Request form via a link to an "include_appointment_info_ead.html" include file, please follow the instructions below to update your include_appointment_info_ead.html file:
- Download the latest feature-specific appointment scheduling pages from the Aeon Downloads page
-
Overwrite your existing include_appointment_info_ead.html field with the updated file
If you have used a different name for this file, please delete the old file and replace it with the updated include_appointment_info_ead.html file, then update the line of code used to link to the include file on EADRequest.html with the new filename (see step 3) -
Check to ensure that your EADRequest.html uses the following code to link to the new include file:
<#INCLUDE filename="include_appointment_info_ead.html">
Update Instructions for Hardcoded Appointment Scheduling Fields
If your EAD Request form contains hardcoded appointment scheduling fields (i.e., the code for those fields is directly within EADRequest.html and are not in an include_appointment_info_ead.html file), please follow the instructions below to remove the old fields and implement the new fields using the new include_appointment_info_ead.html file:
- Locate the hardcoded appointment scheduling fields within EADRequest.html: Request For (RequestLink), Site, Reading Room (ReadingRoomID), Appointment (AppointmentID)
-
Delete the code for the hardcoded fields and replace it with the following line of code:
<#INCLUDE filename="include_appointment_info_ead.html">
WebValidation Table Updates for EADRequest.html (No Photoduplication Toggle)
If you are not using a photoduplication toggle on EADRequest.html, follow the steps in the documentation to ensure that the ReadingRoomID field has been added to the WebValidation table for EADRequest.html. Additionally, if you had added a rule to the WebValidation table in the Aeon Customization Manager to require the Appointment field (AppointmentID) on EADRequest.form in Aeon 5.1, delete this rule. This rule is no longer necessary to properly enforce the appointment requirement on EADRequest.html in Aeon 5.2.
5.2 Release (Default Web Pages)
New Accessible Scheduled Date Calendar | Fix Issue with Fields Hidden by Toggle Options on Request Forms | Remove Hidden Username Inputs and <div> Tags| Fix Field Value Persistence for Safari Browser | Remove 'Required' Attribute from EditEADRequest.html | Update FAQ | Add Missing 'type' Attribute to Buttons | Improve Color Contrast for Buttons and Dropdown Menu Options | Fix Broken Web Alert Attribute | Remove Broken Attribute on ChangePassword.html | Adjust Color for Hyperlinks in Cookie Banner | Adjust Label Color for Form Fields Failing Validation | Adjust Formatting for Search Box | Improve Transaction Menu Responsiveness | Realign Actions Menu Dropdown Options | Fix Text Responsiveness Issues | Update Copyright Year on Logon.html | Add Information to Saved Requests Page
New Accessible Scheduled Date Calendar
The date picker calendar used for the Scheduled Date field in the default Aeon web pages has been updated with a significantly more accessible version for screen reader and keyboard-only users. Implementing the new accessible calendar tool will require adding new files to your web directory and modifying existing files according to the instructions below.
New Files to Add | Files to Overwrite | Files to Overwrite or Modify | Updating the EAD Request Form | Updating Other Request Forms
New Files to Add
The following files are new in Aeon 5.2 and should be added to your web directory. Please download the latest default web pages and add the following new files:
- include_scheduled_date.html
- include_scheduled_date_ead.html
- CSS folder:
-
css\images\fa-calendar.svg
Note: This file should be added to the images subfolder inside the CSS folder - css\datepicker.min.css
-
- JS folder:
- Copy over the entire 'lang' subfolder containing:
- js\lang\en-US.js
- js\datepicker.min.js
- Copy over the entire 'lang' subfolder containing:
Files to Overwrite
The following files have been updated and should be overwritten to ensure the most recent version of each file is being used. Please download the latest default web pages and overwrite these files with the updated files:
- CSS folder:
- css\cookieconsent.min.css
- JS folder:
- js\atlasCookieConsent.js
- js\cookieconsent.min.js
- js\scheduled-date.js
Files to Overwrite or Modify
It is strongly recommended to also overwrite the following web page files with the new updated files released for Aeon 5.2. However, if any of these files have been extensively modified for your institution, then the required code changes for each file can be made manually to your existing files following the instructions in the expandable section below:
- include_head.html
- include_head_request.html
- ViewUserReviewRequests.html
- CSS folder:
- css\aeon.css
css\aeon.css
Change this (default lines 321-330):
|
To this:
|
Then add this code to the end of the aeon.css file:
|
include_head_request.html
Add this code to the end of the file:
|
include_head.html
Change this (default lines 7-12):
|
To this:
|
ViewUserReviewRequests.html
Change this (default lines 35-48):
|
To this:
|
Updating the EAD Request Form
To implement the new Scheduled Date functionality on the EAD Request form, please overwrite your default EADRequest.html file with the updated file or make the changes manually following the example below:
EADRequest.html
Change this (default lines 100-118):
|
To this:
|
Updating Other Request Forms
All request forms and their corresponding edit forms (excluding EADRequest.html) that use the Scheduled Date field should be modified to use the new include_scheduled_date.html include file in place of the hardcoded Scheduled Date field. To implement these changes, make the following update on each of your request forms that contain the Scheduled Date field following the example for DefaultRequest.html below:
Change this (DefaultRequest.html default lines 167-185):
|
To this:
|
Make the changes above on the following default request forms:
- DefaultRequest.html (default lines 167-185)
- EditDefaultRequest.html (default lines 176-194)
- GenericRequestManuscript.html (default lines 133-151)
- EditGenericRequestManuscript.html (default lines 127-145)
- GenericRequestMonograph.html (default lines 170-188)
- EditGenericRequestMonograph.html (default lines 182-200)
- GenericRequestSerial.html (default lines 138-156)
- EditGenericRequestSerial.html (default lines 167-185)
Fix Issue with Fields Hidden by Toggle Options on Request Forms
To fix an issue where hidden billing fields (such as those hidden by a customized photoduplication toggle option on the EAD Request form) could become enabled (but remain hidden) on request forms and prevent submission of the form, please download the latest default web pages and overwrite your js\billingContextOptionHandler.js and js\duplicationPermissionToggle.js files with the updated files.
The fix will not apply to any affected billing fields that use the position: fixed CSS property. The following error message will be returned in the browser console when this issue occurs:
The [HTML ID for the affected billing field] SELECT element has a fixed position and
its visibility may not be accurately determined by billingContextOptionHandler.js
To resolve this issue, please locate the affected billing field within the code for the relevant web page and remove the position: fixed property.
js\billingContextOptionHandler.js
Please overwrite this file with the updated file.
js\duplicationPermissionToggle.js
Please overwrite this file with the updated file.
Remove Hidden Username Inputs and <div> Tags
Unnecessary hidden inputs for the username field have been removed from the default web pages to improve the efficiency of the code on these pages. Please either overwrite these files with the new default files or make the changes each page manually following the examples below as a guide:
Example - Default Web Pages
The "Username" hidden input should be deleted from the default web pages following the example below:
Change this (DefaultRequest.html default line 18):
|
To this:
|
On the following web pages at the specified default lines:
- ChangePassword.html (default line 16)
- DefaultRequest.html (default line 18)
- EADRequest.html (default line 40)
- EditDefaultRequest.html (default line 18)
- EditEADRequest.html (default line 18)
- EditGenericRequestManuscript.html (default line 19)
- EditGenericRequestManuscriptPhotodup.html (default line 19)
- EditGenericRequestMonograph.html (default line 19)
- EditGenericRequestMonographPhotodup.html (default line 19)
- EditGenericRequestSerial.html (default line 19)
- EditPhotoduplicationRequest.html (default line 19)
- GenericRequestManuscript.html (default line 19)
- GenericRequestManuscriptPhotodup.html (default line 19)
- GenericRequestMonograph.html (default line 19)
- GenericRequestMonographPhotodup.html (default line 19)
- GenericRequestSerial.html (default line 19)
- PhotoduplicationRequest.html (default line 19)
Fix Field Value Persistence for Safari Browser
To fix an issue where fields marked with the "data-persisted-value" attribute will not properly persist their values in the Safari web browser, please download the latest default web pages and overwrite your js\atlasUtility.js file with the updated file.
js\atlasUtility.js
Please overwrite this file with the updated file.
Remove 'required' Attribute from EditEADRequest.html
To remove an unnecessary 'required' attribute from the ItemSubTitle field on EditEADRequest.html, please overwrite your default EditEADRequest.html file with the updated file or make the following changes:
EditEADRequest.html
Change this (default line 44):
|
To this:
|
Update FAQ
To update outdated information on the default FAQ web page, please overwrite your default FAQ.html file with the updated file or make the following changes:
FAQ.html
Change this (default line 82):
|
To this:
|
And change this (default lines 126-127):
|
To this:
|
Add Missing 'type' Attribute to Buttons
'Type' attributes have been added to buttons where missing to fix intermittent issues when using buttons on the order processing web pages, web alerts, and Saved Requests page. To implement these changes, please overwrite your webAlerts.js file with the updated file and either overwrite the files listed below with the updated files or make the changes manually as shown below:
js\webAlerts.js
ViewUserReviewRequests.html
Change this (default lines 26-27):
|
To this:
|
ViewOrderEstimates.html
Change this (default lines 30-31):
|
To this:
|
ViewOrderApprovals.html
Change this (default lines 29-30):
|
To this:
|
templates\payment\include_payment_buttons.html
Change this (default line 2):
|
To this:
|
Improve Color Contrast for Buttons and Dropdown Menu Options
The "text-info" class has been removed from several buttons and dropdown menu items in the DataRow template files to improve color contrast against the default Aeon web pages. To implement these changes, please either overwrite the files listed below with the updated files or make the changes manually as shown below:
templates\DataRow_BillingDetail.html
Change this (default line 6):
|
To this:
|
templates\DataRow_CreditCardOrder.html
Change this (default line 15):
|
To this:
|
templates\DataRow_ElectronicDelivery.html
Change this (default line 22):
|
To this:
|
templates\DataRow_OrderBilling.html
Change this (default line 50):
|
To this:
|
templates\DataRow_OrderEstimate.html
Change this (default line 48):
|
To this:
|
Fix Broken Web Alert Attribute
To fix a broken 'aria-labelledby' attribute causing an accessibility issue on the modal dialog for web alerts, please download the latest default web pages and overwrite your js\webAlerts.js file with the updated file.
js\webAlerts.js
Please overwrite this file with the updated file.
Remove Broken Attribute on ChangePassword.html
To remove a broken 'aria-describedby' attribute causing an accessibility issue on ChangePassword.html, please overwrite your default ChangePassword.html file with the updated file or make the following changes:
ChangePassword.html
Change this (default lines 23-30):
|
To this:
|
Adjust Color for Hyperlinks in Cookie Banner
To fix contrast issues with the default color used for hyperlinks added to the cookie consent banner, please overwrite your default css\aeon.css file with the updated file or make the following changes:
css\aeon.css
Change this (default lines 450-452):
|
To this:
|
Adjust Label Color for Form Fields Failing Validation
The default label color used to highlight fields that fail server validation when a form is submitted was changed to fix contrast issues against the default web page background colors. To implement this change, please overwrite your default js\atlasUtility.js file with the updated file and overwrite your css\aeon.css file with the updated file or make the following changes:
js\atlasUtility.js
Please overwrite this file with the updated file.
css\aeon.css
Change this (default line 126-129):
|
To this:
|
Adjust Formatting for Search Box
To fix color contrast issues with the default color used for the border around the search box and to improve the overall layout of the web page, please overwrite your default ViewSearchResults.html file with the updated file or make the following changes:
ViewSearchResults.html
Change this (default lines 19-23):
|
To this:
|
And change this (default lines 32-33):
|
To this:
|
Improve Transaction Menu Responsiveness
To fix issues with the responsiveness and readability of the transaction menu on smaller display sizes and to add an underline on hover for its enabled menu buttons, please overwrite your default aeon.css and include_TransactionMenu.html files with the updated files or make the following changes:
aeon.css
Change this (default lines 237-240):
|
To this:
|
include_TransactionMenu.html
Change this (default lines 1-2):
|
To this:
|
Then follow the example for the Edit Request button to add the "my-1 py-2" class to the code for all buttons on this page at the default lines listed below:
Edit Request Button Example
Change this (default lines 4-7):
|
To this:
|
Add the "my-1 py-2" class to these default lines:
- 4 (Edit Request button)
- 9 (Cancel Request button)
- 14 (Remove from Hold button)
- 19 (Resubmit Request button)
- 24 (Request Copy button)
- 29 (Clone Request button)
- 34 (Clone to Copy button)
- 39 (View Item button)
- 44 (Delete Item button)
- 49 (Submit Request button)
- 54 (Approve Estimate button)
- 59 (Approve Billing button)
- 64 (Export Citation button)
Realign Actions Menu Dropdown Options
To fix an issue where the Actions menu dropdown options are not fully visible on smaller display sizes, please overwrite the files listed below with the new default files or make the change on each page manually following the example below:
Example
Add the "dropdown-menu-right" class to the code for the dropdown menu <div> container:
Change this (DataRow_DefaultActivity.html default line 30):
|
To this:
|
On the following web pages at the specified default lines:
- DataRow_DefaultActivity.html (default line 30)
- DataRow_DefaultRequest.html (default line 20)
- DataRow_ElectronicDelivery.html (default line 21)
- DataRow_OrderBilling.html (default line 48)
- DataRow_OrderEstimate.html (default line 46)
- DataRow_ReviewRequest.html (default line 24)
Fix Text Responsiveness Issues
To fix issues where text would cross over other text and cause readability issues on various web pages when viewed on small screen sizes or high zoom levels, please overwrite the files noted below with the updated files or make the following changes manually:
aeon.css
Change this (default lines 336-338):
|
To this:
|
ActivityInformation.html
Follow the example for the Name field on ActivityInformation.html to add the "transaction-label" class to the code within each file listed below for the fields located at the default lines indicated:
Name Field Example
Change this (default lines 6-13):
|
To this:
|
Add the "transaction-label" class to the fields located at the default lines on the following web page files:
ActivityInformation.html:
- 8 (Name field)
- 17 (Description field)
- 26 (Type [ActivityType] field)
- 35 (Status [ActivityStatus] field)
- 44 (Status Date [ActivityStatusDate] field)
- 53 (Location field)
- 62 (Begin Date field)
- 71 (End Date field)
include_ResearcherTagsUpdate.html:
- 7 (Current Tags [ResearcherTags] field)
ViewDetailedManuscriptInformation.html:
- 7 (Transaction Number field)
- 16 (Title [ItemTitle] field)
- 25 (Author [ItemAuthor] field)
- 34 (Date [ItemDate] field)
- 43 (Collection Name/Location [Location] field)
- 52 (Call Number field)
- 61 (Box(es)/Folder(s) [ItemVolume] field)
- 70 (Requested For [ResearcherUsername] field)
- 79 (Activity Number [ActivityID] field)
- 88 (Scheduled Date field)
- 97 (Special Request field)
ViewDetailedMonographInformation.html:
- 7 (Transaction Number field)
- 16 (Title [ItemTitle] field)
- 25 (Author [ItemAuthor] field)
- 34 (Place of Publication [ItemPlace] field)
- 43 (Publisher [ItemPublisher] field)
- 52 (Date [ItemDate] field)
- 61 (Edition [ItemEdition] field)
- 70 (Volume/Box [ItemVolume] field)
- 79 (Issue/Copy [ItemIssue] field)
- 88 (Size/Physical Description [ItemCitation] field)
- 97 (Call Number field)
- 106 (Collection Name/Location [Location] field)
- 115 (Requested For [ResearcherUsername] field)
- 124 (Activity Number [ActivityID] field)
- 133 (ScheduledDate field)
- 142 (Special Request field)
ViewDetailedSerialInformation.html:
- 8 (Transaction Number field)
- 17 (Title [ItemTitle] field)
- 26 (Place of Publication [ItemPlace] field)
- 35 (Date [ItemDate] field)
- 44 (Volume/Box [ItemVolume] field)
- 53 (Issue/Copy [ItemIssue] field)
- 62 (Call Number field)
- 71 (Collection Name/Location [Location] field)
- 80 (Requested For [ResearcherUsername] field)
- 89 (Activity Number [ActivityID] field)
- 98 (Scheduled Date field)
- 107 (Special Request field)
Update Copyright Year on Logon.html
To update the hardcoded copyright year on the Logon web page to the current year, please overwrite your default Logon.html file with the updated file or make the following changes:
Logon.html
Change this (default line 78):
|
To this:
|
Add Information to Saved Requests Page
To add transaction number and site information to requests listed on the Saved Requests web page, please overwrite your default DataRow_ReviewRequest.html file with the updated file or make the following changes:
templates\DataRow_ReviewRequest.html
Change this (default line 13):
|
To this:
|