Page tree
Skip to end of metadata
Go to start of metadata









Important Upgrade Considerations

This section outlines all changes that require special consideration for customers in production.  Configuration changes may be needed to prevent operational interruptions.  See checklist for guidelines on how to fill this out. 

Changes and Required Actions


Functional AreaChange or AdditionConsiderationsAction requiredAction timingContact personCommentsRelated JIRA issues
Affected app or moduleWhat has been changed or added that should be noted for this releaseWhat challenges may arise related to this change or additionIf applicable, detail what action(s) must be taken hereWhen can the action be taken (before, during or after upgrade)User name of person that can provide additional detailName of user leaving comment: comment on what you encountered or ask a question @mention Contact personInclude issue link for bug fix, story or feature that applies
mod-inventory-storageThe module now depends on Kafka message broker. Kafka should be up and running before module install.Inventory-storage APIs (instances/holding-records/items - create, update, delete actions) will fail with 500 status code if Kafka is unreachable.Make sure KAFKA_PORT and KAFKA_HOST environment variables are set and propagated to the mod-inventory-storage container before module installation.

Example: for rancher dev environments we set following values - KAFKA_HOST: kafka, KAFKA_PORT: 9092
Before upgradeThe same approach as for mod-pubsub may be used here. We tried to follow the same naming for the properties.
mod-inventory-storageStatistical code name needs to be uniqueThe upgrade process will fail when there are two or more statistical codes with the same name prior to the upgradeChange the name of any existing statistical codes that are the same as another statistical codeBefore upgrade

MODINVSTOR-709 - Getting issue details... STATUS

MODINVSTOR-596 - Getting issue details... STATUS

mod-inventory-storageThe id property of the circulationNotes array property in the Item object is  mandatoryThe id property got added to the item schema in Honeysuckle. If data added in, it will break things.

With Iris, this id is now mandatory, and the UI and the API  will hang if not present.Before upgrade

This is an unexpected impact of MODINV-129 - Getting issue details... STATUS and has been reported as MODINV-442 - Getting issue details... STATUS

This issue was likely present in previous distributions of FOLIO

MODINV-442 - Getting issue details... STATUS

MODINV-129 - Getting issue details... STATUS

mod-source-record-manager

Changes to the default MARC Bib-to-Instance map:

  1. Added support for the 880 alternate script fields
  2. Revised mappings for 541, 542, 561, 583 fields to set the Staff only checkbox based on value in 1st indicator

If library has customized the default MARC bib-to-Instance map, review these changes and decide if they should be added to the library's custom map. If changes are made, you may need to trigger a refresh of the existin gInstances that are based on the SRS MARC records, so that the changes are reflected in the Instance

MODDICORE-114

MODSOURMAN-377

mod-source-record-storageAn end point has been added to allow searching MARC records.The end point will only return results from MARC records added after the upgrade. A script to retroactively process pre-existing records has  been developed, see MODSOURCE-276: Add existing records to the SRS Query API tableTo add records  that existed prior to  upgrade to the query search  see MODSOURCE-276: Add existing records to the SRS Query API table Script: https://github.com/folio-org/mod-source-record-storage/blob/master/mod-source-record-storage-server/src/main/resources/migration_scripts/fill_marc_indexers.sqlAfter upgrade

UXPROD-2791 - Getting issue details... STATUS

mod-circulationThe age to lost processes (ageing borrowed items to lost and issuing fees / fines for those items)  are no longer automatically scheduled to run periodicallyNo items will be aged to lost and no fees / fines will be issued unless these processes are scheduled by the hosting provider

Organisations who need these processes to run will have to schedule them from outside the system

Configuration needed by the hosting provider

  • a user that has permissions to invoke these processes
  • a scheduled task that logs in as the user and invokes the relevant process

Organisations will likely need to schedule these processes separately meaning two separate tasks and schedules are likely to be needed (separate users may be used for each process)

New External Endpoints

  • POST /circulation/scheduled-age-to-lost (permission needed: circulation.scheduled-age-to-lost.post )
  • POST /circulation/scheduled-age-to-lost-fee-charging (permission needed: circulation.scheduled-age-to-lost-fee-charging.post )

No body needs to be provided to make requests to either of these endpoints.

Further documentation is available at How to Schedule Age to Lost Processes

During or after the upgrade

CIRC-1084 - Getting issue details... STATUS

FOLIO-3013 - Getting issue details... STATUS


mod-kb-ebsco-javaNew feature "Usage Consolidation" is now supportedConfiguring Usage Consolidation settingsIn order to configure "Usage Consolidation" → apart from the settings on UI, middle layer service needs to be configured by making a query directly to DB like the below:
```
INSERT INTO <tenant_id>_mod_kb_ebsco_java.usage_consolidation_credentials(client_id, client_secret) VALUES (?, ?);
```
User stories have been created to make this configurable from UI.
After upgrade to Iris

MODKBEKBJ-576 - Getting issue details... STATUS

UIEH-1112 - Getting issue details... STATUS

mod-ncipNew permission required to call NCIP services:
manualblocks.collection.get


During or after upgrade

mod-oai-pmhThis is not a required step but we noticed during tests that if the mod-oai-pmh performance is poor, re-indexing and vacuuming indexes located in mod-inventory-storage resolved the issue.

REINDEX instance_pmh_metadata_updateddate_idx;
REINDEX item_pmh_metadata_updateddate_idx;
REINDEX holdings_record_pmh_metadata_updateddate_idx;
REINDEX audit_instance_pmh_createddate_idx;
REINDEX audit_holdings_record_pmh_createddate_idx;
REINDEX audit_item_pmh_createddate_idx ;

During or after upgrade

mod-data-import, mod-source-record-manager, mod-source-record-storage, mod-inventory, mod-invoiceAll modules involved in data import process are now communicating through Kafka directly. Kafka should be configured and running before modules are installed and additional parameters should be set for modules.New setup and configurations requiredFollow the instructions to set all the necessary parameters for Kafka and the modulesBefore and during the upgrade

mod-search

Since 1.3.0 version OKAPI_URL environment variable is required for the module.

Data ingestion won't work. Set/pass OKAPI_URL to the application container. On module startup.

