This documentation supports the 20.08 version of BMC Discovery.

To view an earlier version of the product, select the version from the Product version menu.

tw_convert_reports

The tw_convert_reports utility enables you to manually customize reports and channels on the appliance. This utility can serve as a standalone tool to manually convert reports from the old format to the new format (introduced in Tideway Foundation 7.3) after you have upgraded BMC Discovery and started the system.

This report format was introduced in Tideway Foundation 7.3. Therefore, the utility is required only for report files that have been manually copied from an appliance version earlier than 7.3 to an appliance version later than 7.3. If you upgrade to a BMC Discovery version later than 7.3, the utility runs automatically.

To use the utility, type the following command at the $TIDEWAY/bin/ directory:

$TIDEWAY/bin/tw_convert_reports options reports_file

where:

  • reports_file is the name of the xml reports file to be converted.
    If a file name is not specified, an error is displayed.
  • options are any of the options described in the following table and the common command line options described in Using command line utilities.

Command Line Option

Description

-d, --debug

Specifies to display debug messages

-r, --rename

Specifies to rename the input file reports_file.old and save the converted file as reports_file. If there are errors, they are written to the terminal and the file is not converted.

-v, --verbose

Specifies to display errors and warning messages. If no errors are reported, the reports and charts work the same way they did in the previous version. These messages are also written in the comments section of the converted file.

User example

In the following example, type the commands on a single line. Line breaks are provided to make the example easier to read.

Converting a reports file

To convert a consolidated report file named 30ListenerReports.xml, type the following command:

$ cd /usr/tideway/data/custom/reports
$ ls
30ListenerReports.xml
$ TIDEWAY/bin/tw_convert_reports 30ListenerReports.xml

Generated converted_30ListenerReports.xml (0 errors, 2 warnings)
$ ls
30ListenerReports.xml
converted_30ListenerReports.xml
$

The file is converted and saved as a new file prepended with converted_. The original file is not changed.

Was this page helpful? Yes No Submitting... Thank you

Comments