AAF-ORCID Webinar - Understanding ORCID Integration

30

Transcript of AAF-ORCID Webinar - Understanding ORCID Integration

Page 1: AAF-ORCID Webinar - Understanding ORCID Integration
Page 2: AAF-ORCID Webinar - Understanding ORCID Integration

INTRODUCTIONS

MelroyAlmeidaTechnicalSupportAnalyst

Elleina FilippiServiceDeliveryManager

DaliaAbrahamTechnicalSupportAnalyst

TerrySmithTechnicalManager

AAFSupportTeam:

Page 4: AAF-ORCID Webinar - Understanding ORCID Integration

WHO THIS SESSION WILL BENEFIT

• Decision makers / Project managers on ORCID integration

• Anyone else who is involved in an ORCID integration

• Software developers involved in an ORCID integration

• Business Analysts involved on an ORCID integration

Page 5: AAF-ORCID Webinar - Understanding ORCID Integration

OBJECTIVES § Know the different ORCID API’s available

§ Understand the difference between Public API and Member API

§ The benefits of a member API

§ Understand ORCID integration with Vendor Systems

§ Understand custom ORCID integration

§ Understand what the Australian ORCID consortium lead can do for you ?

Page 6: AAF-ORCID Webinar - Understanding ORCID Integration

WHAT IS ORCID

Open Researcher and Contributor ID

Data source that describes connection between a researcher and their works.

Unique to a researcher

Persistent identifier

Page 7: AAF-ORCID Webinar - Understanding ORCID Integration

• Identity provider, assurance of identity

• Repository of works

• Software services provider

• Provider of unique identifiers

• Data source describing connection between researcher and her/his works

• Open API provider

IS IS NOT

Page 8: AAF-ORCID Webinar - Understanding ORCID Integration

WHY ORCID ?Unique, persistent and open identifier

For Researchers Time saving / easy to use

Researchers are in control

Enables discoverability and recognition

They are being required by publishers and funders.

Page 9: AAF-ORCID Webinar - Understanding ORCID Integration

WHY ORCID ?

88% of respondents from ANZ agree/strongly agree that integrating ORCID at their organization would support better data quality

For Organisations

I want the internet to work better and persistent identifiers are the way to go (66% respondents from ANZ )

Page 10: AAF-ORCID Webinar - Understanding ORCID Integration

BENEFITS TO ORGANISATIONS • Alleviates mistaken identity

• Enables machine to machine update for researcher reporting

• Reduces need for researcher disambiguation process

• Strengthens connection/stickiness of researchers to system

• Maintains researcher’s connection even if name or affiliation changes.

Page 11: AAF-ORCID Webinar - Understanding ORCID Integration

MEMBER BASICS

ORCID is a hub for machine-readable connections between identifiers for organizations, funding, outputs and people

Researchers interact with ORCID via the ORCID website .

Members have systems that interact with the ORCID via the API.

Page 12: AAF-ORCID Webinar - Understanding ORCID Integration

ORCID API

Page 13: AAF-ORCID Webinar - Understanding ORCID Integration

API

Lets one software program talk to another software program and exchanges data behind the scene

Application Programming Interface

Example: What is an API (video link)

Page 14: AAF-ORCID Webinar - Understanding ORCID Integration

ORCID API IN A NUTSHELL

Permissions / scopes : Your contract with the user

ORCID messages : Format of the data exchanged

Oauth calls : (permission protocol) How you “execute the contract”

ORCID-specific calls : Providing and receiving information from the registry.

Page 15: AAF-ORCID Webinar - Understanding ORCID Integration

ORCID HAS 3 API’S

• Authenticate

• READ (Public)

• Register

• Single API credential

Public API Basic Member API Premium Member API

• All features of Public API

• READ (Limited)

• ADD

• UPDATE

More information: ORCID membership comparision

• All features of Member API

• 5 API credentials

• Webhooks

• Monthly reports

Page 16: AAF-ORCID Webinar - Understanding ORCID Integration

HOW DO I GET STARTED ?

Page 17: AAF-ORCID Webinar - Understanding ORCID Integration

BEFORE PLANNING INTEGRATION CONSIDER…

• What benefits will an ORCID integration provide to your organization

• What are your organizations priorities for integrating with ORCID

