JISC IE Metadata Schema Registry

Functional Requirements for the IE Metadata Schema Registry

   ILRT logo | Link to ILRT UKOLN logo | Link to home page

-

Home Background Dissemination Contacts
Phase 1 WP1: Project management WP2: Model/Use WP3: Tools WP4: m2m WP5: Validation WP6: Policy WP7: Evaluation

Contents

  1. Introduction
  2. Dublin Core Application Profiles
    1. Describe Metadata Vocabulary
    2. Describe DCAP
    3. Describe Set of Instances (Controlled Vocabulary)
    4. Describe Schema Document
    5. Submit/Withdraw Schema Document
    6. Browse Registry Data
    7. Query Registry Data
    8. View Registry Data
    9. Administer Registry Database
    10. API
  3. LOM Application Profiles
    1. Describe LOMAP
    2. Describe Non-LOM Vocabulary
    3. Describe Extended Data Element Set
    4. Describe Schema Document
    5. Submit/Withdraw Schema Document
    6. Browse Registry Data
    7. Query Registry Data
    8. View Registry Data
    9. Administer Registry Database
    10. API
  4. Notes
  5. References

1. Introduction

This document builds on the high-level description of the functions of the IEMSR and the usage scenarios to provide some more detailed functional requirements for the IEMSR.

The entity types referred to here are described in more detail in the two documents: Model for Dublin Core Application Profile and Model for LOM Application Profile.

2. Dublin Core Application Profiles

The IEMSR should support the following high-level functions:

  1. Describe Metadata Vocabulary: the creation and/or maintainance of a description of a metadata vocabulary, its component properties and classes, and related resources. Results in the creation of a new or updated Schema Document.

  2. Describe DC Application Profile: the creation and maintainance of a description of a DC Application Profile, its component entities and related resources. Results in the creation of a new or updated Schema Document.

  3. Describe Set of Instances (Controlled Vocabulary terms): the creation and maintainance of a description of a set on Instances. Results in the creation of a new or updated Schema Document.

  4. Describe Schema Document: the creation and/or maintainance of descriptions of these Schema Documents as distributed data sources for the IEMSR. Schema Documents may be:

    • documents created by the one of the first three functions above

    • RDF/XML documents already published on the Web

  5. Submit/Withdraw Schema Document: request that a Schema Document is read and the content indexed and added to the registry database; or request that the content of a previously indexeddocument is removed from the registry database

  6. Browse Registry Data: the navigation of the database through an HTML interface for human users

  7. Query Registry Data: the provision of query services on that database through an HTML interface for human users

  8. Administer Registry Database:

  9. API

Although these are listed as distinct functions, multiple functions may be provided within a single software tool. Each function is described in more detail in the following sections.

2.1 Describe Metadata Vocabulary

2.1.1 Create New Description of Metadata Vocabulary

The human administrator of a metadata vocabulary (or a third party) needs to be able to create a new description of a metadata vocabulary:

  1. Create New Schema Document

  2. Create Agency Description: create a description of the Agency responsible for the management of the metadata vocabulary, including descriptions of any related Text Document (home page for the Agency).

  3. Create Metadata Vocabulary Description: create a description of the Metadata Vocabulary, including descriptions of any related Text Document (human-readable specification or guidelines).

  4. For zero or more classes in the metadata vocabulary:

    • Create Class Description: create a description of the Class, including descriptions of any related Text Document (human-readable specification or guidelines).

      For zero or more subclass relations required:

      • Add Subclass Relationship Add subclass relation between this class and a selected class in the same or a different metadata vocabulary

  5. For zero or more properties in the metadata vocabulary

    • Create Property Description: create a description of the Property, including descriptions of any related Text Document (human-readable specification or guidelines).

      For zero or more subproperty/refinement relations required:

      • Add Subproperty Relationship Add subproperty relation between this property and a selected property in the same or a different metadata vocabulary

  6. Save Schema Document: as local file.

2.1.2 Edit Description of Metadata Vocabulary

The human administrator of a metadata vocabulary (or a third party) needs to be able to edit an existing description of a metadata vocabulary:

  1. Open Schema Document: either from local file or from URL.

  2. Edit Agency Description: edit the description of the Agency responsible for the management of the metadata vocabulary, including descriptions of any related Text Document (home page for the Agency).

  3. Edit Metadata Vocabulary Description: edit the description of the Metadata Vocabulary, including descriptions of any related Text Document (human-readable specification or guidelines).

  4. For zero or more selected classes in the metadata vocabulary:

    • Edit Class Description: edit the description of the Class, including descriptions of any related Text Document (human-readable specification or guidelines).

      For zero or more subclass relations to be removed:

      • Remove Subclass Relationship Remove subclass relation between this class and a second class in the same or a different metadata vocabulary

      For zero or more subclass relations to be added:

      • Add Subclass Relationship: (see above)

  5. For zero or more selected properties in the metadata vocabulary

    • Edit Property Description: edit the description of the Property, including descriptions of any related Text Document (human-readable specification or guidelines).

      For zero or more subproperty relations to be removed:

      • Remove Subproperty Relationship: Remove subproperty relation between this property and a second property in the same or a different metadata vocabulary

      For zero or more subproperty relations to be added:

      • Add Subproperty Relationship: (see above).

  6. For zero or more selected classes in the metadata vocabulary:

    • Delete Class Description: delete the description of the Class, including descriptions of any related Text Document (human-readable specification or guidelines), and remove any subclass relationships in which this class is subject.

      [Not sure whether this should delete node or flag node as deleted?]

  7. For zero or more selected properties in the metadata vocabulary:

    • Delete Property Description: delete the description of the Property, including descriptions of any related Text Document (human-readable specification or guidelines), and remove any subproperty relationships in which this property is subject.

      [Not sure whether this should delete node or flag node as deleted?]

  8. For zero or more additional classes for this metadata vocabulary

    • Create Class Description (as above)

  9. For zero or more additional properties for this metadata vocabulary

    • Create Property Description (as above)

  10. Save Schema Document: as local file.

2.1.3 Delete Description of Metadata Vocabulary

[Not sure whether this should delete node or flag node as deleted?]

2.2 Describe DC Application Profile

2.2.1 Create New Description of DCAP

The human administrator of a DCAP (or a third party) needs to be able to create a new description of a DCAP:

  1. Create New Schema Document

  2. Create Agency Description: create a description of the Agency responsible for the management of the DC application profile, including descriptions of any related Text Document (home page for the Agency).

  3. Create DCAP Description: create a description of the DCAP, including descriptions of any related Text Document (human-readable specification or guidelines).

  4. For zero or more binding schemas associated with the DCAP:

    • Create Binding Schema Description: create a description of Binding Schema, including descriptions of any related Text Document (human-readable specification or guidelines).

  5. For zero or more resource types described by instances of the DCAP:

    • Select Subject Resource Type: select an existing class from a metadata vocabulary.

      • Select Property for Use: select an existing property from a metadata vocabulary.

      • Create Property Usage Description: create a description of the Property Usage, including descriptions of any related Text Document (human-readable specification or guidelines).

        For zero or more encoding schemes in this property usage:

        • Add Encoding Scheme: add encoding scheme relation between this property usage and a selected existing class from a metadata vocabulary.

  6. For zero or more resource types described by instances of the DCAP:

    • Select Subject Resource Type: select an existing class from a metadata vocabulary.

      For zero or more metadata vocabularies used in the description of instances of this class:

      • Select Metadata Vocabulary for Use: select an existing metadata vocabulary and by doing so select all the properties in that metadata vocabulary.

        For zero or more properties used in the description of instances of this class:

        • Create Property Usage Description: (as above)

  7. Save Schema Document: as local file.

2.2.2 Edit Description of DCAP

The human administrator of a DCAP (or a third party) needs to be able to edit an existing description of a DCAP:

  1. Open Schema Document: either from local file or from URL.

  2. Edit Agency Description: edit the description of the Agency responsible for the management of the DCAP, including descriptions of any related Text Document (home page for the Agency).

  3. Edit DCAP Description: edit the description of the DCAP, including descriptions of any related Text Document (human-readable specification or guidelines).

  4. For zero or more selected binding schemas associated with the DCAP:

    • Edit Binding Schema Description: edit the description of Binding Schema, including descriptions of any related Text Document (human-readable specification or guidelines).

  5. For zero or more selected binding schemas associated with the DCAP:

    • Delete Binding Schema Description: delete the description of Binding Schema, including descriptions of any related Text Document (human-readable specification or guidelines).

      [Not sure whether this should delete node or flag node as deleted?]

  6. For zero or more additional binding schemas associated with the DCAP:

    • Create Binding Schema Description: (as above).

  7. For zero or more selected property usages:

    • Edit Property Usage Description: edit the description of the PropertyUsage, including descriptions of any related Text Document (human-readable specification or guidelines).

      For zero or more encoding scheme relations to be removed:

      • Remove Encoding Scheme: Remove encoding scheme relationships between this property usage and a class

      For zero or more encoding scheme relations to be added:

      • Add Encoding Scheme: (see above).

  8. For zero or more selected property usages:

    • Delete Property Usage Description: delete the description of the PropertyUsage, including descriptions of any related Text Document (human-readable specification or guidelines), and remove any encoding scheme relationships in which this property usage is subject.

  9. For zero or more selected subject resource type described by instances of the DCAP:

    • For zero or more additional properties used in the description of instances of this class:

      • Select Property for Use: (as above).

      • Create Property Usage Description (as above).

  10. For zero or more additional subject resource types described by instances of the DCAP:

    • Select Subject Resource Type: select an existing class from a metadata vocabulary.

      For zero or more properties used in the description of instances of this class:

      • Select Property for Use: (as above).

      • Create Property Usage Description (as above).

  11. Save Schema Document: as local file.

