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.
...
- 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 MEMBERSHIP2 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
- REQUIRE MEMBERSHIP2 A work must belong to at least one collection of this type
Advanced configurations:3
...
- 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 only use case identified for required membership is Admin Sets. Let me know if you have a use case for more than one collection type in a system requiring membership (i.e., all works must be a member of collection type Admin Set AND all works must be a member of collection type A).
3 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 by assigning a name and clicking Add (mockup)
Step 2: Define configurations (mockup)
Example Configurations - User Collections and Exhibits
...
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 |
---|---|---|---|
|
|
- SHARING
|
- SHARING
|
- SHARING
|
- SHARING
For a self-deposit site, there may be only one collection type defined, that is, the User Collections for a self-deposit site.
...
NOTE: Your site may define User Collections and Exhibits different than what is presented here.
...
FAQ
Table of Contents | ||||
---|---|---|---|---|
|
What about Admin Sets?
Admin Sets can be viewed as a collection type. For the initial implementation, the code controlling and managing Admin Sets will remain the same. Sites cannot change the configuration of Admin Sets. The configuration is defined by the code implementing the behaviors of Admin Sets. Effectively, the configuration is...
Admin Sets (effective) configuration |
---|
Basic:
|
|
- SHARING
Advanced:
|
UI changes
Since these configurations and the grouping functionality is consistent with the concept of Collections, the UI is being adjusted to show Admin Sets to users as though they were implemented as just another collection type. The UI adjustments include...
...
- Changes at this level to Admin Sets would require migration for existing sites.
- There is a lot of work required to create the extended functionality for collections. We don't want to add more if we can avoid it.
- We want to be sure that the collection extensions are solidly in place before requiring sites to migrate to Admin Sets as a collection type.
- All this is designed to minimize churn for those already moving toward production with Hyrax using the current definition of Admin Sets.
...
...
What happens when a configuration is changed and collections of that type already exist?
Once a collection of a type exists, the checkable configurations (i.e. Nestable, Discovery, Sharing, Multiple Membership, Require Membership, Workflow, and Visibility) can NOT be changed.
Why Not? If we allowed these to change, existing collections of that type would require transmogrification. This is not currently allowed for work types and is not planned for collection types due to the complexity of handling this on the fly.
You can continue to update Managers and Creators. And you can continue to add a new collection type, if needed.
...