Difference between revisions of "NSDL Registry Use Cases (Application Profiles)"

From Metadata-Registry
Jump to: navigation, search
(Use Case 5: Maintainer Adds/Edits Information in an Application Profile Description—Hosted Application Profile)
(Use Case 3: Creates an Application Profile--Uploading (Hosted))
Line 52: Line 52:
 
#A Maintainer associated with the Organization is associated with the application profile.
 
#A Maintainer associated with the Organization is associated with the application profile.
  
==Use Case 3: Creates an Application Profile--Uploading (Hosted)==
+
==Use Case 3: Create an Application Profile--Uploading (Hosted)==
 
;Purpose:An NSDL project wants to upload a file containing a machine-readable application profile to be hosted by the Registry that  
 
;Purpose:An NSDL project wants to upload a file containing a machine-readable application profile to be hosted by the Registry that  
 
#Associates elements drawn from one or more declared metadata schemas with an application profile description in the Registry; and  
 
#Associates elements drawn from one or more declared metadata schemas with an application profile description in the Registry; and  

Revision as of 10:55, 9 October 2005

Use Case 1: Publish a Description of an Application Profile

Purpose
A Maintainer associated with an Organization wishes to enter the description of an application profile into the Registry. This step is necessary before identifying specific terms or uploading an extant application profile. It is important to note that this use case describes the entry of a description of an application profile and not the application profile 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 Application Profile Maintenance page and selects 'Describe New Application Profile'
  2. Registry displays the Describe Application Profile form, containing a list of Organizations with which Maintainer is associated
  3. Maintainer selects Organization, adds a description of the application profile
  4. Maintainer either:
    1. Saves the application profile description in order to continue work later; or
    2. Submits the completed application profile description to the Registry
  5. Registry assigns PURL to application profile description, stores description info in database and sends confirmation email (no response required)
  6. Registry notifies Registry Manager(s) that application profile description has been added
  7. Registry displays a list of other Maintainers associated with this Organization and asks if Maintainer wishes to add them to this application profile and also offers Maintainer the opportunity to Register other Maintainers or add existing Maintainers to this Organization
  8. Maintainer selects from list and/or adds Maintainer registration information for other Maintainers
  9. Registry sends other Maintainers a confirmation email indicating that they have been added to this application profile
Result
  1. Application profile description is entered into the Registry

Use Case 2: Publish an Application Profile

Purpose
An NSDL project wants to
  1. Associate elements drawn from one or more declared metadata schemas with an application profile description in the Registry; and
  2. Define the uses of, and constraints on, those elements in the context of their project
Primary Actor
Maintainer
Prerequisites
  1. A description of the Organization for whom the application profile is being created already exists in the Registry
  2. The Maintainer has already been associated with a Registry description of the application profile
  3. All elements to be used in the application profile must have been declared in one or more Web-addressable schemas whether hosted in the Registry or hosted elsewhere

Sequence

  1. Maintainer accesses the Create Application Profile page
  2. Maintainer searches for the appropriate application profile description amongst the descriptions assigned the Maintainer
  3. Maintainer searches for existing terms in the Registry that meet the needs of the Organization's metadata schema
  4. Maintainer selects approriate discovered elements and adds them one at a time to the application profile
    1. Maintainer may add elements to the application profile that are Web-addressable but not hosted in the Registry
  5. Maintainer determines use constraints on each element selected:
    1. If an element is to be restricted to the use of particular controlled vocabulary (rdfs:range), the Maintainer searches for that vocabulary in the Registry and associates it with the element
    2. Other constrains are applied (cardinality etc.)
  6. Maintainer either:
    1. Saves the application profile in order to continue work later; or
    2. Submits the completed application profile to the Registry
  7. Upon submission, Registry assigns a URI (PURL) to each term in the application profile using the base URI established when the application profile description was created
  8. Registry validates the input
  9. If the application profile 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
  10. If the application profile 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
  11. Upon review, Registry Manager submits the final application profile to the Registry
Result
  1. Application profile associated with an Oranization is registered.
  2. A Maintainer associated with the Organization is associated with the application profile.