2.2.3 Delete Description of DCAP

[Not sure whether this should delete node or flag node as deleted?]

2.2.4 Clone Description of DCAP

The human administrator of a DCAP (or a third party) needs to be able to create a new description of a DCAP, by using an existing DCAP as the starting point:

Note: the cloning of a DCAP does not imply any relationship between the newly created DCAP and the selecteed/cloned DCAP; this operation is simply a convenience for the DCAP creator. It does not imply that instances conforming to the newly created DCAP will necessarily conform to the selected/cloned DCAP. For example, where a property usage in the selected/cloned DCAP specified that usage of a property was mandatory, a propery usage in the newly created DCAP might specify that it is optional.

  1. Create New Schema Document

  2. Select DCAP: select an existing DCAP to serve as the the starting point for this new description of a DCAP

  3. If agency which manages new DCAP is different from that of cloned DCAP

    • Delete Agency Description

    • Create Agency Description (as above)

  4. Edit DCAP Description: (as above)

  5. For zero or more selected binding schemas associated with the DCAP:

    • Edit Binding Schema Description: (as above).

  6. For zero or more selected binding schemas associated with the DCAP:

    • Delete Binding Schema Description: (as above).

  7. For zero or more additional binding schemas associated with the DCAP:

    • Create Binding Schema Description: (as above).

  8. For zero or more selected property usages:

    • Edit Property Usage Description: (as above)

  9. For zero or more selected property usages:

    • Delete Property Usage Description: (as above)

  10. For zero or more selected subject resource type described by instances of the DCAP:

    • For zero or more additional properties used in the description of instances of this class:

      • Select Property for Use: (as above).

      • Create Property Usage Description (as above).

  11. For zero or more additional subject resource types described by instances of the DCAP:

    • Select Subject Resource Type: select an existing class from a metadata vocabulary.

      For zero or more properties used in the description of instances of this class:

      • Select Property for Use: (as above).

      • Create Property Usage Description (as above).

  12. Save Schema Document: as local file.

2.3 Describe Set of Instances (Controlled Vocabulary)

2.3.1 Create New Description of Set of Instances

The human administrator of a set of instances (or a third party) needs to be able to create a new description of a set of instances:

  1. Create New Schema Document

  2. Select Class to Instantiate: select the existing class of which these resources are instances.

  3. For one or more instances:

    • Create Description of Instance: create a description of the instance, including descriptions of any related Text Document (human-readable specification or guidelines).

  4. Save Schema Document: as local file.

2.3.2 Edit Description of Set of Instances

The human administrator of a set of instances (or a third party) needs to be able to edit an existing description of a set of instances:

  1. Open Schema Document: either from local file or from URL.

  2. For zero or more selected instances:

    • Edit Description of Instance: edit a description of the instance, including descriptions of any related Text Document (human-readable specification or guidelines).

  3. For zero or more additional instances:

    • Create Description of Instance: (as above).

  4. For zero or more selected instances:

    • Delete Description of Instance.

      [Not sure whether this should delete node or flag node as deleted?]

  5. Save Schema Document: as local file.

2.4 Describe Schema Document

A Schema Document may be

  • a document created by the one of the first three functions above

  • an RDF/XML document already published on the Web

N.B. The publisher of a Schema Document may be a different Agency from the administrator of the Metadata Vocabulary/DCAP/set of Instances described by that Schema Document; and where descriptions of a Metadata Vocabulary/DCAP/set of Instances are available in multiple Schema Documents (in multiple languages), each of those Schema Documents may have a different Agency as publisher.

2.4.1 Create New Description of Schema Document

The human publisher of a Schema Document (or a third party) needs to be able to create a new description of a Schema Document.

  1. Create Agency Description: create a description of the Agency responsible for the management of the Schema Document, including descriptions of any related Text Document (home page for the Agency).

  2. Create Description of Schema Document: create a description of the Schema Document.

2.4.2 Edit Description of Schema Document

The human publisher of a Schema Document (or a third party) needs to be able to edit a description of a Schema Document.

  1. Edit Agency Description: edit a description of the Agency responsible for the management of the Schema Document, including descriptions of any related Text Document (home page for the Agency).

  2. Edit Description of Schema Document: edit description of the Schema Document.

2.4.2 Delete Description of Schema Document

[Not sure whether this should delete node or flag node as deleted?]

2.5 Submit/Withdraw Schema Document

2.5.1 Submit Schema Document to Registry

Having created or edited a Schema Document and created or edited a description of that Schema Document, the human publisher of a Schema Document (or a third party) needs to be able to signal to the registry server that it should be read and indexed.

Note: Schema Documents may be any relevant RDF/XML data source, e.g. the schema documents published on the Web by DCMI. The IEMSR must support the use of these data sources with minimum extra work on the part of the submitter. In the MEG-CORES registry, the human effort required in generating additional data for the registry was very time-consuming and proved a considerable barrier to indexing existing data describing metadata vocabularies.

Note: As part of the submission process, the IEMSR should store a copy of the submitted document, so that it is still available in the case that the copy at the location maintained by the publisher becomes inaccessible.

2.5.2 Withdraw Schema Document from Registry

The human publisher of a Schema Document (or a third party) needs to be able to signal to the registry server that an existing Schema Document should no longer be read and indexed,and the content should be removed from the database.

2.6 Browse Registry Database

The human-readable interface should allow a researcher to browse lists of all entities described (except instances, property usages, text documents and binding schemas):

2.6.1 Browse Schema Documents

For each Schema Document in database, view Schema Document Summary. Sort list by [Schema Document] Language [RFC3066] Value, [Schema Document] published by [Agency] Name, [Schema Document] Title.

2.6.2 Browse Agencies

For each Agency in database, view Agency Summary. Sort list by [Agency] Name.

2.6.3 Browse Metadata Vocabularies
2.6.3.1 Browse All Metadata Vocabularies

For each Metadata Vocabulary in database, view Metadata Vocabulary Summary. Two different sort options:

  • [Metadata Vocabulary] Title, [Metadata Vocabulary] Version.
  • [Metadata Vocabulary] Preferred XML Namespace Prefix, [Metadata Vocabulary] Title, [Metadata Vocabulary] Version.
2.6.3.2 Browse Metadata Vocabularies Grouped by Status

For each Metadata Vocabulary in database, view Metadata Vocabulary Summary. grouped by [Metadata Vocabulary] Status. Within grouping, allow two different sort options:

  • [Metadata Vocabulary] Title, [Metadata Vocabulary] Version.
  • [Metadata Vocabulary] Preferred XML Namespace Prefix, [Metadata Vocabulary] Title, [Metadata Vocabulary] Version.
2.6.4 Browse Properties
2.6.4.1 Browse All Properties

For each Property in database, view Property Summary. Two different sort options:

  • [Property] Label, [Property] Is Member Of [Metadata Vocabulary] Title, [Property] Is Member Of [Metadata Vocabulary] Version
  • QName of Property (derive QName from preferred XML prefix/namespace name for Metadata Vocabulary)
2.6.4.2 Browse Properties Grouped by Status

For each Property in database, view Property Summary. grouped by [Property] Status. Within grouping, allow two different sort options:

  • [Property] Label, [Property] Is Member Of [Metadata Vocabulary] Title, [Property] Is Member Of [Metadata Vocabulary] Version
  • QName of Property (derive QName from preferred XML prefix/namespace name for Metadata Vocabulary)
2.6.5 Browse Classes
2.6.5.1 Browse All Classes

For each Class in database, view Class Summary. Two different sort options:

  • [Class] Label, [Class] Is Member Of [Metadata Vocabulary] Title, [Class] Is Member Of [Metadata Vocabulary] Version
  • QName of Class (derive QName from preferred XML prefix/namespace name for Metadata Vocabulary)
2.6.5.2 Browse Classes Grouped by Status

For each Class in database, view Class Summary. grouped by [Class] Status. Within grouping, allow two different sort options:

  • [Class] Label, [Class] Is Member Of [Metadata Vocabulary] Title, [Class] Is Member Of [Metadata Vocabulary] Version
  • QName of Class (derive QName from preferred XML prefix/namespace name for Metadata Vocabulary)