• Who are potential stakeholders at your organization that have a vested interest in ORCID

Page 18: AAF-ORCID Webinar - Understanding ORCID Integration

2 Models

Vendor System Custom Connection

Page 19: AAF-ORCID Webinar - Understanding ORCID Integration

VENDOR SYSTEMS

• Repository System E.g.- Dspace, ePrints, Hydra/Fedora

• Publishing and Manuscript submission systems. E.g.- eJournalPress, Open Journal System, ScholarOne

Some vendor systems for research information have built-in ORCID Integration

More information: ORCID enabled systems

• Current Research Information Systems (CRIS) E.g.- Elements, Converis, IRMA, Pure, Vivo etc

Page 20: AAF-ORCID Webinar - Understanding ORCID Integration

CUSTOM CONNECTION

• User-flows

• Customised buttons and user feedback

• Fine-tuned control

More information: ORCID current integration list

Done through the ORCID member API

Page 21: AAF-ORCID Webinar - Understanding ORCID Integration

WHICH MODEL SHOULD I USE ?

• Where does ORCID fit into your existing systems ?

• Think about your workflow and see what others are doing. e.g: AAF ORCID- Greenhouse

• What information will be exchanged ?

• Are you using a vendor system that supports ORCID ?

• What do you communicate about ORCID to your researchers ?

Page 22: AAF-ORCID Webinar - Understanding ORCID Integration

STEPS TO INTEGRATION

PLAN:

• How will you use the collected ORCID iD’s ?

• How your integration will work ?

• What does your institution want to do with ORCID iD’s ?

• At what point will you target your users ?

Relates to the permission / scopes you request

Page 23: AAF-ORCID Webinar - Understanding ORCID Integration

STEPS TO INTEGRATION

• Read the XML Schema used by ORCID

• Register for Sandbox credentials

• Read the ORCID API calls and tutorials

• Build / develop / test your application in ORCID Sandbox environment

• Demonstrate working of application to ORCID Support and Consortium Lead

BUILD: build and test your integration

Page 24: AAF-ORCID Webinar - Understanding ORCID Integration

STEPS TO INTEGRATION

• Authorize confirmation page

• ORCID guidelines

• Sign-in button

• Deny / reconsider page

COMMUNICATE:

Page 25: AAF-ORCID Webinar - Understanding ORCID Integration

BEFORE INTEGRATION, DO THE HARD WORK …..

• Top down , bottom up approach

• Start small – identify pilot groups to roll out integration to

• Identify existing ORCID users at your institutions to be champions.

• Regular updates and reminders

• Keep messages relevant

EVANGELISM

COMMUNICATIONS

Rollout -TIMING

Page 26: AAF-ORCID Webinar - Understanding ORCID Integration

WHAT CAN THE CONSORTIUM LEAD

(CL) DO ?

Page 27: AAF-ORCID Webinar - Understanding ORCID Integration

• Document member integration use-cases and disseminate to consortium members

WHAT CAN THE CL DO FOR YOU ?

• Provide assistance with planning your integration

• Provide Tier 1 support

• Act as a conduit between consortium members and ORCID

Page 28: AAF-ORCID Webinar - Understanding ORCID Integration

• Ask us on questions you do not know the answer to - email [email protected]

NEED HELP FINDING ANSWERS ?

• Start at http://members.orcid.org/api

• For face to face discussions, send an email to [email protected] and we can schedule a meeting.

• Check the ORCID resources on AAF website https://aaf.edu.au/orcid/resources.html

Page 29: AAF-ORCID Webinar - Understanding ORCID Integration

RESOURCES

• API Documentation – http://members.orcid.org/api

• List of supported vendor systems – http://members.orcid.org/orcid-enabled-systems

• ORCID iDeas Forum - http://support.orcid.org/forums/175591

• ORCID Api Tutorials - https://members.orcid.org/api/tutorials

• The ORCID message format (XSD) - https://github.com/ORCID/ORCID-

Source/blob/master/orcid-model/src/main/resources/README.md

• ORCID Error Codes – http://members.orcid.org/api/api-error-codes

• AAF – ORCID Greenhouse - https://aaf.edu.au/orcid/greenhouse.html

Page 30: AAF-ORCID Webinar - Understanding ORCID Integration

QUESTIONS ?