Use Case 3: Create an Application Profile--Uploading (Hosted)

Purpose
An NSDL project wants to upload a file containing a machine-readable application profile to be hosted by the Registry that
  1. Associates elements drawn from one or more declared metadata schemas with an application profile description in the Registry; and
  2. Defines the uses of, and constraints on, those elements in the context of their project
Primary Actor
Maintainer
Prerequisites
  1. A description of the Organization for whom the application profile is being created already exists in the Registry
  2. The Maintainer has already been associated with a Registry description of the application profile
  3. All elements to be used in the application profile have been declared in one or more Web-addressable schemas whether hosted in the Registry or hosted elsewhere
  4. The application profile to be uploaded already exists and is encoded in a Registry-appropriate syntax
  5. The application profile creator has included appropriate Registry URIs for all elements base on the URI established when the application profile description was created

Sequence

  1. Maintainer accesses the Create Application Profile page
  2. Maintainer searches for the appropriate application profile description amongst the descriptions assigned the Maintainer
  3. Maintainer selects the file upload function for an existing application profile
  4. Maintainer selects the application profile file to upload by:
    1. Finding the application profile file on the Maintainer's local machine; or
    2. Providing a network address where the encoded file may be found
  5. Maintainer either:
    1. Saves the application profile in order to continue work later; or
    2. Submits the completed application profile to the Registry
  6. Upon submission, Registry validates the input
  7. If the application profile 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 application profile 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 application profile to the Registry and it is published
Result
  1. Application profile associated with an Oranization is registered.
  2. A Maintainer associated with the Organization is associated with the application profile.

Use Case 4: Create an Application Profile—Uploading (Non-Hosted)

Purpose
An NSDL project wants to upload a file for a non-hosted, machine-readable application profile that
  1. Associates elements drawn from one or more declared metadata schemas with an application profile description in the Registry; and
  2. Defines the uses of, and constraints on, those elements in the context of their project

Note: This use case is for application profiles that are hosted elsewhere--i.e., in a registry maintained by an agency other than the NSDL Registry

Primary Actor
Maintainer
Prerequisites
  1. A description of the Organization for whom the application profile is being created already exists in the Registry
  2. The Maintainer has already been associated with a Registry description of the application profile
  3. All elements to be used in the application profile have been declared in one or more Web-addressable schemas whether hosted in the Registry or hosted elsewhere
  4. The application profile to be uploaded already exists and is encoded in a Registry-appropriate syntax
  5. The application profile creator has included appropriate URIs for all elements to the namespace managed by the Organization associated with the application profile

Sequence

  1. Maintainer accesses the Create Application Profile page
  2. Maintainer searches for the appropriate application profile description amongst the descriptions assigned the Maintainer
  3. Maintainer selects the file upload function for an existing application profile
  4. Maintainer selects the application profile file to upload by:
    1. Finding the application profile file on the Maintainer's local machine; or
    2. Providing a network address where the encoded file may be found
  5. Maintainer either:
    1. Saves the application profile in order to continue work later; or
    2. Submits the completed application profile to the Registry
  6. Upon submission, Registry validates the input
  7. If the application profile 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 application profile 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 application profile to the Registry
Result
  1. Application profile associated with an Oranization is registered and published
  2. A Maintainer associated with the Organization is associated with the application profile

Use Case 5: Add/Edit Information in an Application Profile Description—Hosted Application Profile

Purpose
Maintainer associated with an existing application profile wishes to add information or editing existing information in the application profile description
Primary Actor
Maintainer
Prerequisites
  1. The Maintainer has already been associated with a Registry description of the application profile
  2. The application profile has already been registered and published

Sequence

  1. Maintainer searches for his or her associated application profiles
  2. Maintainer selects application profile to edit
  3. Registry provides Edit Application Profile Description form
  4. Maintainer adds/edits information
  5. Maintainer either:
    1. Saves the application profile edits in order to continue work later; or
    2. Submits the edited application profile to the Registry
  6. Upon submission, Registry validates the input
  7. If the application profile 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 application profile 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 application profile to the Registry
  10. Registry backs up the old application profile and replaces it with the new file
Result

Updated application profile