ILLiad 9.2 Release Notes

Fixed an issue where the lender was not imported into the Lending String field when submitting requests in DOCLINE.

Added functionality to the Web Platform's Create Transaction API endpoint that allows transactions to be created for a user using an external user ID if the ILLiad username is not available in the external integrating system. For more information, see The ILLiad Web Platform API. 

Updated the AtlasPDF tool used by the Odyssey Manager to v1.1.3. This version updates the log4net component used by the tool to v2.0.14 in order to fix an issue causing crashes.

Updated the embedded browser used by the OCLC Policies Directory to Chromium in order to fix several formatting and display issues. In addition to fixing these issues, the new browser will also implement the following changes:

• Any links clicked within the Policies Directory screen will open up in an external window in the default web browser for the machine.
• Email links will no longer open in the machine's default email application when clicked. Email addresses must now be manually copied and pasted directly into the external email application to initiate an email. 

Removed the Ribbon Display Options button that was located next to the Minimize button on the main application window of the ILLiad Client.

Fixed an issue that prevented custom searching on the OCLC and Z39.50 tabs of the ILLiad Request form.

Fixed an issue that prevented importing for Borrowing and Lending requests in the DOCLINE interface if the FieldTranslation.xml and LendingFieldTranslation.xml files were not found in the old DOCLINE install path (C:\Program Files (x86)\ILLiad\Docline\). The ILLiad Client will now read those files from the new installation location (C:\ProgramData\ILLiad\Docline\). 

Fixed an issue where request text was not added to the Imported Request tab on the ILLiad Request form when importing DOCLINE Lending requests.

Fixed an issue where error details would not be properly displayed on the screen when a DOCLINE order failed to be placed.

Fixed various accessibility and other issues on the web pages to improve the user experience and address several bugs. The list of changes can be found below. For more information on implementing each fix, see Implementing 9.2 Web Page Changes. 

• Added custom focus indicators and new underline behavior for hyperlinks to address color contrast issues 
• Changed the default title of the first-time user registration page (FirstTime.html) to differentiate it from the logon pages 
• Changed the default color of the "No search results" message on the search results web page to fix contrast issues with the default background color. Bug #17644
• Added missing "(required)" labels to several fields marked as required by default in the ILLiad Customization Manager's WebValidation table. Bug #17645
• Added borders to all buttons to address color contrast issues 
• Added custom focus indicators for input fields and buttons and added an outline to form fields to address color contrast issues Bug #17641
• Fixed an issue where users on some mobile devices were not able to zoom in and out of the web pages. Bug# 16529
• Fixed accessibility issues caused by the "All" and "None" buttons used to set notification preferences within the include_notification_prefences.html file. Bug# 16533
• Fixed an issue where certain buttons used in the DataRow template files could not be activated using keyboard controls 
• Removed tooltips from the DataRow template files that did not meet accessibility requirements 
• Fixed an accessibility issue caused by the "Actions" button on DataRow_ElectronicDelivery.html
• Fixed an issue where the cookie notification popup could not be dismissed using keyboard controls Bug# 16945
• Added a missing space between the Transaction Number and Due Date field labels and their respective values on several DataRow template files
• Added an error page (Error.html) to the Lending web directory to ensure this page is displayed to users encountering errors on the Lending web pages

Fixed formatting and contrast issues for the radio buttons and search box on the search web pages (ViewSearchResults.html and LendingViewSearchResults.html). Bug# 13557

Removed unnecessary hidden inputs from various web forms to enhance security and improve the efficiency of the code on these pages.

Changed the page header on NewAuthRegistration.html to better reflect the purpose of the web page.

Updated the signing certificate used by the application to fix an issue that prevented the SQL Alias Manager from opening.

Fixed an issue where DOCLINE lending requests would not import into ILLiad after the DOCLINE 6.2.41 update.

Fixed an existing issue where requests from each service level were not all imported after using the Import All button.

Changed the default mail merge method used by the ILLiad Client to fix an issue where attempting to print after updating to Microsoft Word version 2211 or above could potentially return an error stating "The OpenDataSource method or property is not available because a macro is currently running."

The following new configuration options are available for the ILLiad web interface to prevent bot-driven spam account creation via the New User Registration forms (NewUserRegistration.html and LendingNewUserRegistration.html):

