Introduction

Welcome to the guidelines of EUDAT’s metadata service B2FIND for data providers. These guidelines are intended to provide information about the requirements for successful integration in B2FIND.

Intended Audience

The audience of this document is research data providers and repository managers who intend to publish their metadata on B2FIND.

Objective

B2FIND gathers diverse metadata on the research output of many heterogeneous sources, with the aim of providing a unified discovery portal allowing widespread and cross-disciplinary search and access to the underlying data collections.

These guidelines provide instructions and policies that should be followed by data providers to establish an ingestion workflow.

Open research data principles

EUDAT propagates 'best practices' which follow the so-called FAIR principles, a set of guidelines widely used for managing scientific data so that it can be accessed and re-used efficiently, see Guidelines on FAIR Data Management in Horizon 2020 . The FAIR principles promote:

  • the availability of data supporting scholarly publications,
  • the use of data repositories,
  • the value of data curation to enable data access and reuse,
  • support for developing researchers’ data skills,
  • cultural norms of academia that ensure individuals can gain credit for sharing data.

We address these principles to the extent that they affect metadata in the following sections. In general, we follow a low-barrier approach that aims to facilitate an easy and smooth integration into B2FIND.

Contents of the Guidelines

The guidelines are divided into three sections:

  1. The first section addresses the policies for Providing Metadata for EUDAT-B2FIND, e.g. policies about the structure and availability of the provided metadata.
  2. The subsequent section focuses on the Harvesting of Metadata by B2FIND.
  3. Finally, we investigate the Mapping onto the common B2FIND Schema and give some recommendations on how metadata quality can be improved or assured during this process.

B2FIND Workflow

A schema of the B2FIND metadata ingestion workflow can be seen in the figure below. Besides the first (MD Generation) and last (MD Uploading) steps, the sub processes ‘MD Providing’, ‘MD Harvesting’ and ‘MD Mapping’ correspond to the paragraphs of the guidelines.

B2FIND ingestion workflow
The B2FIND metadata ingestion workflow

While we don't go in the technical details, we refer

  • data managers who are interested in the step by step implementation of the whole metadata ingestion workflow to the B2FIND-Training material.
  • developers who are interested in the underlying software and source code to the github repository EUDAT-B2FIND .

Versions

  • 1.3 September 2018
  • 1.0 August 2017 - Initial publication on the productive B2FIND instance
  • 0.3 June 2017 - Initial publication on the training instance .
  • 0.2. May 2017 - Reviewed version and first draft for web pages
  • 0.1 February 2017 - Initial internal reviewed document
  • 0.0.2 January 2017 - Added changes and proposals (still working on paper)
  • 0.0.1 December 2017 - Early draft, B2FIND team

Editors

  • Juha Hakala, NLF
  • Heinke Höck, DKRZ
  • Mikael Karlsson, CSC
  • Michael Kurtz, DKRZ
  • Claudia Martens, DKRZ
  • Sara Ramezani, Surf-sara
  • Hannes Thiemann, DKRZ
  • Heinrich Widmann, DKRZ
  • Anna-Lena Flügel, DKRZ