ATIS 0800032-2009 Metadata for IPTV Fault Codes.pdf

1、 IHS Additional Content Page Access to Additional Content for ATIS-0800032 2009 (Click here to view the publication) This Page is not part of the original publication: This page has been added by IHS as a convenience to the user in order to provide access to additional content as authorized by the C

2、opyright holder of this document. Click the link(s) below to access the content and use normal procedures for downloading or opening the files. ATIS-08000329 ZIP File Information contained in the above is the property of the Copyright holder and all Notice of Disclaimer & Limitation of Liability of

3、the Copyright holder apply. If you have any questions, or need technical assistance please contact IHS Support. ATIS-0800032 METADATA FOR IPTV FAULT CODES The Alliance for Telecommunication Industry Solutions (ATIS) is a technical planning and standards development organization that is committed to

4、rapidly developing and promoting technical and operations standards for the communications and related information technologies industry worldwide using a pragmatic, flexible and open approach. Over 1,100 participants from over 300 communications companies are active in ATIS 22 industry committees a

5、nd its Incubator Solutions Program. Notice of Disclaimer & Limitation of Liability The information provided in this document is directed solely to professionals who have the appropriate degree of experience to understand and interpret its contents in accordance with generally accepted engineering or

6、 other professional standards and applicable regulations. No recommendation as to products or vendors is made or should be implied. NO REPRESENTATION OR WARRANTY IS MADE THAT THE INFORMATION IS TECHNICALLY ACCURATE OR SUFFICIENT OR CONFORMS TO ANY STATUTE, GOVERNMENTAL RULE OR REGULATION, AND FURTHE

7、R, NO REPRESENTATION OR WARRANTY IS MADE OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR AGAINST INFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS. ATIS SHALL NOT BE LIABLE, BEYOND THE AMOUNT OF ANY SUM RECEIVED IN PAYMENT BY ATIS FOR THIS DOCUMENT, WITH RESPECT TO ANY CLAIM, AND IN NO EVENT

8、SHALL ATIS BE LIABLE FOR LOST PROFITS OR OTHER INCIDENTAL OR CONSEQUENTIAL DAMAGES. ATIS EXPRESSLY ADVISES ANY AND ALL USE OF OR RELIANCE UPON THIS INFORMATION PROVIDED IN THIS DOCUMENT IS AT THE RISK OF THE USER. NOTE - The users attention is called to the possibility that compliance with this stan

9、dard may require use of an invention covered by patent rights. By publication of this standard, no position is taken with respect to whether use of an invention covered by patent rights will be required, and if any such use is required no position is taken regarding the validity of this claim or any

10、 patent rights in connection therewith. ATIS-0800032, Metadata for IPTV Fault Codes Is an ATIS standard developed by the Metadata and Transaction Delivery (MTD) Committee under the ATIS IPTV Interoperability Forum (IIF). Published by Alliance for Telecommunications Industry Solutions 1200 G Street,

11、NW, Suite 500 Washington, DC 20005 Copyright 2009 by Alliance for Telecommunications Industry Solutions All rights reserved. No part of this publication may be reproduced in any form, in an electronic retrieval system or otherwise, without the prior written permission of the publisher. For informati

12、on contact ATIS at 202.628.6380. ATIS is online at . Printed in the United States of America. ATIS-0800032 ATIS Standard on METADATA FOR IPTV FAULT CODES Alliance for Telecommunications Industry Solutions Approved May 19, 2009 Abstract The fault codes defined in ATIS-0800028, Fault Codes for IPTV, r

13、equire a metadata exchange between consumer domain devices and service provider and/or network provider systems. This document and the associated XML schema provide this metadata. NOTE - Annex A, IPTV Fault Code Metadata XML Description Scheme, of this Standard has also been formatted as a separate

14、file and electronically packaged with this standard. ATIS-0800032 ii FOREWORD The Alliance for Telecommunication Industry Solutions (ATIS) serves the public through improved understanding between carriers, customers, and manufacturers. The IPTV Interoperability Forum (IIF) develops requirements, sta

15、ndards, and specifications that will determine the industrys end-to-end solution for Internet Protocol Television (IPTV). The mandatory requirements are designated by the word shall and recommendations by the word should. Where both a mandatory requirement and a recommendation are specified for the

16、same criterion, the recommendation represents a goal currently identifiable as having distinct compatibility or performance advantages. The word may denotes a optional capability that could augment the standard. The standard is fully functional without the incorporation of this optional capability.

17、Suggestions for improvement of this document are welcome. They should be sent to the Alliance for Telecommunications Industry Solutions, IIF Staff, 1200 G Street NW, Suite 500, Washington, DC 20005. The Metadata and Transaction Delivery (MTD) Committee was responsible for the development of this doc

