[Osaas-commits] r80 - in trunk: . contrib/billing contrib/billing/doc

Wed Oct 27 17:28:04 CEST 2010

Author: bjoern
Date: 2010-10-27 17:28:04 +0200 (Wed, 27 Oct 2010)
New Revision: 80

Added:
   trunk/contrib/billing/doc/
   trunk/contrib/billing/doc/HowTo.txt
   trunk/contrib/billing/doc/osaas-contrib_short_manual.de.rst
Modified:
   trunk/ChangeLog
Log:
Added a german short manual for the billing stuff and a howto for explaining
how to build a html or pdf version of the short manual.


Modified: trunk/ChangeLog
===================================================================

--- trunk/ChangeLog	2010-10-25 10:51:50 UTC (rev 79)
+++ trunk/ChangeLog	2010-10-27 15:28:04 UTC (rev 80)
@@ -1,3 +1,10 @@
+2010-10-27  Bjoern Schilberg <bjoern.schilberg at intevation.de>
+
+	* contrib/billing/doc/osaas-contrib_short_manual.de.rst: Added a german
+	  short manual for how to use the billing stuff.
+	* contrib/billing/doc/HowTo.txt: Added a howto for explaining how to
+	  build a pdf or html version of the short manual.
+
 2010-10-25  Bjoern Schilberg <bjoern.schilberg at intevation.de>
 
 	* packaging/rpm/osaas-suse10.3-gp.spec: Added a contrib subpackage

Added: trunk/contrib/billing/doc/HowTo.txt
===================================================================
--- trunk/contrib/billing/doc/HowTo.txt	2010-10-25 10:51:50 UTC (rev 79)
+++ trunk/contrib/billing/doc/HowTo.txt	2010-10-27 15:28:04 UTC (rev 80)
@@ -0,0 +1,21 @@
+=============================
+HowTo build the documentation
+=============================
+
+Build html
+==========
+
+  rst2html osaas-contrib_short_manual.de.rst > osaas-contrib_short_manual.de.html
+
+Requirements: 
+
+- `docutils <http://docutils.sourceforge.net>`_
+
+Build pdf
+=========
+
+  rst2pdf osaas-contrib_short_manual.de.rst
+
+Requirements: 
+
+- `rst2pdf <http://code.google.com/p/rst2pdf/>`_

