Technical Overview

Here's a quick overview of how the parts of the SHARE notification service work together.

---

The Code Behind the Notification Service

The SHARE Notification Service has two main hubs: scrAPI, and the OSF.

scrAPI

ScrAPI is the "brains" of the SHARE Notification service - it coordinates all of the harvesters, makes sure that each task is run when it is scheduled to run, and stores all of the raw metadata for later use.

All of the code for scrAPI is located in the scrAPI github repository.

Once scrAPI gathers all of the metadata from each source, it then sends it to the OSF for further processing, and ultimate notification distribution.

For more information and details, see the scrAPI section on the OSF Development Wiki.

The OSF

The output and outside access portions of the SHARE Notification Service works together with the Open Science Framework, and takes advantage of the robust structure, scalability, and security that the OSF offers.

The Open Science Framework will provide the scaffolding for the many sources of output for the notification service, including the ATOM feed and JSON endpoint. While it is under active development, all of the code for the notification service is located off of the main branch.

The OSF also has a demonstration SHARE Search page that is built on top of the core data in the OSF JSON endpoint, and is sortable by tag, source, and contributor.

For more detailed information, see the OSF section on the OSF Development Wiki.