EPrints Documentation - User contributions [en-gb]

Jisc Publications Router

2020-09-23T11:36:55Z

Arehin:

[[Category: Howto]]
[[Category: Plugins]]
[[Category: Bazaar Package]]

=Introduction=

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

<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=

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 '''[http://bazaar.eprints.org/390/ RIOXX2 plugin]''' installed and enabled. 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=

===Overview===

The '''''Jisc PubRouter RIOXXplus Connector''''' plugin, available from the [http://bazaar.eprints.org/1127/ Bazaar], receives input from Jisc PubRouter in the form of XML that describes 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 and enabled.

The plugin will create an Eprints record containing the received article metadata. Where the XML also contains links to the article PDF or other files then these will be automatically downloaded and attached to the record.

You will need a PubRouter account (see previous section) in order to receive data from PubRouter. You will also need to update the plugin's configuration file - details below - so that the plugin can retrieve article files that are (temporarily) stored on PubRouter.

===For Developers===

The plugin installation package is available from [http://bazaar.eprints.org/1127/ Eprints Bazaar] and the source code is also available on [https://github.com/jisc-services/eprints-plugin-PubRouter-RIOXXplus-Connector GitHub].

====Latest version====

Version 1.2.1 (9th August 2019) - This version provides better handling of supplied licence information.

====Upgrading the plugin====

This is best done in consultation with the Jisc PubRouter support team because an amendment will be required to your PubRouter account ''Repository configuration'' setting (although you could do this yourself).

Upgrading the ''Jisc PubRouter RIOXXplus Connector'' plugin from an earlier version is easily accomplished via your Eprints Admin panel: ''System Tools'' --> ''Eprints Bazaar'' which will offer you a "one click" upgrade option. There is no need to modify the original RIOXXplus configuration file, which will continue to be used by the new plugin version.

:IMPORTANT: After performing the upgrade you will need to reload the Eprints configuration, again via Admin panel: ''Config. Tools'' --> ''Reload Configuration'' or alternatively, on the server, by restarting the Apache2 service.

Once the plugin has been upgraded it will be necessary to amend your PubRouter Account's SWORD connection settings, by changing the ''Repository configuration'' setting from ''Eprints RIOXXplus'' to ''Eprints RIOXXplus 2 (new)''. The Jisc support team will be happy to do this on your behalf.

====Installing the plugin====

From the Eprints Admin panel, ''System Tools'' --> ''Eprints Bazaar'':

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

2. After installation it should appear thus (BUT as '''version 1.2.1'''), note that it is designed to work with the RIOXX2 plugin:

[[File:Installed-pkg.jpg|600px]]

3. The plugin must be configured - see following section.

====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]]

=====Editing the configuration file: zzz_pubrouter_rioxx_importer.pl=====

The configuration file is edited via the Eprints Admin panel: ''Config. Tools'' --> ''View Configuration'' --> Folder ''cfg.d'' --> File ''zzz_pubrouter_rioxx_importer.pl'' (near bottom of list).

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:

[[File:Config.jpg|600px]]

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;

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.

Jisc Publications Router

2020-01-31T14:39:16Z

Arehin: /* Installing the plugin */

[[Category: Howto]]
[[Category: Plugins]]
[[Category: Bazaar Package]]

=Introduction=

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

<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=

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 '''[http://bazaar.eprints.org/390/ RIOXX2 plugin]''' installed and enabled. 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=

===Overview===

The '''''Jisc PubRouter RIOXXplus Connector''''' plugin, available from the [http://bazaar.eprints.org/1127/ Bazaar], receives input from Jisc PubRouter in the form of XML that describes 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 and enabled.

The plugin will create an Eprints record containing the received article metadata. Where the XML also contains links to the article PDF or other files then these will be automatically downloaded and attached to the record.

You will need a PubRouter account (see previous section) in order to receive data from PubRouter. You will also need to update the plugin's configuration file - details below - so that the plugin can retrieve article files that are (temporarily) stored on PubRouter.

===For Developers===

The plugin installation package is available from [http://bazaar.eprints.org/1127/ Eprints Bazaar] and the source code is also available on [https://github.com/jisc-services/eprints-plugin-PubRouter-RIOXXplus-Connector GitHub].

====Latest version====

Version 1.2.1 (9th August 2019) - This version provides better handling of supplied licence information.

====Upgrading the plugin====

This is best done in consultation with the Jisc PubRouter support team because an amendment will be required to your PubRouter account ''Repository configuration'' setting (although you could do this yourself).

Upgrading the ''Jisc PubRouter RIOXXplus Connector'' plugin from an earlier version is easily accomplished via your Eprints Admin panel: ''System Tools'' --> ''Eprints Bazaar'' which will offer you a "one click" upgrade option. There is no need to modify the original RIOXXplus configuration file, which will continue to be used by the new plugin version.

:IMPORTANT: After performing the upgrade you will need to reload the Eprints configuration, again via Admin panel: ''Config. Tools'' --> ''Reload Configuration'' or alternatively, on the server, by restarting the Apache2 service.

Once the plugin has been upgraded it will be necessary to amend your PubRouter Account's SWORD connection settings, by changing the ''Repository configuration'' setting from ''Eprints RIOXXplus'' to ''Eprints RIOXXplus 2 (new)''. The Jisc support team will be happy to do this on your behalf.

====Installing the plugin====

:IMPORTANT: In the following screenshots the ''Jisc PubRouter RIOXXplus Connector'' is shown as ''version 1.0.0'', despite this you should install the latest version (v1.2.1).

From the Eprints Admin panel, ''System Tools'' --> ''Eprints Bazaar'':

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]]

3. The plugin must be configured - see following section.

====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]]

=====Editing the configuration file: zzz_pubrouter_rioxx_importer.pl=====

The configuration file is edited via the Eprints Admin panel: ''Config. Tools'' --> ''View Configuration'' --> Folder ''cfg.d'' --> File ''zzz_pubrouter_rioxx_importer.pl'' (near bottom of list).

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:

[[File:Config.jpg|600px]]

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;

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.

Jisc Publications Router

2020-01-31T14:38:27Z

Arehin: /* Upgrading the plugin */

[[Category: Howto]]
[[Category: Plugins]]
[[Category: Bazaar Package]]

=Introduction=

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

<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=

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 '''[http://bazaar.eprints.org/390/ RIOXX2 plugin]''' installed and enabled. 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=

===Overview===

