From 6f22019629be8bcc13595d965c7ae4440fd2a5f4 Mon Sep 17 00:00:00 2001 From: Luana Mincu Date: Fri, 10 Dec 2021 14:19:03 +0200 Subject: ELCCR-2189: user documentation for tile server maps Change-Id: I0bfcec8c04ed9a968b5a22e05de80d5411706405 --- .../doc/images/create_tileserver.png | Bin 0 -> 18018 bytes doc/book-enea-edge-getting-started/doc/submaps.xml | 584 +++++++++++++++------ 2 files changed, 420 insertions(+), 164 deletions(-) create mode 100644 doc/book-enea-edge-getting-started/doc/images/create_tileserver.png diff --git a/doc/book-enea-edge-getting-started/doc/images/create_tileserver.png b/doc/book-enea-edge-getting-started/doc/images/create_tileserver.png new file mode 100644 index 0000000..169ad81 Binary files /dev/null and b/doc/book-enea-edge-getting-started/doc/images/create_tileserver.png differ diff --git a/doc/book-enea-edge-getting-started/doc/submaps.xml b/doc/book-enea-edge-getting-started/doc/submaps.xml index bdb769e..70ed856 100644 --- a/doc/book-enea-edge-getting-started/doc/submaps.xml +++ b/doc/book-enea-edge-getting-started/doc/submaps.xml @@ -1,38 +1,43 @@ - - Submaps + + Maps - The System domain of the Enea Edge Managemement application can be - split into different submaps, used to organize the uCPE devices more - effectively. Each domain is organized like a tree, with each submap being - able to have several other submaps within it. Each device can be placed in - only one submap and the user can create virtual links between devices. +
+ Submaps - Submaps support managed and unmanaged uCPE devices. An unmanaged - device is an icon that looks like a device within the - Map (it supports links and has a similar - icon) but is not a real managed device. + The System domain of the Enea Edge Managemement application can be + split into different submaps, used to organize the uCPE devices more + effectively. Each domain is organized like a tree, with each submap being + able to have several other submaps within it. Each device can be placed in + only one submap and the user can create virtual links between + devices. -
- Submap Operations + Submaps support managed and unmanaged uCPE devices. An unmanaged + device is an icon that looks like a device within the Map (it supports links and has a similar icon) but + is not a real managed device. - In the System view, right-clicking - on a submap opens up a menu with the following operations: +
+ Submap Operations - - - Add Submap + In the System view, + right-clicking on a submap opens up a menu with the following + operations: - This option is used for adding a new submap, placed in the - System view under the current one in - the tree. The new submap will also be added in the Map view of the parent submap. + + + Add Submap - When selecting this option, the following fields need to be set - in the Add Submap window that - pops-up: + This option is used for adding a new submap, placed in the + System view under the current one + in the tree. The new submap will also be added in the Map view of the parent submap. - + When selecting this option, the following fields need to be + set in the Add Submap window that + pops up: + +
Submap properties @@ -118,84 +123,86 @@
- - Snap to Grid, Direction - and Sort Method have the System - Default option. This option can be set by accessing - System, selecting Configuration under the Properties tab, and navigating to the GUI tab. - - More images for backgrounds and icons can be uploaded by - accessing System, selecting - Media Files under the Icons tab or the Backgrounds tab, respectively. - - - - - Remove Submap - - This option is used for removing the current submap. The submap - must be empty, all children submaps or uCPE Devices must be deleted first. - - - - Properties - - This option is used for viewing and/or editing the properties of - the current submap. For more details please see the Submap properties table. - - - - Move Device - - This option is used for adding devices to the current submap. - All devices appear in this list (placed and unplaced). If the device - is already added to a submap, it will be moved from that submap to the - current one. - - -
- -
- Map Operations - - Right-clicking anywhere in the Map - view opens up a menu with the following operations: - - - - Place Device - - This option is used for adding one or more devices in the - current submap. Only unplaced devices appear in this list. - - - - Move Device - - This option is used for moving one or more devices from other - submaps to the current submap. All devices appear in this list (placed - and unplaced). If the device is already added to a submap, it will be - removed from that submap. - - - - Add Unmanaged - - This option is used for creating an unmanaged device. An - unmanaged device is represented by an icon in the current view that - looks like a device (it supports links and has a similar icon) but - is not a real managed device. It will be automatically placed in the current - submap. When selecting this option, the following fields need to be - set in the Add Unmanaged window that - pops-up: - - + + Snap to Grid, + Direction and Sort Method + have the System Default option. This option can + be set by accessing System, + selecting Configuration under the + Properties tab, and navigating to + the GUI tab. + + More images for backgrounds and icons can be uploaded by + accessing System, selecting + Media Files under the Icons tab or the Backgrounds tab, respectively. + + + + + Remove Submap + + This option is used for removing the current submap. The + submap must be empty, all children submaps or uCPE Devices must be + deleted first. + + + + Properties + + This option is used for viewing and/or editing the properties + of the current submap. For more details please see the Submap properties table. + + + + Move Device + + This option is used for adding devices to the current submap. + All devices appear in this list (placed and unplaced). If the device + is already added to a submap, it will be moved from that submap to + the current one. + + + + +
+ Map Operations + + Right-clicking anywhere in the Map view opens up a menu with the following + operations: + + + + Place Device + + This option is used for adding one or more devices in the + current submap. Only unplaced devices appear in this list. + + + + Move Device + + This option is used for moving one or more devices from other + submaps to the current submap. All devices appear in this list + (placed and unplaced). If the device is already added to a submap, + it will be removed from that submap. + + + + Add Unmanaged + + This option is used for creating an unmanaged device. An + unmanaged device is represented by an icon in the current view that + looks like a device (it supports links and has a similar icon) but + is not a real managed device. It will be automatically placed in the + current submap. When selecting this option, the following fields + need to be set in the Add Unmanaged + window that pops up: + +
Unmanaged device properties @@ -232,18 +239,18 @@
- + - - Add Link + + Add Link - This option is used for creating a virtual link between two - devices. They can be any two devices, it does not matter if they are - unplaced, placed in the current submap or placed in any other submap. - When selecting this option, the following fields need to be set in the - Add Link window: + This option is used for creating a virtual link between two + devices. They can be any two devices, it does not matter if they are + unplaced, placed in the current submap or placed in any other + submap. When selecting this option, the following fields need to be + set in the Add Link window: - + Link properties @@ -274,71 +281,320 @@ - + + + + Properties + + This option is used for viewing and/or editing the properties + of the current submap. For more details please see the Submap properties table. + + + + Arrange icons + + This option can be used to auto-arrange devices placed in the + current submap. The rearrangement is done based on the submap's + properties. + + +
+ +
+ Device Operations + + In the Map view, right-clicking + on a device opens up a menu with the following operations: + + + + Links.. + + This option is used for viewing all links to and from that + device. + + + + Remove + + For managed devices, this option is used for removing the + device from the map. The managed device will not be removed + completely from the Enea Edge Management application, but will be + moved to the Unplaced submap + instead. + + For unmanaged devices, this option removes the device + altogether from the Enea Edge Management application. + + + + Add Link + + This option is used for creating a virtual link between two + devices. They can be any two devices, it does not matter if they are + unplaced, placed in the current submap or placed in any other + submap. The current device is already selected as the From endpoint in the Add Link pop-up. For more details please see + the Link properties table. + + + + Properties + + This option is used for viewing and editing the properties of + an unmanaged device. For more details please see the Unmanaged device properties + table. + + +
+
- - Properties +
+ Tile Server Map - This option is used for viewing and/or editing the properties of - the current submap. For more details please see the Submap properties table. - + The Enea Edge Management application has the capacity to render a map from a tile + server. Each uCPE device can have a set location and will be automatically + placed on the tile server map at its exact location. - - Arrange icons +
+ Tile Server Configuration - This option can be used to auto-arrange devices placed in the - current submap. The rearrangement is done based on the submap's - properties. - - -
+ To configure the tile server map, perform the following steps in + the Enea Edge Management application: + + + + Access the System menu and + select Configuration. A new window + will open. + -
- Device Operations + + In the System Configuration + window, under the Properties tab, + navigate to the GUI tab. + - In the Map view, right-clicking on - a device opens up a menu with the following operations: + + Under the Tile Server + category, the user can set the following properties: - - - Links... + + Tile Server properties - This option is used for viewing all links to and from that - device. - + + + + Name - - Remove + The name of the domain map. This is + mandatory. + - For managed devices, this option is used for removing the device - from the map. The managed device will not be removed completely from - the Enea Edge Management application, but will be moved to the Unplaced submap instead. + + Tile server URL - For unmanaged devices, this option removes the device altogether - from the Enea Edge Management application. - + The URL of the tile server's XYZ. + - - Add Link + + TileJSON URL - This option is used for creating a virtual link between two - devices. They can be any two devices, it does not matter if they are - unplaced, placed in the current submap or placed in any other submap. - The current device is already selected as the From endpoint in the Add - Link pop-up. For more details please see the Link properties table. - + The URL of the TileJSON configuration file. Leave it + blank if the tile server used does not support json + configuration files. + - - Properties + + Tile server attribution - This option is used for viewing and editing the properties of an - unmanaged device. For more details please see the Unmanaged device properties table. - - + The attribution to be displayed on the map. + + + +
+ + + + Press the Apply button. The + Saved successfully message will be + shown. + + + + + The Browser Cross-Origin Resource Sharing (CORS) policy prevents + requests from HTTPS to an external HTTP. This means that if the default + HTTPS configuration is used for the Enea Edge Management application, + the application will not be able to reach a tile server that is + accessible only through HTTP. In this case a proxy can be installed that + provides a gateway for HTTPS calls to HTTP. Optionally, HTTP web access + can be used for accessing the Enea Edge Management application. + +
+ +
+ Creating the Tile Server View + + To create a tile server view, perform the following steps in the + Enea Edge Management application: + + + + Access the Security menu and + select Configuration. A new window + will open. + + + + In the Security Configuration + window, navigate to the Views tab. + The Views Table will be + shown. + + + + Press the Add button. A new + window will open. + + + + In the Create View window, + set a name for the TileServer view, select tileserver + in the Map Type drop-down menu and place the + admin user in the right-hand side listbox. + + + + Press the OK button. The + current window will close and the success message Created successfully will be shown. + + + + A new entry will be added in the Views + Table. + +
+ Create a tile server view + + + + + + +
+ + In the main window, select the newly created tile server view in + the View drop-down menu. Upon a correct + configuration, the map will be loaded. +
+ +
+ Setting uCPE Device Location + + To set the location of a managed uCPE device, perform the + following steps: + + + + Access the Device menu and + select Manage. A new window will + open. + + + + In the Manage Devices window, + navigate to the Devices tab. The + Managed Devices Table will be + shown. + + + + Select de desired uCPE device. The device's properties will be + shown on the right side of the window. + + + + Navigate to the Location tab. + Latitude and longitude can be set here. + + + Latitude and longitude should be in the decimal degrees (DD) + format. + + + + + Press the Apply button. The + Saved successfully message will be + shown. + + The device will be automatically added on the map in the tile + server view. If the device is already added on the tile server map, + its location will be updated. + + +
+ +
+ Placing the uCPE Device on the Map + + To place a uCPE device on the map in the tile server view, perform + the following steps: + + + + Right-click on the map and choose the Place device option. A new window will + open. + + + + In the Add Device window, + select the desired device. + + + + If the Override device + location checkbox is left unchecked, the device will be placed at + the coordonates previously set in the Location tab. + + + + If the Override device + location checkbox is checked, the coordonates set on the device + previously will be ignored, and the device will be placed at the cursor's + position. + + + Checking the Override device + location checkbox does not alter the coordonates + already set for the device. + + + + + A device already placed on the map can be dragged and dropped + inside the map. Coordonates will not be changed. + + If two or more uCPE devices are too close together on the map, and + the current zoom level cannot accomodate all their icons, a cluster + will be shown. The cluster is represented by a large circle that + displays a number representing the number of devices it contains. The + color of the cluster changes according to the alarms of the devices in + the cluster. + + Once clicked, the cluster will zoom in to a degree where all + elements can be distinguished. When hovering over the cluster, a window + with information about the cluster will be available. It will contain + the number of the devices in the cluster, as well as their status. The + Devices link will open a drop-down menu that contains all the devices. +
\ No newline at end of file -- cgit v1.2.3-54-g00ecf