Okapi Permissions-to-Eureka Roles Converter Project

Feature Description

This feature involves developing an upgrade tool and process that translates Okapi Permissions and Permission Sets into Eureka Capabilities and Roles. The goal is to ensure that library administrators can manage the new Role-Capability structure effectively in Eureka, preserving operational logic and maintainability.

Challenges with the Existing Upgrade Process

(Per Vince B’s documentation)

• Unlimited Nesting:
  Okapi Permission Sets support nesting with no restriction on nesting levels.

• Institutional Customization:
  Permission Sets have been carefully curated and customized at each institution to create logical groupings for assigning staff permissions based on operational needs.

• Current Migration Tool Limitations:
  The existing Eureka migration tool offers basic conversion: it migrates users from Okapi Folio to Eureka Folio without loss of user functionality.
  However, this comes at a cost—carefully constructed permission sets and their logical, maintainable structure are mostly lost. The resulting configuration is difficult for library administrators to manage and adapt.

Proposed Solution: Flattening Before Migration

To address this, we propose flattening the existing Okapi permission structure prior to migration. This means:

• Flatten Nested Permission Sets:
  Break down nested Permission Sets into flat, non-nested lists, preserving all the operational permissions assigned to each staff member.

• Map Flat Sets to Capabilities and Roles:
  Translate these flat Permission Sets into Eureka Capabilities and group them into Roles that mirror the institution’s logical groupings as much as possible.

• Maintainability:
  The resulting Role-Capability structure in Eureka will be more transparent, easier to understand, and more maintainable for library administrators post-upgrade.

Next Steps

• Define a flattening algorithm that preserves all permission logic.

• Develop mapping rules from Okapi Permissions/Sets to Eureka Capabilities/Roles.

• Provide a migration preview/report so admins can review mappings before committing.

Rough Implementation Plan