COAR Notify

From EPrints Documentation
Revision as of 13:21, 31 July 2025 by Will.fyson (talk | contribs)
Jump to: navigation, search

Introduction

This page includes details on the COAR Notify implementation for EPrints. For an overview of COAR Notify in EPrints please see COAR Notify Overview.

For more details on the Repository Linking implementation which is included as part of this ingredient/plugin, please see COAR Notify: Repository Linking.

For more details on the PCI integration which uses COAR Notify, please see COAR Notify: PCI

Repository Linking

The repository linking functionality is included as part of the main COAR Notify implementation. This allows two records held in different repositories (e.g. a publications repository and a separate research data repository) to establish links between each other.

Overview

Links between repositories can be specified via a new field in the deposit workflow. Users can specify the URL of a summary page they want to link to and send the request.

Repository Linking- Deposit Workflow.png

The input component displays all requests that have been sent, with a red bar indicating a failed request and a green bar representing a successful request. Once a link between two items has been made, the input component should prevent the same link request from being made again.

Once links have been established these appear on the summary pages. If the link is established between two EPrints repositories which both have the COAR Notify implementation installed and configured, the links will appear on the summary pages for the remote repository too.

Repository Linking- Summary Page.png

Implementation

Workflow Updates

To include the new input component in the deposit workflow, first add a new stage if required:

  <flow>
    <stage ref="type"/>
    <stage ref="files"/>
    <stage ref="core"/>
    <stage ref="links"/>
  </flow>

And add the following to define the new stage:

  <stage name="links">
    <component type="Field::NotifyLink"><field ref="notify_links"/></component>
  </stage>

Summary Page Updates

To display incoming and outgoing repository links in summary pages, add the following to the citation file.

  <epc:print expr="$item.property('notify_links')" />

Download and Install

Prerequisites: Signposting

Ingredient (for EPrints v3.4+)

Available at: https://github.com/eprintsug/coar_notify

Including the ingredient in the repository flavour's inc file should be sufficient for installation, no further customisations required.

Bazaar Plugin (for EPrints v3)

Available at: https://github.com/eprintsug/coar_notify/tree/epm

The EPM can be installed either via the Bazaar or by inclusion as a submodule in your repository's lib/epm directory.

Version History

Version 1.0 (29th July 2025)

  • Initial release including
    • LDN and LDN Inbox datasets and functionality
    • Repository linking input component, rendering and handling