Konfiguration: Unterschied zwischen den Versionen

Aus EBKuS Dokumentation
Wechseln zu: Navigation, Suche
 
(40 dazwischenliegende Versionen von 7 Benutzern werden nicht angezeigt)
Zeile 1: Zeile 1:
−
== Systemvariablen ==
+
Die zentrale Konfigurationsdatei für eine EBKuS-Installation ist eine Textdatei namens <code>ebkus.conf</code> und befindet sich im Homeverzeichnis ({{file|ebkus}} im Installationsverzeichnis).
  
 +
Als Ausgangspunkt für die eigene Konfiguration dient die vom Installationsskript {{code|install.py}} aus einer Vorlage generierte Konfigurationsdatei. Die meisten Parameter (= Konfigurationvariable) sind darin bereits korrekt gesetzt.
 +
 +
 +
== Aufbau von <code>ebkus.conf</code> ==
 +
 +
Zeilen, die leer sind oder mit dem Kommentarzeichen <code>#</code> beginnen, werden ignoriert, z.B.:
 +
 +
<pre>#ebkus_home:  %(install_dir)s\ebkus</pre>
 +
 +
In diesem Fall hat der Parameter den in der Tabelle genannten Standardwert.
 +
 +
Zeilen, die nur aus einem Namen in eckigen Klammern bestehen, leiten eine Sektion ein, z.B.:
 +
 +
<pre>[apache]</pre>
 +
Die übrigen Zeilen weisen einem Parameter einen Wert zu. Sie beginnen mit dem Namen des Parameters, gefolgt von einem Doppelpunkt, gefolgt von dem Wert. Vor oder nach dem Doppelpunkt können Leerzeichen stehen. Beispiel:
 +
 +
<pre>install_dir: C:\ebkus_installation</pre>
 +
Werte können eine Syntax enthalten, die es erlaubt, vorher definierte Parameter in einen aktuellen Wert einzubeziehen (''Parametersubstitution''), z.B.:
 +
 +
<pre>ebkus_home:  %(install_dir)s\ebkus</pre>
 +
Hier wird der Wert von <code>install_dir</code> in den Wert von <code>ebkus_home</code> einbezogen. Das ist genauso, als ob man gleich
 +
 +
<pre>ebkus_home:  C:\ebkus_installation\ebkus</pre>
 +
definiert hätte. <code>%(</code>''parameter''<code>)s</code> wird durch den Wert von ''parameter'' ersetzt.
 +
 +
Jede gültige Konfigurationsdatei muss die folgenden Sektionen aufweisen:
 +
 +
*<code>[DEFAULT]</code>
 +
*<code>[ebkus]</code>
 +
*<code>[apache]</code>
 +
*<code>[openssl]</code>
 +
*eine Sektion für jede Instanz: <code>[</code>''Instanzname''<code>]</code>
 +
 +
Die möglichen Parameter für jede Sektion sind in den folgenden Tabellen aufgeführt.
 +
 +
Alle Parameter außer denen, die in den Tabelle rot markiert sind, haben einen Standardwert (manchmal auch ''Defaultwert'' genannt), der in der Tabelle in der Spalte Standardwert angegeben ist. Ein Parameter hat diesen Wert, wenn er in der Konfiguration fehlt oder auskommentiert ist.
 +
 +
Wie man sieht, können Parametersubstitutionen auch bei Standardwerten stattfinden.  Der Wert des notwendige Parameter ''install_dir'' findet dadurch Eingang in weitere Parameter (''ebkus_home'', ''instance_home''), ohne dass diese explizit in der Konfiguration aufgeführt sind.
 +
 +
''Anmerkung zu den Tabellen'': In einigen Fällen ist der angegebene Parameter bzw. Standardwert aus layout-technischen Gründen auf mehrere Zeilen verteilt, obwohl er eigentlich ohne Leerzeichen hintereinanderweg in einer Zeile stehen müsste.
 +
 +
Wir unterscheiden ''Systemparameter'' von ''fachlichen Parametern''. Erstere betreffen den technischen Betrieb von EBKuS und werden von den Systemadministratoren (IT) bei der Installation eingerichtet. Fachparameter können ebenso wie Systemparameter in der {{file|ebkus.conf}} in der Instanzsektion gesetzt werden, außerdem kann aber auch der Anwendungsbetreuer über {{pfad2|Administratorhauptmenü|Allgemeine Konfiguration}} weitere Veränderungen vornehmen. Die vom Anwendungsbetreuer vorgenommenen Änderungen haben stets Vorrang über den Angaben in der {{file|ebkus.conf}}.
 +
 +
 +
== Systemparameter ==
 +
 +
=== <nowiki>[DEFAULT]</nowiki> ===
 +
 +
Die generierte Konfigurationsdatei enthält die korrekten Werte.
 +
 +
Der Parameter {{konfig|install_dir}} bezeichnet das Installationsverzeichnis und muss immer in der Konfiguration definiert werden. Es bildet den Bezugspunkt für alle weiteren Pfade. Standardmäßig ist {{konfig|ebkus_home}} das Verzeichnis <code>ebkus</code> im Installationsverzeichnis; das sollte nicht verändert werden.
 +
 +
Die in der Sektion <code>[DEFAULT]</code> definierten Parameter können in allen anderen Sektionen im Rahmen der Parametersubstitution als Teil eine Wertes verwendet werden (z.B. in der Definition von {{konfig|instance_home}}). Ansonsten stehen nur die Parameter derselben Sektion zur Verfügung.
  
 
{|border="1" cellspacing="0" cellpadding="8" style="background-color:snow;" width="100%"
 
{|border="1" cellspacing="0" cellpadding="8" style="background-color:snow;" width="100%"
Zeile 8: Zeile 61:
 
! Bedeutung
 
! Bedeutung
 
|-
 
|-
−
|{{code|install_dir}}
+
|{{konfig|install_dir}}
−
|'''NOTWENDIG'''
+
|style="background-color:orangered;"|{{code|}}
 
|Installationsverzeichnis
 
|Installationsverzeichnis
 
|-
 
|-
−
|{{code|ebkus_home}}
+
|{{konfig|ebkus_home}}
−
|{{code|%(install_dir)s/ebkus}}
+
|{{konfig|install_dir}}/ebkus
−
|Homeverzeichnis. Sollte
+
|Homeverzeichnis
−
nie explizit angegeben werden.
+
 
|}
 
|}
  
  
−
== Fachvariablen ==
+
=== <nowiki>[ebkus]</nowiki> ===
  
−
<table border="1" cellspacing="0" cellpadding="8" style="background-color:snow;" width="100%">
+
Die generierte Konfigurationsdatei enthält in der Regel die korrekten Werte.
−
<tr align="left" style="background-color:aliceblue;"><th>Parameter</th>
+
−
<th>Standardwert</th>
+
−
<th>Bedeutung</th>
+
−
</tr>
+
−
<tr><td><tt>instance_name</tt></td>
+
−
<td><em>Instanzname</em>
+
−
(<strong>NOTWENDIG</strong>)</td>
+
−
<td>Name der Instanz. Muss
+
−
angegeben werden und mit
+
−
dem Namen der Sektion identisch
+
−
sein.</td>
+
−
</tr>
+
−
<tr><td><tt>instance_home</tt></td>
+
−
<td><tt>%(ebkus_home)s/</tt>
+
−
<tt>%(instance_name)s</tt></td>
+
−
<td>>Instanzverzeichnis</td>
+
−
</tr>
+
−
<tr><td><tt>database_name</tt></td>
+
−
<td><tt>%(instance_name)s</tt></td>
+
−
<td>Name der Instanz-Datenbank</td>
+
−
</tr>
+
−
<tr><td><tt>database_host</tt></td>
+
−
<td><tt>localhost</tt></td>
+
−
<td>Name oder IP-Nummer des Rechners,
+
−
auf dem die Datenbank läuft.</td>
+
−
</tr>
+
−
<tr><td><tt>database_user</tt></td>
+
−
<td><tt>%(instance_name)s</tt></td>
+
−
<td>Name des Datenbankbenutzers der
+
−
Instanz</td>
+
−
</tr>
+
−
<tr><td><tt>database_password</tt></td>
+
−
<td><tt>%(instance_name)s</tt></td>
+
−
<td>Datenbankpasswort der Instanz</td>
+
−
</tr>
+
−
<tr><td><tt>port</tt></td>
+
−
<td><strong>NOTWENDIG</strong></td>
+
−
<td>Portnummer über die der EBKuS-Server
+
−
angesprochen wird. Muss angegeben
+
−
werden. Jede Instanz muss eine
+
−
unterschiedliche Portnummer erhalten.</td>
+
−
</tr>
+
−
<tr><td><tt>host</tt></td>
+
−
<td><tt>localhost</tt></td>
+
−
<td>Name oder IP-Nummer des Rechners, auf
+
−
dem der EBKuS-Server läuft</td>
+
−
</tr>
+
−
<tr><td><tt>log_file</tt></td>
+
−
<td><tt>%(instance_home)s/</tt>
+
−
<tt>%(instance_name)s.log</tt></td>
+
−
<td>Name der Datei, in die der EBKuS-Server
+
−
Meldungen schreibt</td>
+
−
</tr>
+
−
<tr><td><tt>log_level</tt></td>
+
−
<td><tt>INFO</tt></td>
+
−
<td>Legt fest, wie &quot;geschwätzig&quot; der
+
−
EBKuS-Server ist. Muss einer der
+
−
folgenden Werte sein, in aufsteigender
+
−
Wortfülle:
+
−
<tt>CRITICAL, ERROR, WARNING,
+
−
INFO, DEBUG</tt>
+
−
(<tt>DEBUG</tt> ist <em>nur</em> für die
+
−
Fehlersuche
+
−
geeignet,
+
−
da sehr viel ausgegeben wird.)</td>
+
−
</tr>
+
−
<tr><td><tt>loeschfrist</tt></td>
+
−
<td><tt>36</tt></td>
+
−
<td>Löschfrist in Monaten. Akten, die
+
−
älter sind, können vom Administrator
+
−
gelöscht werden.</td>
+
−
</tr>
+
−
<tr><td><tt>session_time</tt></td>
+
−
<td><tt>120</tt></td>
+
−
<td>Länge einer Session in Minuten. Nach
+
−
dieser Zeit wird ein Benutzer
+
−
automatisch abgemeldet, wenn er keine
+
−
Eingaben mehr macht.</td>
+
−
</tr>
+
−
<tr><td><tt>admin_name</tt></td>
+
−
<td><tt>Keine Angabe</tt></td>
+
−
<td>Name des Administrators.
+
−
Wird in Fehlermeldungen genannt.</td>
+
−
</tr>
+
−
<tr><td><tt>admin_tel</tt></td>
+
−
<td><tt>Keine Angabe</tt></td>
+
−
<td>Telefonnummer des Administrators.
+
−
Wird in Fehlermeldungen genannt.</td>
+
−
</tr>
+
−
<tr><td><tt>admin_email</tt></td>
+
−
<td><tt>Keine Angabe</tt></td>
+
−
<td>Email-Adresse des Administrators.
+
−
Wird in Fehlermeldungen genannt.</td>
+
−
</tr>
+
−
<tr><td><tt>berliner_version</tt></td>
+
−
<td><tt>false</tt></td>
+
−
<td>Wenn hier <tt>true</tt> steht, wird die
+
−
Berliner EBKuS-Version verwendet (mit
+
−
Berliner Straßenkatalog).</td>
+
−
</tr>
+
−
</table>
+
  
−
== Neue Tabellen ==
+
Die {{konfig|database_admin_*}}-Parameter erlauben den Installationsskripten, neue Datenbanken für Instanzen einzurichten und diese bei der Deinstallation auch wieder zu entfernen.
  
−
=== <nowiki>[ebkus]</nowiki> ===
+
Falls aus Sicherheitsgründen erwünscht, kann hier ein Passwort für den Administratorzugriff auf MySQL eingetragen werden. Geschieht dies unter Windows vor der automatischen Installation von MySQL, wird bei der automatischen Installation der Administratorzugriff mit diesem Passwort eingerichtet.
 +
 
 +
Falls das Passwort für den Administratorzugriff nicht im Klartext in der Konfigurationsdatei stehen soll, kann stattdessen <code>ASK</code>eingetragen werden. Dann fragen alle Skripte, die den Administratorzugriff benötigen, interaktiv nach dem Passwort, ohne es irgendwo zu speichern.
 +
 
 +
