1. Atlas Systems
  2. ILLiad
  3. Release Notes

ILLiad 9.2 Release Notes

Print Friendly and PDF Follow

Avatar
Brittany De Gail
Updated

Important Update Information

Released March 22, 2022

Highlights      

As promised on the ILLiad Product Roadmap, here are the main features/enhancements of ILLiad v9.2:

There are over 30 bug fixes and several underlying component updates to continue supporting external systems in this release.      

Considerations Before You Update         

Review ILLiad v9.2 FAQ   

For frequently asked questions and additional information regarding the 9.2 features and fixes, please see the ILLiad 9.2 FAQ. 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 ILLiad 9.2. For specific instructions on updating, see Updating ILLiad to the Newest Version.

If updating from a previous version of ILLiad, the ILLiad Client must be opened using the Run as Administrator option after the server update is completed to ensure that the Client update process is successful.

ILLiad Client v9.2 requires Microsoft Visual C++ 2019 Redistributable in order to use the latest version of the embedded Chromium browser. This component will be installed automatically by the 9.2 Client Installer to ensure compatibility.

Installation Procedures

If you are performing a fresh install of ILLiad 9.2 rather than updating from a previous version, please note that running the 9.2 Server Installer will no longer also download the 9.2 Client Installer. This installer will need to be downloaded from the ILLiad Downloads page and run separately. 

Manual ISO Service Upgrade

The ISO Service will require a manual upgrade after the 9.2 update. For more information and instructions on upgrading, see 9.2 ISO Service Upgrade.

End of Support for Windows 7 

As of v9.2, Windows 7 is no longer a supported operating system. The minimum required operating system for ILLiad is now Windows 8.1.

Point Releases 

Bug fixes and new features are added periodically as point releases. See 9.2.x point releases below:

For a list of current known issues, see UserVoice.

ILLiad 9.2 Features & Fixes    

Addons | Administrative | API | Authentication | Copyright | Customization Manager | Database | Decision Support Pipeline | DOCLINE | Email | ISO | OCLC | Odyssey | SQL Alias Manager | Staff Client | Staff Manager | System Manager | Web Interface | Web Platform 

Addons   

Changed

Atlas addons are no longer installed by default when installing ILLiad.

If you are updating ILLiad from a prior version to version 9.2, no action is needed. Your default addons will be backed up to whichever version of each addon you have installed prior to updating and restored during the update process.

If you are performing a fresh install of ILLiad at version 9.2, you will need to manually download and install your desired addons from the Addon Directory. Please also ensure that you download the Atlas Helpers Library and install it to your C:\Program Files (x86)\ILLiad\Addons\Atlas\ directory as it contains helper methods for required for various ILLiad addons to run properly. 
Changed

Updated the embedded Chromium browser used by addons to the latest CEFSharp package version for security and performance enhancements.

Action Required: Updating Existing Addons

An addon has been updated to use the new Chromium version and should be re-installed at the latest version upon updating ILLiad to v9.2 to fix compatibility issues:
Changed

Added the ability to download PDFs and other files directly from within the embedded Chromium browser using the browser's file download button.
Fixed

Fixed an issue where the database connection created by a Client addon after opening its relevant form in the Client would not be closed upon closing that form.
Fixed

Fixed an issue where addons using the Chromium browser would display incorrectly aligned on high-DPI monitors. Bug# 13103

Administrative

Changed

Updated the log4net component used in several ILLiad services and applications to the latest secure version (v2.0.14). 
Fixed

Updated the DevExpress libraries used by the ILLiad Client and the Odyssey Manager's Atlas PDF Utility to fix issues with handling and opening certain PDFs.

API

New

Added new endpoints to the Web API to retrieve all currently defined web display status rules and to retrieve web display statuses defined for a specific transaction number, NVTGC, process type, or transaction status. For more information, see the Web Display Status section of the ILLiad Web Platform API article. 
Fixed

Fixed an issue where the Create User API endpoint would not create new users with a valid delivery location in the NVTGC field. Bug# 13156

Authentication

New

Added a built-in module to provide integrated support for remote authentication via Security Assertion Markup Language (SAML). The integrated SAML module removes the need to install additional software on the ILLiad Server to communicate with authentication systems based on SAML, such as Shibboleth and OpenAthens. For more information on configuring remote authentication using this module, see RemoteAuth: Configuring the SAML Module.

