CARVIEW |
ONIX
ONIX for Books
- - Overview
- - FAQs
- - About Release 3.0 and 3.1
- - Release 3.0 and 3.1 Downloads
- - Code Lists
- - Archived Previous Releases
- - Maintenance and support
- - ONIX and MARC21
ONIX for Subscription Products
- - Overview
- - ONIX-PC
- - ONIX-PH
- - ONIX-SOH
- - ONIX-SPS
- - ONIX-SRN
- - Serials Code Lists
- - Serials Coverage Statement
- - Structured Name and Address Model
Licensing Terms and Rights Information
- - Overview
- - ONIX-PL
- - ONIX-PL Examples
- - OPLE Software
- - ONIX-RS
- - ONIX for RROs
- - Royalty Reporting
ONIX Identifier Registration Formats
- - ONIX ISBN Registration format
- - ONIX ISTC Registration Format
- - ONIX DOI Registration Formats
E-Commerce
EDIFACT
- - EDIFACT Overview
- - Trade Book Supply
- - Library Book Supply
- - Serials and Subscription Products
- - Code Lists
EDItX XML
- - EDItX Overview
- - Trade Book Supply
- - Library Book Supply
- - Consumer Direct Fulfilment
- - Sales and Inventory Reporting
- - ICEDIS Subscription Claims
- - ICEDIS New Orders
ICEDIS Fixed-length Formats
- - Overview
- - Advice on Existing Subscription
- - Price at Subscription Level
- - Order Renewal and Transfer
- - Complete Guidelines
Filenaming
- - FTP Filenaming
ONIX
STANDARDS
ONIX
- ONIX for Books
- ONIX for Subscription Products
- Licensing Terms and Rights Information
- ONIX Identifier Registration Formats
E-Commerce
Identifiers
Thema current version 1.6
Release 3.0 and 3.1 Downloads
- ONIX 3.0 and 3.1 Specifications latest revision 3.1.2, codelists issue 70
- Implementation and best practice guide latest revision 3.1.2, codelists issue 70
- Schemas (DTD, XSD, RNG files) latest revision 3.1.2, codelists issue 70
- ONIX 3.0 Tagname converter and Large file splitter
- Code Lists for Release 3.0 and 3.1 latest issue 70
- Additional Guidelines
- Documentation in other languages
ONIX 3.0 and 3.1 Specifications
For the core ONIX 3.0 and 3.1 documentation, the packages below include the Product Information Format Specification in PDF format. For packages containing the same information in HTML format, see the Implementation and Best Practice Guides package below.
The documentation package includes the full ONIX for Books Product Information Message Format Specification covering both the Header and the Product record of the Product Information Message format. Appendices include a full sample message and a summary list of all the ONIX XML tags. The package also includes HTML versions of the latest Codelists, which are hyperlinked from the main specification document. The individual codelists should be in a subfolder ‘codelists’ (lower case) within the same folder as the main PDF in order for the links to be recognized.
- ONIX for Books 3.0.8 Specification + Codelists Issue 70 (PDF in ZIP)
- ONIX for Books 3.1.2 Specification + Codelists Issue 70 (PDF in ZIP)
The latest version of the Specification covers 3.1, released March 2023. This revision is almost fully backward-compatible with earlier versions of the 3.0 specification. A detailed summary of the changes between version 3.0.8 and the latest 3.1 is available. Summaries for earlier updates are also available.
- Summary of changes from 3.1.1 to 3.1.2 (PDF)
- Summary of changes from 3.1 to 3.1.1 (PDF)
- Summary of changes from 3.0.8 to 3.1 (PDF)
- Summary of changes from 3.0.7 to 3.0.8 (PDF)
- Summary of changes from 3.0.6 to 3.0.7 (PDF)
- Summary of changes from 3.0.5 to 3.0.6 (PDF)
- Summary of changes from 3.0.4 to 3.0.5 (PDF)
- Summary of changes from 3.0.3 to 3.0.4 (PDF)
- Summary of changes from 3.0.2 to 3.0.3 (PDF)
- Summary of changes from 3.0.1 to 3.0.2 (PDF)
- Summary of changes from 3.0 (2010) to 3.0.1 (PDF)
The Specification also includes an annotated sample file, and the file itself can be downloaded separately.
- Sample ONIX 3.0 message file (XML file in zip)
- Sample ONIX 3.1 message file (XML file in zip)
The ONIX for Books Acknowledgement Format Specification, released January 2015, is a separate and optional message intended to be sent to an ONIX data supplier in response to receipt of a standard ONIX for Books message. It allows an ONIX for Books recipient to:
- confirm receipt of the original ONIX message
- report to the original sender a summary of Product records processed and updated into the recipient’s database
- report details of any errors encountered, or any queries about the product data supplied, or
- return to the sender details of proprietary identifiers assigned by the recipient
It can form part of a ‘choreography’ of messages between sender and recipient (say between publisher and data aggregator, or between distributor and retailer). However, it is not expected that it will be used in every ONIX 3.0 data feed, and where it is adopted, implementations might at first use only the simplest functionality (confirmation of receipt).
The documentation package contains the full ONIX Acknowledgement message Specification. If placed in the same folder as the main ONIX specification PDF and the associated ‘codelists’ subfolder, it too contains hyperlinks linking directly to the codelists. The specification also includes a number of annotated sample acknowledgement messages, and the sample files can be downloaded separately.
Note this initial version is numbered Release 3.0 only for consistency with the numbering of the main ONIX message specification.
Implementation and Best Practice Guide
An Implementation and Best Practice Guide has been created to accompany the main ONIX Specification. These guidelines are intended to set a global benchmark for implementors, to reduce the variation between different interpretations of the standard in different countries, and to ensure that ONIX 3.0 messages are as interoperable as possible on a global scale.
The documentation package includes the Implementation and Best Practice Guide, as well as the enhanced Message Specification, the Acknowledgement Specification, plus the latest version of the codelists, all in HTML format. The Specification and the Guide are extensively linked together for ease of use.
- ONIX for Books 3.0.8 Specification + Acknowledgement Specification + Best Practice Guide + Codelists Issue 70 (HTML in ZIP)
- ONIX for Books 3.1.2 Specification + Acknowledgement Specification + Best Practice Guide + Codelists Issue 70 (HTML in ZIP)
Note the Guide is updated regularly – typically in line with new Issues of the Codelists – to incorporate improvements and additional guidance. Any comments on the guidelines should be forwarded to graham@editeur.org – views are particularly encouraged from non-English language implementers, and on how well the best practices described meet the needs of different national book and e-book supply chains.
Three schema definition options are available for ONIX 3.0, two for ONIX 3.1. The recommended options are the W3C (XSD) schema language or the ISO standard RelaxNG (RNG) schema language, which both allow effective validity checking. However, a legacy DTD option is also available – though not recommended – for ONIX 3.0. All options support both reference names and short tags for ONIX data elements. Each is downloadable below as a zipped package, and all the packages include the latest issue of the codelists (with a DTD these can be used only to control attribute values, not coded data elements).
- ONIX for Books 3.0.8 XSD Schema + Codelists Issue 70 (XML in Zip)
- ONIX for Books 3.0.8 RNG Schema + Codelists Issue 70 (XML in Zip)
- ONIX for Books 3.0.8 DTD + Codelists Issue 70 (XML in Zip)
- ONIX for Books 3.1.2 XSD Schema + Codelists Issue 70 (XML in Zip)
- ONIX for Books 3.1.2 RNG Schema + Codelists Issue 70 (XML in Zip)
- no DTD is available for ONIX 3.1.2 – use the XSD instead
- Note some improvements made to the schema files alongside Issue 32 (PDF)
For ONIX 2.1, EDItEUR originally maintained copies of the latest versions of the DTDs and XSD schemas on its website, for online lookup as part of the validation of an ONIX message. As part of the planned ‘sunset’ of ONIX 2.1 at the end of 2014, this online option was removed. For ONIX 3.0 and 3.1, an online option has never been offered, partly because of the greater variety of schema technologies which are now available, partly to avoid adding an extra dependency into validation workflows, and partly because of the traffic loads which it would place on the EDItEUR’s website. For validation purposes, you should download whichever latest version of the schema option which you prefer, and store it locally. This means validations are much faster and potentially more reliable. EDItEUR strongly recommends validation of ONIX messages using the XSD or RNG schemas. For more detail, please see the XML technical notes which are part of the Release 3.0 and 3.1 documentation packages above.
Schema files (DTD, XSD and RNG) are also available for the initial release of the ONIX Acknowledgement message. This single zip file contains all versions, plus compatible codelist files.
An advanced XSD schema option is now available. This ‘strict’ version of the XSD implements many additional validation rules that cannot be implemented in the ordinary or ‘classic’ schema files. For example, the advanced schema is able to validate ISBN check digits. It validates certain rules around inclusion of countries and regions in <SalesRights>, and it checks the structure of any <Tax> information included with prices. The rules provide ‘friendly’ error messages. Optionally, it can also offer warnings when deprecated elements and codes are used.
This advanced schema uses XSD 1.1, so is compatible with some XML tools (eg oXygen, XML Spy or others based on the Saxon, Xerces or Raptor parsers), but is NOT compatible with simple (often free) XML tools that use libxml, including command line tools such as xmllint, or with Microsoft’s .NET XML framework (unless the Saxon parser for .NET has been installed).
Note: the advanced schema includes embedded versions of a handful of the ONIX codelists. It must therefore be updated upon each new release of the codelists themselves.
The advanced schema also contains embedded Schematron rules to provide the deprecation warnings. These are not enabled by default, and make no difference to the validation unless specifically enabled. Only limited documentation is available, and is included in the Zip package. This includes instructions on how to enable Schematron. It should be suitable for anyone who has experience of validation using the main XSD schema files with XSD 1.1-compatible tools.
- Note the introduction of a ‘strict’ schema (using XSD 1.1) (PDF)
- ONIX for Books 3.0.8 Advanced XSD Schema + Codelists Issue 70 (XML in ZIP)
- ONIX for Books 3.1.2 Advanced XSD Schema + Codelists Issue 70 (XML in ZIP)
The ‘strict’ schema files are updated regularly to keep alignment with the main schema files and to add new validation rules.
ONIX 3.0 and 3.1 Tagname converter and Large file splitter
The ONIX for Books Release 3.0 Tagname converter is an XSLT script which enables ONIX reference names to be translated into short tags, and vice versa. The XSLT script and instructions for its use are available here. This script can be used with ONIX files conforming to Releases 3.0 or 3.1. The latest v1.3 of the tag converter now works without a reference to the ONIX 3.0 DTD – it should now use the 3.0 or 3.1 XSD instead.
The Large file splitter allows single large ONIX files – which may contain thousands or tens of thousands of Product records – to be broken down into multiple smaller files. This can provide a simple way of avoiding Out of memory errors when processing large volumes of ONIX data. The XSLT script and instructions for use are available here. This XSLT works with any version of ONIX 2.1, 3.0 or 3.1.
A large file splitter for Windows with .Net v4.8 is also freely available, kindly contributed by ONIXtools.de – download it here. Instructions for use (in English) are in the config file within the zip.
Codelists for Release 3.0 and 3.1
The latest Issue of the ONIX Books Codelists includes all of the lists that are required for ONIX 3.0, 3.1 and the ONIX Acknowledgement message. A separate HTML document provides an eye-readable list of all codes, old and new, which are used in ONIX 3.0 and 3.1. You can also download a notice which details the changes made since the previous issue of the codelists. Earlier change notices and the latest codelists in other file formats (including various machine-readable formats) can be downloaded from the Codelists page of the website.
- ONIX Codelists Issue 70 Changes and updates (PDF)
- ONIX Codelists Issue 70 for Release 3.0 and 3.1 (HTML)
These additional documents provide more detailed guidance on how to use ONIX 3.0 and 3.1 than it is possible to include in a formal specification. The focus on specific aspects of ONIX usage, and areas that data providers and recipients find tricky.
Application Notes
Application notes are a series of short informal papers on specific aspects of ONIX. The visual application notes – pre-recorded webinar-style videos – are usually best viewed in combination with reading the main documents. Transcripts of the video app notes are provided for accessibility purposes (they use UTF-8 text encoding).
- Accessibility metadata in ONIX (essentials)
- Accessibility metadata in ONIX (advanced) UPDATED DRAFT comments are invited,
by e-mail to info@editeur.org - Aspects of AI in ONIX
- Audiobooks in ONIX
- Block 3 vs Block 8 (for audiobooks)
- Block updates in ONIX (or watch our visual application note [35 mins] [transcript])
- Collections in ONIX 3.0 and 3.1 [25 mins] (pre-recorded BISG Metadata 106 webinar [transcript])
- Collections in ONIX 3.0 and 3.1 (advanced) [30 mins] (pre-recorded advanced companion to BISG Metadata 106 webinar [transcript])
- Commodity codes and international trade in ONIX
- ‘Deletions’ in ONIX – use of Notification type code 05, and deleting fields via full record or block updates
- Did you know? – less well known aspects of ONIX
- Did you also know? – another handful of less well known aspects of ONIX
- E-books and digital content in ONIX
- Embedding HTML markup in ONIX (or watch our visual application note [30 mins] (transcript)
- EU Deforestation Regulations NEW or watch our earlier webinar [40 mins] (prerecorded BISG /Booknet Canada webinar [transcript])
- Identifiers in ONIX NEW
- Internationalising metadata [30 mins] (pre-recorded BISG Metadata 103 webinar [transcript])
- Languages in ONIX 3.0 and 3.1 [30 mins] (pre-recorded webinar)
- Lifecycle dates in ONIX
- Multilingual metadata in ONIX
- Open Access monographs in ONIX (or watch our visual application note [20 mins] (transcript)
- Pricing in ONIX (part one)
- Pricing in ONIX (part two)
- Product safety requirements in ONIX NEW
- Products in multiple markets (part one) (or watch our visual application note [15 mins] [transcript])
- Products in multiple markets (part two) NEW
- Publishing status and Product availability in ONIX
- Related products in ONIX
- Sales Rights in ONIX
- Twelve ONIX problems – common issues faced by ONIX recipients…
- and its companion Another twelve ONIX problems – common issues faced by data senders
- Validating ONIX 3.0 and 3.1 files (MacOS edition) (or watch our visual applicaton note [35 mins] [transcript])
- Validating ONIX 3.0 and 3.1 files (Windows edition)
- Weights and dimensions in ONIX
- Works in ONIX 3.0 and 3.1 [35 mins] (pre-recorded BISG Metadata 109 webinar [transcript])
Application Guides
Application guides comprise a limited set of longer papers on ONIX usage.
- How to describe sets and series in ONIX 3
ONIX 3.0 and 3.1 offer a better and more flexible way to describe sets and series than previous releases of ONIX. These guidelines also include worked examples of different use cases. - How to describe digital products in ONIX 3
The growing variety of ways in which e-books and other digital products are now formatted, packaged and distributed means that their description is necessarily something of a moving target. The guidelines and examples provided here remain in some respects provisional, and EDItEUR very much appreciates comments, either on the ONIX implementation discussion forum or through the ‘Contact us’ facility on the website (towards the bottom of the page). - How to send block updates in ONIX 3
The ‘block’ structure in ONIX 3.0 and 3.1 allows updates to individual blocks to be sent without sending complete replacement records. New records, complete replacement records and block updates can in principle be freely mixed in a single ONIX message. These guidelines provide details of notification type codes and business rules for ONIX 3.0 and 3.1 block updates. - How to specify different terms of supply in different territories<
These guidelines, which are applicable to ONIX 3.0 and 3.1, give details of how to specify agency terms in an ONIX message, using new code values added in March 2010. They will also be useful to senders who need to specify different terms in different supply territories even if they are not adopting an agency model. - Transitioning from ONIX 2.1 to ONIX 3 [115 mins] (pre-recorded BISG webinar)
Pour les utilisateurs des pays francophones, il existe une traduction en français des ONIX Version 3.0, réalisée avec permission sous le contrôle du groupe ONIX France et avec le soutien du Cercle de la Librairie (Paris), disponible sur le site:
Notez que cela n’inclut pas les dernières modifications qui ont été faites en Octobre 2010 ou Janvier 2012.
Documentation in Spanish
A complete translation of the ONIX 3.0.8 specification and up-to-date codelists is available from www.dilve.es, translation by Federación de Gremios de Editores de España and CERLALC.
Documentation in German
An initial ‘best practice’ document for the German-speaking market.
Documentation in Arabic
An Arabic version of the main parts of the ONIX 3.0 Specification translated with permission by El Kotob and ibiidi. It is available from https://www.editeur.org/files/ONIX%203/translations/arabic/AR-ONIX-Arabic-subset-11062012.pdf. An English version of this subset is also available from https://www.editeur.org/files/ONIX%203/translations/arabic/EN-ONIX-Arabic-subset-11062012.pdf.
Documentation in Portuguese (partial)
For use in Lusophone countries, a translation of the ONIX 3.0.2 Specification and key codelists in Brazilian Portuguese, translated with permission by Bibliomundi. Note that it is not complete – only those parts most relevant for e-book description and trading are included.
Documentation in Mandarin Chinese
ONIX 3.0 documentation is available in China as Chinese National Standard GB/T 30330:2013 (a translation of ONIX 3.0.2). This standard also contains a translation of the ONIX codelists (as at issue 12). An updated version of GB/T 30330 is in preparation.
Browse
- Home
- About
- Events
- Collaborations
- Membership
- - Application
- - Members List
- Contact
- ONIX for Books
- - Overview
- - FAQs
- - About Release 3.0 and 3.1
- - Release 3.0 and 3.1 Downloads
- - Code Lists
- - Archived Previous Releases
- - Maintenance and support
- - ONIX and MARC21
- ONIX for Subscription Products
- - Overview
- - ONIX-PC
- - ONIX-PH
- - ONIX-SOH
- - ONIX-SPS
- - ONIX-SRN
- - Serials Code Lists
- - Serials Coverage Statement
- - Structured Name and Address Model
- Licensing Terms and Rights Information
- - Overview
- - ONIX-PL
- - ONIX-PL Examples
- - OPLE Software
- - ONIX-RS
- - ONIX for RROs
- - Royalty Reporting
- ONIX Identifier Registration Formats
- - ONIX ISBN Registration format
- - ONIX ISTC Registration Format
- - ONIX DOI Registration Formats
- EDIFACT
- - EDIFACT Overview
- - Trade Book Supply
- - Library Book Supply
- - Serials and Subscription Products
- - Code Lists
- EDItX XML
- - EDItX Overview
- - Trade Book Supply
- - Library Book Supply
- - Consumer Direct Fulfilment
- - Sales and Inventory Reporting
- - ICEDIS Subscription Claims
- - ICEDIS New Orders
- ICEDIS Fixed-length Formats
- - Overview
- - Advice on Existing Subscription
- - Price at Subscription Level
- - Order Renewal and Transfer
- - Complete Guidelines
- Filenaming
- - FTP Filenaming
Contact Details
- EDItEUR Limited
- United House
- North Road
- London
- N7 9DP
- UK
- Registered office as above
- email: info@editeur.org
- tel: +44 (0)20 7503 6418
- fax: +44 (0)20 7503 6418
Terms & Conditions | Privacy Policy | Cookie Policy
Copyright © 2009 Editeur. All rights reserved.
Website by thegoodwebsitecompany.com