OpenEdition KBART Documentation

_images/openedition.png

OpenEdition provides electronic resource title lists and coverage data for the documents published on OpenEdition Books and OpenEdition Journals as KBART files. Alternatively, OpenEdition metadata can be harvested using OpenEdition OAI-PMH repository or downloaded as MARC records.

This documentation describes the specific elements related to OpenEdition but does not include a complete description of KBART specifications.

Overview

In order to facilitate the integration of data between OpenEdition Books, OpenEdition Journals, knowledge bases and discovery tools, KBART metadata (Knowledge Base And Related Tools) is now available for download on OpenEdition and BACON, the French national knowledge base (BAse de COnnaissance Nationale Française). Such data provides information relating to the status of the collections and the bundles available for purchase.

KBART files are published on BACON under the CC0 license and on OpenEdition under the following licenses: Creative Commons Attribution 4.0 International License and the French “Licence Ouverte / Open license”.

Knowledge Base And Related Tools

In an era of electronic documentation, we are facing the challenge of ever-evolving catalogues and moving resources. In order to tackle this issue, the US agency for normalisation proposed KBART as a framework for sharing information about electronic collections.

The KBART recommandation mostly consists of a standard 25 columns TSV table and best practices about how to fill it, name it and share it. KBART files are very well suited to describe electronic collections such as OpenEdition’s. For each available resource, it allows one to get minimal bibliographic information along with access modalities (is this journal Open Access? what is the URL for that book?)

Yet, the KBART format is not adapted to retrieve detailed metadata about a resource. It is made to describe catalogues, bundles and states of collections. In case you’re looking for detailed metadata about OpenEdition resources, you should consider reading OpenEdition’s OAI-PMH or MARC documentations. In this case, KBART could be useful as en entry point in order to retrieve identifiers, for example. Such case is developed in the “Going further…” section of this documentation.

A standard format such as KBART facilitates interoperability, electronic resources maintenance and subscription management. It allows one to develop or use tools that are not provider-dependant.

BACON

BACON (BAse de COnnaissance Nationale) is a platform created and maintained by the ABES (Agence Bibliographique pour l’Enseignement Supérieur) in order to provide a Knowledge Base hub, centralizing KBART storage & access from many providers relevant for Superior Education & Research.

BACON provides free metadata (everything is CC0-licensed) for signaling electronic resources. It offers various services related to knwoledge bases.

A National Knowledge Base

At the end of March 2020, BACON gathers data from 106 providers, making more than 850 packages available from https://bacon.abes.fr

This website offers three main functionnalities : exporting data, signaling mistakes & syndication feeds. It comes with a documentation available in English, and a useful glossary, yet only in French. (alternatively, one can consult the NISO Kbart glossary)

This documentation also describes a few webservices, which allow one to build complex tools over BACON. These webservices expose KBART, XML or JSON and offer various functionnalities, such as retrieving a structured list of available packages.

The BACON documentation being quite extensive, we won’t be detailing here how to use BACON website & webservices.

Standard name scheme & unique endpoint

BACON-hosted KBART files follow the KBART recommandation for file naming: [ProviderName]_[Region/Consortium]_[PackageName]_[YYYY-MM-DD].txt

Knowing a KBART file name, it is possible to access it at: https://bacon.abes.fr/package2kbart/[Filename]

Versionning

As the name scheme above suggests, BACON makes it possible to get the version of a KBART file at a given date by specifying it in the last part of the file name, in YYYY-MM-DD format.

If that part is omitted, so the filename looks like [ProviderName]_[Region/Consortium]_[PackageName].txt, BACON will automatically serve the most up-to-date version.

It is also possible to graphically browse a file’s versions in the website interface:

_images/bacon_versions.png

Data curation & quality label

BACON’s data is monitored and curated by the ABES teams. When a KBART file meets certain quality criterias, it is given a “quality label”. As it can be seen in the above screenshot, the OpenEdition Hypotheses KBART has been highlighted by this label.

Warning

KBART files served by BACON are appended a non-standard 26th column, called bestppn. It is the best matching identifier found for this resource in the SUDOC catalogue. Additional information about this 26th column can be found in this article from the ABES’s blog (in French).

