Doku zu lx_office.conf und wiederkehrenden Rechnungen für 2.6.3

diff --git a/doc/UPGRADE b/doc/UPGRADE
index 78206ce..05683f0 100644 (file)
--- a/doc/UPGRADE
+++ b/doc/UPGRADE
@@ -19,6 +19,9 @@ angelegt und authentication.pl und lx-erp.conf gelöscht oder verschoben wurden.
 Es gibt keine local-Variante der lx_office.conf, arbeitet man mit git sollte
 man lx_office.conf nicht einchecken.
 
+Eine etwas ausführlichere Beschreibung findet sich in der Datei:
+doc/konfigurationsdatei.txt
+
 
 Upgrade auf v2.6.2
 ==================

diff --git a/doc/konfigurationsdatei.txt b/doc/konfigurationsdatei.txt
new file mode 100644 (file)
index 0000000..d2e6ef2
--- /dev/null
+++ b/doc/konfigurationsdatei.txt
@@ -0,0 +1,63 @@
+== Lx-Office Konfigurationsdatei ab Version 2.6.3 ==
+
+Seit Lx-Office 2.6.3. findet sich die Hauptconfigurationsdatei von Lx-Office in
+der Datei config/lx_office.conf.
+
+Diese muß bei der Erstinstallation von Lx-Office (oder Migration von älteren
+Versionen) angelegt werden, als Vorlage dient die Datei
+config/lx_office.conf.default. Die Datei lx_office.conf ist eine
+installationsspezifische Datei, enthält z.B. die wichtigsten Passwörter der
+lokalen Installation, und findet sich auch nicht im Git Repository.  Diese
+Konfigurationsdatei ist unabhängig von den verschiedenen Mandanten, die auf der
+Installation laufen.
+
+Die Konfigurationsdatei besteht aus mehreren Teilen, die entsprechend kommentiert sind:
+
+* authentication
+* authentication/database
+* authentication/ldap
+* system
+* features
+* paths
+* applications
+* environment
+* print_templates
+* task_server
+* periodic_invoices
+* console
+* debug
+
+Die üblicherweise wichtigsten Parameter, die am Anfang einzustellen oder zu kontrollieren sind, sind:
+
+[authentication]
+admin_password = geheim
+
+[authentication/database]
+host     = localhost
+port     = 5432
+db       = lxerp_auth
+user     = postgres
+password =
+
+[system]:
+* eur
+* dbcharset
+
+Nutzt man wiederkehrende Rechnungen kann man unter [periodic_invoices] den
+Login eines Benutzers angeben, der nach Erstellung der Rechnungen eine
+entsprechende E-Mail mit Informationen über die erstellten Rechnungen bekommt.
+
+Nutzt man den Taskserver für wiederkehrende Rechnungen, muß unter [task_server]
+ein Login eines Benutzers angegeben werden, mit dem sich der Taskserver an
+Lx-Office bei der Datenbank anmeldet, die dem Benutzer zugewiesen ist.
+
+Für Entwickler finden sich unter [debug] wichtige Funktionen, um die
+Fehlersuche zu erleichtern.
+
+
+== Versionen vor 2.6.3 ==
+
+In älteren Lx-Office Versionen gab es im Verzeichnis config die Dateien
+authentication.pl und lx-erp.conf, die jeweils Perl-Dateien waren. Es gab auch
+die Möglichkeit, eine lokale Version der Konfigurationsdatei zu erstellen
+(lx-erp-local.conf), dies ist ab 2.6.3 auch nicht mehr möglich/nötig.

diff --git a/doc/programmierstilrichtlinien.txt b/doc/programmierstilrichtlinien.txt
index 67e63ec..4b8b201 100644 (file)
--- a/doc/programmierstilrichtlinien.txt
+++ b/doc/programmierstilrichtlinien.txt
@@ -188,6 +188,6 @@ Einige der Regeln lassen sich automatisch überprüfen, andere nicht.
 
 14. Alle neuen Module müssen use strict verwenden.
 
-    $form, $auth, $locale, $lxdebug, %myconfig sowie der Inhalt der lx-erp.conf
-    werden derzeit aus dem main package importiert. Alle anderen Konstrukte
-    sollten lexikalisch lokal gehalten werden.
+    $form, $auth, $locale, $lxdebug und %myconfig werden derzeit aus dem main
+    package importiert. Alle anderen Konstrukte sollten lexikalisch lokal
+    gehalten werden.

