ESNI Schema-Process - 2018
ESNI Schema-Process - 2018
The Digital Video Subcommittee has established a formal schema management process for
creating, updating, administering, and publishing (hosting) definitions and values of
attributes of non-normative schemas developed by Working Groups within DVS.
Working Group 5 (WG5) utilizes this process and authority to manage attributes and
values necessary and relevant to two non-normative schemas of SCTE 224, Event
Scheduling and Notification Interface (ESNI): Action, Audience, and Metadat. Given the
highly dynamic and evolving nature of new attributes, this process authority allows for the
capture, coordination, and maintenance of such properties outside a formal balloting
process but within formal SCTE guidelines and oversight.
2.0 GOVERNANCE:
As the entity responsible for the creation of SCTE 224 (ESNI) and it related schemas,
WG5 is responsible for managing the process and controlling the approval of the artifacts
resulting from this process. WG5 is confined to evaluation and consideration of additions,
deletions, or updates to “audience”, “action”, and “metadata” declaratives as submitted
through the formal process outlined herein, following a clear set of objective evaluation
criteria to evaluate and approve through consensus of a formal submissions.
Submissions shall use the referenced submission form and submit the entry
electronically via email at standards@scte.org. The submission will be accepted or
rejected within 15 days of submission and if accepted posted within 15 days of the
date of acceptance.
Evaluation Criteria:
For “action”, a declarative value is in scope if the aim of the action is relevant
and reasonably possible on the content distribution platform and is confined to
realm of possibilities of such platforms (i.e. accept “Display User Options”, ask
for clarification if “Fly to Mars”). An action is in scope even if not immediately
or obviously possible though one could imagine it to be reasonably possible if
skilled in the art.
For “metadata”, a declarative value is in scope if the value is a property that
could encompass and describe a description for an item identified by a
MediaPoint (i.e. “NetworkSpotProduct” or “starttime”).
Approval occurs when the consensus of the members participating when a submission
is being considered agree that the submission passes the objective criteria. Upon
approval, the necessary artifacts would be updated and made available for download
as a resource from the public SCTE Standards website.
2.4
The XML schema will be used for both Audience, Action, and Metadata formal
documentation of the accepted declaratives. Each will be formally hosted and resolvable
by it’s namespace. Versioning will not be included as the expectation that the artifacts are
the “latest” and completely backwards compatible.
The following XML Schema snippet is meant to illustrate a few Audience properties
that will be published for general use. The namespace of the Schema is
“urn:scte:224:audience” and indicates that this Schema contains the standard audience
properties.
2. Zip – A simple string token meant to contain a 5-digit U.S. Postal ZIP code.
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns="urn:scte:224:audience" targetNamespace="urn:scte:224:audience"
xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
<xs:element name="DeviceFeature">
<xs:annotation>
<xs:documentation>Properties/attributes of a hardware device that is being used
to view content. May be controllable features of that hardware device. i.e. digital
output</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:token">
<xs:enumeration value="DEDICATED_DISPLAY">
<xs:annotation>
<xs:documentation>A device that has its own integrated content display
(e.g. tablet, smartphone, smartTV)</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="DIGITAL_OUTPUT">
<xs:annotation>
<xs:documentation>A device that has the capability to output digital
content through any means (e.g. hardware port, wireless casting)</xs:documentation>
</xs:annotation>
</xs:enumeration>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="Zip" type="xs:token">
<xs:annotation>
<xs:documentation>The client is located geographically within a region
designated by a 5 decimal numerical digits indicating the postal codes used by the
United States Postal Service (USPS) https://www.usps.com/ Example:<!--
audience:Zip>80202</audience:Zip --></xs:documentation>
</xs:annotation>
</xs:element>
</xs:schema>
3.2 Action Schema Example
The following XML Schema snippet is meant to illustrate a few Action properties that
will be published for general use. The namespace of the Schema is
“urn:scte:224:action” and indicates that this Schema contains the standard action
properties.
The following example shows how the Audience Schema would be used in an actual
ESNI document. The audience namespace is declared as part of the Audience and
then used to reference a corresponding property from the Schema.
<?xml version="1.0" encoding="UTF-8"?>
<Audience xmlns="http://www.scte.org/schemas/224/2015"
xmlns:audience="urn:scte:224:audience" id="audience/145"
<audience:Zip>80027</audience:Zip>
</Audience>
The following example shows how the Action Schema would be used in an actual
ESNI document. The action namespace is declared as part of the ViewingPolicy and
then used to reference a corresponding property from the Schema.
<?xml version="1.0" encoding="UTF-8"?>
<ViewingPolicy xmlns="http://www.scte.org/schemas/224/2015"
xmlns:action="urn:scte:224:action"
xmlns:xlink="http://www.w3.org/1999/xlink"
<Audience xlink:href="audience/145"/>
<action:Content>SomeProvider/SomeContent</action:Content>
</ViewingPolicy>
3.5 Metadata Usage Example
The following example shows how the Metadata Schema would be used in an actual
ESNI document. The metadata namespace is declared as part of the MediaPoint and
then used to reference a corresponding property from the Schema.