2.6.6 Browse Instances

No browse interface required.

2.6.7 Browse Datatypes

No browse interface required.

2.6.8 Browse DCAPs
2.6.8.1 Browse All DCAPs

For each DCAP in database, view DCAP Summary. Sort list by [DCAP] Title, [DCAP] Version.

2.6.8.2 Browse DCAPs Grouped by Status

For each DCAP in database, view DCAP Summary, grouped by [DCAP] Status. Within group, sort list by [DCAP] Title, [DCAP] Version.

2.6.9 Browse Property Usages

No browse interface required.

2.6.10 Browse Binding Schemas

No browse interface required.

2.6.11 Browse Text Documents

No browse interface required.

2.7 Query Registry Database

A human researcher should be able to query the aggregated data:

Using simple keyword searches on literal values:

  • search for Agencies, by keyword in [Agency] Name, [Agency] Description; present result set as view Agency Summary.
  • search for Metadata Vocabularies by keyword in [Metadata Vocabulary] Title, [Metadata Vocabulary] Description; present result set as view Metadata Vocbaulary Summary.
  • search for Properties by keyword in [Property] Label, [Property] Definition, [Property] Usage note/Comment; present result set as view Property Summary.
  • search for Classes by keyword in [Class] Label, [Class] Definition, [Class] Usage note/Comment; present result set as view Class Summary.
  • search for DCAPs by keyword in [DCAP] Title, [DCAP] Description; present result set as view DCAP Summary.
  • search for Binding Schemas by keyword in [Binding Schema] Title, [Binding Schema] Description; present result set as view Binding Schema Summary.
  • search for Text Documents by keyword in [Text Document] Title, [Text Document] Description; present result set as view Text Document Summary.
  • search for Schema Documents by keyword in [Schema Document] Title, [Schema Document] Description; present result set as view Schema Document Summary.

searches by e.g. date?

filter by language?

2.8 View Registry Database

2.8.1 View Schema Document Description
2.8.1.1 View Schema Document Summary
  • [Schema Document] Language [RFC3066] Value
  • [Schema Document] Title (hyperlink: target = View Schema Document Detail)
  • [Schema Document] Publisher [Agency] Name (hyperlink: target = View Agency Detail)
  • [Schema Document] Identifier (hyperlink: target = View Schema Document (external link))
2.8.1.2 View Schema Document Detail

Display full Schema Document description:

  • [Schema Document] Identifier (hyperlink: target = View Schema Document (external link))
  • [Schema Document] Title
  • [Schema Document] Date Modified
  • [Schema Document] Description
  • [Schema Document] Language [RFC3066] Value
  • [Schema Document] Publisher [Agency] Name (hyperlink: target = view Agency Detail)
  • For each Metadata Vocabulary described by this Schema Document, view Metadata Vocabulary Summary. Sort list by [Metadata Vocabulary] Title, [Metadata Vocabulary] Version.
  • For each DCAP described by this Schema Document, view DCAP Summary. Sort list by [DCAP] Title, [DCAP] Version.
  • For each Instance described by this Schema Document, view Instance Summary. Sort list by [Instance] Label.
2.8.2 View Agency Description
2.8.2.1 View Agency Summary
  • [Agency] Name (hyperlink: target = View Agency Detail)
2.8.2.2 View Agency Detail

View full Agency description:

  • [Agency] Identifier
  • [Agency] Name
  • [Agency] Description

Also:

  • For each Text Document which is the homepage of this Agency, view Text Document Summary. Sort list by [Text Document] Language [RFC3066] Value, [Text Document] Title.
  • For each Metadata Vocabulary for which this Agency is the administrator/publisher, view Metadata Vocabulary Summary. Sort list by [Metadata Vocabulary] Title, [Metadata Vocabulary] Version.
  • For each DCAP for which this Agency is the administrator/publisher, view DCAP Summary. Sort list by [DCAP] Title, [DCAP] Version.
  • For each Schema Document for which this Agency is the publisher, view Schema Document Summary. Sort list by [Schema Document] Language [RFC3066] Value, [Schema Document] Title, [Schema Document] Version.
2.8.2.3 View Agency for Print

View full Agency description:

  • [Agency] Identifier
  • [Agency] Name
  • [Agency] Description
2.8.3 View Metadata Vocabulary Description
2.8.3.1 View Metadata Vocabulary Summary
  • [Metadata Vocabulary] Title (hyperlink: target = view Metadata Vocabulary Detail)
  • [Metadata Vocabulary] Preferred XML Namespace Prefix
  • [Metadata Vocabulary] Version
  • [Metadata Vocabulary] Status [Vocab Status] Label
  • [Metadata Vocabulary] Administrator [Agency] Name (hyperlink: target = view Agency Detail)
2.8.3.2 View Metadata Vocabulary Detail

View full Metadata Vocabulary description:

  • [Metadata Vocabulary] Identifier
  • [Metadata Vocabulary] Title
  • [Metadata Vocabulary] Version
  • [Metadata Vocabulary] Date Modified
  • [Metadata Vocabulary] Description
  • [Metadata Vocabulary] Status [Vocab Status] Label
  • [Metadata Vocabulary] Preferred XML Namespace Name
  • [Metadata Vocabulary] Preferred XML Namespace Prefix
  • [Metadata Vocabulary] Administrator [Agency] Name (hyperlink: target = view Agency Detail)

Also:

  • For each Schema Document which describes this Metadata Vocabulary, view Schema Document Summary. Sort list by [Schema Document] Language [RFC3066] Value, [Schema Document] Title.
  • For each Text Document which is a specification/guidelines document for this Metadata Vocabulary, view Text Document Summary. Sort list by [Text Document] Language [RFC3066] Value, [Text Document] Title.
  • For each Property which is a member of this Metadata Vocabulary, view Property Summary. Sort list by [Property] Label.
  • For each Class which is a member of this Metadata Vocabulary, view Class Summary. Sort list by [Class] Label.
2.8.3.3 View Metadata Vocabulary for Print

A representation of a Metadata Vocabulary and its components suitable for printing. (Includes detail views of components rather than just summary views.)

View full Metadata Vocabulary description:

  • [Metadata Vocabulary] Identifier
  • [Metadata Vocabulary] Title
  • [Metadata Vocabulary] Version
  • [Metadata Vocabulary] Date Modified
  • [Metadata Vocabulary] Description
  • [Metadata Vocabulary] Status [Vocab Status] Label
  • [Metadata Vocabulary] Preferred XML Namespace Name
  • [Metadata Vocabulary] Preferred XML Namespace Prefix

Also:

  • For each Agency which is an administrator of this Metadata Vocabulary, view Agency for Print.
  • For each Property which is a member of this Metadata Vocabulary, view Property for Print. Sort list by [Property] Label.
  • For each Class which is a member of this Metadata Vocabulary, view Class for Print. Sort list by [Class] Label.
2.8.4 View Property Description
2.8.4.1 View Property Summary
  • [Property] Label (hyperlink: target = view Property Detail)
  • QName of Property
  • [Property] Status [Term Status] Label
  • [Property] Is Member Of [Metadata Vocabulary] Title (hyperlink: target = view Metadata Vocabulary Detail)
2.8.4.2 View Property Detail

Display full Property description:

  • [Property] Identifier
  • [Property] Label
  • QName of Property
  • [Property] Status
  • [Property] Definition
  • [Property] Comment/Usage Note
  • [Property] Is Member Of [Metadata Vocabulary] Title (hyperlink: target = view Metadata Vocabulary Detail)

Also:

  • For each Text Document which is a specification/guidelines document for this Property, view Text Document Summary. Sort list by [Text Document] Language [RFC3066] Value, [Text Document] Title.
  • For each Property of which this Property is a subproperty, view Property Summary. Sort list by [Property] Label.
  • For each Property which is a subproperty of this Property, view Property Summary. Sort list by [Property] Label.
  • For each Property Usage which uses this Property, view Property Usage Summary. Sort list by [Property Usage] Is Member Of [DCAP] Title, [Property Usage] Is Member Of [DCAP] Version, [Property Usage] Subject Type [Class] Label, [Property Usage] Label.
  • For each Class which is used as an Encoding Scheme in a Property Usage which uses this Property, view Encoding Scheme Summary. Sort list by [Class] Label, [Property Usage] Is Member Of [DCAP] Title, [Property Usage] Is Member Of [DCAP] Version, [Property Usage] Subject Type [Class] Label, [Property Usage] Label.
2.8.4.3 View Property for Print

Display full Property description:

  • [Property] Identifier
  • [Property] Label
  • QName of Property
  • [Property] Status
  • [Property] Definition
  • [Property] Comment/Usage Note
  • [Property] Is Member Of [Metadata Vocabulary] Title

