ORCID Plugin enhancement

withanage commented 7 years ago

Current Status

Previous plugins

Issue	Status/ Explanation		area	res.
user-id, author-id	Manual insertion of ID (no-validation) Button on registration form : Autofill firstname, lastname after validation Input button on profile: validate and automatic-id adding	✔ ✔ ✔	orcIdProfile	PKP
Login	ORCID Login for registered-ojs users	✔	pkp-auth	ULS
Synchronize	Synchronize articles into ORCID	✔		HD
Notify	send e-mail/notification to auhtors	✔		HD
authenticate	authentication for an existing user Display orcid id under the author on the monograph's view page	✔ ✔	pkp-orcid OMP	HIRMEOS

References

PKP-Sprint Document

nils-stefan-weiher commented 6 years ago

Hi @ajnyga, some answers to the questions below. I will also be able to tell you more after an internal meeting next Tuesday.

But I do like the idea of automated message in some point of the workflow. Would this be possible for example when the article moves to production or when "schedule for publication" is selected? This way the ORCID data would probably be ready at the time of publishing when the metadata is sent forward.

Yes I think the same e-mail can be send when "schedule for publication" is selected, because the plugin already hooks into this step to send the meta-data for already published issues.

Another question about the link. When you say clicking it will add the article data to the ORCID profile you are probably talking about using the member API to push the article data, right? But at the same time you are also storing the author ORCID to the OJS database, right? So just to make sure, if the journal does not have the member API, the emails are still getting sent and the ORCIDs added to the OJS database - only the data being pushed to the ORCID database will be missing, right?

Yes the e-mails will still be sent, only the data pushing would then be disabled. But I still have to code the logic to distinguish between free and member api.

Selecting the scope is probably the same thing as selecting between the free API and the member API, right? If so, then it is a great idea to have a selection for that. I do not have a ready opinion what the selection should be like. I guess the simplest solution would be just having two options there to choose between the limited and full features.

In current version of the orcidProfile Plugin the API can be selected and this has not changed. I just thought that although Member API credentials are available for a journal or installation it should still be possible to disable the pushing to ORCID, to only use the plugin to collect ORCID ids. But it would probably be clearer and easier to understand to let the scopes be determind by the Plugin and only show the API selection and a checkbox for pushing of data.

ajnyga commented 6 years ago

Sounds good!

To be honest I really do not know the details concerning what the member API can do at the moment. You are probably right that instead of selecting between APIs it would be better to enable users select between features.

asmecher commented 6 years ago

Just a note about the members' API -- generally we're trying to avoid dependency on it, as most of our user community won't be able to pay for it. But if there are useful optional pieces of functionality that depend on it, then those would be fine to incorporate, as long as they're optional.

nils-stefan-weiher commented 6 years ago

Just a note about the members' API -- generally we're trying to avoid dependency on it, as most of our user community won't be able to pay for it. But if there are useful optional pieces of functionality that depend on it, then those would be fine to incorporate, as long as they're optional.

Yes, we are making sure that the plugin is still functional with the Public API. And like I wrote earlier in a comment, the collecting of ORCID ids via emails to author will still work with the free Public API.

ajnyga commented 6 years ago

This all sounds very good! Let me know if you need help with testing etc. Starting from next summer I will probably have more time to participate in coding as well, that is if there is any left then :)

nils-stefan-weiher commented 6 years ago

@ajnyga Thank you for the offer. I will let you know if more testing is needed.

Because you showed a valid point, we decided to change the point in time when automatic mails are send to authors for collecting/authorizing ORCID record access. The e-mails will now be sent as a Submission is promoted to production, this also aligns nicely with adding the meta data to ORCID records in a later step when the containing issue is published or the submission is scheduled for publication in an already published issue. Thanks again for the input.

@ajnyga @asmecher Another question came up concerning the sender of the e-mail: At the moment the journal primary contact is used for the "From" field of the e-mails, because we did not want to use the e-mail of the user triggering the action, this could vary from submission to submission and this may be confusing for authors receiving the mails. But this also means if there are errors with the e-mail transfer the journal primary contact receives all the bounced e-mails.

Should the sender address and name be configurable in the plugin settings or add a "Reply to" contact so that journals could enter a specific contact person for ORCID related issues?
This would mean more work, and would probably be done at a later point in time as we want to finish the work on the new features this week or latest beginning of next week. But this would

ajnyga commented 6 years ago

Thanks @isgrim, sounds good!

Concerning the question you had, I personally do not see it as a problem that the journal primary contact is sending those messages. It is already used to send a lot of other similar messages. There is a bounce setting in Settings > Workflow > Emails. Can you see if the applies to messages sent by plugins as well? I do not have a clear idea how it works in OJS.

ps. I was invited to a seminar concerning ORCID and was asked to tell how it is integrated in OJS/Journal.fi. There are at least two ORCID representatives participating as well. Unluckily I am on holiday during that same week so I can not go. It is a pity, because it would had been great to show them what you have accomplished here.

nils-stefan-weiher commented 5 years ago

pkp/orcidProfile#57 Contains the changes needed for OJS 3.1.2 release

Let me know if there are any more issues with the code.

asmecher commented 5 years ago

Thanks, @isgrim (& @withanage)! I've merged that PR to stable-3_1_2 and forward-ported it to master. I'll do some testing of this for the forthcoming OJS 3.1.2 release shortly.

The PR to ojs-stable-3_1_1 might be useful to others who need to stick with that release, but I'm content to focus on stable-3_1_2 and master.

Is there anything still pending on this issue, or shall I close it?

ajnyga commented 5 years ago

(thank you @isgrim for all the hard work you have done with this!)

withanage commented 5 years ago

@asmecher
we can close the issue now and thanks a lot for accompanying the plugin development process.

@mtub we did a simple german translation, but a collegue also makes a general german ORCID translation, that can be used for any service-end-point, if you are interested, I can send you that, as soon as it is finished ?

asmecher commented 5 years ago

Excellent! Much appreciated, everyone!

pkp / pkp-lib