This presentation was originally give as part of a BISG webcast on October 14, 2014, and then again on November 12, 2014. The webcast focused on the migration from ONIX 2.1 to ONIX 3.0, detailing the key differences between the two message standards, and the benefits and extra functionality offered by the new format. EDItEUR's Graham Bell outlined the areas of the message where the changes are simple to deal with and offered advice on those areas of the message where more significant modifications will be required. This presentation is particularly timely because of the impending sunset of ONIX 2.1 support at the end of 2014.

1. Navigating the transition
from ONIX 2.1 to 3.0
Graham Bell
EDItEUR
BISG Metadata Committee & webcast
16 July and 14th October 2014

2. Roots of ONIX
• 1997 EPICS and BIC Basic
• 1998 <indecs> project, W3C XML specification
• 1999 ‘Online Information Exchange’ initiative
from AAP Digital Issues working party
• ONIX developed by EDItEUR
• 2000 ONIX 1.0 and 1.1 – obsolete
• 2001 ONIX 2.0 – retired
• 2003 ONIX 2.1 – revision 02 in 2004
• 2009 ONIX 3.0 – version 3.0.2 in 2014

3. Roots of ONIX
• 1997 EPICS and BIC Basic
• 1998 <indecs> project, W3C XML specification
• 1999 ‘Online Information Exchange’ initiative
from AAP Digital Issues working party
• ONIX developed by EDItEUR
• 2000 ONIX 1.0 and 1.1 – obsolete
• 2001 ONIX 2.0 – retired
• 2003 ONIX 2.1 – revision 02 in 2004
• 2009 ONIX 3.0 – version 3.0.2 in 2014

4. Roots of ONIX
• 1997 EPICS and BIC Basic
• 1998 <indecs> project, W3C XML specification
• 1999 ‘Online Information Exchange’ initiative
from AAP Digital Issues working party
• ONIX developed by EDItEUR
• 2000 ONIX 1.0 and 1.1 – obsolete
• 2001 ONIX 2.0 – retired
• 2003 ONIX 2.1 – revision 02 in 2004
• 2009 ONIX 3.0 – version 3.0.2 in 2014

5. Roots of ONIX
• 1997 EPICS and BIC Basic
• 1998 <indecs> project, W3C XML specification
• 1999 ‘Online Information Exchange’ initiative
from AAP Digital Issues working party
• ONIX developed by EDItEUR
• 2000 ONIX 1.0 and 1.1 – obsolete
• 2001 ONIX 2.0 – retired
• 2003 ONIX 2.1 – revision 02 in 2004
• 2009 ONIX 3.0 – version 3.0.2 in 2014

6. Roots of ONIX
• widely used in North America, Western
Europe, Eastern Europe and Russia,
growing in Asia-Pacific
• used by small and large organisations alike
• included in many off-the-shelf IT systems, but
also plausible for in-house developers
• current status
• ONIX v2.1 – still most widely deployed in US
• ONIX v3.0 – growing in importance

7. ONIX governance
• standard is managed by EDItEUR
• documentation and tools available free of
charge, covered by permissive EDItEUR licence
• membership supports development, and
members help identify new requirements
• all changes discussed by National Groups to
ensure broad international applicability, and
ratified by International Steering Committee to
ensure stability
• BISG metadata committee is US national group
• ISC decided in 2011 to sunset ONIX 2.1

8. ONIX governance
support
for 2.1 will be
reduced at
end of 2014
• standard is managed by EDItEUR
• documentation and tools available free of
charge, covered by permissive EDItEUR licence
• membership supports development, and
members help identify new requirements
• all changes discussed by National Groups to
ensure broad international applicability, and
ratified by International Steering Committee to
ensure stability
• BISG metadata committee is US national group
• ISC decided in 2011 to sunset ONIX 2.1

9. ONIX 2.1 vs ONIX 3.0
• two quite distinct messages
• block-level updates
• digital products
• sets and series
• sales rights
• marketing collateral
• parallel multi-lingual data
• related works
• international markets

10. ONIX 2.1 vs ONIX 3.0
• two quite distinct messages
• block-level updates
• digital products
• sets and series
• sales rights
• marketing collateral
• parallel multi-lingual data
• related works
• international markets
10 years
accumulated
experience
extended
schema
support
global
best practice
guide

14. so how do we go
from 2.1 to 3.0 ?