MSEARCH-97 - Getting issue details... STATUS

mod-pubsubEnvironment variables SYSTEM_USER_NAME and SYSTEM_USER_PASSWORD can be used to set up credentials for PubSub system user. Otherwise, default values (username pub-sub, password pubsub) will be used.Not providing these variables will result in using default credentials which is considered a security issue.Set SYSTEM_USER_NAME and SYSTEM_USER_PASSWORD environment variables.On module startup.

MODPUBSUB-78 - Getting issue details... STATUS

mod-agreementsWhen upgrading from Goldenrod consider running the Supplementary Document cleanup job on initialising the module in the tenant. The Supplementary Document cleanup job fixes an issue that could lead to a single supplementary document being linked to multiple agreements. The cleanup job will detect this situation and duplicate the document so each agreement is linked to it's own copy of the document

On installing/starting the module in the tenant, include

cleanSupplementaryDocs%3Dtrue

in the tenantParameters.

e.g.

/_/proxy/tenants/diku/install?tenantParameters=cleanSupplementaryDocs%3Dtrue
On module startup.

ERM-1114 - Getting issue details... STATUS

mod-patron-blocksEvents which took place before first mod-patron-blocks deployment are NOT taken into account while calculating automated patron blocks.This is an inherent limitation of mod-patron-blocks which is an event-based system.

If tenant plans on using Automated Patron Blocks feature AND full event synchronization has not been performed before, follow steps outlined in Q3 2020 (Honeysuckle) Release Notes.

After upgrade


MODPATBLK-41 - Getting issue details... STATUS

mod-source-record-storageCleanup of invalid snapshot statuses Data Import update of records associated with snapshot (with invalid status) will fail

Table snapshots_lib records should only contain status values of 'ERROR' or 'COMMITTED' for jobs which are no longer executing - the following manual script can be run to adjust values:
```
UPDATE <tenant_id>_mod_source_record_storage.snapshots_lb SET status = 'ERROR' where status not in ('COMMITTED', 'ERROR');
```
User story has been added for this cleanup to happen as part of migration to Hotfix 3

This script should NOT be run if DI jobs are currently actively in progress 

Before or After Upgrade

(DI Jobs not running)


MODSOURCE-329 - Getting issue details... STATUS

mod-source-record-storagePopulate missed instance_hrid 
Run following manual script to populate missed instance_hrid in records_lb table.
```
DO $$
BEGIN
  RAISE notice 'Script for populating missing Instance HRIDs in SRS started';
  
  UPDATE <tenant>_mod_source_record_storage.records_lb rec
  SET instance_hrid = arr.item_object->>'001'
  FROM <tenant>_mod_source_record_storage.marc_records_lb ind, jsonb_array_elements(content->'fields') with ordinality arr(item_object, position)
  WHERE
    rec.id = ind.id
    and rec.instance_id is not null
    and rec.instance_hrid is null
    and arr.item_object ? '001';

  RAISE notice 'Script for populating missing Instance HRIDs in SRS finished';
END;
$$;

```

Before or After Upgrade

MODSOURCE-327 - Getting issue details... STATUS

mod-circulationAll Service Points must be associated with a Fee/Fine Owner at Settings>Users>Fee/Fine: Owners for overdue fines and lost item fees to work properly.  If an overdue fine/lost item fee is calculated for an item with a Location whose Primary Service Point is not associated to a Fee/Fine Owner, the overdue fine/lost item fee will NOT be charged to the patron.In the future we will have a Default Fee/fine Owner to be charged.  (See UXPROD-2278 for details.)




mod-circulationUpon deployment make sure that automatic fee/fine types were added to the mod-feesfines database.  Otherwise overdue fine creation functionality will not work.To check, make a call to /feefines?query=automatic==true.  The response should contain 4 entries: "Overdue fine", "Lost item fee", Lost item processing fee" and "Replacement processing fee."




mod-circulationOverdue fine policies must be set up and circulation rules have to refer to policies that exist. If you do not charge overdue fines, you need to create one overdue fine policy that is for an overdue fine of 0 and use that overdue fine policy for every circulation rule.




mod-circulationLost item fine policies must be set up and circulation rules have to refer to policies that exist. If you do not charge lost item fees, you need to create one lost item fee policy that is for a lost item fee of blank and use that lost item fee policy for every circulation rule.





New Apps

Remote storage integration (Dematic)

Remote storage integration for Dematic StagingDirector and Dematic EMS. Accessed through Settings > Remote storage and Settings > Remote storage and Settings > Tenant > Location.


Circulation log export to CSV

This feature will allow a user to export filtered data in the Circulation log to a CSV file. Accessed through the Circulation Log app > Run a search > Open the “Actions” drop-down list > Select “.CSV export” 


Cornell Library's go-live requirements to transfer fees/fines to the Cornell bursar system

Automated Transfer of fees/fines to bursar or other account. Accessed through Settings > Tenant > General: Bursar (to run a Bursar export manually or set the scheduling parameters for the export)

Permissions Updates

AppNew PermissionsDeprecated PermissionsProduct Owner
Data importRenamed UI: ui-data-import module is enabled to Data import: all permissions, to make it clearer. Scope of the permissions did not change.
Data importRenamed Settings (data-import): display list of settings pages to Settings (Data import): Can view, create, edit, and remove, to make it clearer. Scope of the permission did not change.
Ann-Marie Breaux
Inventory 

The option to add tags to Inventory record types (instance, holdings, item) now has the consequence that anyone with inventory permissions should have their permissions edited to add either the Tags on records: View only or Tags: All permissions

Important: If the user permissions are not updated as described above, then the Inventory app will not display in the top menu bar for the user with the Inventory app permissions.


Inventory

We have implemented the possibility to move holdings and item in Inventory, but any transfers are not yet being reflected in dependent apps; e.g. Orders, Request, and Courses. In order to prevent corrupt data it's highly recommended that all libraries limit the ability to move holdings and item by limiting the number of staff having the appropriate user permission to move holdings and item.