18、ument, with the leadership of the following people: D. OCallaghan, IIF Chair R. Brand, IIF Vice Chair H. Bassali, MTD Committee Co-Chair K. Bacon, MTD Committee Co-Chair C.A. Underkoffler, ATIS Chief Editor A. Blasgen, IIF Committee Administrator CONTRIBUTORS David Gibbon, AT&T Kinney Bacon, Cisco P

19、aul Higgs, Ericsson Gomer Thomas, LG Electronics JoonHui Lee, LG Electronics Tony Faustini, Microsoft Joseph Rodolico, Nielsen Company Quentin Meek, Qzik Engineering Jim Alexander, Tandberg Television Harpal Bassali, Verizon ATIS-0800032 iii TABLE OF CONTENTS 1 BACKGROUND & SCOPE 1 1.1 BACKGROUND 1

20、1.2 SCOPE .1 2 REFERENCES .1 3 ACRONYMS, & ABBREVIATIONS .1 4 IPTV FAULT CODES DESCRIPTION (INFORMATIVE) 2 4.1 OVERVIEW/BACKGROUND OF IPTV FAULT CODES 2 4.2 OVERVIEW/BACKGROUND OF IPTV FAULT CODE METADATA.2 4.2.1 Future-Proof 2 4.2.2 Expandable 2 4.2.3 Delivery Mechanism 2 4.2.4 Parameter Request.2

21、4.2.5 Poll/Event.2 5 IPTV FAULT CODE METADATA SPECIFICATION (NORMATIVE) 3 5.1 IPTV FAULT CODE XML FRAMEWORK3 5.1.1 XML Schema 3 5.2 IPTV FAULT CODE METADATA IMPLEMENTATION 3 5.2.1 IPTV Fault Code Request/Response Metadata Operation.3 5.2.2 IPTV Fault Code Type Description3 A IPTV FAULT CODE METADATA

22、 XML DESCRIPTION SCHEME7 TABLE OF FIGURES FIGURE 1: TOP LEVEL FAULT CODE TABLE4 FIGURE 2: FAULT CODE TABLE TYPE .4 FIGURE 3: FAULT CODE TYPE.5 FIGURE 4: FAULT CODE ACCESS DATA TYPE .6 ATIS STANDARD ATIS-0800032 Metadata for IPTV Fault Codes 1 1 BACKGROUND & SCOPE 1.1 Background The fault codes defin

23、ed in the ATIS-0800028, Fault Code for IPTV 1, require a metadata exchange between consumer domain devices and service provider and/or network provider systems. This document and the associated XML schema provide this metadata. 1.2 Scope This document provides a description of the associated fault c

24、ode schema file. 2 REFERENCES The following standards contain provisions which, through reference in this text, constitute provisions of this ATIS Standard. At the time of publication, the editions indicated were valid. All standards are subject to revision, and parties to agreements based on this A

25、TIS Standard are encouraged to investigate the possibility of applying the most recent editions of the standards indicated below. 1 ATIS-0800028, Fault Codes for IPTV, March 2009.12 Broadband Forum TR-069, CPE WAN Management Protocol, May 2004, and Amendment 1, November 2006.23 W3C Recommendation, E

26、xtensible Markup Language (XML) 1.0 (Fourth Edition), August 2006.33 ACRONYMS, & ABBREVIATIONS ATIS Alliance for Telecommunications Industry Solutions DNG Delivery Network Gateway DRM Digital Rights Management IIF IPTV Interoperability Forum IPTV Internet Protocol Television ITF IPTV Terminal Functi

27、on NSP Network Service Provider 1This document is available from the Alliance for Telecommunications Industry Solutions, 1200 G Street N.W., Suite 500, Washington, DC 20005. 2This document is available from the Broadband Forum. 3This document is available from the World Wide Web Consortium (W3C). AT

28、IS-0800032 2 QoS Quality of Service W3C World Wide Web Consortium XML eXtensible Markup Language 4 IPTV FAULT CODES DESCRIPTION (INFORMATIVE) 4.1 Overview/Background of IPTV Fault Codes Please refer to 1 for information on the IPTV fault codes. 4.2 Overview/Background of IPTV Fault Code Metadata The

29、 metadata for the IPTV Fault Codes has been developed using the following philosophy: The metadata is future-proof. The metadata is expandable. The metadata is non-delivery specific. The metadata can be used to request or deliver fault codes. The metadata can be used in a polled or event driven envi

30、ronment. 4.2.1 Future-Proof The metadata is future proofed for addition of new IPTV fault codes by defining the fault codes as non-specific strings where the value of the string is the name defined in 1. There are no enumerated values. All of the fault code parameters are defined as strings with exc

31、eption of the timestamp, which uses the XML standardized dateTime value. 4.2.2 Expandable The metadata is expandable by utilizing a simple loop with an unlimited number of elements. 4.2.3 Delivery Mechanism The metadata is designed to be non-delivery mechanism specific. 4.2.4 Parameter Request The m

