Getting Oriented: A Hyku Overview

Owned by Kevin Kochanski
Last updated: Nov 30, 2023
3 min read

Hyku is an open source software solution which is advanced by a community of contributors. It is continually in development and new features and changes are being added regularly. Updating this documentation is also a community effort. Depending on the version updates, this documentation may not reflect every instance of Hyku. While development continues, you may encounter pages or features that do not perfectly match what is depicted here.

For a detailed list of features, both implemented and planned, see the Hyku Features wiki page.

A Hyku application has two sides: the Dashboard for Registered Users and the Discovery view for public Users. When a User logs in to the application, they are on the Dashboard. The repository’s Discovery view, or public homepage, is accessed by clicking on the repository name or icon in the header, or by logging out of the application. Users can also navigate back to the Dashboard by clicking on their name in the header and clicking the “Dashboard” link.

Dashboard/Repository Activity

On login, users are redirected to their dashboard. This page will look different for Repository Administrators vs. public Registered Users.

Public Registered User Dashboard

Public Registered (non-Admin) Users will see:

Hyku Registered User Dashboard Menu options
Hyku Registered User Dashboard Menu

  • Activity

    • Repository Activity

      • Activity Summary

    • Your Activity

      • Profile - All Users have a profile which can be edited from here. It includes the number of collections and works created by the user, and space to include email, phone, address. Contact information for a User can only be edited by a Super Admin (see Manage Users Across the Entire Repository). “Edit Profile” allows users to update a profile photo and edit ORCID ID and social media handles; these fields only appear on the profile if they contain a value. Users can also curate highlighted works on their profile here.

      • Notifications - Displays anything that requires the user’s attention, including Work ownership change requests, approval status for mediated submissions, and batch Work updates. It includes a search bar to find notifications by keyword. Notifications can be deleted individually or with a “Delete All” button that clears them all.

      • Transfers - Work ownership can be transferred (see …). A log of transfer requests sent or received by the user is displayed here.

      • Manage Proxies - Users can allow other users to deposit Works on their behalf, which allows both users edit rights to those Works. In this UI, users can search for other registered users to assign or revoke these proxy rights. This can also be done at the individual work level for specific works.

  • Repository Contents

    • Collections - Lists any collections created by this users, with limited ability to administer changes.

    • Works - Lists any works created by this user, with limited ability to administer changes.

    • Importers - Non-admin users cannot access this module.

    • Exporters - Non-admin users cannot access this module.

 

Repository Administrator Dashboard

Administrator level Users will see:

  • Activity

Repository Activity

  • Activity Summary

  • System Status

  • Your Activity (same as Public Registered User)

    • Profile

    • Notifications

    • Transfers

    • Manage Proxies

  • Reports - Module for analytics reporting.

  • Repository Contents (same as Public Registered User)

    • Collections

    • Works

    • Importers

    • Exporters

  • Tasks

    • Review Submissions

    • Manage Users

    • Manage Groups

    • Manage Embargoes

    • Manage Leases

  • Configuration

    • Settings

      • Account

      • Identity Providers

      • Labels

      • Appearance

      • Collection Types

      • Pages

      • Content Blocks

      • Features

      • Available Work Types

    • Workflow Roles