schema de - OpenAPC/openapc-de GitHub Wiki
OpenAPC Daten-Schemata
Die folgenden Schemata beschreiben die von der OpenAPC-Initiative aggregierten Datensätze. Jede Zeile entspricht einer Spalte in der entsprechenden CSV-Datei. Zurzeit werden 4 Datensätze gepflegt:
- APC-Datensatz (für APCs auf Basis der einzelnen Veröffentlichungen)
- BPC-Datensatz (für BPCs auf Basis der einzelnen Veröffentlichungen)
- Transformative Agreements (TA)-Datensatz (für Zeitschriftenartikel, die im Rahmen von Transformationsverträgen und anderen Verlagsvereinbarungen veröffentlicht wurden, wie etwa Springer Compact oder DEAL)
- Contracts-Datensatz (zentrale Erfassung von Vertragsmetadaten und Kosteninformationen)
APC-Datensatz
- Art der Veröffentlichung: Zeitschriftenartikel
- Kostendaten: pro Publikation, obligatorisch
- CSV-Datei
- Treemap-Visualisierung
Dies ist der ursprüngliche OpenAPC-Datensatz, hier werden Kostendaten zu Article Processing Charges (APCs) pro Veröffentlichung aggregiert. Der APC-Datensatz enthält ausschließlich Artikel, die eigenständig mit APCs bezahlt wurden und keiner vertraglichen Vereinbarung zugeordnet werden können. Er besteht aus 18 Metadatenfeldern, von denen 5 bei der Übermittlung von Daten obligatorisch sind.
Obligatorische und zusätzliche Spalten
Nur die ersten 5 Spalten sind immer Pflichtfelder. Die 4 als „Backup“ gekennzeichneten Spalten sind nur dann erforderlich, wenn mindestens einer der Artikel in einer Beitragstabelle keinen zugewiesenen DOI hat. In diesem Fall müssen die Artikel ohne DOI (und nur diese) diese 4 Datenfelder als zusätzliche Informationen ausweisen (Beispiel).
Wenn Sie zusätzliche Kosten melden wollen, können Sie entsprechende Datenfelder anhängen. Sie können dies tun, indem Sie Ihre Tabelle um eine Auswahl an Datenfelder aus dem Datensatz „Zusatzkosten“ erweitern.
| Spalte | Beschreibung | Quelle | Erforderlich? |
|---|---|---|---|
| institution | übergeordnete Institution, welcher die gemeldeten Kosten zugeordnet sind, z.B. "Universität Bielefeld" | - | obligatorisch |
| period | Jahr der APC-Zahlung (YYYY) | - | obligatorisch |
| euro | der gezahlte APC-Betrag in EURO, inkl. MwSt und eventueller Rabatte | - | obligatorisch |
| doi | Digital Object Identifier | - | obligatorisch |
| is_hybrid | zeigt an, ob der Artikel in einer hybriden Zeitschrift (TRUE) oder in einer vollständigen/Gold Open-Access-Zeitschrift (FALSE) veröffentlicht wurde | - | obligatorisch |
| publisher | Name des Verlags, der die Gebühr erhoben hat | CrossRef | backup |
| journal_full_title | vollständiger Name der Zeitschrift, die den Artikel enthält | CrossRef | backup |
| issn | International Standard Serial Number | CrossRef | backup |
| issn_print | International Standard Serial Number - print version | CrossRef | nein |
| issn_electronic | International Standard Serial Number - electronic version | CrossRef | nein |
| issn_l | Linking International Standard Serial Number | ISSN International Centre | nein |
| license_ref | Lizenz, unter welcher der Artikel veröffentlicht wurde | CrossRef | nein |
| indexed_in_crossref | zeigt an, ob der Beitrag bei der DOI-Agentur CrossRef registriert ist (TRUE/FALSE) | CrossRef | nein |
| pmid | ID für Metadatensätze, die in Europe Pubmed Central (Europe PMC) indiziert sind | Europe PMC | nein |
| pmcid | ID für Artikel, die in der Volltextsammlung von Europe PubMed Central verfügbar sind | Europe PMC | nein |
| ut | Web of Science Unique Item ID | Web of Science | nein |
| url | URL zum Artikel, wenn kein DOI verfügbar ist | - | backup |
| doaj | zeigt an, ob die Zeitschrift im Directory of Open Access Journals indiziert ist (TRUE/FALSE) | DOAJ | nein |
Zusatzkosten-Datensatz
- Art der Veröffentlichung: Zusatzkosten zu Zeitschriftenartikeln
- Kostendaten: verknüpft mit einzelnen Publikationenaus dem APC- oder TA-Datensatz
- CSV-Datei
Der Datensatz „Zusatzkosten“ ist nicht als eigenständiger Datensatz angedacht, sondern wird verwendet um den APC- und den TA-Datensatz mit Zusatzkosten anzureichern.
| Spalte | Beschreibung | Quelle | Erforderlich? |
|---|---|---|---|
| doi | Verknüpfung mit einer existierenden DOI im APC-Datensatz | - | obligatorisch |
| colour charge | Zusatzkosten für Farbabbildungen, inkl. MwSt | - | nein |
| cover charge | Zusatzkosten für die Präsentation eines Artikels auf dem Zeitschriftencover / Cover-Abbildung, inkl. MwSt | - | nein |
| page charge | Zusatzkosten für Überlänge / Überlängenaufschlag, inkl. MwSt | - | nein |
| permission | Abdrucklizenz / Gebühren für die Wiederverwendung z.B. einer Abbildung aus einer anderen bereits veröffentlichten Publikation, inkl. MwSt | - | nein |
| reprint | Gebühren für den Reprint von Publikationen, inkl. MwSt | - | nein |
| submission fee | Gebühr für die Einreichung eines Artikels, inkl. MwSt | - | nein |
| payment fee | Zusatzkosten für Transaktionen (Bankgebühren, Aufschlag für Zahlungen per Kredikarte), inkl. MwSt | - | nein |
| other | sonstige Zusatzkosten (bspw. Übersetzungsgebühr, Gebühren für Abstracts, etc.), inkl. MwSt | - | nein |
BPC-Datensatz
- Art der Veröffentlichung: Bücher/Monographien (keine Einzelkapitel)
- Kostendaten: pro Publikation, obligatorisch
- CSV-Datei
- Treemap-Visualisierung
Dieser Datensatz sammelt Daten zu BPCs (Book Processing Charges). Er besteht aus 13 Feldern, von denen 5 obligatorisch sind.
Obligatorische und zusätzliche Spalten
Die ersten 5 Spalten sind Pflichtfelder. Die Spalte „isbn“ ist als „Backup“ gekennzeichnet und wird benötigt, wenn dem Buch kein DOI zugeordnet ist. Da die Verwendung von DOIs bei Büchern nicht so weit verbreitet ist wie bei Zeitschriftenartikeln, geben wir zwei zusätzliche Empfehlungen für die Eingabe von Daten:
- Die Spalte book_title ist als empfohlen gekennzeichnet. Sie ist nicht unbedingt erforderlich, aber wenn Sie Zugang zu dieser Art von Informationen haben, könnte es hilfreich sein, sie der Tabelle hinzuzufügen.
- Bücher können je nach Publikationsform (Hardcover, Softcover, PDF, epub...) eine Vielzahl von ISBNs haben. Wenn Ihre Originaldaten Felder für mehr als einen ISBN-Typ vorsehen, empfehlen wir, sie alle aufzunehmen. Es ist nicht erforderlich, die zusätzlichen Spalten entsprechend zu benennen, ein allgemeines Schema (isbn_1, isbn_2...) reicht aus.
| Spalte | Beschreibung | Quelle | Erforderlich? |
|---|---|---|---|
| institution | übergeordnete Institution, welcher die gemeldeten Kosten zugeordnet sind,z.B. "Universität Bielefeld" | - | obligatorisch |
| period | Jahr der BPC-Zahlung (YYYY) | - | obligatorisch |
| euro | der gezahlte BPC-Betrag in EURO, inkl. MwSt und eventueller Rabatte | - | obligatorisch |
| doi | Digital Object Identifier | - | obligatorisch |
| backlist_oa | Wurde das Buch von Anfang an Open Access veröffentlicht (FALSE) oder war es bereits Teil der Backlist eines Verlags und wurde nachträglich Open Access (TRUE)? | - | obligatorisch |
| publisher | Name des Verlags, der die Gebühr erhoben hat | CrossRef | nein |
| book_title | Titel der Monographie | CrossRef | empfohlen |
| isbn | International Standard Book Number | CrossRef | backup |
| isbn_print | International Standard Book Number - print version | CrossRef | nein |
| isbn_electronic | International Standard Book Number - electronic version | CrossRef | nein |
| license_ref | Lizenz, unter welcher das Buch veröffentlicht wurde | CrossRef | nein |
| indexed_in_crossref | zeigt an, ob das Buch bei der DOI-Agentur CrossRef registriert ist (TRUE/FALSE) | CrossRef | nein |
| doab | zeigt an, ob das Buch im Directory of Open Access Books indiziert ist (TRUE/FALSE) | DOAJ | nein |
Datensatz über Transformationsvereinbarungen (Transformative Agreements, TA)
- Art der Veröffentlichung: Zeitschriftenartikel
- Kostenangaben: Nein (pro Veröffentlichung in einigen Fällen optional, siehe unten)
- CSV-Datei
- Treemap-Visualisierung (kostenbasiert)
- Treemap-Visualisierung (artikelzahlenbasiert)
Der Datensatz Transformative Agreements (TA) enthält Metadaten zu Zeitschriftenartikeln, die im Rahmen von Transformationsverträgen und anderen Verlagsvereinbarungen veröffentlicht wurden. Diese Art von Verträgen wird mit Verlagen abgeschlossen und bezieht in der Regel größere Einrichtungen wie Forschungsorganisationen (z. B. Max-Planck-Gesellschaft) oder nationale Konsortien als Vertragspartner ein.
Die Kosten- und Zahlungsmodelle können sehr unterschiedlich sein. Der TA-Datensatz kann sowohl Artikel mit individuell abgerechneten Kosten enthalten (z. B. Gold-OA-Artikel im Rahmen von DEAL), als auch Artikel ohne konkrete Kosteninformationen. Vertragskosten werden dabei nicht auf Artikelebene abgebildet, sondern zentral im Contracts-Datensatz erfasst. Die Verknüpfung zwischen Artikeln und Verträgen erfolgt über die group_id, die eine eindeutige Zuordnung zu den entsprechenden Vertragseinträgen ermöglicht. Gleichzeitig bleibt es weiterhin möglich, Artikel ausschließlich mit bibliographischen Metadaten, aber ohne jegliche Kostenangaben zu melden.
Obligatorische und zusätzliche Spalten
Da die DOI-Registrierung von Artikeln bei Verlagsvereinbarungen ein akzeptierter Standard ist, gilt die "Backup"-Regel des OpenAPC-Datensatzes hier nicht. Alle Einträge im TA-Datensatz müssen daher eine gültige DOI haben.
| Spalte | Beschreibung | Quelle | Erforderlich? |
|---|---|---|---|
| institution | übergeordnete Institution, zu welcher der Autor des Artikels gehört | - | obligatorisch |
| period | Jahr der Zahlung (YYYY) | - | obligatorisch |
| euro | Artikelkosten, die in der Regel im Nachhinein anhand einer vereinbarten Formel berechnet werden | - | nein |
| doi | Digital Object Identifier | - | obligatorisch |
| is_hybrid | zeigt an, ob der Artikel in einer hybriden Zeitschrift (TRUE) oder in einer vollständigen/Gold OA-Zeitschrift (FALSE) veröffentlicht wurde | - | obligatorisch |
| opt_out | Gibt an, ob es sich um einen Opt-Out-Artikel (TRUE) handelt oder nicht (FALSE) | - | obligatorisch |
| publisher | Name des Verlags, mit dem die TA abgeschlossen wurde | CrossRef | nein |
| journal_full_title | vollständiger Name der Zeitschrift, die den Artikel enthält | CrossRef | nein |
| issn | International Standard Serial Number | CrossRef | nein |
| issn_print | International Standard Serial Number - print version | CrossRef | nein |
| issn_electronic | International Standard Serial Number - electronic version | CrossRef | nein |
| issn_l | Linking International Standard Serial Number | ISSN International Centre | nein |
| license_ref | Lizenz, unter welcher der Artikel veröffentlicht wurde | CrossRef | nein |
| indexed_in_crossref | zeigt an, ob der Beitrag bei der DOI-Agentur CrossRef registriert ist (TRUE/FALSE) | CrossRef | nein |
| pmid | ID für Metadatensätze, die in Europe Pubmed Central (Europe PMC) indiziert sind | Europe PMC | nein |
| pmcid | ID für Artikel, die in der Volltextsammlung von Europe PubMed Central verfügbar sind | Europe PMC | nein |
| ut | Web of Science Unique Item ID | Web of Science | nein |
| url | URL zum Artikel, wenn kein DOI verfügbar ist | - | nein |
| doaj | zeigt an, ob die Zeitschrift im Directory of Open Access Journals indiziert ist (TRUE/FALSE) | DOAJ | nein |
| agreement | ESAC-ID (bevorzugt) oder alternativ ein sprechender Agreement-Name | - | obligatorisch |
| group_id | Verknüpfung mit Einträgen in der contracts.csv; besteht aus der Kombination institution_ror + esac_id (alternativ: Agreement-Name) + period | - (wird durch OpenAPC automatisch generiert) | nein |
Wenn Sie zusätzliche Kosten melden wollen, können Sie entsprechende Datenfelder anhängen. Sie können dies tun, indem Sie Ihre Tabelle um eine Auswahl an Datenfelder aus dem Datensatz „Zusatzkosten“ erweitern.
Vertragsdatensatz (contracts.csv)
- Art der Veröffentlichung: Verträge/Verlagsvereinbarungen
- Kostenangaben: Optional, kostentypbezogen
- CSV-Datei
Der Vertrags-Datensatz enthält Metadaten und Kosteninformationen zu Transformationsverträgen und Verlagsvereinbarungen. Er ergänzt den TA-Datensatz, indem Vertragskosten zentral erfasst werden, während die einzelnen Artikel über die group_id mit den entsprechenden Vertragseinträgen verknüpft werden.
| Spalte | Beschreibung | Quelle | Erforderlich? |
|---|---|---|---|
| institution | Zuordnung zum berichtenden Partner (z. B. Universität oder Konsortium) | - | ja |
| consortium | Name des Konsortiums, falls Vertrag über ein Konsortium abgeschlossen wurde | ggf. ESAC-Registry | nein |
| contract_name | Sprechender Name des Vertrags | ggf. ESAC-Registry | ja |
| identifier | Optionaler Vertrags-Identifier (z. B. ESAC-ID) | - | nein |
| period_from | Beginn des Lizenzzeitraums (Jahr) | - | ja |
| period_to | Ende des Lizenzzeitraums (Jahr) | - | ja |
| cost_type | Art der Kostenangabe gemäß openCost-Vokabular (Publish, Read, Publish and Read, Service Fee) | - | nein |
| euro | Betrag für den jeweiligen Kostentyp | - | nein |
| group_id | Eindeutiger Schlüssel zur Verknüpfung mit Artikeln im TA-Datensatz | - (wird durch OpenAPC automatisch generiert) | ja |
Hinweise:
- Enthält eine Rechnung für ein Lizenzjahr mehrere Kostenkomponenten (z. B. Publish- und Read-Anteile), wird jede Komponente in einer eigenen Zeile erfasst.
- Die übrigen Felder (institution, consortium, contract_name, identifier, period_from, period_to, group_id) bleiben in diesem Fall identisch.
- Verträge ohne konkrete Kostendaten (weder auf Artikelebene noch auf Vertragsebene) können ebenfalls erfasst werden; cost_type und euro erhalten dann den Wert NA.