ORCID Support - Revision history

Rwf1v07@soton.ac.uk: /* ORCID Support Advance */

2022-04-13T12:08:31Z

ORCID Support Advance

← Older revision		Revision as of 12:08, 13 April 2022
Line 131:		Line 131:

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

			==First orcid.org Connection==
			When a user first connects their repository account to their ORCID account, and their ORCID is set in their user profile as a result, the repository does a search for all the eprints in the repository where that user's email is associated with one of ORCID contributor fields (i.e. creators or editors). These eprints are then recommitted, updating the ORCID contributor fields with the user's ORCID.

	==Import from orcid.org==		==Import from orcid.org==

Rwf1v07@soton.ac.uk: /* For Developers */

2022-04-13T11:58:45Z

For Developers

← Older revision		Revision as of 11:58, 13 April 2022
Line 248:		Line 248:

	Similarly, when a user first connects their user profile to orcid.org and the ORCID is added to their repository user account, a user commit trigger is called which will attempt to find all of the eprint records where that user is listed as a creator, and then commit those eprints so the new ORCID is pulled through. This trigger is also found in z_orcid_support_advance.pl and will need updating to ensure the lookup for a user's eprints, based on creators_id, is using the correct field.		Similarly, when a user first connects their user profile to orcid.org and the ORCID is added to their repository user account, a user commit trigger is called which will attempt to find all of the eprint records where that user is listed as a creator, and then commit those eprints so the new ORCID is pulled through. This trigger is also found in z_orcid_support_advance.pl and will need updating to ensure the lookup for a user's eprints, based on creators_id, is using the correct field.

			===ORCID Log Dataset (v1.9.4+)===
			A new ORCID log dataset is added to the repository to store details of communications between the repository and orcid.org when users first connect their accounts. The main purpose of this dataset is twofold:

			* To store the state when making the OAuth connection, to ensure the response we get back has a matching state
			* To store the repository permissions that are not explicitly shared with orcid.org, namely the permission to allow the repository to automatically update orcid.org every time a new item is published or a live item is updated.

	===Employment/Education Affiliation===		===Employment/Education Affiliation===

Rwf1v07@soton.ac.uk: /* Users with ORCIDs */

2022-04-13T11:51:00Z

Users with ORCIDs

← Older revision		Revision as of 11:51, 13 April 2022
Line 158:		Line 158:
	==New Reports==		==New Reports==
	===Users with ORCIDs===		===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.		With ORCID Support Advance installed, the ''Users with an ORCID'' reports has been updated to include the permissions the user has granted for the repository to interact with their orcid.org profile, as well as the ORCID token expiry date.

	~~[[File:orcid_user_perms.png\|800px\|thumb\|none]]~~

			[[File:orcid_advance_user_report.jpg\|800px\|thumb\|none]]

	===orcid.org Name Mismatch===		===orcid.org Name Mismatch===

Rwf1v07@soton.ac.uk: /* Export to orcid.org */

2022-04-13T11:48:02Z

Export to orcid.org

← Older revision		Revision as of 11:48, 13 April 2022
Line 153:		Line 153:

	[[File:export_to_orcid.jpg\|800px\|thumb\|none]]		[[File:export_to_orcid.jpg\|800px\|thumb\|none]]

			Items that have been exported to an orcid.org profile, may also be removed using this screen, via the ''Remove from orcid.org profile'' button.

	==New Reports==		==New Reports==

Rwf1v07@soton.ac.uk: /* Export to orcid.org */

2022-04-13T11:46:53Z

Export to orcid.org

← Older revision		Revision as of 11:46, 13 April 2022
Line 152:		Line 152:
	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 one of the contributor fields (e.g. creator, editor, etc.). Items may also be filtered based on when they were last modified.		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 one of the contributor fields (e.g. creator, editor, etc.). Items may also be filtered based on when they were last modified.

	[[File:export_to_orcid.~~png~~\|800px\|thumb\|none]]		[[File:export_to_orcid.jpg\|800px\|thumb\|none]]

	==New Reports==		==New Reports==

Rwf1v07@soton.ac.uk: /* Export to orcid.org */

2022-04-13T11:46:45Z

Export to orcid.org

← Older revision		Revision as of 11:46, 13 April 2022
Line 150:		Line 150:
	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.		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 one of the contributor fields (e.g. creator, editor, etc.). Items may also be filtered based on when they were last modified.

	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 <tt>creators</tt> field.		[[File:export_to_orcid.png\|800px\|thumb\|none]]

	==New Reports==		==New Reports==

Rwf1v07@soton.ac.uk: /* Import from orcid.org */

2022-04-13T09:58:34Z

Import from orcid.org

← Older revision		Revision as of 09:58, 13 April 2022
Line 137:		Line 137:
	[[File:orcid_import_button.png\|800px\|thumb\|none]]		[[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.		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. Users can also filter which records appear by publication date, to help ensure only ORCID works from the relevant period are shown.

	[[File:~~orcid_import~~.~~png~~\|800px\|thumb\|none]]		[[File:import_from_orcid.jpg\|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.		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.

Rwf1v07@soton.ac.uk: /* Connecting to orcid.org */

2022-04-13T09:53:41Z

Connecting to orcid.org

← Older revision		Revision as of 09:53, 13 April 2022
Line 120:		Line 120:
	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.		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:connect_to_orcid_screen.~~png~~\|800px\|thumb\|none]]		[[File:connect_to_orcid_screen.jpg\|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.		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]]		[[File:authorize_orcid.jpg\|800px\|thumb\|none]]

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

Rwf1v07@soton.ac.uk: /* Connecting to orcid.org */

2022-04-13T09:51:31Z

Connecting to orcid.org

← Older revision		Revision as of 09:51, 13 April 2022
Line 120:		Line 120:
	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.		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]]		[[File:connect_to_orcid_screen.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.		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.

Rwf1v07@soton.ac.uk: /* Connecting to orcid.org */

2022-04-13T09:48:01Z

Connecting to orcid.org

← Older revision		Revision as of 09:48, 13 April 2022
Line 114:		Line 114:

	==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 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.		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 ''Connect to ORCID®'' link that appears in the menu area when the logged in user does not have an ORCID associated with their account.

	[[File:~~orcid_create_or_connect~~.~~png~~\|800px\|thumb\|none]]		[[File:connect_to_orcid.jpg\|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.		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.