1. Wozu dient das XML-Ausgabeformat der EZB?

Die UB Regensburg hat für die EZB ein XML-Ausgabeformat entwickelt, das es ermöglicht, das Angebot der EZB auf eine beliebige Website einzubinden und die Inhalte im eigenen Layout darzustellen.

2. Wie ist das Vorgehen zur Nutzung des XML-Ausgabeformates der EZB?

Beispiele für die Präsentation der E-Zeitschriften aus der EZB im Layout der eigenen Einrichtung:

3. Grundsätzliches zum Aufruf der EZB-Services

Alle EZB-Services werden über HTTP GET-Requests nach dem Muster
http://ezb.uni-regensburg.de/ezeit/<skriptname>.phtml?bibid=UBR&colors=7&lang=de&...<skriptspezifische Parameter>...&xmloutput=1
aufgerufen.

Da in der EZB die Lizenzdaten von 647 Anwendereinrichtungen verwaltet werden, ist das Ergebnis des Aufrufs eines EZB-Service abhängig von der aktuell gewählten Sicht. Die Wahl der aktuellen Sicht wird durch die Parameter bibid, client_ip, colors und lang beim Aufruf des Service bestimmt.

Die aktuellen Werte der Parameter bibid, colors und lang werden im XML-Response mit übergeben, sie sollten für weitere Aufrufe verwendet werden.

3.1 Die Standardparameter bibid, client_ip, colors und lang

Der Parameter bibid bestimmt, welche Teilnehmereinrichtung für die Anzeige der Lizenzinformationen herangezogen wird. Die Liste der möglichen bibid's kann über einen Service abgefragt werden. Falls keine bibid angegeben ist, wird die Teilnehmereinrichtung beim direkten Aufruf einer EZB-Seite durch den Browser eines Benutzers anhand der IP-Adresse des anfragenden Rechners bestimmt. Beim Aufruf eines EZB-Services, der nicht durch den Rechner des Benutzers direkt, sondern durch einen vermittelnden Server erfolgt, sollte bei fehlender bibid die IP-Adresse des beim vermittelnden Server anfragenden Clients im Parameter client_ip übergeben werden.

Mit dem Parameter colors wird ausgewählt, welche Einträge für Zeitschriften angezeigt werden sollen. Der Wert 1 steht für Zeitschriften mit frei zugänglichen Volltextartikeln, 2 für Zeitschriften, bei denen der Zugriff auf die Volltexte für die jeweilige Institution lizenziert ist und 4 für Zeitschriften, bei denen nicht auf Volltextartikel zugegriffen werden kann. Durch Aufsummieren der Werte sind beliebige Kombinationen möglich, der Standardwert ist 7 (für alle Zeitschriften).

Der Parameter lang legt fest, welche Sprache in der XML-Antwort verwendet wird. Mögliche Werte sind de für deutsch und en für englisch, die Standardeinstellung ist de. Falls ein EZB-Teilnehmer keine englischsprachige Ausgabe konfiguriert hat, wird auf deutsch umgeschaltet.

3.2 Versionierung der XML-Ausgabe

Suchergebnisse

Für die Ausgabe der Suchergebnisse wurde eine neue Version des XML Schemas erstellt, die die exakten Treffer enthält. Man erhält die neue Version der XML-Ausgabe, wenn man in der URL den Parameter &xmlv=3 (XML-Version 3) ergänzt.

Detailseite

Für die Detailausgabe wurde eine neue Version des XML Schemas erstellt, die den DOAJ-Link von grünen Zeitschrift enthält. Man erhält die neue Version der XML-Ausgabe, wenn man in der URL den Parameter &xmlv=2 (XML-Version 2) ergänzt.

