Aleph RESTful APIsDr. Harald Jele
Universitat Klagenfurt
Vortrag am 6.5.2014 zum Treffen der SystembibliothekarInnen an der Vorarlberger Landesbibliothek – p. 1
Die Ausgangslage• Mit Aleph lässt sich viel aber nicht alles
erledigen.
Vortrag am 6.5.2014 zum Treffen der SystembibliothekarInnen an der Vorarlberger Landesbibliothek – p. 2
Die Ausgangslage• Mit Aleph lässt sich viel aber nicht alles
erledigen.• Die individuellen Vorstellungen, was wann
wie im System zu erfolgen hat, sind m.u.deutlich voneinander verschieden.
Vortrag am 6.5.2014 zum Treffen der SystembibliothekarInnen an der Vorarlberger Landesbibliothek – p. 2
Die Ausgangslage• Mit Aleph lässt sich viel aber nicht alles
erledigen.• Die individuellen Vorstellungen, was wann
wie im System zu erfolgen hat, sind m.u.deutlich voneinander verschieden.
• Aleph bietet viele Möglichkeiten, an die Dateneiner Institution zu gelangen.
Vortrag am 6.5.2014 zum Treffen der SystembibliothekarInnen an der Vorarlberger Landesbibliothek – p. 2
Die Ausgangslage• Mit Aleph lässt sich viel aber nicht alles
erledigen.• Die individuellen Vorstellungen, was wann
wie im System zu erfolgen hat, sind m.u.deutlich voneinander verschieden.
• Aleph bietet viele Möglichkeiten, an die Dateneiner Institution zu gelangen.
• Die Art und Weise, wie die Daten gespeichertsind, unterliegt keiner (in jedem Fallzuverlässigen) Dauerhaftigkeit.Vortrag am 6.5.2014 zum Treffen der SystembibliothekarInnen an der Vorarlberger Landesbibliothek – p. 2
Was tun Institutionen insolch einer Lage?
• Sie fügen mit der Zeit mehr und mehrRoutinen und Programme in das System ein,mit denen die individuellen Befürfnisseabgedeckt werden.
Vortrag am 6.5.2014 zum Treffen der SystembibliothekarInnen an der Vorarlberger Landesbibliothek – p. 3
Wieso ist dasproblematisch?
• Ist es im Grunde gar nicht. Man muss aberdie Mittel und Möglichkeiten haben, jedeÄnderung im System, die einen betrifft, zuerkennen und entsprechend zu reagieren.Wenn noch jemand in der Bibliothekvorhanden ist, der die Zusammenhängekennt ;-)
Vortrag am 6.5.2014 zum Treffen der SystembibliothekarInnen an der Vorarlberger Landesbibliothek – p. 4
Wo und wie dockt man typi-scherweise bei Aleph an?
• Über das Filesystem (tab17 –Öffnungszeiten).
Vortrag am 6.5.2014 zum Treffen der SystembibliothekarInnen an der Vorarlberger Landesbibliothek – p. 5
Wo und wie dockt man typi-scherweise bei Aleph an?
• Über das Filesystem (tab17 –Öffnungszeiten).
• Über die Datenbankschnittstellen (Oracle).
Vortrag am 6.5.2014 zum Treffen der SystembibliothekarInnen an der Vorarlberger Landesbibliothek – p. 5
Wo und wie dockt man typi-scherweise bei Aleph an?
• Über das Filesystem (tab17 –Öffnungszeiten).
• Über die Datenbankschnittstellen (Oracle).
• Über Aleph-eigene Routinen.
Vortrag am 6.5.2014 zum Treffen der SystembibliothekarInnen an der Vorarlberger Landesbibliothek – p. 5
Wo und wie dockt man typi-scherweise bei Aleph an?
• Über das Filesystem (tab17 –Öffnungszeiten).
• Über die Datenbankschnittstellen (Oracle).
• Über Aleph-eigene Routinen.• Ausgabe über CGI in HTML oder Text via
E-Mail.
Vortrag am 6.5.2014 zum Treffen der SystembibliothekarInnen an der Vorarlberger Landesbibliothek – p. 5
Auszug aus der Liste derErweiterungen der UBK
• Gebührenkorrektur.
Vortrag am 6.5.2014 zum Treffen der SystembibliothekarInnen an der Vorarlberger Landesbibliothek – p. 6
Auszug aus der Liste derErweiterungen der UBK
• Gebührenkorrektur.• Behandlung dritter Mahnungen.
Vortrag am 6.5.2014 zum Treffen der SystembibliothekarInnen an der Vorarlberger Landesbibliothek – p. 6
Auszug aus der Liste derErweiterungen der UBK
• Gebührenkorrektur.• Behandlung dritter Mahnungen.• Zählstatistik für Ausleihschalter.
Vortrag am 6.5.2014 zum Treffen der SystembibliothekarInnen an der Vorarlberger Landesbibliothek – p. 6
Auszug aus der Liste derErweiterungen der UBK
• Gebührenkorrektur.• Behandlung dritter Mahnungen.• Zählstatistik für Ausleihschalter.• Erinnerungs-Email an Benutzer.
Vortrag am 6.5.2014 zum Treffen der SystembibliothekarInnen an der Vorarlberger Landesbibliothek – p. 6
Auszug aus der Liste derErweiterungen der UBK
• Gebührenkorrektur.• Behandlung dritter Mahnungen.• Zählstatistik für Ausleihschalter.• Erinnerungs-Email an Benutzer.• Schließtage mit Rückgaben.
Vortrag am 6.5.2014 zum Treffen der SystembibliothekarInnen an der Vorarlberger Landesbibliothek – p. 6
Auszug aus der Liste derErweiterungen der UBK
• Gebührenkorrektur.• Behandlung dritter Mahnungen.• Zählstatistik für Ausleihschalter.• Erinnerungs-Email an Benutzer.• Schließtage mit Rückgaben.• Offen gebliebenes aus der Fernleihe.
Vortrag am 6.5.2014 zum Treffen der SystembibliothekarInnen an der Vorarlberger Landesbibliothek – p. 6
Auszug aus der Liste derErweiterungen der UBK
• Itemstatus-Check.
Vortrag am 6.5.2014 zum Treffen der SystembibliothekarInnen an der Vorarlberger Landesbibliothek – p. 7
Auszug aus der Liste derErweiterungen der UBK
• Itemstatus-Check.• Formale Prüfung der Aufstellungssystematik.
Vortrag am 6.5.2014 zum Treffen der SystembibliothekarInnen an der Vorarlberger Landesbibliothek – p. 7
Auszug aus der Liste derErweiterungen der UBK
• Itemstatus-Check.• Formale Prüfung der Aufstellungssystematik.• Bestellübersichten.
Vortrag am 6.5.2014 zum Treffen der SystembibliothekarInnen an der Vorarlberger Landesbibliothek – p. 7
Auszug aus der Liste derErweiterungen der UBK
• Itemstatus-Check.• Formale Prüfung der Aufstellungssystematik.• Bestellübersichten.• Budgetübersichten.
Vortrag am 6.5.2014 zum Treffen der SystembibliothekarInnen an der Vorarlberger Landesbibliothek – p. 7
Auszug aus der Liste derErweiterungen der UBK
• Etikettierung.
Vortrag am 6.5.2014 zum Treffen der SystembibliothekarInnen an der Vorarlberger Landesbibliothek – p. 8
Auszug aus der Liste derErweiterungen der UBK
• Etikettierung.• Verwaltung Semesterapparate.
Vortrag am 6.5.2014 zum Treffen der SystembibliothekarInnen an der Vorarlberger Landesbibliothek – p. 8
Auszug aus der Liste derErweiterungen der UBK
• Etikettierung.• Verwaltung Semesterapparate.• XML-RPC-Schnittstelle zur Uni-Verwaltung.
Vortrag am 6.5.2014 zum Treffen der SystembibliothekarInnen an der Vorarlberger Landesbibliothek – p. 8
Auszug aus der Liste derErweiterungen der UBK
• Etikettierung.• Verwaltung Semesterapparate.• XML-RPC-Schnittstelle zur Uni-Verwaltung.• etc., etc.
Vortrag am 6.5.2014 zum Treffen der SystembibliothekarInnen an der Vorarlberger Landesbibliothek – p. 8
Was ist ReST?• Web-Technologie.
Vortrag am 6.5.2014 zum Treffen der SystembibliothekarInnen an der Vorarlberger Landesbibliothek – p. 9
Was ist ReST?• Web-Technologie.• Representational State Transfer.
Vortrag am 6.5.2014 zum Treffen der SystembibliothekarInnen an der Vorarlberger Landesbibliothek – p. 9
Was ist ReST?• Web-Technologie.• Representational State Transfer.• Im Grunde bezeichnet ReST die Idee, dass
ein URL genau einen Seiteninhalt alsErgebnis einer serverseitigen Aktion (etwadas Anzeigen einer Trefferliste nach einerSuche) darstellt.
Vortrag am 6.5.2014 zum Treffen der SystembibliothekarInnen an der Vorarlberger Landesbibliothek – p. 9
Was ist ReST?• Web-Technologie.• Representational State Transfer.• Im Grunde bezeichnet ReST die Idee, dass
ein URL genau einen Seiteninhalt alsErgebnis einer serverseitigen Aktion (etwadas Anzeigen einer Trefferliste nach einerSuche) darstellt.
• Weitere bekannte sind z.B. XML-RPC, SOAP.
Vortrag am 6.5.2014 zum Treffen der SystembibliothekarInnen an der Vorarlberger Landesbibliothek – p. 9
Warum könnte die RESTful-API zu Aleph hier helfen?
• Davon ausgehend, dass die Schnittstellestabil ist.
Vortrag am 6.5.2014 zum Treffen der SystembibliothekarInnen an der Vorarlberger Landesbibliothek – p. 10
Warum könnte die RESTful-API zu Aleph hier helfen?
• Davon ausgehend, dass die Schnittstellestabil ist.
• Trennung der Art der Speicherung der Datenund deren Zugänglichkeit.
Vortrag am 6.5.2014 zum Treffen der SystembibliothekarInnen an der Vorarlberger Landesbibliothek – p. 10
Warum könnte die RESTful-API zu Aleph hier helfen?
• Davon ausgehend, dass die Schnittstellestabil ist.
• Trennung der Art der Speicherung der Datenund deren Zugänglichkeit.
• Ändert sich die Speicherung (z.B. Tabellen,Spalten der Datenbank), muss der Anbieterder API dies nachziehen.
Vortrag am 6.5.2014 zum Treffen der SystembibliothekarInnen an der Vorarlberger Landesbibliothek – p. 10
Warum könnte die RESTful-API zu Aleph hier helfen?
• Davon ausgehend, dass die Schnittstellestabil ist.
• Trennung der Art der Speicherung der Datenund deren Zugänglichkeit.
• Ändert sich die Speicherung (z.B. Tabellen,Spalten der Datenbank), muss der Anbieterder API dies nachziehen.
• Die Abfrage (Methode und Syntax) solltejedoch gleich bleiben.
Vortrag am 6.5.2014 zum Treffen der SystembibliothekarInnen an der Vorarlberger Landesbibliothek – p. 10
Warum könnte die RESTful-API zu Aleph hier helfen?
• Die Entscheidung, sich mit dieserSchnittstelle zu beschäftigen, ist eine reinökonomische und keinesfalls eine technische.
Vortrag am 6.5.2014 zum Treffen der SystembibliothekarInnen an der Vorarlberger Landesbibliothek – p. 11
Warum könnte die RESTful-API zu Aleph hier helfen?
• Die Entscheidung, sich mit dieserSchnittstelle zu beschäftigen, ist eine reinökonomische und keinesfalls eine technische.
• Zudem existiert eine gewisse Neugierdedarauf, was nach Aleph kommen mag undwas einen dann tangieren könnte.
Vortrag am 6.5.2014 zum Treffen der SystembibliothekarInnen an der Vorarlberger Landesbibliothek – p. 11
RESTful-API Doku imRahmen der „EL Commons“
• Customer-Center ->
Vortrag am 6.5.2014 zum Treffen der SystembibliothekarInnen an der Vorarlberger Landesbibliothek – p. 12
RESTful-API Doku imRahmen der „EL Commons“
• Customer-Center ->• EL Commons ->
Vortrag am 6.5.2014 zum Treffen der SystembibliothekarInnen an der Vorarlberger Landesbibliothek – p. 12
RESTful-API Doku imRahmen der „EL Commons“
• Customer-Center ->• EL Commons ->• CodeShare ->
Vortrag am 6.5.2014 zum Treffen der SystembibliothekarInnen an der Vorarlberger Landesbibliothek – p. 12
RESTful-API Doku imRahmen der „EL Commons“
• Customer-Center ->• EL Commons ->• CodeShare ->• Aleph Open Interfaces ->
Vortrag am 6.5.2014 zum Treffen der SystembibliothekarInnen an der Vorarlberger Landesbibliothek – p. 12
RESTful-API Doku imRahmen der „EL Commons“
• Customer-Center ->• EL Commons ->• CodeShare ->• Aleph Open Interfaces ->• Aleph RESTful APIs (seit v.18)
Vortrag am 6.5.2014 zum Treffen der SystembibliothekarInnen an der Vorarlberger Landesbibliothek – p. 12
RESTful-API• Kommunikation funktioniert ausschließlich
über HTTP/HTTPS.
Vortrag am 6.5.2014 zum Treffen der SystembibliothekarInnen an der Vorarlberger Landesbibliothek – p. 13
RESTful-API• Kommunikation funktioniert ausschließlich
über HTTP/HTTPS.• Jeder Aufruf ist ein Weblink zum
Web-Applikations-Server (JBOSS).http://server.name:1892/
Vortrag am 6.5.2014 zum Treffen der SystembibliothekarInnen an der Vorarlberger Landesbibliothek – p. 13
RESTful-API• Kommunikation funktioniert ausschließlich
über HTTP/HTTPS.• Jeder Aufruf ist ein Weblink zum
Web-Applikations-Server (JBOSS).http://server.name:1892/
• Weblink beinhaltet das aufgerufeneProgramm, das am Web-Server ausgeführtwird:http://server.name:1892/rest-dlf/record/
Vortrag am 6.5.2014 zum Treffen der SystembibliothekarInnen an der Vorarlberger Landesbibliothek – p. 13
RESTful-API• Einen Wert, der dem Programm übergeben
wird, sowie optionale Parameter:http://server.name:1892/rest-dlf/record/<record id>/items?view=full
Vortrag am 6.5.2014 zum Treffen der SystembibliothekarInnen an der Vorarlberger Landesbibliothek – p. 14
RESTful-API• Einen Wert, der dem Programm übergeben
wird, sowie optionale Parameter:http://server.name:1892/rest-dlf/record/<record id>/items?view=full
• Die Antwort, die der Web-Server liefert ist inXML-Notation gehalten. In diesem Fall dieExemplarliste zu einem Titel aufgrund seinerSystemnummer im Vollformat.
Vortrag am 6.5.2014 zum Treffen der SystembibliothekarInnen an der Vorarlberger Landesbibliothek – p. 14
RESTful-API• Die Daten eines spezifischen Exemplars
werden abgerufen durch:http://server.name:1892/rest-dlf/record/<record id>/items/<item id>/
Vortrag am 6.5.2014 zum Treffen der SystembibliothekarInnen an der Vorarlberger Landesbibliothek – p. 15
RESTful-API• Die Daten eines spezifischen Exemplars
werden abgerufen durch:http://server.name:1892/rest-dlf/record/<record id>/items/<item id>/
• Daran erkennt man die Architektur derSchnittstelle: sie ist rein hierarchischangelegt. Das heisst, um zu den eigentlichenInhalten zu gelangen, muss man die„übergeordneten“ Informationen besitzen.
Vortrag am 6.5.2014 zum Treffen der SystembibliothekarInnen an der Vorarlberger Landesbibliothek – p. 15
Beispiel: Benutzeraktion
Vortrag am 6.5.2014 zum Treffen der SystembibliothekarInnen an der Vorarlberger Landesbibliothek – p. 16
RESTful-API• Vormerkungen für Benutzer-ID 0036:
http://server.name:1892/rest-dlf/patron/0036/circulationActions/requests/holds
Vortrag am 6.5.2014 zum Treffen der SystembibliothekarInnen an der Vorarlberger Landesbibliothek – p. 17
RESTful-API• Vormerkungen für Benutzer-ID 0036:
http://server.name:1892/rest-dlf/patron/0036/circulationActions/requests/holds
• Vormerkungen innerhalb einer LIB:http://server.name:1892/rest-dlf/patron/0036/circulationActions/requests/holds?institution=UBK50
Vortrag am 6.5.2014 zum Treffen der SystembibliothekarInnen an der Vorarlberger Landesbibliothek – p. 17
Antwort: Vormerkungsliste
Vortrag am 6.5.2014 zum Treffen der SystembibliothekarInnen an der Vorarlberger Landesbibliothek – p. 18
Antwort: Vormerkung Detail
Vortrag am 6.5.2014 zum Treffen der SystembibliothekarInnen an der Vorarlberger Landesbibliothek – p. 19
Die Krux mit der Hierarchie• . . . beginnt immer dann, wenn man sie selbst
nicht auflösen kann (Top-Down).
Vortrag am 6.5.2014 zum Treffen der SystembibliothekarInnen an der Vorarlberger Landesbibliothek – p. 20
Die Krux mit der Hierarchie• . . . beginnt immer dann, wenn man sie selbst
nicht auflösen kann (Top-Down).• Dies ist meist der Fall, wenn man
Informationen erfragen möchte, dieexemplarspezifisch sind (Bottom-Up).
Vortrag am 6.5.2014 zum Treffen der SystembibliothekarInnen an der Vorarlberger Landesbibliothek – p. 20
Die Krux mit der Hierarchie• . . . beginnt immer dann, wenn man sie selbst
nicht auflösen kann (Top-Down).• Dies ist meist der Fall, wenn man
Informationen erfragen möchte, dieexemplarspezifisch sind (Bottom-Up).
• Ausgangspunkt solcher Abfragen sind dannzumeist der Barcode, eine Bestellnummer,eine Signatur . . .
Vortrag am 6.5.2014 zum Treffen der SystembibliothekarInnen an der Vorarlberger Landesbibliothek – p. 20
Die Krux mit der Hierarchie• . . . und man kennt üblicherweise nicht die
dazugehörige Systemnummer des Titels undden Item-Record-Key, um an dieExemplarinformationen zu gelangen.
Vortrag am 6.5.2014 zum Treffen der SystembibliothekarInnen an der Vorarlberger Landesbibliothek – p. 21
Die Krux mit der Hierarchie• . . . und man kennt üblicherweise nicht die
dazugehörige Systemnummer des Titels undden Item-Record-Key, um an dieExemplarinformationen zu gelangen.
• Hier wäre eine Art „Resolver“ notwendig, deraufgrund solcher Informationen denhierarchischen Baum auflöst, um mit diesenInformationen weiterarbeiten zu können.
Vortrag am 6.5.2014 zum Treffen der SystembibliothekarInnen an der Vorarlberger Landesbibliothek – p. 21
Die Bescheidenheit
Vortrag am 6.5.2014 zum Treffen der SystembibliothekarInnen an der Vorarlberger Landesbibliothek – p. 22
Die Bescheidenheit• Kein Zugang zu Bestell-Informationen oder
Budgets.
Vortrag am 6.5.2014 zum Treffen der SystembibliothekarInnen an der Vorarlberger Landesbibliothek – p. 23
Die Bescheidenheit• Kein Zugang zu Bestell-Informationen oder
Budgets.• Aber auch kein Zugang zu allen anderen
Informationen, die mit einem Exemplarverknüpft sind.
Vortrag am 6.5.2014 zum Treffen der SystembibliothekarInnen an der Vorarlberger Landesbibliothek – p. 23
Die Bescheidenheit• Kein Zugang zu Bestell-Informationen oder
Budgets.• Aber auch kein Zugang zu allen anderen
Informationen, die mit einem Exemplarverknüpft sind.
• Und diese bildeten im Wesentlichen ja denAusgangspunkt der Fragestellung.
Vortrag am 6.5.2014 zum Treffen der SystembibliothekarInnen an der Vorarlberger Landesbibliothek – p. 23
Die Nützlichkeit• Es sind genau jene Funktionen definiert, die
man braucht, wenn man typische Funktioneneines OPACs in einem ExLibris-fremdenProdukt (z.B. VuFind in Kombination mitAleph) abbilden möchte.
Vortrag am 6.5.2014 zum Treffen der SystembibliothekarInnen an der Vorarlberger Landesbibliothek – p. 24
Die Nützlichkeit• Es sind genau jene Funktionen definiert, die
man braucht, wenn man typische Funktioneneines OPACs in einem ExLibris-fremdenProdukt (z.B. VuFind in Kombination mitAleph) abbilden möchte.
• Dazu gehören Funktionen wie Verfügbarkeit,Vormerkungen, Verlängerungen,Bestellungen, Fernleihaktivitäten, Kontostandetc.
Vortrag am 6.5.2014 zum Treffen der SystembibliothekarInnen an der Vorarlberger Landesbibliothek – p. 24
Vielen Dank für dieAufmerksamkeit
Vortrag am 6.5.2014 zum Treffen der SystembibliothekarInnen an der Vorarlberger Landesbibliothek – p. 25