Da MySQL standardmäßig nur von dem lokalen Rechner erreichbar ist, und dieser ohnehin nur für dem Administrator zugänglich ist, ist die zusätzliche Absicherung durch ein Passwort oft nicht nötig.
  
 
{|border="1" cellspacing="0" cellpadding="8" style="background-color:snow;" width="100%"
 
{|border="1" cellspacing="0" cellpadding="8" style="background-color:snow;" width="100%"
Zeile 133: Zeile 88:
 
! Standardwert
 
! Standardwert
 
! Bedeutung
 
! Bedeutung
 +
|-
 +
|{{konfig|download_dir}}
 +
|{{konfig|install_dir}}/download
 +
|Downloadverzeichnis. Dort steht die zu installierende Software, die im Bedarfsfall heruntergeladen wird.
 
|-
 
|-
 
|{{konfig|database_admin_host}}
 
|{{konfig|database_admin_host}}
 
|{{code|localhost}}
 
|{{code|localhost}}
−
|
+
|Name oder IP-Nummer des Rechners, auf dem MySQL läuft. Muss angegeben werden, wenn das nicht der lokale Rechner ist.
−
 
+
−
 
+
−
|-
+
−
|{{konfig|database_admin_password}}
+
−
|{{code|}}
+
−
|
+
−
 
+
−
 
+
 
|-
 
|-
 
|{{konfig|database_admin_user}}
 
|{{konfig|database_admin_user}}
 
|{{code|root}}
 
|{{code|root}}
−
|
+
|MySQL-Benutzer mit Administratorrechten
−
 
+
−
 
+
 
|-
 
|-
−
|{{konfig|download_dir}}
+
|{{konfig|database_admin_password}}
−
|{{code|%(install_dir)s/download}}
+
−
|
+
−
 
+
−
 
+
−
|-
+
−
|{{konfig|ebkus_document_root}}
+
−
|{{code|%(ebkus_home)s/htdocs/ebkus}}
+
−
|
+
−
 
+
−
 
+
−
|-
+
−
|{{konfig|ebkus_home}}
+
−
|{{code|%(install_dir)s/ebkus}}
+
−
|
+
−
 
+
−
 
+
−
|-
+
−
|{{konfig|ebkus_python_path}}
+
−
|{{code|%(ebkus_home)s/lib}}
+
−
|
+
−
 
+
−
 
+
−
|-
+
−
|{{konfig|ebkus_version}}
+
−
|{{code|_ebkus_version}}
+
−
|
+
−
 
+
−
 
+
−
|-
+
−
|{{konfig|install_dir}}
+
 
|{{code|}}
 
|{{code|}}
−
|
+
|Dessen Passwort. Wenn hier ``ASK`` steht, wird das Passwort bei Bedarf interaktiv abgefragt.
−
 
+
  
 
|-
 
|-
 
|{{konfig|mysql_dir}}
 
|{{konfig|mysql_dir}}
 
|{{code|}}
 
|{{code|}}
−
|
+
|Verzeichnis, in dem die MySQL-Programme mysql, mysqldump, etc. stehen. Muss angegeben werden, wenn MySQL-Programme nicht im Pfad stehen.
−
 
+
  
 
|-
 
|-
 
|{{konfig|python_executable}}
 
|{{konfig|python_executable}}
−
|{{code|sys.executable}}
 
 
|
 
|
 +
|Vollständiger Pfad des Python-Executable, mit dem EBKuS ausgeführt wird
 
|}
 
|}
  
  
 
=== <nowiki>[apache]</nowiki> ===
 
=== <nowiki>[apache]</nowiki> ===
 +
 +
Für den Parameter {{konfig|server_name}} muss unbedingt der Name oder die IP-Nummer des Rechners eingetragen werden, auf dem der Apache-Webserver läuft. Die generierte Konfigurationsdatei setzt den Standardwert <code>localhost</code>, womit EBKuS nur auf dem lokalen Rechner zugänglich ist.
 +
 +
Für den Parameter {{konfig|server_admin}} sollte eine sinnvolle Email-Adresse eingetragen werden. Sie taucht in Apache-Fehlermeldungen auf (die allerdings normalerweise nicht vorkommen sollten).
 +
 +