Most of the time, it can simply be ignored if it’s not of any use to you.

Accessing KBART files

OpenEdition offers two types of KBART files: masterlists & bundles. The complete lists may be accessed as a whole, by platform, or by access policy. For each available KBART file, this page provides update rate and access links, whether directly on OpenEdition or on BACON .

All the KBART files listed in this page link to the most up-to-date available version. Please refer to the versionning section of this documentation in order to know how to retrieve a file’s state at a given date.

Complete lists

Update: daily

All titles (journals & books)   BACON
OpenEdition Journals OpenEdition BACON
OpenEdition Books OpenEdition BACON
Hypothèses OpenEdition BACON

Lists by access policy

Update: daily

OpenEdition Journals

Open Access OpenEdition BACON
Open Access Freemium OpenEdition BACON
Journals with embargo period OpenEdition BACON

OpenEdition Books

Open Access OpenEdition BACON
Open Access Freemium OpenEdition BACON
Exclusive access OpenEdition BACON

Lists by bundle or license

OpenEdition Journals

Update: yearly

The OpenEdition Freemium for Journals annual bundle:

OpenEdition Books

Update: between 3 and 6 times per year

Over 70 bundles by new release, discipline, theme, publisher, language area, geographic area, and specially created bundles for our partner consortia.

The following bundles are described as KBART on BACON:

National license

OpenEdition contribution to ISTEX: a collection of ebooks in the field of letters & human sciences with nearly 1200 titles of reasearch in history, anthropology and sociology, from the origins to 2015.

ISTEX (Excellency Initiative for Scientific and Technical Information / Initiative d’excellence de l’Information Scientifique et Technique) covers 23 millions documents from 27 scientific litterature corpus of all disciplines. It represents more than 9 279 journals and 346 863 ebooks between 1473 and 2016 for Research & Superior Education.

Kbart data for ISTEX License is only available on BACON.

KBART files for partner institutions available upon request

Our library partnership officers can make available upon request the KBART files relating to purchased books and journals.

Note

OpenEdition also provides non-standard files for describing title list and coverage data (full lists and by access policy for OpenEdition Journals and OpenEdition Books):

Update: daily

Data description

KBART-formatted files are UTF-8-encoded 25 columns TSV tables. The first line of a KBART file is always the header, so it must contain the title of each field.

We will be describing here how each field is filled in OpenEdition’s KBART files. An empty implementation note means the field is never used.

Field title Implementation notes
publication_title title of the described resource
print_identifier
if any: print ISSN for OpenEdition Journals,
print ISBN for OpenEdition Books
online_identifier
electronic ISSN for OpenEdition Journals & Hypotheses research blogs
electronic ISBN for OpenEdition Books
date_first_issue_online
year of first available issue for OpenEdition Journals
date of first post for Hypotheses Research blogs
num_first_vol_online number of the first available volume for OpenEdition Journals
num_first_issue_online number of the first available issue for OpenEdition Journals
date_last_issue_online
year of last available issue for OpenEdition Journals (for both embargoed and inactive journals)
date of last post for inactive Hypotheses Research blogs
num_last_vol_online number of the last available volume for OpenEdition Journals
num_last_issue_online number of the last available issue for OpenEdition Journals
title_url URL of the described resource
first_author first author, for OpenEdition Books
title_id identifier of the described resource
embargo_info Not implemented, even for embargoed journals
coverage_depth fulltext
notes see the notes section below
publisher_name publisher name
publication_type
serial for OpenEdition Journals and Hypotheses
monograph for OpenEdition Books
date_monograph_published_print print publication date for OpenEdition Books, if any
date_monograph_published_online electronic publication date on OpenEdition Books
monograph_volume  
monograph_edition  
first_editor name of the first editor for OpenEdition Books, if any
parent_publication_title_id  
preceding_publication_title_id  
access_type
F for OpenEdition Journals, Open Access & Open Access Freemium OpenEdition Books and Hypotheses
P for exclusive access OpenEdition Books

