Difference between revisions of "About YateMMI"

From YateBTS
Jump to: navigation, search
(Subscriber Management)
(YateMMI Concepts)
 
(10 intermediate revisions by 2 users not shown)
Line 1: Line 1:
'''THIS PAGE IS A DRAFT.'''
+
YateMMI is a Mobile Management Interface that allows an easy configuration/management of all Yate-based products (Core Network and Radio network equipments)
  
== An introduction to YateMMI ==
+
== YateMMI Concepts ==
  
YateMMI's purpose if that of allowing a swift and easy configuration of all the Yate-based products: YateUCN, YateHSS/HLR, SatSite and STP.
+
<p style="float:right">[[File:modules-mmi.png]]</p>
 
+
The configuration procedures are easy, without an excess of technical information.
+
YateMMI does not demand special training or a dedicated network administrator to handle the overall configuration (especially not for the standard settings).
+
 
+
YateMMI is installed on the first product you purchased or can be installed on a separate equipment, and can be accessed '''remotely''' from any part of the world.
+
It uses the JSON API of each equipment.
+
The MMI was created with the purpose of aiding operators in typical configuration scenarios.
+
For more special configuration scenarios, a dedicated extension will be provided.
+
 
+
YateMMI allows to set generic information about the network, the roaming partners settings, the interconnect settings, the equipment settings, as well as the subscriber management for YateHSS/HLR.
+
All these configurations are done though wizards (link here).
+
 
+
== Types of equipment ==
+
 
+
=== RAN ===
+
 
+
Our main RAN equipment is the '''[http://yatebts.com/sat_site.php SatSite Model 142]''', a complete 4G LTE eNodeB, containing both the radio and baseband functions.
+
It can also be configured via software to operate as a 2.5G GSM/GPRS BTS+BSC.
+
 
+
For configuring and managing the SatSite via YateMMI, refer to the following pages:
+
 
+
1. [link SatSite YateMMI LTE Configuration]
+
 
+
2. [link SatSite YateMMI GSM Configuration]
+
 
+
=== Core Network ===
+
 
+
Our main core network equipment are:
+
 
+
* '''[http://yatebts.com/yateucn.php YateUCN]''', a unified core network solution that implements the functions below in software, in a single, commodity hardware server:
+
** all the functions and protocols of the LTE EPC (MME, S-GW, P-GW, PCRF, and PCEF)
+
** all the functions and protocols of the LTE VoLTE IMS P-CSCF, I/S-CSCF, IWF, and BGW
+
** all the functions and protocols of the GSM/GPRS core network (MSC/VLR/SGSN/GGSN/GMSC)
+
* '''[http://yatebts.com/products/yatehss YateHSS/HLR]''', the subscriber server for GSM, UMTS, LTE, IMS, WiFi networks, using both Diameter and SS7 MAP for authentication
+
* YateSTP
+
 
+
== YateMMI Concepts ==
+
  
YateMMI is organized in various '''contexts''':
+
YateMMI is organized in various '''contexts''', as ''1st level menu entries'':
 
* Home
 
* Home
 
* My Network
 
* My Network
 
* Equipment
 
* Equipment
 
* Subscriber Management  
 
* Subscriber Management  
 +
* Profile Management
  