15. ONIX 2.0 vs ONIX 2.1
• not really distinct messages – ONIX 2.1 was
fully compatible with 2.0
• deprecations of dedicated elements,
egEAN13, BICMainSubject
• encouragement to use composites instead,
egProductIdentifier, MainSubject
• optional new functionality, eg in SalesRights,
ProductFormDetail, MarketRepresentation
• if your 2.1 has been brought ‘up-to-date’,
then migration to 3.0 is much simpler than
it is if you are still (in effect) using 2.0

16. ONIX 2.1 vs ONIX 3.0
• these are distinct messages – there is no
backwards compatibility
• removal of previously deprecated elements
(there are actually fewer tags in 3.0)
• continued development of composites, and the
introduction of blocks
• new functionality, eg usage constraints,
licensing, rentals, multi-lingual metadata,
though again this is mostly optional
• but huge amount of continuity
• at least half of the message remains unchanged

17. ONIX 3.0 data elements
• message details
• identity and authority
• record details
• product identifiers
• 1. descriptive details
• product form
• special features
• packaging
• physical size
• drm, usage constraints
• trade classification
• product parts
• collection titles
• titles
• contributors
• conference
• edition
• language
• extent
• subject
• audience

18. ONIX 3.0 data elements
• 2. collateral details
• supporting text
• cited material
• supporting resources
• prizes
• 3. content detail
• 4. publishing details
• imprint and publisher
• lifecycle dates
• copyright details
• territorial rights
• 5. related material
• related works
• related products
• 6. supply details
• markets
• market details
• suppliers
• discounts
• prices and tax
• reissue details

20. 1. spring cleaning

21. 1.0 1.1 1.2 2.0 2.1
ISBN0007232837/ISBN
EAN139780007232833/EAN13

22. 2.0 2.1
ISBN0007232837/ISBN
EAN139780007232833/EAN13
ProductIdentifier
ProductIDType01/ProductIDType
IDTypeNameHCP PID/IDTypeName
IDValue32032-4/IDValue
/ProductIdentifier

23. 2.0 2.1
ProductIdentifier
ProductIDType01/ProductIDType
IDTypeNameHCP PID/IDTypeName
IDValue32032-4/IDValue
/ProductIdentifier
3.0
ProductIdentifier
ProductIDType03/ProductIDType
IDValue9780007232833/IDValue
/ProductIdentifier
ProductIdentifier
ProductIDType15/ProductIDType
IDValue9780007232833/IDValue
/ProductIdentifier

24. AudienceCode03/AudienceCode
2.0 2.1 3.0
Audience
AudienceCodeType01/AudienceCodeType
AudienceCodeValue03/AudienceCodeValue
/Audience

25. 2.1
AvailabilityCodeIP/AvailabilityCode
ProductAvailability20/ProductAvailability

26. 2.1 3.0
ProductAvailability20/ProductAvailability

27. 2. renaming and reordering

28. 2.1
Contributor
SequenceNumber1/SequenceNumber
ContributorRoleA01/ContributorRole
PersonNameMaj Sjouml;wall/PersonName
PersonNameIdentifier
PersonNameIDType01/PersonNameIDType
IDTypeNameHCP Author ID/IDTypeName
IDValue7421/IDValue
/PersonNameIdentifier
BiographicalNote textformat=05pMaj
Sjouml;wall is a poet. She lives in Sweden./p
/BiographicalNote
/Contributor

29. Contributor
SequenceNumber1/SequenceNumber
ContributorRoleA01/ContributorRole
NameIdentifier
3.0
NameIDType01/NameIDType
IDTypeNameHCP Author ID/IDTypeName
IDValue7421/IDValue
/NameIdentifier
PersonNameMaj Sjöwall/PersonName
BiographicalNote textformat=05pMaj
Sjöwall is a poet. She lives in Sweden./p
/BiographicalNote
/Contributor

30. 3. restructuring for greater
consistency and flexibility

31. 2.1
PublicationDate20110428/PublicationDate
YearFirstPublished1811/YearFirstPublished
OnSaleDate20110428/OnSaleDate

32. PublishingDate
PublishingDateRole11/PublishingDateRole
Date dateformat=051811/Date
/PublishingDate
PublishingDate
PublishingDateRole19/PublishingDateRole
Date dateformat=01198510/Date
/PublishingDate
PublishingDate
PublishingDateRole01/PublishingDateRole
Date20110428/Date
/PublishingDate
PublishingDate
PublishingDateRole02/PublishingDateRole
Date20110428/Date
/PublishingDate
3.0

