Skip to content

Latest commit

 

History

History
63 lines (41 loc) · 4 KB

UC1.4-ViewProvenance.md

File metadata and controls

63 lines (41 loc) · 4 KB

Library Main Navigation:     Ecosystem Library Home   |  User Stories   |   Efforts   |   Library Help


Each use case represents a specific interaction requirement from the User/Actor perspective. This page details the following:

  • Intended Workflow which details the order of actions and describes actor decision points.
  • Sequence Diagram which models the flow of logic between actors and components in the system

See Library Help for answers to questions about Library documentation and related terms.



UC1.4: View Provenance


Related Efforts Related User Stories
E1: Data Repository Finder (enabling functionality)



Intended Workflow

A workflow is a description of a set of tasks that are necessary to accomplish a given goal for a given actor or actors. The intended workflow breaks a given use case down into actor starting and end points, actions, and decision points to describe actions as well as relationships between actions. Library documents require a list of preconditions for the workflow, and a description of the actions in the workflow to accompany the diagram.


Intended workflow for the View Provenance use case.

Preconditions

  • Publisher has been given an account with the system (becomes Publisher Registered User)
  • Publisher Registered User is logged into the system
  • Publisher Registered User views repository details page

Text Description

  • (Starting point) Publisher Registered User views repository information fields.
  • They view the change notes field in UI.
  • (Decision point) If they need more information, they request the change log from the developer, then view the change log sent from the developer. Otherwise,
  • (Decision point) If they agree with past decisions indicated in the change notes and/or change log, they publish the repository (see UC 1.2 Publish Repository) (end point), otherwise
  • They contact a Subject Matter Expert (SME) who edits the repository (see UC 1.3 Edit Repository) (end point).




Sequence Diagram

In UML, this diagram models the flow of logic within a system in a visual manner, enabling both documentation and validation of that logic. Sequence diagrams are commonly used for both analysis and design purposes. Library documentation requires a sequence diagram for each use case, and a description of the sequenced actions to accompany the diagram.

Sequence diagram for the View Provenance use case. Text description describes the workflow steps.>

Text Description

A Publisher Registered User who is logged in interacts with the User Interface(UI) component, Developer (Actor), and SME (Actor) in the following manner:

  1. They view the repository information fields in the UI
  2. They view the change notes in the UI
  3. They request the change log from the Developer (Actor).
    • Developer sends the change log.
  4. They publish the repository (see UC 1.2 Publish Repository)
  5. They contact the SME (Actor).
  6. SME edits the repository (see UC 1.3 Edit Repository)