Notes

The notes field is used in order to provide complementary information which could not expressed in the other fields.

All Open Access Freemium Journals are highlighted with this note: Full access to the HTML version of the content. Access to PDF and Epub reserved to subscribing institutions.

Moreover, for OpenEdition Journals, some characters and abbreviations are used to precisely describe coverage range:

  • abs. is used to list missing issues. For example abs. 2018, 12 means issue #12 published in 2018 is missing.
  • suppl. is used to list added content, such as special issues: suppl. HS 2001 means a special issue identified as “HS 2001” is available.
  • ; is used as a separator between issues: abs. 2018, 12 ; 2019, 15 means issues 12 and 15 are missing
  • — is used as a continuity marker: abs. 2018, 12—2019, 15 means issues 12 to 15 are missing (12, 13, 14, 15)
  • | is used as a subfield separator: abs. 2018, 12 ; 2019, 15 | suppl. HS 2001
  • … is used to mean a series is still going on: suppl. HS 2001, 1–… means special issues have been regularly published since 2001.

Sample file

Here are the first 10 lines from the KBART file describing OpenEdition Open Access Freemium Journals. It does include the 26th non-standard bestppn column from BACON.

publication_title    print_identifier        online_identifier       date_first_issue_online num_first_vol_online    num_first_issue_online  date_last_issue_online  num_last_vol_online     num_last_issue_online   title_url       first_author    title_id        embargo_info    coverage_depth  notes   publisher_name  publication_type        date_monograph_published_print  date_monograph_published_online monograph_volume        monograph_edition       first_editor    parent_publication_title_id     preceding_publication_title_id  access_type     bestppn
ABE Journal          2275-6639       2012    1                                       http://journals.openedition.org/abe             abe             fulltext        Full access to the HTML version of the content. Access to PDF and Epub reserved to subscribing institutions.    InVisu  serial                                                          F       187652759
Afrique : Archéologie et Arts        1634-3123       2431-2045       2004    3                                       http://journals.openedition.org/aaa             aaa             fulltext        Full access to the HTML version of the content. Access to PDF and Epub reserved to subscribing institutions.    CNRS - UMR 7041 (Archéologie et Sciences de l'Antiquité - ArScAn)       serial                                                          F       190738103
Afriques             2108-6796       2010    1                                       http://journals.openedition.org/afriques                afriques                fulltext        Full access to the HTML version of the content. Access to PDF and Epub reserved to subscribing institutions.    Institut des mondes africains (IMAF)    serial                                                          F       144221322
Aitia. Regards sur la culture hellénistique au XXIe siècle           1775-4275       2011    1                                       http://journals.openedition.org/aitia           aitia           fulltext        Full access to the HTML version of the content. Access to PDF and Epub reserved to subscribing institutions.    ENS Éditions    serial                                                          F       15515737X
Alsic                1286-4986       1998    1       1                               http://journals.openedition.org/alsic           alsic           fulltext        Full access to the HTML version of the content. Access to PDF and Epub reserved to subscribing institutions.    Adalsic serial                                                          F       040654435
América      0982-9237       2427-9048       2011    40                                      http://journals.openedition.org/america         america         fulltext        Full access to the HTML version of the content. Access to PDF and Epub reserved to subscribing institutions.    Presses Sorbonne Nouvelle       serial                                                          F       187771863
Amerika              2107-0806       2010    1                                       http://journals.openedition.org/amerika         amerika         fulltext        Full access to the HTML version of the content. Access to PDF and Epub reserved to subscribing institutions.    LIRA-Université de Rennes 2     serial                                                          F       142582050
Amérique latine histoire et mémoire  1628-6731       1777-5175       2000    1                                       http://journals.openedition.org/alhim           alhim           fulltext        Full access to the HTML version of the content. Access to PDF and Epub reserved to subscribing institutions.    Université Paris VIII   serial                                                          F       111735939
Amnis                1764-7193       2001    1                                       http://journals.openedition.org/amnis           amnis           fulltext        suppl. H.S. 1, 2004 ; H.S. 2, 2011 ; Journées d'études, 2013 ; numéro spécial 2015 ; numéro spécial 2018 | Full access to the HTML version of the content. Access to PDF and Epub reserved to subscribing institutions. TELEMME - UMR 6570      serial                                                          F       090141377

