From: Moritz Bunkus Date: Tue, 10 Jan 2012 21:11:28 +0000 (+0100) Subject: Migration der einzelnen Dokumentationsdateien in eine DocBook-Datei X-Git-Tag: release-2.7.0beta1~68 X-Git-Url: http://wagnertech.de/git?a=commitdiff_plain;h=7ee506b343e315d622fd94a5f774ad99aad63a5c;p=kivitendo-erp.git Migration der einzelnen Dokumentationsdateien in eine DocBook-Datei --- diff --git a/doc/20111013_globale_variablen.txt b/doc/20111013_globale_variablen.txt deleted file mode 100644 index fb6b3daf7..000000000 --- a/doc/20111013_globale_variablen.txt +++ /dev/null @@ -1,249 +0,0 @@ -nachdem Holger heute den Bug eingestellt hat den ich schon lange befürchtet -habe, bin ich heute mal die globalen Variablen angegangen. Das ganze ist über -die Jahre leider recht komfus geworden, deshalb hier ne Erklärung, die -hoffentlich sowas in Zukunft vermeidet. - - -Wie sehen globale Variablen in Perl aus? ----------------------------------------- - -Globale Variablen liegen in einem speziellen namespace namens "main", der von -überall erreichbar ist. Darüber hinaus sind bareword globs global und die -meisten speziellen Variablen sind... speziell. - -Daraus ergeben sich folgende Formen: - - $main::form - expliziter namespace main - $::form - impliziter namespace main - open FILE, "file.txt" - FILE ist global - $_ - speziell. - -(Ja, da fehlen noch ein paar Sachen, ich weiß) - -Im Gegensatz zu PHP gibt es kein Schlüsselwort wir "global" mit dem man -importieren kann, my, our und local machen was anderes. - - my $form - lexikalische Variable, gültig bis zum Ende des scopes - our $form - $form referenziert ab hier $PACKAGE::form. - local $form - Alle Änderungen an $form werden am Ende des scopes zurückgesetzt - -Warum ist das ein Problem? --------------------------- - -Das erste Problem ist FCGI. - -sql-ledger hat fast alles im globalen namespace abgelegt, und erwartet, dass es -da auch wiederzufinden ist. Unter FCGI müssen diese Sachen auch wieder -aufgeräumt werden, damit sie nicht in den nächsten Request kommen. Einige -Sachen wiederum sollen nicht gelöscht werden, wie zum Beispiel -Datenbankverbindungen, weil die ne Ewigkeit zum initialisieren brauchen. - -Das zweite Problem ist strict. - -Unter strict werden alle Variablen die nicht explizit mit Package, my oder our -angegeben werden als Tippfehler angemarkert, was einen vor so mancher Stunde -suchen nach einem Bug erspart. Da globale Variablen aber implizit mit Package -angegeben werden, werden die nicht geprüft, und ein Tippfehler da fällt -niemandem auf. - -Kanonische globale Variablen ----------------------------- - -Um dieses Problem im Griff zu halten gibt es einige wenige globale Variablen, -die kanonisch sind, und alles andere sollte anderweitig umhergereicht werden. - -Diese Variablen sind im Moment die folgenden neun: - - $::form - %::myconfig - $::locale - $::lxdebug - $::auth - $::lx_office_conf - $::instance_conf - $::dispatcher - $::request - -Damit diese nicht als Müllhalde misbrauch werden, im Folgenden eine kurze -Erläuterung was man von denn erwarten kann. - - -$::form - -- Ist ein Objekt der Klasse "Form" -- Wird nach jedem Request gelöscht -- Muss auch in Tests und Konsolenscripts vorhanden sein. -- Enthält am Anfang eines Requests die Requestparameter vom User -- Kann zwar intern über Requestgrenzen ein Datenbankhandle cachen, das wird - aber momentan absichtlich zerstört - -$::form wurde unter sql ledger als Gottobjekt für alles misbraucht. Sämtliche alten -Funktionen unter SL/ mutieren $::form, das heißt, alles was einem lieb ist, -sollte man vor einem Aufruf von zum Beispiel IS->retrieve_customer in Sicherheit bringen. - -Das Objekt der Klasse Form hat leider im Moment noch viele zentrale Funktionen -Gdie vom internen Zustand abhängen, deshalb bitte nie einfach zerstören oder -überschreiben. Es geht ziemlich sicher etwas kaputt. - -$::form ist gleichzeitig der Standard Scope in den Template::Toolkit Templates -ausserhalb der Controller, der Ausdruck [% var %] greift auf $::form->{var} zu. -Unter Controllern ist der Standard Scope anders, da lautet der Zugriff [% -FORM.var %]. In Druckvorlagen sind normale Variablen ebenfall im $::form Scope, -d.h. <%var%> zeigt auf $::form->{var}. Innerhalb von Schleifen -wird $::form->{TEMPLATE_ARRAYS}{var}[$index] bevorzugt wenn vorhanden. - - -%::myconfig - -- Das einzige Hash unter den globalen Variablen -- Wird spätestens benötigt wenn auf die Datenbank zugegriffen wird -- Wird bei jedem Request neu erstellt. -- Enthält die Userdaten des aktuellen Logins -- Sollte nicht ohne Filterung irgendwo gedumpt werden oder extern serialisiert - werden, weil da auch der Datenbankzugriff für diesen user drinsteht. -- Enthält unter anderem Listenbegrenzung vclimit, Datumsformat dateformat und - Nummernformat numberformat -- Enthält Datenbankzugriffinformationen - -%::myconfig ist im Moment der Ersatz für ein Userobjekt. Die meisten Funktionen, -die etwas anhand des aktuellen Users entscheiden müssen befragen %::myconfig. - - -$::locale - -- Objekt der Klasse "Locale" -- Wird pro Request erstellt -- Muss auch für Tests und Scripte immer verfügbar sein. -- Cached intern über Requestgrenzen hinweg benutzte Locales - -Lokalisierung für den aktuellen User. Alle Übersetzungen, Zahlen- und -Datumsformatierungen laufen über dieses Objekt. - - -$::lxdebug - -- Objekt der Klasse "LXDebug" -- Wird global gecached -- Muss immer verfügbar sein, in nahezu allen Funktionen - -$::lxdebug stellt Debuggingfunktionen bereit, wie "enter_sub" und "leave_sub", -mit denen in den alten Modulen ein brauchbares Tracing gebaut ist, "log_time", -mit der man die Wallclockzeit seit Requeststart loggen kann, und "message" und -"dump" mit denen man flott Informationen ins Log packen kann. - - -$::auth - -- Objekt der Klasse "SL::Auth" -- Wird global gecached -- Hat eine permanente DB Verbindung zur Authdatenbank -- Wird nach jedem Request resettet. - -$::auth stellt Funktionen bereit um die Rechte des aktuellen Users abzufragen. -Obwohl diese Informationen vom aktuellen User abhängen wird das Objekt aus -Geschwindigkeitsgründen nur einmal angelegt und dann nach jedem Request kurz -resettet. - - -$::lx_office_conf - -- Objekt der Klasse "SL::LxOfficeConf" -- Global gecached -- Repräsentation der config/lx_office.conf[.default] Dateien - -Globale Konfiguration. - -Configdateien werden zum Start gelesen, und nicht mehr angefasst. Es ist -derzeit nicht geplant, dass das Programm die Konfiguration ändern kann oder -sollte. - -Der Konfigurationskey - - [Debug] - - file = /tmp/lxoffice_debug_log.txt - -ist im Programm als $::lx_office_conf->{Debug}{file} erreichbar. - -Warnung: Zugriff auf die Konfiguration erfolgt im Moment über Hashkeys, sind -also nicht gegen Tippfehler abgesichert. - - -$::instance_conf - -- Objekt der Klasse "SL::InstanceConfiguration" -- wird pro Request neu erstellt. - -Funktioniert wie $::lx_office_conf, speichert aber Daten die von der Instanz -abhängig sind. Eine Instanz ist hier eine Mandantendatenbank. Prominentestes -Datum ist "eur", die Information ob Bilanz oder Einnahmenüberschussrechnung -gemacht wird. - - - -$::dispatcher - -- Objekt der Klasse "SL::Dispatcher" -- wird pro Serverprozess erstellt. -- enthält Informationen über die technische Verbindung zum Server - -Der dritte Punkt ist auch der einzige Grund warum das Objekt global gespeichert -wird. Wird vermutlich irgendwann in einem anderen Objekt untergebracht. - - - -$::request - -- Hashref (evtl später Objekt) -- Wird pro Request neu initialisiert. -- Keine Unterstruktur garantiert. - -$::request ist ein generischer Platz um Daten "für den aktuellen Request" -abzulegen. Sollte nicht für action at a distance benutzt werden, sondern um -lokales memoizing zu ermöglichen, das garantiert am Ende des Requests zerstört -wird. - -Vieles von dem was im moment in $::form liegt sollte eigentlich hier liegen. -Die groben Differentialkriterien sind: - -- Kommt es vom User, und soll unverändert wieder an den User? - => $::form, steht da eh schon - -- Sind es Daten aus der Datenbank, die nur bis zum Ende des Requests gebraucht werden? - => $::request - -- Muss ich von anderen Teilen des Programms lesend drauf zugreifen? - => $::request, aber Zugriff über Wrappermethode - - - - -Ehemalige globale Variablen ---------------------------- - -Die folgenden Variablen waren einmal im Programm, und wurden entfernt. - - -$::cgi - -- war nötig, weil cookie Methoden nicht als Klassenfunktionen funktionieren -- Aufruf als Klasse erzeugt Dummyobjekt was im Klassennamespace gehalten wird - und über Requestgrenzen leaked -- liegt jetzt unter $::request->{cgi} - - -$::all_units - -- war nötig, weil einige Funktionen in Schleifen zum Teil ein paar hundert mal - pro Request eine Liste der Einheiten brauchen, und die als Parameter durch - einen Riesenstack von Funktionen geschleift werden müssten. -- Liegt jetzt unter $::request->{cache}{all_units} -- Wird nur in AM->retrieve_all_units gesetzt oder gelesen. - - -%::called_subs - -- wurde benutzt um callsub deep recursions abzufangen. -- Wurde entfernt, weil callsub nur einen Bruchteil der möglichen Rekursioenen - darstellt, und da nie welche auftreten. -- komplette recursion protection wurde entfernt. diff --git a/doc/INSTALL.fcgi b/doc/INSTALL.fcgi deleted file mode 100644 index 31ba60f18..000000000 --- a/doc/INSTALL.fcgi +++ /dev/null @@ -1,208 +0,0 @@ - -Diese Datei ist in Plain Old Documentation geschrieben. Mit - -> perldoc INSTALL.fcgi - -ist sie deutlich leichter zu lesen. - -=encoding utf8 - -=head1 FastCGI für Lx-Office - -=head2 Was ist FastCGI? - -Direkt aus L kopiert: - - FastCGI ist ein Standard für die Einbindung externer Software zur Generierung - dynamischer Webseiten in einem Webserver. FastCGI ist vergleichbar zum Common - Gateway Interface (CGI), wurde jedoch entwickelt, um dessen - Performance-Probleme zu umgehen. - - -=head2 Warum FastCGI? - -Perl Programme (wie Lx-Office eines ist) werden nicht statisch kompiliert. -Stattdessen werden die Quelldateien bei jedem Start übersetzt, was bei kurzen -Laufzeiten einen Großteil der Laufzeit ausmacht. Während SQL Ledger einen -Großteil der Funktionalität in einzelne Module kapselt, um immer nur einen -kleinen Teil laden zu müssen, ist die Funktionalität von Lx-Office soweit -gewachsen, dass immer mehr Module auf den Rest des Programms zugreifen. -Zusätzlich benutzen wir umfangreiche Bibliotheken um Funktionaltät nicht selber -entwickeln zu müssen, die zusätzliche Ladezeit kosten. All dies führt dazu dass -ein Lx-Office Aufruf der Kernmasken mittlerweile deutlich länger dauert als -früher, und dass davon 90% für das Laden der Module verwendet wird. - -Mit FastCGI werden nun die Module einmal geladen, und danach wird nur die -eigentliche Programmlogik ausgeführt. - -=head2 Kombinationen aus Webservern und Plugin. - -Folgende Kombinationen sind getestet: - - * Apache 2.2.11 (Ubuntu) und mod_fcgid. - * Apache 2.2.11 (Ubuntu) und mod_fastcgi. - -Dabei wird mod_fcgid empfohlen, weil mod_fastcgi seit geraumer Zeit -nicht mehr weiter entwickelt wird. - -Als Perl Backend wird das Modul FCGI.pm verwendet. Vorsicht: FCGI 0.69 und -höher ist extrem strict in der Behandlung von Unicode, und verweigert bestimmte -Eingaben von Lx-Office. Solange diese Probleme nicht behoben sind, muss auf die -Vorgängerversion FCGI 0.68 ausgewichen werden. - -Mit cpan lässt sie sich wie folgt installieren: - - force install M/MS/MSTROUT/FCGI-0.68.tar.gz - -=head2 Konfiguration des Webservers. - -Bevor Sie versuchen eine Lx-Office Installation unter FCGI laufen zu lassen, -empfliehlt es sich die Installation ersteinmal unter CGI aufzusetzen. FCGI -macht es nicht einfach Fehler zu debuggen die beim ersten aufsetzen auftreten -können. Sollte die Installation schon funktionieren, lesen Sie weiter. - -Zuerst muss das FastCGI-Modul aktiviert werden. Dies kann unter -Debian/Ubuntu z.B. mit folgendem Befehl geschehen: - - a2enmod fcgid - -bzw. - - a2enmod fastcgi - -Die Konfiguration für die Verwendung von Lx-Office mit FastCGI erfolgt -durch Anpassung der vorhandenen Alias- und Directory-Direktiven. Dabei -wird zwischen dem Installationspfad von Lx-Office im Dateisystem -("/path/to/lx-office-erp") und der URL unterschieden, unter der -Lx-Office im Webbrowser erreichbar ist ("/web/path/to/lx-office-erp"). - -Folgendes Template funktioniert mit mod_fastcgi: - - AliasMatch ^/web/path/to/lx-office-erp/[^/]+\.pl /path/to/lx-office-erp/dispatcher.fcgi - Alias /web/path/to/lx-office-erp/ /path/to/lx-office-erp/ - - - AllowOverride All - Options ExecCGI Includes FollowSymlinks - Order Allow,Deny - Allow from All - - - - Order Deny,Allow - Deny from All - - -Für mod_fcgid muss ein AddHandler ergänzt werden und die erste Zeile geändert werden: - - AddHandler fcgid-script .fpl - AliasMatch ^/web/path/to/lx-office-erp/[^/]+\.pl /path/to/lx-office-erp/dispatcher.fpl - -Seit mod_fcgid-Version 2.6.3 gelten sehr kleine Grenzen für die -maximale Größe eines Requests. Diese sollte wie folgt hochgesetzt werden: - - FcgidMaxRequestLen 10485760 - -Das ganze sollte dann so aussehen: - - AddHandler fcgid-script .fpl - AliasMatch ^/web/path/to/lx-office-erp/[^/]+\.pl /path/to/lx-office-erp/dispatcher.fpl - Alias /web/path/to/lx-office-erp/ /path/to/lx-office-erp/ - FcgidMaxRequestLen 10485760 - - - AllowOverride All - Options ExecCGI Includes FollowSymlinks - Order Allow,Deny - Allow from All - - - - Order Deny,Allow - Deny from All - - -Hierdurch wird nur ein zentraler Dispatcher gestartet. Alle Zugriffe -auf die einzelnen Scripte werden auf diesen umgeleitet. Dadurch, dass -zur Laufzeit öfter mal Scripte neu geladen werden, gibt es hier kleine -Performance-Einbußen. - - -Es ist möglich die gleiche Lx-Office Version parallel unter cgi und fastcgi zu -betreiben. Dafür bleiben die Directorydirektiven wie oben beschrieben, die URLs -werden aber umgeleitet: - - # Zugriff über cgi - Alias /web/path/to/lx-office-erp /path/to/lx-office-erp - - # Zugriff mit mod_fcgid: - AliasMatch ^/web/path/to/lx-office-erp-fcgid/[^/]+\.pl /path/to/lx-office-erp/dispatcher.fpl - Alias /web/path/to/lx-office-erp-fcgid/ /path/to/lx-office-erp/ - - # Zugriff mit mod_fastcgi: - AliasMatch ^/web/path/to/lx-office-erp-fastcgi/[^/]+\.pl /path/to/lx-office-erp/dispatcher.fcgi - Alias /web/path/to/lx-office-erp-fastcgi/ /path/to/lx-office-erp/ - -Dann ist unter C die normale Version erreichbar, -und unter C bzw. -C die FastCGI Version. - -=head2 Entwicklungsaspekte - -Wenn Änderungen in der Konfiguration von Lx-Office gemacht werden, muss der -Webserver neu gestartet werden. - -Bei der Entwicklung für FastCGI ist auf ein paar Fallstricke zu achten. Dadurch -dass das Programm in einer Endlosschleife läuft, müssen folgende Aspekte -geachtet werden: - -=head3 Programmende und Ausnahmen: C, C, C, C, C - -Fehler, die dass Programm normalerweise sofort beenden (fatale Fehler), werden -mit dem FastCGI Dispatcher abgefangen, um das Programm am Laufen zu halten. Man -kann mit C, C oder C Fehler ausgeben, die dann vom Dispatcher -angezeigt werden. Die Lx-Office eigene C<$::form->error()> tut im Prinzip das -Gleiche, mit ein paar Extraoptionen. C und C hingegen werden nicht -abgefangen. C wird direkt nach STDERR, also in Server Log eine Nachricht -schreiben (sofern in der Konfiguration nicht die Warnungen in das Lx-Office Log -umgeleitet wurden), und C wird die Ausführung beenden. - -Prinzipiell ist es kein Beinbruch, wenn sich der Prozess beendet, fcgi wird ihn -sofort neu starten. Allerdings sollte das die Ausnahme sein. Quintessenz: Bitte -kein C benutzen, alle anderen Exceptionmechanismen sind ok. - -=head3 Globale Variablen - -Um zu vermeiden, dass Informationen von einem Request in einen anderen gelangen, -müssen alle globalen Variablen vor einem Request sauber initialisiert werden. -Das ist besonders wichtig im C<$::cgi> und C<$::auth> Objekt, weil diese nicht -gelöscht werden pro Instanz, sondern persistent gehalten werden. - -In C gibt es einen sauber abgetrennten Block der alle -kanonischen globalen Variablen listet und erklärt. Bitte keine anderen -einführen ohne das sauber zu dokumentieren. - -Datenbankverbindungen wird noch ein Guide verfasst werden, wie man sicher geht, -dass man die richtige erwischt. - -=head2 Performance und Statistiken - -Die kritischen Pfade des Programms sind die Belegmasken, und unter diesen ganz -besonders die Verkaufsrechnungsmaske. Ein Aufruf der Rechnungsmaske in -Lx-Office 2.4.3 stable dauert auf einem Core2duo mit 4GB Arbeitsspeicher und -Ubuntu 9.10 eine halbe Sekunde. In der 2.6.0 sind es je nach Menge der -definierten Variablen 1-2s. Ab der Moose/Rose::DB Version sind es 5-6s. - -Mit FastCGI ist die neuste Version auf 0,26 Sekunden selbst in den kritischen -Pfaden, unter 0,15 sonst. - -=head2 Bekannte Probleme - -=head3 Encoding Awareness - -UTF-8 kodierte Installationen sind sehr anfällig gegen fehlerhfate Encodings -unter FCGI. latin9 Installationen behandeln falsch kodierte Zeichen eher -unwissend, und geben sie einfach weiter. UTF-8 verweigert bei fehlerhaften -Programmpfaden kurzerhand das Ausliefern. Es wird noch daran gearbeitet, alle -Fehler da zu beseitigen. - diff --git a/doc/INSTALL.html b/doc/INSTALL.html deleted file mode 100644 index 31ccd435a..000000000 --- a/doc/INSTALL.html +++ /dev/null @@ -1,1191 +0,0 @@ - - -Lx-Office Installationsanleitung - - - - - - - - - -

Lx-Office Installationsanleitung

-
-

Table of Contents

- -
- - - -
-

- -nächstes: , -aufwärts: (dir) - -
- -

Inhalt der Anleitung

- - - - -
-

- -nächstes: , -voriges: Top, -aufwärts: Top - -
- -

1 Aktuelle Hinweise

- -

Aktuelle Installations- und Konfigurationshinweise gibt es: - -

- - -
-

- - -nächstes: , -voriges: Aktuelle Hinweise, -aufwärts: Top - -
- -

2 Benötigte Software und Pakete

- -
    -
  • Betriebssystem: Unterstützte Betriebsysteme und Hinweise für ältere Systeme -
  • Pakete: Benötigte Software und Perlpakete sowie deren Quellen -
- -
-

- -nächstes: , -aufwärts: Benötigte Software und Pakete - -
- -

2.1 Betriebssystem

- -

Lx-Office ist für Linux konzipiert, und sollte auf jedem unixoiden -Betriebssystem zum Laufen zu kriegen sein. Getestet ist diese Version im -speziellen auf Debian und Ubuntu, grundsätzlich wurde bei der Auswahl der -Pakete aber darauf Rücksicht genommen, dass es ohne große Probleme auf den -derzeit aktuellen verbreiteten Distributionen läuft. - -

Anfang 2011 sind das folgende Systeme: - -

    -
  • Ubuntu 8.04 LTS Hardy Heron -
  • Ubuntu 9.10 Karmic Koala -
  • Ubuntu 10.04 Lucid Lynx -
  • Ubuntu 10.10 Maverick Meerkat -
  • Debian 5.0 Lenny -
  • Debian 6.0 Squeeze -
  • openSUSE 11.2 -
  • openSUSE 11.3 -
  • SuSE Linux Enterprice Server 11 -
  • Fedora 13 -
  • Fedora 14 -
- -

Für die debianoiden Betriebssysteme existiert ein .deb, das deutlich einfacher -zu installieren ist. - -

Ubuntu 8.04 LTS hat zusätzlich die Schwierigkeit, dass die Module im Archiv -recht alt sind, und das viele der benötigten Module nicht einfach zu -installieren sind. Dafür sollte es kurz nach dem Release ein eigenes .deb -geben. - -

Alternativ dazu kann die normale Installation durchgeführt werden -(siehe Manuelle Installation des Programmpaketes), wenn vorher ein -Kompatibilitätspaket installiert wird, das die fehlenden Pakete bereitstellt. -Das Paket ist auf Sourceforge unter dem Namen lx-erp-perl-libs-compat-v2.tar.gz hinterlegt. - -

Zur Installation das Paket in das entpackte Lx-Office Verzeichnis entpacken: - -

tar xzf lx-erp-perl-libs-compat-v2.tar.gz /path/to/lx-office/ - -

Zusätzlich müssen dann noch die folgenden Pakete installiert weerden - -

libbit-vector-perl libsub-exporter-perl libclone-perl libclass-factory-util-perl - -

Danach sollte der Installationscheck (siehe Pakete) die enthaltenen Pakete erkennen. - -

-

- -voriges: Betriebssystem, -aufwärts: Benötigte Software und Pakete - -
- -

2.2 Pakete

- -

Zum Betrieb von Lx-Office werden zwingend ein Webserver (meist Apache) -und ein Datenbankserver (PostgreSQL, mindestens v8.2) benötigt. - -

Zusätzlich benötigt Lx-Office die folgenden Perl-Pakete, die nicht Bestandteil -einer Standard-Perl-Installation sind: - -

    -
  • parent -
  • Archive::Zip -
  • Config::Std -
  • DateTime -
  • DBI -
  • DBD::Pg -
  • Email::Address -
  • JSON -
  • List::MoreUtils -
  • Params::Validate -
  • PDF::API2 -
  • Rose::Object -
  • Rose::DB -
  • Rose::DB::Object -
  • Template -
  • Text::CSV_XS -
  • Text::Iconv -
  • URI -
  • XML::Writer -
  • YAML -
- -

Gegenüber Version 2.6.0 sind zu dieser Liste 2 Pakete hinzugekommen, URI -und XML::Writer sind notwendig. Ohne startet Lx-Office nicht. - -

Gegenüber Version 2.6.1 sind parent, DateTime, -Rose::Object, Rose::DB und Rose::DB::Object neu -hinzugekommen. IO::Wrap wurde entfernt. - -

Gegenüber Version 2.6.3 ist JSON neu hinzugekommen. - -

Email::Address und List::MoreUtils sind schon länger feste -Abhängigkeiten, wurden aber bisher mit Lx-Office mitgeliefert. Beide sind auch -in 2.6.1 weiterhin mit ausgeliefert, wurden in einer zukünftigen Version aber -aus dem Paket entfernt werden. Es wird empfohlen diese Module zusammen mit den -anderen als Bibliotheken zu installieren. - -

Die zu installierenden Pakete können in den verschiedenen Distributionen unterschiedlich heißen. - -

Für Debian oder Ubuntu benötigen Sie diese Pakete: - -

apache2 postgresql libparent-perl libarchive-zip-perl libdatetime-perl libdbi-perl libdbd-pg-perl libpg-perl libemail-address-perl liblist-moreutils-perl libpdf-api2-perl librose-object-perl librose-db-perl librose-db-object-perl libtemplate-perl libtext-csv-xs-perl libtext-iconv-perl liburi-perl libxml-writer-perl libyaml-perl libconfig-std-perl libparams-validate-perl libjson-perl - -

Für Fedora Core benötigen Sie diese Pakete: - -

httpd postgresql-server perl-parent perl-DateTime perl-DBI perl-DBD-Pg perl-Email-Address perl-List-MoreUtils perl-PDF-API2 perl-Rose-Object perl-Rose-DB perl-Rose-DB-Object perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv perl-URI perl-XML-Writer perl-YAML - -

Für OpenSuSE benötigen Sie diese Pakete: - -

apache2 postgresql-server perl-Archive-Zip perl-DateTime perl-DBI perl-DBD-Pg perl-MailTools perl-List-MoreUtils perl-PDF-API2 perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv perl-URI perl-XML-Writer perl-YAML - -

Bei openSuSE 11 ist parent bereits enthalten, und braucht nicht nachinstalliert werden. Die Rose::* Pakete sind derzeit nicht für SuSE gepackt, und müssen anderweitig nachinstalliert werden. - -

Lx-Office enthält ein Script, mit dem überprüft werden kann, ob alle -benötigten Perl-Module installiert sind. Der Aufruf lautet wie folgt: - -

./scripts/installation_check.pl - - -

-

- -nächstes: , -voriges: Benötigte Software und Pakete, -aufwärts: Top - -
- -

3 Manuelle Installation des Programmpaketes

- -

Die Lx-Office ERP Installationsdatei (lxoffice-erp-2.6.2.tgz) wird im -Dokumentenverzeichnis des Webservers (z.B. /var/www/html/, -/srv/www/htdocs oder /var/www/) entpackt: - -

cd /var/www -
-tar xvzf lxoffice-erp-2.6.2.tgz - -

Verändern Sie evtl. noch den Namen des Verzeichnisses mit - -

mv lxoffice-erp/ lx-erp/ - -

Alternativ können Sie auch einen Alias in der Webserverkonfiguration -benutzen, um auf das tatsächliche Installationsverzeichnis zu -verweisen. - -

Die Verzeichnisse users, spool und webdav müssen -für den Benutzer beschreibbar sein, unter dem der Webserver läuft. Die -restlichen Dateien müssen für diesen Benutzer lesbar sein. Der -Benutzername ist bei verschiedenen Distributionen unterschiedlich -(z.B. bei Debian/Ubuntu www-data, bei Fedora core apache -oder bei OpenSuSE wwwrun). - -

Der folgende Befehl ändert den Besitzer für die oben genannten -Verzeichnisse auf einem Debian/Ubuntu-System: - -

chown -R www-data lx-office-erp/users lx-office-erp/spool lx-office-erp/webdav - -

Weiterhin muss der Webserver-Benutzer im Verzeichnis templates Verzeichnisse für -jeden neuen Benutzer, der in lx-office angelegt wird, anlegen dürfen: - -

chgrp www-data lx-office-erp/templates; chmod g+w lx-office-erp/templates - - -

-

- - -nächstes: , -voriges: Manuelle Installation des Programmpaketes, -aufwärts: Top - -
- -

4 Anpassung der PostgreSQL-Konfiguration

- -

PostgreSQL muss auf verschiedene Weisen angepasst werden. - -

- -
-

- - -nächstes: , -aufwärts: Anpassung der PostgreSQL-Konfiguration - -
- -

4.1 Zeichensätze/die Verwendung von UTF-8

- -

Lx-Office kann komplett mit UTF-8 als Zeichensatz verwendet -werden. Dabei gibt es zwei Punkte zu beachten: PostgreSQL muss in -Version 8.0 oder neuer benutzt werden, und der -PostgreSQL-Datenbankcluster muss ebenfalls mit UTF-8 als Locale -angelegt worden sein. - -

Dieses ist kann überprüft werden: ist das Encoding der Datenbank -“template1” “UTF8”, so kann auch Lx-Office mit UTF-8 betrieben -werden. Andernfalls ist es notwendig, einen neuen Datenbankcluster mit -UTF-8-Encoding anzulegen und diesen zu verwenden. Unter Debian und -Ubuntu kann dies z.B. mit dem folgenden Befehl getan werden: - -

pg_createcluster --locale=de_DE.UTF-8 --encoding=UTF-8 8.2 clustername - -

Die Datenbankversionsnummer muss an die tatsächlich verwendete -Versionsnummer angepasst werden. - -

Unter anderen Distributionen gibt es ähnliche Methoden. - -

Wurde PostgreSQL nicht mit UTF-8 als Encoding initialisiert und ist -ein Neuanlegen eines weiteren Clusters nicht möglich, so kann -Lx-Office mit ISO-8859-15 als Encoding betrieben werden. - -

Das Encoding einer Datenbank kann in psql mit \l geprüft werden. - -

-

- - -nächstes: , -voriges: Zeichensätze/die Verwendung von UTF-8, -aufwärts: Anpassung der PostgreSQL-Konfiguration - -
- -

4.2 Änderungen an Konfigurationsdateien

- -

