Konfiguration
Die zentrale Konfigurationsdatei für eine EBKuS-Installation ist eine Textdatei namens ebkus.conf und befindet sich im Homeverzeichnis (Installationsverzeichnis/ebkus)
Als Ausgangspunkt für die eigene Konfiguration dient die vom Installationsskript install.py generierte Konfigurationsdatei. Die meisten Parameter (= Konfigurationvariable) sind darin bereits korrekt gesetzt.
Inhaltsverzeichnis
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.:
install_dir: C:\ebkus_installation
ebkus_home: %(install_dir)s\ebkus</pre>
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.
Systemvariablen
[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 ebkusim 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.
| Parameter | Standardwert | Bedeutung |
|---|---|---|
install_dir
|
|
Installationsverzeichnis |
ebkus_home
|
install_dir/ebkus
|
Homeverzeichnis |
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]
| 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.
|
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]
| 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]
| 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.
; getrennt werden.Im Normalfall brauchen Sie den voreingestellten Wert nicht zu ändern. Beispiele:
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 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_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.
Fachvariablen
[Instanz]
| Parameter | Standardwert | Bedeutung |
|---|---|---|
admin_email
|
Keine Angabe
|
Email-Adresse des Anwendungsadministrators.
Wird in Fehlermeldungen genannt. |
admin_name
|
Keine Angabe
|
Name des Anwendungsadministrators.
Wird in Fehlermeldungen genannt. |
admin_tel
|
Keine Angabe
|
Telefonnummer des Anwendungsadministrators.
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). |
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 |
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. |
fallunabhaengige _aktivitaeten_bs
|
false
|
Falls true können fallunabhängige Aktivitäten eingetragen und ausgewertet werden. Speziell für Braunschweig.
|
instance_title
|
instance_name
|
Langname für die Instanz.
Erscheint bei der Anmeldung und in der Statuszeile. |
loeschfrist
|
36
|
Löschfrist in Monaten.
Akten, die älter sind, können vom Administrator gelöscht werden. |
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:
( 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. |
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:
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. |
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.
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:
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. |