• ILLiad can now integrate with one of three supported third-party captcha providers to add a captcha challenge requirement to the New User Registration forms (NewUserRegistration.html and LendingNewUserRegistration.html). The captcha challenge will provide extra security against bot-driven account creation by requiring new users to solve the challenge in order to submit the form and create their accounts. The following captcha providers and plans are supported by ILLiad (note that a separate account must be created with your chosen captcha provider to implement this feature): 

  • Google reCAPTCHA: reCAPTCHA v2 (both the "invisible" and "checkbox" variants) and reCAPTCHA v3
    • Note that reCAPTCHA Enterprise is not supported by ILLiad
  • hCaptcha: Free "Publisher" plan
  • MTCaptcha: Free plan
• As an alternative to implementing the captcha requirement, user registration can now be completely disabled for accounts created through basic ILLiad authentication (ILLiadAuth) from the New User Registration forms (NewUserRegistration.html and LendingNewUserRegistration.html) using the new ILLiadAuthUserRegistrationEnabled customization key. This option will prevent the creation of spam accounts by completely blocking account creation for users who are not pre-authorized for an ILLiad account via an ILLiad Exclusive, LDAP, PatronAPI, SymphonyAPI, or Remote Authentication configuration. This option should not be chosen if you only allow users to register for accounts through the basic ILLiad account creation and authentication process.

Added the following new customization keys to the ILLiad Customization Manager to support the new bot-driven spam account prevention options:

• ILLiadAuthUserRegistrationEnabled: Determines if new user registrations can be created via basic ILLiad authentication (ILLiadAuth)
• SLUserRegistrationDisabled: The web status line that appears if registration has been disabled using the ILLiadAuthUserRegistrationEnabled key
• CaptchaProvider, CaptchaSecret, CaptchaSiteID: These keys are used to configure the captcha integration for the user registration form
• SLCaptchaFailure: The web status line that appears if a user fails the CAPTCHA challenge during user registration.

Added the CAPTCHA web DLL tag to the ILLiad web interface. This tag is used to display the captcha challenge requirement on the New User Registration form (NewUserRegistration.html) and Lending New User Registration form (LendingNewUserRegistration.html) when a captcha integration has been configured in the ILLiad Customization Manager. 

Added a WebCookieSameSite customization key to the ILLiad Customization Manager under Web Interface | System that will set the SameSite property value on the session ID cookie that is generated in the user's web browser on login to the ILLiad web interface. Valid options are None, Lax, and Strict.

Users will no longer be able to register for an ILLiad account from the TestWeb directory to prevent bot-driven spam account creation from the ILLiad TestWeb web pages. User registration will be disabled by default for the web pages in the TestWeb directory upon update and cannot be re-enabled.

Expanded the maximum length of the AuthUser and AuthPass fields in the ZServerConfig database table to 100 characters. These fields display as the Username and Password fields on Z39.50 server configuration form in the ILLiad Customization Manager.

The ILLiad Connection Manager will now add a note to the ILLiad request if the lending string on the ILLiad request is modified when sending the request to OCLC (e.g., in the case that a symbol was removed because the lender is a non-supplier or because the symbol is invalid). The note will include detailed information about which lending symbols were modified/removed for troubleshooting purposes.

Fixed a security vulnerability present in the ILLiad Connection Manager.

Modified NewUserRegistration.html to include the new <CAPTCHA> tag and added the following new files to the default web pages to implement captcha support on the New User Registration form:

• include_captcha_none.html
• include_hcaptcha.html
• include_mtcaptcha.html
• include_recaptcha_v2_checkbox.html
• include_recaptcha_v2_invisible.html
• include_recaptcha_v3.html

Removed the unused and deprecated Lending\js\userNotificationPreferences.js file from the default Lending web pages. Bug# 18086

Updated the hardcoded copyright year on the web pages to 2023.