Added: trunk/contrib/billing/doc/osaas-contrib_short_manual.de.rst
===================================================================
--- trunk/contrib/billing/doc/osaas-contrib_short_manual.de.rst	2010-10-25 10:51:50 UTC (rev 79)
+++ trunk/contrib/billing/doc/osaas-contrib_short_manual.de.rst	2010-10-27 15:28:04 UTC (rev 80)
@@ -0,0 +1,149 @@
+=======================================================================
+Abrechnungskript für die Abrechnung der Anzahl von angefragten Features
+=======================================================================
+
+Einleitung
+==========
+
+Das ``osaas-server-contrib`` Paket dient der skriptgestützten Ermittlung der
+Anzahl der angefragten Elemente/Features bei einer WFS-GetFeature-Anfrage.
+
+Hierbei werden jeweils die Anzahlen angefragter Elemente seit der letzten
+Aktualisierung über eine analoge Anfrage, die zuvor durch deegree owsProxy
+Wrapper in die Datenbank geschrieben worden ist, gegen den WFS mit dem
+``resultType hits`` abgesetzt und der ermittelte Wert in die Datenbank
+zurückgeschrieben. Hierbei ist zu beachten, dass dieser Mechanismus vor einer
+Aktualisierung des Datenbestandes auf dem WFS zu erfolgen hat, um eine
+entsprechend passende und abrechenbare Grundlage zu ermöglichen.
+
+Schritte für die Einrichtung
+============================
+
+Folgende Schritte sind für die Einrichtung und einen Test erforderlich:
+
+- osaas-server-contrib installieren
+- PostgreSQL konfigurieren
+- WFS-Request Logging konfigurieren
+- Auswertungsskript (``billing.cfg``) konfigurieren
+- Test GetFeature-Anfragen an den abgesicherten Dienst stellen
+- Auswertungsskript (``billing.py``) starten
+
+osaas-server-contrib installieren
+---------------------------------
+
+Das ``osaas-server-contrib`` Paket kann auf der Kommandozeile mit folgendem
+Befehl installiert werden::
+
+  zypper in osaas-server-contrib
+
+PostgreSQL konfigurieren
+------------------------
+
+Um die an den abgesicherten WFS-Dienst gestellten Anfragen auswerten zu können,
+muss eine PostgreSQL Datenbank erstellt und konfiguriert werden, welche ein
+OSAAS-kompatibles Datenbank-Schema besitzt, in welches die Anfragen und die
+Auswertung geschrieben werden können.
+
+Konfigurationsdatei ``/var/lib/pgsql/data/postgresql.conf`` anpassen::
+
+  listen_adress='localhost'
+  port = 5432
+
+Klient Authentifizierung in der Datei ``/var/lib/pgsql/data/pg_hba.conf``
+ergänzen und folgenden Einträge hinzufügen::
+
+  host osaas_logging osaas  127.0.0.1/32 md5
+
+Benutzer ``osass`` und Datenbank ``osass_logging`` anlegen::
+
+  su postgres -c "createuser -SDRleP osaas"
+  su postgres -c "createdb -O osaas osaas_logging"
+
+PostgreSQL neu starten::
+
+  /etc/init.d/postgresql restart
+
+Fügen Sie das OSAAS-kompatible Datenbank-Schema für die zuvor erstellten
+Datenbank mit folgendem Befehl hinzu::
+
+  su postgres -c "psql -U osaas -h localhost -d osaas_logging -f /opt/gispatcher/osaas-server/contrib/billing/wfs_requests.sql"
+
+Fügen Sie das Auswertungs-Datenbank-Schema für das Auswertungsskript mit dem
+folgendem Befehl hinzu::
+
+  su postgres -c "psql -U osaas -h localhost -d osaas_logging -f /opt/gispatcher/osaas-server/contrib/billing/billing.sql"
+
+WFS-Request Logging konfigurieren
+---------------------------------
+
+Konfigurieren Sie den owsProxy Wrapper, damit dieser die Anfragen für eine
+weitere Auswertung in die zuvor erstellte Datenbank schreiben kann.
+
+Dazu sind in der Datei ``logging.xml`` folgende Einträge anzupassen:
+
+- @DATABASE_HOST@
+- @DATABASE_PORT@
+- @DATABASE@
+- @DATABASE_USER@
+- @DATABASE_PASSWORD@
+
+Die Datei ``logging.xml`` befindet sich in::
+
+  /opt/gispatcher/deegree3-owsproxy/webapps/owsproxy-wrapper/WEB-INF/conf/jdbc/logging.xml
+
+Starten Sie nach erfolgter Anpassung den owsProxy Wrapper neu::
+
+  /etc/init.d/owsproxy-wrapper restart
+
+Auswertungsskript (billing.cfg) konfigurieren
+---------------------------------------------
+
+Konfigurieren Sie das Auswertungsskript, damit diese die Auswertung der
+Anfragen in der zuvor erstellten Datenbank vornehmen kann.
+
+Passen Sie dazu die folgenden Einträge in der Datei ``billing.cfg`` an:
+
+- host
+- database
+- user
+- password
+
+Die Datei ``billing.cfg`` befindet sich in::
+
+  /opt/gispatcher/osaas-server/contrib/billing/billing.cfg
+
+Test GetFeature-Anfragen an den abgesicherten Dienst stellen
+------------------------------------------------------------
+
+Stellen Sie mit den entsprechenden Klienten testweise GetFeature Anfragen an
+abgesicherten Dienst.
+
+Auswertungsskript (billing.py) starten
+--------------------------------------
+
+Um eine Auswertung der Anfragen vorzunehmen zu können, wechseln Sie in das
+Verzeichnis::
+
+  /opt/gispatcher/osaas-server/contrib/billing/
+
+Starten Sie in dem Verzeichnis das Auswertungsskript auf der Kommandozeile mit
+folgendem Befehl::
+
+  ./billing.py
+
+Die ermittelte Wert wurde nach der Ausführung des Auswertungsskript in die
+zuvor erstellte Datenbank geschrieben. Die Anzahl der angefragten Elemente
+``numfeatures`` und die Aktualisierungszeit ``billtime`` sind in der Tabelle
+``request`` eingetragen worden.
+
+Hinweise
+''''''''
+
+Hilfe zu dem Auswertungsskript erhalten Sie wenn Sie das Verzeichnis
+``/opt/gispatcher/osaas-server/contrib/billing/`` wechseln und auf der
+Kommandozeile den folgenden Befehl ausführen::
+
+  ./billing.py --help
+
+Das Logfile zum Auswertungsskript liegt in dem Verzeichnis in welchem das
+Auswertungsskript ``billing.py`` aufgerufen worden ist.

