Glossary
Administrative Set (Admin Set): An organizing mechanism for one or more Works in the repository used for administrative purposes. Equipped with tools to configure Workflow, select default release and visibility settings for Works in the set, and to assign Users and Groups to deposit and manage Works in the set.
Bulkrax: Bulkrax is the default importer for Samvera applications, including support for OAI-PMH, CSV, and more (the list is growing). It is designed to be extensible, allowing you to easily add new importers in your application. Bulkrax provides a full admin interface including creating, editing, scheduling and reviewing imports, and error reporting. https://github.com/samvera/bulkrax
Collection: Created by a Repository Administrator or editor, a collection is a grouping of one or more Works, or nested under collection for hierarchy. Collections can be set to private, shared with select Users, Groups, or made discoverable. A single Work can be a member of one or more collection
Depositor: One of the default Groups in Hyku. Users in this Group are allowed to deposit Works into any Admin Set in their tenant.
Editor: One of the default Groups in Hyku. Users in this Group are allowed to read and edit all Collections and Works in their tenant regardless of public visibility settings. They can also: create Collections, deposit and approve Works, manage embargoes and leases, and manage Bulkrax importers and exporters.
Facets: Additional search filters, which appear on the left side of search results UI in Hyku (and Blacklight apps in general). These are typically indexed based on metadata and while Hyku has a default set, additional ones can be created by a developer.
FileSet: A set of files that represent the same file. For example, a book might include tiff, pdf, and text files representing the same page, or tiff, svg, and png files representing the same image.
Gem: In this context, a gem is an add-on to Hyku Core to make other features possible. A “gem” is a term specific to the Ruby coding language and Rails framework, which Samvera applications utilize, and is an optional code library that can be implemented into code.
Hyrax: Built on Samvera, Hyrax is a front-end that enables common digital collections management and institutional repository features, including creation of repository object types on demand, deposit of content via multiple configurable workflows, and description of content with flexible metadata. It lets institutions assemble and deploy robust and durable repository applications that are tailored to their users' needs and workflows. Hyku is a turn-key solution based on Hyrax.
IIIF Print: A gem (Rails "engine") for Hyrax-based digital repository applications to support displaying parent/child Works in the same viewer (Universal Viewer) and the ability to search OCR from the parent Work to the child Work(s).
Items: If a Work contains one or more files as well as nested (child) Works, then its file(s) child Works are referred to collectively as Items.
OCR: Stands for optical character recognition. IIIF Print allows Users to search for specific words within a Work’s universal viewer. To use OCR in your tenant, SSL configuration must be turned on in proprietor home page > Accounts > Edit a tenant or Dashboard > Settings > Account.
Proxy depositor: Depositors may designate proxies to deposit Works on their behalf. This feature can be turned on or off in Dashboard > Settings > Features.
Public User: A User who is not logged in to Hyku, and only has access to publicly-available repository pages and content.
Registered User: One of the default User Groups in Hyku, a Registered User is any user with a Hyku account. While logged in, a Registered User can access more repository functions than a Public User can, like the ability to submit works subject to approval.
Repository Administrator (Admin): One of the default User Groups in Hyku. The User with management control of a single tenant. Has access to all functionality available on the Administrative Dashboard, and is responsible for configuring the repository, creating and configuring Admin Sets, and assigning Groups and Roles.
Samvera: Samvera is a community of information and technology professionals who work together to make digitals collections accessible. The community maintains a set of Ruby on Rails components that, together, can be used to build flexible and extensible digital repository solutions.https://samvera.org/
Super Administrator (Super Admin): The User with full proprietor-level control of the entire Hyku instance. Can create/edit/delete new tenants and can create/edit/delete Users for all tenants. Can do all other functions Repository Administrators can perform. Retains these rights for every tenant.
Tenant: This refers to a single repository (sometimes also referred to as an “account” in the Super Admin interface) in a Hyku instance, which may contain multiple discrete repositories. You may have a single-tenant or multi-tenant repository. Each tenant has its own Users, Admin Sets, Collections, and Works. If your Hyku application is in a consortium, for instance, each tenant may be a different member library. Super Admin can control tenant settings on a proprietor level.
Universal Viewer (UV): The viewer on a Work’s show page that displays the contents of the Works. Can display images, PDFs, audio, and video.
Valkyrie: Valkyrie is the name of a Hyrax project that allows libraries to choose where their metadata and files reside. Previously, Fedora was used for this purpose. With this update, APIs have been included to choose Fedora, Postgres, Redis, DynamoDB, etc.
Work: A single organizational unit of content capable of containing one or more files or folders of files. Described by a metadata record which is indexed for discovery and access by Public Users. Can be shared with specific Users. Can be arranged hierarchically (“nested”) with other Works for more complex object structures.
Workflow: A Workflow is a process or set of steps to deposit items into the institutional repository. By default, Hyku has three workflows: single-step in which the item is deposited by the submitter; two-step in which the item is submitted for review before being added to the repository; proxy deposit in which a Depositor can grant their rights to another.