Skip to content
This repository has been archived by the owner on Dec 11, 2023. It is now read-only.

Candidate User Stories for Initial Capability

Jump to bottom
Jack Sheriff edited this page Dec 1, 2020 · 11 revisions

As a user...

I want to view the contents of a remote Collection Index (see issue #8)

  • The Collection Index may be at a remote URL or in a file on my local filesystem
  • If at a remote URL, the UI will call the Collection Manager to retrieve the Collection Index
  • If in a file on my local filesystem, the UI will read the file directly

Implementation Note: The Collection Manager app will support retrieving a Collection Index from a Remote URL (through the Collection Manager REST API)

I want to save the contents of a Collection Index in my organization's workspace

  • This only saves the index, it does not save the actual Collection data
  • If the Collection Index was retrieved from a remote URL, the remote URL will also be saved for later use

Implementation Note: The UI will save the Collection Index directly through the Workbench REST API

I want to view the Collection Indexes that have been saved in my organization's workspace

Implementation Note: The UI will retrieve the Collection Indexes directly through the Workbench REST API

I want to set the update policy for a Collection Index

  • The update policy may be manual or automatic
  • If manual, the Collection Index is only updated when the user explicitly requests an update
  • If automatic, the Collection Manager will periodically retrieve the Collection Index and update the database if the retrieved Collection Index is newer
  • The user may set the retrieval frequency

Implementation Note: The UI will saved changes to the Collection Index update policy directly through the Workbench REST API.

I want to manually refresh a Collection Index that has been saved in my organization's workspace (see issue #9)

  • Refresh means retrieving the Collection Index from the remote URL and saving it in the DB
  • May be used whether the update policy is manual or automatic
  • Updating a Collection Index overwrites the existing one
  • The Collection Index will be retrieved from the remote URL that the Collection Index was originally retrieved from

Implementation Note: The UI will call the Collection Manager app to refresh the Collection Index from a Remote URL (using the Collection Manager REST API)

I want the Collection Manager to automatically retrieve a Collection Index (see issue #10)

  • The update policy for the Collection Index must be automatic
  • Updates the saved Collection Index if the retrieved one is newer
  • Updating a Collection Index overwrites the existing one
  • May trigger a Collection import for subscribed collections

Implementation Note: The Collection Manager will support automatic retrieval of Collection Indexes. The initial implementation will stay current by polling the database for changes to update policies using the Workbench REST API.

I want to import a Collection into my organization's workspace (without a Collection Index) (see issue #11)

  • The Collection may be at a URL or in a file on my local filesystem
  • Allow preview of objects before importing
  • Allow user to select objects to be imported

Implementation Note: If the Collection is at a remote URL, the UI will call the Collection Manager to retrieve a Collection (using the Collection Manager REST API). The Collection Manager will return the Collection, but not save it in the database. If the Collection is in a file on the local filesystem, the UI will read the Collection directly from the file. The UI will save the Collection using the Workbench REST API.

I want to import a Collection into my organization's workspace (using a Collection Index) (see issue #11)

  • The Collection must be at a URL listed in the Collection Index
  • This may be combined with subscribing as one action
  • Allow preview of objects before importing
  • Allow user to select objects to be imported

Implementation Note: The UI will call the Collection Manager to retrieve the Collection (using the Collection Manager REST API). The Collection Manager will return the Collection, but not save it in the database. The UI will save the Collection using the Workbench REST API.

I want to subscribe to a Collection

  • Only available if the Collection is referenced by a Collection Index and the Collection Index update policy is set to automatic
  • The Collection Manager automatically imports the updated version of a Collection when the updated Collection Index indicates that a newer version of the Collection is available
  • Subscribing to a Collection triggers an import of the latest version of the Collection if it hasn't been imported already

Implementation Note: The UI will save changes to the Collection update policy directly through the Workbench REST API. This will trigger an automatic import the next time the Collection Manager retrieves the Collection Index if the latest version of the Collection has not been imported already.

I want the Collection Manager to automatically import the latest version of a Collection into my organization's workspace (see issue #12)

  • Triggered when the retrieved Collection Index indicates a newer version of the Collection is available
  • Only occurs if the Collection has been subscribed to
  • All objects will be imported (the user is not given the opportunity to select objects to be imported)

Implementation Note: The Collection Manager will support the automatic import of Collections. The automatic import of Collections is triggered by the retrieval of an updated Collection Index.

I want to view the Collection References and Collection Versions that belong to a Collection Index

  • Subscription information should be included in this view if applicable (a subscription is associated with a Collection Reference)
  • Imported Collection information should be included if applicable (an imported Collection is associated with a Collection Version)

Implementation Note: The UI will retrieve the Collection Index directly through the Workbench REST API. The Collection Index will contain the Collection References and Collection Versions

I want to view the Collections that have been subscribed to from my organization's workspace

Implementation Note: The UI will retrieve the Collection subscription status directly through the Workbench REST API

I want to view the Collections that have been imported into my organization's workspace

Implementation Note: The UI will retrieve the Collection import status directly through the Workbench REST API

Clone this wiki locally