Versions Compared

Version Old Version 39 New Version Current
Changes made by

Fride Fosseng

Svein Are Grønsund

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
stylenone

Changelog

...

Date

...

Table of Contents
stylenone

Changelog

Date

Introducing v2-endpoint for Onix Export. Most new features will be exclusive to the new v2-endpoint, see also deprecation-notice for v1.

  • Device support

    • 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

...

    • “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

Note

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

Status
colourGreen
titledone

Contributor Unnamed Persons

  • export

In prod from (only v2)

⚠️ Breaking change

Status
colourBlue
titleTEST / STAGE

Subject

  • export

September 2024

Status
colourGreen
titledone

FSC, PEFC, carbon emission

  • import

Q2 2025 (only v2)

Status
titlenot started

FSC, PEFC, carbon emission

  • export

Q2 2025 (only v2)

Status
titlenot started

Contributor Role Code

  • import

November 2024

Status
colourGreen
titledone

Contributor Role Code

  • export

November 2024

Status
colourGreen
titledone

Chapters in audio/text books

  • export

October 2024January 2025 (only v2)

Status
colourBlueGreen
titleTEST / STAGEdone

Device support

  • import

⚠️ End-of-life for old syntax

Status
colourGreen
titledone

Device support

  • export

January 2025 (only v2)

In stage from

⚠️ Breaking change

Status
colourBlueGreen
titleTEST / STAGEdone

Collection (publisher)

  • import

Q4 2024

Status
colourBlueGreen
titleTEST / STAGEdone

Collection (publisher)

  • export

Q4 2024 (only v2)

Status
colourBlueGreen
titleTEST / STAGEdone

Price condition (automatic renewed)

  • import

Q2 2025

Status
titleNot started

Price condition (automatic renewed)

  • export

Q2 2025

Status
titleNot started

Text and data mining

  • export

October 2024

Status
colourGreen
titledone

Onix 3.1

Q4 2024

  • import

TBA

Status
titleNot started

Onix 3.1

  • export

(only v2)

Status
colourGreen
titledone

GPSR - General Product Safety Regulation (EU)

Q1 2025 (only v2)

Status
titleNot started

Features / changes

...

Expand
titleGuide

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>

<Subject>
<SubjectSchemeIdentifier>24</SubjectSchemeIdentifier>
<SubjectSchemeName>Bokbasen_Genre</SubjectSchemeName>
<SubjectHeadingText>Krim</SubjectHeadingText>
</Subject>

Expand
titleExamples

<Subject>
<SubjectSchemeIdentifier>24</SubjectSchemeIdentifier>
<SubjectSchemeName>Bokbasen_Form</SubjectSchemeName>
<SubjectHeadingText>Romaner</SubjectHeadingText>
</Subject>

<Subject>
<SubjectSchemeIdentifier>24</SubjectSchemeIdentifier>
<SubjectSchemeName>Bokbasen_Genre</SubjectSchemeName>
<SubjectHeadingText>Krim</SubjectHeadingText>
</Subject>

<Subject>
<SubjectSchemeIdentifier>C8</SubjectSchemeIdentifier>
<SubjectCode>https://id.nb.no/vocabulary/ntsf/25</SubjectCode>
<SubjectHeadingText>Romaner</SubjectHeadingText>
</Subject>

<Subject>
<SubjectSchemeIdentifier>C8</SubjectSchemeIdentifier>
<SubjectCode>https://id.nb.no/vocabulary/ntsf/159</SubjectCode>
<SubjectHeadingText>Krim</SubjectHeadingText>
</Subject>

EUDR, FSC, PEFC, carbon emission

...

Expand
titleExamples

Due Diligence Statement

<ProductFormFeature>
<ProductFormFeatureType>50</ProductFormFeatureType>
<ProductFormFeatureValue>24FRXVV3VOS991</ProductFormFeatureValue>
</ProductFormFeature>

Provenance of raw material for cover

