Ensure your content stands out on Snapplify by preparing your XML metadata correctly. Follow our guidelines to compile and validate your XML documents using our provided XSD file. Name your files in the YYYYMMDD_HHmm.xml format, and associate your content files accurately.
If you're using XML metadata to deliver your content to Snapplify, we will provide an XSD (snapplify-onix-metadata.xsd) that can be used to build and validate metadata XML documents. The XSD contains annotations for what values are allowed in each field. If no annotation is present, free text is assumed.
Snapplify uses a subset of the ONIX 3.0 XML standards.
The pricing provided in your metadata must either be inclusive or exclusive of VAT (sales tax), based on what has been agreed in your distribution agreement.
To prepare your XML metadata
XML filename
The name of the XML file must be in the format YYYYMMDD_HHmm.xml (example: 20140213_1532.xml).
Associated content files
Filenames are inferred via the values of IDValue for ProductIDType=15 in the ProductIdentifier element, and ProductFormDetail in the DescriptiveDetail element
Images follow the same convention, but are independent of the ProductFormDetail element. Supported image formats are jpg, png, or gif. Only one image is supported per record.
Example 1:
- Asset file associated with this record will be 9780801448157.epub
- Jacket image file associated with this record will be 9780801448157.jpg/png
<Product>
<ProductIdentifier>
<ProductIDType>15</ProductIDType>
<IDValue>9780801448157</IDValue>
</ProductIdentifier>
<DescriptiveDetail>
<ProductFormDetail>E101</ProductFormDetail>
</DescriptiveDetail>
</Product>
Example 2:
- Asset file associated with this record will be 9781600608667.pdf
- Jacket image file associated with this record will be 9781600608667.jpg/png
<Product>
<ProductIdentifier>
<ProductIDType>15</ProductIDType>
<IDValue>9781600608667</IDValue>
</ProductIdentifier>
<DescriptiveDetail>
<ProductFormDetail>E107</ProductFormDetail>
</DescriptiveDetail>
</Product>
Assigning DRM restrictions in XML metadata
Specifying if DRM is enabled on a product is done via the EpubTechnicalProtection:
| Element | EpubTechnicalProtection |
| Allowed values | Description |
| 00 | None – product doesn't require DRM |
| 01 | DRM enabled |
If EpubTechnicalProtection = 01, then optional EpubUsageContraint elements can be supplied. If none are supplied, the default DRM scheme will be used.
EpubUsageContraint element is described in Snapplify’s XSD.
Currently only ePUB and PDF types may support DRM.
Example: DRM Restriction XML snippets
User restricted to downloading title, on the same device, or multiple devices, a total of 5 times:
<EpubUsageConstraint>
<!-- 04 = use on multiple devices, 10 = licence days -->
<EpubUsageType>04</EpubUsageType>
<!--01 - unlimited, 02 = limited -->
<EpubUsageStatus>02</EpubUsageStatus>
<EpubUsageLimit>
<Quantity>5</Quantity>
<!-- 06 - devices, 09 - days -->
<EpubUsageUnit>06</EpubUsageUnit>
</EpubUsageLimit>
</EpubUsageConstraint>
User licence will expire 365 days after first licence acquisition:
<EpubUsageConstraint>
<!-- 04 = use on multiple devices, 10 = licence days -->
<EpubUsageType>10</EpubUsageType>
<!--01 - unlimited, 02 = limited, 03 = prohibited -->
<EpubUsageStatus>02</EpubUsageStatus>
<EpubUsageLimit>
<Quantity>365</Quantity>
<!-- 06 - devices, 09 - days -->
<EpubUsageUnit>09</EpubUsageUnit>
</EpubUsageLimit>
</EpubUsageConstraint>
- Find out how to prepare CSV metadata and CoureSource metadata for your content.
- Learn how digital rights management (DRM) works for content owners.
Need help? Reach out to us by emailing [email protected].