SAML v1.0.1.1 will be added to the ILLiad Server Updater as a new component when updating to or installing the ILLiad 9.2 Server. During the server installation/update process, the files used to configure and install the module on the ILLiad Server will be downloaded to the default path C:\ILLiad\SAML.
Note: If you have already configured Shibboleth or another SAML-based system to work with ILLiad you should continue using your existing solution upon updating to ILLiad v9.2. The integrated SAML module is intended as a solution for those unable to install their Service Provider module on the ILLiad Server.
New

Added a "replace" action to the available options for the ValidAction field entry in the RemoteAuthValidation table. This action allows you to use regular expressions to modify the incoming remote field value before it is written to the ILLiad database. For more information, see Authentication Enhancements: RemoteAuthValidation Table. 

Copyright

New

Updated ILLiad to use the new Copyright Clearance Center (CCC) web service in order to keep integration with this service functional. The changes made by the CCC to the APIs used in its new web service have required several changes to the CCC configuration settings in the ILLiad Customization Manager and to the copyright search and ordering process and controls in the ILLiad Client.

Please review the ILLiad Copyright Processing Changes After the CCC Web Service Update for complete information on each of these changes.

CCC Account Now Required for Searching

The CCC no longer supports anonymous searching, meaning that you will need to create a CCC Marketplace account if your institution does not have one already in order to perform CCC searches in ILLiad. If your institution does not use ILLiad to perform CCC copyright searches and orders, then you will not need to set up a CCC Marketplace account after updating. For more information on using the Process Copyright screen with a CCC account after the update, see Using ILLiad Copyright Processing Without a CCC Marketplace Account After the 9.1.4/9.2 Update.

After the account is created, you must configure it to work with ILLiad using the CCCUsername and CCCPassword keys in the ILLiad Customization Manager. Accounts can be created on the CCC's website:

  • Note that when creating an account, you will need to select to create a corporate account and not an individual account. If your existing CCC account is an individual account, you will need to create a separate corporate account to use with ILLiad.
  • After creating your account, you will need to contact the CCC to request to switch your default payment method to invoice. If your payment method is not switched, you will not be able to submit copyright orders through ILLiad. All new accounts created within the past 6 months will need to complete this step before processing copyright orders.
RightsLink accounts are not compatible with the new CCC web service. If your existing account is a RightsLink account, you will need to create a new CCC Marketplace account following the instructions above.
Before creating a new CCC account, please attempt to log into the CCC Marketplace using existing credentials or use the "Forgot your password?" option if you have forgotten your password. Please only create a new CCC account if you cannot find your username or if you have never previously registered for an account.

The following configuration settings have changed in the ILLiad Customization Manager:

  • If not already configured, the CCCUsername and CCCPassword customization keys (located under Borrowing | Copyright) will need to contain valid CCC account information for your institution. 
  • All CCC orders must now include a billing address, which is drawn from the BillingAddress fields for each ILLiad site configured in the Customization Manager's LocalInfo table. Please ensure that these fields are filled out and that they match the billing address on your CCC Marketplace account.

  • If your institution operates in multiple countries, your institutional CCC account may contain multiple Location IDs that will now need to be configured in the ILLiad Customization Manager. Please see the ILLiad Copyright Processing Changes After the CCC Web Service Update article for more information.

    If your institution only operates in a single country, you will not need to configure additional location information after the update.

The following changes were made to the copyright search and ordering process in the ILLiad Client:

  • Searching now requires valid CCC account credentials to be configured in the ILLiad Customization Manager (i.e., searches cannot be performed anonymously). If your CCC credentials are invalid, you will see an error message stating "Error communicating with CCC." upon attempting a copyright search.
  • Removed the option to search by Publisher or by multiple parameters at once from the Copyright search interface.
  • Searching will now only return one rightsholder for the item selected automatically by the CCC based on the publication year.
  • Items for which it is not possible to determine permissions or copyright costs or for which a special order is required will no longer be returned in search results.
  • The Granted status previously returned in Right field for search results has been changed to Licensing Available. 

  • Copyright orders containing multiple transactions will no longer be grouped under a single invoice number contained in the Order Header field when submitted. Each transaction will only be assigned a unique Order Detail number when the copyright order is placed and these transactions will be grouped into separate invoices by the CCC for payment based on a frequency setting configured on your CCC account. Please see Copyright Order Handling Changes for more information.

    Pre-existing transactions in the ILLiad database will have their OrderHeader and OrderDetail field values combined upon updating to v9.2. See the Database section for more information.
  • Removed the Order Status dropdown button and the Cancel Order button from the Borrowing Request form.
  • Added new Copyright Order and Order Placed fields on the Borrowing Request form and changed the label of the "CCC Number" number field to "CCC Publication ID" for additional clarity.