Integrating to library tools

Library tools often come with a knowledge base provided by the sotfware vendor. For example, ProQuest’s services are backed by the 360 CORE KB. It is possible that such knowledge bases include metadata related to OpenEdition’s catalogue. Yet, you may want to manually setup your ILP to import and update its data straight from BACON.

In order to do so, the steps to follow depend on the tool you’re using. Most of the time, you should be looking for menus called Electronic Resources Management (ERM) or Holdings Management. You should be able to add a custom source for your resources, or as it is sometimes called, set up a locally-managed holdings database.

Extensive documentation on how to perform these operations is provided by ProQuest for 360 CORE, and for Primo, and by EBSCO for EBSCO Admin. If needed, you should ask your library software provider for support.

Note

As a complement, this slideshow from a conference at JABES 2016 (in French) describes a BACON-based workflow for updating electronic collections.

Working with KBART files in LibreOffice

We provide here a simple example of how to perform data extraction from BACON with LibreOffice (a free and open source office suite, created and maintained by The Document Foundation). We’ll show how to automatically retrieve coverage data for Open Access Journals from OpenEdition Journals.

Working with the data

Now let’s rename this sheet as “BACON” and switch to another sheet. From this one, which won’t be affected when we update the data, we can perform usual operations with Libreoffice: filtering, using formulas & macros, etc.

For example, in order to search for a given journal by its e-ISSN and return its first available issue, we can enter this formula in the A1 cell: (The searched ISSN has to be entered in cell B1)

=CONCAT(VLOOKUP(B1;$BACON.C:E;2;0);"-";VLOOKUP(B1;$BACON.C:E;3;0))

With a little practice, powerful tools can be built this way, in order to monitor publications or track newly available issues. The extensive Libreoffice documentation may be of some help.

Updating data

This file can be saved to be reused with newer data or another Kbart file.

When needed, the data might be updated by using the “Links to external files” in the “Edit” menu:

_images/libreoffice_update.png

Going further…

Using the Kbart files is also an opportunity to get a bit into OpenEdition’s data. As an example, this page will show how to retrieve structured metadata about available issues for a given journal, using KBART files.

We will be using common command line tools to illustrate how it can be achieved but other implementations are possible.

We’ll be working on the journal identified by ISSN 2275-2145, Sciences de la société

Get the KBART from BACON

First we need to get the data. Refer to the access section of this documentation in order to identify the relevant package for your case and its URL.

We use here the whole OpenEdition Journal catalogue, so the matching URL is https://bacon.abes.fr/package2kbart/OPENEDITION_GLOBAL_ALLJOURNALS.txt

For this example, we will be using curl to download the desired KBART file:

$ curl https://bacon.abes.fr/package2kbart/OPENEDITION_GLOBAL_ALLJOURNALS.txt

Extract a journal’s data

This last command will pour the entire catalogue description as TSV in the console and its output won’t be shown here. Instead, we’ll pipe (|) it to grep in order to isolate the target journal, with grep 2275-2145:

$ curl https://bacon.abes.fr/package2kbart/OPENEDITION_GLOBAL_ALLJOURNALS.txt | grep 2275-2145
% Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                              Dload  Upload   Total   Spent    Left  Speed
100 32736    0 32736    0     0   9977      0 --:--:--  0:00:03 --:--:--  9977
Sciences de la société       1168-1446       2275-2145       2010    79                                      http://journals.openedition.org/sds             sds             fulltext        Full access to the HTML version of the content. Access to PDF and Epub reserved to subscribing institutions.    Presses universitaires du Midi  serial                                                          F       180782584

Parse columns to find an identifier

Please refer to the data description section of this documentation in order to identify the relevant fields for your case.

Here, the identifier we need is in the target_id column, which happens to be the twelfth. Then we can simply cut the line to extract this identifier, with cut -d$'\t' -f12:

