Responsible for this page: ​Davor Ostojić.
Last content check: 03-11-2015
Status: design

Purpose

The purpose of this page is to collect relevant information about Curation Module project.

Project: Curation Module

The goal of this project is to implement software component for curation and quality assessment which can be integrated in the CLARIN workflow. Project is initialized by Metadata Curation Task Force. Specification for the Curation Module is based on the Metadata Quality Assessement Service proposal.
For implementation this project will use some of the existing CLARIN components:

---

Contents

1. Project: Curation Module
   1. People
   2. Getting code
   3. Usage
   4. System Requirements
   5. Dependencies
   6. Building and Deploying
   7. Interfaces
   8. Design
   9. Tickets
   10. Status, Planning and Roadmap
   11. Resources
   12. History

---

People

• ​Matej Ďurčo - coordinator (CLARIN-AT, CLARIN Center Vienna)
• ​Davor Ostojić - developer (CLARIN-AT, CLARIN Center Vienna)

---

Getting code

The project is in design phase, when the code becomes available, links to code will be posted here.

---

Usage

---

System Requirements

Requirements for the project are based on Metadata Quality Assessement Service requirements

Identified Use Cases

Use Case 1 – Metadata Editor checks the validity of newly created record

• Title: Check validity of metadata record
• Actor: MD Author / Editor
• Level: User Goal
• Main Success Scenario:
  
  1. User copies MD record into the web form and starts validation by clicking "Validate" button
     
  2. Module does schema validation, link checks, vocabulary check, facet coverage assessment
     
  3. User gets the report with status, eventual errors and assessment
     
  4. User gets instructions how to improve MD record (recommended profile, recommended values)
     

Use Case 2 – CMDI Admin checks the quality of newly created profile

• Title: Check quality of profile/schema
• Actor: CMDI Editor
• Level: User Goal
• Main Success Scenario:
  
  1. CMDI Editor runs the curation module and passes as argument profile or schema
     
  2. Module does link checks and facet coverage assessment
     
  3. User gets the report on links availability and facet coverage
     

Use Case 3 – Repository Admin checks quality of metadata in his repository

• Title: Check overall quality of metadata in repository
• Actor: Repository Admin
• Level: User Goal
• Main Success Scenario:
  
  1. Admin runs module from command line and passes as argument location containing MD records
     
  2. Module does quality assessment of the records
     
  3. Admin gets summarized report on overall quality of MD records in his repository
     

Use Case 4 – Curation Module in VLO workflow

• Title: Use Case 4 – Curation Module in VLO workflow
• Actor: VLO workflow
• Level: Summary
• Main Success Scenario:
  
  1. Curation Module is called before vlo-importer component with location where MD records are stored as argument
     
  2. Module does validation and normalization and generates different kinds of reports and normalized MD record
     
  3. VLO importer uses normalized records in post-processing phase and imports them into SOLR
     
  4. After importing script emails reports to VLO admin, MD Curators and data providers
     

---

Dependencies

For implementation following projects will be used:

• CMDI Validator
• VLO backend
• OAI Harvester

---

Building and Deploying

---

Interfaces

---

Design

Component Diagram:

---

Tickets

#676 - Create a metadata curation module

---

Status, Planning and Roadmap

Status: is the project active, on hold, mature but supported, due to be deprecated, etc.

Planning and roadmap: if there are other places with planning documents, don't forget to link to them.

---

Resources

Link to (external) documents, e.g. documentation, papers, requirement analyses, relevant to this project in this section.

---

History

Who has worked on this project, and roughly what did they do? Mention significant developments even if the relevant code/functionality has later been removed. Include yourself, of course.