4. Die EZB-Services im Überblick

  • Fachliste: Dargestellt werden alle Fachgebiete der jeweiligen Bibliothek und die Größe des jeweiligen Datenbestands (Menge der Einträge) an Online-Zeitschriften.
  • Alphabetische Titelliste: Die Zeitschriften-Volltexttitel sind alphabetisch sortiert. Zu dieser Liste gelangt man in der EZB entweder direkt (Link Zeitschriften/alphabetisch), dann enthält diese Liste alle in der Bibliothek aufgeführten Titel alphabetisch geordnet, oder über die Fachliste, in der man vorher das gewünschte Fachgebiet ausgewählt hat. Diese Alphabetische Titelliste enthält alle relevanten, weiterführenden Links zu den aufgeführten Zeitschriften und ist daher wie ein alphabetischer Zeitschriftenkatalog (mit bequemer alphabetischer Navigation) der jeweiligen Bibliothek sortiert.
  • Detailansicht: Über den Informationsbutton der Titelliste gelangt man zur Detailansicht der ausgewählten Zeitschrift. Dargestellt sind dort alle Einträge, die über das gewählte Journal eingegeben worden sind (Details), einschließlich der Zeitschriften-spezifischen Urls. Zudem enthält es Informationen die eine Weiterverlinkung auf die Homepage der Zeitschrift, mögliche Lizenzbedingungen, eine mögliche Kostenpflichtigkeit (pay per view) und eine Anzeige aller Bibliotheken ermöglicht, die die besagte Zeitschrift abonniert haben. Aufgeführte Daten der Detailansicht können so sein: Zeitschriftentitel, Lizenzierungsangaben, Link mit Lizenzinformationen zum Verlag, Link mit Weiterverlinkung zur Homepage, Verlag, EISSN-Nummern, PISSN-Nummern, ZDB-Nummer (mit Url), Fachbereiche (-gruppe), Schlagwörter, Zugang (z.B. http), Format (z.B. pdf), Volltext-Url, Homepage des Journals mit Url, Volltextartikel, erster- und letzter Volltextjahrgang, erster- und letzter Artikel (auch gescanned), erstes- und letztes Bild oder Grafik, erste Ausgabe, letzte Ausgabe, Erscheinungsweise, Kosten und Zugriffsmöglichkeit sowie Bemerkungen.
  • HP-Weiterleitung: Mit dieser direkten Weiterverlinkung zur Homepage der Zeitschrift/ des Artikels gelangt man problemlos auf die jeweilig gewünschte Website der ausgesuchten Zeitschrift. In Spezialfällen mit unterschiedlichen Lizenzierungszeiträumen gelangt man auf eine Zwischenseite der EZB, auf der dann weiterführende Details und Links aufgeführt sind (mit Links zur Zeitschrift und/oder ggf. Links zur Readme-Datei der Lizenzbestimmungen des Verlags...)
  • Readme für lizenzpflichtige Zeitschriften: Lizenzierungen auf Zeitschriften haben in der EZB Lizenzinformationen zur Folge, die unter 'Readme' aufgerufen werden können. Dies leistet eine Weiterverlinkung zu etwaigen Lizenzbestimmungen der Verlage.
  • Suchfunktion: Die Suchmaske der EZB (Link Zeitschriften/suchen) enthält Sucheingabemöglichkeiten zu Journal- und Verlagscharakteristika, Navigation, Treffern, Fachgebieten und Volltextzugriffsmöglichkeiten. Als Suchparameter dienen der Suchmaske in der EZB Titelworte, Titelanfang, Schlagworte, Verlage, ISSN Nummern, Eingabedatum, Datum der letzten Änderung oder ZDB-Nummer. Diese Suchangaben können als Bedingung zutreffend oder nicht zutreffend behandelt werden und sich mit 'UND' oder 'ODER' ergänzen bzw. ausschließen.
  • Resultat der Suche: Die Suchfunktion (Link Zeitschriften/suchen) liefert als Ergebnis eine ähnliche Benutzeroberfläche wie bei der alphabetischen Sortierung der Titelliste. Dargestellt werden können aber nicht nur alphabetisch geordnete Suchergebnisse, sondern auch seitenweise ausgegebene 'Blätter'.
  • Einstellungen: Die Einstellungen (Link Einstellungen) enthalten neben den wählbaren Auswahlkriterien wie die Lizenzeigenschaften von Zeitschriften auch weitere Optionen wie z.B. Länder, Teilnehmerkategorien und Institute (Teilnehmer). Sie gelten als allgemeine Auswahloption und als Hilfe zur Eingrenzung der Suche nach bestimmten Zeitschriftentypen. Damit können u.a. die Zeitschriftensortimente bestimmter Institute abgerufen werden.
  • Liste der teilnehmenden, Volltextzugriff bietenden Institutionen: Sie (Link unter Detail/Liste der teilnehmenden Institutionen,...) entspricht den Möglichkeiten, eine Liste der teilnehmenden Institutionen, die zur gewählten Zeitschrift Volltextzugriff bietet, anzuzeigen. Spezifizierungen für eine ausgewählte Zeitschrift nach z.B. Instituten/Einrichtungen können so durchgeführt werden, um zu erfahren, welche Lizenzbedingungen wo vorliegen.
  • Kontakt: Bei Fragen und Problemen kann der User Kontakt (Link unter Kontakt/Ansprechpartner) zu den beim jeweiligen EZB-Teilnehmer (z.B. Bibliothek) verantwortlichen Personenkreis (E-Mail, Homepage) aufnehmen.
    Genaueres mit den skriptspezifischen Parametern folgt in den folgenden Kapiteln.

