Didn't find what you were looking for?

Email questions or documentation suggestions to info@projectreshare.org.

ReShare 1.13 release notes


Release date: August 2023 (1.13), September 2023 (1.13.1) **

Summary: This release introduces functionality to support Controlled Digital Lending (CDL) as another method of resource sharing within ReShare. In addition to the new CDL feature, there are 8 enhancements/improvements, 2 bug fixes, and 3 non-functional changes.

** Release 1.13 / 1.13.1 is currently being used in a pilot environment for CDL

New features

Support for Controlled Digital Lending (CDL)

  • A new state model / workflow has been developed in release 1.13 to support the consortial lending of digital objects in ReShare.

  • Requests that contain a delivery method of URL are marked for controlled digital lending.

  • The autoresponder checks to see that the requested item is available and on the shelf for the current lender in the rota to ensure the own to loan ratio.

  • Lending staff pull the item from the shelf to scan and/or sequester it. The item is checked out in the ILS to ensure that if another request is placed on the item that lender is not added to the rota to ensure the own to loan ratio.

  • The due date returned from the ILS is the date the loaned digital item will be completed and the requesting patron will no longer be able to access the material.

  • ReShare integrates with Hyku, an open source digital repository system. Scanning of a requested item is done outside of ReShare and then uploaded into Hyku as a digital work. Staff then review and approve the digital works in Hyku.

  • When filling a ReShare loan request digitally, lending staff search Hyku to find the URL to the digital work they are being asked to loan. Then they copy and paste the digital object’s URL into the URL field in the ReShare request.

  • Requesting libraries can create a notice template to alert patrons when a digital loan is ready to access. A new token for the digital object’s URL can be added to the template and the notice can be triggered on a new state of Loaned digitally.

  • The patron will need to authenticate in VuFind in order to access the digital object. Once authenticated in VuFind, a new listing titled ‘Digital loans’ will display all active loans along with the URL to access them in Hyku and their due date.

  • Once the due date is reached and the loan is no longer active the item is removed from the patron’s ‘Digital loans’ list and marked complete on the requesting side. Note: this same behavior will happen for returnable (non-digital) loans that are listed. Once the library has marked the material ‘return shipped’ the item will disappear from the patron’s list of active loans.

  • The item is moved to a state of ‘Awaiting desequestration’ on the lender’s side. Lending staff complete the item in ReShare to check the item back into their ILS.


WMS/WMS2 adapters improved to use the library’s local OCLC number when checking for availability (1.13.1)

  • Prior to release 1.13 the WMS/WMS2 adapters used an OCLC number taken from the request’s citation metadata to perform a lookup in the WMS library’s catalog. If the citation data did not contain this OCLC number the adapter would resort to doing a lookup by isbn or title which would fail as they are not supported searches in WMS. This in turn caused WMS libraries to get fewer requests directed to them to fill. To correct this the WMS/WMS2 adapters were improved to use the library’s local OCLC number from their record in the Shared Inventory.

When a request is marked shipped, the ISO18626 ReasonForMessage has been changed

  • Prior to release 1.13, when the ISO18626 message was sent to the requesting library to indicate a request had been shipped, the ReasonForMessage sent was RequestResponse. This has been updated to send StatusChange as the ReasonForMessage to align with the standard.

Restore the status associated with a supplier in the Details page/Supplier section in the Request app

  • The status of a request at a given supplier is now reflected again in the Supplier section of the request on its Details page in the Request app.

Manual editing of request details through the Request app updates more information in the Request and Supply apps

  • Prior to release 1.13 only changes to the pickup location were reflected on the supplier side when a request was manually edited in the Request app. In release 1.13 all bibliographic data fields and the need-by-date are also immediately updated on the supplier side request and the changes are reflected immediately in the Request and Supply app user interface.

Hide the Messages all seen action in the Details page/Audit trail section of a request

  • Prior to release 1.13, every time a staff member accessed the messages box that action was recorded to the audit trail of the request. Starting with release 1.13, these actions will now be hidden from the audit trail so they do not clog up the list of actions.

Labelling updates to the Pull slip options in Settings>Resource Sharing

  • A few changes were made to the Pull slip labels listed in Settings>Resource Sharing>Pull slip configuration to reflect that pull slip is two words:
    Pullslip logo was changed to Pull slip logo
    Pullslip report was changed to Pull slip report and to reduce confusion

  • Also to avoid confusion with report templates (jrxml files), the Pull slip templates setting in Settings>Resource Sharing was renamed to Pull slip notification templates

Addition of a logging section in Settings>Resource Sharing>Logging

  • ReShare users will now have the ability to log the following protocol messages for a request when troubleshooting a problem request: ISO18626 messages, NCIP messages, Rota building messages
    and Autoresponder messages. To support this, a new section titled Logging has been added to Settings>Resource Sharing to allow users to set turn on/off logging of any given protocol message and indicate the time that logging will occur for.

Addition of a Protocol messages section on the Details page of a request

  • A section titled “Protocol messages” has been added to the Detail page of a request under the Audit trail section to allow users to be able to easily see what has been logged for any given protocol message that has been turned on in Settings>Resource Sharing>Logging

Remove the “New” action from the Supply app

  • The New action button in the top right hand corner of the Supply app has been removed as it served no function and was confusing to users.

Bug Fixes

The Koha Host LMS adapter was seeing checked out items as available

  • When checking to see if an item was checked in and available, the Koha Host LMS adapter was not identifying checked out items correctly and was considering them as available. This has been corrected.

Undoing a filled request was not undoing the due date assigned to it via NCIP

  • Found during final testing, the due date assigned to a request when it was filled in the Supply app was not being removed if the “Undo last action performed” was done on the request. The due date is now properly being removed.

Non-functional changes

  • Enhanced state tables that make use of inheritance so they can choose not to inherit certain transitions.

  • Converted static keys / values into static variables that are defined in one place so in the future there is only one place in the code to change the variable if needed.

  • The following two queries were combined into one to make pulling information for patron notices more efficient:
    NoticePolicyNotice[] notices = NoticePolicyNotice.findAll


Query query = sess.createQuery



Operated as a Community Resource by the Open Library Foundation