Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Create from Template
spaceKeyDSPAC
blueprintModuleCompleteKeycom.atlassian.confluence.plugins.confluence-software-blueprints:requirements-blueprint
templateNamecom.atlassian.confluence.plugins.confluence-software-blueprints:requirements-blueprint
buttonLabelAdd Product requirements

...

Core RequirementSummary Notes/DecisionsWho can execute it? Metadata or Services group?  Which system would this be done through

Priority level: Must have/Should have/Could have/Won't have

(Services)

TicketsReference links

Standard repository features

Searching, Facets, thumbnails, search results interface, item interface, customizable header footer and landing page


Devs

or

Gabe/Chin

SBlacklight/DSpace custom/DSpace standardMust Have

DOIs- autogenerationDOIs generated automatically, or at the push of a button
Gabe/Chin

S

M

DSpace back end

S: Must have 

M: Must have


Out of the box DOI integration:  https://wiki.duraspace.org/display/DSDOC6x/DOI+Digital+Object+Identifier
Customize Facets for displayCustomizable facets
Gabe/ChinS

Blacklight/DSpace custom

Must have
Jira Legacy
serverSystem JIRA
serverId72190e5c-ce35-3f39-b915-64292d694deb
keyDSPAC-71

Procedure: https://wiki.duraspace.org/pages/viewpage.action?pageId=30218817


Citation generationAutomatic Citation generation, either via DSpace's native features or some sort of external plugin that functions through the interface
DevsSBlacklight/DSpace custom/DSpace standardShould have 
Jira Legacy
serverSystem JIRA
serverId72190e5c-ce35-3f39-b915-64292d694deb
keyDSPAC-73
https://wiki.duraspace.org/display/DSPACE/Citation+Generation
Direct Submission form- form A direct submission form through which faculty can submit
Gabe/ChinSDSpace back endMust have
Jira Legacy
serverSystem JIRA
serverId72190e5c-ce35-3f39-b915-64292d694deb
keyDSPAC-68

Documentation:  https://wiki.duraspace.org/display/DSDOC6x/Submission+User+Interface

Input forms customized via: https://github.com/DSpace/dspace-release/blob/master/config/input-forms.xml (The form-map maps collection handles to forms.)

Item submission process customized via this:  https://github.com/DSpace/DSpace/blob/master/dspace/config/item-submission.xml  (The process-map maps collection handles to a particular Item Submission Process.)

slide deck: https://www.slideshare.net/bramluyten/secrets-of-the-dspace-submission-form


Direct Submission form- Public access via web A way to authenticate users submitting through the form, probably via TUID/LDAPExternal to DSpace in some regard.  Gabe/ChinSDSpace back endMust have
Jira Legacy
serverSystem JIRA
serverId72190e5c-ce35-3f39-b915-64292d694deb
keyDSPAC-82

https://wiki.duraspace.org/display/DSDOC6x/Authentication+Plugins

Homepage customizedCustomizable display layer, including homepage, subpage, configurable interface, customizable facets, etc.

Devs

Gabe/Chin

SBlacklight/DSpace front end custom/DSpace front end standardMust have
Jira Legacy
serverSystem JIRA
serverId72190e5c-ce35-3f39-b915-64292d694deb
keyDSPAC-76

'Making DSpace your own' webinar

https://www.slideshare.net/DuraSpace/42418-making-dspace-your-own-webinar-recording

Here's the custom code from the webinar

https://github.com/DSpace-Labs/DSpace-rel-demo

Documentation portalA place to contain our policies and advisory text External to DSpace, as well as a part of the custom homepage?SBlacklight/DSpace front end customMust have
Jira Legacy
serverSystem JIRA
serverId72190e5c-ce35-3f39-b915-64292d694deb
keyDSPAC-77

Customize simple item display- structural Ability to customize the features of each page.  For example, adjusting thumbnail size.Doable out-of-the box up until a point.  Would require dev support for more sophisticated integrations.  

Devs

Gabe/Chin