Also:

  • For each Property of which this Property is a subproperty, view Property Summary. Sort list by [Property] Label.
  • For each Property which is a subproperty of this Property, view Property Summary. Sort list by [Property] Label.
2.8.5 View Class Description
2.8.5.1 View Class Summary
  • [Class] Label (hyperlink: target = view Class Detail)
  • QName of Class
  • [Class] Status [Term Status] Label
  • [Class] Is Member Of [Metadata Vocabulary] Title (hyperlink: target = view Metadata Vocabulary Detail)
2.8.5.2 View Class Detail

Display full Class description:

  • [Class] Identifier
  • [Class] Label
  • QName of Class
  • [Class] Status
  • [Class] Definition
  • [Class] Comment/Usage Note
  • [Class] Is Member Of [Metadata Vocabulary] Title (hyperlink: target = view Metadata Vocabulary Detail)

Also:

  • For each Text Document which is a specification/guidelines document for this Class, view Text Document Summary. Sort list by [Text Document] Language [RFC3066] Value, [Text Document] Title.
  • For each Class of which this Class is a subclass, view Class Summary. Sort list by [Class] Label.
  • For each Class which is a subclass of this Class, view Class Summary. Sort list by [Class] Label.
  • For each DCAP that has as a member a Property Usage which uses this Class as a Subject Type, view DCAP Summary. Sort list by [DCAP] Title, [DCAP] Version.
  • For each Property Usage which uses this Class as an Encoding Scheme, view Property Usage Summary. Sort list by [Property Usage] Is Member Of [DCAP] Title, [Property Usage] Is Member Of [DCAP] Version, [Property Usage] Subject Type [Class] Label, [Property Usage] Label.
2.8.5.3 View Class for Print

Display full Class description:

  • [Class] Identifier
  • [Class] Label
  • QName of Class
  • [Class] Status
  • [Class] Definition
  • [Class] Comment/Usage Note
  • [Class] Is Member Of [Metadata Vocabulary]

Also:

  • For each Class of which this Class is a subclass, view Class Summary. Sort list by [Class] Label.
  • For each Class which is a subclass of this Class, view Class Summary. Sort list by [Class] Label.
2.8.6 View Instance Description
2.8.1.1 View Instance Summary
  • [Instance] Label (hyperlink: target = View Instance Detail)
  • [Instance] Status [Term Status] Label
2.8.6.2 View Instance Detail

Display full Instance description:

  • [Instance] Identifier
  • [Instance] Label
  • [Instance] Value
  • [Instance] Status [Term Status] Label
  • [Instance] Description

Also:

  • For each Text Document which is a specification/guidelines document for this Instance, view Text Document Summary. Sort list by [Text Document] Language [RFC3066] Value, [Text Document] Title.
  • For each Schema Document which describes this Instance, view Schema Document Summary. Sort list by [Schema Document] Language [RFC3066] Value, [Schema Document] Title
  • For each Class of which this Instance is an instance, view Class Summary. Sort list by [Class] Label
2.8.7 View Datatype Description
2.8.8 View DCAP Description
2.8.8.1 View DCAP Summary
  • [DCAP] Title (hyperlink: target = view DCAP Detail)
  • [DCAP] Version
  • [DCAP] Status [Vocab Status] Label
  • [DCAP] Administrator [Agency] Name (hyperlink: target = View Agency detail)
2.8.8.2 View DCAP Detail

Display full DCAP description:

  • [DCAP] Identifier
  • [DCAP] Title
  • [DCAP] Version
  • [DCAP] Date Modified
  • [DCAP] Description
  • [DCAP] Status [Vocab Status] Label
  • [DCAP] Administrator [Agency] Name (hyperlink: target = view Agency Detail)

Also:

  • For each Schema Document which describes this DCAP, view Schema Document Summary. Sort list by [Schema Document] Language [RFC3066] Value, [Schema Document] Title
  • For each Text Document which is a specification/guidelines document for this DCAP, view Text Document Summary. Sort list by [Text Document] Language [RFC3066] Value, [Text Document] Title.
  • For each Binding Schema which expresses this DCAP, view Binding Schema Summary. Sort list by [Binding Schema] Title
  • For each Property Usage which is a member of this DCAP, view Property Usage Summary. Sort list by [Property Usage] Subject Type [Class] Label, [Property Usage] Label.
2.8.8.3 View DCAP for Print

A representation of a DCAP and its components suitable for printing. (Includes detail views of components rather than just summary views.)

View full DCAP description:

  • [DCAP] Identifier
  • [DCAP] Title
  • [DCAP] Version
  • [DCAP] Date Modified
  • [DCAP] Description
  • [DCAP] Status [Vocab Status] Label

Also:

  • For each Agency which is an administrator of this DCAP, view Agency for Print.
  • For each Class which is a Subject Type in a Property Usage which is a member of this DCAP, view Subject Type for Print. Sort list by [Property Usage] Subject Type [Class] Label.
  • For each Property Usage which is a member of this DCAP, view Property Usage for Print. Sort list by [Property Usage] Subject Type [Class] Label, [Property Usage] Label.
2.8.9 View Property Usage Description
2.8.9.1 View Property Usage Summary
  • [Property Usage] Subject Type [Class] Label (hyperlink: target = view Class Detail)
  • [Property Usage] Label (hyperlink: target = Property Usage detail page)
  • QName of used Property
  • [Property Usage] Uses [Property] Label (hyperlink: target = view Property Detail)
  • [Property Usage] Status [Term Status] Label
  • [Property Usage] Is Member Of [DCAP] Title (hyperlink: target = view DCAP Detail)
2.8.9.2 View Property Usage Detail

Display full Property Usage description:

  • [Property Usage] Identifier
  • [Property Usage] Subject Type [Class] Label (hyperlink: target = view Class Detail)
  • [Property Usage] Label
  • QName of used Property (hyperlink: target = view Property Detail)
  • [Property Usage] Uses [Property] Label (hyperlink: target = view Property Detail)
  • [Property Usage] Status
  • [Property Usage] Definition
  • [Property Usage] Comment/Usage Note
  • [Property Usage] Obligation
  • [Property Usage] Condition
  • [Property Usage] Occurrences
  • [Property Usage] Is Member Of [DCAP] Title (hyperlink: target = view DCAP Detail)

Also:

  • For each Text Document which is a specification/guidelines document for this Property Usage, view Text Document Summary. Sort list by [Text Document] Language [RFC3066] Value, [Text Document] Title.
  • For each Class which is used as an Encoding Scheme in this Property Usage, view Encoding Scheme Summary. Sort list by [Class] Label.
2.8.9.3 View Property Usage for Print

Display full Property Usage description:

  • [Property Usage] Identifier
  • [Property Usage] Subject Type [Class] Label
  • [Property Usage] Label
  • QName of used Property
  • [Property Usage] Uses [Property] Label
  • [Property Usage] Status
  • [Property Usage] Definition
  • [Property Usage] Comment/Usage Note
  • [Property Usage] Obligation
  • [Property Usage] Condition
  • [Property Usage] Occurrences

Also:

  • For each Class which is used as an Encoding Scheme in this Property Usage, view Encoding Scheme for Print. Sort list by [Class] Label.
2.8.10 View Binding Schema Description
2.8.10.1 View Binding Schema Summary
  • [Binding Schema] Title (hyperlink: target = View Binding Schema Detail)
  • [Binding Schema] Type [Binding Schema Type] Label
  • [Binding Schema] Publisher [Agency] Name (hyperlink: target = View Agency Detail)
2.8.10.2 View Binding Schema Detail

Display full Binding Schema description:

  • [Binding Schema] Identifier (hyperlink: target = View Schema Document (external link))
  • [Binding Schema] Title
  • [Binding Schema] Version
  • [Binding Schema] Type [Binding Schema Type] Label
  • [Binding Schema] Date Modified
  • [Binding Schema] Status [Vocab Status] Label
  • [Binding Schema] Description
  • [Binding Schema] Publisher [Agency] Name (hyperlink: target = view Agency Detail)

Also:

  • For each Text Document which is a specification/guidelines document for this Binding Schema, view Text Document Summary. Sort list by [Text Document] Language [RFC3066] Value, [Text Document] Title.
  • For each DCAP which is expressed by this Binding Schema, view DCAP Summary. Sort list by [DCAP] Title, [DCAP] Version.
2.8.11 View Text Document Description
2.8.11.1 View Text Document Summary
  • [Text Document] Language [RFC3066] Value
  • [Text Document] Title (hyperlink: target = View Text Document Detail)
  • [Text Document] Identifier (hyperlink: target = View Text Document (external link))
2.8.11.2 View Text Document Detail

Display full Text Document description:

  • [Text Document] Identifier (hyperlink: target = View Text Document (external link))
  • [Text Document] Title
  • [Text Document] Description
  • [Text Document] Language [RFC3066] Value