Charlotte Whitt
Remote StorageRemote storage integration has one level of permissions - Remote storage: Create, read, update, delete. A user with these permissions can create and configure remote locations.
Any user with Inventory: View, create, edit instances has the ability to change the location of holdings and items to remote storage, and from remote storage to main locations. 

Check out

New Permissions: ui-checkout.viewRequests (Check out: View requests), ui-checkout.viewLoans (Check out: View loans), and ui-checkout.viewFeeFines (Check out: View fees/fines)

UI-only permissions that control whether the Loans, Requests, and FeeFine information in the user pane of Check out are active hyperlinks to their respective information.

Important: these permissions are not included in any other permission set by default, including ui-checkout.all (Check out: All permissions), and they are required to enable the indicated hyperlinks in Check out.


quickMARCquickMARC: Derive new MARC bibliographic record - this permission allows one to derive a new MARC bib record from an existing MARC record
Khalilah Gambrell
eholdings
  • eHoldings: Can view Usage & analysis data for packages, titles and resources | View usage consolidation on eholdings app
  • Settings (eholdings): Create, edit, and view Usage Consolidation API credentials | Ability to update and view usage consolidation settings
  • Settings (eholdings): View Usage Consolidation API credentials | Ability to view usage consolidation settings
  • Settings (eHoldings): Can assign/unassign a user from a KB | Ability to assign/unassign a user from KB credentials. Permission should only be used by institutions that maintain multiple EBSCO KB configurations. 

Khalilah Gambrell
Agreements
  • Updated permission "Agreements: Search & view e-resources": Grants all permissions included in 'Agreements: Search & view agreements' plus the ability to search and view e-resources (packages and titles in those packages) in the internal KB.
  • New permission "Agreements: Search & view platforms": Grants all permissions included in 'Agreements: Search & view e-resources' plus the ability to search and view platforms in the internal KB
  • New permission "Agreements: Edit platforms": Grants all permissions included in 'Platforms: Search & view platforms' plus the ability to edit platform properties


Licenses
  • Updated permission "Settings (Licenses): Manage license terms": Grants permissions to access the License settings and the ability to manage the available license terms. This was updated to include the ability to view pick list information which is necessary to manage license terms which use pick lists (previously this required an additional permission to be granted)


Local KB Admin
  • New permission "Local KB admin: Manage proxy server configuration": Grants permission to create, edit and delete Proxy server settings for reverse proxy servers used to enable users to access online resources
  • Updated permission "Local KB admin: Create jobs": Grants permission to create new jobs (i.e. upload files of resources to the Agreements local knowledgebase). This was updated to include the ability to view knowledgebase information and upload files without which the user could not complete the creation of a job (previously this would have required additional permissions to be granted to the user)


Known Issues

General

  • Most front-end modules don't fetch exact search result count from backend ( RMB-673 - Getting issue details... STATUS ).
  • Estimated search result count has a wording that incorrectly suggests it is a precise number ("8081 records found"). Only numbers below 1000 are precise (details: RMB Estimated totalRecords). (WIP UXPROD-2623 - Wait for POC of Elastic Search - Round estimated search result hit count (totalRecords) Blocked )
  • Some modules fail in Pgpool-II replication ( FOLIO-2447 - Getting issue details... STATUS , FOLIO-2978 - Getting issue details... STATUS ).
AppKnown issueWorkaroundJIRA issueProduct Owner
Orders and ReceivingData corruption. When holding/item data are moved in Inventory the connected Order lines are not updated accordingly. The PO remains linked to the original instance and items but location IS NOT updated. This could result in receiving of unreceived pieces generating new holding records or moving back to the original instance.The current workaround is to be very judicious in allowing users to move items and holdings in Inventory when there are open orders related to item records. We suggest ONLY granting certain users this ability for now. All short term fix we attempted to put in place while we wait for a more systemic resolution to the underlying issue would introduce problems of its own.

UIOR-682 - Getting issue details... STATUS

Orders and receiving

If users "Unopen" orders that have "Manually add pieces for receiving" = true. If they had created any pieces they will not be able to open the order again without deleting pieces from the receiving area. System will force user to delete as part of open order process.

You can recreate the necessary records after the opening the order again. 

MODORDERS-502 - Getting issue details... STATUS

OrdersPossible to save POL with no location even though location is a "required" field. This can happen when you use an order template to add a location field set with only quantity populated When order fails to open edit POL and select a location. Save POL and Open when desired.

UIOR-720 - Getting issue details... STATUS

OrdersWhen using save and open button on POL. If Funds have no budget the UI may tell you that it could not save the POL when it actually did save the POL. This could result in the user unknowingly creating multiple POLs and needing to delete them after.Make sure your Funds have current budgets before applying them to purchase orders. If error occurs "Unopen" order and delete extra POLs.Already resolved for the Juniper release.Dennis Bridges
mod-orders-storageIf OKAPI_URL contains a path after the hostname like https://example.com/okapi the upgrade always fails.no known workaround

MODORDSTOR-231 - Getting issue details... STATUS

OrganizationsWhen fields within a closed accordion are invalid the UI does not force them open when trying to save the record. This may confuse users as to why they cannot save edits to an organization recordClick "Expand all" accordions and look for the validation errors. This may be empty required fields or invalid data added during a migration. 

UIORGS-244 - Getting issue details... STATUS

OrdersWhen order includes only 1 Fund distribution, deleting it from the AND not adding a new one to the POL before clicking save and close. Results in a lingering encumbrance that is not released appearing on the budgetIf you wish to remove the last Fund distribution from a POL such that it will no longer have any encumbrance. Edit the POL and then navigate to the encumbrance in the finance app and use the "Release encumbrance" action. Note it requires a permission.

UIOR-756 - Getting issue details... STATUS

Dennis Bridges
Data exportHoldings' permanent location or item's effective location not always populated during the export while using a custom mapping profile.Not known at this point.  We believe this is the data corruption issue as we were not able to recreate it on other than Bugfest environments.MDEXP-391
OAI-PMHHoldings data is not discoverable when item record is suppressedNot known at this pointMODOAIPMH-317
RequestsOut of sync data: When holding/item data are moved, or other updates made to items, in inventory, any connected requests are not updated accordingly (eg. new barcodes, title, or instance identifiers)Take care when modifying items with open hold requests.

