EPrints Documentation - User contributions [en-gb]

Tips to write plugins

2017-06-30T12:35:27Z

E.jennings@bath.ac.uk:

[[Category:Plugins]]
I've written a lot of plugins for EPrints 3+ now and so i think its time to share the knowledge. If you care you can read about the mess I got into in the early days [http://blogs.ecs.soton.ac.uk/oneshare/2009/09/25/taking-stock-and-mopping-up-the-mess-i-made-of-eprints/ here].

So without further ado let me give you the top 10 ways to avoid making a hash of your EPrints install when doing a large customization:

* Rule 1: NEVER edit Session.pm if there is one file that you will absolutely not recover from it’s this. also there is an easy way to avoid editing it see rule 6.

* Rule 2: Don’t edit anything in perl_lib/EPrints. Make copies with a new name and new package. That way these files wont be over written when you upgrade.

* Rule 3: Everything in the Plugin/ directory which you do should be kept in the appropiate place in archives/YOUR_REPOSITORY/cfg/plugins/EPrints/Plugin etc. This is a really good way to keep track of what you’ve actually done.

* Rule 4: Everything you do should be a plugin. EPrints has plugins for almost everything which means you should be able to do almost all funtionality in plugins. See [[Instructions for local plugins]]

* Rule 5: For everything you want to do which doesn't seem to be a plugin think really hard. Are you SURE it’s not a plugin? Really SURE? Are you SURE you need this functionality? Really SURE?

* Rule 6: If you have followed rule 5 and you are still really sure then kludge a plugin, a kuldgin as I like to call them, using namespace over writing. This is feature/artifact of perl, from one package you can write in another package. Add methods to the DataObj::EPrint good example of where you might want to do this. To do it :

make a Plugin (yes a plugin) in your local cfg (see rule 3). start the plugin file in the normal way:
package EPrints::Plugin::MyPlugin;
use strict;
our @ISA = qw/ EPrints::Plugin /;
#now for the clever bit
package EPrints::DataObj::EPrint;
sub mysubroutine{
return(”foo”);
}

That has added mysubroutine to DataObj::EPrint so you can now

my $eprint = EPrint::DataObj::EPrint->new($session, 23); #get eprint 23
print $eprint->mysubroutine(); #prints “foo”

You can use this to overwrite behaviour from an existing subroutine. Make sure to delete the original first:
package EPrints::Plugin::MyPlugin;
use strict;
our @ISA = qw/ EPrints::Plugin /;
package EPrints::DataObj::EPrint;
BEGIN { delete $EPrints::DataObj::EPrint::{existing_subroutine}; }
sub existing_subroutine{
return(”foo”);
}

* Rule 7: learn about cfg/cfg.d/plugins.pl. This file lets you disable plugins you dont want to use or map you modified plugins over other plugins. For example use MyReview.pm everywhere you would usually use Review.pm – very powerful. It also lets you define where plugins apear around about the place.

* Rule 8: for plugins which use a cgi script for whatever reason (usually ajax) make a directory in cgi which has the same name as the plugin for example cgi/myfirstplugin where all the cgi used by MyFirstPlugin.pm can be found. It makes it much easier to see what youve done and if you want to deploy the plugin somewhere else you grab the plugin file and the directory and you well on the way.

* Rule 9: Give each plugin its own phrase file. I got into a hidious mess where my zz_local.xml phrase file was about a 4000 lines long and it wasnt clear what phrases belonged to what plugin.

* Rule 10: If your plugin needs configuring put all the config options in a cfg/cfg.d/my_plugins_config_options.pl that way the user only has to go to one place edit the options and different repositories using the same plugin can have different options.

In conclusion obey rules 1-10. If I’d known this stuff when I’d started we probably wouldnt have needed the first 6 months of the OneShare project.

User group meetings

2017-01-05T12:12:15Z

E.jennings@bath.ac.uk: /* Bath, UK */

__toc__

=2016=

==Bath, UK==
Date: 19th December
Location: University of Bath

