Difference between revisions of "ORCID Support"

From EPrints Documentation
Jump to: navigation, search
(ORCID Support Advance)
m
(21 intermediate revisions by 2 users not shown)
Line 1: Line 1:
==Introduction==
+
=Introduction=
 +
 
The 'ORCID Support' and 'ORCID Support Advance' plugins have been developed to group together various ORCID developments from across a range of repositories  
 
The 'ORCID Support' and 'ORCID Support Advance' plugins have been developed to group together various ORCID developments from across a range of repositories  
  
Line 6: Line 7:
 
'ORCID Support Advance' builds upon the functionality of 'ORCID Support', and allows users to connect their repository profiles with their accounts on orcid.org. Once an account has been connected, the user may manage their orcid.org permissions, controlling how the repository reads and writes from orcid.org. If read permissions have been granted, works from orcid.org may be imported to the user's work area. If write permissions have been granted, records where the user's ORCID is present may be exported to their orcid.org profile.
 
'ORCID Support Advance' builds upon the functionality of 'ORCID Support', and allows users to connect their repository profiles with their accounts on orcid.org. Once an account has been connected, the user may manage their orcid.org permissions, controlling how the repository reads and writes from orcid.org. If read permissions have been granted, works from orcid.org may be imported to the user's work area. If write permissions have been granted, records where the user's ORCID is present may be exported to their orcid.org profile.
  
==ORCID Support==
+
=ORCID Support=
===ORCID Field===
+
==ORCID Field==
 
ORCID Support adds a new 'ORCID' field to both the 'Creators' and 'Editors' field, as well as the adding a new stage to the edit user workflow where an ORCID may be stored. All of these fields are of type 'ORCID', a special type of text field that validates the ORCID is of the correct format, 16 digits broken into 4 groups of 4 separated by a dash, e.g. 0000-0003-1495-7122. The field also checks that the final digit of the ORCID, the checksum, is valid and a warning is displayed if the ORCID is invalid in any way.
 
ORCID Support adds a new 'ORCID' field to both the 'Creators' and 'Editors' field, as well as the adding a new stage to the edit user workflow where an ORCID may be stored. All of these fields are of type 'ORCID', a special type of text field that validates the ORCID is of the correct format, 16 digits broken into 4 groups of 4 separated by a dash, e.g. 0000-0003-1495-7122. The field also checks that the final digit of the ORCID, the checksum, is valid and a warning is displayed if the ORCID is invalid in any way.
  
Line 20: Line 21:
 
The 'Creators' and 'Editors' fields will also be automatically be populated from user profiles if the 'Creators' or 'Editors' ID subfields can be used to lookup a corresponding user profile.
 
The 'Creators' and 'Editors' fields will also be automatically be populated from user profiles if the 'Creators' or 'Editors' ID subfields can be used to lookup a corresponding user profile.
  
===Display ORCIDS===
+
==Display ORCIDS==
 
ORCIDs are always displayed next to a small, green ORCID badge, and in form of a link to the corresponding orcid.org profile.
 
ORCIDs are always displayed next to a small, green ORCID badge, and in form of a link to the corresponding orcid.org profile.
  
Line 29: Line 30:
 
[[File:orcid_tooltip.png|800px|thumb|none]]
 
[[File:orcid_tooltip.png|800px|thumb|none]]
  
===Reports===
+
==Reports==
 
Where the [[Generic Reporting Framework]] plugin has been installed, new reports will become available, under the heading 'ORCID Dashboard'.
 
Where the [[Generic Reporting Framework]] plugin has been installed, new reports will become available, under the heading 'ORCID Dashboard'.
  
Line 42: Line 43:
 
[[File:orcid_creators_report.png|800px|thumb|none]]
 
[[File:orcid_creators_report.png|800px|thumb|none]]
  
===RIOXX===
+
==RIOXX==
 
