Sufia Sprint UI Design

Owned by Bill Branan
Feb 23, 2024

The work linked from this page is outdated. The work of the Sufia User Interface Working Group has superseded this work. See also UI Wireframes from the Sufia 7 UI Working Group.

View wireframe mockups at...

  Behavioral Assumptions

Phase 1

Model Restrictions
  • Collection has 0..m member GenericWorks
  • GenericWork belongs to 0..m Collections
  • GenericWork has 0..m member GenericFiles
  • GenericFile belongs to 1 GenericWorks
  • GenericFile contains 1..m File(s) - only 1 of which was uploaded by the user; others are auto-generated
  • File belongs to 1 GenericFile
UI Impact
  • GenericWork can belong to 0 Collections
    • Dashboard requires My Collections and My Works.  Otherwise, works that are not members of a collection would not be available from Dashboard.
    • Browse requires browse Collections and browse Works. Otherwise, works that are not members of a collection would not be available from Browse.
    • remove from a collection instead of delete, because a work can live outside of a collection
  • GenericWork can belong to m Collections
    • remove from collection instead of delete, because the work may belong to another collection
    • Add Works page should include a note directing user to the dashboard to select existing works to include in the collection
    • delete work and remove from all collections is done through Dashboard -> My Works action list
  • GenericFile can belong to 1 GenericWorks
    • delete from work instead of remove, since the file cannot belong to another work
  • File belongs to 1..1 GenericFile
    • delete GenericFile deletes all contained Files

 

Phase 2

Model Restrictions
  • Collection has 0..m member Collections NEW
  • Collection belongs to 0..m Collections NEW
  • Collection has 0..m member GenericWorks
  • GenericWork belongs to 0..m Collections
  • GenericWork has 0..m member GenericWorks NEW
  • GenericWork belongs to 0..m GenericWorks NEW
  • GenericWork has 0..m member GenericFiles
  • GenericFile belongs to 1..m GenericWorks MODIFIED
  • GenericFile contains 1..m File(s) - only 1 of which was uploaded by the user; others are auto-generated
  • File belongs to 1 GenericFile
UI Impact

Only for new and modified...

  • Collection can belong to a Collections
  • GenericFile can belong to m GenericWorks
    • remove from work instead of delete, because the file may belong to another work
    • How do users select existing files to include in a work?  
      • For works, the user adds an existing work to a collection via Dashboard -> My Works -> select checkbox -> Add to Collection
      • There is no Dashboard -> My Files
    • How do users delete a file.
      • For works, the user deletes a work via Dashboard -> My Works -> a Work -> action menu: Delete
      • There is not Dashboard -> My Files

 

  UI Consistency FAQ
Should links be underlined?

No

 

Phase 1 - Required Basics for the Sprint

Exploring
Actions

 

Phase 2 - Building on Sprint Basics

Exploring
Actions
  • Apply ordering
    • to files in a multi-part work
    • to works within a collection
  • Set time limits on availability
    • embargo (delayed release)

    • lease (time limited release, e.g. 2 weeks)

       

Beyond PCDM – Out of Scope for the Sprint

  • Complex Modeling
    • General discussion of...
      • GenericWorks hasMember GenericWork vs. GenericFile hasMember GenericFile vs. both
    • Simple user managed sub-files
      • adding sub-files
      • viewing user managed sub-files
      • ordering of sub-files
    • Building Complex Models in Sufia
      • Book Model gem and integration with Sufia
      • Viewing complex models in Sufia
      • ordering within complex models

  • From Mike Giarlo's email about long term priorities

    • Mediated deposit workflows

    • More configurable/less rigid upload workflow

    • Administrative sets/APOs

    • "Curated" collections that can be highlighted on the homepage

    • Better (and more performant) support for large files

    • Work "types"

    • An administrative dashboard

    • A set of rich relationships that may be asserted between works and collections for more graph-like interrelationships between related works and collections

    • Finer-grained and more flexible control and configuration of derivatives (such as different-sized thumbnails, or preservation/access/web/service forms)

    • Integration with QA and LinkedVocabs/Oargun for more sophisticated vocabulary management

    • Better support for batch loading (via the CLI and administrative UI), especially for bags

    • Better support for streaming time-based media

"Worth clarifying: I'm not saying that all of the above code should *live* in Sufia. Rather we should endeavor to gemify so that other Hydra apps and engines can put these features to use as well. I think this has been a desideratum in Hydra for a good long while and a common challenge has been lack of a common data model. Now we have that in PCDM, so once it's implemented we should pay increased attention to gemification."  - Mike Giarlo

 

 

 

 

  Info you can ignore that I am using while developing the wireframes

 

Requests for additional wireframes...

Needed:

  • Upload/Create workflow
  • Edit a work
  • Edit a GenericFile (assuming there is descriptive metadata on GenericFiles. Consider "title" at least)
  • Add a new file(s) to a work
  • Remove a file from a work
  • Add work to a collection

Great comment.

Here now:

  • browsing collections from a non-depositor view point

Coming Soon

  • making a deposit
  • using the dashboard
    • Upload
    • My Files ("My Works" ?)
    • My Collections
  • impacts on search results