Broadband Customer Reporting MAX Product CSV and XML Files

Transcription

1 User Guide Broadband Customer Reporting MAX Product CSV and XML Files

2 Index Index...2 Document History...2 Introduction...2 Benefits...3 Getting Started...4 MAX Reports available via Request...5 MAX Reports available via On-line Download...5 Reporting Problems...7 Change Management...7 File Formats...7 Line Rate Synchronisation Report...7 KBPS e.g Line Rate Change Delta Report...9 CSV/XML File Format...9 Service Profile Report...11 CSV/XML File Format...11 Current Service Details Report (CSV) File Format...13 Max End User Summary Report...14 CSV File Format...14 KBPS e.g Document History Issue Date Reason 1 August 2005 CSV format for MAX Speed and Profile data. 2 December 2005 Enhancements for MAX Launch. 3 February 2006 Modification to include product variants Introduction The MAX product set has been designed to address the needs of BT Wholesale customers and end users who want to utilise emerging bandwidth hungry applications on their ADSL lines. MAX will introduce a new flexible self-install access component that will be incorporated into IPstream Home, IPstream Office and Datastream. ADSL products and will offer the fastest broadband the line can support between 256Kbps DSL line rate 1 and 8Mbps 1 Throughout this document DSL Line Rate refers to the visible DSL line rate and equates to the ATM rate which includes ATM headers. Eg with a line rate of 2272 kbps once you take off the ATM header this leaves around 2058 kbps of useable bandwidth.

3 (8128kbps DSL line Rate) downstream. The upstream rate will rate adapt and will be between set ranges dependant on the product For further details of the Max products please refer to the Beta Trial Handbooks provided to you as part of the Beta Trial sign up. This document is designed to support Service Providers (SP) who wish to receive the Beta MAX product Speed and Profile data via CSV download, CSV file attached to or XML format. For further details regarding obtaining reports in XML format, please refer to the XML User Guide. IMPORTANT Please note the following : 1. This version of the document has been amended to show the Beta trial names for Max products, the notified Launch names for Datastream Max family of products and the agreed launch names for IPstream Max family of products. It may be subject to minor changes. Please refer to any launch notifications for confirmation of names. 2. DSL Max data items and reports in red text may not available until the launch of the IPStream and/or DataStream MAX products 3. Throughout this document the launch names of the IPstream Max and "Datastream Max" products will be used. However you need to note that alternative product names may be used during trial and prior to any launch as listed below. Name to be used at, and post launch of the product BT IPstream Max BT IPstream Max Premium BT Datastream Max Name to be used up to formal launch of the product, or otherwise notified. BT IPstream Home Max BT IPstream Office Max BT Datastream Home Max BT Datastream Max CBR BT Datastream MaxVBRrt BT Datastream Max Premium BT Datastream Office Max BT Datastream Max Premium CBR BT Datastream Max Premium VBRrt Benefits The line qualification systems have been upgraded so that customers are given an estimate of the highest speed that a line can support. When the line is connected the rate will be set at the highest speed that can be supported (within safe working margins) This is known as Rate Adaptive Technology. The CSV files support the use of Rate Adaptive

4 Technology, to achieve a Downstream rate of initially between 256Kb and 8Mb enabling Service Providers to apply any changes required on their systems to support the MAX product set. Reports will be available on-line, CSV attached to , or via files in either CSV or XML format. Administrator level allows administrator to configure the timing of the MAX CSV reports. The Line Rate Change Delta CSV file can support an update within 15 minutes of rate changes being applied to the IP or DS circuit for the SP by the BT system. Therefore it is possible any report will be upto 15 minutes out of date. This report may be requested multiple times during a day, to include a maximum of 1 day of information in each request. This may be up to 14 days old (i.e. a single file may have up to one day of data, from any time within the last 14 days). NOTE ; If there has been extensive activity on MAX product circuits then it is recommended that the frequency of this report is increased, as the resulting report file may be excessively large. Reports in excess of 2MB may cause problems with facilities resulting in delivery failure. The Line Rate Synchronisation and Service Profile report files can provide an update when the Rate and Fault threshold levels have been set for an IP or DS circuit. This data is updated on a daily basis. This report may be requested multiple times during a day, to include a maximum of 1 day of information in each request. This may be up to 14 days old (i.e. a single file may have up to one day of data, from any time within the last 14 days). The Current Service Details report will give a view of the current state of all MAX circuits belonging to an SP at a given point in time. The MAX End User Summary will provide a view of the current service details for a particular Datastream Max (including CBR and VBRrt variants), Datastream Max Premium (including CBR and VBRrt variants), IPStream Max or IPStream Max Premium circuit. The CSV files for Line Rate Change can be scheduled to run every 5 minutes if required. Getting Started This document assumes that the Service provider who requires the MAX product CSV files to be ed will have access to Broadband Customer Reporting Release 2. To receive the files via CSV attached to , an request must be set up via the Broadband Customer Reporting Administrator function. To receive CSV files attached to the following selections must be made: Include Weekends Select if you want delivery on Saturday and Sunday. Period Type Select from the drop down menu how often you want an report (in conjunction with frequency). This option is not available for the Current Services Detail Report, which can only be scheduled to run on an adhoc basis. Frequency Select from the drop down menu how frequent you want an report, the maximum being every 5 minutes (in conjunction with Period Type). This option is not available for the Current Services Detail Report, which can only be schedule to run on an adhoc basis. Record Retention. First Dispatch This is the date and time that you want to start receiving s from and should be in the format dd/mm/yyy hh:mm

