ORCID id an der TUM. Dipl.-Ing. (Univ.) Andreas Bernhofer Technische Universität München IT-Management Düsseldorf, 12.

Transkript

1 ORCID id an der TUM Dipl.-Ing. (Univ.) Andreas Bernhofer Technische Universität München IT-Management Düsseldorf, 12. September 2018

2 Vorschau Was ist ORCID / ORCID id? Weshalb ORCID an der TUM? Verknüpfung der ORCID id / Ablauf für den Nutzer (Demo) ORCID API Implementierung in TUMonline (CAMPUSonline) ORCID id im Directory Disclaimer: Der Vortrag enthält wenig bunte Grafiken, dafür (bunten) Code! 3

3 ORCID id ORCID (Open Researcher and Contributor ID) ist eine Non-Profit-Organisation, die eindeutige Identifizierungsnummern (ORCID ids) für Autorinnen und Autoren vergibt. Diese Nummern werden von vielen ORCID-Mitgliedern zur Autorenidentifikation verwendet. Die ORCID id ist eine unbegrenzt gültige Identifizierungsnummer für eine einzelne Person. Sie besteht aus 16 Ziffern, die in Viererblöcken dargestellt sind. Als Teil einer ORCID- Webadresse verweist sie auf das ORCID-Profil einer Person, in dem institutionenunabhängig und dauerhaft weitere Daten hinterlegt werden können Die Deutsche Forschungsgemeinschaft (DFG) fördert die Verbreitung der ORCID id in Deutschland seit 2016 mit dem auf drei Jahre angelegten Projekt ORCID DE Förderung der Open Researcher and Contributor ID in Deutschland. Das Projekt zielt darauf ab, die Implementierung der ORCID id an Hochschulen und außeruniversitären Forschungseinrichtungen in Deutschland organisatorisch, rechtlich und technisch zu unterstützen. 4

4 ORCID id - Profil 5

5 ORCID id an der TUM Insbesondere seitens der Universitätsbibliothek der TUM entstand der Wunsch, die ORCID id als Identifikationsmerkmal unserer Nutzer zu erfassen, um damit Publikationen zuordnen zu können. Angestrebte Lösung: Einfache und freiwillige Erfassung der ORCID id durch den Nutzer in unserem zentralen Campus-Management-System TUMonline Provisionierung in angeschlossene Verzeichnisse (Meta-Directory, Shibboleth IdP, Bib) ORCID id muss korrekt und Inhaberschaft geprüft sein (keine manuelle Texteingabe) Umsetzung als Erweiterung für TUMonline (CAMPUSonline) 6

6 ORCID id an der TUM Klick-Pfad in TUMonline (ggf. Live Demo) 7

7 ORCID id in TUMonline 8

8 ORCID id in TUMonline 9

9 ORCID id in TUMonline 10

10 ORCID id in TUMonline 11

11 ORCID id in TUMonline Wie funktioniert die automatische Übermittlung der ORCID id an TUMonline? OAuth! 12

12 ORCID als OAuth2 ID Provider ORCID bietet eine OAuth2 basierte REST API für den Zugriff auf einen ORCID Account. Diese API steht prinzipiell jedem Nutzer offen, sodass keine Absprache mit ORCID für die Nutzung nötig ist. Für Organisationen gibt es allerdings auf Anfrage spezielle Konditionen (erweiterte Berechtigungen). Der Nutzer autorisiert den Zugriff auf diese API durch Login. Vorteile: ORCID id ist fehlerfrei erfasst Inhaberschaft ist verifiziert Erfassung ist mit einem Klick/Login erledigt OAuth Token könnte in Zukunft genutzt werden, um Daten in das ORCID Profil zu schreiben 13

13 ORCID API Zwei Arten von API für eigene Apps verfügbar: Public API Für jeden ORCID Nutzer direkt nutzbar Authentifizierung und lesender Profilzugriff möglich (hinreichend für Integration) API CLIENT_ID ist dem ORCID Nutzer als Admin zugeordnet Verwaltung über die Website ( ) Member API Nur nutzbar für zahlende ORCID Mitglieder/Einrichtungen API CLIENT_ID ist nicht an persönlichen Account gebunden Erlaubt das schreiben von Profilinformationen im Kontext der Einrichtung Für Mitglieder des ORCID DE Konsortiums inbegriffen Verwaltung zum Teil schriftlich über ORCID Support Link: 14

14 API Client registrieren (1/3) 15

15 API Client registrieren (2/3) 16

16 API Client registrieren (3/3) 17

17 ORCID id abrufen: OAuth Flow (1/2) 1. Nutzer auf client_id=app-zhivgw81eortmi6a &response_type=code &scope=/authenticate &redirect_uri= &state=42 leiten 2. Nutzer loggt sich auf orcid.org ein und bestätigt 3. Nutzer wird auf zurück geleitet. 19