diff --git a/doc/wiederkehrende_rechnungen.txt b/doc/wiederkehrende_rechnungen.txt
new file mode 100755 (executable)
index 0000000..fe9a07c
--- /dev/null
+++ b/doc/wiederkehrende_rechnungen.txt
@@ -0,0 +1,78 @@
+Wiederkehrende Rechnungen werden als normale Aufträge definiert und\r
+konfiguriert, mit allen dazugehörigen Kunden- und Artikelangaben. Die\r
+konfigurierten Aufträge werden später automatisch in Rechnungen\r
+umgewandelt, so als ob man den Workflow benutzen würde, und auch die\r
+Auftragsnummer wird übernommen, sodass alle wiederkehrenden\r
+Rechnungen, die aus einem Auftrag erstellt wurden, später leicht\r
+wiederzufinden sind.\r
+\r
+Um einen Auftrag für wiederkehrende Rechnung zu konfigurieren, findet sich beim\r
+Bearbeiten des Auftrags ein neuer Knopf "Konfigurieren", der ein neues Fenster\r
+öffnet, in dem man die nötigen Parameter einstellen kann.  Hinter dem Knopf\r
+wird außerdem noch angezeigt, ob der Auftrag als wiederkehrende Rechnung\r
+konfiguriert ist oder nicht.\r
+\r
+Folgende Parameter kann man konfigurieren:\r
+\r
+* Status:\r
+ Bei aktiven Rechnungen wird automatisch eine Rechnung erstellt, wenn die\r
+ Periodizität erreicht ist (z.B. Anfang eines neuen Monats).\r
+\r
+ Ist ein Auftrag nicht aktiv, so werden für ihn auch keine wiederkehrenden\r
+ Rechnungen erzeugt. Stellt man nach längerer nicht-aktiver Zeit einen Auftrag\r
+ wieder auf aktiv, wird beim nächsten Periodenwechsel für alle Perioden, seit\r
+ der letzten aktiven Periode, jeweils eine Rechnung erstellt. Möchte man dies\r
+ verhindern, muss man vorher das Startdatum neu setzen.\r
+\r
+ Für gekündigte Aufträge werden nie mehr Rechnungen erstellt. Man kann sich\r
+ diese Aufträge aber gesondert in den Berichten anzeigen lassen.\r
+\r
+* Periodizität:\r
+  Ob monatlich, quartalsweise oder jährlich auf neue Rechnungen überprüft\r
+  werden soll. Für jede Periode seit dem Startdatum wird überprüft, ob für die\r
+  Periode (beginnend immer mit dem ersten Tag der Periode) schon eine Rechnung\r
+  erstellt wurde. Unter Umständen können bei einem Startdatum in der\r
+  Vergangenheit gleich mehrere Rechnungen erstellt werden.\r
+\r
+* Buchen auf:\r
+  Das Forderungskonto, in der Regel "Forderungen aus Lieferungen\r
+  und Leistungen". Das Gegenkonto ergibt sich aus den Buchungsgruppen der\r
+  betreffenden Waren.\r
+\r
+* Startdatum: ab welchem Datum auf Rechnungserstellung geprüft werden soll\r
+\r
+* Enddatum: ab wann keine Rechnungen mehr erstellt werden sollen.\r
+\r
+* Automatische Verlängerung um x Monate:\r
+  Sollen die wiederkehrenden Rechnungen bei Erreichen des\r
+  eingetragenen Enddatums weiterhin erstellt werden, so kann man hier\r
+  die Anzahl der Monate eingeben, um die das Enddatum automatisch nach\r
+  hinten geschoben wird.\r
+\r
+* Drucken:\r
+  Sind Drucker konfiguriert, so kann man sich die erstellten Rechnungen auch\r
+  gleich ausdrucken lassen.\r
+\r
+Unter Verkauf->Berichte->Aufträge finden sich zwei neue Checkboxen,\r
+"Wiederkehrende Rechnungen aktiv" und "Wiederkehrende Rechnungen inaktiv", mit\r
+denen man sich einen Überglick über die wiederkehrenden Rechnungen verschaffen\r
+kann.\r
+\r
+Die zeitliche und periodische Überprüfung, ob eine wiederkehrende\r
+Rechnung automatisch erstellt werden soll, geschieht durch den\r
+Taskserver, einen externen Dienst, der automatisch beim Start des\r
+Servers gestartet werden sollte.\r
+\r
+Nach Erstellung der Rechnungen kann eine E-Mail mit Informationen zu\r
+den erstellten Rechnungen verschickt werden. Konfiguriert wird dies in\r
+der Konfigurationsdatei config/lx_office.conf im Abschnitt\r
+[periodic_invoices].\r
+\r
+Will man im laufenden Monat eine monatlich wiederkehrende Rechnung inkl. des\r
+laufenden Monats starten, stellt man das Startdatum auf den Monatsanfang und\r
+wartet ein paar Minuten, bis der Taskserver den neu konfigurieren Auftrag\r
+erkennt und daraus eine Rechnung generiert hat. Alternativ setzt man das\r
+Startdatum auf den Monatsersten des Folgemonats und erstellt die erste Rechnung\r
+direkt manuell über den Workflow.\r
+\r
+\r