UIREQ-589 - Getting issue details... STATUS FOLIO-2474 - Getting issue details... STATUS

Circulation logLoan details from the Action dropdown in the Log will sometimes show an error message BEFORE loan details actually load. Give the record a little time to load, or get Loan details from another source, like the Item record

UIU-2120

Stephanie Buck
Claimed returned fees/fines

There were two bugs discovered in the Iris BugFest after the test cases had been passed and just before Iris was to be released.  They were caused by changes to the code in BugFest that adversely impacted what had already been tested.   As there are easy workarounds, the two bugs will not be fixed until the Juniper (R2 2021) release.

Bug 1:  When checking in a claimed returned item, the "suspended" lost item fees are not being cancelled (UICHKIN-252)

Bug 2:  When resolving a claimed returned situation, the lost item fees are not cancelled if they have had a transfer made before they were claimed returned (UICIRC-570)

We also have a bug that was found earlier that we were unable to fix for the Iris Release.

Bug 3: For aged to lost items that are claimed returned, and then returned by patron, if the Lost Item Processing Fee is not refunded the Payment Status should be updated to "Outstanding" (UIU-2129)


Bug 1:  The "suspended" Lost Item Fee and Lost Item Processing Fee (if there is one) remain suspended after claimed returned item is check in.  Given they are "suspended", the patron is not being held liable for the fees.  The library is able to waive the "suspended" lost fees to remove them from the "suspended" status.

Bug 2:  The "suspended" Lost Item Processing Fee appears in the Closed Fees/Fines tab, so the patron is not being held liable.  This should not be a problem at all for libraries that don't transfer fees/fines or don't do it quickly.

Bug 3:  This only impacts you if your institution is using aged to lost processing and do not refund the Lost Item Processing Fee if a lost item is returned.   The Lost Item Processing Fee will remain as "Suspended claim returned."  It can be paid with this status, but more likely you will want to waive the original Lost Item Processing Fee and create a new one as a manual charge.

UICHKIN-252

UICIRC-570

UIU-2129

Holly Mistlebauer
Overdue fines

Overdue fines not charged when charging overdue fines by the minute over periods when library is opened then closed

This bug only impacts you if your institution bills overdue fines by the minute and does not charge overdue fines when the library is closed.  You will need to update your "Overdue fine" policies to use hours (or anything other than minutes) as the "Interval". CIRC-1135Holly Mistlebauer
Manual fees/finesWhen creating a new manual fee/fine, if you enter a comma in the "Fee/fine amount" field the value will not be saved properly despite looking correct (for example, "1,000.00" will be saved as "1.00").Do not enter a comma in the "Fee/fine amount" field on the "New fee/fine" page.UIU-2156
Mod-finance-storageTransaction table upgrade failure when purchase order record is missing. Discovered when upgrading from mod-finance-storage-6.0.1 to mod-finance-storage-7.0.2Delete orphaned encumbrance transaction records. Retry migration. See script in comment here from Wayne for more information. 

MODFISTO-237 - Getting issue details... STATUS

Data ImportMARC record field protection is not yet working correctly

UIDATIMP-907 - Getting issue details... STATUS

Data ImportEDIFACT invoices can be imported, but invoice and invoice-line adjustments still need additional work. Also, if an incoming invoice line does not link to a corresponding purchase order line, there is no manual way to link them in Iris (will be available in Juniper). If the EDIFACT invoice file has an upper-case file extension (e.g. EDI), it much be changed to lower-case (e.g. edi) before uploading and importing.

For invoice and invoice-line adjustments, enter them manually after the rest of the invoice has been imported.

For invoice lines that do not match to purchase order lines, 1) delete the invoice line, and add the invoice line manually, based on finding and linking the purchase order line manually. Or 2) review the matchpoints in the invoice data, and manually edit each purchase order lines to include those matchpoints manually, Then delete the imported invoice, and re-import it. This time the incoming invoice-lines should match to the corresponding purchase order lines.

UINV-193 - Getting issue details... STATUS

UXPROD-3068 - Getting issue details... STATUS

Ann-Marie Breaux
Local KB Admin SettingsThe "LOCAL" knowledgebase appears as editable in the settings. Only external data sources should be visible and editable in this screen. Editing the LOCAL knowledgebase could cause issues or the creation of an addition LOCAL knowledgebase (if the name is changed)Do NOT edit the LOCAL knowledgebase in the settings

ERM-1632 - Getting issue details... STATUS

Mod-invoice and mod-financeCredit invoice results in a credit of $0 being charged to the fund. Meaning $0 is added back to the Fund.No current workaround. Suggesting libs avoid creating credit invoices. This should be resolved in a hotfix release

MODINVOICE-255 - Getting issue details... STATUS

CoursesAn error in the "Courses: All Permissions" system-defined permission set was inadvertently introduced as part of the Iris release and not discovered until Iris implementer sites began testing. Users with the permission set "Courses: All Permissions" and no other Courses permissions cannot edit courses.

The workaround is not use the Courses: All Permissions set, and instead assigned Courses app users a mix of the segmented permissions that allows them to have desired create/edit functionality:

Courses: Add and edit courses' reserved items
Courses: Add, edit, and remove courses' reserved items
Courses: All permissions
Settings (Courses): Can create, edit and delete course settings

The Courses: All Permissions set is fixed as of the Juniper release, so permissions can be reverted at that point.

UICR-141 - Getting issue details... STATUS

N/A

Notes on functionality

Permissions

