blob: 3b2ff9ff3b013b930f5ee68cdcbd1430437eb966 [file] [log] [blame]
[[section-introduction-and-goals]]
== Introduction and Goals
Distribution System Operators (DSO) are bodies of public affairs (BPA). As such they are included in the coordination processes for project planning, land use planning and infrastructure projects. Their comments, objections and notices must be taken into account in the upcoming planning processes. The procedure of these inquiries follow a standardized process and are triggered in a similar form on a regular basis.
To support these processes, a systematic management of these inquiries are recommended to the network operator.
The openKONSEQUENZ platform already provides a rich set of modules providing solutions to support network operators.
The new module statement public affairs is planned as an openKONSEQUENZ user module to support network operator staff with these recurring processes.
=== Requirements Overview
The module Statement Public Affairs shall support the processing of statement requests from the receiving of new statement requests, over the evaluation of the request and the creation of the statement response, to the dispatch of the response to the receiver. New requests can come in via mail or e-mail. Both sources shall be considered as entry points to process new statement requests with the module. The creation process of a statement response requires a joint contribution of multiple workers in different user roles. The statement processing shall address these workflows in the module implementation. The dispatch of statement responses shall also be possible via mail or e-mail.
=== Quality Goals
The following documents contain the quality goals in detail:
* Architecture Committee Handbook v1.6.0 from 10-07-2019
* Quality Committee Handbook v2.0.1 from 15-10-2018
The architecture is based on the AC-Handbook. The quality demands are described in the QC-Handbook.
Both specifications were fully complied with in the project, so that a high quality is given.
The code quality regarding static code analysis and unit test code coverage on the back-end and front-end sides are ensured by the use of sonarqube. The rule set and the quality gate are defined by the default, the so called "sonar way" in agreement with the AC/QC.
The module 'Statement Public Affairs' is part of the Eclipse project 'Eclipse openK User Modules'.
This project bases on the Eclipse Public Licence 2.0.
=== Stakeholders
.Stakeholders
[options="header",cols="1,2,2"]
|===
|Role/Name|Contact|Expectations
| Product Owner | Benedikt Herget, Holger Kronschnabel | The software must fulfil their functional and nonfunctional requirements.
| Module Developer | Dr. Christopher Keim, Tobias Stummer| All relevant technical information must be available for implementing the software.
| Scrum Master | Samir Al-Hilank | The module development follows the scrum process.
|External Reviewer (represents the AC/QC)| Heiko Oberlรคnder, Alexander Langold |The software and the documentation is realized according to the Quality and Architecture Handbook of openKONSEQUENZ.
|External Reviewer (represents the Eclipse-Requirements)|n.n.|The software is licensed under the EPL 2.0. It must be validated that all requirements are fulfilled.
|System Integrator|n.n.|A documentation for the integration of the module in the DSO specific environments must be available.
|===