The aim of this document is to create a functional guide to ensure the understanding of the Context Broker Healthy Leisure, so the users are able to exploit it to its fullest.
This section describes how to start using the Context Broker Healthy Leisure, once it has been deployed on a local or remote server.
Once the Context Broker Healthy Leisure has been deployed either on a local or remote server, the user will be able to access it via a web browser, as this component is a web application.
In order to access it, the user should introduce in the web browser’s search bar the URL where the Context Broker Healthy Leisure has been deployed, i.e. localhost is set by default.
Illustration 1. Context Broker Healthy Leisure's URL.
The access to all URLs has been restricted, so the first page the user will see is the sign in page. The users will have to sign in to see all the Data visualisation content. A default user has been set in order to enable the access. To access only the email and the password is needed.
Illustration 2. Sign in page.
A create new user page has been added in order to create alternative users and enable the access to different users. The new users can only be created by another user, so it will be necessary to be signed in.
This new users will have permission to access, see and edit, if possible, all the data visualisation features.
Illustration 3. Create new user page.
When the user accesses the Context Broker Healthy Leisure for the first time, the first step is to configure a Context Broker instance in order for data to start flowing. Hence, an information panel will appear giving the user the option to begin this configuration through the Configuration page.
Illustration 4. Initial configuration pop-up
With the purpose of facilitating the integration of one or multiple Context Broker instances and historical data tools, the Context Broker Healthy Leisure provides a visual and intuitive configuration panel. The user will be able to use this panel to configure the information that is desired to be visualized.
This Configuration page is divided into different sections, for the configuration of the Context Broker (including its services) or the historical data tools.
The tools to be used have been configured following the tutorials for deployment of the Context Broker Healthy Leisure.
The Add Context Broker button should be pressed to starting configuring a new Context Broker instance.
The user should introduce the desired name for that particular Context Broker instance and the URL where the data is available. Note that there may be a need to indicate the Context Broker’s port if the instance is serving in a specific one. For instance, if it is configured in a local environment and the port number is 1026, the URL should be localhost:1026.
Before proceeding, it is recommended to check the status of the Context Broker instance to ensure that the configuration provided is valid and ready to be used. This can be done by pressing the yellow checkbox next to the URL.
Illustration 5. Configuration Panel
Illustration 6. Adding a new Context Broker
If the URL introduced for the Context Broker is incorrect, the user will be informed with an unsuccesful connection message under the URL input.
Illustration 7. Incorrect Context Broker URL.
After the initial configuration of the Context Broker instance is done, the user must choose the desired entities and attributes to be displayed in the Context Broker Healthy Leisure by pressing the Choose entities and attributes button.
Illustration 8. Successful Context Broker connection.
Illustration 9. Selecting the entities and attributes.
The entities and attributes can be selected and unselected by pressing the checkbox or the name of the desired option. At least one entity must be selected, otherwise an error message will appear.
If various Context Broker instances are configured, they will appear as a group of tabs where each one can be displayed for its edition. In order to delete a Context Broker instance, the bin icon must be pressed. A confirmation message will appear asking the user to confirm the action.
Illustration 10. Context Broker List.
Illustration 11. Deleting a Context Broker.
The information of a Context Broker instance can be organized and divided in what is called Services. By using these services, the information can be encapsulated in different logical groups and their access has to be granted.
The aim of the services, which are optional, is to increase the security of the Context Broker's data. A user may have access to one service but not to the rest. Therefore, the user has the option of adding a service if necessary.
More information of services can be found here.
If the user has access to one or several services, they can be added, edited and eliminated in the Context Broker Healthy Leisure. In order to add a new service to a Context Broker instance, the The context Broker uses services checkbox must be selected. A new panel with the Services configuration will be opened where the user will be able to start configuring them.
Illustration 12. Configuring services.
The user will be able to create services by pressing the Add service button.
Illustration 13. Adding services.
The user will need to configure the name of the service and, if needed, the service path. More information about the Healthy Leisure Services. To check its availability, the Choose entities and attributes button should be pressed. If the configuration is incorrect, the user will be informed with an entities not found message under the button.
Illustration 14. Incorrect service name.
Illustration 15. Incorrect service path.
If the configuration is correct, a list of the available entities and attributes will appear, where the user will be able to select or unselect the desired ones. At least one entity must be selected, otherwise an error message will appear.
Illustration 16. Correct service name and path.
Illustration 17. Error message for no entities selected.
If various services are configured, they will appear as a group of tabs where each one can be displayed for its edition. In order to delete a service, the garbage icon must be pressed. A confirmation message will appear asking the user to confirm the action.
Illustration 18. List of services.
Illustration 19. Deleting a Service.
Once the entities and the attributes of the Context Broker instance (or one of its services) have been selected, the user will be able to select one single main attribute of the entity by pressing the star icon. This main attribute represents the data that will be statically displayed on the map next to the geo-localized sensor.
The user will only be allowed to select one main attribute per each category.
Illustration 20. Configuring main attributes
This information will be explained in the Main attributes section of this document.
Once the user has finished configuring the Context Broker instance, its services and tools, the Apply Configuration button at the top of the page must be pressed to save the overall configurations. Otherwise, the current configuration will not be effective.
Illustration 21. Saving the configuration.
The map that supports the Context Broker Healthy Leisure is the open source World map OpenStreetMap.
The Context Broker Healthy Leisure supports the use of various Context Broker instances, therefore, all of the information contained in the configured Context Broker instances is shown on the map with the real-time data they provide.
Regarding the representation of the sensors, all of them must have coordinates for their geo-location and, taking advantage of those coordinates, they can be displayed directly over the map.
When zooming out of the map, the icons will start to cluster together in a single notification, showing the number of sensors available in the area. As the user zooms in, the sensors will start to separate and appear in the exact locations.
Illustration 22. The Context Broker Healthy Leisure Map.
The user is be able to select one single main attribute for each entity from the Configuration page. If an important attribute has been configured, the visualisation of the map will include the visualisation of the selected main attribute.
The user will also be able to visualize on a side panel the list of main attributes selected for each type of sensor.
Illustration 23. Main attributes over the sensors
The Context Broker Healthy Leisure will also give the user the possibility to enable or disable the display of the main attributes and the side panel through a switch option.
Illustration 24. Main attributes disabled
The icons that appear on the map correspond to a list of categories that classifies the data in different groups depending on the type of information it gives:
Alerts: Alerts Events related to risk or warning conditions which require action taking.
Smart Environment: Domain repository for topics related with environment. Currently available Environment, Waster management and Weather.
Environment: Enable to monitor air quality and other environmental conditions for a healthier living.
Point of interest: Specific point locations that someone may find useful or interesting. For instance, weather stations, touristic landmarks, etc.
Civic issue tracking: Data models for civic issue tracking interoperable with the de-facto standard Open311.
Street lighting: Modeling street lights and all their controlling equipment towards energyefficient and effective urban illuminance.
Device: IoT devices (sensors, actuators, wearables, etc.) with their characteristics and dynamic status.
Transportation: Transportation data models for smart mobility and efficient management of municipal services.
Indicators: Key performance indicators intended to measure the success of an organization or of a particular activity in which it engages.
Waste management: Enable efficient, recycling friendly, municipal or industrial waste management using containers, litters, etc.
Parking: Real time and static parking data (on street and off street) interoperable with the EU standard DATEX II.
Weather: Weather observed, weather forecasted or warnings about potential extreme weather conditions.
Generic: For other categories not included in the FIWARE data models.
If more information about these categories is needed, the FIWARE data models can be consulted through this link.
Whenever a geo-localized sensor is selected on the map, an information panel with the sensor’s information will appear. This panel will contain the attributes that were selected while configuring the Context Broker instance along with the real time data they have available.
Illustration 25. Example of pop-up attributes.
Illustration 26. Sensor pop-up.
If the user unselects any of the attributes in the configuration of the desired Context Broker instance, they will disappear from the pop-up as seen in the information panel.
Illustration 27.Example of unselecting pop-up attributes.
Illustration 28. Same information panel without the attributes.
Illustration 29. Sensor's information panel characteristics.
Apart from showing the real-time data of the sensor, the information panel offers another funcionality: raw data overview.
The RAW data Overview consists in showing the sensor’s information in a RAW format, just as the Context Broker provides it, without being processed. This raw information will appear in a side panel.
The user will be able to copy the complete JSON by pressing on the Copy button.
Illustration 30. RAW data Overview
A new page has been added in order to see the historical data persisted from the sensors. The user can access to it using the top menu link, which will redirect to this specific page. It contains Kibana dashboards with graphs, charts and tables to display the historical data. Different dashboards has been added to separate group the info depending on the data souces.
Illustration 31. Historical data dashboard
To switch between the different dashboards, the user will use the buttons placed at the top-right of the page by clicking the proper button, which have a descriptive name.
Illustration 32. Buttons to switch between different Kibana dashboards.
The user will be able to create, edit and remove rules, that will send a notification using the alert data model when one of the set rules is met. A rule consists of defining a threshold for a specific attribute, depending on the selected service, which will send an alert for the category selected by the user.
Illustration 33. Rules page.
To create a new rule, the user will click the Add rule button and a new accordion will be created to be filled with the required fields. The rules require a name, the service where the data is taken, the attribute that will be checked, the operator and the threshold. For the alert type, the user will select the category of the rule, the subcategory, the severity and the recurrence.
Illustration 34. Creation of a new rule.
To finish the creation of the rule, the user will press the Apply rules button placed at the top center of the page.
If various services are configured, they will appear as a group of tabs where each one can be displayed for its edition.
Illustration 35. Editing a rule .
To save the changes in the rule, the user will press the Apply rules button placed at the top center of the page, as it is done in the creation of a new rule.
In order to delete a service, the garbage icon must be pressed. A confirmation message will appear asking the user to confirm the action.
Illustration 36. List of the rules.
Illustration 37. Deleting a rule confirmation.
A search bar is available to localize cities on the map in a faster way. The user will have to introduce the name of the city they wish to see and, after selecting one of the results, the map will automatically change its focus to the city.
Illustration 38. Using the search bar.
To see the alerts launched with the created rules, a Kibana dashboard has been created and included to a data visualisation page in order to show all the alerts. To access the notifications panel, the user will click on Notifications button, placed at the right top menu.
Illustration 39. Button to see notifications panel.
Once the user is in the page, a Kibana dashboard is used to display the diferent alerts launched. Not only as a raw data but also including different charts, graphs and tables that will show the users relevant information about the alerts.
Illustration 40. Notifications panel used to see the alerts.
The user will be able to add dynamic filters to hide or show certain sensors on the map in case they want to focus in a specific aspect of any of the attributes. For instance, if there is a need to localize the higher priority risk alerts in order to take actions faster.
There is an available filter to filter by layers, based on checking or unchecking entities/attributes to be displayed and a Center map button, which allows the user to center the map in case of moving thorugh the map too far from the pointers.
Illustration 41. Filtering Option and center map button.
This option is available by clicking the Layers button. Its objective is to show/hide types of sensors on the map by selecting/unselecting, respectively, the checkboxes next to the desired variables.
Illustration 42. Selecting entities and attributes.
This configuration is not stored, so it will be discarded after closing the Context Broker Healthy Leisure.