ECS Documentation
- Joseph Reimers
- Dennis Bridges
- Khalilah Gambrell
This page is for documentation, videos, presentations and other similar ECS-related reference content.
ECS Glossary
Note: this glossary is a work in progress and subject to change/clarification
| Term | Description |
|---|---|
| Central tenant (aka Consortia/Administrative tenant) | The FOLIO tenant in an ECS implementation responsible for managing consortium-wide configurations, shared databases and other central management components. Tenant where mod-consortia is enabled |
| Data tenant/Member tenant | A FOLIO tenant in an ECS implementation responsible for managing a subset of records or other data types, with its own configuration, permissions and other local settings. When that tenant is largely self-sustaining with its own internal operations (e.g. an independent library within a consortium) it is a "member tenant". When that tenant is administrative and not fully autonomous (e.g. a special collection or part of a larger library), it is a "data tenant." |
| ECS (Enhanced Consortia Support) | A framework for allowing multiple FOLIO tenants to work together as a cohesive unit while allowing high levels of tenant-specific configuration, permissions and other local settings. |
| Local | Specific to one given tenant. A "local" instance record only supports holdings and items from that same tenant and not from other member tenants. |
| Promote | Transform a local instance record into a shared instance record |
| Shadow | A type of record used to synchronize data between central and data tenants. Users designated as "staff" at member tenants automatically create shadow users at the central tenant. |
| Shared | Common to all tenants across the consortium and managed at the Central tenant. A "shared" instance record supports holdings and items from any member/data tenant. |
| Affiliation | Association with a given tenant in a multitenant environment. "Primary affiliation" is the default association, "active affiliation" is the association during a given session. |
Primary Affiliation | Home tenant of user. Identifer of the tenant of a Primary User. Upon login the users Primary affiliation will be set to active |
Active Affiliation | Current tenant with which FOLIO actions are performed. Active affiliation is displayed in main navigation bar at all times. |
Shadow User | a user account created in a destination tenant to allow the principal in an originating tenant to act by proxy in the destination tenant. |
Primary User | a user account created in the active affiliation tenant. Acts as a primary link to shadow users in other tenants. |
Shared Instance | An Inventory instance that lives in the consortial tenant. Can be shared to other tenants in the consortium. |
Shadow Instance | Copy of a Shared Instance in a Member Tenant. |