Use Case 38 - Reserve an IdentifierΒΆ

Revisions

View document revision history.

Goal

Reserve an identifier to ensure it is available at some reasonable time in the future.

Summary

As new content is added to the DataONE system, it is desirable to reserve an identifier in advance of creating the content as it is necessary for the client to generate relationships between content that may not exist in the DataONE system (e.g. a new data set with associated science metadata).

Actors

ITK, Coordinating Node

Preconditions
  • CN and MN operational

Triggers
  • A client needs to reserve an identifier so that associations can be created in the system metadata

Post Conditions
  • An identifier is reserved and guaranteed to be unique for some finite period of time.

../../_images/b05cca189efaf573df8d8af9d42763835c3131b0d64acd75e8a8ed9b1a3f8874.svg

Figure 1. Use case 38. Note that id a Member Node needs to reserve an identifier then it would use the functioanlity of the Investigator Toolkit Library - that is, the reserveIdentifier operation is not required for Member Node functionality.

../../_images/099541d98558c6ca41a8a874bb78890e730e157acb668b050d79ca9f8073ff78.svg

Figure 2. Sequence diagram for use case 38. The Coordinating Node needs to keep track of identifiers that have been reserved, and this information needs to be replicated between Coordinating Nodes. The reserved identifier should not be discoverable and should not be involved with any Member Node synchronization or Member Node replication.