Difference between revisions of "NSDL Registry Use Case Documentation (Schemas)"

From Metadata-Registry
Jump to: navigation, search
m
Line 187: Line 187:
  
 
==Use Case 8: Change Semantics of a Schema Element—Non-Hosted Schema==
 
==Use Case 8: Change Semantics of a Schema Element—Non-Hosted Schema==
 +
;Purpose:An NSDL project wants to edit the information associated with a specific element hosted in a namespace other than the Registry.  <u>Note</u>:  The editing process for this use case is handled outside the Registry; therefore, the primary function of the use case is the uploading of a revised element set.
 +
;Primary Actor:Maintainer
 +
;Prerequisites:
 +
#The Maintainer has already been associated with a Registry description of the relevant element set
 +
#The element set to be changed is hosted and maintained in a namespace outside the Registry
 +
#Edits to the element have been handled in the Organization's namespace according to its own editorial and versioning processes
 +
<b>Sequence</b>
 +
#Maintainer accesses the <i>Element Set Maintenance</i> page
 +
#Maintainer searches for the element set description amongst the descriptions assigned the Maintainer
 +
#Maintainer selects the file upload function for an existing schema
 +
#Maintainer selects the element set file to upload by:
 +
##Finding the element set file on the Maintainer's local machine; or
 +
##Providing a network address where the encoded file may be found
 +
#Maintainer uploads the element set file
 +
#Maintainer either:
 +
##Saves the element set in order to continue work later (without affecting the published version); or
 +
##Submits the completed element set to the Registry
 +
#Upon submission, Registry validates the input
 +
#If the element set does not validate, an email notification is sent to the associated Maintainer that includes error messages associated with the process, a link to a FAQ detailing the error messages and possible next steps
 +
#If the element set passes validation routines:
 +
##An email notification is sent to the Maintainer (and the Organization Contact)
 +
##The Registry queues the file for Registry Manager and/or Editor/Reviewer
 +
#Upon review, Registry Manager submits the edited element set to the Registry
 +
#Registry:
 +
##Backs up the old version of the schema
 +
##Registers and publishes the new version of the schema
 +
##Associates the old and new versions of the schema
 +
;Result:
 +
#The editing transaction has been backed up
 +
#Revised element set has been registered and published
  
 
==Use Case 9: Change Status of a Schema Element&#8212;Hosted Schema==
 
==Use Case 9: Change Status of a Schema Element&#8212;Hosted Schema==
  
 
==Use Case 10: Change Status of a Schema Element&#8212;Non-Hosted Schema==
 
==Use Case 10: Change Status of a Schema Element&#8212;Non-Hosted Schema==

Revision as of 14:11, 23 October 2005

Registry Use Case: Schemas

Use Case 1: Publish a Description of a Schema (Element Set)

Purpose
A Maintainer associated with an Organization wishes to enter the description of a schema (element set) into the Registry. This step is necessary before identifying specific elements (properties) or uploading an extant schema. It is important to note that this use case describes the entry of a description of an schema and not the schema itself.
Primary Actor
Maintainer
Prerequisites
  1. Organization must be registered
  2. Maintainer must be associated with that Organization and logged in

Sequence

  1. Maintainer accesses the Element Set Maintenance page and selects 'Describe New Element Set'
  2. Registry displays the Describe Element Set form containing a list of Organizations with which Maintainer is associated
  3. Maintainer selects Organization
  4. Maintainer adds a description of the element set
  5. Maintainer either:
    1. Saves the element set description in order to continue work later; or
    2. Submits the completed element set description to the Registry
  6. Registry assigns PURL to the element set description, stores description info in database and sends confirmation email (no response required)
  7. Registry notifies Registry Manager(s) that an element set description has been added
  8. Registry displays a list of other Maintainers associated with this Organization and asks if Maintainer wishes to add them to this element set
  9. Maintainer selects from list
  10. Registry sends other Maintainers a confirmation email indicating that they have been added to this application profile
Result
  1. Element set (schema) description is entered into the Registry and published

Use Case 2: Register Schema Element(s)—Hosted Schema

Purpose
Maintainer wishes to add new elements (properties) associated with a schema description that is hosted in the Registry
Primary Actor
Maintainer
Prerequisites
  1. Maintainer must be associated with the Organization owning the element set
  2. The associated schema description exists in the Registry

Sequence

  1. Maintainer selects the schema from a list of schema descriptions with which he or she is associated
  2. Maintainer accesses the Element Set Maintenance page and selects 'Enter New Elements'
  3. Registry displays the Describe Element form
  4. Maintainer enters the information for one or more new elements
  5. Maintainer either:
    1. Saves the element(s) in order to continue work later; or
    2. Submits the element(s) to the Registry
  6. Registry assigns a PURL to each element based on the URI established at creation of the schema description
  7. Registry validates the schema
  8. If the schema does not validate, an email notification is sent to the associated Maintainer that includes error messages associated with the process, a link to a FAQ detailing the error messages and possible next steps
  9. If the schema passes validation routines:
    1. An email notification is sent to the Maintainer (and the Organization Contact)
    2. The Registry queues the schema for Registry Manager and/or Editor/Reviewer
  10. Upon review, Registry Manager submits the schema to the Registry
