Difference between revisions of "COAR Notify"

From EPrints Documentation
Jump to: navigation, search
(Repository Linking)
Line 18: Line 18:
 
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.
 
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.
  
 +
 +
===Workflow Updates===
 +
To include the new input component in the deposit workflow, first add a new stage if required:
 +
 +
<pre>
 +
  <flow>
 +
    <stage ref="type"/>
 +
    <stage ref="files"/>
 +
    <stage ref="core"/>
 +
    <stage ref="links"/>
 +
  </flow>
 +
</pre>
 +
 +
And add the following to define the new stage:
 +
 +
<pre>
 +
  <stage name="links">
 +
    <component type="Field::NotifyLink"><field ref="notify_links"/></component>
 +
  </stage>
 +
</pre>
 +
===Summary Page Updates===
  
 
==Download and Install==
 
==Download and Install==

Revision as of 12:51, 31 July 2025

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

Implementation

Pre-Requisites

LDN Inbox

The repository's LDN Inbox is available at https://myrepo.com/coar_notify/inbox

LDN Dataset

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.


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

Download and Install

Prerequisites: Signposting; COAR Notify ingredient/plugin.

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