Difference between revisions of "HUB Use Cases"

From Metadata-Registry
Jump to: navigation, search
(→‎XC HUB Use Cases)
(→‎Use Case 1: A User wishes to register a Service)
Line 42: Line 42:
 
===Service Registry Use Cases===
 
===Service Registry Use Cases===
  
−
====Use Case 1: A User wishes to register a Service====
+
====Use Case 1/SR: A User wishes to register a Service====
−
;Purpose:An XC project has a metadata service that they wish to register.  
+
;Purpose:An XC project has a service that they wish to register.  
 
;Primary Actor:User
 
;Primary Actor:User
 
;Prerequisites:User must be associated with the organization providing the service
 
;Prerequisites:User must be associated with the organization providing the service
Line 51: Line 51:
 
#* by entering basic information about the organization providing the service -- Name, address, phone, domain (if available), URL, description. User may then enter self (and may designate others in addition) as Primary Contact or Technical Contact by including name and email. If User is neither Primary nor Technical Contact, another role may be entered.
 
#* by entering basic information about the organization providing the service -- Name, address, phone, domain (if available), URL, description. User may then enter self (and may designate others in addition) as Primary Contact or Technical Contact by including name and email. If User is neither Primary nor Technical Contact, another role may be entered.
 
#User submits form and Registry sends confirmation email to all contact(s) as well as the Hub Manager.
 
#User submits form and Registry sends confirmation email to all contact(s) as well as the Hub Manager.
−
#Use and contact(s) respond to confirmation email, verifying email address(es)
+
#User and contact(s) respond to confirmation email, verifying email address(es)
 
#Registry notifies HUB Manager(s) that Service has been added
 
#Registry notifies HUB Manager(s) that Service has been added
 
;Result: Service is registered. User is now a Registered User and an organization contact associated with the registered service.
 
;Result: Service is registered. User is now a Registered User and an organization contact associated with the registered service.
 +
 +
====Use Case 2/SR: A User wishes to modify a Service registration====
 +
;Purpose:An XC project has service registration that they wish to modify.
 +
;Primary Actor:Primary Contact or Technical Contact
 +
;Prerequisites:Primary Contact or Technical Contact must be associated with the organization providing the service within the service registration.
 +
<b>Sequence</b>
 +
#Contact accesses the Service Registry and chooses to edit the service registration:
 +
#* if the OAI server address has changed, the harvester will initiate a test harvest to:
 +
#** refresh the information provided by the server
 +
#** test the server conformance with OAI (given that more than the server address might have changed behind the scenes)
 +
#* if contact details for registered contacts are changed (or new contacts are designated) the verification of email addresses will be done for any new or changed addresses.
 +
#Contact submits form and Registry sends confirmation email to all contact(s) as well as the Hub Manager.
 +
#Contact(s) respond to confirmation email, verifying email address(es)
 +
#Registry notifies HUB Manager(s) that Service registration has changed has been added
 +
;Result: Service registration is updated.

Revision as of 12:33, 13 December 2007

XC HUB Use Cases

User Roles

[

Human Actors

  • System Administrator
    • Overall system administrator. Responsible for system-level software and hardware maintenance
  • HUB Manager
    • One or more persons responsible for the administrative tasks involved in the management of a HUB instance
    • Authorizations: Service Administrator for all registered Services Editor for all Collections and Metadata [not sure about this one]
    • Only role authorized to Delete Services, Users, and Collections
  • Service Administrator
    • One or more persons authorized to maintain one or more Service records. The user who registers a Service becomes the Service Administrator for that Service
    • Authorizations:
      • Service Administrator for all Services owned by that Agent
      • Edit/Delete Service Records
      • Designate other Registered Users as Service Contacts
      • Register Contacts and designate them as: Service Administrators for that Agent or Technical Contacts for that Agent
  • Service Primary Contact
    • One or more persons acting on behalf of a Service, to whom notifications to the Service may be sent.
    • Domain of email address must match the domain registered to that Service
  • Service Technical Contact
    • One or more persons acting on behalf of a service, to whom technical notifications to the Service may be sent.
  • User
    • A User is a visitor who has an intent to register a service. A User may assume an additional role while registering a service. **[


OAI Harvester Use Cases

OAI Server Use Cases

Service Registry Use Cases

Use Case 1/SR: A User wishes to register a Service

Purpose
An XC project has a service that they wish to register.
Primary Actor
User
Prerequisites
User must be associated with the organization providing the service

Sequence

  1. User accesses the Service Registry and initiates Registration in one of two ways:
    • by entering the URI of the OAI server for the service
    • by entering basic information about the organization providing the service -- Name, address, phone, domain (if available), URL, description. User may then enter self (and may designate others in addition) as Primary Contact or Technical Contact by including name and email. If User is neither Primary nor Technical Contact, another role may be entered.
  2. User submits form and Registry sends confirmation email to all contact(s) as well as the Hub Manager.
  3. User and contact(s) respond to confirmation email, verifying email address(es)
  4. Registry notifies HUB Manager(s) that Service has been added
Result
Service is registered. User is now a Registered User and an organization contact associated with the registered service.

Use Case 2/SR: A User wishes to modify a Service registration

Purpose
An XC project has service registration that they wish to modify.
Primary Actor
Primary Contact or Technical Contact
Prerequisites
Primary Contact or Technical Contact must be associated with the organization providing the service within the service registration.

Sequence

  1. Contact accesses the Service Registry and chooses to edit the service registration:
    • if the OAI server address has changed, the harvester will initiate a test harvest to:
      • refresh the information provided by the server
      • test the server conformance with OAI (given that more than the server address might have changed behind the scenes)
    • if contact details for registered contacts are changed (or new contacts are designated) the verification of email addresses will be done for any new or changed addresses.
  2. Contact submits form and Registry sends confirmation email to all contact(s) as well as the Hub Manager.
  3. Contact(s) respond to confirmation email, verifying email address(es)
  4. Registry notifies HUB Manager(s) that Service registration has changed has been added
Result
Service registration is updated.
Retrieved from "http://wiki.metadataregistry.org/index.php?title=HUB_Use_Cases&oldid=3137"