The following changes were made to the ILLiad Copyright Web Reports:

  • Renamed the CCC Number column to CCC Publication ID, renamed the Order Detail column to CCC Order Number, and removed the Order Header column from the Copyright web reports.
New

Added the CCCLocation customization key to the ILLiad Customization Manager under Borrowing | Copyright that allows institutions operating in multiple countries to configure a specific CCC Location ID for each ILLiad site. 

Institutions operating ILLiad sites in only a single country should not adjust the value in this key.
New

Added the CCCSupportPage customization key to the ILLiad Customization Manager under Borrowing | Copyright to hold the URL for the Atlas Support page containing detailed CCC-related troubleshooting information. 
Fixed

Added additional detail to the CCC-related error messages displayed by the ILLiad Client to facilitate troubleshooting. Each error message will also contain a link to the Atlas Support page containing further troubleshooting information, configured in the CCCSupportPage customization key described above.
Fixed Updated the value of the CCCHomePage customization key used to open the Copyright Clearance Center's home page from the Staff Client to https://www.copyright.com/ to ensure that the link does not break due to future URL changes. Bug# 12120

Customization Manager

Fixed Changed the color of the three-line application menu button (the "hamburger" button) on the Office 2019 skin to make it visible. This change also applies to the Staff Client and Staff Manager. Bug# 5890
Fixed Fixed an issue where updating a customization key on a Shared Server site would only add a customization tracking entry for one NVTGC.
Fixed Added missing descriptions for the RenewalWindowDays, ISOCanSendReceived, ISOCanSendReturned, ISOCurrencyCode, and ISOMonetaryValue customization keys. Bug# 4569

Database

Changed

Upon updating to v9.2, any pre-existing values within the OrderHeader and OrderDetail fields in the CopyrightSessions table will be combined into one value in the OrderDetail field due to the Copyright Clearance Center's decision to no longer use the OrderHeader field to store copyright order information:

  • If there is no value in the OrderDetail field for a transaction, then the value in the OrderHeader will be copied into the OrderDetail field.
  • If both the OrderHeader and OrderDetail fields contain values, those values will be concatenated as one value in the OrderDetail field, with a format of <OrderHeader> / <OrderDetail>.

In either case, after the OrderHeader values are moved into the OrderDetail field, the OrderHeader field will be cleared out (i.e., it will contain a value of ""). 
Changed

Removed the unused ClientAccess table from the database.

Note: This table was deprecated in ILLiad v8.1 and its removal will not require any additional action or changes by new or existing ILLiad installations. 
Changed

Expanded the maximum length of the RemoteFieldName field in the RemoteAuthValidation table to 1024 characters. 
Fixed Removed a constraint from the database that limited to RequestType values to either "Article" or "Loan" to fix performance issues with the ISO Service. 
Fixed

Expanded the maximum length of the AddedBy field in the Notes and LibraryNotes tables and the Staff field in the TestModeInvoicePayments and TestModeInvoiceTracking tables to 100 characters to match similar Username fields in other database tables. Bug# 4912/4913

Decision Support Pipeline   

Fixed

Fixed an issue where the tooltip for the Select Recommended Action button would not update with the appropriate addon after switching between requests on the Pipeline Request Review form. Bug# 5643
Fixed

Fixed an issue where requests were not being routed to Awaiting Pipeline Error Review if the relevant Decision Support Pipeline addon encountered an error during execution. In these cases, requests will now be routed to that queue and a History entry containing the error message will be added to the request.
Fixed

Fixed an issue where DSP business rules with the Target Type Route would route all requests to the target queue regardless of the conditions entered in the rule's match string. Route type business rules will now only generate a recommended or automatic action for requests that satisfy the conditions in the rule's match string.
Fixed

Fixed an issue where DSP business rules with the Target Type Route and Rule Type Automatic would not automatically route a request if no fulfillment data was generated for that request.

DOCLINE 

Action Required: DOCLINE Login Methods

The 9.2 release will include support for the Chromium browser. This will fix all DOCLINE login methods impacted by the depreciation of IE, however, Google accounts will NOT work after updating to v9.2 due to Google no longer allowing authentication via embedded browsers. For more details, see DOCLINE Login Methods Before and After the 9.2 Update. Please also see Google's reasoning for this change.
New

Updated the ILLiad DOCLINE Lua Scripts to version 4.0.1.

Note: Performing the 9.2.1 ILLiad Client update will install DOCLINE Scripts v4.0.0. After the update is completed, running the Client will automatically prompt you to update these scripts to the latest version, v4.0.1. 
New