Result
Schema is registered in the Registry and published

Use Case 3: Upload and Register Schema Element(s) File—Hosted Schema

Purpose
An NSDL project wants to upload a file containing a machine-readable schema (element set) to be hosted by the Registry
Primary Actor
Maintainer
Prerequisites
  1. A description of the element set to be uploaded already exists in the Registry
  2. Maintainer has already been associated with a Registry description of the schema
  3. The schema to be uploaded already exists and is encoded in a Registry-appropriate syntax
  4. The schema creator has included appropriate Registry URIs for all elements base on the URI established when the schema description was created

Sequence

  1. Maintainer accesses the Element Set Maintenance page
  2. Maintainer searches for the element set description amongst the descriptions assigned the Maintainer
  3. Maintainer selects the file upload function for an existing schema
  4. Maintainer selects the element set file to upload by:
    1. Finding the element set file on the Maintainer's local machine; or
    2. Providing a network address where the encoded file may be found
  5. Maintainer uploads the element set file
  6. Maintainer either:
    1. Saves the element set in order to continue work later; or
    2. Submits the completed element set to the Registry
  7. Upon submission, the Registry validates the input
  8. If the element set does not validate, an email notification is sent to the associated Maintainer that includes error messages associated with the process, a link to a FAQ detailing the error messages and possible next steps
  9. If the element set passes validation routines:
    1. An email notification is sent to the Maintainer (and the Organization Contact)
    2. The Registry queues the file for Registry Manager and/or Editor/Reviewer
  10. Upon review, Registry Manager submits the final element set to the Registry and it is published
Result
  1. Element set associated with an Oranization is registered.

Use Case 4: Upload and Register Schema Element(s) File—Non-Hosted Schema

Purpose
An NSDL project wants to upload a file containing a machine-readable schema (element set) that is hosted and maintained in a namespace outside the Registry
Primary Actor
Maintainer
Prerequisites
  1. A description of the element set to be uploaded already exists in the Registry
  2. Maintainer has already been associated with a Registry description of the element set
  3. The schema to be uploaded already exists and is encoded in a Registry-appropriate syntax
  4. The schema creator has included appropriate URIs to its own namespace for all elements in the set

Sequence

  1. Maintainer accesses the Element Set Maintenance page
  2. Maintainer searches for the element set description amongst the descriptions assigned the Maintainer
  3. Maintainer selects the file upload function for an existing schema
  4. Maintainer selects the element set file to upload by:
    1. Finding the element set file on the Maintainer's local machine; or
    2. Providing a network address where the encoded file may be found
  5. Maintainer uploads the element set file
  6. Maintainer either:
    1. Saves the element set in order to continue work later; or
    2. Submits the completed element set to the Registry
  7. Upon submission, Registry validates the input
  8. If the element set does not validate, an email notification is sent to the associated Maintainer that includes error messages associated with the process, a link to a FAQ detailing the error messages and possible next steps
  9. If the element set passes validation routines:
    1. An email notification is sent to the Maintainer (and the Organization Contact)
    2. The Registry queues the file for Registry Manager and/or Editor/Reviewer
  10. Upon review, Registry Manager submits the final element set to the Registry and it is published
Result
  1. Element set associated with an Oranization is registered.

Use Case 5: Edit Schema Element(s)—Hosted

Purpose
An NSDL project wants to edit the information associated with a specific element hosted in the Registry. Note: This use case assumes that the edits to the existing element do not change its semantics. If semantics are to be changed, see Use Case 5
Primary Actor
Maintainer
Prerequisites
  1. The schema for the element set already exists in the Registry
  2. Maintainer has already been associated with a Registry description of the element set

Sequence

  1. Maintainer accesses the Element Set Maintenance page
  2. Maintainer searches for the element to edit by:
    1. Searching for the relevant element set description amongst the descriptions assigned the Maintainer and picking the relevant element from its member elements; or
    2. Searching for the element directly
  3. Registry presents the Maintainer with the element to edit
  4. Maintainer edits the information associated with the element.
  5. Maintainer either:
    1. Saves the element set in order to continue work later; or
    2. Submits the edited element set to the Registry
  6. Upon submission, Registry validates the input
  7. If the element set does not validate, an email notification is sent to the associated Maintainer that includes error messages associated with the process, a link to a FAQ detailing the error messages and possible next steps
  8. If the element set passes validation routines:
    1. An email notification is sent to the Maintainer (and the Organization Contact)
    2. The Registry queues the file for Registry Manager and/or Editor/Reviewer
  9. Upon review, Registry Manager submits the final element set to the Registry
  10. Registry "versions" the transaction and registers the edited element
Result
  1. Edited Element is registered.

Use Case 6: Edit Schema Element(s)—Non-Hosted Schema

