diff --git a/docs/baseline.md b/docs/baseline.md new file mode 100644 index 00000000..92553553 --- /dev/null +++ b/docs/baseline.md @@ -0,0 +1,18 @@ +--- +id: baseline +title: Baseline Audit +sidebar_label: Baseline Audit +--- + +The baseline module automatically computes a network baseline and generates a comparison report. The baseline is computed by grouping +GSM cells by BSCs, WCDMA/UMTS cells by RNC, and LTE cells by tracking area. + +To run the baseline, first import your data through the "**Parse and Import**" module. +Then launch the **Baseline Audit** module. Once there, click run baseline to generate network baseline. + + +![GIS Module](/bts-ce-lite/img/baseline_module.png) + +The generated comparison report can be viewed under the **Baseline Audit** reports folder in the reports module tree. + +![GIS Module](/bts-ce-lite/img/baseline_comparison_report.png) diff --git a/docs/gis.md b/docs/gis.md index 063bd676..dd524dde 100644 --- a/docs/gis.md +++ b/docs/gis.md @@ -4,8 +4,28 @@ title: GIS sidebar_label: GIS --- -This GIS module displays network entities and their properties on map. It allows filtering based on technology, name, and environment. +This GIS module displays cells and sites and their properties on a map. It allows filtering based on technology, name, and environment. Below is a screenshot of the GIS module. -![GIS Module](/bts-ce-lite/img/gis.jpeg) \ No newline at end of file +![GIS Module](/bts-ce-lite/img/gis.jpeg) + +## Importing data +Currently, we can import boda cell files(structure is avialable in the import and load documentation) and TEMS CEL and XML files for GSM, WCDMA, and LTE. To import data, +launch the GIS module, click the **data icon** on the left menu to see import options. Select the import file format and optionaly +specify whether to first clear the old data before loading the new data. +shows how to +![Import data into Map](/bts-ce-lite/img/gis_import_data.png) + +## Filtering cells +It's important to filter the cells on the map so that you can concentrate on the key cells you want to view. +Filtering can be donw by selecting the technology, or searching for a cell's name vie the filter search text field. The search +text fields accepts regular expressions for complex filtering criteria. + +![Filtering cells on the map](/bts-ce-lite/img/gis_filter_cells.png) + +## Editing display properties +The property edit pane allows your to set the sector radius per technology and specify the +color used for each carrier frequency. + +![Update sector colors](/bts-ce-lite/img/gis_update_carrier_colors.png) \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index e75bb986..086cf8cd 100644 --- a/docs/index.md +++ b/docs/index.md @@ -13,6 +13,8 @@ Boda-Lite is a multi-vendor network management desktop application. It is a mini - [Parse and Import](parse_and_import.md) - [Reports](reports.md) - [GIS](gis.md) +- [Baseline](baseline.md) +- [Utilities](utilities.md) - [Key Files and Folders](key_files_and_folders.md) - [Contributing](contributing.md) - [Development](development.md) diff --git a/docs/introduction.md b/docs/introduction.md index 1937a19e..238da11b 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -21,7 +21,8 @@ Below is a summary of the steps needed to install and start the application: * Parsing and import of configuration management(CM), performance management(PM) and fault management(FM) network dumps * Reports module that supports tabular, various graphical reports and composite/dashboard like reports * Advanced GIS module -* Importation of planning network data +* Importation of planning network data through boda cell file +* Useful utilities such as combining csv files to excel ## Planned functionality diff --git a/docs/utilities.md b/docs/utilities.md new file mode 100644 index 00000000..a393bd92 --- /dev/null +++ b/docs/utilities.md @@ -0,0 +1,11 @@ +--- +id: utilities +title: Utilities +sidebar_label: Utilities +--- + + +## Combine CSV files into a excel workbook +The **CSV to Excel Combiner** utility combines a list of csv files into one excel workbook with each file on a separate worksheet. + +![GIS Module](/bts-ce-lite/img/csv_to_excel_combiner.png) diff --git a/package.json b/package.json index e647252f..e2079873 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "Boda-Lite", - "version": "0.3.0-rc.1", + "version": "0.3.0", "description": "Boda-Lite is a telecommunication network management application", "private": true, "homepage": "./", diff --git a/src/version.js b/src/version.js index c15621e4..e82d3698 100644 --- a/src/version.js +++ b/src/version.js @@ -1,3 +1,3 @@ -export const VERSION = "0.3.0-rc.1"; +export const VERSION = "0.3.0"; export default VERSION; diff --git a/website/blog/2019-10-08-new-version-0.3.0.md b/website/blog/2019-10-08-new-version-0.3.0.md new file mode 100644 index 00000000..7300b260 --- /dev/null +++ b/website/blog/2019-10-08-new-version-0.3.0.md @@ -0,0 +1,23 @@ +--- +title: Version 0.3.0 Release +author: Emmanuel Robert Ssebaggala +authorURL: https://www.ssegga.com +--- + +0.3.0 is now available. Below are changes +* Baseline computation +* Added GIS module that supports boda cell file and TEMS CEL and XML files +* Added csv to excel combiner +* Preserve column ordering when reports are exported +* Update documentation with boda cell file structure +* Added relations reports +* Tracking documetation with releases +* Parsing and loading of Ericsson EAW printous added +* Parsing of Motorola Cell X Export dumps +* Processing and loading of Ericsson, Huawei, and Nokia PM +* Added database migrations scripts +* Parsing and loading of Ericsson BSM inventory dumps +* Parsing and loading of Huawei AUTOBAK XML files +* Added relations reports +* Added combined key parameter report +* Added table styling during report creation \ No newline at end of file diff --git a/website/i18n/en.json b/website/i18n/en.json index 8be44449..4fb4148b 100644 --- a/website/i18n/en.json +++ b/website/i18n/en.json @@ -5,6 +5,10 @@ "previous": "Previous", "tagline": "Multi-vendor/technology desktop telecommunication management app", "docs": { + "baseline": { + "title": "Baseline Audit", + "sidebar_label": "Baseline Audit" + }, "contributing": { "title": "Contributing", "sidebar_label": "Contributing" @@ -40,6 +44,66 @@ "reports": { "title": "Reports", "sidebar_label": "Reports" + }, + "utilities": { + "title": "Utilities", + "sidebar_label": "Utilities" + }, + "version-0.3.0/version-0.3.0-baseline": { + "title": "Baseline Audit", + "sidebar_label": "Baseline Audit" + }, + "version-0.3.0/version-0.3.0-gis": { + "title": "GIS", + "sidebar_label": "GIS" + }, + "version-0.3.0/version-0.3.0-index": { + "title": "Contents", + "sidebar_label": "Table of contents" + }, + "version-0.3.0/version-0.3.0-introduction": { + "title": "Introduction", + "sidebar_label": "Introduction" + }, + "version-0.3.0/version-0.3.0-utilities": { + "title": "Utilities", + "sidebar_label": "Utilities" + }, + "version-2.3.0/version-2.3.0-contributing": { + "title": "Contributing", + "sidebar_label": "Contributing" + }, + "version-2.3.0/version-2.3.0-development": { + "title": "Development", + "sidebar_label": "Development Guide" + }, + "version-2.3.0/version-2.3.0-gis": { + "title": "GIS", + "sidebar_label": "GIS" + }, + "version-2.3.0/version-2.3.0-index": { + "title": "Contents", + "sidebar_label": "Table of contents" + }, + "version-2.3.0/version-2.3.0-installation": { + "title": "Installation", + "sidebar_label": "Installation" + }, + "version-2.3.0/version-2.3.0-introduction": { + "title": "Introduction", + "sidebar_label": "Introduction" + }, + "version-2.3.0/version-2.3.0-key_files_and_folders": { + "title": "Key Files and Folders", + "sidebar_label": "Key Files and Folders" + }, + "version-2.3.0/version-2.3.0-parse_and_import": { + "title": "Parse and Import", + "sidebar_label": "Parse and Import" + }, + "version-2.3.0/version-2.3.0-reports": { + "title": "Reports", + "sidebar_label": "Reports" } }, "links": { diff --git a/website/pages/en/index.js b/website/pages/en/index.js index 56b1b289..4722dfc6 100644 --- a/website/pages/en/index.js +++ b/website/pages/en/index.js @@ -64,7 +64,7 @@ class HomeSplash extends React.Component {
- +
@@ -203,6 +203,26 @@ class Index extends React.Component { ); }; + const Sponsors = () => { + + const showcase = [ + {name: "Bodastage Solutions", siteUrl: "https://www.bodastage.com", logoUrl: '/bts-ce-lite/img/bodastage_logo.png'}, + {name: "Telecomhall", siteUrl: "https://www.telecomhall.net", logoUrl: '/bts-ce-lite/img/telecomhall_forum_Logo.png'} + ].map(sp => ( + + {sp.name} + + )); + + return ( +
+

Sponsors

+

This project is sponsored by

+
{showcase}
+
+ ); + }; + return (
@@ -213,6 +233,7 @@ class Index extends React.Component { +
); diff --git a/website/pages/en/versions.js b/website/pages/en/versions.js new file mode 100644 index 00000000..8c4c3c89 --- /dev/null +++ b/website/pages/en/versions.js @@ -0,0 +1,118 @@ +/** + * Copyright (c) 2017-present, Facebook, Inc. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +const React = require('react'); + +const CompLibrary = require('../../core/CompLibrary'); + +const Container = CompLibrary.Container; + +const CWD = process.cwd(); + +const versions = require(`${CWD}/versions.json`); + +function Versions(props) { + const {config: siteConfig} = props; + const latestVersion = versions[0]; + const repoUrl = `https://github.com/${siteConfig.organizationName}/${ + siteConfig.projectName + }`; + return ( +
+ +
+
+

{siteConfig.title} Versions

+
+

New versions of this project are released every so often.

+

Current version (Stable)

+ + + + + + + + +
{latestVersion} + {/* You are supposed to change this href where appropriate + Example: href="/docs(/:language)/:id" */} + + Documentation + + + Release Notes +
+

