Use Cases

The following technical use cases describe the component and system interactions in the DataONE infrastructure. The use cases describe functionality to address the broader scope user scenarios and overall project requirements.

Object Discovery, Access, Creation, Modification

• Use Case 01 - Get Object Identified by PID
• Use Case 02 - List PIDs By Search
• Use Case 04 - Create New Object
• Use Case 05 - Update Science Metadata
• Use Case 11 - CRUD Workflow Objects
• Use Case 24 - MNs and CNs Support Transactions
• Use Case 29 - CN Load Balancing
• Use Case 33 - Search for Data
• Use Case 34 - CNs Support Other Discovery Mechanisms (e.g. Google)
• Use Case 35 - Query Coordinating Node for Metadata Describing a Member Node
• Use Case 36 - Resolve an Object Location
• Use Case 37 - Get System Metadata for Object
• Use Case 38 - Reserve an Identifier
• Use Case 42 - Hide or Unhide an Object from Discovery

Synchronization and Replication

• Use Case 06 - MN Synchronize
• Use Case 08 - Replication Policy Communication
• Use Case 09 - Replicate MN to MN
• Use Case 35 - Query Coordinating Node for Metadata Describing a Member Node
• Use Case 37 - Get System Metadata for Object
• Use Case 40 - Member Node Requests Synchronization

User and System Authentication and Access Control

• Use Case 12 - User Authentication
• Use Case 13 - User Authorization
• Use Case 14 - System Authentication and Authorization
• Use Case 15 - Account Management
• Use Case 31 - Manage Access Policies
• Use Case 32 - Transfer Object Ownership

System and Content Integrity

• Use Case 03 - Register MN
• Use Case 10 - MN Status Reports
• Use Case 23 - Owner Expunge Content
• Use Case 24 - MNs and CNs Support Transactions
• Use Case 25 - Detect Damaged Content
• Use Case 26 - Data Quality Checks
• Use Case 27 - Metadata Version Migration
• Use Case 29 - CN Load Balancing
• Use Case 30 - MN Outage Notification
• Use Case 35 - Query Coordinating Node for Metadata Describing a Member Node
• Use Case 37 - Get System Metadata for Object
• Use Case 39 - Test Node APIs

Logging, Reporting, and Notification

• Use Case 16 - Log CRUD Operations
• Use Case 17 - CRUD Logs Aggregated at CNs
• Use Case 18 - MN Retrieve Aggregated Logs
• Use Case 19 - Retrieve Object Download Summary
• Use Case 20 - Owner Retrieve Aggregate Logs
• Use Case 21 - Owner Subscribe to CRUD Operations
• Use Case 28 - Derived Product Original Change Notification
• Use Case 30 - MN Outage Notification

---

Sequential List of Functional Use Cases

• Use Case 01 - Get Object Identified by PID
• Use Case 02 - List PIDs By Search
• Use Case 03 - Register MN
• Use Case 04 - Create New Object
• Use Case 05 - Update Science Metadata
• Use Case 06 - MN Synchronize
• Use Case 07 - CN Batch Upload (Dupe of UC06)
• Use Case 08 - Replication Policy Communication
• Use Case 09 - Replicate MN to MN
• Use Case 10 - MN Status Reports
• Use Case 11 - CRUD Workflow Objects
• Use Case 12 - User Authentication
• Use Case 13 - User Authorization
• Use Case 14 - System Authentication and Authorization
• Use Case 15 - Account Management
• Use Case 16 - Log CRUD Operations
• Use Case 17 - CRUD Logs Aggregated at CNs
• Use Case 18 - MN Retrieve Aggregated Logs
• Use Case 19 - Retrieve Object Download Summary
• Use Case 20 - Owner Retrieve Aggregate Logs
• Use Case 21 - Owner Subscribe to CRUD Operations
• Use Case 22 - Link/Citation Report for Owner
• Use Case 23 - Owner Expunge Content
• Use Case 24 - MNs and CNs Support Transactions
• Use Case 25 - Detect Damaged Content
• Use Case 26 - Data Quality Checks
• Use Case 27 - Metadata Version Migration
• Use Case 28 - Derived Product Original Change Notification
• Use Case 29 - CN Load Balancing
• Use Case 30 - MN Outage Notification
• Use Case 31 - Manage Access Policies
• Use Case 32 - Transfer Object Ownership
• Use Case 33 - Search for Data
• Use Case 34 - CNs Support Other Discovery Mechanisms (e.g. Google)
• Use Case 35 - Query Coordinating Node for Metadata Describing a Member Node
• Use Case 36 - Resolve an Object Location
• Use Case 37 - Get System Metadata for Object
• Use Case 38 - Reserve an Identifier
• Use Case 39 - Test Node APIs
• Use Case 40 - Member Node Requests Synchronization
• Use Case 41 - Archive an Object
• Use Case 42 - Hide or Unhide an Object from Discovery
• Use Case 43 - Index Content for Discovery
• Use Case 44 - Deprecate a Member Node

---

About Use Cases

An important early part in the process of system architecture is identifying the functional requirements that the resulting system should be able to address. Use cases are helpful for this as they describe how actors (typically entities external to the system) interact with system components. Interaction diagrams help define the interfaces and messages transmitted between components.

Use Case Layout

Each use case document is structured following a common template which includes the following elements.

Revisions

A link to the revision history of the document as recorded by subversion.

Goal

Brief description of what is intended with the use case.

Summary

An overview of the use case which includes the goal and major actors.

Use case diagram

A diagram representation of the use case, somewhat following the UML.

Sequence diagram

A sequence diagram that shows the operations involved in addressing the use case.

Actors

The participants in the use case - includes people and systems.

Preconditions

The conditions that must exist for the use case. For example, a particular use case may only be valid if the use has been authenticated.

Triggers

Describes the even that causes the use case to be initiated.

Postconditions

The state of the system after the use case - what conditions are true after the use case is completed.

Notes

Miscellaneous notes and discussion items that can’t be placed in the various categories. Comments should be annotated with time and author.