The '''''Jisc PubRouter RIOXXplus Connector''''' plugin, available from the [http://bazaar.eprints.org/1127/ Bazaar], receives input from Jisc PubRouter in the form of XML that describes 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 and enabled.

The plugin will create an Eprints record containing the received article metadata. Where the XML also contains links to the article PDF or other files then these will be automatically downloaded and attached to the record.

You will need a PubRouter account (see previous section) in order to receive data from PubRouter. You will also need to update the plugin's configuration file - details below - so that the plugin can retrieve article files that are (temporarily) stored on PubRouter.

===For Developers===

The plugin installation package is available from [http://bazaar.eprints.org/1127/ Eprints Bazaar] and the source code is also available on [https://github.com/jisc-services/eprints-plugin-PubRouter-RIOXXplus-Connector GitHub].

====Latest version====

Version 1.2.1 (9th August 2019) - This version provides better handling of supplied licence information.

====Upgrading the plugin====

This is best done in consultation with the Jisc PubRouter support team because an amendment will be required to your PubRouter account ''Repository configuration'' setting (although you could do this yourself).

Upgrading the ''Jisc PubRouter RIOXXplus Connector'' plugin from an earlier version is easily accomplished via your Eprints Admin panel: ''System Tools'' --> ''Eprints Bazaar'' which will offer you a "one click" upgrade option. There is no need to modify the original RIOXXplus configuration file, which will continue to be used by the new plugin version.

:IMPORTANT: After performing the upgrade you will need to reload the Eprints configuration, again via Admin panel: ''Config. Tools'' --> ''Reload Configuration'' or alternatively, on the server, by restarting the Apache2 service.

Once the plugin has been upgraded it will be necessary to amend your PubRouter Account's SWORD connection settings, by changing the ''Repository configuration'' setting from ''Eprints RIOXXplus'' to ''Eprints RIOXXplus 2 (new)''. The Jisc support team will be happy to do this on your behalf.

====Installing the plugin====

:NOTE: In the following screenshots the ''Jisc PubRouter RIOXXplus Connector'' is shown as ''version 1.0.0'', despite this you should install the latest version (v1.2.1).

From the Eprints Admin panel, ''System Tools'' --> ''Eprints Bazaar'':

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]]

3. The plugin must be configured - see following section.

====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]]

=====Editing the configuration file: zzz_pubrouter_rioxx_importer.pl=====

The configuration file is edited via the Eprints Admin panel: ''Config. Tools'' --> ''View Configuration'' --> Folder ''cfg.d'' --> File ''zzz_pubrouter_rioxx_importer.pl'' (near bottom of list).

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:

[[File:Config.jpg|600px]]

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;

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.

Jisc Publications Router

2019-09-03T16:13:04Z

Arehin: /* Jisc PubRouter RIOXXplus Connector Plugin */

[[Category: Howto]]
[[Category: Plugins]]
[[Category: Bazaar Package]]

=Introduction=

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

<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=

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 '''[http://bazaar.eprints.org/390/ RIOXX2 plugin]''' installed and enabled. 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=

===Overview===

The '''''Jisc PubRouter RIOXXplus Connector''''' plugin, available from the [http://bazaar.eprints.org/1127/ Bazaar], receives input from Jisc PubRouter in the form of XML that describes 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 and enabled.

The plugin will create an Eprints record containing the received article metadata. Where the XML also contains links to the article PDF or other files then these will be automatically downloaded and attached to the record.

You will need a PubRouter account (see previous section) in order to receive data from PubRouter. You will also need to update the plugin's configuration file - details below - so that the plugin can retrieve article files that are (temporarily) stored on PubRouter.

===For Developers===

The plugin installation package is available from [http://bazaar.eprints.org/1127/ Eprints Bazaar] and the source code is also available on [https://github.com/jisc-services/eprints-plugin-PubRouter-RIOXXplus-Connector GitHub].

====Latest version====

Version 1.2.1 (9th August 2019) - This version provides better handling of supplied licence information.

====Upgrading the plugin====

This is best done in consultation with the Jisc PubRouter support team because an amendment will be required to your PubRouter account ''Repository configuration'' setting (although you could do this yourself).

Upgrading the ''Jisc PubRouter RIOXXplus Connector'' plugin from an earlier version is easily accomplished via your Eprints Admin panel: ''System Tools'' --> ''Eprints Bazaar'' which will offer you a "one click" upgrade option. There is no need to modify the original RIOXXplus configuration file, which will continue to be used by the new plugin version.

:IMPORTANT: After performing the upgrade you will need to reload the Eprints configuration, again via Admin panel: ''Config. Tools'' --> ''Reload Configuration'' or alternatively, on the server, by restarting the Apache2 service.

Once the plugin has been upgraded it will be necessary to amend your PubRouter Account's SWORD connection settings, by changing the ''Repository configuration'' setting from ''Eprints RIOXXplus'' to ''Eprints RIOXXplus v2 (new)''. The Jisc support team will be happy to do this on your behalf.

====Installing the plugin====

:NOTE: In the following screenshots the ''Jisc PubRouter RIOXXplus Connector'' is shown as ''version 1.0.0'', despite this you should install the latest version (v1.2.1).

From the Eprints Admin panel, ''System Tools'' --> ''Eprints Bazaar'':

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]]

3. The plugin must be configured - see following section.

====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]]

=====Editing the configuration file: zzz_pubrouter_rioxx_importer.pl=====

The configuration file is edited via the Eprints Admin panel: ''Config. Tools'' --> ''View Configuration'' --> Folder ''cfg.d'' --> File ''zzz_pubrouter_rioxx_importer.pl'' (near bottom of list).

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:

[[File:Config.jpg|600px]]

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;

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.

Jisc Publications Router

2019-08-15T14:07:39Z

Arehin: /* Installing the plugin */

[[Category: Howto]]
[[Category: Plugins]]
[[Category: Bazaar Package]]

=Introduction=

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

<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=

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 '''[http://bazaar.eprints.org/390/ RIOXX2 plugin]''' installed and enabled. 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=

===Overview===

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 that describes 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 and enabled.

The plugin will create an Eprints record containing the received article metadata. Where the XML also contains links to the article PDF or other files then these will be automatically downloaded and attached to the record.

You will need a PubRouter account (see previous section) in order to receive data from PubRouter. You will also need to update the plugin's configuration file - details below - so that the plugin can retrieve article files that are (temporarily) stored on PubRouter.

===For Developers===

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].

====Latest version====

Version 1.2.1 (9th August 2019) - This version provides better handling of supplied licence information.

====Upgrading the plugin====

This is best done in consultation with the Jisc PubRouter support team because an amendment will be required to your PubRouter account ''Repository configuration'' setting (although you could do this yourself).

Upgrading the ''Jisc PubRouter RIOXXplus Connector'' plugin from an earlier version is easily accomplished via your Eprints Admin panel: ''System Tools'' --> ''Eprints Bazaar'' which will offer you a "one click" upgrade option. There is no need to modify the original RIOXXplus configuration file, which will continue to be used by the new plugin version.

:IMPORTANT: After performing the upgrade you will need to reload the Eprints configuration, again via Admin panel: ''Config. Tools'' --> ''Reload Configuration'' or alternatively, on the server, by restarting the Apache2 service.

