Page tree
Skip to end of metadata
Go to start of metadata

Sprint 1: May 7-18, 2018

Sprint Goals

(NOTE: Currently these goals are very high-level. They need to be broken down into specific tasks / tickets prior to the Sprint, so that those tickets are claimable by individuals.)

  1. Alphabetic jump to (specific letter) in results listing
    1. E.g. Jump to a Title / Author starting with a specific letter or string, like http://demo.dspace.org/xmlui/browse?type=title
  2. Build out Administrative Search/Browse tools (each of these tools is limited to Site Administrators)
    1. Find Item by Internal Item ID/Item Handle  (e.g. XMLUI: http://demo.dspace.org/xmlui/admin/item , JSPUI: http://demo.dspace.org/jspui/tools/edit-item)
    2. Administrative Search feature, which allows for faceted searching & browsing of "hidden" items.  This feature would replace the following two Administrative Browse use cases (by providing a way to filter items by withdrawn status and/or private status)
      1. Browse Withdrawn Items (by Title) (e.g. XMLUI: http://demo.dspace.org/xmlui/admin/withdrawn , JSPUI: http://demo.dspace.org/jspui/dspace-admin/withdrawn)
      2. Browse Private Items (by Title) (e.g. XMLUI: http://demo.dspace.org/xmlui/admin/private , JSPUI: http://demo.dspace.org/jspui/dspace-admin/privateitems)
  3. Administrative Edit Item form
    1. Build a simple edit item form that mirrors the existing XMLUI and JSPUI edit item pages (e.g. XMLUI: http://demo.dspace.org/xmlui/admin/item, JSPUI: http://demo.dspace.org/jspui/tools/edit-item)
      1. This form should allow Administrators to add/update/delete any metadata field values for this item.
      2. This form should allow Administrators to withdrawn/reinstantiate the item
      3. This form should allow Administrators to make the item discoverable/private
      4. This form should allow Administrators to add/update/delete bitstreams attached to the item.
      5. This form should allow Administrators to delete an item
  4. Improve developer documentation / getting up-to-speed documentation.

UI Tasks

These are somewhat lower level than the goals above, in order to get an idea of the effort required, but need more detail before they can be turned in to github issues

Alphabetic jump to (specific letter) in results listing

  • Service
    • Effort: 24h
    • To do

      • construct the Rest URL based on the params

      • parse the response

      • ensure everything gets cached properly

      • build remotedata objects for results

      • write tests

  • StartsWithComponent
    • Effort16h

    • To do

      • show letters as links
      • show a startswith input
      • handle the case for phone screens (too small to show the alphabet)
      • call the service with the correct query
      • links should work with js disabled
      • component should be abstract enough to be used with any kind of list
      • write tests
  • Browse By Title Component
    • Description
    • Effort: 8h
    • To do:
      • create the component
      • configure the routes
      • call the service with optional scope and metadatafield filters
      • configure existing components for alphabetic filtering, object lists and pagination to work with the correct data
      • write tests
  • Browse By Metadata Field Component:
    • Description
      • has an alphabetic selector or a date selector at the top
      • shows a list of metadata values
      • can be paged and sorted
      • links go to a browse by title view filtered by the scope and the metadatafield of this component
    • Effort: 16h
    • To do:
      • create the component
      • configure the routes
      • configure existing components for alphabetic filtering, object lists and pagination to work with the correct data
      • create a component to select by date
      • reuse the search’s date widget?
      • Create an object list entry for metadata values
      • the metadatafield it works with should be configurable: title, author, subject, etc.
      • this should reflect in the route e.g. /collection/:id/browse/title
      • and the i18n labels.
      • It should work with or without a scope
      • write tests

Build out Administrative Search/Browse tools (each of these tools is limited to Site Administrators)

Find Item by Internal Item ID/Item Handle
  • Routing by handle
    • Effort: 24h
    • To do:
      • Create an index that maps handles to self links
      • Modify the DSOResponseParsingService, to update the handle index every time an object is added to the cache
      • add hasByHandle and getByHandle methods to ObjectCacheService
      • modify RequestService.configure to check by handles as well to determine if something is cached.
        • perhaps make the fields to check for configurable, I could imaging a check by DOI for example
      • Add findByHandle to DataService
      • configure handle based routes, that redirect to the DSOType based route
      • write tests
  • Find Item admin component
    • Examples:
    • Effort: 8h
    • To do:
      • write a component that allows you to enter the ID or handle
      • on submit, determine whether it’s an id or a handle, and redirect to its edit page
      • configure the route, using a guard that limits access to authorized users
      • ensure the return button on the edit page returns you to the Find Item admin page
        • preferably by using the route history in the store (or even browser history) rather than specifying the source page as a param
      • write tests
Administrative Search

REST Tasks

These are somewhat lower level than the goals above, in order to get an idea of the effort required, but need more detail before they can be turned in to JIRA issues

Alphabetic jump to (specific letter) in results listing

  • Add REST method to compute the offset / specify the offset as a startWith
    • Effort: t.b.d
    • To do

      • write the contract

        • create a ticket on the github rest contract to discussion the best strategy

      • implement the new method / offset calculation strategy

      • write tests

Build out Administrative Search/Browse tools (each of these tools is limited to Site Administrators)

Find Item by Internal Item ID/Item Handle
  • Find a DSpaceObject by identifer (handle)
    • Effort: 8h
    • To do:
      • write the contract (it should be a redirect to the specific items/communities/collections endpoint)
      • implement a new dedicated controller
      • write tests
        • valid identifiers
        • unvalid identifiers
Administrative Search
  • Effort: 24h
  • To do:
    • introduce special withdrawn and private prefix for discover configuration
    • enable the discover controller to search over withdrawn and private items
      • fix the "public search" configuration to exclude withdrawn / private items
      • write a default discover configuration that reuse the default filters / facets
      • write a SolrSearchPlugin to exclude withdrawn and private items to non-administrators
    • write tests

Build out Administrative Edit item

Metadata representation
  • Express the metadata in the DSpaceObject as a map
Patch items
  • Add/Remove/reorder metadata
    • Effort: 24h
    • To do:
      • write the contract (it must be based on PATCH)
      • implement the patch method in the Item repository using a support class so to be reusable for each DSpaceObject (Collection, Community, EPerson, ...)
      • write tests
  • Withdrawn, Reinstatiate, make private or discoverable an item
    • Effort: 8h
    • To do:
      • write the contract (it must be based on PATCH)
      • implement the patch method in the Item repository
      • write tests
Delete an item
  • Effort: 8hr
  • To do:
    • write the contract (it must be a DELETE on the item endpoint)
    • implement the method in the item repository, it should consider where the item is used (it could be a template of a community/collection or wrapped in a workspace/workflow)
    • write tests
Manage bitstreams
  • Add bitstreams to an existent item
    • Effort: 8hr
    • To do:
      • write the contract (it should be based on POST multipart)
      • implement the method in the Item repository, it should be possible to specify the Bundle where the bitstream will be created
      • write tests
  • Delete bitstreams in an item
    • Effort: 8hr
    • To do:
      • write the contract (it must be a DELETE on the bitstreams endpoint)
      • implement the method in the bitstream repository, it should consider where the bitstream is used (it could be a logo of a community/collection)
      • write tests
  • Reorder the bitstreams of an item (out-of-scope?)
    • Effort: ???
    • To do:
      • write the contract (it should be based on PATCH... is the current item representation good enough?)
      • implement the method
      • write tests

 

  • No labels