SBlacklight/DSpace front end custom/DSpace front end standardCould have
Jira Legacy
serverSystem JIRA
serverId72190e5c-ce35-3f39-b915-64292d694deb
keyDSPAC-79
Thread: https://groups.google.com/forum/#!searchin/dspace-tech/orcid|sort:date/dspace-tech/f_BZETZYXiM/mavRYst_AwAJ
Visual improvements/aesthetic upgrades to the interface (search results, item view, and homepage)

Devs
Blacklight/DSpace front end custom/DSpace front end standardMust have

Customizable search results interface- structural

Devs
Blacklight/DSpace front end custom/DSpace front end standardCould have

View and download counts Analytics integrated into front endConfigurable through Mirage2

Devs

Gabe/Chin

SBlacklight/DSpace front end customMust have
Jira Legacy
serverSystem JIRA
serverId72190e5c-ce35-3f39-b915-64292d694deb
keyDSPAC-78

Documentation: 

https://wiki.duraspace.org/display/DSDOC6x/DSpace+Google+Analytics+Statistics


RAMP:

http://ramp.montana.edu/

Analytics (back end)Site admins can retrieve and run reports on analytics
Gabe/Chin
DSpace back endMust have

Social media/Sharing buttonsSocial media sharing buttons
?SBlacklight/DSpace front end customShould have
Links/buttons for sharing work via social media (Twitter, Facebook/LinkedIn)
Share via email button or function

Devs
Blacklight/DSpace front end customShould have 

New human-readable URLCustomizable URL

Yes it's implementable.

The Services group must decide on the URL

Gabe/ChinSDSpace back endMust have
Jira Legacy
serverSystem JIRA
serverId72190e5c-ce35-3f39-b915-64292d694deb
keyDSPAC-81

Thumbnails next to recently added
Requires customization of DSpace's front-end code

Devs

SBlacklight/DSpace front end custom/DSpace front end standardCould have

ADA note integrated into interface

DevsSBlacklight/DSpace front end custom/DSpace front end standardMust have

ORCID integration- front end

Green ORCID button linking back to author's ORCID profile, as in DukeSpace

Devs

SBlacklight/DSpace front end customMust haveDSPAC-65- ORCID strategyIN PROGRESS

Cambridge: https://www.repository.cam.ac.uk/handle/1810/266430

Duke: https://dukespace.lib.duke.edu/dspace/handle/10161/8875

DSpace orcid documentation: https://wiki.duraspace.org/display/DSDOC6x/ORCID+Integration

Thread on v6.2 compatibility and 6.3 errors

https://groups.google.com/forum/#!topic/dspace-tech/N_azMfWalD8

GG's orcid doc: https://docs.google.com/document/d/1ump6tlTrd62nvDoXo4I9GBsSdLs5SeY7k1flP2InYTs/edit

6.3 errors doc: 

https://groups.google.com/forum/#!searchin/dspace-tech/orcid|sort:date/dspace-tech/09qKMO-qTyM/lMAKDz04AAAJ

https://groups.google.com/forum/#!searchin/dspace-tech/orcid|sort:date/dspace-tech/N_azMfWalD8/Kzhwner5GQAJ

collating fields in advanced search Combining two fields separated on the back end for practical reasons into a single field in the advanced search UIDefinitely a developer taskDevsMDSpace back end Should have
See: http://kim-shepherd.blogspot.com/2010/11/discovering-discovery-dspace-solr-tips.html
Transform language codes (or any metadata value) into full words via display layer the field contains the value 'en' but the interface displays the word 'English'This is doable through the tweaking of the native theme or another theme like Mirage2.  I was unable to find a way to do this other than through the themeDevsMBlacklight/DSpace front end custom/DSpace front end standardMust haveDSPAC-66- Transform language codes for display TO DO

Thread on the topic: 

http://dspace.2283337.n4.nabble.com/A-way-to-alter-metadata-values-for-display-td4689929.html#a4689930