Example shows single GPS coordinate (latitude and longitude), denoting the centre of a 4Ha plot of land where the trees grew.

<ProductFormFeature>
<ProductFormFeatureType>48</ProductFormFeatureType>
<ProductFormFeatureValue>GB 202401</ProductFormFeatureValue>
<ProductFormFeatureDescription>51.544708 0.061076</ProductFormFeatureDescription>
</ProductFormFeature>

Provenance of raw material for body

Three or more GPS coordinates denotes a polygon outlining the forest where the trees grew.

<ProductFormFeature>
<ProductFormFeatureType>47</ProductFormFeatureType>
<ProductFormFeatureValue>GB 202311</ProductFormFeatureValue>
<ProductFormFeatureDescription>51.549040 -0.120975, 51.556838 -0.127326, 51.555092 -0.108261, 51.549040 -0.120975</ProductFormFeatureDescription>
</ProductFormFeature>

Contributor Role Code

Contributor role code is used to indicate the role played by a person or a corporate body in the creation of the product.

...

Code

Heading

A15

Preface by

A19

Afterword by

A23

Foreword by

A36

Cover design or artwork by (children’s literature only)

A42

Continued by

A43

Interviewer

A44

Interviewee

B34

Sensitivity reader / editor

Expand
titleExample

<Contributor>
<SequenceNumber>1</SequenceNumber>
<ContributorRole>A23</ContributorRole>
<NameType>04</NameType>
<NameIdentifier>
<NameIDType>01</NameIDType>
<IDTypeName>Bokbasen_ProprietaryID</IDTypeName>
<IDValue>90707439</IDValue>
</NameIdentifier>
<PersonNameInverted>Gaugin, Paul René</PersonNameInverted>
</Contributor>

Chapters in audio and ebooks

...