5 Last Dispatch Set to the last date and time that an was dispatched from BT to the SP. 1 to 6 Enter up to 6 addresses and this is where your report will be sent to. Cease Date The date the service is to be ceased. For the Current Service Detail Report this will always be the day after the report was requested for. Update Choose this button and the criteria that you have just completed will be used to fulfil the requirements. Cancel Choose this button before choosing Update and your selections will return to their original settings. MAX Reports available via Request Current Service Details Report To provide a report giving current service details for all IP and DS lines within 1 working day of a request from the SP. This report is requested on an ad-hoc basis, and therefore cannot be scheduled for regular delivery. This report is internally limited within BT Application to prevent more than two reports running at any one time, and is scheduled to run overnight. If two reports are already scheduled for the same date that you request, you will not be able to schedule the report for the selected date. MAX Reports available via On-line Download In CSV Format Line Rate Synchronisation Report This report shows the Maximum Stable Rate and the Fault Threshold Rate of MAX IPStream and DataStream circuits when the rate has stabilised.( see Beta Trial Customer Handbooks for more detail) Data is supplied to BIP on a daily basis, and this report may be downloaded in CSV file format. Note : this report is also available online. Line Rate Change Delta Report This report will give an update for all IP and DS circuits for the SP for which a Line Rate Change (either Upstream or Downstream) has been applied. A record is written to the report when the line is first sync ed up and thereafter the line is reported whenever there is a change of speed. Data is supplied to BIP every 5 minutes, and this report can be scheduled to run at intervals from 5 minutes to 24 hours. It may be scheduled to be delivered in CSV file format attached to . Note : this report is also available online.

6 Service Profile Report This provides a report of profile changes for IP and DS circuits, ie Noise Margin and/or Run Mode on a daily basis, and may be downloaded in CSV file format. Note : this report is also available online. Max End User Summary Report This report shows service details for a specified Datastream Max (including CBR and VBRrt variants), Datastream Max Premium (including CBR and VBRrt variants), IPstream Max or IPstream Max Premium circuit. Data is supplied to BIP on a daily basis, reports can be scheduled to run at intervals from 5 minutes to 24 hours. Note : this report is also available online. In XML Format Note: please see XML User Guide for further details. Line Rate Synchronisation Report This report shows the Maximum Stable Rate and the Fault Threshold Rate of MAX IPstream and Datastream circuits when the rate has stabilised.( see Beta Trial Customer Handbooks for more detail) Data is supplied to BIP on a daily basis. Note : this report is also available online and via CSV download. Line Rate Change Delta Report This report will give an update for all IP and DS circuits for the SP for which a Line Rate Change (either Upstream or Downstream) has been applied. A record is written to the report when the line is first sync ed up and thereafter the line is reported whenever there is a change of speed. Data is supplied to BIP every 5 minutes, s can be scheduled to run at intervals from 5 minutes to 24 hours Note : this report is also available online and in CSV file format attached to . Service Profile Report This provides a report of profile changes for IP and DS circuits, ie Noise Margin and/or Run Mode on a daily basis Note : this report is also available online and via CSV file download.

