Skip to content
This repository has been archived by the owner on Aug 9, 2024. It is now read-only.

Report Tool

William Lupton edited this page Oct 11, 2017 · 2 revisions

Overview

The BBF Report Tool is a perl program that generates reports from Broadband Forum TR-069 data model definitions. These data model definitions are commonly referred to as DM Instances (DM = Data Model) because they conform to the TR-106 cwmp-datamodel XML Schema.

Reports of various formats can be generated, but it is most common to generate HTML. HTML generated using the BBF Report Tool is published on the Broadband Forum CWMP page.

The BBF Report Tool is distributed as report.pl, as a Windows executable report.exe, as a Mac OS X executable report.darwin and as Klaus Wich's packaged Windows ReportGUI.

For example, this is how to use report.pl to generate an HTML report on the TR-181 Issue 2 Amendment 2 data model (this assumes that all the necessary DM Instances are in the current directory).

 report.pl --report html tr-181-2-2-0.xml >tr-181-2-2-0.html
 urn:broadband-forum-org:tr-143-1-0-2: 47
 urn:broadband-forum-org:tr-157-1-1-0: 223
 urn:broadband-forum-org:tr-157-1-2-0: 40
 urn:broadband-forum-org:tr-157-1-3-0: 83
 urn:broadband-forum-org:tr-181-2-0-1: 1769
 urn:broadband-forum-org:tr-181-2-1-0: 1
 urn:broadband-forum-org:tr-181-2-2-0: 321

The URNs and numbers indicate where the various objects and parameters were originally defined. The resulting HTML can be found here.

The BBF Report Tool supports many options, e.g. to control the report format, to highlight the differences between two files, or to request more pedantic warnings. report.pl --help outputs an explanation of all of the options.

The BBF Report Tool was written by and is maintained by William Lupton.

Clone this wiki locally