Skip to content

Commit

Permalink
Merge pull request #1113 from Deltares/bogaardt-patch-2
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
bogaardt authored Dec 4, 2024
2 parents 5f4d7c8 + dfbd315 commit 236bfaa
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions docs/public/project/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Key assumptions regarding the development process are:

## 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:
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 Software days (refer to presentations). The key features were defined as:

Functional:

Expand All @@ -64,7 +64,7 @@ Functional:

Non-functional:

- Focus on code quality, test and deployement process.
- Focus on code quality, test and deployment process.
- Adhere present day insights regarding cyber security, authentication and Authorization
- Performance
- Relevant configuration will be part of the existing Delft-FEWS configuration concept.
Expand All @@ -74,12 +74,12 @@ In line with the features listed above, the first release of Web OC ([Dec 2023](
| 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).<br>Visualize timeseries configured in Filters.xml when linked to toplogy node (graph/table view).<br>Show associated threshold levels in time series graphs.<br>Show associated quality flags in table view.<br>Show SCADA displays including support for most click-actions.<br>Visualize data layers configured in the spatial display.<br>Ensembles not supported yet. |
| Dispatching jobs | Not supported in this release. However, FewsWebServices toplogy/nodes? Endpoint extended with information on workflows. |
| Visualize data (time series, map fields, SCADA displays, also including associated information such as thresholds). | Visualize configured Display Groups when linked to topology node (graph/table view).<br>Visualize timeseries configured in Filters.xml when linked to topology node (graph/table view).<br>Show associated threshold levels in time series graphs.<br>Show associated quality flags in table view.<br>Show SCADA displays including support for most click-actions.<br>Visualize data layers configured in the spatial display.<br>Ensembles not supported yet. |
| Dispatching jobs | Not supported in this release. However, FewsWebServices topology/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):<br>- Version management: Subversion<br>- Issue tracking in JIRA<br>- Development feature and unit tests<br>- Code Review<br>- Deploy new FewsWebServices on test server (both open and authorized version). ||
|| Front-end (Libaries and Web OC components):<br>- Version management: Deltares Github<br>- Issue tracking in JIRA<br>- New branch in Git for each issue (manual) <br>- Review and push to main branch (manual)<br>- Run tests for Typescript libraries (automated Teamcity)<br>- Run test for Web OC components (automated Teamcity)<br>- Test successful, deploy on Azure test environment (artifact on build server) |
| Focus on code quality, test and deployment process. | Back-end (FewsWebServices):<br>- Version management: Subversion<br>- Issue tracking in JIRA<br>- Development feature and unit tests<br>- Code Review<br>- Deploy new FewsWebServices on test server (both open and authorized version). ||
|| Front-end (Libraries and Web OC components):<br>- Version management: Deltares Github<br>- Issue tracking in JIRA<br>- New branch in Git for each issue (manual) <br>- Review and push to main branch (manual)<br>- Run tests for Typescript libraries (automated Teamcity)<br>- Run test for Web OC components (automated Teamcity)<br>- 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<br>FEWS permissions as configured in FEWS configuration respected by FewsWebServices<br>Run automated ZAP scan (OWASP) on Web OC components and demo Web OC.<br>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](https://deltares.github.io/fews-web-oc/configuration/) |
Expand Down

0 comments on commit 236bfaa

Please sign in to comment.