In der Datei postgresql.conf, die je nach Distribution in -verschiedenen Verzeichnissen liegen kann -(z.B. /var/lib/pgsql/data/ oder /etc/postgresql/, muss -sichergestellt werden, dass TCP/IP-Verbindungen aktiviert sind. Das -Verhalten wird über den Parameter listen_address -gesteuert. Laufen PostgreSQL und Lx-Office auf demselben Rechner, so -kann dort der Wert localhost verwendet werden. Andernfalls -müssen Datenbankverbindungen auch von anderen Rechnern aus zugelassen -werden, was mit dem Wert \* geschieht. - -

In der Datei pg_hba.conf, die im gleichen Verzeichnis wie die -postgresql.conf zu finden sein sollte, müssen die -Berichtigungen für den Zugriff geändert werden. Hier gibt es mehrere -Möglichkeiten. Eine besteht darin, lokale Verbindungen immer -zuzulassen - -

local all all trust -
-host all all 127.0.0.1 255.0.0.0 trust - -

Besser ist es, für eine bestimmte Datenbank Zugriff nur per Passwort -zuzulassen. Beispielsweise: - -

local all lxoffice password -
-host all lxoffice 127.0.0.1 255.255.255.255 password - - -

-

- - -nächstes: , -voriges: Ã„nderungen an Konfigurationsdateien, -aufwärts: Anpassung der PostgreSQL-Konfiguration - -
- -

4.3 Erweiterung für servergespeicherte Prozeduren

- -

In der Datenbank template1 muss die Unterstützung für servergespeicherte -Prozeduren eingerichet werden. Melden Sie sich dafür als Benutzer “postgres” -an der Datenbank an, und führen Sie die folgenden Kommandos aus: - -

create language 'plpgsql'; - -

Achtung: In älteren Postgresversionen (vor 8.0) muss der Handler für die -Sprache manuell anlelegt werden, diese Versionen werden aber nicht mehr -offiziell von Lx-Office unterstützt. Dafür dann die folgenden Kommandos: - -

create function plpgsql_call_handler () returns opaque as '/usr/lib/pgsql/plpgsql.so' language 'c'; -
-create language 'plpgsql' handler plpgsql_call_handler lancompiler 'pl/pgsql'; - -

Bitte beachten Sie, dass der Pfad zur Datei plpgsql.so von Distribution -zu Distribution verschiedlich sein kann. Bei Debian/Ubuntu befindet sie sich -unter /usr/lib/postgresql/lib/plpgsql.so. - - -

-

- -voriges: Erweiterung für servergespeicherte Prozeduren, -aufwärts: Anpassung der PostgreSQL-Konfiguration - -
- -

4.4 Datenbankbenutzer anlegen

- -

Wenn Sie nicht den Datenbanksuperuser “postgres” zum Zugriff -benutzen wollen, so sollten Sie bei PostgreSQL einen neuen Benutzer -anlegen. Ein Beispiel, wie Sie einen neuen Benutzer anlegen können: - -

su - postgres -
-createuser -d -P lxoffice - -

Wenn Sie später einen Datenbankzugriff konfigurieren, verändern Sie -den evtl. voreingestellten Benutzer “postgres” auf “lxoffice” -bzw. den hier gewählten Benutzernamen. - - -

-

- - -nächstes: , -voriges: Anpassung der PostgreSQL-Konfiguration, -aufwärts: Top - -
- -

5 Apache-Konfiguration

- -

Hinweis: Für einen deutlichen Performanceschub sorgt die Ausführung -mittels FCGI. Die Einrichtung wird ausführlich in der Datei -INSTALL.fcgi beschrieben. - -

Der Zugriff auf das Programmverzeichnis muss in der Apache -Webserverkonfigurationsdatei httpd.conf eingestellt -werden. Fügen Sie den folgenden Abschnitt dieser Datei oder einer -anderen Datei hinzu, die beim Starten des Webservers eingelesen wird: - -


-AddHandler cgi-script .pl -
-Alias /lx-erp/ /var/www/lx-erp/ -
-<Directory /var/www/lx-erp> -
- Options ExecCGI Includes FollowSymlinks -
-</Directory> -
-
-<Directory /var/www/lx-erp/users> -
- Order Deny,Allow -
- Deny from All -
-</Directory> -
- - -

Ersetzen Sie dabei die Pfade durch diejenigen, in die Sie vorher das -Lx-Office-Archiv entpacket haben. - -

Achtung: Vor den einzelnen Optionen muss bei einigen Distributionen ein -Plus ‘+’ gesetzt werden. - -

Auf einigen Webservern werden manchmal die Grafiken und Style-Sheets -nicht ausgeliefert. In solchen Fällen hat es oft geholfen, die -folgende Option in die Konfiguration aufzunehmen: - -

EnableSendfile Off - - -

-

- - -nächstes: , -voriges: Apache-Konfiguration, -aufwärts: Top - -
- -

6 Der Task-Server

- -

Der Task-Server ist ein Prozess, der im Hintergrund läuft, in -regelmäßigen Abständen nach abzuarbeitenden Aufgaben sucht und diese -zu festgelegten Zeitpunkten abarbeitet (ähnlich wie Cron). Dieser -Prozess wird bisher nur für die Erzeugung der wiederkehrenden -Rechnungen benutzt, wird aber in Zukunft deutlich mehr Aufgaben -übertragen bekommen. - -

- -
-

- - -nächstes: , -aufwärts: Der Task-Server - -
- -

6.1 Verfügbare und notwendige Konfigurationsoptionen

- -

Die Konfiguration erfolgt über den Abschnitt [task_server] in -der Datei config/lx_office.conf. Die dort verfügbaren Optionen -sind: - -

    -
  • login: gültiger Lx-Office-Benutzername, der benutzt wird, um die zu verwendende Datenbankverbindung auszulesen. Der Benutzer muss in der Administration angelegt werden. Diese Option muss angegeben werden. -
  • run_as: Wird der Server vom Systembenutzer root gestartet, so wechselt er auf den mit run_as angegebenen Systembenutzer. Der Systembenutzer muss dieselben Lese- und Schreibrechte haben, wie auch der Webserverbenutzer (siehe siehe Manuelle Installation des Programmpaketes). Daher ist es sinnvoll, hier denselben Systembenutzer einzutragen, unter dem auch der Webserver läuft. -
  • debug: Schaltet Debug-Informationen an und aus. -
- -
-

- - -voriges: Prozesskontrolle, -aufwärts: Der Task-Server - -
- -

6.2 Automatisches Starten des Task-Servers beim Booten

- -

Der Task-Server verhält sich von seinen Optionen her wie ein reguläres -SystemV-kompatibles Boot-Script. Außerdem wechselt er beim Starten -automatisch in das Lx-Office-Installationsverzeichnis. - -

Deshalb ist es möglich, ihn durch Setzen eines symbolischen Links aus -einem der Runlevel-Verzeichnisse heraus in den Boot-Prozess -einzubinden. Da das bei neueren Linux-Distributionen aber nicht -zwangsläufig funktioniert, werden auch Start-Scripte mitgeliefert, die -anstelle eines symbolischen Links verwendet werden können. - -

6.2.1 SystemV-basierende Systeme (z.B. Debian, OpenSuSE, Fedora Core)

- -

Kopieren Sie die Datei -scripts/boot/system-v/lx-office-task-server nach -/etc/init.d/lx-office-task-server. Passen Sie in der kopierten -Datei den Pfad zum Task-Server an (Zeile DAEMON=....). Binden -Sie das Script in den Boot-Prozess ein. Dies ist distributionsabhängig: - -

    -
  • Debian-basierende Systeme: -
    -update-rc.d lx-office-task-server defaults -
    -# Nur bei Debian Squeeze und neuer: -
    -insserv lx-office-task-server     -
  • OpenSuSE und Fedora Core: -
    -chkconfig --add lx-office-task-server -
- -

Danach kann der Task-Server mit dem folgenden Befehl gestartet werden: -/etc/init.d/lx-office-task-server start - -

6.2.2 Upstart-basierende Systeme (z.B. Ubuntu)

- -

Kopieren Sie die Datei -scripts/boot/upstart/lx-office-task-server.conf nach -/etc/init/lx-office-task-server.conf. Passen Sie in der kopierten -Datei den Pfad zum Task-Server an (Zeile exec ....). - -

Danach kann der Task-Server mit dem folgenden Befehl gestartet werden: -service lx-office-task-server start - -

-

- -nächstes: , -voriges: Konfiguration des Task-Servers, -aufwärts: Der Task-Server - -
- -

6.3 Wie der Task-Server gestartet und beendet wird

- -

Der Task-Server wird wie folgt kontrolliert: - -

./scripts/task_server.pl Befehl - -

Befehl ist dabei eine der folgenden Optionen: - -

    -
  • start startet eine neue Instanz des Task-Servers. Die Prozess-ID wird innerhalb des users-Verzeichnisses abgelegt. -
  • stop beendet einen laufenden Task-Server. -
  • restart beendet und startet ihn neu. -
  • status berichtet, ob der Task-Server läuft. -
- -

Der Task-Server wechselt beim Starten automatisch in das Lx-Office-Installationsverzeichnis. - -

Dieselben Optionen können auch für die SystemV-basierenden -Runlevel-Scripte benutzt werden (siehe oben). - - -

-

- -nächstes: , -voriges: Der Task-Server, -aufwärts: Top - -
- -

7 Benutzerauthentifizierung und Administratorpasswort

- -

Informationen über die Einrichtung der Benutzerauthentifizierung, über -die Verwaltung von Gruppen und weitere Einstellungen - -

- - -
-

- -nächstes: , -aufwärts: Benutzerauthentifizierung und Administratorpasswort - -
- -

7.1 Grundlagen zur Benutzerauthentifizierung

- -

Lx-Office verwaltet die Benutzerinformationen in einer Datenbank, die -im folgenden “Authentifizierungsdatenbank” genannt wird. Für jeden -Benutzer kann dort eine eigene Datenbank für die eigentlichen -Finanzdaten hinterlegt sein. Diese beiden Datenbanken können, müssen -aber nicht unterschiedlich sein. - -

Im einfachsten Fall gibt es für Lx-Office nur eine einzige Datenbank, -in der sowohl die Benutzerinformationen als auch die Daten abgelegt -werden. - -

Zusätzlich ermöglicht es Lx-Office, dass die Benutzerpasswörter -entweder gegen die Authentifizierungsdatenbank oder gegen einen -LDAP-Server überprüft werden. - -

Welche Art der Passwortüberprüfung Lx-Office benutzt und wie Lx-Office -die Authentifizierungsdatenbank erreichen kann, wird in der -Konfigurationsdatei config/lx_office.conf festgelegt. Diese -muss bei der Installation und bei einem Upgrade von einer Version vor -v2.6.0 angelegt werden. Eine Beispielkonfigurationsdatei -config/lx_office.conf.default existiert, die als Vorlage -benutzt werden kann. - -

-

- -nächstes: , -voriges: Grundlagen zur Benutzerauthentifizierung, -aufwärts: Benutzerauthentifizierung und Administratorpasswort - -
- -

7.2 Administratorpasswort

- -

Das Passwort, das zum Zugriff auf das Aministrationsinterface benutzt wird, -wird ebenfalls in dieser Datei gespeichert. Es kann auch nur dort und nicht -mehr im Administrationsinterface selber geändert werden. Der Parameter dazu -heißt $self->{admin_password}. - -

-

- -nächstes: , -voriges: Administratorpasswort, -aufwärts: Benutzerauthentifizierung und Administratorpasswort - -
- -

7.3 Authentifizierungsdatenbank

- -

Die Verbindung zur Authentifizierungsdatenbank wird mit den Parametern -in $self->{DB_config} konfiguriert. Hier sind die folgenden -Parameter anzugeben: - -

    -
  • ‘host’ – Der Rechnername oder die IP-Adresse des Datenbankservers -
  • ‘port’ – Die Portnummer des Datenbankservers, meist 5432 -
  • ‘db’ – Der Name der Authentifizierungsdatenbank -
  • ‘user’ – Der Benutzername, mit dem sich Lx-Office beim Datenbankserver anmeldet (z.B. “postgres”) -
  • ‘password’ – Das Passwort für den Datenbankbenutzer -
- -

Die Datenbank muss noch nicht existieren. Lx-Office kann sie -automatisch anlegen (mehr dazu siehe unten). - -

-

- - -nächstes: , -voriges: Authentifizierungsdatenbank, -aufwärts: Benutzerauthentifizierung und Administratorpasswort - -
- -

7.4 Passwortüberprüfung

- -

Lx-Office unterstützt Passwortüberprüfung auf zwei Arten: gegen die -Authentifizierungsdatenbank und gegen einen externen LDAP- oder -Active-Directory-Server. Welche davon benutzt wird, regelt der -Parameter $self->{module}. - -

Sollen die Benutzerpasswörter in der Authentifizierungsdatenbank -gespeichert werden, so muss der Parameter $self->{module} den -Wert ‘DB’ enthalten. In diesem Fall können sowohl der -Administrator als auch die Benutzer selber ihre Psaswörter in -Lx-Office ändern. - -

Soll hingegen ein externer LDAP- oder Active-Directory-Server benutzt -werden, so muss der Parameter $self->{module} auf ‘LDAP’ -gesetzt werden. In diesem Fall müssen zusätzliche Informationen über -den LDAP-Server in $self->{LDAP_config} angegeben werden: - -

    -
  • ‘host’ – Der Rechnername oder die IP-Adresse des LDAP- oder Active-Directory-Servers. Diese Angabe ist zwingend erforderlich. -
  • ‘port’ – Die Portnummer des LDAP-Servers; meist 389. -
  • ‘tls’ – Wenn Verbindungsverschlüsselung gewünscht ist, so diesen Wert auf ‘1’ setzen, andernfalls auf ‘0’ belassen -
  • ‘attribute’ – Das LDAP-Attribut, in dem der Benutzername steht, den der Benutzer eingegeben hat. Für Active-Directory-Server - ist dies meist ‘sAMAccountName’, für andere LDAP-Server hingegen ‘uid’. Diese Angabe ist zwingend erforderlich. -
  • ‘base_dn’ – Der Abschnitt des LDAP-Baumes, der durchsucht werden soll. Diese Angabe ist zwingend erforderlich. -
  • ‘filter’ – Ein optionaler LDAP-Filter. Enthält dieser Filter das Wort <%login%>, so wird dieses durch den vom Benutzer - eingegebenen Benutzernamen ersetzt. Andernfalls wird der LDAP-Baum nach einem Element durchsucht, bei dem das oben angegebene Attribut - mit dem Benutzernamen identisch ist. -
  • ‘bind_dn’ und ‘bind_password’ – Wenn der LDAP-Server eine Anmeldung erfordert, bevor er durchsucht werden kann (z.B. ist dies bei - Active-Directory-Servern der Fall), so kann diese hier angegeben werden. Für Active-Directory-Server kann als ‘bind_dn’ entweder eine - komplette LDAP-DN wie z.B. ‘cn=Martin Mustermann,cn=Users,dc=firmendomain’ auch nur der volle Name des Benutzers - eingegeben werden; in diesem Beispiel also ‘Martin Mustermann’. -
- -
-

- - -nächstes: , -voriges: Passwortüberprüfung, -aufwärts: Benutzerauthentifizierung und Administratorpasswort - -
- -

7.5 Name des Session-Cookies

- -

Sollen auf einem Server mehrere Lx-Office-Installationen aufgesetzt -werden, so müssen die Namen der Session-Cookies für alle -Installationen unterschiedlich sein. Der Name des Cookies wird mit dem -Parameter $self->{cookie_name} gesetzt. - -

Diese Angabe ist optional, wenn nur eine Installation auf dem Server -existiert. - -

-

- -voriges: Name des Session-Cookies, -aufwärts: Benutzerauthentifizierung und Administratorpasswort - -
- -

7.6 Anlegen der Authentifizierungsdatenbank

- -

Nachdem alle Einstellungen in config/lx_office.conf -vorgenommen wurden, muss Lx-Office die Authentifizierungsdatenbank -anlegen. Dieses geschieht automatisch, wenn Sie sich im -Administrationsmodul anmelden, das unter der folgenden URL erreichbar -sein sollte: - -

http://localhost/lx-erp/admin.pl - - -

-

- - -nächstes: , -voriges: Benutzerauthentifizierung und Administratorpasswort, -aufwärts: Top - -
- -

8 Benutzer- und Gruppenverwaltung

- -

Nach der Installation müssen Benutzer, Gruppen und Datenbanken -angelegt werden. Dieses geschieht im Administrationsmenü, das Sie -unter folgender URL finden: - -

http://localhost/lx-erp/admin.pl - -

Verwenden Sie zur Anmeldung das Password, dass Sie in der Datei -config/lx_office.conf eingetragen haben. - -

- -
-

- - -nächstes: , -aufwärts: Benutzer- und Gruppenverwaltung - -
- -

8.1 Zusammenhänge

- -

Lx-Office verwendet eine Datenbank zum Speichern all seiner -Informationen wie Kundendaten, Artikel, Angebote, Rechnungen etc. Um -mit Lx-Office arbeiten zu können, muss eine Person einen -Benutzeraccount haben. Jedem Benutzeraccount wiederum wird genau eine -Datenbank zugewiesen, mit der dieser Benutzer arbeiten kann. Es ist -möglich und normal, dass mehreren Benutzern die selbe Datenbank -zugewiesen wird, sodass sie alle mit den selben Daten arbeiten können. - -

Die Basisdaten der Benutzer, die in der Administration eingegeben -werden können, werden in einer zweiten Datenbank gespeichert, der -bereits erwähnten Authentifizierungsdatenbank. Diese ist also den -Produktivdaten enthaltenden Datenbanken vorgeschaltet. Pro -Lx-Office-Installation gibt es nur eine Authentifizierungsdatenbank, -aber beliebig viele Datenbanken mit Firmendaten. - -

Lx-Office kann seinen Benutzern Zugriff auf bestimmte -Funktionsbereiche erlauben oder verbieten. Wird der Zugriff nicht -gestattet, so werden der entsprechenden Menüpunkte auch nicht -angezeigt. Diese Rechte werden ebenfalls in der -Authentifizierungsdatenbank gespeichert. - -

Um Rechte verteilen zu können, verwendet Lx-Office ein -Gruppen-Prinzip. Einer Gruppe kann der Zugriff auf bestimmte Bereiche -erlaubt werden. Ein Benutzer wiederum kann Mitglied in einer oder -mehrerer Gruppen sein. Der Benutzer hat Zugriff auf alle diejenigen -Funktionen, die mindestens einer Gruppe erlaubt sind, in der der -Benutzer Mitglied ist. - -

Die allgemeine Reihenfolge, in der Datenbanken, Gruppen und Benutzer -angelegt werden sollten, lautet: - -

    -
  1. Datenbank anlegen -
  2. Gruppen anlegen -
  3. Benutzer anlegen -
  4. Benutzer den Gruppen zuordnen -
- -
-

- -nächstes: , -voriges: Zusammenhänge, -aufwärts: Benutzer- und Gruppenverwaltung - -
- -

8.2 Datenbanken anlegen

- -

Zuerst muss eine Datenbank angelegt werden. Verwenden Sie für den -Datenbankzugriff den vorhin angelegten Benutzer (in unseren Beispielen -ist dies ‘lxoffice’). - -

Wenn Sie für die Lx-Office-Installation nicht den europäischen -Schriftsatz ISO-8859-15 sondern UTF-8 (Unicode) benutzen wollen, so -müssen Sie vor dem Anlegen der Datenbank in der Datei -config/lx_office.conf die Variable dbcharset im -Abschnitt system auf den Wert ‘UTF-8’ setzen. Zusätzlich -muss beim Anlegen der Datenbank ‘UTF-8 Unicode’ als Schriftsatz -ausgewählt werden. - -

Bitte beachten Sie, dass alle Datenbanken den selben Zeichensatz -verwenden müssen, da diese Einstellungen momentan global in Lx-Office -vorgenommen wird und nicht nach Datenbank unterschieden werden -kann. Auch die Authentifizierungsdatenbank muss mit diesem Zeichensatz -angelegt worden sein. - -

-

- -nächstes: , -voriges: Datenbanken anlegen, -aufwärts: Benutzer- und Gruppenverwaltung - -
- -

8.3 Gruppen anlegen

- -

Eine Gruppe wird in der Gruppenverwaltung angelegt. Ihr muss ein Name -gegeben werden, eine Beschreibung ist hingegen optional. Nach dem -Anlegen können Sie die verschiedenen Bereiche wählen, auf die -Mitglieder dieser Gruppe Zugriff haben sollen. - -

Benutzergruppen sind unabhängig von Datenbanken, da sie in der -Authentifizierungsdatenbank gespeichert werden. Sie gelten für alle -Datenbanken, die in dieser Installation verwaltet werden. - -

-

- -nächstes: , -voriges: Gruppen anlegen, -aufwärts: Benutzer- und Gruppenverwaltung - -
- -

8.4 Benutzer anlegen

- -

Beim Anlegen von Benutzern werden für viele Parameter -Standardeinstellungen vorgenommen, die den Gepflogenheiten des -deutschen Raumes entsprechen. - -

Zwingend anzugeben sind der Loginname sowie die komplette -Datenbankkonfiguration. Wenn die Passwortauthentifizierung über die -Datenbank eingestellt ist, so kann hier auch das Benutzerpasswort -gesetzt bzw. geändert werden. Ist hingegen die LDAP-Authentifizierung -aktiv, so ist das Passwort-Feld deaktiviert. - -

In der Datenbankkonfiguration müssen die Zugriffsdaten einer der eben -angelegten Datenbanken eingetragen werden. - -

-

- -nächstes: , -voriges: Benutzer anlegen, -aufwärts: Benutzer- und Gruppenverwaltung - -
- -

8.5 Gruppenmitgliedschaften verwalten

- -

Nach dem Anlegen von Benutzern und Gruppen müssen Benutzer den Gruppen -zugewiesen werden. Dazu gibt es zwei Möglichkeiten: - -

    -
  1. In der Gruppenverwaltung wählt man eine Gruppe aus. Im folgenden -Dialog kann man dann einzeln die Benutzer der Gruppe hinzufügen. -
  2. In der Gruppenverwaltung wählt man das Tool zur Verwaltung der -Gruppenmitgliedschaft. Hier wird eine Matrix angezeigt, die alle im -System angelegten Gruppen und Benutzer enthält. Durch Setzen der -Häkchen wird der Benutzer in der ausgewählten Zeile der Gruppe in der -ausgewählten Spalte hinzugefügt. -
- -
-

- -voriges: Gruppenmitgliedschaften verwalten, -aufwärts: Benutzer- und Gruppenverwaltung - -
- -

8.6 Migration alter Installationen

- -

Wenn Lx-Office 2.6.2 über eine ältere Version installiert wird, in der -die Benutzerdaten noch im Dateisystem im Verzeichnis users -verwaltet wurden, so bietet Lx-Office die Möglichkeit, diese -Benutzerdaten automatisch in die Authentifizierungsdatenbank zu -übernehmen. Dies geschieht, wenn man sich nach dem Update der -Installation das erste Mal im Administrationsbereich anmeldet. Findet -Lx-Office die Datei users/members, so wird der -Migrationsprozess gestartet. - -

Der Migrationsprozess ist nahezu vollautomatisch. Alle Benutzerdaten -können übernommen werden. Nach den Benutzerdaten bietet Lx-Office noch -die Möglichkeit an, dass automatisch eine Benutzergruppe angelegt -wird. Dieser Gruppe wird Zugriff auf alle Funktionen von Lx-Office -gewährt. Alle migrierten Benutzern werden Mitglied in dieser -Gruppe. Damit wird das Verhalten von Lx-Office bis Version 2.4.3 -inklusive wiederhergestellt, und die Benutzer können sich sofort -wieder anmelden und mit dem System arbeiten. - - -

-

- - -nächstes: , -voriges: Benutzer- und Gruppenverwaltung, -aufwärts: Top - -
- -

9 Drucken mit Lx-Office

- -

Das Drucksystem von Lx-Office benutzt von Haus aus LaTeX Vorlagen. Um drucken -zu können, braucht der Server ein geeignetes LaTeX System. Am einfachsten ist -dazu eine texlive Installation. Unter Debianoiden Betriebssystemen sind -das die Pakete: - -

texlive-latex-base texlive-latex-extra texlive-fonts-recommended - -

Diese hinteren beiden enthalten Bibliotheken und Schriftarten die von den -Standardvorlagen verwendet werden. - -

TODO: rpm Pakete. - -

In den allermeisten Installationen sollte drucken jetzt schon funktionieren. -Sollte ein Fehler auftreten wirft TeX sehr lange Fehlerbeschreibungen, der -eigentliche Fehler ist immer die erste Zeite die mit einem Ausrufezeichen -anfängt. Häufig auftretende Fehler sind zum Beispiel: - -

    -
  • ! LaTeX Error: File `eurosym.sty' not found. -Die entsprechende LaTeX-Bibliothek wurde nicht gefunden. Das tritt vor allem -bei Vorlagen aus der Community auf. Installieren Sie die entsprechenden Pakete. -
  • ! Package inputenc Error: Unicode char \u8:桜 not set up for use with LaTeX. -Dieser Fehler tritt auf, wenn sie versuchen mit einer Standardinstallation -exotische utf8 Zeichen zu drucken. TeXLive unterstützt von Haus nur romanische -Schriften und muss mit diversen Tricks dazu gebracht werden andere Zeichen zu -akzeptieren. Adere TeX Systeme wie XeTeX schaffen hier Abhilfe. -
- -

Wird garkein Fehler angezeigt sondern nur der Name des Templates, heißt das -normalerweise, dass das LaTeX Binary nicht gefunden wurde. Prüfen Sie den Namen -in der Konfiguration (Standard: pdflatex), und stellen Sie sicher, dass -pdflatex (oder das von Ihnen verwendete System) vom Webserver ausgeführt werden -darf. - - -

-

- - -nächstes: , -voriges: Drucken mit Lx-Office, -aufwärts: Top - -
- -

10 OpenDocument-Vorlagen

- -

Lx-Office unterstützt die Verwendung von Vorlagen im -OpenDocument-Format, wie es OpenOffice.org ab Version 2 -erzeugt. Lx-Office kann dabei sowohl neue OpenDocument-Dokumente als -auch aus diesen direkt PDF-Dateien erzeugen. Um die Unterstützung von -OpenDocument-Vorlagen zu aktivieren muss in der Datei -config/lx_office.conf die Variable opendocument im -Abschnitt print_templates auf ‘1’ stehen. Dieses ist die -Standardeinstellung. - -

Weiterhin muss in der Datei config/lx_office.conf die Variable -dbcharset im Abschnitt system auf die Zeichenkodierung -gesetzt werden, die auch bei der Speicherung der Daten in der -Datenbank verwendet wird. Diese ist in den meisten Fällen "UTF-8". - -

Während die Erzeugung von reinen OpenDocument-Dateien keinerlei -weitere Software benötigt, wird zur Umwandlung dieser Dateien in PDF -OpenOffice.org benötigt. Soll dieses Feature genutzt werden, so muss -neben OpenOffice.org ab Version 2 auch der “X virtual frame buffer” -(xvfb) installiert werden. Bei Debian ist er im Paket “xvfb” -enthalten. Andere Distributionen enthalten ihn in anderen Paketen. - -

Nach der Installation müssen in der Datei config/lx_config.conf -zwei weitere Variablen angepasst werden: openofficeorg_writer -muss den vollständigen Pfad zur OpenOffice.org Writer-Anwendung -enthalten. xvfb muss den Pfad zum “X virtual frame buffer” -enthalten. Beide stehen im Abschnitt applications. - -

Zusätzlich gibt es zwei verschiedene Arten, wie Lx-Office mit -OpenOffice kommuniziert. Die erste Variante, die benutzt wird, wenn -die Variable $openofficeorg_daemon gesetzt ist, startet ein -OpenOffice, das auch nach der Umwandlung des Dokumentes gestartet -bleibt. Bei weiteren Umwandlungen wird dann diese laufende Instanz -benutzt. Der Vorteil ist, dass die Zeit zur Umwandlung deutlich -reduziert wird, weil nicht für jedes Dokument ein OpenOffice gestartet -werden muss. Der Nachteil ist, dass diese Methode Python und die -Python-UNO-Bindings benötigt, die Bestandteil von OpenOffice 2 sind. - -

Ist $openofficeorg_daemon nicht gesetzt, so wird für jedes -Dokument OpenOffice neu gestartet und die Konvertierung mit Hilfe -eines Makros durchgeführt. Dieses Makro muss in der Dokumentenvorlage -enthalten sein und “Standard.Conversion.ConvertSelfToPDF()” -heißen. Die Beispielvorlage ‘templates/mastertemplates/German/invoice.odt’ -enthält ein solches Makro, das in jeder anderen Dokumentenvorlage -ebenfalls enthalten sein muss. - -

Als letztes muss herausgefunden werden, welchen Namen OpenOffice.org -Writer dem Verzeichnis mit den Benutzereinstellungen gibt. Unter -Debian ist dies momentan ~/.openoffice.org2. Sollte der Name -bei Ihrer OpenOffice.org-Installation anders sein, so muss das -Verzeichnis users/.openoffice.org2 entsprechend umbenannt -werden. Ist der Name z.B. einfach nur .openoffice, so wäre -folgender Befehl auszuführen: - -

mv users/.openoffice.org2 users/.openoffice - -

Dieses Verzeichnis, wie auch das komplette users-Verzeichnis, muss vom -Webserver beschreibbar sein. Dieses wurde bereits erledigt -(siehe Manuelle Installation des Programmpaketes), kann aber erneut überprüft -werden, wenn die Konvertierung nach PDF fehlschlägt. - - -

-

- - -voriges: OpenDocument-Vorlagen, -aufwärts: Top - -
- -

11 Lx-Office ERP verwenden

- -

Nach erfolgreicher Installation ist der Loginbildschirm unter -folgender URL erreichbar: - -

http://localhost/lx-office-erp/login.pl - -

Die Administrationsseite erreichen Sie unter: - -

http://localhost/lx-office-erp/admin.pl - - - - diff --git a/doc/INSTALL.texi b/doc/INSTALL.texi deleted file mode 100644 index 785f25cdf..000000000 --- a/doc/INSTALL.texi +++ /dev/null @@ -1,926 +0,0 @@ -\input texinfo @c -*-texinfo-*- -@c %**start of header -@setfilename INSTALL.info -@documentencoding UTF-8 -@afourpaper -@settitle Lx-Office Installationsanleitung -@c %**end of header - -@c @copying -@c Die Lx-Office Installationsanleitung kann beliebig weiter verwendet -@c werden. -@c @end copying - -@titlepage -@title Lx-Office Installationsanleitung -@end titlepage - -@contents - -@ifnottex -@node Top -@top Inhalt der Anleitung -@end ifnottex - -@menu -* Aktuelle Hinweise:: Andere Informationsquellen als diese Anleitung -* Benötigte Software und Pakete:: Vorraussetzungen zum Betrieb von Lx-Office -* Manuelle Installation des Programmpaketes:: Installationsort, Berechtigungen -* Anpassung der PostgreSQL-Konfiguration:: Verschiedene Aspekte der Datenbankkonfiguration -* Apache-Konfiguration:: Einrichtung eines Aliases und Optionen für das Ausführen von CGI-Scripten -* Der Task-Server:: Konfiguration und Einrichtung des Task-Server-Dämonen -* Benutzerauthentifizierung und Administratorpasswort:: Einrichtung der Authentifizierungsdatenbank und der Passwortüberprüfung -* Benutzer- und Gruppenverwaltung:: Einrichten von Benutzern, Gruppen und Datenbanken -* Drucken mit Lx-Office:: Voraussetzungen, Einrichtung und Fehlerdiagnose -* OpenDocument-Vorlagen:: Wichtige Hinweise zum Erstellen und zur Verwendung von Dokumentenvorlagen -* Lx-Office ERP verwenden:: Die URLs zur Anmeldung und Administration -@end menu - -@c --------------------------------------------------------------- - -@node Aktuelle Hinweise -@chapter Aktuelle Hinweise - -Aktuelle Installations- und Konfigurationshinweise gibt es: - -@itemize -@item -auf der Lx-Office Homepage unter @uref{http://lx-office.org/index.php?id=dokumentation} - -@item -im Lx-Office-Wiki unter Dokumentation (@uref{http://wiki.lx-office.org/index.php/Lx-Office_ERP}) - -@item -im Lx-Office-Forum: @uref{http://www.lx-office.org/forum/} -@end itemize - -@c --------------------------------------------------------------- - -@node Benötigte Software und Pakete -@chapter Benötigte Software und Pakete - -@menu -* Betriebssystem:: Unterstützte Betriebsysteme und Hinweise für ältere Systeme -* Pakete:: Benötigte Software und Perlpakete sowie deren Quellen -@end menu - -@node Betriebssystem -@section Betriebssystem - -Lx-Office ist für Linux konzipiert, und sollte auf jedem unixoiden -Betriebssystem zum Laufen zu kriegen sein. Getestet ist diese Version im -speziellen auf Debian und Ubuntu, grundsätzlich wurde bei der Auswahl der -Pakete aber darauf Rücksicht genommen, dass es ohne große Probleme auf den -derzeit aktuellen verbreiteten Distributionen läuft. - -Anfang 2011 sind das folgende Systeme: - -@itemize -@item -Ubuntu 8.04 LTS Hardy Heron -@item -Ubuntu 9.10 Karmic Koala -@item -Ubuntu 10.04 Lucid Lynx -@item -Ubuntu 10.10 Maverick Meerkat -@item -Debian 5.0 Lenny -@item -Debian 6.0 Squeeze -@item -openSUSE 11.2 -@item -openSUSE 11.3 -@item -SuSE Linux Enterprice Server 11 -@item -Fedora 13 -@item -Fedora 14 -@end itemize - -Für die debianoiden Betriebssysteme existiert ein .deb, das deutlich einfacher -zu installieren ist. - -Ubuntu 8.04 LTS hat zusätzlich die Schwierigkeit, dass die Module im Archiv -recht alt sind, und das viele der benötigten Module nicht einfach zu -installieren sind. Dafür sollte es kurz nach dem Release ein eigenes .deb -geben. - -Alternativ dazu kann die normale Installation durchgeführt werden -(@pxref{Manuelle Installation des Programmpaketes}), wenn vorher ein -Kompatibilitätspaket installiert wird, das die fehlenden Pakete bereitstellt. -Das Paket ist auf @uref{https://sourceforge.net/projects/lx-office/files/Lx-Office%20ERP/2.6.2/, Sourceforge} unter dem Namen @code{lx-erp-perl-libs-compat-v2.tar.gz} hinterlegt. - -Zur Installation das Paket in das entpackte Lx-Office Verzeichnis entpacken: - -@code{tar xzf lx-erp-perl-libs-compat-v2.tar.gz /path/to/lx-office/} - -Zusätzlich müssen dann noch die folgenden Pakete installiert weerden - -@code{libbit-vector-perl libsub-exporter-perl libclone-perl libclass-factory-util-perl} - -Danach sollte der Installationscheck (@pxref{Pakete}) die enthaltenen Pakete erkennen. - -@node Pakete -@section Pakete - -Zum Betrieb von Lx-Office werden zwingend ein Webserver (meist Apache) -und ein Datenbankserver (PostgreSQL, mindestens v8.2) benötigt. - -Zusätzlich benötigt Lx-Office die folgenden Perl-Pakete, die nicht Bestandteil -einer Standard-Perl-Installation sind: - -@itemize -@item -parent -@item -Archive::Zip -@item -Config::Std -@item -DateTime -@item -DBI -@item -DBD::Pg -@item -Email::Address -@item -JSON -@item -List::MoreUtils -@item -Params::Validate -@item -PDF::API2 -@item -Rose::Object -@item -Rose::DB -@item -Rose::DB::Object -@item -Template -@item -Text::CSV_XS -@item -Text::Iconv -@item -URI -@item -XML::Writer -@item -YAML -@end itemize - -Gegenüber Version 2.6.0 sind zu dieser Liste 2 Pakete hinzugekommen, @code{URI} -und @code{XML::Writer} sind notwendig. Ohne startet Lx-Office nicht. - -Gegenüber Version 2.6.1 sind @code{parent}, @code{DateTime}, -@code{Rose::Object}, @code{Rose::DB} und @code{Rose::DB::Object} neu -hinzugekommen. @code{IO::Wrap} wurde entfernt. - -Gegenüber Version 2.6.3 ist @code{JSON} neu hinzugekommen. - -@code{Email::Address} und @code{List::MoreUtils} sind schon länger feste -Abhängigkeiten, wurden aber bisher mit Lx-Office mitgeliefert. Beide sind auch -in 2.6.1 weiterhin mit ausgeliefert, wurden in einer zukünftigen Version aber -aus dem Paket entfernt werden. Es wird empfohlen diese Module zusammen mit den -anderen als Bibliotheken zu installieren. - -Die zu installierenden Pakete können in den verschiedenen Distributionen unterschiedlich heißen. - -Für Debian oder Ubuntu benötigen Sie diese Pakete: - -@code{apache2 postgresql libparent-perl libarchive-zip-perl libdatetime-perl libdbi-perl libdbd-pg-perl libpg-perl libemail-address-perl liblist-moreutils-perl libpdf-api2-perl librose-object-perl librose-db-perl librose-db-object-perl libtemplate-perl libtext-csv-xs-perl libtext-iconv-perl liburi-perl libxml-writer-perl libyaml-perl libconfig-std-perl libparams-validate-perl libjson-perl} - -Für Fedora Core benötigen Sie diese Pakete: - -@code{httpd postgresql-server perl-parent perl-DateTime perl-DBI perl-DBD-Pg perl-Email-Address perl-List-MoreUtils perl-PDF-API2 perl-Rose-Object perl-Rose-DB perl-Rose-DB-Object perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv perl-URI perl-XML-Writer perl-YAML} - -Für OpenSuSE benötigen Sie diese Pakete: - -@code{apache2 postgresql-server perl-Archive-Zip perl-DateTime perl-DBI perl-DBD-Pg perl-MailTools perl-List-MoreUtils perl-PDF-API2 perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv perl-URI perl-XML-Writer perl-YAML} - -Bei openSuSE 11 ist @code{parent} bereits enthalten, und braucht nicht nachinstalliert werden. Die @code{Rose::*} Pakete sind derzeit nicht für SuSE gepackt, und müssen anderweitig nachinstalliert werden. - -Lx-Office enthält ein Script, mit dem überprüft werden kann, ob alle -benötigten Perl-Module installiert sind. Der Aufruf lautet wie folgt: - -@code{./scripts/installation_check.pl} - -@c --------------------------------------------------------------- - -@node Manuelle Installation des Programmpaketes -@chapter Manuelle Installation des Programmpaketes - -Die Lx-Office ERP Installationsdatei (lxoffice-erp-2.6.2.tgz) wird im -Dokumentenverzeichnis des Webservers (z.B. @code{/var/www/html/}, -@code{/srv/www/htdocs} oder @code{/var/www/}) entpackt: - -@code{cd /var/www -@* -tar xvzf lxoffice-erp-2.6.2.tgz} - -Verändern Sie evtl. noch den Namen des Verzeichnisses mit - -@code{mv lxoffice-erp/ lx-erp/} - -Alternativ können Sie auch einen Alias in der Webserverkonfiguration -benutzen, um auf das tatsächliche Installationsverzeichnis zu -verweisen. - -Die Verzeichnisse @code{users}, @code{spool} und @code{webdav} müssen -für den Benutzer beschreibbar sein, unter dem der Webserver läuft. Die -restlichen Dateien müssen für diesen Benutzer lesbar sein. Der -Benutzername ist bei verschiedenen Distributionen unterschiedlich -(z.B. bei Debian/Ubuntu @code{www-data}, bei Fedora core @code{apache} -oder bei OpenSuSE @code{wwwrun}). - -Der folgende Befehl ändert den Besitzer für die oben genannten -Verzeichnisse auf einem Debian/Ubuntu-System: - -@code{chown -R www-data lx-office-erp/users lx-office-erp/spool lx-office-erp/webdav} - -Weiterhin muss der Webserver-Benutzer im Verzeichnis @code{templates} Verzeichnisse für -jeden neuen Benutzer, der in lx-office angelegt wird, anlegen dürfen: - -@code{chgrp www-data lx-office-erp/templates; chmod g+w lx-office-erp/templates} - - -@c --------------------------------------------------------------- - -@node Anpassung der PostgreSQL-Konfiguration -@chapter Anpassung der PostgreSQL-Konfiguration - -PostgreSQL muss auf verschiedene Weisen angepasst werden. - -@menu -* Zeichensätze/die Verwendung von UTF-8:: Was bei der Verwendung von UTF-8 zu beachten ist -* Änderungen an Konfigurationsdateien:: Anpassungen für Anmeldung am Server und Featureunterstützung -* Erweiterung für servergespeicherte Prozeduren:: Lx-Office benutzt servergespeicherte Prozeduren -* Datenbankbenutzer anlegen:: Um den Zugriff besser zu reglementieren -@end menu - -@node Zeichensätze/die Verwendung von UTF-8 -@section Zeichensätze/die Verwendung von UTF-8 - -Lx-Office kann komplett mit UTF-8 als Zeichensatz verwendet -werden. Dabei gibt es zwei Punkte zu beachten: PostgreSQL muss in -Version 8.0 oder neuer benutzt werden, und der -PostgreSQL-Datenbankcluster muss ebenfalls mit UTF-8 als Locale -angelegt worden sein. - -Dieses ist kann überprüft werden: ist das Encoding der Datenbank -``template1'' ``UTF8'', so kann auch Lx-Office mit UTF-8 betrieben -werden. Andernfalls ist es notwendig, einen neuen Datenbankcluster mit -UTF-8-Encoding anzulegen und diesen zu verwenden. Unter Debian und -Ubuntu kann dies z.B. mit dem folgenden Befehl getan werden: - -@code{pg_createcluster --locale=de_DE.UTF-8 --encoding=UTF-8 8.2 clustername} - -Die Datenbankversionsnummer muss an die tatsächlich verwendete -Versionsnummer angepasst werden. - -Unter anderen Distributionen gibt es ähnliche Methoden. - -Wurde PostgreSQL nicht mit UTF-8 als Encoding initialisiert und ist -ein Neuanlegen eines weiteren Clusters nicht möglich, so kann -Lx-Office mit ISO-8859-15 als Encoding betrieben werden. - -Das Encoding einer Datenbank kann in @code{psql} mit @code{\l} geprüft werden. - -@node Änderungen an Konfigurationsdateien -@section Änderungen an Konfigurationsdateien - -In der Datei @code{postgresql.conf}, die je nach Distribution in -verschiedenen Verzeichnissen liegen kann -(z.B. @code{/var/lib/pgsql/data/} oder @code{/etc/postgresql/}, muss -sichergestellt werden, dass TCP/IP-Verbindungen aktiviert sind. Das -Verhalten wird über den Parameter @code{listen_address} -gesteuert. Laufen PostgreSQL und Lx-Office auf demselben Rechner, so -kann dort der Wert @code{localhost} verwendet werden. Andernfalls -müssen Datenbankverbindungen auch von anderen Rechnern aus zugelassen -werden, was mit dem Wert \@code{*} geschieht. - -In der Datei @code{pg_hba.conf}, die im gleichen Verzeichnis wie die -@code{postgresql.conf} zu finden sein sollte, müssen die -Berichtigungen für den Zugriff geändert werden. Hier gibt es mehrere -Möglichkeiten. Eine besteht darin, lokale Verbindungen immer -zuzulassen - -@code{local all all trust -@* -host all all 127.0.0.1 255.0.0.0 trust} - -Besser ist es, für eine bestimmte Datenbank Zugriff nur per Passwort -zuzulassen. Beispielsweise: - -@code{local all lxoffice password -@* -host all lxoffice 127.0.0.1 255.255.255.255 password} - -@c --------------------------------------------------------------- - -@node Erweiterung für servergespeicherte Prozeduren -@section Erweiterung für servergespeicherte Prozeduren - -In der Datenbank @code{template1} muss die Unterstützung für servergespeicherte -Prozeduren eingerichet werden. Melden Sie sich dafür als Benutzer ``postgres'' -an der Datenbank an, und führen Sie die folgenden Kommandos aus: - -@code{create language 'plpgsql';} - -Achtung: In älteren Postgresversionen (vor 8.0) muss der Handler für die -Sprache manuell anlelegt werden, diese Versionen werden aber nicht mehr -offiziell von Lx-Office unterstützt. Dafür dann die folgenden Kommandos: - -@code{create function plpgsql_call_handler () returns opaque as '/usr/lib/pgsql/plpgsql.so' language 'c'; -@* -create language 'plpgsql' handler plpgsql_call_handler lancompiler 'pl/pgsql';} - -Bitte beachten Sie, dass der Pfad zur Datei @code{plpgsql.so} von Distribution -zu Distribution verschiedlich sein kann. Bei Debian/Ubuntu befindet sie sich -unter @code{/usr/lib/postgresql/lib/plpgsql.so}. - -@c --------------------------------------------------------------- - -@node Datenbankbenutzer anlegen -@section Datenbankbenutzer anlegen - -Wenn Sie nicht den Datenbanksuperuser ``postgres'' zum Zugriff -benutzen wollen, so sollten Sie bei PostgreSQL einen neuen Benutzer -anlegen. Ein Beispiel, wie Sie einen neuen Benutzer anlegen können: - -@code{su - postgres -@* -createuser -d -P lxoffice} - -Wenn Sie später einen Datenbankzugriff konfigurieren, verändern Sie -den evtl. voreingestellten Benutzer ``postgres'' auf ``lxoffice'' -bzw. den hier gewählten Benutzernamen. - -@c --------------------------------------------------------------- - -@node Apache-Konfiguration -@chapter Apache-Konfiguration - -Hinweis: Für einen deutlichen Performanceschub sorgt die Ausführung -mittels FCGI. Die Einrichtung wird ausführlich in der Datei -@code{INSTALL.fcgi} beschrieben. - -Der Zugriff auf das Programmverzeichnis muss in der Apache -Webserverkonfigurationsdatei @code{httpd.conf} eingestellt -werden. Fügen Sie den folgenden Abschnitt dieser Datei oder einer -anderen Datei hinzu, die beim Starten des Webservers eingelesen wird: - -@code{@* -AddHandler cgi-script .pl -@* -Alias /lx-erp/ /var/www/lx-erp/ -@* - -@* - Options ExecCGI Includes FollowSymlinks -@* - -@* -@* - -@* - Order Deny,Allow -@* - Deny from All -@* - -@* -} - -Ersetzen Sie dabei die Pfade durch diejenigen, in die Sie vorher das -Lx-Office-Archiv entpacket haben. - -Achtung: Vor den einzelnen Optionen muss bei einigen Distributionen ein -Plus @samp{+} gesetzt werden. - -Auf einigen Webservern werden manchmal die Grafiken und Style-Sheets -nicht ausgeliefert. In solchen Fällen hat es oft geholfen, die -folgende Option in die Konfiguration aufzunehmen: - -@code{EnableSendfile Off} - -@c --------------------------------------------------------------- - -@node Der Task-Server -@chapter Der Task-Server - -Der Task-Server ist ein Prozess, der im Hintergrund läuft, in -regelmäßigen Abständen nach abzuarbeitenden Aufgaben sucht und diese -zu festgelegten Zeitpunkten abarbeitet (ähnlich wie Cron). Dieser -Prozess wird bisher nur für die Erzeugung der wiederkehrenden -Rechnungen benutzt, wird aber in Zukunft deutlich mehr Aufgaben -übertragen bekommen. - -@menu -* Konfiguration des Task-Servers:: Verfügbare und notwendige Konfigurationsoptionen -* Prozesskontrolle:: Wie der Task-Server gestartet und beendet wird -* Einbinden in den Boot-Prozess:: Automatisches Starten des Task-Servers beim Booten -@end menu - -@node Konfiguration des Task-Servers -@section Verfügbare und notwendige Konfigurationsoptionen - -Die Konfiguration erfolgt über den Abschnitt @code{[task_server]} in -der Datei @file{config/lx_office.conf}. Die dort verfügbaren Optionen -sind: - -@itemize -@item @code{login}: gültiger Lx-Office-Benutzername, der benutzt wird, um die zu verwendende Datenbankverbindung auszulesen. Der Benutzer muss in der Administration angelegt werden. Diese Option muss angegeben werden. -@item @code{run_as}: Wird der Server vom Systembenutzer @code{root} gestartet, so wechselt er auf den mit @code{run_as} angegebenen Systembenutzer. Der Systembenutzer muss dieselben Lese- und Schreibrechte haben, wie auch der Webserverbenutzer (siehe @pxref{Manuelle Installation des Programmpaketes}). Daher ist es sinnvoll, hier denselben Systembenutzer einzutragen, unter dem auch der Webserver läuft. -@item @code{debug}: Schaltet Debug-Informationen an und aus. -@end itemize - -@node Einbinden in den Boot-Prozess -@section Automatisches Starten des Task-Servers beim Booten - -Der Task-Server verhält sich von seinen Optionen her wie ein reguläres -SystemV-kompatibles Boot-Script. Außerdem wechselt er beim Starten -automatisch in das Lx-Office-Installationsverzeichnis. - -Deshalb ist es möglich, ihn durch Setzen eines symbolischen Links aus -einem der Runlevel-Verzeichnisse heraus in den Boot-Prozess -einzubinden. Da das bei neueren Linux-Distributionen aber nicht -zwangsläufig funktioniert, werden auch Start-Scripte mitgeliefert, die -anstelle eines symbolischen Links verwendet werden können. - -@subsection SystemV-basierende Systeme (z.B. Debian, OpenSuSE, Fedora Core) - -Kopieren Sie die Datei -@file{scripts/boot/system-v/lx-office-task-server} nach -@file{/etc/init.d/lx-office-task-server}. Passen Sie in der kopierten -Datei den Pfad zum Task-Server an (Zeile @code{DAEMON=....}). Binden -Sie das Script in den Boot-Prozess ein. Dies ist distributionsabhängig: - -@itemize -@item Debian-basierende Systeme: -@* -@code{update-rc.d lx-office-task-server defaults -@* -# Nur bei Debian Squeeze und neuer: -@* -insserv lx-office-task-server} -@item OpenSuSE und Fedora Core: -@* -@code{chkconfig --add lx-office-task-server} -@end itemize - -Danach kann der Task-Server mit dem folgenden Befehl gestartet werden: -@code{/etc/init.d/lx-office-task-server start} - -@subsection Upstart-basierende Systeme (z.B. Ubuntu) - -Kopieren Sie die Datei -@file{scripts/boot/upstart/lx-office-task-server.conf} nach -@file{/etc/init/lx-office-task-server.conf}. Passen Sie in der kopierten -Datei den Pfad zum Task-Server an (Zeile @code{exec ....}). - -Danach kann der Task-Server mit dem folgenden Befehl gestartet werden: -@code{service lx-office-task-server start} - -@node Prozesskontrolle -@section Wie der Task-Server gestartet und beendet wird - -Der Task-Server wird wie folgt kontrolliert: - -@code{./scripts/task_server.pl Befehl} - -@code{Befehl} ist dabei eine der folgenden Optionen: - -@itemize -@item @code{start} startet eine neue Instanz des Task-Servers. Die Prozess-ID wird innerhalb des @file{users}-Verzeichnisses abgelegt. -@item @code{stop} beendet einen laufenden Task-Server. -@item @code{restart} beendet und startet ihn neu. -@item @code{status} berichtet, ob der Task-Server läuft. -@end itemize - -Der Task-Server wechselt beim Starten automatisch in das Lx-Office-Installationsverzeichnis. - -Dieselben Optionen können auch für die SystemV-basierenden -Runlevel-Scripte benutzt werden (siehe oben). - -@c --------------------------------------------------------------- - -@node Benutzerauthentifizierung und Administratorpasswort -@chapter Benutzerauthentifizierung und Administratorpasswort - -Informationen über die Einrichtung der Benutzerauthentifizierung, über -die Verwaltung von Gruppen und weitere Einstellungen - -@menu -* Grundlagen zur Benutzerauthentifizierung:: Verfügbare Methoden, Name der Konfigurationsdatei -* Administratorpasswort:: Wo das Administratorpasswort gesetzt werden kann -* Authentifizierungsdatenbank:: Verbindungseinstellungen zur Authentifizierungsdatenbank -* Passwortüberprüfung:: Einstellungen zur Überprüfung der Benutzerpasswörter -* Name des Session-Cookies:: Ändern des Cookie-Namens bei Verwendung mehrerer Lx-Office-Installationen auf einem Server -* Anlegen der Authentifizierungsdatenbank:: Wie die Authentifizierungsdatenbank angelegt wird -@end menu - -@c --------------------------------------------------------------- - -@node Grundlagen zur Benutzerauthentifizierung -@section Grundlagen zur Benutzerauthentifizierung - -Lx-Office verwaltet die Benutzerinformationen in einer Datenbank, die -im folgenden ``Authentifizierungsdatenbank'' genannt wird. Für jeden -Benutzer kann dort eine eigene Datenbank für die eigentlichen -Finanzdaten hinterlegt sein. Diese beiden Datenbanken können, müssen -aber nicht unterschiedlich sein. - -Im einfachsten Fall gibt es für Lx-Office nur eine einzige Datenbank, -in der sowohl die Benutzerinformationen als auch die Daten abgelegt -werden. - -Zusätzlich ermöglicht es Lx-Office, dass die Benutzerpasswörter -entweder gegen die Authentifizierungsdatenbank oder gegen einen -LDAP-Server überprüft werden. - -Welche Art der Passwortüberprüfung Lx-Office benutzt und wie Lx-Office -die Authentifizierungsdatenbank erreichen kann, wird in der -Konfigurationsdatei @file{config/lx_office.conf} festgelegt. Diese -muss bei der Installation und bei einem Upgrade von einer Version vor -v2.6.0 angelegt werden. Eine Beispielkonfigurationsdatei -@file{config/lx_office.conf.default} existiert, die als Vorlage -benutzt werden kann. - -@node Administratorpasswort -@section Administratorpasswort - -Das Passwort, das zum Zugriff auf das Aministrationsinterface benutzt wird, -wird ebenfalls in dieser Datei gespeichert. Es kann auch nur dort und nicht -mehr im Administrationsinterface selber geändert werden. Der Parameter dazu -heißt @code{$self->@{admin_password@}}. - -@node Authentifizierungsdatenbank -@section Authentifizierungsdatenbank - -Die Verbindung zur Authentifizierungsdatenbank wird mit den Parametern -in @code{$self->@{DB_config@}} konfiguriert. Hier sind die folgenden -Parameter anzugeben: - -@itemize -@item -@samp{host} -- Der Rechnername oder die IP-Adresse des Datenbankservers -@item -@samp{port} -- Die Portnummer des Datenbankservers, meist 5432 -@item -@samp{db} -- Der Name der Authentifizierungsdatenbank -@item -@samp{user} -- Der Benutzername, mit dem sich Lx-Office beim Datenbankserver anmeldet (z.B. ``postgres'') -@item -@samp{password} -- Das Passwort für den Datenbankbenutzer -@end itemize - -Die Datenbank muss noch nicht existieren. Lx-Office kann sie -automatisch anlegen (mehr dazu siehe unten). - -@node Passwortüberprüfung -@section Passwortüberprüfung - -Lx-Office unterstützt Passwortüberprüfung auf zwei Arten: gegen die -Authentifizierungsdatenbank und gegen einen externen LDAP- oder -Active-Directory-Server. Welche davon benutzt wird, regelt der -Parameter @code{$self->@{module@}}. - -Sollen die Benutzerpasswörter in der Authentifizierungsdatenbank -gespeichert werden, so muss der Parameter @code{$self->@{module@}} den -Wert @samp{DB} enthalten. In diesem Fall können sowohl der -Administrator als auch die Benutzer selber ihre Psaswörter in -Lx-Office ändern. - -Soll hingegen ein externer LDAP- oder Active-Directory-Server benutzt -werden, so muss der Parameter @code{$self->@{module@}} auf @samp{LDAP} -gesetzt werden. In diesem Fall müssen zusätzliche Informationen über -den LDAP-Server in @code{$self->@{LDAP_config@}} angegeben werden: - -@itemize -@item -@samp{host} -- Der Rechnername oder die IP-Adresse des LDAP- oder Active-Directory-Servers. Diese Angabe ist zwingend erforderlich. -@item -@samp{port} -- Die Portnummer des LDAP-Servers; meist 389. -@item -@samp{tls} -- Wenn Verbindungsverschlüsselung gewünscht ist, so diesen Wert auf @samp{1} setzen, andernfalls auf @samp{0} belassen -@item -@samp{attribute} -- Das LDAP-Attribut, in dem der Benutzername steht, den der Benutzer eingegeben hat. Für Active-Directory-Server - ist dies meist @samp{sAMAccountName}, für andere LDAP-Server hingegen @samp{uid}. Diese Angabe ist zwingend erforderlich. -@item -@samp{base_dn} -- Der Abschnitt des LDAP-Baumes, der durchsucht werden soll. Diese Angabe ist zwingend erforderlich. -@item -@samp{filter} -- Ein optionaler LDAP-Filter. Enthält dieser Filter das Wort @code{<%login%>}, so wird dieses durch den vom Benutzer - eingegebenen Benutzernamen ersetzt. Andernfalls wird der LDAP-Baum nach einem Element durchsucht, bei dem das oben angegebene Attribut - mit dem Benutzernamen identisch ist. -@item -@samp{bind_dn} und @samp{bind_password} -- Wenn der LDAP-Server eine Anmeldung erfordert, bevor er durchsucht werden kann (z.B. ist dies bei - Active-Directory-Servern der Fall), so kann diese hier angegeben werden. Für Active-Directory-Server kann als @samp{bind_dn} entweder eine - komplette LDAP-DN wie z.B. @samp{cn=Martin Mustermann,cn=Users,dc=firmendomain} auch nur der volle Name des Benutzers - eingegeben werden; in diesem Beispiel also @samp{Martin Mustermann}. -@end itemize - -@node Name des Session-Cookies -@section Name des Session-Cookies - -Sollen auf einem Server mehrere Lx-Office-Installationen aufgesetzt -werden, so müssen die Namen der Session-Cookies für alle -Installationen unterschiedlich sein. Der Name des Cookies wird mit dem -Parameter @code{$self->@{cookie_name@}} gesetzt. - -Diese Angabe ist optional, wenn nur eine Installation auf dem Server -existiert. - -@node Anlegen der Authentifizierungsdatenbank -@section Anlegen der Authentifizierungsdatenbank - -Nachdem alle Einstellungen in @file{config/lx_office.conf} -vorgenommen wurden, muss Lx-Office die Authentifizierungsdatenbank -anlegen. Dieses geschieht automatisch, wenn Sie sich im -Administrationsmodul anmelden, das unter der folgenden URL erreichbar -sein sollte: - -@uref{http://localhost/lx-erp/admin.pl} - - -@c --------------------------------------------------------------- - -@node Benutzer- und Gruppenverwaltung -@chapter Benutzer- und Gruppenverwaltung - -Nach der Installation müssen Benutzer, Gruppen und Datenbanken -angelegt werden. Dieses geschieht im Administrationsmenü, das Sie -unter folgender URL finden: - -@uref{http://localhost/lx-erp/admin.pl} - -Verwenden Sie zur Anmeldung das Password, dass Sie in der Datei -@file{config/lx_office.conf} eingetragen haben. - -@menu -* Zusammenhänge:: Übersicht über Benutzer, Gruppen, Berechtigungen und Datenbanken -* Datenbanken anlegen:: Hinweise zum Anlegen von Datenbanken -* Gruppen anlegen:: Hinweise zum Anlegen von Gruppen -* Benutzer anlegen:: Hinweise zum Anlegen von Benutzern -* Gruppenmitgliedschaften verwalten:: Wie man Gruppen Benutzer zuordnet -* Migration alter Installationen:: Automatische Übernahme bei Update von einer älteren Version -@end menu - -@node Zusammenhänge -@section Zusammenhänge - -Lx-Office verwendet eine Datenbank zum Speichern all seiner -Informationen wie Kundendaten, Artikel, Angebote, Rechnungen etc. Um -mit Lx-Office arbeiten zu können, muss eine Person einen -Benutzeraccount haben. Jedem Benutzeraccount wiederum wird genau eine -Datenbank zugewiesen, mit der dieser Benutzer arbeiten kann. Es ist -möglich und normal, dass mehreren Benutzern die selbe Datenbank -zugewiesen wird, sodass sie alle mit den selben Daten arbeiten können. - -Die Basisdaten der Benutzer, die in der Administration eingegeben -werden können, werden in einer zweiten Datenbank gespeichert, der -bereits erwähnten Authentifizierungsdatenbank. Diese ist also den -Produktivdaten enthaltenden Datenbanken vorgeschaltet. Pro -Lx-Office-Installation gibt es nur eine Authentifizierungsdatenbank, -aber beliebig viele Datenbanken mit Firmendaten. - -Lx-Office kann seinen Benutzern Zugriff auf bestimmte -Funktionsbereiche erlauben oder verbieten. Wird der Zugriff nicht -gestattet, so werden der entsprechenden Menüpunkte auch nicht -angezeigt. Diese Rechte werden ebenfalls in der -Authentifizierungsdatenbank gespeichert. - -Um Rechte verteilen zu können, verwendet Lx-Office ein -Gruppen-Prinzip. Einer Gruppe kann der Zugriff auf bestimmte Bereiche -erlaubt werden. Ein Benutzer wiederum kann Mitglied in einer oder -mehrerer Gruppen sein. Der Benutzer hat Zugriff auf alle diejenigen -Funktionen, die mindestens einer Gruppe erlaubt sind, in der der -Benutzer Mitglied ist. - -Die allgemeine Reihenfolge, in der Datenbanken, Gruppen und Benutzer -angelegt werden sollten, lautet: - -@enumerate -@item -Datenbank anlegen -@item -Gruppen anlegen -@item -Benutzer anlegen -@item -Benutzer den Gruppen zuordnen -@end enumerate - -@node Datenbanken anlegen -@section Datenbanken anlegen - -Zuerst muss eine Datenbank angelegt werden. Verwenden Sie für den -Datenbankzugriff den vorhin angelegten Benutzer (in unseren Beispielen -ist dies @samp{lxoffice}). - -Wenn Sie für die Lx-Office-Installation nicht den europäischen -Schriftsatz ISO-8859-15 sondern UTF-8 (Unicode) benutzen wollen, so -müssen Sie vor dem Anlegen der Datenbank in der Datei -@file{config/lx_office.conf} die Variable @code{dbcharset} im -Abschnitt @code{system} auf den Wert @samp{UTF-8} setzen. Zusätzlich -muss beim Anlegen der Datenbank @samp{UTF-8 Unicode} als Schriftsatz -ausgewählt werden. - -Bitte beachten Sie, dass alle Datenbanken den selben Zeichensatz -verwenden müssen, da diese Einstellungen momentan global in Lx-Office -vorgenommen wird und nicht nach Datenbank unterschieden werden -kann. Auch die Authentifizierungsdatenbank muss mit diesem Zeichensatz -angelegt worden sein. - -@node Gruppen anlegen -@section Gruppen anlegen - -Eine Gruppe wird in der Gruppenverwaltung angelegt. Ihr muss ein Name -gegeben werden, eine Beschreibung ist hingegen optional. Nach dem -Anlegen können Sie die verschiedenen Bereiche wählen, auf die -Mitglieder dieser Gruppe Zugriff haben sollen. - -Benutzergruppen sind unabhängig von Datenbanken, da sie in der -Authentifizierungsdatenbank gespeichert werden. Sie gelten für alle -Datenbanken, die in dieser Installation verwaltet werden. - -@node Benutzer anlegen -@section Benutzer anlegen - -Beim Anlegen von Benutzern werden für viele Parameter -Standardeinstellungen vorgenommen, die den Gepflogenheiten des -deutschen Raumes entsprechen. - -Zwingend anzugeben sind der Loginname sowie die komplette -Datenbankkonfiguration. Wenn die Passwortauthentifizierung über die -Datenbank eingestellt ist, so kann hier auch das Benutzerpasswort -gesetzt bzw. geändert werden. Ist hingegen die LDAP-Authentifizierung -aktiv, so ist das Passwort-Feld deaktiviert. - -In der Datenbankkonfiguration müssen die Zugriffsdaten einer der eben -angelegten Datenbanken eingetragen werden. - -@node Gruppenmitgliedschaften verwalten -@section Gruppenmitgliedschaften verwalten - -Nach dem Anlegen von Benutzern und Gruppen müssen Benutzer den Gruppen -zugewiesen werden. Dazu gibt es zwei Möglichkeiten: - -@enumerate -@item -In der Gruppenverwaltung wählt man eine Gruppe aus. Im folgenden -Dialog kann man dann einzeln die Benutzer der Gruppe hinzufügen. -@item -In der Gruppenverwaltung wählt man das Tool zur Verwaltung der -Gruppenmitgliedschaft. Hier wird eine Matrix angezeigt, die alle im -System angelegten Gruppen und Benutzer enthält. Durch Setzen der -Häkchen wird der Benutzer in der ausgewählten Zeile der Gruppe in der -ausgewählten Spalte hinzugefügt. -@end enumerate - -@node Migration alter Installationen -@section Migration alter Installationen - -Wenn Lx-Office 2.6.2 über eine ältere Version installiert wird, in der -die Benutzerdaten noch im Dateisystem im Verzeichnis @code{users} -verwaltet wurden, so bietet Lx-Office die Möglichkeit, diese -Benutzerdaten automatisch in die Authentifizierungsdatenbank zu -übernehmen. Dies geschieht, wenn man sich nach dem Update der -Installation das erste Mal im Administrationsbereich anmeldet. Findet -Lx-Office die Datei @code{users/members}, so wird der -Migrationsprozess gestartet. - -Der Migrationsprozess ist nahezu vollautomatisch. Alle Benutzerdaten -können übernommen werden. Nach den Benutzerdaten bietet Lx-Office noch -die Möglichkeit an, dass automatisch eine Benutzergruppe angelegt -wird. Dieser Gruppe wird Zugriff auf alle Funktionen von Lx-Office -gewährt. Alle migrierten Benutzern werden Mitglied in dieser -Gruppe. Damit wird das Verhalten von Lx-Office bis Version 2.4.3 -inklusive wiederhergestellt, und die Benutzer können sich sofort -wieder anmelden und mit dem System arbeiten. - -@c --------------------------------------------------------------- - -@node Drucken mit Lx-Office -@chapter Drucken mit Lx-Office - -Das Drucksystem von Lx-Office benutzt von Haus aus LaTeX Vorlagen. Um drucken -zu können, braucht der Server ein geeignetes LaTeX System. Am einfachsten ist -dazu eine @code{texlive} Installation. Unter Debianoiden Betriebssystemen sind -das die Pakete: - -@code{texlive-latex-base texlive-latex-extra texlive-fonts-recommended} - -Diese hinteren beiden enthalten Bibliotheken und Schriftarten die von den -Standardvorlagen verwendet werden. - -TODO: rpm Pakete. - -In den allermeisten Installationen sollte drucken jetzt schon funktionieren. -Sollte ein Fehler auftreten wirft TeX sehr lange Fehlerbeschreibungen, der -eigentliche Fehler ist immer die erste Zeite die mit einem Ausrufezeichen -anfängt. Häufig auftretende Fehler sind zum Beispiel: - -@itemize -@item ! LaTeX Error: File `eurosym.sty' not found. -Die entsprechende LaTeX-Bibliothek wurde nicht gefunden. Das tritt vor allem -bei Vorlagen aus der Community auf. Installieren Sie die entsprechenden Pakete. -@item ! Package inputenc Error: Unicode char \u8:桜 not set up for use with LaTeX. -Dieser Fehler tritt auf, wenn sie versuchen mit einer Standardinstallation -exotische utf8 Zeichen zu drucken. TeXLive unterstützt von Haus nur romanische -Schriften und muss mit diversen Tricks dazu gebracht werden andere Zeichen zu -akzeptieren. Adere TeX Systeme wie XeTeX schaffen hier Abhilfe. -@end itemize - -Wird garkein Fehler angezeigt sondern nur der Name des Templates, heißt das -normalerweise, dass das LaTeX Binary nicht gefunden wurde. Prüfen Sie den Namen -in der Konfiguration (Standard: @code{pdflatex}), und stellen Sie sicher, dass -pdflatex (oder das von Ihnen verwendete System) vom Webserver ausgeführt werden -darf. - -@c --------------------------------------------------------------- - -@node OpenDocument-Vorlagen -@chapter OpenDocument-Vorlagen - -Lx-Office unterstützt die Verwendung von Vorlagen im -OpenDocument-Format, wie es OpenOffice.org ab Version 2 -erzeugt. Lx-Office kann dabei sowohl neue OpenDocument-Dokumente als -auch aus diesen direkt PDF-Dateien erzeugen. Um die Unterstützung von -OpenDocument-Vorlagen zu aktivieren muss in der Datei -@file{config/lx_office.conf} die Variable @code{opendocument} im -Abschnitt @code{print_templates} auf @samp{1} stehen. Dieses ist die -Standardeinstellung. - -Weiterhin muss in der Datei @file{config/lx_office.conf} die Variable -@code{dbcharset} im Abschnitt @code{system} auf die Zeichenkodierung -gesetzt werden, die auch bei der Speicherung der Daten in der -Datenbank verwendet wird. Diese ist in den meisten Fällen "UTF-8". - -Während die Erzeugung von reinen OpenDocument-Dateien keinerlei -weitere Software benötigt, wird zur Umwandlung dieser Dateien in PDF -OpenOffice.org benötigt. Soll dieses Feature genutzt werden, so muss -neben OpenOffice.org ab Version 2 auch der ``X virtual frame buffer'' -(xvfb) installiert werden. Bei Debian ist er im Paket ``xvfb'' -enthalten. Andere Distributionen enthalten ihn in anderen Paketen. - -Nach der Installation müssen in der Datei @file{config/lx_config.conf} -zwei weitere Variablen angepasst werden: @code{openofficeorg_writer} -muss den vollständigen Pfad zur OpenOffice.org Writer-Anwendung -enthalten. @code{xvfb} muss den Pfad zum ``X virtual frame buffer'' -enthalten. Beide stehen im Abschnitt @code{applications}. - -Zusätzlich gibt es zwei verschiedene Arten, wie Lx-Office mit -OpenOffice kommuniziert. Die erste Variante, die benutzt wird, wenn -die Variable @code{$openofficeorg_daemon} gesetzt ist, startet ein -OpenOffice, das auch nach der Umwandlung des Dokumentes gestartet -bleibt. Bei weiteren Umwandlungen wird dann diese laufende Instanz -benutzt. Der Vorteil ist, dass die Zeit zur Umwandlung deutlich -reduziert wird, weil nicht für jedes Dokument ein OpenOffice gestartet -werden muss. Der Nachteil ist, dass diese Methode Python und die -Python-UNO-Bindings benötigt, die Bestandteil von OpenOffice 2 sind. - -Ist @code{$openofficeorg_daemon} nicht gesetzt, so wird für jedes -Dokument OpenOffice neu gestartet und die Konvertierung mit Hilfe -eines Makros durchgeführt. Dieses Makro muss in der Dokumentenvorlage -enthalten sein und ``Standard.Conversion.ConvertSelfToPDF()'' -heißen. Die Beispielvorlage @samp{templates/mastertemplates/German/invoice.odt} -enthält ein solches Makro, das in jeder anderen Dokumentenvorlage -ebenfalls enthalten sein muss. - -Als letztes muss herausgefunden werden, welchen Namen OpenOffice.org -Writer dem Verzeichnis mit den Benutzereinstellungen gibt. Unter -Debian ist dies momentan @code{~/.openoffice.org2}. Sollte der Name -bei Ihrer OpenOffice.org-Installation anders sein, so muss das -Verzeichnis @code{users/.openoffice.org2} entsprechend umbenannt -werden. Ist der Name z.B. einfach nur @code{.openoffice}, so wäre -folgender Befehl auszuführen: - -@code{mv users/.openoffice.org2 users/.openoffice} - -Dieses Verzeichnis, wie auch das komplette @code{users}-Verzeichnis, muss vom -Webserver beschreibbar sein. Dieses wurde bereits erledigt -(@pxref{Manuelle Installation des Programmpaketes}), kann aber erneut überprüft -werden, wenn die Konvertierung nach PDF fehlschlägt. - -@c --------------------------------------------------------------- - -@node Lx-Office ERP verwenden -@chapter Lx-Office ERP verwenden - -Nach erfolgreicher Installation ist der Loginbildschirm unter -folgender URL erreichbar: - -@uref{http://localhost/lx-office-erp/login.pl} - -Die Administrationsseite erreichen Sie unter: - -@uref{http://localhost/lx-office-erp/admin.pl} - -@bye diff --git a/doc/INSTALL.txt b/doc/INSTALL.txt deleted file mode 100644 index 3539c127e..000000000 --- a/doc/INSTALL.txt +++ /dev/null @@ -1,874 +0,0 @@ -Table of Contents -***************** - -Inhalt der Anleitung -1 Aktuelle Hinweise -2 Benötigte Software und Pakete - 2.1 Betriebssystem - 2.2 Pakete -3 Manuelle Installation des Programmpaketes -4 Anpassung der PostgreSQL-Konfiguration - 4.1 Zeichensätze/die Verwendung von UTF-8 - 4.2 Änderungen an Konfigurationsdateien - 4.3 Erweiterung für servergespeicherte Prozeduren - 4.4 Datenbankbenutzer anlegen -5 Apache-Konfiguration -6 Der Task-Server - 6.1 Verfügbare und notwendige Konfigurationsoptionen - 6.2 Automatisches Starten des Task-Servers beim Booten - 6.2.1 SystemV-basierende Systeme (z.B. Debian, OpenSuSE, Fedora Core) - 6.2.2 Upstart-basierende Systeme (z.B. Ubuntu) - 6.3 Wie der Task-Server gestartet und beendet wird -7 Benutzerauthentifizierung und Administratorpasswort - 7.1 Grundlagen zur Benutzerauthentifizierung - 7.2 Administratorpasswort - 7.3 Authentifizierungsdatenbank - 7.4 Passwortüberprüfung - 7.5 Name des Session-Cookies - 7.6 Anlegen der Authentifizierungsdatenbank -8 Benutzer- und Gruppenverwaltung - 8.1 Zusammenhänge - 8.2 Datenbanken anlegen - 8.3 Gruppen anlegen - 8.4 Benutzer anlegen - 8.5 Gruppenmitgliedschaften verwalten - 8.6 Migration alter Installationen -9 Drucken mit Lx-Office -10 OpenDocument-Vorlagen -11 Lx-Office ERP verwenden - - -Inhalt der Anleitung -******************** - -1 Aktuelle Hinweise -******************* - -Aktuelle Installations- und Konfigurationshinweise gibt es: - - * auf der Lx-Office Homepage unter - `http://lx-office.org/index.php?id=dokumentation' - - * im Lx-Office-Wiki unter Dokumentation - (`http://wiki.lx-office.org/index.php/Lx-Office_ERP') - - * im Lx-Office-Forum: `http://www.lx-office.org/forum/' - -2 Benötigte Software und Pakete -******************************** - -2.1 Betriebssystem -================== - -Lx-Office ist für Linux konzipiert, und sollte auf jedem unixoiden -Betriebssystem zum Laufen zu kriegen sein. Getestet ist diese Version im -speziellen auf Debian und Ubuntu, grundsätzlich wurde bei der Auswahl -der Pakete aber darauf Rücksicht genommen, dass es ohne große Probleme -auf den derzeit aktuellen verbreiteten Distributionen läuft. - - Anfang 2011 sind das folgende Systeme: - - * Ubuntu 8.04 LTS Hardy Heron - - * Ubuntu 9.10 Karmic Koala - - * Ubuntu 10.04 Lucid Lynx - - * Ubuntu 10.10 Maverick Meerkat - - * Debian 5.0 Lenny - - * Debian 6.0 Squeeze - - * openSUSE 11.2 - - * openSUSE 11.3 - - * SuSE Linux Enterprice Server 11 - - * Fedora 13 - - * Fedora 14 - - Für die debianoiden Betriebssysteme existiert ein .deb, das deutlich -einfacher zu installieren ist. - - Ubuntu 8.04 LTS hat zusätzlich die Schwierigkeit, dass die Module im -Archiv recht alt sind, und das viele der benötigten Module nicht -einfach zu installieren sind. Dafür sollte es kurz nach dem Release ein -eigenes .deb geben. - - Alternativ dazu kann die normale Installation durchgeführt werden -(*note Manuelle Installation des Programmpaketes::), wenn vorher ein -Kompatibilitätspaket installiert wird, das die fehlenden Pakete -bereitstellt. Das Paket ist auf Sourceforge -(https://sourceforge.net/projects/lx-office/files/Lx-Office%20ERP/2.6.2/) -unter dem Namen `lx-erp-perl-libs-compat-v2.tar.gz' hinterlegt. - - Zur Installation das Paket in das entpackte Lx-Office Verzeichnis -entpacken: - - `tar xzf lx-erp-perl-libs-compat-v2.tar.gz /path/to/lx-office/' - - Zusätzlich müssen dann noch die folgenden Pakete installiert weerden - - `libbit-vector-perl libsub-exporter-perl libclone-perl -libclass-factory-util-perl' - - Danach sollte der Installationscheck (*note Pakete::) die -enthaltenen Pakete erkennen. - -2.2 Pakete -========== - -Zum Betrieb von Lx-Office werden zwingend ein Webserver (meist Apache) -und ein Datenbankserver (PostgreSQL, mindestens v8.2) benötigt. - - Zusätzlich benötigt Lx-Office die folgenden Perl-Pakete, die nicht -Bestandteil einer Standard-Perl-Installation sind: - - * parent - - * Archive::Zip - - * Config::Std - - * DateTime - - * DBI - - * DBD::Pg - - * Email::Address - - * JSON - - * List::MoreUtils - - * Params::Validate - - * PDF::API2 - - * Rose::Object - - * Rose::DB - - * Rose::DB::Object - - * Template - - * Text::CSV_XS - - * Text::Iconv - - * URI - - * XML::Writer - - * YAML - - Gegenüber Version 2.6.0 sind zu dieser Liste 2 Pakete hinzugekommen, -`URI' und `XML::Writer' sind notwendig. Ohne startet Lx-Office nicht. - - Gegenüber Version 2.6.1 sind `parent', `DateTime', `Rose::Object', -`Rose::DB' und `Rose::DB::Object' neu hinzugekommen. `IO::Wrap' wurde -entfernt. - - Gegenüber Version 2.6.3 ist `JSON' neu hinzugekommen. - - `Email::Address' und `List::MoreUtils' sind schon länger feste -Abhängigkeiten, wurden aber bisher mit Lx-Office mitgeliefert. Beide -sind auch in 2.6.1 weiterhin mit ausgeliefert, wurden in einer -zukünftigen Version aber aus dem Paket entfernt werden. Es wird -empfohlen diese Module zusammen mit den anderen als Bibliotheken zu -installieren. - - Die zu installierenden Pakete können in den verschiedenen -Distributionen unterschiedlich heißen. - - Für Debian oder Ubuntu benötigen Sie diese Pakete: - - `apache2 postgresql libparent-perl libarchive-zip-perl -libdatetime-perl libdbi-perl libdbd-pg-perl libpg-perl -libemail-address-perl liblist-moreutils-perl libpdf-api2-perl -librose-object-perl librose-db-perl librose-db-object-perl -libtemplate-perl libtext-csv-xs-perl libtext-iconv-perl liburi-perl -libxml-writer-perl libyaml-perl libconfig-std-perl -libparams-validate-perl libjson-perl' - - Für Fedora Core benötigen Sie diese Pakete: - - `httpd postgresql-server perl-parent perl-DateTime perl-DBI -perl-DBD-Pg perl-Email-Address perl-List-MoreUtils perl-PDF-API2 -perl-Rose-Object perl-Rose-DB perl-Rose-DB-Object perl-Template-Toolkit -perl-Text-CSV_XS perl-Text-Iconv perl-URI perl-XML-Writer perl-YAML' - - Für OpenSuSE benötigen Sie diese Pakete: - - `apache2 postgresql-server perl-Archive-Zip perl-DateTime perl-DBI -perl-DBD-Pg perl-MailTools perl-List-MoreUtils perl-PDF-API2 -perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv perl-URI -perl-XML-Writer perl-YAML' - - Bei openSuSE 11 ist `parent' bereits enthalten, und braucht nicht -nachinstalliert werden. Die `Rose::*' Pakete sind derzeit nicht für -SuSE gepackt, und müssen anderweitig nachinstalliert werden. - - Lx-Office enthält ein Script, mit dem überprüft werden kann, ob alle -benötigten Perl-Module installiert sind. Der Aufruf lautet wie folgt: - - `./scripts/installation_check.pl' - -3 Manuelle Installation des Programmpaketes -******************************************* - -Die Lx-Office ERP Installationsdatei (lxoffice-erp-2.6.2.tgz) wird im -Dokumentenverzeichnis des Webservers (z.B. `/var/www/html/', -`/srv/www/htdocs' oder `/var/www/') entpackt: - - `cd /var/www -tar xvzf lxoffice-erp-2.6.2.tgz' - - Verändern Sie evtl. noch den Namen des Verzeichnisses mit - - `mv lxoffice-erp/ lx-erp/' - - Alternativ können Sie auch einen Alias in der Webserverkonfiguration -benutzen, um auf das tatsächliche Installationsverzeichnis zu verweisen. - - Die Verzeichnisse `users', `spool' und `webdav' müssen für den -Benutzer beschreibbar sein, unter dem der Webserver läuft. Die -restlichen Dateien müssen für diesen Benutzer lesbar sein. Der -Benutzername ist bei verschiedenen Distributionen unterschiedlich (z.B. -bei Debian/Ubuntu `www-data', bei Fedora core `apache' oder bei -OpenSuSE `wwwrun'). - - Der folgende Befehl ändert den Besitzer für die oben genannten -Verzeichnisse auf einem Debian/Ubuntu-System: - - `chown -R www-data lx-office-erp/users lx-office-erp/spool -lx-office-erp/webdav' - - Weiterhin muss der Webserver-Benutzer im Verzeichnis `templates' -Verzeichnisse für jeden neuen Benutzer, der in lx-office angelegt wird, -anlegen dürfen: - - `chgrp www-data lx-office-erp/templates; chmod g+w -lx-office-erp/templates' - -4 Anpassung der PostgreSQL-Konfiguration -**************************************** - -PostgreSQL muss auf verschiedene Weisen angepasst werden. - -4.1 Zeichensätze/die Verwendung von UTF-8 -========================================== - -Lx-Office kann komplett mit UTF-8 als Zeichensatz verwendet werden. -Dabei gibt es zwei Punkte zu beachten: PostgreSQL muss in Version 8.0 -oder neuer benutzt werden, und der PostgreSQL-Datenbankcluster muss -ebenfalls mit UTF-8 als Locale angelegt worden sein. - - Dieses ist kann überprüft werden: ist das Encoding der Datenbank -"template1" "UTF8", so kann auch Lx-Office mit UTF-8 betrieben werden. -Andernfalls ist es notwendig, einen neuen Datenbankcluster mit -UTF-8-Encoding anzulegen und diesen zu verwenden. Unter Debian und -Ubuntu kann dies z.B. mit dem folgenden Befehl getan werden: - - `pg_createcluster --locale=de_DE.UTF-8 --encoding=UTF-8 8.2 -clustername' - - Die Datenbankversionsnummer muss an die tatsächlich verwendete -Versionsnummer angepasst werden. - - Unter anderen Distributionen gibt es ähnliche Methoden. - - Wurde PostgreSQL nicht mit UTF-8 als Encoding initialisiert und ist -ein Neuanlegen eines weiteren Clusters nicht möglich, so kann Lx-Office -mit ISO-8859-15 als Encoding betrieben werden. - - Das Encoding einer Datenbank kann in `psql' mit `\l' geprüft werden. - -4.2 Änderungen an Konfigurationsdateien -======================================== - -In der Datei `postgresql.conf', die je nach Distribution in -verschiedenen Verzeichnissen liegen kann (z.B. `/var/lib/pgsql/data/' -oder `/etc/postgresql/', muss sichergestellt werden, dass -TCP/IP-Verbindungen aktiviert sind. Das Verhalten wird über den -Parameter `listen_address' gesteuert. Laufen PostgreSQL und Lx-Office -auf demselben Rechner, so kann dort der Wert `localhost' verwendet -werden. Andernfalls müssen Datenbankverbindungen auch von anderen -Rechnern aus zugelassen werden, was mit dem Wert \`*' geschieht. - - In der Datei `pg_hba.conf', die im gleichen Verzeichnis wie die -`postgresql.conf' zu finden sein sollte, müssen die Berichtigungen für -den Zugriff geändert werden. Hier gibt es mehrere Möglichkeiten. Eine -besteht darin, lokale Verbindungen immer zuzulassen - - `local all all trust -host all all 127.0.0.1 255.0.0.0 trust' - - Besser ist es, für eine bestimmte Datenbank Zugriff nur per Passwort -zuzulassen. Beispielsweise: - - `local all lxoffice - password -host all lxoffice 127.0.0.1 255.255.255.255 -password' - -4.3 Erweiterung für servergespeicherte Prozeduren -================================================== - -In der Datenbank `template1' muss die Unterstützung für -servergespeicherte Prozeduren eingerichet werden. Melden Sie sich dafür -als Benutzer "postgres" an der Datenbank an, und führen Sie die -folgenden Kommandos aus: - - `create language 'plpgsql';' - - Achtung: In älteren Postgresversionen (vor 8.0) muss der Handler für -die Sprache manuell anlelegt werden, diese Versionen werden aber nicht -mehr offiziell von Lx-Office unterstützt. Dafür dann die folgenden -Kommandos: - - `create function plpgsql_call_handler () returns opaque as -'/usr/lib/pgsql/plpgsql.so' language 'c'; -create language 'plpgsql' handler plpgsql_call_handler lancompiler -'pl/pgsql';' - - Bitte beachten Sie, dass der Pfad zur Datei `plpgsql.so' von -Distribution zu Distribution verschiedlich sein kann. Bei Debian/Ubuntu -befindet sie sich unter `/usr/lib/postgresql/lib/plpgsql.so'. - -4.4 Datenbankbenutzer anlegen -============================= - -Wenn Sie nicht den Datenbanksuperuser "postgres" zum Zugriff benutzen -wollen, so sollten Sie bei PostgreSQL einen neuen Benutzer anlegen. Ein -Beispiel, wie Sie einen neuen Benutzer anlegen können: - - `su - postgres -createuser -d -P lxoffice' - - Wenn Sie später einen Datenbankzugriff konfigurieren, verändern Sie -den evtl. voreingestellten Benutzer "postgres" auf "lxoffice" bzw. den -hier gewählten Benutzernamen. - -5 Apache-Konfiguration -********************** - -Hinweis: Für einen deutlichen Performanceschub sorgt die Ausführung -mittels FCGI. Die Einrichtung wird ausführlich in der Datei -`INSTALL.fcgi' beschrieben. - - Der Zugriff auf das Programmverzeichnis muss in der Apache -Webserverkonfigurationsdatei `httpd.conf' eingestellt werden. Fügen Sie -den folgenden Abschnitt dieser Datei oder einer anderen Datei hinzu, -die beim Starten des Webservers eingelesen wird: - - ` -AddHandler cgi-script .pl -Alias /lx-erp/ /var/www/lx-erp/ - -Options ExecCGI Includes FollowSymlinks - - -Order Deny,Allow -Deny from All - -' - - Ersetzen Sie dabei die Pfade durch diejenigen, in die Sie vorher das -Lx-Office-Archiv entpacket haben. - - Achtung: Vor den einzelnen Optionen muss bei einigen Distributionen -ein Plus `+' gesetzt werden. - - Auf einigen Webservern werden manchmal die Grafiken und Style-Sheets -nicht ausgeliefert. In solchen Fällen hat es oft geholfen, die folgende -Option in die Konfiguration aufzunehmen: - - `EnableSendfile Off' - -6 Der Task-Server -***************** - -Der Task-Server ist ein Prozess, der im Hintergrund läuft, in -regelmäßigen Abständen nach abzuarbeitenden Aufgaben sucht und diese zu -festgelegten Zeitpunkten abarbeitet (ähnlich wie Cron). Dieser Prozess -wird bisher nur für die Erzeugung der wiederkehrenden Rechnungen -benutzt, wird aber in Zukunft deutlich mehr Aufgaben übertragen -bekommen. - -6.1 Verfügbare und notwendige Konfigurationsoptionen -===================================================== - -Die Konfiguration erfolgt über den Abschnitt `[task_server]' in der -Datei `config/lx_office.conf'. Die dort verfügbaren Optionen sind: - - * `login': gültiger Lx-Office-Benutzername, der benutzt wird, um die - zu verwendende Datenbankverbindung auszulesen. Der Benutzer muss - in der Administration angelegt werden. Diese Option muss angegeben - werden. - - * `run_as': Wird der Server vom Systembenutzer `root' gestartet, so - wechselt er auf den mit `run_as' angegebenen Systembenutzer. Der - Systembenutzer muss dieselben Lese- und Schreibrechte haben, wie - auch der Webserverbenutzer (siehe *note Manuelle Installation des - Programmpaketes::). Daher ist es sinnvoll, hier denselben - Systembenutzer einzutragen, unter dem auch der Webserver läuft. - - * `debug': Schaltet Debug-Informationen an und aus. - -6.2 Automatisches Starten des Task-Servers beim Booten -====================================================== - -Der Task-Server verhält sich von seinen Optionen her wie ein reguläres -SystemV-kompatibles Boot-Script. Außerdem wechselt er beim Starten -automatisch in das Lx-Office-Installationsverzeichnis. - - Deshalb ist es möglich, ihn durch Setzen eines symbolischen Links aus -einem der Runlevel-Verzeichnisse heraus in den Boot-Prozess -einzubinden. Da das bei neueren Linux-Distributionen aber nicht -zwangsläufig funktioniert, werden auch Start-Scripte mitgeliefert, die -anstelle eines symbolischen Links verwendet werden können. - -6.2.1 SystemV-basierende Systeme (z.B. Debian, OpenSuSE, Fedora Core) ---------------------------------------------------------------------- - -Kopieren Sie die Datei `scripts/boot/system-v/lx-office-task-server' -nach `/etc/init.d/lx-office-task-server'. Passen Sie in der kopierten -Datei den Pfad zum Task-Server an (Zeile `DAEMON=....'). Binden Sie das -Script in den Boot-Prozess ein. Dies ist distributionsabhängig: - - * Debian-basierende Systeme: - `update-rc.d lx-office-task-server defaults - # Nur bei Debian Squeeze und neuer: - insserv lx-office-task-server' - - * OpenSuSE und Fedora Core: - `chkconfig --add lx-office-task-server' - - Danach kann der Task-Server mit dem folgenden Befehl gestartet -werden: `/etc/init.d/lx-office-task-server start' - -6.2.2 Upstart-basierende Systeme (z.B. Ubuntu) ----------------------------------------------- - -Kopieren Sie die Datei -`scripts/boot/upstart/lx-office-task-server.conf' nach -`/etc/init/lx-office-task-server.conf'. Passen Sie in der kopierten -Datei den Pfad zum Task-Server an (Zeile `exec ....'). - - Danach kann der Task-Server mit dem folgenden Befehl gestartet -werden: `service lx-office-task-server start' - -6.3 Wie der Task-Server gestartet und beendet wird -================================================== - -Der Task-Server wird wie folgt kontrolliert: - - `./scripts/task_server.pl Befehl' - - `Befehl' ist dabei eine der folgenden Optionen: - - * `start' startet eine neue Instanz des Task-Servers. Die Prozess-ID - wird innerhalb des `users'-Verzeichnisses abgelegt. - - * `stop' beendet einen laufenden Task-Server. - - * `restart' beendet und startet ihn neu. - - * `status' berichtet, ob der Task-Server läuft. - - Der Task-Server wechselt beim Starten automatisch in das -Lx-Office-Installationsverzeichnis. - - Dieselben Optionen können auch für die SystemV-basierenden -Runlevel-Scripte benutzt werden (siehe oben). - -7 Benutzerauthentifizierung und Administratorpasswort -***************************************************** - -Informationen über die Einrichtung der Benutzerauthentifizierung, über -die Verwaltung von Gruppen und weitere Einstellungen - -7.1 Grundlagen zur Benutzerauthentifizierung -============================================ - -Lx-Office verwaltet die Benutzerinformationen in einer Datenbank, die -im folgenden "Authentifizierungsdatenbank" genannt wird. Für jeden -Benutzer kann dort eine eigene Datenbank für die eigentlichen -Finanzdaten hinterlegt sein. Diese beiden Datenbanken können, müssen -aber nicht unterschiedlich sein. - - Im einfachsten Fall gibt es für Lx-Office nur eine einzige Datenbank, -in der sowohl die Benutzerinformationen als auch die Daten abgelegt -werden. - - Zusätzlich ermöglicht es Lx-Office, dass die Benutzerpasswörter -entweder gegen die Authentifizierungsdatenbank oder gegen einen -LDAP-Server überprüft werden. - - Welche Art der Passwortüberprüfung Lx-Office benutzt und wie -Lx-Office die Authentifizierungsdatenbank erreichen kann, wird in der -Konfigurationsdatei `config/lx_office.conf' festgelegt. Diese muss bei -der Installation und bei einem Upgrade von einer Version vor v2.6.0 -angelegt werden. Eine Beispielkonfigurationsdatei -`config/lx_office.conf.default' existiert, die als Vorlage benutzt -werden kann. - -7.2 Administratorpasswort -========================= - -Das Passwort, das zum Zugriff auf das Aministrationsinterface benutzt -wird, wird ebenfalls in dieser Datei gespeichert. Es kann auch nur dort -und nicht mehr im Administrationsinterface selber geändert werden. Der -Parameter dazu heißt `$self->{admin_password}'. - -7.3 Authentifizierungsdatenbank -=============================== - -Die Verbindung zur Authentifizierungsdatenbank wird mit den Parametern -in `$self->{DB_config}' konfiguriert. Hier sind die folgenden Parameter -anzugeben: - - * `host' - Der Rechnername oder die IP-Adresse des Datenbankservers - - * `port' - Die Portnummer des Datenbankservers, meist 5432 - - * `db' - Der Name der Authentifizierungsdatenbank - - * `user' - Der Benutzername, mit dem sich Lx-Office beim - Datenbankserver anmeldet (z.B. "postgres") - - * `password' - Das Passwort für den Datenbankbenutzer - - Die Datenbank muss noch nicht existieren. Lx-Office kann sie -automatisch anlegen (mehr dazu siehe unten). - -7.4 Passwortüberprüfung -========================= - -Lx-Office unterstützt Passwortüberprüfung auf zwei Arten: gegen die -Authentifizierungsdatenbank und gegen einen externen LDAP- oder -Active-Directory-Server. Welche davon benutzt wird, regelt der -Parameter `$self->{module}'. - - Sollen die Benutzerpasswörter in der Authentifizierungsdatenbank -gespeichert werden, so muss der Parameter `$self->{module}' den Wert -`DB' enthalten. In diesem Fall können sowohl der Administrator als auch -die Benutzer selber ihre Psaswörter in Lx-Office ändern. - - Soll hingegen ein externer LDAP- oder Active-Directory-Server benutzt -werden, so muss der Parameter `$self->{module}' auf `LDAP' gesetzt -werden. In diesem Fall müssen zusätzliche Informationen über den -LDAP-Server in `$self->{LDAP_config}' angegeben werden: - - * `host' - Der Rechnername oder die IP-Adresse des LDAP- oder - Active-Directory-Servers. Diese Angabe ist zwingend erforderlich. - - * `port' - Die Portnummer des LDAP-Servers; meist 389. - - * `tls' - Wenn Verbindungsverschlüsselung gewünscht ist, so diesen - Wert auf `1' setzen, andernfalls auf `0' belassen - - * `attribute' - Das LDAP-Attribut, in dem der Benutzername steht, - den der Benutzer eingegeben hat. Für Active-Directory-Server ist - dies meist `sAMAccountName', für andere LDAP-Server hingegen - `uid'. Diese Angabe ist zwingend erforderlich. - - * `base_dn' - Der Abschnitt des LDAP-Baumes, der durchsucht werden - soll. Diese Angabe ist zwingend erforderlich. - - * `filter' - Ein optionaler LDAP-Filter. Enthält dieser Filter das - Wort `<%login%>', so wird dieses durch den vom Benutzer - eingegebenen Benutzernamen ersetzt. Andernfalls wird der LDAP-Baum - nach einem Element durchsucht, bei dem das oben angegebene Attribut - mit dem Benutzernamen identisch ist. - - * `bind_dn' und `bind_password' - Wenn der LDAP-Server eine - Anmeldung erfordert, bevor er durchsucht werden kann (z.B. ist - dies bei Active-Directory-Servern der Fall), so kann diese hier - angegeben werden. Für Active-Directory-Server kann als `bind_dn' - entweder eine komplette LDAP-DN wie z.B. `cn=Martin - Mustermann,cn=Users,dc=firmendomain' auch nur der volle Name des - Benutzers eingegeben werden; in diesem Beispiel also `Martin - Mustermann'. - -7.5 Name des Session-Cookies -============================ - -Sollen auf einem Server mehrere Lx-Office-Installationen aufgesetzt -werden, so müssen die Namen der Session-Cookies für alle Installationen -unterschiedlich sein. Der Name des Cookies wird mit dem Parameter -`$self->{cookie_name}' gesetzt. - - Diese Angabe ist optional, wenn nur eine Installation auf dem Server -existiert. - -7.6 Anlegen der Authentifizierungsdatenbank -=========================================== - -Nachdem alle Einstellungen in `config/lx_office.conf' vorgenommen -wurden, muss Lx-Office die Authentifizierungsdatenbank anlegen. Dieses -geschieht automatisch, wenn Sie sich im Administrationsmodul anmelden, -das unter der folgenden URL erreichbar sein sollte: - - `http://localhost/lx-erp/admin.pl' - -8 Benutzer- und Gruppenverwaltung -********************************* - -Nach der Installation müssen Benutzer, Gruppen und Datenbanken angelegt -werden. Dieses geschieht im Administrationsmenü, das Sie unter -folgender URL finden: - - `http://localhost/lx-erp/admin.pl' - - Verwenden Sie zur Anmeldung das Password, dass Sie in der Datei -`config/lx_office.conf' eingetragen haben. - -8.1 Zusammenhänge -================== - -Lx-Office verwendet eine Datenbank zum Speichern all seiner -Informationen wie Kundendaten, Artikel, Angebote, Rechnungen etc. Um -mit Lx-Office arbeiten zu können, muss eine Person einen -Benutzeraccount haben. Jedem Benutzeraccount wiederum wird genau eine -Datenbank zugewiesen, mit der dieser Benutzer arbeiten kann. Es ist -möglich und normal, dass mehreren Benutzern die selbe Datenbank -zugewiesen wird, sodass sie alle mit den selben Daten arbeiten können. - - Die Basisdaten der Benutzer, die in der Administration eingegeben -werden können, werden in einer zweiten Datenbank gespeichert, der -bereits erwähnten Authentifizierungsdatenbank. Diese ist also den -Produktivdaten enthaltenden Datenbanken vorgeschaltet. Pro -Lx-Office-Installation gibt es nur eine Authentifizierungsdatenbank, -aber beliebig viele Datenbanken mit Firmendaten. - - Lx-Office kann seinen Benutzern Zugriff auf bestimmte -Funktionsbereiche erlauben oder verbieten. Wird der Zugriff nicht -gestattet, so werden der entsprechenden Menüpunkte auch nicht -angezeigt. Diese Rechte werden ebenfalls in der -Authentifizierungsdatenbank gespeichert. - - Um Rechte verteilen zu können, verwendet Lx-Office ein -Gruppen-Prinzip. Einer Gruppe kann der Zugriff auf bestimmte Bereiche -erlaubt werden. Ein Benutzer wiederum kann Mitglied in einer oder -mehrerer Gruppen sein. Der Benutzer hat Zugriff auf alle diejenigen -Funktionen, die mindestens einer Gruppe erlaubt sind, in der der -Benutzer Mitglied ist. - - Die allgemeine Reihenfolge, in der Datenbanken, Gruppen und Benutzer -angelegt werden sollten, lautet: - - 1. Datenbank anlegen - - 2. Gruppen anlegen - - 3. Benutzer anlegen - - 4. Benutzer den Gruppen zuordnen - -8.2 Datenbanken anlegen -======================= - -Zuerst muss eine Datenbank angelegt werden. Verwenden Sie für den -Datenbankzugriff den vorhin angelegten Benutzer (in unseren Beispielen -ist dies `lxoffice'). - - Wenn Sie für die Lx-Office-Installation nicht den europäischen -Schriftsatz ISO-8859-15 sondern UTF-8 (Unicode) benutzen wollen, so -müssen Sie vor dem Anlegen der Datenbank in der Datei -`config/lx_office.conf' die Variable `dbcharset' im Abschnitt `system' -auf den Wert `UTF-8' setzen. Zusätzlich muss beim Anlegen der Datenbank -`UTF-8 Unicode' als Schriftsatz ausgewählt werden. - - Bitte beachten Sie, dass alle Datenbanken den selben Zeichensatz -verwenden müssen, da diese Einstellungen momentan global in Lx-Office -vorgenommen wird und nicht nach Datenbank unterschieden werden kann. -Auch die Authentifizierungsdatenbank muss mit diesem Zeichensatz -angelegt worden sein. - -8.3 Gruppen anlegen -=================== - -Eine Gruppe wird in der Gruppenverwaltung angelegt. Ihr muss ein Name -gegeben werden, eine Beschreibung ist hingegen optional. Nach dem -Anlegen können Sie die verschiedenen Bereiche wählen, auf die -Mitglieder dieser Gruppe Zugriff haben sollen. - - Benutzergruppen sind unabhängig von Datenbanken, da sie in der -Authentifizierungsdatenbank gespeichert werden. Sie gelten für alle -Datenbanken, die in dieser Installation verwaltet werden. - -8.4 Benutzer anlegen -==================== - -Beim Anlegen von Benutzern werden für viele Parameter -Standardeinstellungen vorgenommen, die den Gepflogenheiten des -deutschen Raumes entsprechen. - - Zwingend anzugeben sind der Loginname sowie die komplette -Datenbankkonfiguration. Wenn die Passwortauthentifizierung über die -Datenbank eingestellt ist, so kann hier auch das Benutzerpasswort -gesetzt bzw. geändert werden. Ist hingegen die LDAP-Authentifizierung -aktiv, so ist das Passwort-Feld deaktiviert. - - In der Datenbankkonfiguration müssen die Zugriffsdaten einer der eben -angelegten Datenbanken eingetragen werden. - -8.5 Gruppenmitgliedschaften verwalten -===================================== - -Nach dem Anlegen von Benutzern und Gruppen müssen Benutzer den Gruppen -zugewiesen werden. Dazu gibt es zwei Möglichkeiten: - - 1. In der Gruppenverwaltung wählt man eine Gruppe aus. Im folgenden - Dialog kann man dann einzeln die Benutzer der Gruppe hinzufügen. - - 2. In der Gruppenverwaltung wählt man das Tool zur Verwaltung der - Gruppenmitgliedschaft. Hier wird eine Matrix angezeigt, die alle im - System angelegten Gruppen und Benutzer enthält. Durch Setzen der - Häkchen wird der Benutzer in der ausgewählten Zeile der Gruppe in - der ausgewählten Spalte hinzugefügt. - -8.6 Migration alter Installationen -================================== - -Wenn Lx-Office 2.6.2 über eine ältere Version installiert wird, in der -die Benutzerdaten noch im Dateisystem im Verzeichnis `users' verwaltet -wurden, so bietet Lx-Office die Möglichkeit, diese Benutzerdaten -automatisch in die Authentifizierungsdatenbank zu übernehmen. Dies -geschieht, wenn man sich nach dem Update der Installation das erste Mal -im Administrationsbereich anmeldet. Findet Lx-Office die Datei -`users/members', so wird der Migrationsprozess gestartet. - - Der Migrationsprozess ist nahezu vollautomatisch. Alle Benutzerdaten -können übernommen werden. Nach den Benutzerdaten bietet Lx-Office noch -die Möglichkeit an, dass automatisch eine Benutzergruppe angelegt wird. -Dieser Gruppe wird Zugriff auf alle Funktionen von Lx-Office gewährt. -Alle migrierten Benutzern werden Mitglied in dieser Gruppe. Damit wird -das Verhalten von Lx-Office bis Version 2.4.3 inklusive -wiederhergestellt, und die Benutzer können sich sofort wieder anmelden -und mit dem System arbeiten. - -9 Drucken mit Lx-Office -*********************** - -Das Drucksystem von Lx-Office benutzt von Haus aus LaTeX Vorlagen. Um -drucken zu können, braucht der Server ein geeignetes LaTeX System. Am -einfachsten ist dazu eine `texlive' Installation. Unter Debianoiden -Betriebssystemen sind das die Pakete: - - `texlive-latex-base texlive-latex-extra texlive-fonts-recommended' - - Diese hinteren beiden enthalten Bibliotheken und Schriftarten die -von den Standardvorlagen verwendet werden. - - TODO: rpm Pakete. - - In den allermeisten Installationen sollte drucken jetzt schon -funktionieren. Sollte ein Fehler auftreten wirft TeX sehr lange -Fehlerbeschreibungen, der eigentliche Fehler ist immer die erste Zeite -die mit einem Ausrufezeichen anfängt. Häufig auftretende Fehler sind -zum Beispiel: - - * ! LaTeX Error: File `eurosym.sty' not found. Die entsprechende - LaTeX-Bibliothek wurde nicht gefunden. Das tritt vor allem bei - Vorlagen aus der Community auf. Installieren Sie die - entsprechenden Pakete. - - * ! Package inputenc Error: Unicode char \u8:桜 not set up for use - with LaTeX. Dieser Fehler tritt auf, wenn sie versuchen mit einer - Standardinstallation exotische utf8 Zeichen zu drucken. TeXLive - unterstützt von Haus nur romanische Schriften und muss mit - diversen Tricks dazu gebracht werden andere Zeichen zu - akzeptieren. Adere TeX Systeme wie XeTeX schaffen hier Abhilfe. - - Wird garkein Fehler angezeigt sondern nur der Name des Templates, -heißt das normalerweise, dass das LaTeX Binary nicht gefunden wurde. -Prüfen Sie den Namen in der Konfiguration (Standard: `pdflatex'), und -stellen Sie sicher, dass pdflatex (oder das von Ihnen verwendete -System) vom Webserver ausgeführt werden darf. - -10 OpenDocument-Vorlagen -************************ - -Lx-Office unterstützt die Verwendung von Vorlagen im -OpenDocument-Format, wie es OpenOffice.org ab Version 2 erzeugt. -Lx-Office kann dabei sowohl neue OpenDocument-Dokumente als auch aus -diesen direkt PDF-Dateien erzeugen. Um die Unterstützung von -OpenDocument-Vorlagen zu aktivieren muss in der Datei -`config/lx_office.conf' die Variable `opendocument' im Abschnitt -`print_templates' auf `1' stehen. Dieses ist die Standardeinstellung. - - Weiterhin muss in der Datei `config/lx_office.conf' die Variable -`dbcharset' im Abschnitt `system' auf die Zeichenkodierung gesetzt -werden, die auch bei der Speicherung der Daten in der Datenbank -verwendet wird. Diese ist in den meisten Fällen "UTF-8". - - Während die Erzeugung von reinen OpenDocument-Dateien keinerlei -weitere Software benötigt, wird zur Umwandlung dieser Dateien in PDF -OpenOffice.org benötigt. Soll dieses Feature genutzt werden, so muss -neben OpenOffice.org ab Version 2 auch der "X virtual frame buffer" -(xvfb) installiert werden. Bei Debian ist er im Paket "xvfb" -enthalten. Andere Distributionen enthalten ihn in anderen Paketen. - - Nach der Installation müssen in der Datei `config/lx_config.conf' -zwei weitere Variablen angepasst werden: `openofficeorg_writer' muss -den vollständigen Pfad zur OpenOffice.org Writer-Anwendung enthalten. -`xvfb' muss den Pfad zum "X virtual frame buffer" enthalten. Beide -stehen im Abschnitt `applications'. - - Zusätzlich gibt es zwei verschiedene Arten, wie Lx-Office mit -OpenOffice kommuniziert. Die erste Variante, die benutzt wird, wenn die -Variable `$openofficeorg_daemon' gesetzt ist, startet ein OpenOffice, -das auch nach der Umwandlung des Dokumentes gestartet bleibt. Bei -weiteren Umwandlungen wird dann diese laufende Instanz benutzt. Der -Vorteil ist, dass die Zeit zur Umwandlung deutlich reduziert wird, weil -nicht für jedes Dokument ein OpenOffice gestartet werden muss. Der -Nachteil ist, dass diese Methode Python und die Python-UNO-Bindings -benötigt, die Bestandteil von OpenOffice 2 sind. - - Ist `$openofficeorg_daemon' nicht gesetzt, so wird für jedes -Dokument OpenOffice neu gestartet und die Konvertierung mit Hilfe eines -Makros durchgeführt. Dieses Makro muss in der Dokumentenvorlage -enthalten sein und "Standard.Conversion.ConvertSelfToPDF()" heißen. Die -Beispielvorlage `templates/mastertemplates/German/invoice.odt' enthält -ein solches Makro, das in jeder anderen Dokumentenvorlage ebenfalls -enthalten sein muss. - - Als letztes muss herausgefunden werden, welchen Namen OpenOffice.org -Writer dem Verzeichnis mit den Benutzereinstellungen gibt. Unter Debian -ist dies momentan `~/.openoffice.org2'. Sollte der Name bei Ihrer -OpenOffice.org-Installation anders sein, so muss das Verzeichnis -`users/.openoffice.org2' entsprechend umbenannt werden. Ist der Name -z.B. einfach nur `.openoffice', so wäre folgender Befehl auszuführen: - - `mv users/.openoffice.org2 users/.openoffice' - - Dieses Verzeichnis, wie auch das komplette `users'-Verzeichnis, muss -vom Webserver beschreibbar sein. Dieses wurde bereits erledigt (*note -Manuelle Installation des Programmpaketes::), kann aber erneut überprüft -werden, wenn die Konvertierung nach PDF fehlschlägt. - -11 Lx-Office ERP verwenden -************************** - -Nach erfolgreicher Installation ist der Loginbildschirm unter folgender -URL erreichbar: - - `http://localhost/lx-office-erp/login.pl' - - Die Administrationsseite erreichen Sie unter: - - `http://localhost/lx-office-erp/admin.pl' - - - -Local Variables: -coding: utf-8 -End: diff --git a/doc/Lx-Office_Installation_DE.pdf b/doc/Lx-Office_Installation_DE.pdf deleted file mode 100644 index 02c0543cd..000000000 Binary files a/doc/Lx-Office_Installation_DE.pdf and /dev/null differ diff --git a/doc/dokumentation.xml b/doc/dokumentation.xml new file mode 100644 index 000000000..6e7248b31 --- /dev/null +++ b/doc/dokumentation.xml @@ -0,0 +1,5196 @@ + + + + Lx-Office: Installation, Konfiguration, Entwicklung + + + Aktuelle Hinweise + + Aktuelle Installations- und Konfigurationshinweise gibt es: + + + + auf der Lx-Office-Homepage unter http://lx-office.org/index.php?id=dokumentation + + + + im Lx-Office-Wiki unter Dokumentation (http://wiki.lx-office.org/index.php/Lx-Office_ERP) + + + + im Lx-Office-Forum: http://www.lx-office.org/forum/ + + + + + + + + Installation und Grundkonfiguration + + + Benötigte Software und Pakete + + + Betriebssystem + + Lx-Office ist für Linux konzipiert, und sollte auf jedem + unixoiden Betriebssystem zum Laufen zu kriegen sein. Getestet ist + diese Version im speziellen auf Debian und Ubuntu, grundsätzlich wurde + bei der Auswahl der Pakete aber darauf Rücksicht genommen, dass es + ohne große Probleme auf den derzeit aktuellen verbreiteten + Distributionen läuft. + + Anfang 2011 sind das folgende Systeme: + + + + Ubuntu 8.04 LTS Hardy Heron + + + + Ubuntu 9.10 Karmic Koala + + + + Ubuntu 10.04 Lucid Lynx + + + + Ubuntu 10.10 Maverick Meerkat + + + + Debian 5.0 Lenny + + + + Debian 6.0 Squeeze + + + + openSUSE 11.2 + + + + openSUSE 11.3 + + + + SuSE Linux Enterprice Server 11 + + + + Fedora 13 + + + + Fedora 14 + + + + Für die debianoiden Betriebssysteme existiert ein .deb, das + deutlich einfacher zu installieren ist. + + Ubuntu 8.04 LTS hat zusätzlich die Schwierigkeit, dass die + Module im Archiv recht alt sind, und das viele der benötigten Module + nicht einfach zu installieren sind. Dafür sollte es kurz nach dem + Release ein eigenes .deb geben. + + Alternativ dazu kann die normale Installation durchgeführt + werden (siehe ), wenn vorher + ein Kompatibilitätspaket installiert wird, das die fehlenden Pakete + bereitstellt. Das Paket ist auf Sourceforge + unter dem Namen lx-erp-perl-libs-compat-v2.tar.gz + hinterlegt. + + Zur Installation das Paket in das entpackte Lx-Office + Verzeichnis entpacken: + + tar xzf lx-erp-perl-libs-compat-v2.tar.gz + /path/to/lx-office/ + + Zusätzlich müssen dann noch die folgenden Pakete installiert + weerden + + libbit-vector-perl libsub-exporter-perl libclone-perl + libclass-factory-util-perl + + Danach sollte der Installationscheck (siehe ) die enthaltenen Pakete erkennen. + + + + Pakete + + Zum Betrieb von Lx-Office werden zwingend ein Webserver (meist + Apache) und ein Datenbankserver (PostgreSQL, mindestens v8.2) + benötigt. + + Zusätzlich benötigt Lx-Office die folgenden Perl-Pakete, die + nicht Bestandteil einer Standard-Perl-Installation sind: + + + + parent + + + + Archive::Zip + + + + Config::Std + + + + DateTime + + + + DBI + + + + DBD::Pg + + + + Email::Address + + + + JSON + + + + List::MoreUtils + + + + Params::Validate + + + + PDF::API2 + + + + Rose::Object + + + + Rose::DB + + + + Rose::DB::Object + + + + Template + + + + Text::CSV_XS + + + + Text::Iconv + + + + URI + + + + XML::Writer + + + + YAML + + + + Gegenüber Version 2.6.0 sind zu dieser Liste 2 Pakete + hinzugekommen, URI und + XML::Writer sind notwendig. Ohne startet Lx-Office + nicht. + + Gegenüber Version 2.6.1 sind parent, + DateTime, Rose::Object, + Rose::DB und Rose::DB::Object + neu hinzugekommen. IO::Wrap wurde entfernt. + + Gegenüber Version 2.6.3 ist JSON neu + hinzugekommen. + + Email::Address und + List::MoreUtils sind schon länger feste + Abhängigkeiten, wurden aber bisher mit Lx-Office mitgeliefert. Beide + sind auch in 2.6.1 weiterhin mit ausgeliefert, wurden in einer + zukünftigen Version aber aus dem Paket entfernt werden. Es wird + empfohlen diese Module zusammen mit den anderen als Bibliotheken zu + installieren. + + Die zu installierenden Pakete können in den verschiedenen + Distributionen unterschiedlich heißen. + + Für Debian oder Ubuntu benötigen Sie diese Pakete: + + apache2 postgresql libparent-perl libarchive-zip-perl + libdatetime-perl libdbi-perl libdbd-pg-perl libpg-perl + libemail-address-perl liblist-moreutils-perl libpdf-api2-perl + librose-object-perl librose-db-perl librose-db-object-perl + libtemplate-perl libtext-csv-xs-perl libtext-iconv-perl liburi-perl + libxml-writer-perl libyaml-perl libconfig-std-perl + libparams-validate-perl libjson-perl + + Für Fedora Core benötigen Sie diese Pakete: + + httpd postgresql-server perl-parent perl-DateTime + perl-DBI perl-DBD-Pg perl-Email-Address perl-List-MoreUtils + perl-PDF-API2 perl-Rose-Object perl-Rose-DB perl-Rose-DB-Object + perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv perl-URI + perl-XML-Writer perl-YAML + + Für OpenSuSE benötigen Sie diese Pakete: + + apache2 postgresql-server perl-Archive-Zip + perl-DateTime perl-DBI perl-DBD-Pg perl-MailTools perl-List-MoreUtils + perl-PDF-API2 perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv + perl-URI perl-XML-Writer perl-YAML + + Bei openSuSE 11 ist parent bereits enthalten, + und braucht nicht nachinstalliert werden. Die + Rose::* Pakete sind derzeit nicht für SuSE gepackt, + und müssen anderweitig nachinstalliert werden. + + Lx-Office enthält ein Script, mit dem überprüft werden kann, ob + alle benötigten Perl-Module installiert sind. Der Aufruf lautet wie + folgt: + + ./scripts/installation_check.pl + + + + + Manuelle Installation des Programmpaketes + + Die Lx-Office ERP Installationsdatei (lxoffice-erp-2.6.2.tgz) wird + im Dokumentenverzeichnis des Webservers (z.B. + /var/www/html/, + /srv/www/htdocs oder + /var/www/) entpackt: + + cd /var/www tar xvzf +lxoffice-erp-2.6.2.tgz + + Verändern Sie evtl. noch den Namen des Verzeichnisses mit + + mv lxoffice-erp/ lx-erp/ + + Alternativ können Sie auch einen Alias in der + Webserverkonfiguration benutzen, um auf das tatsächliche + Installationsverzeichnis zu verweisen. + + Die Verzeichnisse users, + spool und webdav müssen für + den Benutzer beschreibbar sein, unter dem der Webserver läuft. Die + restlichen Dateien müssen für diesen Benutzer lesbar sein. Der + Benutzername ist bei verschiedenen Distributionen unterschiedlich (z.B. + bei Debian/Ubuntu www-data, bei Fedora core + apache oder bei OpenSuSE + wwwrun). + + Der folgende Befehl ändert den Besitzer für die oben genannten + Verzeichnisse auf einem Debian/Ubuntu-System: + + chown -R www-data lx-office-erp/users lx-office-erp/spool lx-office-erp/webdav + + Weiterhin muss der Webserver-Benutzer im Verzeichnis + templates Verzeichnisse für jeden neuen Benutzer, + der in lx-office angelegt wird, anlegen dürfen: + + chgrp www-data lx-office-erp/templates +chmod g+w lx-office-erp/templates + + + + Lx-Office-Konfigurationsdatei + + + Einführung + + + Seit Lx-Office 2.6.3. gibt es nur noch eine Konfigurationsdatei die benötigt wird: config/lx_office.conf (kurz: + "die Hauptkonfigurationsdatei"). Diese muss bei der Erstinstallation von Lx-Office bzw. der Migration von älteren Versionen angelegt + werden. + + + + Als Vorlage dient die Datei config/lx_office.conf.default (kurz: "die Default-Datei"): + + + $ cp config/lx_office.conf.default config/lx_office.conf + + + Die Default-Datei wird immer zuerst eingelesen. Werte, die in der Hauptkonfigurationsdatei stehen, überschreiben die + Werte aus der Default-Datei. Die Hauptkonfigurationsdatei muss also nur die Abschintte und Werte + enthalten, die von denen der Default-Datei abweichen. + + + + Diese Hauptkonfigurationsdatei ist dann eine installationsspezifische Datei, d.h. sie enthält bspw. lokale Passwörter und wird auch + nicht im Versionsmanagement (git) verwaltet. + + + + Die Konfiguration ist ferner serverabhängig, d.h. für alle Mandaten, bzw. Datenbanken gleich. + + + + + Abschnitte und Parameter + + + 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 = 1 +dbcharset = UTF-8 + + + 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, muss 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 nicht mehr möglich, aber auch nicht mehr + nötig. + + + + Beim Update von einer Lx-Office-Version vor 2.6.3 auf 2.6.3 oder jünger müssen die Einstellungen aus den alten Konfigurationsdateien + manuell übertragen und die alten Konfigurationsdateien anschließend gelöscht oder verschoben werden. Ansonsten zeigt Lx-Office eine + entsprechende Fehlermeldung an. + + + + + + Anpassung der PostgreSQL-Konfiguration + + PostgreSQL muss auf verschiedene Weisen angepasst werden. + + + Zeichensätze/die Verwendung von UTF-8 + + Lx-Office kann komplett mit UTF-8 als Zeichensatz verwendet + werden. Dabei gibt es zwei Punkte zu beachten: PostgreSQL muss in + Version 8.0 oder neuer benutzt werden, und der + PostgreSQL-Datenbankcluster muss ebenfalls mit UTF-8 als Locale + angelegt worden sein. + + Dieses ist kann überprüft werden: ist das Encoding der Datenbank + “template1” “UTF8”, so kann auch Lx-Office mit UTF-8 betrieben werden. + Andernfalls ist es notwendig, einen neuen Datenbankcluster mit + UTF-8-Encoding anzulegen und diesen zu verwenden. Unter Debian und + Ubuntu kann dies z.B. mit dem folgenden Befehl getan werden: + + pg_createcluster --locale=de_DE.UTF-8 --encoding=UTF-8 + 8.2 clustername + + Die Datenbankversionsnummer muss an die tatsächlich verwendete + Versionsnummer angepasst werden. + + Unter anderen Distributionen gibt es ähnliche Methoden. + + Wurde PostgreSQL nicht mit UTF-8 als Encoding initialisiert und + ist ein Neuanlegen eines weiteren Clusters nicht möglich, so kann + Lx-Office mit ISO-8859-15 als Encoding betrieben werden. + + Das Encoding einer Datenbank kann in psql mit + \l geprüft werden. + + + + Änderungen an Konfigurationsdateien + + In der Datei postgresql.conf, die je nach + Distribution in verschiedenen Verzeichnissen liegen kann (z.B. + /var/lib/pgsql/data/ oder + /etc/postgresql/, muss sichergestellt werden, dass + TCP/IP-Verbindungen aktiviert sind. Das Verhalten wird über den + Parameter listen_address gesteuert. Laufen + PostgreSQL und Lx-Office auf demselben Rechner, so kann dort der Wert + localhost verwendet werden. Andernfalls müssen + Datenbankverbindungen auch von anderen Rechnern aus zugelassen werden, + was mit dem Wert \* geschieht. + + In der Datei pg_hba.conf, die im gleichen + Verzeichnis wie die postgresql.conf zu finden sein + sollte, müssen die Berichtigungen für den Zugriff geändert werden. + Hier gibt es mehrere Möglichkeiten. Eine besteht darin, lokale + Verbindungen immer zuzulassen + + local all all trust host all all 127.0.0.1 255.0.0.0 + trust + + Besser ist es, für eine bestimmte Datenbank Zugriff nur per + Passwort zuzulassen. Beispielsweise: + + local all lxoffice password host all lxoffice 127.0.0.1 + 255.255.255.255 password + + + + + + Erweiterung für servergespeicherte Prozeduren + + In der Datenbank template1 muss die + Unterstützung für servergespeicherte Prozeduren eingerichet werden. + Melden Sie sich dafür als Benutzer “postgres” an der Datenbank an, und + führen Sie die folgenden Kommandos aus: + + create language 'plpgsql'; + + Achtung: In älteren Postgresversionen (vor 8.0) muss der Handler + für die Sprache manuell anlelegt werden, diese Versionen werden aber + nicht mehr offiziell von Lx-Office unterstützt. Dafür dann die + folgenden Kommandos: + + create function plpgsql_call_handler () returns opaque + as '/usr/lib/pgsql/plpgsql.so' language 'c'; create language 'plpgsql' + handler plpgsql_call_handler lancompiler 'pl/pgsql'; + + Bitte beachten Sie, dass der Pfad zur Datei + plpgsql.so von Distribution zu Distribution + verschiedlich sein kann. Bei Debian/Ubuntu befindet sie sich unter + /usr/lib/postgresql/lib/plpgsql.so. + + + + + + Datenbankbenutzer anlegen + + Wenn Sie nicht den Datenbanksuperuser “postgres” zum Zugriff + benutzen wollen, so sollten Sie bei PostgreSQL einen neuen Benutzer + anlegen. Ein Beispiel, wie Sie einen neuen Benutzer anlegen + können: + + su - postgres createuser -d -P + lxoffice + + Wenn Sie später einen Datenbankzugriff konfigurieren, verändern + Sie den evtl. voreingestellten Benutzer “postgres” auf “lxoffice” bzw. + den hier gewählten Benutzernamen. + + + + + + + Webserver-Konfiguration + + + Grundkonfiguration mittels CGI + + + Für einen deutlichen Performanceschub sorgt die Ausführung + mittels FastCGI/FCGI. Die Einrichtung wird ausführlich im Abschnitt + beschrieben. + + + Der Zugriff auf das Programmverzeichnis muss in der Apache + Webserverkonfigurationsdatei httpd.conf eingestellt + werden. Fügen Sie den folgenden Abschnitt dieser Datei oder einer + anderen Datei hinzu, die beim Starten des Webservers eingelesen + wird: + + AddHandler cgi-script .pl Alias /lx-erp/ + /var/www/lx-erp/ <Directory /var/www/lx-erp> Options ExecCGI + Includes FollowSymlinks </Directory> <Directory + /var/www/lx-erp/users> Order Deny,Allow Deny from All + </Directory> + + Ersetzen Sie dabei die Pfade durch diejenigen, in die Sie vorher + das Lx-Office-Archiv entpacket haben. + + Achtung: Vor den einzelnen Optionen muss bei einigen + Distributionen ein Plus ‘+’ gesetzt werden. + + Auf einigen Webservern werden manchmal die Grafiken und + Style-Sheets nicht ausgeliefert. In solchen Fällen hat es oft + geholfen, die folgende Option in die Konfiguration aufzunehmen: + + EnableSendfile Off + + + + Konfiguration für FastCGI/FCGI + + + Was ist FastCGI? + + Direkt aus Wikipedia + kopiert: + + FastCGI ist ein Standard für die Einbindung + externer Software zur Generierung dynamischer Webseiten in einem + Webserver. FastCGI ist vergleichbar zum Common Gateway Interface + (CGI), wurde jedoch entwickelt, um dessen Performance-Probleme zu + umgehen. + + + + Warum FastCGI? + + Perl Programme (wie Lx-Office eines ist) werden nicht statisch + kompiliert. Stattdessen werden die Quelldateien bei jedem Start + übersetzt, was bei kurzen Laufzeiten einen Großteil der Laufzeit + ausmacht. Während SQL Ledger einen Großteil der Funktionalität in + einzelne Module kapselt, um immer nur einen kleinen Teil laden zu + müssen, ist die Funktionalität von Lx-Office soweit gewachsen, dass + immer mehr Module auf den Rest des Programms zugreifen. Zusätzlich + benutzen wir umfangreiche Bibliotheken um Funktionaltät nicht selber + entwickeln zu müssen, die zusätzliche Ladezeit kosten. All dies + führt dazu dass ein Lx-Office Aufruf der Kernmasken mittlerweile + deutlich länger dauert als früher, und dass davon 90% für das Laden + der Module verwendet wird. + + Mit FastCGI werden nun die Module einmal geladen, und danach + wird nur die eigentliche Programmlogik ausgeführt. + + + + Getestete Kombinationen aus Webservern und Plugin + + Folgende Kombinationen sind getestet: + + + + Apache 2.2.11 (Ubuntu) und mod_fcgid. + + + + Apache 2.2.11 (Ubuntu) und mod_fastcgi. + + + + Dabei wird mod_fcgid empfohlen, weil mod_fastcgi seit geraumer + Zeit nicht mehr weiter entwickelt wird. Im Folgenden wird auf + mod_fastcgi nicht mehr explizit eingegangen. + + Als Perl Backend wird das Modul FCGI.pm + verwendet. + + + FCGI 0.69 und höher ist extrem strict in der Behandlung von + Unicode, und verweigert bestimmte Eingaben von Lx-Office. Falls es + Probleme mit Umlauten in Ihrere Installation gibt, muss auf die + Vorgängerversion FCGI 0.68 ausgewichen werden. + + + Mit CPAN lässt sie sich die Vorgängerversion wie folgt + installieren: + + force install M/MS/MSTROUT/FCGI-0.68.tar.gz + + + + Konfiguration des Webservers + + Bevor Sie versuchen, eine Lx-Office Installation unter FCGI + laufen zu lassen, empfliehlt es sich die Installation ersteinmal + unter CGI aufzusetzen. FCGI macht es nicht einfach Fehler zu + debuggen die beim ersten aufsetzen auftreten können. Sollte die + Installation schon funktionieren, lesen Sie weiter. + + Zuerst muss das FastCGI-Modul aktiviert werden. Dies kann + unter Debian/Ubuntu z.B. mit folgendem Befehl geschehen: + + a2enmod fcgid + + Die Konfiguration für die Verwendung von Lx-Office mit FastCGI + erfolgt durch Anpassung der vorhandenen Alias- + und Directory-Direktiven. Dabei wird zwischen + dem Installationspfad von Lx-Office im Dateisystem + ("/path/to/lx-office-erp") und der URL + unterschieden, unter der Lx-Office im Webbrowser erreichbar ist + ("/web/path/to/lx-office-erp"). + + Folgender Konfigurationsschnipsel funktioniert mit + mod_fastcgi: + + AliasMatch ^/web/path/to/lx-office-erp/[^/]+\.pl /path/to/lx-office-erp/dispatcher.fcgi +Alias /web/path/to/lx-office-erp/ /path/to/lx-office-erp/ + +<Directory /path/to/lx-office-erp> + AllowOverride All + Options ExecCGI Includes FollowSymlinks + Order Allow,Deny + Allow from All +</Directory> + +<DirectoryMatch /path/to/lx-office-erp/users> + Order Deny,Allow + Deny from All +</DirectoryMatch> + + Seit mod_fcgid-Version 2.6.3 gelten sehr kleine Grenzen für + die maximale Größe eines Requests. Diese sollte wie folgt + hochgesetzt werden: + + FcgidMaxRequestLen 10485760 + + Das ganze sollte dann so aussehen: + + AddHandler fcgid-script .fpl +AliasMatch ^/web/path/to/lx-office-erp/[^/]+\.pl /path/to/lx-office-erp/dispatcher.fpl +Alias /web/path/to/lx-office-erp/ /path/to/lx-office-erp/ +FcgidMaxRequestLen 10485760 + +<Directory /path/to/lx-office-erp> + AllowOverride All + Options ExecCGI Includes FollowSymlinks + Order Allow,Deny + Allow from All +</Directory> + +<DirectoryMatch /path/to/lx-office-erp/users> + Order Deny,Allow + Deny from All +</DirectoryMatch> + + Hierdurch wird nur ein zentraler Dispatcher gestartet. Alle + Zugriffe auf die einzelnen Scripte werden auf diesen umgeleitet. + Dadurch, dass zur Laufzeit öfter mal Scripte neu geladen werden, + gibt es hier kleine Performance-Einbußen. + + Es ist möglich, die gleiche Lx-Office Version parallel unter + CGI und FastCGI zu betreiben. Dafür bleiben die Directorydirektiven + wie oben beschrieben, die URLs werden aber umgeleitet: + + # Zugriff über CGI +Alias /web/path/to/lx-office-erp /path/to/lx-office-erp + +# Zugriff mit mod_fcgid: +AliasMatch ^/web/path/to/lx-office-erp-fcgid/[^/]+\.pl /path/to/lx-office-erp/dispatcher.fpl +Alias /web/path/to/lx-office-erp-fcgid/ /path/to/lx-office-erp/ + + Dann ist unter + /web/path/to/lx-office-erp/ die normale Version + erreichbar, und unter + /web/path/to/lx-office-erp-fcgid/ die + FastCGI-Version. + + + + + + Der Task-Server + + Der Task-Server ist ein Prozess, der im Hintergrund läuft, in + regelmäßigen Abständen nach abzuarbeitenden Aufgaben sucht und diese zu + festgelegten Zeitpunkten abarbeitet (ähnlich wie Cron). Dieser Prozess + wird bisher nur für die Erzeugung der wiederkehrenden Rechnungen + benutzt, wird aber in Zukunft deutlich mehr Aufgaben übertragen + bekommen. + + + Verfügbare und notwendige Konfigurationsoptionen + + Die Konfiguration erfolgt über den Abschnitt + [task_server] in der Datei + config/lx_office.conf. Die dort verfügbaren + Optionen sind: + + + + login: gültiger Lx-Office-Benutzername, + der benutzt wird, um die zu verwendende Datenbankverbindung + auszulesen. Der Benutzer muss in der Administration angelegt + werden. Diese Option muss angegeben werden. + + + + run_as: Wird der Server vom + Systembenutzer root gestartet, so wechselt er + auf den mit run_as angegebenen Systembenutzer. + Der Systembenutzer muss dieselben Lese- und Schreibrechte haben, + wie auch der Webserverbenutzer (siehe see ). Daher ist + es sinnvoll, hier denselben Systembenutzer einzutragen, unter dem + auch der Webserver läuft. + + + + debug: Schaltet Debug-Informationen an + und aus. + + + + + + Automatisches Starten des Task-Servers beim Booten + + Der Task-Server verhält sich von seinen Optionen her wie ein + reguläres SystemV-kompatibles Boot-Script. Außerdem wechselt er beim + Starten automatisch in das Lx-Office-Installationsverzeichnis. + + Deshalb ist es möglich, ihn durch Setzen eines symbolischen + Links aus einem der Runlevel-Verzeichnisse heraus in den Boot-Prozess + einzubinden. Da das bei neueren Linux-Distributionen aber nicht + zwangsläufig funktioniert, werden auch Start-Scripte mitgeliefert, die + anstelle eines symbolischen Links verwendet werden können. + + + SystemV-basierende Systeme (z.B. Debian, OpenSuSE, Fedora + Core) + + Kopieren Sie die Datei + scripts/boot/system-v/lx-office-task-server + nach /etc/init.d/lx-office-task-server. Passen + Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile + DAEMON=....). Binden Sie das Script in den + Boot-Prozess ein. Dies ist distributionsabhängig: + + + + Debian-basierende Systeme: + + update-rc.d lx-office-task-server defaults # Nur + bei Debian Squeeze und neuer: insserv + lx-office-task-server + + + + OpenSuSE und Fedora Core: + + chkconfig --add + lx-office-task-server + + + + Danach kann der Task-Server mit dem folgenden Befehl gestartet + werden: /etc/init.d/lx-office-task-server + start + + + + Upstart-basierende Systeme (z.B. Ubuntu) + + Kopieren Sie die Datei + scripts/boot/upstart/lx-office-task-server.conf + nach /etc/init/lx-office-task-server.conf. + Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile + exec ....). + + Danach kann der Task-Server mit dem folgenden Befehl gestartet + werden: service lx-office-task-server + start + + + + + Wie der Task-Server gestartet und beendet wird + + Der Task-Server wird wie folgt kontrolliert: + + ./scripts/task_server.pl Befehl + + Befehl ist dabei eine der folgenden + Optionen: + + + + start startet eine neue Instanz des + Task-Servers. Die Prozess-ID wird innerhalb des + users-Verzeichnisses abgelegt. + + + + stop beendet einen laufenden + Task-Server. + + + + restart beendet und startet ihn + neu. + + + + status berichtet, ob der Task-Server + läuft. + + + + Der Task-Server wechselt beim Starten automatisch in das + Lx-Office-Installationsverzeichnis. + + Dieselben Optionen können auch für die SystemV-basierenden + Runlevel-Scripte benutzt werden (siehe oben). + + + + + + + Benutzerauthentifizierung und Administratorpasswort + + Informationen über die Einrichtung der Benutzerauthentifizierung, + über die Verwaltung von Gruppen und weitere Einstellungen + + + + + Grundlagen zur Benutzerauthentifizierung + + Lx-Office verwaltet die Benutzerinformationen in einer + Datenbank, die im folgenden “Authentifizierungsdatenbank” genannt + wird. Für jeden Benutzer kann dort eine eigene Datenbank für die + eigentlichen Finanzdaten hinterlegt sein. Diese beiden Datenbanken + können, müssen aber nicht unterschiedlich sein. + + Im einfachsten Fall gibt es für Lx-Office nur eine einzige + Datenbank, in der sowohl die Benutzerinformationen als auch die Daten + abgelegt werden. + + Zusätzlich ermöglicht es Lx-Office, dass die Benutzerpasswörter + entweder gegen die Authentifizierungsdatenbank oder gegen einen + LDAP-Server überprüft werden. + + Welche Art der Passwortüberprüfung Lx-Office benutzt und wie + Lx-Office die Authentifizierungsdatenbank erreichen kann, wird in der + Konfigurationsdatei config/lx_office.conf + festgelegt. Diese muss bei der Installation und bei einem Upgrade von + einer Version vor v2.6.0 angelegt werden. Eine + Beispielkonfigurationsdatei + config/lx_office.conf.default existiert, die als + Vorlage benutzt werden kann. + + + + Administratorpasswort + + Das Passwort, das zum Zugriff auf das Aministrationsinterface + benutzt wird, wird ebenfalls in dieser Datei gespeichert. Es kann auch + nur dort und nicht mehr im Administrationsinterface selber geändert + werden. Der Parameter dazu heißt + $self->{admin_password}. + + + + Authentifizierungsdatenbank + + Die Verbindung zur Authentifizierungsdatenbank wird mit den + Parametern in $self->{DB_config} konfiguriert. + Hier sind die folgenden Parameter anzugeben: + + + + ‘host’ – Der Rechnername oder die + IP-Adresse des Datenbankservers + + + + ‘port’ – Die Portnummer des + Datenbankservers, meist 5432 + + + + ‘db’ – Der Name der + Authentifizierungsdatenbank + + + + ‘user’ – Der Benutzername, mit dem sich + Lx-Office beim Datenbankserver anmeldet (z.B. “postgres”) + + + + ‘password’ – Das Passwort für den + Datenbankbenutzer + + + + Die Datenbank muss noch nicht existieren. Lx-Office kann sie + automatisch anlegen (mehr dazu siehe unten). + + + + Passwortüberprüfung + + Lx-Office unterstützt Passwortüberprüfung auf zwei Arten: gegen + die Authentifizierungsdatenbank und gegen einen externen LDAP- oder + Active-Directory-Server. Welche davon benutzt wird, regelt der + Parameter $self->{module}. + + Sollen die Benutzerpasswörter in der Authentifizierungsdatenbank + gespeichert werden, so muss der Parameter + $self->{module} den Wert ‘DB’ + enthalten. In diesem Fall können sowohl der Administrator als auch die + Benutzer selber ihre Psaswörter in Lx-Office ändern. + + Soll hingegen ein externer LDAP- oder Active-Directory-Server + benutzt werden, so muss der Parameter + $self->{module} auf ‘LDAP’ + gesetzt werden. In diesem Fall müssen zusätzliche Informationen über + den LDAP-Server in $self->{LDAP_config} + angegeben werden: + + + + ‘host’ – Der Rechnername oder die + IP-Adresse des LDAP- oder Active-Directory-Servers. Diese Angabe + ist zwingend erforderlich. + + + + ‘port’ – Die Portnummer des LDAP-Servers; + meist 389. + + + + ‘tls’ – Wenn Verbindungsverschlüsselung + gewünscht ist, so diesen Wert auf ‘1’ setzen, + andernfalls auf ‘0’ belassen + + + + ‘attribute’ – Das LDAP-Attribut, in dem + der Benutzername steht, den der Benutzer eingegeben hat. Für + Active-Directory-Server ist dies meist + ‘sAMAccountName’, für andere LDAP-Server + hingegen ‘uid’. Diese Angabe ist zwingend + erforderlich. + + + + ‘base_dn’ – Der Abschnitt des + LDAP-Baumes, der durchsucht werden soll. Diese Angabe ist zwingend + erforderlich. + + + + ‘filter’ – Ein optionaler LDAP-Filter. + Enthält dieser Filter das Wort <%login%>, + so wird dieses durch den vom Benutzer eingegebenen Benutzernamen + ersetzt. Andernfalls wird der LDAP-Baum nach einem Element + durchsucht, bei dem das oben angegebene Attribut mit dem + Benutzernamen identisch ist. + + + + ‘bind_dn’ und + ‘bind_password’ – Wenn der LDAP-Server eine + Anmeldung erfordert, bevor er durchsucht werden kann (z.B. ist + dies bei Active-Directory-Servern der Fall), so kann diese hier + angegeben werden. Für Active-Directory-Server kann als + ‘bind_dn’ entweder eine komplette LDAP-DN wie + z.B. ‘cn=Martin + Mustermann,cn=Users,dc=firmendomain’ auch nur der volle + Name des Benutzers eingegeben werden; in diesem Beispiel also + ‘Martin Mustermann’. + + + + + + Name des Session-Cookies + + Sollen auf einem Server mehrere Lx-Office-Installationen + aufgesetzt werden, so müssen die Namen der Session-Cookies für alle + Installationen unterschiedlich sein. Der Name des Cookies wird mit dem + Parameter $self->{cookie_name} gesetzt. + + Diese Angabe ist optional, wenn nur eine Installation auf dem + Server existiert. + + + + Anlegen der Authentifizierungsdatenbank + + Nachdem alle Einstellungen in + config/lx_office.conf vorgenommen wurden, muss + Lx-Office die Authentifizierungsdatenbank anlegen. Dieses geschieht + automatisch, wenn Sie sich im Administrationsmodul anmelden, das unter + der folgenden URL erreichbar sein sollte: + + http://localhost/lx-erp/admin.pl + + + + + + + Benutzer- und Gruppenverwaltung + + Nach der Installation müssen Benutzer, Gruppen und Datenbanken + angelegt werden. Dieses geschieht im Administrationsmenü, das Sie unter + folgender URL finden: + + http://localhost/lx-erp/admin.pl + + Verwenden Sie zur Anmeldung das Password, dass Sie in der Datei + config/lx_office.conf eingetragen haben. + + + Zusammenhänge + + Lx-Office verwendet eine Datenbank zum Speichern all seiner + Informationen wie Kundendaten, Artikel, Angebote, Rechnungen etc. Um + mit Lx-Office arbeiten zu können, muss eine Person einen + Benutzeraccount haben. Jedem Benutzeraccount wiederum wird genau eine + Datenbank zugewiesen, mit der dieser Benutzer arbeiten kann. Es ist + möglich und normal, dass mehreren Benutzern die selbe Datenbank + zugewiesen wird, sodass sie alle mit den selben Daten arbeiten + können. + + Die Basisdaten der Benutzer, die in der Administration + eingegeben werden können, werden in einer zweiten Datenbank + gespeichert, der bereits erwähnten Authentifizierungsdatenbank. Diese + ist also den Produktivdaten enthaltenden Datenbanken vorgeschaltet. + Pro Lx-Office-Installation gibt es nur eine + Authentifizierungsdatenbank, aber beliebig viele Datenbanken mit + Firmendaten. + + Lx-Office kann seinen Benutzern Zugriff auf bestimmte + Funktionsbereiche erlauben oder verbieten. Wird der Zugriff nicht + gestattet, so werden der entsprechenden Menüpunkte auch nicht + angezeigt. Diese Rechte werden ebenfalls in der + Authentifizierungsdatenbank gespeichert. + + Um Rechte verteilen zu können, verwendet Lx-Office ein + Gruppen-Prinzip. Einer Gruppe kann der Zugriff auf bestimmte Bereiche + erlaubt werden. Ein Benutzer wiederum kann Mitglied in einer oder + mehrerer Gruppen sein. Der Benutzer hat Zugriff auf alle diejenigen + Funktionen, die mindestens einer Gruppe erlaubt sind, in der der + Benutzer Mitglied ist. + + Die allgemeine Reihenfolge, in der Datenbanken, Gruppen und + Benutzer angelegt werden sollten, lautet: + + + + Datenbank anlegen + + + + Gruppen anlegen + + + + Benutzer anlegen + + + + Benutzer den Gruppen zuordnen + + + + + + Datenbanken anlegen + + Zuerst muss eine Datenbank angelegt werden. Verwenden Sie für + den Datenbankzugriff den vorhin angelegten Benutzer (in unseren + Beispielen ist dies ‘lxoffice’). + + Wenn Sie für die Lx-Office-Installation nicht den europäischen + Schriftsatz ISO-8859-15 sondern UTF-8 (Unicode) benutzen wollen, so + müssen Sie vor dem Anlegen der Datenbank in der Datei + config/lx_office.conf die Variable + dbcharset im Abschnitt system + auf den Wert ‘UTF-8’ setzen. Zusätzlich muss beim + Anlegen der Datenbank ‘UTF-8 Unicode’ als + Schriftsatz ausgewählt werden. + + Bitte beachten Sie, dass alle Datenbanken den selben Zeichensatz + verwenden müssen, da diese Einstellungen momentan global in Lx-Office + vorgenommen wird und nicht nach Datenbank unterschieden werden kann. + Auch die Authentifizierungsdatenbank muss mit diesem Zeichensatz + angelegt worden sein. + + + + Gruppen anlegen + + Eine Gruppe wird in der Gruppenverwaltung angelegt. Ihr muss ein + Name gegeben werden, eine Beschreibung ist hingegen optional. Nach dem + Anlegen können Sie die verschiedenen Bereiche wählen, auf die + Mitglieder dieser Gruppe Zugriff haben sollen. + + Benutzergruppen sind unabhängig von Datenbanken, da sie in der + Authentifizierungsdatenbank gespeichert werden. Sie gelten für alle + Datenbanken, die in dieser Installation verwaltet werden. + + + + Benutzer anlegen + + Beim Anlegen von Benutzern werden für viele Parameter + Standardeinstellungen vorgenommen, die den Gepflogenheiten des + deutschen Raumes entsprechen. + + Zwingend anzugeben sind der Loginname sowie die komplette + Datenbankkonfiguration. Wenn die Passwortauthentifizierung über die + Datenbank eingestellt ist, so kann hier auch das Benutzerpasswort + gesetzt bzw. geändert werden. Ist hingegen die LDAP-Authentifizierung + aktiv, so ist das Passwort-Feld deaktiviert. + + In der Datenbankkonfiguration müssen die Zugriffsdaten einer der + eben angelegten Datenbanken eingetragen werden. + + + + Gruppenmitgliedschaften verwalten + + Nach dem Anlegen von Benutzern und Gruppen müssen Benutzer den + Gruppen zugewiesen werden. Dazu gibt es zwei Möglichkeiten: + + + + In der Gruppenverwaltung wählt man eine Gruppe aus. Im + folgenden Dialog kann man dann einzeln die Benutzer der Gruppe + hinzufügen. + + + + In der Gruppenverwaltung wählt man das Tool zur Verwaltung + der Gruppenmitgliedschaft. Hier wird eine Matrix angezeigt, die + alle im System angelegten Gruppen und Benutzer enthält. Durch + Setzen der Häkchen wird der Benutzer in der ausgewählten Zeile der + Gruppe in der ausgewählten Spalte hinzugefügt. + + + + + + Migration alter Installationen + + Wenn Lx-Office 2.6.2 über eine ältere Version installiert wird, + in der die Benutzerdaten noch im Dateisystem im Verzeichnis + users verwaltet wurden, so bietet Lx-Office die + Möglichkeit, diese Benutzerdaten automatisch in die + Authentifizierungsdatenbank zu übernehmen. Dies geschieht, wenn man + sich nach dem Update der Installation das erste Mal im + Administrationsbereich anmeldet. Findet Lx-Office die Datei + users/members, so wird der Migrationsprozess + gestartet. + + Der Migrationsprozess ist nahezu vollautomatisch. Alle + Benutzerdaten können übernommen werden. Nach den Benutzerdaten bietet + Lx-Office noch die Möglichkeit an, dass automatisch eine + Benutzergruppe angelegt wird. Dieser Gruppe wird Zugriff auf alle + Funktionen von Lx-Office gewährt. Alle migrierten Benutzern werden + Mitglied in dieser Gruppe. Damit wird das Verhalten von Lx-Office bis + Version 2.4.3 inklusive wiederhergestellt, und die Benutzer können + sich sofort wieder anmelden und mit dem System arbeiten. + + + + + + + Drucken mit Lx-Office + + Das Drucksystem von Lx-Office benutzt von Haus aus LaTeX Vorlagen. + Um drucken zu können, braucht der Server ein geeignetes LaTeX System. Am + einfachsten ist dazu eine texlive Installation. Unter + Debianoiden Betriebssystemen sind das die Pakete: + + texlive-latex-base texlive-latex-extra + texlive-fonts-recommended + + Diese hinteren beiden enthalten Bibliotheken und Schriftarten die + von den Standardvorlagen verwendet werden. + + TODO: rpm Pakete. + + In den allermeisten Installationen sollte drucken jetzt schon + funktionieren. Sollte ein Fehler auftreten wirft TeX sehr lange + Fehlerbeschreibungen, der eigentliche Fehler ist immer die erste Zeite + die mit einem Ausrufezeichen anfängt. Häufig auftretende Fehler sind zum + Beispiel: + + + + ! LaTeX Error: File `eurosym.sty' not found. Die entsprechende + LaTeX-Bibliothek wurde nicht gefunden. Das tritt vor allem bei + Vorlagen aus der Community auf. Installieren Sie die entsprechenden + Pakete. + + + + ! Package inputenc Error: Unicode char \u8:桜 not set up for + use with LaTeX. Dieser Fehler tritt auf, wenn sie versuchen mit + einer Standardinstallation exotische utf8 Zeichen zu drucken. + TeXLive unterstützt von Haus nur romanische Schriften und muss mit + diversen Tricks dazu gebracht werden andere Zeichen zu akzeptieren. + Adere TeX Systeme wie XeTeX schaffen hier Abhilfe. + + + + Wird garkein Fehler angezeigt sondern nur der Name des Templates, + heißt das normalerweise, dass das LaTeX Binary nicht gefunden wurde. + Prüfen Sie den Namen in der Konfiguration (Standard: + pdflatex), und stellen Sie sicher, dass pdflatex + (oder das von Ihnen verwendete System) vom Webserver ausgeführt werden + darf. + + + + + + OpenDocument-Vorlagen + + Lx-Office unterstützt die Verwendung von Vorlagen im + OpenDocument-Format, wie es OpenOffice.org ab Version 2 erzeugt. + Lx-Office kann dabei sowohl neue OpenDocument-Dokumente als auch aus + diesen direkt PDF-Dateien erzeugen. Um die Unterstützung von + OpenDocument-Vorlagen zu aktivieren muss in der Datei + config/lx_office.conf die Variable + opendocument im Abschnitt + print_templates auf ‘1’ stehen. + Dieses ist die Standardeinstellung. + + Weiterhin muss in der Datei + config/lx_office.conf die Variable + dbcharset im Abschnitt system auf + die Zeichenkodierung gesetzt werden, die auch bei der Speicherung der + Daten in der Datenbank verwendet wird. Diese ist in den meisten Fällen + "UTF-8". + + Während die Erzeugung von reinen OpenDocument-Dateien keinerlei + weitere Software benötigt, wird zur Umwandlung dieser Dateien in PDF + OpenOffice.org benötigt. Soll dieses Feature genutzt werden, so muss + neben OpenOffice.org ab Version 2 auch der “X virtual frame buffer” + (xvfb) installiert werden. Bei Debian ist er im Paket “xvfb” enthalten. + Andere Distributionen enthalten ihn in anderen Paketen. + + Nach der Installation müssen in der Datei + config/lx_config.conf zwei weitere Variablen + angepasst werden: openofficeorg_writer muss den + vollständigen Pfad zur OpenOffice.org Writer-Anwendung enthalten. + xvfb muss den Pfad zum “X virtual frame buffer” + enthalten. Beide stehen im Abschnitt + applications. + + Zusätzlich gibt es zwei verschiedene Arten, wie Lx-Office mit + OpenOffice kommuniziert. Die erste Variante, die benutzt wird, wenn die + Variable $openofficeorg_daemon gesetzt ist, startet + ein OpenOffice, das auch nach der Umwandlung des Dokumentes gestartet + bleibt. Bei weiteren Umwandlungen wird dann diese laufende Instanz + benutzt. Der Vorteil ist, dass die Zeit zur Umwandlung deutlich + reduziert wird, weil nicht für jedes Dokument ein OpenOffice gestartet + werden muss. Der Nachteil ist, dass diese Methode Python und die + Python-UNO-Bindings benötigt, die Bestandteil von OpenOffice 2 + sind. + + Ist $openofficeorg_daemon nicht gesetzt, so + wird für jedes Dokument OpenOffice neu gestartet und die Konvertierung + mit Hilfe eines Makros durchgeführt. Dieses Makro muss in der + Dokumentenvorlage enthalten sein und + “Standard.Conversion.ConvertSelfToPDF()” heißen. Die Beispielvorlage + ‘templates/mastertemplates/German/invoice.odt’ + enthält ein solches Makro, das in jeder anderen Dokumentenvorlage + ebenfalls enthalten sein muss. + + Als letztes muss herausgefunden werden, welchen Namen + OpenOffice.org Writer dem Verzeichnis mit den Benutzereinstellungen + gibt. Unter Debian ist dies momentan + ~/.openoffice.org2. Sollte der Name bei Ihrer + OpenOffice.org-Installation anders sein, so muss das Verzeichnis + users/.openoffice.org2 entsprechend umbenannt werden. + Ist der Name z.B. einfach nur .openoffice, so wäre + folgender Befehl auszuführen: + + mv users/.openoffice.org2 + users/.openoffice + + Dieses Verzeichnis, wie auch das komplette + users-Verzeichnis, muss vom Webserver beschreibbar + sein. Dieses wurde bereits erledigt (siehe ), kann aber erneut + überprüft werden, wenn die Konvertierung nach PDF fehlschlägt. + + + + + + Lx-Office ERP verwenden + + Nach erfolgreicher Installation ist der Loginbildschirm unter + folgender URL erreichbar: + + http://localhost/lx-office-erp/login.pl + + Die Administrationsseite erreichen Sie unter: + + http://localhost/lx-office-erp/admin.pl + + + + + Entwicklerdokumentation + + + Globale Variablen + + + Wie sehen globale Variablen in Perl aus? + + Globale Variablen liegen in einem speziellen namespace namens + "main", der von überall erreichbar ist. Darüber hinaus sind bareword + globs global und die meisten speziellen Variablen sind... + speziell. + + Daraus ergeben sich folgende Formen: + + + + $main::form + + + expliziter Namespace "main" + + + + + $::form + + + impliziter Namespace "main" + + + + + open FILE, "file.txt" + + + FILE ist global + + + + + $_ + + + speziell + + + + + Im Gegensatz zu PHP gibt es kein + Schlüsselwort wie "global", mit dem man + importieren kann. my, our + und local machen was anderes. + + + + my $form + + + lexikalische Variable, gültig bis zum Ende des + Scopes + + + + + our $form + + + $form referenziert ab hier + $PACKAGE::form. + + + + + local $form + + + Alle Änderungen an $form werden am Ende + des scopes zurückgesetzt + + + + + + + Warum sind globale Variablen ein Problem? + + Das erste Problem ist FCGI. + + SQL-Ledger hat fast alles im globalen + namespace abgelegt, und erwartet, dass es da auch wiederzufinden ist. + Unter FCGI müssen diese Sachen auch wieder + aufgeräumt werden, damit sie nicht in den nächsten Request kommen. + Einige Sachen wiederum sollen nicht gelöscht werden, wie zum Beispiel + Datenbankverbindungen, weil die ne Ewigkeit zum initialisieren + brauchen. + + Das zweite Problem ist strict. Unter + strict werden alle Variablen die nicht explizit + mit Package, my oder + our angegeben werden als Tippfehler angemarkert, + was einen vor so mancher Stunde suchen nach einem Bug erspart. Da + globale Variablen aber implizit mit Package angegeben werden, werden + die nicht geprüft, und ein Tippfehler da fällt niemandem auf. + + + + Kanonische globale Variablen + + Um dieses Problem im Griff zu halten gibt es einige wenige + globale Variablen, die kanonisch sind, und alles andere sollte + anderweitig umhergereicht werden. + + Diese Variablen sind im Moment die folgenden neun: + + + + $::form + + + + %::myconfig + + + + $::locale + + + + $::lxdebug + + + + $::auth + + + + $::lx_office_conf + + + + $::instance_conf + + + + $::dispatcher + + + + $::request + + + + Damit diese nicht als Müllhalde misbrauch werden, im Folgenden + eine kurze Erläuterung was man von denn erwarten kann. + + + $::form + + + + Ist ein Objekt der Klasse + "Form" + + + + Wird nach jedem Request gelöscht + + + + Muss auch in Tests und Konsolenscripts vorhanden + sein. + + + + Enthält am Anfang eines Requests die Requestparameter vom + User + + + + Kann zwar intern über Requestgrenzen ein Datenbankhandle + cachen, das wird aber momentan absichtlich zerstört + + + + $::form wurde unter SQL + Ledger als Gottobjekt für alles misbraucht. Sämtliche + alten Funktionen unter SL/ mutieren $::form, das + heißt, alles was einem lieb ist, sollte man vor einem Aufruf von zum + Beispiel IS->retrieve_customer() in + Sicherheit bringen. + + Das Objekt der Klasse Form hat leider im Moment noch viele + zentrale Funktionen Gdie vom internen Zustand abhängen, deshalb + bitte nie einfach zerstören oder überschreiben. Es geht ziemlich + sicher etwas kaputt. + + $::form ist gleichzeitig der Standard Scope + in den Template::Toolkit Templates + außerhalb der Controller: der Ausdruck [% var + %] greift auf $::form->{var} zu. + Unter Controllern ist der Standard Scope anders, da lautet der + Zugriff [% FORM.var %]. In Druckvorlagen sind + normale Variablen ebenfall im $::form Scope, d.h. + <%var%> zeigt auf + $::form->{var}. Innerhalb von Schleifen wird + $::form->{TEMPLATE_ARRAYS}{var}[$index] + bevorzugt, wenn vorhanden. + + + + %::myconfig + + + + Das einzige Hash unter den globalen Variablen + + + + Wird spätestens benötigt wenn auf die Datenbank + zugegriffen wird + + + + Wird bei jedem Request neu erstellt. + + + + Enthält die Userdaten des aktuellen Logins + + + + Sollte nicht ohne Filterung irgendwo gedumpt werden oder + extern serialisiert werden, weil da auch der Datenbankzugriff + für diesenuser drinsteht. + + + + Enthält unter anderem Listenbegrenzung vclimit, + Datumsformat dateformat und Nummernformat numberformat + + + + Enthält Datenbankzugriffinformationen + + + + %::myconfig ist im Moment der Ersatz für + ein Userobjekt. Die meisten Funktionen, die etwas anhand des + aktuellen Users entscheiden müssen, befragen + %::myconfig. + + + + $::locale + + + + Objekt der Klasse "Locale" + + + + Wird pro Request erstellt + + + + Muss auch für Tests und Scripte immer verfügbar + sein. + + + + Cached intern über Requestgrenzen hinweg benutzte + Locales + + + + Lokalisierung für den aktuellen User. Alle Übersetzungen, + Zahlen- und Datumsformatierungen laufen über dieses Objekt. + + + + $::lxdebug + + + + Objekt der Klasse "LXDebug" + + + + Wird global gecached + + + + Muss immer verfügbar sein, in nahezu allen + Funktionen + + + + $::lxdebug stellt Debuggingfunktionen + bereit, wie "enter_sub" und + "leave_sub", mit denen in den alten Modulen ein + brauchbares Tracing gebaut ist, "log_time", mit + der man die Wallclockzeit seit Requeststart loggen kann, sowie + "message" und "dump" mit + denen man flott Informationen ins Log packen kann. + + + + $::auth + + + + Objekt der Klasse "SL::Auth" + + + + Wird global gecached + + + + Hat eine permanente DB Verbindung zur Authdatenbank + + + + Wird nach jedem Request resettet. + + + + $::auth stellt Funktionen bereit um die + Rechte des aktuellen Users abzufragen. Obwohl diese Informationen + vom aktuellen User abhängen wird das Objekt aus + Geschwindigkeitsgründen nur einmal angelegt und dann nach jedem + Request kurz resettet. + + + + $::lx_office_conf + + + + Objekt der Klasse + "SL::LxOfficeConf" + + + + Global gecached + + + + Repräsentation der + config/lx_office.conf[.default]-Dateien + + + + Globale Konfiguration. Configdateien werden zum Start gelesen, + und nicht mehr angefasst. Es ist derzeit nicht geplant, dass das + Programm die Konfiguration ändern kann oder sollte. + + Für die folgende Konfigurationsdatei: + + [debug] + file = /tmp/lxoffice_debug_log.txt + + ist der Key file im Programm als + $::lx_office_conf->{debug}{file} + erreichbar. + + + Zugriff auf die Konfiguration erfolgt im Moment über + Hashkeys, sind also nicht gegen Tippfehler abgesichert. + + + + + $::instance_conf + + + + Objekt der Klasse + "SL::InstanceConfiguration" + + + + wird pro Request neu erstellt + + + + Funktioniert wie $::lx_office_conf, + speichert aber Daten die von der Instanz abhängig sind. Eine Instanz + ist hier eine Mandantendatenbank. Prominentestes Datum ist "eur", + die Information ob Bilanz oder Einnahmenüberschussrechnung gemacht + wird. + + + + $::dispatcher + + + + Objekt der Klasse + "SL::Dispatcher" + + + + wird pro Serverprozess erstellt. + + + + enthält Informationen über die technische Verbindung zum + Server + + + + Der dritte Punkt ist auch der einzige Grund warum das Objekt + global gespeichert wird. Wird vermutlich irgendwann in einem anderen + Objekt untergebracht. + + + + $::request + + + + Hashref (evtl später Objekt) + + + + Wird pro Request neu initialisiert. + + + + Keine Unterstruktur garantiert. + + + + $::request ist ein generischer Platz um + Daten "für den aktuellen Request" abzulegen. Sollte nicht für action + at a distance benutzt werden, sondern um lokales memoizing zu + ermöglichen, das garantiert am Ende des Requests zerstört + wird. + + Vieles von dem, was im moment in $::form + liegt, sollte eigentlich hier liegen. Die groben + Differentialkriterien sind: + + + + Kommt es vom User, und soll unverändert wieder an den + User? Dann $::form, steht da eh schon + + + + Sind es Daten aus der Datenbank, die nur bis zum Ende des + Requests gebraucht werden? Dann $::request + + + + Muss ich von anderen Teilen des Programms lesend drauf + zugreifen? Dann $::request, aber Zugriff über + Wrappermethode + + + + + + + Ehemalige globale Variablen + + Die folgenden Variablen waren einmal im Programm, und wurden + entfernt. + + + $::cgi + + + + war nötig, weil cookie Methoden nicht als + Klassenfunktionen funktionieren + + + + Aufruf als Klasse erzeugt Dummyobjekt was im + Klassennamespace gehalten wird und über Requestgrenzen + leaked + + + + liegt jetzt unter + $::request->{cgi} + + + + + + $::all_units + + + + war nötig, weil einige Funktionen in Schleifen zum Teil + ein paar hundert mal pro Request eine Liste der Einheiten + brauchen, und de als Parameter durch einen Riesenstack von + Funktionen geschleift werden müssten. + + + + Liegt jetzt unter + $::request->{cache}{all_units} + + + + Wird nur in + AM->retrieve_all_units() gesetzt oder + gelesen. + + + + + + %::called_subs + + + + wurde benutzt um callsub deep recursions + abzufangen. + + + + Wurde entfernt, weil callsub nur einen Bruchteil der + möglichen Rekursioenen darstellt, und da nie welche + auftreten. + + + + komplette recursion protection wurde entfernt. + + + + + + + + Dokumentenvorlagen und verfügbare Variablen + + + Einführung + + Dies ist eine Auflistung der Standard-Dokumentenvorlagen und + aller zur Bearbeitung verfügbaren Variablen. Eine Variable wird in + einer Vorlage durch ihren Inhalt ersetzt, wenn sie in der Form + <%variablenname%> verwendet wird. Für + LaTeX- und HTML-Vorlagen kann man die Form dieser Tags auch verändern + (siehe ). + + Früher wurde hier nur über LaTeX gesprochen. Inzwischen + unterstützt Lx-Office aber auch OpenDocument-Vorlagen. Sofern es nicht + ausdrücklich eingeschränkt wird, gilt das im Folgenden gesagte für + alle Vorlagenarten. + + Insgesamt sind technisch gesehen eine ganze Menge mehr Variablen + verfügbar als hier aufgelistet werden. Die meisten davon können + allerdings innerhalb einer solchen Vorlage nicht sinnvoll verwendet + werden. Wenn eine Auflistung dieser Variablen gewollt ist, so kann + diese wie folgt erhalten werden: + + + + SL/Form.pm öffnen und am Anfang die + Zeile "use Data::Dumper;" einfügen. + + + + In Form.pm die Funktion + parse_template suchen und hier die Zeile + print(STDERR Dumper($self)); einfügen. + + + + Einmal per Browser die gewünschte Vorlage "benutzen", z.B. + ein PDF für eine Rechnung erzeugen. + + + + Im error.log Apache steht die Ausgabe + der Variablen $self in der Form 'key' + => 'value',. Alle keys sind + verfügbar. + + + + + + Variablen ausgeben + + Um eine Variable auszugeben, müssen sie einfach nur zwischen die + Tags geschrieben werden, also z.B. + <%variablenname%>. + + Optional kann man auch mit Leerzeichen getrennte Flags angeben, + die man aber nur selten brauchen wird. Die Syntax sieht also so aus: + <%variablenname FLAG1 FLAG2%>. Momentan + werden die folgenden Flags unterstützt: + + + + gilt nur für Zahlenwerte und gibt + den Wert ohne Formatierung, also ohne Tausendertrennzeichen mit + mit einem Punkt als Dezimaltrennzeichen aus. Nützlich z.B., wenn + damit in der Vorlage z.B. von LaTeX gerechnet werden soll. + + + + NOESCAPE unterdrückt das Escapen von + Sonderzeichen für die Vorlagensprache. Wenn also in einer + Variablen bereits gültiger LaTeX-Code steht und dieser von LaTeX + auch ausgewertet und nicht wortwörtlich angezeigt werden soll, so + ist dieses Flag sinnvoll. + + + + Beispiel: + + <%quototal NOFORMAT%> + + + + Verwendung in Druckbefehlen + + In der Admininstration können Drucker definiert werden. Auch im + dort eingebbaren Druckbefehl können die hier aufgelisteten Variablen + und Kontrollstrukturen verwendet werden. Ihr Inhalt wird dabei nach + den Regeln der gängigen Shells formatiert, sodass Sonderzeichen wie + `...` nicht zu unerwünschtem Verhalten + führen. + + Dies erlaubt z.B. die Definition eines Faxes als Druckerbefehl, + für das die Telefonnummer eines Ansprechpartners als Teil der + Kommandozeile verwendet wird. Für ein fiktives Kommando könnte das + z.B. wie folgt aussehen: + + send_fax --number <%if cp_phone2%><%cp_phone2%><%else%><%cp_phone1%><%end%> + + + + Anfang und Ende der Tags verändern + + Der Standardstil für Tags sieht vor, dass ein Tag mit dem + Kleinerzeichen und einem Prozentzeichen beginnt und mit dem + Prozentzeichen und dem Größerzeichen endet, beispielsweise + <%customer%>. Da diese Form aber z.B. in + LaTeX zu Problemen führen kann, weil das Prozentzeichen dort + Kommentare einleitet, kann pro HTML- oder LaTeX-Dokumentenvorlage der + Stil umgestellt werden. + + Dazu werden in die Datei Zeilen geschrieben, die mit dem für das + Format gültigen Kommentarzeichen anfangen, dann + config: enthalten, die entsprechende Option + setzen und bei HTML-Dokumentenvorlagen mit dem Kommentarendzeichen + enden. Beispiel für LaTeX: + + % config: tag-style=($ $) + + Dies würde Lx-Office dazu veranlassen, Variablen zu ersetzen, + wenn sie wie folgt aussehen: ($customer$). Das + äquivalente Beispiel für HTML-Dokumentenvorlagen sieht so aus: + + <!-- config: tag-style=($ $) --> + + + + Zuordnung von den Dateinamen zu den Funktionen + + Diese folgende kurze Auflistung zeigt, welche Vorlage bei + welcher Funktion ausgelesen wird. Dabei ist die Dateiendung + ".ext" geeignet zu ersetzen: + ".tex" für LaTeX-Vorlagen und + ".odt" für OpenDocument-Vorlagen. + + + + bin_list.ext + + + Lagerliste + + + + + check.ext + + + ? + + + + + invoice.ext + + + Rechnung + + + + + packing_list.ext + + + Packliste + + + + + pick_list.ext + + + Sammelliste + + + + + purchase_delivery_order.ext + + + Lieferschein (Einkauf) + + + + + purcharse_order.ext + + + Bestellung an Lieferanten + + + + + request_quotation.ext + + + Anfrage an Lieferanten + + + + + sales_delivery_order.ext + + + Lieferschein (Verkauf) + + + + + sales_order.ext + + + Bestellung + + + + + sales_quotation.ext + + + Angebot an Kunden + + + + + zahlungserinnerung.ext + + + Mahnung (Dateiname im Programm konfigurierbar) + + + + + zahlungserinnerung_invoice.ext + + + Rechnung über Mahngebühren (Dateiname im Programm + konfigurierbar) + + + + + + + Sprache, Drucker und E-Mail + + Angeforderte Sprache und Druckerkürzel in den Dateinamen mit + eingearbeitet. So wird aus der Vorlage + sales_order.ext bei Sprache + de und Druckerkürzel lpr2 + der Vorlagenname sales_order_de_lpr2.ext. + Zusätzlich können für E-Mails andere Vorlagen erstellt werden, diese + bekommen dann noch das Kürzel _email, der + vollständige Vorlagenname wäre dann + sales_order_email_de_lpr2.ext. In allen Fällen + kann eine Standarddatei default.ext hinterlegt + werden. Diese wird verwendet, wenn keine der anderen Varianten + gefunden wird. + + Die vollständige Suchreihenfolge für einen Verkaufsauftrag mit + der Sprache "de" und dem Drucker "lpr2", der per E-Mail im Format PDF + verschickt wird, ist: + + + + sales_order_email_de_lpr2.tex + + + + sales_order_de_lpr2.tex + + + + sales_order.tex + + + + default.tex + + + + Die kurzen Varianten dieser Vorlagentitel müssen dann entweder + Standardwerte anzeigen, oder die angeforderten Werte selbst auswerten, + siehe dazu . + + + + Allgemeine Variablen, die in allen Vorlagen vorhanden + sind + + + Metainformationen zur angeforderten Vorlage + + Diese Variablen liefern Informationen darüber welche Variante + einer Vorlage der Benutzer angefragt hat. Sie sind nützlich für + Vorlagenautoren, die aus einer zentralen Layoutvorlage die einzelnen + Formulare einbinden möchten. + + + + template_meta.formname + + + Basisname der Vorlage. Identisch mit der Zurordnung + zu den Dateinamen ohne die Erweiterung. Ein + Verkaufsauftrag enthält hier + sales_order. + + + + + template_meta.language.description + + + Beschreibung der verwendeten Sprache + + + + + template_meta.language.template_code + + + Vorlagenürzel der verwendeten Sprache, identisch mit dem + Kürzel das im Dateinamen verwendetet wird. + + + + + template_meta.language.output_numberformat + + + Zahlenformat der verwendeten Sprache in der Form + "1.000,00". Experimentell! Nur + interessant für Vorlagen die mit unformatierten Werten + arbeiten. + + + + + template_meta.language.output_dateformat + + + Datumsformat der verwendeten Sprache in der Form + "dd.mm.yyyy". Experimentell! Nur + interessant für Vorlagen die mit unformatierten Werten + arbeiten. + + + + + template_meta.format + + + Das angeforderte Format. Kann im Moment die Werte + pdf, postscript, + html, opendocument, + opendocument_pdf und + excel enthalten. + + + + + template_meta.extension + + + Dateierweiterung, wie im Dateinamen. Wird aus + format entschieden. + + + + + template_meta.media + + + Ausgabemedium. Kann zur Zeit die Werte + screen für Bildschirm, + email für E-Mmail (triggert das + _email Kürzel im Dateinamen), + printer für Drucker, und + queue für Warteschlange enthalten. + + + + + template_meta.printer.description + + + Beschreibung des ausgewählten Druckers + + + + + template_meta.printer.template_code + + + Vorlagenürzel des ausgewählten Druckers, identisch mit + dem Kürzel das im Dateinamen verwendetet wird. + + + + + + + Stammdaten von Kunden und Lieferanten + + + + account_number + + + Kontonummer + + + + + bank + + + Name der Bank + + + + + bank_code + + + Bankleitzahl + + + + + bic + + + Bank-Identifikations-Code (Bank Identifier Code, + BIC) + + + + + business + + + Kunden-/Lieferantentyp + + + + + city + + + Stadt + + + + + contact + + + Kontakt + + + + + country + + + Land + + + + + cp_email + + + Email des Ansprechpartners + + + + + cp_givenname + + + Vorname des Ansprechpartners + + + + + cp_greeting + + + Anrede des Ansprechpartners + + + + + cp_name + + + Name des Ansprechpartners + + + + + cp_phone1 + + + Telefonnummer 1 des Ansprechpartners + + + + + cp_phone2 + + + Telefonnummer 2 des Ansprechpartners + + + + + cp_title + + + Titel des Ansprechpartners + + + + + creditlimit + + + Kreditlimit + + + + + customeremail + + + Email des Kunden; nur für Kunden + + + + + customerfax + + + Faxnummer des Kunden; nur für Kunden + + + + + customernotes + + + Bemerkungen beim Kunden; nur für Kunden + + + + + customernumber + + + Kundennummer; nur für Kunden + + + + + customerphone + + + Telefonnummer des Kunden; nur für Kunden + + + + + discount + + + Rabatt + + + + + email + + + Emailadresse + + + + + fax + + + Faxnummer + + + + + homepage + + + Homepage + + + + + iban + + + Internationale Kontonummer (International Bank Account + Number, IBAN) + + + + + language + + + Sprache + + + + + name + + + Firmenname + + + + + payment_description + + + Name der Zahlart + + + + + payment_terms + + + Zahlungskonditionen + + + + + phone + + + Telefonnummer + + + + + shiptocity + + + Stadt (Lieferadresse) * + + + + + shiptocontact + + + Kontakt (Lieferadresse) * + + + + + shiptocountry + + + Land (Lieferadresse) * + + + + + shiptodepartment1 + + + Abteilung 1 (Lieferadresse) * + + + + + shiptodepartment2 + + + Abteilung 2 (Lieferadresse) * + + + + + shiptoemail + + + Email (Lieferadresse) * + + + + + shiptofax + + + Fax (Lieferadresse) * + + + + + shiptoname + + + Firmenname (Lieferadresse) * + + + + + shiptophone + + + Telefonnummer (Lieferadresse) * + + + + + shiptostreet + + + Straße und Hausnummer (Lieferadresse) * + + + + + shiptozipcode + + + Postleitzahl (Lieferadresse) * + + + + + street + + + Straße und Hausnummer + + + + + taxnumber + + + Steuernummer + + + + + ustid + + + Umsatzsteuer-Identifikationsnummer + + + + + vendoremail + + + Email des Lieferanten; nur für Lieferanten + + + + + vendorfax + + + Faxnummer des Lieferanten; nur für Lieferanten + + + + + vendornotes + + + Bemerkungen beim Lieferanten; nur für Lieferanten + + + + + vendornumber + + + Lieferantennummer; nur für Lieferanten + + + + + vendorphone + + + Telefonnummer des Lieferanten; nur für + Lieferanten + + + + + zipcode + + + Postleitzahl + + + + + + Anmerkung: Sind die shipto*-Felder in den + Stammdaten nicht eingetragen, so haben die Variablen + shipto* den gleichen Wert wie die die + entsprechenden Variablen der Lieferdaten. Das bedeutet, dass sich + einige shipto*-Variablen so nicht in den + Stammdaten wiederfinden sondern schlicht Kopien der + Lieferdatenvariablen sind (z.B. + shiptocontact). + + + + + Informationen über den Bearbeiter + + + + employee_address + + + Adressfeld + + + + + employee_businessnumber + + + Firmennummer + + + + + employee_company + + + Firmenname + + + + + employee_co_ustid + + + Usatzsteuer-Identifikationsnummer + + + + + employee_duns + + + DUNS-Nummer + + + + + employee_email + + + Email + + + + + employee_fax + + + Fax + + + + + employee_name + + + voller Name + + + + + employee_signature + + + Signatur + + + + + employee_taxnumber + + + Steuernummer + + + + + employee_tel + + + Telefonnummer + + + + + + + Informationen über den Bearbeiter + + + + salesman_address + + + Adressfeld + + + + + salesman_businessnumber + + + Firmennummer + + + + + salesman_company + + + Firmenname + + + + + salesman_co_ustid + + + Usatzsteuer-Identifikationsnummer + + + + + salesman_duns + + + DUNS-Nummer + + + + + salesman_email + + + Email + + + + + salesman_fax + + + Fax + + + + + salesman_name + + + voller Name + + + + + salesman_signature + + + Signatur + + + + + salesman_taxnumber + + + Steuernummer + + + + + salesman_tel + + + Telefonnummer + + + + + + + Variablen für die einzelnen Steuern + + + + tax + + + Steuer + + + + + taxbase + + + zu versteuernder Betrag + + + + + taxdescription + + + Name der Steuer + + + + + taxrate + + + Steuersatz + + + + + + + + Variablen in Rechnungen + + + Allgemeine Variablen + + + + creditremaining + + + Verbleibender Kredit + + + + + currency + + + Währung + + + + + cusordnumber + + + Bestellnummer beim Kunden + + + + + deliverydate + + + Lieferdatum + + + + + duedate + + + Fälligkeitsdatum + + + + + globalprojectnumber + + + Projektnummer des ganzen Beleges + + + + + globalprojectdescription + + + Projekbeschreibung des ganzen Beleges + + + + + intnotes + + + Interne Bemerkungen + + + + + invdate + + + Rechnungsdatum + + + + + invnumber + + + Rechnungsnummer + + + + + invtotal + + + gesamter Rechnungsbetrag + + + + + notes + + + Bemerkungen der Rechnung + + + + + orddate + + + Auftragsdatum + + + + + ordnumber + + + Auftragsnummer, wenn die Rechnung aus einem Auftrag + erstellt wurde + + + + + payment_description + + + Name der Zahlart + + + + + payment_terms + + + Zahlungskonditionen + + + + + quodate + + + Angebotsdatum + + + + + quonumber + + + Angebotsnummer + + + + + shippingpoint + + + Versandort + + + + + shipvia + + + Transportmittel + + + + + subtotal + + + Zwischensumme aller Posten ohne Steuern + + + + + total + + + Restsumme der Rechnung (Summe abzüglich bereits + bezahlter Posten) + + + + + transaction_description + + + Vorgangsbezeichnung + + + + + transdate + + + Auftragsdatum wenn die Rechnung aus einem Auftrag + erstellt wurde + + + + + + + Variablen für jeden Posten auf der Rechnung + + + + bin + + + Stellage + + + + + description + + + Artikelbeschreibung + + + + + discount + + + Rabatt als Betrag + + + + + discount_sub + + + Zwischensumme mit Rabatt + + + + + drawing + + + Zeichnung + + + + + ean + + + EAN-Code + + + + + image + + + Grafik + + + + + linetotal + + + Zeilensumme (Anzahl * Einzelpreis) + + + + + longdescription + + + Langtext + + + + + microfiche + + + Mikrofilm + + + + + netprice + + + Nettopreis + + + + + nodiscount_linetotal + + + Zeilensumme ohne Rabatt + + + + + nodiscount_sub + + + Zwischensumme ohne Rabatt + + + + + number + + + Artikelnummer + + + + + ordnumber_oe + + + Auftragsnummer des Originalauftrags, wenn die Rechnung + aus einem Sammelauftrag erstellt wurde + + + + + p_discount + + + Rabatt in Prozent + + + + + partnotes + + + Die beim Artikel gespeicherten Bemerkungen + + + + + partsgroup + + + Warengruppe + + + + + price_factor + + + Der Preisfaktor als Zahl, sofern einer eingestellt + ist + + + + + price_factor_name + + + Der Name des Preisfaktors, sofern einer eingestellt + ist + + + + + projectnumber + + + Projektnummer + + + + + projectdescription + + + Projektbeschreibung + + + + + qty + + + Anzahl + + + + + reqdate + + + Lieferdatum + + + + + runningnumber + + + Position auf der Rechnung (1, 2, 3...) + + + + + sellprice + + + Verkaufspreis + + + + + serialnumber + + + Seriennummer + + + + + tax_rate + + + Steuersatz + + + + + transdate_oe + + + Auftragsdatum des Originalauftrags, wenn die Rechnung + aus einem Sammelauftrag erstellt wurde + + + + + unit + + + Einheit + + + + + weight + + + Gewicht + + + + + Für jeden Posten gibt es ein Unterarray mit den Informationen + über Lieferanten und Lieferantenartikelnummer. Diese müssen mit + einer foreach-Schleife ausgegeben werden, da + für jeden Artikel mehrere Lieferanteninformationen hinterlegt sein + können. Die Variablen dafür lauten: + + + + make + + + Lieferant + + + + + model + + + Lieferantenartikelnummer + + + + + + + Variablen für die einzelnen Zahlungseingänge + + + + payment + + + Betrag + + + + + paymentaccount + + + Konto + + + + + paymentdate + + + Datum + + + + + paymentmemo + + + Memo + + + + + paymentsource + + + Beleg + + + + + + + Benutzerdefinierte Kunden- und Lieferantenvariablen + + Die vom Benutzer definierten Variablen für Kunden und + Lieferanten stehen beim Ausdruck von Einkaufs- und Verkaufsbelegen + ebenfalls zur Verfügung. Ihre Namen setzen sich aus dem Präfix + vc_cvar_ und dem vom Benutzer festgelegten + Variablennamen zusammen. + + Beispiel: Der Benutzer hat eine Variable namens + number_of_employees definiert, die die Anzahl der + Mitarbeiter des Unternehmens enthält. Diese Variable steht dann + unter dem Namen vc_cvar_number_of_employees zur + Verfügung. + + + + + Variablen in Mahnungen und Rechnungen über Mahngebühren + + + Namen der Vorlagen + + Die Namen der Vorlagen werden im System-Menü vom Benutzer + eingegeben. Wird für ein Mahnlevel die Option zur automatischen + Erstellung einer Rechnung über die Mahngebühren und Zinsen + aktiviert, so wird der Name der Vorlage für diese Rechnung aus dem + Vorlagenname für diese Mahnstufe mit dem Zusatz + _invoice gebildet. Weiterhin werden die Kürzel + für die ausgewählte Sprache und den ausgewählten Drucker + angehängt. + + + + Allgemeine Variablen in Mahnungen + + Die Variablen des Verkäufers stehen wie gewohnt als + employee_... zur Verfügung. Die Adressdaten des + Kunden stehen als Variablen name, + street, zipcode, + city, country, + department_1, department_2, + und email zur Verfügung. + + Weitere Variablen beinhalten: + + + + dunning_date + + + Datum der Mahnung + + + + + dunning_duedate + + + Fälligkeitsdatum für diese Mahhnung + + + + + dunning_id + + + Mahnungsnummer + + + + + fee + + + Kummulative Mahngebühren + + + + + interest_rate + + + Zinssatz per anno in Prozent + + + + + total_amount + + + Gesamter noch zu zahlender Betrag als + fee + total_interest + + total_open_amount + + + + + total_interest + + + Zinsen per anno über alle Rechnungen + + + + + total_open_amount + + + Summe über alle offene Beträge der Rechnungen + + + + + + + Variablen für jede gemahnte Rechnung in einer Mahnung + + + + dn_amount + + + Rechnungssumme (brutto) + + + + + dn_duedate + + + Originales Fälligkeitsdatum der Rechnung + + + + + dn_dunning_date + + + Datum der Mahnung + + + + + dn_dunning_duedate + + + Fälligkeitsdatum der Mahnung + + + + + dn_fee + + + Kummulative Mahngebühr + + + + + dn_interest + + + Zinsen per anno für diese Rechnung + + + + + dn_invnumber + + + Rechnungsnummer + + + + + dn_linetotal + + + Noch zu zahlender Betrag (ergibt sich aus + dn_open_amount + dn_fee + + dn_interest) + + + + + dn_netamount + + + Rechnungssumme (netto) + + + + + dn_open_amount + + + Offener Rechnungsbetrag + + + + + dn_ordnumber + + + Bestellnummer + + + + + dn_transdate + + + Rechnungsdatum + + + + + dn_curr + + + Währung, in der die Rechnung erstellt wurde. (Die + Rechnungsbeträge sind aber immer in der Hauptwährung) + + + + + + + Variablen in automatisch erzeugten Rechnungen über + Mahngebühren + + Die Variablen des Verkäufers stehen wie gewohnt als + employee_... zur Verfügung. Die Adressdaten des + Kunden stehen als Variablen name, + street, zipcode, + city, country, + department_1, department_2, + und email zur Verfügung. + + Weitere Variablen beinhalten: + + + + duedate + + + Fälligkeitsdatum der Rechnung + + + + + dunning_id + + + Mahnungsnummer + + + + + fee + + + Mahngebühren + + + + + interest + + + Zinsen + + + + + invamount + + + Rechnungssumme (ergibt sich aus fee + + interest) + + + + + invdate + + + Rechnungsdatum + + + + + invnumber + + + Rechnungsnummer + + + + + + + + Variablen in anderen Vorlagen + + + Einführung + + Die Variablen in anderen Vorlagen sind ähnlich wie in der + Rechnung. Allerdings heißen die Variablen, die mit + inv beginnen, jetzt anders. Bei den Angeboten + fangen sie mit quo für "quotation" an: + quodate für Angebotsdatum etc. Bei Bestellungen + wiederum fangen sie mit ord für "order" an: + ordnumber für Bestellnummer etc. + + Manche Variablen sind in anderen Vorlagen hingegen gar nicht + vorhanden wie z.B. die für bereits verbuchte Zahlungseingänge. Dies + sind Variablen, die vom Geschäftsablauf her in der entsprechenden + Vorlage keine Bedeutung haben oder noch nicht belegt sein + können. + + Im Folgenden werden nur wichtige Unterschiede zu den Variablen + in Rechnungen aufgeführt. + + + + Angebote und Preisanfragen + + + + quonumber + + + Angebots- bzw. Anfragenummer + + + + + reqdate + + + Gültigkeitsdatum (bei Angeboten) bzw. Lieferdatum (bei + Preisanfragen) + + + + + transdate + + + Angebots- bzw. Anfragedatum + + + + + + + Auftragsbestätigungen und Lieferantenaufträge + + + + ordnumber + + + Auftragsnummer + + + + + reqdate + + + Lieferdatum + + + + + transdate + + + Auftragsdatum + + + + + + + Lieferscheine (Verkauf und Einkauf) + + + + cusordnumber + + + Bestellnummer des Kunden (im Verkauf) bzw. Bestellnummer + des Lieferanten (im Einkauf) + + + + + donumber + + + Lieferscheinnummer + + + + + transdate + + + Lieferscheindatum + + + + + Für jede Position eines Lieferscheines gibt es ein Unterarray + mit den Informationen darüber, von welchem Lager und Lagerplatz aus + die Waren verschickt wurden (Verkaufslieferscheine) bzw. auf welchen + Lagerplatz sie eingelagert wurden. Diese müssen mittels einer + foreach-Schleife ausgegeben werden. Diese + Variablen sind: + + + + si_bin + + + Lagerplatz + + + + + si_chargenumber + + + Chargennummer + + + + + si_bestbefore + + + Mindesthaltbarkeit + + + + + si_number + + + Artikelnummer + + + + + si_qty + + + Anzahl bzw. Menge + + + + + si_runningnumber + + + Positionsnummer (1, 2, 3 etc) + + + + + si_unit + + + Einheit + + + + + si_warehouse + + + Lager + + + + + + + Variablen für Sammelrechnung + + + + c0total + + + Gesamtbetrag aller Rechnungen mit Fälligkeit < 30 + Tage + + + + + c30total + + + Gesamtbetrag aller Rechnungen mit Fälligkeit >= 30 + und < 60 Tage + + + + + c60total + + + Gesamtbetrag aller Rechnungen mit Fälligkeit >= 60 + und < 90 Tage + + + + + c90total + + + Gesamtbetrag aller Rechnungen mit Fälligkeit >= 90 + Tage + + + + + total + + + Gesamtbetrag aller Rechnungen + + + + + Variablen für jede Rechnungsposition in Sammelrechnung: + + + + invnumber + + + Rechnungsnummer + + + + + invdate + + + Rechnungsdatum + + + + + duedate + + + Fälligkeitsdatum + + + + + amount + + + Summe der Rechnung + + + + + open + + + Noch offener Betrag der Rechnung + + + + + c0 + + + Noch offener Rechnungsbetrag mit Fälligkeit < 30 + Tage + + + + + c30 + + + Noch offener Rechnungsbetrag mit Fälligkeit >= 30 und + < 60 Tage + + + + + c60 + + + Noch offener Rechnungsbetrag mit Fälligkeit >= 60 und + < 90 Tage + + + + + c90 + + + Noch offener Rechnungsbetrag mit Fälligkeit >= 90 + Tage + + + + + + + + Blöcke, bedingte Anweisungen und Schleifen + + + Einfürhung + + Der Parser kennt neben den Variablen einige weitere + Konstrukte, die gesondert behandelt werden. Diese sind wie + Variablennamen in spezieller Weise markiert: + <%anweisung%> ... <%end%> + + Anmerkung zum <%end%>: Der besseren + Verständlichkeit halber kann man nach dem end + noch beliebig weitere Wörter schreiben, um so zu markieren, welche + Anweisung (z.B. if oder + foreach) damit abgeschlossen wird. + + Beispiel: Lautet der Beginn eines Blockes z.B. + <%if type == "sales_quotation"%>, so könnte + er mit <%end%> genauso abgeschlossen werden + wie mit <%end if%> oder auch + <%end type == "sales_quotation"%>. + + + + Der if-Block + + <%if variablenname%> +... +<%end%> + + Eine normale "if-then"-Bedingung. Die Zeilen zwischen dem "if" + und dem "end" werden nur ausgegeben, wenn die Variable + variablenname gesetzt und ungleich 0 ist. + + Die Bedingung kann auch negiert werden, indem das Wort + not nach dem if verwendet + wird. Beispiel: + + <%if not cp_greeting%> +... +<%end%> + + Zusätzlich zu dem einfachen Test, ob eine Variable gesetzt ist + oder nicht, bietet dieser Block auch die Möglichkeit, den Inhalt + einer Variablen mit einer festen Zeichenkette oder einer anderen + Variablen zu vergleichen. Ob der Vergleich mit einer Zeichenkette + oder einer anderen Variablen vorgenommen wird, hängt davon ab, ob + die rechte Seite des Vergleichsoperators in Anführungszeichen + gesetzt wird (Vergleich mit Zeichenkette) oder nicht (Vergleich mit + anderer Variablen). Zwei Beispiele, die beide Vergleiche + zeigen: + + <%if var1 == "Wert"%> + + Testet die Variable var1 auf + übereinstimmung mit der Zeichenkette Wert. + Mittels != anstelle von == + würde auf Ungleichheit getestet. + + %if var1 == var2%> + + Testet die Variable var1 auf + übereinstimmung mit der Variablen var2. Mittel + != anstelle von == würde + auf Ungleichheit getestet. + + Erfahrere Benutzer können neben der Tests auf (Un-)Gleichheit + auch Tests auf übereinstimmung mit regulären Ausdrücken ohne + Berücksichtung der Groß- und Kleinschreibung durchführen. Dazu dient + dieselbe Syntax wie oben nur mit =~ und + !~ als Vergleichsoperatoren. + + Beispiel für einen Test, ob die Variable + intnotes (interne Bemerkungen) das Wort + schwierig enthält: + + <%if intnotes =~ "schwierig"%> + + + + Der foreach-Block + + <%foreach variablenname%> +... +<%end%> + + Fügt die Zeilen zwischen den beiden Anweisungen so oft ein, + wie das Perl-Array der Variablen variablenname + Elemente enthät. Dieses Konstrukt wird zur Ausgabe der einzelnen + Posten einer Rechnung / eines Angebots sowie zur Ausgabe der Steuern + benutzt. In jedem Durchlauf werden die zeilenbezogenen + Variablen jeweils auf den Wert für die aktuelle Position + gesetzt. + + Die Syntax sieht normalerweise wie folgt aus: + + <%foreach number%> +Position: <%runningnumber%> +Anzahl: <%qty%> +Artikelnummer: <%number%> +Beschreibung: <%description%> +... +<%end%> + + Besonderheit in OpenDocument-Vorlagen: Tritt ein + <%foreach%>-Block innerhalb einer + Tabellenzelle auf, so wird die komplette Tabellenzeile so oft + wiederholt wie notwendig. Tritt er außerhalb auf, so wird nur der + Inhalt zwischen <%foreach%> und + <%end%> wiederholt, nicht aber die + komplette Zeile, in der er steht. + + + + + Markup-Code zur Textformatierung innerhalb von + Formularen + + Wenn der Benutzer innhalb von Formularen in Lx-Office Text + anders formatiert haben möchte, so ist dies begrenzt möglich. + Lx-Office unterstützt die Textformatierung mit HTML-ähnlichen Tags. + Der Benutzer kann z.B. bei der Artikelbeschreibung auf einer Rechnung + Teile des Texts zwischen Start- und Endtags setzen. Dieser Teil wird + dann automatisch in Anweisungen für das ausgewählte Vorlagenformat + (HTML oder PDF über LaTeX) umgesetzt. + + Die unterstützen Formatierungen sind: + + + + <b>Text</b> + + + Text wird in Fettdruck gesetzt. + + + + + <i>Text</i> + + + Text wird kursiv gesetzt. + + + + + <u>Text</u> + + + Text wird unterstrichen. + + + + + <s>Text</s> + + + Text wird durchgestrichen. Diese Formatierung ist nicht + bei der Ausgabe als PDF über LaTeX verfügbar. + + + + + <bullet> + + + Erzeugt einen ausgefüllten Kreis für Aufzählungen (siehe + unten). + + + + + Der Befehl <bullet> funktioniert + momentan auch nur in Latex-Vorlagen. + + + + + Excel-Vorlagen + + + Zusammenfassung + + Dieses Dokument beschreibt den Mechanismus, mit dem + Exceltemplates abgearbeitet werden, und die Einschränkungen, die damit + einhergehen. + + + + Bedienung + + Der Excel Mechanismus muss in der Konfigurationsdatei aktiviert + werden. Die Konfigurationsoption heißt excel_templates = + 1 im Abschnitt [print_templates]. + + Eine Excelvorlage kann dann unter dem Namen einer beliebigen + anderen Vorlage mit der Endung .xls gespeichert + werden. In den normalen Verkaufsmasken taucht nun + Excel als auswählbares Format auf und kann von da + an wie LaTeX- oder OpenOffice-Vorlagen benutzt werden. + + Der Sonderfall der Angebote aus der Kundenmaske ist ebenfalls + eine Angebotsvorlage und wird unter dem internen Namen der Angebote + sales_quotation.xls gespeichert. + + + + Variablensyntax + + Einfache Syntax: + <<varname>> + + Dabei sind << und + >> die Delimiter. Da Excel auf festen + Breiten besteht, kann der Tag künstlich verlängert werden, indem + weitere < oder > + eingefügt werden. Der Tag muss nicht symmetrisch sein. + Beispiel: + + <<<<<varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> + + Um die Limitierung der festen Breite zu reduzieren, können + weitere Variablen in einem Block interpoliert werden. Whitespace wird + dazwishen dann erhalten. Beispiel: + + <<<<<varname1 varname2 varname3>>>>>>>>>>>>>>>>>>>>>>>>>> + + Die Variablen werden interpoliert, und linksbündig mit + Leerzeichen auf die gewünschte Länge aufgefüllt. Ist der String zu + lang, werden überzählige Zeichen abgeschnitten. + + Es ist ausserdem möglich, Daten rechtsbündig darzustellen, wenn + der Block mit einem Leerzeichen anfängt. Beispiel: + + <<<<<< varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> + + Dies würde rechtsbündig triggern. Wenn bei rechtsbündiger + Ausrichtung Text abgeschnitten werden muss, wird er vom linken Ende + entfernt. + + + + Einschränkungen + + Das Excelformat bis 2002 ist ein binäres Format, und kann nicht + mit vertretbarem Aufwand editiert werden. Der Templatemechanismus + beschränkt sich daher darauf, Textstellen exakt durch einen anderen + Text zu ersetzen. + + Aus dem gleichen Grund sind die Kontrolllstrukturen + <%if%> und + <%foreach%> nicht vorhanden. Der Delimiter + <% %> kommt in den Headerinformationen + evtl. vor. Deshalb wurde auf den sichereren Delimiter + << und >> + gewechselt. + + + + + Entwicklung unter FastCGI + + + Allgemeines + + Wenn Änderungen in der Konfiguration von Lx-Office gemacht + werden, muss der Webserver neu gestartet werden. + + Bei der Entwicklung für FastCGI ist auf ein paar Fallstricke zu + achten. Dadurch, dass das Programm in einer Endlosschleife läuft, + müssen folgende Aspekte beachtet werden. + + + + Programmende und Ausnahmen + + Betrifft die Funktionen warn, + die, exit, + carp und confess. + + Fehler, die dass Programm normalerweise sofort beenden (fatale + Fehler), werden mit dem FastCGI Dispatcher abgefangen, um das Programm + am Laufen zu halten. Man kann mit die, + confess oder carp Fehler + ausgeben, die dann vom Dispatcher angezeigt werden. Die Lx-Office + eigene $::form-error()> tut im Prinzip das + Gleiche, mit ein paar Extraoptionen. warn und + exit hingegen werden nicht abgefangen. + warn wird direkt nach STDERR, also in Server Log + eine Nachricht schreiben (sofern in der Konfiguration nicht die + Warnungen in das Lx-Office Log umgeleitet wurden), und + exit wird die Ausführung beenden. + + Prinzipiell ist es kein Beinbruch, wenn sich der Prozess + beendet, fcgi wird ihn sofort neu starten. Allerdings sollte das die + Ausnahme sein. Quintessenz: Bitte kein exit + benutzen, alle anderen Exceptionmechanismen sind ok. + + + + Globale Variablen + + Um zu vermeiden, dass Informationen von einem Request in einen + anderen gelangen, müssen alle globalen Variablen vor einem Request + sauber initialisiert werden. Das ist besonders wichtig im + $::cgi und $::auth Objekt, weil + diese nicht gelöscht werden pro Instanz, sondern persistent gehalten + werden. + + In SL::Dispatcher gibt es einen sauber + abgetrennten Block, der alle kanonischen globalen Variablen listet und + erklärt. Bitte keine anderen einführen ohne das sauber zu + dokumentieren. + + Datenbankverbindungen wird noch ein Guide verfasst werden, wie + man sicher geht, dass man die richtige erwischt. + + + + Performance und Statistiken + + Die kritischen Pfade des Programms sind die Belegmasken, und + unter diesen ganz besonders die Verkaufsrechnungsmaske. Ein Aufruf der + Rechnungsmaske in Lx-Office 2.4.3 stable dauert auf einem Core2duo mit + 4GB Arbeitsspeicher und Ubuntu 9.10 eine halbe Sekunde. In der 2.6.0 + sind es je nach Menge der definierten Variablen 1-2s. Ab der + Moose/Rose::DB Version sind es 5-6s. + + Mit FastCGI ist die neuste Version auf 0,26 Sekunden selbst in + den kritischen Pfaden, unter 0,15 sonst. + + + + Bekannte Probleme + + + Encoding Awareness + + UTF-8 kodierte Installationen sind sehr anfällig gegen + fehlerhfate Encodings unter FCGI. latin9 Installationen behandeln + falsch kodierte Zeichen eher unwissend, und geben sie einfach + weiter. UTF-8 verweigert bei fehlerhaften Programmpfaden kurzerhand + das Ausliefern. Es wird noch daran gearbeitet, alle Fehler da zu + beseitigen. + + + + + + SQL-Upgradedateien + + + Einführung + + + Der alte Mechanismus für SQL-Upgradescripte, der auf einer Versionsnummer beruht und dann in sql/Pg-upgrade nach einem Script für + diese Versionsnummer sucht, schränkt sehr ein, z.B. was die parallele Entwicklung im stable- und unstable-Baum betrifft. + + + + Dieser Mechanismus wurde für Lx-Office 2.4.1 deutlich erweitert. Es werden weiterhin alle Scripte aus sql/Pg-upgrade + ausgeführt. Zusätzlich gibt es aber ein zweites Verzeichnis, sql/Pg-upgrade2. In diesem Verzeichnis muss pro Datenbankupgrade eine + Datei existieren, die neben den eigentlich auszuführenden SQL- oder Perl-Befehlen einige Kontrollinformationen enthält. + + + + Neu sind die Kontrollinformationen, die Abhängigkeiten und Prioritäten definieren können werden, sodass Datenbankscripte zwar in + einer sicheren Reihenfolge ausgeführt werden (z.B. darf ein "ALTER TABLE" erst ausgeführt werden, wenn die Tabelle mit "CREATE TABLE" + angelegt wurde), diese Reihenfolge aber so flexibel ist, dass man keine Versionsnummern mehr braucht. + + + + Lx-Office merkt sich dabei, welches der Upgradescripte in sql/Pg-upgrade2 bereits durchgeführt wurde und führt diese nicht erneut + aus. Dazu dient die Tabelle "schema_info", die bei der Anmeldung automatisch angelegt wird. + + + + + Format der Kontrollinformationen + + + Die Kontrollinformationen sollten sich am Anfang der jeweiligen Upgradedatei befinden. Jede Zeile, die Kontrollinformationen enthält, + hat dabei das folgende Format: + + + + Für SQL-Upgradedateien: + + + -- @key: value + + + Für Perl-Upgradedateien: + + + # @key: value + + + Leerzeichen vor "value" werden entfernt. + + + + Die folgenden Schlüsselworte werden verarbeitet: + + + + + tag + + + Wird zwingend benötigt. Dies ist der "Name" des Upgrades. Dieser "tag" kann von anderen Kontrolldateien in ihren Abhängigkeiten + verwendet werden (Schlüsselwort "depends"). Der "tag" ist auch der Name, der in der Datenbank eingetragen wird. + + + + Normalerweise sollte die Kontrolldatei genau so heißen wie der "tag", nur mit der Endung ".sql" bzw. "pl". + + + + Ein Tag darf nur aus alphanumerischen Zeichen sowie den Zeichen _ - ( ) bestehen. Insbesondere sind Leerzeichen nicht erlaubt und + sollten stattdessen mit Unterstrichen ersetzt werden. + + + + + + charset + + + Empfohlen. Gibt den Zeichensatz an, in dem das Script geschrieben wurde, z.B. "UTF-8". Aus + Kompatibilitätsgründen mit alten Upgrade-Scripten wird bei Abwesenheit des Tags der Zeichensatz "ISO-8859-15" + angenommen. + + + + + + description + + + Benötigt. Eine Beschreibung, was in diesem Update passiert. Diese wird dem Benutzer beim eigentlichen Datenbankupdate + angezeigt. Während der Tag in englisch gehalten sein sollte, sollte die Beschreibung auf Deutsch erfolgen. + + + + + + depends + + + Optional. Eine mit Leerzeichen getrennte Liste von "tags", von denen dieses Upgradescript abhängt. Lx-Office stellt sicher, dass + die in dieser Liste aufgeführten Scripte bereits durchgeführt wurden, bevor dieses Script ausgeführt wird. + + + + Abhängigkeiten werden rekursiv betrachtet. Wenn also ein Script "b" existiert, das von Änderungen in "a" abhängt, und eine neue + Kontrolldatei für "c" erstellt wird, die von Änderungen in "a" und "b" abhängt, so genügt es, in "c" nur den Tag "b" als + Abhängigkeit zu definieren. + + + + Es ist nicht erlaubt, sich selbst referenzierende Abhängigkeiten zu definieren (z.B. "a" -> "b", + "b" -> "c" und "c" -> "a"). + + + + + + priority + + + Optional. Ein Zahlenwert, der die Reihenfolge bestimmt, in der Scripte ausgeführt werden, die die gleichen Abhängigkeitstiefen + besitzen. Fehlt dieser Parameter, so wird der Wert 1000 benutzt. + + + + Dies ist reine Kosmetik. Für echte Reihenfolgen muss "depends" benutzt werden. Lx-Office sortiert die auszuführenden Scripte + zuerst nach der Abhängigkeitstiefe (wenn "z" von "y" abhängt und "y" von "x", so hat "z" eine Abhängigkeitstiefe von 2, "y" von 1 + und "x" von 0. "x" würde hier zuerst ausgeführt, dann "y", dann "z"), dann nach der Priorität und bei gleicher Priorität + alphabetisch nach dem "tag". + + + + + + + + Hilfsscript dbupgrade2_tool.pl + + + Um die Arbeit mit den Abhängigkeiten etwas zu erleichtern, existiert ein Hilfsscript namens + "scripts/dbupgrade2_tool.pl". Es muss aus dem Lx-Office-ERP-Basisverzeichnis heraus aufgerufen werden. Dieses + Tool liest alle Datenbankupgradescripte aus dem Verzeichnis sql/Pg-upgrade2 aus. Es benutzt dafür die gleichen + Methoden wie Lx-Office selber, sodass alle Fehlersituationen von der Kommandozeile überprüft werden können. + + + + Wird dem Script kein weiterer Parameter übergeben, so wird nur eine Überprüfung der Felder und Abhängigkeiten vorgenommen. Man kann + sich aber auch Informationen auf verschiedene Art ausgeben lassen: + + + + + Listenform: "./scripts/dbupgrade2_tool.pl --list" + + + Gibt eine Liste aller Scripte aus. Die Liste ist in der Reihenfolge sortiert, in der Lx-Office die Scripte ausführen würde. Es + werden neben der Listenposition der Tag, die Abhängigkeitstiefe und die Priorität ausgegeben. + + + + + Baumform: "./scripts/dbupgrade2_tool.pl --tree" + + + Listet alle Tags in Baumform basierend auf den Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte, von denen keine + anderen abhängen. Die Unterknoten sind Scripte, die beim übergeordneten Script als Abhängigkeit eingetragen sind. + + + + + Umgekehrte Baumform: "./scripts/dbupgrade2_tool.pl --rtree" + + + Listet alle Tags in Baumform basierend auf den Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte mit der geringsten + Abhängigkeitstiefe. Die Unterknoten sind Scripte, die das übergeordnete Script als Abhängigkeit eingetragen haben. + + + + + Baumform mit Postscriptausgabe: "./scripts/dbupgrade2_tool.pl --graphviz" + + + Benötigt das Tool "graphviz", um mit seiner Hilfe die umgekehrte Baumform in eine Postscriptdatei namens + "db_dependencies.ps" auszugeben. Dies ist vermutlich die übersichtlichste Form, weil hierbei jeder Knoten nur + einmal ausgegeben wird. Bei den Textmodusbaumformen hingegen können Knoten und all ihre Abhängigkeiten mehrfach ausgegeben werden. + + + + + + Scripte, von denen kein anderes Script abhängt: "./scripts/dbupgrade2_tool.pl --nodeps" + + + + Listet die Tags aller Scripte auf, von denen keine anderen Scripte abhängen. + + + + + + + + Translations and languages + + + Introduction + + + Dieser Abschnitt ist in Englisch geschrieben, um + internationalen Übersetzern die Arbeit zu erleichtern. + + + This section describes how localization packages in Lx-Office + are built. Currently the only language fully supported is German, and + since most of the internal messages are held in English the English + version is usable too. + + A stub version of French is included but not functunal at this + point. + + + + File structure + + The structure of locales in Lx-Office is: + + lx-office/locale/<langcode>/ + + where <langcode> stands for an abbreviation of the + language package. The builtin packages use two letter ISO 639-1 codes, + but the actual name is not relevant for the program and can easily be + extended to IETF language + tags (i.e. "en_GB"). In fact the original language packages + from SQL Ledger are named in this way. + + In such a language directory the following files are + recognized: + + + + LANGUAGE + + + This file is mandatory. + + The LANGUAGE file contains the self + descripted name of the language. It should contain a native + representation first, and in parenthesis an english translation + after that. Example: + + Deutsch (German) + + + + + charset + + + This file should be present. + + The charset file describes which + charset a language package is written in and applies to all + other language files in the package. It is possible to write + some language packages without an explicit charset, but it is + still strongly recommended. You'll never know in what + environment your language package will be used, and neither + UTF-8 nor Latin1 are guaranteed. + + The whole content of this file is a string that can be + recognized as a valid charset encoding. Example: + + UTF-8 + + + + + all + + + This file is mandatory. + + The central translation file. It is essentially an inline + Perl script autogenerated by locales.pl. To + generate it, generate the directory and the two files mentioned + above, and execute the following command: + + scripts/locales.pl <langcode> + + Otherwise you can simply copy one of the other languages. + You will be told how many are missing like this: + + $ scripts/locales.pl en +English - 0.6% - 2015/2028 missing + + A file named "missing" will be + generated and can be edited. You can also edit the + "all" file directly. Edit everything you + like to fit the target language and execute + locales.pl again. See how the missing words + get fewer. + + + + + Num2text + + + Legacy code from SQL Ledger. It provides a means for + numbers to be converted into natural language, like + 1523 => one thousand five hundred twenty + three. If you want to provide it, it must be inlinable + Perl code which provides a num2text sub. If + an init sub exists it will be executed + first. + + Only used in the check and receipt printing module. + + + + + special_chars + + + Lx-Office comes with a lot of interfaces to different + formats, some of which are rather picky with their accepted + charset. The special_chars file contains a + listing of chars not suited for different file format and + provides substitutions. It is written in "Simple Ini" style, + containing a block for every file format. + + First entry should be the order of substitution for + entries as a whitespace separated list. All entries are + interpolated, so \n, \x20 + and \\ all work. + + After that every entry is a special char that should be + translated when writing text into such a file. + + Example: + + [Template/XML] +order=& < > \n +&=&amp; +<=&lt; +>=&gt; +\n=<br> + + Note the importance of the order in this example. + Substituting < and > befor & would lead to $gt; become + &amp;gt; + + For a list of valid formats, see the German + special_chars entry. As of this writing the + following are recognized: + + HTML +URL@HTML +Template/HTML +Template/XML +Template/LaTeX +Template/OpenDocument +filenames + + The last of which is very machine dependant. Remember that + a lot of characters are forbidden by some filesystems, for + exmaple MS Windows doesn't like ':' in its files where Linux + doesn't mind that. If you want the files created with your + language pack to be portable, find all chars that could cause + trouble. + + + + + missing + + + This file is not a part of the language package + itself. + + This is a file generated by + scripts/locales.pl while processing your + locales. It's only to have the missing entries singled out and + does not belong to a language package. + + + + + lost + + + This file is not a part of the language package + itself. + + Another file generated by + scripts/locales.pl. If for any reason a + translation does not appear anymore and can be deleted, it gets + moved here. The last 50 or so entries deleted are saved here in + case you made a typo, so that you don't have to translate + everything again. If a tranlsation is missing, the lost file is + checked first. If you maintain a language package, you might + want to keep this safe somewhere. + + + + + + + Stil-Richtlinien + + + Die folgenden Regeln haben das Ziel, den Code möglichst gut les- und wartbar zu machen. Dazu gehört zum Einen, dass der Code + einheitlich eingerückt ist, aber auch, dass Mehrdeutigkeit so weit es geht vermieden wird (Stichworte "Klammern" oder "Hash-Keys"). + + + + Diese Regeln sind keine Schikane sondern erleichtern allen das Leben! + + + + Jeder, der einen Patch schickt, sollte seinen Code vorher überprüfen. Einige der Regeln lassen sich automatisch überprüfen, andere + nicht. + + + + + + Es werden keine echten Tabs sondern Leerzeichen verwendet. + + + + + + Die Einrückung beträgt zwei Leerzeichen. Beispiel: + + + foreach my $row (@data) { + if ($flag) { + # do something with $row + } + + if ($use_modules) { + $row->{modules} = MODULE->retrieve( + id => $row->{id}, + date => $use_now ? localtime() : $row->{time}, + ); + } + + $report->add($row); +} + + + + Öffnende geschweifte Klammern befinden sich auf der gleichen Zeile wie der letzte Befehl. Beispiele: + + sub debug { + ... +} + + oder + + if ($form->{item_rows} > 0) { + ... +} + + + + + Schließende geschweifte Klammern sind so weit eingerückt wie der Befehl / die öffnende schließende Klammer, die den Block gestartet + hat, und nicht auf der Ebene des Inhalts. Die gleichen Beispiele wie bei 3. gelten. + + + + + + Die Wörter "else", "elsif", "while" befinden sich auf der gleichen + Zeile wie schließende geschweifte Klammern. Beispiele: + + + if ($form->{sum} > 1000) { + ... +} elsif ($form->{sum} > 0) { + ... +} else { + ... +} + +do { + ... +} until ($a > 0); + + + + + Parameter von Funktionsaufrufen müssen mit runden Klammern versehen werden. Davon nicht betroffen sind interne Perl-Funktionen, + und grep-ähnliche Operatoren. Beispiel: + + + $main::lxdebug->message("Could not find file."); +%options = map { $_ => 1 } grep { !/^#/ } @config_file; + + + + + Verschiedene Klammern, Ihre Ausdrücke und Leerzeichen: + + + + Generell gilt: Hashkeys und Arrayindices sollten nicht durch Leerzeichen abgesetzt werden. Logische Klammerungen ebensowenig, + Blöcke schon. Beispiel: + + + if (($form->{debug} == 1) && ($form->{sum} - 100 < 0)) { + ... +} + +$array[$i + 1] = 4; +$form->{sum} += $form->{"row_$i"}; +$form->{ $form->{index} } += 1; + +map { $form->{sum} += $form->{"row_$_"} } 1..$rowcount; + + + + + Mehrzeilige Befehle + + + + + + Werden die Parameter eines Funktionsaufrufes auf mehrere Zeilen aufgeteilt, so sollten diese bis zu der Spalte eingerückt + werden, in der die ersten Funktionsparameter in der ersten Zeile stehen. Beispiel: + + + $sth = $dbh->prepare("SELECT * FROM some_table WHERE col = ?", + $form->{some_col_value}); + + + + + Ein Spezialfall ist der ternäre Oprator "?:", der am besten in einer übersichtlichen Tabellenstruktur organisiert + wird. Beispiel: + + + my $rowcount = $form->{"row_$i"} ? $i + : $form->{oldcount} ? $form->{oldcount} + 1 + : $form->{rowcount} - $form->{rowbase}; + + + + + + + Kommentare + + + + + Kommentare, die alleine in einer Zeile stehen, sollten soweit wie der Code eingerückt sein. + + + + Seitliche hängende Kommentare sollten einheitlich formatiert werden. + + + + + Sämtliche Kommentare und Sonstiges im Quellcode ist bitte auf Englisch zu verfassen. So wie ich keine Lust habe, französischen + Quelltext zu lesen, sollte auch der Lx-Office Quelltext für nicht-Deutschsprachige lesbar sein. Beispiel: + + + my $found = 0; +while (1) { + last if $found; + + # complicated check + $found = 1 if // +} + +$i = 0 # initialize $i +$n = $i; # save $i +$i *= $const; # do something crazy +$i = $n; # recover $i + + + + + + + Hashkeys sollten nur in Anführungszeichen stehen, wenn die Interpolation gewünscht ist. Beispiel: + + + $form->{sum} = 0; +$form->{"row_$i"} = $form->{"row_$i"} - 5; +$some_hash{42} = 54; + + + + + Die maximale Zeilenlänge ist nicht bescränkt. Zeilenlängen unterhalb von 79 Zeichen helfen unter bestimmten Bedingungen, aber + wenn die Lesbarkeit unter kurzen Zeilen leidet (wie zum Biespiel in grossen Tabellen), dann ist Lesbarkeit vorzuziehen. + + + + Als Beispiel sei die Funktion print_options aus bin/mozilla/io.pl angeführt. + + + + + + Trailing Whitespace, d.h. Leerzeichen am Ende von Zeilen sind unerwünscht. Sie führen zu unnötigen Whitespaceänderungen, die + diffs verfälschen. + + + + Emacs und vim haben beide recht einfache Methoden zur Entfernung von trailing whitespace. Emacs kennt das Kommande + nuke-trailing-whitespace, vim macht das gleiche manuell über :%s/\s\+$//e Mit :au + BufWritePre * :%s/\s\+$//e wird das an Speichern gebunden. + + + + + + Es wird kein perltidy verwendet. + + + + In der Vergangenheit wurde versucht, perltidy zu verwenden, um einen einheitlichen Stil zu erlangen. Es hat + sich aber gezeigt, dass perltidys sehr eigenwilliges Verhalten, was Zeilenumbrüche angeht, oftmals gut + formatierten Code zerstört. Für den Interessierten sind hier die perltidy-Optionen, die grob den + beschriebenen Richtlinien entsprechen: + + + -syn -i=2 -nt -pt=2 -sbt=2 -ci=2 -ibc -hsc -noll -nsts -nsfs -asc -dsm +-aws -bbc -bbs -bbb -mbl=1 -nsob -ce -nbl -nsbl -cti=0 -bbt=0 -bar -l=79 +-lp -vt=1 -vtc=1 + + + + + STDERR ist tabu. Unkonditionale Debugmeldungen auch. + + + + Lx-Office bietet mit dem Modul LXDebug einen brauchbaren Trace-/Debug-Mechanismus. Es gibt also keinen + Grund, nach STDERR zu schreiben. + + + + Die LXDebug-Methode "message" nimmt als ersten Paramter außerdem eine Flagmaske, für + die die Meldung angezeigt wird, wobei "0" immer angezeigt wird. Solche Meldungen sollten nicht eingecheckt werden und werden in + den meisten Fällen auch vom Repository zurückgewiesen. + + + + + + Alle neuen Module müssen use strict verwenden. + + + + $form, $auth, $locale, $lxdebug und + %myconfig werden derzeit aus dem main package importiert (siehe . Alle anderen + Konstrukte sollten lexikalisch lokal gehalten werden. + + + + + + + diff --git a/doc/dokumentenvorlagen-und-variablen.html b/doc/dokumentenvorlagen-und-variablen.html deleted file mode 100644 index e1dac111b..000000000 --- a/doc/dokumentenvorlagen-und-variablen.html +++ /dev/null @@ -1,1660 +0,0 @@ - - - Dokumentenvorlagen und verfügbare Variablen - - - - - - -

Dokumentenvorlagen und verfügbare Variablen

- -

geschrieben von Moritz - Bunkus. Version: $Id$

- -
- -

Inhaltsverzeichnis

- -
    -
  1. - Inhaltsverzeichnis
    2. - -
  2. Einführung -
    3. - -
  3. - Zuordnung von Dateinamen zu den Funktionen
    4. - -
  4. Variablen ausgeben -
    5. - -
  5. Verwendung in Druckbefehlen -
    6. - -
  6. - Anfang und Ende der Tags verändern
    7. - -
  7. - Allgemeine Variablen, die in allen Vorlagen vorhanden sind
    - -
      -
    1. - Stammdaten von Kunden und Lieferanten
      2. - -
    2. - Informationen über den Bearbeiter
      3. - -
    3. - Informationen über den Verkäufer
      4. - -
    4. - Variablen für jede Steuer
      5. -
    -
    8. - -
  8. - Variablen in Rechnungen - -
      -
    1. - Allgemeine Variablen
      2. - -
    2. - Variablen für jeden Posten auf der Rechnung
      3. - -
    3. - Variablen für die Zahlungseingänge
      4. - -
    4. - Benutzerdefinierte Kunden- und Lieferantenvariablen
      5. -
    -
    9. - -
  9. - Variablen in Mahnungen und Rechnungen über Mahngebühren - -
      -
    1. - Namen der Vorlagen
      2. - -
    2. - Allgemeine Variablen in Mahnungen
      3. - -
    3. - Variablen für jede gemahnte Rechnung in einer Mahnung
      4. - -
    4. - Variablen in automatisch erzeugten Rechnungen über Mahngebühren
      5. -
    -
    10. - -
  10. - Variablen in anderen Vorlagen - -
      -
    1. Angebote und Preisanfragen
      2. -
    2. Auftragsbestätigungen und Lieferantenaufträge
      3. -
    3. Lieferscheine (Verkauf und Einkauf)
      4. -
    4. Sammelrechnung
      5. -
    -
    11. - -
  11. - Blöcke, bedingte Anweisungen und Schleifen - -
      -
    1. - Der if-Block
      2. - -
    2. - Die foreach-Schleife
      3. -
    -
    12. - -
  12. - Markup-Code, der innerhalb von Formularen zur Textformatierung verwendet - werden kann
    13. - -
- -
- -

Einführung

- -

Dies ist eine Auflistung der Standard-Dokumentenvorlagen und aller - zur Bearbeitung verfügbaren Variablen. Eine Variable wird in - einer Vorlage durch ihren Inhalt ersetzt, wenn sie in der Form - <%variablenname%> verwendet wird. Für LaTeX- - und HTML-Vorlagen kann man die Form dieser Tags auch - - verändern. -

- -

Einige Zahlenwerte werden auch in unformatierter Form zur Verfügung - gestellt (also z.B. 35 statt 35,00 oder 12.3 statt 12,30). Der Dezimaltrenner - ist dabei also immer ein Punkt unabhaengig vom eingestellten Zahlenformat. - Diese Variabelen kann man mit der Erweiterung _nofmt (für no-format) aufrufen - (also z.B. netprice = 12,30 -- netprice_nofmt = 12.3). Variabeln die zusätzlich - unformatiert zur Verfügung stehen sind unten als variable[_nofmt] gelistet. - Die Eckigen Klammern weisen also auf eine optionale Verwändung der Erweiterung hin. -

- -

Früher wurde hier nur über LaTeX gesprochen. Inzwischen - unterstützt Lx-Office aber auch OpenDocument-Vorlagen. Sofern - es nicht ausdrücklich eingeschränkt wird, gilt das im - Folgenden gesagte für alle Vorlagenarten.

- -

Insgesamt sind technisch gesehen eine ganze Menge mehr Variablen - verfügbar als hier aufgelistet werden. Die meisten davon können - allerdings innerhalb einer solchen Vorlage nicht sinnvoll verwendet - werden. Wenn eine Auflistung dieser Variablen gewollt ist, so kann diese wie - folgt erhalten werden:

- -
    - -
  1. SL/Form.pm öffnen und am Anfang die Zeile - 
    "use Data::Dumper;"
    einfügen.
    2. - -
  2. In Form.pm die Funktion parse_template - suchen und hier die Zeile 
    print(STDERR Dumper($self));
    - einfügen.
    3. - -
  3. Einmal per Browser die gewünschte Vorlage "benutzen", z.B. ein PDF - für eine Rechnung erzeugen.
    4. - -
  4. Im error.log vom Apache steht die Ausgabe der Variablen - $self in der Form 'key' => 'value',. Alle - keys sind verfügbar.
    5. - -
- - - zum Inhaltsverzeichnis
-
- -

Variablen ausgeben

- -

Um eine Variable auszugeben, müssen sie einfach nur zwischen die - Tags geschrieben werden, also - z.B. <%variablenname%>.

- -

- Optional kann man auch mit Leerzeichen getrennte Flags angeben, die - man aber nur selten brauchen wird. Die Syntax sieht also so - aus: <%variablenname FLAG1 FLAG2%>. Momentan werden - die folgenden Flags unterstützt: -

- -
    -
  • - NOFORMAT gilt nur für Zahlenwerte und gibt den Wert - ohne Formatierung, also ohne Tausendertrennzeichen mit mit einem - Punkt als Dezimaltrennzeichen aus. Nützlich z.B., wenn damit in der - Vorlage z.B. von LaTeX gerechnet werden soll. -
    • - -
  • - NOESCAPE unterdrückt das Escapen von Sonderzeichen für - die Vorlagensprache. Wenn also in einer Variablen bereits gültiger - LaTeX-Code steht und dieser von LaTeX auch ausgewertet und nicht - wortwörtlich angezeigt werden soll, so ist dieses Flag sinnvoll. -
    • -
- -

- Beispiel: <%quototal NOFORMAT%> -

- - - zum Inhaltsverzeichnis
-
- -

Verwendung in Druckbefehlen

- -

- In der Admininstration können Drucker definiert werden. Auch im dort - eingebbaren Druckbefehl können die hier aufgelisteten Variablen und - Kontrollstrukturen verwendet werden. Ihr Inhalt wird dabei nach den - Regeln der gängigen Shells formatiert, sodass Sonderzeichen - wie `...` nicht zu unerwünschtem Verhalten führen. -

- -

- Dies erlaubt z.B. die Definition eines Faxes als Druckerbefehl, für - das die Telefonnummer eines Ansprechpartners als Teil der - Kommandozeile verwendet wird. Für ein fiktives Kommando könnte das - z.B. wie folgt aussehen: -

- -

- send_fax --number <%if cp_phone2%><%cp_phone2%><%else%><%cp_phone1%><%end%> -

- - - zum Inhaltsverzeichnis
-
- -

- Anfang und Ende der Tags verändern

- -

Der Standardstil für Tags sieht vor, dass ein Tag mit dem - Kleinerzeichen und einem Prozentzeichen beginnt und mit dem - Prozentzeichen und dem Größerzeichen endet, - beispielsweise <%customer%>. Da diese Form aber - z.B. in LaTeX zu Problemen führen kann, weil das Prozentzeichen - dort Kommentare einleitet, kann pro HTML- oder - LaTeX-Dokumentenvorlage der Stil umgestellt werden.

- -

Dazu werden in die Datei Zeilen geschrieben, die mit dem für - das Format gültigen Kommentarzeichen anfangen, - dann config: enthalten, die entsprechende Option setzen - und bei HTML-Dokumentenvorlagen mit dem Kommentarendzeichen - enden. Beispiel für LaTeX:

- -

% config: tag-style=($ $)

- -

Dies würde Lx-Office dazu veranlassen, Variablen zu ersetzen, - wenn sie wie folgt aussehen: ($customer$). Das - äquivalente Beispiel für HTML-Dokumentenvorlagen sieht so - aus:

- -

<!-- config: tag-style=($ $) -->

- - - zum Inhaltsverzeichnis
-
- -

- Zuordnung von den Dateinamen zu den Funktionen

- -

Diese folgende kurze Auflistung zeigt, welche Vorlage bei welcher - Funktion ausgelesen wird. Dabei ist die Dateiendung ".ext" - geeignet zu ersetzen: ".tex" fü LaTeX-Vorlagen und - ".odt" für OpenDocument-Vorlagen.

- -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
DateinameBedeutung
bin_list.extLagerliste
check.ext?
invoice.extRechnung
packing_list.extPackliste
pick_list.extSammelliste
purchase_delivery_order.extLieferschein (Einkauf)
purcharse_order.extBestellung an Lieferanten
request_quotation.extAnfrage an Lieferanten
sales_delivery_order.extLieferschein (Verkauf)
sales_order.extBestellung
sales_quotation.extAngebot an Kunden
zahlungserinnerung.extMahnung (Dateiname im Programm konfigurierbar)
zahlungserinnerung_invoice.extRechnung über Mahngebühren (Dateiname im Programm konfigurierbar)
-

- - Sprache, Drucker und E-Mail - -

Angeforderte Sprache und Druckerkürzel in den Dateinamen mit eingearbeitet. So wird aus der Vorlage sales_order.ext bei Sprache de und Druckerkürzel lpr2 der Vorlagenname sales_order_de_lpr2.ext. Zusätzlich können für E-Mails andere Vorlagen erstellt werden, diese bekommen dann noch das Kürzel _email, der vollständige Vorlagenname wäre dann sales_order_email_de_lpr2.ext. In allen Fällen kann eine Standarddatei default.ext hinterlegt werden. Diese wird verwendet, wenn keine der anderen Varianten gefunden wird.

- -

Die vollständige Suchreihenfolge für einen Verkaufsauftrag mit der Sprache "de" und dem Drucker "lpr2", der per E-Mail im Format PDF verschickt wird, ist:

-

- - - - - - -
Reihenfolge der möglichen Vorlagennamen
sales_order_email_de_lpr2.tex
sales_order_de_lpr2.tex
sales_order.tex
default.tex
-

- -

Die kurzen Varianten dieser Vorlagentitel müssen dann entweder Standardwerte anzeigen, oder die angeforderten Werte selbst auswerten, siehe dazu Metadaten in Vorlagen

- - - zum Inhaltsverzeichnis
-
- -

- Allgemeine Variablen, die in allen Vorlagen vorhanden sind

- -

- Metainformationen zur angeforderten Vorlage:

- -

Diese Variablen liefern Informationen darüber welche Variante einer Vorlage der Benutzer angefragt hat. Sie sind nützlich für Vorlagenautoren, die aus einer zentralen Layoutvorlage die einzelnen Formulare einbinden möchten.

- -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
VariablennameBedeutung
template_meta.formnameBasisname der Vorlage. Identisch mit der Zurordnung zu den Dateinamen ohne die Erweiterung. Ein Verkaufsauftrag enthält hier sales_order.
template_meta.language.descriptionBeschreibung der verwendeten Sprache
template_meta.language.template_codeVorlagenürzel der verwendeten Sprache, identisch mit dem Kürzel das im Dateinamen verwendetet wird.
template_meta.language.output_numberformatZahlenformat der verwendeten Sprache in der Form "1.000,00". Experimentell!. Nur interessant für Vorlagen die mit unformatierten Werten arbeiten.
template_meta.language.output_dateformatDatumsformat der verwendeten Sprache in der Form "dd.mm.yyyy". Experimentell!. Nur interessant für Vorlagen die mit unformatierten Werten arbeiten.
template_meta.formatDas angeforderte Format. Kann im Moment die Werte pdf, postscript, html, opendocument, opendocument_pdf und excel enthalten.
template_meta.extensionDateierweiterung, wie im Dateinamen. Wird aus format entschieden.
template_meta.mediaAusgabemedium. Kann zur Zeit die Werte screen für Bildschirm, email für E-Mmail (triggert das _email Kürzel im Dateinamen), printer für Drucker, und queue für Warteschlange enthalten.
template_meta.printer.descriptionBeschreibung des ausgewählten Druckers
template_meta.printer.template_codeVorlagenürzel des ausgewählten Druckers, identisch mit dem Kürzel das im Dateinamen verwendetet wird.
-

- -

- Stammdaten von Kunden und Lieferanten:

- -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
VariablennameBedeutung
account_numberKontonummer
bankName der Bank
bank_codeBankleitzahl
bicBank-Identifikations-Code (Bank Identifier Code, BIC)
businessKunden-/Lieferantentyp
cityStadt
contactKontakt
countryLand
cp_emailEmail des Ansprechpartners
cp_givennameVorname des Ansprechpartners
cp_greetingAnrede des Ansprechpartners
cp_nameName des Ansprechpartners
cp_phone1Telefonnummer 1 des Ansprechpartners
cp_phone2Telefonnummer 2 des Ansprechpartners
cp_titleTitel des Ansprechpartners
creditlimitKreditlimit
customeremailEmail des Kunden; nur für Kunden
customerfaxFaxnummer des Kunden; nur für Kunden
customernotesBemerkungen beim Kunden; nur für Kunden
customernumberKundennummer; nur für Kunden
customerphoneTelefonnummer des Kunden; nur für Kunden
discountRabatt
emailEmailadresse
faxFaxnummer
homepageHomepage
ibanInternationale Kontonummer (International Bank Account Number, IBAN)
languageSprache
nameFirmenname
payment_descriptionName der Zahlart
payment_termsZahlungskonditionen
phoneTelefonnummer
shiptocityStadt (Lieferadresse) - *
shiptocontactKontakt (Lieferadresse) - *
shiptocountryLand (Lieferadresse) - *
shiptodepartment1Abteilung 1 (Lieferadresse) - *
shiptodepartment2Abteilung 2 (Lieferadresse) - *
shiptoemailEmail (Lieferadresse) - *
shiptofaxFax (Lieferadresse) - *
shiptonameFirmenname (Lieferadresse) - *
shiptophoneTelefonnummer (Lieferadresse) - *
shiptostreetStraße und Hausnummer (Lieferadresse) - *
shiptozipcodePostleitzahl (Lieferadresse) - *
streetStraße und Hausnummer
taxnumberSteuernummer
ustidUmsatzsteuer-Identifikationsnummer
vendoremailEmail des Lieferanten; nur für Lieferanten
vendorfaxFaxnummer des Lieferanten; nur für Lieferanten
vendornotesBemerkungen beim Lieferanten; nur für Lieferanten
vendornumberLieferantennummer; nur für Lieferanten
vendorphoneTelefonnummer des Lieferanten; nur für Lieferanten
zipcodePostleitzahl
-

- -

Anmerkung: Sind die - shipto*-Felder in den Stammdaten nicht eingetragen, so haben - die Variablen shipto* den gleichen Wert wie die die - entsprechenden Variablen der Lieferdaten. Das bedeutet, dass sich einige - shipto*-Variablen so nicht in den Stammdaten wiederfinden - sondern schlicht Kopien der Lieferdatenvariablen sind - (z.B. shiptocontact).

- -

- Informationen über den Bearbeiter:

- -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
VariablennameBedeutung
employee_addressAdressfeld
employee_businessnumberFirmennummer
employee_companyFirmenname
employee_co_ustidUsatzsteuer-Identifikationsnummer
employee_dunsDUNS-Nummer
employee_emailEmail
employee_faxFax
employee_namevoller Name
employee_signatureSignatur
employee_taxnumberSteuernummer
employee_telTelefonnummer
-

- -

- Informationen über den Verkäufer (nur bei Verkaufsmasken):

- -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
VariablennameBedeutung
salesman_addressAdressfeld
salesman_businessnumberFirmennummer
salesman_companyFirmenname
salesman_co_ustidUsatzsteuer-Identifikationsnummer
salesman_dunsDUNS-Nummer
salesman_emailEmail
salesman_faxFax
salesman_namevoller Name
salesman_signatureSignatur
salesman_taxnumberSteuernummer
salesman_telTelefonnummer
-

- -

- Variablen für die einzelnen Steuern:

- -

- - - - - - - - - - - - - - - - - - -
VariablennameBedeutung
taxSteuer
taxbasezu versteuernder Betrag
taxdescriptionName der Steuer
taxrateSteuersatz
-

- - - zum Inhaltsverzeichnis
-
- -

Variablen in Rechnungen

- -

Allgemeine Variablen:

- -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
VariablennameBedeutung
creditremainingVerbleibender Kredit
currencyWährung
cusordnumberBestellnummer beim Kunden
deliverydateLieferdatum
duedateFälligkeitsdatum
globalprojectnumberProjektnummer des ganzen Beleges
globalprojectdescriptionProjekbeschreibung des ganzen Beleges
intnotesInterne Bemerkungen
invdateRechnungsdatum
invnumberRechnungsnummer
invtotalgesamter Rechnungsbetrag
notesBemerkungen der Rechnung
orddateAuftragsdatum
ordnumberAuftragsnummer, wenn die Rechnung aus einem Auftrag erstellt wurde
payment_descriptionName der Zahlart
payment_termsZahlungskonditionen
quodateAngebotsdatum
quonumberAngebotsnummer
shippingpointVersandort
shipviaTransportmittel
subtotal[_nofmt]Zwischensumme aller Posten ohne Steuern
totalRestsumme der Rechnung (Summe abzüglich bereits bezahlter Posten)
transaction_descriptionVorgangsbezeichnung
transdateAuftragsdatum wenn die Rechnung aus einem Auftrag erstellt wurde
-

- -

- Variablen für jeden Posten auf der Rechnung:

- -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
VariablennameBedeutung
binStellage
descriptionArtikelbeschreibung
discount[_nofmt]Rabatt als Betrag
discount_sub[_nofmt]Zwischensumme mit Rabatt
drawingZeichnung
eanEAN-Code
imageGrafik
linetotal[_nofmt]Zeilensumme (Anzahl * Einzelpreis)
longdescriptionLangtext
microficheMikrofilm
netprice[_nofmt]Nettopreis
nodiscount_linetotal[_nofmt]Zeilensumme ohne Rabatt
nodiscount_sub[_nofmt]Zwischensumme ohne Rabatt
numberArtikelnummer
ordnumber_oeAuftragsnummer des Originalauftrags, wenn die Rechnung aus einem Sammelauftrag erstellt wurde
p_discountRabatt in Prozent
partnotesDie beim Artikel gespeicherten Bemerkungen
partsgroupWarengruppe
price_factorDer Preisfaktor als Zahl, sofern einer eingestellt ist
price_factor_nameDer Name des Preisfaktors, sofern einer eingestellt ist
projectnumberProjektnummer
projectdescriptionProjektbeschreibung
qty[_nofmt]Anzahl
reqdateLieferdatum
runningnumberPosition auf der Rechnung (1, 2, 3...)
sellprice[_nofmt]Verkaufspreis
serialnumberSeriennummer
tax_rateSteuersatz
transdate_oeAuftragsdatum des Originalauftrags, wenn die Rechnung aus einem Sammelauftrag erstellt wurde
unitEinheit
weightGewicht
-

- -

Für jeden Posten gibt es ein Unterarray mit den Informationen über - Lieferanten und Lieferantenartikelnummer. Diese müssen mit - einer foreach-Schleife ausgegeben werden, da für jeden - Artikel mehrere Lieferanteninformationen hinterlegt sein können. Die - Variablen dafür lauten:

- -

- - - - - - - - - - -
VariablennameBedeutung
makeLieferant
modelLieferantenartikelnummer
-

- -

- Variablen für die einzelnen Zahlungseingänge:

- -

- - - - - - - - - - - - - - - - - - - - - - -
VariablennameBedeutung
paymentBetrag
paymentaccountKonto
paymentdateDatum
paymentmemoMemo
paymentsourceBeleg
-

- -

- Benutzerdefinierte Kunden- und Lieferantenvariablen:

- -

- Die vom Benutzer definierten Variablen für Kunden und - Lieferanten stehen beim Ausdruck von Einkaufs- und Verkaufsbelegen - ebenfalls zur Verfügung. Ihre Namen setzen sich aus dem - Präfix vc_cvar_ und dem vom Benutzer festgelegten - Variablennamen zusammen.

- -

Beispiel: Der Benutzer hat eine Variable - namens number_of_employees definiert, die die Anzahl - der Mitarbeiter des Unternehmens enthält. Diese Variable steht - dann unter dem Namen vc_cvar_number_of_employees zur - Verfügung.

- - - zum Inhaltsverzeichnis
-
- -

Variablen in Mahnungen und Rechnungen über Mahngebühren

- -

Namen der Vorlagen

- -

Die Namen der Vorlagen werden im System-Menü vom Benutzer - eingegeben. Wird für ein Mahnlevel die Option zur automatischen - Erstellung einer Rechnung über die Mahngebühren und Zinsen - aktiviert, so wird der Name der Vorlage für diese Rechnung aus - dem Vorlagenname für diese Mahnstufe mit dem - Zusatz _invoice gebildet. Weiterhin werden die - Kürzel für die ausgewählte Sprache und den - ausgewählten Drucker angehängt.

- -

Allgemeine Variablen in Mahnungen:

- -

Die Variablen des Verkäufers stehen wie gewohnt - als employee_... zur Verfügung. Die Adressdaten des - Kunden stehen als Variablen name, street, - zipcode, city, country, - department_1, department_2, und - email zur Verfügung. -

- -

Weitere Variablen beinhalten:

- -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
VariablennameBedeutung
dunning_dateDatum der Mahnung
dunning_duedateFälligkeitsdatum für diese Mahhnung
dunning_idMahnungsnummer
feeKummulative Mahngebühren
interest_rateZinssatz per anno in Prozent
total_amountGesamter noch zu zahlender Betrag als fee + total_interest + total_open_amount
total_interestZinsen per anno über alle Rechnungen
total_open_amountSumme über alle offene Beträge der Rechnungen
-

- -

- Variablen für jede gemahnte Rechnung in einer Mahnung:

- -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
VariablennameBedeutung
dn_amountRechnungssumme (brutto)
dn_duedateOriginales Fälligkeitsdatum der Rechnung
dn_dunning_dateDatum der Mahnung
dn_dunning_duedateFälligkeitsdatum der Mahnung
dn_feeKummulative Mahngebühr
dn_interestZinsen per anno für diese Rechnung
dn_invnumberRechnungsnummer
dn_linetotalNoch zu zahlender Betrag (ergibt sich aus dn_open_amount + dn_fee + dn_interest)
dn_netamountRechnungssumme (netto)
dn_open_amountOffener Rechnungsbetrag
dn_ordnumberBestellnummer
dn_transdateRechnungsdatum
dn_currWährung, in der die Rechnung erstellt wurde. (Die Rechnungsbeträge - sind aber immer in der Hauptwährung)
-

- -

Variablen in automatisch erzeugten - Rechnungen über Mahngebühren

- -

Die Variablen des Verkäufers stehen wie gewohnt - als employee_... zur Verfügung. Die Adressdaten des - Kunden stehen als Variablen name, street, - zipcode, city, country, - department_1, department_2, und - email zur Verfügung. -

- -

Weitere Variablen beinhalten:

- -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
VariablennameBedeutung
duedateFälligkeitsdatum der Rechnung
dunning_idMahnungsnummer
feeMahngebühren
interestZinsen
invamountRechnungssumme (ergibt sich aus fee + interest)
invdateRechnungsdatum
invnumberRechnungsnummer
-

- - - zum Inhaltsverzeichnis
-
- -

- Variablen in anderen Vorlagen

- -

Die Variablen in anderen Vorlagen sind ähnlich wie in der - Rechnung. Allerdings heißen die Variablen, die mit inv - beginnen, jetzt anders. Bei den Angeboten fangen sie mit quo - für "quotation" an: quodate für Angebotsdatum - etc. Bei Bestellungen wiederum fangen sie mit ord für - "order" an: ordnumber für Bestellnummer etc.

- -

Manche Variablen sind in anderen Vorlagen hingegen gar nicht vorhanden wie - z.B. die für bereits verbuchte Zahlungseingänge. Dies sind - Variablen, die vom Geschäftsablauf her in der entsprechenden Vorlage - keine Bedeutung haben oder noch nicht belegt sein können.

- -

Im Folgenden werden nur wichtige Unterschiede zu den Variablen in - Rechnungen aufgeführt.

- -

Angebote und Preisanfragen

- -

- - - - - - - - - - - - - - -
VariablennameBedeutung
quonumberAngebots- bzw. Anfragenummer
reqdateGültigkeitsdatum (bei Angeboten) bzw. Lieferdatum (bei Preisanfragen)
transdateAngebots- bzw. Anfragedatum
-

- -

Auftragsbestätigungen und Lieferantenaufträge

- -

- - - - - - - - - - - - - - -
VariablennameBedeutung
ordnumberAuftragsnummer
reqdateLieferdatum
transdateAuftragsdatum
-

- -

Lieferscheine (Verkauf und Einkauf)

- -

- - - - - - - - - - - - - - -
VariablennameBedeutung
cusordnumberBestellnummer des Kunden (im Verkauf) bzw. Bestellnummer des Lieferanten (im Einkauf)
donumberLieferscheinnummer
transdateLieferscheindatum
-

- -

Für jede Position eines Lieferscheines gibt es ein Unterarray mit - den Informationen darüber, von welchem Lager und Lagerplatz aus die - Waren verschickt wurden (Verkaufslieferscheine) bzw. auf welchen - Lagerplatz sie eingelagert wurden. Diese müssen mittels - einer foreach-Schleife ausgegeben werden. Diese - Variablen sind:

- - -

Für jede Position eines Lieferscheines gibt es ein Unterarray mit - den Informationen darüber, von welchem Lager und Lagerplatz aus die - Waren verschickt wurden (Verkaufslieferscheine) bzw. auf welchen - Lagerplatz sie eingelagert wurden. Diese müssen mittels - einer foreach-Schleife ausgegeben werden. Diese - Variablen sind:

- -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
VariablennameBedeutung
si_binLagerplatz
si_chargenumberChargennummer
si_bestbeforeMindesthaltbarkeit
si_numberArtikelnummer
si_qtyAnzahl bzw. Menge
si_runningnumberPositionsnummer (1, 2, 3 etc)
si_unitEinheit
si_warehouseLager
-

- -

Sammelrechnung

- -

Variablen für Sammelrechnung:

-

- - - - - - - - - - - - - - - - - - - - - - -
VariablennameBedeutung
c0totalGesamtbetrag aller Rechnungen mit Fälligkeit < 30 Tage
c30totalGesamtbetrag aller Rechnungen mit Fälligkeit >= 30 und < 60 Tage
c60totalGesamtbetrag aller Rechnungen mit Fälligkeit >= 60 und < 90 Tage
c90totalGesamtbetrag aller Rechnungen mit Fälligkeit >= 90 Tage
totalGesamtbetrag aller Rechnungen
-

- -

Variablen für jede Rechnungsposition in Sammelrechnung:

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
VariablennameBedeutung
invnumberRechnungsnummer
invdateRechnungsdatum
duedateFälligkeitsdatum
amountSumme der Rechnung
openNoch offener Betrag der Rechnung
c0Noch offener Rechnungsbetrag mit Fälligkeit < 30 Tage
c30Noch offener Rechnungsbetrag mit Fälligkeit >= 30 und < 60 Tage
c60Noch offener Rechnungsbetrag mit Fälligkeit >= 60 und < 90 Tage
c90Noch offener Rechnungsbetrag mit Fälligkeit >= 90 Tage
-

- - - - - - zum Inhaltsverzeichnis
-
- -

- Blöcke, bedingte Anweisungen und Schleifen

- -

Der Parser kennt neben den Variablen einige weitere Konstrukte, - die gesondert behandelt werden. Diese sind wie Variablennamen in - spezieller Weise markiert: <%anweisung%> - ... <%end%>

- -

Anmerkung zum <%end%>: Der besseren - Verständlichkeit halber kann man nach dem end noch - beliebig weitere Wörter schreiben, um so zu markieren, welche - Anweisung (z.B. if oder foreach) damit - abgeschlossen wird.

- -

Beispiel: Lautet der Beginn eines Blockes - z.B. <%if type == - "sales_quotation"%>, so könnte er mit - <%end%> genauso abgeschlossen werden - wie mit - <%end if%> oder auch - <%end type == - "sales_quotation"%>.

- -

Der if-Block

- -

<%if variablenname%>
- ...
- <%end%>

- -

Eine normale "if-then"-Bedingung. Die Zeilen zwischen - dem "if" und dem "end" werden nur ausgegeben, - wenn die Variable "variablenname" gesetzt und ungleich 0 - ist.

- -

Die Bedingung kann auch negiert werden, indem das Wort - "not" nach dem "if" verwendet - wird. Beispiel: <%if not - cp_greeting%>

- -

Zusätzlich zu dem einfachen Test, ob eine Variable gesetzt ist - oder nicht, bietet dieser Block auch die Möglichkeit, den Inhalt - einer Variablen mit einer festen Zeichenkette oder einer anderen - Variablen zu vergleichen. Ob der Vergleich mit einer Zeichenkette - oder einer anderen Variablen vorgenommen wird, hängt davon ab, ob - die rechte Seite des Vergleichsoperators in Anführungszeichen - gesetzt wird (Vergleich mit Zeichenkette) oder nicht (Vergleich mit - anderer Variablen). Zwei Beispiele, die beide Vergleiche zeigen:

- -

<%if var1 == "Wert"%> - testet die Variable "var1" auf Übereinstimmung mit der - Zeichenkette "Wert". Mittels "!=" anstelle von - "==" würde auf Ungleichheit getestet.

- -

<%if var1 == var2%> testet die - Variable "var1" auf Übereinstimmung mit der Variablen - "var2". Mittels "!=" anstelle von "==" - würde auf Ungleichheit getestet.

- -

Erfahrere Benutzer können neben der Tests auf (Un-)Gleichheit auch - Tests auf Übereinstimmung mit regulären Ausdrücken ohne - Berücksichtung der Groß- und Kleinschreibung durchführen. Dazu dient - dieselbe Syntax wie oben nur mit "=~" und "!~" - als Vergleichsoperatoren.

- -

Beispiel für einen Test, ob die Variable "intnotes" - (interne Bemerkungen) das Wort "schwierig" enthält: - <%if intnotes =~ - "schwierig"%>

- -

Die foreach-Schleife

- -

<%foreach variablenname%>
- ...
- <%end%>

- -

Fügt die Zeilen zwischen den beiden Anweisungen so oft ein, wie das - Perl-Array der Variablen "variablenname" Elemente enthät. Dieses - Konstrukt wird zur Ausgabe der einzelnen Posten einer Rechnung / eines - Angebots sowie zur Ausgabe der Steuern benutzt. In jedem Durchlauf werden - die zeilenbezogenen - Variablen jeweils auf den Wert für die aktuelle Position - gesetzt.

- -

Die Syntax sieht normalerweise wie folgt aus:

- -

<%foreach number%>
- Position: <%runningnumber%>
- Anzahl: <%qty%>
- Artikelnummer: <%number%>
- Beschreibung: <%description%>
- ...
- <%end%>

- -

Besonderheit in OpenDocument-Vorlagen: Tritt ein - <%foreach%>-Block innerhalb einer Tabellenzelle - auf, so wird die komplette Tabellenzeile so oft wiederholt wie - notwendig. Tritt er außerhalb auf, so wird nur der Inhalt - zwischen <%foreach%> und <%end%> - wiederholt, nicht aber die komplette Zeile, in der er steht.

- - - zum Inhaltsverzeichnis
-
- -

- Markup-Code, der innerhalb von Formularen zur Textformatierung - verwendet werden kann

- -

Wenn der Benutzer innhalb von Formularen in Lx-Office Text anders - formatiert haben möchte, so ist dies begrenzt möglich. Lx-Office - unterstützt die Textformatierung mit HTML-ähnlichen Tags. Der - Benutzer kann z.B. bei der Artikelbeschreibung auf einer Rechnung Teile des - Texts zwischen Start- und Endtags setzen. Dieser Teil wird dann automatisch - in Anweisungen für das ausgewählte Vorlagenformat (HTML oder - PDF über LaTeX) umgesetzt.

- -

Die unterstützen Formatierungen sind:

- -

- - - - - - - - - - - - - - - - - - - - - - - - - - -
FormatierungAuswirkung
<b>Text</b>Text wird in fettdruck gesetzt.
<i>Text</i>Text wird kursiv gesetzt.
<u>Text</u>Text wird unterstrichen.
<s>Text</s>Text wird durchgestrichen. Diese Formatierung ist nicht bei der - Ausgabe als PDF über LaTeX verfügbar.
<pagebreak>Erzwingt einen Seitenumbruch (siehe unten).
<bullet>Erzeugt einen ausgefüllten Kreis für Aufzählungen (•) (siehe unten).
-

- -

Eine Besonderheit ist der Befehl <pagebreak>, - der nur in LaTeX-Vorlagen funktioniert und in anderen Vorlagen - einfach gelöscht wird. Dieser erzwingt einen Seitenumbruch nach - der aktuellen Rechnungsposition. Dementsprechend funktioniert er nur - innerhalb von - <%foreach...%>-Schleifen. Weiterhin benötigt - er kein Endtag.

- -

Auch <bullet> funktioniert momentan auch nur in Latex-Vorlagen.

- - - zum Inhaltsverzeichnis
-
- - - diff --git a/doc/excel_templates.txt b/doc/excel_templates.txt deleted file mode 100644 index fe16d6de4..000000000 --- a/doc/excel_templates.txt +++ /dev/null @@ -1,79 +0,0 @@ -Table of Contents ------------------ - -Inhalt der Anleitung -1 Zusammenfassung -2 Bedienung -3 Exceltemplate Syntax -4 Einschränkungen - - - -Zusammenfassung ---------------- - -Dieses Dokument beschreibt den Mechanismus, mit dem Exceltemplates abgearbeitet -werden, und die Einschränkungen die damit einhergehen. - - - -Bedienung ---------- - -Der Excel Mechanismus muss in der Konfigurationsdatei aktiviert werden. Die -Konfigurationsoption heißt: - - $excel_templates = 1; - -Eine Excelvorlage kann dann unter dem Namen einer beliebigen anderen Vorlage mit -der Endung .xls gespeichert werden. In den normalen Verkaufsmasken taucht nun -"Excel" als auswählbares Format auf, und kann von da an bnutzt weren wie Latex -oder OpenOffice Vorlagen. - -Der Sonderfall der Angebote aus der Kundenmaske ist ebenfalls eine -Angebotsvorlage, und wird unter dem internen Namen der Angebote -"sales_quotation.xls" gespeichert. - - - -Exceltemplate Syntax --------------------- - -Einfache Syntax: <> - -Wobei "<<" und ">>" die Delimiter sind. Da Excel auf festen Breiten besteht, -kann der Tag künstlich verlängert werden, indem weitere "<" oder ">" gegefügt -werden. Der Tag muss nicht symmetrisch sein. - -Beispiel: <<<<>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> - -Um die Limitierung der festen Breite zu reduzieren, können weitere Variablen in -einem Block interpoliert werden. Whitespace wird dazwishen dann erhalten. - -Beispiel: <<<<>>>>>>>>>>>>>>>>>>>>>>>>> - -Die Variablen werden interpoliert, und linksbündig mit Leerzeichen auf die -gewünschte Länge aufgefüllt. Ist der String zu lang, werden überzählige Zeichen -abgeschnitten. - -Es ist ausserdem möglich Daten rechtsbündig darzustellen, wenn der Block mit -einem Leerzeichen anfängt. - -Beispiel: <<<<<< varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> - -würde rechtsbündig triggern. Wenn bei rechtsbündiger Ausrichtung Text -abgeschnitten werden muss, wird er vom linken Ende entfernt. - - - -Einschränkungen ---------------- - -Das Excelformat bis 2002 ist ein binäres Format, und kann nicht mit vertretbarem -Aufwand editiert werden. Der Templatemechanismus beschränkt sich daher darauf, -Textstellen _exakt_ durch einen anderen Text zu ersetzen. - -Aus dem gleichen Grund sind die Templatekonstrukte <% if %> und <% foreach %> -nicht vorhanden. Der Delimiter <% %> kommt in den Headerinformationen evtl vor, -deshalb wurde auf den sichereren "<<"/">>" gewechselt. - diff --git a/doc/konfigurationsdatei.txt b/doc/konfigurationsdatei.txt deleted file mode 100644 index 128365bbc..000000000 --- a/doc/konfigurationsdatei.txt +++ /dev/null @@ -1,76 +0,0 @@ -== Lx-Office Konfigurationsdatei ab Version 2.6.3 == - -Seit Lx-Office 2.6.3. gibt es nur noch eine Konfigurationsdatei die benötigt wird - die: 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. - - $ cp config/lx_office.conf.default config/lx_office.conf - -Die Datei config/lx_office.conf.default wird immer eingelesen, Werte die in -config/lx_office.conf stehen überschreiben die Werte aus -config/lx_office.conf.default. Die Datei config/lx_office.conf muss also nur -die Abschintte und Werte enthalten die von config/lx_office.conf.default abweichen. - -Diese Datei (lx_office.conf) ist dann eine installationsspezifische Datei, -d.h. sie enthält bspw. lokale Passwörter und wird auch nicht im Versionsmanagement (git) verwaltet. - -Die Konfiguration ist ferner serverabhängig, d.h. für alle Mandaten, bzw. Datenbanken gleich. - - -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. - -Beim Update von einer älteren Lx-Office Version auf 2.6.3 müssen die -Einstellungen aus den alten Konfigurationsdateien manuell übertragen werden und -die alten Konfigurationsdateien gelöscht oder verschoben werden, sonst kommt es -zu einer Fehlermeldung. diff --git a/doc/languages_howto.txt b/doc/languages_howto.txt deleted file mode 100644 index 15c3b2d62..000000000 --- a/doc/languages_howto.txt +++ /dev/null @@ -1,167 +0,0 @@ -Table of Contents -================= - -1. What's this? -2. File Structue - * LANGUAGE - * charset - * all - * Num2text - * special_chars - * missing - * lost - - -What's this? -============ - -This document describes how localization packages in Lx-Office are built. -Currently the only language fully supported is german, and since most of the -internal messages are held in english the english version is usable too. - -A stub version of french is included, but not functunal at this point. - - -File Structure -============== - -The structure of locales in Lx-Office is: - - lx-office/locale// - -where stands for an abbreviation of the language package. The builtin -packages use two letter ISO 639-1 codes, but the actual name is not relevant for -the program and can easily be extended to IETF language tags (i.e. "en_GB"). In -fact the original language packages from sql ledger are named in this way. - -In such a language directory the following files are recognized: - -LANGUAGE (mandatory) --------------------- - -The LANGUAGE file contains the self descripted name of the language. It should -contain a native representation first, and in parenthesis an english -translation after that. - -Example: - - Deutsch (German) - - -charset (encouraged) --------------------- - -The charset file describes which charset a language package is written in and -applies to all other language files in the package. It is possible to write some -language packages without an explicit charset, but it is still strongly -recommended. You'll never know in what environment your language package will be -used, and neither utf-8 nor latin1 are guaranteed. - -The whole content of this file is a string that can be recognized as a valid -charset encoding. - -Example: - - ISO-8859-1 - - -all (mandatory) ---------------- - -The central translation file. It is essentially an inline perlscript -autogenerated by locales.pl. To generate it, generate the directory and the two -files mentioned above, and execute - - scripts/locales.pl - -or simply copy one of the other languages. You will be told how many are missing -like this: - - $ scripts/locales.pl en - - English - 0.6% - 2015/2028 missing - -A "missing" file will be generated and can be edited. You can also edit the "all" file -directly. Edit everything you like to fit the target language, and execute -locales.pl again. See how the missing words get fewer. - - - -These three files are necessary for a localization to be working. Other files -are optional, but will have special effects: - - -Num2text (optional) -------------------- - -Legacy code from sql ledger. It provides a means for numbers to be converted -into natural language, like 1523 => one thousand five hundred twenty three. If -you want to provide it, it must be inlinable perl code which provides a num2text -sub. If an init sub exists, it will be executed first. - -Only used in the check and receipt printing module. - -special_chars -------------- - -Lx-Office comes with a lot of interfaces to different formats, some of which are -rather picky with their accepted charset. The special_chars file contains a -listing of chars not suited for different file format, and provides -substitutions. It is written in "Simple Ini" style, containing a block for every -file format. - -First entry should be the order of substitution for entries as a whitespace -separated list. All entries are interpolated, so \n, \x20 and \\ all work. - -After that every entry is a special char that should be translated when writing -text into such a file. - -Example: - - [Template/XML] - order=& < > \n - &=& - <=< - >=> - \n=
- -Note the importance of the order in this example. Substituting < and > befor & -would lead to $gt; become &gt; - -For a list of valid formats, see the german special_chars entry. As of this -writing the following are recognized: - - HTML - URL@HTML - Template/HTML - Template/XML - Template/LaTeX - Template/OpenDocument - filenames - -The last of which is very machine dependant. Remember that a lot of characters -are forbidden by some filesystems, for exmaple MS Windows doesn't like ':' in -its files where Linux doesn't mind that. If you want the files created with your -language pack to be portable, find all chars that could cause trouble. - - -missing (not part of language package) --------------------------------------- - -This is a file generated by scripts/locales.pl while processing your locales. -It's only to have the missing entries singled out and does not belong to a -language package. - - -lost (not part of language package) ------------------------------------ - -Another file generated by scripts/locales.pl. If for any reason a translation -does not appear anymore and can be deleted, it gets moved here. The last 50 or -so entries deleted are saved here in case you made a typo, so that you don't -have to translate everything again. If a tranlsation is missing, the lost file -is checked first. If you maintain a language package, you might want to keep -this safe somewhere. It is not part of a language package. - - - diff --git a/doc/programmierstilrichtlinien.txt b/doc/programmierstilrichtlinien.txt deleted file mode 100644 index 4b8b20122..000000000 --- a/doc/programmierstilrichtlinien.txt +++ /dev/null @@ -1,193 +0,0 @@ -Lx-Office Style Guide ---------------------- - -Die folgenden Regeln haben das Ziel, den Code möglichst gut les- und wartbar -zu machen. Dazu gehört zum Einen, dass der Code einheitlich eingerückt ist, -aber auch, dass Mehrdeutigkeit so weit es geht vermieden wird (Stichworte -"Klammern" oder "Hash-Keys"). - -Diese Regeln sind keine Schikane, sondern erleichtern allen das Leben! - -Jeder, der einen Patch schickt, sollte seinen Code vorher überprüfen. -Einige der Regeln lassen sich automatisch überprüfen, andere nicht. - --------------------------------------------------------------------------- - -1. Es werden keine echten iTabs sondern Leerzeichen verwendet. - -2. Die Einrückung beträgt zwei Leerzeichen. - Beispiel: - - foreach my $row (@data) { - if ($flag) { - # do something with $row - } - - if ($use_modules) { - $row->{modules} = MODULE->retrieve( - id => $row->{id}, - date => $use_now ? localtime() : $row->{time}, - ); - } - - $report->add($row); - } - - -3. Öffnende geschweifte Klammern befinden sich auf der gleichen Zeile wie - der letzte Befehl. - Beispiele: - - sub debug { - ... - } - - oder - - if ($form->{item_rows} > 0) { - ... - } - -4. Schließende geschweifte Klammern sind so weit eingerückt wie der Befehl/ - die öffnende schließende Klammer, die den Block gestartet hat, und nicht - auf der Ebene des Inhalts. Die gleichen Beispiele wie bei 3. gelten. - -5. Die Wörter "else" "elsif", "while" befinden sich auf der gleichen - Zeile wie schließende geschweifte Klammern. - Beispiele: - - if ($form->{sum} > 1000) { - ... - } elsif ($form->{sum} > 0) { - ... - } else { - ... - } - - do { - ... - } until ($a > 0); - -6. Parameter von Funktionsaufrufen müssen mit runden Klammern versehen - werden. Davon nicht betroffen sind interne perl Funktionen, - und grep ähnliche Operatoren. - - Beispiel: - - $main::lxdebug->message("Could not find file."); - %options = map { $_ => 1 } grep { !/^#/ } @config_file; - -7. Verschiedene Klammern, Ihre Ausdrücke und Leerzeichen: - - Generell gilt: Hashkeys und Arrayindices sollten _nicht_ durch Leerzeichen - abgesetzt werden. Logische Klammerungen ebensowenig, Blöcke schon. - - - Beispiel: - - if (($form->{debug} == 1) && ($form->{sum} - 100 < 0)) { - ... - } - - $array[$i + 1] = 4; - $form->{sum} += $form->{"row_$i"}; - $form->{ $form->{index} } += 1; - - map { $form->{sum} += $form->{"row_$_"} } 1..$rowcount; - -8. Mehrzeilige Befehle - - 8.1 Werden die Parameter eines Funktionsaufrufes auf mehrere Zeilen - aufgeteilt, so sollten diese bis zu der Spalte eingerückt werden, - in der die ersten Funktionsparameter in der ersten Zeile stehen. - Beispiel: - - $sth = $dbh->prepare("SELECT * FROM some_table WHERE col = ?", - $form->{some_col_value}); - - 8.3 Ein Spezialfall ist der ternäre Oprator "?:", der am besten in einer - übersichtlichen Tabellenstruktur organisiert wird. - - Beispiel: - - my $rowcount = $form->{"row_$i"} ? $i - : $form->{oldcount} ? $form->{oldcount} + 1 - : $form->{rowcount} - $form->{rowbase}; - -9. Kommentare - - 9.1 Kommentare, die alleine in einer Zeile stehen, sollten soweit wie der - Code eingerückt sein. - 9.2 Seitliche hängende Kommentare sollten einheitlich formatiert werden. - - 9.3 Sämtliche Kommentare und Sonstiges im Quellcode ist bitte auf Englisch - zu verfassen. So wie ich keine Lust habe französischen Quelltext zu lesen, - sollte auch der Lx-Office Quelltext für nicht-Deutschsprachige lesbar sein. - - Beispiel: - - my $found = 0; - while (1) { - last if $found; - - # complicated check - $found = 1 if // - } - - $i = 0 # initialize $i - $n = $i; # save $i - $i *= $const; # do something crazy - $i = $n; # recover $i - -10. Hashkeys sollten nur in Anführungszeichen stehen, wenn die Interpolation - gewünscht ist. - - Beispiele: - - $form->{sum} = 0; - $form->{"row_$i"} = $form->{"row_$i"} - 5; - $some_hash{42} = 54; - -11. Die maximale Zeilenlänge ist nicht bescränkt. Zeilenlängen <= 79 - helfen unter bestimmten Bedingungen, aber wenn die Lesbarkeit unter - kurzen Zeilen leidet (wie zum Biespiel in grossen Tabellen), dann - ist Lesbarkeit vorzuziehen. - - Als Beispiel sei print_options aus bin/mozilla/io.pl angeführt. - -12. Trailing Whitespace, d.h. Leerzeichen am Ende von Zeilen sind unerwünscht. - Sie führen zu unnötigen Whitespaceänderungen die diffs verfälschen. - - Emacs und vim haben beide recht einfache Methoden dafür: - emacs kennt das Kommande nuke-trailing-whitespace, - vim macht das gleiche manuell über :%s/\s\+$//e, mit - :au BufWritePre * :%s/\s\+$//e - wird das an speichern gebunden. - -12. Es wird kein perltidy verwendet. - - In der Vergangenheit wurde versucht perltidy zu verwenden um einen - einheitlichen Stil zu erlangen, es hat sich aber gezeigt, dass Perltidys - sehr eigenwilliges Verhaltes was Zeilenumbrüche angeht oftmals gut - formatierten Code zerstört. Für den Interessierten sind hier die perltidy - Optionen, die grob den beschriebenen Richtlinien entsprechen. - - -syn -i=2 -nt -pt=2 -sbt=2 -ci=2 -ibc -hsc -noll -nsts -nsfs -asc -dsm - -aws -bbc -bbs -bbb -mbl=1 -nsob -ce -nbl -nsbl -cti=0 -bbt=0 -bar -l=79 - -lp -vt=1 -vtc=1 - -13. STDERR ist tabu. Unkonditionale Debugmeldungen auch. - - Lx-Office bietet mit dem LXDebug Modul einen brauchbaren Trace/Debug - Mechanismus, es gibt also keinen Grund nach STDERR zu schreiben. - - Die LXDebug Methode "message" nimmt als ersten Paramter außerdem eine - Flagmaske, für die die Meldung angezeigt wird, wobei "0" immer angezeigt - wird. Sollte Meldungen sollten nicht eingecheckt werden, und werden in den - meisten Fällen auch vom Repository zurückgewiesen. - -14. Alle neuen Module müssen use strict verwenden. - - $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/sql-upgrade-dateien.txt b/doc/sql-upgrade-dateien.txt deleted file mode 100644 index 0d750698e..000000000 --- a/doc/sql-upgrade-dateien.txt +++ /dev/null @@ -1,142 +0,0 @@ -Neuer Mechanismus für SQL-Upgradedateien ----------------------------------------- - -Der alte Mechanismus für SQL-Upgradescripte, der auf einer -Versionsnummer beruht und dann in sql/Pg-upgrade nach einem Script für -diese Versionsnummer sucht, schränkt sehr ein, z.B. was die parallele -Entwicklung im stable- und unstable-Baum betrifft. - -Dieser Mechanismus wurde für Lx-Office 2.4.1 deutlich erweitert. Es -werden weiterhin alle Scripte aus sql/Pg-upgrade -ausgeführt. Zusätzlich gibt es aber ein zweites Verzeichnis, -sql/Pg-upgrade2. In diesem Verzeichnis muss pro Datenbankupgrade eine -Datei existieren, die neben den eigentlich auszuführenden SQL- oder -Perl-Befehlen einige Kontrollinformationen enthält. - -Neu sind die Kontrollinformationen, die Abhängigkeiten und Prioritäten -definieren können werden, sodass Datenbankscripte zwar in einer -sicheren Reihenfolge ausgeführt werden (z.B. darf ein "ALTER TABLE" -erst ausgeführt werden, wenn die Tabelle mit "CREATE TABLE" angelegt -wurde), diese Reihenfolge aber so flexibel ist, dass man keine -Versionsnummern mehr braucht. - -Lx-Office merkt sich dabei, welches der Upgradescripte in -sql/Pg-upgrade2 bereits durchgeführt wurde und führt diese nicht -erneut aus. Dazu dient die Tabelle "schema_info", die bei der -Anmeldung automatisch angelegt wird. - -Format der Kontrollinformationen --------------------------------- - -Die Kontrollinformationen sollten sich am Anfang der jeweiligen -Upgradedatei befinden. Jede Zeile, die Kontrollinformationen enthält, -hat dabei das folgende Format: - -Für SQL-Upgradedateien: - --- @key: value - - -Für Perl-Upgradedateien: - -# @key: value - - -Leerzeichen vor "value" werden entfernt. - -Die folgenden Schlüsselworte werden verarbeitet: - -* tag: Wird zwingend benötigt. Dies ist der "Name" des - Upgrades. Dieser "tag" kann von anderen Kontrolldateien in ihren - Abhängigkeiten verwendet werden (Schlüsselwort "depends"). Der "tag" - ist auch der Name, der in der Datenbank eingetragen wird. - - Normalerweise sollte die Kontrolldatei genau so heißen wie der - "tag", nur mit der Endung ".sql" bzw. "pl". - - Ein Tag darf nur aus alphanumerischen Zeichen sowie den Zeichen _ - - ( ) bestehen. Insbesondere sind Leerzeichen nicht erlaubt und - sollten stattdessen mit Unterstrichen ersetzt werden. - -* description: Benötigt. Eine Beschreibung, was in diesem Update - passiert. Diese wird dem Benutzer beim eigentlichen Datenbankupdate - angezeigt. Während der Tag in englisch gehalten sein sollte, sollte - die Beschreibung auf Deutsch erfolgen. - -* depends: Optional. Eine mit Leerzeichen getrennte Liste von "tags", - von denen dieses Upgradescript abhängt. Lx-Office stellt sicher, - dass die in dieser Liste aufgeführten Scripte bereits durchgeführt - wurden, bevor dieses Script ausgeführt wird. - - Abhängigkeiten werden rekursiv betrachtet. Wenn also ein Script "b" - existiert, das von Änderungen in "a" abhängt, und eine neue - Kontrolldatei für "c" erstellt wird, die von Änderungen in "a" und - "b" abhängt, so genügt es, in "c" nur den Tag "b" als Abhängigkeit - zu definieren. - - Es ist nicht erlaubt, sich selbst referenzierende Abhängigkeiten zu - definieren (z.B. "a" -> "b", "b" -> "c" und "c" -> "a"). - -* priority: Optional. Ein Zahlenwert, der die Reihenfolge bestimmt, in - der Scripte ausgeführt werden, die die gleichen Abhängigkeitstiefen - besitzen. Fehlt dieser Parameter, so wird der Wert 1000 benutzt. - - Dies ist reine Kosmetik. Für echte Reihenfolgen muss "depends" - benutzt werden. Lx-Office sortiert die auszuführenden Scripte zuerst - nach der Abhängigkeitstiefe (wenn "z" von "y" abhängt und "y" von - "x", so hat "z" eine Abhängigkeitstiefe von 2, "y" von 1 und "x" von - 0. "x" würde hier zuerst ausgeführt, dann "y", dann "z"), dann nach - der Priorität und bei gleicher Priorität alphabetisch nach dem - "tag". - -Hilfsscript dbupgrade2_tool.pl ------------------------------- - -Um die Arbeit mit den Abhängigkeiten etwas zu erleichtern, existiert -ein Hilfsscript namens "scripts/dbupgrade2_tool.pl". Es muss aus dem -Lx-Office-ERP-Basisverzeichnis heraus aufgerufen werden. Dieses Tool -liest alle Datenbankupgradescripte aus dem Verzeichnis sql/Pg-upgrade2 -aus. Es benutzt dafür die gleichen Methoden wie Lx-Office selber, -sodass alle Fehlersituationen von der Kommandozeile überprüft werden -können. - -Wird dem Script kein weiterer Parameter übergeben, so wird nur eine -Überprüfung der Felder und Abhängigkeiten vorgenommen. Man kann sich -aber auch Informationen auf verschiedene Art ausgeben lassen: - -1. Listenform: "./scripts/dbupgrade2_tool.pl --list" - - Gibt eine Liste aller Scripte aus. Die Liste ist in der Reihenfolge - sortiert, in der Lx-Office die Scripte ausführen würde. Es werden - neben der Listenposition der Tag, die Abhängigkeitstiefe und die - Priorität ausgegeben. - -2. Baumform: "./scripts/dbupgrade2_tool.pl --tree" - - Listet alle Tags in Baumform basierend auf den Abhängigkeiten - auf. Die "Wurzelknoten" sind dabei die Scripte, von denen keine - anderen abhängen. Die Unterknoten sind Scripte, die beim - übergeordneten Script als Abhängigkeit eingetragen sind. - -3. Umgekehrte Baumform: "./scripts/dbupgrade2_tool.pl --rtree" - - Listet alle Tags in Baumform basierend auf den Abhängigkeiten auf. - Die "Wurzelknoten" sind dabei die Scripte mit der geringsten - Abhängigkeitstiefe. Die Unterknoten sind Scripte, die das - übergeordnete Script als Abhängigkeit eingetragen haben. - -4. Baumform mit Postscriptausgabe: "./scripts/dbupgrade2_tool.pl --graphviz" - - Benötigt das Tool "graphviz", um mit seiner Hilfe die Baumform aus - 3. in eine Postscriptdatei namens "db_dependencies.ps" - auszugeben. Dies ist vermutlich die übersichtlichste Form, weil - hierbei jeder Knoten nur einmal ausgegeben wird. Bei den - Textmodusbaumformen hingegen können Knoten und all ihre - Abhängigkeiten mehrfach ausgegeben werden. - -5. Scripte, von denen kein anderes Script abhängt: - "./scripts/dbupgrade2_tool.pl --nodeps" - - Listet die Tags aller Scripte auf, von denen keine anderen Scripte - abhängen. -