/
Glossary

Glossary

Administrative Set

An Administrative Set (AKA admin set) is an organizing mechanism for one or more Works in the repository used for administrative purposes. They are intended to provide repository administrators the ability to apply a workflow, define behaviors, and apply policies on a set of works.

Unlike Collections, Administrative Sets are not discoverable by searching or browsing the catalog. Only repository administrators can create an administrative set, but they can designate any user to have manager or edit access to an administrative set. All works must belong to one, and only one, Admin Set.

Bulkrax  

Bulkrax is the default bulk importer for Samvera applications, including support for OAI-PMH, CSV, and more. It is designed to be extensible, allowing repository administrators to easily add new importers in the application. Bulkrax provides a full admin interface including creating, editing, scheduling and reviewing imports, and error reporting. GitHub - samvera/bulkrax: Bulk Import and Export For Samvera

Child Work

The lower-level work in a work-to-work relationship. Children can have one or more parent works. The same work can be a parent and a child.

Collection

A grouping of works or collections. Any user in the system can create a Collection in Hyrax, but only users with access to the collection can add works to it. In Hyku, a repository administrator or editor must create the collection. 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 collections.

Collection Type (Hyrax only)

Collection Types provide a means for configuring behavior of collections within a site. The configuration options are nesting, sharing, discovery, multiple-membership, and branding. Once collections of a type have been created, these configurations can no longer be changed.

Collection Type Templates (Hyrax only)

Collection type templates define the participants for a collection based on it’s collection type. The template is created through the UI when a collection type is created or edited. It is applied to collections when the collections are created, but any changes to the template will only be applied to new collections created after the change.

Depositor

Depositor is one of the default groups in both Hyrax and Hyku. In Hyku, users in this Group are allowed to deposit Works into any Admin Set in their tenant. In Hyrax, users in this group can deposit to any administrative set to which they are given access. It is possible in Hyrax to allow all registered users to deposit to a particular administrative set.

Editor (Hyku only)

Editor is 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

Facets are additional search filters, which appear on the left side of the search results UI in both Hyku and Hyrax. These are typically indexed based on metadata and while both products have a default set, additional facets can be created by a developer.

Fileset

The container representing a single file uploaded to the repository. The set holds the original uploaded file and any generated derivative files (e.g. thumbnails, full text, etc.). A work can consist of one or many filesets.

Gem

A gem is an add-on to Hyku or Hyrax to make other features possible. A “gem” is a term specific to the Ruby coding language and Rails framework, which Samvera applications utilize.

Groups

Groups consists of several users which are controlled by repository administrators. Groups can be assigned as Participants for Collection Types and Admin Sets and given Sharing roles for Collections and Works.

Hyku

Hyku is a turn-key solution based on Hyrax.

Hyrax

Hyrax is a front-end repository solution 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.

IIIF Print

A gem for Hyrax and Hyku to support displaying parent and child Works in the same 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.

Knapsack (Hyku only)

A layer on top of Hyku that enables customizations without sacrificing maintainability, and upgrade compatibility.

Mediated deposit

An out-of-the-box workflow for works in Hyrax and Hyku. In this workflow, a work must be approved by an administrative set manager or repository administrator before it is published.

OCR

OCR is an acronym for Optical Character Recognition. In Hyku, the IIIF Print gem allows Users to search for specific words within a Work’s universal viewer. To use OCR in your Hyku tenant, SSL configuration must be turned on in proprietor home page > Accounts > Edit a tenant or Dashboard > Settings > Account.

Parent Work

The higher-level work in a work-to-work relationship where there is at least one child work relationship established. Parents can have one or more child works. The same work can be a parent and a child.

Participants

Assigning participants to Administrative Sets allows the repository manager to define what individual users or groups of users can do with or to items in an Admin Set, such as deposit, approve, edit, or withdraw.

Participants for Collection Types allow the repository manager to define which individual users or groups of users can have roles related to collections of a type. A manager is given full edit access to collections of this type. A creator is allowed to create new collections of this type.

Permission Templates

A template that defines the Visibility, Release, Workflow, and Participants for an Admin Set or Collection. The template is applied to works when the work is created. The template is created through the UI when an Admin Set or Collection is created or edited. Changes to the template are not applied to existing works and will only affect new works created after the change.

Proxy

A user who can deposit works on behalf of another user. This feature can be turned on or off in Dashboard > Settings > Features.

Public User

A user who is not logged in to Hyku or Hyrax, and only has access to publicly-available repository pages and content.