Once the plugin has been upgraded it will be necessary to amend your PubRouter Account's SWORD connection settings, by changing the ''Repository configuration'' setting from ''Eprints RIOXXplus'' to ''Eprints RIOXXplus v2 (new)''. The Jisc support team will be happy to do this on your behalf.

====Installing the plugin====

:NOTE: In the following screenshots the ''Jisc PubRouter RIOXXplus Connector'' is shown as ''version 1.0.0'', despite this you should install the latest version (v1.2.1).

From the Eprints Admin panel, ''System Tools'' --> ''Eprints Bazaar'':

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]]

3. The plugin must be configured - see following section.

====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]]

=====Editing the configuration file: zzz_pubrouter_rioxx_importer.pl=====

The configuration file is edited via the Eprints Admin panel: ''Config. Tools'' --> ''View Configuration'' --> Folder ''cfg.d'' --> File ''zzz_pubrouter_rioxx_importer.pl'' (near bottom of list).

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:

[[File:Config.jpg|600px]]

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;

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.

Jisc Publications Router

2019-08-15T14:06:21Z

Arehin: /* Upgrading the plugin */

[[Category: Howto]]
[[Category: Plugins]]
[[Category: Bazaar Package]]

=Introduction=

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

<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=

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 '''[http://bazaar.eprints.org/390/ RIOXX2 plugin]''' installed and enabled. 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=

===Overview===

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 that describes 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 and enabled.

The plugin will create an Eprints record containing the received article metadata. Where the XML also contains links to the article PDF or other files then these will be automatically downloaded and attached to the record.

You will need a PubRouter account (see previous section) in order to receive data from PubRouter. You will also need to update the plugin's configuration file - details below - so that the plugin can retrieve article files that are (temporarily) stored on PubRouter.

===For Developers===

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].

====Latest version====

Version 1.2.1 (9th August 2019) - This version provides better handling of supplied licence information.

====Upgrading the plugin====

This is best done in consultation with the Jisc PubRouter support team because an amendment will be required to your PubRouter account ''Repository configuration'' setting (although you could do this yourself).

Upgrading the ''Jisc PubRouter RIOXXplus Connector'' plugin from an earlier version is easily accomplished via your Eprints Admin panel: ''System Tools'' --> ''Eprints Bazaar'' which will offer you a "one click" upgrade option. There is no need to modify the original RIOXXplus configuration file, which will continue to be used by the new plugin version.

:IMPORTANT: After performing the upgrade you will need to reload the Eprints configuration, again via Admin panel: ''Config. Tools'' --> ''Reload Configuration'' or alternatively, on the server, by restarting the Apache2 service.

Once the plugin has been upgraded it will be necessary to amend your PubRouter Account's SWORD connection settings, by changing the ''Repository configuration'' setting from ''Eprints RIOXXplus'' to ''Eprints RIOXXplus v2 (new)''. The Jisc support team will be happy to do this on your behalf.

====Installing the plugin====

:NOTE: In the following diagrams the ''Jisc PubRouter RIOXXplus Connector'' is shown as ''version 1.0.0'', despite this you should install the latest version (v1.2.1).

From the Eprints Admin panel, ''System Tools'' --> ''Eprints Bazaar'':

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]]

3. The plugin must be configured - see following section.

====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]]

=====Editing the configuration file: zzz_pubrouter_rioxx_importer.pl=====

The configuration file is edited via the Eprints Admin panel: ''Config. Tools'' --> ''View Configuration'' --> Folder ''cfg.d'' --> File ''zzz_pubrouter_rioxx_importer.pl'' (near bottom of list).

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:

[[File:Config.jpg|600px]]

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;

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.

Jisc Publications Router

2019-08-15T13:05:43Z

Arehin: /* Upgrading the plugin */

[[Category: Howto]]
[[Category: Plugins]]
[[Category: Bazaar Package]]

=Introduction=

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

<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=

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 '''[http://bazaar.eprints.org/390/ RIOXX2 plugin]''' installed and enabled. 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=

===Overview===

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 that describes 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 and enabled.

The plugin will create an Eprints record containing the received article metadata. Where the XML also contains links to the article PDF or other files then these will be automatically downloaded and attached to the record.

You will need a PubRouter account (see previous section) in order to receive data from PubRouter. You will also need to update the plugin's configuration file - details below - so that the plugin can retrieve article files that are (temporarily) stored on PubRouter.

===For Developers===

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].

====Latest version====

Version 1.2.1 (9th August 2019) - This version provides better handling of supplied licence information.

====Upgrading the plugin====

This is best done in consultation with the Jisc PubRouter support team because an amendment will be required to your PubRouter account ''Repository configuration'' setting (although you could do this yourself).

Upgrading the plugin from an earlier version is easily accomplished via your Eprints Admin panel: ''System Tools'' --> ''Eprints Bazaar'' which will offer you a "one click" upgrade option. There is no need to modify the original RIOXXplus configuration file, which will continue to be used by the new plugin version.

:IMPORTANT: After performing the upgrade you will need to reload the Eprints configuration, again via Admin panel: ''Config. Tools'' --> ''Reload Configuration'' or alternatively, on the server, by restarting the Apache2 service.

Once the plugin has been upgraded it will be necessary to amend your PubRouter Account's SWORD connection settings, by changing the ''Repository configuration'' setting from ''Eprints RIOXXplus'' to ''Eprints RIOXXplus v2 (new)''. The Jisc support team will be happy to do this on your behalf.

====Installing the plugin====

:NOTE: In the following diagrams the ''Jisc PubRouter RIOXXplus Connector'' is shown as ''version 1.0.0'', despite this you should install the latest version (v1.2.1).

From the Eprints Admin panel, ''System Tools'' --> ''Eprints Bazaar'':

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]]

3. The plugin must be configured - see following section.

====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]]

=====Editing the configuration file: zzz_pubrouter_rioxx_importer.pl=====

The configuration file is edited via the Eprints Admin panel: ''Config. Tools'' --> ''View Configuration'' --> Folder ''cfg.d'' --> File ''zzz_pubrouter_rioxx_importer.pl'' (near bottom of list).

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:

[[File:Config.jpg|600px]]

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;

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.

Jisc Publications Router

2019-08-15T13:05:14Z

Arehin: /* Upgrading the plugin */

[[Category: Howto]]
[[Category: Plugins]]
[[Category: Bazaar Package]]

=Introduction=

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

<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=

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 '''[http://bazaar.eprints.org/390/ RIOXX2 plugin]''' installed and enabled. 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=

===Overview===

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 that describes 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 and enabled.

The plugin will create an Eprints record containing the received article metadata. Where the XML also contains links to the article PDF or other files then these will be automatically downloaded and attached to the record.

