A guide to a Tech Contact's onboarding on the Test Hub

113 views
Skip to first unread message

Jason Gush

unread,
Jun 8, 2017, 7:28:32 PM6/8/17
to nz-orcid-hub
As we're now encouraging test users for the Hub's first production release later this month, here's a recap of the onboarding flow that the Technical Contacts will have to go through to enable the Hub for their researchers.

Note this demonstration uses the production Tuakiri Federation and the ORCID sandbox.

This exchange involves, for each organisation:

1/ An email invitation from the Hub Admin to the Technical Contact containing a link to the Hub
2/ On clicking the Hub link, the Tech Contact is asked to authenticate with their Tuakiri service.  NB: If there's an email mismatch between Tuakiri and the Hub's record, the login is rejected 
3/ They're returned to the Hub's Onboarding page, where they can click the "Take me to ORCID to obtain my Client ID and Client Secret" to be taken to ORCID to ...
4/ For the Test Hub, the Tech Contact is taken the registration page for the ORCID Sandbox API (as much information as we could manage is auto-filled), so the only steps necessary are to prove they're "not a robot" and to click the "Request Credentials" page.

That's it until ORCID responds, usually within a day or two but allow up to a week before contacting the Society, so feel free to log out of the hub.

5/ Any subsequent visit to the hub by the Tech Contact will start at the Onboarding page, so once the credential mail is received, head to https://test.orcidhub.org.nz; log in (as in /2); and copy/paste the Client ID and Secret from the mail into the relevant fields and click "Confirmation".  NB the Hub immediately tries an automated request against the ORCID sandbox, and will warn you if there's any problem with the credentials supplied.

6/ The Tech Contact will receive an automated confirmation email, and the Hub is now open for their researchers to use, i.e., see the "From webpage to an authoritative affiliation in your ORCID record with just 6 clicks" post.  Although while logged-in, why not link your own sandbox ORCID iD.

If you've any questions or would like to start testing with your organisation, please drop a mail to or...@royalsociety.org.nz


-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------


The Technical Contact is sent email by the Hub containing an onboarding link

They'll end up at the Hub's landing page,  


For this we're using https://test.orcidhub.org.nz 


Once there, they click the "Login via Tuakiri" button…

 to be taken to the Tuakiri directory. Where they (2) pick their Home Organisation, and (3) click "Select" to be sent to their institution's sign-on service.


In my case that's the Tuakiri VHO


They enter/confirm their home credentials, click "Login" and are returned to the hub… 

 


 with their identity confirmed.


As this is the first time at the Hub, they need to request API Credentials from ORCID by clicking that "Take me to ORCID to obtain my Client ID and Client Secret" button.



Check the content, and change if necessary; however the intent is to have filled as much as possible, so that the only interaction required is:

Click the "I'm not a robot" checkbox, and if asked satisfy the reCAPTCHA task.

Click "Request Credentials"



At some later date the Tech Contact will receive email from ORCID with the credentials, so they log back into the Test Hub and paste those credentials in and click "Confirmation".

NB: this shows the error after trying with an altered Client Secret.

 

If there's no warning, the Hub is now working for any researcher at that organisation.

Congratulations!

The Tech Contact should soon receive a congratulatory confirmation email, but why not link your own sandbox ORCID iD now.

NB: For more detail on this process, see the "From webpage to an authoritative affiliation in your ORCID record with just 6 clicks" post. 


Now any researchers from your organisation that use the Hub will appear in the "View Researchers" page.  

NB: This page is only accessible to the Organisation's Technical Contact and nominated Organisation Administrators.


Please let or...@royalsociety.org.nz know if you have any problems or questions.

Good luck!



Reply all
Reply to author
Forward
0 new messages