33. 2.1
SalesRights
SalesRightsType01/SalesRightsType
RightsCountryAG AI AU BB BD BM BN BS BW
BZ CM CY DM EG FJ FK GB GD GH GI GM
GY HK IE IL IN IO JM JO KE KI KN KW KY
LC LK LS MT MU MV MW MY MZ NA NG
NR NZ PG PK PN SB SC SD SG SH SL SO SZ
TC TO TT TV TZ UG VC VG VU WS YE RS ME
ZA ZM ZW/RightsCountry
/SalesRights

34. 2.1
SalesRights
SalesRightsType01/SalesRightsType
RightsCountryCA US/RightsCountry
/SalesRights
SalesRights
SalesRightsType03/SalesRightsType
RightsCountryGB IE AU NZ/RightsCountry
/SalesRight

35. SalesRights
RightsCountry *
RightsTerritory *
RightsRegion (dep.)
NotForSale
RightsCountry *
RightsTerritory *
2.1
SupplyDetail
SupplyToCountry *
SupplyToTerritory *
SupplyToRegion (dep.)
SupplyToCountryExcluded *
MarketRepresentation
MarketCountry *
MarketTerritory *
MarketCountryExcluded *
Price
CountryCode
Territory *
CountryExcluded *
TerritoryExcluded *

36. SalesRights
Territory
CountriesIncluded *
RegionsIncluded *
CountriesExcluded *
RegionsExcluded *
3.0

37. SalesRights
SalesRightsType01/SalesRightsType
Territory
CountriesIncludedCA US/CountriesIncluded
Territory
/SalesRights
SalesRights
SalesRightsType03/SalesRightsType
Territory
CountriesIncludedGB IE AU
NZ/CountriesIncluded
Territory
/SalesRights
ROWSalesRightsType02/ROWSalesRightsType
3.0

38. SalesRights
SalesRightsType01/SalesRightsType
Territory
3.0
CountriesIncludedUS/CountriesIncluded
RegionsExcludedUS-HI US-AK/RegionsExcluded
/Territory
/SalesRights
ROWSalesRightsType03/ROWSalesRightsType

39. SalesRights
SalesRightsType01/SalesRightsType
Territory
3.0
RegionsIncludedWORLD/RegionsIncluded
/Territory
/SalesRights

40. 4. syntax updates

41. Basic syntax updates
• no !DOCTYPE, recomendation to use
XSD schema for validation
• recommendation to use Unicode and
UTF-8, but can still use Latin-1 if required
• named character entities (eg ouml;) not
valid – use ö instead, or if not using a rich
character set, use #246; or #xf6;
• in line with broader XML developments

42. 5. structural changes
…set, series and main titles,
and markets

43. sets, series and main titles

44. Series
Title
2.1
TitleType01/TitleType
TitleText textcase=02The Chronicles of
Narnia/TitleText
/Title
/Series

45. Collection
CollectionType10/CollectionType
TitleDetail
TitleType01/TitleType
TitleElement
TitleElementLevel02/TitleElementLevel
TitlePrefixThe/TitlePrefix
TitleWithoutPrefix textcase=02Chronicles
of Narnia/TitleWithoutPrefix
/TitleElement
/TitleDetail
/Collection
3.0

46. TitleElementLevel02/TitleElementLevel
TitlePrefixThe/TitlePrefix
TitleWithoutPrefix textcase=02Chronicles
of Narnia/TitleWithoutPrefix
/TitleElement
/TitleDetail
/Collection
3.0
TitleDetail
TitleType01/TitleType
TitleElement
TitleElementLevel01/TitleElementLevel
TitlePrefixThe/TitlePrefix
TitleWithoutPrefix textcase=02Lion, the
Witch and the Wardrobe/TitleWithoutPrefix
/TitleElement
/TitleDetail

47. TitleDetail
TitleType01/TitleType
TitleElement
TitleElementLevel02/TitleElementLevel
NoPrefix/
TitleWithoutPrefix textcase=02Focus on
Maths/TitleWithoutPrefix
/TitleElement
TitleElement
TitleElementLevel01/TitleElementLevel
NoPrefix/
TitleWithoutPrefix textcase=02Workbook
6/TitleWithoutPrefix
/TitleElement
/TitleDetail
3.0.2

48. • two ways to provide collection details in
ONIX 3.0
• in P.5, as a title element in TitleDetail
withinCollection, or…
• in P.6, as just another title element
withinTitleDetail
• not always a simple choice
• depends on whether collection title is an
integral part of the identity of the product, or
whether the product has an identity separate
from the collection

49. • two ways to provide collection details in
ONIX 3.0
• in P.5, as a title element in TitleDetail
The Lion,
the Witch and
the Wardrobe
withinCollection, or…
• in P.6, as just another title element
withinTitleDetail
• not always a simple choice
• depends on whether collection title is an
integral part of the identity of the product, or
whether the product has an identity separate
from the collection
Focus on
Physics:
Workbook 6