You will need a PubRouter account (see previous section) in order to receive data from PubRouter. You will also need to update the plugin's configuration file - details below - so that the plugin can retrieve article files that are (temporarily) stored on PubRouter.

===For Developers===

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].

====Latest version====

Version 1.2.1 (9th August 2019) - This version provides better handling of supplied licence information.

====Upgrading the plugin====

This is best done in consultation with the Jisc PubRouter support team because an amendment will be required to your PubRouter account ''Repository configuration'' setting (although you could do this yourself).

Upgrading the plugin from an earlier version is easily accomplished via your Eprints Admin panel: ''System Tools'' --> ''Eprints Bazaar'' which will offer you a "one click" upgrade option. There is no need to modify the original RIOXXplus configuration file, which will continue to be used by the new plugin version.

:IMPORTANT: After performing the upgrade you will need to reload the Eprints configuration, again via Admin panel: ''Config. Tools'' --> ''Reload Configuration'' or alternatively, on the server, by restarting the Apache2 service.

Once the plugin has been upgraded it will be necessary to amend your PubRouter Account's SWORD connection settings, by changing the ''Repository configuration'' setting from ''Eprints RIOXXplus'' to '''Eprints RIOXXplus v2 (new)'''. The Jisc support team will be able to do this on your behalf.

====Installing the plugin====

:NOTE: In the following diagrams the ''Jisc PubRouter RIOXXplus Connector'' is shown as ''version 1.0.0'', despite this you should install the latest version (v1.2.1).

From the Eprints Admin panel, ''System Tools'' --> ''Eprints Bazaar'':

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]]

3. The plugin must be configured - see following section.

====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]]

=====Editing the configuration file: zzz_pubrouter_rioxx_importer.pl=====

The configuration file is edited via the Eprints Admin panel: ''Config. Tools'' --> ''View Configuration'' --> Folder ''cfg.d'' --> File ''zzz_pubrouter_rioxx_importer.pl'' (near bottom of list).

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:

[[File:Config.jpg|600px]]

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;

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.

Jisc Publications Router

2019-08-15T13:04:16Z

Arehin: /* Upgrading the plugin */

[[Category: Howto]]
[[Category: Plugins]]
[[Category: Bazaar Package]]

=Introduction=

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

<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=

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 '''[http://bazaar.eprints.org/390/ RIOXX2 plugin]''' installed and enabled. 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=

===Overview===

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 that describes 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 and enabled.

The plugin will create an Eprints record containing the received article metadata. Where the XML also contains links to the article PDF or other files then these will be automatically downloaded and attached to the record.

You will need a PubRouter account (see previous section) in order to receive data from PubRouter. You will also need to update the plugin's configuration file - details below - so that the plugin can retrieve article files that are (temporarily) stored on PubRouter.

===For Developers===

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].

====Latest version====

Version 1.2.1 (9th August 2019) - This version provides better handling of supplied licence information.

====Upgrading the plugin====

Upgrading the plugin is best done in consultation with the Jisc PubRouter support team because an amendment will be required to your PubRouter account's ''Repository configuration'' setting (although you could do this yourself).

Upgrading the plugin from an earlier version is easily accomplished via your Eprints Admin panel: ''System Tools'' --> ''Eprints Bazaar'' which will offer you a "one click" upgrade option. There is no need to modify the original RIOXXplus configuration file, which will continue to be used by the new plugin version.

:IMPORTANT: After performing the upgrade you will need to reload the Eprints configuration, again via Admin panel: ''Config. Tools'' --> ''Reload Configuration'' or alternatively, on the server, by restarting the Apache2 service.

Once the plugin has been upgraded it will be necessary to amend your PubRouter Account's SWORD connection settings, by changing the ''Repository configuration'' setting from ''Eprints RIOXXplus'' to '''Eprints RIOXXplus v3 (new)'''. The Jisc support team will be able to do this on your behalf.

====Installing the plugin====

:NOTE: In the following diagrams the ''Jisc PubRouter RIOXXplus Connector'' is shown as ''version 1.0.0'', despite this you should install the latest version (v1.2.1).

From the Eprints Admin panel, ''System Tools'' --> ''Eprints Bazaar'':

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]]

3. The plugin must be configured - see following section.

====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]]

=====Editing the configuration file: zzz_pubrouter_rioxx_importer.pl=====

The configuration file is edited via the Eprints Admin panel: ''Config. Tools'' --> ''View Configuration'' --> Folder ''cfg.d'' --> File ''zzz_pubrouter_rioxx_importer.pl'' (near bottom of list).

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:

[[File:Config.jpg|600px]]

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;

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.

Jisc Publications Router

2019-08-15T12:54:21Z

Arehin: /* Upgrading the plugin */

[[Category: Howto]]
[[Category: Plugins]]
[[Category: Bazaar Package]]

=Introduction=

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

<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=

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 '''[http://bazaar.eprints.org/390/ RIOXX2 plugin]''' installed and enabled. 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=

===Overview===

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 that describes 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 and enabled.

The plugin will create an Eprints record containing the received article metadata. Where the XML also contains links to the article PDF or other files then these will be automatically downloaded and attached to the record.

You will need a PubRouter account (see previous section) in order to receive data from PubRouter. You will also need to update the plugin's configuration file - details below - so that the plugin can retrieve article files that are (temporarily) stored on PubRouter.

===For Developers===

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].

====Latest version====

Version 1.2.1 (9th August 2019) - This version provides better handling of supplied licence information.

====Upgrading the plugin====

Upgrading the plugin from an earlier version is easily accomplished via your Eprints Admin panel: ''System Tools'' --> ''Eprints Bazaar'' which will offer you a "one click" upgrade option. There is no need to modify the original RIOXXplus configuration file, which will continue to be used by the new plugin version.

:IMPORTANT: After performing the upgrade you will need to reload the Eprints configuration, again via Admin panel: ''Config. Tools'' --> ''Reload Configuration'' or alternatively, on the server, by restarting the Apache2 service.

====Installing the plugin====

:NOTE: In the following diagrams the ''Jisc PubRouter RIOXXplus Connector'' is shown as ''version 1.0.0'', despite this you should install the latest version (v1.2.1).

From the Eprints Admin panel, ''System Tools'' --> ''Eprints Bazaar'':

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]]

3. The plugin must be configured - see following section.

====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]]

=====Editing the configuration file: zzz_pubrouter_rioxx_importer.pl=====

The configuration file is edited via the Eprints Admin panel: ''Config. Tools'' --> ''View Configuration'' --> Folder ''cfg.d'' --> File ''zzz_pubrouter_rioxx_importer.pl'' (near bottom of list).

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:

[[File:Config.jpg|600px]]

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;

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.

Jisc Publications Router

2019-08-15T11:53:04Z

Arehin: /* Editing the configuration file: zzz_pubrouter_rioxx_importer.pl */