[https://drive.google.com/open?id=1WqSV5XvEGapiZ-hOCiwO3KtofuWn5r4-g0z-VbmTg1Q Collaborative notes (Google Doc)]

[https://drive.google.com/open?id=0B4pSjSeAg96cZHUtQV96WmZwUkU Making EPrints Angular - Lizz Jennings (University of Bath) (PowerPoint)]

[http://dx.doi.org/10.7892/boris.91710 BORIS & Swiss EPrints community - Dirk Verdicchio (Universitätsbibliothek Bern) (PDF)]

[https://drive.google.com/open?id=0B4pSjSeAg96cOGZfeXh3UXhGY0E ORCID and EPrints - Monica Duke (Jisc) (PowerPoint)]

[https://drive.google.com/open?id=0B4pSjSeAg96ccEh3aGNJR3ZHMHc Reporting for the REF OA policy - Helen Webb (University of Sussex) (PowerPoint)]

Hack Day: 20th December

[[File:2016-12-20_hack_day_1.jpg]]
[[File:2016-12-20_hack_day_2.jpg]]
[[File:2016-12-20_hack_day_3.jpg]]
[[File:2016-12-20_hack_day_4.jpg]]

Photos by Helen Cooper

==Preston, UK==
Date: 13th May
Location: University of Central Lancashire

[https://drive.google.com/open?id=1v5YLeHe8Mro59dYcl3yhK0nKelIlr-dZrRDq11nMMuQ Collaborative notes (Google Doc)]

=2015=

==Southampton, UK==
Date: 11th September
Location: University of Southampton

[https://drive.google.com/open?id=1yy8fol8NXz8Z3aEHsYkWSS2pfVDfaZCk36Zcq3TUb6A Collaborative notes (Google Doc)]

==London, UK==
Date: 15th January
Location: University of London

[https://drive.google.com/open?id=1Ya6ML9gk1oYEosbdUr7--KqcKKQdnW05PqWO3bTk07M Collaborative notes (Google Doc)]

=2014=

==Leeds, UK==
Date: 27th June
Location: University of Leeds

[https://drive.google.com/open?id=1ZaF5wonSTwdKFmxkrR_ioeML1k_xEkBrYooN1odkUeY Collaborative notes (Google Doc)]

User group meetings

2017-01-04T17:09:57Z

E.jennings@bath.ac.uk: /* Bath, UK */

__toc__

=2016=

==Bath, UK==
Date: 19th December
Location: University of Bath

[https://drive.google.com/open?id=1WqSV5XvEGapiZ-hOCiwO3KtofuWn5r4-g0z-VbmTg1Q Collaborative notes (Google Doc)]

[https://drive.google.com/open?id=0B4pSjSeAg96cZHUtQV96WmZwUkU Making EPrints Angular - Lizz Jennings (University of Bath) (PowerPoint)]

[http://dx.doi.org/10.7892/boris.91710 BORIS & Swiss EPrints community - Dirk Verdicchio (Universitätsbibliothek Bern) (PDF)]

[https://drive.google.com/open?id=0B4pSjSeAg96cOGZfeXh3UXhGY0E ORCID and EPrints - Monica Duke (Jisc) (PowerPoint)]

Hack Day: 20th December

[[File:2016-12-20_hack_day_1.jpg]]
[[File:2016-12-20_hack_day_2.jpg]]
[[File:2016-12-20_hack_day_3.jpg]]
[[File:2016-12-20_hack_day_4.jpg]]

Photos by Helen Cooper

==Preston, UK==
Date: 13th May
Location: University of Central Lancashire

[https://drive.google.com/open?id=1v5YLeHe8Mro59dYcl3yhK0nKelIlr-dZrRDq11nMMuQ Collaborative notes (Google Doc)]

=2015=

==Southampton, UK==
Date: 11th September
Location: University of Southampton

[https://drive.google.com/open?id=1yy8fol8NXz8Z3aEHsYkWSS2pfVDfaZCk36Zcq3TUb6A Collaborative notes (Google Doc)]

==London, UK==
Date: 15th January
Location: University of London

[https://drive.google.com/open?id=1Ya6ML9gk1oYEosbdUr7--KqcKKQdnW05PqWO3bTk07M Collaborative notes (Google Doc)]

=2014=

==Leeds, UK==
Date: 27th June
Location: University of Leeds

[https://drive.google.com/open?id=1ZaF5wonSTwdKFmxkrR_ioeML1k_xEkBrYooN1odkUeY Collaborative notes (Google Doc)]

User group meetings

2017-01-04T17:07:38Z

E.jennings@bath.ac.uk: /* Bath, UK */

__toc__

=2016=

==Bath, UK==
Date: 19th December
Location: University of Bath

[https://drive.google.com/open?id=1WqSV5XvEGapiZ-hOCiwO3KtofuWn5r4-g0z-VbmTg1Q Collaborative notes (Google Doc)]

[https://drive.google.com/open?id=0B4pSjSeAg96cZHUtQV96WmZwUkU Making EPrints Angular - Lizz Jennings (University of Bath) (PowerPoint)]

[http://dx.doi.org/10.7892/boris.91710 BORIS & Swiss EPrints community - Dirk Verdicchio (Universitätsbibliothek Bern) (PDF)]

Hack Day: 20th December

[[File:2016-12-20_hack_day_1.jpg]]
[[File:2016-12-20_hack_day_2.jpg]]
[[File:2016-12-20_hack_day_3.jpg]]
[[File:2016-12-20_hack_day_4.jpg]]

==Preston, UK==
Date: 13th May
Location: University of Central Lancashire

[https://drive.google.com/open?id=1v5YLeHe8Mro59dYcl3yhK0nKelIlr-dZrRDq11nMMuQ Collaborative notes (Google Doc)]

=2015=

==Southampton, UK==
Date: 11th September
Location: University of Southampton

[https://drive.google.com/open?id=1yy8fol8NXz8Z3aEHsYkWSS2pfVDfaZCk36Zcq3TUb6A Collaborative notes (Google Doc)]

==London, UK==
Date: 15th January
Location: University of London

[https://drive.google.com/open?id=1Ya6ML9gk1oYEosbdUr7--KqcKKQdnW05PqWO3bTk07M Collaborative notes (Google Doc)]

=2014=

==Leeds, UK==
Date: 27th June
Location: University of Leeds

[https://drive.google.com/open?id=1ZaF5wonSTwdKFmxkrR_ioeML1k_xEkBrYooN1odkUeY Collaborative notes (Google Doc)]

File:2016-12-20 hack day 4.jpg

2017-01-04T17:06:37Z

E.jennings@bath.ac.uk:

File:2016-12-20 hack day 3.jpg

2017-01-04T17:06:16Z

E.jennings@bath.ac.uk:

File:2016-12-20 hack day 2.jpg

2017-01-04T17:05:45Z

E.jennings@bath.ac.uk:

File:2016-12-20 hack day 1.jpg

2017-01-04T17:05:13Z

E.jennings@bath.ac.uk:

User group meetings

2017-01-04T16:38:30Z

E.jennings@bath.ac.uk: /* Bath, UK */

__toc__

=2016=

==Bath, UK==
Date: 19th December
Location: University of Bath

[https://drive.google.com/open?id=1WqSV5XvEGapiZ-hOCiwO3KtofuWn5r4-g0z-VbmTg1Q Collaborative notes (Google Doc)]

[https://drive.google.com/open?id=0B4pSjSeAg96cZHUtQV96WmZwUkU Making EPrints Angular - Lizz Jennings (University of Bath) (PowerPoint)]

[http://dx.doi.org/10.7892/boris.91710 BORIS & Swiss EPrints community - Dirk Verdicchio (Universitätsbibliothek Bern) (PDF)]

==Preston, UK==
Date: 13th May
Location: University of Central Lancashire

[https://drive.google.com/open?id=1v5YLeHe8Mro59dYcl3yhK0nKelIlr-dZrRDq11nMMuQ Collaborative notes (Google Doc)]

=2015=

==Southampton, UK==
Date: 11th September
Location: University of Southampton

[https://drive.google.com/open?id=1yy8fol8NXz8Z3aEHsYkWSS2pfVDfaZCk36Zcq3TUb6A Collaborative notes (Google Doc)]

==London, UK==
Date: 15th January
Location: University of London

[https://drive.google.com/open?id=1Ya6ML9gk1oYEosbdUr7--KqcKKQdnW05PqWO3bTk07M Collaborative notes (Google Doc)]

=2014=

==Leeds, UK==
Date: 27th June
Location: University of Leeds

[https://drive.google.com/open?id=1ZaF5wonSTwdKFmxkrR_ioeML1k_xEkBrYooN1odkUeY Collaborative notes (Google Doc)]

User group meetings

2017-01-04T12:35:16Z

E.jennings@bath.ac.uk:

User group meetings

2017-01-04T12:34:22Z

E.jennings@bath.ac.uk:

User group meetings

2017-01-04T12:26:13Z

E.jennings@bath.ac.uk:

__toc__

=2016=

==Bath, UK==
Date: 19th December
Location: University of Bath

[https://drive.google.com/open?id=1WqSV5XvEGapiZ-hOCiwO3KtofuWn5r4-g0z-VbmTg1Q Collaborative notes (Google Doc)]

==Preston, UK==
Date: 13th May
Location: University of Central Lancashire

[https://drive.google.com/open?id=1v5YLeHe8Mro59dYcl3yhK0nKelIlr-dZrRDq11nMMuQ Collaborative notes (Google Doc)]

=2015=

==Southampton, UK==
Date: 11th September
Location: University of Southampton

[https://drive.google.com/open?id=1yy8fol8NXz8Z3aEHsYkWSS2pfVDfaZCk36Zcq3TUb6A Collaborative notes (Google Doc)]

==London, UK==
Date: 15th January
Location: University of London

[https://drive.google.com/open?id=1Ya6ML9gk1oYEosbdUr7--KqcKKQdnW05PqWO3bTk07M Collaborative notes (Google Doc)]

=2014=

==Leeds, UK==
Date: 27th June
Location: University of Leeds

[https://drive.google.com/open?id=1ZaF5wonSTwdKFmxkrR_ioeML1k_xEkBrYooN1odkUeY Collaborative notes (Google Doc)]

Main Page

2017-01-04T12:13:29Z

E.jennings@bath.ac.uk: /* Getting Support */

[[Category:Howto]]
__NOTOC__
'''Welcome to the EPrints Wiki'''

This wiki contains technical and user-contributed documentation for the [[Introduction|EPrints software]].

[http://demoprints3.eprints.org/ Demoprints] is our live, online server that allows anyone to try EPrints without having to install it first.

For more information on the EPrints project and related activities visit http://eprints.org/.

==New to EPrints?==

On this wiki you can find:

*[[:Category:Training Video|Video Training Course]]
*[[EPrints_Manual|Documentation]]
*[[Working Groups]]
*Mailing lists

There are two mail lists that you might like to join and where you can ask for help and share ideas:

'''The EPrints User Group Google Group''' https://groups.google.com/forum/#!forum/eprints-uk-user-group

This group is for anyone involved in using EPrints. Ask questions, share ideas, hear about forthcoming meetings.

'''The Eprints Technical Mailing List'''

Joining information for [[Contact| EPrints Tech list]]
*How to [[Wiki_editing_guidlines|contribute to the EPrints wiki]]
*Code Sharing Repository https://github.com/eprintsug

== Download EPrints ==

{{Download}}

==Installation==

* [[:Category:Installation|Installing]] EPrints on various platforms

==Getting Started==

* [[EPrints Manual|EPrints 3 Documentation]]
* [[Perl 101 for EPrints]]
* [http://www.eprints.org/software/training/ Training materials] provided by EPrints Services.
* [[Frequently Asked Questions]]
* [[:Category:Howto|How to...]]
* [[:Category:Plugins|Plugins and Bazaar packages for EPrints]]
* [[:Category:Training Video|EPrints Training Course]]

==Getting Support==

* [http://www.eprints.org/services/ EPrints Services] - premium support, training and hosting from EPrints experts
* [[Contact]] - mailing lists, bug reports etc.
* [[User group meetings]] - regional meetings for users, which often have notes, presentations and information of general interest

==Add-ons, patches and translations==

* As of version 3.3 EPrints can now install plugins and translations through the [https://bazaar.eprints.org EPrints Bazaar] the wiki also has information about [[:Category:EPrints Bazaar|packaging plugins for the Bazaar]].
* The [http://files.eprints.org/ EPrints Files Repository] contains add-on and 3rd party scripts, patches and translations. This also provides an archive of all previous EPrints releases (3.0 onwards).
* [[:Category:Plugins|Plugins]]: Some Wiki pages about scripts and patches.

{{Register}}

==Contributing to EPrints==

* [[Usability|EPrints usability]]
* [[:Category:Releases|New features in EPrints]] - released and proposed
* [[How to contribute|How to contribute to EPrints development]]
* [http://trac.eprints.org/ EPrints Trac] - access nightly builds, tickets and changes (requires free registration to view source code)
* [[EPrints4 Roadmap]]
* [[EPrints3 Roadmap]] - 2016 Community Roadmap

== Content management ==

* [[Digital preservation]]: managing content for longer-term access and use

User group meetings

2017-01-04T12:12:30Z

E.jennings@bath.ac.uk: Created page with "=User Group Meetings="

=User Group Meetings=

How to modify static pages

2016-12-20T14:48:15Z

E.jennings@bath.ac.uk:

[[Category:Static Pages]]
The static web pages are created by combining the .xpage files from [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/static | /opt/eprints3/archives/ARCHIVEID/cfg/lang/en/static/]] with the site template. The template can be found at [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/templates|opt/eprints3/archives/ARCHIVEID/cfg/lang/en/templates]]. This is what generate_static does.

Generate static also copies all files which do not have the suffix .xpage from [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/static | /opt/eprints3/archives/ARCHIVEID/cfg/lang/en/static/]]

Non-language specific files go in the [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg|/opt/eprints3/archives/ARCHIVEID/cfg]] directory and appear on the website no matter what language the site is in. eg. images and the style sheet.

Obviously french source files go in cfg/lang/fr/ etc.

Edit the .xpage file (or other file in /static/)

Run [[Bin/|generate_static]] ARCHIVEID

===Issues===

The XML Editor encodes all extended characters, with the exception of core HTML ones (e.g. <) -- this causes issues with pages that need to include one of these symbols. See https://github.com/eprints/eprints/blob/3.3/perl_lib/EPrints/Plugin/Screen/Admin/Config/Edit/XML.pm#L29

A set of phrases have been created for html entites to be used in static pages and phrases that can be edited through the front-end tools. E.g:

<source lang='html4strict'>
<p>Nuts <epc:phrase ref='entity_amp'/> bolts</p>
</source>

A [http://bazaar.eprints.org/id/eprint/471 bazaar package] has been created for the following phrases:

* entity_amp
* entity_gt
* entity_lt
* entity_quot
* entity_apos

See

How to modify static pages

2016-12-20T14:05:05Z

E.jennings@bath.ac.uk:

Training Video:Edit and Create Static Pages

2016-12-20T14:02:30Z

E.jennings@bath.ac.uk:

[[Category:Howto]]
[[Category:Training_Video|Edit and Create Static Pages]]

==Introduction==

This video is a Walkthrough of editing and creating static pages (including linking into repository navigation).

==What You Will Learn==

* What a static page is
* How to edit static pages via the web
* How to create a new static page and link to it

==What You Should Already Know==

* An understanding of HTML
* How to access the EPrints Administration pages

==Resources==

=== Video===
The Video can be found at [http://youtu.be/KzrS_u-4eoM http://youtu.be/KzrS_u-4eoM].
====Index====
* [http://youtu.be/HTg_8gbiiN8?t=00m00s 00:00 - Introduction]
* [http://youtu.be/HTg_8gbiiN8?t=00m07s 00:07 - What is a static page?]
* [http://youtu.be/HTg_8gbiiN8?t=00m31s 00:31 - Editing via the View Configuration tool]
* [http://youtu.be/HTg_8gbiiN8?t=01m11s 01:11 - Editing via the 'Edit Page' menu link]
* [http://youtu.be/HTg_8gbiiN8?t=01m33s 01:33 - Adding content to an existing page]
* [http://youtu.be/HTg_8gbiiN8?t=03m06s 03:06 - Creating a new page]
* [http://youtu.be/HTg_8gbiiN8?t=03m42s 03:42 - Copy structure from existing page]
* [http://youtu.be/HTg_8gbiiN8?t=04m20s 04:20 - Set title and content of new page]
* [http://youtu.be/HTg_8gbiiN8?t=05m50s 05:50 - Verify page]
* [http://youtu.be/HTg_8gbiiN8?t=06m05s 06:05 - Add link to menu (edit template)]

==== The Video====
<youtube>HTg_8gbiiN8</youtube>

====Notes, Errata and Additional Information====

* EPrints 3.3.14
* Ubuntu 15.04

==Test Yourself==

* Edit a static page (try [http://demoprints.eprints.org demoprints] if you don't have access to your own test repository)
* create a new static page
* create a link to the new static page
* include a repository phrase in a static page

==More Reading==

* [[How_to_modify_static_pages | How to modify static pages ]]
* [[Training_Video:Edit_Phrases| Editing phrases]]
* [[Branding/Logos| Branding your repository]]

ORCID connector

2016-07-05T12:07:00Z

E.jennings@bath.ac.uk: /* Requirements */

This page is intended to capture requirements for ORCID integrations, with a view to agreeing a community vision for EPrints development.

To see existing integrations, visit the [[ORCID]] page.

==Use Cases==

===No API connection===

'''As a''' repository connecting to ORCID through another system

'''I need''' a field to record ORCID IDs

'''So that I can''' display and link the ORCID ID to other systems

'''As a''' repository which records ORCID IDs

'''I need''' to render the ORCID as a link

'''So that I can''' display the ID in the recommended format

===Tier 1 (public) API connection===

'''As a''' repository

'''I need''' to harvest information from ORCID public profiles

'''So that I can''' populate item records with information

===Tier 2 (private) API connection===

'''As a''' repository connecting to ORCID through this system

'''I need''' to communicate with ORCID

'''So that I can''' authenticate ORCID IDs

'''As a''' researcher

'''I need''' to choose which permissions to give my institution

'''So that I can''' integrate my ORCID to meet my personal requirements

===End User===

'''As a''' third party harvesting from EPrints

'''I need''' ORCID IDs to be exported in all metadata formats, not just oai_dc

'''So that I can''' reuse the metadata in my system

==Requirements==

This table is designed to record requirements for ORCID plugin development. It shows the function, how you would test it is doing the intended job, how desirable it is for each level of integration and whether the information is suggested, proposed or agreed by the community.

At present, all these items are "Suggested" - a survey will be compiled from this and circulated to form a proposal, with a MoSCoW analysis for each item.

{| class="wikitable"
! Function !! Test !! No API !! Tier 1 API !! Tier 2 API !! End User !! Status
|-
|| Record ORCID ID against user || EPrints field (ideally named "orcid") available to record ORCID ID in User Profile || || || || || Suggested
|-
|| Record ORCID ID against creator || EPrints field (ideally named "orcid") available to record ORCID ID in EPrint record || || || || || Suggested
|-
|| Validate ORCID ID || ORCID ID validated (http://support.orcid.org/knowledgebase/articles/116780-structure-of-the-orcid-identifier) || || || || || Suggested
|-
|| Lookup ORCID ID || ORCID ID is included in name lookup || || || || || Suggested
|-
|| Display ORCID ID in User Profile || ORCID is rendered in User Profile || || || || || Suggested
|-
|| Display ORCID ID in EPrint abstract page || ORCID is rendered in EPrint abstract pages || || || || || Suggested
|-
|| Display ORCID ID in citation || ORCID is rendered in citation formats || || || || || Suggested
|-
|| Display ORCID ID in page metadata || ORCID is included in page metadata || || || || || Suggested
|-
|| Render ORCID as a link || ORCID is linked to ORCID profile where rendered || || || || || Suggested
|-
|| Enable depositors to import items from ORCID || Records can be imported from ORCID || || || || || Suggested
|-
|| Enable depositors to export items to ORCID || Records can be exported to ORCID || || || || || Suggested
|-
|| Enable administrators to import items from ORCID || Records can be imported from ORCID || || || || || Suggested
|-
|| Enable administrators to export items to ORCID || Records can be exported to ORCID || || || || || Suggested
|-
|| Record permissions granted || Permissions granted to ORCID are recorded in EPrints (against User record) || || || || || Suggested
|-
|| Include ORCID in export formats || All export formats include ORCID where supplied<ref>oai_dc does not support attributes on the 'people' elements (e.g. creator). Exposing ORCIDs via oai_dc is NOT a real option. An extension to oai_dc profile may need to be made!</ref> || || || || || Suggested
|}

<references/>

==Concerns==

===Compatibility===

* The plugin needs to be compatible with other standard plugins, e.g. Rioxx

* Known third-party systems being used to integrate with ORCID:
** Pure
** Oracle Database HR System

* Known third-party systems harvesting ORCID from EPrints:
** EThOS (uketd_dc format)

* Is there a need to include ORCID in the IRUS plugin?

ORCID connector

2016-07-05T11:59:10Z

E.jennings@bath.ac.uk: /* Requirements */

This page is intended to capture requirements for ORCID integrations, with a view to agreeing a community vision for EPrints development.

To see existing integrations, visit the [[ORCID]] page.

==Use Cases==

===No API connection===

'''As a''' repository connecting to ORCID through another system

'''I need''' a field to record ORCID IDs

'''So that I can''' display and link the ORCID ID to other systems

'''As a''' repository which records ORCID IDs

'''I need''' to render the ORCID as a link

'''So that I can''' display the ID in the recommended format

===Tier 1 (public) API connection===

'''As a''' repository

'''I need''' to harvest information from ORCID public profiles

'''So that I can''' populate item records with information

===Tier 2 (private) API connection===

'''As a''' repository connecting to ORCID through this system

'''I need''' to communicate with ORCID

'''So that I can''' authenticate ORCID IDs

'''As a''' researcher

'''I need''' to choose which permissions to give my institution

'''So that I can''' integrate my ORCID to meet my personal requirements

===End User===

'''As a''' third party harvesting from EPrints

'''I need''' ORCID IDs to be exported in all metadata formats, not just oai_dc

'''So that I can''' reuse the metadata in my system

==Requirements==

This table is designed to record requirements for ORCID plugin development. It shows the function, how you would test it is doing the intended job, how desirable it is for each level of integration and whether the information is suggested, proposed or agreed by the community.

At present, all these items are "Suggested" - a survey will be compiled from this and circulated to form a proposal, with a MoSCoW analysis for each item.

{| class="wikitable"
! Function !! Test !! No API !! Tier 1 API !! Tier 2 API !! End User !! Status
|-
|| Record ORCID ID against user || EPrints field (ideally named "orcid") available to record ORCID ID in User Profile || || || || || Suggested
|-
|| Record ORCID ID against creator || EPrints field (ideally named "orcid") available to record ORCID ID in EPrint record || || || || || Suggested
|-
|| Validate ORCID ID || ORCID ID validated (http://support.orcid.org/knowledgebase/articles/116780-structure-of-the-orcid-identifier) || || || || || Suggested
|-
|| Lookup ORCID ID || ORCID ID is included in name lookup || || || || || Suggested
|-
|| Display ORCID ID in User Profile || ORCID is rendered in User Profile || || || || || Suggested
|-
|| Display ORCID ID in EPrint abstract page || ORCID is rendered in EPrint abstract pages || || || || || Suggested
|-
|| Display ORCID ID in citation || ORCID is rendered in citation formats || || || || || Suggested
|-
|| Display ORCID ID in page metadata || ORCID is included in page metadata || || || || || Suggested
|-
|| Render ORCID as a link || ORCID is linked to ORCID profile where rendered || || || || || Suggested
|-
|| Enable depositors to import items from ORCID || Records can be imported from ORCID || || || || || Suggested
|-
|| Enable depositors to export items to ORCID || Records can be exported to ORCID || || || || || Suggested
|-
|| Enable administrators to import items from ORCID || Records can be imported from ORCID || || || || || Suggested
|-
|| Enable administrators to export items to ORCID || Records can be exported to ORCID || || || || || Suggested
|-
|| Include ORCID in export formats || All export formats include ORCID where supplied<ref>oai_dc does not support attributes on the 'people' elements (e.g. creator). Exposing ORCIDs via oai_dc is NOT a real option. An extension to oai_dc profile may need to be made!</ref> || || || || || Suggested
|}

<references/>

==Concerns==

===Compatibility===

* The plugin needs to be compatible with other standard plugins, e.g. Rioxx

* Known third-party systems being used to integrate with ORCID:
** Pure
** Oracle Database HR System

* Known third-party systems harvesting ORCID from EPrints:
** EThOS (uketd_dc format)

* Is there a need to include ORCID in the IRUS plugin?

ORCID connector

2016-07-05T11:58:38Z

E.jennings@bath.ac.uk: /* Requirements */

This page is intended to capture requirements for ORCID integrations, with a view to agreeing a community vision for EPrints development.

To see existing integrations, visit the [[ORCID]] page.

==Use Cases==

===No API connection===

'''As a''' repository connecting to ORCID through another system

'''I need''' a field to record ORCID IDs

'''So that I can''' display and link the ORCID ID to other systems

'''As a''' repository which records ORCID IDs

'''I need''' to render the ORCID as a link

'''So that I can''' display the ID in the recommended format

===Tier 1 (public) API connection===

'''As a''' repository

'''I need''' to harvest information from ORCID public profiles

'''So that I can''' populate item records with information

===Tier 2 (private) API connection===

'''As a''' repository connecting to ORCID through this system

'''I need''' to communicate with ORCID

'''So that I can''' authenticate ORCID IDs

'''As a''' researcher

'''I need''' to choose which permissions to give my institution

'''So that I can''' integrate my ORCID to meet my personal requirements

===End User===

'''As a''' third party harvesting from EPrints

'''I need''' ORCID IDs to be exported in all metadata formats, not just oai_dc

'''So that I can''' reuse the metadata in my system

==Requirements==

This table is designed to record requirements for ORCID plugin development. It shows the function, how you would test it is doing the intended job, how desirable it is for each level of integration and whether the information is suggested, proposed or agreed by the community.

At present, all these items are "Suggested" - a survey will be compiled from this and circulated to form a proposal, with a MoSCoW analysis for each item.

{| class="wikitable"
! Function !! Test !! No API !! Tier 1 API !! Tier 2 API !! End User !! Status
|-
|| Record ORCID ID against user || EPrints field (ideally named "orcid") available to record ORCID ID in User Profile || || || || || Suggested
|-
|| Record ORCID ID against creator || EPrints field (ideally named "orcid") available to record ORCID ID in EPrint record || || || || || Suggested
|-
|| Validate ORCID ID || ORCID ID validated (http://support.orcid.org/knowledgebase/articles/116780-structure-of-the-orcid-identifier) || || || || || Suggested
|-
|| Lookup ORCID ID || ORCID ID is included in name lookup || || || || || Suggested
|-
|| Display ORCID ID in User Profile || ORCID is rendered in User Profile || || || || || Suggested
|-
|| Display ORCID ID in EPrint abstract page || ORCID is rendered in EPrint abstract pages || || || || || Suggested
|-
|| Display ORCID ID in citation || ORCID is rendered in citation formats || || || || || Suggested
|-
|| Display ORCID ID in page metadata || ORCID is included in page metadata || || || || || Suggested
|-
|| Render ORCID as a link || ORCID is linked to ORCID profile where rendered || || || || || Suggested
|-
|| Enable depositors to import items from ORCID || Records can be imported from ORCID || || || || || Suggested
|-
|| Enable depositors to import items from ORCID || Records can be imported from ORCID || || || || || Suggested
|-
|| Enable administrators to import items from ORCID || Records can be imported from ORCID || || || || || Suggested
|-
|| Enable administrators to export items to ORCID || Records can be exported to ORCID || || || || || Suggested
|-
|| Include ORCID in export formats || All export formats include ORCID where supplied<ref>oai_dc does not support attributes on the 'people' elements (e.g. creator). Exposing ORCIDs via oai_dc is NOT a real option. An extension to oai_dc profile may need to be made!</ref> || || || || || Suggested
|}

<references/>

==Concerns==

===Compatibility===

* The plugin needs to be compatible with other standard plugins, e.g. Rioxx

* Known third-party systems being used to integrate with ORCID:
** Pure
** Oracle Database HR System

* Known third-party systems harvesting ORCID from EPrints:
** EThOS (uketd_dc format)

* Is there a need to include ORCID in the IRUS plugin?

ORCID

2016-07-04T16:17:03Z

E.jennings@bath.ac.uk: /* Add additional identifiers to creators */

This page has been created to gather information about how different EPrints repositories have integrated ORCID.
At this time (April 2016) there doesn't seem to be a 'best practice' approach that has been adopted widely - this will hopefully change over time.

If you are looking to retrieve publications from the ORCID service, the [http://bazaar.eprints.org/354/ Import from ORCID (Tier 1 API)] Bazaar package, or the [https://github.com/eprintsug/orcidt2 ORCID Tier 2 api framework] are good places to start.

2016-05-20 [[User:Alan.stiles@open.ac.uk|Alan Stiles]] at The Open University is working on a plugin to connect EPrints with ORCID via the Tier 2 Members API to retrieve ORCID ids and synchronise publications and affiliation details.

Some aspects that need to be considered when adopting ORCIDs, and making them available to other systems are:

* storing the ORCID (see: http://support.orcid.org/knowledgebase/articles/116780-structure-of-the-orcid-identifier)
* rendering the ORCID in abstract pages (see [http://support.orcid.org/knowledgebase/articles/116780-structure-of-the-orcid-identifier link above])
* exposing ORCIDs over OAI-PMH metadata profiles e.g. RIOXX

NB The examples below may refer to the 'creators' field - but the same approach could be used to extend other 'person' fields - e.g. contributors.

= Re-using creators.id subfield =

The creators.id field is labelled 'email' by default, but as it's an 'id' type field, it can be used to store ORCIDs.
To re-label the field, a simple addition to a phrase file in <code>archives/ARCHIVEID/cfg/lang/en/phrases/</code> needs to be made:
<source lang="xml">
<epp:phrase id="eprint_fieldname_creators_id">ORCID / Creators email (if known)</epp:phrase>
</source>

== Rendering the ORCID in a citation ==
The rendering of this field then needs to be changed to accommodate an author with an ORCID. The following script adds methods that can be called via the EPScript language:

<source lang="perl">
# add to e.g. ~/archives/ARCHIVEID/cfg/cfg.d/z_add_to_EPrints_Script_Compiled.pl
# Write into EPrints::Script::Compiled package to allow use of function in epscript
{
package EPrints::Script::Compiled;
use strict;

sub run_wrro_people_with_orcids
{
my( $self, $state, $value ) = @_;

my $session = $state->{session};
my $r = $state->{session}->make_doc_fragment;

my $creators = $value->[0];

foreach my $i (0..$#$creators){

my $creator = @$creators[$i];

if( $i > 0 ){
#not first item (or only one item)
if( $i == $#$creators ){
#last item
$r->appendChild( $session->make_text( " and " ) );
} else {
$r->appendChild( $session->make_text( ", " ) );
}
}

my $person_span = $session->make_element( "span", "class" => "person" );
$person_span->appendChild( $session->render_name( $creator->{name} ) );

my $id = $creator->{id};
if( defined $id && $id =~ m/^(?:orcid.org\/)?(\d{4}\-\d{4}\-\d{4}\-\d{3}(?:\d|X))$/ )
{
my $orcid_span = $session->make_element( "span", "class" => "orcid" );

# According to https://orcid.org/trademark-and-id-display-guidelines
# "recommended display is a hyperlinked URI preceded by the iD icon"
# This looks terrible in a citation. Removed for the time being.
#
# my $orcid_link = $session->make_element(
# "a",
# "href" => "http://orcid.org/",
# "target" => "_blank",
# "class" => "orcid-icon"
# );
# $orcid_link->appendChild( $session->make_element(
# "img",
# "src" => "/images/orcid_16x16.png",
# "title" => "ORCID"
# ) );
# $orcid_span->appendChild( $orcid_link );

my $link = $session->make_element(
"a",
"href" => "http://orcid.org/$1",
"target" => "_blank",
);
$link->appendChild( $session->make_text( "orcid.org/$1" ) );

$orcid_span->appendChild( $session->make_text( "(" ) );
$orcid_span->appendChild( $link );
$orcid_span->appendChild( $session->make_text( ")" ) );

$person_span->appendChild( $session->make_text( " " ) );
$person_span->appendChild( $orcid_span );
}
$r->appendChild( $person_span );
}

return [ $r, "XHTML" ];
}

}
# END EPrints::Script::Compiled additions
</source>

You may also want a bit of CSS to style ORCID links
<source lang="css">
/* Add to e.g. ~/archives/ARCHIVEID/cfg/static/style/auto/zzz_orcid.css */
.person:hover {border-bottom: 1px dashed #a6ce39;}
.orcid {}
.orcid a:hover {
color: #a6ce39;
}
.orcid-icon {}
.orcid-icon img { vertical-align: text-bottom; margin: 0 4px 0 2px; }
</source>

And finally, you have to call the new EPScript function from a citation file e.g. <code>archives/ARCHIVEID/cfg/citations/eprint/default.xml</code>
<source lang="xml">

<print expr="wrro_people_with_orcids(creators)" />
</source>

== Exposing the ORCID in RIOXX ==
Based on re-using the creators.id field, this block of code over-writes the default <code>rioxx2_value_author</code> function.
<source lang="perl">
# Add to e.g. ~/archives/ARCHIVEID/cfg/cfg.d/zzz_rioxx2_overwrites.pl
$c->{rioxx2_value_author} = sub {
my( $eprint ) = @_;

my @authors;
for( @{ $eprint->value( "creators" ) } )
{
my $id = $_->{id};
if( defined $id && $id =~ m/^(?:orcid.org\/)?(\d{4}\-\d{4}\-\d{4}\-\d{3}(?:\d|X))$/ )
{
push @authors, {
author => EPrints::Utils::make_name_string( $_->{name} ),
id => "http://orcid.org/$1"
};
} else {
push @authors, {
author => EPrints::Utils::make_name_string( $_->{name} ),
};
}
}

#NB If your corp_creators has DOIs or ISNIs for the entries, a similar method could be used to include these here.
foreach my $corp ( @{ $eprint->value( "corp_creators" ) } )
{
my $entry = {};
$entry->{name} = $corp;
push @authors, { author => $corp };
}

return \@authors;
};

</source>

= Add additional identifiers to creators =
Another approach to storing ORCIDs is to add an additional sub-field to the creator field.
This has been discussed on the Eprints tech list. If you know how to do this, please document it here!

This is how University of Bath has done it. We're getting the ORCID data from another system, so have used a text field to capture it for display. At present there is no special rendering on it, it's just displaying as a number.
<source lang="perl">
{
name => 'creators',
type => 'compound',
multiple => 1,
fields => [
{
sub_name => 'name',
type => 'name',
hide_honourific => 1,
hide_lineage => 1,
family_first => 1,
},
{
sub_name => 'id',
type => 'text',
input_cols => 20,
allow_null => 1,
},
{
sub_name => 'orcid',
type => 'text',
input_cols => 20,
allow_null => 1,
}

],
input_boxes => 4,
},
</source>
This is how University of Pittsburgh has done it:
<source lang="perl">
{
'name' => 'creators',
'type' => 'compound',
'multiple' => 1,
'fields' => [
{
'sub_name' => 'name',
'type' => 'name',
'hide_honourific' => 1,
'hide_lineage' => 1,
'family_first' => 1,
},
{
'sub_name' => 'email',
'type' => 'text',
'input_cols' => 20,
'allow_null' => 1,
},
{
'sub_name' => 'id',
'type' => 'text',
'input_cols' => 20,
'allow_null' => 1,
},
{
'sub_name' => 'orcid',
'type' => 'id',
'input_cols' => 19,
'allow_null' => 1,
},
],
'input_boxes' => 4,
'render_value' => 'custom_render_creators_with_orcid',
},

</source>

==Notes from Pittsburgh:==

We have added some ORCID functionality in our IR System here at the University of Pittsburgh. We however have not “linked” our IR with orcid.org in anyway such as we do not have a lookup user in ORCID or the ability to add publications from ORCID to our IR. The only link is the entering of the ORCID into the system so that it can be displayed.

An example record is available here: [http://d-scholarship.pitt.edu/28114/ http://d-scholarship.pitt.edu/28114/]

# Users have an ORCID field in their profile – user_fields.pl
# Any “Creator” types have an ORCID field added to the workflow – eprint_fields.pl
# We have added ORCID validation adhering to this document: [http://support.orcid.org/knowledgebase/articles/116780-structure-of-the-orcid-identifier] - eprint_validate.pl
# We have added the ORCID to the “lookup” function to populate the ORCID field. – cgi/users/lookup/name
# We display the ORCID as such on the input form, where the green icon links out to our own orcid.pitt.edu site, but could be to orcid.org by default.
# We display the ORCID as such on the public display of the record where the ORCID is linked out to orcid.org (see [http://d-scholarship.pitt.edu/28114/ example record])

(Information courtesy of Brian Gregg)

ORCID

2016-07-04T16:11:34Z

E.jennings@bath.ac.uk: /* Add additional identifiers to creators */

ORCID connector

2016-06-29T11:45:46Z

E.jennings@bath.ac.uk: /* Requirements */

This page is intended to capture requirements for ORCID integrations, with a view to agreeing a community vision for EPrints development.

To see existing integrations, visit the [[ORCID]] page.

==Use Cases==

===No API connection===

'''As a''' repository connecting to ORCID through another system

'''I need''' a field to record ORCID IDs

'''So that I can''' display and link the ORCID ID to other systems

'''As a''' repository which records ORCID IDs

'''I need''' to render the ORCID as a link

'''So that I can''' display the ID in the recommended format

===Tier 1 (public) API connection===

'''As a''' repository

'''I need''' to harvest information from ORCID public profiles

'''So that I can''' populate item records with information

===Tier 2 (private) API connection===

'''As a''' repository connecting to ORCID through this system

'''I need''' to communicate with ORCID

'''So that I can''' authenticate ORCID IDs

'''As a''' researcher

'''I need''' to choose which permissions to give my institution

'''So that I can''' integrate my ORCID to meet my personal requirements

===End User===

'''As a''' third party harvesting from EPrints

'''I need''' ORCID IDs to be exported in all metadata formats, not just oai_dc

'''So that I can''' reuse the metadata in my system

==Requirements==

This table is designed to record requirements for ORCID plugin development. It shows the function, how you would test it is doing the intended job, how desirable it is for each level of integration and whether the information is suggested, proposed or agreed by the community.

At present, all these items are "Suggested" - a survey will be compiled from this and circulated to form a proposal, with a MoSCoW analysis for each item.

{| class="wikitable"
! Function !! Test !! No API !! Tier 1 API !! Tier 2 API !! End User !! Status
|-
|| Record ORCID ID against user || EPrints field (ideally named "orcid") available to record ORCID ID in User Profile || || || || || Suggested
|-
|| Record ORCID ID against creator || EPrints field (ideally named "orcid") available to record ORCID ID in EPrint record || || || || || Suggested
|-
|| Validate ORCID ID || ORCID ID validated (http://support.orcid.org/knowledgebase/articles/116780-structure-of-the-orcid-identifier) || || || || || Suggested
|-
|| Lookup ORCID ID || ORCID ID is included in name lookup || || || || || Suggested
|-
|| Display ORCID ID in User Profile || ORCID is rendered in User Profile || || || || || Suggested
|-
|| Display ORCID ID in EPrint abstract page || ORCID is rendered in EPrint abstract pages || || || || || Suggested
|-
|| Display ORCID ID in citation || ORCID is rendered in citation formats || || || || || Suggested
|-
|| Display ORCID ID in page metadata || ORCID is included in page metadata || || || || || Suggested
|-
|| Render ORCID as a link || ORCID is linked to ORCID profile where rendered || || || || || Suggested
|-
|| Enable administrators to import items from ORCID || Records can be imported from ORCID || || || || || Suggested
|-
|| Enable administrators to export items to ORCID || Records can be exported to ORCID || || || || || Suggested
|-
|| Include ORCID in export formats || All export formats include ORCID where supplied<ref>oai_dc does not support attributes on the 'people' elements (e.g. creator). Exposing ORCIDs via oai_dc is NOT a real option. An extension to oai_dc profile may need to be made!</ref> || || || || || Suggested
|}

<references/>

==Concerns==

===Compatibility===

* The plugin needs to be compatible with other standard plugins, e.g. Rioxx

* Known third-party systems being used to integrate with ORCID:
** Pure
** Oracle Database HR System

* Known third-party systems harvesting ORCID from EPrints:
** EThOS (uketd_dc format)

* Is there a need to include ORCID in the IRUS plugin?

ORCID connector

2016-06-29T11:44:42Z

E.jennings@bath.ac.uk: /* Requirements */

This page is intended to capture requirements for ORCID integrations, with a view to agreeing a community vision for EPrints development.

To see existing integrations, visit the [[ORCID]] page.

==Use Cases==

===No API connection===

'''As a''' repository connecting to ORCID through another system

'''I need''' a field to record ORCID IDs

'''So that I can''' display and link the ORCID ID to other systems

'''As a''' repository which records ORCID IDs

'''I need''' to render the ORCID as a link

'''So that I can''' display the ID in the recommended format

===Tier 1 (public) API connection===

'''As a''' repository

'''I need''' to harvest information from ORCID public profiles

'''So that I can''' populate item records with information

===Tier 2 (private) API connection===

'''As a''' repository connecting to ORCID through this system

'''I need''' to communicate with ORCID

'''So that I can''' authenticate ORCID IDs

'''As a''' researcher

'''I need''' to choose which permissions to give my institution

'''So that I can''' integrate my ORCID to meet my personal requirements

===End User===

'''As a''' third party harvesting from EPrints

'''I need''' ORCID IDs to be exported in all metadata formats, not just oai_dc

'''So that I can''' reuse the metadata in my system

==Requirements==

This table is designed to record requirements for ORCID plugin development. It shows the function, how you would test it is doing the intended job, how desirable it is for each level of integration and whether the information is suggested, proposed or agreed by the community.

At present, all these items are "Suggested" - a survey will be compiled from this and circulated to form a proposal, with a MoSCoW analysis for each item.

{| class="wikitable"
! Function !! Test !! No API !! Tier 1 API !! Tier 2 API !! End User !! Status
|-
|| Record ORCID ID against user || EPrints field available to record ORCID ID in User Profile || || || || || Suggested
|-
|| Record ORCID ID against creator || EPrints field available to record ORCID ID in EPrint record || || || || || Suggested
|-
|| Validate ORCID ID || ORCID ID validated (http://support.orcid.org/knowledgebase/articles/116780-structure-of-the-orcid-identifier) || || || || || Suggested
|-
|| Lookup ORCID ID || ORCID ID is included in name lookup || || || || || Suggested
|-
|| Display ORCID ID in User Profile || ORCID is rendered in User Profile || || || || || Suggested
|-
|| Display ORCID ID in EPrint abstract page || ORCID is rendered in EPrint abstract pages || || || || || Suggested
|-
|| Display ORCID ID in citation || ORCID is rendered in citation formats || || || || || Suggested
|-
|| Display ORCID ID in page metadata || ORCID is included in page metadata || || || || || Suggested
|-
|| Render ORCID as a link || ORCID is linked to ORCID profile where rendered || || || || || Suggested
|-
|| Enable administrators to import items from ORCID || Records can be imported from ORCID || || || || || Suggested
|-
|| Enable administrators to export items to ORCID || Records can be exported to ORCID || || || || || Suggested
|-
|| Include ORCID in export formats || All export formats include ORCID where supplied<ref>oai_dc does not support attributes on the 'people' elements (e.g. creator). Exposing ORCIDs via oai_dc is NOT a real option. An extension to oai_dc profile may need to be made!</ref> || || || || || Suggested
|}

<references/>

==Concerns==

===Compatibility===

* The plugin needs to be compatible with other standard plugins, e.g. Rioxx

* Known third-party systems being used to integrate with ORCID:
** Pure
** Oracle Database HR System

* Known third-party systems harvesting ORCID from EPrints:
** EThOS (uketd_dc format)

* Is there a need to include ORCID in the IRUS plugin?

ORCID connector

2016-06-29T11:42:35Z

E.jennings@bath.ac.uk: /* Requirements */

This page is intended to capture requirements for ORCID integrations, with a view to agreeing a community vision for EPrints development.

To see existing integrations, visit the [[ORCID]] page.

==Use Cases==

===No API connection===

'''As a''' repository connecting to ORCID through another system

'''I need''' a field to record ORCID IDs

'''So that I can''' display and link the ORCID ID to other systems

'''As a''' repository which records ORCID IDs

'''I need''' to render the ORCID as a link

'''So that I can''' display the ID in the recommended format

===Tier 1 (public) API connection===

'''As a''' repository

'''I need''' to harvest information from ORCID public profiles

'''So that I can''' populate item records with information

===Tier 2 (private) API connection===

'''As a''' repository connecting to ORCID through this system

'''I need''' to communicate with ORCID

'''So that I can''' authenticate ORCID IDs

'''As a''' researcher

'''I need''' to choose which permissions to give my institution

'''So that I can''' integrate my ORCID to meet my personal requirements

===End User===

'''As a''' third party harvesting from EPrints

'''I need''' ORCID IDs to be exported in all metadata formats, not just oai_dc

'''So that I can''' reuse the metadata in my system

==Requirements==

This table is designed to record requirements for ORCID plugin development. It shows the function, how you would test it is doing the intended job, how desirable it is for each level of integration and whether the information is suggested, proposed or agreed by the community.

At present, all these items are "Suggested" - a survey will be compiled from this and circulated to form a proposal, with a MoSCoW analysis for each item.

{| class="wikitable"
! Function !! Test !! No API !! Tier 1 API !! Tier 2 API !! End User !! Status
|-
|| Record ORCID ID against user || EPrints field available to record ORCID ID in User Profile || || || || || Suggested
|-
|| Record ORCID ID against creator || EPrints field available to record ORCID ID in EPrint record || || || || || Suggested
|-
|| Validate ORCID ID || ORCID ID validated (http://support.orcid.org/knowledgebase/articles/116780-structure-of-the-orcid-identifier) || || || || || Suggested
|-
|| Display ORCID ID in User Profile || ORCID is rendered in User Profile || || || || || Suggested
|-
|| Display ORCID ID in EPrint abstract page || ORCID is rendered in EPrint abstract pages || || || || || Suggested
|-
|| Display ORCID ID in citation || ORCID is rendered in citation formats || || || || || Suggested
|-
|| Display ORCID ID in page metadata || ORCID is included in page metadata || || || || || Suggested
|-
|| Render ORCID as a link || ORCID is linked to ORCID profile where rendered || || || || || Suggested
|-
|| Enable administrators to import items from ORCID || Records can be imported from ORCID || || || || || Suggested
|-
|| Enable administrators to export items to ORCID || Records can be exported to ORCID || || || || || Suggested
|-
|| Include ORCID in export formats || All export formats include ORCID where supplied<ref>oai_dc does not support attributes on the 'people' elements (e.g. creator). Exposing ORCIDs via oai_dc is NOT a real option. An extension to oai_dc profile may need to be made!</ref> || || || || || Suggested
|}

<references/>

==Concerns==

===Compatibility===

* The plugin needs to be compatible with other standard plugins, e.g. Rioxx

* Known third-party systems being used to integrate with ORCID:
** Pure
** Oracle Database HR System

* Known third-party systems harvesting ORCID from EPrints:
** EThOS (uketd_dc format)

* Is there a need to include ORCID in the IRUS plugin?

ORCID connector

2016-06-29T11:39:13Z

E.jennings@bath.ac.uk: /* Requirements */

This page is intended to capture requirements for ORCID integrations, with a view to agreeing a community vision for EPrints development.

To see existing integrations, visit the [[ORCID]] page.

==Use Cases==

===No API connection===

'''As a''' repository connecting to ORCID through another system

'''I need''' a field to record ORCID IDs

'''So that I can''' display and link the ORCID ID to other systems

'''As a''' repository which records ORCID IDs

'''I need''' to render the ORCID as a link

'''So that I can''' display the ID in the recommended format

===Tier 1 (public) API connection===

'''As a''' repository

'''I need''' to harvest information from ORCID public profiles

'''So that I can''' populate item records with information

===Tier 2 (private) API connection===

'''As a''' repository connecting to ORCID through this system

'''I need''' to communicate with ORCID

'''So that I can''' authenticate ORCID IDs

'''As a''' researcher

'''I need''' to choose which permissions to give my institution

'''So that I can''' integrate my ORCID to meet my personal requirements

===End User===

'''As a''' third party harvesting from EPrints

'''I need''' ORCID IDs to be exported in all metadata formats, not just oai_dc

'''So that I can''' reuse the metadata in my system

==Requirements==

This table is designed to record requirements for ORCID plugin development. It shows the function, how you would test it is doing the intended job, how desirable it is for each level of integration and whether the information is suggested, proposed or agreed by the community.

At present, all these items are "Suggested" - a survey will be compiled from this and circulated to form a proposal, with a MoSCoW analysis for each item.

{| class="wikitable"
! Function !! Test !! No API !! Tier 1 API !! Tier 2 API !! End User !! Status
|-
|| Record ORCID ID against user || EPrints field available to record ORCID ID in User Profile || || || || || Suggested
|-
|| Record ORCID ID against creator || EPrints field available to record ORCID ID in EPrint record || || || || || Suggested
|-
|| Display ORCID ID in User Profile || ORCID is rendered in User Profile || || || || || Suggested
|-
|| Display ORCID ID in EPrint abstract page || ORCID is rendered in EPrint abstract pages || || || || || Suggested
|-
|| Display ORCID ID in citation || ORCID is rendered in citation formats || || || || || Suggested
|-
|| Display ORCID ID in page metadata || ORCID is included in page metadata || || || || || Suggested
|-
|| Render ORCID as a link || ORCID is linked to ORCID profile where rendered || || || || || Suggested
|-
|| Enable administrators to import items from ORCID || Records can be imported from ORCID || || || || || Suggested
|-
|| Enable administrators to export items to ORCID || Records can be exported to ORCID || || || || || Suggested
|-
|| Include ORCID in export formats || All export formats include ORCID where supplied<ref>oai_dc does not support attributes on the 'people' elements (e.g. creator). Exposing ORCIDs via oai_dc is NOT a real option. An extension to oai_dc profile may need to be made!</ref> || || || || || Suggested
|}

<references/>

==Concerns==

===Compatibility===

* The plugin needs to be compatible with other standard plugins, e.g. Rioxx

* Known third-party systems being used to integrate with ORCID:
** Pure
** Oracle Database HR System

* Known third-party systems harvesting ORCID from EPrints:
** EThOS (uketd_dc format)

* Is there a need to include ORCID in the IRUS plugin?

ORCID connector

2016-06-29T11:28:39Z

E.jennings@bath.ac.uk: /* Compatibility */

This page is intended to capture requirements for ORCID integrations, with a view to agreeing a community vision for EPrints development.

To see existing integrations, visit the [[ORCID]] page.

==Use Cases==

===No API connection===

'''As a''' repository connecting to ORCID through another system

'''I need''' a field to record ORCID IDs

'''So that I can''' display and link the ORCID ID to other systems

'''As a''' repository which records ORCID IDs

'''I need''' to render the ORCID as a link

'''So that I can''' display the ID in the recommended format

===Tier 1 (public) API connection===

'''As a''' repository

'''I need''' to harvest information from ORCID public profiles

'''So that I can''' populate item records with information

===Tier 2 (private) API connection===

'''As a''' repository connecting to ORCID through this system

'''I need''' to communicate with ORCID

'''So that I can''' authenticate ORCID IDs

'''As a''' researcher

'''I need''' to choose which permissions to give my institution

'''So that I can''' integrate my ORCID to meet my personal requirements

===End User===

'''As a''' third party harvesting from EPrints

'''I need''' ORCID IDs to be exported in all metadata formats, not just oai_dc

'''So that I can''' reuse the metadata in my system

==Requirements==

This table is designed to record requirements for ORCID plugin development. It shows the function, how you would test it is doing the intended job, how desirable it is for each level of integration and whether the information is suggested, proposed or agreed by the community.

At present, all these items are "Suggested" - a survey will be compiled from this and circulated to form a proposal, with a MoSCoW analysis for each item.

{| class="wikitable"
! Function !! Test !! No API !! Tier 1 API !! Tier 2 API !! End User !! Status
|-
|| Record ORCID ID against user || EPrints field available to record ORCID ID in User Profile || || || || || Suggested
|-
|| Record ORCID ID against creator || EPrints field available to record ORCID ID in EPrint record || || || || || Suggested
|-
|| Display ORCID ID in User Profile || ORCID is rendered in User Profile || || || || || Suggested
|-
|| Display ORCID ID in EPrint abstract page || ORCID is rendered in EPrint abstract pages || || || || || Suggested
|-
|| Display ORCID ID in citation || ORCID is rendered in citation formats || || || || || Suggested
|-
|| Display ORCID ID in page metadata || ORCID is included in page metadata || || || || || Suggested
|-
|| Enable administrators to import items from ORCID || Records can be imported from ORCID || || || || || Suggested
|-
|| Enable administrators to export items to ORCID || Records can be exported to ORCID || || || || || Suggested
|-
|| Include ORCID in export formats || All export formats include ORCID where supplied<ref>oai_dc does not support attributes on the 'people' elements (e.g. creator). Exposing ORCIDs via oai_dc is NOT a real option. An extension to oai_dc profile may need to be made!</ref> || || || || || Suggested
|}

<references/>

==Concerns==

===Compatibility===

* The plugin needs to be compatible with other standard plugins, e.g. Rioxx

* Known third-party systems being used to integrate with ORCID:
** Pure
** Oracle Database HR System

* Known third-party systems harvesting ORCID from EPrints:
** EThOS (uketd_dc format)

* Is there a need to include ORCID in the IRUS plugin?

ORCID connector

2016-06-29T11:22:08Z

E.jennings@bath.ac.uk: /* Compatibility */

This page is intended to capture requirements for ORCID integrations, with a view to agreeing a community vision for EPrints development.

To see existing integrations, visit the [[ORCID]] page.

==Use Cases==

===No API connection===

'''As a''' repository connecting to ORCID through another system

'''I need''' a field to record ORCID IDs

'''So that I can''' display and link the ORCID ID to other systems

'''As a''' repository which records ORCID IDs

'''I need''' to render the ORCID as a link

'''So that I can''' display the ID in the recommended format

===Tier 1 (public) API connection===

'''As a''' repository

'''I need''' to harvest information from ORCID public profiles

'''So that I can''' populate item records with information

===Tier 2 (private) API connection===

'''As a''' repository connecting to ORCID through this system

'''I need''' to communicate with ORCID

'''So that I can''' authenticate ORCID IDs

'''As a''' researcher

'''I need''' to choose which permissions to give my institution

'''So that I can''' integrate my ORCID to meet my personal requirements

===End User===

'''As a''' third party harvesting from EPrints

'''I need''' ORCID IDs to be exported in all metadata formats, not just oai_dc

'''So that I can''' reuse the metadata in my system

==Requirements==

This table is designed to record requirements for ORCID plugin development. It shows the function, how you would test it is doing the intended job, how desirable it is for each level of integration and whether the information is suggested, proposed or agreed by the community.

At present, all these items are "Suggested" - a survey will be compiled from this and circulated to form a proposal, with a MoSCoW analysis for each item.

{| class="wikitable"
! Function !! Test !! No API !! Tier 1 API !! Tier 2 API !! End User !! Status
|-
|| Record ORCID ID against user || EPrints field available to record ORCID ID in User Profile || || || || || Suggested
|-
|| Record ORCID ID against creator || EPrints field available to record ORCID ID in EPrint record || || || || || Suggested
|-
|| Display ORCID ID in User Profile || ORCID is rendered in User Profile || || || || || Suggested
|-
|| Display ORCID ID in EPrint abstract page || ORCID is rendered in EPrint abstract pages || || || || || Suggested
|-
|| Display ORCID ID in citation || ORCID is rendered in citation formats || || || || || Suggested
|-
|| Display ORCID ID in page metadata || ORCID is included in page metadata || || || || || Suggested
|-
|| Enable administrators to import items from ORCID || Records can be imported from ORCID || || || || || Suggested
|-
|| Enable administrators to export items to ORCID || Records can be exported to ORCID || || || || || Suggested
|-
|| Include ORCID in export formats || All export formats include ORCID where supplied<ref>oai_dc does not support attributes on the 'people' elements (e.g. creator). Exposing ORCIDs via oai_dc is NOT a real option. An extension to oai_dc profile may need to be made!</ref> || || || || || Suggested
|}

<references/>

==Concerns==

===Compatibility===

* The plugin needs to be compatible with other standard plugins, e.g. Rioxx

* Known third-party systems being used to integrate with ORCID:
** Pure
** Oracle Database HR System

* Is there a need to include ORCID in the IRUS plugin?

ORCID connector

2016-06-29T11:21:28Z

E.jennings@bath.ac.uk: /* Requirements */

This page is intended to capture requirements for ORCID integrations, with a view to agreeing a community vision for EPrints development.

To see existing integrations, visit the [[ORCID]] page.

==Use Cases==

===No API connection===

'''As a''' repository connecting to ORCID through another system

'''I need''' a field to record ORCID IDs

'''So that I can''' display and link the ORCID ID to other systems

'''As a''' repository which records ORCID IDs

'''I need''' to render the ORCID as a link

'''So that I can''' display the ID in the recommended format

===Tier 1 (public) API connection===

'''As a''' repository

'''I need''' to harvest information from ORCID public profiles

'''So that I can''' populate item records with information

===Tier 2 (private) API connection===

'''As a''' repository connecting to ORCID through this system

'''I need''' to communicate with ORCID

'''So that I can''' authenticate ORCID IDs

'''As a''' researcher

'''I need''' to choose which permissions to give my institution

'''So that I can''' integrate my ORCID to meet my personal requirements

===End User===

'''As a''' third party harvesting from EPrints

'''I need''' ORCID IDs to be exported in all metadata formats, not just oai_dc

'''So that I can''' reuse the metadata in my system

==Requirements==

This table is designed to record requirements for ORCID plugin development. It shows the function, how you would test it is doing the intended job, how desirable it is for each level of integration and whether the information is suggested, proposed or agreed by the community.

At present, all these items are "Suggested" - a survey will be compiled from this and circulated to form a proposal, with a MoSCoW analysis for each item.

{| class="wikitable"
! Function !! Test !! No API !! Tier 1 API !! Tier 2 API !! End User !! Status
|-
|| Record ORCID ID against user || EPrints field available to record ORCID ID in User Profile || || || || || Suggested
|-
|| Record ORCID ID against creator || EPrints field available to record ORCID ID in EPrint record || || || || || Suggested
|-
|| Display ORCID ID in User Profile || ORCID is rendered in User Profile || || || || || Suggested
|-
|| Display ORCID ID in EPrint abstract page || ORCID is rendered in EPrint abstract pages || || || || || Suggested
|-
|| Display ORCID ID in citation || ORCID is rendered in citation formats || || || || || Suggested
|-
|| Display ORCID ID in page metadata || ORCID is included in page metadata || || || || || Suggested
|-
|| Enable administrators to import items from ORCID || Records can be imported from ORCID || || || || || Suggested
|-
|| Enable administrators to export items to ORCID || Records can be exported to ORCID || || || || || Suggested
|-
|| Include ORCID in export formats || All export formats include ORCID where supplied<ref>oai_dc does not support attributes on the 'people' elements (e.g. creator). Exposing ORCIDs via oai_dc is NOT a real option. An extension to oai_dc profile may need to be made!</ref> || || || || || Suggested
|}

<references/>

==Concerns==

===Compatibility===

* The plugin needs to be compatible with other standard plugins, e.g. Rioxx

* Known third-party systems being used to integrate with ORCID:
** Pure
** Oracle Database HR System

ORCID connector

2016-06-29T10:59:26Z

E.jennings@bath.ac.uk:

This page is intended to capture requirements for ORCID integrations, with a view to agreeing a community vision for EPrints development.

To see existing integrations, visit the [[ORCID]] page.

==Use Cases==

===No API connection===

'''As a''' repository connecting to ORCID through another system

'''I need''' a field to record ORCID IDs

'''So that I can''' display and link the ORCID ID to other systems

'''As a''' repository which records ORCID IDs

'''I need''' to render the ORCID as a link

'''So that I can''' display the ID in the recommended format

===Tier 1 (public) API connection===

'''As a''' repository

'''I need''' to harvest information from ORCID public profiles

'''So that I can''' populate item records with information

===Tier 2 (private) API connection===

'''As a''' repository connecting to ORCID through this system

'''I need''' to communicate with ORCID

'''So that I can''' authenticate ORCID IDs

'''As a''' researcher

'''I need''' to choose which permissions to give my institution

'''So that I can''' integrate my ORCID to meet my personal requirements

===End User===

'''As a''' third party harvesting from EPrints

'''I need''' ORCID IDs to be exported in all metadata formats, not just oai_dc

'''So that I can''' reuse the metadata in my system

==Requirements==

This table is designed to record requirements for ORCID plugin development. It shows the function, how you would test it is doing the intended job, how desirable it is for each level of integration and whether the information is suggested, proposed or agreed by the community.

At present, all these items are "Suggested" - a survey will be compiled from this and circulated to form a proposal, with a MoSCoW analysis for each item.

{| class="wikitable"
! Function !! Test !! No API !! Tier 1 API !! Tier 2 API !! End User !! Status
|-
|| Record ORCID ID against user || EPrints field available to record ORCID ID in User Profile || || || || || Suggested
|-
|| Record ORCID ID against creator || EPrints field available to record ORCID ID in EPrint record || || || || || Suggested
|-
|| Display ORCID ID in User Profile || ORCID is rendered in User Profile || || || || || Suggested
|-
|| Display ORCID ID in EPrint abstract page || ORCID is rendered EPrint abstract pages || || || || || Suggested
|-
|| Enable administrators to import items from ORCID || Records can be imported from ORCID || || || || || Suggested
|-
|| Enable administrators to export items to ORCID || Records can be exported to ORCID || || || || || Suggested
|-
|| Include ORCID in export formats || All export formats include ORCID where supplied<ref>oai_dc does not support attributes on the 'people' elements (e.g. creator). Exposing ORCIDs via oai_dc is NOT a real option. An extension to oai_dc profile may need to be made!</ref> || || || || || Suggested
|}

<references/>

==Concerns==

===Compatibility===

* The plugin needs to be compatible with other standard plugins, e.g. Rioxx

* Known third-party systems being used to integrate with ORCID:
** Pure
** Oracle Database HR System

User:E.jennings@bath.ac.uk

2016-06-20T10:47:00Z

E.jennings@bath.ac.uk: Created page with "Technical Data Officer at University of Bath"

Technical Data Officer at University of Bath

ORCID connector

2016-06-09T16:05:14Z

E.jennings@bath.ac.uk:

ORCID connector

2016-06-09T16:00:22Z

E.jennings@bath.ac.uk: /* Requirements */

==Use Cases==

===No API connection===

'''As a''' repository connecting to ORCID through another system

'''I need''' a field to record ORCID IDs

'''So that I can''' display and link the ORCID ID to other systems

'''As a''' repository which records ORCID IDs

'''I need''' to render the ORCID as a link

'''So that I can''' display the ID in the recommended format

===Tier 1 (public) API connection===

'''As a''' repository

'''I need''' to harvest information from ORCID public profiles

'''So that I can''' populate item records with information

===Tier 2 (private) API connection===

'''As a''' repository connecting to ORCID through this system

'''I need''' to communicate with ORCID

'''So that I can''' authenticate ORCID IDs

'''As a''' researcher

'''I need''' to choose which permissions to give my institution

'''So that I can''' integrate my ORCID to meet my personal requirements

===End User===

'''As a''' third party harvesting from EPrints

'''I need''' ORCID IDs to be exported in all metadata formats, not just oai_dc

'''So that I can''' reuse the metadata in my system

==Requirements==

This table is designed to record requirements for ORCID plugin development. It shows the function, how you would test it is doing the intended job, how desirable it is for each level of integration and whether the information is suggested, proposed or agreed by the community.

At present, all these items are "Suggested" - a survey will be compiled from this and circulated to form a proposal, with a MoSCoW analysis for each item.

{| class="wikitable"
! Function !! Test !! No API !! Tier 1 API !! Tier 2 API !! End User !! Status
|-
|| Record ORCID ID against user || EPrints field available to record ORCID ID in User Profile || || || || || Suggested
|-
|| Record ORCID ID against creator || EPrints field available to record ORCID ID in EPrint record || || || || || Suggested
|-
|| Display ORCID ID in User Profile || ORCID is rendered in User Profile || || || || || Suggested
|-
|| Display ORCID ID in EPrint abstract page || ORCID is rendered EPrint abstract pages || || || || || Suggested
|-
|| Enable administrators to import items from ORCID || Records can be imported from ORCID || || || || || Suggested
|-
|| Enable administrators to export items to ORCID || Records can be exported to ORCID || || || || || Suggested
|-
|| Include ORCID in export formats || All export formats include ORCID where supplied || || || || || Suggested
|}

==Concerns==

===Compatibility===

* The plugin needs to be compatible with other standard plugins, e.g. Rioxx

ORCID connector

2016-06-09T15:55:04Z

E.jennings@bath.ac.uk: /* Requirements */

==Use Cases==

===No API connection===

'''As a''' repository connecting to ORCID through another system

'''I need''' a field to record ORCID IDs

'''So that I can''' display and link the ORCID ID to other systems

'''As a''' repository which records ORCID IDs

'''I need''' to render the ORCID as a link

'''So that I can''' display the ID in the recommended format

===Tier 1 (public) API connection===

'''As a''' repository

'''I need''' to harvest information from ORCID public profiles

'''So that I can''' populate item records with information

===Tier 2 (private) API connection===

'''As a''' repository connecting to ORCID through this system

'''I need''' to communicate with ORCID

'''So that I can''' authenticate ORCID IDs

'''As a''' researcher

'''I need''' to choose which permissions to give my institution

'''So that I can''' integrate my ORCID to meet my personal requirements

===End User===

'''As a''' third party harvesting from EPrints

'''I need''' ORCID IDs to be exported in all metadata formats, not just oai_dc

'''So that I can''' reuse the metadata in my system

==Requirements==

This table is designed to record requirements for ORCID plugin development. It shows the function, how you would test it is doing the intended job, how desirable it is for each level of integration and whether the information is suggested, proposed or agreed by the community.

{| class="wikitable"
! Function !! Test !! No API !! Tier 1 API !! Tier 2 API !! End User !! Status
|-
|| Record ORCID ID against user || EPrints field available to record ORCID ID in User Profile || Could || Could || Must || - || Suggested
|-
|| Record ORCID ID against creator || EPrints field available to record ORCID ID in EPrint record || Must || Should || Should || - || Suggested
|-
|| Display ORCID ID in User Profile || ORCID is rendered in User Profile || Could || Could || Should || Could || Suggested
|-
|| Display ORCID ID in EPrint abstract page || ORCID is rendered EPrint abstract pages || Should || Should || Should || Should || Suggested
|-
|| Enable administrators to import items from ORCID || Records can be imported from ORCID || Won't || Must || Should || - || Suggested
|-
|| Enable administrators to export items to ORCID || Records can be exported to ORCID || Won't || Won't || Should || - || Suggested
|-
|| Include ORCID in export formats || All export formats include ORCID where supplied || Should || Should || Should || Must || Suggested
|}

==Concerns==

===Compatibility===

* The plugin needs to be compatible with other standard plugins, e.g. Rioxx

ORCID connector

2016-06-09T15:53:20Z

E.jennings@bath.ac.uk: /* Requirements */

==Use Cases==

===No API connection===

'''As a''' repository connecting to ORCID through another system

'''I need''' a field to record ORCID IDs

'''So that I can''' display and link the ORCID ID to other systems

'''As a''' repository which records ORCID IDs

'''I need''' to render the ORCID as a link

'''So that I can''' display the ID in the recommended format

===Tier 1 (public) API connection===

'''As a''' repository

'''I need''' to harvest information from ORCID public profiles

'''So that I can''' populate item records with information

===Tier 2 (private) API connection===

'''As a''' repository connecting to ORCID through this system

'''I need''' to communicate with ORCID

'''So that I can''' authenticate ORCID IDs

'''As a''' researcher

'''I need''' to choose which permissions to give my institution

'''So that I can''' integrate my ORCID to meet my personal requirements

===End User===

'''As a''' third party harvesting from EPrints

'''I need''' ORCID IDs to be exported in all metadata formats, not just oai_dc

'''So that I can''' reuse the metadata in my system

==Requirements==

This table is designed to record requirements for ORCID plugin development. It shows the function, how you would test it is doing the intended job, how desirable it is for each level of integration and whether the information is suggested, proposed or agreed by the community.

{| class="wikitable"
! Function !! Test !! No API !! Tier 1 API !! Tier 2 API !! Status
|-
|| Record ORCID ID against user || EPrints field available to record ORCID ID in User Profile || Could || Could || Must || Suggested
|-
|| Record ORCID ID against creator || EPrints field available to record ORCID ID in EPrint record || Must || Should || Should || Suggested
|-
|| Display ORCID ID in User Profile || ORCID is rendered in User Profile || Could || Could || Should || Suggested
|-
|| Display ORCID ID in EPrint abstract page || ORCID is rendered EPrint abstract pages || Should || Should || Should || Suggested
|-
|| Enable administrators to import items from ORCID || Records can be imported from ORCID || Won't || Must || Should || Suggested
|-
|| Enable administrators to export items to ORCID || Records can be exported to ORCID || Won't || Won't || Should || Suggested
|-
|| Include ORCID in export formats || All export formats include ORCID where supplied || Should || Should || Should || Suggested
|}

==Concerns==

===Compatibility===

* The plugin needs to be compatible with other standard plugins, e.g. Rioxx

ORCID connector

2016-06-09T14:19:51Z

E.jennings@bath.ac.uk: /* Requirements */

==Use Cases==

===No API connection===

'''As a''' repository connecting to ORCID through another system

'''I need''' a field to record ORCID IDs

'''So that I can''' display and link the ORCID ID to other systems

'''As a''' repository which records ORCID IDs

'''I need''' to render the ORCID as a link

'''So that I can''' display the ID in the recommended format

===Tier 1 (public) API connection===

'''As a''' repository

'''I need''' to harvest information from ORCID public profiles

'''So that I can''' populate item records with information

===Tier 2 (private) API connection===

'''As a''' repository connecting to ORCID through this system

'''I need''' to communicate with ORCID

'''So that I can''' authenticate ORCID IDs

'''As a''' researcher

'''I need''' to choose which permissions to give my institution

'''So that I can''' integrate my ORCID to meet my personal requirements

===End User===

'''As a''' third party harvesting from EPrints

'''I need''' ORCID IDs to be exported in all metadata formats, not just oai_dc

'''So that I can''' reuse the metadata in my system

==Requirements==

This table is designed to record requirements for ORCID plugin development. It shows the function, how you would test it is doing the intended job, how desirable it is for each level of integration and whether the information is suggested, proposed or agreed by the community.

{| class="wikitable"
! Function !! Test !! No API !! Tier 1 API !! Tier 2 API !! Status
|-
|| Record ORCID ID against user || EPrints field available to record ORCID ID in User Profile || Could || Could || Must || Suggested
|-
|| Record ORCID ID against creator || EPrints field available to record ORCID ID in EPrint record || Must || Should || Should || Suggested
|-
|| Display ORCID ID in User Profile || ORCID is rendered in User Profile || Could || Could || Should || Suggested
|-
|| Display ORCID ID in EPrint abstract page || ORCID is rendered EPrint abstract pages || Should || Should || Should || Suggested
|-
|| Enable administrators to import items from ORCID || Records can be imported from ORCID || Won't || Must || Should || Suggested
|-
|| Enable administrators to export items to ORCID || Records can be exported to ORCID || Won't || Won't || Should || Suggested
|}

==Concerns==

===Compatibility===

* The plugin needs to be compatible with other standard plugins, e.g. Rioxx

ORCID connector

2016-06-09T14:16:31Z

E.jennings@bath.ac.uk:

==Use Cases==

===No API connection===

'''As a''' repository connecting to ORCID through another system

'''I need''' a field to record ORCID IDs

'''So that I can''' display and link the ORCID ID to other systems

'''As a''' repository which records ORCID IDs

'''I need''' to render the ORCID as a link

'''So that I can''' display the ID in the recommended format

===Tier 1 (public) API connection===

'''As a''' repository

'''I need''' to harvest information from ORCID public profiles

'''So that I can''' populate item records with information

===Tier 2 (private) API connection===

'''As a''' repository connecting to ORCID through this system

'''I need''' to communicate with ORCID

'''So that I can''' authenticate ORCID IDs

'''As a''' researcher

'''I need''' to choose which permissions to give my institution

'''So that I can''' integrate my ORCID to meet my personal requirements

===End User===

'''As a''' third party harvesting from EPrints

'''I need''' ORCID IDs to be exported in all metadata formats, not just oai_dc

'''So that I can''' reuse the metadata in my system

==Requirements==

This table is designed to record requirements for ORCID plugin development. It shows the function, how you would test it is doing the intended job, how desirable it is for each level of integration and whether the information is suggested, proposed or agreed by the community.

{| class="wikitable"
! Function !! Test !! No API !! Tier 1 API !! Tier 2 API !! Status
|-
|| Record ORCID ID against user || EPrints field available to record ORCID ID in User Profile || Could || Could || Must || Suggested
|-
|| Record ORCID ID against creator || EPrints field available to record ORCID ID in EPrint record || Must || Should || Should || Suggested
|-
|| Display ORCID ID against user || EPrints field available and render method available to display ORCID ID in User Profile || Could || Could || Should || Suggested
|-
|| Record ORCID ID against creator || EPrints field available and render method available to display ORCID ID in EPrint record || Should || Should || Should || Suggested

|}

==Concerns==

===Compatibility===

* The plugin needs to be compatible with other standard plugins, e.g. Rioxx

ORCID connector

2016-06-09T11:26:00Z

E.jennings@bath.ac.uk:

ORCID connector

2016-06-09T10:55:35Z

E.jennings@bath.ac.uk:

==Use Cases==

===No API connection===

'''As a''' repository connecting to ORCID through another system

'''I need''' a field to record ORCID IDs

'''So that I can''' display and link the ORCID ID to other systems

===Tier 1 (public) API connection===

'''As a''' repository

'''I need''' to harvest information from ORCID public profiles

'''So that I can''' populate item records with information

===Tier 2 (private) API connection===

'''As a''' repository connecting to ORCID through this system

'''I need''' to communicate with ORCID

'''So that I can''' authenticate ORCID IDs

'''As a''' researcher

'''I need''' to choose which permissions to give my institution

'''So that I can''' integrate my ORCID to meet my personal requirements

===End User===

'''As a''' third party harvesting from EPrints

'''I need''' ORCID IDs to be exported in all metadata formats, not just oai_dc

'''So that I can''' reuse the metadata in my system

==Requirements==

This table is designed to record requirements for ORCID plugin development. It shows the function, how you would test it is doing the intended job, how desirable it is for each level of integration and whether the information is suggested, proposed or agreed by the community.

{| class="wikitable"
! Function !! Test !! No API !! Tier 1 API !! Tier 2 API !! Status
|-
|| Record ORCID ID against user || EPrints field available to record and / or display ORCID ID in User Profile || Could || Could || Must || Suggested
|-
|| Record ORCID ID against creator || EPrints field available to record and / or display ORCID ID in EPrint record || Must || Should || Should || Suggested
|}

ORCID connector

2016-05-25T15:45:40Z

E.jennings@bath.ac.uk: Created page with "==Use Cases== ===No API connection=== '''As a''' repository connecting to ORCID through another system '''I need''' a field to record ORCID IDs '''So that I can''' display..."

==Use Cases==

===No API connection===

'''As a''' repository connecting to ORCID through another system

'''I need''' a field to record ORCID IDs

'''So that I can''' display and link the ORCID ID to other systems

===Tier 1 (public) API connection===

'''As a''' repository

'''I need''' to harvest information from ORCID public profiles

'''So that I can''' populate item records with information

===Tier 2 (private) API connection===

'''As a''' repository connecting to ORCID through this system

'''I need''' to communicate with ORCID

'''So that I can''' authenticate ORCID IDs

'''As a''' researcher

'''I need''' to choose which permissions to give my institution

'''So that I can''' integrate my ORCID to meet my personal requirements

==Requirements==

This table is designed to record requirements for ORCID plugin development. It shows the function, how you would test it is doing the intended job, how desirable it is for each level of integration and whether the information is suggested, proposed or agreed by the community.

{| class="wikitable"
! Function !! Test !! No API !! Tier 1 API !! Tier 2 API !! Status
|-
|| Record ORCID ID against user || EPrints field available to record and / or display ORCID ID in User Profile || Could || Could || Must || Suggested
|-
|| Record ORCID ID against creator || EPrints field available to record and / or display ORCID ID in EPrint record || Must || Should || Should || Suggested
|}

ORCID

2016-05-20T11:37:04Z

E.jennings@bath.ac.uk: /* Add additional identifiers to creators */

This page has been created to gather information about how different EPrints repositories have integrated ORCID.
At this time (April 2016) there doesn't seem to be a 'best practice' approach that has been adopted widely - this will hopefully change over time.

If you are looking to retrieve publications from the ORCID service, the [http://bazaar.eprints.org/354/ Import from ORCID (Tier 1 API)] Bazaar package, or the [https://github.com/eprintsug/orcidt2 ORCID Tier 2 api framework] are good places to start.

Some aspects that need to be considered when adopting ORCIDs, and making them available to other systems are:

* storing the ORCID (see: http://support.orcid.org/knowledgebase/articles/116780-structure-of-the-orcid-identifier)
* rendering the ORCID in abstract pages (see [http://support.orcid.org/knowledgebase/articles/116780-structure-of-the-orcid-identifier link above])
* exposing ORCIDs over OAI-PMH metadata profiles e.g. RIOXX

NB The examples below may refer to the 'creators' field - but the same approach could be used to extend other 'person' fields - e.g. contributors.

= Re-using creators.id subfield =

The creators.id field is labelled 'email' by default, but as it's an 'id' type field, it can be used to store ORCIDs.
To re-label the field, a simple addition to a phrase file in <code>archives/ARCHIVEID/cfg/lang/en/phrases/</code> needs to be made:
<source lang="xml">
<epp:phrase id="eprint_fieldname_creators_id">ORCID / Creators email (if known)</epp:phrase>
</source>

== Rendering the ORCID in a citation ==
The rendering of this field then needs to be changed to accommodate an author with an ORCID. The following script adds methods that can be called via the EPScript language:

<source lang="perl">
# add to e.g. ~/archives/ARCHIVEID/cfg/cfg.d/z_add_to_EPrints_Script_Compiled.pl
# Write into EPrints::Script::Compiled package to allow use of function in epscript
{
package EPrints::Script::Compiled;
use strict;

sub run_wrro_people_with_orcids
{
my( $self, $state, $value ) = @_;

my $session = $state->{session};
my $r = $state->{session}->make_doc_fragment;

my $creators = $value->[0];

foreach my $i (0..$#$creators){

my $creator = @$creators[$i];

if( $i > 0 ){
#not first item (or only one item)
if( $i == $#$creators ){
#last item
$r->appendChild( $session->make_text( " and " ) );
} else {
$r->appendChild( $session->make_text( ", " ) );
}
}

my $person_span = $session->make_element( "span", "class" => "person" );
$person_span->appendChild( $session->render_name( $creator->{name} ) );

my $id = $creator->{id};
if( defined $id && $id =~ m/^(?:orcid.org\/)?(\d{4}\-\d{4}\-\d{4}\-\d{3}(?:\d|X))$/ )
{
my $orcid_span = $session->make_element( "span", "class" => "orcid" );

# According to https://orcid.org/trademark-and-id-display-guidelines
# "recommended display is a hyperlinked URI preceded by the iD icon"
# This looks terrible in a citation. Removed for the time being.
#
# my $orcid_link = $session->make_element(
# "a",
# "href" => "http://orcid.org/",
# "target" => "_blank",
# "class" => "orcid-icon"
# );
# $orcid_link->appendChild( $session->make_element(
# "img",
# "src" => "/images/orcid_16x16.png",
# "title" => "ORCID"
# ) );
# $orcid_span->appendChild( $orcid_link );

my $link = $session->make_element(
"a",
"href" => "http://orcid.org/$1",
"target" => "_blank",
);
$link->appendChild( $session->make_text( "orcid.org/$1" ) );

$orcid_span->appendChild( $session->make_text( "(" ) );
$orcid_span->appendChild( $link );
$orcid_span->appendChild( $session->make_text( ")" ) );

$person_span->appendChild( $session->make_text( " " ) );
$person_span->appendChild( $orcid_span );
}
$r->appendChild( $person_span );
}

return [ $r, "XHTML" ];
}

}
# END EPrints::Script::Compiled additions
</source>

You may also want a bit of CSS to style ORCID links
<source lang="css">
/* Add to e.g. ~/archives/ARCHIVEID/cfg/static/style/auto/zzz_orcid.css */
.person:hover {border-bottom: 1px dashed #a6ce39;}
.orcid {}
.orcid a:hover {
color: #a6ce39;
}
.orcid-icon {}
.orcid-icon img { vertical-align: text-bottom; margin: 0 4px 0 2px; }
</source>

And finally, you have to call the new EPScript function from a citation file e.g. <code>archives/ARCHIVEID/cfg/citations/eprint/default.xml</code>
<source lang="xml">

<print expr="wrro_people_with_orcids(creators)" />
</source>

== Exposing the ORCID in RIOXX ==
Based on re-using the creators.id field, this block of code over-writes the default <code>rioxx2_value_author</code> function.
<source lang="perl">
# Add to e.g. ~/archives/ARCHIVEID/cfg/cfg.d/zzz_rioxx2_overwrites.pl
$c->{rioxx2_value_author} = sub {
my( $eprint ) = @_;

my @authors;
for( @{ $eprint->value( "creators" ) } )
{
my $id = $_->{id};
if( defined $id && $id =~ m/^(?:orcid.org\/)?(\d{4}\-\d{4}\-\d{4}\-\d{3}(?:\d|X))$/ )
{
push @authors, {
author => EPrints::Utils::make_name_string( $_->{name} ),
id => "http://orcid.org/$1"
};
} else {
push @authors, {
author => EPrints::Utils::make_name_string( $_->{name} ),
};
}
}

#NB If your corp_creators has DOIs or ISNIs for the entries, a similar method could be used to include these here.
foreach my $corp ( @{ $eprint->value( "corp_creators" ) } )
{
my $entry = {};
$entry->{name} = $corp;
push @authors, { author => $corp };
}

return \@authors;
};

</source>

= Add additional identifiers to creators =
Another approach to storing ORCIDs is to add an additional sub-field to the creator field.
This has been discussed on the Eprints tech list. If you know how to do this, please document it here!

This is how University of Bath has done it. We're getting the ORCID data from another system, so have used a text field to capture it for display. At present there is no special rendering on it, it's just displaying as a number.
<source lang="perl">
{
name => 'creators',
type => 'compound',
multiple => 1,
fields => [
{
sub_name => 'name',
type => 'name',
hide_honourific => 1,
hide_lineage => 1,
family_first => 1,
},
{
sub_name => 'id',
type => 'text',
input_cols => 20,
allow_null => 1,
},
{
sub_name => 'orcid',
type => 'text',
input_cols => 20,
allow_null => 1,
}

],
input_boxes => 4,
},
</source>

ORCID

2016-05-20T11:35:46Z

E.jennings@bath.ac.uk: /* Add additional identifiers to creators */

This page has been created to gather information about how different EPrints repositories have integrated ORCID.
At this time (April 2016) there doesn't seem to be a 'best practice' approach that has been adopted widely - this will hopefully change over time.

If you are looking to retrieve publications from the ORCID service, the [http://bazaar.eprints.org/354/ Import from ORCID (Tier 1 API)] Bazaar package, or the [https://github.com/eprintsug/orcidt2 ORCID Tier 2 api framework] are good places to start.

Some aspects that need to be considered when adopting ORCIDs, and making them available to other systems are:

* storing the ORCID (see: http://support.orcid.org/knowledgebase/articles/116780-structure-of-the-orcid-identifier)
* rendering the ORCID in abstract pages (see [http://support.orcid.org/knowledgebase/articles/116780-structure-of-the-orcid-identifier link above])
* exposing ORCIDs over OAI-PMH metadata profiles e.g. RIOXX

NB The examples below may refer to the 'creators' field - but the same approach could be used to extend other 'person' fields - e.g. contributors.

= Re-using creators.id subfield =

The creators.id field is labelled 'email' by default, but as it's an 'id' type field, it can be used to store ORCIDs.
To re-label the field, a simple addition to a phrase file in <code>archives/ARCHIVEID/cfg/lang/en/phrases/</code> needs to be made:
<source lang="xml">
<epp:phrase id="eprint_fieldname_creators_id">ORCID / Creators email (if known)</epp:phrase>
</source>

== Rendering the ORCID in a citation ==
The rendering of this field then needs to be changed to accommodate an author with an ORCID. The following script adds methods that can be called via the EPScript language:

<source lang="perl">
# add to e.g. ~/archives/ARCHIVEID/cfg/cfg.d/z_add_to_EPrints_Script_Compiled.pl
# Write into EPrints::Script::Compiled package to allow use of function in epscript
{
package EPrints::Script::Compiled;
use strict;

sub run_wrro_people_with_orcids
{
my( $self, $state, $value ) = @_;

my $session = $state->{session};
my $r = $state->{session}->make_doc_fragment;

my $creators = $value->[0];

foreach my $i (0..$#$creators){

my $creator = @$creators[$i];

if( $i > 0 ){
#not first item (or only one item)
if( $i == $#$creators ){
#last item
$r->appendChild( $session->make_text( " and " ) );
} else {
$r->appendChild( $session->make_text( ", " ) );
}
}

my $person_span = $session->make_element( "span", "class" => "person" );
$person_span->appendChild( $session->render_name( $creator->{name} ) );

my $id = $creator->{id};
if( defined $id && $id =~ m/^(?:orcid.org\/)?(\d{4}\-\d{4}\-\d{4}\-\d{3}(?:\d|X))$/ )
{
my $orcid_span = $session->make_element( "span", "class" => "orcid" );

# According to https://orcid.org/trademark-and-id-display-guidelines
# "recommended display is a hyperlinked URI preceded by the iD icon"
# This looks terrible in a citation. Removed for the time being.
#
# my $orcid_link = $session->make_element(
# "a",
# "href" => "http://orcid.org/",
# "target" => "_blank",
# "class" => "orcid-icon"
# );
# $orcid_link->appendChild( $session->make_element(
# "img",
# "src" => "/images/orcid_16x16.png",
# "title" => "ORCID"
# ) );
# $orcid_span->appendChild( $orcid_link );

my $link = $session->make_element(
"a",
"href" => "http://orcid.org/$1",
"target" => "_blank",
);
$link->appendChild( $session->make_text( "orcid.org/$1" ) );

$orcid_span->appendChild( $session->make_text( "(" ) );
$orcid_span->appendChild( $link );
$orcid_span->appendChild( $session->make_text( ")" ) );

$person_span->appendChild( $session->make_text( " " ) );
$person_span->appendChild( $orcid_span );
}
$r->appendChild( $person_span );
}

return [ $r, "XHTML" ];
}

}
# END EPrints::Script::Compiled additions
</source>

You may also want a bit of CSS to style ORCID links
<source lang="css">
/* Add to e.g. ~/archives/ARCHIVEID/cfg/static/style/auto/zzz_orcid.css */
.person:hover {border-bottom: 1px dashed #a6ce39;}
.orcid {}
.orcid a:hover {
color: #a6ce39;
}
.orcid-icon {}
.orcid-icon img { vertical-align: text-bottom; margin: 0 4px 0 2px; }
</source>

And finally, you have to call the new EPScript function from a citation file e.g. <code>archives/ARCHIVEID/cfg/citations/eprint/default.xml</code>
<source lang="xml">

<print expr="wrro_people_with_orcids(creators)" />
</source>

== Exposing the ORCID in RIOXX ==
Based on re-using the creators.id field, this block of code over-writes the default <code>rioxx2_value_author</code> function.
<source lang="perl">
# Add to e.g. ~/archives/ARCHIVEID/cfg/cfg.d/zzz_rioxx2_overwrites.pl
$c->{rioxx2_value_author} = sub {
my( $eprint ) = @_;

my @authors;
for( @{ $eprint->value( "creators" ) } )
{
my $id = $_->{id};
if( defined $id && $id =~ m/^(?:orcid.org\/)?(\d{4}\-\d{4}\-\d{4}\-\d{3}(?:\d|X))$/ )
{
push @authors, {
author => EPrints::Utils::make_name_string( $_->{name} ),
id => "http://orcid.org/$1"
};
} else {
push @authors, {
author => EPrints::Utils::make_name_string( $_->{name} ),
};
}
}

#NB If your corp_creators has DOIs or ISNIs for the entries, a similar method could be used to include these here.
foreach my $corp ( @{ $eprint->value( "corp_creators" ) } )
{
my $entry = {};
$entry->{name} = $corp;
push @authors, { author => $corp };
}

return \@authors;
};

</source>

= Add additional identifiers to creators =
Another approach to storing ORCIDs is to add an additional sub-field to the creator field.
This has been discussed on the Eprints tech list. If you know how to do this, please document it here!
<source lang="perl">
{
name => 'creators',
type => 'compound',
multiple => 1,
fields => [
{
sub_name => 'name',
type => 'name',
hide_honourific => 1,
hide_lineage => 1,
family_first => 1,
},
{
sub_name => 'id',
type => 'text',
input_cols => 20,
allow_null => 1,
},
{
sub_name => 'orcid',
type => 'text',
input_cols => 20,
allow_null => 1,
}

],
input_boxes => 4,
},
</source>

Training Video:Search Troubleshooting

2016-01-11T17:07:29Z

E.jennings@bath.ac.uk: /* Test Yourself */

[[Category:Howto]]
[[Category:Training_Video|Search Troubleshooting]]

==Introduction==

A walkthrough of some common issues with search in EPrints, including checking and starting the indexer, and reindexing the repository.

==What You Will Learn==

* How to identify search errors
* How to troubleshoot simple issues as an administrator
* How to investigate and resolve more complex issues as a system administrator

==What You Should Already Know==

'''To identify errors, check status and start the indexer (basic)'''
* Familiarity with EPrints Admin interface

'''To resolve other search issues (advanced)'''
* Familiarity with command line interface for EPrints tools
* Familiarity with MySQL

==Resources==

=== Video===
The Video can be found at [http://youtu.be/iIRB7HeSHek http://youtu.be/iIRB7HeSHek].

====Index====
* [http://youtu.be/iIRB7HeSHek?t=0m14s 00:14 Identifying problems in searches]
* [http://youtu.be/iIRB7HeSHek?t=0m46s 00:46 Comparing number of items in browse with number returned in search]
* [http://youtu.be/iIRB7HeSHek?t=0m57s 00:57 Checking the search indexer]
* [http://youtu.be/iIRB7HeSHek?t=1m10s 01:10 Indexer Status screen - list of pending tasks]
* [http://youtu.be/iIRB7HeSHek?t=2m02s 02:02 Starting the indexer]
* [http://youtu.be/iIRB7HeSHek?t=2m38s 02:38 Checking for items not showing even after indexer has run]
* [http://youtu.be/iIRB7HeSHek?t=3m11s 03:11 Reindexing an item]
* [http://youtu.be/iIRB7HeSHek?t=3m17s 03:17 Finding the /bin directory]
* [http://youtu.be/iIRB7HeSHek?t=3m55s 03:55 Finding the epadmin command]
* [http://youtu.be/iIRB7HeSHek?t=4m06s 04:06 Operations available to the epadmin command]
* [http://youtu.be/iIRB7HeSHek?t=4m26s 04:26 Accessing detailed help for a command]
* [http://youtu.be/iIRB7HeSHek?t=4m53s 04:53 Reindexing the whole repository]
* [http://youtu.be/iIRB7HeSHek?t=6m10s 06:10 Investigating in the database]
* [http://youtu.be/iIRB7HeSHek?t=7m06s 07:06 Showing index tables]
* [http://youtu.be/iIRB7HeSHek?t=7m39s 07:39 Viewing index for specific eprint]
* [http://youtu.be/iIRB7HeSHek?t=9m06s 09:06 Normalised values]

==== The Video====
<youtube>iIRB7HeSHek</youtube>

====Notes, Errata and Additional Information====

* EPrints 3.3.14
* Ubuntu 15.04

==Test Yourself==

On a test repository:

* Check the status of the indexer. Stop the indexer.

* Create a new EPrint and deposit it. Move it to the repository, and search to check that it doesn't appear.

* Check the status of the indexer to see the outstanding indexer tasks. Start the indexer.

* Search for the item to ensure it is now indexed.

==More Reading==

Training Video:Technical Orientation

2016-01-11T16:31:39Z

E.jennings@bath.ac.uk: /* Introduction */

[[Category:Howto]]
[[Category:Training_Video|Technical Orientation]]

==Introduction==

This video will explain what EPrints configuration files are and where to find them. It explains some of the most commonly changed files, and is an ideal start for working with EPrints at the back end.

==What You Will Learn==

* Where to find the main configuration files in EPrints using the command line
* How EPrints configuration files are structured
* How to make local changes safely

==What You Should Already Know==

* Basic Linux command line interface
* EPrints as a user and admin

==Resources==

=== Video===
The Video can be found at [http://youtu.be/-D4hEsRB0g4 http://youtu.be/-D4hEsRB0g4].

====Index====

* [http://youtu.be/-D4hEsRB0g4?t=0m00s 0:00 Introduction to the topics in the video]
* [http://youtu.be/-D4hEsRB0g4?t=0m25s 0:25 Where is EPrints installed? (Ubuntu / Debian style)]
* [http://youtu.be/-D4hEsRB0g4?t=0m36s 0:36 Using the Apache configuration file to find EPrints]
* [http://youtu.be/-D4hEsRB0g4?t=2m05s 2:05 What is EPrints? (as a system)]
* [http://youtu.be/-D4hEsRB0g4?t=2m17s 2:17 Finding the database (default file)]
* [http://youtu.be/-D4hEsRB0g4?t=2m40s 2:40 Checking for overrides to the default file]
* [http://youtu.be/-D4hEsRB0g4?t=3m40s 3:40 Looking at the database]
* [http://youtu.be/-D4hEsRB0g4?t=3m57s 3:57 Listing tables in the database]
* [http://youtu.be/-D4hEsRB0g4?t=4m05s 4:05 The EPrint table (non-multiple fields)]
* [http://youtu.be/-D4hEsRB0g4?t=4m21s 4:21 Finding tables holding multiple fields]
* [http://youtu.be/-D4hEsRB0g4?t=6m06s 6:06 The cfg.d directory]
* [http://youtu.be/-D4hEsRB0g4?t=6m25s 6:25 Simple and complex configurations]
* [http://youtu.be/-D4hEsRB0g4?t=7m13s 7:13 eprint_render.pl - changing abstract pages]
* [http://youtu.be/-D4hEsRB0g4?t=7m35s 7:35 views.pl - changing browse views]
* [http://youtu.be/-D4hEsRB0g4?t=7m45s 7:45 Best practice for customising configuration settings]
* [http://youtu.be/-D4hEsRB0g4?t=8m20s 8:20 Adding a new field in a new configuration file]
* [http://youtu.be/-D4hEsRB0g4?t=9m15s 9:15 Using diff to check local configuration files against default configuration files]
* [http://youtu.be/-D4hEsRB0g4?t=10m00s 10:00 Benefits of using separate files when upgrading]
* [http://youtu.be/-D4hEsRB0g4?t=10m21s 10:21 The /bin directory]
* [http://youtu.be/-D4hEsRB0g4?t=10m35s 10:35 epadmin - some common functions]
* [http://youtu.be/-D4hEsRB0g4?t=11m25s 11:25 Default configuration files for a new archive]
* [http://youtu.be/-D4hEsRB0g4?t=11m53s 11:53 Global (all archives) settings in the /lib directory]
* [http://youtu.be/-D4hEsRB0g4?t=12m37s 12:37 Overriding global configurations for an archive (Templates example)]
* [http://youtu.be/-D4hEsRB0g4?t=14m51s 14:51 Reloading the repository to show changes]
* [http://youtu.be/-D4hEsRB0g4?t=15m28s 15:28 Making changes to phrases (displayed text)]
* [http://youtu.be/-D4hEsRB0g4?t=17m35s 17:35 The /archives directory]
* [http://youtu.be/-D4hEsRB0g4?t=17m53s 17:53 Inside an archive directory]
* [http://youtu.be/-D4hEsRB0g4?t=18m03s 18:03 The archive /documents directory]
* [http://youtu.be/-D4hEsRB0g4?t=24m01s 24:01 Finding the documents for a specific EPrint]
* [http://youtu.be/-D4hEsRB0g4?t=26m00s 26:00 System generated documents (previews)]
* [http://youtu.be/-D4hEsRB0g4?t=26m23s 26:23 History of an EPrint - Revision files in the /revisions directory]
* [http://youtu.be/-D4hEsRB0g4?t=27m04s 27:04 Static files in /html]
* [http://youtu.be/-D4hEsRB0g4?t=28m41s 28:41 Static files in /cfg/lang/[en]/static and cfg/static]
* [http://youtu.be/-D4hEsRB0g4?t=31m12s 31:12 Running generate_static to refresh html pages (and --prune option to remove)]
* [http://youtu.be/-D4hEsRB0g4?t=31m57s 31:57 Citations - where to find them]
* [http://youtu.be/-D4hEsRB0g4?t=32m30s 32:30 Plugins - where to find them]
* [http://youtu.be/-D4hEsRB0g4?t=34m06s 34:06 Plugins - where to create a directory for Archive-specific plugins]

==== The Video====
<youtube>-D4hEsRB0g4</youtube>

====Notes, Errata and Additional Information====

Any notes, version information, errata, etc concerned with this video

* EPrints 3.3.14
* Ubuntu 15.04

==Test Yourself==

Exercises as appropriate to allow the learner to practice the subject of the page.

* Locate the home directory of your EPrints installation using Apache configuration files.

* Find the name of the database in the default file. Check it hasn't been overridden by another configuration file.

* Find the cfg.d folder for an archive. Compare it to the defaultcfg/cfg.d folder

* Create a static page in the /lang/en/static folder (or whichever language your archive is in)

* Change a phrase by adding a copy to the local.xml file.

==More Reading==

* For more details on specific configuration tasks, see the [[:Category:Training_Video|Training Course]] sections on Configuring EPrints and Maintaining and Developing EPrints.

Training Video:Technical Orientation

2016-01-11T15:28:57Z

E.jennings@bath.ac.uk:

[[Category:Howto]]
[[Category:Training_Video|Technical Orientation]]

==Introduction==

Prose: Why should you watch this video, what is the purpose in EPrints of the thing that you’re learning?

==What You Will Learn==

* Where to find the main configuration files in EPrints using the command line
* How EPrints configuration files are structured
* How to make local changes safely

==What You Should Already Know==

* Basic Linux command line interface
* EPrints as a user and admin

==Resources==

=== Video===
The Video can be found at [http://youtu.be/-D4hEsRB0g4 http://youtu.be/-D4hEsRB0g4].

====Index====

* [http://youtu.be/-D4hEsRB0g4?t=0m00s 0:00 Introduction to the topics in the video]
* [http://youtu.be/-D4hEsRB0g4?t=0m25s 0:25 Where is EPrints installed? (Ubuntu / Debian style)]
* [http://youtu.be/-D4hEsRB0g4?t=0m36s 0:36 Using the Apache configuration file to find EPrints]
* [http://youtu.be/-D4hEsRB0g4?t=2m05s 2:05 What is EPrints? (as a system)]
* [http://youtu.be/-D4hEsRB0g4?t=2m17s 2:17 Finding the database (default file)]
* [http://youtu.be/-D4hEsRB0g4?t=2m40s 2:40 Checking for overrides to the default file]
* [http://youtu.be/-D4hEsRB0g4?t=3m40s 3:40 Looking at the database]
* [http://youtu.be/-D4hEsRB0g4?t=3m57s 3:57 Listing tables in the database]
* [http://youtu.be/-D4hEsRB0g4?t=4m05s 4:05 The EPrint table (non-multiple fields)]
* [http://youtu.be/-D4hEsRB0g4?t=4m21s 4:21 Finding tables holding multiple fields]
* [http://youtu.be/-D4hEsRB0g4?t=6m06s 6:06 The cfg.d directory]
* [http://youtu.be/-D4hEsRB0g4?t=6m25s 6:25 Simple and complex configurations]
* [http://youtu.be/-D4hEsRB0g4?t=7m13s 7:13 eprint_render.pl - changing abstract pages]
* [http://youtu.be/-D4hEsRB0g4?t=7m35s 7:35 views.pl - changing browse views]
* [http://youtu.be/-D4hEsRB0g4?t=7m45s 7:45 Best practice for customising configuration settings]
* [http://youtu.be/-D4hEsRB0g4?t=8m20s 8:20 Adding a new field in a new configuration file]
* [http://youtu.be/-D4hEsRB0g4?t=9m15s 9:15 Using diff to check local configuration files against default configuration files]
* [http://youtu.be/-D4hEsRB0g4?t=10m00s 10:00 Benefits of using separate files when upgrading]
* [http://youtu.be/-D4hEsRB0g4?t=10m21s 10:21 The /bin directory]
* [http://youtu.be/-D4hEsRB0g4?t=10m35s 10:35 epadmin - some common functions]
* [http://youtu.be/-D4hEsRB0g4?t=11m25s 11:25 Default configuration files for a new archive]
* [http://youtu.be/-D4hEsRB0g4?t=11m53s 11:53 Global (all archives) settings in the /lib directory]
* [http://youtu.be/-D4hEsRB0g4?t=12m37s 12:37 Overriding global configurations for an archive (Templates example)]
* [http://youtu.be/-D4hEsRB0g4?t=14m51s 14:51 Reloading the repository to show changes]
* [http://youtu.be/-D4hEsRB0g4?t=15m28s 15:28 Making changes to phrases (displayed text)]
* [http://youtu.be/-D4hEsRB0g4?t=17m35s 17:35 The /archives directory]
* [http://youtu.be/-D4hEsRB0g4?t=17m53s 17:53 Inside an archive directory]
* [http://youtu.be/-D4hEsRB0g4?t=18m03s 18:03 The archive /documents directory]
* [http://youtu.be/-D4hEsRB0g4?t=24m01s 24:01 Finding the documents for a specific EPrint]
* [http://youtu.be/-D4hEsRB0g4?t=26m00s 26:00 System generated documents (previews)]
* [http://youtu.be/-D4hEsRB0g4?t=26m23s 26:23 History of an EPrint - Revision files in the /revisions directory]
* [http://youtu.be/-D4hEsRB0g4?t=27m04s 27:04 Static files in /html]
* [http://youtu.be/-D4hEsRB0g4?t=28m41s 28:41 Static files in /cfg/lang/[en]/static and cfg/static]
* [http://youtu.be/-D4hEsRB0g4?t=31m12s 31:12 Running generate_static to refresh html pages (and --prune option to remove)]
* [http://youtu.be/-D4hEsRB0g4?t=31m57s 31:57 Citations - where to find them]
* [http://youtu.be/-D4hEsRB0g4?t=32m30s 32:30 Plugins - where to find them]
* [http://youtu.be/-D4hEsRB0g4?t=34m06s 34:06 Plugins - where to create a directory for Archive-specific plugins]

==== The Video====
<youtube>-D4hEsRB0g4</youtube>

====Notes, Errata and Additional Information====

Any notes, version information, errata, etc concerned with this video

* EPrints 3.3.14
* Ubuntu 15.04

==Test Yourself==

Exercises as appropriate to allow the learner to practice the subject of the page.

* Locate the home directory of your EPrints installation using Apache configuration files.

* Find the name of the database in the default file. Check it hasn't been overridden by another configuration file.

* Find the cfg.d folder for an archive. Compare it to the defaultcfg/cfg.d folder

* Create a static page in the /lang/en/static folder (or whichever language your archive is in)

* Change a phrase by adding a copy to the local.xml file.

==More Reading==

* For more details on specific configuration tasks, see the [[:Category:Training_Video|Training Course]] sections on Configuring EPrints and Maintaining and Developing EPrints.

Training Video:Technical Orientation

2016-01-11T15:00:13Z

E.jennings@bath.ac.uk: /* Index */

[[Category:Howto]]
[[Category:Training_Video|Technical Orientation]]

==Introduction==

Prose: Why should you watch this video, what is the purpose in EPrints of the thing that you’re learning?

==What You Will Learn==

* Learning Objective 1
* Learning Objective 2
* Learning Objective 3

==What You Should Already Know==

* Prerequisite 1 with links if appropriate
* Prerequisite 2 with links if appropriate
* Prerequisite 3 with links if appropriate

==Resources==

=== Video===
The Video can be found at [http://youtu.be/-D4hEsRB0g4 http://youtu.be/-D4hEsRB0g4].
====Index====

0:00 Introduction to the topics in the video
0:25 Where is EPrints installed? (Ubuntu / Debian style)
0:36 Using the Apache configuration file to find EPrints
2:05 What is EPrints? (as a system)
2:17 Finding the database (default file)
2:40 Checking for overrides to the default file
3:40 Looking at the database
3:57 Listing tables in the database
4:05 The EPrint table (non-multiple fields)
4:21 Finding tables holding multiple fields
6:06 The cfg.d directory
6:25 Simple and complex configurations
7:13 eprint_render.pl - changing abstract pages
7:35 views.pl - changing browse views
7:45 Best practice for customising configuration settings
8:20 Adding a new field in a new configuration file
9:15 Using diff to check local configuration files against default configuration files
10:00 Benefits of using separate files when upgrading
10:21 The /bin directory
10:35 epadmin - some common functions
11:25 Default configuration files for a new archive
11:53 Global (all archives) settings in the /lib directory
12:37 Overriding global configurations for an archive (Templates example)
14:51 Reloading the repository to show changes
15:28 Making changes to phrases (displayed text)
17:35 The /archives directory
17:53 Inside an archive directory
18:03 The archive /documents directory
24:01 Finding the documents for a specific EPrint
26:00 System generated documents (previews)
26:23 History of an EPrint - Revision files in the /revisions directory
27:04 Static files in /html
28:41 Static files in /cfg/lang/[en]/static and cfg/static
31:12 Running generate_static to refresh html pages (and --prune option to remove)
31:57 Citations - where to find them
32:30 Plugins - where to find them
34:06 Plugins - where to create a directory for Archive-specific plugins

==== The Video====
<youtube>-D4hEsRB0g4</youtube>

====Notes, Errata and Additional Information====

Any notes, version information, errata, etc concerned with this video

* EPrints 3.3.14
* Ubuntu 15.04

==Test Yourself==

Exercises as appropriate to allow the learner to practice the subject of the page.

* Locate the home directory of your EPrints installation using Apache configuration files.

* Find the name of the database in the default file. Check it hasn't been overridden by another configuration file.

==More Reading==

* Wiki page 1
* Wiki page 2
* Wiki page 3

Training Video:Technical Orientation

2016-01-11T12:47:18Z

E.jennings@bath.ac.uk: /* Test Yourself */

[[Category:Howto]]
[[Category:Training_Video|Technical Orientation]]

==Introduction==

Prose: Why should you watch this video, what is the purpose in EPrints of the thing that you’re learning?

==What You Will Learn==

* Learning Objective 1
* Learning Objective 2
* Learning Objective 3

==What You Should Already Know==

* Prerequisite 1 with links if appropriate
* Prerequisite 2 with links if appropriate
* Prerequisite 3 with links if appropriate

==Resources==

=== Video===
The Video can be found at [http://youtu.be/-D4hEsRB0g4 http://youtu.be/-D4hEsRB0g4].
====Index====

==== The Video====
<youtube>-D4hEsRB0g4</youtube>

====Notes, Errata and Additional Information====

Any notes, version information, errata, etc concerned with this video

* EPrints 3.3.14
* Ubuntu 15.04

==Test Yourself==

Exercises as appropriate to allow the learner to practice the subject of the page.

* Locate the home directory of your EPrints installation using Apache configuration files.

* Find the name of the database in the default file. Check it hasn't been overridden by another configuration file.

==More Reading==

* Wiki page 1
* Wiki page 2
* Wiki page 3

Training Video:Technical Orientation

2016-01-11T12:40:20Z

E.jennings@bath.ac.uk: /* Test Yourself */

[[Category:Howto]]
[[Category:Training_Video|Technical Orientation]]

==Introduction==

Prose: Why should you watch this video, what is the purpose in EPrints of the thing that you’re learning?

==What You Will Learn==

* Learning Objective 1
* Learning Objective 2
* Learning Objective 3

==What You Should Already Know==

* Prerequisite 1 with links if appropriate
* Prerequisite 2 with links if appropriate
* Prerequisite 3 with links if appropriate

==Resources==

=== Video===
The Video can be found at [http://youtu.be/-D4hEsRB0g4 http://youtu.be/-D4hEsRB0g4].
====Index====

==== The Video====
<youtube>-D4hEsRB0g4</youtube>

====Notes, Errata and Additional Information====

Any notes, version information, errata, etc concerned with this video

* EPrints 3.3.14
* Ubuntu 15.04

==Test Yourself==

Exercises as appropriate to allow the learner to practice the subject of the page.

* Locate the home directory of your EPrints installation using Apache configuration files.

==More Reading==

* Wiki page 1
* Wiki page 2
* Wiki page 3

Training Video:Setting up SSL

2015-12-09T10:00:29Z

E.jennings@bath.ac.uk: Created page with "Category:Howto Template ==Introduction== Prose: Why should you watch this video, what is the purpose in EPrints of the thing that you’re le..."

[[Category:Howto]]
[[Category:Training_Video|Template]]

==Introduction==

Prose: Why should you watch this video, what is the purpose in EPrints of the thing that you’re learning?

==What You Will Learn==

* Learning Objective 1
* Learning Objective 2
* Learning Objective 3

==What You Should Already Know==

* Prerequisite 1 with links if appropriate
* Prerequisite 2 with links if appropriate
* Prerequisite 3 with links if appropriate

==Resources==

Each resource on this page (video, document, block of wiki text) should have a similar format to the Video section below.

=== Video===
The Video can be found at [http://youtu.be/KzrS_u-4eoM http://youtu.be/KzrS_u-4eoM].
====Index====
* [http://youtu.be/KzrS_u-4eoM?t=0m00s 0:00 - Installation context]
* [http://youtu.be/KzrS_u-4eoM?t=0m30s 0:30 - Documentation]
* [http://youtu.be/KzrS_u-4eoM?t=0m49s 0:49 - Adding apt repositories]
* [http://youtu.be/KzrS_u-4eoM?t=1m28s 1:28 - Installing using apt-get]
* [http://youtu.be/KzrS_u-4eoM?t=2m44s 2:44 - Setting MySQL root password]
* [http://youtu.be/KzrS_u-4eoM?t=4m10s 4:10 - Setting a hostname in the hosts file (local DNS)]
* [http://youtu.be/KzrS_u-4eoM?t=5m34s 5:34 - Create a repository]
* [http://youtu.be/KzrS_u-4eoM?t=8m08s 8:08 - Enabling EPrints in apache]
* [http://youtu.be/KzrS_u-4eoM?t=8m30s 8:30 - Restarting Apache]
* [http://youtu.be/KzrS_u-4eoM?t=9m02s 9:02 - Verifying the repository is running]
* [http://youtu.be/KzrS_u-4eoM?t=10m18s 10:18 - Import test records]
* [http://youtu.be/KzrS_u-4eoM?t=11m45s 11:45 - Regenerating browse views]
* [http://youtu.be/KzrS_u-4eoM?t=11m56s 11:56 - Verify browse views, export and abstract page, fulltext download]
* [http://youtu.be/KzrS_u-4eoM?t=12m40s 12:40 - Set up nightly jobs (crontab)]
* [http://youtu.be/KzrS_u-4eoM?t=16m08s 16:08 - Verifying crontab commands]

==== The Video====
<youtube>KzrS_u-4eoM</youtube>

====Notes, Errata and Additional Information====

Any notes, version information, errata, etc concerned with this video

* EPrints 3.3.14
* Ubuntu 15.04

==Test Yourself==

Exercises as appropriate to allow the learner to practice the subject of the page.

==More Reading==

* Wiki page 1
* Wiki page 2
* Wiki page 3

Training Video:Search Troubleshooting

2015-11-18T17:59:57Z

E.jennings@bath.ac.uk:

[[Category:Howto]]
[[Category:Training_Video|Search Troubleshooting]]

==Introduction==

A walkthrough of some common issues with search in EPrints, including checking and starting the indexer, and reindexing the repository.

==What You Will Learn==

* How to identify search errors
* How to troubleshoot simple issues as an administrator
* How to investigate and resolve more complex issues as a system administrator

==What You Should Already Know==

'''To identify errors, check status and start the indexer (basic)'''
* Familiarity with EPrints Admin interface

'''To resolve other search issues (advanced)'''
* Familiarity with command line interface for EPrints tools
* Familiarity with MySQL

==Resources==

Each resource on this page (video, document, block of wiki text) should have a similar format to the Video section below.

=== Video===
The Video can be found at [http://youtu.be/iIRB7HeSHek http://youtu.be/iIRB7HeSHek].

====Index====
* [http://youtu.be/iIRB7HeSHek?t=0m14s 00:14 Identifying problems in searches]
* [http://youtu.be/iIRB7HeSHek?t=0m46s 00:46 Comparing number of items in browse with number returned in search]
* [http://youtu.be/iIRB7HeSHek?t=0m57s 00:57 Checking the search indexer]
* [http://youtu.be/iIRB7HeSHek?t=1m10s 01:10 Indexer Status screen - list of pending tasks]
* [http://youtu.be/iIRB7HeSHek?t=2m02s 02:02 Starting the indexer]
* [http://youtu.be/iIRB7HeSHek?t=2m38s 02:38 Checking for items not showing even after indexer has run]
* [http://youtu.be/iIRB7HeSHek?t=3m11s 03:11 Reindexing an item]
* [http://youtu.be/iIRB7HeSHek?t=3m17s 03:17 Finding the /bin directory]
* [http://youtu.be/iIRB7HeSHek?t=3m55s 03:55 Finding the epadmin command]
* [http://youtu.be/iIRB7HeSHek?t=4m06s 04:06 Operations available to the epadmin command]
* [http://youtu.be/iIRB7HeSHek?t=4m26s 04:26 Accessing detailed help for a command]
* [http://youtu.be/iIRB7HeSHek?t=4m53s 04:53 Reindexing the whole repository]
* [http://youtu.be/iIRB7HeSHek?t=6m10s 06:10 Investigating in the database]
* [http://youtu.be/iIRB7HeSHek?t=7m06s 07:06 Showing index tables]
* [http://youtu.be/iIRB7HeSHek?t=7m39s 07:39 Viewing index for specific eprint]
* [http://youtu.be/iIRB7HeSHek?t=9m06s 09:06 Normalised values]

==== The Video====
<youtube>iIRB7HeSHek</youtube>

====Notes, Errata and Additional Information====

Any notes, version information, errata, etc concerned with this video

* EPrints 3.3.14
* Ubuntu 15.04

==Test Yourself==

==More Reading==