Also:

  • For each Agency for which this Text Document is a homepage, view Agency Summary. Sort list by [Agency] Name.
  • For each Metadata Vocabulary for which this Text Document is a specification/guidelines document, view Metadata Vocabulary Summary. Sort list by [Metadata Vocabulary] Title, [Metadata Vocabulary] Version.
  • For each Property for which this Text Document is a specification/guidelines document, view Property Summary. Sort list by [Property] Is Member Of [Metadata Vocabulary] Title, [Property] Is Member Of [Metadata Vocabulary] Version, [Property] Label.
  • For each Class for which this Text Document is a specification/guidelines document, view Class Summary. Sort list by [Class] Is Member Of [Metadata Vocabulary] Title, [Class] Is Member Of [Metadata Vocabulary] Version, [Class] Label.
  • For each Instance for which this Text Document is a specification/guidelines document, view Instance Summary. Sort list by [Instance] Label, [Instance] Type [Class] Label.
  • For each DCAP for which this Text Document is a specification/guidelines document, view DCAP Summary. Sort list by [DCAP] Title, [DCAP] Version.
  • For each Property Usage for which this Text Document is a specification/guidelines document, view Property Usage Summary. Sort list by [Property Usage] Is Member Of [DCAP] Title, [DCAP] Version, [Property Usage] Subject Type [Class] Label, [Property Usage] Label.
  • For each Binding Schema for which this Text Document is a specification/guidelines document, view Binding Schema Summary. Sort list by [Binding Schema] Title, [Binding Schema] Version.
2.8.12 View Encoding Scheme Description

Note: An Encoding Scheme is not defined as a distinct resource type in the data model. An Encoding Scheme is a Class which is associated with a Property Usage to prescribe the value space for a property.

2.8.12.1 View Encoding Scheme Summary
  • [Class] Label (hyperlink: target = view Class Detail)
  • QName of Class
  • [Class] Status [Term Status] Label
  • [Class] Is Member Of [Metadata Vocabulary] Title (hyperlink: target = view Metadata Vocabulary Detail)
2.8.10.2 View Encoding Scheme Detail

Display full Encoding Scheme description:

  • [Class] Label (hyperlink: target = view Class Detail)
  • QName of Class
  • [Class] Status
  • [Class] Definition
  • [Class] Comment/Usage Note
  • [Class] Is Member Of [Metadata Vocabulary] Title (hyperlink: target = view Metadata Vocabulary Detail)

Also:

  • For each Instance which is an instance of this Class, view Instance Summary. Sort list by [Instance] Label.
  • For each Property Usage which uses this Class as an Encoding Scheme, view Property Usage Summary. Sort list by [Property Usage] Is Member Of [DCAP] Title, [Property Usage] Is Member Of [DCAP] Version, [Property Usage] Subject Type [Class] Label, [Property Usage] Label.
2.8.10.3 View Encoding Scheme for Print

Display full Encoding Scheme description:

  • [Class] Label
  • QName of Class
  • [Class] Status
  • [Class] Definition
  • [Class] Comment/Usage Note
  • [Class] Is Member Of [Metadata Vocabulary] Title
2.8.12 View Subject Type Description

Note: A Subject Type is not defined as a distinct resource type in the data model. A Subject Type is a Class which is associated with a Property Usage to specify the type of resource described by a Property Usage.

2.8.13.1 View Subject Type Summary
  • [Class] Label (hyperlink: target = view Class Detail)
  • QName of Class
  • [Class] Status [Term Status] Label
  • [Class] Is Member Of [Metadata Vocabulary] Title (hyperlink: target = view Metadata Vocabulary Detail)
2.8.13.2 View Subject Type Detail

Display full Subject Type description:

  • [Class] Identifier
  • [Class] Label
  • QName of Class
  • [Class] Status
  • [Class] Definition
  • [Class] Comment/Usage Note
  • [Class] Is Member Of [Metadata Vocabulary] Title (hyperlink: target = view Metadata Vocabulary Detail)

Also:

  • For each DCAP that has as a member a Property Usage which uses this Class as a Subject Type, view DCAP Summary. Sort list by [DCAP] Title, [DCAP] Version.
2.8.13.3 View Subject Type for Print

Display full Subject Type description:

  • [Class] Identifier
  • [Class] Label
  • QName of Class
  • [Class] Status
  • [Class] Definition
  • [Class] Comment/Usage Note
  • [Class] Is Member Of [Metadata Vocabulary] Title

2.9 Administer Registry Database

To be completed

2.10 API

The registry must provide one or more interfaces that allow applications to:

  • query the registry database
  • add statements to the registry database
  • remove statements from the registry database
  • update statements in the registry database

Appropriate authentication/authorisation mechanisms must be provided.

It would be useful to support a generic RDF Query/Update API as well as a schema-specific API.

If services are provided using SOAP bindings, equivalent services should be provided using REST/HTTP bindings.

In defining the API, consideration should be given to the current best practice recommendations of the W3C Semantic Web Data Access Working Group (DAWG).

3. LOM Application Profiles

The IEMSR should support the following high-level functions.

Note: thefollowing specification is based on the premise that descriptions of LOM Data Elements, LOM Datatypes, LOM Standard Value Spaces, LOM Vocabularies, and LOM Vocabulary Values are already available (pre-loaded to the registry database): the creator of a description of a LOMAP does not need to creare these descriptions, only to refer to them. For this reason, functions such as "Describe LOM Data Element" are not included below.

  1. Describe LOM Application Profile: the creation and maintainance of a description of a LOM Application Profile, its component entities and related resources. Results in the creation of a new or updated Schema Document.

  2. Describe non-LOM Vocabulary: the creation and maintainance of a description of a non-LOM Vocabulary and its constituent non-LOM Vocabulary Values. Results in the creation of a new or updated Schema Document.

  3. Describe Extended Data Element Set: the creation and maintainance of a description of an Extended Data Element Set and its constituent Extended Data Elements.

  4. Describe Schema Document: the creation and/or maintainance of descriptions of these Schema Documents as distributed data sources for the IEMSR. A Schema Documents is created by the one of the first three functions above

  5. Submit/Withdraw Schema Document: request that a Schema Document is read and the content indexed and added to the registry database; or request that the content of a previously indexeddocument is removed from the registry database

  6. Browse Registry Data: the navigation of the database through an HTML interface for human users

  7. Query Registry Datae: the provision of query services on that database through an HTML interface for human users

  8. Administer Registry Database:

  9. API

Although these are listed as distinct functions, multiple functions may be provided within a single software tool. Each function is described in more detail in the following sections.

3.1 Describe LOMAP

3.1.1 Create New Description of LOMAP

The human administrator of a LOMAP (or a third party) needs to be able to create a new description of a LOMAP:

  1. Create New Schema Document

  2. Create Agency Description: create a description of the Agency responsible for the management of the DC application profile, including descriptions of any related Text Document (home page for the Agency).

  3. Create LOMAP Description: create a description of the LOMAP, including descriptions of any related Text Document (human-readable specification or guidelines).

  4. For zero or more binding schemas associated with the LOMAP:

    • Create Binding Schema Description: create a description of Binding Schema, including descriptions of any related Text Document (human-readable specification or guidelines).

  5. For zero or more LOM Data Elements used in this LOMAP:

    • Select LOM Data Element for Use: select a LOM Data Element.

    • Create Data Element Usage Description: create a description of the Data Element Usage, including descriptions of any related Text Document (human-readable specification or guidelines).

      For a usage of a simple LOM Data Element with the LOM Datatype "Vocabulary", for zero or more non-LOM Vocabularies:

      • Add non-LOM Vocabulary as Value Space Extension: add relation between this LOM Data Element Usage and a selected existing non-LOM Vocabulary.

      For zero or more usages of the LOM Data Element "9. Classification":

      • Add Classification Purpose: from standard LOM Vocabulary for Classification.

      • Add Taxonomy: add relation between this LOM Data Element Usage and a selected existing Taxonomy.

  6. Save Schema Document: as local file.

3.1.2 Edit Description of LOMAP