5. Aufbau der XML-Dateien

  • Root-Element: ezb_page, Attribute lang und colors
  • Immer aufgeführt: library, Attribute: bibid und href, Inhalt: Name der Bibliothek page_name, Inhalt: Name des Skripts für die Seite
    Falls nötig aufgeführt: page_vars
Weiterhin werden benötigt: Die zusätzlichen Parameter für die jeweils aktuelle Seite. In der Regel ist der Name des Elements/Attributs auch der des benötigten Parameters. Ausnahmen: Notations im Suchmodus (Ausgabe im Suchergebnis), (>> Notations[]).

Internationalisierung: Wechseln von deutsch <-> englisch mittels lang=de bzw. lang=en.

Weitere Informationen finden sich unter:

6. Die EZB-Services im Detail

6.1 Liste der Fachgebiete

fl.phtml ohne zusätzliche Parameter:
Inhalt: Links zu Fachgebieten mit deren Volltextzeitschriften, Liste der Fachgebiete der jeweiligen Bibliothek, Größe des jeweiligen Datenbestands (Anzahl der Zeitschriften).
Mutterelement: ezb_subject_list Weitere Parameter: Pro Fach ein Element subject mit Mutterelement subjects und den Attributen notation und journalcount.
Inhalt des Elements subject: Name des Fachs. Mit den verwendeten Parametern läßt sich dann auch der Link zur alphabetisch geordneten Liste der Onlinezeitschriften im jeweiligen Fachgebiet konstruieren.

XML-Beispiel: LINK

6.2 Alphabetische Liste der Zeitschriften eines Fachgebietes, alphabetische Gesamtliste

fl.phtml mit Parameter notation:
Inhalt: Alphabetische Liste der Zeitschriften für das jeweilige Fach (oder eine Gesamtliste mit dem Parameter notation=ALL), 50 Treffer pro Seite (default-Wert). Aufgrund der oftmals großen Anzahl an Zeitschriften enthält die Datei eine übersichtliche alphabetische Navigationsleiste. Die weiteren Links sind zeitschriftenspezifisch (Name der Zeitschrift, Link zur Zeitschrift oder zum Verlag, Lizenzbestimmungen des Verlags, Detailinformationen zur Zeitschrift, Pay-per-view-Eigenschaft).
Mutterelement: ezb_alphabetical_list
Weitere Parameter: Zusammengefasst unter page_vars