Expand
titleExample (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>

Expand
titleExample (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
Status
colourRed
titleBreaking change

...

It will now be present as ProductFormFeatureDescription (code 07 from list 79). to allow the indication of multiple devices supported.

Expand
titleExample

<ProductFormDescription>Smarttelefon</ProductFormDescription>

<ProductFormFeature>
<ProductFormFeatureType>07</ProductFormFeatureType>
<ProductFormFeatureDescription>Smarttelefon</ProductFormFeatureDescription>
</ProductFormFeature>

Price condition (automatic renewed)

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?.

Expand
titleGuide

Code 12 07 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.

Expand
titleExamples

<PriceCondition>
<PriceConditionType>07</PriceConditionType
<PriceConditionQuantity>
<PriceConditionQuantityType>02</PriceConditionQuantityType
<Quantity>12</Quantity>
<QuantityUnit>09</QuantityUnit>
</PriceConditionQuantity>
<ProductIdentifier>
<ProductIDType>15</ProductIDType>
<IDValue>9788205399815</IDValue>
</ProductIdentifier>
</PriceCondition>

Collection (Norw. forlagsserie)

...

Expand
titleExamples

Collection Type 11 (publisher’s collection)

<Collection>
<CollectionType>11</CollectionType>
<CollectionIdentifier>
<CollectionIDType>01</CollectionIDType>
<IDTypeName>Bokbasen_ProprietaryID</IDTypeName>
<IDValue>150140617</IDValue>
</CollectionIdentifier>
</CollectionIdentifier>
<TitleDetail>
<TitleType>01</TitleType>
<TitleElement>
<TitleElementLevel>02</TitleElementLevel>
<TitleText>Bestselger Schibsted</TitleText> <TitleDetail>
<TitleType>01</TitleType>
<TitleElement>
<TitleElementLevel>02</TitleElementLevel>
<TitleText>Bestselger Schibsted</TitleText>
</TitleElement>
</TitleDetail>
</Collection>

Collection Type 10, with part number element

<Collection>
<CollectionType>10</CollectionType>
<CollectionIdentifier>
<CollectionIDType>01</CollectionIDType>
<IDTypeName>Bokbasen_ProprietaryID</IDTypeName>
<IDValue>20090529101912_rine</IDValue>
</CollectionIdentifier>
<TitleDetail>
<TitleType>01</TitleType>
<TitleElement>
<TitleElementLevel>02</TitleElementLevel>
<TitleText>Percy Jackson</TitleText>
</TitleElement>
<TitleElement>
<TitleElementLevel>01</TitleElementLevel>
<PartNumber>1</PartNumber>
</TitleElement>
</TitleDetail>
</Collection>

Collection Type 10, with part number element

<Collection>
<CollectionType>10</CollectionType>
<CollectionIdentifier>
<CollectionIDType>01</CollectionIDType>
<IDTypeName>Bokbasen_ProprietaryID</IDTypeName>
<IDValue>20090529101912_rine</IDValue>
</CollectionIdentifier>
<TitleDetail>
<TitleType>01</TitleType>
<TitleElement>
<TitleElementLevel>02</TitleElementLevel>
<TitleText>Percy Jackson</TitleText>
</TitleElement>
<TitleElement>
<TitleElementLevel>01</TitleElementLevel>
<PartNumber>1</PartNumber>
</TitleElement>
</TitleDetail>
</Collection>

Text and data mining

In all Bokbasen’s customer contracts, use of the product for extraction or automated computer analaysis is regulated and forbidden.

This constraint will be added to the Onix-records in Epub Usage Constraint.

Expand
titleGuide

EpubUsageType will include information indicating that use of the content of the product by artificial intelligence systems is forbidden.

Usage type 11 is used in combination with code 03 in EpubUsageStatus, to state that text and data mining is prohibited.

Expand
titleExample

<EpubUsageConstraint>
<EpubUsageType>11</EpubUsageType>
<EpubUsageStatus>03</EpubUsageStatus>
</EpubUsageConstraint>

Onix 3.1

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.

...

titleDeprecated elements

Deprecated elements in Onix 3.1_

Audience code

Conference

CurrenzyZone

DateFormat

PromotionContact

Reissue

Gender

...

Text and data mining

In all Bokbasen’s customer contracts, use of the product for extraction or automated computer analaysis is regulated and forbidden.

This constraint will be added to the Onix-records in Epub Usage Constraint.

Expand
titleGuide

EpubUsageType will include information indicating that use of the content of the product by artificial intelligence systems is forbidden.

Usage type 11 is used in combination with code 03 in EpubUsageStatus, to state that text and data mining is prohibited.

Expand
titleExample

<EpubUsageConstraint>
<EpubUsageType>11</EpubUsageType>
<EpubUsageStatus>03</EpubUsageStatus>
</EpubUsageConstraint>

Onix 3.1

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.

Expand
titleDeprecated elements

Deprecated elements in Onix 3.1_

Audience code

Conference

CurrenzyZone

DateFormat

PromotionContact

Reissue

Gender

Language, PriceType and Currency in Header

GPSR - General Product Safety Regulation (EU)

General Product Safety Regulations (GPSR) of the European Union, came into force at the end of 2024 and mandates specific contact details for consumer queries relating to physical product safety, product liability, defects in the product etc. The requirements apply to both over-the-counter sales within the EU and to all online sales to EU customers, even for products like ‘books’ that are generally considered ‘safe’.

ProductContact will be added to metadata for all physical products.

Expand
titleExample

<ProductContact>
<ProductContactRole>10</ProductContactRole>
<ProductContactName>{PUBLISHER_NAME}</ProductContactName>
<EmailAddress>{PUBLIC_EMAIL}</EmailAddress>
<StreetAddress>{POSTAL_ADDRESS}</StreetAddress>
<LocationName>{CITY}</LocationName>
<PostalCode>{POSTAL_CODE}</PostalCode>
<CountryCode>{COUNTRY_CODE_ONIX_91}</CountryCode>
</ProductContact>