There are several changes related to migration of static (system-defined) permissions introduced in Iris:

  • When permissions that once appeared in a module descriptor are removed in a newer version of the module descriptor, they will be marked deprecated. 
    • In Iris, this means the displayName of these permissions will be prefixed with "(deprecated) ", but the permissions will not be filtered out of any API calls. 
    • Eventually we'd like to filter deprecated permissions out of API responses unless they're specifically requested.  This feature, however, did not make it into Iris.
  • Permissions can now be renamed via a new "replaces" property.  Perm-users (Assignments) and PermissionSet sub-permissions will be updated automatically.
    • Example:  "foo.get" replaces "foo.read", "foo.view".  Any users which were assigned either "foo.read" or "foo.view" would automatically be granted "foo.get".  Permissions "foo.read" and "foo.view" would be marked deprecated.
  • A new "purgeDeprecated" API has been introduced to allow an operator to purge deprecated permissions.  This will:
    • Remove deprecated permissions from the system
    • Remove deprecated permission names from user's permission assignments
    • Remove deprecated permissions from permission sets
    • N.B. This API should only be called once you're confident that a module downgrade will not be required.  Once deprecated permissions are purged, the system will not know how to "undo" the permission migration for that module. 
    • N.B. Currently this is an all-or-nothing operation.  There is no way to purge individual deprecated permissions, or remove deprecated permissions for a particular module.
  • If a permission name collides with a user-defined permission with the same name,
    • In Iris, the call to enable the module (install/upgrade) will fail with an appropriate error message.  
    • Eventually we'd like to do something like rename the user-defined permissions and adjust assignments as needed. 
  • All system-defined permissions will now include context about the module that defined them (new permission fields moduleName/moduleVersion).
  • Duplicate permission definitions are not allowed.  If a permission (name) is defined by multiple module descriptors the upgrade will fail with an appropriate error message. 
  • The mutable property will now be ignored when creating or updating permissions.  This is a system-controlled field.
  • Orphaned system-defined permissions - those which are marked as immutable and are no longer present in any enabled module descriptor - will automatically be deprecated when upgrading mod-permissions.

Deployment Considerations:

  • If you want to benefit from permission migration you need OKAPI v4.6.0 or greater (v4.7.2 or greater is highly recommended) and mod-permissions v5.13.0.
  • Contrary to earlier communications, it is NOT required to upgrade mod-permissions first or last.  It is also NOT required that you upgrade to the latest Honeysuckle Hot Fix release prior to upgrading to Iris.

Please contact the Craig McNally, Adam Dickmeiss, or Jakub Skoczen with questions.

Data Import

  • Supported in Iris: 
    • Create and update Inventory Instances, Holdings, and Items
    • MARC record modifications to add, remove, and change constant data within the incoming file
    • MARC-MARC matching on 001 and 999 ff fields, but not any other MARC fields
    • EDIFACT invoice loading
  • For importing EDIFACT invoices, the User needs these permissions
    • Data import: all permissions
    • Settings (Data import): Can view, create, edit, and remove
    • Invoice: Assign acquisitions units to new record
    • Invoice: Can view, edit and create new Invoices and Invoice lines
    • Invoice: Can view, edit and delete Invoices and Invoice lines

Inventory

  • Implemented configurable number of locations
    • UIIN-1480 - in order to support library systems with more and more locations, then we have implemented a change and made the number of locations configurable in the platform' Stripes configuration file, stripes.config.js
  • Supported in Iris:
    • Assign tags to Instances, Holdings, and Item records, and filter by them
  • Add a Java-based migration process for item effectiveShelvingOrder property, this has following impact:
    • Module initialization takes significant time for migration to 20.2.1 version (the process is triggered only once), currently it is up to 5 hours. It is recommended to run this process at non working hours, because mod-inventory-storage is a critical part of FOLIO, most subsystems will be irresponsible.  
    • The migration process does not generates domain events for updates.

Requests

  • Override blocks on requests:
    • UXPROD-2910 - Added the ability to override patron and item blocks on requests
  • Warning modals when an item with pending requests is marked missing, withdrawn, claimed returned, or declared lost:
    • UXPROD-2411 - When changing an item's status to missing or withdrawn in Inventory or claimed returned or declared lost in Users, a modal stating the number of open requests (with a link to the request queue) will be presented to staff with the option to cancel the status change
  • Patron comments on requests:
    • UXPROD-1800 - Added a patron comments field to requests that can be entered by staff or via the edge-patron API (discovery) and is available as a token in staff slips and the Requests interface

Circulation log

  • Check Removed Loan and User detail links when circulation action has been anonymized
  • Removed Loan details when circulation action includes multiple  barcodes (item details available through linked barcode)
  • Checked in filter added to Loans dropdown
  • Dates reformatted to match dates in the rest of FOLIO
  • Updated search boxes to free-text format as in the rest of FOLIO

Claimed returned fees/fines

As discussed with the Resource Access SIG, not all of the claimed returned fee/fine changes have been included in Iris.  The remainder will be finished for Juniper.  Please see the Google Sheet here to see what is included in each release.  Holly has also updated Emma's Claimed Returned Flowchart to show what is in Iris (R1) and Juniper (R2), which was helpful for her and may help you as well. (Important note:  There were two bugs discovered in the Iris BugFest after the test cases had been passed and just before Iris was to be released. They were caused by changes to the code in BugFest that adversely impacted what had already been tested.  The two bugs are described in the "Known Issues" section above.)

Agreements

  • Changes to Agreement periods and start and end date management mean that:
    • The earliest period start date is now treated as the agreement start date
    • The latest period end date is now treated as the agreement end date, or if there is a blank period end date the agreement is treated as having no end date
    • If only a single agreement period is used, no other information is displayed in relation to periods, allowing tenants to use single periods as the start/end date for an agreement
    • If multiple agreement periods are used it is easy to see the "previous", "current" and "next" periods for the agreement as well as view the details of all the agreement periods
    • Agreements can be searched by start and end date
  • When an agreement line is linked to a Purchase Order Line that is linked to an Inventory instance, a link directly to the Inventory instance is displayed in the Agreement Line display
  • In the Agreement display any accordions not populated with data and not otherwise required are not displayed to the user, simplifying the display
  • Keyboard shortcuts now supported
  • Separate actions buttons (Edit, Delete, etc.) replaced by single Actions menu
  • New settings (Settings → Agreements → Display settings) to control the number of lines to show per page (i.e. before showing the "Load more" button) in multi-column lists (tabular lists) across the Agreements application. The default value for all lists is 10. The multi-column lists affected are:
    • Agreement view pane > Agreement lines

    • Agreement view pane > E-resources covered by this agreement

    • E-resource view pane > Options for acquiring e-resource

    • Package view pane > E-resources in package

    • E-resource view pane > Agreements for this e-resource