Inhalt des Elements page_vars: notation / sc, lc zum Blättern nach Anfangsbuchstaben, falls > 50 (default) Zeitschriften / sindex zum Blättern in der Liste für einen Anfangsbuchstaben Inhalt des Elements ezb_alphabetical_list: Element subject mit Attribut notation, Inhalt ist der Name des Fachgebietes.
Element navlist mit Kindelementen current_page und other_pages zum Blättern nach Buchstaben Element(e) first_fifty zum Blätter in der Liste zum aktuellen Anfangsbuchstaben Element alphabetical_order, pro Zeitschrift ein Kindelement journals mit Attribut jour_id (interne EZB-id der Zs.) und Kindelementen title, journal_color, detail_link (-> Link zur Detailanzeige: detail mit jour_id), warpto_link(-> Link zur Zeitschrift: warpto mit jour_id) und (für gelbe und gelbrote Ampeln (= Lizenzierungen)) der readme_link (-> Link zur Readme-Seite: show_readme mit jour_id), journal_new (= wenn ein Neueintrag jünger als 7 Tage ist). Element(e) next_fifty zum Blätter in der Liste zum aktuellen Anfangsbuchstaben Element contact für einen Ansprechpartner für das aktuelle Fach.

XML-Beispiel: LINK

6.3 Detailanzeige zu einer Zeitschrift

detail.phtml:

Inhalt: Detailangaben zur ausgesuchten Zeitschrift (über die alphabetische Liste)
Mutterelement: ezb_detail_about_journal
Weitere Parameter: Zusammengefasst unter page_vars: jour_id

Inhalt des Elements ezb_detail_about_journal: Kindelement journal

Inhalt des Elements journal:
title (Zeitschriftentitel), journal_color (Lizenzierungsfarbe (rot-gelb-grün), mit Attr. color_code), readme_link falls gelb (mit Lizenzinformationen zum Verlag, mit Attr. url), warpto_link falls gelb, grün, rot (mit Weiterverlinkung zur Homepage der Zs. oder des Verlages), where_link (Angabe, wo überall Lizenzen für die ausgewählte Zs. bestehen), periods falls gelbrot (Angaben über Lizenzzeiträume, etc.), detail mit Kindelementen.

Inhalt des Kindelementes periods (von journal):
period mit journal_color (nur gelb oder rot), label (für gelb), warpto_link mit Attribut url (urlencoded), readme_link mit Attribut url für gelb (direkte Verlinkung auf die Readme-Seite).

Inhalt des Kindelementes detail (von journal):
publisher (Verlag), E_ISSN (EISSN-Nummer) mit Mutterelement E_ISSNs, P_ISSN (PISSN-Nummer) mit Mutterelement P_ISSNs, ZDB_number (ZDB-Nummer mit Attr. url), subject (Fachbereiche (-gruppe)), mit Mutterelement subjects, keyword (Schlagwörter) mit Mutterelement keywords, first_fulltext_issue (erste Volltextausgabe), mit den Tochterelementen first_volume, first_issue und first_date; last_fulltext_issue (letzte Volltextausgabe), mit den Tochterelementen last_volume, last_issue und last_date; access (Zugang (z.B. http)), formate (Format (z.B. pdf)), fulltext (Volltext-Url mit Attr. url), homepages -> homepage (Homepage des Journals mit Attr. url), first_issue (erste Ausgabe), last_issue (letzte Ausgabe), moving_wall (Moving Wall Zeitraum), appearence (Erscheinungsweise), costs (Kosten), pay_per_view mit dem Kindelement suppliers und seinen Tochterelementen supplier, supplier_url (Attribut url) und first_date und last_date (alles zur Pay-per-view-Option gehörend); journal_access (Zugriffsmöglichkeit mit Attr. url), remarks (Bemerkungen).
Zusätzlich sind für "ebsco" möglich:
fulltext_articles (Volltextartikel).
Zusätzlich sind für "proquest" möglich:
article_text (erster, letzter Artikel), scanned_articles (...auch gescanned), text_graphics (erstes, letztes Bild oder Grafik).

XML-Beispiel: LINK (grün)
XML-Beispiel: LINK (gelb-rot)
XML-Beispiel: LINK (gelb)
XML-Beispiel: LINK (rot)

6.4 Link zur Zeitschrift

warpto.phtml:

