Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Section
Column
width400px

Introduction

TODO Location StructureThis section will describe all the elements that can be managed and changed for the same organization. Only the Organization Administrator can do this. These include;

  • Sites information management
  • Location structure (tree) management
  • User management
  • API activation
Column
width400px
Panel
borderColorlightgrey
bgColor#f0f0f0
titleOn this page:

Table of Contents

...

  • General: In this tab the following information can be changed:
    • Enabled: The enabled status. If disabled the site will be hidden. It is the previous step to deletion.
    • Name: The site name that will be shown on the system. 
    • Prod/Dev: The type of site, which can be PRODUCTIVE or TEST
    • The Address, for information purpose only
    • The coordinates of the site, that will be used on the dashboard map.
    • The last known IP of the site is shown, but cannot be changed.
  • Floor Plan: In this tab a floor plan can be selected an uploaded. It has to be an image (jpg/png)
  • Gateways: In this tab is where the site template and system config template is assigned to a site. They can be selected from a drop down menu that shows all the available templates for the organization. It also shows the information about the platform used, the serial configured and the software versions.
  • Views: Shows a list of all the views that can be used for this site, with a direct link to them.
    Image RemovedImage Added
  • Remote Calls: If the site has any configured remote call (on the System template) it will be shown here.
Info

To make any change permanent always press Save before leaving the page.

Deleting a site

To delete a site do the following:

  1. Go to Organization → Locations.
    Image Added
  2. Click Edit on the location to be deleted.
    Image Added
  3. Uncheck the Enabled check box.
    Image Added
  4. A Delete button will appear. Click it.
    Image Added
  5. Confirm that the site can be deleted.
    Image Added
Info

If only the Enabled checkbox is unchecked, the site will still be on the system, but it will not be shown nor it will be processing more incoming data. To show it on the locations page, just uncheck the Enabled button on the list.

Image Added


User Management

...

  • Personal, where the user personal data,such as phone, name, id, etc. is set.  For a new user a password has to be set. For existing users the password can be changed using the "Reset Password" option. Here the users can be deleted with the Delete button. They can also be deactivated, which means that the user will still be in the system but without being able to access the system.


  • Notifications, where the user specific notifications settings are configured (see Notifications)
    Image RemovedImage Added
  • Settings, where the user can language can be selected, enable/disable the sounds and popup notifications, and the timeout. To disable the timeout set it to -1.

    Warning

    Setting the timeout -1 means that the session will never be closed by the system. If a user closes it's browser and opens it again, the session will still be open and the system accessible with the last user privileges. This can be a security risk under certain scenarios.


    Image RemovedImage Added

  • Access & Services, to set certain additional privileges to the users, such as Gateway (the username can be used in the gateways for connection) or API (the username can be used by third party software to access the external API)

...

Location Structure Edition

The locations tree structure shows all the locations in a predefined structure. This has to be defined by the administrator.  The can be as many location trees as wanted. The user can choose which to use by selecting it:

Image Added

To open the tree click the tree button left of the search box;

Image Added

To create, delete and manage the Location Structure, go to Organization → Location Structure

Image Added

Creating a new Location Tree

  1. A new tree can be added clicking the +Add button. A tree will be created will the date as name.
    Image Added
  2. Click on the name (in blue) to edit it and change it.
    Image Added
  3. Once changed click Save.


Editing the Location Tree

The Location Tree has a hierarchical structure of up to 5 levels: Country, Region 1, Region 2, City and Location. It needs to have at least two levels: The Location and an upper lever.

To add the upper levels, click +Add Structure Element. It will show all the options:

Image Added

A new level can also be created using the + button on an existing element. The new one will be placed under it if it is of a lower level. The new element can be then edited. The name will be empty, but can be changed just by clicking on it. 

Image Added

For each element the following can be done:

  • Move the item around using Drag And Drop, dragging from the left end of the item Image Added
  • Expand or Contract the lower levels Image Added
  • Select the country flag (only for countries). Use the two letter country code (ISO 3166-1 alpha-2). After putting the two letter code and saving the proper flag will be shown.
    Image Added
  • Change the item name. Can be edited by clicking on it.
  • Change the element level.
    Image Added
  • Add a new element.
    Image Added
  • Delete the current element Image Added


Once the upper levels are in place, the locations can be placed in under the right element. To do that just drag and drop the location to the correct place. Drag by the Image Addedsymbol at the left end of the location.

Image Added

Warning

Remember to click the Save button before leaving the page to make all changes permanent.


External API

In this page is the external API to connect to third party software is enabled. Just select the parts of the API that need to be enabled. They will be activated immediately and the options saved. 

...