ECS: Changes and Required Actions Only Concerning Systems With Enhanced Consortia Support Enabled

Affected app or module

What has been changed or added that should be noted for this release

What challenges may arise related to this change or addition

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?

Name of user leaving comment: comment on what you encountered or ask a question @mention Contact person

User name of person that can provide additional detail.
Include issue link for bug fix, story or feature that applies

Enhanced Consortia Support

Added mod-consortia and ui-consortia-settings

Added for libraries that would like to run a multi-tenant FOLIO system. Please review the following documentation Steps to setup Consortia env. This will instruct you as to how and why you would enable this functionality.

 Configuration takes place after the upgrade

Applicable only for multi-tenant FOLIO customers. If site is not multi-tenant the are no actions required to disable these functions.

@Serhii_Nosko @Dennis Bridges 

Consortia, mod-search

A new tenant initialization parameter, "centralTenantId," is introduced to specify the tenant for database structure and index creation. This parameter is necessary because Elasticsearch indices and the database schema should only be generated for the central tenant. If the parameter is omitted, the tenant is assumed to be "not in consortia," and the indices and database schema are created. If the parameter is provided and it differs from the tenant for which the module is enabled, the tenant is considered a "member," and the indices and database structure are not generated.

This parameter is exclusively required for consortium-like environments and should be provided to all tenants within the consortium, both central and member tenants.

To pass the 'centralTenantId' parameter during the initialization of all consortium tenants (with the value of the central tenant ID), it should be included in the 'tenantParameters' parameter in the same way as we handle 'loadReference' and 'loadSample'. The format would be:

@Viacheslav Kolesnyk

MSEARCH-531

OAI-PMH

Consortial permissions required for institutional user when harvesting in consortial multitenant settings.

user-tenants.collection.get permission needs to be assigned to institutional user

Additional information: https://github.com/folio-org/edge-oai-pmh#multi-tenant-consortia-harvesting-setup

@Magda Zacharska

@Viachaslau Khandramai (Deactivated)  

@Mikita Siadykh 

Login

Changes made to mod-consortia, mod-login, mod-users, mod-authtoken. Username is unique across member tenants

If the cluster has existing users - all they should be processed by the consortium pipeline: Steps to setup Consortia env.  The process of adding tenants to the consortium will take care about migration of existing users that have a type that does not equal to 'patron' or 'dcb'.

For Forgot email/Forgot password functionality make sure that config entries for module 'USERSBL' like: 'FOLIO_HOST', 'RESET_PASSWORD_UI_PATH' populated for each tenant in the consortium. So no new params added, just make sure that all existing ones are populated for each tenant.

For mod-authtoken to be able to do cross tenant requests for ECS based envs need to populate system property: 'allow.cross.tenant.requests=true' 

Make sure that the DB schema for the central tenant is located in the DB cluster as schemas for all other tenants in the consortium.

@Serhii_Nosko 

Consortia manager

In an environment that has consortia functionality enabled (see above) There is now an area in settings where consortia membership can be edited.

Membership can only be edited in the UI. To add or remove members you must use APIs (see above for more info)

After migration

@Dennis Bridges @Serhii_Nosko 

Consortia manager

Settings areas that can be manipulated via the consortia manager now have a "source" field with a possible value of "consortium" OR "local"

No action is required but users should be aware they can only edit settings with source "local" unless they're in Consortium Manager.

N/A

@Dennis Bridges 

Users

User type is a required field. For non-consortia environments, it is optional but can be used if desired through the UI.

In a consortia environment, users must be given a type of "patron" OR "staff". There is also a type of "system" and "shadow", "dcb" that is used by FOLIO to manage user accounts and access across members.

Can not be ignored when creating users as it will be required in ECS environments. In non-ECS environments selecting a value or leaving this field blank will have no consequence. If a value is set it will be possible to filter accounts based on this data.

@Dennis Bridges