Where the [http://bazaar.eprints.org/390/ RIOXX] plugin has been installed, ORCIDs will be added as the 'id' attribute for <rioxxterms:author> elements.
 
Where the [http://bazaar.eprints.org/390/ RIOXX] plugin has been installed, ORCIDs will be added as the 'id' attribute for <rioxxterms:author> elements.
  
===For Developers===
+
==For Developers==
====Updating Citations====
+
 
 +
===Existing ORCID Fields===
 +
The ORCID support plugin will add an ORCID field in the the following three places:
 +
# As a sub-field of <tt>Creators</tt> for an EPrint.  Check the <tt>Details</tt> stage of your EPrint workflow.
 +
# As a sub-field of <tt>Editors</tt> for an EPrint.  Check the <tt>Details</tt> stage of your EPrint workflow when the EPrint id of type <tt>Book</tt> or <tt>Book Section</tt>.
 +
# As a field for a <tt>User</tt>. Check the <tt>Profile</tt> stage in your User workflow. 
 +
If you already have an ORCID field in any of these three locations, the ORCID Support will skip creating its own.  However, it will not update the existing field to the new 'orcid' type.  Therefore if one or more of the fields exist you will need to edit them manually to change their type from 'text' to 'orcid' after the ORCID support plugin has been installed.:
 +
{
 +
  'sub_name' => 'orcid',
 +
  'type' => 'text',
 +
  'input_cols' => 20,
 +
  'allow_null' => 1,
 +
}
 +
 
 +
Becomes:
 +
 
 +
{
 +
  'sub_name' => 'orcid',
 +
  'type' => 'orcid',
 +
  'input_cols' => 20,
 +
  'allow_null' => 1,
 +
}
 +
 
 +
If you have pre-configured the creators' or editors' ORCID sub-field, this will likely be in your archive's <tt>cfg/cfg.d/eprint_fields.pl</tt>.  The user's ORCID field will most likely be in your archive's <tt>cfg/cfg.d/user_fields.pl</tt>.
 +
 
 +
===Updating Citations===
 
ORCID Support provides a function for rendering green ORCID badges which show the user's ORCID in a tooltip when hovered over. To add these in a citation, simply include the following when displaying creator or editor fields.
 
ORCID Support provides a function for rendering green ORCID badges which show the user's ORCID in a tooltip when hovered over. To add these in a citation, simply include the following when displaying creator or editor fields.
  
Line 58: Line 84:
 
</pre>
 
</pre>
  
==ORCID Support Advance==
+
=ORCID Support Advance=
 
'''ORCID Support is required for ORCID Support Advance'''
 
'''ORCID Support is required for ORCID Support Advance'''
  
===Connecting to orcid.org===
+
==Connecting to orcid.org==
Before users can import or export from orcid.org, they first need to connect their repository user profiles with their orcid.org user profiles. This can be done through
+
Before users can import or export from orcid.org, they first need to connect their repository user profiles with their orcid.org user profiles. This can be done via the 'Create or Connect your ORCID iD' link that appears in the menu area when the logged in user does not have an ORCID associated with their account.
  
===For Developers===
+
[[File:orcid_create_or_connect.png|800px|thumb|none]]
 +
 
 +
When clicked, the user will be taken to a new screen where they may specify which permissions they grant the repository when connecting to their orcid.org profile. By default all permissions are granted unless specified otherwise, which includes allowing the repository to connect with the orcid.org profile, read restricted works from the profile, and update activities on the profile.
 +
 
 +
[[File:orcid_manage_permissions.png|800px|thumb|none]]
 +
 
 +
Once the user has specified which permissions they would like to grant the repository, clicking the 'Create or Connect your ORCID ID' button, will take the user to the ORCID site where they may sign in to connect their existing ORCID, or may create a new ORCID if they do not already have one.
 +
 
 +
[[File:orcid_sign_in.png|800px|thumb|none]]
 +
 
 +
 
 +
Upon completion of this process, the user will be redirected to the 'Manage ORcID Permissions' screen.
 +
 
 +
Each time the permissions are updated by clicking the 'Connect to ORCID' button, the user will once again be asked to sign in to ORCID, as per the initial connection, so that orcid.org is aware of the permissions the user has granted to the repository.
 +
 
 +
When the 'Create and update publication details on your ORCID record' check box is selected, the repository will try to update the user's orcid.org profile with details about their institution. By default, the institution will be added to the ORCID profile's 'Employment' section. However the plugin's configuration may specify that certain user types should have their 'Education' section updated instead.
 +
 
 +
==Import from orcid.org==
 +
 
 +
With the 'Retrieve restricted details from your ORCID profile' option selected in the 'Manage ORCID Permissions' screen, a 'Import from orcid.org' button should appear on the 'Manage deposits' screen.
 +
 
 +
[[File:orcid_import_button.png|800px|thumb|none]]
 +
 
 +
This screen will display all of the records from the user's orcid.org profile which the user has given permission to be read. Users can select which records they would like to appear by selecting the check boxes (all checkboxes are selected by default). If the record has been imported previously, the option to select the record for importing again will not be presented.
 +
 
 +
[[File:orcid_import.png|800px|thumb|none]]
 +
 
 +
The 'Import from orcid.org' will also appear on user profile screens, allowing admin users to import records from orcid.org on behalf of the repository's users.
 +
 
 +
==Export to orcid.org==
 +
 
 +
When the 'Create and update publication details on your ORCID record' option is selected in the 'Manage ORCID Permissions screen, the 'Export to orcid.org' button appears on the 'Manage deposits'
 +
 
 +
[[File:orcid_export_button.png|800px|thumb|none]]
 +
 
 +
The 'Export to orcid.org' will also appear on user profile screens, allowing admin users to export records from the repository to the user's orcid.org profile, on behalf of the repository's users.
 +
 
 +
[[File:orcid_export.png|800px|thumb|none]]
 +
 
 +
Like the import screen, here the user may select which records they wish to export to their orcid.org profile using the checkboxes. The records presented are any of those where the user's ORCID is listed in the 'Creators' field.
 +
 
 +
==New Reports==
 +
 
 +
===Users with ORCIDs===
 +
With ORCID Support Advance installed, the 'Users with ORCIDs' reports has been updated to include the permissions the user has granted for the repository to interact with their orcid.org profile.
 +
 
 +
[[File:orcid_user_perms.png|800px|thumb|none]]
 +
 
 +
===orcid.org Name Mismatch===
 +
This report highlights where a user's name in their repository user profile differs from their name in their orcid.org profile.
 +
 
 +
[[File:orcid_mismatch.png|800px|thumb|none]]
 +
 
 +
==For Developers==
 +
Configuration for the ORCID Support Advance plugin is stored in 'z_orcid_support_advance.pl' at the local archive level.
 +
 
 +
To use the plugin, a 'client_id' and 'client_secret' will need to be provided. ORCID members may acquired these credentials by registering the repository as a client application at https://orcid.org/content/register-client-application-production-trusted-party.
 +
 
 +
'''When registering the Redirect URI should be your repository's address followed by 'cgi/orcid/authenticate'.'''
 +
 
 +
<pre>
 +
E.g. https://test-eprints.org/cgi/orcid/authenticate/
 +
</pre>
 +
 
 +
For non-members, a sandbox API is also provided which only gives access to ORCID details stored in the ORCID Sandbox. The [https://sandbox.orcid.org/sandbox.html Sandbox] is a test website, which only sends emails to @mailinator email addresses and does not contain the records found in the Production Registry (for more info please see the [https://support.orcid.org/knowledgebase/articles/166623-is-the-sandbox-different-from-the-production-regis Sandbox FAQ]).
 +
 
 +
<pre>
 +
###General ORCID Support Advance config###
 +
$c->{ORCID_contact_email} = $c->{adminemail};
 +
 
 +
$c->{orcid_support_advance}->{client_id} = "XXXX";
 +
$c->{orcid_support_advance}->{client_secret} = "YYYY";
 +
 
 +
$c->{orcid_support_advance}->{orcid_apiv2} = "https://api.sandbox.orcid.org/v2.0/";
 +
$c->{orcid_support_advance}->{orcid_org_auth_uri} = "https://sandbox.orcid.org/oauth/authorize";
 +
$c->{orcid_support_advance}->{orcid_org_exch_uri} = "https://api.sandbox.orcid.org/oauth/token";
 +
$c->{orcid_support_advance}->{redirect_uri} = $c->{"perl_url"} . "/orcid/authenticate";
 +
</pre>
 +
 
 +
 
 +
===Employment/Education Affiliation===
 +
ORCID identifies institutions using a RINGGOLD identifier: https://support.orcid.org/knowledgebase/articles/276884-how-are-organizations-identified-in-orcid
 +
 
 +
The RINGGOLD identifier for the repository's institution may be defined in 'z_orcid_support_advance.pl', as used by ORCID Support Advance when trying to update the user's orcid.org profile:
 +
 
 +
<pre>
 +
#Details of the organization for affiliation inclusion - the easiest way to obtain the RINGGOLD id is to add it to your ORCID user record manually, then pull the orcid-profile via the API and the identifier will be on the record returned.
 +
$c->{"plugins"}->{"Event::OrcidSync"}->{"params"}->{"affiliation"} = {
 +
                                                "organization" => {
 +
                                                        "name" => "My University Name", #name of organization - REQUIRED
 +
                                                        "address" => {
 +
                                                                "city" => "My Town",  # name of the town / city for the organization - REQUIRED if address included
 +
                                                        #      "region" => "Countyshire",  # region e.g. county / state / province - OPTIONAL
 +
                                                                "country" => "GB",  # 2 letter country code - AU, GB, IE, NZ, US, etc. - REQUIRED if address included
 +
                                                        },
 +
                                                        "disambiguated-organization" => {
 +
                                                                "disambiguated-organization-identifier" => "ZZZZ",  # replace ZZZZ with Institutional identifier from the recognised source
 +
                                                                "disambiguation-source" => "RINGGOLD", # Source for institutional identifier should be RINGGOLD or ISNI
 +
                                                        }
 +
                                                }
 +
};
 +
</pre>
 +
 
 +
To specify which user types should have their 'Education' section updated on their orcid.org profile, instead of the 'Employment' section, add the user types to the following array.
 +
 
 +
<pre>
 +
$c->{orcid_support_advance}->{education_user_types} = [];
 +
</pre>

Revision as of 13:50, 20 November 2017

Introduction

The 'ORCID Support' and 'ORCID Support Advance' plugins have been developed to group together various ORCID developments from across a range of repositories

'ORCID Support' provides basic ORCID functionality for the repository including the addition of a new ORCID metafield, ORCID rendering and validation, and basic reporting with the Generic Reporting Framework.

'ORCID Support Advance' builds upon the functionality of 'ORCID Support', and allows users to connect their repository profiles with their accounts on orcid.org. Once an account has been connected, the user may manage their orcid.org permissions, controlling how the repository reads and writes from orcid.org. If read permissions have been granted, works from orcid.org may be imported to the user's work area. If write permissions have been granted, records where the user's ORCID is present may be exported to their orcid.org profile.

ORCID Support

ORCID Field

ORCID Support adds a new 'ORCID' field to both the 'Creators' and 'Editors' field, as well as the adding a new stage to the edit user workflow where an ORCID may be stored. All of these fields are of type 'ORCID', a special type of text field that validates the ORCID is of the correct format, 16 digits broken into 4 groups of 4 separated by a dash, e.g. 0000-0003-1495-7122. The field also checks that the final digit of the ORCID, the checksum, is valid and a warning is displayed if the ORCID is invalid in any way.

Orcid creators.png
Orcid user profile.png
Orcid warning.png

The lookup script for the 'Creators' and 'Editors' fields has also been updated to include the ORCID where this can be retrieved from other records where the ORCID has already been stored.

The 'Creators' and 'Editors' fields will also be automatically be populated from user profiles if the 'Creators' or 'Editors' ID subfields can be used to lookup a corresponding user profile.

Display ORCIDS

ORCIDs are always displayed next to a small, green ORCID badge, and in form of a link to the corresponding orcid.org profile.

Orcid rendering.png

Where space on the screen is more restricted, such as in citations, the ORCID itself is removed and only the green ORCID badge is displayed. The badge still links to the orcid.org profile and when hovered over, the ORCID is displayed in a green tooltip.

Orcid tooltip.png

Reports

Where the Generic Reporting Framework plugin has been installed, new reports will become available, under the heading 'ORCID Dashboard'.

The 'All users with and without ORCIDs' report will show all the users in the repository, showing users without an ORCID as non-compliant and users with an ORCID as compliant.

Orcid all users report.png

The 'Users with ORCIDs' report, is similar to the 'All users' report, but instead only shows the users who have ORCIDs in their user profile.

Finally, the 'Creators with ORCIDs' report will highlight all EPrint records that have 'Creators' values with ORCIDs assigned to them.

Orcid creators report.png

RIOXX

Where the RIOXX plugin has been installed, ORCIDs will be added as the 'id' attribute for <rioxxterms:author> elements.

For Developers

Existing ORCID Fields

The ORCID support plugin will add an ORCID field in the the following three places:

  1. As a sub-field of Creators for an EPrint. Check the Details stage of your EPrint workflow.
  2. As a sub-field of Editors for an EPrint. Check the Details stage of your EPrint workflow when the EPrint id of type Book or Book Section.
  3. As a field for a User. Check the Profile stage in your User workflow.

If you already have an ORCID field in any of these three locations, the ORCID Support will skip creating its own. However, it will not update the existing field to the new 'orcid' type. Therefore if one or more of the fields exist you will need to edit them manually to change their type from 'text' to 'orcid' after the ORCID support plugin has been installed.:

{
  'sub_name' => 'orcid',
  'type' => 'text',
  'input_cols' => 20,
  'allow_null' => 1,
}

Becomes:

{
  'sub_name' => 'orcid',
  'type' => 'orcid',
  'input_cols' => 20,
  'allow_null' => 1,
}

If you have pre-configured the creators' or editors' ORCID sub-field, this will likely be in your archive's cfg/cfg.d/eprint_fields.pl. The user's ORCID field will most likely be in your archive's cfg/cfg.d/user_fields.pl.

Updating Citations

ORCID Support provides a function for rendering green ORCID badges which show the user's ORCID in a tooltip when hovered over. To add these in a citation, simply include the following when displaying creator or editor fields.

<!-- For Creators -->

<print expr="people_with_orcids(creators)" /> 

<!-- For Editors -->
<print expr="people_with_orcids(editors)" /> 

ORCID Support Advance

ORCID Support is required for ORCID Support Advance

Connecting to orcid.org

Before users can import or export from orcid.org, they first need to connect their repository user profiles with their orcid.org user profiles. This can be done via the 'Create or Connect your ORCID iD' link that appears in the menu area when the logged in user does not have an ORCID associated with their account.

Orcid create or connect.png

When clicked, the user will be taken to a new screen where they may specify which permissions they grant the repository when connecting to their orcid.org profile. By default all permissions are granted unless specified otherwise, which includes allowing the repository to connect with the orcid.org profile, read restricted works from the profile, and update activities on the profile.

Orcid manage permissions.png

Once the user has specified which permissions they would like to grant the repository, clicking the 'Create or Connect your ORCID ID' button, will take the user to the ORCID site where they may sign in to connect their existing ORCID, or may create a new ORCID if they do not already have one.

Orcid sign in.png


Upon completion of this process, the user will be redirected to the 'Manage ORcID Permissions' screen.

Each time the permissions are updated by clicking the 'Connect to ORCID' button, the user will once again be asked to sign in to ORCID, as per the initial connection, so that orcid.org is aware of the permissions the user has granted to the repository.

When the 'Create and update publication details on your ORCID record' check box is selected, the repository will try to update the user's orcid.org profile with details about their institution. By default, the institution will be added to the ORCID profile's 'Employment' section. However the plugin's configuration may specify that certain user types should have their 'Education' section updated instead.

Import from orcid.org

With the 'Retrieve restricted details from your ORCID profile' option selected in the 'Manage ORCID Permissions' screen, a 'Import from orcid.org' button should appear on the 'Manage deposits' screen.

Orcid import button.png

This screen will display all of the records from the user's orcid.org profile which the user has given permission to be read. Users can select which records they would like to appear by selecting the check boxes (all checkboxes are selected by default). If the record has been imported previously, the option to select the record for importing again will not be presented.

Orcid import.png

The 'Import from orcid.org' will also appear on user profile screens, allowing admin users to import records from orcid.org on behalf of the repository's users.

Export to orcid.org

When the 'Create and update publication details on your ORCID record' option is selected in the 'Manage ORCID Permissions screen, the 'Export to orcid.org' button appears on the 'Manage deposits'

Orcid export button.png

The 'Export to orcid.org' will also appear on user profile screens, allowing admin users to export records from the repository to the user's orcid.org profile, on behalf of the repository's users.

Orcid export.png

Like the import screen, here the user may select which records they wish to export to their orcid.org profile using the checkboxes. The records presented are any of those where the user's ORCID is listed in the 'Creators' field.

New Reports

Users with ORCIDs

With ORCID Support Advance installed, the 'Users with ORCIDs' reports has been updated to include the permissions the user has granted for the repository to interact with their orcid.org profile.

Orcid user perms.png

orcid.org Name Mismatch

This report highlights where a user's name in their repository user profile differs from their name in their orcid.org profile.

Orcid mismatch.png

For Developers

Configuration for the ORCID Support Advance plugin is stored in 'z_orcid_support_advance.pl' at the local archive level.

To use the plugin, a 'client_id' and 'client_secret' will need to be provided. ORCID members may acquired these credentials by registering the repository as a client application at https://orcid.org/content/register-client-application-production-trusted-party.

When registering the Redirect URI should be your repository's address followed by 'cgi/orcid/authenticate'.

E.g. https://test-eprints.org/cgi/orcid/authenticate/

For non-members, a sandbox API is also provided which only gives access to ORCID details stored in the ORCID Sandbox. The Sandbox is a test website, which only sends emails to @mailinator email addresses and does not contain the records found in the Production Registry (for more info please see the Sandbox FAQ).

###General ORCID Support Advance config###
$c->{ORCID_contact_email} = $c->{adminemail};

$c->{orcid_support_advance}->{client_id} = "XXXX";
$c->{orcid_support_advance}->{client_secret} = "YYYY";

$c->{orcid_support_advance}->{orcid_apiv2} = "https://api.sandbox.orcid.org/v2.0/";
$c->{orcid_support_advance}->{orcid_org_auth_uri} = "https://sandbox.orcid.org/oauth/authorize";
$c->{orcid_support_advance}->{orcid_org_exch_uri} = "https://api.sandbox.orcid.org/oauth/token";
$c->{orcid_support_advance}->{redirect_uri} = $c->{"perl_url"} . "/orcid/authenticate";


Employment/Education Affiliation

ORCID identifies institutions using a RINGGOLD identifier: https://support.orcid.org/knowledgebase/articles/276884-how-are-organizations-identified-in-orcid

The RINGGOLD identifier for the repository's institution may be defined in 'z_orcid_support_advance.pl', as used by ORCID Support Advance when trying to update the user's orcid.org profile:

#Details of the organization for affiliation inclusion - the easiest way to obtain the RINGGOLD id is to add it to your ORCID user record manually, then pull the orcid-profile via the API and the identifier will be on the record returned.
$c->{"plugins"}->{"Event::OrcidSync"}->{"params"}->{"affiliation"} = {
                                                "organization" => {
                                                        "name" => "My University Name", #name of organization - REQUIRED
                                                        "address" => {
                                                                "city" => "My Town",  # name of the town / city for the organization - REQUIRED if address included
                                                        #       "region" => "Countyshire",  # region e.g. county / state / province - OPTIONAL
                                                                "country" => "GB",  # 2 letter country code - AU, GB, IE, NZ, US, etc. - REQUIRED if address included
                                                        },
                                                        "disambiguated-organization" => {
                                                                "disambiguated-organization-identifier" => "ZZZZ",  # replace ZZZZ with Institutional identifier from the recognised source
                                                                "disambiguation-source" => "RINGGOLD", # Source for institutional identifier should be RINGGOLD or ISNI
                                                        }
                                                }
};

To specify which user types should have their 'Education' section updated on their orcid.org profile, instead of the 'Employment' section, add the user types to the following array.

$c->{orcid_support_advance}->{education_user_types} = [];