Alle übrigen Werte können in der Regel von der generierten Konfigurationsdatei übernommen werden.
  
 
{|border="1" cellspacing="0" cellpadding="8" style="background-color:snow;" width="100%"
 
{|border="1" cellspacing="0" cellpadding="8" style="background-color:snow;" width="100%"
Zeile 209: Zeile 132:
 
|-
 
|-
 
|{{konfig|apache_log_dir}}
 
|{{konfig|apache_log_dir}}
−
|{{code|%(ebkus_home)s/log}}
+
|{{konfig|ebkus_home}}/log
−
|
+
|Verzeichnis, in dem der Apache-Webserver Log-Dateien anlegt
−
 
+
−
 
+
 
|-
 
|-
 
|{{konfig|server_admin}}
 
|{{konfig|server_admin}}
 
|{{code|admin@localhost}}
 
|{{code|admin@localhost}}
−
|
+
|Email-Adresse des Serveradministrators, die auf evt. Fehlerseiten des Servers erscheint.
−
 
+
  
 
|-
 
|-
 
|{{konfig|server_name}}
 
|{{konfig|server_name}}
 
|{{code|localhost}}
 
|{{code|localhost}}
−
|
+
|Name oder IP-Nummer des Rechners, auf dem der Apache-Webserver läuft.
 +
**Muss** explizit eingetragen werden, sonst kann EBKuS nur auf dem lokalen Rechner verwendet werden!
  
 +
|-
 +
|{{konfig|server_https_port}}
 +
|{{code|443}}
 +
|Port für verschlüsselte Verbindungen. Die EBKuS-Anwendung wird ausschließlich über diesen Port abgewickelt. Wenn der Standardport {{code|443}} nicht zur Verfügung steht, kann hier ein alternativer Port angegeben werden. Dieser muss dann als Teil der URL aufgeführt werden, z.B. für den Alternativport {{code|500}}: {{code|<nowiki>https://192.168.1.73:500/ebkus/demo/</nowiki>}}.
 +
 +
|-
 +
|{{konfig|server_https_port}}
 +
|{{code|80}}
 +
|Port für unverschlüsselte Verbindungen. Die EBKuS-Anwendung verwendet diesen Port nicht. Dient nur zur Kontrolle des Apache Webservers: {{code|<nowiki>http://localhost/</nowiki>}} liefert "It works!". Wird hier der Port {{code|8080}} angegeben, müsste man  {{code|<nowiki>http://localhost:8080/</nowiki>}} schreiben.
  
 
|-
 
|-
 
|{{konfig|ssl_certificate_file}}
 
|{{konfig|ssl_certificate_file}}
−
|{{code|%(ebkus_home)s/ebkus_ssl_certificates/ebkusserver.cert}}
+
|{{konfig|ebkus_home}}/ebkus_ssl_certificates/ebkusserver.cert
−
|
+
|Vollständiger Pfad der SSL-Zertifikat-Datei
  
  
 
|-
 
|-
 
|{{konfig|ssl_certificate_key_file}}
 
|{{konfig|ssl_certificate_key_file}}
−
|{{code|%(ebkus_home)s/ebkus_ssl_certificates/ebkusserver.key}}
+
|{{konfig|ebkus_home}}/ebkus_ssl_certificates/ebkusserver.key
−
|
+
|Vollständiger Pfad der SSL-Schlüssel-Datei
 
|}
 
|}
  
  
 
=== <nowiki>[openssl]</nowiki> ===
 
=== <nowiki>[openssl]</nowiki> ===
 +
 +
Die Anwendung ist voll funktionsfähig mit den Werten aus der generierten Konfigurationsdatei; es empfiehlt sich jedoch, die organisatorischen Angaben für das SSL-Zertifikat anzupassen.
  
 
{|border="1" cellspacing="0" cellpadding="8" style="background-color:snow;" width="100%"
 
{|border="1" cellspacing="0" cellpadding="8" style="background-color:snow;" width="100%"
Zeile 246: Zeile 178:
 
! Bedeutung
 
! Bedeutung
 
|-
 
|-
−
|{{konfig|land}}
+
|{{konfig|openssl_executable}}
−
|{{code|Berlin}}
+
|{{code|openssl}}
−
|
+
|Falls openssl nicht im Pfad steht, muss der hier der vollständige Pfad zum Executable stehen
  
 +
|-
 +
|{{konfig|output_password}}
 +
|{{code|polo}}
 +
|Wird zur automatischen Zertifikatgenerierung benötigt
  
 
|-
 
|-
−
|{{konfig|openssl_executable}}
+
|{{konfig|staat}}
−
|{{code|openssl}}
+
|{{code|DE}}
−
|
+
|Erscheint im SSL-Zertifikat
  
 +
|-
 +
|{{konfig|land}}
 +
|{{code|Berlin}}
 +
|Erscheint im SSL-Zertifikat
  
 +
|-
 +
|{{konfig|ort}}
 +
|{{code|Berlin}}
 +
|Erscheint im SSL-Zertifikat
 
|-
 
|-
 
|{{konfig|organisation}}
 
|{{konfig|organisation}}
 
|{{code|EFB}}
 
|{{code|EFB}}
−
|
+
|Erscheint im SSL-Zertifikat
−
 
+
  
 
|-
 
|-
 
|{{konfig|organisationseinheit}}
 
|{{konfig|organisationseinheit}}
 
|{{code|EFB}}
 
|{{code|EFB}}
−
|
+
|Erscheint im SSL-Zertifikat
  
 +
|}
  
−
|-
 
−
|{{konfig|ort}}
 
−
|{{code|Berlin}}
 
−
|
 
  
 +
=== <nowiki>[</nowiki>''Instanz''<nowiki>]</nowiki> ===
  
−
|-
 
−
|{{konfig|output_password}}
 
−
|{{code|polo}}
 
−
|
 
  
 +
Im Rahmen einer EBKuS-Installation auf einem Server können mehrere Instanzen einer EBKuS-Anwendung eingerichtet werden. Jede Instanz
  
−
|-
+
*hat einen Namen ({{konfig|instance_name}})
−
|{{konfig|staat}}
+
*ist über eine eigene URL ansprechbar (<code>https://</code>'''server_name'''<code>/ebkus/</code>'''instance_name'''<code>/index.html</code>)
−
|{{code|DE}}
+
*hat eine eigene Datenbank im Rahmen einer MySQL-Installation ({{konfig|database_name}}, {{konfig|database_user}}, {{konfig|database_password}})
−
|
+
*hat ein eigenes Verzeichnis ({{konfig|instance_home}})
−
|}
+
*hat einen eigenen EBKuS-Server, der vom Apache-Webserver über eine eigene Portnummer angesprochen wird ({{konfig|port}})
 +
*hat eine eigene Log-Datei ({{konfig|log_file}})
 +
 
 +
 
 +
Für jede gewünschte Instanz wird eine Sektion in der Konfigurationsdatei angelegt. Die Sektionsüberschrift wird aus dem Namen der Instanz in eckigen Klammern gebildet. Der Name sollte mit einem Buchstaben beginnen und ansonsten nur Buchstaben, Ziffern und Unterstriche (<code>_</code>) enthalten (keine Leerzeichen!). Ein zusätzlicher Name für die Instanz ohne diese Einschränkung lässt sich über den Parameter {{konfig|instance_title}} einrichten (siehe unten).
 +
 
 +
Falls der Instanzname mit <code>demo</code> beginnt, werden bei der Installation der Datenbank automatisch Demodaten erzeugt. Neben dem Benutzer <code>Admin</code> (Passwort: <code>Admin</code>) gibt es dann auch den Benutzer <code>test</code> (Passwort: <code>test</code>) und <code>verw</code>(Passwort: <code>verw</code>).
  
 +
Jede Sektion kann die in der Tabelle aufgeführten Parameter definieren. Erforderlich ist Wiederholung des Instanznamen als Wert von {{konfig|instance_name}}, ferner die Angabe einer eigenen, eindeutigen Portnummer, {{konfig|port}}. Für alle anderen Parameter können die Standardwerte genommen werden.
 +
 +
Natürlich muss man {{konfig|berliner_version}} auf <code>true</code> setzen, wenn man die Berliner Version mit Berliner Straßenkatalog haben möchte; EBKuS-spezifische Fehlermeldungen sollten außerdem eine sinnvolle Telefonnummer bzw. Email-Adresse des Anwendungsbetreuers haben ({{konfig|admin_tel}}, {{konfig|admin_email}}).
 +
 +
Die Parameter {{konfig|host}} und {{konfig|database_host}} müssen nur dann angepasst werden, wenn der EBKuS-Server bzw. die MySQL-Datenbank nicht auf demselben Rechner laufen wie der Apache-Webserver.
 +
 +
Die bei der Installation generierte Konfigurationsdatei definiert vier Instanzen (2 davon auskommentiert):
 +
 +
*<code>demo</code>: Demodaten, kein Straßenkatalog
 +
*<code>muster_efb</code>: keine Demodaten, kein Straßenkatalog. Beispiel für eine Produktionsinstanz, die vom Anwendungsbetreuer eingerichtet werden muss (siehe Einrichtung der Anwendung im Handbuch).
 +
 +
Auskommentiert:
 +
*<code>demo_berlin</code>: Demodaten, Berliner Straßenkatalog (kleiner Ausschnitt, nur Straßen, deren Namen mit 'K' beginnen)
 +
*<code>demo_braunschweig</code>: Demodaten, Straßenkatalog mit Straßen aus Braunschweig, Gifhorn, Wolfenbüttel und Wolfsburg.
  
−
=== <nowiki>[instance]</nowiki> ===
 
  
 
{|border="1" cellspacing="0" cellpadding="8" style="background-color:snow;" width="100%"
 
{|border="1" cellspacing="0" cellpadding="8" style="background-color:snow;" width="100%"
Zeile 295: Zeile 252:
 
! Standardwert
 
! Standardwert
 
! Bedeutung
 
! Bedeutung
−
|-
 
−
|{{konfig|admin_email}}
 
−
|{{code|Keine Angabe}}
 
−
|Email-Adresse des Anwendungsadministrators.
 
  
−
Wird in Fehlermeldungen genannt.
 
−
|-
 
−
|{{konfig|admin_name}}
 
−
|{{code|Keine Angabe}}
 
−
|Name des Anwendungsadministrators.
 
  
−
Wird in Fehlermeldungen genannt.
 
 
|-
 
|-
−
|{{konfig|admin_tel}}
+
|{{konfig|instance_name}}
−
|{{code|Keine Angabe}}
+
|style="background-color:orangered;"|{{code|}}
−
|Telefonnummer des Anwendungsadministrators.
+
|Name der Instanz. Muss angegeben werden und dem Namen des Abschnitts (in eckigen Klammern) identisch sein. Darf keine Sonderzeichen außer den Unterstrich ('_') enthalten.
−
 
+
−
Wird in Fehlermeldungen genannt.
+
−
|-
+
−
|{{konfig|ak_dirs_max}}
+
−
|{{code|100}}
+
−
|
+
  
  
 
|-
 
|-
−
|{{konfig|anmeldungsdaten_obligatorisch}}
+
|{{konfig|instance_home}}
−
|{{code|false}}
+
|{{konfig|ebkus_home}}/{{konfig|instance_name}}
−
|Falls <code>true</code>
+
|Instanzverzeichnis. Liegt im Homeverzeichnis. Sollte nicht verändert werden.
−
werden die Anmeldungsdaten obligatorisch im Aufnahmeformular erhoben anstatt optional
+
−
in einer getrennten Maske.
+
  
−
Die entsprechenden Pflichfelder sind dabei auszufüllen. Eine spätere Bearbeitung der Anmeldungsdaten erfolgt wie bisher in einer eigenständigen Maske (analog der späteren Bearbeitung einer Leistung).
 
 
|-
 
|-
−
|{{konfig|beratungskontakte}}
+
|{{konfig|initial_content}}
−
|{{code|false}}
+
|{{code|}}
−
|Falls <code>true</code> können in der
+
|Hier kann eine Datei angegeben werden, mit der die Instanzdatenbank initialisiert werden kann. Diese Datei wird immer dann geladen, wenn bei der Installation der Instanz ({{code|install.py}} oder {{code|configure.py}}) keine funktionierende Datenbank für die Instanz vorgefunden wird. Wenn keine Datei angegeben ist, wird eine neue Datenbank mit dem Merkmalskatalog ({{file|sql/merkmale_standard.py}}) und evt. einem Straßenkatalog erstellt. Wenn kein vollständiger Pfad für die Datei angegeben wird, muss die Datei im Homeverzeichnis liegen. Zulässige Dateien sind die mit dem Skript {{code|datenbank_sichern.py}} erzeugte Dateien sowie sonstige passende SQL-Dumps.
−
Klientenakte einzelne Beratungskontakte eingetragen werden.
+
  
−
Die Summen werden in die Bundesstatistik und in die  Fachstatistik als Vorgabe übernommen.
 
−
|-
 
−
|{{konfig|beratungskontakte_bs}}
 
−
|{{code|false}}
 
−
|Falls <code>true</code> treten Anpassungen speziell
 
−
für Braunschweig in Kraft.
 
−
 
−
Die Variable <code>beratungskontakte</code> muss ebenfalls auf <code>true</code> stehen.
 
 
|-
 
|-
 
|{{konfig|berliner_version}}
 
|{{konfig|berliner_version}}
 
|{{code|false}}
 
|{{code|false}}
−
|
+
|Wenn hier {{code|true}} steht, wird die Berliner EBKuS-Version verwendet mit Berliner Straßenkatalog.
−
 
+
  
 
|-
 
|-
 
|{{konfig|database_host}}
 
|{{konfig|database_host}}
 
|{{code|localhost}}
 
|{{code|localhost}}
−
|
+
|Name oder IP-Nummer, auf dem der Datenbankserver läuft.
−
 
+
  
 
|-
 
|-
 
|{{konfig|database_name}}
 
|{{konfig|database_name}}
−
|{{code|%(instance_name)s}}
+
|{{konfig|instance_name}}
−
|
+
|Name der Instanzdatenbank
  
 +
 +
|-
 +
|{{konfig|database_user}}
 +
|{{konfig|instance_name}}
 +
|Benutzername der Instanzdatenbank
  
 
|-
 
|-
 
|{{konfig|database_password}}
 
|{{konfig|database_password}}
−
|{{code|%(instance_name)s}}
+
|{{konfig|instance_name}}
−
|
+
|Passwort der Instanzdatenbank
  
  
 
|-
 
|-
−
|{{konfig|database_type}}
+
|{{konfig|gemeindeschluessel_von_plz}}
−
|{{code|MySQLdb}}
+
|{{code|}}
−
|
+
|Definiert die Teilmenge der amtlichen Gemeindeschlüssel für die Bundesstatistik. Im Normalfall muss hier nichts eingetragen werden.
 +
<br />
 +
In der Bundesstatistik soll der amtliche Gemeindeschlüssel für den Wohnort des Klienten  eingetragen werden, wenn der Wohnort des Klienten außerhalb des Kreises der Beratungsstelle liegt.  Um die Menge der Daten zu begrenzen, kann hier über die Anfangsziffern der Postleitzahl eine Teilmenge  definiert werden. Wenn mehrere Ziffernfolgen angegeben werden, müssen diese mit <code>;</code> getrennt  werden.<br /><br /> Beispiele: <ul> <li>Alle Gemeindeschlüssel verwenden, außer die Postleitzahl der Gemeinde beginnt mit '9': <pre> 0;1;2;3;4;5;6;7;8 </pre> </li> <li>Große Teile Niedersachsens: <pre> 29;30;31;37;38 </pre> </li> <li>Nördliches Niedersachsen und Schleswig Holstein: <pre> 2 </pre> </li> <li>Berlin und Umgebung: <pre> 10;12;13;14;15;16 </pre> </li> <li>Bleibt die Variable leer, werden alle Gemeindeschlüssel verwendet. </li> </ul>  Wenn es bei der Erkennung von Gemeindeschluesseln zu vielen Fehlern kommt, beispielsweise wegen unterschiedlicher Schreibweisen von Orten, kann man selber eine Datei  <code>EBKUS_HOME/sql/gemeindeschluessel.csv</code> erstellen, bestehend aus einer Tabelle mit den Spalten  <code>plz, ort ags</code>. Als Vorlage kann die Datei <code>EBKUS_HOME/sql/gemeindeschluessel_cache.csv</code> dienen, die automatisch erzeugt wird,  wenn die Konfigurationsvariable <code>gemeindeschluessel_von_plz</code> einen Wert hat.
 +
|-
 +
|{{konfig|host}}
 +
|{{code|localhost}}
 +
|Name oder IP-Nummer des Rechners, auf der der EBKuS-Server der Instanz läuft.
  
  
 
|-
 
|-
−
|{{konfig|database_user}}
+
|{{konfig|keine_bundesstatistik}}
−
|{{code|%(instance_name)s}}
+
|{{code|false}}
−
|
+
|Falls hier {{code|true}} steht, wird die Bundesstatistik aus der Anwendung ausgeblendet. Es kann keine Bundesstatistik ausgefüllt werden und steht auch nicht für Statistik und Export zur Verfügung.
  
 +
|-
 +
|{{konfig|log_file}}
 +
|{{konfig|instance_home}}{{code|/}}{{konfig|instance_name}}{{code|.log}}
 +
|Name der Datei, in die der EBKuS-Server Meldungen schreibt
  
 
|-
 
|-
−
|{{konfig|document_root}}
+
|{{konfig|log_level}}
−
|{{code|%(instance_home)s/htdocs}}
+
|{{code|INFO}}
−
|
+
|Legt fest, wie "geschwätzig" der EBKuS-Server ist. Muss einer der folgenden Werte sein, in aufsteigender Wortfülle: {{code|CRITICAL, ERROR, WARNING, INFO, DEBUG}} ({{code|DEBUG}} ist nur für die Fehlersuche geeignet, da sehr viel ausgegeben wird.)
−
 
+
  
 
|-
 
|-
−
|{{konfig|extern_button1_label}}
+
|{{konfig|port}}
−
|{{code|}}
+
|style="background-color:orangered;"|{{code|}}
−
|
+
|Portnummer über die der EBKuS-Server angesprochen wird. Muss angegeben werden. Jede Instanz muss eine unterschiedliche Portnummer erhalten.
 +
|}
  
  
−
|-
+
==== Konfiguration für externe Anwendungen ====
−
|{{konfig|extern_button1_url}}
+
−
|{{code|}}
+
−
|
+
  
 +
Die folgenden Konfigurationsvariablen bewirken, dass auf der Klientenkarte ein Kasten mit maximal vier Buttons erscheint, die in einem neuen Tab/Fenster eine URL aufrufen, die Felder des aktuellen (letzten) Falles bzw. des angemeldeten Mitarbeiters als Bestandteile haben kann:
 +
  # Kein Kasten, wenn diese Variable keinen Wert hat.
 +
  extern_fieldset_label: Externe Anwendung
 +
  # Position auf der Klientenkarte
 +
  extern_fieldset_position: 6
 +
  # Maximal vier Buttons, für jeden eine Bezeichnung und eine Url.
 +
  # Ein Button kommt nur zustande, wenn sowohl Label als auch Url
 +
  # einen Wert haben.
 +
  extern_button1_label: GoogleWeb
 +
  extern_button1_url: <nowiki>http://www.google.com/search?q=$$fall_id$$_$$fall_akte__ort$$</nowiki>
 +
  extern_button2_label: GoogleMaps
 +
  extern_button2_url: <nowiki>http://www.google.com/maps?q=$$mitarbeiter_na$$</nowiki>
 +
  extern_button3_label: GoogleImages
 +
  extern_button3_url: <nowiki>http://www.google.com/images?q=$$fall_akte__ort$$</nowiki>
 +
  extern_button4_label: GoogleNews
 +
  extern_button4_url: http://www.google.com/news?q=$$fall_fn$$</nowiki>
  
−
|-
+
Urls können Abschnitte der folgenden Form enthalten:
−
|{{konfig|extern_button2_label}}
+
{{code|$$<fall oder mitarbeiter>_<feld>$$}}
−
|{{code|}}
+
Der ganze Abschnitt wird durch den Wert von {{code|<feld>}} ersetzt,
−
|
+
wobei entweder im Fall-Objekt oder im Mitarbeiter-Objekt
 +
nachgeschlagen wird.
 +
Beispiele:
 +
{{code|$$fall_id$$}}, {{code|$$mitarbeiter_na$$}}, {{code|$$fall_akte__ort$$}}
  
 +
Im Beispiel oben werden als externe Anwendungen verschiedene Google-Dienst aufgerufen, wobei als Parameter Daten aus dem aktuellen Fall übergeben werden.
 +
(Das Beispiel ist nicht sinnvoll und dient nur der Illustration des Mechanismus.)
  
 +
{|border="1" cellspacing="0" cellpadding="8" style="background-color:snow;" width="100%"
 +
|- align="left" style="background-color:aliceblue;"
 +
! Parameter
 +
! Standardwert
 +
! Bedeutung
 
|-
 
|-
−
|{{konfig|extern_button2_url}}
+
|{{konfig|extern_fieldset_label}}
 
|{{code|}}
 
|{{code|}}
−
|
+
|Bezeichnung für den Kasten mit den Buttons für die externen Anwendungen
−
 
+
  
 
|-
 
|-
−
|{{konfig|extern_button3_label}}
+
|{{konfig|extern_fieldset_position}}
 +
|{{code|2}}
 +
|Position auf der Klientenkarte (Gezählt werden die umrandeten Kästen mit einer Bezeichnung: Klientendaten, Bezugspersonen, Leistungen, etc.)
 +
|-
 +
|{{konfig|extern_buttonX_label}}
 
|{{code|}}
 
|{{code|}}
−
|
+
|Name der externen Anwendung
  
  
 
|-
 
|-
−
|{{konfig|extern_button3_url}}
+
|{{konfig|extern_buttonX_url}}
 
|{{code|}}
 
|{{code|}}
−
|
+
|URL der externen Anwendung mit Platzhaltern für die zu übernehmenden Parameter
 +
 
 
|}
 
|}
  
 +
{{konfig|X}} kann 1,2,3 oder 4 sein.
  
−
|-
 
−
|{{konfig|extern_button4_label}}
 
−
|{{code|}}
 
−
|
 
  
 +
== Fachliche Parameter ==
  
−
|-
+
Die hier beschriebenen Einstellungen können auch vom Anwendungsbetreuer über {{pfad2|Administratorhauptmenü|Allgemeine Konfiguration}} vorgenommen werden.
−
|{{konfig|extern_button4_url}}
+
−
|{{code|}}
+
−
|
+
  
  
 +
=== <nowiki>[</nowiki>''Instanz''<nowiki>]</nowiki> ===
 +
 +
{|border="1" cellspacing="0" cellpadding="8" style="background-color:snow;" width="100%"
 +
|- align="left" style="background-color:aliceblue;"
 +
! Parameter
 +
! Standardwert
 +
! Bedeutung
 
|-
 
|-
−
|{{konfig|extern_fieldset_label}}
+
|{{konfig|admin_email}}
−
|{{code|}}
+
|{{code|Keine Angabe}}
−
|
+
|Email-Adresse des Anwendungsbetreuers.
  
 +
Wird in Fehlermeldungen genannt.
 +
|-
 +
|{{konfig|admin_name}}
 +
|{{code|Keine Angabe}}
 +
|Name des Anwendungsbetreuers.
  
 +
Wird in Fehlermeldungen genannt.
 
|-
 
|-
−
|{{konfig|extern_fieldset_position}}
+
|{{konfig|admin_tel}}
−
|{{code|2}}
+
|{{code|Keine Angabe}}
−
|
+
|Telefonnummer des Anwendungsbetreuers.
−
 
+
  
 +
Wird in Fehlermeldungen genannt.
 
|-
 
|-
−
|{{konfig|fachstatistik_akte_diskrepanz_nicht_zulassen}}
+
|{{konfig|anmeldungsdaten_}} {{konfig|obligatorisch}}
 
|{{code|false}}
 
|{{code|false}}
−
|Falls <code>true</code>
+
|Falls <code>true</code> werden die Anmeldungsdaten obligatorisch im Aufnahmeformular erhoben anstatt optional in einer getrennten Maske.
−
werden Diskrepanzen zwischen Fachstatistik und Akte nicht zugelassen.
+
  
−
Die entsprechenden Items in der Fachstatistik zeigen die Werte aus der Akte und sind nicht modifizierbar. Eine Diskrepanz kann so gar nicht entstehen. Allerdings muss bei Änderungen in der Akte die Fachstatistik neu abgespeichert werden, damit die Änderungen übernommen und für die Statistik wirksam werden.<br /> Betroffen sind nur die Items 'Familienstatus', 'Empfohlen von' und 'Erbrachte Leistungen in der Fachstatistik', deren Werte im Normalfall aus der Akte vorbelegt werden.
+
Die entsprechenden Pflichfelder sind dabei auszufüllen. Eine spätere Bearbeitung der Anmeldungsdaten erfolgt wie bisher in einer eigenständigen Maske (analog der späteren Bearbeitung einer Leistung).
 
|-
 
|-
−
|{{konfig|fallunabhaengige_aktivitaeten_bs}}
+
|{{konfig|anmeldeprobleme_und_}} {{konfig|beschaeftigung_bei_}}{{konfig|anmeldung_erfassen}}
 
|{{code|false}}
 
|{{code|false}}
−
|Falls <code>true</code> können
+
|Falls <code>true</code> werden Probleme bei der Anmeldung und Beschäftigung schon bei der Anmeldung erfasst und später für die Fachstatistik übernommen.
−
fallunabhängige Aktivitäten eingetragen und ausgewertet
+
−
werden. Speziell für Braunschweig.
+
−
 
+
  
 +
Die Auswahlfelder 'Beschäftigung Jugendliche(r)', 'Beschäftigungsverhältnis Mutter', 'Beschäftigungsverhältnis Vater' und das Mehrfachauswahlfeld 'Problem(e) bei der Anmeldung' aus der Fachstatistik werden in den Kasten Anmeldekontakt als Pflichtfelder aufgenommen. Es ist jedoch in jedem Fall möglich 'Keine Angabe' auszuwählen (genau wie in der Fachstatistik selbst). Die Daten werden mit dem Fall (nicht mit der Akte bzw. den Stammdaten) gespeichert. Wenn eine Fachstatistik angelegt wird, werden die Daten übernommen.
 
|-
 
|-
−
|{{konfig|gemeindeschluessel_von_plz}}
+
|{{konfig|beratungskontakte}}
−
|{{code|}}
+
|{{code|false}}
−
|Definiert die Teilmenge der amtlichen Gemeindeschlüssel für die Bundesstatistik.
+
|Falls <code>true</code> können in der Klientenakte einzelne Beratungskontakte eingetragen werden. Die Summen werden in die Bundesstatistik und in die  Fachstatistik als Vorgabe übernommen.
−
 
+
−
In der Bundesstatistik soll der amtliche Gemeindeschlüssel für den Wohnort des Klienten  eingetragen werden, wenn der Wohnort des Klienten außerhalb des Kreises der Beratungsstelle liegt.  Um die Menge der Daten zu begrenzen, kann hier über die Anfangsziffern der Postleitzahl eine Teilmenge  definiert werden. Wenn mehrere Ziffernfolgen angegeben werden, müssen diese mit <code>;</code> getrennt  werden.<br /><br /> Im Normalfall brauchen Sie den voreingestellten Wert nicht zu ändern. <br /><br /> Beispiele: <ul> <li>Alle Gemeindeschlüssel verwenden, außer die Postleitzahl der Gemeinde beginnt mit '9': <pre> 0;1;2;3;4;5;6;7;8 </pre> </li> <li>Große Teile Niedersachsens: <pre> 29;30;31;37;38 </pre> </li> <li>Nördliches Niedersachsen und Schleswig Holstein: <pre> 2 </pre> </li> <li>Berlin und Umgebung: <pre> 10;12;13;14;15;16 </pre> </li> <li>Bleibt die Variable leer, werden alle Gemeindeschlüssel verwendet. </li> </ul> Wenn es bei der Erkennung von Gemeindeschluesseln zu vielen Fehlern kommt, beispielsweise wegen unterschiedlicher Schreibweisen von Orten, kann man selber eine Datei  <code>EBKUS_HOME/sql/gemeindeschluessel.csv</code> erstellen, bestehend aus einer Tabelle mit den Spalten  <code>plz, ort ags</code>. Als Vorlage kann die Datei <code>EBKUS_HOME/sql/gemeindeschluessel_cache.csv</code> dienen, die automatisch erzeugt wird,  wenn die Konfigurationsvariable <code>gemeindeschluessel_von_plz</code> einen Wert hat.  
+
 
|-
 
|-
−
|{{konfig|host}}
+
|{{konfig|beratungskontakte_bs}}
−
|{{code|localhost}}
+
|{{code|false}}
−
|
+
|Falls <code>true</code> treten Anpassungen speziell für Braunschweig in Kraft.
−
 
+
  
 +
Die Variable <code>beratungskontakte</code> muss ebenfalls auf <code>true</code> stehen.
 
|-
 
|-
−
|{{konfig|initial_content}}
+
|{{konfig|cache_on}}
−
|{{code|}}
+
|{{code|true}}
−
|
+
|Falls <code>true</code> wird der Objektcache eingeschaltet, sonst bleibt er abgeschaltet.
  
 +
Normalerweise ist der Cache an, aber es kann in seltenen Fällen zu Fehlern kommen, die verschwinden, wenn er abgeschaltet wird. Auf die inhaltlichen Abläufe hat das keine Auswirkungen,
 +
allenfalls auf die Performance.
 +
|-????
 +
|{{konfig|erinnern_nach_wochen_ohne_kontakt}}
 +
|{{code|0}}
 +
|Anzahl der Wochen ohne Kontakt nach der ein offener Fall in die Erinnerungsfunktion aufgenommen wird.
  
−
|-
+
Wenn hier eine Zahl zwischen 1 und 99 steht, wird die Erinnerungsfunktion aktiviert. Auf einem zusätzlichen Button im Hauptmenü steht dann die Anzahl der offenen Fälle, mit denen es länger als die angegebene Anzahl von Wochen keinen Kontakt gegeben hat. Nach dem Betätigen des Buttons erscheint eine Liste dieser Fälle. Jeder Fall kann als erledigt markiert werden, worauf er künftig normalerweiser nicht mehr in der Liste erscheint. Für die gesamte Liste gibt es aber eine Option, alle Fälle einschließlich der erledigten anzuzeigen. Die 'Erledigt'-Markierung kann dann auch wieder rückgängig gemacht werden.
−
|{{konfig|instance_home}}
+
−
|{{code|%(ebkus_home)s/%(instance_name)s}}
+
−
|
+
−
 
+
  
 +
Es muss hier die Ziffer 0 stehen, wenn die Erinnerungsfunktion deaktiviert bleiben soll.
 
|-
 
|-
−
|{{konfig|instance_name}}
+
|{{konfig|fachstatistik_akte_}} {{konfig|diskrepanz_nicht_zulassen}}
−
|{{code|}}
+
|{{code|false}}
−
|
+
|Falls <code>true</code> werden Diskrepanzen zwischen Fachstatistik und Akte nicht zugelassen.
−
 
+
  
 +
Die entsprechenden Items in der Fachstatistik zeigen die Werte aus der Akte und sind nicht modifizierbar. Eine Diskrepanz kann so gar nicht entstehen. Allerdings muss bei Änderungen in der Akte die Fachstatistik neu abgespeichert werden, damit die Änderungen übernommen und für die Statistik wirksam werden.<br /> Betroffen sind nur die Items 'Familienstatus', 'Empfohlen von' und 'Erbrachte Leistungen in der Fachstatistik', deren Werte im Normalfall aus der Akte vorbelegt werden.
 +
|-
 +
|{{konfig|fallunabhaengige}} {{konfig|_aktivitaeten_bs}}
 +
|{{code|false}}
 +
|Falls <code>true</code> können fallunabhängige Aktivitäten eingetragen und ausgewertet werden. Speziell für Braunschweig. 
 +
|-
 +
|{{konfig|fallbeginn_bei_}}{{konfig|erster_leistung}}
 +
|{{code|false}}
 +
|Bei Neumelde- und Abschlusszahlen sowie Klienten pro Mitarbeiter wird der Fallbeginn ab dem Datum der erste Leistung definiert anstatt ab dem Anmeldedatum.
 +
|-
 +
|{{konfig|fallbeginn_waehlbar}}
 +
|{{code|false}}
 +
|Bei Neumelde- und Abschlusszahlen sowie Klienten pro Mitarbeiter kann ein Häkchen gesetzt werden, um den Fallbeginn ab erster Leistung zu definieren.
 
|-
 
|-
 
|{{konfig|instance_title}}
 
|{{konfig|instance_title}}
−
|{{code|self.get_instance_title(instance_name)}}
+
|{{konfig|instance_name}}
 
|Langname für die Instanz.
 
|Langname für die Instanz.
  
 
Erscheint bei der Anmeldung und in der Statuszeile.
 
Erscheint bei der Anmeldung und in der Statuszeile.
 
|-
 
|-
−
|{{konfig|keine_bundesstatistik}}
+
|{{konfig|jgh_gemeindeschluessel}}
 +
|{{code|}}
 +
|Die letzten drei Ziffern des [http://de.wikipedia.org/wiki/Amtlicher_Gemeindeschl%C3%BCssel Amtlichen Gemeindeschlüssels] oder das Wort "blank".
 +
 
 +
Standardmäßig setzt EBKuS für diese drei Ziffern (Spalte 7-9 des Exportdatensatzes) drei mal die Ziffer 0 ein. Unseres Wissens werden diese Daten für die
 +
Bundesstatistik allerdings nicht ausgewertet. Bei Bedarf kann hier das Wort "blank" angegeben werden, dann erscheinen im Datensatz drei Leerzeichen, oder es können drei Ziffern
 +
eingegeben werden, die dann in den Datensatz eingefügt werden.
 +
|-
 +
|{{konfig|leistungsende_in_}}
 +
{{konfig|zukunft_erlaubt}}
 
|{{code|false}}
 
|{{code|false}}
−
|Fall kann ohne Bundestatistik abgeschlossen werden.
+
|Beim Eintrag einer Leistung darf für das Ende ein Datum, das in der Zukunft liegt, eingetragen werden.
  
−
Alles andere sollte trotzdem noch funktionieren.  
+
Der Abschluss des Falls ist erst möglich, wenn alle Leistungen beendet sind.
 
|-
 
|-
 
|{{konfig|loeschfrist}}
 
|{{konfig|loeschfrist}}
Zeile 508: Zeile 504:
 
Akten, die älter sind, können vom Administrator gelöscht werden.
 
Akten, die älter sind, können vom Administrator gelöscht werden.
 
|-
 
|-
−
|{{konfig|log_file}}
+
|{{konfig|log_query_laenger_als}}
−
|{{code|%(instance_home)s/%(instance_name)s.log}}
+
|{{code|0}}
−
|
+
|Falls größer 0, Datenbankqueries in die Logdatei schreiben, die länger dauern als die angegeben Zahl in Millisekunden.
−
 
+
−
 
+
−
|-
+
−
|{{konfig|log_level}}
+
−
|{{code|INFO}}
+
−
|
+
−
 
+
−
 
+
−
|-
+
−
|{{konfig|master_site}}
+
−
|{{code|A}}
+
−
|
+
−
 
+
  
 +
Wenn 0 eingetragen wird, werden keine Datenbankqueries protokolliert. Alle Datenbankqueries können mit <code>log_level=DEBUG</code> erfasst werden. Nützlich zur Diagnose von Performanceproblemen.
 
|-
 
|-
 
|{{konfig|meldung_vom_admin}}
 
|{{konfig|meldung_vom_admin}}
Zeile 534: Zeile 518:
 
|{{konfig|neumeldungen_nach_region}}
 
|{{konfig|neumeldungen_nach_region}}
 
|{{code|}}
 
|{{code|}}
−
|Definiert eine Tabelle "Neumeldungen nach Region" unter "Neumelde- und Abschlusszahlen".
+
|Definiert eine Tabelle ''Neumeldungen nach Region'' unter ''Neumelde- und Abschlusszahlen''.
−
 
+
−
Die Regionen, für die in der Tabelle die Neumeldungen ausgezählt werden sollen, müssen unter  "Hauptmenü -- Statistikabfrage -- Teilmenge -- Neu" als Teilmengendefinitionen eingeführt werden. Der Namen der gewünschten Definitionen werden durch <code>;</code> getrennt aufgeführt. <br /><br /> Beispiel: <ul> <li> <pre>    Gifhorn und Samtgemeinde Meinersen; Braunschweig 38120 und 38112 </pre> </li> </ul> "Gifhorn und Samtgemeinde Meinersen" ist eine Teilmengendefinition mit der Definition: <code>( ort = 'Gifhorn' ODER samtgemeinde = 'Meinersen' )</code>. "Braunschweig 38120 und 38112" ist eine Teilmengendefinition mit der Definition: <code>( ort = 'Braunschweig' UND plz = '38112' oder '38120' )</code>. <br /><br />
+
−
|-
+
−
|{{konfig|port}}
+
−
|{{code|}}
+
−
|
+
−
 
+
−
 
+
−
|-
+
−
|{{konfig|protocol_dir}}
+
−
|{{code|%(instance_home)s/protokolle}}
+
−
|
+
−
 
+
  
 +
Die Regionen, für die in der Tabelle die Neumeldungen ausgezählt werden sollen, müssen unter {{pfad4|Hauptmenü|Statistikabfrage|Teilmenge|Neu}} als Teilmengendefinitionen eingeführt werden. Der Namen der gewünschten Definitionen werden durch <code>;</code> getrennt aufgeführt. <br /><br /> Beispiel: <ul> <li> <pre>    Gifhorn und Samtgemeinde Meinersen; Braunschweig 38120 und 38112 </pre> </li> </ul> "Gifhorn und Samtgemeinde Meinersen" ist eine Teilmengendefinition mit der Definition: <code>( ort = 'Gifhorn' ODER samtgemeinde = 'Meinersen' )</code>. "Braunschweig 38120 und 38112" ist eine Teilmengendefinition mit der Definition: <code>( ort = 'Braunschweig' UND plz = '38112' oder '38120' )</code>. <br /><br />
 
|-
 
|-
 
|{{konfig|session_time}}
 
|{{konfig|session_time}}
Zeile 555: Zeile 527:
  
 
Nach dieser Zeit wird ein Benutzer automatisch abgemeldet, wenn er keine Eingaben mehr macht.
 
Nach dieser Zeit wird ein Benutzer automatisch abgemeldet, wenn er keine Eingaben mehr macht.
−
|-
 
−
|{{konfig|site}}
 
−
|{{code|A}}
 
−
|
 
−
 
−
 
 
|-
 
|-
 
|{{konfig|sql_abfrage}}
 
|{{konfig|sql_abfrage}}
 
|{{code|false}}
 
|{{code|false}}
−
|Falls <code>true</code>
+
|Falls <code>true</code> steht die Maske zum Absetzen von SQL-Abfragen vom Administrationsmenü aus zur Verfügung.  
−
steht die Maske zum Absetzen von SQL-Abfragen vom
+
−
Administrationsmenü aus zur Verfügung.
+
−
 
+
  
 
|-
 
|-
 
|{{konfig|strassenkatalog}}
 
|{{konfig|strassenkatalog}}
 
|{{code|}}
 
|{{code|}}
−
|Falls diese Variable nicht leer ist, wird bei der Adresseingabe der Straßenkatalog
+
|Falls diese Variable nicht leer ist, wird bei der Adresseingabe der Straßenkatalog verwendet.
−
verwendet.
+
  
−
Der eigentliche Wert der Variable spielt nur bei der Erstinstallation der Instanz eine Rolle.<br />Eine Instanz ohne Straßenkatalog kann auch später noch für die Verwendung  mit Straßenkatalog eingerichtet werden, indem der Straßenkatalog über "Administratorhauptmenü -- Straßenkatalog importieren" importiert wird und der Variable 'strassenkatalog' ein beliebiger Wert zugewiesen wird, beispielsweise der Ortsname.
+
Der eigentliche Wert der Variable spielt nur bei der Erstinstallation der Instanz eine Rolle.<br />Eine Instanz ohne Straßenkatalog kann auch später noch für die Verwendung  mit Straßenkatalog eingerichtet werden, indem der Straßenkatalog über {{pfad2|Administratorhauptmenü|Straßenkatalog importieren}} importiert wird und der Variable {{konfig|strassenkatalog}} ein beliebiger Wert zugewiesen wird, beispielsweise der Ortsname.
 
|-
 
|-
−
|{{konfig|strassenkatalog_vollstaendig}}
+
|{{konfig|strassenkatalog_}} {{konfig|vollstaendig}}
 
|{{code|false}}
 
|{{code|false}}
−
|Falls <code>true</code> wird
+
|Falls <code>true</code> wird angenommen, dass der Straßenkatalog Einträge für jede einzelne Hausnummer enthält.
−
angenommen, dass der Straßenkatalog Einträge für jede einzelne
+
−
Hausnummer enthält.
+
  
 
Ansonsten wird angenommen, dass lediglich Einträge für ganze Straßen bzw. für bestimmte Intervalle von Hausnummern vorhanden sind.
 
Ansonsten wird angenommen, dass lediglich Einträge für ganze Straßen bzw. für bestimmte Intervalle von Hausnummern vorhanden sind.
Zeile 587: Zeile 547:
 
|{{konfig|strassensuche}}
 
|{{konfig|strassensuche}}
 
|{{code|}}
 
|{{code|}}
−
|Bestimmt die Anzeige von Zusatzinformationen aus dem
+
|Bestimmt die Anzeige von Zusatzinformationen aus dem Straßenkatalog bei der Darstellung und Eingabe von Adressen.
−
Straßenkatalog bei der Darstellung und Eingabe von Adressen.
+
  
 
Zulässige Werte sind: <code>ort bezirk ortsteil samtgemeinde</code>.<br /><br /> Beispiele: <ul> <li>In Berlin gibt es nur einen Ort im Straßenkatalog, nämlich 'Berlin'. Das Feld <code>ort</code> ist daher  nicht nötig. Ortsteil und Samtgemeinde haben im Straßenkatalog keine Werte, Bezirk allerdings schon. Der sinnvolle Wert für Berlin ist also <pre>    bezirk </pre> </li> <li>In Gifhorn gibt es mehrere Orte im Straßenkatalog. Sowohl Ortsteile und Samtgemeinden spielen eine Rolle und sind im Straßenkatalog erfasst, Bezirke jedoch nicht. Der sinnvolle Wert hier ist also <pre>    ort ortsteil samtgemeinde </pre> </li> <li>Wenn es nur einen Ort gibt und weder Bezirke, Ortsteile oder Samtgemeinden im Straßenkatalog erfasst sind, sollte die Variable leer bleiben. </ul> <br /><br />Irrelevant, wenn kein Straßenkatalog verwendet wird.
 
Zulässige Werte sind: <code>ort bezirk ortsteil samtgemeinde</code>.<br /><br /> Beispiele: <ul> <li>In Berlin gibt es nur einen Ort im Straßenkatalog, nämlich 'Berlin'. Das Feld <code>ort</code> ist daher  nicht nötig. Ortsteil und Samtgemeinde haben im Straßenkatalog keine Werte, Bezirk allerdings schon. Der sinnvolle Wert für Berlin ist also <pre>    bezirk </pre> </li> <li>In Gifhorn gibt es mehrere Orte im Straßenkatalog. Sowohl Ortsteile und Samtgemeinden spielen eine Rolle und sind im Straßenkatalog erfasst, Bezirke jedoch nicht. Der sinnvolle Wert hier ist also <pre>    ort ortsteil samtgemeinde </pre> </li> <li>Wenn es nur einen Ort gibt und weder Bezirke, Ortsteile oder Samtgemeinden im Straßenkatalog erfasst sind, sollte die Variable leer bleiben. </ul> <br /><br />Irrelevant, wenn kein Straßenkatalog verwendet wird.
 
|-
 
|-
−
|{{konfig|warnung_bei_fachstatistik_akte_diskrepanz}}
+
|{{konfig|warnung_bei_fachstatistik_}} {{konfig|akte_diskrepanz}}
 
|{{code|false}}
 
|{{code|false}}
−
|Falls <code>true</code>
+
|Falls <code>true</code> wird beim Speichern der Fachstatistik auf eine Diskrepanz zwischen Akte und Fachstatistik hingewiesen, falls vorhanden.
−
wird beim Speichern der Fachstatistik auf eine Diskrepanz  
+
−
zwischen Akte und Fachstatistik hingewiesen, falls vorhanden.
+
  
 
Wenn man bei dem dann zur Verfügung stehendem Item "Diskrepanz zur Akte zulassen" ein Häkchen setzt, kann man trotzdem speichern.<br /> Betroffen sind nur die Items 'Familienstatus', 'Empfohlen von' und 'Erbrachte Leistungen in der Fachstatistik', deren Werte im Normalfall aus der Akte vorbelegt werden.
 
Wenn man bei dem dann zur Verfügung stehendem Item "Diskrepanz zur Akte zulassen" ein Häkchen setzt, kann man trotzdem speichern.<br /> Betroffen sind nur die Items 'Familienstatus', 'Empfohlen von' und 'Erbrachte Leistungen in der Fachstatistik', deren Werte im Normalfall aus der Akte vorbelegt werden.
Zeile 608: Zeile 565:
 
|{{konfig|wohnt_nicht_ausserhalb}}
 
|{{konfig|wohnt_nicht_ausserhalb}}
 
|{{code|}}
 
|{{code|}}
−
|Definiert die Teilmenge der Adressen, die im Sinne der Bundesstatistik in die Zuständigkeit
+
|Definiert die Teilmenge der Adressen, die im Sinne der Bundesstatistik in die Zuständigkeit der Beratungsstelle fallen.
−
der Beratungsstelle fallen.
+
  
−
Aufgrund der hier angegebenen Kriterien wird entschieden, ob der Klient in der Bundesstatistik als ausserhalb des Kreises der Beratungsstelle wohnend angegeben wird. Als mögliche Kriterien kommen in Frage: <code>plz,ort,ortsteil,samtgemeinde,bezirk,plraum</code>. Die Kriterien <code>ortsteil,samtgemeinde,bezirk</code> sind nur sinnvoll, wenn ein Straßenkatalog verwendet wird und dieser auch entsprechende Angaben enthält. <br /><br /> Die Kriterien werden wie folgt in der angegebenen Reihenfolge abgearbeitet: <ul> <li>Wenn die Klientenadresse keinen Wert für das Kriterium aufweist, wird zum nächsten Kriterium übergegangen. </li> <li>Falls die Klientenadresse einen Wert hat und im Kriterium genannt wird, wohnt er nicht außerhalb.  Ist der Wert im Kriterium nicht genannt, wohnt er außerhalb. In beiden Fällen werden die weiteren Kriterien  nicht mehr betrachtet. </li> <li>Falls aufgrund fehlender Werte (oder fehlender Kriterien) kein Kriterium angewendet werden konnte,  wird standardmäßig angenommen, dass der Klient nicht außerhalb wohnt.  </li> </ul> Beispiele: <ul> <li> <pre> bezirk: Friedrichshain-Kreuzberg; ort: Berlin </pre> In Berlin enthalten alle mit dem Straßenkatalog abgeglichene Adressen einen Wert für den Bezirk. Da jede Beratungsstelle genau für einen Bezirk zuständig ist, kann auf dieser Basis entschieden werden. Falls eine Adresse nicht mit dem Straßenkatalog abgeglichen wurde, kann der Ort als Kriterium herangezogen  werden, da in diesem Fall für Bezirk keine Angaben vorliegen. </li> <li> Falls kein Straßenkatalog verwendet wird, kann nur der Ort, die Postleitzahl oder evt. der Planungsraum (falls solche definiert sind und routinemäßig mit den Klientenadressen zusammen erfasst werden) als Kriterium verwendet werden, z.B. (fiktiv!): <pre> plz: 12345;23456;34567 </pre> Adressen mit diesen Postleitzahlen werden als nicht außerhalb wohnend betrachtet, alle anderen als außerhalb. Falls die Klientenadresse keine 5-stellige PLZ enthält, gilt der Wert als fehlend.  Ungenauigkeiten werden in Kauf genommen, da die Region der Zuständigkeit nicht immer exakt mit den Regionen der Postleitzahlen übereinstimmt. </li> <li> <pre> samtgemeinde: Name1;Name2;Name3; plz: 12345;23456 </pre> Analog zum Berliner Beispiel würde hier auch zunächst das Kriterium Samtgemeinde versucht, das aber nur nach einem Abgleich mit dem Straßenkatalog bekannt ist. Für die nicht abgeglichenen Adressen wird dann die Postleitzahl herangezogen. In seltenen Fällen kann das zu Fehlern führen, da die Bereiche der Postleitzahlen manchmal nicht mit den Bereichen der Zuständigkeit exakt übereinstimmen. </li> </ul>  Falls das Ergebnis "wohnt außerhalb" ist, wird automatisch ein entsprechender Eintrag in die Bundesstatistik vorgenommen, der beim Ausfüllen oben im Kasten "Falldaten" angezeigt wird. Wenn möglich wird der <strong>amtliche Gemeindeschlüssel</strong> eingetragen. Wenn dieser  nicht gefunden wird, wird Postleitzahl und Wohnort angegeben. <br /><br />  <strong>Syntax</strong> wie in den Beispielen. Rund um die Trenner <code>;</code> und <code>:</code> dürfen Leerzeichen stehen. Es können auch mehrere Zeilen verwendet werden.  <br /><br /> Unter (Berater-) "Hauptmenü -- Statistik -- Teilmenge -- Neu -- Neue Bedingung" finden Sie  für jedes Kriterium die Menge der möglichen Werte. <br /><br />  Zur <strong>Testen</strong> gibt es unter "Aministratorhauptmenü -- Bundesstatistik -- Exportieren" einen neuen  Punkt "Adressen außerhalb prüfen". Sie können dort in einer Tabelle sehen, welche Adressen als außerhalb klassifiziert werden.
+
Aufgrund der hier angegebenen Kriterien wird entschieden, ob der Klient in der Bundesstatistik als ausserhalb des Zuständigkeitsbereichs der Beratungsstelle wohnend angegeben wird. Als mögliche Kriterien kommen in Frage: <code>plz,ort,ortsteil,samtgemeinde,bezirk,plraum</code>. Die Kriterien <code>ortsteil,samtgemeinde,bezirk</code> sind nur sinnvoll, wenn ein Straßenkatalog verwendet wird und dieser auch entsprechende Angaben enthält. <br /><br /> Die Kriterien werden wie folgt in der angegebenen Reihenfolge abgearbeitet: <ul> <li>Wenn die Klientenadresse keinen Wert für das Kriterium aufweist, wird zum nächsten Kriterium übergegangen. </li> <li>Falls die Klientenadresse einen Wert hat und im Kriterium genannt wird, wohnt er nicht außerhalb.  Ist der Wert im Kriterium nicht genannt, wohnt er außerhalb. In beiden Fällen werden die weiteren Kriterien  nicht mehr betrachtet. </li> <li>Falls aufgrund fehlender Werte (oder fehlender Kriterien) kein Kriterium angewendet werden konnte,  wird standardmäßig angenommen, dass der Klient nicht außerhalb wohnt.  </li> </ul> Beispiele: <ul> <li> <pre> bezirk: Friedrichshain-Kreuzberg; ort: Berlin </pre> In Berlin enthalten alle mit dem Straßenkatalog abgeglichene Adressen einen Wert für den Bezirk. Da jede Beratungsstelle genau für einen Bezirk zuständig ist, kann auf dieser Basis entschieden werden. Falls eine Adresse nicht mit dem Straßenkatalog abgeglichen wurde, kann der Ort als Kriterium herangezogen  werden, da in diesem Fall für Bezirk keine Angaben vorliegen. </li> <li> Falls kein Straßenkatalog verwendet wird, kann nur der Ort, die Postleitzahl oder evt. der Planungsraum (falls solche definiert sind und routinemäßig mit den Klientenadressen zusammen erfasst werden) als Kriterium verwendet werden, z.B. (fiktiv!): <pre> plz: 12345;23456;34567 </pre> Adressen mit diesen Postleitzahlen werden als nicht außerhalb wohnend betrachtet, alle anderen als außerhalb. Falls die Klientenadresse keine 5-stellige PLZ enthält, gilt der Wert als fehlend.  Ungenauigkeiten werden in Kauf genommen, da die Region der Zuständigkeit nicht immer exakt mit den Regionen der Postleitzahlen übereinstimmt. </li> <li> <pre> samtgemeinde: Name1;Name2;Name3; plz: 12345;23456 </pre> Analog zum Berliner Beispiel würde hier auch zunächst das Kriterium Samtgemeinde versucht, das aber nur nach einem Abgleich mit dem Straßenkatalog bekannt ist. Für die nicht abgeglichenen Adressen wird dann die Postleitzahl herangezogen. In seltenen Fällen kann das zu Fehlern führen, da die Bereiche der Postleitzahlen manchmal nicht mit den Bereichen der Zuständigkeit exakt übereinstimmen. </li> </ul>  Falls das Ergebnis "wohnt außerhalb" ist, wird automatisch ein entsprechender Eintrag in die Bundesstatistik vorgenommen, der beim Ausfüllen oben im Kasten "Falldaten" angezeigt wird. Wenn möglich wird der <strong>amtliche Gemeindeschlüssel</strong> eingetragen. Wenn dieser  nicht gefunden wird, wird Postleitzahl und Wohnort angegeben. <br /><br />  <strong>Syntax</strong> wie in den Beispielen. Rund um die Trenner <code>;</code> und <code>:</code> dürfen Leerzeichen stehen. Es können auch mehrere Zeilen verwendet werden.  <br /><br /> Unter (Berater-) {{pfad5|Hauptmenü|Statistik|Teilmenge|Neu|Neue Bedingung}}" finden Sie  für jedes Kriterium die Menge der möglichen Werte. <br /><br />  Zur <strong>Testen</strong> gibt es unter {{pfad3|Aministratorhauptmenü|Bundesstatistik|Exportieren}} einen neuen  Punkt ''Adressen außerhalb prüfen''. Sie können dort in einer Tabelle sehen, welche Adressen als außerhalb klassifiziert werden.  
 +
|}

Aktuelle Version vom 19. August 2020, 10:57 Uhr

Die zentrale Konfigurationsdatei für eine EBKuS-Installation ist eine Textdatei namens ebkus.conf und befindet sich im Homeverzeichnis (ebkus im Installationsverzeichnis).

Als Ausgangspunkt für die eigene Konfiguration dient die vom Installationsskript install.py aus einer Vorlage generierte Konfigurationsdatei. Die meisten Parameter (= Konfigurationvariable) sind darin bereits korrekt gesetzt.


Aufbau von ebkus.conf

Zeilen, die leer sind oder mit dem Kommentarzeichen # beginnen, werden ignoriert, z.B.: 

#ebkus_home:  %(install_dir)s\ebkus

In diesem Fall hat der Parameter den in der Tabelle genannten Standardwert.

Zeilen, die nur aus einem Namen in eckigen Klammern bestehen, leiten eine Sektion ein, z.B.: 

[apache]

Die übrigen Zeilen weisen einem Parameter einen Wert zu. Sie beginnen mit dem Namen des Parameters, gefolgt von einem Doppelpunkt, gefolgt von dem Wert. Vor oder nach dem Doppelpunkt können Leerzeichen stehen. Beispiel: 

install_dir: C:\ebkus_installation

Werte können eine Syntax enthalten, die es erlaubt, vorher definierte Parameter in einen aktuellen Wert einzubeziehen (Parametersubstitution), z.B.: 

ebkus_home:  %(install_dir)s\ebkus

Hier wird der Wert von install_dir in den Wert von ebkus_home einbezogen. Das ist genauso, als ob man gleich 

ebkus_home:  C:\ebkus_installation\ebkus

definiert hätte. %(parameter)s wird durch den Wert von parameter ersetzt.

Jede gültige Konfigurationsdatei muss die folgenden Sektionen aufweisen:

  • [DEFAULT]
  • [ebkus]
  • [apache]
  • [openssl]
  • eine Sektion für jede Instanz: [Instanzname]

Die möglichen Parameter für jede Sektion sind in den folgenden Tabellen aufgeführt.

Alle Parameter außer denen, die in den Tabelle rot markiert sind, haben einen Standardwert (manchmal auch Defaultwert genannt), der in der Tabelle in der Spalte Standardwert angegeben ist. Ein Parameter hat diesen Wert, wenn er in der Konfiguration fehlt oder auskommentiert ist.

Wie man sieht, können Parametersubstitutionen auch bei Standardwerten stattfinden. Der Wert des notwendige Parameter install_dir findet dadurch Eingang in weitere Parameter (ebkus_home, instance_home), ohne dass diese explizit in der Konfiguration aufgeführt sind.

Anmerkung zu den Tabellen: In einigen Fällen ist der angegebene Parameter bzw. Standardwert aus layout-technischen Gründen auf mehrere Zeilen verteilt, obwohl er eigentlich ohne Leerzeichen hintereinanderweg in einer Zeile stehen müsste.

Wir unterscheiden Systemparameter von fachlichen Parametern. Erstere betreffen den technischen Betrieb von EBKuS und werden von den Systemadministratoren (IT) bei der Installation eingerichtet. Fachparameter können ebenso wie Systemparameter in der ebkus.conf in der Instanzsektion gesetzt werden, außerdem kann aber auch der Anwendungsbetreuer über Administratorhauptmenü > Allgemeine Konfiguration weitere Veränderungen vornehmen. Die vom Anwendungsbetreuer vorgenommenen Änderungen haben stets Vorrang über den Angaben in der ebkus.conf.


Systemparameter

[DEFAULT]

Die generierte Konfigurationsdatei enthält die korrekten Werte.

Der Parameter install_dir bezeichnet das Installationsverzeichnis und muss immer in der Konfiguration definiert werden. Es bildet den Bezugspunkt für alle weiteren Pfade. Standardmäßig ist ebkus_home das Verzeichnis ebkus im Installationsverzeichnis; das sollte nicht verändert werden.

Die in der Sektion [DEFAULT] definierten Parameter können in allen anderen Sektionen im Rahmen der Parametersubstitution als Teil eine Wertes verwendet werden (z.B. in der Definition von instance_home). Ansonsten stehen nur die Parameter derselben Sektion zur Verfügung.

Parameter Standardwert Bedeutung
install_dir Installationsverzeichnis
ebkus_home install_dir/ebkus Homeverzeichnis


[ebkus]

Die generierte Konfigurationsdatei enthält in der Regel die korrekten Werte.

Die database_admin_*-Parameter erlauben den Installationsskripten, neue Datenbanken für Instanzen einzurichten und diese bei der Deinstallation auch wieder zu entfernen.

Falls aus Sicherheitsgründen erwünscht, kann hier ein Passwort für den Administratorzugriff auf MySQL eingetragen werden. Geschieht dies unter Windows vor der automatischen Installation von MySQL, wird bei der automatischen Installation der Administratorzugriff mit diesem Passwort eingerichtet.

Falls das Passwort für den Administratorzugriff nicht im Klartext in der Konfigurationsdatei stehen soll, kann stattdessen ASKeingetragen werden. Dann fragen alle Skripte, die den Administratorzugriff benötigen, interaktiv nach dem Passwort, ohne es irgendwo zu speichern.

Da MySQL standardmäßig nur von dem lokalen Rechner erreichbar ist, und dieser ohnehin nur für dem Administrator zugänglich ist, ist die zusätzliche Absicherung durch ein Passwort oft nicht nötig.

Parameter Standardwert Bedeutung
download_dir install_dir/download Downloadverzeichnis. Dort steht die zu installierende Software, die im Bedarfsfall heruntergeladen wird.
database_admin_host localhost Name oder IP-Nummer des Rechners, auf dem MySQL läuft. Muss angegeben werden, wenn das nicht der lokale Rechner ist.
database_admin_user root MySQL-Benutzer mit Administratorrechten
database_admin_password Dessen Passwort. Wenn hier ``ASK`` steht, wird das Passwort bei Bedarf interaktiv abgefragt.
mysql_dir Verzeichnis, in dem die MySQL-Programme mysql, mysqldump, etc. stehen. Muss angegeben werden, wenn MySQL-Programme nicht im Pfad stehen.
python_executable Vollständiger Pfad des Python-Executable, mit dem EBKuS ausgeführt wird


[apache]

Für den Parameter server_name muss unbedingt der Name oder die IP-Nummer des Rechners eingetragen werden, auf dem der Apache-Webserver läuft. Die generierte Konfigurationsdatei setzt den Standardwert localhost, womit EBKuS nur auf dem lokalen Rechner zugänglich ist.

Für den Parameter server_admin sollte eine sinnvolle Email-Adresse eingetragen werden. Sie taucht in Apache-Fehlermeldungen auf (die allerdings normalerweise nicht vorkommen sollten).

Alle übrigen Werte können in der Regel von der generierten Konfigurationsdatei übernommen werden.

Parameter Standardwert Bedeutung
apache_log_dir ebkus_home/log Verzeichnis, in dem der Apache-Webserver Log-Dateien anlegt
server_admin admin@localhost Email-Adresse des Serveradministrators, die auf evt. Fehlerseiten des Servers erscheint.
server_name localhost Name oder IP-Nummer des Rechners, auf dem der Apache-Webserver läuft.
    • Muss** explizit eingetragen werden, sonst kann EBKuS nur auf dem lokalen Rechner verwendet werden!
server_https_port 443 Port für verschlüsselte Verbindungen. Die EBKuS-Anwendung wird ausschließlich über diesen Port abgewickelt. Wenn der Standardport 443 nicht zur Verfügung steht, kann hier ein alternativer Port angegeben werden. Dieser muss dann als Teil der URL aufgeführt werden, z.B. für den Alternativport 500: https://192.168.1.73:500/ebkus/demo/.
server_https_port 80 Port für unverschlüsselte Verbindungen. Die EBKuS-Anwendung verwendet diesen Port nicht. Dient nur zur Kontrolle des Apache Webservers: http://localhost/ liefert "It works!". Wird hier der Port 8080 angegeben, müsste man http://localhost:8080/ schreiben.
ssl_certificate_file ebkus_home/ebkus_ssl_certificates/ebkusserver.cert Vollständiger Pfad der SSL-Zertifikat-Datei


ssl_certificate_key_file ebkus_home/ebkus_ssl_certificates/ebkusserver.key Vollständiger Pfad der SSL-Schlüssel-Datei


[openssl]

Die Anwendung ist voll funktionsfähig mit den Werten aus der generierten Konfigurationsdatei; es empfiehlt sich jedoch, die organisatorischen Angaben für das SSL-Zertifikat anzupassen.

Parameter Standardwert Bedeutung
openssl_executable openssl Falls openssl nicht im Pfad steht, muss der hier der vollständige Pfad zum Executable stehen
output_password polo Wird zur automatischen Zertifikatgenerierung benötigt
staat DE Erscheint im SSL-Zertifikat
land Berlin Erscheint im SSL-Zertifikat
ort Berlin Erscheint im SSL-Zertifikat
organisation EFB Erscheint im SSL-Zertifikat
organisationseinheit EFB Erscheint im SSL-Zertifikat


[Instanz]

Im Rahmen einer EBKuS-Installation auf einem Server können mehrere Instanzen einer EBKuS-Anwendung eingerichtet werden. Jede Instanz

  • hat einen Namen (instance_name)
  • ist über eine eigene URL ansprechbar (https://server_name/ebkus/instance_name/index.html)
  • hat eine eigene Datenbank im Rahmen einer MySQL-Installation (database_name, database_user, database_password)
  • hat ein eigenes Verzeichnis (instance_home)
  • hat einen eigenen EBKuS-Server, der vom Apache-Webserver über eine eigene Portnummer angesprochen wird (port)
  • hat eine eigene Log-Datei (log_file)


Für jede gewünschte Instanz wird eine Sektion in der Konfigurationsdatei angelegt. Die Sektionsüberschrift wird aus dem Namen der Instanz in eckigen Klammern gebildet. Der Name sollte mit einem Buchstaben beginnen und ansonsten nur Buchstaben, Ziffern und Unterstriche (_) enthalten (keine Leerzeichen!). Ein zusätzlicher Name für die Instanz ohne diese Einschränkung lässt sich über den Parameter instance_title einrichten (siehe unten).

Falls der Instanzname mit demo beginnt, werden bei der Installation der Datenbank automatisch Demodaten erzeugt. Neben dem Benutzer Admin (Passwort: Admin) gibt es dann auch den Benutzer test (Passwort: test) und verw(Passwort: verw).

Jede Sektion kann die in der Tabelle aufgeführten Parameter definieren. Erforderlich ist Wiederholung des Instanznamen als Wert von instance_name, ferner die Angabe einer eigenen, eindeutigen Portnummer, port. Für alle anderen Parameter können die Standardwerte genommen werden.

Natürlich muss man berliner_version auf true setzen, wenn man die Berliner Version mit Berliner Straßenkatalog haben möchte; EBKuS-spezifische Fehlermeldungen sollten außerdem eine sinnvolle Telefonnummer bzw. Email-Adresse des Anwendungsbetreuers haben (admin_tel, admin_email).

Die Parameter host und database_host müssen nur dann angepasst werden, wenn der EBKuS-Server bzw. die MySQL-Datenbank nicht auf demselben Rechner laufen wie der Apache-Webserver.

Die bei der Installation generierte Konfigurationsdatei definiert vier Instanzen (2 davon auskommentiert):

  • demo: Demodaten, kein Straßenkatalog
  • muster_efb: keine Demodaten, kein Straßenkatalog. Beispiel für eine Produktionsinstanz, die vom Anwendungsbetreuer eingerichtet werden muss (siehe Einrichtung der Anwendung im Handbuch).

Auskommentiert:

  • demo_berlin: Demodaten, Berliner Straßenkatalog (kleiner Ausschnitt, nur Straßen, deren Namen mit 'K' beginnen)
  • demo_braunschweig: Demodaten, Straßenkatalog mit Straßen aus Braunschweig, Gifhorn, Wolfenbüttel und Wolfsburg.


Parameter Standardwert Bedeutung


instance_name Name der Instanz. Muss angegeben werden und dem Namen des Abschnitts (in eckigen Klammern) identisch sein. Darf keine Sonderzeichen außer den Unterstrich ('_') enthalten.


instance_home ebkus_home/instance_name Instanzverzeichnis. Liegt im Homeverzeichnis. Sollte nicht verändert werden.
initial_content Hier kann eine Datei angegeben werden, mit der die Instanzdatenbank initialisiert werden kann. Diese Datei wird immer dann geladen, wenn bei der Installation der Instanz (install.py oder configure.py) keine funktionierende Datenbank für die Instanz vorgefunden wird. Wenn keine Datei angegeben ist, wird eine neue Datenbank mit dem Merkmalskatalog (sql/merkmale_standard.py) und evt. einem Straßenkatalog erstellt. Wenn kein vollständiger Pfad für die Datei angegeben wird, muss die Datei im Homeverzeichnis liegen. Zulässige Dateien sind die mit dem Skript datenbank_sichern.py erzeugte Dateien sowie sonstige passende SQL-Dumps.
berliner_version false Wenn hier true steht, wird die Berliner EBKuS-Version verwendet mit Berliner Straßenkatalog.
database_host localhost Name oder IP-Nummer, auf dem der Datenbankserver läuft.
database_name instance_name Name der Instanzdatenbank


database_user instance_name Benutzername der Instanzdatenbank
database_password instance_name Passwort der Instanzdatenbank


gemeindeschluessel_von_plz Definiert die Teilmenge der amtlichen Gemeindeschlüssel für die Bundesstatistik. Im Normalfall muss hier nichts eingetragen werden.


In der Bundesstatistik soll der amtliche Gemeindeschlüssel für den Wohnort des Klienten eingetragen werden, wenn der Wohnort des Klienten außerhalb des Kreises der Beratungsstelle liegt. Um die Menge der Daten zu begrenzen, kann hier über die Anfangsziffern der Postleitzahl eine Teilmenge definiert werden. Wenn mehrere Ziffernfolgen angegeben werden, müssen diese mit ; getrennt werden.

Beispiele:
  • Alle Gemeindeschlüssel verwenden, außer die Postleitzahl der Gemeinde beginnt mit '9': 
     0;1;2;3;4;5;6;7;8
  • Große Teile Niedersachsens: 
     29;30;31;37;38
  • Nördliches Niedersachsen und Schleswig Holstein: 
     2
  • Berlin und Umgebung: 
     10;12;13;14;15;16
  • Bleibt die Variable leer, werden alle Gemeindeschlüssel verwendet.
Wenn es bei der Erkennung von Gemeindeschluesseln zu vielen Fehlern kommt, beispielsweise wegen unterschiedlicher Schreibweisen von Orten, kann man selber eine Datei EBKUS_HOME/sql/gemeindeschluessel.csv erstellen, bestehend aus einer Tabelle mit den Spalten plz, ort ags. Als Vorlage kann die Datei EBKUS_HOME/sql/gemeindeschluessel_cache.csv dienen, die automatisch erzeugt wird, wenn die Konfigurationsvariable gemeindeschluessel_von_plz einen Wert hat.
host localhost Name oder IP-Nummer des Rechners, auf der der EBKuS-Server der Instanz läuft.


keine_bundesstatistik false Falls hier true steht, wird die Bundesstatistik aus der Anwendung ausgeblendet. Es kann keine Bundesstatistik ausgefüllt werden und steht auch nicht für Statistik und Export zur Verfügung.
log_file instance_home/instance_name.log Name der Datei, in die der EBKuS-Server Meldungen schreibt
log_level INFO Legt fest, wie "geschwätzig" der EBKuS-Server ist. Muss einer der folgenden Werte sein, in aufsteigender Wortfülle: CRITICAL, ERROR, WARNING, INFO, DEBUG (DEBUG ist nur für die Fehlersuche geeignet, da sehr viel ausgegeben wird.)
port Portnummer über die der EBKuS-Server angesprochen wird. Muss angegeben werden. Jede Instanz muss eine unterschiedliche Portnummer erhalten.


Konfiguration für externe Anwendungen

Die folgenden Konfigurationsvariablen bewirken, dass auf der Klientenkarte ein Kasten mit maximal vier Buttons erscheint, die in einem neuen Tab/Fenster eine URL aufrufen, die Felder des aktuellen (letzten) Falles bzw. des angemeldeten Mitarbeiters als Bestandteile haben kann: 

 # Kein Kasten, wenn diese Variable keinen Wert hat.
 extern_fieldset_label: Externe Anwendung
 # Position auf der Klientenkarte
 extern_fieldset_position: 6
 # Maximal vier Buttons, für jeden eine Bezeichnung und eine Url.
 # Ein Button kommt nur zustande, wenn sowohl Label als auch Url
 # einen Wert haben. 
 extern_button1_label: GoogleWeb
 extern_button1_url: http://www.google.com/search?q=$$fall_id$$_$$fall_akte__ort$$
 extern_button2_label: GoogleMaps
 extern_button2_url: http://www.google.com/maps?q=$$mitarbeiter_na$$
 extern_button3_label: GoogleImages
 extern_button3_url: http://www.google.com/images?q=$$fall_akte__ort$$
 extern_button4_label: GoogleNews
 extern_button4_url: http://www.google.com/news?q=$$fall_fn$$</nowiki>

Urls können Abschnitte der folgenden Form enthalten: $$<fall oder mitarbeiter>_<feld>$$ Der ganze Abschnitt wird durch den Wert von <feld> ersetzt, wobei entweder im Fall-Objekt oder im Mitarbeiter-Objekt nachgeschlagen wird. Beispiele: $$fall_id$$, $$mitarbeiter_na$$, $$fall_akte__ort$$

Im Beispiel oben werden als externe Anwendungen verschiedene Google-Dienst aufgerufen, wobei als Parameter Daten aus dem aktuellen Fall übergeben werden. (Das Beispiel ist nicht sinnvoll und dient nur der Illustration des Mechanismus.)

Parameter Standardwert Bedeutung
extern_fieldset_label Bezeichnung für den Kasten mit den Buttons für die externen Anwendungen
extern_fieldset_position 2 Position auf der Klientenkarte (Gezählt werden die umrandeten Kästen mit einer Bezeichnung: Klientendaten, Bezugspersonen, Leistungen, etc.)
extern_buttonX_label Name der externen Anwendung


extern_buttonX_url URL der externen Anwendung mit Platzhaltern für die zu übernehmenden Parameter

X kann 1,2,3 oder 4 sein.


Fachliche Parameter

Die hier beschriebenen Einstellungen können auch vom Anwendungsbetreuer über Administratorhauptmenü > Allgemeine Konfiguration vorgenommen werden.


[Instanz]

Parameter Standardwert Bedeutung
admin_email Keine Angabe Email-Adresse des Anwendungsbetreuers.

Wird in Fehlermeldungen genannt.

admin_name Keine Angabe Name des Anwendungsbetreuers.

Wird in Fehlermeldungen genannt.

admin_tel Keine Angabe Telefonnummer des Anwendungsbetreuers.

Wird in Fehlermeldungen genannt.

anmeldungsdaten_ obligatorisch false Falls true werden die Anmeldungsdaten obligatorisch im Aufnahmeformular erhoben anstatt optional in einer getrennten Maske.

Die entsprechenden Pflichfelder sind dabei auszufüllen. Eine spätere Bearbeitung der Anmeldungsdaten erfolgt wie bisher in einer eigenständigen Maske (analog der späteren Bearbeitung einer Leistung).

anmeldeprobleme_und_ beschaeftigung_bei_anmeldung_erfassen false Falls true werden Probleme bei der Anmeldung und Beschäftigung schon bei der Anmeldung erfasst und später für die Fachstatistik übernommen.

Die Auswahlfelder 'Beschäftigung Jugendliche(r)', 'Beschäftigungsverhältnis Mutter', 'Beschäftigungsverhältnis Vater' und das Mehrfachauswahlfeld 'Problem(e) bei der Anmeldung' aus der Fachstatistik werden in den Kasten Anmeldekontakt als Pflichtfelder aufgenommen. Es ist jedoch in jedem Fall möglich 'Keine Angabe' auszuwählen (genau wie in der Fachstatistik selbst). Die Daten werden mit dem Fall (nicht mit der Akte bzw. den Stammdaten) gespeichert. Wenn eine Fachstatistik angelegt wird, werden die Daten übernommen.

beratungskontakte false Falls true können in der Klientenakte einzelne Beratungskontakte eingetragen werden. Die Summen werden in die Bundesstatistik und in die Fachstatistik als Vorgabe übernommen.
beratungskontakte_bs false Falls true treten Anpassungen speziell für Braunschweig in Kraft.

Die Variable beratungskontakte muss ebenfalls auf true stehen.

cache_on true Falls true wird der Objektcache eingeschaltet, sonst bleibt er abgeschaltet.

Normalerweise ist der Cache an, aber es kann in seltenen Fällen zu Fehlern kommen, die verschwinden, wenn er abgeschaltet wird. Auf die inhaltlichen Abläufe hat das keine Auswirkungen, allenfalls auf die Performance.

erinnern_nach_wochen_ohne_kontakt 0 Anzahl der Wochen ohne Kontakt nach der ein offener Fall in die Erinnerungsfunktion aufgenommen wird.

Wenn hier eine Zahl zwischen 1 und 99 steht, wird die Erinnerungsfunktion aktiviert. Auf einem zusätzlichen Button im Hauptmenü steht dann die Anzahl der offenen Fälle, mit denen es länger als die angegebene Anzahl von Wochen keinen Kontakt gegeben hat. Nach dem Betätigen des Buttons erscheint eine Liste dieser Fälle. Jeder Fall kann als erledigt markiert werden, worauf er künftig normalerweiser nicht mehr in der Liste erscheint. Für die gesamte Liste gibt es aber eine Option, alle Fälle einschließlich der erledigten anzuzeigen. Die 'Erledigt'-Markierung kann dann auch wieder rückgängig gemacht werden.

Es muss hier die Ziffer 0 stehen, wenn die Erinnerungsfunktion deaktiviert bleiben soll.

fachstatistik_akte_ diskrepanz_nicht_zulassen false Falls true werden Diskrepanzen zwischen Fachstatistik und Akte nicht zugelassen.

Die entsprechenden Items in der Fachstatistik zeigen die Werte aus der Akte und sind nicht modifizierbar. Eine Diskrepanz kann so gar nicht entstehen. Allerdings muss bei Änderungen in der Akte die Fachstatistik neu abgespeichert werden, damit die Änderungen übernommen und für die Statistik wirksam werden.
Betroffen sind nur die Items 'Familienstatus', 'Empfohlen von' und 'Erbrachte Leistungen in der Fachstatistik', deren Werte im Normalfall aus der Akte vorbelegt werden.

fallunabhaengige _aktivitaeten_bs false Falls true können fallunabhängige Aktivitäten eingetragen und ausgewertet werden. Speziell für Braunschweig.
fallbeginn_bei_erster_leistung false Bei Neumelde- und Abschlusszahlen sowie Klienten pro Mitarbeiter wird der Fallbeginn ab dem Datum der erste Leistung definiert anstatt ab dem Anmeldedatum.
fallbeginn_waehlbar false Bei Neumelde- und Abschlusszahlen sowie Klienten pro Mitarbeiter kann ein Häkchen gesetzt werden, um den Fallbeginn ab erster Leistung zu definieren.
instance_title instance_name Langname für die Instanz.

Erscheint bei der Anmeldung und in der Statuszeile.

jgh_gemeindeschluessel Die letzten drei Ziffern des Amtlichen Gemeindeschlüssels oder das Wort "blank".

Standardmäßig setzt EBKuS für diese drei Ziffern (Spalte 7-9 des Exportdatensatzes) drei mal die Ziffer 0 ein. Unseres Wissens werden diese Daten für die Bundesstatistik allerdings nicht ausgewertet. Bei Bedarf kann hier das Wort "blank" angegeben werden, dann erscheinen im Datensatz drei Leerzeichen, oder es können drei Ziffern eingegeben werden, die dann in den Datensatz eingefügt werden.

leistungsende_in_

zukunft_erlaubt

false Beim Eintrag einer Leistung darf für das Ende ein Datum, das in der Zukunft liegt, eingetragen werden.

Der Abschluss des Falls ist erst möglich, wenn alle Leistungen beendet sind.

loeschfrist 36 Löschfrist in Monaten.

Akten, die älter sind, können vom Administrator gelöscht werden.

log_query_laenger_als 0 Falls größer 0, Datenbankqueries in die Logdatei schreiben, die länger dauern als die angegeben Zahl in Millisekunden.

Wenn 0 eingetragen wird, werden keine Datenbankqueries protokolliert. Alle Datenbankqueries können mit log_level=DEBUG erfasst werden. Nützlich zur Diagnose von Performanceproblemen.

meldung_vom_admin Inhalt wird als Meldung vom Administrator unübersehbar auf jeder EBKuS-Seite über der Statuszeile ausgegeben.

Damit kann der Administrator Meldungen an alle aktiven EBKuS-Nutzer ausgeben, z.B. um einen Ausfall von EBKuS wegen Wartungsarbeiten anzukündigen.

neumeldungen_nach_region Definiert eine Tabelle Neumeldungen nach Region unter Neumelde- und Abschlusszahlen. Die Regionen, für die in der Tabelle die Neumeldungen ausgezählt werden sollen, müssen unter Hauptmenü > Statistikabfrage > Teilmenge > Neu als Teilmengendefinitionen eingeführt werden. Der Namen der gewünschten Definitionen werden durch ; getrennt aufgeführt.

Beispiel: 
  •      Gifhorn und Samtgemeinde Meinersen; Braunschweig 38120 und 38112
"Gifhorn und Samtgemeinde Meinersen" ist eine Teilmengendefinition mit der Definition: ( ort = 'Gifhorn' ODER samtgemeinde = 'Meinersen' ). "Braunschweig 38120 und 38112" ist eine Teilmengendefinition mit der Definition: ( ort = 'Braunschweig' UND plz = '38112' oder '38120' ).

session_time 120 Länge einer Session in Minuten.

Nach dieser Zeit wird ein Benutzer automatisch abgemeldet, wenn er keine Eingaben mehr macht.

sql_abfrage false Falls true steht die Maske zum Absetzen von SQL-Abfragen vom Administrationsmenü aus zur Verfügung.
strassenkatalog Falls diese Variable nicht leer ist, wird bei der Adresseingabe der Straßenkatalog verwendet.

Der eigentliche Wert der Variable spielt nur bei der Erstinstallation der Instanz eine Rolle.
Eine Instanz ohne Straßenkatalog kann auch später noch für die Verwendung mit Straßenkatalog eingerichtet werden, indem der Straßenkatalog über Administratorhauptmenü > Straßenkatalog importieren importiert wird und der Variable strassenkatalog ein beliebiger Wert zugewiesen wird, beispielsweise der Ortsname.

strassenkatalog_ vollstaendig false Falls true wird angenommen, dass der Straßenkatalog Einträge für jede einzelne Hausnummer enthält.

Ansonsten wird angenommen, dass lediglich Einträge für ganze Straßen bzw. für bestimmte Intervalle von Hausnummern vorhanden sind.

strassensuche Bestimmt die Anzeige von Zusatzinformationen aus dem Straßenkatalog bei der Darstellung und Eingabe von Adressen. Zulässige Werte sind: ort bezirk ortsteil samtgemeinde.

Beispiele:
  • In Berlin gibt es nur einen Ort im Straßenkatalog, nämlich 'Berlin'. Das Feld ort ist daher nicht nötig. Ortsteil und Samtgemeinde haben im Straßenkatalog keine Werte, Bezirk allerdings schon. Der sinnvolle Wert für Berlin ist also 
         bezirk
  • In Gifhorn gibt es mehrere Orte im Straßenkatalog. Sowohl Ortsteile und Samtgemeinden spielen eine Rolle und sind im Straßenkatalog erfasst, Bezirke jedoch nicht. Der sinnvolle Wert hier ist also 
         ort ortsteil samtgemeinde
  • Wenn es nur einen Ort gibt und weder Bezirke, Ortsteile oder Samtgemeinden im Straßenkatalog erfasst sind, sollte die Variable leer bleiben.


Irrelevant, wenn kein Straßenkatalog verwendet wird.
warnung_bei_fachstatistik_ akte_diskrepanz false Falls true wird beim Speichern der Fachstatistik auf eine Diskrepanz zwischen Akte und Fachstatistik hingewiesen, falls vorhanden.

Wenn man bei dem dann zur Verfügung stehendem Item "Diskrepanz zur Akte zulassen" ein Häkchen setzt, kann man trotzdem speichern.
Betroffen sind nur die Items 'Familienstatus', 'Empfohlen von' und 'Erbrachte Leistungen in der Fachstatistik', deren Werte im Normalfall aus der Akte vorbelegt werden.

wiederaufnahmefrist 1 Anzahl der Monate, innerhalb derer ein abgeschlossener Fall wiederaufgenommen werden kann ("z.d.A. rückgängig").

Danach muss ein neuer Fall angelegt werden.

wohnt_nicht_ausserhalb Definiert die Teilmenge der Adressen, die im Sinne der Bundesstatistik in die Zuständigkeit der Beratungsstelle fallen. Aufgrund der hier angegebenen Kriterien wird entschieden, ob der Klient in der Bundesstatistik als ausserhalb des Zuständigkeitsbereichs der Beratungsstelle wohnend angegeben wird. Als mögliche Kriterien kommen in Frage: plz,ort,ortsteil,samtgemeinde,bezirk,plraum. Die Kriterien ortsteil,samtgemeinde,bezirk sind nur sinnvoll, wenn ein Straßenkatalog verwendet wird und dieser auch entsprechende Angaben enthält.

Die Kriterien werden wie folgt in der angegebenen Reihenfolge abgearbeitet:
  • Wenn die Klientenadresse keinen Wert für das Kriterium aufweist, wird zum nächsten Kriterium übergegangen.
  • Falls die Klientenadresse einen Wert hat und im Kriterium genannt wird, wohnt er nicht außerhalb. Ist der Wert im Kriterium nicht genannt, wohnt er außerhalb. In beiden Fällen werden die weiteren Kriterien nicht mehr betrachtet.
  • Falls aufgrund fehlender Werte (oder fehlender Kriterien) kein Kriterium angewendet werden konnte, wird standardmäßig angenommen, dass der Klient nicht außerhalb wohnt.
Beispiele: 
  •  bezirk: Friedrichshain-Kreuzberg; ort: Berlin
    In Berlin enthalten alle mit dem Straßenkatalog abgeglichene Adressen einen Wert für den Bezirk. Da jede Beratungsstelle genau für einen Bezirk zuständig ist, kann auf dieser Basis entschieden werden. Falls eine Adresse nicht mit dem Straßenkatalog abgeglichen wurde, kann der Ort als Kriterium herangezogen werden, da in diesem Fall für Bezirk keine Angaben vorliegen.
  • Falls kein Straßenkatalog verwendet wird, kann nur der Ort, die Postleitzahl oder evt. der Planungsraum (falls solche definiert sind und routinemäßig mit den Klientenadressen zusammen erfasst werden) als Kriterium verwendet werden, z.B. (fiktiv!): 
     plz: 12345;23456;34567
    Adressen mit diesen Postleitzahlen werden als nicht außerhalb wohnend betrachtet, alle anderen als außerhalb. Falls die Klientenadresse keine 5-stellige PLZ enthält, gilt der Wert als fehlend. Ungenauigkeiten werden in Kauf genommen, da die Region der Zuständigkeit nicht immer exakt mit den Regionen der Postleitzahlen übereinstimmt. 
  •  samtgemeinde: Name1;Name2;Name3; plz: 12345;23456
    Analog zum Berliner Beispiel würde hier auch zunächst das Kriterium Samtgemeinde versucht, das aber nur nach einem Abgleich mit dem Straßenkatalog bekannt ist. Für die nicht abgeglichenen Adressen wird dann die Postleitzahl herangezogen. In seltenen Fällen kann das zu Fehlern führen, da die Bereiche der Postleitzahlen manchmal nicht mit den Bereichen der Zuständigkeit exakt übereinstimmen.
Falls das Ergebnis "wohnt außerhalb" ist, wird automatisch ein entsprechender Eintrag in die Bundesstatistik vorgenommen, der beim Ausfüllen oben im Kasten "Falldaten" angezeigt wird. Wenn möglich wird der amtliche Gemeindeschlüssel eingetragen. Wenn dieser nicht gefunden wird, wird Postleitzahl und Wohnort angegeben.

Syntax wie in den Beispielen. Rund um die Trenner ; und : dürfen Leerzeichen stehen. Es können auch mehrere Zeilen verwendet werden.

Unter (Berater-) Hauptmenü > Statistik > Teilmenge > Neu > Neue Bedingung" finden Sie für jedes Kriterium die Menge der möglichen Werte.

Zur Testen gibt es unter Aministratorhauptmenü > Bundesstatistik > Exportieren einen neuen Punkt Adressen außerhalb prüfen. Sie können dort in einer Tabelle sehen, welche Adressen als außerhalb klassifiziert werden.
Von „https://ebkus.org/w/index.php?title=Konfiguration&oldid=357“