Agreements Local Knowledgebase

  • Support for proxy server and platform dependent URL customisations. See Proxy server configuration and URL customizations for a full description of this functionality.
  • Platform search and view added to Agreements app to support the ability to manage platform dependent URL customisations
  • Tags and tag search now supported for Titles and Packages in the local KB
  • "Suppress from discovery" flag now supported (edit and display) for Titles and Titles in a Package as well as Agreement Lines
  • Links on Titles in the "E-resources covered by this agreement" list now link to the Title in Package record rather than the Title record
  • In Local KB Admin Separate actions buttons (New, Delete, etc.) replaced by single Actions menu
  • Keyboard shortcuts supported in Local KB Admin app
  • Keyboard shortcuts supported in ERM comparisons app

Licenses

  • Support for duplicating amendments on a license
  • Keyboard shortcuts now supported
  • Separate actions buttons (Edit, Delete, etc.) replaced by single Actions menu
  • Ability to search licenses by start and end date
  • In the License display any accordions not populated with data and not otherwise required are not displayed to the user, simplifying the display
  • When duplicating a license the license term values are now included in duplication
  • On license CSV export the escape character used changed from backslash (ASCII 92) to quote mark (ASCII 34) for improved compatibility with common software used to view CSV files (specifically Microsoft Excel)

Post-Release Hotfixes

Hot fix release #1 - RELEASED AT MAY 28

Tickets list

Key Summary T Assignee P Resolution Reporter
Loading...
Refresh

Modules list


Project Priority
P1P1 P2P2 P3P3 TBDTBD T:
Okapi 0 0 0 1 1
data-import-processing-core 0 2 0 0 2
mod-circulation 0 2 0 1 3
mod-data-export-spring 1 0 0 0 1
mod-data-export-worker 1 0 0 0 1
mod-data-import 1 0 0 0 1
mod-erm-usage-harvester 0 0 1 0 1
mod-finance 0 1 0 0 1
mod-finance-storage 1 0 0 0 1
mod-inventory 0 1 0 0 1
mod-password-validator 0 2 0 0 2
mod-patron 0 0 0 1 1
mod-pubsub 0 0 0 2 2
mod-quick-marc 1 0 2 0 3
mod-source-record-manager 0 2 0 0 2
mod-source-record-storage 0 4 0 0 4
ui-inventory 0 1 0 0 1
Total Unique Issues: 5 15 3 5 28
Showing 17 of 17 statistics.
View in Jira


Module mod-aes removed from the Iris release platform by request of the dev team (Hongwei Ji and Matt Reno). Was added by mistake

Hot fix release #2 - RELEASED AT JUNE 25

Tickets list

Key Summary T Assignee P Resolution Reporter
Loading...
Refresh

Modules list


Project Priority
P1P1 P2P2 P3P3 T:
edge-dematic 1 0 0 1
mod-circulation 0 1 0 1
mod-copycat 1 0 0 1
mod-inventory 0 4 0 4
mod-invoice 0 1 0 1
mod-login-saml 1 0 0 1
mod-orders 1 1 0 2
mod-pubsub 1 0 0 1
mod-quick-marc 1 1 0 2
mod-source-record-manager 2 2 0 4
mod-source-record-storage 2 1 1 4
mod-user-import 1 0 0 1
sip2 0 1 0 1
ui-checkin 0 2 0 2
ui-checkout 0 1 0 1
ui-data-import 1 0 0 1
ui-inventory 0 1 0 1
ui-invoice 0 1 0 1
ui-quick-marc 0 2 0 2
ui-receiving 0 2 0 2
ui-users 0 1 0 1
Total Unique Issues: 12 22 1 35
Showing 21 of 21 statistics.
View in Jira

Hot fix release #3 - RELEASED AT JULY 26

Tickets list

Key Summary T Assignee P Resolution Reporter
Loading...
Refresh

Modules list


Project Priority
P1P1 P2P2 P3P3 T:
data-import-processing-core 2 0 0 2
edge-dematic 1 0 0 1
mod-data-export-spring 1 3 0 4
mod-data-export-worker 0 5 0 5
mod-gobi 0 1 0 1
mod-inventory 2 1 0 3
mod-inventory-storage 1 0 0 1
mod-invoice 0 1 0 1
mod-orders 0 1 0 1
mod-patron 1 1 0 2
mod-remote-storage 0 3 0 3
mod-search 0 0 1 1
mod-source-record-manager 1 0 0 1
mod-source-record-storage 1 1 0 2
stripes-smart-components 0 1 0 1
ui-plugin-bursar-export 0 1 1 2
ui-users 0 1 1 2
Total Unique Issues: 10 20 3 33
Showing 17 of 17 statistics.
View in Jira


New Features by Epic (Sub-Project)

Key Summary
Loading...
Refresh

Closed Bugs