[[Category: Howto]]
[[Category: Plugins]]
[[Category: Bazaar Package]]

=Introduction=

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

<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=

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 '''[http://bazaar.eprints.org/390/ RIOXX2 plugin]''' installed and enabled. 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=

===Overview===

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 that describes 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 and enabled.

The plugin will create an Eprints record containing the received article metadata. Where the XML also contains links to the article PDF or other files then these will be automatically downloaded and attached to the record.

You will need a PubRouter account (see previous section) in order to receive data from PubRouter. You will also need to update the plugin's configuration file - details below - so that the plugin can retrieve article files that are (temporarily) stored on PubRouter.

===For Developers===

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].

====Latest version====

Version 1.2.1 (9th August 2019) - This version provides better handling of supplied licence information.

====Upgrading the plugin====

Upgrading the plugin from an earlier version is easily accomplished via your Eprints Admin panel: ''System Tools'' --> ''Eprints Bazaar'' which will offer you a "1 click" upgrade option. There is no need to modify the original RIOXXplus configuration file, which will continue to be used by the new plugin version.

:IMPORTANT: After performing the upgrade you will need to reload the Eprints configuration, again via Admin panel: ''Config. Tools'' --> ''Reload Configuration'' or alternatively, on the server, by restarting the Apache2 service.

====Installing the plugin====

:NOTE: In the following diagrams the ''Jisc PubRouter RIOXXplus Connector'' is shown as ''version 1.0.0'', despite this you should install the latest version (v1.2.1).

From the Eprints Admin panel, ''System Tools'' --> ''Eprints Bazaar'':

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]]

3. The plugin must be configured - see following section.

====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]]

=====Editing the configuration file: zzz_pubrouter_rioxx_importer.pl=====

The configuration file is edited via the Eprints Admin panel: ''Config. Tools'' --> ''View Configuration'' --> Folder ''cfg.d'' --> File ''zzz_pubrouter_rioxx_importer.pl'' (near bottom of list).

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:

[[File:Config.jpg|600px]]

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;

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.

Jisc Publications Router

2019-08-15T11:51:18Z

Arehin: /* For Information: Other Configuration File Content */

[[Category: Howto]]
[[Category: Plugins]]
[[Category: Bazaar Package]]

=Introduction=

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

<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=

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 '''[http://bazaar.eprints.org/390/ RIOXX2 plugin]''' installed and enabled. 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=

===Overview===

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 that describes 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 and enabled.

The plugin will create an Eprints record containing the received article metadata. Where the XML also contains links to the article PDF or other files then these will be automatically downloaded and attached to the record.

You will need a PubRouter account (see previous section) in order to receive data from PubRouter. You will also need to update the plugin's configuration file - details below - so that the plugin can retrieve article files that are (temporarily) stored on PubRouter.

===For Developers===

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].

====Latest version====

Version 1.2.1 (9th August 2019) - This version provides better handling of supplied licence information.

====Upgrading the plugin====

Upgrading the plugin from an earlier version is easily accomplished via your Eprints Admin panel: ''System Tools'' --> ''Eprints Bazaar'' which will offer you a "1 click" upgrade option. There is no need to modify the original RIOXXplus configuration file, which will continue to be used by the new plugin version.

:IMPORTANT: After performing the upgrade you will need to reload the Eprints configuration, again via Admin panel: ''Config. Tools'' --> ''Reload Configuration'' or alternatively, on the server, by restarting the Apache2 service.

====Installing the plugin====

:NOTE: In the following diagrams the ''Jisc PubRouter RIOXXplus Connector'' is shown as ''version 1.0.0'', despite this you should install the latest version (v1.2.1).

From the Eprints Admin panel, ''System Tools'' --> ''Eprints Bazaar'':

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]]

3. The plugin must be configured - see following section.

====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]]

=====Editing the configuration file: zzz_pubrouter_rioxx_importer.pl=====

The configuration file is edited via the Eprints Admin panel: ''Config. Tools'' --> ''View Configuration'' --> Folder ''cfg.d'' --> ''zzz_pubrouter_rioxx_importer.pl'' (near bottom of list).

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:

[[File:Config.jpg|600px]]

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;

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.

Jisc Publications Router

2019-08-15T11:50:51Z

Arehin: /* Editing Configuration file: zzz_pubrouter_rioxx_importer.pl */

[[Category: Howto]]
[[Category: Plugins]]
[[Category: Bazaar Package]]

=Introduction=

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

<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=

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 '''[http://bazaar.eprints.org/390/ RIOXX2 plugin]''' installed and enabled. 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=

===Overview===

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 that describes 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 and enabled.

The plugin will create an Eprints record containing the received article metadata. Where the XML also contains links to the article PDF or other files then these will be automatically downloaded and attached to the record.

You will need a PubRouter account (see previous section) in order to receive data from PubRouter. You will also need to update the plugin's configuration file - details below - so that the plugin can retrieve article files that are (temporarily) stored on PubRouter.

===For Developers===

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].

====Latest version====

Version 1.2.1 (9th August 2019) - This version provides better handling of supplied licence information.

====Upgrading the plugin====

Upgrading the plugin from an earlier version is easily accomplished via your Eprints Admin panel: ''System Tools'' --> ''Eprints Bazaar'' which will offer you a "1 click" upgrade option. There is no need to modify the original RIOXXplus configuration file, which will continue to be used by the new plugin version.

:IMPORTANT: After performing the upgrade you will need to reload the Eprints configuration, again via Admin panel: ''Config. Tools'' --> ''Reload Configuration'' or alternatively, on the server, by restarting the Apache2 service.

====Installing the plugin====

:NOTE: In the following diagrams the ''Jisc PubRouter RIOXXplus Connector'' is shown as ''version 1.0.0'', despite this you should install the latest version (v1.2.1).

From the Eprints Admin panel, ''System Tools'' --> ''Eprints Bazaar'':

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]]

3. The plugin must be configured - see following section.

====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]]

=====Editing the configuration file: zzz_pubrouter_rioxx_importer.pl=====

The configuration file is edited via the Eprints Admin panel: ''Config. Tools'' --> ''View Configuration'' --> Folder ''cfg.d'' --> ''zzz_pubrouter_rioxx_importer.pl'' (near bottom of list).

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:

[[File:Config.jpg|600px]]

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;

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.

File:Putrouter-screen.jpg

2019-08-15T11:50:09Z

Arehin: Arehin uploaded a new version of "File:Putrouter-screen.jpg"

PubRouter screen highlighting location of API key needed for configuration.

Jisc Publications Router

2019-08-15T11:46:37Z

Arehin: /* For Developers */

[[Category: Howto]]
[[Category: Plugins]]
[[Category: Bazaar Package]]

=Introduction=

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