7 Reporting Problems If you have any difficulty running the application then the problem should be reported to the eco helpdesk on and select option 1. If you have any query regarding the data contained in the downloaded reports, then this should be reported in the first instance to your owning Service Team at the Service Centre. Change Management Any development that impacts on the CSV files that can be downloaded via causing any changes in content or format will be detailed and communicated to Service Providers with expected dates of the change. In some cases dates and changes may be dictated by the need to change due to the inclusion of new products or services. An outline of latest changes will be included in the changes section. File Formats The following tables give the column names and possible entries and comments for the MAX CSV and XML files. These items will be available from Broadband Customer Reporting on-line and via . Line Rate Synchronisation Report This report shows the stabilised Rate and fault threshold of MAX IPStream and DataStream circuits (including CBR and VBRrt variants) when the rate has stabilised. A record is written to the report when the speed has been synchronised for the first time or has been re-synchronised following clearance of a fault. CSV/XML File Format Column Title Possible Entries Format Explanation Service Id FT or FTIP or BBIP or BBVS or BBDS and 9 number The unique identifier of the service. It never changes. Network Id CBUK then 6 or 8 numbers The identifier

8 Product IPstream Max IPstream Max Premium Datastream Max Datastream Max CBR Datastream Max VBRrt Datastream Max Premium Datastream Max Premium CBR Datastream Max Premium VBRrt 100 Char Max of the network virtual circuit over which customers service runs. The Product Name Maximum Stable Rate Fault Threshold Rate Max Stable Rate Re-set Status Line Rate Timestamp BIP Update Time KBPS e.g KBPS e.g Set to C if the Stable Rate is being calculated for the first time, Y if the Stable Rate has been reset, R if the Stable Rate is being recalculated, or N if it has never been re-set. Date and Time Date and Time DD/MM/YYYY HH:MM:SS DD/MM/YYYY HH24:MI:SS Maximum Stable DownStream Line Rate the service is expected to work at. The lowest DownStream Line Rate the service is expected to work at. Below this rate a fault can be raised. Indication if the Max Stable rate (speed) has been synchronised for the first time or has been resynchronised following the clearance of a fault. Date and time the Line Rate was set The time when the Customer Reporting record was last updated prior to dispatch

9 Line Rate Change Delta Report To provide a near real-time speed report for all IP and DS circuits for the SP. A record is written to the report when the line is first synchronised and thereafter the line is reported whenever there is a change of line rate (either Upstream or Downstream). For IPstream a line rate change record will only be written if this has forced a change on the BT BRAS (in ½ Mb steps), and thus the effective service given on a line. For Datastream (including CBR and VBRrt variants) any line rate change (in 32K steps) will be written to the report. CSV/XML File Format Column Title Possible Entries Format Explanation Service Id FT or FTIP or BBIP or BBVS or BBDS and 9 number The unique identifier of the service. It never changes. Network Id CBUK then 6 or 8 numbers Product IPstream Max IPstream Max Premium Datastream Max Datastream Max CBR Datastream Max VBRrt Datastream Max Premium Datastream Max Premium CBR Datastream Max Premium VBRrt 100 Char Max The identifier of the network virtual circuit over which customers service runs. The Product Name Upstream Line Rate Downstream Line Rate Line Rate Timestamp KBPS e.g KBPS e.g Date and Time DD/MM/YYYY HH:MM:SS Up Stream Line Rate at which the service was running at the timestamp indicated Down Stream Line Rate at which the service was running at the timestamp indicated. Date and time the Line Rate (either

10 Interleaved I Opt In, O Opt Out, A Auto Advanced Service Indicator BIP Update Time Y when End User is an Advanced Services User also. Date and Time DD/MM/YYYY HH24:MI:SS upstream or downstream) was recorded Indicates whether interleaving has been specifically enabled, disabled or defaulted. Indicates whether End User has Advanced Services as well as MAX products The time when the Customer Reporting record was last updated prior to dispatch

