onestop

OneStop is a data discovery system being built by CIRES researchers on a grant from the NOAA National Centers for Environmental Information. We welcome contributions from the community!

This project is maintained by cedardevs

Documentation Home

Estimated Reading Time: 25 minutes

Metadata Manager Documentation

Since this role requires interacting with several OneStop components, you are encouraged to start with the brief architectural overview to get your bearings.

Table of Contents

Creating Metadata

If you need to create your metadata manually here are some useful, external, guides and templates for metadata. Questions specific to these documents should be directed to the NCEI Metadata WG at ncei.metadata@noaa.gov.

Keep in mind that however your data is getting into OneStop it supports the metadata formats of either JSON or ISO-19115-2 XML.

For a better OneStop discovery experience please be mindful of what fields are in your metadata.

Loading Metadata into OneStop

If your metadata isn’t automatically being loading into OneStop (some applications already automatically send metadata to OneStop), there are a few ways to do that:

OneStop Python Client

The OneStop Clients repo has a python client that is useful for searching OneStop for metadata.

Registry API

Metadata can be published into OneStop via the Registry API. The Registry application has a RESTful interface that allows for CRUD (Create, Read, Update, and Delete) actions on metadata.
Keep in mind the Registry REST API is secured via CAS authentication, more detail within the OneStop Registry Security documentation.

There’s a little more information in Upload Test Metadata

Kafka

Searching OneStop for Metadata

Perhaps you’ve loaded your metadata through an external tool that pushes its output to OneStop. On the other hand, you might be directly pushing metadata to OneStop via the Registry API.

No matter how your metadata gets into OneStop, however, you’ll probably be curious about what you can do to take full advantage of the OneStop search functionality.

For the purpose of search engines be able to find the data in OneStop we iterate over every collection within OneStop and pull out important fields that end up in a sitemap file that search engines such as Google can use as an index for OneStop’s content.

References


Top of Page