Blog

Collection Types

Issue 1 of the Collection Extensions blog

Collection Extensions is an effort to create a consistent and flexible approach for grouping items in Hyrax repositories.  Implementation sprints are beginning Aug 7, 2017 (sign-up).


Use Cases

What is your use case for collecting together works?  The Collection Extensions Requirements Working Group identified several use cases.

 

Admin Sets

An administrative grouping of works that an administrative unit is ultimately responsible for managing. The set itself helps to manage the items within it. 

User Collections

An intellectual grouping of works, primarily used by individual users to create groups of items or favorites. 

Exhibits

A grouping of existing works into an exhibit oriented toward display of content to end users.

General Nested

Provide the ability to nest collections for the purpose of organizing content.  Several use cases fall into this category and have significant overlap of requirements.  These include DSpace migrated content (i.e. Community → Collection), organization unit based collections (e.g. University → School → Department; Agency → Sub-agency; etc.), and general nesting for organizing materials.  

 

Don’t see your use case?  That’s ok, because Collection Types allow you to define and configure your own type.

Configuring a Collection Type

You can add as many collection types as you need for your system.1  Before we start configuring types, let's look at the configuration options that define the behaviors of a collection type.

Basic configurations:

  • NESTABLE Allow collections to be nested (a collection can contain other collections)
  • MULTIPLE MEMBERSHIP  Allow a work to belong to multiple collections
  • DISCOVERY  Allow collections to be discoverable
  • REQUIRE MEMBERSHIP  A work must belong to at least one collection of this type
  • SHARING  Allow users to assign collection managers, depositors, and viewers for collections they manage

Advanced configurations:2

  • WORKFLOW Allow collections of this type to assign workflow to a new work
  • VISIBILITY  Allow collections of this type to assign initial visibility settings to a new work
  • CONTROL VISIBILITY  Visibility of works in collections of this type are controlled by the settings in the collection


Collection Participants:

  • assign Collection Managers (groups or users) who can edit collections other users have created, including adding to and removing works from a collection, modifying collection metadata, and deleting collections
  • assign Collection Creators (groups or users) who can create and manage their own collections


Footnotes:

1  Based on use cases identified so far, it is expected that the number of collection types will be less than 5.  If you have a use case requiring more, please let me know.  A large number of collection types has an impact on UI design.

2  The Advanced configurations are not expected to be part of the original sprint.  More information on these will be included in a later blog post.


Basic Configuration Process

The process for defining and configuring a collection type is quite simple.

Step 1:  Add a configuration type for User Collection  (mockup)


Step 2:  Define configurations  (mockup)

Example Configuration - User Collections and Exhibits

The current implementation of collections in Hyrax is the User Collection.  This implementation has worked well for some sites, but may be limiting for others.  In this example, we will look at several configurations. 1) a configuration that matches the current implementation of user collections, 2) user collections as they might be defined in a self-deposit site, 3) user collections as they might be defined in a staff curated site, and 4) exhibit collections that are curated by staff.

User Collections for a self-deposit site

In this case, general users who self-register for the system are providing all the content.  They are building collections that may have value to the public.  These user collections are discoverable by the public.

User Collections in a staff curated site

In this case, the content that is discoverable by the public are Exhibit type collections.  Staff curate the content that goes into exhibits.  User Collections in this site are used by staff to organize work they are responsible for in what ever way makes their work easier.  These personal collections are not exhibits for public view and are not discoverable.

Exhibit

In this definition of Exhibit type, Exhibit collections create a grouping of items for display to public users.


Current User Collection features (for reference)

User Collections for a self-deposit site

User Collections in a staff curated site

Exhibit
  • NESTABLE
  • MULTIPLE MEMBERSHIP
  • DISCOVERY (public by default)
  • REQUIRE MEMBERSHIP
  • SHARING
  • NESTABLE
  • MULTIPLE MEMBERSHIP
  • DISCOVERY
  • REQUIRE MEMBERSHIP
  • SHARING
  • NESTABLE
  • MULTIPLE MEMBERSHIP
  • DISCOVERY
  • REQUIRE MEMBERSHIP
  • SHARING
  • NESTABLE
  • MULTIPLE MEMBERSHIP
  • DISCOVERY
  • REQUIRE MEMBERSHIP
  • SHARING


For a self-deposit site, there may be only one collection type defined, that is, the User Collections for a self-deposit site.

For a curated site, there may be both User Collections in a staff curated site and Exhibit collections.


NOTE:  Your site may define User Collections and Exhibits different than what is presented here.




This is the first of several blog posts intended to raise awareness of the implementation effort to expand the functionality of collections.  Please don't hesitate to ask questions and get clarifications.  That will allow for better communication and solidify the design.



FAQ

What happens when a configuration is changed and collections of that type already exist?


Less Restrictive
(from Not-Allowed to Allowed)
More Restrictive
(from Allowed to Not-Allowed)


Easy approach...Moderate approach...Difficult approach...
NESTABLENo impactWarning that any collections already nested will remain nested.Warning that includes a count of the number of collections impacted.Warning + count + page to help with reconciliation.
MULTIPLE MEMBERSHIPNo impactWarning that any works already in collections of this type may continue to belong to multiple collections.Warning that includes a count of the number of collections impacted.Warning + count + page to help with reconciliation.
DISCOVERYRequires action to make existing collections discoverableWarning that collections already marked PUBLIC will remain discoverable.Warning that includes a count of the number of collections impacted.Warning + count + page to help with reconciliation.
REQUIRE MEMBERSHIPNo impactWarning that works already created may not be in a collection of this type.Warning that includes a count of the number of works impacted.Warning + count + page to help with reconciliation.
SHARINGNo impactWarning that works already created may have sharing privileges assigned.Warning that includes a count of the number of works impacted.Warning + count + page to help with reconciliation.


I would expect that these might change during development, but would stabilize by the time the system goes into production.  The easy approach may be sufficient.

NOTE: Changes to Workflow and Visibility do not have an impact.  They are used as templates when a work is created.  After that point, they do not control any aspect of the work.  The changes will only effect new works created after the change.