The human administrator of a LOMAP (or a third party) needs to be able to edit an existing description of a DCAP:

  1. Open Schema Document: either from local file or from URL.

  2. Edit Agency Description: edit the description of the Agency responsible for the management of the LOMAP, including descriptions of any related Text Document (home page for the Agency).

  3. Edit LOMAP Description: edit the description of the LOMAP, including descriptions of any related Text Document (human-readable specification or guidelines).

  4. For zero or more selected binding schemas associated with the LOMAP:

    • Edit Binding Schema Description: edit the description of Binding Schema, including descriptions of any related Text Document (human-readable specification or guidelines).

  5. For zero or more selected binding schemas associated with the LOMAP:

    • Delete Binding Schema Description: delete the description of Binding Schema, including descriptions of any related Text Document (human-readable specification or guidelines).

      [Not sure whether this should delete node or flag node as deleted?]

  6. For zero or more additional binding schemas associated with the LOMAP:

    • Create Binding Schema Description: (as above).

  7. For zero or more selected LOM Data Element Usages:

    • Edit LOM Data Element Usage Description: edit the description of the LOM Data Element Usage, including descriptions of any related Text Document (human-readable specification or guidelines).

      For a usage of a simple LOM Data Element with the LOM Datatype "Vocabulary", for zero or more non-LOM Vocabularies to be removed:

      • Remove Non-LOM Vocabulary as Value Space Extension: Remove relationships between this LOM Data Element usage and a non-LOM Vocabulary

      For a usage of a simple LOM Data Element with the LOM Datatype "Vocabulary", for zero or more non-LOM Vocabularies to be added:

      • Add non-LOM Vocabulary as Value Space Extension: (as above).

      For zero or more usages of the LOM Data Element "9. Classification":

      • Edit Classification Purpose: from standard LOM Vocabulary for Classification.

      • Remove Taxonomy: remove relation between this LOM Data Element Usage and a selected existing Taxonomy.

      • Add Taxonomy: (as above).

  8. For zero or more selected LOM Data Element usages:

    • Delete LOM Data Element Usage Description: delete the description of the LOM Data Element Usage, including descriptions of any related Text Document (human-readable specification or guidelines), and remove any encoding scheme relationships in which this property usage is subject.

  9. For zero or more additional LOM Data Elements used in this LOMAP:

    • Select LOM Data Element for Use: (as above).

    • Create LOM Data Element Usage Description (as above).

  10. Save Schema Document: as local file.

3.1.3 Delete Description of LOMAP

[Not sure whether this should delete node or flag node as deleted?]

3.1.4 Clone Description of LOMAP

The human administrator of a LOMAP (or a third party) needs to be able to create a new description of a LOMAP, by using an existing LOMAP as the starting point:

Note: the cloning of a LOMAP does not imply any relationship between the newly created LOMAP and the selecteed/cloned LOMAP; this operation is simply a convenience for the LOMAP creator. It does not imply that instances conforming to the newly created LOMAP will necessarily conform to the selected/cloned LOMAP. For example, where a LOM Data Element Usage in the selected/cloned LOMAP specified that usage of a LOM Data Element was mandatory, a LOM Data Element Usage in the newly created LOMAP might specify that it is optional.

  1. Create New Schema Document

  2. Select LOMAP: select an existing LOMAP to serve as the the starting point for this new description of a LOMAP

  3. If agency which manages new LOMAP is different from that of cloned DCAP

    • Delete Agency Description

    • Create Agency Description (as above)

  4. Edit LOMAP Description: (as above)

  5. For zero or more selected binding schemas associated with the LOMAP:

    • Edit Binding Schema Description: (as above).

  6. For zero or more selected binding schemas associated with the LOMAP:

    • Delete Binding Schema Description: (as above).

  7. For zero or more additional binding schemas associated with the LOMAP:

    • Create Binding Schema Description: (as above).

  8. For zero or more selected LOM Data Element usages:

    • Edit LOM Data Element Usage Description: (as above)

  9. For zero or more selected LOM Data Element usages:

    • Delete LOM Data Element Usage Description: (as above)

  10. For zero or more additional LOM Data Elements used in this LOMAP:

    • Select LOM Data Element for Use: (as above).

    • Create LOM Data Element Usage Description (as above).

  11. Save Schema Document: as local file.

3.1.5 Create New Description of LOMAP conforming to existing "base" LOMAP

The human administrator of a LOMAP (or a third party) needs to be able to create a new description of a LOMAP, where all instances conforming to the new LOMAP will also conform to an existing "base" LOMAP. i.e. the constraints expressed in the new LOMAP are a superset of those expressed in the existing LOMAP.

Note: this differs from the "cloning" case described in the previous section. For example, in this case where a LOM Data Element Usage in the "base" LOMAP specified that usage of a LOM Data Element was mandatory, a LOM Data Element Usage in the newly created LOMAP must not specify that it is optional. A LOM Data Element Usage specified in the base LOMAP canbe edited, but must not be deleted. The author must be able to confirm that the LOMAP being created/edited conforms to the constraints of the existing "base" LOMAP.

  1. Create New Schema Document

  2. Select LOMAP: select an existing LOMAP to serve as the "base" for this new description of a LOMAP

  3. If agency which manages new LOMAP is different from that of cloned DCAP

    • Delete Agency Description

    • Create Agency Description (as above)

  4. Edit LOMAP Description: (as above)

  5. For zero or more selected binding schemas associated with the LOMAP:

    • Edit Binding Schema Description: (as above).

  6. For zero or more selected binding schemas associated with the LOMAP:

    • Delete Binding Schema Description: (as above).

  7. For zero or more additional binding schemas associated with the LOMAP:

    • Create Binding Schema Description: (as above).

  8. For zero or more selected LOM Data Element usages:

    • Edit LOM Data Element Usage Description: (as above)

  9. For zero or more additional LOM Data Elements used in this LOMAP:

    • Select LOM Data Element for Use: (as above).

    • Create LOM Data Element Usage Description (as above).

  10. Save Schema Document: as local file.

3.2 Describe non-LOM Vocabulary

3.2.1 Create New Description of non-LOM Vocabulary

Note: We need to consider what level of interoperability with VDEX we are proposing. Should IEMSR tools support the capacity to import vocabularies from VDEX documents? And expose vocabularies as VDEX? If other LOM tools are working with VDEX, and LOM implementers are creating VDEX documents, then it seems problematic if IEMSR doesn't use/provide them e.g. we shouldn't ask LOMAP creators to re-enter their vocabulary for the IEMSR if a VDEX document exists.

  1. Create New Schema Document

  2. Create Non-LOM Vocabulary Description: create a description of the Non-LOM Vocabulary, including descriptions of any related Text Document (human-readable specification or guidelines).

  3. For one or more Vocabulary Values:

    • Create Description of Vocabulary Value: create a description of the Vocabulary Value, including descriptions of any related Text Document (human-readable specification or guidelines).

  4. Save Schema Document: as local file.

3.2.2 Edit Description of non-LOM Vocabulary

  1. Open Schema Document: either from local file or from URL.

  2. For zero or more selected instances:

    • Edit Description of Vocabulary Value: edit a description of the Vocabulary Value, including descriptions of any related Text Document (human-readable specification or guidelines).

  3. For zero or more additional Vocabulary Values:

    • Create Description of Vocabulary Value: (as above).

  4. For zero or more selected Vocabulary Values:

    • Delete Description of Vocabulary Value.

      [Not sure whether this should delete node or flag node as deleted?]

  5. Save Schema Document: as local file.

3.2.3 Delete Description of non-LOM Vocabulary

[Not sure whether this should delete node or flag node as deleted?]

3.3 Describe Extended Data Element Set

[Defer to second phase]

3.4 Describe Schema Document

A Schema Document is a document created by the one of the first three functions above.

N.B. The publisher of a Schema Document may be a different Agency from the administrator of the LOMAP/non-LOM Vocabulary/Extended Data Element Set described by that Schema Document; and where descriptions of a LOMAP/non-LOM Vocabulary/Extended Data Element Set are available in multiple Schema Documents (in multiple languages), each of those Schema Documents may have a different Agency as publisher.

3.4.1 Create New Description of Schema Document

The human publisher of a Schema Document (or a third party) needs to be able to create a new description of a Schema Document.

  1. Create Agency Description: create a description of the Agency responsible for the management of the Schema Document, including descriptions of any related Text Document (home page for the Agency).

  2. Create Description of Schema Document: create a description of the Schema Document.

3.4.2 Edit Description of Schema Document

The human publisher of a Schema Document (or a third party) needs to be able to edit a description of a Schema Document.

  1. Edit Agency Description: edit a description of the Agency responsible for the management of the Schema Document, including descriptions of any related Text Document (home page for the Agency).

  2. Edit Description of Schema Document: edit description of the Schema Document.

3.4.2 Delete Description of Schema Document

[Not sure whether this should delete node or flag node as deleted?]

3.5 Submit/Withdraw Schema Document

3.5.1 Submit Schema Document to Registry

Having created or edited a Schema Document and created or edited a description of that Schema Document, the human publisher of a Schema Document (or a third party) needs to be able to signal to the registry server that it should be read and indexed.

Note: As part of the submission process, the IEMSR should store a copy of the submitted document, so that it is still available in the case that the copy at the location maintained by the publisher becomes inaccessible.

3.5.2 Withdraw Schema Document from Registry

The human publisher of a Schema Document (or a third party) needs to be able to signal to the registry server that an existing Schema Document should no longer be read and indexed,and the content should be removed from the database.

3.6 Browse Registry Database

The human-readable interface should allow a researcher to browse lists of all entities described (except data element usages, text documents and binding schemas):

3.6.1 Browse Schema Documents

For each Schema Document in database, view Schema Document Summary. Sort list by [Schema Document] Language [RFC3066] Value, [Schema Document] published by [Agency] Name, [Schema Document] Title.

3.6.2 Browse Agencies