Inhalt: Eine direkte Weiterverlinkung zur Homepage der Zeitschrift/ des Artikels ('Normalfall'). Der 'Spezialfall' der gelb-roten Ampel, beinhaltet hier eine Weiterleitung zu einer EZB Zwischenseite, die Auskunft darüber gibt, für welche Zeiträume die Zeitschrift lizenziert ist. Dort werden auch Links aufgeführt, zu denen mittels warpto_link mit Attribut url zur Zs. weiterverlinkt wird. Ggf. wird auch ein Link zur Readme-Datei der Lizenzbestimmungen des Verlags.
Mutterelement: ezb_warpto_journal
Normalfall:
journal (mit dem Attribut jourid) und location mit dem Link zur Zs. (-> direktes Weiterverlinken)
Spezialfall:
journal (mit dem Attribut jourid) und den Kindelementen title und periods (siehe unter detail)

XML-Beispiel 'Normalfall': LINK
XML-Beispiel 'Spezialfall': LINK

6.5 Anzeige einer Readme-Seite

show_readme.phtml:

Inhalt: Lizenzierungen spiegeln sich in der EZB durch gelbe (gelb-rote) Ampeln wieder. Bei den betroffenen Zeitschriften existieren von Verlag zu Verlag mitunter abweichende Lizenzbestimmungen. Diese können mit dem Link 'Readme' aufgerufen werden.
Mutterelement: ezb_readme_page
Weitere Parameter: journal (mit dem Attribut jourid) und location welches immer den Link zur Readmeseite enthält.
Alternativ dazu:
noreadme (alle nicht-gelben Fälle) oder alternativ, wenn mehrere Lizenzzeiträume für die Zs. existieren:
journal (mit dem Attribut jourid) und den Kindelementen title und periods und location (siehe unter detail)

XML-Beispiel: LINK mit Noreadme
XML-Beispiel: LINK mit Readme
XML-Beispiel: LINK bei mehreren Readmes

6.6 Optionen für eine Suchmaske

search.phtml:

Inhalt: Die Suchfunktion (Zeitschriften/suchen) enthält verschiedene Sucheingabemöglichkeiten für das Ermitteln von Zeitschriften. Aufbau der Suchmaske mit Hilfe der Parameter in page_vars:
hits_per_page sc wie bei fl sindex wie bei fl oder statt sc offset
jq_type1 jq_term1 jq_bool2 jq_not2
jq_type2 jq_term2 jq_bool3 jq_not3
jq_type3 jq_term3
Jeweils mit Inhalt zum Vorausfüllen der Felder (bei "Verfeinern der Suche").

Mutterelement: ezb_search:
Darin enthalten sind die option_list und sein Kindelement option:
Folgende Inhalte für das unter option_list enthaltene Attribut name und das unter option gebrauchte Attribut value können vorkommen:

<option_list name="jq_type"> mit den Möglichkeiten:
<option value="KT">Titelwort(e)</option>
<option value="KS">Titelanfang</option>
<option value="KW">Schlagwort(e)</option>
<option value="PU">Verlag</option>
<option value="IS">ISSN</option>
<option value="ID">Eingabedatum</option>
<option value="LC">Letzte Änderung</option>
<option value="ZD">ZDB-Nummer</option>

<option_list name="jq_bool"> mit den Möglichkeiten:
<option value="AND">und</option>
<option value="OR">oder</option>

<option_list name="jq_not"> mit den Möglichkeiten:
<option value=" "/>
<option value="NOT">nicht</option>

<option_list name="offset">
<option value="-1" selected="true">alphabetisch</option>
<option value="0">blättern</option>

<option_list name="hits_per_page">
mit diversen Auswahlmöglichkeiten für die Zahl der Treffer pro Seite

<option_list name="Notations" multiple="true">
mit einer Liste der Fächer zur (Mehrfach-)Auswahl

<option_list name="selected_colors" multiple="true">
mit einer Liste der anzuzeigenden "Ampelfarben"