Purpose
An NSDL project wants to edit the information associated with a specific element hosted in a namespace other than the Registry. Note: The editing process for this use case is handled outside the Registry; therefore, the primary function of the use case is the uploading of a revised element set.
Primary Actor
Maintainer
Prerequisites
  1. The Maintainer has already been associated with a Registry description of the relevant element set
  2. The element set to be changed is hosted and maintained in a namespace outside the Registry
  3. Edits to the element have been handled in the Organization's namespace according to its own editorial and versioning processes

Sequence

  1. Maintainer accesses the Element Set Maintenance page
  2. Maintainer searches for the element set description amongst the descriptions assigned the Maintainer
  3. Maintainer selects the file upload function for an existing schema
  4. Maintainer selects the element set file to upload by:
    1. Finding the element set file on the Maintainer's local machine; or
    2. Providing a network address where the encoded file may be found
  5. Maintainer uploads the element set file
  6. Maintainer either:
    1. Saves the element set in order to continue work later (without affecting the published version); or
    2. Submits the completed element set to the Registry
  7. Upon submission, Registry validates the input
  8. If the element set does not validate, an email notification is sent to the associated Maintainer that includes error messages associated with the process, a link to a FAQ detailing the error messages and possible next steps
  9. If the element set passes validation routines:
    1. An email notification is sent to the Maintainer (and the Organization Contact)
    2. The Registry queues the file for Registry Manager and/or Editor/Reviewer
  10. Upon review, Registry Manager submits the edited element set to the Registry
  11. Registry:
    1. Backs up the old version of the schema
    2. Registers and publishes the new version of the schema
    3. Associates the old and new versions of the schema
Result
  1. The editing transaction has been backed up
  2. Revised element set has been registered and published

Use Case 7: Change Semantics of a Schema Element—Hosted Schema

Purpose
An NSDL project wants to edit the information associated with a specific element hosted in the Registry that alters the semantics of the term.
Primary Actor
Maintainer
Prerequisites
  1. The schema for the element set already exists in the Registry
  2. Maintainer has already been associated with a Registry description of the element set

Sequence

  1. Maintainer accesses the Element Set Maintenance page
  2. Maintainer searches for the element to edit by:
    1. Searching for the relevant element set description amongst the descriptions assigned the Maintainer and picking the relevant element from its member elements; or
    2. Searching for the element directly
  3. Registry presents the Maintainer with the element to edit
  4. Maintainer edits the information associated with the element and 'checks' that changes have been made to the semantics of the element
  5. Maintainer either:
    1. Saves the element set in order to continue work later; or
    2. Submits the edited element set to the Registry
  6. Upon submission, Registry issues URI for the new version of the term
  7. Registry validates the input
  8. If the element set does not validate, an email notification is sent to the associated Maintainer that includes error messages associated with the process, a link to a FAQ detailing the error messages and possible next steps
  9. If the element set passes validation routines:
    1. An email notification is sent to the Maintainer (and the Organization Contact)
    2. The Registry queues the file for Registry Manager and/or Editor/Reviewer
  10. Upon review, Registry Manager submits the final element set to the Registry
  11. Registry "versions" the transaction and registers the edited element
Result
  1. Edited Element is registered with verioning information maintained.

Use Case 8: Change Semantics of a Schema Element—Non-Hosted Schema

Purpose
An NSDL project wants to edit the information associated with a specific element hosted in a namespace other than the Registry. Note: The editing process for this use case is handled outside the Registry; therefore, the primary function of the use case is the uploading of a revised element set.
Primary Actor
Maintainer
Prerequisites
  1. The Maintainer has already been associated with a Registry description of the relevant element set
  2. The element set to be changed is hosted and maintained in a namespace outside the Registry
  3. Edits to the element have been handled in the Organization's namespace according to its own editorial and versioning processes

Sequence

  1. Maintainer accesses the Element Set Maintenance page
  2. Maintainer searches for the element set description amongst the descriptions assigned the Maintainer
  3. Maintainer selects the file upload function for an existing schema
  4. Maintainer selects the element set file to upload by:
    1. Finding the element set file on the Maintainer's local machine; or
    2. Providing a network address where the encoded file may be found
  5. Maintainer uploads the element set file
  6. Maintainer either:
    1. Saves the element set in order to continue work later (without affecting the published version); or
    2. Submits the completed element set to the Registry
  7. Upon submission, Registry validates the input
  8. If the element set does not validate, an email notification is sent to the associated Maintainer that includes error messages associated with the process, a link to a FAQ detailing the error messages and possible next steps
  9. If the element set passes validation routines:
    1. An email notification is sent to the Maintainer (and the Organization Contact)
    2. The Registry queues the file for Registry Manager and/or Editor/Reviewer
  10. Upon review, Registry Manager submits the edited element set to the Registry
  11. Registry:
    1. Backs up the old version of the schema
    2. Registers and publishes the new version of the schema
    3. Associates the old and new versions of the schema
Result
  1. The editing transaction has been backed up
  2. Revised element set has been registered and published

Use Case 9: Change Status of a Schema Element—Hosted Schema

Use Case 10: Change Status of a Schema Element—Non-Hosted Schema