Orchid (R1 2023) Release Notes

When can the action be taken (before, during or after upgrade)?

If applicable, detail what action(s) must be taken here

Is this action required for the next release?

HZ_CLUSTERNAME=nolana
HZ_CLUSTERNAME=orchid

While technically being a breaking change, this should not affect anyone because:

a) we never create requests without status programmatically

b) we scanned DBs of known tenants and did not find a single such request

Indexes are added automatically during the upgrade process.

Default DB configuration implies automatic analyzing of tables. In case it is disabled, execute ANALYZE command on mod-source-record-storage schemas.

• `inventory-view`
• `inventory-view-instance-set`
• `item-storage-dereferenced`
• `instance-storage`
• `instance-storage-batch-sync`
• `instance-storage-batch-sync-unsafe`
• `inventory`
• `inventory-batch`
• `search`
• `browse`

{
            "migrations": [
                "subjectSeriesMigration"
            ],
            "affectedEntities": [
                "INSTANCE"
            ]
        }

Migration could be done after the upgrade.
Migration could be sped up with scaling up mod-inventory-storage's replicas

Libraries should review and decide: 

1. If existing Instances should be refreshed against the updated map, so that all existing instances reflect these changes

See Update of mapping to change how Relator term is populated on instance record R1 2023 Orchid release for additional details.

Update: 21 April: an update script has been provided. 

Mandatory change. 

Note that any revised mappings will only apply to Instances created or updated via MARC Bibs after the map is updated. To refresh existing Instances against the current SRS MARC Bibs and current map, the library may consider running Script 3 described here: Scripts for Inventory, Source Record Storage, and Data Import Cleanup

Libraries should review and decide: 

1. If they would like this change included in their default map. If so, update the library's map, or have the hosting provider do it.
2. If existing Instances should be refreshed against the updated map, so that all existing instances reflect these changes

For stable operation, mod-oai-pmh  requires the following memory configuration. Java: -XX:MetaspaceSize=384m -XX:MaxMetaspaceSize=512m -Xmx2160m. Amazon Container: cpu - 2048, memory - 3072, memoryReservation - 2765.

edge-oai-pmh memory settings remain the same as in previous releases. Java: -XX:MetaspaceSize=384m -XX:MaxMetaspaceSize=512m -Xmx1440m. Amazon Container: cpu - 1024, memory - 1512, memoryReservation - 1360.

Multiple concurrent harvests of full library collection are currently not supported. Results of the performance tests when running multiple full harvests can be found here.   

mod oai-pmh provides APIs for monitoring the harvesting process as documented in the READ.ME file.

Additional information: OAI-PMH Best Practices

MARC Authority, Inventory, SRS, Data import

Instructions on how to update default MARC-Instance mapping rules are described here: Update to MARC Bib-to-Instance Default map changes to support Authority control feature

Update: 21 April: an update script has been provided. 

Mandatory change. 

Must be done after the mod-source-record-manager upgrade

Before initializing mod-search 2.0.x for a tenant,  add the following cluster-level permissions to the Opensearch role used by mod-search:   

cluster:admin/script/get
cluster:admin/script/put
cluster:admin/script/delete

The migration adds a foreign key for content_type.ct_content_type_fk referencing refdata_value.rdv_id. If rdv_id record has been deleted migration will fail with 

ERROR: insert or update on table "content_type" violates foreign key constraint "content_type_fk_rdvFK"

Before migration run SQL

SET search_path TO diku_mod_agreements;
DELETE FROM content_type WHERE ct_content_type_fk NOT IN (SELECT rdv_id FROM refdata_value);

Introduced to improve performance of the module and decrease dependency on other modules.

Increases number of records that can be bulk edited to 100k

Newly added Logs tab provides easy way to preview of current and past jobs.  It also provides access to the files used to trigger bulk edit and files generated during the bulk edit.

This module uses S3 storage for files. AWS S3 and Minio Server are supported for files storage. It is also necessary to specify variable S3_IS_AWS to determine if AWS S3 is used as files storage. By default, this variable is false and means that MinIO server is used as storage. This value should be true if AWS S3 is used.

To stable module operating the following configuration is required: Java args -XX:MetaspaceSize=384m -XX:MaxMetaspaceSize=512m -Xmx2048m, AWS container: memory - 3072, memory (soft limit) - 2600, cpu - 1024.

For other environmental variables see README.md

For the module design see Bulk Operations Redesign. 

In the UI permission named Settings (Data import): Can view, create, edit, and remove, these permissions were added

• ui-orders.orders.view (to enable view of the JSON tab for created orders)
• acquisitions-units.units.collection.get (to enable view and assignment of acquisitions units in the Order field mapping profile)
• organizations.organizations.collection.get (to enable organization lookup and assignment in the Invoice and Order field mapping profile)

Data Import

mod-data-import

In mod-data-import module permissions, these permissions were added to enable creation of order field mapping profiles and creation of orders with PO prefixes and suffixes:

• orders-storage.configuration.prefixes.collection.get
• orders-storage.configuration.suffixes.collection.get

mod-source-record-manager

mod-data-import

After update of the create invoice flow, the permission set has been updated. In order to support these changes in invoice data import flow, the permission set in mod-data-source-manager was updated to add:

• "orders-storage.order-invoice-relationships.item.post"
• "finance-storage.budget-expense-classes.collection.get"
• "finance.ledgers.collection.get"
• "finance.funds.budget.item.get"
• "finance-storage.fiscal-years.item.get"
• "finance.fiscal-years.item.get"
• "finance-storage.budgets.collection.get"
• "finance.transactions.collection.get"
• "finance.expense-classes.collection.get"
• "finance.exchange-rate.item.get"

Added permissions:

Bulk edit: Query - for the Query tab access

Bulk edit: Can view logs - for the Logs tab access