<b>Copyright (C) 2008-2011, Cable Television Laboratories, Inc.</b><b>SaFI Interactive Application Messaging Interface, XML Schema, Release Version 3.0.0</b><b>Controlled by specification: OC-SP-SaFI-IAMv3.0-xxxxxx</b>
Properties
attribute form default:
unqualified
element form default:
qualified
version:
1.0
Element AppMsg
Namespace
urn:cablelabs:safi:xsd:iam:3.0
Annotations
<b>AppMsg is the wrapper element containing each message. It contains exactly one message header along with one or more Application Message Blocks.</b>
<xs:element name="AppMsg" type="ApplicationMessageType"><xs:annotation><xs:documentation><b>AppMsg is the wrapper element containing each message. It contains exactly one message header along with one or more Application Message Blocks.</b></xs:documentation></xs:annotation></xs:element>
<xs:simpleType name="UnitIDType"><xs:annotation><xs:documentation><P>UnitID represents the device unique identifier. This could be the device MAC address.</P></xs:documentation></xs:annotation><xs:restriction base="xs:string"><xs:length value="12"/></xs:restriction></xs:simpleType>
Complex Type DecoderInfoType
Namespace
urn:cablelabs:safi:xsd:iam:3.0
Annotations
<p>Information about the decoder sending the message</p>
<xs:complexType name="ContextInfoType"><xs:annotation><xs:documentation><p>Context information related to the instance of the application</p></xs:documentation></xs:annotation><xs:sequence><xs:element name="ContextDesignators" minOccurs="0" maxOccurs="unbounded"><xs:complexType><xs:attribute name="contextDesignatorType" type="xs:int" use="required"/><xs:attribute name="contextDesignatorValue" type="xs:string" use="required"/></xs:complexType></xs:element><xs:element name="ProgramDesignators" minOccurs="0" maxOccurs="unbounded"><xs:complexType><xs:attribute name="programType" type="xs:int" use="required"/><xs:attribute name="programValue" type="xs:int" use="required"/></xs:complexType></xs:element><xs:element name="MediaDesignator" minOccurs="0"><xs:complexType><xs:attribute name="mediaDesignatorType" type="xs:int" use="required"/><xs:attribute name="mediaDesignatorValue" type="xs:string" use="required"/></xs:complexType></xs:element><xs:element name="PositionalDesignator" minOccurs="0"><xs:complexType><xs:sequence minOccurs="0"><xs:choice><xs:element name="TemporalPositionOffset" type="xs:int"/><xs:element name="TemporalPositionUTC" type="xs:dateTime"/><xs:element name="TemporalPositionNPT" type="xs:string"/></xs:choice><xs:element name="DirectionSpeedDesignator" minOccurs="0"><xs:complexType><xs:attribute name="direction" type="xs:string" use="required"/><xs:attribute name="speed" type="xs:int" use="required"/></xs:complexType></xs:element></xs:sequence></xs:complexType></xs:element></xs:sequence><xs:attribute name="ContextType" type="xs:int" use="required"/><xs:attribute name="Description" type="xs:string" use="optional"/></xs:complexType>
Complex Type ApplicationMessageBlockType
Namespace
urn:cablelabs:safi:xsd:iam:3.0
Annotations
<P>This is the payload of the AppMsg. Each message must contain 1 or more AppMsgBlocks. Each AppMsgBlock will have an inheirited PEID from the Applcation Message Header along with an EPSID for unique identification. The AppMsgBlock can contain multiple AppReportBlocks each with its own EventID for identification.</P>
<xs:complexType name="ApplicationMessageBlockType"><xs:annotation><xs:documentation><P>This is the payload of the AppMsg. Each message must contain 1 or more AppMsgBlocks. Each AppMsgBlock will have an inheirited PEID from the Applcation Message Header along with an EPSID for unique identification. The AppMsgBlock can contain multiple AppReportBlocks each with its own EventID for identification.</P></xs:documentation></xs:annotation><xs:sequence><xs:element name="EPSID" type="com:EpsidType"/><xs:element name="AppReportBlock" type="ApplicationReportBlockType" minOccurs="1" maxOccurs="unbounded"/></xs:sequence></xs:complexType>
Complex Type ApplicationReportBlockType
Namespace
urn:cablelabs:safi:xsd:iam:3.0
Annotations
<P>AppReportBlocks are the finest level of reporting. They allow reporting at the EventID level.</P>
<xs:complexType name="ApplicationReportBlockType"><xs:annotation><xs:documentation><P>AppReportBlocks are the finest level of reporting. They allow reporting at the EventID level.</P></xs:documentation></xs:annotation><xs:sequence><xs:element name="EventID" type="com:EventIDType" minOccurs="0"/><xs:element name="UserInput" type="com:UserInputType" minOccurs="0"/><xs:element name="Parameters" type="com:ParametersType" minOccurs="0"/></xs:sequence><xs:attributeGroup ref="com:RelativeTimeAttributeGroup"/></xs:complexType>
<p>This group contains the data elements representing the Header of an Application Message. The header info appears exactly once in each message. It is constructed from the following elements, each contracted to save space:</p><p>Version - a MinSchemaVersion (Replaces ProtocolVersion as the common schema/protocol versioning element across all interfaces)</p><p>UnitId - Unit ID</p><p>GeoCode - Geographic ID/Code</p><p>PEID - Programming Event ID</p><p>Timestamp - Timestamp is a reference time in UTC (YYYY-MM-DDThh:mm:ss.mm) that is sent with each message so that each Event carried in an Application Message can reference times in a more compact format specifically as an offset of the reference time. Note: The common TimestampType from CommonTypes.xsd is not used here as Applcaition messaging requires a more compact timing scheme.</p><p>ApplicationInfo - A set of attributes that identify a specific appllication</p><p>DecoderInfo - A set of attributes related to the decoder environment</p><p>ContextInfo - A set of attributes that describe the sofware and media environment</p>
<xs:group name="ApplicationMessageHeaderGroup"><xs:annotation><xs:documentation><p>This group contains the data elements representing the Header of an Application Message. The header info appears exactly once in each message. It is constructed from the following elements, each contracted to save space:</p><p>Version - a MinSchemaVersion (Replaces ProtocolVersion as the common schema/protocol versioning element across all interfaces)</p><p>UnitId - Unit ID</p><p>GeoCode - Geographic ID/Code</p><p>PEID - Programming Event ID</p><p>Timestamp - Timestamp is a reference time in UTC (YYYY-MM-DDThh:mm:ss.mm) that is sent with each message so that each Event carried in an Application Message can reference times in a more compact format specifically as an offset of the reference time. Note: The common TimestampType from CommonTypes.xsd is not used here as Applcaition messaging requires a more compact timing scheme.</p><p>ApplicationInfo - A set of attributes that identify a specific appllication</p><p>DecoderInfo - A set of attributes related to the decoder environment</p><p>ContextInfo - A set of attributes that describe the sofware and media environment</p></xs:documentation></xs:annotation><xs:sequence><xs:element name="Version" type="com:VersionType"/><xs:element name="UnitID" type="UnitIDType"/><xs:element name="GeoCode" type="com:GeographicCodeType"/><xs:element name="PEID" type="com:PeidType"/><xs:element name="Timestamp" type="xs:dateTime"/><xs:element name="ApplicationInfo" minOccurs="0"><xs:complexType><xs:attributeGroup ref="com:ApplicationDefinitionAttributeGroup"/></xs:complexType></xs:element><xs:element name="DecoderInfo" type="DecoderInfoType" minOccurs="0"/><xs:element name="ContextInfo" type="ContextInfoType" minOccurs="0"/></xs:sequence></xs:group>