Registered User

Registered User is any user with a Hyku or Hyrax account. While logged in, a Registered User can access more repository functions than a Public User can, like the ability to deposit works. Registered user is a default user group in both Hyku and Hyrax.

Repository Administrator

Repository administrators (AKA repository admin or repo admin) are one of the default user groups in both Hyrax and Hyku, but their permissions vary depending on the system.

In Hyku, repository administrators have management control of a single tenant. They have access to all functionality available on the Administrative Dashboard, and are responsible for configuring the repository, creating and configuring Admin Sets, and assigning Groups and Roles.

In Hyrax, repository administrators have management control of the entire repository. They have access to all functionality available on the Administrative Dashboard, and are responsible for configuring the repository, creating and configuring Admin Sets, and assigning Groups and Roles. They can override settings configured by managers.

Repository Object Roles

Repository object roles allow a category of user to perform action on specific repository objects like collection types, administrative sets, collections and works. These include:

  • Manager and Creators of a Collection Type

  • Viewers, Depositors, Managers of an Administrative Set

  • Viewers, Depositors, Managers of a Collection

  • Work Editors, Viewers

Resource Type

A classification for content that is assigned to the Work by the depositor, such as Article, Dataset, and Image. Resource Types are discoverable via facet by default.

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. Hyrax and Hyku are two products developed by the Samvera Community.Samvera - a vibrant and welcoming community developing repository software tools

Sharing

Sharing roles allow depositors of a work or managers of a collection to give access to the work or collection to others.

For collections, users given manager access are given full edit access to the collection. Depositors can add resources to the collection. And viewers can see the collection even when it is private. These roles can optionally be applied to works created in the collection.

Works can be shared by giving individual users or groups of users edit access or read access. Edit access give the users full editing access to the work. Read access allows users to view the work even when it is private.

Super Administrator (Hyku only)

In Hyku, a super administrator (or super admin) is the user with full proprietor-level control of the entire Hyku instance. They can create/edit/delete new tenants and can create/edit/delete Users for all tenants. Also, they can do all other functions Repository Administrators can perform. The super admin retains these rights for every tenant.

System Roles

System roles are categories of users which exist within Hyrax or Hyku that allow the user to perform actions within the repository. In Hyrax, the repository administrator role is the only system-wide role which exists out of the box. Additional system roles include registered user and public user. Hyku has an additional system role of super administrator.

Technical Metadata

Technical metadata are properties automatically stored describing technical aspects of files or other objects (for example: file size, format, and mime type). These properties are not editable.

For Hyrax and Hyku, Technical Metadata Application Profile provides recommendations for technical metadata properties to store and default. Hyrax more than likely uses most of these properties but it is possible that not every property is implemented. Additionally, File Use Vocabulary offers roles that can be applied per file to further manage which file to use in a given context. Hyrax by default might be using some of these roles (Original File, Thumbnail Image, Extracted Text) but it is not likely that all of them are in place.

Avalon Metadata provides information about technical metadata stored about files and objects in Avalon Media System.

Tenant (Hyku only)

A tenant 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. It is possible to have a single-tenant or multi-tenant repository. Each tenant has its own Users, Admin Sets, Collections, and Works. If a Hyku application is in a consortium, for instance, each tenant may be a different member library. The 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. It can display images, PDFs, audio, and video.

Valkyrie

Valkyrie is a Hyrax project which allows administrators to choose the system which stores their metadata and files. Prior to Valkyrie, administrators were limited to Fedora only. After Valkyrie, administrators can choose any file store, although only Postgres and Fedora are formally supported.

Work

A single organizational unit of content that can contain one or more files or folders of files. It is described by a metadata record which is indexed for discovery and access. Works can be shared with specific users and arranged hierarchically (“nested”) with other Works for more complex object structures.

Work Ownership

Works are usually owned by the user who makes the deposit, unless that user is a Proxy for another user. Work ownership can be transferred between current users of the system.

Work Type

A classification tool for the submission of distinct types of works. Custom work types can be generated to allow different descriptive metadata to be collected as appropriate for the classification. Work Types are discoverable via facet by default. Examples include: Publication, Dataset, Image.

Workflow

A Workflow is a process or set of steps to deposit items into a repository. Hyrax and Hyku have two workflows out-of-the-box: a single-step (or default) in which the work is published when deposited and a two-step in which the work is submitted for review before being published.

Workflow Roles

Workflow roles specify actions that a category of user can perform in a workflow, such as creating or approving a work.