Achtung:
  • Notations und selected_colors müssen mit [] aufgerufen werden
  • bei einem Aufruf zum Verfeinern der Suche werden die in offset, hits_per_page, Notations und selected_colors zuletzt verwendeten Werte mit dem Attribut selected="true" versehen.
XML-Beispiel: LINK

6.7 Suchergebnis

searchres.phtml:

Inhalt: Suchresultate werden als alphabetische Liste wie in fl oder zum seitenweisen Blättern präsentiert.
Mutterelement: ezb_alphabetical_list_searchresult
Wie in der Suchmaske sind auch hier die Parameter der page_vars entscheidend:
hits_per_page sc wie bei fl sindex wie bei fl oder statt sc offset
jq_type1 jq_term1 jq_bool2 jq_not2
jq_type2 jq_term2 jq_bool3 jq_not3
jq_type3 jq_term3
Achtung:
  • Notations muss mit [] aufgerufen werden
Im Aufbau der fl ähnlich (sc, sindex), hits_per_page einstellbar, oder alternativ durch Blättern mit hits_per_page Treffern pro Seite, dann navlist mit first_page, previous_page, next_page, last_page jeweils mit dem Attribut offset.

current_page mit Inhalt [von - bis]
XML-Beispiel: LINK

6.8 Anzeige aller teilnehmenden Institutionen

select.phtml:

Inhalt: Liste aller Teilnehmereinrichtungen.
Mutterelement: ezb_partner_selection mit Kindelementen:
  • countries
    Mit einer Liste von country; Attribute ID und lang mit Inhalt Ländername.
  • categories
    Mit einer Liste von category; Attribute ID, lang und country_refs mit dem Inhalt des Namens der Kategorie. Außerdem Attribut countryrefs (ID's der countries, in denen die category vorkommen).
  • institutions
    Mit einer Liste von institution; Attribute ID (bibid der Institution), lang, catrefs und countryref
    Erläuterung: catrefs = Kategorien, in die die Institution gehört; countryref = Land, Sortierung nach Stadt, Name der Einrichtung.
Außerdem eine option_list wie z.B. in:
<option_list name="selected_colors" multiple="true"> mit einer Liste der anzuzeigenden "Ampelfarben" und Kindelement option für die 'Ampeltexte':
<option value="1" selected="true">frei zugänglich</option>
<option value="2" selected="true">für Angehörige der Universität Regensburg im Uninetz frei, Zugangsbedingungen im Readme</option>
<option value="4" selected="true">für Angehörige der Universität Regensburg nicht zugänglich...</option>


XML-Beispiel: LINK

6.9 Anzeige der teilnehmenden Institutionen, die Volltextzugriff auf eine Zeitschrift bieten

where.phtml:

Inhalt: Liste der Teilnehmereinrichtungen, die Volltextzugriff auf eine Zeitschrift bieten.
Mutterelement: ezb_where_journal_at_partners mit Kindern: journal und Attribut jourid, und dessen Kind title
Weitere Kinder von ezb_where_journal_at_partners: partner_selection
Wie unter select (ezb_partner_selection) mit Kindern countries, categories und institutions.
Weitere Parameter unter page_vars: jour_id

XML-Beispiel: LINK

6.10 Ansprechpartner an der Teilnehmerinstitution

kontakt.phtml:

Inhalt: Führt Ansprechpartneradressen (E-Mail, Homepage) auf.
Mutterelement: ezb_contact mit dem Attribut href für den Link zur Kontaktperson und dem dazugehörenden Text zum Link.

XML-Beispiel: LINK

7. Gibt es Logos und Graphiken, die verwendet werden können?

Ja, unter http://ezb.uni-regensburg.de/services/ezbmaterials.phtml gibt es eine Reihe von Logos und Graphiken, die Sie auf Ihren Webseiten einsetzen können.

8. An wen kann ich mich wenden, falls Fehler auftreten?

Für den Fall, dass Sie einen Fehler beobachtet haben, senden Sie bitte eine E-Mail an: technik.ezb@ur.de
Zuletzt geändert am: 08.12.2017