ONIX Serials Online Holdings Message Formats
ONIX Serials Online Holdings By-Host
Version 1.1 User Guide
Date issued: October 2007
This User Guide has been prepared for the
EDItEUR / NISO Joint Working Party for the Exchange of
Serials Online Holdings Information by Katharina Klemperer, David Martin and Francis
Cave. It is designed to accompany a machine-readable specification of the
formats written in XML Schema, which
has been developed by Francis Cave.
Copyright © 2006-2007
EDItEUR Limited. All rights reserved.
The structural diagrams have been produced using
XML Spy™ from Altova
General guidance on schema use
This schema provides a formal specification of what constitutes valid use of XML to construct ONIX Serials Online Holdings (SOH) messages. As well as specifying the XML tags that may be used and in what sequence, it also specifies valid ranges of data values for data contained in XML elements, i.e. between matching pairs of XML tags.
The schema to which this document refers comprises two files which together form an XML document that conforms to the XML Schema Recommendation of the World Wide Web Consortium (W3C). The two files are:
|Filename ||Description of content|
|ONIX_SerialsOnlineHoldings_n.n.xsd ||definitions of the message-level element and of complex types
specific to SOH messages (the number 'n.n' is the version number of this
|ONIX_Serials_CodeLists.xsd ||definitions of datatypes common to all ONIX Serials
For further information see
XML Schema Part 1: Structures
and XML Schema Part 2:
It is intended that this schema be used to guide implementation of systems for either originating or receiving SOH messages. Used in conjunction with a suitable “schema parser” it may also be used to validate the structure and contents of an individual message.
This schema defines how the substance, or “payload”, of SOH messages are to be represented in XML, but is silent on the question of how this message is to be conveyed from originator to recipient. It is likely that supply chain partners will need to adopt different approaches to message transport, packaging and delivery, depending upon the specific business systems in which this message format is being implemented.
Guidance on reading the message format
In this user guide each successive XML element is illustrated by a
graphic which shows any “child” elements. Clicking on any
“child” element will take you to the description of that element.
Clicking “Back” will return you to the
If a “child” element is shown with a solid outline,
the element is mandatory in any occurrence of the “parent”. If it
is shown with a dotted outline, it is conditional in this context. If it is
repeatable, the element box has the legend “1..∞” or
“0..∞” immediately below it, indicating “mandatory
and repeatable” or “conditional and repeatable”.
All data types are based upon built-in primitive data types defined
in XML Schema Part 2:
Datatypes. The names of all pre-defined data types are prefixed by
“xs:” and include:
|xs:string||a string of characters|
|xs:decimal||a number that may have a decimal part|
|xs:int||an integer between -2147483648 and +2147483647 inclusive|
The ONIX Serials Online Holdings (SOH) format defines a family of XML messages used for communicating information about the holdings or coverage of online serial resources from a party that holds or supplies the resources to a party that needs this information in its systems. Please see the ONIX Serials Online Holdings Overview for a general introduction to the SOH messages and their applications. There are two messages currently defined:
- AtoZ. In the flat AtoZ list, each resource is listed separately with the hosted collection identified individually for each resource. To avoid repeating the same detail for every serial version held in a particular hosted collection, the holdings list begins with a section in which each hosted collection is described and identified, by a name or a coded identifier or both. The collection can then be referenced at serial version level by either name or identifier.
- ByHost. In the ByHost message, resources are grouped by hosted collection. Each hosted collection is identified once only, at the beginning of the holdings list, followed by details of the resources available in that collection.
Some words or phrases are used throughout ONIX for Serials with a very specific meaning. These are defined in the ONIX for Serials Glossary, and there are direct links from their first appearance in this text to the definition in the glossary.
Please refer to the following documents for a more detailed introduction to the SOH format:
- SOH Outline Specification Release 1.1
- ONIX Serials Glossary