For each Agency in database, view Agency Summary. Sort list by [Agency] Name.

3.6.3 Browse LOM Data Elements

For each LOM Data Element in database, view LOM Data Element Summary. Sort list by [LOM Data Element] Number.

3.6.4 Browse LOM Vocabularies

For each LOM Vocabulary in database, view LOM Vocabulary Summary. Sort list by [LOM Vocabulary] Name.

3.6.5 Browse non-LOM Vocabularies

For each non-LOM Vocabulary in database, view non-LOM Vocabulary Summary. Sort list by [Non-LOM Vocabulary] Name.

3.6.6 Browse LOMAPs
3.6.6.1 Browse All LOMAPs

For each LOMAP in database, view LOMAP Summary. Sort list by [LOMAP] Title, [LOMAP] Version.

3.6.6.2 Browse LOMAPs Grouped by Status

For each LOMAP in database, view LOMAP Summary, grouped by [LOMAP] Status. Within group, sort list by [LOMAP] Title, [LOMAP] Version.

3.6.7 Browse Extended Data Element Sets

[Defer to second phase]

3.6.8 Browse Extended Data Elements

[Defer to second phase]

3.6.9 Browse Data Element Usages

No browse interface required.

3.6.10 Browse Binding Schemas

No browse interface required.

3.6.11 Browse Text Documents

No browse interface required.

3.7 Query Registry Database

A human researcher should be able to query the aggregated data:

Using simple keyword searches on literal values:

  • search for Agencies, by keyword in [Agency] Name, [Agency] Description; present result set as view Agency Summary.
  • search for LOMAPs by keyword in [LOMAP] Title, [LOMAP] Description; present result set as view LOMAP Summary.
  • search for Non-LOM Vocabularies by keyword in [non-LOM Vocabulary] Title, [non-LOM Vocabulary] Description; present result set as view non-LOM Vocabulary Summary.
  • search for Extended Data Element Sets by keyword in [Extended Data Element Set] Title, [Extended Data Element Set] Description; present result set as view Extended Data Element Set Summary.
  • search for Text Documents by keyword in [Text Document] Title, [Text Document] Description; present result set as view Text Document Summary.
  • search for Schema Documents by keyword in [Schema Document] Title, [Schema Document] Description; present result set as view Schema Document Summary.

3.8 View Registry Database

3.8.1 View Schema Document Description
3.8.1.1 View Schema Document Summary
  • [Schema Document] Language [RFC3066] Value
  • [Schema Document] Title (hyperlink: target = View Schema Document Detail)
  • [Schema Document] Publisher [Agency] Name (hyperlink: target = View Agency Detail)
  • [Schema Document] Identifier (hyperlink: target = View Schema Document (external link))
3.8.1.2 View Schema Document Detail

Display full Schema Document description:

  • [Schema Document] Identifier (hyperlink: target = View Schema Document (external link))
  • [Schema Document] Title
  • [Schema Document] Date Modified
  • [Schema Document] Description
  • [Schema Document] Language [RFC3066] Value
  • [Schema Document] Publisher [Agency] Name (hyperlink: target = view Agency Detail)

Also:

  • For each LOMAP described by this Schema Document, view LOMAP Summary. Sort list by [LOMAP] Title, [LOMAP] Version.
  • For each non-LOM Vocabulary described by this Schema Document, view non-LOM Vocabulary Summary. Sort list by [Non-LOM Vocabulary] Title, [Non-LOM Vocabulary] Version.
3.8.2 View Agency Description
3.8.2.1 View Agency Summary
  • [Agency] Name (hyperlink: target = View Agency Detail)
3.8.2.2 View Agency Detail

View full Agency description:

  • [Agency] Identifier
  • [Agency] Name
  • [Agency] Description

Also:

  • For each Text Document which is the homepage of this Agency, view Text Document Summary. Sort list by [Text Document] Language [RFC3066] Value, [Text Document] Title.
  • For each LOMAP for which this Agency is the administrator/publisher, view LOMAP Summary. Sort list by [LOMAP] Title, [LOMAP] Version.
  • For each non-LOM Vocabulary for which this Agency is the administrator/publisher, view non-LOM Vocabulary Summary. Sort list by [Non-LOM Vocabulary] Title, [Non-LOM Vocabulary] Version.
  • For each Schema Document for which this Agency is the publisher, view Schema Document Summary. Sort list by [Schema Document] Language [RFC3066] Value, [Schema Document] Title, [Schema Document] Version.
3.8.2.3 View Agency for Print

View full Agency description:

  • [Agency] Identifier
  • [Agency] Name
  • [Agency] Description
3.8.3 View LOM Data Element Description
3.8.3.1 View LOM Data Element Summary
  • [LOM Data Element] Number
  • [LOM Data Element] Name (hyperlink: target = View LOM Data Element Detail)
3.8.3.2 View LOM Data Element Detail

Display full LOM Data Element description:

  • [LOM Data Element] Identifier
  • [LOM Data Element] Number
  • [LOM Data Element] Name
  • [LOM Data Element] Description
  • [LOM Data Element] Size
  • [LOM Data Element] Order
  • [LOM Data Element] Is Child Of [LOM Data Element] Name (hyperlink: target = view LOM Data Element Detail)

For a Simple LOM Data Element, also:

  • [LOM Data Element] Value Space
  • [LOM Data Element] Datatype
  • [LOM Data Element] Example

For a Simple LOM Data Element of datatype Vocabulary, also:

  • [LOM Data Element] Value Space (hyperlink: target = view LOM Vocabulary Detail)

Also:

  • For each LOM Data Element Usage which uses this LOM Data Element, view LOM Data Element Usage Summary. Sort list by [LOM Data Element Usage] Is Member Of [LOMAP] Title, [LOM Data Element Usage] Is Member Of [LOMAP] Version.
3.8.4 View LOM Vocabulary Description
3.8.4.1 View LOM Vocabulary Summary
  • [LOM Vocabulary] Name (hyperlink: target = View LOM Vocabulary Detail)
  • [LOM Data Element] Name (hyperlink: target = View LOM Data Element Detail) (i.e. the LOM Data Element for which this vocabulary defines the value space)
3.8.4.2 View LOM Vocabulary Detail
  • [LOM Vocabulary] Identifier
  • [LOM Vocabulary] Name (hyperlink: target = View LOM Vocabulary Detail)
  • [LOM Data Element] Name (hyperlink: target = View LOM Data Element Detail) (i.e. the LOM Data Element for which this vocabulary defines the value space)
  • [LOM Vocabulary] Description
  • [LOM Vocabulary] VDEX (hyperlink: target = View VDEX Document Detail)

Also:

  • For each Schema Document which describes this LOM Vocabulary, view Schema Document Summary. Sort list by [Schema Document] Language [RFC3066] Value, [Schema Document] Title
  • For each Vocabulary Value which is a member of this Vocabulary, view Vocabulary Value Summary. Sort list by [Vocabulary Value] Label.
3.8.5 View Non-LOM Vocabulary Description
3.8.5.1 View Non-LOM Vocabulary Summary
  • [Non-LOM Vocabulary] Name (hyperlink: target = View Non-LOM Vocabulary Detail)
  • [Non-LOM Vocabulary] Version
  • [Non-LOM Vocabulary] Status [Vocab Status] Label
  • [Non-LOM Vocabulary] Administrator [Agency] Name (hyperlink: target = View Agency detail)
3.8.4.2 View Non-LOM Vocabulary Detail
  • [Non-LOM Vocabulary] Identifier
  • [Non-LOM Vocabulary] Name (hyperlink: target = View LOM Vocabulary Detail)
  • [Non-LOM Vocabulary] Description
  • [Non-LOM Vocabulary] VDEX (hyperlink: target = View VDEX Document Detail)

Also:

  • For each Schema Document which describes this Non-LOM Vocabulary, view Schema Document Summary. Sort list by [Schema Document] Language [RFC3066] Value, [Schema Document] Title
  • For each Vocabulary Value which is a member of this Vocabulary, view Vocabulary Value Summary. Sort list by [Vocabulary Value] Label.
  • For each LOM Data Element Usage which uses this Non-LOM Vocabulary to extend the value space, view LOM Data Element Usage Summary. Sort list by [LOM Data Element Usage] Is Member Of [LOMAP] Title, [LOM Data Element Usage] Is Member Of [LOMAP] Version.
3.8.6 View Vocabulary Value Description
2.8.1.1 View Vocabulary Value Summary
  • [Vocabulary Value] Label (hyperlink: target = View Instance Detail)
  • [Vocabulary Value] Status [Term Status] Label
3.8.6.2 View Vocabulary Value Detail
  • [Vocabulary Value] Identifier
  • [Vocabulary Value] Label
  • [Vocabulary Value] Status [Term Status] Label
  • [Vocabulary Value] Description
  • [Vocabulary Value] Type/Is Member Of [Vocabulary] Name (hyperlink: target = View Vocabulary Detail)
  • For each Text Document which is a specification/guidelines document for this Vocabulary Value, view Text Document Summary. Sort list by [Text Document] Language [RFC3066] Value, [Text Document] Title.
  • For each Schema Document which describes this Vocabulary Value, view Schema Document Summary. Sort list by [Schema Document] Language [RFC3066] Value, [Schema Document] Title