Changed the default colors used for hyperlinks added to the cookie consent banner (Bug# 18485), web alert titles (Bug# 18774), and fields that fail server validation when a form is submitted (Bug# 18767) to address contrast issues against the default web page background colors.

Reordered the list of stylesheet links contained in include_head.html to improve the consistency of the code within this file.

Fixed an issue where tracking entries for requests on the ILLiad web pages were not converted to the local timezone and would sometimes display at a different time than what was shown in the ILLiad Client. Bug# 20739

Corrected outdated information on the Borrowing and Lending FAQ pages regarding web browser and cookie requirements for using the ILLiad web pages. Bug# 18265

Fixed several issues affecting the modal dialog used for web alerts:

• Added a missing 'type' attribute to the Close buttons to ensure that they always work as expected
• Fixed a broken 'aria-labelledby' attribute causing an accessibility issue (Bug# 18775)

Fixed improperly formatted label elements on the Lending web pages that prevented some fields from being read out to screen reader users. Bug# 20405

Realigned the Actions menu dropdown options contained in the DataRow template files to fix an issue where this menu was not fully visible on smaller display sizes. Bug# 18916

Fixed several issues affecting the transaction menu (include_TransactionMenu.html):

• Fixed an issue where the menu was not fully visible on smaller display sizes and contained inconsistently formatted buttons Bug# 17956/Bug# 18918
• Added an underline on hover to its enabled menu buttons for better consistency with other buttons on the ILLiad web pages

Updated the JavaScript used in the ILLiad web pages to persist a user's previously selected values in dropdown menus, radio buttons, and checkboxes to resolve the following issues:

• Fixed an issue where the search type checkbox toggle switch that is hidden by default on the search web pages (ViewSearchResults.html and LendingViewSearchResults.html) would not correctly filter search results to include active requests only when enabled Bug# 19970
• Fixed an issue where values would not persist properly on the web pages when using Safari or other WebKit-based web browsers Bug# 14597

Fixed an issue where some small notes attached to fields on web forms were not read automatically by screen readers and also removed unused 'aria-describedby' attributes causing accessibility issues on the Change Password web pages (ChangePassword.html and LendingChangePassword.html). Bug# 19935

The ILLiad DOCLINE Lua Scripts bundle will now include two sets of scripts to ensure that the most recent version of the scripts is backward compatible with prior versions of the ILLiad Client that do not support the new WebView2 embedded browser controls released with ILLiad Client v9.2.4/9.2.5: 

• WebView2 versions of the scripts that will use the new embedded WebView2 browser in the ILLiad Client to display DOCLINE forms and controls if the currently installed version of the ILLiad Client is v9.2.4 (or later)
• Chromium versions of the scripts that will use the embedded Chromium browser to display DOCLINE forms and controls if the ILLiad Client is on an earlier version (i.e., v9.2.3 or prior) that does not include support for the WebView2 controls

When the v5.0.0 DOCLINE Scripts update is performed, both the WebView2 and Chromium versions of these scripts will be downloaded to the same DOCLINE Script directory on the local machine. The ILLiad Client will then determine which set of v5.0.0 DOCLINE scripts to load based on the version of the ILLiad Client that is currently installed. 

The Import All button will now import all DOCLINE lending requests starting from the bottom service level link. Previously these requests would be imported starting from the top service level link.

The Import All button will now import all DOCLINE lending requests for each receipt page before attempting to mark receipted to ensure that page navigation does not interrupt the import process.

The session cookie generated by the Atlas Auth Portal will now include SameSite and Secure properties to address login persistence issues experienced in other Atlas products that were caused by the recent SameSite cookie changes rolled out by Google Chrome and other web browsers. Note that these issues do not yet affect ILLiad and the changes to the session cookie in this release were made to provide consistent handling for this cookie across Atlas products. 

Added support for the new Chromium-based Microsoft Edge WebView2 embedded browser within the ILLiad Client and Client addons. Support for the WebView2 browser will include the following enhancements:

• Easier updating process: The WebView2 browser is updated via the Windows Update process on your local machine, removing the need to update the version of the browser used by ILLiad by manually updating the ILLiad Client.
• Accessible version tracking: The version of WebView2 currently installed on your machine and used by ILLiad can be easily checked by navigating to the Resources tab located within the ILLiad Options form in the ILLiad Client. 
• New cache clearing options for easier debugging: A Clear Cache button is available next to the WebView2 version number information on the ILLiad Options form that will clear the cache for the WebView2 browser (cookies, logins, and browser history) on the local machine for the user currently logged into the ILLiad Client.

Several addons have been updated to use the WebView2 browser and are available for download in the ILLiad Addon Directory. Users of these addons will need to update the addons before or shortly after installing the ILLiad Client v9.2.5 update to ensure full compatibility with the new Client version. See the complete list of the addons requiring updates in the Action Required: Update Existing Addons section at the top of the release notes.

Forms and windows in the ILLiad Client that were previously rendered using Chromium browser controls have been updated to use new WebView2 controls including:

• All DOCLINE forms and controls
• The OCLC Policies Directory window

Updated the citation controls located within the Z39.50, OCLC, and DOCLINE search interfaces on the Request form to display citation information in rich text format.

Fixed issues caused by a third-party component in the ILLiad Client after the v9.2.4 update.

Updated the names used for the default statuses/queues monitored by ILLiad to send and process requests through the Automated Request Manager (ARM) and the language used to refer to ARM in ILLiad log statements in order to standardize the name used for this service across OCLC and ILLiad:

• Changed the name of the default queue used to send requests to ARM from Awaiting Direct Request Sending status to Awaiting ARM Sending 
• Changed the name of the default queue used to indicate an ILLiad request has been sent to ARM and is awaiting lenders from Awaiting Direct Request Lenders status to Awaiting ARM Response 
• ILLiad log statements relevant to the ARM service will now use the term ARM in place of Direct Request

Added support for configuring more granular ARM automation matches between OCLC and ILLiad using the new ARMMatchField customization key located in the ILLiad Customization Manager under Borrowing | Direct Request. 

Changed the following behavior in the default ARM workflow to support more varied and enhanced workflow options when using ILLiad with ARM:

• When a request is routed to review by ARM, either through an ARM automation action set to Route Request to Review or in the case that a request is sent to lenders by ARM but returns unfilled:
  • The associated ILLiad request will now be routed to the new Awaiting ARM Manual Review queue instead of the Awaiting Request Processing queue
  • If a lending string was created for the request by ARM, it will now be retained on the ILLiad request and will no longer be overwritten with "Direct Request," allowing staff to manually review the constructed lending string before sending the request out to lenders
• If a lending string is created for the request at any point during ARM processing, a History entry will be added to the ILLiad request with the lending string value
• If an error occurs during ARM processing, the error message will now be added to the ILLiad transaction notes

Added new indexes to the Transactions database table to improve the performance of the ILLiad application:

• Changed the primary key for the Transaction table from a nonclustered to a clustered index to speed up data processing and retrieval 
• CreationDate index: Improves performance when running copyright journal queries and when querying transactions for web reports
• Username index: Improves performance when querying for transactions based on username
• RequestType index: Improves performance when using the Decision Support Pipeline, printing functions, and routing rules to process requests
• ILLNumber index: Improves performance for DOCLINE, RAPID, and Scanning form lookups
• PhotoJournalTitle index: Improves performance when running the standard copyright journal "rule of 5" query to process copyright requirements for requests

The Connection Manager will now retrieve and download all Lending requests (regardless of the time last modified) in the OCLC status PENDING every ten minutes immediately after checking for modified requests over that time interval to fix issues where errors occurring during the 10-minute update process could lead to those PENDING requests being skipped and not retrieved until the next scheduled run of the Connection Manager's resync process (occurring every 12 hours).

Errors occurring within OCLC that prevent the successful processing of a request in ILLiad (e.g., in the case that any of the citation information on the OCLC request contains a special character in the text that cannot be processed by WorldShare) will now be displayed as errors in the Connection Manager logs instead of as debug-level messages for better visibility and easier troubleshooting:

Upon update, ILLiad will check for any deprecated database indexes left over from previous versions of ILLiad that have since been re-implemented under different names and remove them from the database, if present.

Fixed various issues on the Lending and Borrowing default web pages as described below. For more information on implementing each fix, see Implementing 9.2 Web Page Changes. 

• Fixed an issue where the Lending\LendingLogon2.html and Lending\LendingFirstTime.html files did not reference the include_header.html file and instead included a hardcoded header from an older version of the ILLiad web pages. Bug# 25879
• Fixed an issue where the Profile dropdown menu located in the navigation bar used by the Lending web pages (Lending\include_nav.html and Lending\include_nav_search.html) was missing the horizontal line divider between the menu items in the dropdown and the "Logged in as" information. Bug# 25894
• Removed FORMSTATE tags (<#FORMSTATE>) from the default Lending web pages as this tag is not used by the ILLiad Lending Web DLL and is unnecessary on the Lending web pages. Bug# 25896
• Fixed issues where the edit form for the default patent request form (EditPatentRequest.html) was missing the hidden input for the Transaction Number field and referenced the incorrect ILLiad form name in the code, affecting the functionality of the web form. Bug# 25897
• Updated the default contact email address and phone number used on the FAQ and Electronic Delivery Information pages (Lending\LendingFAQ.html, FAQ.html, ElectronicDeliveryInformation.html) to pull in email address and phone information from the relevant LendingEMailAddress, BorrowingEMailAddress, LendingPhone, and BorrowingPhone values configured in the LocalInfo table in the ILLiad Customization Manager and updated an outdated URL on the Electronic Delivery Information page.
• Updated the 'name' attribute used on <form> elements across the default web pages to instead use the 'id' attribute due to the deprecation of the use of the 'name' attribute for these elements. 

Fixed an issue where DOCLINE lending requests would not import into ILLiad after the DOCLINE v6.2.50 update.

Resolved a version conflict issue in the previous version of the DOCLINE LUA Scripts (v5.0.1) that could prevent the scripts from properly updating via the DOCLINE Automatic Updater.

Fixed various issues on the Lending and Borrowing default web pages as described below. For more information on implementing each fix, see Implementing 9.2 Web Page Changes. 

• Removed unnecessary FORMSTATE tags (<#FORMSTATE>) from default request forms in the Borrowing web pages. Bug# 25397
• Updated the hardcoded copyright year in the Borrowing and Lending web pages to 2024.
• Fixed an issue where disabled action buttons for transactions on the ILLiad web interface could still be activated using keyboard controls, allowing users to perform actions such as resubmitting finished requests. Bug# 18919
• Updated CSS files in the Borrowing and Lending default web pages to support automated code minification by internal Atlas Systems tools.
• Changed underlined text used for emphasis on the Borrowing and Lending search results web pages (ViewSearchResults.html & Lending\LendingViewSearchResults.html) to instead use bolded text to adhere to W3C HTML5 guidelines. Bug# 17980
• Encoded ampersands used in the code for HTML attribute values on various Borrowing and Lending default web pages. Bug# 11203
• Removed a duplicate instance of the Item Author field from the detailed transaction information page in the Borrowing and Lending web pages. Bug# 10618
• Updated the quotation mark format used for attribute values in certain DLL tags across the Borrowing and Lending web pages to adhere to best coding practices. 
• Updated the buildSiteMap.js file in the Lending and Borrowing web pages to fix an issue where empty hyperlinks would be generated in the site map if a hyperlinked image was added to the footer (include_footer.html or Lending\include_footer.html).
• Fixed an incorrect ERROR tag (<#ERROR>) parameter for the Title field (database field name: PhotoJournalTitle) on the Edit Patent Request form (EditPatentRequest.html). Bug# 14817
• Commented out the default Format field on the Multimedia Request form and its corresponding edit form (MultimediaRequest.html and EditMultimediaRequest.html) to address an issue where data entered into this field is not saved to the database by default upon form submission. Bug# 5852

Updated the ILLiad Borrowing and Lending web pages to rename some of the account management-related features for clarity and to ensure naming consistency across the web pages:

• The Profile dropdown in both the Borrowing and Lending navigation menus was renamed Account Info
• The option within the Profile dropdown menu in the Borrowing web pages to navigate to the ChangeUserInformation.html page was changed from Update Profile to Update User Information
• The option within the Profile dropdown menu in the Lending web pages to navigate to the Lending\LendingUpdateAddressInformation.html page was changed from Update Profile to Update Address Information
• The page title and page header on ChangeUserInformation.html and Lending\LendingUpdateAddressInformation.html were changed to match the new names for the options to navigate to these pages in the Profile dropdown menu (as described above)

For more information on implementing each change, see Implementing 9.2 Web Page Changes. 

The following changes have been made to the layout and style used to format the ILLiad Borrowing and Lending 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:

• The following elements are now hidden when the web page is printed:
  • Action buttons (e.g., Edit, Cancel, etc.) on web pages containing transaction details
  • Buttons included in the DataRow template files (e.g., Details, Action, etc.)
  • The "Skip to main content" link
  • Web alerts
• Form fields are now formatted with a black border color and black text when printed to enhance color contrast
• Buttons and badges are now formatted with a white background color and black text when printed to enhance color contrast
• Increased the font size used for body text on print layouts from 10pt to 11pt
• Implemented missing print styling on the Logon.html web page so that this page is now properly formatted when printed

For more information on implementing each change, see Implementing 9.2 Web Page Changes. 

Added new minified versions of most default JavaScript and CSS files used in the ILLiad Borrowing and Lending web pages and updated all relevant web page files to use the new minified files in order to optimize the performance of the ILLiad 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 new default Borrowing and Lending web pages alongside the original un-minified version of each file. 

For more information on implementing these new files, see Implementing 9.2 Web Page Changes. 

Includes fixes to resolve Copyright Clearance Center issues experienced by some users after the v9.2.7 update.