Difference between revisions of "COAR Notify Overview"

From EPrints Documentation
Jump to: navigation, search
(Created page with "Initial work on COAR Notify integration for EPrints is taking place at: https://github.com/eprints/eprints3.4/pull/387 (Signposting) https://github.com/eprintsug/coar_notify...")
 
(Peer Community In (PCI))
 
(10 intermediate revisions by the same user not shown)
Line 1: Line 1:
Initial work on COAR Notify integration for EPrints is taking place at:
+
==Introduction==
 +
COAR Notify is a technology for enabling the "bi-directional linking between peer review services, overlay journals and repositories". It uses "well-established W3C technologies/standards" including "[https://www.w3.org/TR/ldn/ linked data notifications] and [https://www.w3.org/TR/activitystreams-core/ activity streams]". For more information about COAR Notify please see: https://coar-repositories.org/what-we-do/notify/
  
https://github.com/eprints/eprints3.4/pull/387 (Signposting)
+
==Use Cases==
 +
COAR Notify has been implemented in EPrints with two main uses cases in mind.
  
https://github.com/eprintsug/coar_notify (COAR Notify plugin)
+
===Peer Community In (PCI)===
 +
A collection of academic communities that self-organise peer review processes. COAR Notify enables EPrints repositories to communicate with PCI communities, facilitating a process for the peer review of preprint eprint records, allowing the repository to request reviews and handle rejections or endorsements.
  
https://github.com/eprintsug/notifications (Notifications UI)
+
For more information about PCI, please see https://peercommunityin.org/
 +
 
 +
For more information about PCI in EPrints, please see [[COAR Notify: PCI]]
 +
 
 +
===Inter-Repository Linking===
 +
This use case implements COAR Notify to enable repositories to announce relationships to items held within another repository. For example, where an institution may have a publications repository and a separate research data repository, items within the two can be linked using Notify's linked data notifications.
 +
 
 +
For more information, please see [COAR Notify: Repository Linking]
 +
 
 +
==Implementation==
 +
COAR Notify has been integrated into EPrints through changes to the core EPrints code base as well as ingredients (for EPrints 3.4+) and Bazaar plugins (for EPrints 3.3). An overview of the changes are presented below...
 +
 
 +
===Signposting===
 +
A pre-requisite for COAR Notify. Signposting has been implemented in EPrints 3.3 and 3.4.
 +
 
 +
To enable Signposting in your repository you need the following changes https://github.com/eprints/eprints3.4/pull/387
 +
 
 +
This is a minor change which introduces Typed Links to the HTTP response headers. These direct services to links where more information can be found about the resource usng a specified format, supporting COAR Notify's "pass by reference" approach to communication.
 +
 
 +
For more information about Signposting in EPrints, please see [[Signposting]]
 +
 
 +
For more information about Signposting, please see https://signposting.org/
 +
 
 +
===COAR Notify===
 +
The COAR Notify integration is available as either an ingredient or Bazaar plugin at https://github.com/eprintsug/coar_notify
 +
 
 +
'''Prerequisites: [[Signposting]]'''
 +
 
 +
This integration enables several core COAR Notify components:
 +
* Linked Data Notification (LDN) dataset
 +
* LDN inbox and handler
 +
* Framework for sending LDNs
 +
* [[COAR Notify: Repository linking]] - input component, rendering and handling
 +
 
 +
For more information, please see [[COAR Notify]]
 +
 
 +
===PCI===
 +
The PCI integration is available as either an ingredient or Bazaar plugin at: https://github.com/eprintsug/notifications
 +
 
 +
'''Prerequisites: [[Signposting]]; [[COAR Notify]] ingredient/plugin.'''
 +
 
 +
For more information please see: [[COAR Notify: Peer Community In]]
 +
 
 +
==Acknowledgements==
 +
COAR Notify development for EPrints has been supported by the [https://coar-repositories.org/what-we-do/notify/ COAR Notify Initiative] via funding from [https://www.arcadiafund.org.uk/ Arcadia].

Latest revision as of 15:33, 20 July 2025

Introduction

COAR Notify is a technology for enabling the "bi-directional linking between peer review services, overlay journals and repositories". It uses "well-established W3C technologies/standards" including "linked data notifications and activity streams". For more information about COAR Notify please see: https://coar-repositories.org/what-we-do/notify/

Use Cases

COAR Notify has been implemented in EPrints with two main uses cases in mind.

Peer Community In (PCI)

A collection of academic communities that self-organise peer review processes. COAR Notify enables EPrints repositories to communicate with PCI communities, facilitating a process for the peer review of preprint eprint records, allowing the repository to request reviews and handle rejections or endorsements.

For more information about PCI, please see https://peercommunityin.org/

For more information about PCI in EPrints, please see COAR Notify: PCI

Inter-Repository Linking

This use case implements COAR Notify to enable repositories to announce relationships to items held within another repository. For example, where an institution may have a publications repository and a separate research data repository, items within the two can be linked using Notify's linked data notifications.

For more information, please see [COAR Notify: Repository Linking]

Implementation

COAR Notify has been integrated into EPrints through changes to the core EPrints code base as well as ingredients (for EPrints 3.4+) and Bazaar plugins (for EPrints 3.3). An overview of the changes are presented below...

Signposting

A pre-requisite for COAR Notify. Signposting has been implemented in EPrints 3.3 and 3.4.

To enable Signposting in your repository you need the following changes https://github.com/eprints/eprints3.4/pull/387

This is a minor change which introduces Typed Links to the HTTP response headers. These direct services to links where more information can be found about the resource usng a specified format, supporting COAR Notify's "pass by reference" approach to communication.

For more information about Signposting in EPrints, please see Signposting

For more information about Signposting, please see https://signposting.org/

COAR Notify

The COAR Notify integration is available as either an ingredient or Bazaar plugin at https://github.com/eprintsug/coar_notify

Prerequisites: Signposting

This integration enables several core COAR Notify components:

  • Linked Data Notification (LDN) dataset
  • LDN inbox and handler
  • Framework for sending LDNs
  • COAR Notify: Repository linking - input component, rendering and handling

For more information, please see COAR Notify

PCI

The PCI integration is available as either an ingredient or Bazaar plugin at: https://github.com/eprintsug/notifications

Prerequisites: Signposting; COAR Notify ingredient/plugin.

For more information please see: COAR Notify: Peer Community In

Acknowledgements

COAR Notify development for EPrints has been supported by the COAR Notify Initiative via funding from Arcadia.