From 4c40aa2d67684b44438d4adbd7ca9a2bd6aed4a5 Mon Sep 17 00:00:00 2001 From: Luana Mincu Date: Mon, 30 Aug 2021 16:00:08 +0300 Subject: ELCCR-1267 - add documentation to Submaps Change-Id: I1833c7ecdf03e349a593f3b35274293cfbe85dbb --- doc/book-enea-edge-getting-started/doc/book.xml | 7 +- doc/book-enea-edge-getting-started/doc/submaps.xml | 344 +++++++++++++++++++++ 2 files changed, 348 insertions(+), 3 deletions(-) create mode 100644 doc/book-enea-edge-getting-started/doc/submaps.xml (limited to 'doc') diff --git a/doc/book-enea-edge-getting-started/doc/book.xml b/doc/book-enea-edge-getting-started/doc/book.xml index f317f15..e74ac85 100644 --- a/doc/book-enea-edge-getting-started/doc/book.xml +++ b/doc/book-enea-edge-getting-started/doc/book.xml @@ -1,4 +1,4 @@ - + @@ -7,8 +7,7 @@ <trademark class="registered">Enea</trademark> Edge Getting Started - Release Version Release Version @@ -37,6 +36,8 @@ + + + + Submaps + + 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 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. + +
+ Submap Operations + + In the System view, right-clicking + on a submap opens up a menu with the following operations: + + + + Add Submap + + 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 + + + + + Name + + The name of the domain map. This is + mandatory. + + + + Description + + A text description of the domain map. + + + + Background Color + + The background color of the domain map. Possible + values: white, black, blue, cyan, grey, green, magenta, + orange, pink, red, yellow. + + + + Background Image + + The background image of the domain map. + + + + Icon Image + + The icon image of the domain map. + + + + Snap to Grid + + True if a placed device should snap to the grid + automatically. + + + + X Grid (px) + + The number of pixels between placement positions in + the horizontal position in the grid. Disabled if + Snap to Grid is false. + + + + Y Grid (px) + + The number of pixels between placement positions in + the vertical position in the grid. Disabled if Snap + to Grid is false. + + + + Direction + + This value describes the direction of sorting the + items (horizontal or vertical). + + + + Sort Method + + This value describes the sorting method used when + arranging icons. Natural is [a1,a2,a11] and Alphabetical is + [a1,a11,a2]. + + + + Arrangement Wrap + + This value indicates the maximum number of items + placed before wrapping to the next row or column. + + + +
+ + + 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 + + + + + Name + + The name of the device. + + + + Description + + A text description of the device. + + + + Icon Image + + The icon image of the device. + + + + Status + + The status of the device. + + + + Status Tooltip + + The tooltip for the device status. + + + +
+ + + + 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: + + + Link properties + + + + + Name + + The name of the link. + + + + Description + + A text description of the link. + + + + From + + One of the endpoints of the link. + + + + To + + The 2nd endpoint of the link. + + + + + + + + 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. + + +
+ \ No newline at end of file -- cgit v1.2.3-54-g00ecf