32、etadata can be used to request specific parameters by setting the FaultCodeRequest element to “TRUE”. If this value is false, then the data contains the report for the various fault codes. 4.2.5 Poll/Event The metadata is agnostic to whether it is polled or delivered as an event. ATIS-0800032 3 5 IP

33、TV FAULT CODE METADATA SPECIFICATION (NORMATIVE) 5.1 IPTV Fault Code XML Framework 5.1.1 XML Schema The IPTV Fault Code Metadata XML Description Scheme that has been developed by the ATIS IIF is associated with the ATIS IIF “fcode:” XML namespace. The full IPTV Fault Code XML Description Scheme is i

34、n the form of an “.xsd” file, which is contained in a “zip” archive that accompanies the present document. In the event of any conflict, this “.xsd” file takes precedence over the XML schema definitions in the present document. The formal definition of the ATIS IIF fcode: metadata namespace is: xmln

35、s:fcode=http:/www.atis.org/schemas/0800032/fcode/15.2 IPTV Fault Code Metadata Implementation 5.2.1 IPTV Fault Code Request/Response Metadata Operation An IPTV Fault Code Request/Response cycle consists of a request and response. 5.2.1.1 IPTV Fault Code Request Operation The IPTV Fault Code Request

36、may consist of sending the fault code metadata to the consumer domain device with the FaultCodeRequest equal to TRUE for the fault codes wished to be received. 5.2.1.2 IPTV Fault Code Metadata Response Operation In response to the IPTV Fault Code Request, the ITF shall return the IPTV Fault Code dat

37、a with the fault codes listed in the request per the schema. 5.2.1.3 IPTV Fault Code Event Operation The ITF may send the IPTV Fault Code data at its own discretion, for example, based on a fault occurring or at a periodic time. 5.2.2 IPTV Fault Code Type Description The IPTV Fault Code metadata fol

38、lows a simple format which references the fault codes defined in 1. This allows for support of future revisions of 1. 5.2.2.1 Top Level Metadata Structure The top level structure consists of a single Fault Code Table which includes any number of fault codes (defined in 5.2.2) using the Fault Code Ta

39、ble type. ATIS-0800032 Figure 1: Top Level Fault Code Table Figure 2: Fault Code Table Type Name R/O Semantics FaultCodeTable R Root element for an ATIS fault code XML document, encompassing all aspects of fault codes. FaultCodeRequest R Boolean value set to TRUE if this is a request for fault codes

40、, set to FALSE if this is a response which includes the fault code values. FaultCode O List of fault codes. If the FaultCodeRequest is set to TRUE and there are no fault codes, then all fault codes shall be requested. If the FaultCodeRequest is set to FALSE and there are no fault codes, then no Faul

41、tCode values shall be included in the document. 5.2.2.2 FaultCodeType The FaultCodeType consists of a Fault Code Group (as defined in 1), a Fault Code Name (as defined in 1), and a choice as to whether this is a request for fault codes or a response or event. 4 ATIS-0800032 Figure 3: Fault Code Type

42、 Name R/O Semantics FaultCodeGroup R FaultCodeGroup shall be included as defined in 1. Valid values for release V0 are listed below. New values may be added with later releases: “Linear IPTV” “Public Service Areas” “Closed Captioning” “Content Advisories and V-chip Technology” “Digital Rights Manage

43、ment” “Metadata” “Network Attachment and Initialization of Devices and Client Discovery of IPTV Services” “Remote Device Management” “IPTV Service Subscription” “Data Collection” FaultCodeName R FaultCodeName shall be as defined in 1. FaultCodeData O If FaultCodeRequest is not present, then the Faul

44、tCodeData shall be present for each fault code returned. 5.2.2.3 FaultCodeAccDataType Description The FaultCodeAccDataType consists of a component, location ID, time stamp, TR-069 fault number (if applicable), and fault condition. 5 ATIS-0800032 Figure 4: Fault Code Access Data Type Name R/O Semanti

45、cs Component R The Component value shall be as defined in section 1.5 of 1. If the component cannot be determined, then this value shall be NULL. LocationId R The LocationID shall be as defined for the Location or Unique ID as defined in section 1.5 of 1. TimeStamp R The TimeStamp shall be as define

46、d in section 1.5 of 1. TR69FaultNumber O The TR69FaultNumber, if returned, shall be as defined in 3. FaultCondition R The FaultCondition shall be a description of the fault defined by the ITF vendor. 6 ATIS-0800032 7 Annex A (normative) A IPTV FAULT CODE METADATA XML DESCRIPTION SCHEME A zipfile has

47、 been electronically packaged with this ATIS Standard that provides the consolidated XML schema definition for the ATIS IIF Metadata for IPTV Fault Codes specification. In case of any discrepancies between the XML schema descriptions in this document and those in the companion .xsd document, the latter shall be normative.