summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat
-rw-r--r--doc/book-enea-edge-getting-started/doc/images/create_tileserver.pngbin0 -> 18018 bytes
-rw-r--r--doc/book-enea-edge-getting-started/doc/submaps.xml584
2 files changed, 420 insertions, 164 deletions
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
--- /dev/null
+++ b/doc/book-enea-edge-getting-started/doc/images/create_tileserver.png
Binary files 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 @@
1<?xml version="1.0" encoding="ISO-8859-1"?> 1<?xml version="1.0" encoding="ISO-8859-1"?>
2<chapter id="submaps"> 2<chapter id="maps">
3 <title>Submaps</title> 3 <title>Maps</title>
4 4
5 <para>The System domain of the Enea Edge Managemement application can be 5 <section id="submaps">
6 split into different submaps, used to organize the uCPE devices more 6 <title>Submaps</title>
7 effectively. Each domain is organized like a tree, with each submap being
8 able to have several other submaps within it. Each device can be placed in
9 only one submap and the user can create virtual links between devices.</para>
10 7
11 <para>Submaps support managed and unmanaged uCPE devices. An unmanaged 8 <para>The System domain of the Enea Edge Managemement application can be
12 device is an icon that looks like a device within the 9 split into different submaps, used to organize the uCPE devices more
13 <emphasis role="bold">Map</emphasis> (it supports links and has a similar 10 effectively. Each domain is organized like a tree, with each submap being
14 icon) but is not a real managed device.</para> 11 able to have several other submaps within it. Each device can be placed in
12 only one submap and the user can create virtual links between
13 devices.</para>
15 14
16 <section id="submap_op"> 15 <para>Submaps support managed and unmanaged uCPE devices. An unmanaged
17 <title>Submap Operations</title> 16 device is an icon that looks like a device within the <emphasis
17 role="bold">Map</emphasis> (it supports links and has a similar icon) but
18 is not a real managed device.</para>
18 19
19 <para>In the <emphasis role="bold">System</emphasis> view, right-clicking 20 <section id="submap_op">
20 on a submap opens up a menu with the following operations:</para> 21 <title>Submap Operations</title>
21 22
22 <itemizedlist> 23 <para>In the <emphasis role="bold">System</emphasis> view,
23 <listitem> 24 right-clicking on a submap opens up a menu with the following
24 <para>Add Submap</para> 25 operations:</para>
25 26
26 <para>This option is used for adding a new submap, placed in the 27 <itemizedlist>
27 <emphasis role="bold">System</emphasis> view under the current one in 28 <listitem>
28 the tree. The new submap will also be added in the <emphasis 29 <para>Add Submap</para>
29 role="bold">Map</emphasis> view of the parent submap.</para>
30 30
31 <para>When selecting this option, the following fields need to be set 31 <para>This option is used for adding a new submap, placed in the
32 in the <emphasis role="bold">Add Submap</emphasis> window that 32 <emphasis role="bold">System</emphasis> view under the current one
33 pops-up:</para> 33 in the tree. The new submap will also be added in the <emphasis
34 role="bold">Map</emphasis> view of the parent submap.</para>
34 35
35 <table id="submap_props"> 36 <para>When selecting this option, the following fields need to be
37 set in the <emphasis role="bold">Add Submap</emphasis> window that
38 pops up:</para>
39
40 <table id="submap_props">
36 <title>Submap properties</title> 41 <title>Submap properties</title>
37 42
38 <tgroup cols="2"> 43 <tgroup cols="2">
@@ -118,84 +123,86 @@
118 </tgroup> 123 </tgroup>
119 </table> 124 </table>
120 125
121 <note> 126 <note>
122 <para><literal>Snap to Grid</literal>, <literal>Direction</literal> 127 <para><literal>Snap to Grid</literal>,
123 and <literal>Sort Method</literal> have the <literal>System 128 <literal>Direction</literal> and <literal>Sort Method</literal>
124 Default</literal> option. This option can be set by accessing 129 have the <literal>System Default</literal> option. This option can
125 <emphasis role="bold">System</emphasis>, selecting <emphasis 130 be set by accessing <emphasis role="bold">System</emphasis>,
126 role="bold">Configuration</emphasis> under the <emphasis 131 selecting <emphasis role="bold">Configuration</emphasis> under the
127 role="bold">Properties</emphasis> tab, and navigating to the <emphasis 132 <emphasis role="bold">Properties</emphasis> tab, and navigating to
128 role="bold">GUI</emphasis> tab.</para> 133 the <emphasis role="bold">GUI</emphasis> tab.</para>
129 134
130 <para>More images for backgrounds and icons can be uploaded by 135 <para>More images for backgrounds and icons can be uploaded by
131 accessing <emphasis role="bold">System</emphasis>, selecting 136 accessing <emphasis role="bold">System</emphasis>, selecting
132 <emphasis role="bold">Media Files</emphasis> under the <emphasis 137 <emphasis role="bold">Media Files</emphasis> under the <emphasis
133 role="bold">Icons</emphasis> tab or the <emphasis 138 role="bold">Icons</emphasis> tab or the <emphasis
134 role="bold">Backgrounds</emphasis> tab, respectively.</para> 139 role="bold">Backgrounds</emphasis> tab, respectively.</para>
135 </note> 140 </note>
136 </listitem> 141 </listitem>
137 142
138 <listitem> 143 <listitem>
139 <para>Remove Submap</para> 144 <para>Remove Submap</para>
140 145
141 <para>This option is used for removing the current submap. The submap 146 <para>This option is used for removing the current submap. The
142 must be empty, all children submaps or uCPE Devices must be deleted first.</para> 147 submap must be empty, all children submaps or uCPE Devices must be
143 </listitem> 148 deleted first.</para>
144 149 </listitem>
145 <listitem> 150
146 <para>Properties</para> 151 <listitem>
147 152 <para>Properties</para>
148 <para>This option is used for viewing and/or editing the properties of 153
149 the current submap. For more details please see the <link 154 <para>This option is used for viewing and/or editing the properties
150 linkend="submap_props">Submap properties</link> table.</para> 155 of the current submap. For more details please see the <link
151 </listitem> 156 linkend="submap_props">Submap properties</link> table.</para>
152 157 </listitem>
153 <listitem> 158
154 <para>Move Device</para> 159 <listitem>
155 160 <para>Move Device</para>
156 <para>This option is used for adding devices to the current submap. 161
157 All devices appear in this list (placed and unplaced). If the device 162 <para>This option is used for adding devices to the current submap.
158 is already added to a submap, it will be moved from that submap to the 163 All devices appear in this list (placed and unplaced). If the device
159 current one.</para> 164 is already added to a submap, it will be moved from that submap to
160 </listitem> 165 the current one.</para>
161 </itemizedlist> 166 </listitem>
162 </section> 167 </itemizedlist>
163 168 </section>
164 <section id="map_op"> 169
165 <title>Map Operations</title> 170 <section id="map_op">
166 171 <title>Map Operations</title>
167 <para>Right-clicking anywhere in the <emphasis role="bold">Map</emphasis> 172
168 view opens up a menu with the following operations:</para> 173 <para>Right-clicking anywhere in the <emphasis
169 174 role="bold">Map</emphasis> view opens up a menu with the following
170 <itemizedlist> 175 operations:</para>
171 <listitem> 176
172 <para>Place Device</para> 177 <itemizedlist>
173 178 <listitem>
174 <para>This option is used for adding one or more devices in the 179 <para>Place Device</para>
175 current submap. Only unplaced devices appear in this list.</para> 180
176 </listitem> 181 <para>This option is used for adding one or more devices in the
177 182 current submap. Only unplaced devices appear in this list.</para>
178 <listitem> 183 </listitem>
179 <para>Move Device</para> 184
180 185 <listitem>
181 <para>This option is used for moving one or more devices from other 186 <para>Move Device</para>
182 submaps to the current submap. All devices appear in this list (placed 187
183 and unplaced). If the device is already added to a submap, it will be 188 <para>This option is used for moving one or more devices from other
184 removed from that submap.</para> 189 submaps to the current submap. All devices appear in this list
185 </listitem> 190 (placed and unplaced). If the device is already added to a submap,
186 191 it will be removed from that submap.</para>
187 <listitem> 192 </listitem>
188 <para>Add Unmanaged</para> 193
189 194 <listitem>
190 <para>This option is used for creating an unmanaged device. An 195 <para>Add Unmanaged</para>
191 unmanaged device is represented by an icon in the current view that 196
192 looks like a device (it supports links and has a similar icon) but 197 <para>This option is used for creating an unmanaged device. An
193 is not a real managed device. It will be automatically placed in the current 198 unmanaged device is represented by an icon in the current view that
194 submap. When selecting this option, the following fields need to be 199 looks like a device (it supports links and has a similar icon) but
195 set in the <emphasis role="bold">Add Unmanaged</emphasis> window that 200 is not a real managed device. It will be automatically placed in the
196 pops-up:</para> 201 current submap. When selecting this option, the following fields
197 202 need to be set in the <emphasis role="bold">Add Unmanaged</emphasis>
198 <table id="unmanaged_props"> 203 window that pops up:</para>
204
205 <table id="unmanaged_props">
199 <title>Unmanaged device properties</title> 206 <title>Unmanaged device properties</title>
200 207
201 <tgroup cols="2"> 208 <tgroup cols="2">
@@ -232,18 +239,18 @@
232 </tbody> 239 </tbody>
233 </tgroup> 240 </tgroup>
234 </table> 241 </table>
235 </listitem> 242 </listitem>
236 243
237 <listitem> 244 <listitem>
238 <para>Add Link</para> 245 <para>Add Link</para>
239 246
240 <para>This option is used for creating a virtual link between two 247 <para>This option is used for creating a virtual link between two
241 devices. They can be any two devices, it does not matter if they are 248 devices. They can be any two devices, it does not matter if they are
242 unplaced, placed in the current submap or placed in any other submap. 249 unplaced, placed in the current submap or placed in any other
243 When selecting this option, the following fields need to be set in the 250 submap. When selecting this option, the following fields need to be
244 <emphasis role="bold">Add Link</emphasis> window:</para> 251 set in the <emphasis role="bold">Add Link</emphasis> window:</para>
245 252
246 <table id="link_props"> 253 <table id="link_props">
247 <title>Link properties</title> 254 <title>Link properties</title>
248 255
249 <tgroup cols="2"> 256 <tgroup cols="2">
@@ -274,71 +281,320 @@
274 </tbody> 281 </tbody>
275 </tgroup> 282 </tgroup>
276 </table> 283 </table>
277 </listitem> 284 </listitem>
285
286 <listitem>
287 <para>Properties</para>
288
289 <para>This option is used for viewing and/or editing the properties
290 of the current submap. For more details please see the <link
291 linkend="submap_props">Submap properties</link> table.</para>
292 </listitem>
293
294 <listitem>
295 <para>Arrange icons</para>
296
297 <para>This option can be used to auto-arrange devices placed in the
298 current submap. The rearrangement is done based on the submap's
299 properties.</para>
300 </listitem>
301 </itemizedlist>
302 </section>
303
304 <section id="device_op">
305 <title>Device Operations</title>
306
307 <para>In the <emphasis role="bold">Map</emphasis> view, right-clicking
308 on a device opens up a menu with the following operations:</para>
309
310 <itemizedlist>
311 <listitem>
312 <para>Links..</para>
313
314 <para>This option is used for viewing all links to and from that
315 device.</para>
316 </listitem>
317
318 <listitem>
319 <para>Remove</para>
320
321 <para>For managed devices, this option is used for removing the
322 device from the map. The managed device will not be removed
323 completely from the Enea Edge Management application, but will be
324 moved to the <emphasis role="bold">Unplaced</emphasis> submap
325 instead.</para>
326
327 <para>For unmanaged devices, this option removes the device
328 altogether from the Enea Edge Management application.</para>
329 </listitem>
330
331 <listitem>
332 <para>Add Link</para>
333
334 <para>This option is used for creating a virtual link between two
335 devices. They can be any two devices, it does not matter if they are
336 unplaced, placed in the current submap or placed in any other
337 submap. The current device is already selected as the <emphasis
338 role="bold">From</emphasis> endpoint in the <emphasis
339 role="bold">Add Link</emphasis> pop-up. For more details please see
340 the <link linkend="link_props">Link properties</link> table.</para>
341 </listitem>
342
343 <listitem>
344 <para>Properties</para>
345
346 <para>This option is used for viewing and editing the properties of
347 an unmanaged device. For more details please see the <link
348 linkend="unmanaged_props">Unmanaged device properties</link>
349 table.</para>
350 </listitem>
351 </itemizedlist>
352 </section>
353 </section>
278 354
279 <listitem> 355 <section id="tileserver">
280 <para>Properties</para> 356 <title>Tile Server Map</title>
281 357
282 <para>This option is used for viewing and/or editing the properties of 358 <para>The Enea Edge Management application has the capacity to render a map from a tile
283 the current submap. For more details please see the <link 359 server. Each uCPE device can have a set location and will be automatically
284 linkend="submap_props">Submap properties</link> table.</para> 360 placed on the tile server map at its exact location.</para>
285 </listitem>
286 361
287 <listitem> 362 <section id="tileserver_config">
288 <para>Arrange icons</para> 363 <title>Tile Server Configuration</title>
289 364
290 <para>This option can be used to auto-arrange devices placed in the 365 <para>To configure the tile server map, perform the following steps in
291 current submap. The rearrangement is done based on the submap's 366 the Enea Edge Management application:</para>
292 properties.</para> 367
293 </listitem> 368 <orderedlist>
294 </itemizedlist> 369 <listitem>
295 </section> 370 <para>Access the <emphasis role="bold">System</emphasis> menu and
371 select <emphasis role="bold">Configuration</emphasis>. A new window
372 will open.</para>
373 </listitem>
296 374
297 <section id="device_op"> 375 <listitem>
298 <title>Device Operations</title> 376 <para>In the <emphasis role="bold">System Configuration</emphasis>
377 window, under the <emphasis role="bold">Properties</emphasis> tab,
378 navigate to the <emphasis role="bold">GUI</emphasis> tab.</para>
379 </listitem>
299 380
300 <para>In the <emphasis role="bold">Map</emphasis> view, right-clicking on 381 <listitem>
301 a device opens up a menu with the following operations:</para> 382 <para>Under the <emphasis role="bold">Tile Server</emphasis>
383 category, the user can set the following properties:</para>
302 384
303 <itemizedlist> 385 <table id="submap_props">
304 <listitem> 386 <title>Tile Server properties</title>
305 <para>Links...</para>
306 387
307 <para>This option is used for viewing all links to and from that 388 <tgroup cols="2">
308 device.</para> 389 <tbody>
309 </listitem> 390 <row>
391 <entry>Name</entry>
310 392
311 <listitem> 393 <entry>The name of the domain map. This is
312 <para>Remove</para> 394 mandatory.</entry>
395 </row>
313 396
314 <para>For managed devices, this option is used for removing the device 397 <row>
315 from the map. The managed device will not be removed completely from 398 <entry>Tile server URL</entry>
316 the Enea Edge Management application, but will be moved to the <emphasis
317 role="bold">Unplaced</emphasis> submap instead.</para>
318 399
319 <para>For unmanaged devices, this option removes the device altogether 400 <entry>The URL of the tile server's XYZ.</entry>
320 from the Enea Edge Management application.</para> 401 </row>
321 </listitem>
322 402
323 <listitem> 403 <row>
324 <para>Add Link</para> 404 <entry>TileJSON URL</entry>
325 405
326 <para>This option is used for creating a virtual link between two 406 <entry>The URL of the TileJSON configuration file. Leave it
327 devices. They can be any two devices, it does not matter if they are 407 blank if the tile server used does not support json
328 unplaced, placed in the current submap or placed in any other submap. 408 configuration files.</entry>
329 The current device is already selected as the <emphasis 409 </row>
330 role="bold">From</emphasis> endpoint in the <emphasis role="bold">Add
331 Link</emphasis> pop-up. For more details please see the <link
332 linkend="link_props">Link properties</link> table.</para>
333 </listitem>
334 410
335 <listitem> 411 <row>
336 <para>Properties</para> 412 <entry>Tile server attribution</entry>
337 413
338 <para>This option is used for viewing and editing the properties of an 414 <entry>The attribution to be displayed on the map.</entry>
339 unmanaged device. For more details please see the <link 415 </row>
340 linkend="unmanaged_props">Unmanaged device properties</link> table.</para> 416 </tbody>
341 </listitem> 417 </tgroup>
342 </itemizedlist> 418 </table>
419 </listitem>
420
421 <listitem>
422 <para>Press the <emphasis role="bold">Apply</emphasis> button. The
423 <emphasis role="bold">Saved successfully</emphasis> message will be
424 shown.</para>
425 </listitem>
426 </orderedlist>
427
428 <note>
429 <para>The Browser Cross-Origin Resource Sharing (CORS) policy prevents
430 requests from HTTPS to an external HTTP. This means that if the default
431 HTTPS configuration is used for the Enea Edge Management application,
432 the application will not be able to reach a tile server that is
433 accessible only through HTTP. In this case a proxy can be installed that
434 provides a gateway for HTTPS calls to HTTP. Optionally, HTTP web access
435 can be used for accessing the Enea Edge Management application.</para>
436 </note>
437 </section>
438
439 <section id="tileserver_create">
440 <title>Creating the Tile Server View</title>
441
442 <para>To create a tile server view, perform the following steps in the
443 Enea Edge Management application:</para>
444
445 <orderedlist>
446 <listitem>
447 <para>Access the <emphasis role="bold">Security</emphasis> menu and
448 select <emphasis role="bold">Configuration</emphasis>. A new window
449 will open.</para>
450 </listitem>
451
452 <listitem>
453 <para>In the <emphasis role="bold">Security Configuration</emphasis>
454 window, navigate to the <emphasis role="bold">Views</emphasis> tab.
455 The <emphasis role="bold">Views Table</emphasis> will be
456 shown.</para>
457 </listitem>
458
459 <listitem>
460 <para>Press the <emphasis role="bold">Add</emphasis> button. A new
461 window will open.</para>
462 </listitem>
463
464 <listitem>
465 <para>In the <emphasis role="bold">Create View</emphasis> window,
466 set a name for the TileServer view, select <literal>tileserver</literal>
467 in the <emphasis role="bold">Map Type</emphasis> drop-down menu and place the
468 admin user in the right-hand side listbox.</para>
469 </listitem>
470
471 <listitem>
472 <para>Press the <emphasis role="bold">OK</emphasis> button. The
473 current window will close and the success message <emphasis
474 role="bold">Created successfully</emphasis> will be shown.</para>
475 </listitem>
476 </orderedlist>
477
478 <para>A new entry will be added in the <emphasis role="bold">Views
479 Table</emphasis>.</para>
480
481 <figure>
482 <title>Create a tile server view</title>
483
484 <mediaobject>
485 <imageobject>
486 <imagedata align="center" contentwidth="600"
487 fileref="images/create_tileserver.png" />
488 </imageobject>
489 </mediaobject>
490 </figure>
491
492 <para>In the main window, select the newly created tile server view in
493 the <emphasis role="bold">View</emphasis> drop-down menu. Upon a correct
494 configuration, the map will be loaded.</para>
495 </section>
496
497 <section id="tileserver_latlon">
498 <title>Setting uCPE Device Location</title>
499
500 <para>To set the location of a managed uCPE device, perform the
501 following steps:</para>
502
503 <orderedlist>
504 <listitem>
505 <para>Access the <emphasis role="bold">Device</emphasis> menu and
506 select <emphasis role="bold">Manage</emphasis>. A new window will
507 open.</para>
508 </listitem>
509
510 <listitem>
511 <para>In the <emphasis role="bold">Manage Devices</emphasis> window,
512 navigate to the <emphasis role="bold">Devices</emphasis> tab. The
513 <emphasis role="bold">Managed Devices Table</emphasis> will be
514 shown.</para>
515 </listitem>
516
517 <listitem>
518 <para>Select de desired uCPE device. The device's properties will be
519 shown on the right side of the window.</para>
520 </listitem>
521
522 <listitem>
523 <para>Navigate to the <emphasis role="bold">Location</emphasis> tab.
524 Latitude and longitude can be set here.</para>
525
526 <note>
527 <para>Latitude and longitude should be in the decimal degrees (DD)
528 format.</para>
529 </note>
530 </listitem>
531
532 <listitem>
533 <para>Press the <emphasis role="bold">Apply</emphasis> button. The
534 <emphasis role="bold">Saved successfully</emphasis> message will be
535 shown.</para>
536
537 <para>The device will be automatically added on the map in the tile
538 server view. If the device is already added on the tile server map,
539 its location will be updated.</para>
540 </listitem>
541 </orderedlist>
542 </section>
543
544 <section id="tileserver_map">
545 <title>Placing the uCPE Device on the Map</title>
546
547 <para>To place a uCPE device on the map in the tile server view, perform
548 the following steps:</para>
549
550 <orderedlist>
551 <listitem>
552 <para>Right-click on the map and choose the <emphasis
553 role="bold">Place device</emphasis> option. A new window will
554 open.</para>
555 </listitem>
556
557 <listitem>
558 <para>In the <emphasis role="bold">Add Device</emphasis> window,
559 select the desired device.</para>
560 </listitem>
561
562 <listitem>
563 <para>If the <emphasis role="bold">Override device
564 location</emphasis> checkbox is left unchecked, the device will be placed at
565 the coordonates previously set in the <emphasis
566 role="bold">Location</emphasis> tab.</para>
567 </listitem>
568
569 <listitem>
570 <para>If the <emphasis role="bold">Override device
571 location</emphasis> checkbox is checked, the coordonates set on the device
572 previously will be ignored, and the device will be placed at the cursor's
573 position.</para>
574
575 <note>
576 <para>Checking the <emphasis role="bold">Override device
577 location</emphasis> checkbox does not alter the coordonates
578 already set for the device.</para>
579 </note>
580 </listitem>
581 </orderedlist>
582
583 <para>A device already placed on the map can be dragged and dropped
584 inside the map. Coordonates will not be changed.</para>
585
586 <para>If two or more uCPE devices are too close together on the map, and
587 the current zoom level cannot accomodate all their icons, a cluster
588 will be shown. The cluster is represented by a large circle that
589 displays a number representing the number of devices it contains. The
590 color of the cluster changes according to the alarms of the devices in
591 the cluster.</para>
592
593 <para>Once clicked, the cluster will zoom in to a degree where all
594 elements can be distinguished. When hovering over the cluster, a window
595 with information about the cluster will be available. It will contain
596 the number of the devices in the cluster, as well as their status. The
597 Devices link will open a drop-down menu that contains all the devices.</para>
598 </section>
343 </section> 599 </section>
344</chapter> \ No newline at end of file 600</chapter> \ No newline at end of file
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2025-05-13 07:51:30 +0000