Ogólnopolskie Repozytorium Prac Dyplomowych System Informacji o Szkolnictwie Wyższym POL-on Źródła danych i sposób zasilania, formaty i aspekty organizacyjne Strona 1 z 8
Spis treści Spis treści 1.Źródła danych... 3 2.Wprowadzanie za pomocą interfejsu WWW... 3 3.Wprowadzanie danych za pomocą interfejsu typu 'PUSH'... 3 3.1.Słownik pojęć... 3 3.2.Żądanie/Request... 3 3.2.1.Punkt dostępu, nagłówki, uwierzytelnianie... 3 3.2.2.Request body... 4 3.3.Odpowiedź/Response... 5 3.3.1.Nagłówki odpowiedzi... 5 3.3.2.Response body... 5 3.4.Symulacja/ testy... 6 4.Wprowadzanie danych poprzez udostępnienie serwera OAI... 6 4.1.Ogólne zasady... 6 4.2.Uwierzytelnianie... 6 4.3.Metadane... 7 4.3.1.Treść prac... 7 Strona 2 z 8
1.Źródła danych Ogólnopolskie Repozytorium Pracy dyplomowych jest zasilane wyłącznie pracami dyplomowymi przez uczelnie. Uczelnie mają do wyboru trzy zasadnicze metody wprowadzania danych: poprzez interfejs WWW poprzez interfejs REST Push Poprzez udostępnienie serwera OAI-PMH 2.Wprowadzanie za pomocą interfejsu WWW W przypadku wprowadzania danych przez interfejs WWW operator uczelni bezpośrednio za pomocą interfejsu WWW. W ramach tego zadania pracownik tworzy nowy wpis w bazie, uzupełnia wymagane pola i wprowadza pliki pracy dyplomowej zgodne z wymaganiami wskazanymi przez ministerstwo. Użytkownik może wprowadzić nową pracę lub też zaktualizować starą. W przypadku aktualizacji możliwe jest uzyskanie dostępu do poprzednich wersji. 3.Wprowadzanie danych za pomocą interfejsu typu 'PUSH' ORPD udostępnia programowe api do składowania prac dyplomowych jako web service typu REST. Jeśli deponowana praca jest już w systemie, wtedy zostanie ona nadpisana nową wersją. 3.1.Słownik pojęć [system] APD = uczelniane archiwum = repozytorium prac dyplomowych 3.2.Żądanie/Request 3.2.1.Punkt dostępu, nagłówki, uwierzytelnianie Adres: https://polon.nauka.gov.pl/orpd/institutions/{institutioncode}/theses/{thes isexternalnumber} institutioncode - kod jednostki podstawowej, do której należy praca dyplomowa thesisexternalnumber - unikalny numer pracy dyplomowej w systemie APD Akcja/metoda:PUT Content-Type: application/zip Strona 3 z 8
Uwierzytelnianie/autoryzacja: HTTP Basic W nagłówku http Authorization należy wysłać jako username - kod instytucji, a jako password wygenerowane dla niej hasło. Hasło dla instytucji musi wygenerować na stronie orpd ([domena]/institutions/tokens) osoba posiadająca odpowiednie uprawnienia (admin repozytorium instytucji - INST_ORPD_IMPORTER_ADM). Należy pamiętać o zakodowaniu pary username:password algorytemem base64. Uwaga: instytucja, której dane służą do uwierzytelnienia musi być albo instytucją, do której jest przypisywana deponowana praca dyplomowa, albo instytucją w stosunku do niej nadrzędną. Np. jeśli system APD jest ogólnouczelniany (co na ogół ma miejsce), wtedy do uwierzytelniania deponowania prac można wykorzystać parę kod_uczelni:hasło_uczelni dla prac z wszystkich jednostek uczelni (nie trzeba generować specyficznych haseł dla każdej jednostki oddzielnie). 3.2.2.Request body Jako treść żądania należy wysłać plik zip, w którym znajdzie się plik o nazwie thesismetadata.xml zawierający metadane deponowanej pracy dyplomowej (opis niżej) pliki z treścią pracy, załącznikami itd. (np. pdf, png) Uwaga: plik zip nie może zawierać żadnych podkatalogów. thesismetadata.xml Plik ten musi być zgodny ze zdefiniowaną schemą: CrpdDeposit.xsd (załączona w dokumentacji, element depositrequestthesismetadata). Wymagane kodowanie znaków: UTF-8. Przykład: <depositrequestthesismetadata xmlns="http://www.icm.edu.pl/crpd/deposit" xmlns:xsi="http://www.w3.org/2001/xmlschema-instance" xsi:schemalocation="http://www.icm.edu.pl/crpd/deposit crpddeposit.xsd "> <title>życie i twórczość Myszki Miki</title> <author> <firstname>wolfgang</firstname> <lastname>rumburak</lastname> <defencedate>2011-02-02</defencedate> </author> <supervisor> <firstname>adam</firstname> <lastname>mackiewicz</lastname> </supervisor> <supervisor> <firstname>aleksander</firstname> Strona 4 z 8
<lastname>frodo</lastname> </supervisor> <reviewer> <firstname>juliusz</firstname> <lastname>głowacki</lastname> </reviewer> <reviewer> <firstname>maria</firstname> <lastname>monopnicka</lastname> </reviewer> </depositrequestthesismetadata> 3.3.Odpowiedź/Response 3.3.1.Nagłówki odpowiedzi Kody odpowiedzi (Http status code): 200 OK 400 Bad request (gdy np. format thesismetadata.xml niepoprawny) 401 Unauthorized (gdy np. błędne hasło) 403 Forbidden (gdy dana zautentykowana instytucja nie ma uprawnień do deponowania prac instytucji przypisanej do pracy) 404 Not found (gdy np. nie znaleziono instytucji o podanym w adresie url kodzie) ContentType application/xml 3.3.2.Response body Format treści odpowiedzi na żądanie zdeponowania pracy jest określony przez schemę xsd: File:CrpdDeposit.xsd (element depositresponse). Przykład: <?xml version="1.0" encoding="utf-8" standalone="yes"?> <depositresponse xmlns="http://www.icm.edu.pl/crpd/deposit"> <status>ok</status> <message>thesis succesfully deposited: /institutions/10011xxdlmvwn/theses/123</message> </depositresponse> Możliwe odpowiedzi: access denied authentication failed unsupported http method type unsupported http content type Strona 5 z 8
no institution with the given code found not a basic organizational unit not a zip content empty thesis data the size of the zip thesis content exceeds the max allowed size no thesis metadata file found incorrect xml format no subdirectories allowed thesis content files missing internal server error occurred 3.4.Symulacja/ testy Deponowanie prac przez APD można zasymulować narzędziem curl. Przykład wywołania: curl https://crpd-test.icm.edu.pl/institutions/10011xxdlmvwn/theses/123 -u 10011xxdLMVWn:4JbjCA4bTaaEdLl -k -X PUT -v -H "Content-Type: application/zip" --data-binary "@C:\temp\depositData.zip" 10011xxdLMVWn - kod jednostki podstawowej, do której jest przypisana praca oraz (akurat w tym przypadku) kod jednostki, na którą się uwierzytelniamy 4JbjCA4bTaaEdLl - hasło dla jednostki wygenerowane w orpd przez admina (INST_ORPD_IMPORTER_ADM) repozytorium uczelnianego k - pomiń sprawdzanie certyfikatu serwera 4.Wprowadzanie danych poprzez udostępnienie serwera OAI 4.1.Ogólne zasady Uczelniane archiwa prac dyplomowych mogą opcjonalnie udostępniać ORPD metadane i treść prac używając protokołu OAI-PMH (http://www.openarchives.org/pmh/) i standardu OAI-ORE (http://www.openarchives.org/ore/). W takim przypadku ORPD łączy się z takimi repozytoriami periodycznie i pobiera nowe prace. Uczelniany operator archiwum własnoręcznie wskazuje w systemie za pomocą interfejsu WWW informacje o lokalizacji archiwum. 4.2.Uwierzytelnianie Strona 6 z 8
W przypadku pobierania prac z archiwum uczelnianego używana jest autoryzacja wg. Numertów IP, uczelnia uzyskuje informację z jakiego IP będzie łączyć się ORPD i umożliwia mu korzystanie ze swoich zasobów. 4.3.Metadane Obecnie rozumianym przez ORPD formatem metadanych jest DSpace Intermediate Metadata Format (https://wiki.duraspace.org/display/dspace/dspaceintermediatemetadata). ORPD oczekuje, że dane w tym formacie będą udostępnione w odpowiedzi na zapytania OAI-PMH z parameterm metadataprefix=dim. W tym formacie winny być wypełnione następujące pola (wraz z obowiązkowymi kwalifikatorami) element qualifier znaczenie identifier title apd wewnętrzny identyfikator pracy w źródłowym APD tytuł pracy contributor author autor pracy contributor advisor promotor pracy contributor reviewer recenzent pracy contributor departmentbycode kod POL-on podstawowej jednostki organizacyjnej date defence data obrony pracy (rrrr-mm-dd) Wartości pól zawierających imiona i nazwiska osób muszą być podane w formacie: Nazwisko, Imię (nazwisko i imię oddzielone przecinkiem i spacją). Jeśli praca ma więcej niż jednego autora, promotora lub recenzenta odpowiednie pole musi wystąpić wielokrotnie. 4.3.1.Treść prac Dla każdej pracy oprócz metadanych APD musi też udostępnić jej treść. W tym celu musi w odpowiedzi na zapytania z parameterm metadataprefix=ore udostępniać mapy zasobów w formacie Atom zgodne ze specyfikacją OAI-ORE (http://www.openarchives.org/ore/). Mapa dla każdej pracy musi agregować (zawierać odnośniki z parametrem rel="http://www.openarchives.org/ore/terms/aggregates") dostępne dla ORPD za Strona 7 z 8
pomocą protokołu HTTPS pliki z treścią pracy (we wszystkich formatach w jakich APD przekazuje treść danej pracy do ORPD) i tylko takie pliki. Strona 8 z 8