This document discusses how organizations can contribute data to ORCID records to help scholars establish and manage their ORCID IDs. It describes how organizations can encourage scholars to create ORCID IDs on their own sites, create IDs for employees, add works and affiliations to a scholar's ORCID record, and add their own organizational IDs. The document provides examples and steps for implementing these functions using the ORCID API. It also lists additional resources like the ORCID developer documentation, sandbox environment, and upcoming features in the October ORCID launch.
2. iD
Today’s Agenda
• About the ORCID Webinar Series
• Background
• Contributing Data
• Scholar creates ID from your site
• Create IDs for employees
• Add works to a scholar’s Record
• Add your system ID to a scholar’s Record
• Additional Resources
• Next steps
ORCID.org
3. iD
The ORCID Webinar Series
• ORCID Resources (Aug 16, 2012)
Learn about the four components of the ORCID Registry: the Players,
Account & Record, Privacy and Accessing Records. Discover what will be
included in the October launch and helpful resources.
• View the recording: http://goo.gl/nLpVE
• See the slides: http://goo.gl/nuc1W
• Member Site Integration (Aug 30, 2012)
Discover some common uses of the API, and learn how to incorporate them
into your own sites and services.
• View the recording: http://goo.gl/wyaYT
• See the slides: http://goo.gl/9skao
• Contributing Data (Sep 13, 2012)
The production database will soon be live and you will be able to load live
data. Learn about common challenges and how to overcome them.
ORCID.org
5. Understanding the ORCID iD
Registry
Accessing ORCID
Records
ORCID Privacy
The ORCID “Cast”
The ORCID Account
& Record
The ORCID ID
http://orcid.org/0000-0002-3843-3472
• 16-digit number
• Compatible with ISO 277729 standard
• Last character is a checksum (ISO/IEC 7064:2006, MOD 11,2)
• Expressed as an HTTP URI
ORCID.org
6. iD
Accessing ORCID Records
Scholar/Researcher Trusted Organizations
From the Website From the API
CREATE EDIT ADD TO READ CREATE permission:
CREATE
granted by ORCID only if employer
ORCID EDIT permission:
Record
EDIT one time ONLY for short term;
granted at time of edit
APPEND permission:
Proxy(ies) ADD TO one time ONLY for short term;
From the Website granted at time of addition
EDIT ADD TO READ READ
READ permission:
granted until revoked by user
ORCID ORCID
Record Record
Permissions at launch– to be extended overORCID.org
time
8. iD
The Near-term Goal
• Establish the use of ORCID IDs among scholars
• Integrate ORCID IDs in workflows throughout the research
community
• Incorporate research activity data into Records to aid in
future disambiguation efforts
To do this we need:
1. Scholars seeing the benefit of creating ORCID IDs
2. Scholars creating or claiming ORCID IDs
3. Linkage with other systems to synch and update research
activity data
ORCID.org
9. Scholar Creates an ID from Your Site
iD
An Example
From Nature.com – need a credit
Special thank you to nature.com for permission to use screen shots from their system
ORCID.org
10. 3
Scholar Creates an ID from Your Site
iD
An Example
From Nature.com – need a credit
Special thank you to nature.com for permission to use screen shots from their system
ORCID.org
11. Scholar Creates an ID from Your Site
iD
An Example
Special thank you to nature.com for permission to use screen shots from their system
ORCID.org
12. Scholar Creates an ID from Your Site
iD
An Example
ORCID ID
and Name
obtained from
the ORCID
Site
From Nature.com – need a credit
Special thank you to nature.com for permission to use screen shots from their system
ORCID.org
13. iD
Scholar Creates an ID from Your Site
You can encourage users to get ORCID IDs through your own site
1 2 3
Member site Member site sends the user to ORCID site returns
encourages the ORCID site to authenticate to user to the member
scholar to attach / the system or create an site; Member site may
create an ORCID account (read permission is use data to fill forms
ID usually also granted)
ORCID.org
14. Scholar Creates an ID from Your Site
iD
How to do it
1. Encourage User
Ø Given your audience, what is the most compelling reason for a
scholar to have an ORCID ID on your system?
2. Launch the process – send the user to ORCID
Ø Launch a new window with the Authorize URI
Ø URI starts the login/sign up process on the ORCID site
1. asks the user to grant the requested permissions
2. Return user to the redirect_uri with an authorization code
3. Read the ORCID ID/Record and more
Ø Get an access token from the authorization code with the Token URI
Ø Use the token to get information from the ORCID Record and more
Ø Fill a form
Ø Store data for later use
Ø etc
ORCID.org
15. iD
Create IDs for Employees
Organizations can centralize ID/Record creation
1 2 3
Get permission Gather information and create ORCID notifies
from Scholars via the ORCID ID/Record via the scholars who can
your own processes API claim and manage
and policies their ID/Record
ORCID.org
16. iD
Create IDs for Employees
How to do it
1. Get permission from scholars to create records
Ø Using your own internal processes outside of the ORCID system
2. Format and send the scholar information
Ø Format data as an ORCID API Message
Ø Send API Message to the ORCID Server using the /orcid-profile/
create scope for each scholar.
3. ORCID Site asks the scholar to claim the ID/Record
Ø The system notifies the scholars
Ø Scholars claim the record and start to manage it on their own.
ORCID.org
17. iD
Add a Scholar’s Works
Help disambiguate authors by adding works and other research activities from
your records to a scholar’s ORCID Record
1 2 3
Enable scholars on Prepare the ORCID API Send the API Message
your website to Message and ask the scholar up append works to
send meta data for permission to send it the scholar’s Record
about works or
other research
activities to ORCID
ORCID.org
18. iD
Add a Scholar’s Works
How to do it
1. On your site enable scholars to add to their ORCID Record
Ø You choose what to enable
2. Format information and ask permission to send to ORCID
Ø Format one or more works in the ORCID API message format
Ø Launch a new window with the Authorize URI
Ø User grants permission to create works in their ORCID Record
3. Create the ORCID Record element
Ø Get an access token from the authorization code with the Token
URI
Ø Use the code to post works to the ORCID Record
Ø The system confirms the data creation with the scholar via email
ORCID.org
19. iD
Add Your ID to a Scholar’s ORCID Record
Help others to find the scholar on your sites by adding your ID to the scholar’s
ORCID Record.
1 2 3
Enable scholars on Prepare the ORCID API Send the API Message
your website to link Message and ask the scholar up append the
your site’s scholar for permission to send it External-ID to the
page on their scholar’s Record
ORCID Record
ORCID.org
20. Add Your ID to a Scholar’s ORCID Record
iD
How to do it
1. On your site enable scholars to add to their ORCID Record
Ø You choose what to enable
2. Format information and ask permission to send to ORCID
Ø Format external-id element in the ORCIC API Message format
Ø Launch a new window with the Authorize URI; User grants
permission to create external IDs in their ORCID Record
3. Create the ORCID Record element
Ø Get an access token from authorization code with the Token URI
Ø Use the code to post external-ids to the ORCID Record
Ø The system confirms the data creation with the scholar via email
ORCID.org
22. iD
ORCID OAuth URIs
• AUTHORIZE: To get Authorization Code
http://devsandbox.orcid.org/oauth/authorize?
redirect_uri=[URL to return user when done]
&response_type=code
&client_id=[Client ID from your client app registration]
&scope=[The permissions you would like to request]
&access_type=offline
• TOKEN: To get Access Token
http://api.devsandbox.orcid.org/oauth/token?
code=[returned authorization code]
&redirect_uri=[URL to return to when done]
&client_id=[Client ID from your client app registration]
&client_secret=[Client secret from client app reg]
&grant_type=authorization_code
ORCID.org
23. iD
ORCID OAuth URIs
• TOKEN: To get Access Token ** for creating new IDs
http://api.devsandbox.orcid.org/oauth/token?
client_id=[Client ID from your client app registration]
&client_secret=[Client secret from client app reg]
&scope=/orcid-profile/create
&grant_type=client_credentials
ORCID.org
24. iD
The API Message
Ø http://orcid.github.com/ORCID-Parent/schemas/orcid-message/1.0.3/
• Describe the XML message and its sections
• Biography – includes: ORCID
Record
• Lists of External Identifiers Biography
• Lists of Affiliations Activities
• Research Activities • Works
• Works • Grants
• Technologies
• Grants
• Technologies (including patents)
• Message Data Return Formats
ORCID.org
25. iD
Key Resources
• Developer Technical Documentation
http://dev.orcid.org/resources
• Structure of the ORCID ID
http://dev.orcid.org/structure-orcid-identifier
• Read / Query API
http://dev.orcid.org/docs/query-api
• Update / Append API
http://dev.orcid.org/docs/deposit-update-api
• The ORCID API Message
http://orcid.github.com/ORCID-Parent/schemas/orcid-message/1.0.3/
• UML Flow Diagram
http://goo.gl/I9wIB
• Technical Support (Available after launch)
ORCID.org
26. iD
To Be Released in October
For Individuals
• Public Registry – Anyone can create an ORCID ID and search
the Registry
• ORCID Record
• Link ID to other identifier schemes, synch data
• Enhance ID with information on research activities, including
biography, works, grants and technology/products
For Member Organizations
• Updated APIs / XML
• Create IDs for employees and students (institutions only)
• Trusted relationship management to share information
ORCID.org
27. iD
Resource: News/Documentation
• Developers Portal (dev.orcid.org)
• Latest about the Launch (dev.orcid.org/launch)
• Documentation, code samples (dev.orcid.org/resources)
• Blog with the latest updates (dev.orcid.org/blog)
• Links to support (available in Oct)
ORCID.org
28. iD
Resource: Sandbox-Try the API
• Sandbox Site (devsandbox.orcid.org)
• Fully functioning API
• Tokens available at dev.orcid.org/create-client-app
• Limited web interface
• In synch with the production server and Registry
• Non-persistent. Data is refreshed periodically
ORCID.org
29. iD
Next Steps
q Get a token to use the Sandbox
(dev.orcid.org/create-client-app)
q Review documentation
(dev.orcid.org/resources)
q Try the things described in this presentation
q Review previous webinars
(/goo.gl/dGrRe)
• Include links to each
q Subscribe to the blog for the latest updates
(RSS: dev.orcid.org/blog/51/feed)
ORCID.org