18 ORCID id abrufen: OAuth Flow (2/2) 4. Code serverseitig gegen Token eintauschen (Beispiel mittels curl): curl --data "client_id=app-hivgw81eortmi6a&client_secret=b42bb21d- ***-0032a&grant_type=authorization_code&code=IQMXjB" 5. Antwort enthält ORCID id und Access-Token für ggf. weitere API Aufrufe: { "access_token":"0b ***-91894e77d0c1", "token_type":"bearer", "refresh_token":" c-***-ac11fc690911", "expires_in": , "scope":"/authenticate", "name":"josiah Carberry", "orcid":" " } Doku: 20

19 Entwicklung in TUMonline CO Crashkurs (1/2) TUMonline (CAMPUSonline) basiert auf einer Oracle Datenbank sowohl für die Haltung der Daten (Tabellen) als auch des Programmcode (Stored Procedures / Packages; PL/SQL) HTTP Aufrufe werden anhand der URL auf Datenbankprozeduren gemappt, welche als Ausgabe die HTTP Antwort erzeugen z.b. Datenbank-Package visitenkarte Prozedur show_vcard Parameter ppersonenid CAMPUSonline gestattet den Kunden das Anlegen eigener Packages mit Prozeduren, wodurch das System einfach erweitert werden kann (Namenskonvention co_loc ) z.b. Datenbank-Package co_loc_wborcid Prozedur init Lokale Erweiterung wird von CAMPUSonline Produktupdates nicht beeinträchtigt 21

20 Entwicklung in TUMonline CO Crashkurs (2/2) Aus dem eigenen Programmcode kann Code aus dem CAMPUSonline Framework aufgerufen werden, wodurch Zugriff auf die Session des Nutzers besteht, sowie einfach eine Ausgabe im CAMPUSonline Look n Feel erzeugt werden kann CAMPUSonline ermöglich es zusätzlich, dem Nutzer beliebige URLs ( Apps ) auf seiner Startseite zu verlinken Lokale Erweiterungen sind dadurch gut integrierbar 22

21 Entwicklung in TUMonline Code 1/5 Spezifikation des Datenbank-Package co_loc_wborcid PACKAGE co_loc_wborcid IS -- ORCID ID Startseite -- PROCEDURE init ( success IN VARCHAR2 DEFAULT NULL, error IN VARCHAR2 DEFAULT NULL, deleted IN VARCHAR2 DEFAULT NULL ); -- OAuth redirect endpoint (wird mit OAuth Code aufgerufen, wenn Nutzer auf orcid.org authentifiziert wurde) -- Diese URL ist als redirect_uri in der App-Konfiguration auf orcid.org anzugeben -- PROCEDURE oauth2receiver ( code IN VARCHAR2 DEFAULT NULL, error IN VARCHAR2 DEFAULT NULL, error_description IN VARCHAR2 DEFAULT NULL, scope IN VARCHAR2 DEFAULT NULL, state IN VARCHAR2 DEFAULT NULL ); -- Weitere Prozeduren (Löschen, Admin-Ansicht, Sicht auf ORCID eines Dritten,...) END; 24

22 Entwicklung in TUMonline Code 2/5 PROCEDURE init ( success IN VARCHAR2 DEFAULT NULL, error IN VARCHAR2 DEFAULT NULL, deleted IN VARCHAR2 DEFAULT NULL ) IS vurl VARCHAR(2000); BEGIN -- CAMPUSonline Framework, erzeugt Seitenheader etc... copage.open(cpageid); -- Prüfen ob der Nutzer eingeloggt ist IF NOT pusession.isidentified() THEN coerror.raisenotidentified(); END IF; -- Anzeige von Info-/Fehlermeldungen wenn Flags dafür gesetzt sind IF success IS NOT NULL THEN comsg.addinfo(cotext.new('$co_loc_orcid_connection_success')); END IF; /* analog für "error" und "deleted" */ IF getuserorcid() IS NOT NULL THEN -- Nutzer hat bereits eine ORCID id hinterlegt - diese wird ihm angezeigt copage.add(cotext.replace(cotext.new('$co_loc_orcid_section_hasorcid'), 'ORCID', getuserorcid())); ELSE -- Nutzer hat keine ORCID id, daher den Info-Text und Link anzeigen vurl := puappl.getcharparameter(pparametername=>'api_url'); vurl := REPLACE(vUrl, '%CLIENT_ID%', puappl.getcharparameter(pparametername=>'client_id')); vurl := REPLACE(vUrl, '%STATE%', puxsrf.getxrtoken); copage.add(cotext.replace(cotext.new('$co_loc_orcid_section_noorcid'), 'URL', vurl); END IF; copage.close(); END; 25

23 Entwicklung in TUMonline Code 3/5 PROCEDURE oauth2receiver( code IN VARCHAR2 DEFAULT NULL, error IN VARCHAR2 DEFAULT NULL, error_description IN VARCHAR2 DEFAULT NULL, scope IN VARCHAR2 DEFAULT NULL, state IN VARCHAR2 DEFAULT NULL ) IS vtimeout NUMBER DEFAULT 5000; vreq utl_http.req; Viel mehr Variablen ;) BEGIN -- Prüfen ob der Nutzer eingeloggt ist IF NOT pusession.isidentified() THEN coerror.raisenotidentified(); END IF; -- ORCID id schon verknüpft? IF getuserorcid() IS NOT NULL THEN coerror.raise(ptext=>cotext.new('orcid_id_already_linked')); ELSE -- state gültig? IF NOT puxsrf.isxrtokenvalid(state) THEN coerror.raise(ptext=>cotext.new('state_mismatch')); END IF; -- code übergeben? IF code IS NULL THEN coerror.raise(ptext=>cotext.new('no_code')); END IF; -- Ab hier nehmen wir an dass wir einen Code zum Abruf des Token erhalten haben 26