<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=

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 '''[http://bazaar.eprints.org/390/ RIOXX2 plugin]''' installed and enabled. 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=

===Overview===

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 that describes 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 and enabled.

The plugin will create an Eprints record containing the received article metadata. Where the XML also contains links to the article PDF or other files then these will be automatically downloaded and attached to the record.

You will need a PubRouter account (see previous section) in order to receive data from PubRouter. You will also need to update the plugin's configuration file - details below - so that the plugin can retrieve article files that are (temporarily) stored on PubRouter.

===For Developers===

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].

====Latest version====

Version 1.2.1 (9th August 2019) - This version provides better handling of supplied licence information.

====Upgrading the plugin====

Upgrading the plugin from an earlier version is easily accomplished via your Eprints Admin panel: ''System Tools'' --> ''Eprints Bazaar'' which will offer you a "1 click" upgrade option. There is no need to modify the original RIOXXplus configuration file, which will continue to be used by the new plugin version.

:IMPORTANT: After performing the upgrade you will need to reload the Eprints configuration, again via Admin panel: ''Config. Tools'' --> ''Reload Configuration'' or alternatively, on the server, by restarting the Apache2 service.

====Installing the plugin====

:NOTE: In the following diagrams the ''Jisc PubRouter RIOXXplus Connector'' is shown as ''version 1.0.0'', despite this you should install the latest version (v1.2.1).

From the Eprints Admin panel, ''System Tools'' --> ''Eprints Bazaar'':

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]]

3. The plugin must be configured - see following section.

====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]]

=====Editing Configuration file: zzz_pubrouter_rioxx_importer.pl=====

The configuration file is edited via the Eprints Admin panel: ''Config. Tools'' --> ''View Configuration'' --> Folder ''cfg.d'' --> ''zzz_pubrouter_rioxx_importer.pl'' (near bottom of list).

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:

[[File:Config.jpg|600px]]

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;

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.

Jisc Publications Router

2019-08-15T11:32:31Z

Arehin: /* Jisc PubRouter RIOXXplus Connector Plugin */

[[Category: Howto]]
[[Category: Plugins]]
[[Category: Bazaar Package]]

=Introduction=

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

<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=

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 '''[http://bazaar.eprints.org/390/ RIOXX2 plugin]''' installed and enabled. 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=

===Overview===

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 that describes 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 and enabled.

The plugin will create an Eprints record containing the received article metadata. Where the XML also contains links to the article PDF or other files then these will be automatically downloaded and attached to the record.

You will need a PubRouter account (see previous section) in order to receive data from PubRouter. You will also need to update the plugin's configuration file - details below - so that the plugin can retrieve article files that are (temporarily) stored on PubRouter.

===For Developers===

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].

====Latest version====

Version 1.2.1 (9th August 2019) - This version primarily provides better handling of supplied licence information.

====Upgrading plugin====

Upgrading the plugin from an earlier version is easily accomplished via your Eprints Admin panel: ''System Tools'' --> ''Eprints Bazaar'' which will offer you the upgrade option.

:IMPORTANT: After performing the upgrade you will need to reload the Eprints configuration, again via Admin panel: ''Config. Tools'' --> ''Reload Configuration'' or alternatively, on the server, by restarting the Apache2 service.

====Install plugin====

:NOTE: In the following diagrams the ''Jisc PubRouter RIOXXplus Connector'' is shown as ''version 1.0.0'', despite this you should install the latest version (v1.2.1).

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
$c->{plugins}{"Import::PubRouter"}{params}{api_key} = "ENTER PUBROUTER API KEY HERE";

Before adding API Key:

[[File:Config.jpg|600px]]

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;

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.

Jisc Publications Router

2019-08-14T15:10:46Z

Arehin: /* Overview */

[[Category: Howto]]
[[Category: Plugins]]
[[Category: Bazaar Package]]

=Introduction=

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

<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=

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 '''[http://bazaar.eprints.org/390/ RIOXX2 plugin]''' installed and enabled. 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=

===Overview===

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 that describes 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 and enabled.

The plugin will create an Eprints record containing the received article metadata. Where the XML also contains links to the article PDF or other files then these will be automatically downloaded and attached to the record.

You will need a PubRouter account (see previous section) in order to receive data from PubRouter. You will also need to update the plugin's configuration file - details below - so that the plugin can retrieve article files that are (temporarily) stored on PubRouter.

===For Developers===

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].

====Latest version====

Version 1.2.1 (9th August 2019) - This version primarily provides better handling of supplied licence information.

====Install plugin====

:NOTE: In the following diagrams the ''Jisc PubRouter RIOXXplus Connector'' is shown as ''version 1.0.0'', despite this you should install the latest version (v1.2.1).

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
$c->{plugins}{"Import::PubRouter"}{params}{api_key} = "ENTER PUBROUTER API KEY HERE";

Before adding API Key:

[[File:Config.jpg|600px]]

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;

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.

Jisc Publications Router

2019-08-14T15:08:19Z

Arehin: /* Jisc PubRouter RIOXXplus Connector Plugin */

[[Category: Howto]]
[[Category: Plugins]]
[[Category: Bazaar Package]]

=Introduction=

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

<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=

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 '''[http://bazaar.eprints.org/390/ RIOXX2 plugin]''' installed and enabled. 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=

===Overview===

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 that describes 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 and enabled.

The plugin will create an Eprints record containing the received meta-data. Where the XML contains links to the article PDF or other files then these will also be automatically downloaded and attached to the record.

You will need a PubRouter account (see previous section) in order to receive data from PubRouter. You will also need to update the plugin's configuration file - details below - so that the plugin can retrieve article files that are (temporarily) stored on PubRouter.

===For Developers===

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].

====Latest version====

Version 1.2.1 (9th August 2019) - This version primarily provides better handling of supplied licence information.

====Install plugin====

:NOTE: In the following diagrams the ''Jisc PubRouter RIOXXplus Connector'' is shown as ''version 1.0.0'', despite this you should install the latest version (v1.2.1).

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
$c->{plugins}{"Import::PubRouter"}{params}{api_key} = "ENTER PUBROUTER API KEY HERE";

Before adding API Key:

[[File:Config.jpg|600px]]

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;

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.

Jisc Publications Router

2018-07-25T10:59:53Z

Arehin: /* Jisc PubRouter RIOXXplus Connector Plugin */

=Introduction=

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

