Ref. Ares(2018)2443566 - 08/05/2018
Political and sOcial awareness on Water EnviRonmental challenges GA N.687809
Deliverable Title D2.2 DSP HUB software - Beta release report Deliverable Lead: BASEFORM Related Work Package: WP2: DSP set-up and start-up Related Task: Task 2.2 Development of DSP HUB tier Main Author: Diogo Vitorino (Baseform) Other Authors: Sergio T. Coelho, Sergio Nunes (Baseform) Dissemination Level: Public Due Submission Date: 30.11.2016 Actual Submission: 25.09.2017 Project Number 687809 Instrument: H2020-ICT10-2015 Start Date of Project: 01.12.2015 Duration: 48 months Abstract This Report describes the purpose, functionality and usage of the Power DSP’s HUB software in its Beta release, which was made available to the project partners on 23/11/2016 at powerhub.baseform.com. It is developed under Task 2.2 of Work Package 2 - DSP set-up and start-up. The HUB backend management system allows for creating and managing content, and running the social participation and gamification functionality of a city’s or utility’s DSP, as well as capabilities to retrieve data and perform analyses that may inform content. This component of the DSP is a non- public system, accessible only to the staff in charge of the DSP and includes data integration services for integrating and exposing environmental static and dynamic data and indicators. It follows the architecture and functionalities developed in Task 2.1 and detailed in deliverable D2.1.
D2.2 DSP HUB software – Beta release report POWER 25.09.2017 687809
Project funded by the European Commission under the H2020 Programme, Call ICT10-2015 ‘Collective Awareness Platforms for Sustainability and Social
Innovation’ - Topic c) Digital Social Platforms (DSP). Versioning and Contribution History Version Date Modified by Modification reason v.00 08/11/2016 Sergio T. Coelho Draft preparation started v.01 24/11/2015 Diogo Vitorino, Sergio T. Internal team draft, final round Coelho, Sergio Nunes v.02 28/11/2016 Diogo Vitorino, Sergio T. Final draft, Baseform team Coelho, Sergio Nunes v.03 21/07/2017 Sara Mendes, Sérgio Revised version (post-M18 review), Baseform Nunes, Sérgio T. Coelho draft v.04 31/08/2017 Sérgio T. Coelho, Sérgio Updated Baseform draft incorporating comments Nunes by Jasminko Novak, Mathias Becker, Carl Holland, Daniel Coles, Alex Cameron v.05 09/09/2017 Sérgio Nunes Review and consistency check vs. ongoing software developments v.06 25/09/2017 Sérgio T Coelho, Sérgio Final version before resubmission. Nunes
Page 2 of 53
D2.2 DSP HUB software – Beta release report POWER 25.09.2017 687809
Table of Contents
1 Introduction ...... 9 2 Software design ...... 11 2.1 Overview ...... 11 2.1.1 Usage of preexisting modules ...... 11 2.2 Use cases ...... 11 2.3 User management, security and interoperability ...... 12 2.3.1 User management ...... 12 2.3.2 Authentication and security ...... 12 2.3.3 Interoperability and interdependency ...... 14 2.4 Data Management ...... 14 2.5 Gamification and knowledge visualization ...... 15 2.6 User interface ...... 15 2.7 Functional modules ...... 15 3 Implementation ...... 18 3.1 Overview ...... 18 3.2 CMS ...... 18 3.3 Statistics ...... 18 3.4 Gamification ...... 18 3.5 Software libraries ...... 19 3.6 Multilingual support ...... 20 4 The HUB’s user interface and its information, analytics and content management features ...... 22 4.1 Introduction ...... 22 4.2 Maps ...... 23 4.2.1 Generating a map ...... 23 4.2.2 Editing a map ...... 25 4.2.3 Publishing a map ...... 27 4.3 Issues ...... 27 4.3.1 Issue configuration and DSP PUB outputs ...... 28 4.3.2 Issue sections ...... 31 4.3.3 Issue documents ...... 36 4.3.4 Issue Events ...... 37 4.3.5 Issue Surveys ...... 38 4.3.6 Issue Gamification set up ...... 39 4.4 Participants ...... 41 4.5 Statistics ...... 42 4.6 DSP Properties ...... 43 5 Included Baseform analytics applications ...... 45 5.1 The Quickstart ‘home’ level ...... 45
Page 3 of 53
D2.2 DSP HUB software – Beta release report POWER 25.09.2017 687809
5.2 The Data Manager ...... 45 5.3 Geodata visualization and geo-processing using the SHAPE module ...... 46 5.4 The Monitor modules: Events, Meters, Zones and Water Balance ...... 47 5.5 The Diagnosis modules: Network Model and Performance Indices ...... 48 5.6 The Predict modules: Failure, Inspections, Component Importance and Unmet Demand ...... 49 5.7 The Planning modules: Plan, Performance Indicators, Financial Analysis and IVI ...... 49 6 Final remarks ...... 51 Appendix A – Baseform software Quickstarts and How-to Guides ...... 52 References ...... 53
Page 4 of 53
D2.2 DSP HUB software – Beta release report POWER 25.09.2017 687809
Table of Figures
Figure 1 - Schematic representation the various DSP instances under development within the context of the project...... 10 Figure 2 – The DSP HUB login page ...... 12 Figure 3 – A view of the user management environment ...... 13 Figure 4 - HUB component diagram ...... 16 Figure 5 - The issue gamification table that maps actions to gamification vectors ...... 19 Figure 6 – The DSP HUB main screen ...... 22 Figure 7 – The Maps tool main screen ...... 23 Figure 8 – Inside the Maps app, adding shape layers...... 24 Figure 9 – Inside Data manager, editing the shape file layout ...... 25 Figure 10 – Inside the Maps app, editing opacity of overlaid shape files ...... 26 Figure 11 – Inside the Maps app, obtaining the map URL ...... 27 Figure 12 – The Issues app: list of issues and search filters ...... 28 Figure 13 – Issue’s configuration window and DSP PUB or MOB outputs ...... 29 Figure 14 – Issue’s Comment moderation page ...... 30 Figure 15 – Editing the Issue configuration form in the DSP HUB ...... 30 Figure 16 – Viewing the list of issue sections ...... 31 Figure 17 – Opening a Section ...... 32 Figure 18 – Editing a section ...... 33 Figure 19 – Editing a section (table insertion example) ...... 34 Figure 20 – Editing a section (image insertion example) ...... 35 Figure 21 – Editing a section (hyperlink insertion example) ...... 36 Figure 22 – The issue section content editor ...... 37 Figure 23 – The Events tab ...... 37 Figure 24 – The details of an Event ...... 37 Figure 25 – The Events editor ...... 38 Figure 26 – The Surveys tab ...... 38 Figure 27 – The survey editor ...... 39 Figure 28 – The Gamification tab ...... 41 Figure 29 – The Participants app ...... 41 Figure 30 – Accessing DSP HUB’s registry of a participant’s DSP PUB and MOB log ...... 42 Figure 31 – The Statistics app ...... 43 Figure 32 – Editing the DSP Properties ...... 44 Page 5 of 53
D2.2 DSP HUB software – Beta release report POWER 25.09.2017 687809
Figure 33 – Baseform’s software Quickstart ...... 45 Figure 34 – Baseform’s software Data manager ...... 46 Figure 35 – Baseform’s software geodata visualization ...... 46 Figure 36 – Baseform’s software Monitor tools – Meters ...... 47 Figure 37 – Baseform’s software Diagnose tools – Network modeling capability ...... 48 Figure 38 – Baseform’s software Predict tools – Failure analysis capability ...... 49 Figure 39 – Baseform’s software Plan tools – Compare&Prioritize capability ...... 50
Page 6 of 53
D2.2 DSP HUB software – Beta release report POWER 25.09.2017 687809
Executive Summary POWER is a Research and Innovation Action, supporting the EIP Water Action Group, NetwercH2O and City Blueprints. POWER addresses four of the eight priorities of the EIP WATER Action Group and will share best practice on urban water cycle services (UCWS). It will also share the outcomes of the Blue Sustainable Cities project. The project’s Digital Social Platform (DSP) is the project’s central tool to be made available to cities, utilities or other promoting agencies, aiming at an important contribution to the creation of digital communities around themes specifically related to water and impacting the quality of life of local populations. This dynamic is achieved by implementing digital interaction mechanisms promoted by local decision-makers and seeking to involve citizens in ongoing projects, decision-making processes, promotion of global awareness and the dissemination and sharing of local knowledge and experiences. A specific local instance of the POWER Digital Social Platform is made available through a dedicated DSP website and an accompanying mobile app. In the context of the project, it is envisioned it will be typically set up by a city, a utility, a municipal-level agency or a water-related interest group to be used by community members, activists, volunteers, municipal officials and representatives, water professionals and experts, as well as regional, national or international-level policy-makers, politicians and other stakeholders. This report is the main deliverable of Task 2.2 Development of the DSP HUB (M6 – M12), the second task of Work Package 2: DSP set-up and start-up (M1-M48). The task is concerned with the development of the HUB backend content manager, which was duly carried out in full. This report accompanies the M12 Beta release of the DSP HUB software, which was made available to the project partners on 23/11/2016 at hub.baseform.com, with an initial group of close to 50 project partner and city users registered by that date. The software follows the concept and the architecture of the POWER Digital Social Platform (DSP), the project’s central support tool for driving sustainable behavior and extending a raised collective awareness on the environment and the consequences of our actions. The POWER DSP is designed in an open and modular way, organized in three main tiers that address the specific needs of the different actors and target groups, and of the different channels of information provision, interaction and knowledge sharing. These are internally referred to as as the HUB (the information and content management backend), PUB (the public web portal) and the MOB (the mobile app). The HUB backend management system makes available to the city representatives involved in providing information, creating and managing content, and running the social participation and gamification functionality of a city’s or utility’s DSP, all those functions as well as capabilities to retrieve data and perform analyses that may inform content. This component of the DSP is a non-public system, accessible only to the staff in charge of the DSP and includes data integration services for integrating and exposing environmental static and dynamic data and indicators. The HUB forms the backbone of the DSP and is made available to the demonstrator cities and other stakeholders to support project work. It follows the architecture and functionalities specified in Task 2.1 and detailed in the D2.1 General architecture, functionalities and analysis report. It is aimed primarily as a data organization and back-office facility for the public-facing PUB DSP websites, whose software is to be made available at a later stage (M15). The HUB is not a traditional content manager, in that, in addition to the customary components for creating, editing and managing new content, managing participants and their data (comments, tips) and
Page 7 of 53
D2.2 DSP HUB software – Beta release report POWER 25.09.2017 687809
statistics, the backend provides a platform with the potential to integrate with other systems that may provide data, intelligence or communications with the stakeholders. Additionally, an analytics engine allows the HUB to process interaction results in order to provide improvement criteria for the cities to decide how to make the social process even more effective. This is an important aspect because one of the main challenges in the management of water-related problems is the translation of very technical information into an assertive, objective language that all users perceive. The HUB also fully supports multi-lingual instances of the DSP. From the viewpoint of the backend and in the context of the POWER DSP, a further integration with a set of technical applications – including previously-existing, optional-usage Baseform modules as planned in the DoW – allows the demonstrator cities to integrate technical data and turn it into key indicators, live charts and other information that may be of assistance in the engagement and communication process. Initial training and a permanent support structure for the partners involved in producing content, in particular the key demonstrator city teams, has been set up by Baseform, and is in full operation. Thematic support has also been actively provided by other partners in the project, in particular by DMU and EIPCM. This report provides a summary of the HUB’s purpose and functionality, with a description of how to access and use its various modules. The report includes detailed instructional materials to guide the users through the steps required in order to take full advantage of the modules’ functionality.
Page 8 of 53
D2.2 DSP HUB software – Beta release report POWER 25.09.2017 687809
1 Introduction POWER is a Research and Innovation Action, supporting the EIP Water Action Group, NetwercH2O and City Blueprints. POWER addresses four of the eight priorities of the EIP WATER Action Group and will share best practice on urban water cycle services (UCWS). It will also share the outcomes of the Blue Sustainable Cities project. The project’s Digital Social Platform (DSP) is its central tool to be made available to cities, aiming at an important contribution to the creation of digital communities around themes specifically related to water and impacting the quality of life of local populations. Each instance of the POWER Digital Social Platform, e.g. set up by a given city, is made available through a dedicated DSP website and an accompanying mobile app. It is set up by the city to be used by local community members, activists, volunteers, municipal officials and representatives, water professionals and experts, as well as regional, national or international-level policy-makers, politicians and other stakeholders. The POWER DSP engages a top-down and bottom-up interaction, in order to enable communication and flows of information and knowledge between the various actors and stakeholders. On the one hand, it provides information on water-related challenges and advice on known best-practice of relevance to the citizens and local communities, that would otherwise be unavailable or difficult to find, in an easily accessible, timely manner. On the other hand, it provides channels for interaction and knowledge sharing among the citizens, local communities and the municipality. To support awareness and stimulate engagement, the information provision, user interaction and knowledge sharing channels and functionalities integrate information and knowledge visualisation and gamification techniques. The information on local needs, the experiences and knowledge created and communicated in bottom-up and P2P exchanges also enable the identification and sharing of community-driven best practices, stemming from local experience and living practice. In the best practice repository, both the knowledge and lessons learned from top-down analysis and expert exchanges about them, and the community-driven exchange and identification of best local practices are interconnected. To achieve this, the POWER DSP is designed in an open and modular way, organized in three main tiers that address the specific needs of the different actors and target groups, and of the different channels of information provision, interaction and knowledge sharing. The information and content management backend is internally referred to as the HUB; the public web portal that materializes each DSP to the outside world is referred to as the PUB; and its accompanying mobile app, termed internally the MOB. The HUB backend management system makes available to the content managers involved in providing information, creating and managing content, and running the social participation and gamification functionality of a city’s or utility’s DSP, all those functions as well as capabilities to retrieve data and perform analyses that may inform content. This component of the DSP is a non-public system, accessible only to the staff in charge of the DSP and includes data integration services for integrating and exposing environmental static and dynamic data and indicators. The POWER project’s piloting program generates an initial set of five DSP instances, one per demonstrator city plus a demo DSP, all managed from the project’s instance of the HUB (Figure 1). The software is also used for the development of a separate instance with special additional features, designed to support the organized publishing of a Best Practices Repository, feeding from and coordinating with the growing number of individual DSP instances.
Page 9 of 53
D2.2 DSP HUB software – Beta release report POWER 25.09.2017 687809
Figure 1 - Schematic representation the various DSP instances under development within the context of the project. This report accompanies the 23/11/2016 Beta release of the POWER DSP’s HUB software, which was made available to the project partners at hub.baseform.com, with an initial group of close to 50 project team members and city users registered by that date. The software is the result of Task 2.2 Development of DSP HUB tier, developed in the context of WP2 - DSP set-up and start-up. It follows and implements the architecture and functionalities specified in Task 2.1 and detailed in the D2.1 General architecture, functionalities and analysis report. This report is divided into the following main sections providing details on: • the software’s design and development options (Chapter 2); • its implementation and selected technologies (Chapter 3); • its user interface mechanics and the software’s features and capabilities (Chapter 4); • the additional analytics modules that are present in the project’s HUB implementation (Chapter 5); and • concluding remarks, followed by a list of bibliography references (Chapter 6). Appendix A references a set of instructional materials to guide the users through the steps required in order to take full advantage of the analytics modules’ functionality, made available through the software’s Quickstart page (see 5.1).
Page 10 of 53
D2.2 DSP HUB software – Beta release report POWER 25.09.2017 687809
2 Software design
2.1 Overview The HUB backend acts as content manager for the public components of the DSP, the PUB and its mobile app counterpart, the MOB. The HUB is not a traditional content manager, in that, in addition to the customary components for creating, editing and managing new content, managing participants and their data (comments, tips) and statistics, the backend represents a platform with the potential to integrate with other systems that may provide data, intelligence or communications with the stakeholders. Additionally, an analytics engine allows the HUB to process interaction results in order to provide improvement criteria for the cities to decide how to make the social process even more effective. This is an important aspect because one of the main challenges in the management of water-related problems is the translation of very technical information into an assertive, objective language that all users perceive. From the viewpoint of the backend and in the context of the POWER DSP, an integration with a set of technical applications allows cities to integrate technical data and turn it into key indicators, live charts or other information that may be of assistance in the engagement and communication process. The full- featured DSP HUB deployment, available to the POWER project, combines DSP HUB core components (such as content and participant management, gamification engine) plugged into previously-existing, optional- usage Baseform modules. The D2.1 General architecture, functionalities and analysis report provides a detailed overview of the concepts and architecture that presided over the system’s development, including components, relationships, dependencies, data model and the usage of external modules such as the pre-existing Baseform analytics apps. In the specific case of the HUB, details are given of its intended use cases, user interface, interoperability, data management, user management and other key design and architecture aspects. That information will not be duplicated in this report. Therefore, this section provides additional insights and details of the HUB as instantiated in its current (Beta) implementation, as made available internally to the project partners. This concerns in particular user management, security and interoperability features, gamification and knowledge visualization capabilities, some considerations about the user interface, and the functional modules, which are further detailed in Chapter 4 and Chapter 5.
2.1.1 Usage of preexisting modules As mentioned in Section 2.3.1 of the D2.1 General architecture, functionalities and analysis report, given the requirement of a fully open-sourced distribution for the software developed under the POWER Project, all non-open source Baseform background software components which are in use during the project will be replaced with simple, focused, effective open-source alternatives. This includes general services (GIS and Monitoring web services), the DSP HUB user interface and back- office user and file management capabilities, as described also in the Section 5.2 Release schedule of the same report.
2.2 Use cases A full analysis of the HUB’s use cases is provided in Section 3.4.2 of the aforementioned report D2.1 General architecture, functionalities and analysis. It is not replicated here due to its extensive nature, but the reader is advised to consult that document for a complete reference.
Page 11 of 53
D2.2 DSP HUB software – Beta release report POWER 25.09.2017 687809
2.3 User management, security and interoperability
2.3.1 User management To manage users, a Baseform module is used: User Manager. This module provides a structured way to manage the DSP HUB users, with operations like creating, deactivating, granting or revoking permissions, etc. This module also provides audit features, keeping track of all the user’s action inside the DSP HUB. Since the HUB supports multiple kinds of users, permission control is very important, in order to make sure that the users only have access to what they are allowed to access. For instance, the different demonstrator cities content producers and content reviewers should only have access to content pertaining to their respective cities. Project coordination user profiles could conceivably be allowed to access content across all cities.
2.3.2 Authentication and security
Figure 2 – The DSP HUB login page As introduced in section 3.7 of the D2.1 General architecture, functionalities and analysis report, user authentication is achieved through a login form (username + password) and session maintenance. The POWER DSP HUB is available internally to the project partners, demonstrator cities and their accredited users, at the following internet address: https://powerhub.baseform.com
Page 12 of 53
D2.2 DSP HUB software – Beta release report POWER 25.09.2017 687809
Any computing platform (personal computer, tablet, smartphone) with access to the web can be used to access the HUB. Although all modern browsersi are supported, best results are obtained using Google Chrome® or Apple Safari®. A preloaded set of DSP HUB users has been added, covering the partner and city pilot teams as requested at the date of publishing. Baseform will update this list as per the project needs, with new users created as needed.
Figure 3 – A view of the user management environment Baseform will manage DSP HUB users and administrators of the PUB, granting the necessary permissions for these users. No public registration form will be available for the users managed by Baseform, as this platform will not have public access.
i This includes all updated versions of the current mainstream browsers. Page 13 of 53
D2.2 DSP HUB software – Beta release report POWER 25.09.2017 687809
As part of the DSP, the HUB inherits all the security features described in section 3.7 of the D2.1 General architecture, functionalities and analysis report. There is additional logic associated to data access control, such as user permissions and profiles, and file visibility and ownership. DSP HUB’s data management implements a set of features to manage user permissions through user groups that aggregate permissions. This is the way to grant permissions to users and enable them to operate according to their roles.
2.3.3 Interoperability and interdependency The HUB is the where most of information in the DSP is produced, content is managed, public participation is moderated, etc. The PUB and MOB also produce information, collecting public participation tokens in its various formats, from comments to checklists, survey replies, event participation and others. This information is less varied and is processed in the HUB tier. The PUB and MOB interact with the public and follow the rules set by the HUB tier. Interoperability between the HUB and PUB is crucial for the accomplishment of the requirements listed in the D2.1 General architecture, functionalities and analysis report. The HUB and PUB share information using a common database. This is a very standard and reliable way of providing a structured repository of dynamic information. For static information such as documents, images or geographical information, a common file system is used, in order to share these between the HUB and the PUB. Regarding the MOB, interaction with the HUB will take place through the PUB, thus reducing the complexity of the HUB. This implies that the PUB has an interface for the MOB to connect to. This interface will consist of a mobile adapted web interface, with the same functionality of the one directly used by the users on desktop devices.
2.4 Data Management The HUB stores all the information either in a database management system, or in a file system. These standard methods bring reliability and adequate performance on reads and writes, which are very important to accomplish the scalability and reliability design principles. Static data Static data such as documents, images, geographical files, telemetry data, etc. is stored in the file system and managed by the Baseform Data Manager, discussed further below. This allows for integrated access to analysis files, telemetry data, mapping files, etc. directly in the HUB. Baseform Data Manager This is a Baseform module that is included in the HUB DSP, in order to access and edit files in an integrated tool. The Data Manager is a web file system, in the sense that it provides the user with the same features that are usually seen in modern desktop operating systems: file creation, deletion, renaming, moving, copying, etc. Dynamic data Issues, users, participants, participation data, etc. are very dynamic data, constantly changing. This requires a structured way of organizing it and accessing it, that also allows for synchronization between the different accesses (there will be even different tiers accessing it simultaneously). This kind of data is stored in a database management system.
Page 14 of 53
D2.2 DSP HUB software – Beta release report POWER 25.09.2017 687809
2.5 Gamification and knowledge visualization As outlined in the D2.1 General architecture, functionalities and analysis report, gamification and knowledge visualization are important features of the POWER platform and are strongly based on requirements (see deliverable D3.2 Report on Socio-Technical Requirements). In the implementation of these features we are following a universal, all-inclusive approach. The gamification model should not consider the PUB and MOB tiers as separate instances, but as two different channels through which users much be incentivized to participate on the DSP. The building blocks of the gamification model have been defined in the D2.1 General architecture, functionalities and analysis report. From the gamification infrastructure depicted in D2.1, the beta release of the PUB comprises the user activity tracking, as it is a prerequisite for the gamification model to work. After internal testing and the iterative definition of scenarios, use cases, and associated content for each pilot in WP3, the specific gamified incentives and visualizations can be designed and implemented, while paying particular attention to the target group’s needs with respect to device usage (e.g. mobile or desktop). The main phase of implementing the common and the pilot specific gamification layers will then take place once the beta version of the HUB has been released, resulting in the release of fully implemented gamification infrastructure jointly with the release of the MOB. After the MOB release, stakeholder tests will yield feedback based on which the model can be refined, as to maximize public participation on the platform.
2.6 User interface The HUB makes use of a modern and well-proven web user interface, AddUI 2.01, used by all of Baseform’s professional-grade software. According to the requirement of a fully open-sourced distribution of the POWER Project developed software (see Section 2.3.1 of the D2.1 General architecture, functionalities and analysis report), all non- open source Baseform background, in use during the project, will be replaced with simple, focused, open- source alternatives. The initial DSP HUB user interface, based on ADDUI will be replaced by a generic alternative and released as part of the open-source release of the software. The Addition User Interface 2.0 is a framework and a set of user interface guidelines. It contains guidelines, rules and places for actions or visualizations to take place in web applications, providing a simple, predictable and powerful look & feel. Among some features that are common to many scenarios: • User account management and logout buttons on the top right. • Tabbed organization for different kinds of content on the top left. • Close button on the top left, above the tabs. • Left drawers that affect what happens in the center (in this case, visualization type and legend). • Map/Model controls on the right that provide tools for map-like navigations.
2.7 Functional modules A range of newly developed POWER DSP HUB capabilities are made available alongside pre-existing Baseform water analytics apps. Both groups are well detailed in Chapters 4 and 5 of this report, as well as in Section 3.4 of the D2.1 General architecture, functionalities and analysis report.
Page 15 of 53
D2.2 DSP HUB software – Beta release report POWER 25.09.2017 687809
In addition to supporting project work, managing raw data, running validation and data coherence processes, and making available the core visualisation and analysis tools, the HUB manages the DSP PUB’s content for each participating city, including issues (content, documentation, events, surveys, gamification), participants and statistics. It is aimed primarily as a data organisation and back-office facility, whose public- facing capabilities are explored through the PUB.
Figure 4 - HUB component diagram POWER’s DSP HUB apps are presented in Chapter 4: • Maps • Issues • Participants • Statistics • DSP properties Baseform’s pre-existing water analytics apps include the range of applications described in Chapter 5 and fully described in the documentation referenced in Appendix A - Baseform software Quickstarts and How- to Guides: • Monitor (Events, Meters, Zones, Water Balance)
Page 16 of 53
D2.2 DSP HUB software – Beta release report POWER 25.09.2017 687809
• Diagnose (Network model, Indices, Minimum Energy, Energy Balance) • Predict (Failure Analysis, Inspection Analysis, Component Importance, Risk of no service) • Plan (Compare & prioritize, Indicators, Financial Analysis, Infrastructure value index).
Page 17 of 53
D2.2 DSP HUB software – Beta release report POWER 25.09.2017 687809
3 Implementation
3.1 Overview The background for the implementation effort of the DSP’s HUB backend, in terms of technical options and general methodology, is provided in the D2.1 General architecture, functionalities and analysis report. This section focuses on detailing the HUB’s specific selected options, as regards the content management system, the statistics and chart plotting features, the gamification features, software libraries used and multilingual support.
3.2 CMS The chosen implementation for the content management system (CMS) is TinyMCE2. This editor fulfils all the requirements, providing a WYSIWYG editor, capable of formatting HTML content, uploading images and HTML source code editing. The HTML source code editing enables the user to edit the produced HTML code directly, which is very useful for including third party embedded content, such as videos or other widgets. Including this component into the HUB is very simple and has very little impact on the “Edit section” page. Instructions for including the TinyMCE editor can be found here: https://www.tinymce.com/docs/get- started/basic-setup/ For editing issue sections, the following plugins are used: • Horizontal Rule: https://www.tinymce.com/docs/plugins/hr/ • Link: https://www.tinymce.com/docs/plugins/link/ • Image: https://www.tinymce.com/docs/plugins/image/ • Code: https://www.tinymce.com/docs/plugins/code/ • Table: https://www.tinymce.com/docs/plugins/table/
3.3 Statistics As extensibility of the statistics module was a key requirement, an effort was made to ensure that adding a new segment, i.e. a new user field, would not imply a great development effort to include it in the statistics. As for the web charts library, Flot3, a Javascript software library for drawing customizable charts. This library enables an easy integration of web charts in web pages. Instructions for including Flot charts into a web page can be found here: https://github.com/flot/flot/blob/master/API.m
3.4 Gamification As the set of possible actions is subject to change for a particular issue – e.g. another event is added – the way to store the table must be carefully thought out. In order to be flexible enough to allow any number of action entries in the table, JSON4 is the chosen format to store the issue gamification table. An example of such format follows: Page 18 of 53
D2.2 DSP HUB software – Beta release report POWER 25.09.2017 687809
{ "cat.personal.practical.knowledge.action.click.link.http://nationalfloodforum.org.uk/": 60, "cat.personal.practical.knowledge.action.click.link.http://www.bluepages.org.uk/": 0, … } This format is basically a map of concatenations of gamification vectors with issue actions to score values. In the example we can see that the participant would score 60 points on vector “Practical Knowledge” of dimension “Personal” for clicking on the “National Flood Forum” link. In terms of user interface, the gamification is materialized in the HUB as a table associated to an issue, that associates vectors and dimensions to action on the issue. Each action will give a certain amount of points per vector to the user that executes it.
Figure 5 - The issue gamification table that maps actions to gamification vectors
The gamification radar web chart was implemented resorting to a software library called ChartJS5 which allows us to draw a radar chart with all the dimensions of the gamification table and all the user (or the overall) scores. Integrating and customizing the ChartJS radar chart into a web page is relatively easy and instructions can be found at: http://www.chartjs.org/docs/latest/
3.5 Software libraries This section provides a list of all the software libraries used to implement the DSP HUB as well as the licenses used by those. Library name Version License
JDBC PostgreSQL 4.2 Postgres
Apache Cayenne 3 Apache
Vibur 17 Apache
Apache Commons 1, 2 and 3 Apache
Page 19 of 53
D2.2 DSP HUB software – Beta release report POWER 25.09.2017 687809
Library name Version License log4j 1.2 Apache xstream 1.4 BSD jxls 1 Apache
Apache POI 3 Apache
Geotools 17 LGPL
SimpleCaptcha 1.2 BSD libphonenumber 8 Apache jQuery 1.11 MIT
TinyMCE 4.5 LGPL
ChartJS 2.6 MIT
Flot 0.8 MIT
OpenLayers 3 BSD
BSD License: http://www.linfo.org/bsdlicense.html LGPL License: https://www.gnu.org/copyleft/lesser.html MIT License: https://opensource.org/licenses/MIT Postgres License: http://www.postgresql.org/about/licenc
Further information on the project’s usage of open-source software and the project’s GitHub repository is given in the D2.1 report.
3.6 Multilingual support As planned in the D2.1 report, the DSP PUB must allow for the demonstrator cities to produce contents in their native languages. Not only there will be different DSP instances in different languages, but the same instance of the PUB may have to display more than one language – for example, among the demonstrator cities are Jerusalem, whose DSP will have contents written in Hebrew, Arabic and English, and Sabadell, with Catalan and Spanish. Full multilingual support capabilities have been implemented. HUB users will be able to create content in the desired language and manage those content separately in case the target DSP requires multiple languages to be present. The contents produced by the DSP producer must have a language associated. An article of content is written in a single language, allowing the content producers to generate different issues for different languages, or, conversely, having multiple issues about the same subject, translated to multiple languages.
Page 20 of 53
D2.2 DSP HUB software – Beta release report POWER 25.09.2017 687809
If an issue is intended to be published in more than one language, it is mandatory to create separately all the different versions of that issue in the correspondent languages with the contents being translated accordingly. The only exception is the Issue code. It is essential that the issue code is repeated among the different language versions produced, to ensure consistency and accuracy in statistical information to be produced. Having many issues with the same code (and different languages) enables the aggregation of statistics by code, or in other words, to aggregate statistics for the same issue in different languages. Each DSP PUB has a predefined set of languages and shows issues in those languages, as long as they are created this way in the DSP HUB. Refer also to Section 4.3.1 for a review of the multilingual features in a user context.
Page 21 of 53
D2.2 DSP HUB software – Beta release report POWER 25.09.2017 687809
4 The HUB’s user interface and its information, analytics and content management features
4.1 Introduction The POWER DSP HUB establishes the common backend system to create and manage the contents of the participating cities’ public DSP websites (their PUB instances) and associated mobile apps (their MOB instances). The HUB is a private system, accessible only to those users that are cleared by each city to manage their DSP. Each ‘issue’ii launched to raise citizen and community awareness on water environmental challenges is individually created and defined in the DSP HUB and then published to the correspondent DSP PUB and MOB. Each individual DSP PUB will collect its own information about its registered participants and navigational and usage statistical information, as well as individual answers to Surveys or Comments submitted, that will collectively be gathered in the DSP HUB as output information.
Figure 6 – The DSP HUB main screen This chapter details the user interface’s mechanics as it describes how the HUB is utilized in order to create or update contents in the Maps and Issues apps and introduces the available information on Participants
ii As mentioned in report D2.1, the choice of the term ‘Issues’ to designate the units of thematic content that make up the DSP PUB/MOB is a provisional solution that may be replaced during the Beta testing stage. Page 22 of 53
D2.2 DSP HUB software – Beta release report POWER 25.09.2017 687809
and Statistics gathered from the cities’ DSP PUB instances. It also describes the available information, by Issue, on Survey answers, Comments and Tips submitted by the participants in the PUB/MOB.
4.2 Maps The Maps section on DSP HUB provides an online tool that allows free combinations of independent layers in order to obtain a representative map to be displayed in the Issue presented in the DSP PUB.
4.2.1 Generating a map
Figure 7 – The Maps tool main screen
A new map can be created by adding the individual shape files, browsed from the DSP HUB’s Data manager folder from which were previously uploaded, that will be combined performing map’s different layers. The Data file management system is the DSP HUB’s central facility to upload, manage, copy, organise and download all the files that may be needed in the system, from the analytics and visualisation apps available from the main menu, to the maps and the documentation files used to support the issues in the PUB. It is important to be familiarised with the basic functionality in Data before using the remaining PUB management apps. The Data app is documented in the tutorials made available from the Quickstart section on the Hub (the ‘home’ screen after log in), and referenced in Appendix A of this report.
Page 23 of 53
D2.2 DSP HUB software – Beta release report POWER 25.09.2017 687809
Figure 8 – Inside the Maps app, adding shape layers
In order to be successfully read as a shapefile archive, when uploading a shapefile to DSP HUB’s Data manager it is mandatory that the shapefile be accompanied by the necessary sidecar files6. The layout to be presented by the shapefile in the Map in terms of color fill, as well as stroke width or color, is set directly in the shapefile archive in the Data manager. These settings can be changed in any moment, although for ease of usage it is recommended that the layout is set when the shapefile is uploaded to Baseform’s software.
Page 24 of 53
D2.2 DSP HUB software – Beta release report POWER 25.09.2017 687809
4.2.2 Editing a map
Figure 9 – Inside Data manager, editing the shape file layout
To enhance proper setting of the map layout, shape layer’s displaying order can easily be defined individually by moving each layer towards bottom or top (Figure 10). The shape layers associated to the map can be changed in any moment, by removing or adding shape files. The base layer gives context to shape layers, laying as background image, and is chosen from a preset list of options including the most common web mapping services. Fine tuning of global map appearance can be improved adjusting the transparency of each shape layer, as well as the base layer. Each map layer is displayed by default in its maximum opacity and can easily gain transparency by dragging the mark over the control line to the desired grade of opacity.
Page 25 of 53
D2.2 DSP HUB software – Beta release report POWER 25.09.2017 687809
Figure 10 – Inside the Maps app, editing opacity of overlaid shape files
A map can be fully prepared in the DSP HUB and then be made public associated to one of DSP PUB’s Issues. The map association to a specific Issue is established in the Issue configuration form in the DSP HUB by indicating the Map URL, as presented in 4.3. Each created map, within DSP HUB’s Maps tool or other equivalent tool, must have an intrinsic URL code. In DSP HUB’s Maps tool the URL can be directly obtained in the Map editing frame (copy URL).
Page 26 of 53
D2.2 DSP HUB software – Beta release report POWER 25.09.2017 687809
4.2.3 Publishing a map
Figure 11 – Inside the Maps app, obtaining the map URL To ensure correct display of the map in the DSP MOB is essential to have a mobile adapted embeddable map. If using the Maps tool, this is achieved by copying the mobile adapted version URL and pasting it into the Issue configuration form. In the DSP HUB’s Maps tool a map can be “public” or not. In order to display it in the DSP PUB and DSP MOB, the map must be published first (checking the Public checkbox).
4.3 Issues The DSP HUB Issues appiii establishes the center stage for DSP PUB’s content management namely enabling the creation of the global water issues to be published in the cities public websites. This app configures the content editor where issues are created and configured, and where their content is managed, including information about their sections, documents, events, surveys and gamification settings.
iii See footnote Error! Bookmark not defined. on Section Error! Reference source not found. Page 27 of 53
D2.2 DSP HUB software – Beta release report POWER 25.09.2017 687809
Figure 12 – The Issues app: list of issues and search filters
The Issues app displays a list of the available issues for each city and a range of search filters based on issues characteristics or state. Each demonstrator city accredited user has access to a pre-filtered list of its own city issues. Full access to all the demonstrator cities issues is only granted to the respective team members and other project partners authorized by the city team, which are the only accredited users with the ability to filter the list of issues by city. New issues are created from the available button above the issues list on the Issues app main window. Any existing issue can be opened by clicking on its name on the list. All listed issues and its contents are permanently available for edition.
4.3.1 Issue configuration and DSP PUB outputs Editing an issue, or creating a new one, brings up the Issue configuration window with its various tabs at the top: Issue, Sections, Documents, Events, Surveys, Gamification. In the second half of this DSP HUB’s window are listed the Answers to surveys, Comments and Tips individually submitted by the participants in the DSP PUB or MOB regarding that particular Issue. This means that the DSP HUB’s issue main page displays simultaneously the content editor material - both in the central pane as in the tabbed contents - along with updated feedback from Participants actions on that Issue’s DSP PUB or MOB - presented by the listed Answers, Comments and Tips outputs, as outputs from the public website.
Page 28 of 53
D2.2 DSP HUB software – Beta release report POWER 25.09.2017 687809
Figure 13 – Issue’s configuration window and DSP PUB or MOB outputs
Participation moderation When adding a Comment or a Tip directly in the DSP PUB or MOB the Participant is actually only submitting that content from the public website into the DSP HUB. When submitted and as illustrated above, DSP PUB or MOB Comments and Tips are listed in the Issue tab of the DSP HUB with a status indicating they will be under evaluation. Comments and Tips moderation occurs in the DSP HUB, where it is decided either the content is accepted or rejected. Only approved contents will be displayed in the cities DSP PUB or MOB. To moderate one of those Comments or Tips with pending approval status, simply select the element from the Comments list or the Tips list to access the correspondent moderation form where the decision to publish it (or not) will take place.
Page 29 of 53
D2.2 DSP HUB software – Beta release report POWER 25.09.2017 687809
Figure 14 – Issue’s Comment moderation page
Issue configuration The issue main page (or configuration window) corresponds to the first tab, simply named Issue as is where this content is configured. The Issue setup can be updated at any time by opening the edition form provided by the EDIT button available on the top of the frame. The form presented in this editing mode is equivalent to the one presented when a new issue is being created from scratch.
Figure 15 – Editing the Issue configuration form in the DSP HUB The Issue configuration form introduces several key features, including the name and description, which are displayed as the title and short description when the issue is listed on the home page of the DSP PUB or MOB. Other relevant features are the start and end dates, representing the time period in which the Issue will be up to Participation, meaning it will be enabled for Participant’s interactions like Commenting, answering the Surveys and other contributions.
Page 30 of 53
D2.2 DSP HUB software – Beta release report POWER 25.09.2017 687809
The configuration form also sets the key to define whether or not the issue is published on the DSP PUB or MOB. Although all issues need to be previously created in the DSP HUB in order to exist in the DSP PUB or MOB, only those marked as Published are made available - shown as visible contents - in the city public website. This feature enables demonstrator cities to prepare all the intended issues in ahead, without having any of them visible by default. The POWER DSP supports multiple languages and the issue configuration form holds a key feature to define the issue’s language. The issue code is not related to any definition of the issue’s displaying order in the DSP PUB or MOB Issues list. It is a simple, though crucial, feature of content management. It is possible to define a selection of hashtags relevant to the Issue goals, which will be used to collect related information on Twitter. This compilation of tweets will be displayed in the DSP PUB or MOB in the bottom of the issue screen. If a map is to be included in the issue, it is essential to copy the map’s URL code from the map prepared in the mapping tool into the Map Url feature in the Issue configuration form. As stated on section 4.2, to ensure the map’s correct displaying either in the DSP PUB as in the DSP MOB, it is essential to indicate the two different URL codes (one for DSP PUB and another for DSP MOB). The cover photo feature allows the upload of an image to be displayed in the DSP PUB or MOB list of Issues, which will identify and give context to the Issue along with other key elements like its Name, Description or Participative period.
4.3.2 Issue sections The tab Sections allows the creation of different compartments in which the Issue information can be organized. The sections of an Issue can be created with multiple understandings: can be used to represent subsets of the Issue’s information; or be helpful to represent different contexts of the same challenge; or even to organize different groups of thematic information; and many other possible interpretations.
Figure 16 – Viewing the list of issue sections
The Sections tab displays the sections that have been created for the issue and allow the creation of new sections. It is possible to access an existing section content simply by expanding that individual section directly from the sections list.
Page 31 of 53
D2.2 DSP HUB software – Beta release report POWER 25.09.2017 687809
Figure 17 – Opening a Section
The section setup can be updated at any time by opening the edition form provided by the EDIT button available. The form presented in this editing mode is equivalent to the one presented when a new section is being created from scratch.
Page 32 of 53
D2.2 DSP HUB software – Beta release report POWER 25.09.2017 687809
Figure 18 – Editing a section
The section index is the feature that defines the displaying order of the different sections. The Issue sections presentation order in the DSP PUB or MOB will follow the positions established in the DSP HUB. The issue section’s index, as well as the issue code, can also be quite helpful to enhance links establishment between sections that can be set in the issue section’s edition form, as illustrated by the previous image. As the sections are populated with resource to a powerful CMS (content management system), can contain rich HTML content in different combinations. In fact, the section contents vary from text, to images or web links. It is also possible to embed many types of multimedia widgets like statistical charts from other websites or videos from the most used streaming platforms. Figure 19, Figure 20 and Figure 21 present a examples of some of the featured capabilities.
Page 33 of 53
D2.2 DSP HUB software – Beta release report POWER 25.09.2017 687809
Figure 19 – Editing a section (table insertion example)
Page 34 of 53
D2.2 DSP HUB software – Beta release report POWER 25.09.2017 687809
Figure 20 – Editing a section (image insertion example)
Page 35 of 53
D2.2 DSP HUB software – Beta release report POWER 25.09.2017 687809
Figure 21 – Editing a section (hyperlink insertion example)
4.3.3 Issue documents It is possible to associate documents to the Issue, as files to be displayed for download in the city DSP PUB or MOB in order to provide additional information to the Participants like, for example, Reports, Master Plans or Glossaries. The Documents tab displays the files that have been created for the issue and allow new documents to be added. It is a simple operation where files are uploaded from the user’s computer. A description and the file type should be added for clarity on the documents list. Virtually all common file types are accepted.
Page 36 of 53
D2.2 DSP HUB software – Beta release report POWER 25.09.2017 687809
Figure 22 – The issue section content editor
4.3.4 Issue Events It is possible to define Events associated to the Issue, as scheduled items that may be of relevance to a DSP issue such as Public presentations or Committee meetings, for example. The Events tab displays the scheduled moments that have been created for the issue and allow the creation of new events.
Figure 23 – The Events tab
When opening an event from the list, it brings up the Event configuration form that resumes the event details. The lower part of the form provides an updated list of the attending Participants that expressed in the DSP PUB or MOB their intention to take part.
Figure 24 – The details of an Event
Page 37 of 53
D2.2 DSP HUB software – Beta release report POWER 25.09.2017 687809
The Event setup can be updated at any time by opening the edition form provided by the EDIT button. The form presented in this editing mode is equivalent to the one presented when a new event is being created from scratch. The Event configuration form introduces several key features, including its name, the date in which it will take place and the indication of the venue. As additional information, it is possible to associate either a link to be accessed by the Participants or a document to be downloaded in the DSP PUB or MOB if any of those option can be helpful to bring context to the event.
Figure 25 – The Events editor
4.3.5 Issue Surveys The surveys tool (Figure 26) allows the issue to present both surveys and checklist-style questionnaires to the users. The Surveys tab displays the surveys/checklists that have been created for the issue and allow the creation of new surveys.
Figure 26 – The Surveys tab
The survey setup can be updated at any time by opening the edition form provided when selecting an existing survey directly from the surveys list. The form presented in this editing mode is equivalent to the one presented when a new survey is being created from scratch. Page 38 of 53
D2.2 DSP HUB software – Beta release report POWER 25.09.2017 687809
The Survey configuration form (Figure 27) introduces several key features, including the name and description. Surveys will be displayed in the DSP PUB or MOB listed by Name. The text indicated in the DSP HUB’s Description feature will be displayed in the DSP PUB or MOB as an introduction to the survey/checklist form to be answered by the Participant. It is also possible to configure the start and end dates, defining the time period in which the survey is available for Participation within the Issue’s participative period. The survey’s elements or items are edited on the lower part of the screen.
Figure 27 – The survey editor
4.3.6 Issue Gamification set up The DSP PUB is equipped with a tool that enables the setting up of gamification strategies to govern and incentivize the relationship between the users and the participatory issues. An initial set of possible (inter)actions with an issue has been defined and rated with regard to their level of activity (low, medium, high). Table 1 lists the preliminary set of actions, the final version will be provided in D3.3 (Report on the Gamification Model).
Table 1: Preliminary list of gamified issue interactions Action name Description Activity level Click on section 1 This action applies on opening and reading section 1 of Low the issue (this action is identical with the opening of the issue from the start page) Page 39 of 53
D2.2 DSP HUB software – Beta release report POWER 25.09.2017 687809
Click on section 2 Opening and reading section 2 of the issue Low (if section 2 exists) Click on section 3 Opening and reading section 3 of the issue Low (if section 3 exists) Click on section 4 Opening and reading section 4 of the issue Low (if section 4 exists) Click on Link (_URL_) Click on a link within the issue. Medium This action needs to be available for every single link defined within the issue. Content area check Functionality needs to be implemented: Medium (_content area name_) Within the section of an issue: possibility to define a content area (with name + text) that calls a box in which the user can confirm that (s)he has read and understood the content area (e. g. checkbox with message “OK, I got it”) Open additional dropdown Functionality needs to be implemented: Medium content area (_dropdown Define a content area with additional content that can be name_) opened by clicking on a “down arrow”. User receives points when opening the dropdown area (a similar content dropdown area is currently already implemented for the survey) Activity within map t.b.d. Medium
Download document Download the document with the name specified Medium (_document name_) This action needs to be available for every single document defined within the issue. Follow the issue Follow the issue by clicking on “Follow” (points need to Medium be withdrawn if user unfollows the issue) Share the issue Share the issue by clicking on “Share” and share by Medium through one of the channels Comment Comment on the issue by clicking on “Have a say” Medium Vote on a tip Functionality to be implemented: Medium User clicks on “Like tip” Take a quiz (_quiz name_) Functionality to be implemented: High Completing a quiz in the issue This action needs to be available for every single quiz defined within the issue. Complete survey (_survey Functionality to be implemented: High name_) Complete a survey This action needs to be available for every survey defined within the issue. Attend an event Attend an event/meeting by checking “I am going” High Points need to be withdrawn on “un-check” This action needs to be available for every single event defined within the issue. Upload a document Functionality needs to be implemented: High User can upload a document (e.g. personal flood plan) Submit a tip Functionality needs to be implemented: High
Page 40 of 53
D2.2 DSP HUB software – Beta release report POWER 25.09.2017 687809
User submits a tip (e.g. for water saving in MK)
The points awarded for each of these actions to a registered are configured in the Gamification tab depicted in Figure 28. The gamification features will be tested and further developed during the Beta testing stage of the project.
Figure 28 – The Gamification tab
4.4 Participants The Participants app of DSP HUB provides a fully updated list of the registered users in the different cities public websites (DSP PUB or MOB). In order to comment or answer a survey in the public website it is mandatory that the Participant has been previously registered in that DSP PUB. The registration is free and self assured by the user by filling and submitting a registration form. Before becoming public, the DSP PUB or MOB registration disclaimer presents to the Participant the Terms and Conditions underlying that register.
Figure 29 – The Participants app
Page 41 of 53
D2.2 DSP HUB software – Beta release report POWER 25.09.2017 687809
When accessing a Participant’s registry is possible to obtain more detailed information on each public user as well as a log of their actions over the PUB or MOB. It is possible to access a log of the main actions performed over the public website, as well as the list of its Participated and Followed Issues.
Figure 30 – Accessing DSP HUB’s registry of a participant’s DSP PUB and MOB log
4.5 Statistics The Statistics app of DSP HUB provides general feedback on age and gender from the cities DSP PUB and the different issues involved, regarding the registered participants in those public websites. The Participants section of DSP HUB provides a fully updated an automated output of Participant’s registration taking place in the different cities DSP PUB websites. The statistical information is resumed by age and gender separately for each city DSP PUB and can be find in more detail for each different issue. The available statistical information in the DSP HUB is an automated and fully updated output collected from the cities DSP PUB websites online activity.
Page 42 of 53
D2.2 DSP HUB software – Beta release report POWER 25.09.2017 687809
The Statistics app will be under development during the Beta testing stage of the project, as city-specific DSP instances are developed, issues created, and a body of data is generated to enable insights into the most useful types of statistical analytics.
Figure 31 – The Statistics app
More detailed statistics are available directly in each city public website. In each Issue, the Statistics section that is present in the lower part of the screen reveals the number of visualizations, follow or shares gathered by the Issue. The STATISTICS section of the DSP PUB provide the main usage statistics that represent the whole public website, revealing the overall numbers of the Participation and Participants actions (like the number of visits and registered users or the number of answered surveys and shared issues, for example).
4.6 DSP Properties The POWER DSP Properties section, accessible on the Administration set of tools at the bottom of the main menu (left side) for authorized users, is where the small texts to be featured on the public website header above the radar charts are defined, as well as the contents to be displayed in the tabs that will be featured on the ABOUT section of the DSP PUB or DSP MOB.
Page 43 of 53
D2.2 DSP HUB software – Beta release report POWER 25.09.2017 687809
Figure 32 – Editing the DSP Properties
Page 44 of 53
D2.2 DSP HUB software – Beta release report POWER 25.09.2017 687809
5 Included Baseform analytics applications
5.1 The Quickstart ‘home’ level The HUB software’s interface strives to be self-explanatory and to contain all the elements and information that the user needs in order to take advantage of the software. This is an important principle that protects the user from the printed information (such as this report) becoming outdated as the project progresses. The ‘home’ button is in effect the Quickstart drawer at the top left of the main screen. This always presents the user with the instructional documentation and the most recent files opened by her.
Figure 33 – Baseform’s software Quickstart
5.2 The Data Manager The HUB implements Data Manager, the file management system in the Baseform software environment, and the active tool when starting the software, enabling the users to manage their files (read, create, edit, delete) in directories that they own, also share them with other users. The main features are: - Navigate the folder structure and create new folders. - Upload & download files and folders. - Rename, copy, move, duplicate or delete files and folders. - Search for files and folders - Examine the properties and content of a file. A Quickstart guide on the Data Manager and a How-to guide on how to upload, backup and restore files are available in Appendix A and in the Quickstart area of the software.
Page 45 of 53
D2.2 DSP HUB software – Beta release report POWER 25.09.2017 687809
Figure 34 – Baseform’s software Data manager
5.3 Geodata visualization and geo-processing using the SHAPE module The Shape module allows for the visualization and geo-processing of GIS information presented either as Shape File zip archives or separate shape and side-car files (at least .shp, .shx and .dbf). The facility is accessed from the Data Manager by clicking on the above mentioned file types. A Quickstart guide is available in Appendix A and in the Quickstart area of the software.
Figure 35 – Baseform’s software geodata visualization
Page 46 of 53
D2.2 DSP HUB software – Beta release report POWER 25.09.2017 687809
5.4 The Monitor modules: Events, Meters, Zones and Water Balance
Figure 36 – Baseform’s software Monitor tools – Meters
. Events - detects deviations to normal network behavior that may translate leaks, pipe breaks, unusual demand or a variety of network issues. . Meters - supports sensor-based monitoring, driving system usage analytics, learning and predicting demand patterns & trends, and consumer behavior. . Zones - deploys interactive map-based environment to precisely calculate zone totals and statistics, as well as a range of key NRW and efficiency indicators. . Water Balance - a library-based, IWA-compliant water audit standard framework for rigorous, automated diagnosis, NRW reduction and asset management.
Page 47 of 53
D2.2 DSP HUB software – Beta release report POWER 25.09.2017 687809
5.5 The Diagnosis modules: Network Model and Performance Indices
Figure 37 – Baseform’s software Diagnose tools – Network modeling capability
. Network Model – Efficient, Java-implemented Epanet simulation engine for full-range hydraulic and water quality simulation, with 3D visualization and Google Earth integration. . Performance Indices (PX) – Simulation-based, technical performance assessment of system capacity, water quality, energy use and any other system behavior.
Page 48 of 53
D2.2 DSP HUB software – Beta release report POWER 25.09.2017 687809
5.6 The Predict modules: Failure, Inspections, Component Importance and Unmet Demand
Figure 38 – Baseform’s software Predict tools – Failure analysis capability
. Failure Analysis (FAIL) - Using system component failure records, such as work orders, predicts present and future probability of failure of pipes or sewers. . Inspections Analysis (INSP) - Using pipeline/sewer inspection and condition assessment records, predicts future condition, residual life, and guide the inspection effort. . Component Importance (CIMP) - Assesses the consequence of failure of each pipe in a water supply network, by simulating the resulting reduced service. . Unmet Demand (UNMET) - Quantifies supply service interruption risk through expected reduced service, based on individual pipe failure probabilities and consequences.
5.7 The Planning modules: Plan, Performance Indicators, Financial Analysis and IVI . PLAN - Compare & Prioritize – Decision-support environment where competing/strategies projects are measured up and prioritized through objectives-guided metrics. . Performance Indicators (PI) – A framework for selection and calculation of KPI based on organized libraries, including industry standards (IWA) and user-developed libraries. . Financial Analysis (FIN) – Assesses net present value (NPV) and the internal rate of return (IRR) of any financial project from a long-term perspective. . Infrastructure Value Index (IVI) – Analyses the ageing degree of an infrastructure comprised of any number of assets, and forecasts short- and long-term investment and rehab needs.
Page 49 of 53
D2.2 DSP HUB software – Beta release report POWER 25.09.2017 687809
Figure 39 – Baseform’s software Plan tools – Compare&Prioritize capability
Page 50 of 53
D2.2 DSP HUB software – Beta release report POWER 25.09.2017 687809
6 Final remarks This report is the main deliverable of Task 2.2 Development of the DSP HUB (M6 – M12), the second task of Work Package 2: DSP set-up and start-up (M1-M48). The task is concerned with the development of the HUB backend content manager, which was duly carried out in full. This report accompanies the M12 Beta release of the DSP HUB software, which was made available to the project partners on 23/11/2016 at hub.baseform.com, with an initial group of close to 50 project partner and city users registered by that date. The software follows the concept and the architecture of the POWER Digital Social Platform (DSP), the project’s central support tool for driving sustainable behavior and extending a raised collective awareness on the environment and the consequences of our actions. The HUB forms the backbone of the DSP and is made available to the demonstrator cities and other stakeholders to support project work. It follows the architecture and functionalities specified in Task 2.1 and detailed in the D2.1 General architecture, functionalities and analysis report. It is aimed primarily as a data organization and back-office facility for the public-facing PUB DSP websites, whose software is to be made available at a later stage (M15). The HUB is not a traditional content manager, in that, in addition to the customary components for creating, editing and managing new content, managing participants and their data (comments, tips) and statistics, the backend provides a platform with the potential to integrate with other systems that may provide data, intelligence or communications with the stakeholders. Additionally, an analytics engine allows the HUB to process interaction results in order to provide improvement criteria for the cities to decide how to make the social process even more effective. This is an important aspect because one of the main challenges in the management of water-related problems is the translation of very technical information into an assertive, objective language that all users perceive. The HUB also fully supports multi-lingual instances of the DSP. From the viewpoint of the backend and in the context of the POWER DSP, a further integration with a set of technical applications – including previously-existing, optional-usage Baseform modules as planned in the DoW – allows the demonstrator cities to integrate technical data and turn it into key indicators, live charts and other information that may be of assistance in the engagement and communication process. Initial training and a permanent support structure for the partners involved in producing content, in particular the key demonstrator city teams, has been set up by Baseform, and is in full operation. Thematic support has also been actively provided by other partners in the project, in particular by DMU and EIPCM. This report provides a summary of the HUB’s purpose and functionality, with a description of how to access and use its various modules. The report includes detailed instructional materials to guide the users through the steps required in order to take full advantage of the modules’ functionality. This report will be shortly followed by the deliverables describing the other two major components of the DSP, coinciding with their software Beta releases on months M15 and M17 respectively: the PUB browser- based portal (D2.3) and the MOB mobile app (D2.4).
Page 51 of 53
D2.2 DSP HUB software – Beta release report POWER 25.09.2017 687809
Appendix A – Baseform software Quickstarts and How-to Guides The following software usage documentation can be found in the Quickstart area of the Hub (its home screen, after log-in) alongside video tutorials and other materials: 01. DATA_MANAGER_quickstart_sm.pdf 02. How To Upload backup and restore files_sm.pdf 03. SHAPE_quickstart_sm.pdf 04. NETWORK_MODEL_quickstart_sm.pdf 05a. PX_quickstart_sm.pdf 05b. How To Access and edit the PX library_sm.pdf 06. FAIL_quickstart_sm.pdf 07. CIMP_quickstart_sm.pdf 08. UNMET_quickstart_sm.pdf 09. PLAN_quickstart_sm.pdf 10a. PI_quickstart_sm.pdf 10b. How To Create or edit a PI library_sm.pdf 11. FIN_quickstart_sm.pdf 12. IVI_quickstart_sm.pdf
Page 52 of 53
D2.2 DSP HUB software – Beta release report POWER 25.09.2017 687809
References
1 [Baseform] Core Technology,2017 (https://baseform.com/np4/tech) 2 [TinyMCE] The Most Advanced WYSIWYG HTML Editor, 2017 (https://www.tinymce.com/)
3 [Flot] Attractive JavaScript plotting for jQuery, 2017 (http://www.flotcharts.org/)
4 [JSON] JSON (http://www.json.org/)
5 [ChartJS] Open source HTML5 Charts for your website, 2017 (http://www.chartjs.org/)
6 [ArcGIS Online] Shapefiles - ArcGIS Online Help, 2017 (http://doc.arcgis.com/en/arcgis- online/reference/shapefiles.htm)
Page 53 of 53