50. markets and prices

51. Markets and suppliers
• ONIX 2.1 describes suppliers and the markets
they operate in
• SupplyDetail describes one supplier
• within SupplyDetail, SupplyToCountry describes
the geographical extent of the supplier’s market
• ONIX 3.0 describes markets and the suppliers
that operate there
• ProductSupply describes one market, including
MarketTerritory for the geographical extent
• within one market, multiple SupplyDetail
composites, for each of that market’s suppliers

52. migration project outline

53. 2.1 to 3.0 migration outline
• bring ONIX 2.1 ‘up to date’
• no deprecations
• use composites wherever possible
• delta updates, if you are not already using them
• add simple enhancements
• use a rich native character set like UTF-8
• add XHTML tagging in richer textual elements
• this is all possible in 2.1

54. 2.1 to 3.0 migration outline
• deal with tags that change names, position
or context
• eg PersonNameIdentifier to
NameIdentifier (but they’re not all that easy)
• tackle the tougher stuff
• Set and Series become Collection
• SalesRights
• ProductSupply and SupplyDetail
• get to 3.0 that conveys the same data as 2.1

55. 2.1 to 3.0 migration summary
• test and implement with initial recipients
• then add new functionality (maybe as ‘phase II’)
• e-book licensing and restrictions
• richer collateral material
• block updates are optional (for senders)
• further reduces amount of data to be processed

56. but what does
migration get me?

57. Consistency and simplicity
• greater consistency in the way data is
specified – eg with sales rights…
• Territory always has the same structure
• requirement for a ROW statement (even if it is
just ‘unknown’)
• sales restriction operates within a territory
• or with contributors…
• contributor identifiers aren’t limited to
personal names – can be used with corporate
authors too

58. Consistency and simplicity
• in turn, this means greater consistency in
the way data is interpreted
• one recommended way of doing things, not
three (eg 2.1 uses either AvailabilityCode or
ProductAvailability, 3.0 uses only the latter)
• helped by greater precision in the Specification
and advice in the Guide
• makes it simpler for recipients

59. Flexibility and extensibility
• consistent use of composites means new
types, roles, rights, restrictions etc can be
added via a codelist change, without adding
specialised tags
• eg added pre-order embargo to ONIX 3.0,
which would require new tags in ONIX 2.1
• less disruption as further functionality is added
in future
• most textual metadata can be multi-lingual

60. New functionality (e-books)
• e-book DRM (including watermarking)
• usage constraints, eg
• preview 10% before purchase
• print only 10% per month
• lend only 24 times
• rent for 3 months
• links to product licences
• vital for open access, useful for commercial
products too

61. New functionality (content)
• primary and secondary content types
• primary part in multi-component products
• multiple work relationships

62. New functionality (collections)
• collections remove anomalies
• series cannot be multi-level
• sets cannot have contributors, or carry
identifiers like ISSN
• collections can have multiple orders, eg
publication order, narrative order

63. New functionality (contributors)
• contributors can be associated with multiple
places
• place of birth / death
• place of current residence / citizenship
• to city or town detail, not just country
• corporate contributors can carry contributor
identifiers and dates

64. New functionality (collateral)
• content audience and ‘use from… until’
dates for descriptive text, cited content and
other supporting resources
• pixel size replaces resolution for images
• file size, MD5 hash to validate downloads

65. New functionality (publishers)
• multiple publisher and imprint identifiers
• multiple product contacts for different
purposes
• clarity on sales rights and restrictions
• clarity on product status and availability
• clear distinction between ‘publisher view’ and
‘distributor view’

66. New functionality (markets)
• more flexible market-specific publishing
details
• eg local market ‘pub date’
• was originally added to 2.1 rev.02 in 2004
(important for Australian exports, but very
rarely used because of patchy support)

67. New functionality (suppliers)
• multiple supplier’s own coding
• proximity and velocity for stock holdings
• gives ONIX compatibility with EDItX stock
report and X.12 / Tradacoms stock messages
• price identifiers
• price conditions (including rentals)
• coded / tiered prices
• comparison prices (strikethrough prices)
• price printed on product

68. Why update?
• it’s not as difficult as most people assume
• improvements in the message – particularly for
e-books, internationalization, multi-lingualism
• some tricky areas
• improvements in the tools (eg Schematron)
• block-level updates (eventually)
• and
• loss of support from end of 2014
• risks of not upgrading

69. graham@editeur.org
http://www.editeur.org