3.8.7 View LOMAP Description
3.8.7.1 View LOMAP Summary
  • [LOMAP] Title (hyperlink: target = view LOMAP Detail)
  • [LOMAP] Version
  • [LOMAP] Status [Vocab Status] Label
  • [LOMAP] Administrator [Agency] Name (hyperlink: target = View Agency detail)
3.8.7.2 View LOMAP Detail

Display full LOMAP description:

  • [LOMAP] Identifier
  • [LOMAP] Title
  • [LOMAP] Version
  • [LOMAP] Date Modified
  • [LOMAP] Description
  • [LOMAP] Status [Vocab Status] Label
  • [LOMAP] Administrator [Agency] Name (hyperlink: target = view Agency Detail)

Also:

  • For each Schema Document which describes this LOMAP, view Schema Document Summary. Sort list by [Schema Document] Language [RFC3066] Value, [Schema Document] Title
  • For each Text Document which is a specification/guidelines document for this LOMAP, view Text Document Summary. Sort list by [Text Document] Language [RFC3066] Value, [Text Document] Title.
  • For each Binding Schema which expresses this LOMAP, view Binding Schema Summary. Sort list by [Binding Schema] Title
  • For each LOM Data Element Usage which is a member of this LOMAP, view LOM Data Element Usage Summary. Sort list by [LOM Data Element Usage] Uses [LOM Data Element] Number.
3.8.7.3 View LOMAP for Print

A representation of a LOMAP and its components suitable for printing. (Includes detail views of components rather than just summary views.)

View full LOMAP description:

  • [LOMAP] Identifier
  • [LOMAP] Title
  • [LOMAP] Version
  • [LOMAP] Date Modified
  • [LOMAP] Description
  • [LOMAP] Status [Vocab Status] Label

Also:

  • For each Agency which is an administrator of this LOMAP, view Agency for Print.
  • For each LOM Data Element Usage which is a member of this LOMAP, view LOM Data Element Usage for Print. Sort list by [LOM Data Element Usage] Uses [LOM Data Element] Number.
3.8.7.4 View LOMAP XML

Obtain a simple XML representation of the LOMAP.

3.8.8 View LOM Data Element Usage Description
3.8.8.1 View Property Usage Summary
  • [LOM Data Element Usage] Uses [LOM Data Element] Number
  • [LOM Data Element Usage] Uses [LOM Data Element] Name (hyperlink: target = view LOM Data Element Detail)
  • [LOM Data Element Usage] Status [Term Status] Label
  • [LOM Data Element Usage] Is Member Of [LOMAP] Title (hyperlink: target = view LOMAP Detail)
3.8.8.2 LOM Data Element Usage Detail
  • [LOM Data Element Usage] Uses [LOM Data Element] Number
  • [LOM Data Element Usage] Uses [LOM Data Element] Name (hyperlink: target = view LOM Data Element Detail)
  • [LOM Data Element Usage] Status [Term Status] Label
  • [LOM Data Element Usage] Comment/Usage Note
  • [LOM Data Element Usage] Obligation
  • [LOM Data Element Usage] Condition
  • [LOM Data Element Usage] Is Member Of [LOMAP] Title (hyperlink: target = view LOMAP Detail)

Also:

  • For each Text Document which is a specification/guidelines document for this LOM Data Element Usage, view Text Document Summary. Sort list by [Text Document] Language [RFC3066] Value, [Text Document] Title.

For a usage of a Simple LOM Data Element of datatype Vocabulary, also:

  • For each Non-LOM Vocabulary which is used to extend the value space of the LOM Data Element, view Non-LOM Vocabulary Summary. Sort list by [Non-LOM Vocabulary] Name.

For a usage of a LOM Classification Data Element, also:

  • [LOM Data Element Usage] Classification Purpose
  • [LOM Data Element Usage] Taxonomy [Non-LOM Vocabulary] Name (hyperlink: target = View Non-LOM Vocabulary Detail)
3.8.8.3 View LOM Data Element Usage for Print
  • [LOM Data Element Usage] Uses [LOM Data Element] Number
  • [LOM Data Element Usage] Uses [LOM Data Element] Name
  • [LOM Data Element Usage] Uses [LOM Data Element]
  • [LOM Data Element Usage] Uses [LOM Data Element] Description
  • [LOM Data Element Usage] Uses [LOM Data Element] Size
  • [LOM Data Element Usage] Uses [LOM Data Element] Order
  • [LOM Data Element Usage] Status [Term Status] Label
  • [LOM Data Element Usage] Comment/Usage Note
  • [LOM Data Element Usage] Obligation
  • [LOM Data Element Usage] Condition

For a Simple LOM Data Element, also:

  • [LOM Data Element Usage] Uses [LOM Data Element] Value Space
  • [LOM Data Element Usage] Uses [LOM Data Element] Datatype
  • [LOM Data Element Usage] Uses [LOM Data Element] Example

For a usage of a Simple LOM Data Element of datatype Vocabulary, also:

  • For each Non-LOM Vocabulary which is used to extend the value space of the LOM Data Element, view Non-LOM Vocabulary Summary. Sort list by [Non-LOM Vocabulary] Name.

For a usage of a LOM Classification Data Element, also:

  • [LOM Data Element Usage] Classification Purpose
  • [LOM Data Element Usage] Taxonomy [Non-LOM Vocabulary] Name
3.8.9 View Extended Data Element Set Description

[Defer to phase 2]

3.8.8 View Extended Data Element Description

[Defer to phase 2]

3.8.11 View Binding Schema Description
3.8.11.1 View Binding Schema Summary
  • [Binding Schema] Title (hyperlink: target = View Binding Schema Detail)
  • [Binding Schema] Type [Binding Schema Type] Label
  • [Binding Schema] Publisher [Agency] Name (hyperlink: target = View Agency Detail)
3.8.11.2 View Binding Schema Detail

Display full Binding Schema description:

  • [Binding Schema] Identifier (hyperlink: target = View Schema Document (external link))
  • [Binding Schema] Title
  • [Binding Schema] Version
  • [Binding Schema] Type [Binding Schema Type] Label
  • [Binding Schema] Date Modified
  • [Binding Schema] Status [Vocab Status] Label
  • [Binding Schema] Description
  • [Binding Schema] Publisher [Agency] Name (hyperlink: target = view Agency Detail)

Also:

  • For each Text Document which is a specification/guidelines document for this Binding Schema, view Text Document Summary. Sort list by [Text Document] Language [RFC3066] Value, [Text Document] Title.
  • For each LOMAP which is expressed by this Binding Schema, view LOMAP Summary. Sort list by [LOMAP] Title, [LOMAP] Version.
3.8.12 View VDEX Document Description
3.8.11 View Text Document Description
3.8.11.1 View Text Document Summary
  • [Text Document] Language [RFC3066] Value
  • [Text Document] Title (hyperlink: target = View Text Document Detail)
  • [Text Document] Identifier (hyperlink: target = View Text Document (external link))
3.8.13.2 View Text Document Detail

Display full Text Document description:

  • [Text Document] Identifier (hyperlink: target = View Text Document (external link))
  • [Text Document] Title
  • [Text Document] Description
  • [Text Document] Language [RFC3066] Value

Also:

  • For each Agency for which this Text Document is a homepage, view Agency Summary. Sort list by [Agency] Name.
  • For each LOMAP for which this Text Document is a specification/guidelines document, view LOMAP Summary. Sort list by [LOMAP] Title, [LOMAP] Version.
  • For each Non-LOM Vocabulary for which this Text Document is a specification/guidelines document, view Non-LOM Vocabulary Summary. Sort list by [Non-LOM Vocabulary] Title, [Non-LOM Vocabulary] Version.
  • For each Binding Schema for which this Text Document is a specification/guidelines document, view Binding Schema Summary. Sort list by [Binding Schema] Title, [Binding Schema] Version.

3.9 Administer Registry Database

To be completed

3.10 API

The registry must provide one or more interfaces that allow applications to:

  • query the registry database
  • add statements to the registry database
  • remove statements from the registry database
  • update statements in the registry database

Appropriate authentication/authorisation mechanisms must be provided.

It would be useful to support a generic RDF Query/Update API as well as a schema-specific API.

If services are provided using SOAP bindings, equivalent services should be provided using REST/HTTP bindings.

In defining the API, consideration should be given to the current best practice recommendations of the W3C Semantic Web Data Access Working Group (DAWG).

-

Valid XHTML 1.0!

Web page content by Pete Johnston of UKOLN
Page last revised on: 31 August 2004

Email comments to webmaster@ukoln.ac.uk