Project Priority
P1P1 P2P2 P3P3 P4P4 TBDTBD T:
ERM Platform 2 5 2 0 12 21
FOLIO 2 5 2 1 6 16
LDP Query 0 0 0 0 1 1
Okapi 0 4 1 0 12 17
RAML Module Builder 0 1 1 0 4 6
Reporting Tools 0 0 0 0 1 1
Stripes 0 1 0 0 2 3
Support 0 0 0 0 1 1
Z39.50 1 0 0 0 0 1
data-import-processing-core 0 2 0 0 0 2
edge-patron 0 0 1 0 0 1
folio-spring-base 0 1 0 0 0 1
generate-marc-utils 0 1 0 0 0 1
mod-aes 0 0 0 0 1 1
mod-audit 0 0 0 0 1 1
mod-authtoken 0 0 0 0 1 1
mod-circulation 0 11 5 0 5 21
mod-circulation-storage 0 0 1 0 1 2
mod-copycat 0 0 0 0 2 2
mod-courses 1 0 0 0 0 1
mod-data-export 3 4 5 0 0 12
mod-data-import 0 1 0 0 0 1
mod-email 0 1 0 0 0 1
mod-erm-usage-harvester 0 0 0 0 4 4
mod-feesfines 0 2 0 0 3 5
mod-finance 0 3 0 0 0 3
mod-finance-storage 0 3 2 0 0 5
mod-graphql 0 0 0 0 1 1
mod-inventory 1 1 1 1 2 6
mod-inventory-storage 1 1 1 0 4 7
mod-invoice 0 0 0 0 1 1
mod-kb-ebsco-java 0 4 8 0 0 12
mod-marccat 1 0 2 0 10 13
mod-notify 0 0 1 0 0 1
mod-oai-pmh 4 3 3 1 0 11
mod-orders 0 1 1 0 0 2
mod-orders-storage 0 1 0 1 0 2
mod-organizations-storage 1 0 0 0 0 1
mod-patron 0 0 1 0 0 1
mod-patron-blocks 0 1 0 0 1 2
mod-permissions 0 1 1 0 1 3
mod-pubsub 1 1 0 0 2 4
mod-remote-storage 0 2 0 0 0 2
mod-source-record-manager 1 0 0 0 1 2
mod-source-record-storage 1 1 4 0 2 8
mod-user-import 1 0 2 0 1 4
mod-users 0 1 0 0 0 1
mod-users-bl 0 0 0 0 1 1
perf-testing 0 0 0 0 1 1
stripes-acq-components 0 0 1 0 0 1
stripes-components 0 1 7 1 3 12
stripes-connect 0 0 1 0 0 1
stripes-core 1 3 4 0 5 13
stripes-smart-components 0 1 5 0 1 7
stripes-webpack 0 0 1 0 0 1
ui-calendar 0 1 0 0 0 1
ui-checkin 0 1 0 1 1 3
ui-checkout 0 4 0 0 0 4
ui-circulation 0 0 3 1 1 5
ui-circulation-log 0 0 0 0 1 1
ui-courses 0 1 1 0 0 2
ui-data-export 0 0 1 0 0 1
ui-data-import 2 5 5 0 0 12
ui-eholdings 0 2 11 0 1 14
ui-erm-usage 0 1 0 0 1 2
ui-finance 1 1 1 0 0 3
ui-finc 0 0 0 0 2 2
ui-inventory 1 3 5 0 2 11
ui-invoice 1 2 2 0 0 5
ui-marccat 0 1 6 0 10 17
ui-orders 0 2 3 0 0 5
ui-organizations 0 0 3 3 0 6
ui-plugin-find-package-title 1 1 2 0 1 5
ui-receiving 0 0 1 0 0 1
ui-requests 0 2 4 1 0 7
ui-search-es 0 0 1 0 0 1
ui-tenant-settings 0 1 0 3 3 7
ui-users 0 15 8 0 9 32
Total Unique Issues: 28 111 121 14 126 400
Showing 78 of 78 statistics.
View in Jira

All Closed Bugs and Stories

Project Priority
P1P1 P2P2 P3P3 P4P4 P5P5 TBDTBD T:
ERM Platform 2 6 4 0 0 37 49
FOLIO 2 13 13 1 0 7 36
Folio Automation Testing 0 0 1 0 0 0 1
LDP Query 0 0 0 0 0 1 1
Okapi 0 6 1 0 0 12 19
RAML Module Builder 0 1 1 0 0 5 7
Reporting Tools 0 0 0 0 0 2 2
Stripes 0 1 1 0 1 3 6
Support 0 0 0 0 0 1 1
User Experience Design 0 3 8 0 0 1 12
Z39.50 1 1 0 0 0 1 3
data-import-processing-core 0 3 1 0 0 0 4
edge-common 0 0 2 0 0 4 6
edge-dematic 0 0 1 0 0 0 1
edge-oai-pmh 0 0 2 0 0 0 2
edge-orders 0 0 2 0 0 0 2
edge-patron 0 0 2 0 0 0 2
edge-rtac 0 1 0 0 0 0 1
edge-search-srs 0 0 1 0 0 0 1
folio-custom-fields 0 0 1 0 0 0 1
folio-di-support 0 0 1 0 0 0 1
folio-holdingsiq-client 0 1 0 0 0 0 1
folio-service-tools 0 0 1 0 0 0 1
folio-spring-base 0 1 0 0 0 1 2
generate-marc-utils 0 1 1 0 0 0 2
mod-aes 0 0 0 0 0 3 3
mod-audit 0 0 0 0 0 2 2
mod-authtoken 0 0 0 0 0 2 2
mod-circulation 0 15 18 0 0 14 47
mod-circulation-storage 0 0 1 0 0 1 2
mod-configuration 0 0 0 0 0 2 2
mod-copycat 0 2 1 0 0 7 10
mod-courses 1 0 0 0 0 0 1
mod-data-export 3 5 19 0 0 0 27
mod-data-import 0 2 2 0 0 0 4
mod-data-import-converter-storage 0 2 1 0 0 0 3
mod-ebsconet 0 0 1 0 0 0 1
mod-email 0 1 0 0 0 0 1
mod-erm-usage 0 0 0 0 0 4 4
mod-erm-usage-harvester 0 0 0 0 0 5 5
mod-feesfines 0 3 0 0 0 8 11
mod-finance 0 3 9 0 0 0 12
mod-finance-storage 0 7 25 0 0 0 32
mod-gobi 0 1 1 0 0 0 2
mod-graphql 0 0 0 0 0 2 2
mod-inventory 1 5 4 1 0 2 13
mod-inventory-storage 1 4 11 0 0 4 20
mod-invoice 0 1 6 0 0 2 9
mod-invoice-storage 0 0 5 0 0 0 5
mod-kb-ebsco-java 0 7 16 0 0 0 23
mod-login 0 0 1 0 0 2 3
mod-login-saml 0 1 0 0 0 0 1
mod-marccat 1 11 8 0 0 19 39
mod-notes 0 0 2 0 0 0 2
mod-notify 0 0 1 0 0 0 1
mod-oai-pmh 4 4 19 1 0 0 28
mod-orders 0 3 12 0 0 0 15
mod-orders-storage 0 1 7 1 0 0 9
mod-organizations-storage 1 0 0 0 0 0 1
mod-password-validator 0 0 1 0 0 0 1
mod-patron 0 0 2 0 0 0 2
mod-patron-blocks 0 2 0 0 0 1 3
mod-permissions 0 3 2 0 0 3 8
mod-pubsub 1 2 0 0 0 2 5
mod-quick-marc 0 0 6 0 0 0 6
mod-remote-storage 0 2 6 0 0 4 12
mod-search 0 2 17 2 0 0 21
mod-sender 0 0 0 0 0 1 1
mod-source-record-manager 1 5 7 0 0 1 14
mod-source-record-storage 1 10 8 0 0 2 21
mod-user-import 1 0 3 0 0 3 7
mod-users 0 1 0 0 0 0 1
mod-users-bl 0 0 0 0 0 1 1
perf-testing 0 1 2 0 0 5 8
release 0 0 0 0 0 2 2
stripes-acq-components 0 0 3 0 0 0 3
stripes-cli 0 0 0 0 0 1 1
stripes-components 1 1 12 1 0 4 19
stripes-connect 0 0 4 0 0 0 4
stripes-core 1 3 7 0 0 6 17
stripes-data-transfer-components 0 0 1 0 0 0 1
stripes-smart-components 0 1 12 0 0 1 14
stripes-util 0 0 0 1 0 0 1
stripes-webpack 0 0 1 0 0 0 1
ui-acquisition-units 0 0 2 0 0 0 2
ui-calendar 0 1 0 0 0 2 3
ui-checkin 0 2 4 1 0 3 10
ui-checkout 0 7 2 0 0 4 13
ui-circulation 0 2 5 1 0 5 13
ui-circulation-log 0 0 5 0 0 1 6
ui-courses 0 2 2 0 0 0 4
ui-data-export 0 0 13 0 0 0 13
ui-data-import 2 13 22 0 0 0 37
ui-eholdings 0 6 38 0 0 1 45
ui-erm-usage 0 1 1 0 0 9 11
ui-export-manager 0 5 0 0 0 0 5
ui-finance 1 4 17 0 0 0 22
ui-finc 0 0 0 0 0 11 11
ui-inventory 1 11 38 2 0 4 56
ui-invoice 1 2 13 0 0 0 16
Total Unique Issues: 31 239 557 21 1 277 1126
Showing 100 of 120 statistics.
View in Jira

