Metadata ingest format – editorial-based
This section describes the metadata ingest format for the editorial-based data model that was introduced in the OpenTV Video Platform 20.51 (Q4) release.
If you are using the older, technical-based data model, refer to Metadata ingest format – technical-based.
The following tables list the elements that can be used in an XML ingest file when using the editorial-based model. The table structure indicates the nesting of the elements.
Where appropriate, on the right side of the table are the corresponding fields in MDS, CCP, and IHS that are populated with the data. Note that all data is stored by CPM.
Legend
| Colour | Meaning |
|---|---|
| Mandatory for ingest, optional or not used for ION | |
| Mandatory for ION, optional for ingest | |
| Mandatory for both ingest and ION | |
| Optional for ingest and optional or not used for ION |
If an element or attribute is marked as mandatory, this means that it is mandatory at the level at which it appears. For example, within contentGroup, metadataSet is optional, but if it is present, it must have a locale attribute.
For ION, the meanings of the non-mandatory values are as follows:
- Not used means that ION does not use the field at all.
- Optional means that ION uses (displays) the field, but if it does not have a value, it does not break anything.
| Elements | Fields/attributes | Type | Required | Sample data | Description | ION |
|---|---|---|---|---|---|---|
cmsData | Mandatory | Schema root element. Each file supplied to the importer will contain exactly one instance of this element. | Not used | |||
xmlns | Mandatory | nis.cim.sp.ml.nagra.com | The prefix xmlns is used only to declare namespace bindings. | Not used | ||
Xmlns:xsi | Optional | http://www.w3.org/2001/XMLSchema-instance | Declares a standard namespace prefix (xsi) for a core namespace used in XSD. | Not used | ||
executionDate | gmtdatetime | Mandatory | 2018-11-20T13:12:27Z | Provides a reference execution date for the XML file. Will normally be the date and time that the file's provider generated it. | Not used | |
Xsi:schemaLocation | Optional | nis.cim.sp.ml.nagra.com Nagravision-Import-Full-Specification-v5.x.xsd | Provide hints to the XML processor as to how to associate an XSD with an XML document. | Not used |
The corresponding elements are described on the following pages: