Catalog and Maps¶
Introduction¶
The Catalog is a web application that enables you to administer, rule and monitor the Sentilo platform resources and activity. On this page, you will learn how to manage and administer the Sentilo resources and how to monitor its activity.
We will begin with the monitoring and then follow with the administration section.
Sentilo monitoring¶
The Catalog allows us to display some Sentilo statistics through a set of features/pages which allow us to inspect the current platform activity and to display the components/sensors over a map.
Statistics¶
The statistic dashboard, which is accessible from the top menu bar, displays some basic use indicators, like total requests processed, number of sensors registered, current requests per second, max daily average and max average requests per second, ….. These values are automatically updated every 30 seconds.
It also shows a time-series graph which displays the platform activity (such as observations, orders and alarms) for the last 100 minutes. This graph is automatically updated every 5 minutes.
Navigate the last data chart¶
You can navigate along the dates of the graph by using the buttons located in the lower right corner of it:
- left arrow: navigate to the past (only if there are older data)
- reload data (center button): reload last data / reset chart data
- right arrow: navigate to the future (only if you have navigated or gone into the past before)
You could also monitor the current activity of each sensor from the different viewers available which are accessible from the Explore item at the top menu bar (Universal viewer and Route viewer).
Universal viewer¶
Components map¶
The catalog provides a default map, based on Google Maps, which shows all the public components registered at the platform. If the user is logged as administrator, all the private components will be displayed as well.
On this page, you can filter the components to show by selecting a component type from the top left select.
Depending on the zoom level, the map will display the elements as individuals POIs or grouped in clusters, showing the number of components in each group.
Component details¶
Sensors list¶
When you select a component, a popup window is opened above the map and displays the list of sensors related to it with the last activity for each one of them (as noted above, the private sensors will be displayed only for logged users):
Sensors last activity view¶
If you click into the content area of the popup window, a new page is open displaying some basic details about the component, and a time-series graph with the last activity of each of its sensors:
You can navigate along the dates of the graph by using the buttons located in the lower right corner of it:
- left arrow: navigate to the past (only if there are older data)
- reload data (center button): reload last data / reset chart data
- right arrow: navigate to the future (only if you have navigated or gone into the past before)
Default configuration¶
The initial map settings are configured in the file:
sentilo-catalog-web/src/main/webapp/WEB-INF/jsp/common/include_script_maps.jsp
and includes settings such as the default map center, the default zoom, ….
// the initial map center (Barcelona city)
var defaultMapCenter [ 41.4001221, 2.172839 ];
var defaultZoomLevel 14;
var defaultInputLocationZoomLevel 17;
// the maximum zoom level beyond which pois are not grouped into clusters
var defaultMaxZoomCluster 13;
// flag for control if routes must be displayed or no on the current map
var showRoutes false;
// the minimum zoom level beyond which routes are displayed
var minRouteZoomLevel 15;
// flag for control if only components that fit into bounds's map must be searched on the server
var filterByBounds true;
...
You could change these configuration parameters or customize the look and feel to meet your requirements, but instead of overwrite the existing values you could add the new values to the file:
sentilo-catalog-web/src/main/webapp/WEB-INF/jsp/common/include_script_maps_config.jsp
For example, add the following line to the include_script_maps_config file if you would change the initial map center to London:
var defaultMapCenter [ 51.4991257, -0.11325074];
When Catalog starts, properties in this file overwrites existing ones having the same name in the file include_script_maps.jsp
Displaying complex data¶
In some cases, you may want to inform complex data as an observation on Sentilo, such like a large json object. For these cases, Sentilo will detect that the text is a json object and then it will be shown to you as a prettyfied json value:
You can expand or compress the prettified json with the bottom buttons under the status field,
Route viewer¶
As the name suggest, the route viewer is a specific map that shows the routes followed by the mobile components (keep in mind that only the last 20 points are displayed for each route):
The same features described previously apply on this map and its markers (popup window, … ), but with the particularity that if you click over a route point then the popup window displays sensor activity related to the time instant in which component was at that location.
Administration console¶
The administration console is composed of several CRUDs used to maintain all the entities of the Catalog such as providers, components, sensors, users, … Only registered users can access it, so you must be logged before starting to manage the Catalog (the login access is located at the top right menu bar). Remember that, by default, the admin user has admin/1234 as access credentials.
All admin pages follow the same structure and layout for ease of use and to facilitate future maintenance. Therefore, below there is only a brief description of each admin page rather than to repeat the same things over and over in every section. In these sections will focus only on the particularities of each one.
When you select any option of the menu admin, the first page that you will see will be a list with the resources of this type already registered on the Catalog. These lists are very intuitive and extremely easy-to-use: you could filter, page and order it. You could delete an existing resource selecting the corresponding checkbox and clicking the Delete selected button; you could add new resources selecting the corresponding button and you could edit anyone clicking over the corresponding row.
When you select to add a new resource, a traditional form page is displayed. Here, you must have filled in the mandatory fields before clicking the Save button. If some mandatory field is not fiiled in or it have a no valid value, the page shows you information about what is wrong:
Otherwise, the resource will be registered into the Catalog and you will be redirect to the list page (at the top right corner you will see a confirmation message that the resource have been succesfully created):
The same applies when you try to delete a resource, but with the peculiarity that the browser will always ask for your confirmation before deleting it:
If the resource has been succesfully removed, the list is reloaded and a confirmation message is displayed at the top right corner:
Otherwise, you will see an error page with a description about what is wrong. For example, if you try to delete a component type that is associated with an existing component the response will be :
Organization¶
The organization is the entity that describes the Sentilo instance.
Detail¶
By default, this organization is created and its identifier is sentilo.
We can also edit the organization’s name other contact details, except the.
Config params¶
In addition, we can edit the visualization formats and public map settings, using the Config params tab:
There we can configure the Visual configuration and the Map configuration.
Visual configuration¶
These params will apply to the entire catalog application visual customization, and how the user will see the data. Note that time zone & date format are directly relationated.
| Property | Description | Comments |
|---|---|---|
| Time zone | Defines the time zone of the organization, and modifies the way to display data on screen, such as dates | You can define hourly difference or time zone abbreviations: CET, UTC, +001… |
| Date format | Defines the date format with which the data will be displayed in the application (lists, details…) | Example: dd/MM/yyyy HH:mm:ss = 30/11/2017 15:34:56 See all possible formats as Java Date Format, at: Java Date Format |
| Chart values number | Number of observations displayed on chart | It must be a positive integer number greater or equals to 10. If blank, it will be a default value of 10. This value will be overwritten by sensor’s configuration one. |
Map configuration¶
These params configure the universal map visualization.
| Property | Description | Comments |
|---|---|---|
| Zoom level | Zoom level of the universal map | Default value is 14. And you can define a value between 1 and 20. See possible values in: https://developers.go ogle.com/maps/documen tation/static-maps/in tro#Zoomlevels |
| Latitude / Longitude | Defines the map center in latitude & longitude values format | |
| Map background color | Define the background color of the map | Possible values applies with the colorpicker, or input a valid css / html color value |
For example, set the map background color to #ffc900:
will result in:
Applications¶
Applications are the data clients of the Sentilo platform and, by default, if you have loaded the default data, you will see two applications registered into the Catalog:
- sentilo-catalog: it is a internal application, used by the catalog to make calls to the API REST and therefore MUST NOT be removed.
- testApp: as the name suggest, this application is used for testing the platform status.
List¶
Access the Application list. This is the main Application page. From here you’ll can access to the desired application to show its details by click on it.
You’ll be able to list, filter, show application details, create (New application button) and delete selected applications (select from left checkbox, and apply by Delete selected button).
Further, you’ll be able to export the list to Excel, by clicking on Export to Excel button. The result file will contain the list columns and a number of extra ones from internal database use.
Use the button panel at the bottom right to navigate through the list (first page, previous page, page number, next page and last page, respectively).
Details tab¶
The detail page is structured into three tabs:
where:
- the Details tab contains the main properties of the application (described below).
- the Permissionstab allows to manage the permissions for other entities (applications or providers)
- the Active subscriptions tab displays a list with all the active subscriptions for the current application (from version 1.5).
The main properties of the Details tab are the following:
| Property | Description | Comments |
|---|---|---|
| Id | Application Identifier | Mandatory. After its creation it can’t be modified. It is the identifier used in the API calls. |
| Name | Display name | If not filled in by the user, its default value will be the Id. |
| Token | Access key | Automatically generated by the system when application is created. It is theidentity_key value used in the API calls. NOTE: only users with ADMIN role will show the entire token chain, other user roles only will see obfuscated text at this place (see below) |
| Description | Description | Optional. The application description text. |
| HTTPS API REST | Application accepts data over HTTPS | The Sentilo Server itself does not support SSL at the moment, however you can put a reverse proxy such as Nginx in front of the Sentilo Server. If this option is checked, the Sentilo Server expects the standard header X-Forwarded-Proto
Please note that when configuring Nginx, you should also use the parameter underscores_in_hea
ders on;
so Nginx would forward sentilo headers to the Sentilo Server. |
| Contact email | Email address of the person responsible for the application | Mandatory. |
How users that has not ADMIN role see the detail section:
Permissions tab¶
As commented before, the Permissions tab allows you to define and manage the authorization privileges that are granted to an application (such privileges are named permissions) which are required for access to the data from other entities.
There are 3 possibles permissions:
- Read: Only allows to read the data but not modify it (e.g. cannot publish orders to sensors/actuators).
- Read-Write: allows to read and write data over the resources of an entity, but not administer them (e.g.. cannot create new sensors for a provider)
- Administration: full control over an entity and its resources.
By default, the application sentilo-catalog has granted the Administration permission over all entities registered into Catalog and, as you would expect, an application has full control over itself .
For example, at the following case where the permissions of the application testApp are displayed:
We will see the following:
- The application testApp could administer the entity testApp (obviously!)
- The application testApp could read any data from the entity testApp_provider.
Active subscriptions tab¶
This tab allows you to inspect the subscriptions that an application has registered on the platform (remember that subscriptions are [created with the API REST](./api_docs/services/subscription/subscription.html)), as shown in the following picture:
Providers¶
In Sentilo, providers are those who send data, i.e. those who publish the data (in contrast to applications, which consume the data). If you have loaded the default data, you will see one default provider registered into the Catalog:
- testApp_provider: as the name suggests, this provider is used for checking platform status.
One singularity of the providers list is the Delete action: if you remove a provider, not only the provider will be deleted from the backend, but also all its related resources such as components, sensors, alerts … and any data published by its sensors, so be very careful with this command.
List¶
Access the Providers list. This is the main Provider page. From here you’ll can access to the desired provider to show its details by click on it.
You’ll be able to list, filter, show provider details, create (New provider button) and delete selected providers (select from left checkbox, and apply by Delete selected button).
Further, you’ll be able to export the list to Excel, by clicking on Export to Excel button. The result file will contain the list columns and a number of extra ones from internal database use.
Use the button panel at the bottom right to navigate through the list (first page, previous page, page number, next page and last page, respectively).
Details tab¶
The detail page of a provider is structured into five tabs:
where
- The Details tab contains the main properties of the provider (described below).
- The Sensors/Actuators tab displays a list with all sensors owned by the current provider (i.e. associated with this provider).
- The Components tab displays a list with all components owned by the current provider (from version 1.5).
- The Active subscriptions tab displays a list with all the active subscriptions for the current provider.
- The Documentation In this tab you can upload any files relevant to provider, such as a maintenance guide, etc.
The main properties of the Details tab are the following:
| Property | Description | Comments |
|---|---|---|
| Identifier | Provider identifier | Mandatory. After its creation can’t be modified. It is the identifier used in the API calls. |
| Name | Display name | If not filled in by the user, its default value will be the Id. |
| Authorization Token | Access key | Automatically generated by the system when application is created. It is the* identity_key* value used in the API calls. NOTE: only users with ADMIN role will show the entire token chain, other user roles only will see obfuscated text at this place (see below) |
| Description | Description | Optional. The provider description text. |
| HTTPS API REST | Provider sends data over HTTPS | The Sentilo Server itself does not support SSL at the moment, however you can put a reverse proxy such as Nginx in front of the Sentilo Server. If this option is checked, the Sentilo Server expects the standard header X-Forwarded-Proto
Please note that when configuring Nginx, you should also use the parameter underscores_in_hea
ders on;
so Nginx would forward sentilo headers to the Sentilo Server. |
| Contact name | Name of the person responsible for the provider | Mandatory |
| Contact email | Email address of the person responsible for the application | Mandatory. |
How users that has not ADMIN role see the detail section:
Sensors/Actuators tab¶
As mentioned before, this tab displays a list with all sensors associated with the current provider, as shown in the picture below where the sensors of the provider CINERGIA are listed:
You could filter, page and order the list but you cannot access to the sensor detail: it must be done from the sensor list administration.
Components tab¶
As explained early, this list is very similar to the previous one but with components.
Active subscriptions tab¶
The meaning of this tab is the same as described for the applications.
Documentation tab¶
In this tab you can upload any files relevant to provider (up to 4MB each). The documents in total should not surpass ~16MB, which the limit of MongoDb.
Components¶
Within the context of Sentilo, components have a special meaning: they are not linked to the API REST (except for the catalog 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, … ).
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 connected to it. A gateway could also be modeled as a component: you could have a wireless sensor network (WSN) 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 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 component and providers have its sensors grouped by components, as shown in the following picture:
List¶
One singularity of the components list page are the two buttons that allows us to change the visibility of a set of components from public to private and vice versa. These buttons apply on the selected rows.
You’ll be able to list, filter, show components details and create (New component button). Like with the providers list, the component list have a Delete button that works as follows:* if you remove a component, not only the component will be deleted from the backend, but also all its related resources will be deleted* such as sensors, alerts … and any data published by its sensors, so be very careful with this command.
Further, you’ll be able to export the list to Excel, by clicking on Export to Excel button. The result file will contain the list columns and a number of extra ones from internal database use.
Use the button panel at the bottom right to navigate through the list (first page, previous page, page number, next page and last page, respectively).
Details tab¶
The detail page of a component is structured into five tabs:
where:
- The Details tab displays the main properties of the component.
- The Technical details tab displays several categorized properties of the component.
- The Additional information tab displays custom properties of the component which are not predefined by Sentilo. See the parameter additionalInfo of the API docs
- The Related components tab shows other components linked with the current component .
- The Sensors/Actuators tab shows the sensor element located in the current component.
The main properties of the Details tab are the following:
| Property | Description | Comments |
|---|---|---|
| Name | Display name | Mandatory. After its creation can’t be modified. It is the identifier used in the API calls. |
| Type | Component type. | Mandatory. Select from a list of available types. |
| Description | Description | Optional. The component description text. |
| Provider | Component owner | Mandatory. |
| Photo | URL of the component photography | It could be defined for each component or it will be inherited using the defined one for the component type. |
| Access type | Checkbox to set the component visibility as public or private in the viewer | |
| Creation date | Creation date | Automatically generated |
| Update date | Last update date | Automatically generated |
| Tags | Related custom tags of the component | Are displayed at the public page |
| Static or Mobile | To mark the component as static or mobile | If the component is static then location is mandatory |
| Address | Address where the component is located | The address, longitude and latitude fields work together with the location list field. It’s possible to use the map to set the points adding new locations. |
| Latitude | Latitude in decimal format | |
| Longitude | Longitude in decimal format | |
| Locations List | Location/s of the component | You can configure the component as a POI, a polyline or a polygon (future feature) depending the location composition. |
Technical details tab¶
As noted above, this tab displays a set of properties related to the technical details of the component such as manufacturer, serial number, ….
where:
| Property | Description | Comments |
|---|---|---|
| Producer | Manufacturer | |
| Model | Component model | |
| Serial number | Serial number | |
| MAC | Mac address of the device | |
| Power type | Energy type used by the device | Select from a list of available values (see the API for details) |
| Connectivity type | Connection type used by the device | Select from a list of available values (see the API for details) |
Additional information tab¶
This tab displays the set of additional properties related to the component See the parameter additionalInfo of the API docs.
These fields are not categorized, i.e., here you could stored any device information which will be of interest.
For each property, it will be displayed as a label-value entry where the property’s key will be the label and the property’s value will be the value, as shown in the following picture:
where the following map, stored on the backend, has been rendered {“Comarca”:“Alt Empordà”,“Terme municipal”:“COLERA”,“Provincia”:“Girona”}
Sensors/actuators tab¶
The meaning of this tab is the same as for the providers, but restricted to the current component.
Sensors¶
These section is used for creating, updating or deleting sensors or actuators. Usually these elements are created by the provider autonomously using the API.
The sensors list page follows the same structure as described for components (you could change the public/private visibility or delete sensors massively through the list).
List¶
It is possible to full-text search the list in the “Filter” box. The filter works for all filter attributes except the creation date. The Filter field is case-sensitive. Only search by the substate’s code is possible at the moment.
You’ll be able to list, filter, show sensors details, and create (New application button) and delete selected sensors (select from left checkbox, and apply by Delete selected button).
Further, you’ll be able to export the list to Excel, by clicking on Export to Excel button. The result file will contain the list columns and a number of extra ones from internal database use.
Use the button panel at the bottom right to navigate through the list (first page, previous page, page number, next page and last page, respectively).
Details Tab¶
The detail page of a sensor is structured into four tabs:
where
- The Details tab displays the main properties of the sensor.
- The Technical details tab displays several categorized properties of the sensor.
- The Additional information tab displays the custom properties of the sensor.
- The Latest data tab shows the latests observations received from the sensor.
The main properties of the Details tab are the following:
| Property | Description | Comments |
|---|---|---|
| Sensor / Actuator | Name of the sensor/actuator. | Mandatory. After its creation can’t be modified. It is the identifier used in the API calls. |
| Provider | Sensor provider owner | Mandatory |
| Description | Description | |
| Component | Component to which the sensor belongs | Mandatory |
| Access type | Checkbox to set the sensor visibility to public or private | |
| Creation date | Creation date | Automatically generated |
| Update date | Last update date | Automatically generated |
| Type | Sensor type | Mandatory. Select from a list of available types |
| Data type | Type of data published by the sensor | Mandatory. Possible values are:
|
| Unit | Measurement unit | |
| Time zone | Time zone for the data sent by the sensor | |
| Tags | Related custom tags of the sensor | |
| State | State of the sensor | Possible values: online | offline. If the sensor is configured as offline the API will reject any data publication, the alerts will be disabled and the sensor won’t be visible in the map. Likewise, offline sensors are excluded from the /catalog GET request. Default value is online. |
| Substate | Substate of the sensor | The list of possible values that that have informational purpose and are specific for every deployment. You can customize the list of possible substate values editing the contents of table sensorSubstate in mongoDB. No default value. |
| TTL (min) | Time of expitation of the sensor in minutes | This value can be configured only from the catalog, Only admin should control this value. The default value is redis.expire.data.seconds from the platform server jedis-config.properties |
Technical details tab¶
As noted above, this tab displays a set of properties related to the technical details of the sensor ( such as the manufacturer, the model, the serial number and the power type , all of which are described in the component section) as shown in the following picture:
Visual configuration tab¶
The only configurable option in this tab is “Chart values number”. This integer indicates how many measures will be show in the observation chart of the sensor.
Additional information tab¶
The meaning of this tab is the same as for the components.
This tab displays the set of additional properties related to the component See the parameter additionalInfo of the API docs.
These fields are not categorized, i.e., here you could stored any device information which will be of interest.
For each property, it will be displayed as a label-value entry where the property’s key will be the label and the property’s value will be the value.
Latest data tab¶
This tab, as shown in the following picture:
displays both the latest observation published by the sensor and a graph with its last activity.
You can navigate along the dates of the graph by using the buttons located in the lower right corner of it:
- left arrow: navigate to the past (only if there are older data)
- reload data (center button): reload last data / reset chart data
- righth arrow: navigate to the future (only if you have navigated or gone into the past before)
Number of chart observations at chart
You can change the number of values shown in the graph. To do this, within the sensor editing tabs, go to “Visual configuration”, and there edit the value of the “Chart values number” field
You must inform a positive value number. If blank, then default value shall be applied as that has been configured in the organization visual configuration.
Showing complex data
If your sensor data type is text, and it contains a complex data in json format, Sentilo will show it as a prettified value:
in this case you will have the possibility to inspect, expand or contract the json map shown as a value using the navigation buttons:
Collapse data: the json map will be collapsed at all
Expand data: the json map will be expanded at all (default view)
Collapse to level X: insert a correct value for the X, and click the button to collapse to the specified level (default level is 0, first level)
Alerts¶
Used for managing internal or external Alerts. Usually, external Alerts are created by a third party autonomously via the API. This third party could be a provider or application. Internal Alerts can be defined from the console or using the API. Internal alerts will always be associated to a provider.
It’s also possible to delete the items massively from the alerts list.
Properties
| Id | Name | Description |
|---|---|---|
| ID | Alert identifier | After its creation can’t be modified |
| Name | Display name | |
| Description | Description | |
| Active | Indicates whether the alert is activated or not | When a sensor goes into the offline state, the associated alerts are also automatically deactivated. |
| Creation date | Creation date | Automatically generated |
| Update date | Last update date | Automatically generated |
| Type | Alert type | Internal/External |
| Provider | Related provider | For external alerts, a provider which will generate the associated alarms. For internal alerts, the related data provider. |
| Application | Related provider | Only for external alerts, application which will generate the associated alarms |
| Component | Related component | Only for internal alerts |
| Sensor | Related sensor | Only for internal alerts |
| Trigger type | Type of trigger that will be applied | Only for internal alerts. Value list, see the API for details |
| Expression | Expression to be evaluated | Only for internal alerts |
List¶
Access the Alerts list. This is the main Alert page. From here you’ll can access to the desired alert to show its details by click on it.
You’ll be able to list, filter, show alerts details, create (New alert button) and delete selected alerts (select from left checkbox, and apply by Delete selected button).
Further, you’ll be able to export the list to Excel, by clicking on Export to Excel button. The result file will contain the list columns and a number of extra ones from internal database use.
Use the button panel at the bottom right to navigate through the list (first page, previous page, page number, next page and last page, respectively).
Filtering the alerts list¶
It is possible to full-text search the list in the “filter” box. The field is case-sensitive. That means that you can search for full or partial text contained in the identifier, type, trigger or status field. If you want to search for certain trigger type, currently only searching by trigger type’s code is possible (e.g. a search for “GT” would return results in the above screen, whereas a search for “GT(40)” wouldn’t).
Alerts creation rules¶
It is possible to bulk-create alerts for a group of sensors. For example, attach a rain alert rule to all pluviometers of certain provider.
List¶
Accessing “Alert creation rules” menu option opens a list of existing Alert Rules.
You’ll be able to list, filter, show alert rules details, create (New rules button) and delete selected rules group (select from left checkbox, and apply by Delete selected button).
Further, you’ll be able to export the list to Excel, by clicking on Export to Excel button. The result file will contain the list columns and a number of extra ones from internal database use.
Use the button panel at the bottom right to navigate through the list (first page, previous page, page number, next page and last page, respectively).
Create rules¶
To create new alerts, use the “New Rules” button.
After pressing the “Confirm” button, a modal window will inform on how many alerts will be created for given combination of provider, component type and sensor type.
Subsequently, alerts are created, all having the same rule. At the moment it is not possible to bulk-create alerts without specifying the provider.
To bulk-delete alerts with associated with a particular rule, just select the item from the Alert Rule list and press Delete.
Users¶
Used for creating, updating or deleting console users. It’s possible to delete users massively through the elements list. There are three available 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.
Properties
| Id | Name | Description |
|---|---|---|
| Id | User identifier | After its creation can’t be modified |
| Password | Password | |
| Repeat | Password check | |
| Name | User name | |
| Description | Description | |
| Creation date | Creation date | Automatically generated |
| Update date | Last update date | Automatically generated |
| User e-mail | ||
| Active | Checkbox for removing access | |
| Role | Related role | Value list |
Sensor types¶
Used for creating, updating or deleting sensor types. The sensor types should be defined through the administrator console before adding elements to the catalog.
It’s possible to delete elements massively through the sensor list.
Properties
| Id | Name | Description |
|---|---|---|
| Id | Type identifier | After its creation can’t be modified |
| Name | Display name | |
| Description | Description | |
| Creation date | Creation date | Automatically generated |
| Update date | Last update date | Automatically generated |
List¶
Access the main Type of Sensors / Actuators list page, will show you a complete list of type of sensors.
You’ll be able to list, filter, show typologies details, create (New typology button) and delete selected typology (select from left checkbox, and apply by Delete selected button).
Further, you’ll be able to export the list to Excel, by clicking on Export to Excel button. The result file will contain the list columns and a number of extra ones from internal database use.
Use the button panel at the bottom right to navigate through the list (first page, previous page, page number, next page and last page, respectively).
New¶
Access to create new typology pressing New typology button. You must inform an identifier, name and description (optional) for the new typology.
Component types¶
Used for creating, updating or deleting component types. The component types should be defined through the administrator console before adding elements to the catalog.
It’s possible to delete elements massively through the component list.
Properties
| Id | Name | Description |
|---|---|---|
| Id | Type identifier | After its creation can’t be modified |
| Name | Display name | |
| Description | Description | |
| Creation date | Creation date | Automatically generated |
| Update date | Last update date | Automatically generated |
| Photo | Related photo | Generic picture for the component type, will be used if there isn’t any specified for the component itself |
| Icon | Related icon | Value list from the deployed icon list. Used in the maps for representing the component |
List¶
Access the main Component’s typology list page, will show you a complete list of available type of components.
You’ll be able to list, filter, show typology details, create (New application button) and delete selected typologies (select from left checkbox, and apply by Delete selected button).
Further, you’ll be able to export the list to Excel, by clicking on Export to Excel button. The result file will contain the list columns and a number of extra ones from internal database use.
Use the button panel at the bottom right to navigate through the list (first page, previous page, page number, next page and last page, respectively).
New¶
Access to create new typology pressing New typology button. You must inform an identifier, name, description (optional), photo (optional) and icon for the new typology.
