Skip to content

Commit

Permalink
wip
Browse files Browse the repository at this point in the history
  • Loading branch information
kcech committed Nov 10, 2020
1 parent 1ae312e commit c9a84d1
Show file tree
Hide file tree
Showing 2 changed files with 78 additions and 62 deletions.
138 changes: 77 additions & 61 deletions docs/catalog_and_maps/administration_console.rst
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,72 @@ will result in:

|Changing_map_color.png|


Users
~~~~~

The "Users" section is for managing users of the catalog application. It’s possible to
A catalog user can be one of these three roles:

- **Admin**: role for administration purposes.
- **Platform**: platform role for internal use.
- **User**: visualisation role, they could access to the administration
console and read all the data, but they haven’t permission for
changing anything, except own contact details and password.

|users_170_001.jpg|

.. note::

A non-admin account will only see a menu "User" with his/her own details. A User role cannot see list other users.

**User properties editable by administrator**

+-----------------------+-----------------------+-----------------------+
| Id | Name | Description |
+=======================+=======================+=======================+
| Id | User identifier | After its creation |
| | | can't be modified |
+-----------------------+-----------------------+-----------------------+
| Password | Password | Admin user can |
| | | rewrite user's |
| | | password |
+-----------------------+-----------------------+-----------------------+
| Repeat | Password check | |
+-----------------------+-----------------------+-----------------------+
| Name | User name | |
+-----------------------+-----------------------+-----------------------+
| Description | Description | |
+-----------------------+-----------------------+-----------------------+
| Creation date | Creation date | Automatically |
| | | generated |
+-----------------------+-----------------------+-----------------------+
| Update date | Last update date | Automatically |
| | | generated |
+-----------------------+-----------------------+-----------------------+
| E-Mail | User e-mail | |
+-----------------------+-----------------------+-----------------------+
| Active | Checkbox for removing | |
| | access | |
+-----------------------+-----------------------+-----------------------+
| Role | Related role | Value list |
+-----------------------+-----------------------+-----------------------+


.. _users-edit-a-user:

Edit a User
^^^^^^^^^^^

|users_170_002.jpg|


.. note::

A password has to have 8-10 characters, and have at least 1 uppercase, 1 lowercase and 1 digit.



Applications
~~~~~~~~~~~~

Expand Down Expand Up @@ -530,21 +596,21 @@ Within the context of Sentilo, components have a special meaning: they
are not linked to the API REST (except for the
`catalog <./api_docs/services/catalog/catalog.html>`__ service), i.e.,
components are not required to publish or read data. We use components
into Catalog to group together sensors sharing a set of properties (such
as location, provider, power, connectivity, … ).
in Catalog to group together sensors sharing a set of properties, such
as location, provider, power or connectivity.

You could think of them as physical devices with a set of sensors, like
a weather station or a microcontroller, with multiple sensors connected.
But not neccesarily a component needs to have sensors physically
But not necessarily a component needs to have sensors physically
connected to it. A gateway could also be modeled as a component: you
could have a wireless sensor network
(`WSN <http://en.wikipedia.org/wiki/Wireless_sensor_network>`__) where
each sensor sends data to a gateway and then it sends data to Sentilo
using its Ethernet/WiFi/.. connection . In this case, the gateway will
be a *component*. And finally, if you have a sensor that connects to
also be a *component*. And finally, if you have a sensor that connects to
Sentilo directly then you will have a component with only one sensor.

In short: into Sentilo, a sensor always need to be related to a
In short: in Sentilo, a sensor always need to be related to a
component and providers have its sensors grouped by components, as shown
in the following picture:

Expand Down Expand Up @@ -1136,68 +1202,17 @@ provider.
To bulk-delete alerts with associated with a particular rule, just
select the item from the Alert Rule list and press Delete.

Users
~~~~~

The "Users" section is for managing users of the catalog application. It’s possible to
A catalog user can be one of these three roles:
Active Subscriptions
~~~~~~~~~~~~~~~~~~~~

- **Admin**: role for administration purposes.
- **Platform**: platform role for internal use.
- **User**: visualisation role, they could access to the administration
console and read all the data, but they haven’t permission for
changing anything, except own contact details and password.
Active Subscriptions is a handy section that gives a view of situation of the subscriptions to Sentilo.

|users_170_001.jpg|
The some system subscribes to Sentilo and then is inaccessible for a long time, this creates a unnecessary queue in the system.

.. note::

A non-admin account will only see a menu "User" with his/her own details. A User role cannot see list other users.

**User properties editable by administrator**
|active_subs_190_001.png|

+-----------------------+-----------------------+-----------------------+
| Id | Name | Description |
+=======================+=======================+=======================+
| Id | User identifier | After its creation |
| | | can't be modified |
+-----------------------+-----------------------+-----------------------+
| Password | Password | Admin user can |
| | | rewrite user's |
| | | password |
+-----------------------+-----------------------+-----------------------+
| Repeat | Password check | |
+-----------------------+-----------------------+-----------------------+
| Name | User name | |
+-----------------------+-----------------------+-----------------------+
| Description | Description | |
+-----------------------+-----------------------+-----------------------+
| Creation date | Creation date | Automatically |
| | | generated |
+-----------------------+-----------------------+-----------------------+
| Update date | Last update date | Automatically |
| | | generated |
+-----------------------+-----------------------+-----------------------+
| E-Mail | User e-mail | |
+-----------------------+-----------------------+-----------------------+
| Active | Checkbox for removing | |
| | access | |
+-----------------------+-----------------------+-----------------------+
| Role | Related role | Value list |
+-----------------------+-----------------------+-----------------------+


.. _users-edit-a-user:

Edit a User
^^^^^^^^^^^

|users_170_002.jpg|


.. note::

A password has to have 8-10 characters, and have at least 1 uppercase, 1 lowercase and 1 digit.

Sensor types
~~~~~~~~~~~~
Expand Down Expand Up @@ -1409,3 +1424,4 @@ The agent `Metrics Monitor Agent <./integrations.html#metrics-monitor-agent>`__
.. |componenttypes_170_002.jpg| image:: ../_static/images/catalog_and_maps/componenttypes_170_002.jpg
.. |metrics_190_001.png| image:: ../_static/images/catalog_and_maps/metrics_190_001.png
.. |metrics_190_002.png| image:: ../_static/images/catalog_and_maps/metrics_190_002.png
.. |active_subs_190_001.png| image:: ../_static/images/catalog_and_maps/active_subs_190_001.png
2 changes: 1 addition & 1 deletion docs/catalog_and_maps/map_viewers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ time-series graph with the last activity of each of its sensors:
|universal_viewer_190_005.png|

You may also click the bottom-right corner icon |universal_viewer_190_006.png|
and get a page with more bigger detail. The URL of this page is shareable, i.e. it is possible to send it by email.
and get a page with bigger detail. The URL of this page is shareable, i.e. it is possible to send it by email.

|universal_viewer_190_007.png|

Expand Down

0 comments on commit c9a84d1

Please sign in to comment.