+ This is the version that is configured automatically when you first + install this project. +

+

Pre-release versions

+ + + + + + + + +
master + {/* You are supposed to change this href where appropriate + Example: href="/docs(/:language)/next/:id" */} + + Documentation + + + Source Code +
+

Other text describing this section.

+

Past Versions

+

Here you can find previous versions of the documentation.

+ + + {versions.map( + version => + version !== latestVersion && ( + + + + + + ), + )} + +
{version} + {/* You are supposed to change this href where appropriate + Example: href="/docs(/:language)/:version/:id" */} + + Documentation + + + + Release Notes + +
+

+ You can find past versions of this project on{' '} + GitHub. +

+
+
+
+ ); +} + +module.exports = Versions; diff --git a/website/sidebars.json b/website/sidebars.json index ed9ade88..9490495c 100644 --- a/website/sidebars.json +++ b/website/sidebars.json @@ -7,6 +7,8 @@ "parse_and_import", "reports", "gis", + "baseline", + "utilities", "key_files_and_folders", "contributing", "development" diff --git a/website/siteConfig.js b/website/siteConfig.js index 62aa746f..eee6c311 100644 --- a/website/siteConfig.js +++ b/website/siteConfig.js @@ -38,7 +38,7 @@ const siteConfig = { // For no header links in the top nav bar -> headerLinks: [], headerLinks: [ - {doc: 'index', label: 'Docs'}, + {doc: '', label: 'Docs'}, {blog: true, label: 'Blog'}, {page: 'users', label: 'Users'}, { @@ -110,7 +110,7 @@ const siteConfig = { // docsSideNavCollapsible: true, // Show documentation's last contributor's name. - // enableUpdateBy: true, + enableUpdateBy: true, // Show documentation's last update time. // enableUpdateTime: true, @@ -123,7 +123,7 @@ const siteConfig = { zIndex: 100, }, - defaultVersionShown: '0.2.3', + defaultVersionShown: '0.3.0', editUrl: 'https://github.com/bodastage/bts-ce-lite/edit/master/docs/', }; diff --git a/website/static/img/baseline_comparison_report.png b/website/static/img/baseline_comparison_report.png new file mode 100644 index 00000000..7982c05a Binary files /dev/null and b/website/static/img/baseline_comparison_report.png differ diff --git a/website/static/img/baseline_module.png b/website/static/img/baseline_module.png new file mode 100644 index 00000000..b70902a9 Binary files /dev/null and b/website/static/img/baseline_module.png differ diff --git a/website/static/img/csv_to_excel_combiner.png b/website/static/img/csv_to_excel_combiner.png new file mode 100644 index 00000000..c0a257be Binary files /dev/null and b/website/static/img/csv_to_excel_combiner.png differ diff --git a/website/static/img/gis_filter_cells.png b/website/static/img/gis_filter_cells.png new file mode 100644 index 00000000..79c470a4 Binary files /dev/null and b/website/static/img/gis_filter_cells.png differ diff --git a/website/static/img/gis_import_data.png b/website/static/img/gis_import_data.png new file mode 100644 index 00000000..1401d76c Binary files /dev/null and b/website/static/img/gis_import_data.png differ diff --git a/website/static/img/gis_sectors.png b/website/static/img/gis_sectors.png new file mode 100644 index 00000000..c9d086e1 Binary files /dev/null and b/website/static/img/gis_sectors.png differ diff --git a/website/static/img/gis_update_carrier_colors.png b/website/static/img/gis_update_carrier_colors.png new file mode 100644 index 00000000..b2f35298 Binary files /dev/null and b/website/static/img/gis_update_carrier_colors.png differ diff --git a/website/static/img/telecomhall_forum_Logo.png b/website/static/img/telecomhall_forum_Logo.png new file mode 100644 index 00000000..cd5f712e Binary files /dev/null and b/website/static/img/telecomhall_forum_Logo.png differ diff --git a/website/versioned_docs/version-0.3.0/baseline.md b/website/versioned_docs/version-0.3.0/baseline.md new file mode 100644 index 00000000..ef018348 --- /dev/null +++ b/website/versioned_docs/version-0.3.0/baseline.md @@ -0,0 +1,19 @@ +--- +id: version-0.3.0-baseline +title: Baseline Audit +sidebar_label: Baseline Audit +original_id: baseline +--- + +The baseline module automatically computes a network baseline and generates a comparison report. The baseline is computed by grouping +GSM cells by BSCs, WCDMA/UMTS cells by RNC, and LTE cells by tracking area. + +To run the baseline, first import your data through the "**Parse and Import**" module. +Then launch the **Baseline Audit** module. Once there, click run baseline to generate network baseline. + + +![GIS Module](/bts-ce-lite/img/baseline_module.png) + +The generated comparison report can be viewed under the **Baseline Audit** reports folder in the reports module tree. + +![GIS Module](/bts-ce-lite/img/baseline_comparison_report.png) diff --git a/website/versioned_docs/version-0.3.0/gis.md b/website/versioned_docs/version-0.3.0/gis.md new file mode 100644 index 00000000..0869f942 --- /dev/null +++ b/website/versioned_docs/version-0.3.0/gis.md @@ -0,0 +1,32 @@ +--- +id: version-0.3.0-gis +title: GIS +sidebar_label: GIS +original_id: gis +--- + +This GIS module displays cells and sites and their properties on a map. It allows filtering based on technology, name, and environment. + +Below is a screenshot of the GIS module. + +![GIS Module](/bts-ce-lite/img/gis.jpeg) + +## Importing data +Currently, we can import boda cell files(structure is avialable in the import and load documentation) and TEMS CEL and XML files for GSM, WCDMA, and LTE. To import data, +launch the GIS module, click the **data icon** on the left menu to see import options. Select the import file format and optionaly +specify whether to first clear the old data before loading the new data. +shows how to +![Import data into Map](/bts-ce-lite/img/gis_import_data.png) + +## Filtering cells +It's important to filter the cells on the map so that you can concentrate on the key cells you want to view. +Filtering can be donw by selecting the technology, or searching for a cell's name vie the filter search text field. The search +text fields accepts regular expressions for complex filtering criteria. + +![Filtering cells on the map](/bts-ce-lite/img/gis_filter_cells.png) + +## Editing display properties +The property edit pane allows your to set the sector radius per technology and specify the +color used for each carrier frequency. + +![Update sector colors](/bts-ce-lite/img/gis_update_carrier_colors.png) \ No newline at end of file diff --git a/website/versioned_docs/version-0.3.0/index.md b/website/versioned_docs/version-0.3.0/index.md new file mode 100644 index 00000000..68dbfcf4 --- /dev/null +++ b/website/versioned_docs/version-0.3.0/index.md @@ -0,0 +1,22 @@ +--- +id: version-0.3.0-index +title: Contents +sidebar_label: Table of contents +original_id: index +--- + +# Boda-Lite Documentation +Boda-Lite is a multi-vendor network management desktop application. It is a minimal feature version of [BTS-CE](https://github.com/bodastage/bts-ce). + +## Contents +- [Introduction](introduction.md) +- [Installation](installation.md) +- [Parse and Import](parse_and_import.md) +- [Reports](reports.md) +- [GIS](gis.md) +- [Baseline](baseline.md) +- [Utilities](utilities.md) +- [Key Files and Folders](key_files_and_folders.md) +- [Contributing](contributing.md) +- [Development](development.md) + diff --git a/website/versioned_docs/version-0.3.0/introduction.md b/website/versioned_docs/version-0.3.0/introduction.md new file mode 100644 index 00000000..d84e08f7 --- /dev/null +++ b/website/versioned_docs/version-0.3.0/introduction.md @@ -0,0 +1,38 @@ +--- +id: version-0.3.0-introduction +title: Introduction +sidebar_label: Introduction +original_id: introduction +--- +The tool is a minimal feature version of [BTS-CE](https://github.com/bodastage/bts-ce). Where as BTS-CE is server based and resource intensive, Boda-Lite is + intentionally light weight and designed to meet the needs of the engineer and run from their personal computers. As such, Boda-Lite is desktop based and supports Windows, Linux and Mac OSX. + +Boda-Lite is open source and licenced under the Apache 2.0 Licence; giving you the freedom to extend and enhance the tool to your needs. + The code is hosted on [github](https://github.com/bodastage/bts-ce-lite) and builds are run on [Travis-CI](https://travis-ci.org/bodastage/bts-ce-lite). + +## Quick Start +Below is a summary of the steps needed to install and start the application: +* Download the latest [release](https://github.com/bodastage/bts-ce-lite/releases/latest) for your operating system +* Install on your personal computer +* Login with username **btsuser** and password **password** +* Go to settings > Database and click **Setup Database** to run the database setup scripts + +## Features +* Support of the main telecommunication vendors: Ericsson, Huawei, Nokia, ZTE and Motorola +* Parsing and import of configuration management(CM), performance management(PM) and fault management(FM) network dumps +* Reports module that supports tabular, various graphical reports and composite/dashboard like reports +* Advanced GIS module +* Importation of planning network data through boda cell file +* Useful utilities such as combining csv files to excel + + +## Planned functionality +* Network baseline generation +* Network Configuration Inconsistency reports +* Network writeback script generation for parameter changes, site comissions, cutovers, swaps and configuration automation +* Network dump comparison +* Key Performance Indicator (KPI) reports +* Cell Trace Processing +* Drive Test Post-processing +* Optimization +* Geo-reference analysis diff --git a/website/versioned_docs/version-0.3.0/utilities.md b/website/versioned_docs/version-0.3.0/utilities.md new file mode 100644 index 00000000..ffabbf65 --- /dev/null +++ b/website/versioned_docs/version-0.3.0/utilities.md @@ -0,0 +1,12 @@ +--- +id: version-0.3.0-utilities +title: Utilities +sidebar_label: Utilities +original_id: utilities +--- + + +## Combine CSV files into a excel workbook +The **CSV to Excel Combiner** utility combines a list of csv files into one excel workbook with each file on a separate worksheet. + +![GIS Module](/bts-ce-lite/img/csv_to_excel_combiner.png) diff --git a/website/versioned_docs/version-2.3.0/contributing.md b/website/versioned_docs/version-2.3.0/contributing.md new file mode 100644 index 00000000..9a1ef5ba --- /dev/null +++ b/website/versioned_docs/version-2.3.0/contributing.md @@ -0,0 +1,77 @@ +--- +id: version-2.3.0-contributing +title: Contributing +sidebar_label: Contributing +original_id: contributing +--- + +Contributions to the project can be in form of issue submissions, feature requests, writing code , and documentation + +Issues and feature requests should be submitted at the project's Github [issue page](https://github.com/bodastage/bts-ce-lite/issues). Code +submissions and documentation should be submitted through Git pull requests(PRs) + +## How to submit PRs + +### Setting up + +1. Create github account at https://www.github.com +2. Fork the https://github.com/bodastage/bts-ce-lite repository +3. Clone your forked repo locally + ```bash + git clone url_to_repo + ``` +4. Add origin repo to your remotes. This will be used to keep the master branch in sync with the original repo + ```bash + git remote add upstream url_to_original_repo + ``` +5. Create feature/patch branch + ``` + git checkout -b patch_branch + ``` +6. Make changes to file + +7. Stage the changes + ```bash + git add ./* + ``` +8. Commit the changes + ```bash + git commit -m "Fix issue ..." + ``` +9. Push feature/patch to github + ```bash + git push origin patch_branch + ``` +10. Create pull request(PR). Go to you forked repo and create PR + +### Submit another changes + +1. checkout the master branch + ``` + git checkout master + ``` +2. Pull changes from the original repo’s master to your local master. + ```bash + git fetch upstream + ``` +3. Merge changes into local master + ```bash + git merge --ff upstream/master + ``` +4. Create feature/patch branch + ```bash + git checkout -b patch_branch + ``` +5. Make changes to file and stage the changes + ``` + git add ./* + ``` +6. Commit the changes + ``` + git commit -m "Fix issue ..." + ``` +7. Push feature/patch to github + ``` + git push origin patch_branch + ``` +8. Create PR. Go to you forked repo and create PR \ No newline at end of file diff --git a/website/versioned_docs/version-2.3.0/development.md b/website/versioned_docs/version-2.3.0/development.md new file mode 100644 index 00000000..e8e17581 --- /dev/null +++ b/website/versioned_docs/version-2.3.0/development.md @@ -0,0 +1,31 @@ +--- +id: version-2.3.0-development +title: Development +sidebar_label: Development Guide +original_id: development +--- + +Boda-Lite is developed with : +* [Electron](https://electronjs.org) +* [PostgreSQL](https://postgresql.org) +* [ReactJs](https://reactjs.org/) + +## Setting up development environment +1. Download and install [nodejs](https://nodejs.org/) +2. Clone your fork of Bota-Lite Github code repository +```bash +git clone https://github.com/GIT_USER_NAME/bts-ce-lite.git +``` +3. Go to your cloned repo folder +4. Install **yarn** +```bash +npm install --global yarn +``` +4. Install dependent packages by running command below +``` +yarn install +``` +5. Launch development version +``` +yarn run electron:dev +``` \ No newline at end of file diff --git a/website/versioned_docs/version-2.3.0/gis.md b/website/versioned_docs/version-2.3.0/gis.md new file mode 100644 index 00000000..23194d8f --- /dev/null +++ b/website/versioned_docs/version-2.3.0/gis.md @@ -0,0 +1,12 @@ +--- +id: version-2.3.0-gis +title: GIS +sidebar_label: GIS +original_id: gis +--- + +This GIS module displays network entities and their properties on map. It allows filtering based on technology, name, and environment. + +Below is a screenshot of the GIS module. + +![GIS Module](/bts-ce-lite/img/gis.jpeg) \ No newline at end of file diff --git a/website/versioned_docs/version-2.3.0/index.md b/website/versioned_docs/version-2.3.0/index.md new file mode 100644 index 00000000..094a9f83 --- /dev/null +++ b/website/versioned_docs/version-2.3.0/index.md @@ -0,0 +1,20 @@ +--- +id: version-2.3.0-index +title: Contents +sidebar_label: Table of contents +original_id: index +--- + +# Boda-Lite Documentation +Boda-Lite is a multi-vendor network management desktop application. It is a minimal feature version of [BTS-CE](https://github.com/bodastage/bts-ce). + +## Contents +- [Introduction](introduction.md) +- [Installation](installation.md) +- [Parse and Import](parse_and_import.md) +- [Reports](reports.md) +- [GIS](gis.md) +- [Key Files and Folders](key_files_and_folders.md) +- [Contributing](contributing.md) +- [Development](development.md) + diff --git a/website/versioned_docs/version-2.3.0/installation.md b/website/versioned_docs/version-2.3.0/installation.md new file mode 100644 index 00000000..6d53b152 --- /dev/null +++ b/website/versioned_docs/version-2.3.0/installation.md @@ -0,0 +1,60 @@ +--- +id: version-2.3.0-installation +title: Installation +sidebar_label: Installation +original_id: installation +--- +- [System Requirements](#system-requirements) +- [Installing Boda-Lite](#installing-laravel) + +## System Requirements +The minimum requirements to run Boda-Lite are: +* 64bit operating system +* Atleast 1GB Memory +* Disk space depends on the data size +* Windows (8 and later), Linux(3.0.0 kernel and later), or Mac OSX operating system +* Java 8 +* PostgreSQL 10 + +## Installing Boda-Lite +1. Download the installer for the latest version for your OS from the Github releases [page](https://github.com/bodastage/bts-ce-lite/releases). +2. Run the installer or start the application executable for the portable versions +3. Login with the default username and passsord. The default username and password are **btsuser@bodastage.org** and **password** respectively. +4. Install PostgreSQL 10 from the [Enterprise DB Download page](https://www.enterprisedb.com/downloads/postgres-postgresql-downloads) +5. Setup the database by going to Settings > Databases and clicking *Setup Database* + +### Installer names +For installation on windows, select from: +* Boda-Lite-VERSION-win.zip +* Boda-Lite-VERSION-win.exe +* Boda-Lite-Setup-VERSION.exe + +For installation on Linux, select from: +* Boda-Lite-VERSION-x86_64.AppImage +* Boda-Lite-VERSION.x86_64.rpm +* Boda-Lite_VERSION_amd64.deb +* Boda-Lite_VERSION_amd64.snap + +For installation on Mac OSX, select from: +* Boda-Lite-VERSION.dmg + +### Installing on linux +To install the **rpm** package run command below. +``` +$ rpm -i Boda-Lite-VERSION.x86_64.rpm +``` + +To install the **.dep** package run command below. +``` +$ dpkg -i Boda-Lite_VERSION_amd64.deb +``` + +To install the **snap** package, run command below. +``` +# Install snap if not already installed +$ sudo apt update +$ sudo apt install snapd + +# Install Boda-Lite span package +$ sudo snap install Boda-Lite_VERSION_amd64.snap +``` \ No newline at end of file diff --git a/website/versioned_docs/version-2.3.0/introduction.md b/website/versioned_docs/version-2.3.0/introduction.md new file mode 100644 index 00000000..ec37b1d1 --- /dev/null +++ b/website/versioned_docs/version-2.3.0/introduction.md @@ -0,0 +1,37 @@ +--- +id: version-2.3.0-introduction +title: Introduction +sidebar_label: Introduction +original_id: introduction +--- +The tool is a minimal feature version of [BTS-CE](https://github.com/bodastage/bts-ce). Where as BTS-CE is server based and resource intensive, Boda-Lite is + intentionally light weight and designed to meet the needs of the engineer and run from their personal computers. As such, Boda-Lite is desktop based and supports Windows, Linux and Mac OSX. + +Boda-Lite is open source and licenced under the Apache 2.0 Licence; giving you the freedom to extend and enhance the tool to your needs. + The code is hosted on [github](https://github.com/bodastage/bts-ce-lite) and builds are run on [Travis-CI](https://travis-ci.org/bodastage/bts-ce-lite). + +## Quick Start +Below is a summary of the steps needed to install and start the application: +* Download the latest [release](https://github.com/bodastage/bts-ce-lite/releases/latest) for your operating system +* Install on your personal computer +* Login with username **btsuser** and password **password** +* Go to settings > Database and click **Setup Database** to run the database setup scripts + +## Features +* Support of the main telecommunication vendors: Ericsson, Huawei, Nokia, ZTE and Motorola +* Parsing and import of configuration management(CM), performance management(PM) and fault management(FM) network dumps +* Reports module that supports tabular, various graphical reports and composite/dashboard like reports +* Advanced GIS module +* Importation of planning network data + + +## Planned functionality +* Network baseline generation +* Network Configuration Inconsistency reports +* Network writeback script generation for parameter changes, site comissions, cutovers, swaps and configuration automation +* Network dump comparison +* Key Performance Indicator (KPI) reports +* Cell Trace Processing +* Drive Test Post-processing +* Optimization +* Geo-reference analysis diff --git a/website/versioned_docs/version-2.3.0/key_files_and_folders.md b/website/versioned_docs/version-2.3.0/key_files_and_folders.md new file mode 100644 index 00000000..3e511667 --- /dev/null +++ b/website/versioned_docs/version-2.3.0/key_files_and_folders.md @@ -0,0 +1,15 @@ +--- +id: version-2.3.0-key_files_and_folders +title: Key Files and Folders +sidebar_label: Key Files and Folders +original_id: key_files_and_folders +--- +There are some key files and folders such as the log file, libraries folder, and migrations files. + +Below is a list of key files and folder +1. Log file. The log file is useful when an error occurs in the application. Below are the locations for the different operation systems supported. + * on Linux: ~/.config/Boda-Lite/log.log + * on macOS: ~/Library/Logs/Boda-Lite/log.log + * on Windows: %USERPROFILE%\AppData\Roaming\Boda-Lite\log.log +2. Libraries. These include the parser jar files for the different vendor formats. + * on Windows: %USERPROFILE%\AppData\Local\Programs\Boda-Lite\resources \ No newline at end of file diff --git a/website/versioned_docs/version-2.3.0/parse_and_import.md b/website/versioned_docs/version-2.3.0/parse_and_import.md new file mode 100644 index 00000000..7336d293 --- /dev/null +++ b/website/versioned_docs/version-2.3.0/parse_and_import.md @@ -0,0 +1,144 @@ +--- +id: version-2.3.0-parse_and_import +title: Parse and Import +sidebar_label: Parse and Import +original_id: parse_and_import +--- +The **Parse and Import** module parses network dumps and optionally loads them into the database. Below is a +screenshot of the module. + +![Parse and Import](/bts-ce-lite/img/parse_and_import.png) + +The **Data type** field has three options: CM, FM, and PM. CM for configuration management files, PM for performance management files, and FM for fault management network dumps. + +The **Load into database** switch determines whether to only stop on parsing. or to load the data into the database after parsing. The **Clear tables before loading** truncatebls +the database table before loading new data. Otherwise new data is added to the table without deleting the previous one. + +## Vendor File Formats +The formats below are supported as of version 0.3.0. + +| Data type | Vendor | Format | Notes | +| ------------- |-------------| -----|-----| +| CM | ERICSSON | BULKCM | Bulk CM XML | +| CM | ERICSSON | CNAIV2 | | +| CM | ERICSSON | BSM | | +| CM | ERICSSON | EAW | | +| CM | HUAWEI | GEXPORT_XML | | +| CM | HUAWEI | NBI_XML | | +| CM | HUAWEI | CFGMML | | +| CM | HUAWEI | AUTOBAK_XML | | +| CM | ZTE | BULKCM | | +| CM | ZTE | XLS | Excel Plan Template Data Workbook | +| CM | NOKIA | RAML | RAML XML | +| CM | MOTOROLA | CELL_X_EXPORT | Cell X Export dump | +| CM | BODSTAGE | BCF_CSV | Boda Cell File in csv format | +| PM | ERICSSON | MEAS_COLLEC_XML | 3GPP TS 32.432(SA5) Performance Management Files | +| PM | HUAWEI | NE_BASED_MEAS_COLLEC_XML | NE Based Performance Management Files | +| PM | ZTE | MEAS_COLLEC_XML | 3GPP TS 32.432(SA5) Performance Management Files | +| PM | NOKIA | PM_XML | | + +## Boda Cell File (BCF) + Boda Cell File is a text file used to import network data into boda-lite. This data is loaded into the tools + plan environment. The data source could be a planning tool or any other external source. + The boda cell file can load 2G, 3G, and 4G cell parameters. + +### How to import + To import the Boda cell file data into Boda-lite +1. Go to the **Parse and Import** module +2. Select **CM** from the **Data type** select field +3. Select **BODASTAGE/BCF_CSV** from the **Vendor/Format** select field +4. Select the input folder with the location of the cell files +5. Process + + ### 2G Cell Parameters + + +| Parameters | Comments | +| --- | --- | +| technology | Required. Values: **GSM** | +| ci | Required | +| cellname | Required | +| siteid | Required | +| carrier_layer | | +| azimuth | | +| electrical_tilt | | +| mechanical_tilt | | +| lac | | +| node | | +| bcch | Required | +| trx_frequencies | | +| antenna_beam | | +| latitude | Required | +| longitude | Required | +| height | | +| vendor | | +| cell_type | | +| bsic | Required | +| bcc | | +| ncc | | +| mnc | | +| mcc | | +| cgi | | +| nbr_1 | Values are neighbour cell CIs | +| nbr_n | | + +### 3G Cell Parameters + +| Parameter | Comments | +| --- | --- | +| technology | Values: **UMTS** | +| ci | Required | +| cellname | Required | +| siteid | Required | +| carrier_layer | | +| azimuth | Required | +| electrical_tilt | | +| mechanical_tilt | | +| lac | | +| rac | | +| sac | | +| node | | +| psc | Required | +| uarfcn | Required | +| antenna_beam | | +| latitude | Required | +| longitude | Required | +| height | | +| vendor | | +| cell_type | | +| mnc | | +| mcc | | +| cgi | | +| rncid | | +| nbr_1 | Values are neighbour cell CIs | +| nbr_n | | + +### 4G Cell Parameters + +| technology | Comments | +| --- | --- | +| technology | Value options are **LTE** | +| ci | Required | +| cellname | Required | +| siteid | Required | +| enodeb_id | | +| carrier_layer | | +| azimuth | | +| electrical_tilt | | +| mechanical_tilt | | +| tac | | +| node | | +| pci | Required | +| euarfcn | Required | +| bandwidth | | +| ecgi | | +| mnc | | +| mcc | | +| antenna_beam | | +| latitude | Required | +| longitude | Required | +| height | | +| vendor | | +| cell_type | | +| nbr_1 | Values are neighbour cell CIs | +| nbr_n | | \ No newline at end of file diff --git a/website/versioned_docs/version-2.3.0/reports.md b/website/versioned_docs/version-2.3.0/reports.md new file mode 100644 index 00000000..97d844a8 --- /dev/null +++ b/website/versioned_docs/version-2.3.0/reports.md @@ -0,0 +1,38 @@ +--- +id: version-2.3.0-reports +title: Reports +sidebar_label: Reports +original_id: reports +--- +This module creates tabular, graphical reports, and composite/dashboard like reports. + +To access the reports module, click the **Reports** icon on the home tab. + +![Reports Module](/bts-ce-lite/img/reports_module.png) + +The main toolbar contains the follwoing options: +* Create report +* Create composite report +* Create report category +* Reload report tree + +## Creating a report + +1. Click the create report icon. This will open the **Create report** tab +![Create report tab](/bts-ce-lite/img/create_report_tab.png) +2.Write your report query using SQL. Click the **Preview** button to see the results. +3.Select the report type and the category. +4.Click the save button and the report will show up in the report tree + +## Creating a category + +1. Click the **Create report category** icon on the reports toolbar(above the reports tree). +![Add report category dialog](/bts-ce-lite/img/add_report_category_dialog.png) +2. Add the category name and some note, the click the Save button to see the new category in the report tree. + +## In-built reports and categories + +Boda-Lite comes with default/in-buitt reports and categories. These cannot be edit or deleted. The in-build categories are **Key Parameters** and **Network Entities**. + +The key parameter category contains key cell parameters for Ericsson, Huawei, Nokia, ZTE, and Motorola. The network entities category contains a list of all +nodes, sites, cells, and relations in the network for all vendors. diff --git a/website/versioned_sidebars/version-0.3.0-sidebars.json b/website/versioned_sidebars/version-0.3.0-sidebars.json new file mode 100644 index 00000000..d824db92 --- /dev/null +++ b/website/versioned_sidebars/version-0.3.0-sidebars.json @@ -0,0 +1,17 @@ +{ + "version-0.3.0-docs": { + "Contents": [ + "version-0.3.0-index", + "version-0.3.0-introduction", + "version-0.3.0-installation", + "version-0.3.0-parse_and_import", + "version-0.3.0-reports", + "version-0.3.0-gis", + "version-0.3.0-baseline", + "version-0.3.0-utilities", + "version-0.3.0-key_files_and_folders", + "version-0.3.0-contributing", + "version-0.3.0-development" + ] + } +} diff --git a/website/versioned_sidebars/version-2.3.0-sidebars.json b/website/versioned_sidebars/version-2.3.0-sidebars.json new file mode 100644 index 00000000..02426de0 --- /dev/null +++ b/website/versioned_sidebars/version-2.3.0-sidebars.json @@ -0,0 +1,15 @@ +{ + "version-2.3.0-docs": { + "Contents": [ + "version-2.3.0-index", + "version-2.3.0-introduction", + "version-2.3.0-installation", + "version-2.3.0-parse_and_import", + "version-2.3.0-reports", + "version-2.3.0-gis", + "version-2.3.0-key_files_and_folders", + "version-2.3.0-contributing", + "version-2.3.0-development" + ] + } +} diff --git a/website/versions.json b/website/versions.json new file mode 100644 index 00000000..71250d23 --- /dev/null +++ b/website/versions.json @@ -0,0 +1,4 @@ +[ + "0.3.0", + "2.3.0" +]