24 Entwicklung in TUMonline Code 4/5 -- HTTP Request vorbereiten utl_http.set_transfer_timeout(vtimeout); utl_http.set_body_charset('utf-8'); vreq := utl_http.begin_request(' 'POST', 'HTTP/1.1'); utl_http.set_header(vreq, 'Accept', 'application/json'); -- Parameter (für POST Body) vorbereiten vparams := 'client_id=' htf.escape_url(puappl.getcharparameter(pparametername=>'client_id')) '&client_secret=' htf.escape_url(puappl.getcharparameter(pparametername=>'client_secret')) '&redirect_uri=' htf.escape_url(puappl.getcharparameter(pparametername=>'redirect_url')) '&grant_type=authorization_code&code=' htf.escape_url(code); utl_http.set_header(vreq, 'Content-Type', 'application/x-www-form-urlencoded'); utl_http.set_header(vreq, 'Content-Length', LENGTHB(vParams)); -- Request absetzen utl_http.write_raw(vreq, data => UTL_RAW.CAST_TO_RAW(vParams)); -- Response einlesen (Loop bis "end_of_body" exception; in anderen Sprachen ein Einzeiler ;)) vresp := utl_http.get_response(vreq); BEGIN LOOP utl_http.read_text(vresp, vrespbuff, 4096); DBMS_LOB.writeappend(vRespText, LENGTH(vRespBuff), vrespbuff); END LOOP; EXCEPTION WHEN utl_http.end_of_body THEN utl_http.end_response(vresp); END; 27

25 Entwicklung in TUMonline Code 5/5 IF vresp.status_code = 200 THEN -- Daten in der Datenbank speichern INSERT INTO orcid_ids ( IDENT_NR, ORCID_ID, ACCESS_TOKEN, REFRESH_TOKEN, TOKEN_TYPE, EXPIRES, NAME, CREATED ) VALUES ( pusession.getidentitaetnr, parsejsonstring(vresptext, 'orcid'), parsejsonstring(vresptext, 'access_token'), parsejsonstring(vresptext, 'refresh_token'), parsejsonstring(vresptext, 'token_type'), CURRENT_TIMESTAMP + numtodsinterval( parsejsonnumber(vresptext, 'expires_in'), 'second' ), parsejsonstring(vresptext, 'name'), CURRENT_TIMESTAMP ); -- Nutzer auf Startseite leiten. Diese Seite wurde in einem Popup geöffnet! -- Daher redirect über JavaScript statt Location-Header! htp.p('<script> window.opener.location.href="co_loc_wborcid.init?success=true"; self.close(); // Popup schließen </script>'); ELSE /* Fehlerbehandlung! */ 28

26 ORCID id im LDAP / MetaDirectory TUMonline synchronisiert die gespeicherte ORCID id, basierend auf einem Trigger auf der Datenbank- Tabelle, direkt ins MetaDirectory (gleicher Mechanismus wie für alle Nutzer-Attribute). Im Directory wird die ORCID id als multi-value edupersonorcid in URL Syntax ( ) abgelegt. 1), 2) Keine konkrete Vorgabe ob oder verwendet werden soll: Values MUST be valid ORCID identifiers in the ORCID-preferred URL representation. Beispiele sind mit gehalten. ORCID selbst schreibt aber: Our recommended display is a full https URI ( ) 3) Da die Beispiele der Attributdefinitionen deutlich einfacher zu finden sind als die ORCID Display Guidelines (die ausserdem primär Web und Print behandeln), haben wir bei uns verwendet. \_( ツ )_/ 1), 2)

27 Stand / Ausblick Aktuell ~2.000 TUM Nutzer mit hinterlegter ORCID id ORCID Profil ist öffentlich sichtbar auf den TUMonline Profilen der Nutzer verlinkt Verknüpfung könnte genutzt werden um Daten in das ORCID Profil der Nutzer abzulegen, z.b. bestätigte Beschäftigungsverhältnisse, Abschlüsse, Veröffentlichungen Login an TUMonline mit ORCID id möglich? 30

28 Fragen? 31