$ curl https://bacon.abes.fr/package2kbart/OPENEDITION_GLOBAL_ALLJOURNALS.txt | grep 2275-2145 | cut -d$'\t' -f12
% Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                               Dload  Upload   Total   Spent    Left  Speed
100  119k    0  119k    0     0  40395      0 --:--:--  0:00:03 --:--:-- 40395
sds

Query OAI-PMH

Now we will query the OpenEdition OAI-PMH repository using this identifier. Please refer to the documentation if you need more information about it.

We will use this sample query URL from the documentation, which expects a journal identifier to be appended to it: http://oai.openedition.org/?verb=ListRecords&metadataPrefix=mets&set=journals:

So we can use the commands we already saw to append this identifier:

$ curl https://bacon.abes.fr/package2kbart/OPENEDITION_GLOBAL_ALLJOURNALS.txt | grep 2275-2145 | cut -d$'\t' -f12 | curl "http://oai.openedition.org/?verb=ListRecords&metadataPrefix=mets&set=journals:$(</dev/stdin)"
% Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                               Dload  Upload   Total   Spent    Left  Speed
100  119k    0  119k    0     0  35593      0 --:--:--  0:00:03 --:--:-- 35603
 <?xml version="1.0" encoding="UTF-8"?>
 <OAI-PMH xmlns="http://www.openarchives.org/OAI/2.0/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.openarchives.org/OAI/2.0/ http://www.openarchives.org/OAI/2.0/OAI-PMH.xsd">
   <responseDate>2020-03-24T14:51:22Z</responseDate>
   <request verb="ListRecords" metadataPrefix="mets" set="journals:sds">http://oai.openedition.org/</request>
   <ListRecords xmlns:mets="http://www.loc.gov/METS/" xmlns:dcterms="http://purl.org/dc/terms/" xmlns:xlink="http://www.w3.org/1999/xlink">
     <record>
       <header>
         <identifier>oai:revues.org:sds/6800</identifier>
         <datestamp>2019-11-25T16:59:19Z</datestamp>
         <setSpec>journals</setSpec>
         <setSpec>journals:sds</setSpec>
         <setSpec>openaire</setSpec>
       </header>
       <metadata>
         <mets:mets xmlns:mets="http://www.loc.gov/METS/" xmlns:dcterms="http://purl.org/dc/terms/" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.loc.gov/METS/ http://www.loc.gov/standards/mets/mets.xsd http://www.w3.org/1999/xlink http://www.loc.gov/standards/mets/xlink.xsd http://purl.org/dc/terms/ https://dublincore.org/schemas/xmls/qdc/2006/01/06/dcterms.xsd">
           <mets:dmdSec ID="MD_OJ_sds_6800">
             <mets:mdWrap MDTYPE="DC" LABEL="Dublin Core Descriptive Metadata" MIMETYPE="text/xml">
               <mets:xmlData>
                 <dcterms:title>L'événement politique en ligne</dcterms:title>
                 <dcterms:type>issue</dcterms:type>
 [...]
 output has been truncated

We now have a XML-structured list of records, formatted as Metadata Encoding and Transmission Standard (mets), describing available issues for the journal Sciences de la société, identified by ISSN 2275-2145.

OpenEdition

OpenEdition is a comprehensive digital publishing infrastructure at the service of scientific information in the Humanities and Social Sciences. The OpenEdition portal includes four publishing and information platforms in the humanities and social sciences: OpenEdition Journals, OpenEdition Books, Hypotheses (research blogs) and Calenda (announcements of international academic events). The portal is thus a space dedicated to the promotion of research, publishing tens of thousands of scientific documents that promote open access, while respecting the economic equilibrium of publications.

https://www.openedition.org

License

Creative Commons Attribution 4.0 International License

OpenEdition KBART Documentation is licensed under a Creative Commons Attribution 4.0 International License.

Creative Commons CC0 1.0 Universal

KBART files are published on BACON and on OpenEdition under the terms of Creative Commons CC0 1.0 Universal.

Need help ?

Please email us: referencement@openedition.org

Changelog

Will be available with the first version.