Added new statements to the ILLiad Client logs to help troubleshoot DOCLINE issues:

  • Upon startup, logs will indicate the version of the DOCLINE scripts that the Client is currently running and the latest version of DOCLINE scripts available. 
  • When processing Borrowing requests, logs will indicate the path of the doclineToc.xml file that is loaded and the paths of the DOCLINE Lua files used by the Client.
Changed

Updated the DOCLINE Borrowing and Lending forms to use the embedded Chromium browser in the ILLiad Client. 

The appearance and functionality of the forms will be unchanged upon update.
Changed

Removed the DoclineUsername and DoclinePassword customization keys from the Customization Manager. Please see DOCLINE Login Methods Before and After the 9.2 Update for information on the login methods supported in the 9.2 ILLiad Client.
Fixed

Fixed an issue where volume/issue and page numbers were not imported when there were non-numeric values in the DOCLINE Citation field (e.g., supplemental issues, roman numerals, etc). Bug# 6539
Fixed

Fixed an issue that prevented ILLiad from loading new DOCLINE scripts installed by the DOCLINE Automatic Updater. DOCLINE script updates can now be performed automatically without manual intervention if the Automatic Updater is enabled. Bug# 11198

Email

Fixed

Fixed an issue that prevented Shared Server sites from using the email importing feature for user creation. Bug# 4441

ISO

Fixed

Updated the ISO Service to version 9.2.2 to patch a potential security vulnerability found in the log4j component and to update this component to the latest version (v2.17.1). 

The ISO Service will require a manual upgrade after the 9.2 update. For more information and instructions on upgrading, see 9.2 ISO Service Upgrade.
Fixed

Fixed an issue where institutions whose SQL servers use both named instances and nonstandard ports would experience connection issues to the database after upgrading their ISO Service.

OCLC

New

Updated ILLiad to use v2.2 of the OCLC Web Service.
New

Added new fields for Language and Format on the OCLC Work Form in the ILLiad Client. These fields are read-only in ILLiad and will contain information imported from the item's OCLC record.
Fixed