Thread: https://groups.google.com/forum/#!searchin/dspace-tech/orcid|sort:date/dspace-tech/f_BZETZYXiM/mavRYst_AwAJ

Auto-Generate MIME types



Automatically populate a field with MIME type values based on file extensionLast option- contact Texas Uni  DevsMDSpace back endShould haveDSPAC-75- Auto-generate MIME types TO DO

See convo with Andrea Schweer

Notes from Services Metadata meeting:  This will impact how cumbersome the workflow is for the IR manager.  How cumbersome will depend on the volume of submissions, which is currently unknown.  

SWORD mapping from ProQuestAutomatic ingests of ETDs and associated metadata from ProQuest, plus mappingOngoing

Gabe/Chin/Holly

Possibly Devs

MDSpace back endShould haveDSPAC-60- SWORD Mapping; PQ->DSpaceIN PROGRESS

DSpace METS SIP Profile: https://wiki.duraspace.org/display/DSPACE/DSpaceMETSSIPProfile

Extend embargo functionality 



It can easily be enabled in the submission form.  To auto-apply embargos via imported ProQuest metadata we need to provide an exact lift date.  Two additional back-end fields must be implemented, embargo.field.terms and embargo.field.lift.  

Note that there may be an exact date in the regular metadata from proquest ETD admin

Gabe/ChinMDSpace back endMust have DSPAC-63- Extending embargo functionality- feasibility IN PROGRESS

Embargo documentation https://wiki.duraspace.org/display/DSDOC6x/DSpace+6.x+Documentation

Implement a variation on this for 'six month', '1 year', etc.: http://wiki.lib.sun.ac.za/index.php?title=SUNScholar/Embargo_Systems/1.8.X

Embargo setter javascript: https://github.com/DSpace/DSpace/blob/master/dspace-api/src/main/java/org/dspace/embargo/DefaultEmbargoSetter.java


CVs- internal list

Gabe/ChinMDSpace back endMust haveDSPAC-80- Controlled VocabsTO DOhttps://wiki.duraspace.org/display/DSPACE/Authority+Control+of+Metadata+Values
CVs- external lookup (via something like LCSH)

Gabe/ChinMDSpace back endCould have

CVs- ORCID

Should be straightforward

Note:  The Services group's ORCID enhancement depends on this.  

Gabe/ChinMDSpace back endCould have 

https://wiki.duraspace.org/display/DSDOC6x/ORCID+Integration

Mirage2 theme-implementCustomizable display layer, including homepage, subpage, configurable interface, customizable facets, etc.
Gabe/ChinSNANA
Jira Legacy
serverSystem JIRA
serverId72190e5c-ce35-3f39-b915-64292d694deb
keyDSPAC-67

Meeting Example:  https://atmire.com/preview/browse?type=title

See note on this page, specifically 'Enabling and building the DSpace 5 Mirage 2 theme' for troubleshooting ideas

Thread on error encountered by Chin, with Fix by Tim Donohue

DOI patchFix for 6.x DOI prob

Gabe/Chin

Maybe devs

S

M

NANA

Thread on the issue: 

https://groups.google.com/forum/#!topic/dspace-tech/EQUlVrif-u8

The old DIM2DataCite.xsl crosswalk: https://github.com/DSpace/DSpace/blob/master/dspace/config/crosswalks/DIM2DataCite.xsl

Patched DIM2DataCite.xsl crosswalk: https://github.com/DSpace/DSpace/pull/2321/commits 

Upgrade to 6.3

Make a backup plan and implement first.  


Use Meld to find versions of our file

Gabe/Chin

M

S

NANADSPAC-72- Upgrade to 6.3IN PROGRESS

Note: DSpace 7.0 will be released mid 2019

https://www.youtube.com/watch?v=JBH0A3QwBUk . (see 18:36 for directories to back up... back up a) sql and solr databases.  see 20:30, section on using meld to discover differences.  23:50 for folders to check for changes)

More Issues
See Jira Board





...

