fews-web-oc

Web OC project

Introduction

At Deltares, we notice an increasing number of requests for web-based user-interfaces connected to Delft-FEWS. Also, we see that there is a broader move ongoing towards online user-interfaces, with many comparable packages used internationally already providing such solutions. As such, the Delft-FEWS 2025 vision also incorporates the development of a Web-based Operator Client Web OC.

Development goals

Considering the use-case for a Web OC, we see the following key benefits:

Furthermore, key overall assumptions are:

Development process

Key assumptions regarding the development process are:

Project timeline

Time Period Activities
2020 Q4 International User Days. Presenting Web OC plans: Vision 2025.
2021 Define use-cases and key assumptions and MVP.
First steps towards technical architecture: Involve both Deltares and external colleagues.
  Start development work.
  International User Days. Present architecture and 3rd party collaboration.
Interactive sessions on key functionality.
2022 Third-party testing of reusability Web OC building blocks.
  Continuation of development work.
User feedback session during CSB meeting and NL/INT User Days.
  International User Days. Demonstration / Plug & Play session Web OC / UI/UX Design session.
2023 Continuation of development work.
  International User Days. Presentation status Web OC Developments.
Dec 2023 Software (0.0.1) available on GitHub.
2024 January Delft-FEWS Web OC Release 1.0.0 (compatible with 2023.02 back-end).
  July Delft-FEWS Web OC Release 1.1.0 (compatible with 2023.02 & 2024.01 back-end).
  Web OC Development in line with the current Delft-FEWS business model.

Present status

As stated in the section “Development process ” the development of Web OC will apply a growth model. Starting from initial requirements and an initial prioritization, relevant functionality will be gradually and iteratively included or enhanced (in line with the current Delft-FEWS business model). The initial requirements for the first release of Web OC have been defined together with the community during sessions organized at the FEWS Sofware days (refer to presentations). The key features were defined as:

Functional:

Non-functional:

In line with the features listed above, the first release of Web OC (Dec 2023), will include the following:

Initial requirements Web OC release 1.0.0 (Dec 2023)*  
Functional    
Visualize data (time series, map fields, SCADA displays, also including associated information such as thresholds). Visualize configured Display Groups when linked to toplogy node (graph/table view).
Visualize timeseries configured in Filters.xml when linked to toplogy node (graph/table view).
Show associated threshold levels in time series graphs.
Show associated quality flags in table view.
Show SCADA displays including support for most click-actions.
Visualize data layers configured in the spatial display.
Ensembles not supported yet.
 
Dispatching jobs Not supported in this release. However, FewsWebServices toplogy/nodes? Endpoint extended with information on workflows.  
Visualize monitoring information “Import status” and “Running Tasks” components of system monitor available in Web OC.  
Non-functional    
Focus on code quality, test and deployement process. Back-end (FewsWebServices):
- Version management: Subversion
- Issue tracking in JIRA
- Development feature and unit tests
- Code Review
- Deploy new FewsWebServices on test server (both open and authorized version).
 
  Front-end (Libaries and Web OC components):
- Version management: Deltares Github
- Issue tracking in JIRA
- New branch in Git for each issue (manual)
- Review and push to main branch (manual)
- Run tests for Typescript libraries (automated Teamcity)
- Run test for Web OC components (automated Teamcity)
- Test successful, deploy on Azure test environment (artifact on build server)
 
Adhere present day insights regarding cyber security, authentication and authorization Using OpenID Connect / Oauth2, for both Web OC front-end and FewsWebServices
FEWS permissions as configured in FEWS configuration respected by FewsWebServices
Run automated ZAP scan (OWASP) on Web OC components and demo Web OC.
Web OC will directly connect to FewsWebServices to obtain configuration and relevant data from the FEWS database.
 
Performance During the development process of Web OC, the FewsWebServices back-end will be enhanced continuously to improve performance and add functionality. It is intended not to introduce any additional software to the Web OC stack to further improve the performance of Web OC.  
Relevant configuration will be part of the existing Delft-FEWS configuration concept. All configuration related to what content is being displayed in Web OC, is managed by the Delft-FEWS configuration. Web OC Configuration  

See release notes section for updates since Dec 2023.

*Please note that Web OC will not support all functionality available in the Desktop OC regarding the features listed above. In addition, not all configurations might be supported. For questions on this matter, please contact Web OC Team via fews-pm@deltares.nl.

Future plans

Following the current release of Web OC, the software will be developed further in line with the current Delft-FEWS business model. Currently, the following features are planned for:

Architectural principles

Key assumptions regarding the technical design and requirements are:

How to use Web OC in your organization?

Provided that you have a running Delft-FEWS system already, its suggested to follow the steps below to get started with Web OC.