Added support for two additional OCLC "Reasons for No" to the Connection Manager that can be used to communicate a reason for cancellation to the requesting library (Bug# 5932):

  • On Reserve (OCLC Code 11)
  • Publisher Embargo (OCLC Code 25)

The new codes (11, 25) will be automatically added to the LendingReasonsForCancellation table in the ILLiad Customization Manager upon update if they are not already defined.

Odyssey

Fixed

Fixed an issue that prevented the System Manager's Item Cleanup process from deleting any Odyssey documents that had been received and deleted in the Client before ever being matched to a transaction number (such as in the case where the document received was incorrect or the document was sent to the incorrect recipient). Bug# 6560
Fixed Fixed an issue where the Delete button was disabled for corrupted files in Electronic Delivery Processing. Bug# 3583
Fixed Fixed an issue where some TIFF files were resized to 8.5x11" and forced into portrait orientation after converting the file to PDF. Bug# 9690

Staff Client

Fixed

Fixed an issue where any customizations made to the columns in the Z39.50 Search and Holdings grids would reset when the Client was closed. Bug# 5470
Fixed

Fixed two issues where new custom queues were not added to the list of existing queues in alphabetical order by default and where a custom queue would sometimes be added to a duplicate Requests category instead of the existing one. The default order of the queues in the Borrowing tab has also been fixed to display in the proper alphabetical order. Bug# 5642

Note: This fix will not apply to any queues that have been manually reordered and saved in a custom layout and also will not merge any pre-existing duplicate Request groups automatically. Existing duplicate Request groups can be merged by manually dragging queues from one group into the other.
Fixed Changed the color of the three-line application menu button (the "hamburger" button) on the Office 2019 skin to make it visible. This change also applies to the Customization and Staff Managers. Bug# 5890
Fixed Fixed an issue where attempting to log into the Client with a valid username but without entering a password would display an error message. A more descriptive message box will now display instead. Bug# 8363
Fixed Fixed an issue where the PDF Document Processor on the Scanning and Electronic Delivery forms would not close PDF files until the Client was closed, prompting an error stating that the file was in use by another process if attempting to use that file elsewhere. Bug# 8578
Fixed Fixed an issue that would occasionally cause a null reference exception error when opening the Overdues list in the Client. Bug# 8564

SQL Alias Manager

New

Updated the SQL Alias Manager (SAM) to v1.3.2 to patch a security issue found in one of its external dependencies. 

Note: The updated version of the SAM contains a new Set Default (Current User) option that allows different Windows accounts on the same machine to use different DBC files. However, this functionality is not yet supported in ILLiad, meaning that the DBC file should be configured and set at the machine level using the Set Default (Local Machine) option, and the Set Default (Local Machine) option should not be used. See Atlas SQL Alias Manager for more information.

Staff Manager

Fixed

Changed the color of the three-line application menu button (the "hamburger" button) on the Office 2019 skin to make it visible. This change also applies to the Customization Manager and Staff Client. Bug# 5890

System Manager

New Added functionality for IFM API transactions in the System Manager that will be used for future integrations.
Fixed Fixed an issue where the System Manager would fail to send a Borrowing overdue notice if the associated NVTGC or delivery location code contained an apostrophe. Bug# 4474

Web Interface

Fixed

Fixed an issue that prevented multi-line web alerts from displaying on the web pages. Bug# 7172
Fixed

Changed the 'display' attribute to 'displayStyle' in the default web pages to fix an issue where transaction notes would display the incorrect date and time on the web. For more information, see Implementing 9.2 Web Page Release Changes. Bug# 7847

The 'display' attribute is still currently supported in the 9.2 web pages, but the new 'displayStyle' attribute is preferred for optimal performance and to ensure compatibility with new functionality in future updates. 
Fixed

Fixed an issue where notification preferences were not set for new users created via the UserValidation table.

Upon updating to v9.2, any users previously affected by this issue will have their notification preference set to the default value of "Electronic."
Fixed

Fixed an issue preventing web alerts of certain types from displaying on the web pages when generated through AJAX. Bug# 5893
Fixed

Fixed a potential security vulnerability found during a web application scan.

Web Platform

Fixed

Fixed an issue in Web Reports that could lead to server errors when using certain data sets. Bug# 3674

ILLiad 9.2.x Point Release Notes

06 April 2021 (4.0.2) DOCLINE Scripts Release

The DOCLINE LUA Scripts on the ILLiad Downloads page have been updated with the latest version (4.0.2).

Update Procedure

To implement these changes:

  • DOCLINE Automatic Updater - If you enabled the auto-updater, the client will prompt to update as soon as the new scripts become available. If you just enabled the updater keys recently, you may need to close and re-open the client to receive the prompt. 
  • Manually replacing the scripts - Download the scripts and replace the current scripts (default location: C:\ProgramData\ILLiad\Docline\). Note: depending on your institution's setup, you may need administrative privileges to replace the scripts and/or may need to contact your local IT support for assistance. 
Fixed

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

14 April 2022 (9.2.2) Web Platform and (9.2.1) Odyssey Manager Server Release

The ILLiad Web Platform has been updated to a new version (9.2.2) in order to add new functionality to the ILLiad Web Platform API that strengthens integration with external systems. The Odyssey Manager has also been updated to v9.2.1 to implement a bug fix.

Update Procedure

To implement these changes, please run the ILLiad Server Updater located at C:\ILLiad\Admin\ILLiadUpdate if self-hosted, or request an update from your hosting provider. Atlas-hosted sites will be contacted by Atlas Support via email and updated automatically as soon as possible.

Note: Please restart the IIS service when the server update is complete.

New

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. 
Fixed

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.

Note: The previous version of log4net used by the AtlasPDF tool (v2.0.12) is not subject to the security vulnerabilities found and addressed in prior versions of log4net. An urgent update is not required.

18 April 2022 (9.2.2) ILLiad Client Update

The ILLiad Client has been updated to a new version (9.2.2) to implement several bug fixes.

Update Procedure

To implement these changes, follow the automatic updater prompts that will display upon opening the ILLiad Client, or download and install the latest Client application from the ILLiad Downloads page.

Changed

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. 
Fixed

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

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

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\). 

18 April 2022 (4.0.4) DOCLINE Scripts Release

The DOCLINE LUA Scripts on the ILLiad Downloads page have been updated with the latest version (4.0.4) to implement several bug fixes.

Update Procedure

To implement these changes:

  • DOCLINE Automatic Updater - If you enabled the auto-updater, the client will prompt to update as soon as the new scripts become available. If you just enabled the updater keys recently, you may need to close and re-open the client to receive the prompt. 
  • Manually replacing the scripts - Download the scripts and replace the current scripts (default location: C:\ProgramData\ILLiad\Docline\). Note: depending on your institution's setup, you may need administrative privileges to replace the scripts and/or may need to contact your local IT support for assistance. 
Fixed

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

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

Questions?

If this article didn’t resolve your issue, please contact Atlas Support for assistance:

Contact Support

Articles in this section