Difference between revisions of "COAR Notify"
Will.fyson (talk | contribs) (→Repository Linking) |
Will.fyson (talk | contribs) (→Introduction) |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
==Introduction== | ==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]]. | 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 PCI integration which uses COAR Notify, please see [[COAR Notify: PCI]] | For more details on the PCI integration which uses COAR Notify, please see [[COAR Notify: PCI]] | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
==Repository Linking== | ==Repository Linking== | ||
| Line 19: | Line 8: | ||
===Overview=== | ===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. | ||
| + | |||
| + | [[File:Repository Linking- Deposit Workflow.png|600px|thumb|none]] | ||
| + | |||
| + | 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. | 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. | ||
| Line 53: | Line 47: | ||
==Download and Install== | ==Download and Install== | ||
| − | '''Prerequisites: [[Signposting]] | + | '''Prerequisites: [[Signposting]]''' |
===Ingredient (for EPrints v3.4+)=== | ===Ingredient (for EPrints v3.4+)=== | ||
| Line 63: | Line 57: | ||
===Bazaar Plugin (for EPrints v3)=== | ===Bazaar Plugin (for EPrints v3)=== | ||
| − | Available at: https://github.com/eprintsug/coar_notify/tree/epm | + | Available at: https://bazaar.eprints.org/1257/ and 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. | The EPM can be installed either via the Bazaar or by inclusion as a submodule in your repository's lib/epm directory. | ||
Latest revision as of 15:13, 31 July 2025
Contents
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 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.
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.
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://bazaar.eprints.org/1257/ and 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