11 Service Profile Report This provides a report of profile changes for IP and DS circuits, ie Noise Margin and/or Run Mode on a daily basis. A record is included in this report if there has been a change of Noise Margin and/or Run Mode and/or ILQ. CSV/XML File Format Column Title Possible Entries Format Explanation Service Id FT or FTIP or BBIP or BBVS or BBDS and 9 number Network Id CBUK then 6 or 8 numbers Product Noise Margin Re-Set (Y/N) Run Mode Run Mode Change (Y/N) IPstream Max IPstream Max Premium Datastream Max Datastream Max CBR Datastream Max VBRrt Datastream Max Premium Datastream Max Premium CBR Datastream Max Premium VBRrt Set to Y if the Noise Margin reset, else set to N Interleaved or Fast Set to Y if the Run Mode changed, else set to N 100 Char Max 1 Interleaved I Opt In, O Opt Out, A Auto The unique identifier of the service. It never changes. The identifier of the network virtual circuit over which customers service runs. The Product Name Has the Noise Margin been re-set to a different value. Indicates the Run Mode Has the Run Mode been changed to a different value. Indicates whether interleaving has been specifically enabled, disabled or defaulted. Profile Change Date and Time DD/MM/YYYY Time the Noise

12 Time HH:MM:SS Margin/Run Mode was last changed BIP Update Time Date and Time DD/MM/YYYY HH24:MI:SS The time when the Customer Reporting record was last updated prior to dispatch

13 Current Service Details Report To provide a report giving current service details for all IP and DS lines within 1 working day of a request from the SP. This report can only be requested on an ad-hoc basis. It should be noted that this file could be extremely large and production of the report will be limited by Broadband Customer Reporting to ensure that no more than two reports are scheduled across all SP s for a given nightly run. (CSV) File Format Column Title Possible Entries Format Explanation Service Id FT or FTIP or BBIP or BBVS or BBDS and 9 number The unique identifier of the service. It never changes. Network Id CBUK then 6 or 8 numbers Product IPstream Max IPstream Max Premium Datastream Max Datastream Max CBR Datastream Max VBRrt Datastream Max Premium Datastream Max Premium CBR Datastream Max Premium VBRrt 100 Char Max The identifier of the network virtual circuit over which customers service runs. The Product Name Upstream Line Rate Downstream Line Rate Noise Margin Re-Set (Y/N) KBPS e.g KBPS e.g Set to Y if the Noise Margin reset, else set to N Up Stream Line Rate at which the service was running at the timestamp indicated Down Stream Line Rate at which the service was running at the timestamp indicated. Has the Noise Margin been re-set to a

14 Run Mode BIP Update Time Interleaved or Fast Date and Time 1 DD/MM/YYYY HH24:MI:SS different value. Indicates the Run Mode Fast or Interleaved The time when the Customer Reporting record was last updated prior to dispatch Max End User Summary Report This report shows service details for a specific Service or Network Id relating to a Datastream Max (including CBR and VBRrt variants), Datastream Max Premium (including CBR and VBRrt variants), IPStream Max or IPStream Max Premium circuit. Additionally a date may be specified to view only details for a particular day. If no date is entered, the most recent changes (maximum of 100) will be displayed. Note : either Network or Service Id will be displayed on this report, but not both. If Service Id is entered as a report parameter then Network Id will be displayed in the report. If Network Id is entered as a report parameter, then Service Id will be displayed in the report. CSV File Format Service Id FT or FTIP or BBIP or BBVS or BBDS and 9 number The unique identifier of the service. It never changes. Network Id CBUK then 6 or 8 numbers Product IPstream Max IPstream Max Premium Datastream Max Datastream Max CBR Datastream Max VBRrt Datastream Max Premium Datastream Max Premium CBR Datastream Max Premium VBRrt 100 Char Max The identifier of the network virtual circuit over which customers service runs. The Product Name Upstream Line KBPS e.g Up Stream Line

15 Rate Rate at which the service was running at the timestamp indicated Downstream Line Rate Maximum Stable Rate Fault Threshold Rate Noise Margin Re-set (Y/N) Run Mode KBPS e.g KBPS e.g KBPS e.g Set to Y if the Noise Margin reset, else set to N Interleaved or Fast 1 Interleaved I Opt In, O Opt Out, A Auto BIP Update Time Date and Time DD/MM/YYYY HH24:MI:SS Down Stream Line Rate at which the service was running at the timestamp indicated. Maximum Stable DownStream Line Rate the service is expected to work at. The lowest DownStream Line Rate the service is expected to work at. Below this rate a fault can be raised. Has the Noise Margin been re-set to a different value. Indicates the Run Mode Fast or Interleaved Indicates whether interleaving has been specifically enabled, disabled or defaulted. The time when the Customer Reporting record was last updated prior to dispatch

16