Merge branch 'DEVELOP' of ssh://git.eclipse.org:29418/openk-usermodules/org.eclipse.openk-usermodules.contactBaseData.backend into DEVELOP
diff --git a/src/main/asciidoc/architectureDocumentation/architectureDocumentation.adoc b/src/main/asciidoc/architectureDocumentation/architectureDocumentation.adoc
index 5b0a523..83fb1fd 100644
--- a/src/main/asciidoc/architectureDocumentation/architectureDocumentation.adoc
+++ b/src/main/asciidoc/architectureDocumentation/architectureDocumentation.adoc
@@ -1,4 +1,4 @@
-////
+////
*******************************************************************************
* Copyright (c) 2019 Contributors to the Eclipse Foundation
*
@@ -29,7 +29,7 @@
=== Requirements Overview
-Many user modules of an openKONSEQUENZ installion need contact datas for their
+Many user modules of an openKONSEQUENZ installion need contact data for their
daily business. Furthermore they have to fulfil the regulatory requirement
of the General Data Protection Regulation (GDPR).
@@ -49,17 +49,17 @@
* *Flexibility* The reference platform shall grant that different systems and modules from different vendors/developers can interact and interoperate, and may be exchanged or recombined.
* *Availability* All platform modules that are running on the platform can only be as available as the platform same for user modules that are based on platform modules.
* *Maintainability* (and testability as part of maintainability) The platform and its platform modules shall be used longer than 15 years.
-* *Integration performance* New implemented functionality of oK own modules and external modules shall be included fast / automatically.
+* *Integration performance* New implemented functionality of oK's own modules and external modules shall be included fast / automatically.
* *Security* The platform and its modules need to underly security-by-design
The main quality goals of the core module Contact Base Data are:
* *Functionality* The core module must fulfil the functional requirements mentioned in the section before
-* *Ergonomics* The web interface must be realized according to oK-GUI-Styleguide.
+* *Ergonomics* The web interface must be realized according to oK-GUI-styleguide.
* *Good documentation* (i.e. code and architecture documentation) makes code changes easier and automatic
tests facilitate rigorous verification.
* *Modifiability* (and testability as part of modifiability)
-* *Integration performance* The core module must be easy integratable in different production environments.
+* *Integration performance* The core module's integration into different production environments has to be easy.
The following documents contain the quality goals in detail:
@@ -69,7 +69,7 @@
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 backend and fronend sides
+The code quality regarding static code analysis and unit test code coverage on the backend and frontend sides
are ensured by the use of sonarqube. The rule set and the qualtity gate are defined by the default, the
so called "sonar way".
@@ -478,9 +478,9 @@
=== Solution Strategy
-The module 'Contact Base Data' bases on a three-tier architecture:
+The module 'Contact Base Data' is based on a three-tier architecture:
-. *Frontend* - The GUI is implemented as a web-frontend with rich-client functionalities.
+. *Frontend* - The GUI is implemented as a web-frontend with rich-client functionality.
. *Backend* - The business functionalities are implemented in the backend tier. It provides the business functions via RESTful Webservices.
. *Database* - The database stores all module specific data.
@@ -493,7 +493,7 @@
. *UI* - Represents the graphical user interface and consumes the services from the business logic component via RESTful webservices.
. *Business Logic* - Realizes the business functionality and the data storage of the module. The
-module itself is split up in several components due to the requirement to use
+module itself is split up into several components due to the requirement to use
microservices.
.Module components
@@ -542,7 +542,7 @@
==== ContactBaseDataFE (frontend tier)
-The frontend component implements the concept of a single-page application (SPA). The framework used is Angular5.
+The frontend component implements the concept of a single-page application (SPA). The framework used is Angular 8.
It divides the contactBaseDataFE into three layers:
@@ -701,7 +701,7 @@
The component "Flyway" is used to make to distribute structural
or content related changes to the database.
-The database is built out of the scripts in the directory "db/migrations". Every sql
+The database is built out of the scripts in the directory "db/migrations". Every SQL
script contains the complete db script for the contact base data database (in different versions).
The highest version number indicates the currently valid script.
@@ -719,12 +719,12 @@
This yml-file can be divided into different configuration profiles.
When starting the backend-service one has the possibility to specify
-the active profile
+the active profile.
* *spring.datasource* configuration section for the database connection
* *flyway.enabled* If enabled=true then the database migrations
- will automatically performed when starting the application
- (this parameter should normally be set to "false"
+ will be performed automatically when starting the application
+ (this parameter should normally be set to "false")
* *server.max-http-header-size* Maximum size for the http-headers
* *jwt.tokenHeader* Name of the http-header which carries the authentication-token.
(should be "Authorization")
@@ -732,9 +732,9 @@
as Authorization-token. (This won't work for calls to other modules
like the Auth'n'Auth-Modul, because the token will be out of date)
* *authNAuthService.ribbon.listOfServers* Here one can configure the base
- url to the Auth'n'Auth-Service
+ URL to the Auth'n'Auth-service
* *ldap.enabled* If set to "true" the ldap functionality will be enabled
-* *ldap.scheduling.enabled* (true or false) swtiches the ldap synchronisation on/off
+* *ldap.scheduling.enabled* (true or false) switches the ldap synchronisation on/off
db-id-mapping: (-1) off = editable
mail-id: 1
@@ -762,13 +762,13 @@
. "SNAPSHOT" or "DEVELOP"
. "MASTER" or "TRUNC"
-The running development is exclusively made on the Snapshot-Branch. Every time
+The running development is exclusively made on the snapshot-branch. Every time
a developer checks in (pushes) code to the repository, an automatic build
-starts on the hudson ci-server. If the Snapshot-build is successful, then the result
-of that build is directly deployed on the Dev-environment.
+starts on the hudson ci-server. If the snapshot-build is successful, then the result
+of that build is directly deployed on the dev-environment.
At the end of a scrum sprint or when a big user story is realized, all
-the code changes are merged from the *Snapshot*-Branch to the *Trunc*.
+code changes are merged from the *SNAPSHOT*-Branch to the *TRUNC*.
This automatically triggers the build and the deployment on the
Q-environment.
@@ -793,10 +793,10 @@
|CNCU|Central Network Control Unit||
|DAO|Data Access Objects||
|DTO|Data Transfer Object||
-|DSO|Distribution System Operator|Verteilnetz-betreiber (VNB)|Manages the distribution network for energy, gas or water.
+|DSO|Distribution System Operator|Verteilnetzbetreiber (VNB)|Manages the distribution network for energy, gas or water.
|EPL|Eclipse Public License||Underlying license model for Eclipse projects like contact-base-data@openK
|ESB|Enterprise Service Bus||Central instance to exchange data to overcome point-to-point connections.
|oK|openKONSEQUENZ|openKONSEQUENZ|Name of the consortium of DSOs
|QC|Quality Committee|Qualitätskomitee|Gives framework and constraints according to quality for oK projects.
-|SCADA|Supervisory Control and Data Acquisition|Netzleitsystem|System, that allows DSOs view/control actual parameters of their power grid.
+|SCADA|Supervisory Control and Data Acquisition|Netzleitsystem|System, that allows DSOs to view/control actual parameters of their power grid.
|========================================================
diff --git a/src/main/asciidoc/img/abbrechen.png b/src/main/asciidoc/img/abbrechen.png
index cf98a3a..4c4abb2 100644
--- a/src/main/asciidoc/img/abbrechen.png
+++ b/src/main/asciidoc/img/abbrechen.png
Binary files differ
diff --git a/src/main/asciidoc/img/abmelden.png b/src/main/asciidoc/img/abmelden.png
index 1a8799f..db1eb04 100644
--- a/src/main/asciidoc/img/abmelden.png
+++ b/src/main/asciidoc/img/abmelden.png
Binary files differ
diff --git a/src/main/asciidoc/img/admin-menue-symbol.png b/src/main/asciidoc/img/admin-menue-symbol.png
new file mode 100644
index 0000000..24c32dd
--- /dev/null
+++ b/src/main/asciidoc/img/admin-menue-symbol.png
Binary files differ
diff --git a/src/main/asciidoc/img/adresse-anlegen.png b/src/main/asciidoc/img/adresse-anlegen.png
new file mode 100644
index 0000000..f73886d
--- /dev/null
+++ b/src/main/asciidoc/img/adresse-anlegen.png
Binary files differ
diff --git a/src/main/asciidoc/img/adresseliste-gefuellt.png b/src/main/asciidoc/img/adresseliste-gefuellt.png
new file mode 100644
index 0000000..34504c3
--- /dev/null
+++ b/src/main/asciidoc/img/adresseliste-gefuellt.png
Binary files differ
diff --git a/src/main/asciidoc/img/adressliste-leer.png b/src/main/asciidoc/img/adressliste-leer.png
new file mode 100644
index 0000000..d09b5a3
--- /dev/null
+++ b/src/main/asciidoc/img/adressliste-leer.png
Binary files differ
diff --git a/src/main/asciidoc/img/adresstyp-anlegen.png b/src/main/asciidoc/img/adresstyp-anlegen.png
new file mode 100644
index 0000000..eb6ff9e
--- /dev/null
+++ b/src/main/asciidoc/img/adresstyp-anlegen.png
Binary files differ
diff --git a/src/main/asciidoc/img/adresstypen-uebersicht.png b/src/main/asciidoc/img/adresstypen-uebersicht.png
new file mode 100644
index 0000000..dce5123
--- /dev/null
+++ b/src/main/asciidoc/img/adresstypen-uebersicht.png
Binary files differ
diff --git a/src/main/asciidoc/img/anpsrechpartner-leer.png b/src/main/asciidoc/img/anpsrechpartner-leer.png
new file mode 100644
index 0000000..5c0436e
--- /dev/null
+++ b/src/main/asciidoc/img/anpsrechpartner-leer.png
Binary files differ
diff --git a/src/main/asciidoc/img/anrede-anlegen.png b/src/main/asciidoc/img/anrede-anlegen.png
new file mode 100644
index 0000000..f5f34a2
--- /dev/null
+++ b/src/main/asciidoc/img/anrede-anlegen.png
Binary files differ
diff --git a/src/main/asciidoc/img/ansprechpartner-anlegen.png b/src/main/asciidoc/img/ansprechpartner-anlegen.png
new file mode 100644
index 0000000..f57a9ca
--- /dev/null
+++ b/src/main/asciidoc/img/ansprechpartner-anlegen.png
Binary files differ
diff --git a/src/main/asciidoc/img/ansprechpartner-gefuellt.png b/src/main/asciidoc/img/ansprechpartner-gefuellt.png
new file mode 100644
index 0000000..3b44ee2
--- /dev/null
+++ b/src/main/asciidoc/img/ansprechpartner-gefuellt.png
Binary files differ
diff --git a/src/main/asciidoc/img/auge-symbol.png b/src/main/asciidoc/img/auge-symbol.png
index 6bb5e6f..455abd2 100644
--- a/src/main/asciidoc/img/auge-symbol.png
+++ b/src/main/asciidoc/img/auge-symbol.png
Binary files differ
diff --git a/src/main/asciidoc/img/auswahl-kontakt-anlegen.png b/src/main/asciidoc/img/auswahl-kontakt-anlegen.png
new file mode 100644
index 0000000..3b57b74
--- /dev/null
+++ b/src/main/asciidoc/img/auswahl-kontakt-anlegen.png
Binary files differ
diff --git a/src/main/asciidoc/img/auswahl-kontakttypen.png b/src/main/asciidoc/img/auswahl-kontakttypen.png
new file mode 100644
index 0000000..5d1bc27
--- /dev/null
+++ b/src/main/asciidoc/img/auswahl-kontakttypen.png
Binary files differ
diff --git a/src/main/asciidoc/img/auswahl-sortierung-2.png b/src/main/asciidoc/img/auswahl-sortierung-2.png
new file mode 100644
index 0000000..319866f
--- /dev/null
+++ b/src/main/asciidoc/img/auswahl-sortierung-2.png
Binary files differ
diff --git a/src/main/asciidoc/img/auswahl-sortierung.png b/src/main/asciidoc/img/auswahl-sortierung.png
new file mode 100644
index 0000000..63ef815
--- /dev/null
+++ b/src/main/asciidoc/img/auswahl-sortierung.png
Binary files differ
diff --git a/src/main/asciidoc/img/dialog-nach-abbrechen.png b/src/main/asciidoc/img/dialog-nach-abbrechen.png
new file mode 100644
index 0000000..fa13b42
--- /dev/null
+++ b/src/main/asciidoc/img/dialog-nach-abbrechen.png
Binary files differ
diff --git a/src/main/asciidoc/img/externe-person-1.png b/src/main/asciidoc/img/externe-person-1.png
new file mode 100644
index 0000000..3b451b8
--- /dev/null
+++ b/src/main/asciidoc/img/externe-person-1.png
Binary files differ
diff --git a/src/main/asciidoc/img/haus-symbol.png b/src/main/asciidoc/img/haus-symbol.png
new file mode 100644
index 0000000..4ace3d2
--- /dev/null
+++ b/src/main/asciidoc/img/haus-symbol.png
Binary files differ
diff --git a/src/main/asciidoc/img/interne-person-1.png b/src/main/asciidoc/img/interne-person-1.png
new file mode 100644
index 0000000..03754b1
--- /dev/null
+++ b/src/main/asciidoc/img/interne-person-1.png
Binary files differ
diff --git a/src/main/asciidoc/img/interne-person-2.png b/src/main/asciidoc/img/interne-person-2.png
new file mode 100644
index 0000000..61fac82
--- /dev/null
+++ b/src/main/asciidoc/img/interne-person-2.png
Binary files differ
diff --git a/src/main/asciidoc/img/kommunikationskanaele-leer.png b/src/main/asciidoc/img/kommunikationskanaele-leer.png
new file mode 100644
index 0000000..1ddc182
--- /dev/null
+++ b/src/main/asciidoc/img/kommunikationskanaele-leer.png
Binary files differ
diff --git a/src/main/asciidoc/img/kommunikationskanal-anlegen.png b/src/main/asciidoc/img/kommunikationskanal-anlegen.png
new file mode 100644
index 0000000..55407a6
--- /dev/null
+++ b/src/main/asciidoc/img/kommunikationskanal-anlegen.png
Binary files differ
diff --git a/src/main/asciidoc/img/kommunikationskanal-gefuellt.png b/src/main/asciidoc/img/kommunikationskanal-gefuellt.png
new file mode 100644
index 0000000..83bf398
--- /dev/null
+++ b/src/main/asciidoc/img/kommunikationskanal-gefuellt.png
Binary files differ
diff --git a/src/main/asciidoc/img/kommunikationstyp-nur-ansicht.png b/src/main/asciidoc/img/kommunikationstyp-nur-ansicht.png
new file mode 100644
index 0000000..80950be
--- /dev/null
+++ b/src/main/asciidoc/img/kommunikationstyp-nur-ansicht.png
Binary files differ
diff --git a/src/main/asciidoc/img/kommunikationstypen-anlegen.png b/src/main/asciidoc/img/kommunikationstypen-anlegen.png
new file mode 100644
index 0000000..4590ad0
--- /dev/null
+++ b/src/main/asciidoc/img/kommunikationstypen-anlegen.png
Binary files differ
diff --git a/src/main/asciidoc/img/kommunikationstypen-uebersicht.png b/src/main/asciidoc/img/kommunikationstypen-uebersicht.png
new file mode 100644
index 0000000..6fd7f21
--- /dev/null
+++ b/src/main/asciidoc/img/kommunikationstypen-uebersicht.png
Binary files differ
diff --git a/src/main/asciidoc/img/kontakte_uebersichtstabelle.png b/src/main/asciidoc/img/kontakte_uebersichtstabelle.png
new file mode 100644
index 0000000..72d4f4d
--- /dev/null
+++ b/src/main/asciidoc/img/kontakte_uebersichtstabelle.png
Binary files differ
diff --git a/src/main/asciidoc/img/loesch-symbol.png b/src/main/asciidoc/img/loesch-symbol.png
new file mode 100644
index 0000000..22af7fa
--- /dev/null
+++ b/src/main/asciidoc/img/loesch-symbol.png
Binary files differ
diff --git a/src/main/asciidoc/img/meldung-hinweis.png b/src/main/asciidoc/img/meldung-hinweis.png
new file mode 100644
index 0000000..fefb6ad
--- /dev/null
+++ b/src/main/asciidoc/img/meldung-hinweis.png
Binary files differ
diff --git a/src/main/asciidoc/img/meldung-loeschen.png b/src/main/asciidoc/img/meldung-loeschen.png
new file mode 100644
index 0000000..9d70d50
--- /dev/null
+++ b/src/main/asciidoc/img/meldung-loeschen.png
Binary files differ
diff --git a/src/main/asciidoc/img/modul-zuordnen.png b/src/main/asciidoc/img/modul-zuordnen.png
new file mode 100644
index 0000000..3b56d58
--- /dev/null
+++ b/src/main/asciidoc/img/modul-zuordnen.png
Binary files differ
diff --git a/src/main/asciidoc/img/modulzuordnung-gefuellt.png b/src/main/asciidoc/img/modulzuordnung-gefuellt.png
new file mode 100644
index 0000000..0ab1681
--- /dev/null
+++ b/src/main/asciidoc/img/modulzuordnung-gefuellt.png
Binary files differ
diff --git a/src/main/asciidoc/img/modulzuordnung-leer.png b/src/main/asciidoc/img/modulzuordnung-leer.png
new file mode 100644
index 0000000..20923b9
--- /dev/null
+++ b/src/main/asciidoc/img/modulzuordnung-leer.png
Binary files differ
diff --git a/src/main/asciidoc/img/neu.png b/src/main/asciidoc/img/neu.png
new file mode 100644
index 0000000..b9c37be
--- /dev/null
+++ b/src/main/asciidoc/img/neu.png
Binary files differ
diff --git a/src/main/asciidoc/img/oeffnen-modul.png b/src/main/asciidoc/img/oeffnen-modul.png
index c6ef04c..e031a76 100644
--- a/src/main/asciidoc/img/oeffnen-modul.png
+++ b/src/main/asciidoc/img/oeffnen-modul.png
Binary files differ
diff --git a/src/main/asciidoc/img/personentypen-anlegen.png b/src/main/asciidoc/img/personentypen-anlegen.png
new file mode 100644
index 0000000..4988a36
--- /dev/null
+++ b/src/main/asciidoc/img/personentypen-anlegen.png
Binary files differ
diff --git a/src/main/asciidoc/img/personentypen-uebersicht.png b/src/main/asciidoc/img/personentypen-uebersicht.png
new file mode 100644
index 0000000..67e3f2f
--- /dev/null
+++ b/src/main/asciidoc/img/personentypen-uebersicht.png
Binary files differ
diff --git a/src/main/asciidoc/img/speichern.png b/src/main/asciidoc/img/speichern.png
index d24aeb4..74aec3a 100644
--- a/src/main/asciidoc/img/speichern.png
+++ b/src/main/asciidoc/img/speichern.png
Binary files differ
diff --git a/src/main/asciidoc/img/stift-symbol.png b/src/main/asciidoc/img/stift-symbol.png
index c892d04..3c392e5 100644
--- a/src/main/asciidoc/img/stift-symbol.png
+++ b/src/main/asciidoc/img/stift-symbol.png
Binary files differ
diff --git a/src/main/asciidoc/img/such-symbol.png b/src/main/asciidoc/img/such-symbol.png
new file mode 100644
index 0000000..2207a59
--- /dev/null
+++ b/src/main/asciidoc/img/such-symbol.png
Binary files differ
diff --git a/src/main/asciidoc/img/suche-beispiel.png b/src/main/asciidoc/img/suche-beispiel.png
new file mode 100644
index 0000000..8777abc
--- /dev/null
+++ b/src/main/asciidoc/img/suche-beispiel.png
Binary files differ
diff --git a/src/main/asciidoc/img/tabellen-menue.png b/src/main/asciidoc/img/tabellen-menue.png
new file mode 100644
index 0000000..943eced
--- /dev/null
+++ b/src/main/asciidoc/img/tabellen-menue.png
Binary files differ
diff --git a/src/main/asciidoc/img/tabellenspalten-verschieben.png b/src/main/asciidoc/img/tabellenspalten-verschieben.png
new file mode 100644
index 0000000..0953ee8
--- /dev/null
+++ b/src/main/asciidoc/img/tabellenspalten-verschieben.png
Binary files differ
diff --git a/src/main/asciidoc/img/uebersicht-anrede.png b/src/main/asciidoc/img/uebersicht-anrede.png
new file mode 100644
index 0000000..4c9163f
--- /dev/null
+++ b/src/main/asciidoc/img/uebersicht-anrede.png
Binary files differ
diff --git a/src/main/asciidoc/img/unternehmen-2.png b/src/main/asciidoc/img/unternehmen-2.png
new file mode 100644
index 0000000..a494ec9
--- /dev/null
+++ b/src/main/asciidoc/img/unternehmen-2.png
Binary files differ
diff --git a/src/main/asciidoc/img/unternehmen.png b/src/main/asciidoc/img/unternehmen.png
new file mode 100644
index 0000000..d2e344b
--- /dev/null
+++ b/src/main/asciidoc/img/unternehmen.png
Binary files differ
diff --git a/src/main/asciidoc/userDocumentation/userDocumentation.adoc b/src/main/asciidoc/userDocumentation/userDocumentation.adoc
new file mode 100644
index 0000000..0309859
--- /dev/null
+++ b/src/main/asciidoc/userDocumentation/userDocumentation.adoc
@@ -0,0 +1,714 @@
+= Benutzerhandbuch: Kontaktstammdaten
+
+<<<
+
+
+* Version: 0.1
+* Datum: 21.02.2020
+* Status: In Bearbeitung
+
+<<<
+
+:Author: Dr. Michel Alessandrini
+:Email: michel.alessandrini@pta.de
+
+:Date: 2020-02-21
+:Revision: 0.1
+
+:icons:
+
+:source-highlighter: highlightjs
+:highlightjs-theme: solarized_dark
+
+:lang: de
+:encoding: utf-8
+
+:imagesdir: ../img
+:iconsdir: ../img/icons
+
+:toc:
+:toclevels: 4
+:toc-title: Inhaltsverzeichnis
+:toc-placement!:
+:sectanchors:
+:numbered:
+
+toc::[]
+
+<<<
+
+== Sinn und Zweck des Moduls Kontaktstammdaten
+
+Das Modul Kontaktstammdaten ist ein Domain-Modul der openKONSEQUENZ.
+
+Das Modul Kontaktstammdaten übernimmt die Verwaltung aller Kontaktdaten
+in einer openKONSEQUENZ-Installation. D.h. es synchronisiert sich mit den
+Benutzern des Auth&Auth-Moduls oder mit dem Unternehmens-LDAP. Des Weiteren
+verwaltet es alle (Internen und Externen) Personen sowie Firmen, die in den
+User Modulen benötigt werden.
+
+Das Modul Kontaktstammdaten ist somit die zentrale Stelle zur Verwaltung
+aller Kontakte und personenbezogener Daten in einer openKONSEQUENZ-Installation.
+Es setzt die DSGVO-Vorgaben um.
+
+<<<
+
+
+[[uebersicht-benutzerrollen]]
+== Benutzerrollen und Aufgaben
+Zur Bearbeitung von Kontaktstammdaten sind folgende Benutzerrollen
+definiert.
+
+[[lesende-rolle]]
+=== Lesende Rolle
+TODO: Am Ende die Links setzen
+
+* <<uebersicht-aller-kontakte,Darf alle Kontakte sehen>>
+
+=== Schreibende Rolle
+TODO: Am Ende die Links setzen
+
+* <<lesende-rolle,Darf alles, was die Lesende Rolle darf>>
+* <<kontakt-erstellen,Darf neue Kontakte anlegen>>
+* <<kontakt-bearbeiten,Darf bestehende Kontakte bearbeiten>>
+
+=== Administrator
+TODO: Am Ende die Links setzen
+
+* <<schreibene-rolle,Darf alles, was die Schreibende Rolle darf>>
+* <<kontakt-loeschen,Darf bestehende Kontakte löschen>>
+* <<stammdaten-pflege,Darf Stammdaten anlegen, bearbeiten, löschen>>
+* <<dsgvo-funktionen,Darf DSGVO-Funktionen ausführen>>
+
+<<<
+
+== Verwaltung der Kontakte
+
+[[uebersicht-aller-kontakte]]
+=== Übersicht
+Die Übersichtsseite stellt standardmäßig alle Kontakte
+in einer Tabelle dar.
+
+.Übersicht der Kontakte
+[options="header,footer"]
+image::kontakte_uebersichtstabelle.png[]
+
+Die Übersichtstabelle zeigt zu jedem Kontakt folgende Informationen an:
+
+.Felder in der Tabellenübersicht
+[options="header,footer"]
+|=========================================================
+|Feld|Erläuterung
+|Name
+a|
+ * Name des Kontakts (Personen- oder Firmen-Name)
+
+|E-Mail
+a|
+
+* E-Mail-Adresse des Kontakts
+
+|Kontakttyp
+a|
+
+* Unternehmen
+* Interne Person
+* Externe Person
+
+|Notiz
+a|
+
+* Bemerkung bzw. Hinweis zu einem Kontakt
+
+|Hauptadresse
+a|
+
+* Primäre Anschrift
+
+|(ohne Überschrift))
+a|
+
+* Bearbeitungssymbole, siehe Abschnitt <<uebersicht-bearbeitungssymbole, Bearbeitungssymbole>>
+
+|=========================================================
+
+[[uebersicht-bearbeitungssymbole]]
+=== Kontakt anlegen, anzeigen, bearbeiten und löschen
+
+Jeder Kontakt kann je nach Benutzerrolle direkt aus der Tabelle angezeigt,
+bearbeitet oder gelöscht werden.
+
+==== Kontakt anzeigen
+
+Über das folgende Symbol in der Tabelle wird der entsprechende Kontakt
+zur Anzeige geöffnet.
+
+.Auge-Symbol zum Anzeigen eines Kontakts
+[options="header,footer"]
+image::auge-symbol.png[]
+
+CAUTION: Das Auge-Symbol ist nur bei der "Lesenden Rolle" sichtbar
+
+==== Kontakt bearbeiten
+
+Über das folgende Symbol in der Tabelle wird der entsprechende Kontakt
+zur Beareitung geöffnet.
+
+.Stift-Symbol zum Bearbeiten eines Kontakts
+[options="header,footer"]
+image::stift-symbol.png[]
+
+CAUTION: Das Stift-Symbol ist nur bei der "Schreibenden Rolle" und der Rolle "Administrator" sichtbar.
+
+==== Kontakt löschen
+
+Über das folgende Symbol in der Tabelle wird der entsprechende Kontakt
+gelöscht.
+
+.Löschen-Symbol zum Entfernen eines Kontakts
+[options="header,footer"]
+image::loesch-symbol.png[]
+
+CAUTION: Das Mülleimer-Symbol ist nur bei der Rolle "Administrator" sichtbar.
+
+CAUTION: Die Löschfunktion steht nur beim Kontakttyp "Ansprechpartner" zur Verfügung.
+
+Nach Klick auf das Löschen-Symbol erscheint ein Dialog, der mit "Ja" zu bestätigen ist.
+
+.Dialog nach Klick auf Löschen
+[options="header,footer"]
+image:meldung-loeschen.png[]
+
+==== Kontakt anlegen
+
+[[kontakt-erstellen]]
+Ist ein Benutzer mit der Benutzerrolle "Schreibende Rolle" angemeldet,
+so besteht die Möglichkeit über die Schaltfläche "Neuen Kontakt anlegen" einen
+neuen Kontakt anzulegen.
+
+.Schaltfläche zum Erstellen von Kontakten
+[options="header,footer"]
+image:auswahl-kontakt-anlegen.png[]
+
+Hier muss der Bearbeiter den Kontakttyp bestimmen:
+
+.Kontakttypen
+[options="header,footer"]
+|=========================================================
+|Kontakttyp|Erläuterung
+|Interner Kontakt
+a|
+ * Eine natürliche Person, die dem Unternehmen angehört
+
+|Externer Kontakt
+a|
+* Eine natürliche Person, die dem Unternehmen nicht angehört
+
+|Unternehmen
+a|
+* Eine juristische Person
+|=========================================================
+
+Um den Kontakt zu speichern, muss die folgende Schaltfläche betätigt werden.
+
+.Schaltfläche zum Speichern
+[options="header,footer"]
+image:speichern.png[]
+
+Wenn die neu erfassten Daten nicht gespeichert werden sollen, dann ist folgende Schaltfläche zu drücken:
+.Schaltfläche zum Abbrechen (ohne speichern)
+[options="header,footer"]
+image:abbrechen.png[]
+
+Anschließend erscheint ein Dialog, der mit "Ja" zu bestätigen ist.
+
+.Dialog nach Abbrechen
+[options="header,footer"]
+image:dialog-nach-abbrechen.png[]
+
+
+=== Kontakttypen
+
+==== Interne Person
+Die Basisinformationen eines Kontakts befindet sich im oberen
+Teil des Benutzerdialogs.
+
+Pflichtfelder sind farblich markiert. Zunächst sind diese rot. Erst wenn die
+Inhalte entsprechend eingetragen sind, ändert sich die Markierung auf grün.
+
+.Basis-Informationen eines Kontakts am Beispiel einer internen Person
+[options="header,footer"]
+image::interne-person-1.png[]
+
+Eine interne Person besitzt folgende Attribute:
+
+.Attribute einer internen Person
+[options="header,footer"]
+|=========================================================
+|Attribut |Pflichtfeld |Inhaltsart |Beschreibung
+|Vorname |nein |Textfeld |Vorname der natürlichen Person
+|Name |ja |Textfeld |Nachname der natürlichen Person
+|Titel |nein |Textfeld |z.B. Prof. oder Dr.
+|Anrede |nein |Auswahlfeld |Auswahl einer Anrede, z.B. Herr oder Frau
+|Personentyp |nein |Auswahlfeld |Auswahl eines Personentyps
+|LDAP User |nein |Textfeld |Bezeichnung des Benutzers im Unternehmens-LDAP. Wird zur Synchronisation verwendet.
+|Portal User |nein |Textfeld |Bezeichnung des Benutzers im Portal. Wird zur Synchronisation verwendet.
+|Abteilung |nein |Textfeld |Abteilung der Person
+|Notiz |nein |Textfeld |Beliebige Hinweise zur Person
+|=========================================================
+
+==== Externe Person
+Die Basisinformationen eines Kontakts befindet sich im oberen
+Teil des Benutzerdialogs.
+
+Pflichtfelder sind farblich markiert. Zunächst sind diese rot. Erst wenn die
+Inhalte entsprechend eingetragen sind, ändert sich die Markierung auf grün.
+
+.Basis-Informationen eines Kontakts am Beispiel einer externen Person
+[options="header,footer"]
+image::externe-person-1.png[]
+
+Eine externe Person besitzt folgende Attribute:
+
+.Attribute einer externen Person
+[options="header,footer"]
+|=========================================================
+|Attribut |Pflichtfeld |Inhaltsart |Beschreibung
+|Vorname |nein |Textfeld |Vorname der natürlichen Person
+|Name |ja |Textfeld |Nachname der natürlichen Person
+|Titel |nein |Textfeld |z.B. Prof. oder Dr.
+|Anrede |nein |Auswahlfeld |Auswahl einer Anrede, z.B. Herr oder Frau
+|Personentyp |nein |Auswahlfeld |Auswahl eines Personentyps
+|Notiz |nein |Textfeld |Beliebige Hinweise zur Person
+|=========================================================
+
+==== Unternehmen
+Die Basisinformationen eines Kontakts befindet sich im oberen
+Teil des Benutzerdialogs.
+
+Pflichtfelder sind farblich markiert. Zunächst sind diese rot. Erst wenn die
+Inhalte entsprechend eingetragen sind, ändert sich die Markierung auf grün.
+
+.Basis-Informationen eines Kontakts am Beispiel eines Unternehmens
+[options="header,footer"]
+image::unternehmen.png[]
+
+Ein unternehmen besitzt folgende Attribute:
+
+.Attribute eines Unternehmens
+[options="header,footer"]
+|=========================================================
+|Attribut |Pflichtfeld |Inhaltsart |Beschreibung
+|Name |ja |Textfeld |Nachname der natürlichen Person
+|Rechtsform |nein |Textfeld |z.B. GmbH oder AG
+|Handelsregisternummer |nein |Textfeld |
+|Notiz |nein |Textfeld |Beliebige Hinweise zum unternehmen
+|=========================================================
+
+
+=== Weitere Informationen zu einem Kontakt
+Die Detailinformationen zu einem Kontakt befinden sich im unteren
+Teil des Benutzerdialogs.
+
+CAUTION: Bei der Neu-Anlage eines Kontakts sind die Details zunächst nicht sichtbar. Erst nach dem Speichern des neuen Kontakts werden die folgenden Detailinformationen angezeigt.
+
+.Detail-Informationen eines Kontakts
+[options="header,footer"]
+image::interne-person-2.png[]
+
+Dieser Bereich ist in folgende Abschnitte unterteilt:
+
+* Adressliste
+* Kommunikationskanäle
+* Modulzuordnung
+* Ansprechpartner (nur bei Unternehmen)
+
+
+==== Adressliste
+Die Adressliste beinhaltet alle Adressen der internen Person. Eine Adresse besteht aus folgenden Attributen:
+
+.Attribute einer Adresse (Kontakt-Detailinformationen)
+[options="header,footer"]
+|=========================================================
+|Attribut |Pflichtfeld |Inhaltsart |Beschreibung
+|Adresstyp |ja |Auswahlfeld |Auswahl eines Adresstyps
+|Hauptadresse |nein |Checkbox |Kennzeichen, ob dies die Hauptadresse ist (nur relevant, wenn mehrere Adressen vorhanden)
+|Postleitzahl |nein |Zahl |Adressdaten
+|Ort |nein |Textfeld |Adressdaten
+|Adresse (Zusatz) |nein |Textfeld |Adressdaten
+|Straße |nein |Textfeld |Adressdaten
+|Hausnummer |nein |Textfeld |Adressdaten
+|WGS84-Zone |nein |Textfeld |
+|Längengrad |nein |Textfeld |
+|Breitengrad |nein |Textfeld |
+|Google Maps URL |nein |Textfeld |
+|Notiz |nein |Textfeld |Beliebige Hinweise zur Person
+|=========================================================
+
+Der geöffnete Bereich sieht folgendermaßen aus:
+
+.Tabellenansicht der Adressen unter einem Kontakt
+[options="header,footer"]
+image::adresseliste-gefuellt.png[]
+
+Über die Schaltfläche "Neue Adresse anlegen" kann eine Adresse angelegt werden.
+Anschließend öffnet sich die folgende Maske, die auch bei der Bearbeitung zum Einsatz kommt:
+
+.Maske zur Anlage einer Adresse unter einem Kontakt
+[options="header,footer"]
+image::adresse-anlegen.png[]
+
+
+==== Kommunikationskanäle
+Die Kommunikationskanäle beinhalten alle Kontaktinformationen. Eine Kommunikationskanal besteht aus folgenden Attributen:
+
+.Attribute eines Kommunikationskanals (Kontakt-Detailinformationen)
+[options="header,footer"]
+|=========================================================
+|Attribut |Pflichtfeld |Inhaltsart |Beschreibung
+|Typ |ja |Auswahlfeld |Auswahl eines Kommunikationskanals
+|Daten |nein |Textfeld |KOntaktinformationen des entsprechenden Kommunikationskanals
+|Notiz |nein |Textfeld |Beliebige Hinweise zum Kommunikationskanal
+|=========================================================
+
+Der geöffnete Bereich sieht folgendermaßen aus:
+
+.Tabellenansicht der Kommunikationskanäle unter einem Kontakt
+[options="header,footer"]
+image::kommunikationskanal-gefuellt.png[]
+
+Über die Schaltfläche "Neuen Kommunikationskanal anlegen" kann ein Kommunikationskanal angelegt werden.
+Anschließend öffnet sich die folgende Maske, die auch bei der Bearbeitung zum Einsatz kommt:
+
+.Maske zur Anlage eines Kommunikationskanals unter einem Kontakt
+[options="header,footer"]
+image::kommunikationskanal-anlegen.png[]
+
+
+==== Modulzuordnung
+Die Modulzuordnung legt fest in welchen Modulen der Kontakt genutzt wird.
+Des Weiteren wird hier hinterlegt, wie lange die Kontaktdaten minestens aufbewahrt werden müssen
+und wann diese ggf. abläuft.
+Eine Modulzuordnung besteht aus folgenden Attributen:
+
+.Attribute einer Modulzuordnung (Kontakt-Detailinformationen)
+[options="header,footer"]
+|=========================================================
+|Attribut |Pflichtfeld |Inhaltsart |Beschreibung
+|Modulname |ja |Auswahlfeld |Auswahl eines openKONSEQUENZ-Moduls
+|Ablaufdatum |nein |Datum |Zeitpunkt, ab wann die Kontaktdaten gemäß DSGVO gelöscht werden müssen
+|Löschsperre bis |nein |Datum |Zeitpunkt, bis wann die Kontaktdaten gemäß DSGVO nicht gelöscht werden dürfen
+|Notiz |nein |Textfeld |Beliebige Hinweise zum Modul
+|=========================================================
+
+Der geöffnete Bereich sieht folgendermaßen aus:
+
+.Tabellenansicht der Modulzuordnungen unter einem Kontakt
+[options="header,footer"]
+image::modulzuordnung-gefuellt.png[]
+
+Über die Schaltfläche "Neue Modulzuordnung anlegen" kann eine Modulzuordnung angelegt werden.
+Anschließend öffnet sich die folgende Maske, die auch bei der Bearbeitung zum Einsatz kommt:
+
+.Maske zur Anlage einer Modulzuordnung unter einem Kontakt
+[options="header,footer"]
+image::modul-zuordnen.png[]
+
+==== Ansprechpartner
+Die Ansprechpartner sind Persoen, die zu einem Unternehmen gehören. Deshalb gibt es diese Daten nur bei dem Kontakttyp Unternehmen.
+Ein Ansprechpartner beitzt folgende Attribute:
+
+.Attribute eines Ansprechpartners (Kontakt-Detailinformationen)
+[options="header,footer"]
+|=========================================================
+|Attribut |Pflichtfeld |Inhaltsart |Beschreibung
+|Vorname |nein |Textfeld |Vorname des Ansprechpartners
+|Name |ja |Textfeld |Nachname des Ansprechpartners
+|Titel |nein |Textfeld |z.B. Prof. oder Dr.
+|Anrede |nein |Auswahlfeld |Auswahl einer Anrede, z.B. Herr oder Frau
+|Personentyp |nein |Auswahlfeld |Auswahl eines Personentyps
+|Notiz |nein |Textfeld |Beliebige Hinweise zum Ansprechpartner
+|=========================================================
+
+Der geöffnete Bereich sieht folgendermaßen aus:
+
+.Tabellenansicht der Ansprechpartner unter einem Kontakt
+[options="header,footer"]
+image::ansprechpartner-gefuellt.png[]
+
+Über die Schaltfläche "Neuen Ansprechpartner anlegen" kann ein Ansprechpartner angelegt werden.
+Anschließend öffnet sich die folgende Maske, die auch bei der Bearbeitung zum Einsatz kommt:
+
+.Maske zur Anlage eines Ansprechpartners unter einem Kontakt
+[options="header,footer"]
+image::ansprechpartner-anlegen.png[]
+
+<<<
+
+[[dsgvo-funktionen]]
+== DSGVO-Funktionen
+
+TODO: Allgemein beschreiben
+
+
+[[dsgvo-erfassen]]
+=== Erfassung der DSGVO-Informationen zu einem Kontakt
+
+TODO: siehe Modulzuordnung
+
+[[dsgvo-anonymisieren]]
+=== Abgelaufene Kontakte identifizieren
+
+TODO
+
+[[dsgvo-loeschsperre]]
+=== Löschsperre bei Kontakten
+
+TODO
+
+[[dsgvo-anonymisieren]]
+=== Kontakt anonymisieren
+
+TODO
+
+
+
+
+<<<
+
+[[verwaltung-stammdaten]]
+== Verwaltung der Stammdaten
+Die Funktionen zur Verwaltung der Stammdaten verbirgt sich hinter dem folgenden
+Symbol in der Menüleiste:
+
+.Symbol zum Aufruf der Stammdaten-Verwaltung
+[options="header,footer"]
+image::admin-menue-symbol.png[]
+
+CAUTION: Die Stammdaten-Verwaltung ist nur für die Rolle "Administrator" verfügbar.
+
+Es können folgende Stammdaten bearbeitet werden:
+
+* Anreden
+* Adresstypen
+* Kommunikationstypen
+* Personentypen
+
+=== Anreden
+Nach dem Aufruf der Anreden-Verwaltung erscheint die Übersicht mit allen bereits
+angelegten Anreden:
+
+.Tabellenansicht der Anreden
+[options="header,footer"]
+image::uebersicht-anrede.png[]
+
+Über die Schaltfläche "Neu" kann einer Eintrag angelegt werden.
+Anschließend öffnet sich die folgende Maske, die auch bei der Bearbeitung zum Einsatz kommt:
+
+.Maske zur Anlage eines Anreden
+[options="header,footer"]
+image::anrede-anlegen.png[]
+
+
+=== Adresstypen
+Nach dem Aufruf der Adresstypen-Verwaltung erscheint die Übersicht mit allen bereits
+angelegten Adresstypen:
+
+.Tabellenansicht der Adresstypen
+[options="header,footer"]
+image::adresstypen-uebersicht.png[]
+
+Über die Schaltfläche "Neu" kann einer Eintrag angelegt werden.
+Anschließend öffnet sich die folgende Maske, die auch bei der Bearbeitung zum Einsatz kommt:
+
+.Maske zur Anlage eines Adresstyps
+[options="header,footer"]
+image::adresstyp-anlegen.png[]
+
+
+=== Kommunikationstypen
+Nach dem Aufruf der Kommunikationstypen-Verwaltung erscheint die Übersicht mit allen bereits
+angelegten Kommunikationstypen:
+
+.Tabellenansicht der Kommunikationstypen
+[options="header,footer"]
+image::kommunikationstypen-uebersicht.png[]
+
+Über die Schaltfläche "Neu" kann einer Eintrag angelegt werden.
+Anschließend öffnet sich die folgende Maske, die auch bei der Bearbeitung zum Einsatz kommt:
+
+.Maske zur Anlage eines Kommunikationstypens
+[options="header,footer"]
+image::kommunikationstypen-anlegen.png[]
+
+Einige Einträge sind in der Standardkonfiguration enthalten und dürfen somit
+nicht geändert werden. Diese sind in der Übersichtstabelle mit einem Auge-Symbol
+gekennzeichnet. Wird der entsprechende Eintrag über dieses Symbol geöffnet,
+so können keine Anpassungen vorgenommen werden.
+
+.Maske zur Anlage eines Kommunikationstypens
+[options="header,footer"]
+image::kommunikationstyp-nur-ansicht.png[]
+
+
+=== Personentypen
+Nach dem Aufruf der Personentypen-Verwaltung erscheint die Übersicht mit allen bereits
+angelegten Personentypen:
+
+.Tabellenansicht der Personentypen
+[options="header,footer"]
+image::personentypen-uebersicht.png[]
+
+Über die Schaltfläche "Neu" kann einer Eintrag angelegt werden.
+Anschließend öffnet sich die folgende Maske, die auch bei der Bearbeitung zum Einsatz kommt:
+
+.Maske zur Anlage eines Personentyps
+[options="header,footer"]
+image::personentypen-anlegen.png[]
+
+
+[[meldungen-hinweise]]
+== Hinweise und Meldungen nach Benutzeraktionen
+Nach Benutzeraktionen erscheinen in bestimmten Fällen Meldungen des Systems,
+um den Benutzer:
+
+* Handlungsanweisungen zu geben,
+* über Fehler des Systems zu informieren.
+
+=== Erfolg einer Aktion
+Ist eine Benutzeraktion erfolgreich, so erscheint keine Meldung.
+
+=== Handlungsanweisung
+In einigen Situationen muss der Benutzer weitere Aktionen ausführen, damit die
+Handlung erfolgreich abgeschlossen werden kann. Diese gelb hinterlegten Hinweise
+erscheinen im folgenden Fall:
+
+* Fehlenden Informationen (Pflichtfelder füllen)
+
+.Hinweis Pflichtfelder
+[options="header,footer"]
+image::meldung-hinweis.png[]
+
+Diese Meldungen bleiben für fünf Sekunden sichtbar und verschwinden dann wieder
+automatisch.
+
+=== Fehlermeldungen
+Wenn Aktionen aufgrund technischer Gegebenheiten nicht erfolgreich durchgeführt
+werden können, erscheinen rot hinterlegte Fehlermeldungen. Das kann u.a. in
+folgenden Situationen passieren:
+
+* Speichern fehlgeschlagen
+* Web Services nicht verfügbar
+
+.Fehlermeldung
+[options="header,footer"]
+image::meldung-fehler.png[]
+
+Diese Meldungen bleiben solange sichtbar bis sie durch den Benutzer über das
+kleine x geschlossen werden. In diesen Fällen ist der Administrator zu
+informieren.
+
+<<<
+
+== Allgemeine Funktionen
+
+=== An- und abmelden
+
+==== Modul "Kontaktstammdaten" aus Portal starten
+Nach erfolgreicher Anmeldung am openKONSEQUENZ-Portal und mit entsprechender
+Berechtigung für das Modul "Kontaktstammdaten" ist die Kachel für das Modul
+sichtbar. Mit einem Klick auf die Kachel startet das Modul "Kontaktstammdaten"
+in einem neuen Fenster.
+
+.Kachel zum Starten des Moduls "Kontaktstammdaten"
+[options="header,footer"]
+image::oeffnen-modul.png[]
+
+==== Abmelden
+Die Schaltfläche zum Abmelden befindet sich hinter dem Benutzernamen.
+
+.Abmelden vom openKONSEQUENZ-System
+[options="header,footer"]
+image::abmelden.png[]
+
+CAUTION: Beim Klick auf "Abmelden" erfolgt nicht nur die Abmeldung vom Modul
+Kontaktstammdaten, sondern die Abmeldung vom Portal. D.h. alle parallel geöffneten
+openKONSEQUENZ-Module (wie z.B. Betriebstagebuch, Geplante Netzmaßnahme) werden
+automatisch mit abgemeldet.
+
+Um die parallel geöffneten openKONSEQUENZ-Module nicht mit abzumelden, ist
+lediglich das Browserfenster mit dem Modul Kontaktstammdaten zu schließen.
+
+=== Home-Button
+Über den folgenden Home-Button in der Menüleiste kann jederzeit zur Tabellenansicht
+zurückgekehrt werden.
+
+.Home-Button
+[options="header,footer"]
+image::haus-symbol.png[]
+
+CAUTION: DEr Aufruf des Home-Buttons setzt die Suche, Filter und Sortierfunktion wieder zurück, sodass die Standardansicht wieder hergestellt ist.
+
+[[suche]]
+=== Suche
+In der Übersicht ist eine Such-Funktion integriert, die eingegebenen Zeichen in
+den Datensätzen der Kontaktstammdaten sucht. Bei der Suche werden alle Felder
+berücksichtigt.
+
+.Suchfunktion
+[options="header,footer"]
+image::suche-beispiel.png[]
+
+Das Auswahlfeld "Alle Kontakttypen" bestimmt den Suchumfang:
+
+* Alle Kontakttypen
+* Interne Personen
+* Externe Personen
+* Unternehmen
+
+Die Suche wird entweder über die "Enter-Taste" oder über das Lupen-Symbol
+ausgeführt:
+
+.Schaltfläche zum Starten der Suche
+[options="header,footer"]
+image::such-symbol.png[]
+
+
+=== Sortieren
+Die Sortierung in der Haupttabelle funktioniert über zwei Auswahlfelder:
+
+.Auswahl des Attributs für die Sortierung
+[options="header,footer"]
+image::auswahl-sortierung.png[]
+
+.Auswahl der Reihenfolge
+[options="header,footer"]
+image::auswahl-sortierung-2.png[]
+
+Nach Auswahl der entsprechenden Felder erfolgt die Suche automatisch.
+
+=== Hilfe
+TODO
+
+=== Synchronisierung mit Verzeichnisdiensten
+Die Aktivierung der Synchronisierung der Kontaktstammdaten mit den Verzeichnisdiensten
+LDAP und/oder Auth&Auth erfolgt durch den Administrator.
+
+
+<<<
+
+== Allgemeiner Hinweis
+Die Anwendung ist für folgende Endgeräte optimiert:
+
+* Desktop-PC
+* Tablet
+
+Es unterstützt folgende Browser:
+
+* Google Chrome
+* Firefox
+
+Die Bildschirmauflösung bzw. die Fenstergröße des Browsers sollte folgende
+Werte nicht unterschreiten:
+
+* 1.024 x 768 Pixel