Each context has multiple '''modules''' and each of these modules can be either enabled or disabled.
+
Contexts use [https://en.wikipedia.org/wiki/Wizard_%28software%29 '''software wizards'''] (''setup assistants'') for a well-defined step-by-step configuration.
Contexts use '''wizards''' for a step-by-step configuration.
+
To find out more about each wizard's fields, read the explanations marked with the '''?''' (question mark).  
+
  
=== Equipment ===
+
Each context has multiple '''modules''', as ''2nd level menu entries''.
  
There are different wizards for each equipment type:
+
Each of these modules can be either enabled or disabled from '''Home''' (''context'') -> '''Settings''' (''module'') -> '''''Modules''''' (''submenu'')
* a wizard for YateHSS/HLR and YateUCN
+
* a different wizard for base stations
+
 
+
Each wizard was designed with the purpose of generating all the necessary SS7, Diameter and equipment-specific settings.
+
  
After setting up the equipment the administrator has to confirm if he wants the settings applied.  
+
'''To find out more about each wizard's field, read the explanations marked with the <span style="color:#0189D7">''?''</span> (question mark).'''
A chron (link) will apply the settings to the equipment and will notify the administrator if the configuration was successful or not.
+
'''If there is no explication about that specific wizard field/parameter, the <span style="color:#0189D7">''?''</span> leads you to generic explanations about that section.'''
  
 
=== My Network ===
 
=== My Network ===
Line 69: Line 27:
  
 
The administrator can start adding only one equipment, and later add more.
 
The administrator can start adding only one equipment, and later add more.
In case he wants to configure multiple equipment, YateMMI will generate pools of IP addresses, point codes, global titles and more.  
+
In case he wants to configure multiple equipments, YateMMI will generate pools of IP addresses, point codes, global titles and more.  
  
 
'''Pools''' are an essential concept used for setting up the network.  
 
'''Pools''' are an essential concept used for setting up the network.  
Line 77: Line 35:
 
* '''Pools of Global Titles''' that will be automatically associated to the network nodes if 'Automatically associate GT to equipment' is enabled.
 
* '''Pools of Global Titles''' that will be automatically associated to the network nodes if 'Automatically associate GT to equipment' is enabled.
 
* '''Pools of Pointcodes''' that will be automatically associated to the network nodes if 'Automatically associate PC to equipment' is enabled.
 
* '''Pools of Pointcodes''' that will be automatically associated to the network nodes if 'Automatically associate PC to equipment' is enabled.
* '''Pools of IP addresses''' that will be automatically associated to equipment if 'Automatically associate IP to equipment' is enabled.
 
 
The administrator has to defined the pools depending on their purpose, be it Radio Network equipment, Core Network, other networks, management or SatSite.
 
  
 
An equipment uses multiple addresses depending on the equipment type.
 
An equipment uses multiple addresses depending on the equipment type.
Line 85: Line 40:
 
Each YateUCN has a pool of IPs associated to each GTP-U tunnel.
 
Each YateUCN has a pool of IPs associated to each GTP-U tunnel.
  
If the 'Automatically associate pools to YateUCN' option is enabled then this pools are associated automatically to YateUCN.
+
<!-- The '''My Network''' context has various modules, as seen below. -->
 
+
The '''My Network''' context has various modules, as seen below.  
+
 
+
 
==== Network Settings ====
 
==== Network Settings ====
  
 
Currently, the '''Network Settings''' tab has two setup types:
 
Currently, the '''Network Settings''' tab has two setup types:
  
* Just YateHSS/HLR
+
* Just YateHSS/HLR - especially designed for MVNOs and allows adding and configuring only a YateHSS/HLR.  
* Extend a network
+
* Extending network - designed to allow adding all Core equipments to a new or an existing network.  
 
+
The first step is especially designed for MVNOs and allows adding and configuring only a YateHSS/HLR.  
+
 
+
The second setup allows adding an new equipment to the already setup network.  
+
  
 
<!-- * Configure an entire network
 
<!-- * Configure an entire network
The first setup is performed through '''pools that allow the administrator to setup an entire range of Yate-based products (multiple SatSites, YateUCNs, YateHSS/HLR(s) and YateSTP(s). -->
+
The first setup is performed through '''pools that allow the administrator to setup an entire range of Yate-based products (multiple SatSites, YateUCNs, YateHSS/HLR(s) and YateSTP(s).  
 
==== Roaming Partners ====
 
==== Roaming Partners ====
 
 
==== BTS Templates ====
 
==== BTS Templates ====
 
 
The '''BTS Templates''' included '''Rural''' and '''Urban''' templates for adding basestations and eNodeBs.  
 
The '''BTS Templates''' included '''Rural''' and '''Urban''' templates for adding basestations and eNodeBs.  
 
Each template has a number of configuration settings tabs.
 
Each template has a number of configuration settings tabs.
 +
==== Interconnect ==== -->
  
==== Interconnect ====
+
=== Equipment ===
  
=== Subscriber Management ===
+
There are different wizards for each equipment type:
 +
* a wizard for YateHSS/HLR and YateUCN
 +
* a different wizard for base stations
  
This context allows configuring SIM profiles, as well as CS, PS, IMS, EPC profiles for the subscribers' network services.  
+
Each wizard was designed with the purpose of generating all the necessary SS7, Diameter and equipment-specific settings.  
  
It's modules are:
+
After setting up the equipment the administrator has to confirm if he wants to apply changes: ''"'''You have changes to apply'''. ['''<span style="color:#0189D7">Apply</span>''']  [Review]  [Drop changes]."''
* Subscribers
+
* Profiles
+
  
'''Note:''' The OSS/BSS services are not included in YateMMI, however it allows applying development APIs for OSS/BSS integration.
+
A ''second notice'' '''"You have changes and they were marked to apply."''' will appear and a '''cron''' (a time-based job scheduler) will apply the settings to the equipment.
  
[[File:example_php.txt]]
+
The administrator will be notified if the configuration was successful or not.
  
[[File:example_js.txt]]
+
'''Note''': Some users have 'Allow web apply' activated. On these users, cron can be bypassed with '''[Push settings now]''' button that appears with ''second notice''.
  
[[File:testphp.php]]
 
  
[[File:test.php.txt]]
+
=== Subscriber Management ===
  
[[File:test2.php.txt]]
+
* Profiles module - allows configuring SIM profiles, as well as CS, PS, IMS, EPC profiles for the subscribers' network services.  
 +
 
 +
* Subscribers - allows SIMs import based on a SIM profile, and subscribers management (add/edit/delete)
 +
 +
 
 +
'''Note:''' The OSS/BSS services are not included in YateMMI, however it allows applying development APIs for OSS/BSS integration.

Latest revision as of 17:35, 29 January 2018

YateMMI is a Mobile Management Interface that allows an easy configuration/management of all Yate-based products (Core Network and Radio network equipments)

YateMMI Concepts

modules-mmi.png

YateMMI is organized in various contexts, as 1st level menu entries:

  • Home
  • My Network
  • Equipment
  • Subscriber Management
  • Profile Management

Contexts use software wizards (setup assistants) for a well-defined step-by-step configuration.

Each context has multiple modules, as 2nd level menu entries.

Each of these modules can be either enabled or disabled from Home (context) -> Settings (module) -> Modules (submenu)

To find out more about each wizard's field, read the explanations marked with the ? (question mark). If there is no explication about that specific wizard field/parameter, the ? leads you to generic explanations about that section.

My Network

This context allows the administrator to set general information about the network. All this information is necessary for the equipment he will later on add.

The administrator can start adding only one equipment, and later add more. In case he wants to configure multiple equipments, YateMMI will generate pools of IP addresses, point codes, global titles and more.

Pools are an essential concept used for setting up the network.

To setup more pieces of equipment of the same type, an administrator may use:

  • Pools of Global Titles that will be automatically associated to the network nodes if 'Automatically associate GT to equipment' is enabled.
  • Pools of Pointcodes that will be automatically associated to the network nodes if 'Automatically associate PC to equipment' is enabled.

An equipment uses multiple addresses depending on the equipment type.

Each YateUCN has a pool of IPs associated to each GTP-U tunnel.

Network Settings

Currently, the Network Settings tab has two setup types:

  • Just YateHSS/HLR - especially designed for MVNOs and allows adding and configuring only a YateHSS/HLR.
  • Extending network - designed to allow adding all Core equipments to a new or an existing network.


Equipment

There are different wizards for each equipment type:

  • a wizard for YateHSS/HLR and YateUCN
  • a different wizard for base stations

Each wizard was designed with the purpose of generating all the necessary SS7, Diameter and equipment-specific settings.

After setting up the equipment the administrator has to confirm if he wants to apply changes: "You have changes to apply. [Apply] [Review] [Drop changes]."

A second notice "You have changes and they were marked to apply." will appear and a cron (a time-based job scheduler) will apply the settings to the equipment.

The administrator will be notified if the configuration was successful or not.

Note: Some users have 'Allow web apply' activated. On these users, cron can be bypassed with [Push settings now] button that appears with second notice.


Subscriber Management

  • Profiles module - allows configuring SIM profiles, as well as CS, PS, IMS, EPC profiles for the subscribers' network services.
  • Subscribers - allows SIMs import based on a SIM profile, and subscribers management (add/edit/delete)


Note: The OSS/BSS services are not included in YateMMI, however it allows applying development APIs for OSS/BSS integration.