Difference between revisions of "Import From ORCID"

From EPrints Documentation
Jump to: navigation, search
(Technical Details)
m (Drn@ecs.soton.ac.uk moved page ImportFromORCID to Import From ORCID: More readable title)
 
(10 intermediate revisions by 2 users not shown)
Line 1: Line 1:
== Overview ==
+
[[Category: ORCID]]
 +
[[Category: Plugins]]
  
'''Import from ORCID''' is a plugin for EPrints that allows you to import publications for a given author identified by an ORCID.
+
== Concept ==
  
The plugin demonstrates how an EPrints repository can interface with the ORCID Tier 1 API.
+
'''Import from ORCID''' is a simple plugin for EPrints that demonstrates how publications could be imported into EPrints for a given author identified by an ORCID, using the ORCID Tier 1 (public) API.
  
== Technical Details ==
+
== For Developers: Technical Details ==
  
Given an author's ORCID, the plugin queries the orcid.com Tier 1 (public) API and retrieves a list of works published by that author in JSON format.
+
Given an author's ORCID, the plugin queries the ORCID Tier 1 API and retrieves a list of works published by that author in JSON format.
  
 
The metadata describing each work may include a ''work-citation-format'' (for example, BIBTEX) and/or multiple ''work-external-identifier-type'' (for example, DOI, PMID) elements - where the ''work-citation-format'' or ''work-external-identifier-type'' can be mapped to an EPrints import plugin an Import option is displayed next to the work.
 
The metadata describing each work may include a ''work-citation-format'' (for example, BIBTEX) and/or multiple ''work-external-identifier-type'' (for example, DOI, PMID) elements - where the ''work-citation-format'' or ''work-external-identifier-type'' can be mapped to an EPrints import plugin an Import option is displayed next to the work.
  
== User Guide ==
+
== For Administrators: Testing the Concept ==
  
 
1. After installing, an ORCID button appears on the Admin screen.
 
1. After installing, an ORCID button appears on the Admin screen.
Line 17: Line 18:
 
[[File:import_from_orcid_admin.png|400px|thumb|none]]
 
[[File:import_from_orcid_admin.png|400px|thumb|none]]
  
2. Enter an ORCID to search for published works.
+
2. Enter an author's ORCID to search for their published works.
  
 
[[File:import_from_orcid_enter_orcid.png|400px|thumb|none]]
 
[[File:import_from_orcid_enter_orcid.png|400px|thumb|none]]
  
3. Search results are listed with import options where available (import from DOI or import from PubMed ID).
+
3. Search results retrieved and listed with import options where available.
  
 
[[File:import_from_orcid_search_results.png|400px|thumb|none]]
 
[[File:import_from_orcid_search_results.png|400px|thumb|none]]
  
4. Clicking Import takes you to the standard Import screen.
+
4. Clicking Import takes you to the default EPrints import screen.
  
 
[[File:import_from_orcid_import.png|400px|thumb|none]]
 
[[File:import_from_orcid_import.png|400px|thumb|none]]

Latest revision as of 10:38, 9 July 2024


Concept

Import from ORCID is a simple plugin for EPrints that demonstrates how publications could be imported into EPrints for a given author identified by an ORCID, using the ORCID Tier 1 (public) API.

For Developers: Technical Details

Given an author's ORCID, the plugin queries the ORCID Tier 1 API and retrieves a list of works published by that author in JSON format.

The metadata describing each work may include a work-citation-format (for example, BIBTEX) and/or multiple work-external-identifier-type (for example, DOI, PMID) elements - where the work-citation-format or work-external-identifier-type can be mapped to an EPrints import plugin an Import option is displayed next to the work.

For Administrators: Testing the Concept

1. After installing, an ORCID button appears on the Admin screen.

Import from orcid admin.png

2. Enter an author's ORCID to search for their published works.

Import from orcid enter orcid.png

3. Search results retrieved and listed with import options where available.

Import from orcid search results.png

4. Clicking Import takes you to the default EPrints import screen.

Import from orcid import.png

5. After importing the item, you are taken to the deposit workflow where you can edit and deposit the item.

Import from orcid edit item.png