released in prod. Both methods supported until end-of-life for old syntax
Collection type 11
released in stage/test
Device support
released in stage/test (both export and import)
EUDR, FSC, PEFC, carbon emission
support for EUDR is postponed, due to delays in the implementation of EUDR
support for FSC, PEFC, carbon emission expected in Q2/2025
Contributor Unnamed Persons
Released in stage/test
In prod from
EUDR, FSC, PEFC, carbon emission
Delayed expected delivery Q2/2025
Contributor Role Code
Released (except B34)
Device support
Delayed expected delivery dates
Price condition
Delayed expected delivery quarter
Text and data mining
Released
“Chapters in audio and ebooks” deployed to test/stage
“Text and data mining” deployed to test/stage
Introduction
To meet the customers demands for more metadata, we are releasing some changes at the end of 2024 / start of 2025. Note: Some of those are also breaking changes. Check the time-schedule.
⚠️ We need your feedback by 20 October 2024 on when changes marked "critical change" can be handled. If we do not receive feedback, this is interpreted as the changes being handled by you, and we follow the set schedule.
General note about compatibility
All changes are compatible with Onix 3.0 (covered by existing schema), and should therefore not break anything. We expect that customers will always handle that more and more fields are populated (as long as they are in the schema.
Introducing a new export-endpoint (v2)
When we introduce Onix 3.1 we see that we need a new endpoint to not break existing integrations.
All the new features will be available from export-endpoint “v2”. See dokumentation ONIX
Onix Export v1 - end of life
We want all our customers to move to v2 to get all the new features, including Onix 3.1.
v1 is now deprecated and will be removed mid-summer 2025
Schedule / Status
Feature
Available from (endpoint version)
Status
Contributor Unnamed Persons
import
Q4 2024
DONE
Contributor Unnamed Persons
export
In prod from (only v2)
⚠️ Breaking change
TEST / STAGE
Subject
export
September 2024
DONE
FSC, PEFC, carbon emission
import
Q2 2025 (only v2)
NOT STARTED
FSC, PEFC, carbon emission
export
Q2 2025 (only v2)
NOT STARTED
Contributor Role Code
import
November 2024
DONE
Contributor Role Code
export
November 2024
DONE
Chapters in audio/text books
export
October 2024 (only v2)
TEST / STAGE
Device support
import
⚠️ End-of-life for old syntax
DONE
Device support
export
(only v2)
In stage from
⚠️ Breaking change
TEST / STAGE
Collection (publisher)
import
Q4 2024
TEST / STAGE
Collection (publisher)
export
Q4 2024 (only v2)
TEST / STAGE
Price condition
import
Q2 2025
NOT STARTED
Price condition
export
Q2 2025
NOT STARTED
Text and data mining
export
October 2024
DONE
Onix 3.1
import
TBT
NOT STARTED
Onix 3.1
export
(only v2)
DONE
Features / changes
Contributor Unnamed Persons BREAKING CHANGE
Breaking Change
Only for export
Unnamed Persons allows positive indication of content generated by AI or where synthesised voices are used for audio content.
Unnamed Persons is part of the Contributor composite.
Unnamed Persons will be supported both for metadata to and from Bokbasen.
Guide
Unnamed Persons uses codes from List 19, combined with the element ContributorRole and codes from list 17.
Supported codes will be:
02 Anonymous (real person) 05 Synthesised voice - male 06 Synthesised voice - female 07 Synthesised voice - unspecified 08 Synthesised voice - based on real voice actor 09 AI (artificial intelligence)
The Subject element contains classification from several different schemes.
Bokbasen will deprecate two proprietary vocabularies for literary form and genres, and replace them with terms from the official Norwegian thesaurus on genre and form (NTSF). The thesaurus is provided by the National Library of Norway.
All records will be updated with terms and URIs from NTSF.
Terms from NTSF will be supported in records from Bokbasen only.
Terms from proprietary vocabularies and NTSF will be included in records from Bokbasen in parallell to facilitate this transitio
Guide
The Norwegian thesaurus on genre and form is identified by code C8 from list 27 in Subject Scheme Identifier.
Terms from the proprietary vocabularies was sent in Subject like this: <Subject> <SubjectSchemeIdentifier>24</SubjectSchemeIdentifier> <SubjectSchemeName>Bokbasen_Form</SubjectSchemeName> <SubjectHeadingText>Romaner</SubjectHeadingText> </Subject>
Support for EUDR is postponed due to delays in the implementation of the regulation, and consequences for the Norwegian market.
Support for FSC, PEFC and carbon emissions will be added as planned.
ProductFormFeature and ProductFormFeatureType is used to indicate if a product is in compliance with EU deforestation regulations (EUDR), is FSC or PEFC certified, or information about a carbon emission scheme.
According to EUDR, provenance of raw material source plot must be stated using GPS coordinates. Publishers are expected to add both an identifier for a Due Diligence Record in the EU registry (DDS) and details of provenance of raw material for cover and body of the product.
Guide
Codes from list 79 Product form feature type identifies what type of information is sent in other subfields of ProductFormFeature.
To facilitate navigation in apps for audio books, we will add metadata describing chapters in Onix records. We will also supply chapters for ebooks. We will start to support manual chapters, and then work with automatic chapters that publishers then need to approve.
Guide
Support for block 3 will be added.
AVItem in ContentDetail will contain information about chapter numbers and start time for each chapter.
LevelSequenceNumber indicated logical numbering, and will not necessarily contain the same number as the chapter number.
AVItemType includes codes from list 240, identifying if the part is front, body or end matter. TextType includes codes from list 42, identifying if the part is front, body or end matter.
TimeRun will indicate start time for each chapter. Format for StartTime/AVDuration is “HHHMMss“.
If you want to supply a title, use TitleDetail. TitleType (list 15) should be 01. TitleElementLevel (list 149) should be 04.
Adding support for other subfields will be considered.
Example (Audio Chapters)
<ContentDetail> <ContentItem> <LevelSequenceNumber>1</LevelSequenceNumber> <AVItem> <AVItemType>03</AVItemType> <TimeRun> <StartTime>0000000</StartTime> </TimeRun> <AVDuration>0010343</AVDuration> <!-- 001h, 03m, 43s --> </AVItem> <ComponentTypeName>Kapittel</ComponentTypeName> <ComponentNumber>1</ComponentNumber> <TitleDetail> <TitleType>01</TitleType> <TitleElement> <TitleElementLevel>04</TitleElementLevel> <TitleText>The name of the first chapter</TitleText> </TitleElement> </TitleDetail> </ContentItem> … <ContentDetail>
Example (Text Chapters)
<ContentDetail> <ContentItem> <LevelSequenceNumber>1</LevelSequenceNumber> <TextItem> <TextItemType>03</TextItemType> <PageRun> <FirstPageNumber>2</FirstPageNumber> </PageRun> <NumberOfPages>22</NumberOfPages> </TextItem> <ComponentTypeName>Kapittel</ComponentTypeName> <ComponentNumber>1</ComponentNumber> <TitleDetail> <TitleType>01</TitleType> <TitleElement> <TitleElementLevel>04</TitleElementLevel> <TitleText>The name of the first chapter</TitleText> </TitleElement> </TitleDetail> </ContentItem> … <ContentDetail>
Device support BREAKING CHANGE
Breaking Change
Export:
Will only give the new format
Import:
We will still support the old syntax until given date
We will move away from using ProductFormDescription.
It will now be present as ProductFormFeatureDescription (code 07 from list 79). to allow the indication of multiple devices supported.
Price condition is used to indicate when the subscription of a product is automatically renewed. Typically used for digital learning resources.
The duration of the license period is specified in PriceConditionQuantity/EpubConstraint?.
Guide
Code 12 from list 167 is used in PriceConditionType to indicate that the rental or subscription will automatically renewed at the end of the period unless actively cancelled.
CollectionType is used to indicate what type of collection is described in the metadata.
Support for code 11 for identifying publisher’s collections will be added.
Publisher’s collections are bibliographic collections defined and identified by a publisher, often used for marketing purposes, and often with a distinct design style. The books in the collection does not necessarily have a specific order, shared subject or authorship.
Collections where the books in the collection have a shared subject, narrative or authorship, are identified by collection type 10. This collection type is independent of the publisher, and will be added as metadata to all editions of a book.
In February 2023 the Onix Steering Committee agreed that in addition to adding new features to Onix, various data elements that were deprecated, plus the <Gender> tag were to be removed. This necessitated the labelling of the revision as release 3.1.
Aside from the removal of the deprecated elements and <Gender>, these updates are all optional and fully backwards-compatible.
Bokbasen will do a revision of Onix both to and from Bokbasen, to make sure that the records are compatible with version 3.1
The deprecated elements has originally not been supported by Bokbasen, and the upgrade to Onix 3.1 should not cause problems for customers of Bokbasen.