Using the NZ ORCID Hub
The Hub has a simple user interface and can be used to write information to ORCID records.
Who can use the Hub?
Each NZ ORCID consortium member's technical contact can use the Hub to get API credentials from ORCID.
The technical contact and/or your organisation's Hub administrator (if appointed) can use the Hub to read from and write information to your staff/students' ORCID records - with the record holder's permission.
Staff and students at onboarded organisations can use the Hub to give permission for information to be written to /read from their ORCID records - or create an ORCID record if they don't already have one.
Onboarding your organisation to the Hub - technical contacts
Each NZ consortium member organisation's ORCID technical contact person must go through an onboarding and testing stage using sandbox ORCID iDs and the Test NZ ORCID Hub before using the production Hub and 'real' ORCID iDs. Onboarding involves requesting API credentials from ORCID.
Test Hub - guide to onboarding
- Tuakiri-testhub-onboarding-and-testing-process.pdf [PDF 424.08 kb]
- Non Tuakiri - file upload method - guide to onboarding and testing [PDF 478.31 kb]
Production Hub - guide to onboarding
- Production-Hub-guide-to-onboarding-Tuakiri-organisations.pdf [PDF 709.66 kb]
- Production-Hub-onboarding-non-Tuakiri-members.pdf [PDF 665.31 kb]
Using the Hub to read from/write to ORCID records
There are four ways to use the Hub to write information to ORCID records:
- Using the Tuakiri federated identity service (if your organisation is a member) - this writes very basic affiliation information to ORCID records.
- Using a file upload method - this writes rich information to ORCID records.
- Using the Hub's webform to write information for individuals.
- Using the Hub's API.
ORCID communication examples
Before you begin requesting permission from your staff/students to access their ORCID records you should undertake a communications campaign. If you want assistance with creating pens, bookmarks or other ORCID branded giveaways contact us. You can use the followng email examples and tailor them to your specific organisation:
Exemplar emails - use these to tell your staff/students that you plan to use the Hub to read from/write to their ORCID records.
a. Members using Tuakiri to write employment affiliations sample email TK-sample-email-employment-permission-request-and-hub-instructions-v2.0May2018.pdf
b. Members using Tuakiri to write education affiliations sample email TK-sample-email-education-permission-request-and-hub-instructions-v2.0May2018.pdf
c. Members using file upload method to write employment affiliations sample email (use before sending emails generated by the Hub) File-upload-message-employment-pre-Hub-email-v1.0May2018.pdf
d. . Members using file upload method to write education affiliations sample email (use before sending emails generated by the Hub) File-upload-message-education-pre-hub-email-v1.0May2018.pdf
Hub user guide for writing affiliation information to ORCID records
This guide is for technical contacts and organisation administrators. It is a step by step guide to using the Hub to write to ORCID records using both Tuakiri and the file upload method. Hub-User-Guide-writing-affiliationsv2.0-Nov2018.pdf
Sample csv for file upload to the Hub
Sample csv file - use this template for uploading staff/student information to the NZ ORCID Hub in order to write detailed affiliations to ORCID records. Minimum fields required are: first name/last name/email/affiliation type (i.e. staff or student). Partial dates are acceptable so 2017-08-04, 2017-08, 2017 are all valid formats. If non-ascii characters are used please save as UTF-8. If the text contains commas you may wish to use tabs to separate fields.
NB as Excel’s csv format will corrupt any unicode such as letters with macrons or other diacritics , the tsv format is recommended for those creating files with Excel. The easiest way to get a unicode .tsv file from Excel is to “Save As” type “Unicode Text (*.txt)” and then rename the file’s suffix to “.tsv”. Note that in Windows you may need to set up your system to show any hidden file extensions as your file will actually be named xxx.tsv.txt.
To do this go to the Windows startup button (bottom left of your screen), type the words: folder options , into the search box; a pop-up will appear on screen. Click the 'view' tab and uncheck the box 'Hide extensions for known file types'. You will see that your saved file was actually named as xxxx.tsv.txt. Edit to remove the .txt ending before uploading to the Hub.
A sample tsv file is available in the Hub's documentation page.
Collect and Connect Badges for Hub Users
Consortium members who use the NZ ORCID Hub and who provide adequate communications to their users about what ORCID is, why its use is being encouraged within the organisation and how it is being used in the organisation’s internal systems will be eligible for four of ORCID's badges. We have written a model communications page that covers the above what and why questions.
- Model-comm-ORCID-hub-Tuakiri-orgs2.pdf [PDF 368.54 kb]
The Hub itself has been awarded four badges: