Summary

  1. Procedure for Importing Files and Metadata
    1. Addition or Modification
    2. ZIP File Structure
  2. Confirmation and Conflict Management
  3. Description of the XML File Tags According to ONIX 2.1 Norms

Introduction

This guide allows for electronic publications in PDF and ePub formats, as well as associated metadata and image, audio and video files to be integrated on the Platform. This guide deals with the addition of new files and the modification of files and information already present on the Platform.

Note: The system is currently running a Beta version. During the next few weeks, we will be adding several new fields and tags so that the application is 100% compatible with your files structured according to BTLF norms and much more.

1 : Procedure for Importing Files and Metadata

To import your publications and metadata to the platform, we recommend proceeding in the following manner:

  1. Identify yourself on the platform with a username and password
  2. "Publications" section, "Import" option - "Select"
  3. Select your ZIP file containing the metadata and / or the publications you would like to import. The structure of the ZIP file is described in the section "ZIP File Structure".

1.1 : Addition or Modification

Upon transmission of an XML or ONIX file, the system will verify whether the ISBN/EAN of the publication already exists in your Platform account. If the publication is not already listed on the platform, it will be added automatically along with all the associated metadata contained in the XML or ONIX file. However, if the publication turns out to already be in your account, the system will overwrite the metadata with that contained in the new XML or ONIX file. Please note that an empty tag in the file will cause the system to DELETE the related information present on the Platform. Tags that should not be deleted are not required to be in the XML file for import. Also, it is possible to put publications that have presumably been added to the platform with others which are being modified on the same XML file.

1.2 : ZIP File Structure

The ZIP file must include:

  1. An XML file (described in section 3) that can contain the information on several publications in several different electronic formats. This XML file, which must be placed at the root of the zip file, must be called: publications.xml.
  2. A directory identified for each publication in the XML, containing the PDF and / or ePub files, and additional files (media). This directory is identified by a reference number (see the RecordReference field) and all the elements of the publication are included in this directory.
  3. The PDF and ePub files placed in this directory must be named in the following manner: "[RecordReference]/publication.pdf, [RecordReference]/publication.epub".
Note that only the long tags of the ONIX 2.1 standard are dealt with during data import. You can get the guides and codes list at http://www.editeur.org/83/Overview/. To avoid repeating the same information for each publication format, we have added multiformat management using the tag which allows you to easily integrate the PDF and ePub formats of your publication. See Section 3. If you import several formats for the same publication, it is recommended that you place all the metadata related to that publication in a single , with an associated by an additional imported format, and to place the other associated formats with only their own information in another . It's important to know that when HTML code is added in an XML file, the content must be placed in a CDATA tag. If not, it will be invalid and the code will be cut. Also note that we have added several additional optional fields, not used in standard BTLF compatible imports, for a greater flexibility of available data.

2 : Confirmation and Conflict Management

While importing your ZIP files to the the Platform platform, you can observe the management of the operations and conversions in the tasks section of your client space. All of these tasks are carried out in a processing queue, so you can continue to work as soon as the downloading of your zip file is complete. The management of conflicts is displayed and an error correction system warns you of any difficulty encountered during the import.

3 : Description of the XML File Tags According to ONIX 2.1 Norms

You will find, below, a description of each of the available tags.

  • Mandatory-always : State that the element is always mandatory
  • Mandatory-Apple : Field is mandatory for the Apple iBookstore's export.
  • Optional-Apple : Field is optional for the Apple iBookstore's export. (Value-added to the data exported to Apple)

 Mandatory  Type of data
 ONIX Tag
Description / Suggested Values
Mandatory-always  

<ONIXMessage>

Allows to distinguish ONIX from the Standard XML import on the platform

Mandatory-always

Message envelope

<Header>

 
Mandatory-always

Name of sender

<FromCompany>

Name of your company

 

Name of recipient

<ToCompany>

ENQC

Mandatory-always

Sending date

<SentDate>

AAAAMMDD or AAAAMMDDHHMM

 

Particular message

<MessageNote>

Text or comment, max 500 chars

 

Default text language

<DefaultLanguageOfText>

    fre : French language

List : 74

 

Default price type

<DefaultPriceTypeCode>

    03 : Price before tax

List : 58

 

Default currency

<DefaultCurrencyCode>

  • can : Canadian dollar
  • eur : Euro

List : 96

   

</Header>

 
Mandatory-always
Mandatory-Apple

Article identification

<Product>

 
Mandatory-always

Unique identifier

<RecordReference>

Internal code of the transmitter; also corresponds to the directory containing the imported files

 

Type of article

<NotificationType>

  • 03 : New product
  • 04 : Update

List : 1

Mandatory-always
Mandatory-Apple

ISBN, EAN or Custom

<ProductIdentifier>

 
Mandatory-always
Mandatory-Apple

Identification

<ProductIDType>

Only one of these identifiers is required, with or without dashes. The platform will make the necessary conversions.

  • 01 : Owner (custom)
  • 02 : ISBN-10
  • 03 : EAN
  • 15 : ISBN-13

List : 5

Mandatory-always
Mandatory-Apple

Value

<IDValue>

ISBN, EAN or Custom value

   

</ProductIdentifier>

 
 

Support type

<ProductForm>

Physical description of support and binding

  • BA : Paper
  • DG : Electronic

List : 7

 

Type of electronic format

<EpubType>

Required if = DG.

  • 002 : PDF
  • 022 : Mobi
  • 023 (or 029) : ePub

List : 10

 

Support type - detail

<ProductFormDetail>

Detailed physical description of support and binding

Optional-Apple

Linked product

<RelatedProduct>

A repeatable group of elements which together describe a product with a specified link to the product described in the ONIX recording. Allows for the creation of one global product encompassing all the associated formats.

Mandatory-always
Optional-Apple

Linked product relationship

<RelationCode>

Code identifying the nature of the relationship between two products

  • 01 : Includes (this product includes the following products as distinct items)
  • 02 : Is part of (this product is a part of the following item)
  • 06 : X is an alternative format of product Y
  • 13 : X is an epublication based on the paper product Y

List : 51

Mandatory-always
Optional-Apple

ISBN, EAN or Custom

<ProductIdentifier>

 
   

<Publisher>

 
   

<PublisherName>

Name of publisher. Required only if importing from the distributor's account.
   

<PublisherRole>

01, only if previous field is present.
   

</Publisher>

 
Mandatory-always
Optional-Apple

Identification

<ProductIDType>

Only one of these identifiers is required, with or without dashes. The platform will make the necessary conversions.

  • 01 : Owner (custom)
  • 02 : ISBN-10
  • 03 : EAN
  • 15 : ISBN-13

List : 5

Mandatory-always
Optional-Apple

Value

<IDValue>

ISBN, EAN or Custom value

   

</ProductIdentifier>

 
Optional-Apple

Support type

<ProductForm>

Physical description of support and binding

  • BA : Paper
  • DG : Electronic

List : 7

Optional-Apple

Type of electronic format

<EpubType>

Required if = DG.

  • 002 : PDF
  • 023 : ePub

List : 10

   

</RelatedProduct>

 
   

<SalesRights>

 
   

<SalesRightsType>

Defines the sale status

  • 01 : Available for sale
  • 02 : Available for sale
  • 03 : Consultation only
   

</SalesRights>

 
Mandatory-Apple

Price

<SupplyDetail>

Dans le cas d'exportation vers le Apple iBookstore, cette section servira à déterminer les territoires permis à la vente, avec leur prix et leur devise approprié.

Mandatory-Apple
 

<Price>

This section is repeatable for each country requiring a cost and a currency.

Mandatory-Apple

Country

<CountryCode>

ISO 3166-1 country code (2 characters) for which price is related.

Mandatory-Apple

Price type

<PriceTypeCode>

Optional if specified in header message

    03 : Price before tax

List : 58

Mandatory-Apple

Amount

<PriceAmount>

Eg. 18,99 or 18.99

Mandatory-Apple

Currency

<CurrencyCode>

If different from (See header message)

  • CAD : Canadian dollar
  • EUR : Euro

List : 96

In order to import a Euro Zone price, include the CountryCode tag set to EUR, but do not include the CountryCode tag.

   

</Price>

 
   

</SupplyDetail>

 
Optional-Apple

Series

<Series>

 
Optional-Apple

Collection

<TitleOfSeries>

Full title of the collection

Optional-Apple

Series - Title of the series

<NumberWithinSeries>

Full title of the series

   

</Series>

 
 

Set

<Set>

 
 

Collection

<TitleOfSet>

Full title of the collection

 

Number in the collection

<ltemNumberWithinSet>

Product number in the collection

   

</Set>

 
Mandatory-Apple

Title

<Title>

 
Mandatory-always
Mandatory-Apple

Type of title

<TitleType>

  • 01 : Unique title
  • 10 : Title of distributor

Liste : 15

Mandatory-always
Mandatory-Apple

Title text

<TitleText>

 
 

Title prefix

<TitlePrefix>

 
 

Subtitle

<Subtitle>

 
   

</Title>

 
Mandatory-Apple

Author, illustrator, photographer…

<Contributor>

In case of Apple iBookstore's export, this section must contain at least one primary contributor to get the publication accepted.

Mandatory-Apple

Séquence

<SequenceNumber>

Position/ordre à lequel doit figuré le contributeur lorsque plusieurs pour une même publication, "1" étant le contributeur primaire.

Mandatory-always
Mandatory-Apple

Type of contribution

<ContributorRole>

In case of Apple iBookstore's export, at least 1 contributor must be related to a role flagged with the symbol *. (Primary contributor)

  • *A01 : Author
  • *A02 : With
  • *A06 : Made by the compositor
  • *A07 : Made by the artist
  • *A08 : Made by the photograph
  • *A99 : Other primary creator
  • A12 : Illustratations by
  • A13 : Photographs par
  • A15 : Preface by
  • A16 : Prologue by
  • B06 : Translated by
  • E03 : Narrator

Liste : 17

Mandatory-always
Mandatory-Apple

Full name

<PersonName>

First (initials) and last name

 

Name inverted

<PersonNameInverted>

Last name and first name (initials)

 

Country

<CountryCode>

Country of contributor

 

Website

<WebsiteLink>

Contributor's website

 

Website

<Website>

 
 

Website

<WebsiteRole>

42
  Website

<WebsiteLink>

http://www.facebook.com/username or

http://twitter.com/username

   

</Website>

 
   

</Contributor>

 
 

Themes and genres

<MainSubject>

Primary classification for the publication (unique, it cannot be a keyword, see additional classification)

Mandatory-always

Identification

<MainSubjectSchemeIdentifier>

  • 01 : Dewey
  • 10 : BISAC Subject Heading
  • 24 : Default genres
  • 28 : Themes genres Electre
  • 29 : CLIL

List : 26

Mandatory-always

Code

<SubjectCode>

Code value.

   

</MainSubject>

 
 

Classification (subjects, themes or genres)

<Subject>

Additional classification (repeatable)

Mandatory-always

Identification

<SubjectSchemeIdentifier>

  • 01 : Dewey
  • 10 : BISAC Subject Heading
  • 20 : Keywords
  • 24 : Default genres
  • 28 : Electre themes
  • 29 : CLIL

List : 26

Mandatory-always

Code

<SubjectCode>

Code value. (Mandatory only if MainSubjectSchemeIdentifier is not '20')

 

Description

<SubjectHeadingText>

Keywords separated by semi-colons (;)

   

</Subject>

 
 

Audience type

<Audience>

 
 

Audience type identification list

<AudienceCodeType>

  • 06 : BTLF Audience Code
  • 07 : Electre Audience Code

List : 29

 

List name

<AudienceCodeTypeName>

BTLF ; Electre

 

Local code of the audience type

<AudienceCodeValue>

Code value.

   

</Audience>

 
Mandatory-Apple

Summary

<OtherText>

 
Mandatory-Apple

Identification

<TextTypeCode>

    01 : Main description (summary)

Liste : 33

Mandatory-Apple

Content

<Text>

Text

   

</OtherText>

 
 

Comments

<OtherText>

 
 

Identification

<TextTypeCode>

    42 : Comments

List : 33

 

Content

<Text>

Text

   

</OtherText>

 
 

Presentation

<OtherText>

 
 

Identification

<TextTypeCode>

    18 : Back cover presentation

List : 33

 

Content

<Text>

Text

   

</OtherText>

 
 

Author picture

<MediaFile>

 
 

Identification

<MediaFileTypeCode>

  • 04 : Main cover
  • 08 : Contributor's picture
  • 23 : Image: Sample content
  • 24 : Back cover
  • 27 : Additional cover
  • 32 : Video interview with author
  • 35 : Video: Sample content
  • 36 : Video promotional
  • 37 : Video review
  • 42 : Audio interview with author
  • 44 : Audio: Sample content
  • 45 : Audio promotional
  • 46 : Audio review
  • 51 : Application: Sample content

List : 38

   

<MediaFileFormatCode>

    03
 

Link type

<MediaFileLinkTypeCode>

  • 01 : Web link
  • 06 : Filename

List : 40

 

File

<MediaFileLink>

Document name. No space or accents in file name.

 

Title

<DownloadCaption>

Title of media. If this file is a contributor's picture, it must match exactly the name of the contributor.

 

Description

<TextWithDownload>

Media description (optional)

   

</MediaFile>

 
Optional-Apple

Translated from

<Language>

 
Optional-Apple

Role

<LanguageRole>

    02 : Original language - translated text

List : 22

Optional-Apple

Language code

<LanguageCode>

  • eng : English
  • fre : French

List : 74

   

</Language>

 
 

Product website

<ProductWebSite>

 
 

Internet link

<ProductWebsiteLink>

Product website URL

   

</ProductWebSite>

 
 

Pages in roman numerals

<PagesRoman>

Number of pages at the beginning of the publication in roman numerals

 

Publication date

<PublicationDate>

 
   

<Date>

AAAAMMJJ or AAAAMMJJHHMM

   

</PublicationDate>

 
 

Type of protection to use

<ePub Technical Protection>

  • 00 : None (open)
  • 02 : Watermark
  • 03 : Adobe DRM (Adobe Content Server)

List : 144 (ONIX 3)

 

Number of pages

<Extent>

If this element is not present, the page number will be determined automatically based upon the file that has been sent

   

<ExtentType>

00 (number of pages of main content)

List : 23 (ONIX 3)

   

<ExtentUnit>

03 (in pages)

List : 24 (ONIX 3)

   

<ExtentValue>

Number of pages

   

</Extent>

 
 

Original text

<TypeCode editon>

 
   

<NoEdition>

Add this tag (empty) if this is the text's original version

   

</TypeCode editon>

 
   

</Product>

 
   

</ONIXMessage>