| Aijana Schumann | b439e2b | 2020-09-03 20:39:00 +0200 | [diff] [blame] | 1 | .. contents:: |
| 2 | :depth: 3 |
| 3 | .. |
| 4 | |
| 5 | Network Map |
| 6 | =========== |
| 7 | |
| 8 | The ‘Network Map’ visualizes a network by showing the location of a site |
| 9 | and its connections (links) to other sites in a geographical context. |
| 10 | |
| 11 | Views |
| 12 | ----- |
| 13 | |
| 14 | The ‘Network Map’ consists of two side-by-side views: The map and the |
| 15 | details-panel. |
| 16 | |
| 17 | Map |
| 18 | ~~~ |
| 19 | |
| 20 | The geographical map visualizes sites and links of a network. Sites are |
| 21 | usually displayed as blue circles and links are shown as lines |
| 22 | connecting sites. |
| 23 | |
| 24 | If a link or site is clicked, its information is presented in the |
| 25 | details panel. If more than one site or link is clicked, or if links or |
| 26 | sites are too close together to determine which element should be |
| 27 | selected, a selection popup appears to select one of the elements. |
| 28 | |
| 29 | The map offers statistics information to visualize the number of links |
| 30 | and sites in the currently shown map area. The statistics information |
| 31 | gets updated when the map stops moving. |
| 32 | |
| 33 | Additionally, the map offers a search field. The user can enter the name |
| 34 | of a site or link. If an element was found, the map will center on the |
| 35 | given element and its information is loaded by the details panel. |
| 36 | |
| 37 | If the zoom level is bigger than 11 and the loaded sites have a type of |
| 38 | high-rise building, datacenter, factory, or street-lamp, the blue |
| 39 | circles are swapped against icons, which visualizes the type of site. |
| 40 | |
| 41 | The swapping of icons can be activated or deactivated via a switch on |
| 42 | the left-hand site of the map. The switch only becomes visible, if the |
| 43 | zoom level is bigger than 9. |
| 44 | |
| 45 | The map supports zoom levels between 0 (furthest zoomed out, the entire |
| 46 | world is visible) and 18 (most detailed). |
| 47 | |
| 48 | Whenever the map stops moving, it updates the URL with its current |
| 49 | latitude, longitude, and zoom values. If the ‘Network Map’ application |
| 50 | is opened with those URL parameters present, it will display the given |
| 51 | area. That way, the map can be bookmarked or shared and will always |
| 52 | display the same result. |
| 53 | |
| 54 | Details |
| 55 | ~~~~~~~ |
| 56 | |
| 57 | The details panel shows information specific to the selected element. |
| 58 | |
| 59 | Sites offer information about itself, such as name, address and owner, |
| 60 | and a short overview of its links and nodes data. The nodes are physical |
| 61 | network elements, comparable to the elements of the ‘connect’ |
| 62 | application, and offer an interface to other apps via buttons, such as |
| 63 | connect, configure, and fault. Currently, those buttons are disabled. By |
| 64 | clicking on a link, the given link is loaded into details. |
| 65 | |
| 66 | If a link of type ‘microwave’ is selected, the ‘calculate link’ button |
| 67 | is available, which opens the `Link |
| 68 | Calculator <../linkCalculator/README.md>`__ in a new tab or page. |
| 69 | |
| 70 | Just like the map, the details panel updates the URL if data is loaded. |
| 71 | Once again, the ‘Network Map’ application will try to load the element |
| 72 | specified in the URL, if one is present. |
| 73 | |
| 74 | Connection Error |
| 75 | ---------------- |
| 76 | |
| 77 | If no tile or network data is available, an error popup is shown. |
| 78 | |
| 79 | Load Network- and Tile-Data |
| 80 | --------------------------- |
| 81 | |
| 82 | On startup of the sdnc-web container, a topology URL for the network |
| 83 | data and a tile URL for the tiles can be specified. |
| 84 | |
| 85 | A ready-to-use topology server offering pre-defined network data is |
| 86 | available here. There is no way to import generic network data as of |
| 87 | now. |