Difference between revisions of "Jisc Publications Router"

From EPrints Documentation
Jump to: navigation, search
(PubRouter and Eprints)
(For Developers)
(14 intermediate revisions by the same user not shown)
Line 4: Line 4:
  
 
<blockquote>"Jisc Publications Router is a messaging system that receives notifications about article publications from publishers and other sources (e.g. Europe PMC) and routes these using a matching algorithm to particular institutional repositories. At its simplest, a notification is simply a metadata package providing details of an article that has either been accepted for publication or has been published. The notification may also include the article text either embedded in the metadata or in associated binary files, for example PDF or WORD documents and graphics files." (see https://pubrouter.jisc.ac.uk/about/resources/)</blockquote>
 
<blockquote>"Jisc Publications Router is a messaging system that receives notifications about article publications from publishers and other sources (e.g. Europe PMC) and routes these using a matching algorithm to particular institutional repositories. At its simplest, a notification is simply a metadata package providing details of an article that has either been accepted for publication or has been published. The notification may also include the article text either embedded in the metadata or in associated binary files, for example PDF or WORD documents and graphics files." (see https://pubrouter.jisc.ac.uk/about/resources/)</blockquote>
 +
  
 
=PubRouter and Eprints=
 
=PubRouter and Eprints=
  
Jisc PubRouter is able to deposit directly into Eprints, either a manage deposits queue or directly into a review queue, using its in-built SWORD interface.
+
Jisc PubRouter is able to deposit directly into Eprints, either to a ''manage deposits'' queue or a ''review'' queue, using its in-built SWORD interface.
  
 
Two modes of integration are available:
 
Two modes of integration are available:
  
* Basic connection to a "vanilla" Eprints repository which requires minimial (if any) configuration on the Eprints side.  This results in deposits with a basic set of meta-data and some limitations on populating particular fields, such as an attached document's License terms (although in these cases the information is available in the Additional Information field).
+
* '''Basic connection''' to an Eprints repository which requires no plugin and minimial (if any) configuration on the Eprints side.  This results in deposits with a basic set of meta-data and, if available, article PDFs and related files.  There are some limitations on populating particular meta-data fields, such as an attached document's License terms, however in these cases the relevant information is captured in the Eprint's Additional Information field.
  
* ''Jisc PubRouter RIOXXplus Connector'' plugin for Eprints repositories that have the [http://bazaar.eprints.org/390/ RIOXX2 plugin] installed.  This will populate the additional RIOXX fields with meta-data and will also populate other fields that the basic connection has to work-around. You will need to install this plugin from Eprints Bazaar and configure it - see further details below.
+
* '''''Jisc PubRouter RIOXXplus Connector'' plugin''' for Eprints repositories that have the [http://bazaar.eprints.org/390/ RIOXX2 plugin] installed.  This will populate the additional RIOXX fields with meta-data and will also populate other fields that the basic connection has to work-around. It also attaches document files where available. You will need to install this plugin from Eprints Bazaar and configure it - see further details below.
 +
 
 +
Note that to take advantage of PubRouter--Eprints integration you will need to establish a PubRouter account.  Details on how to do this may be found on the PubRouter website: https://pubrouter.jisc.ac.uk/.
  
To take advantage of PubRouter -- Eprints integration you will need to establish a PubRouter account.  Details on how to do this may be found on the PubRouter website: https://pubrouter.jisc.ac.uk/.
 
  
 
=Jisc PubRouter RIOXXplus Connector Plugin=
 
=Jisc PubRouter RIOXXplus Connector Plugin=
  
The ''Jisc PubRouter RIOXXplus Connector'' plugin, available from the Bazaar, receives input from Jisc PubRouter in the form of XML to describe an Article for automatic deposit in the repository. The plugin is designed to work with Eprints repositories that also have the RIOXX2 plugin installed.  The plugin will create an Eprints record containing the received meta-data values and also the article PDF or other files where these are available.
+
The ''Jisc PubRouter RIOXXplus Connector'' plugin, available from the [https://bazaar.eprints.org/543/ Bazaar], receives input from Jisc PubRouter in the form of XML to describe an Article for automatic deposit in the repository. The plugin is designed to work with Eprints repositories that also have the [http://bazaar.eprints.org/390/ RIOXX2 plugin] installed.  The plugin will create an Eprints record containing the received meta-data values and also the article PDF or other files where these are available.
  
 
The PubRouter data may also contain links to documents that are either hosted on the PubRouter or elsewhere. Where possible, documents are downloaded from the specified links and added to the newly created EPrint record. Documents hosted on the PubRouter are only accessible with the use of an API key that the repository must provide when requesting the document.
 
The PubRouter data may also contain links to documents that are either hosted on the PubRouter or elsewhere. Where possible, documents are downloaded from the specified links and added to the newly created EPrint record. Documents hosted on the PubRouter are only accessible with the use of an API key that the repository must provide when requesting the document.
Line 25: Line 27:
 
In order to receive data from PubRouter you will need an account (see previous section).  You will also need to update the plugin's configuration file - details below.
 
In order to receive data from PubRouter you will need an account (see previous section).  You will also need to update the plugin's configuration file - details below.
  
==For Developers==
 
  
The ''Jisc PubRouter RIOXXplus Connector'' plugin installs a configuration file at the local archive level, named: <code>zzz_pubrouter_rioxx_importer.pl</code>.
+
===For Developers===
  
This needs to be updated with your PubRouter API Key which will be available once you have a PubRouter account. This is required so that the plugin can retrieve article PDFs and related files for attachment to the Eprint record.
+
The plugin installation package is available from [https://bazaar.eprints.org/543/ Eprints Bazaar] and the source code is also available on [https://github.com/jisc-services/eprints-plugin-PubRouter-RIOXXplus-Connector GitHub].
  
This API key is stored here:
+
====Install plugin====
 +
 
 +
1. Find the ''Jisc PubRouter RIOXXplus Connector'' plugin in the bazaar, and install it:
 +
 
 +
[[File:Bazaar-entry.jpg|600px]]
 +
 
 +
 
 +
2. After installation it should appear thus, note that it is designed to work with the RIOXX2 plugin:
 +
 
 +
[[File:Installed-pkg.jpg|600px]]
 +
 
 +
 
 +
====Configure Plugin====
 +
 
 +
The ''Jisc PubRouter RIOXXplus Connector'' plugin installs a configuration file at the local archive level, named: ''zzz_pubrouter_rioxx_importer.pl''.
 +
 
 +
This needs to be updated with your PubRouter API Key which is required so that the plugin can retrieve article PDFs and related files for attachment to the Eprint record.  The API Key will be available once you have a PubRouter account; it is displayed at the top of your Account page - see highlighted field in screen-shot below (it contains dummy values):
 +
 
 +
[[File:Putrouter-screen.jpg|600px]]
 +
 
 +
 
 +
The PubRouter API key is stored in the plugin configuration file at the line shown below and in the following screen-grabs:
  
 
   #PubRouter API key for importing document via URL supplied by PubRouter
 
   #PubRouter API key for importing document via URL supplied by PubRouter
 
   $c->{plugins}{"Import::PubRouter"}{params}{api_key} = "ENTER PUBROUTER API KEY HERE";
 
   $c->{plugins}{"Import::PubRouter"}{params}{api_key} = "ENTER PUBROUTER API KEY HERE";
  
The configuration file also sets a flag that enables the repository to download and import documents from the Web, which the import plugin needs if documents are to be added to the imported records.
 
  
  #allow documents to be imported via URL
+
Before adding API Key:
  $c->{enable_web_imports} = 1;
+
  
 +
[[File:Config.jpg|600px]]
  
Also, it ensures that the Atom Export plugin, required for generating SWORD deposit responses, has not been disabled.
+
 
 +
After adding API Key (showing dummy key value):
 +
 
 +
[[File:Config-after.jpg|600px]]
 +
 
 +
 
 +
====For Information: Other Configuration File Content====
 +
 
 +
The configuration file also ensures that the Atom Export plugin, required for generating SWORD deposit responses, has not been disabled.
  
 
   $c->{plugins}->{"Export::Atom"}->{params}->{disable} = 0;
 
   $c->{plugins}->{"Export::Atom"}->{params}->{disable} = 0;
  
A new mapping of license values to URLs is also provided for the purpose of autocompleting RIOXX fields where the [http://bazaar.eprints.org/390/ RIOXX2 plugin] is installed.
+
 
 +
Also, it sets a flag that enables the repository to download and import documents from the Web, which the import plugin needs if documents are to be added to the imported records.
 +
 
 +
  #allow documents to be imported via URL
 +
  $c->{enable_web_imports} = 1;
 +
 
 +
Finally, a new mapping of license values to URLs is also provided for the purpose of auto-completing RIOXX fields where the [http://bazaar.eprints.org/390/ RIOXX2 plugin] is installed.

Revision as of 11:05, 1 February 2018

Introduction

Jisc Publications Router aims to streamline the process of depositing journal articles in an institutional repository. As described by Jisc:

"Jisc Publications Router is a messaging system that receives notifications about article publications from publishers and other sources (e.g. Europe PMC) and routes these using a matching algorithm to particular institutional repositories. At its simplest, a notification is simply a metadata package providing details of an article that has either been accepted for publication or has been published. The notification may also include the article text either embedded in the metadata or in associated binary files, for example PDF or WORD documents and graphics files." (see https://pubrouter.jisc.ac.uk/about/resources/)


PubRouter and Eprints

Jisc PubRouter is able to deposit directly into Eprints, either to a manage deposits queue or a review queue, using its in-built SWORD interface.

Two modes of integration are available:

  • Basic connection to an Eprints repository which requires no plugin and minimial (if any) configuration on the Eprints side. This results in deposits with a basic set of meta-data and, if available, article PDFs and related files. There are some limitations on populating particular meta-data fields, such as an attached document's License terms, however in these cases the relevant information is captured in the Eprint's Additional Information field.
  • Jisc PubRouter RIOXXplus Connector plugin for Eprints repositories that have the RIOXX2 plugin installed. This will populate the additional RIOXX fields with meta-data and will also populate other fields that the basic connection has to work-around. It also attaches document files where available. You will need to install this plugin from Eprints Bazaar and configure it - see further details below.

Note that to take advantage of PubRouter--Eprints integration you will need to establish a PubRouter account. Details on how to do this may be found on the PubRouter website: https://pubrouter.jisc.ac.uk/.


Jisc PubRouter RIOXXplus Connector Plugin

The Jisc PubRouter RIOXXplus Connector plugin, available from the Bazaar, receives input from Jisc PubRouter in the form of XML to describe an Article for automatic deposit in the repository. The plugin is designed to work with Eprints repositories that also have the RIOXX2 plugin installed. The plugin will create an Eprints record containing the received meta-data values and also the article PDF or other files where these are available.

The PubRouter data may also contain links to documents that are either hosted on the PubRouter or elsewhere. Where possible, documents are downloaded from the specified links and added to the newly created EPrint record. Documents hosted on the PubRouter are only accessible with the use of an API key that the repository must provide when requesting the document.

In order to receive data from PubRouter you will need an account (see previous section). You will also need to update the plugin's configuration file - details below.


For Developers

The plugin installation package is available from Eprints Bazaar and the source code is also available on GitHub.

Install plugin

1. Find the Jisc PubRouter RIOXXplus Connector plugin in the bazaar, and install it:

Bazaar-entry.jpg


2. After installation it should appear thus, note that it is designed to work with the RIOXX2 plugin:

Installed-pkg.jpg


Configure Plugin

The Jisc PubRouter RIOXXplus Connector plugin installs a configuration file at the local archive level, named: zzz_pubrouter_rioxx_importer.pl.

This needs to be updated with your PubRouter API Key which is required so that the plugin can retrieve article PDFs and related files for attachment to the Eprint record. The API Key will be available once you have a PubRouter account; it is displayed at the top of your Account page - see highlighted field in screen-shot below (it contains dummy values):

Putrouter-screen.jpg


The PubRouter API key is stored in the plugin configuration file at the line shown below and in the following screen-grabs:

 #PubRouter API key for importing document via URL supplied by PubRouter
 $c->{plugins}{"Import::PubRouter"}{params}{api_key} = "ENTER PUBROUTER API KEY HERE";


Before adding API Key:

Config.jpg


After adding API Key (showing dummy key value):

Config-after.jpg


For Information: Other Configuration File Content

The configuration file also ensures that the Atom Export plugin, required for generating SWORD deposit responses, has not been disabled.

 $c->{plugins}->{"Export::Atom"}->{params}->{disable} = 0;


Also, it sets a flag that enables the repository to download and import documents from the Web, which the import plugin needs if documents are to be added to the imported records.

 #allow documents to be imported via URL
 $c->{enable_web_imports} = 1;

Finally, a new mapping of license values to URLs is also provided for the purpose of auto-completing RIOXX fields where the RIOXX2 plugin is installed.