Site-wide configuration of ORCID Profile Plugin

ojs_univie · January 21, 2020, 1:19pm

We’re running OJS 3.1.2-1 and trying to get the ORCID plugin 1.1.0 configured site-wide, because the official readme states that you can

Enable site-wide configuration of ORCID API settings using config.inc.php

However we haven’t been able to find the required values in the documentation (the “installation” section is empty) or anywhere else for that matter. This old thread leads nowhere as far as we can tell. Can you tell us the values required and what the consequences are for adding them to config.inc.php?

Failing this, is it possible to hide the (member API) client secret in a multi-journal environment?

ctgraham · January 21, 2020, 2:53pm

The code indicates that the following can be setting names in config.inc.php, in a section named orcid:

github.com

pkp/orcidProfile/blob/bc8cf3cc3ae5157856ff0fc2e74502615c0d4c45/OrcidProfilePlugin.inc.php#L115


	 * Load a setting for a specific journal or load it from the config.inc.php if it is specified there.
	 *
	 * @param  $contextId int The id of the journal from which the plugin settings should be loaded.
	 * @param  $name string   Name of the setting.
	 * @return mixed          The setting value, either from the database for this context
	 *                        or from the global configuration file.
	 */
	function getSetting($contextId, $name)
	{
		switch ($name) {
			case 'orcidProfileAPIPath':
				$config_value = Config::getVar('orcid','api_url');
				break;
			case 'orcidClientId':
				$config_value = Config::getVar('orcid','client_id');
				break;
			case 'orcidClientSecret':
				$config_value = Config::getVar('orcid','client_secret');
				break;
			default:
				return parent::getSetting($contextId, $name);

api_url
client_id
client_secret

ojs_univie · February 6, 2020, 1:57pm

Worked great, thanks! Add it to the readme please.

srabun · March 2, 2020, 10:37pm

I really just need a straight answer – is it or is it not possible to implement the ORCID plugin for multiple journals on the same OJS instance?

Above it looks like this is possible, but then…

I came across this in the ORCID OJS plugin documentation on this page: Installation and Setup it says: “After you have obtained an API key from ORCID, you can enable and configure the plugin in OJS. For multi-journal installations this needs to be done on a per-journal basis as this plugin is not a site-wide plugin”

What is the correct answer? Can we get some clear documentation on what people need to do to enable ORCID across multiple journals? THanks!

ojs_univie · March 3, 2020, 9:08am

We actually added the information on how to set this up site-wide to the page you are referring to, but the changes don’t seem to have come through to docs yet. Have a look at the GitHub repository to see the changes:

github.com

pkp/pkp-docs/blob/main/orcid/en/installation-setup.md#site-wide-setup

# Installation and Setup

To use the plugin, you will first need to obtain either Public or Member ORCID API credentials (Client ID and Client Secret) and then configure the ORCID Profile Plugin in OJS/OPS with this information. **Please note**: do not enable the plugin until you have the credentials and are ready to setup the plugin.

## Obtain ORCID Sandbox API Credentials

You are strongly advised  to test the ORCID plugin in the ORCID Sandbox environment using Sandbox ORCID API credentials first to make sure that the OJS/OPS environment is configured  properly, before moving to the production environment and going live with the plugin functionality. The process for obtaining your Sandbox ORCID API credentials will vary depending on whether you are planning to use the ORCID Public API or the ORCID Member API. 

ORCID provides two different API endpoints for: sandbox (testing) and production (live) environments: the ORCID Member API, and the ORCID Public API:

### Public API

Free and available to anyone, the Public API allows for ORCID iD authentication and reading public data from ORCID records.

Public API credentials are connected to an individual’s ORCID iD. To obtain Sandbox Public API credentials:

1. Register for a Sandbox ORCID iD account at the [ORCID sandbox site](https://sandbox.orcid.org).
2. Sign in to your Sandbox ORCID record.
3. Go to the “Developer tools” tab, and follow the instructions to [register a public API client application](https://support.orcid.org/hc/en-us/articles/360006897174-Register-a-public-API-client-application). See the note on “ORCID Redirect URIs” below for guidance on what to enter for your Redirect URIs.

This file has been truncated. show original

astevens · March 3, 2020, 10:06pm

Hi @ojs_univie and @srabun,

Thanks, @ojs_univie, for updating the ORCID plugin guide with this information. We merged the changes you made into the guide but they will not be reflected in the published version of the guide until we do a “rebuild” of the Documentation Hub. It’s an extra step required with the software we use. This should be done tomorrow.

Best,
Amanda Stevens
Public Knowledge Project Team

ojs_univie · March 4, 2020, 11:46am

Also added a pull request to add the link for PKP|DOCS to the README of the plugin’s GitHub Repo.

ojs_univie · March 5, 2020, 8:34am

Information is published in PKP|DOCS and README links to the latter. Issue resolved.

Many thanks to @ctgraham and @astevens for your replies and of course to @kaitlin and @asmecher for accepting the pull requests!