Letzte Änderungen von M.Alessandrini
diff --git a/src/main/asciidoc/userDocumentation/userDocumentation.adoc b/src/main/asciidoc/userDocumentation/userDocumentation.adoc
index 7a12001..202b7e2 100644
--- a/src/main/asciidoc/userDocumentation/userDocumentation.adoc
+++ b/src/main/asciidoc/userDocumentation/userDocumentation.adoc
@@ -18,17 +18,17 @@
<<<
-* Version: 0.5
-* Datum: 04.09.2020
-* Status: In Bearbeitung
+* Version: 1.0.1
+* Datum: 08.10.2020
+* Status: Final
<<<
:Author: Dr. Michel Alessandrini
:Email: michel.alessandrini@pta.de
-:Date: 2020-09-04
-:Revision: 0.5
+:Date: 2020-10-08
+:Revision: 1.0.1
:icons:
@@ -548,6 +548,10 @@
* 1.500
* 2.000
+|Aktuelle Adresse |nein |Anzeigefeld |Zeigt die importierte oder die aus den o.a.
+Feldern ausgewählte Adresse an. Diese Feld ist in den internen Bearbeitungsstatus
+"Beendet" und "Storniert" nicht sichtbar.
+
|=========================================================
(*) Pflichtfeld um einen Statuswechsel durchführen zu können.
@@ -584,9 +588,21 @@
|Ort (betroffene Orte) |nein |Textfeld |Bei Bedarf: Ortsangabe
|Ortsteil |nein |Textfeld |Bei Bedarf: Ortsteil
|Postleitzahl |nein |Textfeld |Bei Bedarf: Postleitzahl
+|Radius in Meter |ja |Auswahlfeld
+a|
+Darstellung eines Kreises um den Störungsort mit dem ausgewählten Radius in Meter:
+
+ * 0
+ * 50
+ * 100
+ * 250
+ * 500
+ * 1.000
+ * 1.500
+ * 2.000
|=========================================================
-TIP: Die drei Attribute zur Ergänzung der Standortinformationen werden technisch
+TIP: Die drei erstgenannten Attribute zur Ergänzung der Standortinformationen werden technisch
nicht gegen den ausgewählten Ort in der Karte geprüft.
===== Stationsattribute
@@ -619,13 +635,14 @@
Über den Veröffentlichungskanal wird die Schnittstelle ausgewählt, über die
die Störungsinformationen veröffentlicht werden sollen. Es ist möglich
keinen, einen oder mehrere Kanäle auszuwählen. In der folgenden Abbildung sind
-zwei Veröffentlichungskanäle angebunden, wobei grundsätzlich vier Schnittstellen
+zwei Veröffentlichungskanäle angebunden, wobei grundsätzlich fünf Schnittstellen
zur Verfügung stehen:
. Mail
. Störungsauskunft.de
. SARIS
. SAMO
+. SIT Karten- und Tabellen-Veröffentlichungskomponente
IMPORTANT: Die Sichtbarkeit der verschiedenen Kanäle wird durch den
Administrator eingestellt.
@@ -1170,6 +1187,18 @@
TIP: Die initiale Darstellung, ob alle veröffentlichten oder
keine Störungsmeldung angezeigt wird, konfiguriert der Administrator.
+
+Die Detailinformationen zu einer Störungsmeldung werden angezeigt,
+wenn sich der Mauszeiger über der entsprechenden Störungsmeldung
+in der Karte befindet.
+
+.Internet-Applikation Karte Popup-Fenster zu einer Störungsmeldung
+image::internetkomp-popup.png[]
+
+TIP: Die sichtbaren Felder der Popup-Fensters konfiguriert der
+Administrator.
+
+
==== Liste
In der Listenansicht sind ausschließlich Störungsmeldungen
mit dem Veröffentlichungsstatus "Öffentlich" dargestellt. Die Meldungen enthalten
@@ -1178,6 +1207,10 @@
.Internet-Applikation Liste
image::internet-liste.png[]
+TIP: Die Sichtbarkeit einzelner Spalten konfiguriert der Administrator. D.h. falls
+einzelne Spalten in Ihrer Installation nicht sichtbar sein sollten, so hat der
+Administrator diese ausgeblendet.
+
Die Listenansicht enthält folgende Attribute.
.Felder in der Internet-Applikation Liste
@@ -1200,6 +1233,10 @@
TIP: Die initiale Darstellung, ob alle veröffentlichten oder
keine Störungsmeldung angezeigt wird, konfiguriert der Administrator.
+Die Darstellung des Felds "Letzte Änderung" mit Datum und Uhrzeit in der Fußzeile
+bezieht sich auf den Zeitpunkt der letzten Änderung der Störungsmeldungen.
+
+
==== PLZ-Suche
Über die PLZ-Suche können die beiden Ansichten - Karte und Liste - gefiltert werden.
Dazu muss lediglich die Postleitzahl in das Eingabefeld eingetragen und
@@ -1215,7 +1252,7 @@
-=== Export von Störungsmeldungen
+=== Export von Störungsmeldungen (Veröffentlichung)
Die Veröffentlichung von Störungsmeldung erfolgt über verschiedene Kanäle,
die - technisch - auch als Export-Schnittstellen bezeichnet werden.
@@ -1227,7 +1264,13 @@
. Aktualisierung
. Veröffentlichung beenden
-Details dazu sind in den folgenden Abschnitten erläutert.
+
+TIP: Darüber hinaus kann die Veröffentlichung auch manuell initiiert werden,
+indem der Schalter des entsprechenden Kanals einmal deaktiviert und anschließend
+wieder aktiviert wird, siehe Abchnitt <<veroeffentlichung,Veröffentlichung>>.
+Das kann beispielsweise notwendig sein, wenn sich die Kontakte eines Verteilers
+zwischenzeitlich geändert haben.
+
==== Initiale Veröffentlichung
Die erstmalige Veröffentlichung einer Störungsmeldung erfolgt, wenn der Benutzer
@@ -1262,14 +1305,23 @@
* https://störungsauskunft.de/
-[[SARIS]]
-===== SARIS
-TODO: Gibt es hier relevante Infos?
+=== Import von Störungsmeldungen
+Der automatische Import von Störungsmeldung kann grundsätzlich
+über verschiedene Kanäle erfolgen, die - technisch - auch als
+Import-Schnittstellen bezeichnet werden.
+Die Zeitpunkte, wann die Informationen über die definierten Kanäle
+importiert werden, konfiguriert der Administrator.
-[[SAMO]]
-===== SAMO
-TODO: Gibt es hier relevante Infos?
+Die Bereitstellung der neu importierten Störungsmeldungen erfolgt
+in der Übersicht der Störungsmeldungen. Neue Einträge besitzen
+den internen Bearbeitungsstatus neu.
+
+Folgende Import-Schnittstellen sind verfügbar:
+
+. SARIS
+. SAMO
+
<<<
diff --git a/src/main/asciidoc/userDocumentation/userDocumentation.adoc.html b/src/main/asciidoc/userDocumentation/userDocumentation.adoc.html
index 905443f..1a9aff3 100644
--- a/src/main/asciidoc/userDocumentation/userDocumentation.adoc.html
+++ b/src/main/asciidoc/userDocumentation/userDocumentation.adoc.html
@@ -463,13 +463,13 @@
<div class="ulist">
<ul>
<li>
-<p>Version: 0.5</p>
+<p>Version: 1.0.1</p>
</li>
<li>
-<p>Datum: 04.09.2020</p>
+<p>Datum: 08.10.2020</p>
</li>
<li>
-<p>Status: In Bearbeitung</p>
+<p>Status: Final</p>
</li>
</ul>
</div>
@@ -504,7 +504,8 @@
<li><a href="#_schnittstellen">5. Schnittstellen</a>
<ul class="sectlevel2">
<li><a href="#_internet_applikation">5.1. Internet-Applikation</a></li>
-<li><a href="#_export_von_störungsmeldungen">5.2. Export von Störungsmeldungen</a></li>
+<li><a href="#_export_von_störungsmeldungen_veröffentlichung">5.2. Export von Störungsmeldungen (Veröffentlichung)</a></li>
+<li><a href="#_import_von_störungsmeldungen">5.3. Import von Störungsmeldungen</a></li>
</ul>
</li>
<li><a href="#_benachrichtigungen_und_erinnerungen">6. Benachrichtigungen und Erinnerungen</a>
@@ -1693,6 +1694,14 @@
</ul>
</div></div></td>
</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Aktuelle Adresse</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">nein</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Anzeigefeld</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Zeigt die importierte oder die aus den o.a.
+Feldern ausgewählte Adresse an. Diese Feld ist in den internen Bearbeitungsstatus
+"Beendet" und "Storniert" nicht sichtbar.</p></td>
+</tr>
</tbody>
</table>
<div class="paragraph">
@@ -1777,6 +1786,42 @@
<td class="tableblock halign-left valign-top"><p class="tableblock">Textfeld</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Bei Bedarf: Postleitzahl</p></td>
</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Radius in Meter</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">ja</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Auswahlfeld</p></td>
+<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
+<p>Darstellung eines Kreises um den Störungsort mit dem ausgewählten Radius in Meter:</p>
+</div>
+<div class="ulist">
+<ul>
+<li>
+<p>0</p>
+</li>
+<li>
+<p>50</p>
+</li>
+<li>
+<p>100</p>
+</li>
+<li>
+<p>250</p>
+</li>
+<li>
+<p>500</p>
+</li>
+<li>
+<p>1.000</p>
+</li>
+<li>
+<p>1.500</p>
+</li>
+<li>
+<p>2.000</p>
+</li>
+</ul>
+</div></div></td>
+</tr>
</tbody>
</table>
<div class="admonitionblock tip">
@@ -1786,7 +1831,7 @@
<img src="../img/icons/tip.png" alt="Tip">
</td>
<td class="content">
-Die drei Attribute zur Ergänzung der Standortinformationen werden technisch
+Die drei erstgenannten Attribute zur Ergänzung der Standortinformationen werden technisch
nicht gegen den ausgewählten Ort in der Karte geprüft.
</td>
</tr>
@@ -1853,7 +1898,7 @@
<p>Über den Veröffentlichungskanal wird die Schnittstelle ausgewählt, über die
die Störungsinformationen veröffentlicht werden sollen. Es ist möglich
keinen, einen oder mehrere Kanäle auszuwählen. In der folgenden Abbildung sind
-zwei Veröffentlichungskanäle angebunden, wobei grundsätzlich vier Schnittstellen
+zwei Veröffentlichungskanäle angebunden, wobei grundsätzlich zwei Schnittstellen
zur Verfügung stehen:</p>
</div>
<div class="olist arabic">
@@ -1864,12 +1909,6 @@
<li>
<p>Störungsauskunft.de</p>
</li>
-<li>
-<p>SARIS</p>
-</li>
-<li>
-<p>SAMO</p>
-</li>
</ol>
</div>
<div class="admonitionblock important">
@@ -2404,7 +2443,7 @@
</div>
<div class="listingblock">
<div class="content">
-<pre class="highlightjs highlight"><code data-lang="json" class="language-json hljs"> name;email;mobilenumber
+<pre class="highlightjs highlight"><code data-lang="csv" class="language-csv hljs"> name;email;mobilenumber
Freudenberg, Pauline;PaulineF@gmx.net;01526677884
Buckley, Cornelius;sender@test.tester;</code></pre>
</div>
@@ -2935,6 +2974,30 @@
</tr>
</table>
</div>
+<div class="paragraph">
+<p>Die Detailinformationen zu einer Störungsmeldung werden angezeigt,
+wenn sich der Mauszeiger über der entsprechenden Störungsmeldung
+in der Karte befindet.</p>
+</div>
+<div class="imageblock">
+<div class="content">
+<img src="../img/internetkomp-popup.png" alt="internetkomp popup">
+</div>
+<div class="title">Figure 55. Internet-Applikation Karte Popup-Fenster zu einer Störungsmeldung</div>
+</div>
+<div class="admonitionblock tip">
+<table>
+<tr>
+<td class="icon">
+<img src="../img/icons/tip.png" alt="Tip">
+</td>
+<td class="content">
+Die sichtbaren Felder der Popup-Fensters konfiguriert der
+Administrator.
+</td>
+</tr>
+</table>
+</div>
</div>
<div class="sect3">
<h4 id="_liste"><a class="anchor" href="#_liste"></a>5.1.2. Liste</h4>
@@ -2947,7 +3010,21 @@
<div class="content">
<img src="../img/internet-liste.png" alt="internet liste">
</div>
-<div class="title">Figure 55. Internet-Applikation Liste</div>
+<div class="title">Figure 56. Internet-Applikation Liste</div>
+</div>
+<div class="admonitionblock tip">
+<table>
+<tr>
+<td class="icon">
+<img src="../img/icons/tip.png" alt="Tip">
+</td>
+<td class="content">
+Die Sichtbarkeit einzelner Spalten konfiguriert der Administrator. D.h. falls
+einzelne Spalten in Ihrer Installation nicht sichtbar sein sollten, so hat der
+Administrator diese ausgeblendet.
+</td>
+</tr>
+</table>
</div>
<div class="paragraph">
<p>Die Listenansicht enthält folgende Attribute.</p>
@@ -3008,6 +3085,10 @@
</tr>
</table>
</div>
+<div class="paragraph">
+<p>Die Darstellung des Felds "Letzte Änderung" mit Datum und Uhrzeit in der Fußzeile
+bezieht sich auf den Zeitpunkt der letzten Änderung der Störungsmeldungen.</p>
+</div>
</div>
<div class="sect3">
<h4 id="_plz_suche"><a class="anchor" href="#_plz_suche"></a>5.1.3. PLZ-Suche</h4>
@@ -3020,7 +3101,7 @@
<div class="content">
<img src="../img/internet-suche.png" alt="internet suche">
</div>
-<div class="title">Figure 56. Internet-Applikation PLZ-Suche</div>
+<div class="title">Figure 57. Internet-Applikation PLZ-Suche</div>
</div>
<div class="paragraph">
<p>Anschließend werden autonatisch die beiden Komponenten auf diese PLZ gefiltert.</p>
@@ -3029,12 +3110,12 @@
<div class="content">
<img src="../img/internet-suche-beispiel.png" alt="internet suche beispiel">
</div>
-<div class="title">Figure 57. Internet-Applikation PLZ-Suche (Beispiel)</div>
+<div class="title">Figure 58. Internet-Applikation PLZ-Suche (Beispiel)</div>
</div>
</div>
</div>
<div class="sect2">
-<h3 id="_export_von_störungsmeldungen"><a class="anchor" href="#_export_von_störungsmeldungen"></a>5.2. Export von Störungsmeldungen</h3>
+<h3 id="_export_von_störungsmeldungen_veröffentlichung"><a class="anchor" href="#_export_von_störungsmeldungen_veröffentlichung"></a>5.2. Export von Störungsmeldungen (Veröffentlichung)</h3>
<div class="paragraph">
<p>Die Veröffentlichung von Störungsmeldung erfolgt über verschiedene Kanäle,
die - technisch - auch als Export-Schnittstellen bezeichnet werden.</p>
@@ -3057,8 +3138,21 @@
</li>
</ol>
</div>
-<div class="paragraph">
-<p>Details dazu sind in den folgenden Abschnitten erläutert.</p>
+<div class="admonitionblock tip">
+<table>
+<tr>
+<td class="icon">
+<img src="../img/icons/tip.png" alt="Tip">
+</td>
+<td class="content">
+Darüber hinaus kann die Veröffentlichung auch manuell initiiert werden,
+indem der Schalter des entsprechenden Kanals einmal deaktiviert und anschließend
+wieder aktiviert wird, siehe Abchnitt <a href="#veroeffentlichung">Veröffentlichung</a>.
+Das kann beispielsweise notwendig sein, wenn sich die Kontakte eines Verteilers
+zwischenzeitlich geändert haben.
+</td>
+</tr>
+</table>
</div>
<div class="sect3">
<h4 id="_initiale_veröffentlichung"><a class="anchor" href="#_initiale_veröffentlichung"></a>5.2.1. Initiale Veröffentlichung</h4>
@@ -3111,23 +3205,41 @@
</ul>
</div>
</div>
-<div class="sect4">
-<h5 id="SARIS"><a class="anchor" href="#SARIS"></a>5.2.4.3. SARIS</h5>
-<div class="paragraph">
-<p>TODO: Gibt es hier relevante Infos?</p>
</div>
</div>
-<div class="sect4">
-<h5 id="SAMO"><a class="anchor" href="#SAMO"></a>5.2.4.4. SAMO</h5>
+<div class="sect2">
+<h3 id="_import_von_störungsmeldungen"><a class="anchor" href="#_import_von_störungsmeldungen"></a>5.3. Import von Störungsmeldungen</h3>
<div class="paragraph">
-<p>TODO: Gibt es hier relevante Infos?</p>
+<p>Der automatische Import von Störungsmeldung kann grundsätzlich
+über verschiedene Kanäle erfolgen, die - technisch - auch als
+Import-Schnittstellen bezeichnet werden.</p>
+</div>
+<div class="paragraph">
+<p>Die Zeitpunkte, wann die Informationen über die definierten Kanäle
+importiert werden, konfiguriert der Administrator.</p>
+</div>
+<div class="paragraph">
+<p>Die Bereitstellung der neu importierten Störungsmeldungen erfolgt
+in der Übersicht der Störungsmeldungen. Neue Einträge besitzen
+den internen Bearbeitungsstatus neu.</p>
+</div>
+<div class="paragraph">
+<p>Folgende Import-Schnittstellen sind verfügbar:</p>
+</div>
+<div class="olist arabic">
+<ol class="arabic">
+<li>
+<p>SARIS</p>
+</li>
+<li>
+<p>SAMO</p>
+</li>
+</ol>
</div>
<div style="page-break-after: always;"></div>
</div>
</div>
</div>
-</div>
-</div>
<div class="sect1">
<h2 id="_benachrichtigungen_und_erinnerungen"><a class="anchor" href="#_benachrichtigungen_und_erinnerungen"></a>6. Benachrichtigungen und Erinnerungen</h2>
<div class="sectionbody">
@@ -3143,7 +3255,7 @@
<div class="content">
<img src="../img/glocke-rot.png" alt="glocke rot">
</div>
-<div class="title">Figure 58. Erinnerung(en) vorhanden</div>
+<div class="title">Figure 59. Erinnerung(en) vorhanden</div>
</div>
<div class="paragraph">
<p>In allen anderen Fällen bleibt das Glockensymbol schwarz.</p>
@@ -3152,7 +3264,7 @@
<div class="content">
<img src="../img/glocke-schwarz.png" alt="glocke schwarz">
</div>
-<div class="title">Figure 59. Keine Erinnerung vorhanden</div>
+<div class="title">Figure 60. Keine Erinnerung vorhanden</div>
</div>
</div>
<div class="sect2">
@@ -3195,7 +3307,7 @@
<div class="content">
<img src="../img/meldung-hinweis.png" alt="meldung hinweis">
</div>
-<div class="title">Figure 60. Hinweis Pflichtfelder</div>
+<div class="title">Figure 61. Hinweis Pflichtfelder</div>
</div>
<div class="paragraph">
<p>Diese Meldungen bleiben für einige Sekunden sichtbar und verschwinden dann wieder
@@ -3223,7 +3335,7 @@
<div class="content">
<img src="../img/meldung-fehler.png" alt="meldung fehler">
</div>
-<div class="title">Figure 61. Fehlermeldung</div>
+<div class="title">Figure 62. Fehlermeldung</div>
</div>
<div class="paragraph">
<p>Diese Meldungen bleiben solange sichtbar bis sie durch den Benutzer durch einfaches
@@ -3250,7 +3362,7 @@
<div class="content">
<img src="../img/oeffnen-modul.png" alt="oeffnen modul">
</div>
-<div class="title">Figure 62. Kachel zum Starten des Moduls "Störungsinformationstool"</div>
+<div class="title">Figure 63. Kachel zum Starten des Moduls "Störungsinformationstool"</div>
</div>
</div>
<div class="sect2">
@@ -3262,7 +3374,7 @@
<div class="content">
<img src="../img/abmelden.png" alt="abmelden">
</div>
-<div class="title">Figure 63. Abmelden vom openKONSEQUENZ-System</div>
+<div class="title">Figure 64. Abmelden vom openKONSEQUENZ-System</div>
</div>
<div class="admonitionblock caution">
<table>