Remaining Open Bugs at Time of Release 

Project Priority
No priority P1P1 P2P2 P3P3 P4P4 P5P5 TBDTBD T:
ACQ Draft 0 0 0 0 0 0 1 1
Bug Fest 0 0 0 2 0 0 6 8
Chalmers 0 0 0 3 0 0 34 37
ERM Platform 0 0 8 9 3 0 46 66
FOLIO 0 2 20 28 1 0 55 106
Folio Automation Testing 1 0 0 3 0 0 2 6
Okapi 0 0 2 1 1 0 18 22
RAML Module Builder 0 2 12 17 0 0 36 67
Stripes 0 0 4 2 0 0 2 8
Support 0 0 1 2 0 0 1 4
UX Product 0 0 0 0 0 1 2 3
User Experience Design 0 0 0 0 0 0 1 1
Z39.50 0 2 1 1 0 0 1 5
cql2pgjson 0 0 0 3 0 0 1 4
data-import-processing-core 0 7 12 2 0 0 0 21
edge-caiasoft 0 0 0 0 0 0 1 1
edge-common 0 0 0 0 0 0 1 1
edge-common-spring 0 0 0 0 0 0 2 2
edge-connexion 0 1 1 0 0 0 2 4
edge-dematic 0 3 1 2 0 0 1 7
edge-oai-pmh 0 0 1 0 0 0 0 1
edge-orders 0 0 0 1 0 0 0 1
edge-patron 0 0 1 0 0 0 2 3
edge-rtac 0 0 1 2 0 0 1 4
eslint-config-stripes 0 0 0 1 0 0 0 1
folio-spring-base 0 0 0 0 0 0 1 1
mod-audit 0 0 5 5 0 0 6 16
mod-authtoken 0 0 1 2 0 0 3 6
mod-calendar 0 0 0 0 0 0 1 1
mod-circulation 0 6 31 8 0 0 20 65
mod-circulation-storage 0 0 4 3 0 0 1 8
mod-codex-inventory 0 0 0 1 2 0 0 3
mod-codex-mux 0 0 0 1 0 0 0 1
mod-configuration 0 0 0 1 0 0 3 4
mod-copycat 0 2 5 0 0 0 4 11
mod-courses 0 1 3 1 0 0 2 7
mod-data-export 0 1 2 9 0 0 1 13
mod-data-export-spring 0 2 4 1 0 0 0 7
mod-data-export-worker 0 4 3 1 0 0 3 11
mod-data-import 0 6 21 11 1 0 2 41
mod-data-import-converter-storage 0 0 2 0 0 0 0 2
mod-data-loader 0 0 0 2 0 0 0 2
mod-ebsconet 0 0 2 0 0 0 0 2
mod-email 0 0 1 0 0 0 2 3
mod-erm-usage 0 0 0 1 0 0 3 4
mod-erm-usage-harvester 0 0 5 1 0 0 4 10
mod-eusage-counter 0 0 0 0 0 0 2 2
mod-eusage-reports 0 0 2 0 0 0 2 4
mod-feesfines 0 0 12 2 0 0 7 21
mod-finance 0 1 1 2 0 0 0 4
mod-finance-storage 0 2 6 3 0 0 2 13
mod-gobi 0 0 1 0 0 0 1 2
mod-graphql 0 0 1 1 1 0 0 3
mod-inn-reach 0 0 6 6 0 0 0 12
mod-inventory 0 6 19 4 2 0 6 37
mod-inventory-storage 0 1 12 13 1 0 21 48
mod-inventory-update 0 0 1 0 0 0 0 1
mod-invoice 0 2 9 7 0 0 0 18
mod-invoice-storage 0 0 0 2 0 0 0 2
mod-kb-ebsco-java 0 1 0 9 0 0 3 13
mod-login 0 0 1 2 0 0 2 5
mod-login-saml 0 1 3 2 0 0 4 10
mod-ncip 0 0 0 0 0 0 4 4
mod-notes 0 0 0 2 0 0 0 2
mod-notify 0 0 0