Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Burst Billing Report

Available in pre-release opReports 3.5.0.
Not available in opReports 3.5 ( the official release as at 20 December 2021 2 and newer (not yet in opReports 4).

This report displays 95th percentile InDataVolume and OutDataVolume in Mbps for node interfaces specified in a Burst Billing Customer List File.
This report requires input from a Burst Billing Customer List.

This report is not available from opReports GUI → Views → On-Demand Reports → Create New Report.

...

In the GUI you'd select "from Burst Billing Customer List File (Upload)" and upload the file of choice. For opreports-cli you use burst_billing_customer_list=<path to listfile>, and for a scheduled report you would set the property burst_billing_customer_list with the value being the path to the list file.

The Burst Billing Customer List can only be in csv format:

Each entry must start with the node name, folllowed by an interface, a client number, contracted upstream mbps and contracted downstream mbps:

Code Block
titleBurst Billing Customer List in csv format
ASGARD,FastEthernet0/0,809-101-6782,5,45
ASGARD,2,809-101-6782,60,5
Huawei_AR2240,5,12345678,20,200
Huawei_AR2240,GigabitEthernet0/0/1.243,12345679,100,10
Teldat_ATLAS60,ethernet0/0.3839,12345670,20,20
TeldatM1,10,12345671,10,10

...

opCommon Configuration settings

/path/to/omkj/conf/opCommon.nmis has the following specific configuration settings for this report:

Code Block
title/path/to/omk/conf/opCommon.nmis
'opreports' =>
{
  ...
  'burst_billing_IDUniqueTransactionDateTime_format' => '',
  'burst_billing_IDUniqueTransactionLineNumber_format' => '',
  'burst_billing_csv_display_heading_row' => 1,
  ...
}

Examples of Use:

To get the Burst Billing Report to generate the column IDUniqueTransaction in a different format
once this version of opReports is installed,
the following customisation can be made to the configuration file /path/to/omk/conf/opCommon.nmis:

  • Execute these one-line commands:

    Code Block
    sudo /usr/local/omk/bin/patch_config.exe -b /usr/local/omk/conf/opCommon.nmis /opreports/burst_billing_IDUniqueTransactionDateTime_format='NMIS_%Y%m%d%H_'
    sudo /usr/local/omk/bin/patch_config.exe /usr/local/omk/conf/opCommon.nmis /opreports/burst_billing_IDUniqueTransactionLineNumber_format='%.4d'



To get the Burst Billing Report not to write headings to the first row of the csv file output for the report:

  • execute this one-line command:

    Code Block
    sudo /usr/local/omk/bin/patch_config.exe /usr/local/omk/conf/opCommon.nmis /opreports/burst_billing_csv_display_heading_row=0



Layout Customisation

The layout of this report can be customised from opReports GUI → Views → Report Schedules → Create New → Report → Type=Burst Billing Report → Layout tab:

burst_billing_layout.pngImage RemovedImage Added


Related Topics