<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=

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 '''[http://bazaar.eprints.org/390/ RIOXX2 plugin]''' installed and enabled. 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 [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 and enabled. 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 [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].

====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
$c->{plugins}{"Import::PubRouter"}{params}{api_key} = "ENTER PUBROUTER API KEY HERE";

Before adding API Key:

[[File:Config.jpg|600px]]

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;

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.

Jisc Publications Router

2018-07-25T10:58:54Z

Arehin: /* Jisc PubRouter RIOXXplus Connector Plugin */

=Introduction=

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

<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=

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 '''[http://bazaar.eprints.org/390/ RIOXX2 plugin]''' installed and enabled. 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 [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 and enabled. 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 [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].

====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
$c->{plugins}{"Import::PubRouter"}{params}{api_key} = "ENTER PUBROUTER API KEY HERE";

Before adding API Key:

[[File:Config.jpg|600px]]

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;

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.

Jisc Publications Router

2018-07-25T10:46:56Z

Arehin: /* PubRouter and Eprints */

=Introduction=

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

<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=

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 '''[http://bazaar.eprints.org/390/ RIOXX2 plugin]''' installed and enabled. 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 [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 and enabled. 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 [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].

====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
$c->{plugins}{"Import::PubRouter"}{params}{api_key} = "ENTER PUBROUTER API KEY HERE";

Before adding API Key:

[[File:Config.jpg|600px]]

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;

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.

Jisc Publications Router

2018-07-25T10:46:06Z

Arehin: /* Jisc PubRouter RIOXXplus Connector Plugin */

=Introduction=

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

<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=

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 [http://bazaar.eprints.org/390/ RIOXX2 plugin] installed and enabled. 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 [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 and enabled. 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 [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].

====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
$c->{plugins}{"Import::PubRouter"}{params}{api_key} = "ENTER PUBROUTER API KEY HERE";

Before adding API Key:

[[File:Config.jpg|600px]]

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;

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.

Jisc Publications Router

2018-07-25T10:45:47Z

Arehin: /* PubRouter and Eprints */

=Introduction=

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

<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=

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 [http://bazaar.eprints.org/390/ RIOXX2 plugin] installed and enabled. 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 [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.

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 [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].

====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
$c->{plugins}{"Import::PubRouter"}{params}{api_key} = "ENTER PUBROUTER API KEY HERE";

Before adding API Key:

[[File:Config.jpg|600px]]

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;

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.

Jisc Publications Router

2018-02-01T11:05:34Z

Arehin: /* For Developers */

=Introduction=

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

<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=

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 [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/.

=Jisc PubRouter RIOXXplus Connector Plugin=

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.

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 [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].

====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
$c->{plugins}{"Import::PubRouter"}{params}{api_key} = "ENTER PUBROUTER API KEY HERE";

Before adding API Key:

[[File:Config.jpg|600px]]

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;

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.

Jisc Publications Router

2018-02-01T11:02:56Z

Arehin: /* Jisc PubRouter RIOXXplus Connector Plugin */

=Introduction=

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

<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=

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 [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/.

=Jisc PubRouter RIOXXplus Connector Plugin=

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.

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===

Note that the plugin source code is also available on [https://github.com/jisc-services/eprints-plugin-PubRouter-RIOXXplus-Connector GitHub].

====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
$c->{plugins}{"Import::PubRouter"}{params}{api_key} = "ENTER PUBROUTER API KEY HERE";

Before adding API Key:

[[File:Config.jpg|600px]]

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;

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.

Jisc Publications Router

2017-11-14T17:20:43Z

Arehin: /* Jisc PubRouter RIOXXplus Connector Plugin */

=Introduction=

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

<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=

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 [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/.

=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 [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.

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===

====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
$c->{plugins}{"Import::PubRouter"}{params}{api_key} = "ENTER PUBROUTER API KEY HERE";

Before adding API Key:

[[File:Config.jpg|600px]]

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;

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.

Jisc Publications Router

2017-11-14T17:17:19Z

Arehin: /* Configure Plugin */

=Introduction=

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

<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=

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 [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/.

=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 [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.

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===

====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
$c->{plugins}{"Import::PubRouter"}{params}{api_key} = "ENTER PUBROUTER API KEY HERE";

Before adding API Key:

[[File:Config.jpg|600px]]

After adding API Key (showing dummy key value):

[[File:Config-after.jpg|600px]]

====For Information: Other Configuration File Content====

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
$c->{enable_web_imports} = 1;

Also, it ensures that the Atom Export plugin, required for generating SWORD deposit responses, has not been disabled.

$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.

Jisc Publications Router

2017-11-14T17:16:11Z

Arehin: /* Jisc PubRouter RIOXXplus Connector Plugin */

=Introduction=

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

<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=

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 [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/.

=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 [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.

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===

====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]]

This 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:

[[File:Config.jpg|600px]]

After adding API Key (showing dummy key value):

[[File:Config-after.jpg|600px]]

====For Information: Other Configuration File Content====

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
$c->{enable_web_imports} = 1;

Also, it ensures that the Atom Export plugin, required for generating SWORD deposit responses, has not been disabled.

$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.

Jisc Publications Router

2017-11-14T15:56:51Z

Arehin: /* Jisc PubRouter RIOXXplus Connector Plugin */

=Introduction=

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

<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=

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 [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/.

=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 [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.

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===

====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: <code>zzz_pubrouter_rioxx_importer.pl</code>.

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.

This API key is stored on the line shown below, and also in the following images (before and after editing):

#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:

[[File:Config.jpg|600px]]

After adding API Key (note this shows a dummy key):

[[File:Config-after.jpg|600px]]

The PubRouter API key will be displayed at the top of your PubRouter Account page - see highlighted field (contains dummy values):

[[File:Putrouter-screen.jpg|600px]]

====For Information: Other Configuration File Content====

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
$c->{enable_web_imports} = 1;

Also, it ensures that the Atom Export plugin, required for generating SWORD deposit responses, has not been disabled.

$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.

Jisc Publications Router

2017-11-14T15:52:54Z

Arehin: Images added

=Introduction=

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

<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=

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 [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/.

=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 [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.

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===

====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: <code>zzz_pubrouter_rioxx_importer.pl</code>.

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.

This API key is stored on the line shown below, and also in the following images (before and after editing):

#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:

[[File:Config.jpg|600px]]

After adding API Key (note this shows a dummy key):

[[File:Config-after.jpg|600px]]

The PubRouter API key will be displayed at the top of your PubRouter Account page - see highlighted field (contains dummy values):

[[File:Putrouter-screen.jpg|600px]]

====Other Information====
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
$c->{enable_web_imports} = 1;

Also, it ensures that the Atom Export plugin, required for generating SWORD deposit responses, has not been disabled.

$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.

Jisc Publications Router

2017-11-14T15:50:58Z

Arehin: /* For Developers */

=Introduction=

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

<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=

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 [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/.

=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 [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.

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===

====Install plugin====

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

[[File:Bazaar-entry.jpg|400px]]

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

[[File:Installed-pkg.jpg|400px]]

====Configure Plugin====

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

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.

This API key is stored on the line shown below, and also in the following images (before and after editing):

#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:

[[File:Config.jpg|400px]]

After adding API Key (note this shows a dummy key):

[[File:Config-after.jpg|400px]]

The PubRouter API key will be displayed at the top of your PubRouter Account page - see highlighted field (contains dummy values):

[[File:Putrouter-screen.jpg|400px]]

====Other Information====
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
$c->{enable_web_imports} = 1;

Also, it ensures that the Atom Export plugin, required for generating SWORD deposit responses, has not been disabled.

$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.

File:Installed-pkg.jpg

2017-11-14T15:47:43Z

Arehin: After installing the Jisc PubRouter RIOXXplus Connector plugin, also showing RIOXX2 plugin it is designed to work with.

After installing the Jisc PubRouter RIOXXplus Connector plugin, also showing RIOXX2 plugin it is designed to work with.

File:Config-after.jpg

2017-11-14T15:46:08Z

Arehin: Arehin uploaded a new version of "File:Config-after.jpg"

After installing Jisc PubRouter RIOXXplus Connector plugin, also showing the RIOXX2 plugin it is designed to work with.

File:Putrouter-screen.jpg

2017-11-14T15:36:08Z

Arehin: PubRouter screen highlighting location of API key needed for configuration.

PubRouter screen highlighting location of API key needed for configuration.

File:Config.jpg

2017-11-14T15:35:08Z

Arehin: Configuration for Jisc PubRouter RIOXXplus Connector plugin

Configuration for Jisc PubRouter RIOXXplus Connector plugin

File:Config-after.jpg

2017-11-14T15:34:33Z

Arehin: Arehin uploaded a new version of "File:Config-after.jpg"

After installing Jisc PubRouter RIOXXplus Connector plugin, also showing the RIOXX2 plugin it is designed to work with.

File:Config-after.jpg

2017-11-14T15:33:55Z

Arehin: After installing Jisc PubRouter RIOXXplus Connector plugin, also showing the RIOXX2 plugin it is designed to work with.

After installing Jisc PubRouter RIOXXplus Connector plugin, also showing the RIOXX2 plugin it is designed to work with.

File:Bazaar-entry.jpg

2017-11-14T15:32:56Z

Arehin: Jisc PubRouter RIOXXplus Connector plugin entry in Bazaar

Jisc PubRouter RIOXXplus Connector plugin entry in Bazaar

Jisc Publications Router

2017-11-14T15:13:38Z

Arehin:

=Introduction=

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

<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=

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 [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/.

=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 [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.

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>.

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.

This API key is stored here:

#PubRouter API key for importing document via URL supplied by PubRouter
$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
$c->{enable_web_imports} = 1;

Also, it ensures that the Atom Export plugin, required for generating SWORD deposit responses, has not been disabled.

$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.

Jisc Publications Router

2017-11-14T15:13:25Z

Arehin: /* PubRouter and Eprints */

=Introduction=

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

<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=

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 [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/.

=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 [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.

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>.

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.

This API key is stored here:

#PubRouter API key for importing document via URL supplied by PubRouter
$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
$c->{enable_web_imports} = 1;

Also, it ensures that the Atom Export plugin, required for generating SWORD deposit responses, has not been disabled.

$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.

Jisc Publications Router

2017-11-14T15:08:21Z

Arehin: /* PubRouter and Eprints */

=Introduction=

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

<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=

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 a "vanilla" 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. It also attaches document files where available. You will need to install this plugin from Eprints Bazaar and configure it - see further details below.

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 [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.

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>.

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.

This API key is stored here:

#PubRouter API key for importing document via URL supplied by PubRouter
$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
$c->{enable_web_imports} = 1;

Also, it ensures that the Atom Export plugin, required for generating SWORD deposit responses, has not been disabled.

$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.

Jisc Publications Router

2017-11-14T15:05:30Z

Arehin: /* PubRouter and Eprints */

=Introduction=

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

<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=

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 a "vanilla" 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 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).

* ''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.

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 [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.

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>.

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.

This API key is stored here:

#PubRouter API key for importing document via URL supplied by PubRouter
$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
$c->{enable_web_imports} = 1;

Also, it ensures that the Atom Export plugin, required for generating SWORD deposit responses, has not been disabled.

$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.

Jisc Publications Router

2017-11-14T15:04:52Z

Arehin: /* PubRouter and Eprints */

=Introduction=

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

<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=

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 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).

* ''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.

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 [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.

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>.

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.

This API key is stored here:

#PubRouter API key for importing document via URL supplied by PubRouter
$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
$c->{enable_web_imports} = 1;

Also, it ensures that the Atom Export plugin, required for generating SWORD deposit responses, has not been disabled.

$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.

Jisc Publications Router

2017-11-14T12:57:56Z

Arehin:

=Introduction=

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

<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=

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.

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).

* ''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.

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 [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.

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>.

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.

This API key is stored here:

#PubRouter API key for importing document via URL supplied by PubRouter
$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
$c->{enable_web_imports} = 1;

Also, it ensures that the Atom Export plugin, required for generating SWORD deposit responses, has not been disabled.

$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.

Jisc Publications Router

2017-11-14T12:56:52Z

Arehin: /* Jisc PubRouter RIOXXplus Connector Plugin */

=Introduction=

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

<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=

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.

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).

* ''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.

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 [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.

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>.

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.

This API key is stored here:

#PubRouter API key for importing document via URL supplied by PubRouter
$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
$c->{enable_web_imports} = 1;

Also, it ensures that the Atom Export plugin, required for generating SWORD deposit responses, has not been disabled.

$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.

Jisc Publications Router

2017-11-14T12:56:35Z

Arehin: /* PubRouter and Eprints */

=Introduction=

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

<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=

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.

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).

* ''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.

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 ''Jisc PubRouter RIOXXplus Connector'' plugin installs a configuration file at the local archive level, named: <code>zzz_pubrouter_rioxx_importer.pl</code>.

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.

This API key is stored here:

#PubRouter API key for importing document via URL supplied by PubRouter
$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
$c->{enable_web_imports} = 1;

Also, it ensures that the Atom Export plugin, required for generating SWORD deposit responses, has not been disabled.

$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.

Jisc Publications Router

2017-11-14T12:56:14Z

Arehin: /* Jisc PubRouter RIOXX Importer */

=Introduction=

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

<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=

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.

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).

* ''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. You will need to install this plugin from Eprints Bazaar and configure it - see further details below.

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 ''Jisc PubRouter RIOXXplus Connector'' plugin installs a configuration file at the local archive level, named: <code>zzz_pubrouter_rioxx_importer.pl</code>.

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.

This API key is stored here:

#PubRouter API key for importing document via URL supplied by PubRouter
$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
$c->{enable_web_imports} = 1;

Also, it ensures that the Atom Export plugin, required for generating SWORD deposit responses, has not been disabled.

$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.

Jisc Publications Router

2017-11-14T12:36:28Z

Arehin: /* Introduction */