Difference between revisions of "ORCID connector"

From EPrints Documentation
Jump to: navigation, search
Line 57: Line 57:
 
! Function !! Test !! No API !! Tier 1 API !! Tier 2 API !! Status
 
! 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 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 and / or display ORCID ID in EPrint record || Must || Should || Should || 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

Revision as of 14:16, 9 June 2016

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.

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