Core FunctionalityRequirementsComplications and question: Notes/DecisionsJira TicketsReference Links
DOI generation

DOI agency integrated with DSpace

DSpace, when configured so that DOI generation is integrated, automatically generates a DOI for each item added to the repository.  

    1. Would this be acceptable?   

    2. If not, how would generating DOIs manually look, workflow-wise?

    3. How would we deal with the fact that many articles deposited via our RIM already have DOIs?  The DOIs generated in DSpace would have to be manually deleted, and we'd have to get DOIs imported through Elements into the same field as DOIs generated by DSpace.


Jira Legacy
serverSystem JIRA
serverId72190e5c-ce35-3f39-b915-64292d694deb
keyDSPAC-3

DOI generationManual retrieval and entry of DOIs

How would manual generation of DOIs through a new Libraries CrossRef membership work?  This would be the simplest solution, however would require more manual intervention per-item.  

    1. Would be a cataloger task?

    2. Would this happen through a process integrated into the metadata approval process?  




Subscribing to a DOI Registration agency

We'll need to join a DOI registration service
  1. Crossref -which is difficult to integrate with DSpace and may require dev support for DSpace integration- is cheap ($275 yearly, $1 per DOI).  

  2. DataCite -which integrates easily with DSpace- is, annecdotally at least, far more expensive (7k yearly?!?);  Their pricing is opaque, we’d have to get a quote.


Jira Legacy
serverSystem JIRA
serverId72190e5c-ce35-3f39-b915-64292d694deb
keyDSPAC-37

Jira Legacy
serverSystem JIRA
serverId72190e5c-ce35-3f39-b915-64292d694deb
keyDSPAC-41



DOIs for dataDecide if we want DOIs for data
  1. It’s a complicated question… look at the Australian National Data Services guidelines

    1. Would we have to follow something like this?  

    1. ANDS guide

    2. Decision tree




...

Core FunctionalityRequirementsComplications and question: Notes/DecisionsJira TicketsReference Links
Elements Deposit interface- customize statements

Guidance text- we'll need to provide a statement

Institutional Advice- we'll need to provide a statement



Jira Legacy
serverSystem JIRA
serverId72190e5c-ce35-3f39-b915-64292d694deb
keyDSPAC-32
https://docs.google.com/document/d/1p57lEx70eWyYMhd_EIAias7f9-H-U7Ecb8pKpLnsJ-E/edit

DSpace- licenses

Customize license for Elements→DSpace submission workflow

We may not have to use this... the interface a faculty submitter will have to use is the Elements interface


DSpace- licensesCustomize license/advisory text for Direct Submission→DSpace  workflow



ADA policiesDetermine what they are and how they affect our configurationA text readable layer is required on all digital objects.  This means that the ETD PDFs will have to be OCRed, as well as PDFs ingested via Elements.  


Workflow considerations

Core FunctionalityRequirementsComplications and question: Notes/DecisionsJira TicketsReference Links
Implementation of 'deposit' button in Elements

a deposit embedded in the Elements interface, usable by both library staff and faculty users of our RIMS 

It must be enabled universally.  Is this a problem?  

This functionality cannot be limited only to certain classes of user.  

The crosswalk allows us to move items deposited from Elements→DSpace to specific dspace collections based on their 'publication type' status in elements.  This could be one solution.  




Library mediated deposits from Elements→DSpace

We've discussed having the library deposit from Elements to DSpace on faculty member's behalf.  

One complication is that Elements indexes articles hosted in other systems, but does not ingest copies of articles.  What are the workflow and legal implications of downloading these articles directly from the publication.

Another complication is that many journals allow the deposit of the preprint or accepted version, but not the publisher's version.  How would we obtain one of the permissible versions, which would be unpublished.  




Dark archive?We could set up a DSpace collection shielded from the public that would facilitate the long term preservation of faculty research, while keeping it in accessible due to legal complications

Is this worth it?  

Is this too far in the wrong direction re: open access?




...