X-Git-Url: http://wagnertech.de/git?a=blobdiff_plain;f=doc%2Fdokumentation.xml;h=60713bd74c990807de8019a684fe63d749ec317e;hb=7ff9c8f696520daa18c603a001263f45824b7c69;hp=e906d15e62ea2d9c4809e79c2c53979ad90585c6;hpb=539f5981ec91e07c2d0964f4734c2a9ce98ae32c;p=kivitendo-erp.git diff --git a/doc/dokumentation.xml b/doc/dokumentation.xml index e906d15e6..60713bd74 100644 --- a/doc/dokumentation.xml +++ b/doc/dokumentation.xml @@ -1,8 +1,8 @@ - - Lx-Office: Installation, Konfiguration, Entwicklung + + kivitendo 3.0.0: Installation, Konfiguration, Entwicklung Aktuelle Hinweise @@ -11,73 +11,89 @@ - 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/ + im kivitendo-Forum: https://forum.kivitendo.org/ - - Installation und Grundkonfiguration + + Übersicht + + + Die Installation von kivitendo umfasst mehrere Schritte. Die folgende Liste kann sowohl für Neulinge als auch für alte Hasen als + Übersicht und Stichpunktliste zum Abhaken dienen, um eine Version mit minimalen Features möglichst schnell zum Laufen zu kriegen. + + + + Voraussetzungen überprüfen: kivitendo benötigt gewisse Ressourcen und benutzt weitere + Programme. Das Kapitel "" erläutert diese. Auch die Liste der benötigten Perl-Module + befindet sich hier. + + Installation von kivitendo: Diese umfasst die "" sowie grundlegende Einstellungen, die der "" erläutert. + + Konfiguration externer Programme: hierzu gehören die Datenbank ("") und der Webserver (""). + + Benutzerinformationen speichern können: man benötigt mindestens eine Datenbank, in der + Informationen zur Authentifizierung sowie die Nutzdaten gespeichert werden. Wie man das als Administrator macht, verrät "". + + Benutzer, Gruppen und Datenbanken anlegen: wie dies alles zusammenspielt erläutert "". + + Los geht's: alles soweit erledigt? Dann kann es losgehen: "" + + + + Alle weiteren Unterkapitel in diesem Kapitel sind ebenfalls wichtig und dienen sollten vor einer ernsthaften Inbetriebnahme gelesen + werden. + + + Benötigte Software und Pakete Betriebssystem - Lx-Office ist für Linux konzipiert, und sollte auf jedem + kivitendo 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: + Mitte 2012 sind das folgende Systeme, von denen bekannt ist, + dass kivitendo auf ihnen läuft: - - 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" (hier muss allerdings das Modul FCGI in der Version >= 0.72 compiled werden) + + + 7.0 "Wheezy" + + - Debian 6.0 Squeeze + Ubuntu 10.04 LTS "Lucid Lynx", 12.04 LTS "Precise Pangolin" und 12.10 "Oneiric Ocelot"` - openSUSE 11.2 - - - - openSUSE 11.3 + openSUSE 12.1 und 12.2 @@ -85,142 +101,84 @@ - Fedora 13 - - - - Fedora 14 + Fedora 16 und 17 + - 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. + + Benötigte Perl-Pakete installieren - Zur Installation das Paket in das entpackte Lx-Office - Verzeichnis entpacken: + Zum Betrieb von kivitendo werden zwingend ein Webserver (meist + Apache) und ein Datenbankserver (PostgreSQL, mindestens v8.2) + benötigt. - tar xzf lx-erp-perl-libs-compat-v2.tar.gz - /path/to/lx-office/ + Zusätzlich benötigt kivitendo einige Perl-Pakete, die nicht Bestandteil einer Standard-Perl-Installation sind. Um zu + überprüfen, ob die erforderlichen Pakete installiert und aktuell genug sind, wird ein Script mitgeliefert, das wie folgt aufgerufen + wird: - Zusätzlich müssen dann noch die folgenden Pakete installiert - weerden + ./scripts/installation_check.pl - libbit-vector-perl libsub-exporter-perl libclone-perl - libclass-factory-util-perl + Die vollständige Liste der benötigten Perl-Module lautet: - Danach sollte der Installationscheck (siehe ) die enthaltenen Pakete erkennen. - + + parent (nur bei Perl vor 5.10.1) - - Pakete + Archive::Zip - Zum Betrieb von Lx-Office werden zwingend ein Webserver (meist - Apache) und ein Datenbankserver (PostgreSQL, mindestens v8.2) - benötigt. + Config::Std - Zusätzlich benötigt Lx-Office die folgenden Perl-Pakete, die - nicht Bestandteil einer Standard-Perl-Installation sind: + DateTime - - - parent - + DBI - - Archive::Zip - + DBD::Pg - - Config::Std - + Email::Address - - DateTime - + Email::MIME - - DBI - + FCGI (nicht Versionen 0.68 bis 0.71 inklusive; siehe ) - - DBD::Pg - + JSON - - Email::Address - + List::MoreUtils - - JSON - + Net::SMTP::SSL (optional, bei E-Mail-Versand über SSL; siehe Abschnitt "") - - List::MoreUtils - + Net::SSLGlue (optional, bei E-Mail-Versand über TLS; siehe Abschnitt "") - - Params::Validate - + Params::Validate - - PDF::API2 - + PDF::API2 - - Rose::Object - + Rose::Object - - Rose::DB - + Rose::DB - - Rose::DB::Object - + Rose::DB::Object - - Template - + Template - - Text::CSV_XS - + Text::CSV_XS - - Text::Iconv - + Text::Iconv - - URI - + URI - - XML::Writer - + XML::Writer - - YAML - + YAML + Seit v2.7.0 sind die folgenden Pakete hinzugekommen: Email::MIME, Net::SMTP::SSL, + Net::SSLGlue. + Gegenüber Version 2.6.0 sind zu dieser Liste 2 Pakete hinzugekommen, URI und - XML::Writer sind notwendig. Ohne startet Lx-Office + XML::Writer sind notwendig. Ohne startet kivitendo nicht. Gegenüber Version 2.6.1 sind parent, @@ -233,50 +191,68 @@ Email::Address und List::MoreUtils sind schon länger feste - Abhängigkeiten, wurden aber bisher mit Lx-Office mitgeliefert. Beide + Abhängigkeiten, wurden aber bisher mit kivitendo 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. + + Debian und Ubuntu + + Alle benötigten Perl-Pakete stehen für Debian und Ubuntu als Debian-Pakete zur Verfügung. Sie können mit folgendem Befehl + installiert werden: + + apt-get install apache2 libarchive-zip-perl libclone-perl \ + libconfig-std-perl libdatetime-perl libdbd-pg-perl libdbi-perl \ + libemail-address-perl libemail-mime-perl libfcgi-perl libjson-perl \ + liblist-moreutils-perl libnet-smtp-ssl-perl libnet-sslglue-perl \ + libparams-validate-perl libpdf-api2-perl librose-db-object-perl \ + librose-db-perl librose-object-perl libsort-naturally-perl \ + libstring-shellquote-perl libtemplate-perl libtext-csv-xs-perl \ + libtext-iconv-perl liburi-perl libxml-writer-perl libyaml-perl \ + postgresql + + + + Fedora Core - Für Debian oder Ubuntu benötigen Sie diese Pakete: + Für Fedora Core stehen die meisten der benötigten Perl-Pakete als RPM-Pakete zur Verfügung. Sie können mit folgendem Befehl installeirt werden: - 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 + yum install httpd perl-Archive-Zip perl-Clone perl-DBD-Pg \ + perl-DBI perl-DateTime perl-Email-Address perl-Email-MIME perl-FCGI \ + perl-JSON perl-List-MoreUtils perl-Net-SMTP-SSL perl-Net-SSLGlue \ + perl-PDF-API2 perl-Params-Validate perl-Rose-DB perl-Rose-DB-Object \ + perl-Rose-Object perl-Sort-Naturally perl-String-ShellQuote \ + perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv perl-URI \ + perl-XML-Writer perl-YAML perl-parent postgresql-server - Für Fedora Core benötigen Sie diese Pakete: + Zusätzlich müssen einige Pakete aus dem CPAN installiert werden. Dazu können Sie die folgenden Befehle nutzen: - 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 + yum install perl-CPAN +cpan Config::Std - 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 + + openSUSE - 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. + Für openSUSE stehen die meisten der benötigten Perl-Pakete als RPM-Pakete zur Verfügung. Sie können mit folgendem Befehl + installiert 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: + zypper install apache2 perl-Archive-Zip perl-Clone \ + perl-Config-Std perl-DBD-Pg perl-DBI perl-DateTime perl-Email-Address \ + perl-Email-MIME perl-FastCGI perl-JSON perl-List-MoreUtils \ + perl-Net-SMTP-SSL perl-Net-SSLGlue perl-PDF-API2 perl-Params-Validate \ + perl-Sort-Naturally perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv \ + perl-URI perl-XML-Writer perl-YAML postgresql-server - ./scripts/installation_check.pl + Zusätzlich müssen einige Pakete aus dem CPAN installiert werden. Dazu können Sie die folgenden Befehle nutzen: + + yum install perl-CPAN +cpan Rose::Db::Object + + @@ -284,152 +260,163 @@ xreflabel="Manuelle Installation des Programmpaketes"> 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: + Die kivitendo ERP Installationsdatei (kivitendo-erp-3.0.0.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 + cd /var/www +tar xvzf kivitendo-erp-3.0.0.tgz - Verändern Sie evtl. noch den Namen des Verzeichnisses mit + Wechseln Sie in das entpackte Verzeichnis: - mv lxoffice-erp/ lx-erp/ + cd kivitendo-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). + 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. Die Benutzer- und + Gruppennamen sind 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 + chown -R www-data users spool webdav - Weiterhin muss der Webserver-Benutzer im Verzeichnis - templates Verzeichnisse für jeden neuen Benutzer, - der in lx-office angelegt wird, anlegen dürfen: + Weiterhin muss der Webserver-Benutzer in den Verzeichnissen templates und users + Unterverzeichnisse für jeden neuen Benutzer anlegen dürfen, der in kivitendo angelegt wird: - chgrp www-data lx-office-erp/templates -chmod g+w lx-office-erp/templates + chown www-data templates users - Lx-Office-Konfigurationsdatei + kivitendo-Konfigurationsdatei - - Einführung + + 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. - + In kivitendo gibt es nur noch eine Konfigurationsdatei, + die benötigt wird: config/kivitendo.conf (kurz: + "die Hauptkonfigurationsdatei"). Diese muss bei der Erstinstallation + von kivitendo bzw. der Migration von älteren Versionen angelegt + werden. - - Als Vorlage dient die Datei config/lx_office.conf.default (kurz: "die Default-Datei"): - + Als Vorlage dient die Datei + config/kivitendo.conf.default (kurz: "die + Default-Datei"): - $ cp config/lx_office.conf.default config/lx_office.conf + $ cp config/kivitendo.conf.default config/kivitendo.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. - + 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 + Abschnitte 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. - + + + Vor der Umbenennung in kivitendo hieß diese Datei noch config/lx_office.conf. Aus Gründen der Kompatibilität + wird diese Datei eingelesen, sofern die Datei config/kivitendo.conf nicht existiert. + + - - Die Konfiguration ist ferner serverabhängig, d.h. für alle Mandaten, bzw. Datenbanken gleich. - - + 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 + + Abschnitte und Parameter - - Die Konfigurationsdatei besteht aus mehreren Teilen, die entsprechend kommentiert sind: - + 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 - + + authentication (siehe Abschnitt "" in diesem Kapitel) - - Die üblicherweise wichtigsten Parameter, die am Anfang einzustellen oder zu kontrollieren sind, sind: - + authentication/database - [authentication] + authentication/ldap + + system + + features (siehe Kapitel "") + + paths + + applications + + environment + + mail_delivery (siehe Abschnitt ") + + 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 +db = kivitendo_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. - - + 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. - - Versionen vor 2.6.3 + Nutzt man den Taskserver für wiederkehrende Rechnungen, + muss unter [task_server] ein Login eines Benutzers + angegeben werden, mit dem sich der Taskserver an kivitendo bei der + Datenbank anmeldet, die dem Benutzer zugewiesen ist. - - 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. - + Für Entwickler finden sich unter [debug] + wichtige Funktionen, um die Fehlersuche zu erleichtern. + - - 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. - - + + Versionen vor 2.6.3 + + In älteren kivitendo 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 kivitendo-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 kivitendo eine + entsprechende Fehlermeldung an. + @@ -440,20 +427,23 @@ dbcharset = UTF-8 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. + Bei aktuellen Serverinstallationen braucht man hier meist nicht + eingreifen + + Dieses kann überprüft werden: ist das Encoding der Datenbank + “template1” “UTF8”, so braucht man nichts weiteres diesbezüglich + unternehmen. Zum Testen: + + su postgres +echo '\l' | psql +exit - 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: + Ubuntu kann dies z.B. für PostgreSQL 8.2 mit dem folgenden Befehl + getan werden: - pg_createcluster --locale=de_DE.UTF-8 --encoding=UTF-8 - 8.2 clustername + pg_createcluster --locale=de_DE.UTF-8 --encoding=UTF-8 8.2 clustername Die Datenbankversionsnummer muss an die tatsächlich verwendete Versionsnummer angepasst werden. @@ -462,42 +452,35 @@ dbcharset = UTF-8 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. + kivitendo mit ISO-8859-15 als Encoding betrieben werden. - Das Encoding einer Datenbank kann in psql mit + Das Encoding einer Datenbank kann in psql mit \l geprüft werden. Änderungen an Konfigurationsdateien - In der Datei postgresql.conf, die je nach + 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 + /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 kivitendo 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: + was mit dem Wert * geschieht. - local all lxoffice password host all lxoffice 127.0.0.1 - 255.255.255.255 password + 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. sinnvoll ist es nur die + nögiten Verbindungen immer zuzulassen, für eine lokal laufenden + Datenbank zum Beispiel: - + local all kivitendo password +host all kivitendo 127.0.0.1 255.255.255.255 password @@ -505,26 +488,14 @@ dbcharset = UTF-8 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'; + Melden Sie sich dafür als Benutzer “postgres” an der Datenbank an: + su - postgres +psql template1 - 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. + führen Sie die folgenden Kommandos aus: - + create language 'plpgsql'; +\q @@ -535,14 +506,16 @@ dbcharset = UTF-8 anlegen. Ein Beispiel, wie Sie einen neuen Benutzer anlegen können: - su - postgres createuser -d -P - lxoffice + Die Frage, ob der neue User Superuser sein soll, können Sie mit nein + beantworten, genauso ist die Berechtigung neue User (Roles) zu + generieren nicht nötig. + su - postgres +createuser -d -P kivitendo +exit Wenn Sie später einen Datenbankzugriff konfigurieren, verändern - Sie den evtl. voreingestellten Benutzer “postgres” auf “lxoffice” bzw. + Sie den evtl. voreingestellten Benutzer “postgres” auf “kivitendo” bzw. den hier gewählten Benutzernamen. - - @@ -555,7 +528,7 @@ dbcharset = UTF-8 Für einen deutlichen Performanceschub sorgt die Ausführung mittels FastCGI/FCGI. Die Einrichtung wird ausführlich im Abschnitt - beschrieben. + beschrieben. Der Zugriff auf das Programmverzeichnis muss in der Apache @@ -564,23 +537,31 @@ dbcharset = UTF-8 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> + AddHandler cgi-script .pl +Alias /kivitendo-erp/ /var/www/kiviteno-erp/ + +<Directory /var/www/kivitendo-erp> + Options ExecCGI Includes FollowSymlinks +</Directory> + +<Directory /var/www/kivitendo-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. + das kivitendo-Archiv entpacket haben. - Achtung: Vor den einzelnen Optionen muss bei einigen - Distributionen ein Plus ‘+’ gesetzt werden. + + 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 + EnableSendfile Off Warum FastCGI? - Perl Programme (wie Lx-Office eines ist) werden nicht statisch + Perl Programme (wie kivitendo 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 + müssen, ist die Funktionalität von kivitendo 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 + führt dazu dass ein kivitendo Aufruf der Kernmasken mittlerweile deutlich länger dauert als früher, und dass davon 90% für das Laden der Module verwendet wird. @@ -644,22 +625,21 @@ dbcharset = UTF-8 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. - + FCGI-Versionen ab 0.69 und bis zu 0.71 inklusive sind extrem strict in der Behandlung von Unicode, und verweigern + bestimmte Eingaben von kivitendo. Falls es Probleme mit Umlauten in Ihrere Installation gibt, muss zwingend Version 0.68 oder + aber Version 0.72 und neuer eingesetzt werden. - Mit CPAN lässt sie sich die Vorgängerversion wie folgt - installieren: + Mit CPAN lässt sie sich die Vorgängerversion wie folgt + installieren: - force install M/MS/MSTROUT/FCGI-0.68.tar.gz + force install M/MS/MSTROUT/FCGI-0.68.tar.gz + Konfiguration des Webservers - Bevor Sie versuchen, eine Lx-Office Installation unter FCGI + Bevor Sie versuchen, eine kivitendo 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 @@ -670,28 +650,28 @@ dbcharset = UTF-8 a2enmod fcgid - Die Konfiguration für die Verwendung von Lx-Office mit FastCGI + Die Konfiguration für die Verwendung von kivitendo 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"). + dem Installationspfad von kivitendo im Dateisystem + ("/path/to/kivitendo-erp") und der URL + unterschieden, unter der kivitendo im Webbrowser erreichbar ist + ("/url/for/kivitendo-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/ + AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fcgi +Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/ -<Directory /path/to/lx-office-erp> +<Directory /path/to/kivitendo-erp> AllowOverride All Options ExecCGI Includes FollowSymlinks Order Allow,Deny Allow from All </Directory> -<DirectoryMatch /path/to/lx-office-erp/users> +<DirectoryMatch /path/to/kivitendo-erp/users> Order Deny,Allow Deny from All </DirectoryMatch> @@ -705,18 +685,18 @@ Alias /web/path/to/lx-office-erp/ /path/to/lx-office-erp/ 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/ +AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl +Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/ FcgidMaxRequestLen 10485760 -<Directory /path/to/lx-office-erp> +<Directory /path/to/kivitendo-erp> AllowOverride All Options ExecCGI Includes FollowSymlinks Order Allow,Deny Allow from All </Directory> -<DirectoryMatch /path/to/lx-office-erp/users> +<DirectoryMatch /path/to/kivitendo-erp/users> Order Deny,Allow Deny from All </DirectoryMatch> @@ -726,21 +706,20 @@ FcgidMaxRequestLen 10485760 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 + Es ist möglich, die gleiche kivitendo 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 +Alias /url/for/kivitendo-erp /path/to/kivitendo-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/ +AliasMatch ^/url/for/kivitendo-erp-fcgid/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl +Alias /url/for/kivitendo-erp-fcgid/ /path/to/kivitendo-erp/ - Dann ist unter - /web/path/to/lx-office-erp/ die normale Version - erreichbar, und unter - /web/path/to/lx-office-erp-fcgid/ die + Dann ist unter /url/for/kivitendo-erp/ + die normale Version erreichbar, und unter + /url/for/kivitendo-erp-fcgid/ die FastCGI-Version. @@ -761,33 +740,44 @@ Alias /web/path/to/lx-office-erp-fcgid/ /path/to/lx-office-erp/Die Konfiguration erfolgt über den Abschnitt [task_server] in der Datei - config/lx_office.conf. Die dort verfügbaren + config/kivitendo.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. - + + + login - - 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. - + + gültiger kivitendo-Benutzername, der benutzt wird, um die + zu verwendende Datenbankverbindung auszulesen. Der Benutzer muss + in der Administration angelegt werden. Diese Option muss + angegeben werden. + + - - debug: Schaltet Debug-Informationen an - und aus. - - + + 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. + + + @@ -795,7 +785,7 @@ Alias /web/path/to/lx-office-erp-fcgid/ /path/to/lx-office-erp/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. + Starten automatisch in das kivitendo-Installationsverzeichnis. Deshalb ist es möglich, ihn durch Setzen eines symbolischen Links aus einem der Runlevel-Verzeichnisse heraus in den Boot-Prozess @@ -804,12 +794,11 @@ Alias /web/path/to/lx-office-erp-fcgid/ /path/to/lx-office-erp/ - SystemV-basierende Systeme (z.B. Debian, OpenSuSE, Fedora - Core) + SystemV-basierende Systeme (z.B. Debian, ältere OpenSUSE, ältere Fedora Core) Kopieren Sie die Datei - scripts/boot/system-v/lx-office-task-server - nach /etc/init.d/lx-office-task-server. Passen + scripts/boot/system-v/kivitendo-server + nach /etc/init.d/kivitendo-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: @@ -818,36 +807,56 @@ Alias /web/path/to/lx-office-erp-fcgid/ /path/to/lx-office-erp/ Debian-basierende Systeme: - update-rc.d lx-office-task-server defaults # Nur - bei Debian Squeeze und neuer: insserv - lx-office-task-server + update-rc.d kivitendo-task-server defaults +# Nur bei Debian Squeeze und neuer: +insserv kivitendo-task-server - OpenSuSE und Fedora Core: + Ältere OpenSUSE und ältere Fedora Core: - chkconfig --add - lx-office-task-server + chkconfig --add kivitendo-task-server Danach kann der Task-Server mit dem folgenden Befehl gestartet - werden: /etc/init.d/lx-office-task-server - start + werden: + + /etc/init.d/kivitendo-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. + scripts/boot/upstart/kivitendo-task-server.conf + nach /etc/init/kivitendo-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 + werden: + + service kivitendo-task-server start + + + + systemd-basierende Systeme (z.B. neure OpenSUSE, neuere Fedora Core) + + Verlinken Sie die Datei scripts/boot/systemd/kivitendo-task-server.service nach + /etc/systemd/system/. Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile + ExecStart=.... und ExecStop=...). Binden Sie das Script in den Boot-Prozess ein. + + + Alle hierzu benötigten Befehle sehen so aus: + + cd /var/www/kivitendo-erp/scripts/boot/systemd +ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/ + + Danach kann der Task-Server mit dem folgenden Befehl gestartet + werden: + + systemctl start kivitendo-task-server.service @@ -856,7 +865,7 @@ Alias /web/path/to/lx-office-erp-fcgid/ /path/to/lx-office-erp/Der Task-Server wird wie folgt kontrolliert: - ./scripts/task_server.pl Befehl + ./scripts/task_server.pl Befehl Befehl ist dabei eine der folgenden Optionen: @@ -885,12 +894,26 @@ Alias /web/path/to/lx-office-erp-fcgid/ /path/to/lx-office-erp/ Der Task-Server wechselt beim Starten automatisch in das - Lx-Office-Installationsverzeichnis. + kivitendo-Installationsverzeichnis. Dieselben Optionen können auch für die SystemV-basierenden Runlevel-Scripte benutzt werden (siehe oben). + + + Task-Server mit mehreren Mandanten + + Beim Task-Server wird der Login-Name des Benutzers, unter dem der + Task-Server laufen soll, in die Konfigurationsdatei geschrieben. Hat + man mehrere Mandanten muß man auch mehrere Konfigurationsdateien + anlegen. - + Die Konfigurationsdatei ist eine Kopie der Datei kivitendo.conf, + wo in der Kategorie [task_server] der gewünschte "login" steht. + + Der alternative Task-Server wird dann mit folgendem Befehl + gestartet: + + ./scripts/task_server.pl -c config/DATEINAME.conf @@ -900,32 +923,30 @@ Alias /web/path/to/lx-office-erp-fcgid/ /path/to/lx-office-erp/Informationen über die Einrichtung der Benutzerauthentifizierung, über die Verwaltung von Gruppen und weitere Einstellungen - - Grundlagen zur Benutzerauthentifizierung - Lx-Office verwaltet die Benutzerinformationen in einer + kivitendo 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 + Im einfachsten Fall gibt es für kivitendo 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 + Zusätzlich ermöglicht es kivitendo, 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 + Welche Art der Passwortüberprüfung kivitendo benutzt und wie + kivitendo die Authentifizierungsdatenbank erreichen kann, wird in der + Konfigurationsdatei config/kivitendo.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 + config/kivitendo.conf.default existiert, die als Vorlage benutzt werden kann. @@ -935,133 +956,176 @@ Alias /web/path/to/lx-office-erp-fcgid/ /path/to/lx-office-erp/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}. + werden. Der Parameter dazu heißt admin_password im + Abschnitt [authentication]. Authentifizierungsdatenbank Die Verbindung zur Authentifizierungsdatenbank wird mit den - Parametern in $self->{DB_config} konfiguriert. - Hier sind die folgenden Parameter anzugeben: + Parametern in [authentication/database] + konfiguriert. Hier sind die folgenden Parameter anzugeben: - - - ‘host’ – Der Rechnername oder die - IP-Adresse des Datenbankservers - + + + host - - ‘port’ – Die Portnummer des - Datenbankservers, meist 5432 - + + Der Rechnername oder die IP-Adresse des + Datenbankservers + + - - ‘db’ – Der Name der - Authentifizierungsdatenbank - + + port - - ‘user’ – Der Benutzername, mit dem sich - Lx-Office beim Datenbankserver anmeldet (z.B. “postgres”) - + + Die Portnummer des Datenbankservers, meist 5432 + + - - ‘password’ – Das Passwort für den - Datenbankbenutzer - - + + db + + + Der Name der Authentifizierungsdatenbank + + + + + user + + + Der Benutzername, mit dem sich kivitendo beim + Datenbankserver anmeldet (z.B. + "postgres") + + + + + password + + + Das Passwort für den Datenbankbenutzer + + + - Die Datenbank muss noch nicht existieren. Lx-Office kann sie + Die Datenbank muss noch nicht existieren. kivitendo kann sie automatisch anlegen (mehr dazu siehe unten). Passwortüberprüfung - Lx-Office unterstützt Passwortüberprüfung auf zwei Arten: gegen + kivitendo 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}. + Parameter module im Abschnitt + [authentication]. 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. + gespeichert werden, so muss der Parameter module + den Wert DB enthalten. In diesem Fall können sowohl + der Administrator als auch die Benutzer selber ihre Psaswörter in + kivitendo ä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: + benutzt werden, so muss der Parameter module auf + LDAP gesetzt werden. In diesem Fall müssen + zusätzliche Informationen über den LDAP-Server im Abschnitt + [authentication/ldap] angegeben werden: - - - ‘host’ – Der Rechnername oder die - IP-Adresse des LDAP- oder Active-Directory-Servers. Diese Angabe - ist zwingend erforderlich. - + + + host - - ‘port’ – Die Portnummer des LDAP-Servers; - meist 389. - + + Der Rechnername oder die IP-Adresse des LDAP- oder + Active-Directory-Servers. Diese Angabe ist zwingend + erforderlich. + + - - ‘tls’ – Wenn Verbindungsverschlüsselung - gewünscht ist, so diesen Wert auf ‘1’ setzen, - andernfalls auf ‘0’ belassen - + + port - - ‘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. - + + Die Portnummer des LDAP-Servers; meist 389. + + - - ‘base_dn’ – Der Abschnitt des - LDAP-Baumes, der durchsucht werden soll. Diese Angabe ist zwingend - erforderlich. - + + tls - - ‘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. - + + Wenn Verbindungsverschlüsselung gewünscht ist, so diesen + Wert auf ‘1’ setzen, andernfalls auf + ‘0’ belassen + + - - ‘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’. - - + + 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 + Sollen auf einem Server mehrere kivitendo-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. + Parameter cookie_name im Abschnitt + [authentication]gesetzt. Diese Angabe ist optional, wenn nur eine Installation auf dem Server existiert. @@ -1071,15 +1135,13 @@ Alias /web/path/to/lx-office-erp-fcgid/ /path/to/lx-office-erp/Anlegen der Authentifizierungsdatenbank Nachdem alle Einstellungen in - config/lx_office.conf vorgenommen wurden, muss - Lx-Office die Authentifizierungsdatenbank anlegen. Dieses geschieht + config/kivitendo.conf vorgenommen wurden, muss + kivitendo 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 - - + url="http://localhost/kivitendo-erp/admin.pl">http://localhost/kivitendo-erp/admin.pl @@ -1091,17 +1153,17 @@ Alias /web/path/to/lx-office-erp-fcgid/ /path/to/lx-office-erp/ http://localhost/lx-erp/admin.pl + url="http://localhost/kivitendo-erp/admin.pl">http://localhost/kivitendo-erp/admin.pl Verwenden Sie zur Anmeldung das Password, dass Sie in der Datei - config/lx_office.conf eingetragen haben. + config/kivitendo.conf eingetragen haben. Zusammenhänge - Lx-Office verwendet eine Datenbank zum Speichern all seiner + kivitendo 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 + mit kivitendo 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 @@ -1112,17 +1174,17 @@ Alias /web/path/to/lx-office-erp-fcgid/ /path/to/lx-office-erp/ - Lx-Office kann seinen Benutzern Zugriff auf bestimmte + kivitendo 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 + Um Rechte verteilen zu können, verwendet kivitendo 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 @@ -1156,19 +1218,14 @@ Alias /web/path/to/lx-office-erp-fcgid/ /path/to/lx-office-erp/Zuerst muss eine Datenbank angelegt werden. Verwenden Sie für den Datenbankzugriff den vorhin angelegten Benutzer (in unseren - Beispielen ist dies ‘lxoffice’). + Beispielen ist dies ‘kivitendo’). - 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. + Wenn Sie für die kivitendo-Installation nicht Unicode (UTF-8) sondern den europäischen Schriftsatz ISO-8859-15 benutzen + wollen, so müssen Sie vor dem Anlegen der Datenbank in der Datei config/kivitendo.conf die Variable + dbcharset im Abschnitt system auf den Wert ‘ISO-8859-15’ setzen. Bitte beachten Sie, dass alle Datenbanken den selben Zeichensatz - verwenden müssen, da diese Einstellungen momentan global in Lx-Office + verwenden müssen, da diese Einstellungen momentan global in kivitendo vorgenommen wird und nicht nach Datenbank unterschieden werden kann. Auch die Authentifizierungsdatenbank muss mit diesem Zeichensatz angelegt worden sein. @@ -1230,94 +1287,405 @@ Alias /web/path/to/lx-office-erp-fcgid/ /path/to/lx-office-erp/ Migration alter Installationen - Wenn Lx-Office 2.6.2 über eine ältere Version installiert wird, + Wenn kivitendo 2.6.3 über eine ältere Version installiert wird, in der die Benutzerdaten noch im Dateisystem im Verzeichnis - users verwaltet wurden, so bietet Lx-Office die + users verwaltet wurden, so bietet kivitendo 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 + Administrationsbereich anmeldet. Findet kivitendo 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 + kivitendo 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 + Funktionen von kivitendo gewährt. Alle migrierten Benutzern werden + Mitglied in dieser Gruppe. Damit wird das Verhalten von kivitendo 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 + + E-Mail-Versand aus kivitendo heraus - 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: + kivitendo kann direkt aus dem Programm heraus E-Mails versenden, z.B. um ein Angebot direkt an einen Kunden zu + verschicken. Damit dies funktioniert, muss eingestellt werden, über welchen Server die E-Mails verschickt werden sollen. kivitendo + unterstützt dabei zwei Mechanismen: Versand über einen lokalen E-Mail-Server (z.B. mit Postfix oder + Exim, was auch die standardmäßig aktive Methode ist) sowie Versand über einen SMTP-Server (z.B. der des + eigenen Internet-Providers). - texlive-latex-base texlive-latex-extra - texlive-fonts-recommended + Welche Methode und welcher Server verwendet werden, wird über die Konfigurationsdatei config/kivitendo.conf + festgelegt. Dort befinden sich alle Einstellungen zu diesem Thema im Abschnitt '[mail_delivery]'. - Diese hinteren beiden enthalten Bibliotheken und Schriftarten die - von den Standardvorlagen verwendet werden. + + Versand über lokalen E-Mail-Server - TODO: rpm Pakete. + Diese Methode bietet sich an, wenn auf dem Server, auf dem kivitendo läuft, bereits ein funktionsfähiger E-Mail-Server wie + z.B. Postfix, Exim oder Sendmail läuft. - 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: + Um diese Methode auszuwählen, muss der Konfigurationsparameter 'method = sendmail' gesetzt sein. Dies ist + gleichzeitig der Standardwert, falls er nicht verändert wird. - - - ! 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. - + Um zu kontrollieren, wie das Programm zum Einliefern gestartet wird, dient der Parameter 'sendmail = + ...'. Der Standardwert verweist auf das Programm /usr/bin/sendmail, das bei allen oben genannten + E-Mail-Serverprodukten für diesen Zweck funktionieren sollte. - - ! 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. - + Die Konfiguration des E-Mail-Servers selber würde den Rahmen dieses sprengen. Hierfür sei auf die Dokumentation des + E-Mail-Servers verwiesen. + + + + Versand über einen SMTP-Server + + Diese Methode bietet sich an, wenn kein lokaler E-Mail-Server vorhanden oder zwar einer vorhanden, dieser aber nicht + konfiguriert ist. + + Um diese Methode auszuwählen, muss der Konfigurationsparameter 'method = smtp' gesetzt sein. Die folgenden + Parameter dienen dabei der weiteren Konfiguration: + + + + hostname + + Name oder IP-Adresse des SMTP-Servers. Standardwert: 'localhost' + + + + port + + Portnummer. Der Standardwert hängt von der verwendeten Verschlüsselungsmethode ab. Gilt 'security = + none' oder 'security = tls', so ist 25 die Standardportnummer. Für 'security = + ssl' ist 465 die Portnummer. Muss normalerweise nicht geändert werden. + + + + security + + Wahl der zu verwendenden Verschlüsselung der Verbindung mit dem Server. Standardwert ist + 'none', wodurch keine Verschlüsselung verwendet wird. Mit 'tls' wird TLS-Verschlüsselung + eingeschaltet, und mit 'ssl' wird Verschlüsselung via SSL eingeschaltet. Achtung: Für + 'tls' und 'ssl' werden zusätzliche Perl-Module benötigt (siehe unten). + + + + login und password + + Falls der E-Mail-Server eine Authentifizierung verlangt, so können mit diesen zwei Parametern der Benutzername + und das Passwort angegeben werden. Wird Authentifizierung verwendet, so sollte aus Sicherheitsgründen auch eine Form von + Verschlüsselung aktiviert werden. + + + + Wird Verschlüsselung über TLS oder SSL aktiviert, so werden zusätzliche Perl-Module benötigt. Diese sind: + + + TLS-Verschlüsselung: Modul Net::SSLGlue (Debian-Paketname + libnet-sslglue-perl, Fedora Core: perl-Net-SSLGlue, openSUSE: + perl-Net-SSLGlue + + SSL-Verschlüsselung: Modul Net::SMTP::SSL (Debian-Paketname + libnet-smtp-ssl-perl, Fedora Core: perl-Net-SMTP-SSL, openSUSE: + perl-Net-SMTP-SSL + + + + + + Drucken mit kivitendo + + Das Drucksystem von kivitendo 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 installiert man + die Pakete mit: + + aptitude install texlive-base-bin texlive-latex-recommended texlive-fonts-recommended \ + texlive-latex-extra texlive-lang-german texlive-generic-extra + + TODO: RPM-Pakete. + + kivitendo bringt drei alternative Vorlagensätze mit: + + Standard + f-tex + RB - 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. + + Vorlagenverzeichnis anlegen + Im Administrationsbereich lässt sich bei einem Benutzer/Mandanten einer dieser Vorlagensätze als Basis für die zu + druckenden Dokumente auswählen. Rufen Sie dazu die Benutzerverwaltung auf. + + Wählen Sie dort einen Benutzer aus oder legen Sie einen neuen an. In der Benutzerbearbeiten-Maske müssen Sie zwei Dinge + angeben: + + + : Der Verzeichnisname für den neuen Vorlagensatz. Dieser kann im Rahmen der üblichen + Bedingungen für Verzeichnisnamen frei gewählt werden. + : Wählen Sie hier den Vorlagensatz aus, der kopiert werden soll + (Standard, f-tex oder RB.) + + + Der gleiche Vorlagensatz kann, wenn er mal angelegt ist, bei mehreren Benutzern verwendet werden. + + Die Abhängigkeiten kann man prüfen mit: + + /scripts/installation_check.pl -l + + + + Standard + + Der Standard-Vorlagensatz von Kivitendo. Wie unter http://demo.kivitendo.org zu + sehen. + + + + + f-tex + + Ein Vorlagensatz, der in wenigen Minuten alle Dokumente zur Verfügung stellt. + + + Feature-Übersicht + + Keine Redundanz. Es wird ein- und dieselbe LaTeX-Vorlage für alle briefartigen Dokumente verwendet. Also + Angebot, Rechnung, Performarechnung, Lieferschein, aber eben nicht für Paketaufkleber etc.. + + Leichte Anpassung an das Firmen-Layout durch verwendung eines Hintergrund-PDF. Dieses kann leicht mit dem + eigenen Lieblingsprogramm erstellt werden (Openoffice, Inkscape, Gimp, Adobe*) + + Hintergrund-PDF umschaltbar auf "nur erste Seite" (Standard) oder "alle Seiten" (Option + "" in Datei letter.lco) + + Hintergrund-PDF für Ausdruck auf bereits bedrucktem Briefpapier abschaltbar. Es wird dann nur bei per E-Mail + versendeten Dokumenten eingebunden (Option "" in Datei + letter.lco). + + Nutzung der Layout-Funktionen von LaTeX für Seitenumbruch, Wiederholung von Kopfzeilen, Zwischensummen + etc. (danke an Kai-Martin Knaak für die Vorarbeit) + + Anzeige des Empfängerlandes im Adressfeld nur, wenn es vom Land des eigenen Unternehmens abweicht (also die + Rechnung das Land verlässt). + + Multisprachfähig leicht um weitere Sprachen zu erweitern, alle Übersetzungen in der Datei + translatinos.tex. + + Auflistung von Bruttopreisen für Endverbraucher. + + + + + Die Installation + + Vorlagenverzeichnis mit Option f-tex anlegen, siehe: . Das + Vorlagensystem funktioniert jetzt schon, hat allerdings noch einen Beispiel-Briefkopf. + + Erstelle eine pdf-Hintergrund Datei und verlinke sie nach ./letter_head.pdf. + Editiere den Bereich "" in der datei letter.lco. + + + oder etwas Detaillierter: + + + Es wird eine Datei sample.lco erstellt und diese nach letter.lco verlinkt. Eigentlich + ist dies die Datei die für die Firmenspezifischen Anpassungen gedacht ist. Da die Einstiegshürde in LaTeX nicht ganz niedrig + ist, wird in dieser Datei auf ein Hintergrundpdf verwiesen. Ich empfehle über dieses PDF die persönlichen Layoutanpassungen + vorzunehmen und sample.lco unverändert zu lassen. Die die Anpassung über eine + *.lco-Datei die letztlich auf letter.lco verlinkt ist ist aber auch möglich. + + + + Es wird eine Datei sample_head.pdf mit ausgeliefert, diese wird nach letter_head.pdf + verlinkt. Damit gibt es schon mal eine Funktionsfähige Vorlage. Schau Dir nach Abschluss der Installation die Datei + sample_haed.pdf an und erstelle ein entsprechendes PDF passend zum Briefkopf Deiner Firma, diese dann im + Template Verzeichniss ablegen und statt sample_head.pdf nach letter_head.pdf + verlinken. + + + + letzlich muss letter_head.pdf auf das passende Hintergrund-PDF verweisen, welches gewünschten Briefkopf + enthält. Bei Updates oder nach erneutem + + + + Es wird eine Datei mydata.tex.example ausgeliefert, die nach mytdata.tex verlinkt + ist. Bei verwendetem Hintergrund-PDF wird nur der Eintrag für das Land verwendet. Die Datei muss also nicht angefasst + werden. Die Anderen Werte sind für das Modul 'lp' (Label Print in erp - zur Zeit nicht im öffentlichen Zweig). + + + Alle Anpassungen zum Briefkopf, Fusszeilen, Firmenlogos, etc. sollten über die Hintergrund-PDF-Datei oder die + *.lco-Datei erfolgen. + + + + + f-tex Funktionsübersicht + + Das Konzept von kivitendo sieht vor, für jedes Dokument (Auftragsbestätigung, Lieferschein, Rechnung, etc.) eine LaTeX-Vorlage + vorzuhalten, dies ist sehr Wartungsunfreundlich. Auch das Einlesen einer einheitlichen Quelle für den Briefkopf bringt nur + bedingte Vorteile, da hier leicht die Pflege der Artikel-Tabellen aus dem Ruder läuft. Bei dem vorliegenden Ansatz wird für alle + briefartigen Dokumente mit Artikel-Tabellen eine einheitliche LaTeX-Vorlage verwendet, welche über Codeweichen die + Besonderheiten der jeweiligen Dokumente Berücksichtigt. + + + + Tabellen mit oder ohne Preis + Sprache der Tabellenüberschriften etc. + Anpassung der Bezugs-Zeile (z.B. Rechnungsnummer versus Angebotsnummer) + Darstellung von Brutto oder Netto-Preisen in der Auflistung (Endverbraucher versus Gewerblicher + Kunde) + + + Nachteil: + + + LaTeX hat ohnehin eine sehr steile Lehrnkurve. Die Datei letter.tex ist sehr komplex und verstärkt damit + diesen Effekt noch einmal erheblich. Wer LaTeX-Erfahrung hat, oder geübt ist Scriptsparachen nachzuvollziehen kann natürlich + auch innerhalb der Tabellendarstellung gut persönliche Anpassungen vornehmen. Aber man kann sich hier bei Veränderungen sehr + schnell häftig in den Fuss schiessen. + + + Wer nicht so tief in die Materie einsteigen will oder leicht zu frustrieren ist, sollte sein Hintergrund PDF auf Basis der + mitglieferten Datei sample_head.pdf erstellen, und sich an der Form der dargestellten Tabellen wie sie + ausgeliefert werden, erfreuen. + + + Kleiner Tipp: Nicht zu viel auf einmal wollen, lieber kleine kontinuierliche Schritte gehen. + + + + + Bruttopreise für Endverbraucher + + Der auszuweisende Bruttopreis wird innerhalb der LaTeX-Umgebung berechnet. Es gibt zwar ein Feld, um bei Aufträgen "alle + Preise Brutto" auszuwählen, aber: + + + hierfür müssen die Preise auch in Brutto in der Datenbank stehen (ja - das lässt sich über die Preisgruppen und die + Zuordung einer Default-Preisgruppe handhaben) + + + man darf beim Anlegen des Vorgangs nicht vergessen Dieses Häkchen zu setzen. (das ist in der Praxis wenn man sowohl + Endverbraucher- wie Gewerbekunden beliefert der eigentliche Knackpunkt) + + + + + Es gibt mit f-tex eine weitere Alternative. Die Information ob Brutto oder Nettorechnung wird mit den Zahlarten + verknüpft. Zahlarten bei denen Rechnungen, Angebote, etc, in Brutto ausgegeben werden sollen, enden mit "_E" (für + Endverbraucher). Falls identische Zahlarten für Gewerbekunden und Endverbraucher vorhanden sind, legt man diese einfach doppelt + an (einmal mit der Namensendung "_E"). Gewinn: + + + Die Entscheidung, ob Netopreise ausgewiesen werden, ist nicht mehr fix mit einer Preisliste Verbunden. + Die Default-Zahlart kann im Kundendatensatz hinterlegt werden, und man muss nicht mehr daran denken, "alle Preise + Netto" auszuwählen. + Die Entscheidung, ob Netto- oder Bruttopreise ausgewiesen werden, kann direkt beim Drucken reviediert werden, + ohne dass sich der Auftragswert ändert. + + + + + Lieferadressen + + In Lieferscheinen kommen shipto*-Variablen im Adressfeld zum Einsatz. Wenn die + shipto*-Variable leer ist, wird die entsprechende Adressvariable eingesetzt. Wenn also die Lieferadresse in + Straße, Hausnummer und Ort abweicht, müssen auch nur diese Felder in der Lieferadresse ausgefüllt werden. Für den Firmenname wird + der Wert der Hauptadresse angezeigt. + + + + + + RB + + Vollständiger Dokumentensatz mit alternativem Design + + + + + Allgemeine Hinweise zu LaTeX Vorlagen + 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:... 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. - + Wenn sich das Problem nicht auf Grund der ausgabe im Webbrowser verifizieren lässt: + + + editiere [kivitendo-home]/config/kivitendo.conf und ändere "keep_tmp_files" auf 1 + keep_temp_files = 1; + + + bei fastcgi oder mod_perl den Webserver neu Starten + + + Nochmal einen Druckversuch im Webfrontend auslösen + + + wechsele in das users Verzeichnis von kivitendo + cd [kivitendo-home]/users + + + LaTeX Suchpfad anpassen: + export TEXINPUTS=".:[kivitendo-home]/templates/[aktuelles_template_verzeichniss]:" + + + Finde herraus welche Datei kivitendo beim letzten Durchlauf erstellt hat + ls -lahtr ./1*.tex + Es sollte die letzte Datei ganz unten sein + + + für besseren Hinweis auf Fehler texdatei nochmals übersetzen + pdflatex ./1*.tex + in der *.tex datei nach dem Fehler suchen. + + + OpenDocument-Vorlagen - Lx-Office unterstützt die Verwendung von Vorlagen im + kivitendo 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 + kivitendo 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 + config/kivitendo.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 + config/kivitendo.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 @@ -1331,14 +1699,14 @@ Alias /web/path/to/lx-office-erp-fcgid/ /path/to/lx-office-erp/ Nach der Installation müssen in der Datei - config/lx_config.conf zwei weitere Variablen + config/kivitendo.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 + Zusätzlich gibt es zwei verschiedene Arten, wie kivitendo 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 @@ -1373,3330 +1741,3554 @@ Alias /web/path/to/lx-office-erp-fcgid/ /path/to/lx-office-erp/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. - - + linkend="Manuelle-Installation-des-Programmpaketes" />), kann aber + erneut überprüft werden, wenn die Konvertierung nach PDF + fehlschlägt. - Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung: EUR + Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung: + EUR - - Einführung + + Einführung - - Lx-Office besaß bis inklusive Version 2.6.3 einen Konfigurationsparameter namens eur, der sich in der - Konfigurationsdatei config/lx_office.conf befindet. Somit galt er für alle Mandanten, die in dieser - Installation benutzt wurden. - + kivitendo besaß bis inklusive Version 2.6.3 einen Konfigurationsparameter namens eur, der sich in der + Konfigurationsdatei config/kivitendo.conf (damals noch config/lx_office.conf) + befand. Somit galt er für alle Mandanten, die in dieser Installation benutzt wurden. - - Mit der nachfolgenden Version wurde der Parameter zum Einen in die Mandantendatenbank verschoben und dabei auch gleich in drei - Einzelparameter aufgeteilt, mit denen sich das Verhalten genauer steuern lässt. - + Mit der nachfolgenden Version wurde der Parameter zum Einen in + die Mandantendatenbank verschoben und dabei auch gleich in drei + Einzelparameter aufgeteilt, mit denen sich das Verhalten genauer + steuern lässt. - - Konfigurationsparameter + + Konfigurationsparameter - - Es gibt drei Parameter, die die Gewinnermittlungsart, Versteuerungsart und die Warenbuchungsmethode regeln: - + Es gibt drei Parameter, die die Gewinnermittlungsart, + Versteuerungsart und die Warenbuchungsmethode regeln: - - - profit_determination - - - Dieser Parameter legt die Berechnungsmethode für die Gewinnermittlung fest. Er enthält entweder balance für - Betriebsvermögensvergleich/Bilanzierung oder income für die Einnahmen-Überschuss-Rechnung. - - - + + + profit_determination - - accounting_method - - - Dieser Parameter steuert die Buchungs- und Berechnungsmethoden für die Versteuerungsart. Er enthält entweder - accrual für die Soll-Versteuerung oder cash für die Ist-Versteuerung. - - - + + Dieser Parameter legt die Berechnungsmethode für die + Gewinnermittlung fest. Er enthält entweder + balance für + Betriebsvermögensvergleich/Bilanzierung oder + income für die + Einnahmen-Überschuss-Rechnung. + + - - inventory_system - - - Dieser Parameter legt die Warenbuchungsmethode fest. Er enthält entweder perpetual für die Bestandsmethode - oder periodic für die Aufwandsmethode. - - - - - - - Zum Vergleich der Funktionalität bis und nach 2.6.3: eur = 1 bedeutete Einnahmen-Überschuss-Rechnung, - Ist-Versteuerung und Aufwandsmethode. eur = 0 bedeutete hingegen Bilanzierung, Soll-Versteuerung und - Bestandsmethode. - - - - Die Konfiguration "eur" unter [system] in der Konfigurationsdatei config/lx_office.conf wird nun nicht mehr benötigt und - kann entfernt werden. Dies muss manuell geschehen. - + + accounting_method + + + Dieser Parameter steuert die Buchungs- und + Berechnungsmethoden für die Versteuerungsart. Er enthält + entweder accrual für die Soll-Versteuerung + oder cash für die Ist-Versteuerung. + + + + + inventory_system + + + Dieser Parameter legt die Warenbuchungsmethode fest. Er + enthält entweder perpetual für die + Bestandsmethode oder periodic für die + Aufwandsmethode. + + + + + Zum Vergleich der Funktionalität bis und nach 2.6.3: + eur = 1 bedeutete Einnahmen-Überschuss-Rechnung, + Ist-Versteuerung und Aufwandsmethode. eur = 0 + bedeutete hingegen Bilanzierung, Soll-Versteuerung und + Bestandsmethode. + + Die Konfiguration "eur" unter + [system] in der Konfigurationsdatei + config/kivitendo.conf wird nun nicht mehr + benötigt und kann entfernt werden. Dies muss manuell geschehen. - Festlegen der Parameter - - - Beim Anlegen eines neuen Mandanten bzw. einer neuen Datenbank in der Admininstration können diese Optionen nun unabhängig - voneinander eingestellt werden. - - - - Beim Upgrade bestehender Mandanten wird eur ausgelesen und die Variablen werden so gesetzt, daß sich an der Funktionalität nichts - ändert. - - - - Die aktuelle Konfiguration wird unter Nummernkreise und Standardkonten unter dem neuen Punkt "Einstellungen" angezeigt (read-only). - Eine spätere Änderung ist für einen bestehenden Mandanten nicht mehr möglich. Dies war auch vorher nicht möglich, bzw. vorhandene - Daten wurden so belassen und haben damit die Ergebnisse verfälscht. - + Festlegen der Parameter + + Beim Anlegen eines neuen Mandanten bzw. einer neuen Datenbank in + der Admininstration können diese Optionen nun unabhängig voneinander + eingestellt werden. + + Beim Upgrade bestehender Mandanten wird eur ausgelesen und die + Variablen werden so gesetzt, daß sich an der Funktionalität nichts + ändert. + + Die aktuelle Konfiguration wird unter Nummernkreise und + Standardkonten unter dem neuen Punkt "Einstellungen" (read-only) + angezeigt. Unter System + -> Mandantenkonfiguration können + die Einstellungen auch geändert werden. Dabei ist zu beachten, + dass eine Änderung vorhandene Daten so belässt und damit + evtl. die Ergebnisse verfälscht. Dies gilt vor Allem für die + Warenbuchungsmethode (siehe auch + + Bemerkungen zu Bestandsmethode). - Bemerkungen zu Bestandsmethode - - - Die Bestandsmethode ist eigentlich eine sehr elegante Methode, funktioniert in Lx-Office aber nur unter bestimmten Bedingungen: - Voraussetzung ist, daß auch immer alle Einkaufsrechnungen gepflegt werden, und man beim Jahreswechsel nicht mit einer leeren - Datenbank anfängt, da bei jedem Verkauf anhand der gesamten Rechnungshistorie der Einkaufswert der Ware nach dem FIFO-Prinzip aus - den Einkaufsrechnungen berechnet wird. - - - - Die Bestandsmethode kann vom Prinzip her also nur funktioneren, wenn man mit den Buchungen bei Null anfängt, und man kann auch nicht - im laufenden Betrieb von der Aufwandsmethode zur Bestandsmethode wechseln. - + Bemerkungen zu Bestandsmethode + + Die Bestandsmethode ist eigentlich eine sehr elegante Methode, + funktioniert in kivitendo aber nur unter bestimmten Bedingungen: + Voraussetzung ist, daß auch immer alle Einkaufsrechnungen gepflegt + werden, und man beim Jahreswechsel nicht mit einer leeren Datenbank + anfängt, da bei jedem Verkauf anhand der gesamten Rechnungshistorie + der Einkaufswert der Ware nach dem FIFO-Prinzip aus den + Einkaufsrechnungen berechnet wird. + + Die Bestandsmethode kann vom Prinzip her also nur funktioneren, + wenn man mit den Buchungen bei Null anfängt, und man kann auch nicht + im laufenden Betrieb von der Aufwandsmethode zur Bestandsmethode + wechseln. - Bekannte Probleme + Bekannte Probleme - - Bei bestimmten Berichten kann man derzeit noch inviduell einstellen, ob man nach Ist- oder Sollversteuerung auswertet, und es werden - im Code Variablen wie $accrual oder $cash gesetzt. Diese Codestellen wurden noch nicht angepasst, sondern nur die, wo bisher - die Konfigurationsvariable $::lx_office_conf{system}->{eur} ausgewertet wurde. - + Bei bestimmten Berichten kann man derzeit noch inviduell + einstellen, ob man nach Ist- oder Sollversteuerung auswertet, und es + werden im Code Variablen wie $accrual oder $cash gesetzt. Diese + Codestellen wurden noch nicht angepasst, sondern nur die, wo bisher + die Konfigurationsvariable + $::lx_office_conf{system}->{eur} ausgewertet + wurde. - - Es fehlen Hilfetext beim Neuanlegen eines Mandanten, was die Optionen bewirken, z.B. mit zwei Standardfällen. - + Es fehlen Hilfetext beim Neuanlegen eines Mandanten, was die + Optionen bewirken, z.B. mit zwei Standardfällen. - - Lx-Office ERP verwenden + + SKR04 19% Umstellung für innergemeinschaftlichen Erwerb - Nach erfolgreicher Installation ist der Loginbildschirm unter - folgender URL erreichbar: + + Einführung - http://localhost/lx-office-erp/login.pl + Die Umsatzsteuerumstellung auf 19% für SKR04 für die + Steuerschlüssel "EU ohne USt-ID Nummer" ist erst 2010 erfolgt. + kivitendo beinhaltet ein Upgradeskript, das das Konto 3804 automatisch + erstellt und die Steuereinstellungen korrekt einstellt. Hat der + Benutzer aber schon selber das Konto 3804 angelegt, oder gab es schon + Buchungen im Zeitraum nach dem 01.01.2007 auf das Konto 3803, wird das + Upgradeskript vorsichtshalber nicht ausgeführt, da der Benutzer sich + vielleicht schon selbst geholfen hat und mit seinen Änderungen + zufrieden ist. Die korrekten Einstellungen kann man aber auch per Hand + ausführen. Nachfolgend werden die entsprechenden Schritte anhand von + Screenshots dargestellt. + + Für den Fall, daß Buchungen mit der Steuerschlüssel "EU ohne + USt.-IdNr." nach dem 01.01.2007 erfolgt sind, ist davon auszugehen, + dass diese mit dem alten Umsatzsteuersatz von 16% gebucht worden sind, + und diese Buchungen sollten entsprechend kontrolliert werden. + - Die Administrationsseite erreichen Sie unter: + + Konto 3804 manuell anlegen - http://localhost/lx-office-erp/admin.pl - - + Die folgenden Schritte sind notwendig, um das Konto manuell + anzulegen und zu konfigurieren. Zuerst wird in + System -> + Kontenübersicht -> Konto + erfassen das Konto angelegt. - - Features und Funktionen + + Konto 3804 erfassen - - Wiederkehrende Rechnungen + + + + + + - - Einführung + + Als Zweites muss Steuergruppe 13 für Konto 3803 angepasst werden. Dazu unter System -> + Steuern -> Bearbeiten den Eintrag mit Steuerschlüssel 13 auswählen und ihn + wie im folgenden Screenshot angezeigt anpassen. + - - Wiederkehrende Rechnungen werden als normale Aufträge definiert und konfiguriert, mit allen dazugehörigen Kunden- und - Artikelangaben. Die konfigurierten Aufträge werden später automatisch in Rechnungen umgewandelt, so als ob man den Workflow benutzen - würde, und auch die Auftragsnummer wird übernommen, sodass alle wiederkehrenden Rechnungen, die aus einem Auftrag erstellt wurden, - später leicht wiederzufinden sind. - + + Steuerschlüssel 13 für 3803 (16%) anpassen - + + + + + + - - Konfiguration + + Als Drittes wird ein neuer Eintrag mit Steuerschlüssel 13 für Konto 3804 (19%) angelegt. Dazu unter System -> + Steuern -> Erfassen auswählen und die Werte aus dem Screenshot übernehmen. + - - Um einen Auftrag für wiederkehrende Rechnung zu konfigurieren, findet sich beim Bearbeiten des Auftrags ein neuer Knopf - "Konfigurieren", der ein neues Fenster öffnet, in dem man die nötigen Parameter einstellen kann. Hinter dem Knopf wird außerdem noch - angezeigt, ob der Auftrag als wiederkehrende Rechnung konfiguriert ist oder nicht. - + + Steuerschlüssel 13 für 3804 (19%) anlegen - - Folgende Parameter kann man konfigurieren: - + + + + + + - - - Status - - - Bei aktiven Rechnungen wird automatisch eine Rechnung erstellt, wenn die Periodizität erreicht ist (z.B. Anfang eines neuen - Monats). - + + Als Nächstes sind alle Konten anzupassen, die als Steuerautomatikkonto die 3803 haben, sodass sie ab dem 1.1.2007 auch + Steuerautomatik auf 3804 bekommen. Dies betrifft in der Standardkonfiguration die Konten 4315 und 4726. Als Beispiel für 4315 + müssen Sie dazu unter System -> Kontenübersicht -> Konten + anzeigen das Konto 4315 anklicken und die Einstellungen wie im Screenshot gezeigt vornehmen. + - - Ist ein Auftrag nicht aktiv, so werden für ihn auch keine wiederkehrenden Rechnungen erzeugt. Stellt man nach längerer - nicht-aktiver Zeit einen Auftrag wieder auf aktiv, wird beim nächsten Periodenwechsel für alle Perioden, seit der letzten aktiven - Periode, jeweils eine Rechnung erstellt. Möchte man dies verhindern, muss man vorher das Startdatum neu setzen. - + + Konto 4315 anpassen - - Für gekündigte Aufträge werden nie mehr Rechnungen erstellt. Man kann sich diese Aufträge aber gesondert in den Berichten anzeigen - lassen. - - - + + + + + + - - Periodizität - - - Ob monatlich, quartalsweise oder jährlich auf neue Rechnungen überprüft werden soll. Für jede Periode seit dem Startdatum wird - überprüft, ob für die Periode (beginnend immer mit dem ersten Tag der Periode) schon eine Rechnung erstellt wurde. Unter Umständen - können bei einem Startdatum in der Vergangenheit gleich mehrere Rechnungen erstellt werden. - - - - - - Buchen auf - - - Das Forderungskonto, in der Regel "Forderungen aus Lieferungen und Leistungen". Das Gegenkonto ergibt sich aus den Buchungsgruppen - der betreffenden Waren. - - - - - - Startdatum - - - ab welchem Datum auf Rechnungserstellung geprüft werden soll - - - - - - Enddatum - - - ab wann keine Rechnungen mehr erstellt werden sollen - - - - - - Automatische Verlängerung um x Monate - - - Sollen die wiederkehrenden Rechnungen bei Erreichen des eingetragenen Enddatums weiterhin erstellt werden, so kann man hier die - Anzahl der Monate eingeben, um die das Enddatum automatisch nach hinten geschoben wird. - - - + + Als Letztes sollte die Steuerliste unter System -> Steuern -> + Bearbeiten kontrolliert werden. Zum Vergleich der Screenshot. + - - Drucken - - - Sind Drucker konfiguriert, so kann man sich die erstellten Rechnungen auch gleich ausdrucken lassen. - - - - + + Steuerliste vergleichen - - Nach Erstellung der Rechnungen kann eine E-Mail mit Informationen zu den erstellten Rechnungen verschickt werden. Konfiguriert wird - dies in der Konfigurationsdatei - config/lx_office.conf im Abschnitt [periodic_invoices]. - - + + + + + + + + - - Auflisten + + Einstellungen pro Mandant + + Einige Einstellungen können von einem Benutzer mit dem + Recht "Administration + (Für die Verwaltung der aktuellen Instanz aus einem Userlogin heraus)" + gemacht werden. Diese Einstellungen sind dann für die aktuellen + Mandanten-Datenbank gültig. Die Einstellungen sind + unter System + -> Mandantenkonfiguration erreichbar. + + Bitte beachten Sie die Hinweise zu den einzelnen + Einstellungen. Einige Einstellungen sollten nicht ohne Weiteres + im laufenden Betrieb geändert werden (siehe + auch Bemerkungen zu + Bestandsmethode). + + Die Einstellungen show_bestbefore + und payments_changeable aus dem + Abschnitt features und die Einstellungen im + Abschnitt datev_check (sofern schon vorhanden) + der kivitendo-Konfigurationsdatei + werden bei einem Datenbankupdate einer älteren Version automatisch + übernommen. Diese Einträge können danach aus der Konfigurationsdatei + entfernt werden. + - - Unter Verkauf->Berichte->Aufträge finden sich zwei neue Checkboxen, "Wiederkehrende Rechnungen aktiv" und - "Wiederkehrende Rechnungen inaktiv", mit denen man sich einen Überglick über die wiederkehrenden Rechnungen verschaffen - kann. - - + + kivitendo ERP verwenden - - Erzeugung der eigentlichen Rechnungen + Nach erfolgreicher Installation ist der Loginbildschirm unter + folgender URL erreichbar: - - Die zeitliche und periodische Überprüfung, ob eine wiederkehrende Rechnung automatisch erstellt werden soll, geschieht durch den - Taskserver, einen externen Dienst, der automatisch beim Start des Servers gestartet - werden sollte. - - + http://localhost/kivitendo-erp/login.pl - - Erste Rechnung für aktuellen Monat erstellen + Die Administrationsseite erreichen Sie unter: - - Will man im laufenden Monat eine monatlich wiederkehrende Rechnung inkl. des laufenden Monats starten, stellt man das Startdatum auf - den Monatsanfang und wartet ein paar Minuten, bis der Taskserver den neu konfigurieren Auftrag erkennt und daraus eine Rechnung - generiert hat. Alternativ setzt man das Startdatum auf den Monatsersten des Folgemonats und erstellt die erste Rechnung direkt - manuell über den Workflow. - - + http://localhost/kivitendo-erp/admin.pl - - Entwicklerdokumentation + + Features und Funktionen - - Globale Variablen + + Wiederkehrende Rechnungen - - Wie sehen globale Variablen in Perl aus? + + Einführung - 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. + Wiederkehrende Rechnungen werden als normale Aufträge definiert + und konfiguriert, mit allen dazugehörigen Kunden- und Artikelangaben. + Die konfigurierten Aufträge werden später automatisch in Rechnungen + umgewandelt, so als ob man den Workflow benutzen würde, und auch die + Auftragsnummer wird übernommen, sodass alle wiederkehrenden + Rechnungen, die aus einem Auftrag erstellt wurden, später leicht + wiederzufinden sind. + - Daraus ergeben sich folgende Formen: + + Konfiguration + + Um einen Auftrag für wiederkehrende Rechnung zu konfigurieren, + findet sich beim Bearbeiten des Auftrags ein neuer Knopf + "Konfigurieren", der ein neues Fenster öffnet, in dem man die nötigen + Parameter einstellen kann. Hinter dem Knopf wird außerdem noch + angezeigt, ob der Auftrag als wiederkehrende Rechnung konfiguriert ist + oder nicht. + + Folgende Parameter kann man konfigurieren: - $main::form + Status - expliziter Namespace "main" + Bei aktiven Rechnungen wird automatisch eine Rechnung + erstellt, wenn die Periodizität erreicht ist (z.B. Anfang eines + neuen Monats). + + Ist ein Auftrag nicht aktiv, so werden für ihn auch keine + wiederkehrenden Rechnungen erzeugt. Stellt man nach längerer + nicht-aktiver Zeit einen Auftrag wieder auf aktiv, wird beim + nächsten Periodenwechsel für alle Perioden, seit der letzten + aktiven Periode, jeweils eine Rechnung erstellt. Möchte man dies + verhindern, muss man vorher das Startdatum neu setzen. + + Für gekündigte Aufträge werden nie mehr Rechnungen + erstellt. Man kann sich diese Aufträge aber gesondert in den + Berichten anzeigen lassen. - $::form + Periodizität - impliziter Namespace "main" + Ob monatlich, quartalsweise oder jährlich auf neue + Rechnungen überprüft werden soll. Für jede Periode seit dem + Startdatum wird überprüft, ob für die Periode (beginnend immer + mit dem ersten Tag der Periode) schon eine Rechnung erstellt + wurde. Unter Umständen können bei einem Startdatum in der + Vergangenheit gleich mehrere Rechnungen erstellt werden. - open FILE, "file.txt" + Buchen auf - FILE ist global + Das Forderungskonto, in der Regel "Forderungen aus + Lieferungen und Leistungen". Das Gegenkonto ergibt sich aus den + Buchungsgruppen der betreffenden Waren. - $_ + Startdatum - speziell + ab welchem Datum auf Rechnungserstellung geprüft werden + soll - - - 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 + Enddatum - lexikalische Variable, gültig bis zum Ende des - Scopes + ab wann keine Rechnungen mehr erstellt werden + sollen - our $form + Automatische Verlängerung um x Monate - $form referenziert ab hier - $PACKAGE::form. + Sollen die wiederkehrenden Rechnungen bei Erreichen des + eingetragenen Enddatums weiterhin erstellt werden, so kann man + hier die Anzahl der Monate eingeben, um die das Enddatum + automatisch nach hinten geschoben wird. - local $form + Drucken - Alle Änderungen an $form werden am Ende - des scopes zurückgesetzt + Sind Drucker konfiguriert, so kann man sich die erstellten + Rechnungen auch gleich ausdrucken lassen. + + Nach Erstellung der Rechnungen kann eine E-Mail mit + Informationen zu den erstellten Rechnungen verschickt werden. + Konfiguriert wird dies in der Konfigurationsdatei + config/kivitendo.conf im Abschnitt + [periodic_invoices]. - - Warum sind globale Variablen ein Problem? + + Auflisten - Das erste Problem ist FCGI. + Unter Verkauf->Berichte->Aufträge finden sich zwei neue + Checkboxen, "Wiederkehrende Rechnungen aktiv" und "Wiederkehrende + Rechnungen inaktiv", mit denen man sich einen Überglick über die + wiederkehrenden Rechnungen verschaffen kann. + - 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. + + Erzeugung der eigentlichen Rechnungen - 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. + Die zeitliche und periodische Überprüfung, ob eine + wiederkehrende Rechnung automatisch erstellt werden soll, geschieht + durch den Taskserver, einen + externen Dienst, der automatisch beim Start des Servers gestartet + werden sollte. - - Kanonische globale Variablen + + Erste Rechnung für aktuellen Monat erstellen - Um dieses Problem im Griff zu halten gibt es einige wenige - globale Variablen, die kanonisch sind, und alles andere sollte - anderweitig umhergereicht werden. + Will man im laufenden Monat eine monatlich wiederkehrende + Rechnung inkl. des laufenden Monats starten, stellt man das Startdatum + auf den Monatsanfang und wartet ein paar Minuten, bis der Taskserver + den neu konfigurieren Auftrag erkennt und daraus eine Rechnung + generiert hat. Alternativ setzt man das Startdatum auf den + Monatsersten des Folgemonats und erstellt die erste Rechnung direkt + manuell über den Workflow. + + - Diese Variablen sind im Moment die folgenden neun: + + 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 kivitendo 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: - $::form + SL/Form.pm öffnen und am Anfang die + Zeile "use Data::Dumper;" einfügen. - %::myconfig + In Form.pm die Funktion + parse_template suchen und hier die Zeile + print(STDERR Dumper($self)); einfügen. - $::locale + Einmal per Browser die gewünschte Vorlage "benutzen", z.B. + ein PDF für eine Rechnung erzeugen. - $::lxdebug + Im error.log Apache steht die Ausgabe + der Variablen $self in der Form 'key' + => 'value',. Alle keys sind + verfügbar. + + - - $::auth - + + Variablen ausgeben - - $::lx_office_conf - + Um eine Variable auszugeben, müssen sie einfach nur zwischen die + Tags geschrieben werden, also z.B. + <%variablenname%>. - - $::instance_conf - + 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: + - $::dispatcher + 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. - $::request + 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. - Damit diese nicht als Müllhalde misbrauch werden, im Folgenden - eine kurze Erläuterung was man von denn erwarten kann. + Beispiel: - - $::form + <%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 kivitendo 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 - - Ist ein Objekt der Klasse - "Form" + Lagerliste + + + + check.ext - Wird nach jedem Request gelöscht + ? + + + + invoice.ext - Muss auch in Tests und Konsolenscripts vorhanden - sein. + Rechnung + + + + packing_list.ext - Enthält am Anfang eines Requests die Requestparameter vom - User + Packliste + + + + pick_list.ext - Kann zwar intern über Requestgrenzen ein Datenbankhandle - cachen, das wird aber momentan absichtlich zerstört + Sammelliste - - - $::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 + + purchase_delivery_order.ext - - Das einzige Hash unter den globalen Variablen + Lieferschein (Einkauf) + - - Wird spätestens benötigt wenn auf die Datenbank - zugegriffen wird - + + purcharse_order.ext - Wird bei jedem Request neu erstellt. + Bestellung an Lieferanten + - - Enthält die Userdaten des aktuellen Logins - + + request_quotation.ext - Sollte nicht ohne Filterung irgendwo gedumpt werden oder - extern serialisiert werden, weil da auch der Datenbankzugriff - für diesenuser drinsteht. + Anfrage an Lieferanten + - - Enthält unter anderem Listenbegrenzung vclimit, - Datumsformat dateformat und Nummernformat numberformat - + + sales_delivery_order.ext - Enthält Datenbankzugriffinformationen + Lieferschein (Verkauf) - - - %::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" - + + sales_order.ext - Wird pro Request erstellt + Bestellung + - - Muss auch für Tests und Scripte immer verfügbar - sein. - + + sales_quotation.ext - Cached intern über Requestgrenzen hinweg benutzte - Locales + Angebot an Kunden - - - Lokalisierung für den aktuellen User. Alle Übersetzungen, - Zahlen- und Datumsformatierungen laufen über dieses Objekt. - + - - $::lxdebug + + zahlungserinnerung.ext - - Objekt der Klasse "LXDebug" + Mahnung (Dateiname im Programm konfigurierbar) + - - Wird global gecached - + + zahlungserinnerung_invoice.ext - Muss immer verfügbar sein, in nahezu allen - Funktionen + Rechnung über Mahngebühren (Dateiname im Programm + konfigurierbar) - - - $::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 + + Sprache, Drucker und E-Mail - - - Objekt der Klasse "SL::Auth" - + 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. - - Wird global gecached - + 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: - - Hat eine permanente DB Verbindung zur Authdatenbank - + + + sales_order_email_de_lpr2.tex + - - Wird nach jedem Request resettet. - - + + sales_order_de_lpr2.tex + - $::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. - + + sales_order.tex + - - $::lx_office_conf + + default.tex + + - - - Objekt der Klasse - "SL::LxOfficeConf" - + Die kurzen Varianten dieser Vorlagentitel müssen dann entweder + Standardwerte anzeigen, oder die angeforderten Werte selbst auswerten, + siehe dazu . + - - Global gecached - + + Allgemeine Variablen, die in allen Vorlagen vorhanden + sind - - Repräsentation der - config/lx_office.conf[.default]-Dateien - - + + Metainformationen zur angeforderten Vorlage - 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. + 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. - Für die folgende Konfigurationsdatei: + + + template_meta.formname - [debug] - file = /tmp/lxoffice_debug_log.txt + + Basisname der Vorlage. Identisch mit der Zurordnung + zu den Dateinamen ohne die Erweiterung. Ein + Verkaufsauftrag enthält hier + sales_order. + + - ist der Key file im Programm als - $::lx_office_conf->{debug}{file} - erreichbar. + + template_meta.language.description - - Zugriff auf die Konfiguration erfolgt im Moment über - Hashkeys, sind also nicht gegen Tippfehler abgesichert. - - + + Beschreibung der verwendeten Sprache + + - - $::instance_conf + + template_meta.language.template_code - - - Objekt der Klasse - "SL::InstanceConfiguration" - + + Vorlagenürzel der verwendeten Sprache, identisch mit dem + Kürzel das im Dateinamen verwendetet wird. + + - - wird pro Request neu erstellt - - + + template_meta.language.output_numberformat - 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. - + + Zahlenformat der verwendeten Sprache in der Form + "1.000,00". Experimentell! Nur + interessant für Vorlagen die mit unformatierten Werten + arbeiten. + + - - $::dispatcher + + template_meta.language.output_dateformat - - - 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. + + Datumsformat der verwendeten Sprache in der Form + "dd.mm.yyyy". Experimentell! Nur + interessant für Vorlagen die mit unformatierten Werten + arbeiten. + + - - $::cgi + + template_meta.format - - - war nötig, weil cookie Methoden nicht als - Klassenfunktionen funktionieren - + + Das angeforderte Format. Kann im Moment die Werte + pdf, postscript, + html, opendocument, + opendocument_pdf und + excel enthalten. + + - - Aufruf als Klasse erzeugt Dummyobjekt was im - Klassennamespace gehalten wird und über Requestgrenzen - leaked - + + template_meta.extension - - liegt jetzt unter - $::request->{cgi} - - - + + Dateierweiterung, wie im Dateinamen. Wird aus + format entschieden. + + - - $::all_units + + template_meta.media - - - 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. - + + 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. + + - - Liegt jetzt unter - $::request->{cache}{all_units} - + + template_meta.printer.description - - Wird nur in - AM->retrieve_all_units() gesetzt oder - gelesen. - - - + + Beschreibung des ausgewählten Druckers + + - - %::called_subs + + template_meta.printer.template_code - - - wurde benutzt um callsub deep recursions - abzufangen. - + + Vorlagenürzel des ausgewählten Druckers, identisch mit + dem Kürzel das im Dateinamen verwendetet wird. + + - - Wurde entfernt, weil callsub nur einen Bruchteil der - möglichen Rekursioenen darstellt, und da nie welche - auftreten. - + + template_meta.tmpfile - - komplette recursion protection wurde entfernt. - - + + Datei-Prefix für temporäre Dateien. + + + - - - - 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. - + + Stammdaten von Kunden und Lieferanten - - In Form.pm die Funktion - parse_template suchen und hier die Zeile - print(STDERR Dumper($self)); einfügen. - + + + account_number - - Einmal per Browser die gewünschte Vorlage "benutzen", z.B. - ein PDF für eine Rechnung erzeugen. - + + Kontonummer + + - - Im error.log Apache steht die Ausgabe - der Variablen $self in der Form 'key' - => 'value',. Alle keys sind - verfügbar. - - - + + bank - - Variablen ausgeben + + Name der Bank + + - Um eine Variable auszugeben, müssen sie einfach nur zwischen die - Tags geschrieben werden, also z.B. - <%variablenname%>. + + bank_code - 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: + + Bankleitzahl + + - - - 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. - + + bic - - 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. - - + + Bank-Identifikations-Code (Bank Identifier Code, + BIC) + + - Beispiel: + + business - <%quototal NOFORMAT%> - + + Kunden-/Lieferantentyp + + - - Verwendung in Druckbefehlen + + city - 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. + + Stadt + + - 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: + + contact - send_fax --number <%if cp_phone2%><%cp_phone2%><%else%><%cp_phone1%><%end%> - + + Kontakt + + - - Anfang und Ende der Tags verändern + + country - 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. + + Land + + - 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: + + cp_email - % config: tag-style=($ $) + + Email des Ansprechpartners + + - 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: + + cp_givenname - <!-- config: tag-style=($ $) --> - + + Vorname des Ansprechpartners + + - - Zuordnung von den Dateinamen zu den Funktionen + + cp_greeting - 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. + + Anrede des Ansprechpartners + + - - - bin_list.ext + + cp_name - - Lagerliste - - + + Name des Ansprechpartners + + - - check.ext + + cp_phone1 - - ? - - + + Telefonnummer 1 des Ansprechpartners + + - - invoice.ext + + cp_phone2 - - Rechnung - - + + Telefonnummer 2 des Ansprechpartners + + - - packing_list.ext + + cp_title - - Packliste - - + + Titel des Ansprechpartners + + - - pick_list.ext + + creditlimit - - Sammelliste - - + + Kreditlimit + + - - purchase_delivery_order.ext + + customeremail - - Lieferschein (Einkauf) - - + + Email des Kunden; nur für Kunden + + - - purcharse_order.ext + + customerfax - - Bestellung an Lieferanten - - + + Faxnummer des Kunden; nur für Kunden + + - - request_quotation.ext + + customernotes - - Anfrage an Lieferanten - - + + Bemerkungen beim Kunden; nur für Kunden + + - - sales_delivery_order.ext + + customernumber - - Lieferschein (Verkauf) - - + + Kundennummer; nur für Kunden + + - - sales_order.ext + + customerphone - - Bestellung - - + + Telefonnummer des Kunden; nur für Kunden + + - - sales_quotation.ext + + discount - - Angebot an Kunden - - + + Rabatt + + - - zahlungserinnerung.ext + + email - - Mahnung (Dateiname im Programm konfigurierbar) - - + + Emailadresse + + - - zahlungserinnerung_invoice.ext + + fax - - Rechnung über Mahngebühren (Dateiname im Programm - konfigurierbar) - - - - + + Faxnummer + + - - Sprache, Drucker und E-Mail + + homepage - 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. + + Homepage + + - 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: + + iban - - - sales_order_email_de_lpr2.tex - + + Internationale Kontonummer (International Bank Account + Number, IBAN) + + - - sales_order_de_lpr2.tex - + + language - - sales_order.tex - + + Sprache + + - - default.tex - - + + name - Die kurzen Varianten dieser Vorlagentitel müssen dann entweder - Standardwerte anzeigen, oder die angeforderten Werte selbst auswerten, - siehe dazu . - + + Firmenname + + - - Allgemeine Variablen, die in allen Vorlagen vorhanden - sind + + payment_description - - Metainformationen zur angeforderten Vorlage + + Name der Zahlart + + - 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. + + payment_terms + + + Zahlungskonditionen + + - - template_meta.formname + phone - Basisname der Vorlage. Identisch mit der Zurordnung - zu den Dateinamen ohne die Erweiterung. Ein - Verkaufsauftrag enthält hier - sales_order. + Telefonnummer - template_meta.language.description + shiptocity - Beschreibung der verwendeten Sprache + Stadt (Lieferadresse) * - template_meta.language.template_code + shiptocontact - Vorlagenürzel der verwendeten Sprache, identisch mit dem - Kürzel das im Dateinamen verwendetet wird. + Kontakt (Lieferadresse) * - template_meta.language.output_numberformat + shiptocountry - Zahlenformat der verwendeten Sprache in der Form - "1.000,00". Experimentell! Nur - interessant für Vorlagen die mit unformatierten Werten - arbeiten. + Land (Lieferadresse) * - template_meta.language.output_dateformat + shiptodepartment1 - Datumsformat der verwendeten Sprache in der Form - "dd.mm.yyyy". Experimentell! Nur - interessant für Vorlagen die mit unformatierten Werten - arbeiten. + Abteilung 1 (Lieferadresse) * - template_meta.format + shiptodepartment2 - Das angeforderte Format. Kann im Moment die Werte - pdf, postscript, - html, opendocument, - opendocument_pdf und - excel enthalten. + Abteilung 2 (Lieferadresse) * - template_meta.extension + shiptoemail - Dateierweiterung, wie im Dateinamen. Wird aus - format entschieden. + Email (Lieferadresse) * - template_meta.media + shiptofax - 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. + Fax (Lieferadresse) * - template_meta.printer.description + shiptoname - Beschreibung des ausgewählten Druckers + Firmenname (Lieferadresse) * - template_meta.printer.template_code + shiptophone - Vorlagenürzel des ausgewählten Druckers, identisch mit - dem Kürzel das im Dateinamen verwendetet wird. + Telefonnummer (Lieferadresse) * - - - - - Stammdaten von Kunden und Lieferanten - - account_number + shiptostreet - Kontonummer + Straße und Hausnummer (Lieferadresse) * - bank + shiptozipcode - Name der Bank + Postleitzahl (Lieferadresse) * - bank_code + street - Bankleitzahl + Straße und Hausnummer - bic + taxnumber - Bank-Identifikations-Code (Bank Identifier Code, - BIC) + Steuernummer - business + ustid - Kunden-/Lieferantentyp + Umsatzsteuer-Identifikationsnummer - city + vendoremail - Stadt + Email des Lieferanten; nur für Lieferanten - contact + vendorfax - Kontakt + Faxnummer des Lieferanten; nur für Lieferanten - country + vendornotes - Land + Bemerkungen beim Lieferanten; nur für Lieferanten - cp_email + vendornumber - Email des Ansprechpartners + Lieferantennummer; nur für Lieferanten - cp_givenname + vendorphone - Vorname des Ansprechpartners + Telefonnummer des Lieferanten; nur für + Lieferanten - cp_greeting + zipcode - Anrede des Ansprechpartners + 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 + - cp_name + employee_address - Name des Ansprechpartners + Adressfeld - cp_phone1 + employee_businessnumber - Telefonnummer 1 des Ansprechpartners + Firmennummer - cp_phone2 + employee_company - Telefonnummer 2 des Ansprechpartners + Firmenname - cp_title + employee_co_ustid - Titel des Ansprechpartners + Usatzsteuer-Identifikationsnummer - creditlimit + employee_duns - Kreditlimit + DUNS-Nummer - customeremail + employee_email - Email des Kunden; nur für Kunden + Email - customerfax + employee_fax - Faxnummer des Kunden; nur für Kunden + Fax - customernotes + employee_name - Bemerkungen beim Kunden; nur für Kunden + voller Name - customernumber + employee_signature - Kundennummer; nur für Kunden + Signatur - customerphone + employee_taxnumber - Telefonnummer des Kunden; nur für Kunden + Steuernummer - discount + employee_tel - Rabatt + Telefonnummer + + + + + Informationen über den Bearbeiter + - email + salesman_address - Emailadresse + Adressfeld - fax + salesman_businessnumber - Faxnummer + Firmennummer - homepage + salesman_company - Homepage + Firmenname - iban + salesman_co_ustid - Internationale Kontonummer (International Bank Account - Number, IBAN) + Usatzsteuer-Identifikationsnummer - language + salesman_duns - Sprache + DUNS-Nummer - name + salesman_email - Firmenname + Email - payment_description + salesman_fax - Name der Zahlart + Fax - payment_terms + salesman_name - Zahlungskonditionen + voller Name - phone + salesman_signature - Telefonnummer + Signatur - shiptocity + salesman_taxnumber - Stadt (Lieferadresse) * + Steuernummer - shiptocontact + salesman_tel - Kontakt (Lieferadresse) * + Telefonnummer + + + + Variablen für die einzelnen Steuern + + - shiptocountry + tax - Land (Lieferadresse) * + Steuer - shiptodepartment1 + taxbase - Abteilung 1 (Lieferadresse) * + zu versteuernder Betrag - shiptodepartment2 + taxdescription - Abteilung 2 (Lieferadresse) * + Name der Steuer - shiptoemail + taxrate - Email (Lieferadresse) * + Steuersatz + + + + + + Variablen in Rechnungen + + + Allgemeine Variablen + - shiptofax + creditremaining - Fax (Lieferadresse) * + Verbleibender Kredit - shiptoname + currency - Firmenname (Lieferadresse) * + Währung - shiptophone + cusordnumber - Telefonnummer (Lieferadresse) * + Bestellnummer beim Kunden - shiptostreet + deliverydate - Straße und Hausnummer (Lieferadresse) * + Lieferdatum - shiptozipcode + duedate - Postleitzahl (Lieferadresse) * + Fälligkeitsdatum - street + globalprojectnumber - Straße und Hausnummer + Projektnummer des ganzen Beleges - taxnumber + globalprojectdescription - Steuernummer + Projekbeschreibung des ganzen Beleges - ustid + intnotes - Umsatzsteuer-Identifikationsnummer + Interne Bemerkungen - vendoremail + invdate - Email des Lieferanten; nur für Lieferanten + Rechnungsdatum - vendorfax + invnumber - Faxnummer des Lieferanten; nur für Lieferanten + Rechnungsnummer - vendornotes + invtotal - Bemerkungen beim Lieferanten; nur für Lieferanten + gesamter Rechnungsbetrag - vendornumber + notes - Lieferantennummer; nur für Lieferanten + Bemerkungen der Rechnung - vendorphone + orddate - Telefonnummer des Lieferanten; nur für - Lieferanten + Auftragsdatum - zipcode + ordnumber - Postleitzahl + Auftragsnummer, wenn die Rechnung aus einem Auftrag + erstellt wurde - - - 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). - - + + payment_description - - Informationen über den Bearbeiter + + Name der Zahlart + + - - employee_address + payment_terms - Adressfeld + Zahlungskonditionen - employee_businessnumber + quodate - Firmennummer + Angebotsdatum - employee_company + quonumber - Firmenname + Angebotsnummer - employee_co_ustid + shippingpoint - Usatzsteuer-Identifikationsnummer + Versandort - employee_duns + shipvia - DUNS-Nummer + Transportmittel - employee_email + subtotal - Email + Zwischensumme aller Posten ohne Steuern - employee_fax + total - Fax + Restsumme der Rechnung (Summe abzüglich bereits + bezahlter Posten) - employee_name + transaction_description - voller Name + Vorgangsbezeichnung - employee_signature + transdate - Signatur + Auftragsdatum wenn die Rechnung aus einem Auftrag + erstellt wurde + + + + + Variablen für jeden Posten auf der Rechnung + - employee_taxnumber + bin - Steuernummer + Stellage - employee_tel + description - Telefonnummer + Artikelbeschreibung - - - - - Informationen über den Bearbeiter - - salesman_address + discount - Adressfeld + Rabatt als Betrag - salesman_businessnumber + discount_sub - Firmennummer + Zwischensumme mit Rabatt - salesman_company + drawing - Firmenname + Zeichnung - salesman_co_ustid + ean - Usatzsteuer-Identifikationsnummer + EAN-Code - salesman_duns + image - DUNS-Nummer + Grafik - salesman_email + linetotal - Email + Zeilensumme (Anzahl * Einzelpreis) - salesman_fax + longdescription - Fax + Langtext - salesman_name + microfiche - voller Name + Mikrofilm - salesman_signature + netprice - Signatur + Nettopreis - salesman_taxnumber + nodiscount_linetotal - Steuernummer + Zeilensumme ohne Rabatt - salesman_tel + nodiscount_sub - Telefonnummer + Zwischensumme ohne Rabatt - - - - - Variablen für die einzelnen Steuern - - tax + number - Steuer + Artikelnummer - taxbase + ordnumber_oe - zu versteuernder Betrag + Auftragsnummer des Originalauftrags, wenn die Rechnung + aus einem Sammelauftrag erstellt wurde - taxdescription + p_discount - Name der Steuer + Rabatt in Prozent - taxrate + partnotes - Steuersatz + Die beim Artikel gespeicherten Bemerkungen - - - - - Variablen in Rechnungen + + partsgroup - - Allgemeine Variablen + + Warengruppe + + - - creditremaining + price_factor - Verbleibender Kredit + Der Preisfaktor als Zahl, sofern einer eingestellt + ist - currency + price_factor_name - Währung + Der Name des Preisfaktors, sofern einer eingestellt + ist - cusordnumber + projectnumber - Bestellnummer beim Kunden + Projektnummer - deliverydate + projectdescription - Lieferdatum + Projektbeschreibung - duedate + qty - Fälligkeitsdatum + Anzahl - globalprojectnumber + reqdate - Projektnummer des ganzen Beleges + Lieferdatum - globalprojectdescription + runningnumber - Projekbeschreibung des ganzen Beleges + Position auf der Rechnung (1, 2, 3...) - intnotes + sellprice - Interne Bemerkungen + Verkaufspreis - invdate + serialnumber - Rechnungsdatum + Seriennummer - invnumber + tax_rate - Rechnungsnummer + Steuersatz - invtotal + transdate_oe - gesamter Rechnungsbetrag + Auftragsdatum des Originalauftrags, wenn die Rechnung + aus einem Sammelauftrag erstellt wurde - notes + unit - Bemerkungen der Rechnung + Einheit - orddate + weight - Auftragsdatum + 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: + - ordnumber + make - Auftragsnummer, wenn die Rechnung aus einem Auftrag - erstellt wurde + Lieferant - payment_description + model - Name der Zahlart + Lieferantenartikelnummer + + + + + Variablen für die einzelnen Zahlungseingänge + - payment_terms + payment - Zahlungskonditionen + Betrag - quodate + paymentaccount - Angebotsdatum + Konto - quonumber + paymentdate - Angebotsnummer + Datum - shippingpoint + paymentmemo - Versandort + Memo - shipvia + paymentsource - Transportmittel + 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: + - subtotal + dunning_date - Zwischensumme aller Posten ohne Steuern + Datum der Mahnung - total + dunning_duedate - Restsumme der Rechnung (Summe abzüglich bereits - bezahlter Posten) + Fälligkeitsdatum für diese Mahhnung - transaction_description + dunning_id - Vorgangsbezeichnung + Mahnungsnummer - transdate + fee - Auftragsdatum wenn die Rechnung aus einem Auftrag - erstellt wurde + Kummulative Mahngebühren - - - - - Variablen für jeden Posten auf der Rechnung - - bin + interest_rate - Stellage + Zinssatz per anno in Prozent - description + total_amount - Artikelbeschreibung + Gesamter noch zu zahlender Betrag als + fee + total_interest + + total_open_amount - discount + total_interest - Rabatt als Betrag + Zinsen per anno über alle Rechnungen - discount_sub + total_open_amount - Zwischensumme mit Rabatt + Summe über alle offene Beträge der Rechnungen + + + + + Variablen für jede gemahnte Rechnung in einer Mahnung + - drawing + dn_amount - Zeichnung + Rechnungssumme (brutto) - ean + dn_duedate - EAN-Code + Originales Fälligkeitsdatum der Rechnung - image + dn_dunning_date - Grafik + Datum der Mahnung - linetotal + dn_dunning_duedate - Zeilensumme (Anzahl * Einzelpreis) + Fälligkeitsdatum der Mahnung - longdescription + dn_fee - Langtext + Kummulative Mahngebühr - microfiche + dn_interest - Mikrofilm + Zinsen per anno für diese Rechnung - netprice + dn_invnumber - Nettopreis + Rechnungsnummer - nodiscount_linetotal + dn_linetotal - Zeilensumme ohne Rabatt + Noch zu zahlender Betrag (ergibt sich aus + dn_open_amount + dn_fee + + dn_interest) - nodiscount_sub + dn_netamount - Zwischensumme ohne Rabatt + Rechnungssumme (netto) - number + dn_open_amount - Artikelnummer + Offener Rechnungsbetrag - ordnumber_oe + dn_ordnumber - Auftragsnummer des Originalauftrags, wenn die Rechnung - aus einem Sammelauftrag erstellt wurde + Bestellnummer - p_discount + dn_transdate - Rabatt in Prozent + Rechnungsdatum - partnotes + dn_curr - Die beim Artikel gespeicherten Bemerkungen + 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: + - partsgroup + duedate - Warengruppe + Fälligkeitsdatum der Rechnung - price_factor + dunning_id - Der Preisfaktor als Zahl, sofern einer eingestellt - ist + Mahnungsnummer - price_factor_name + fee - Der Name des Preisfaktors, sofern einer eingestellt - ist + Mahngebühren - projectnumber + interest - Projektnummer + Zinsen - projectdescription + invamount - Projektbeschreibung + Rechnungssumme (ergibt sich aus fee + + interest) - qty + invdate - Anzahl + Rechnungsdatum - reqdate + invnumber - Lieferdatum + 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 + - runningnumber + quonumber - Position auf der Rechnung (1, 2, 3...) + Angebots- bzw. Anfragenummer - sellprice + reqdate - Verkaufspreis + Gültigkeitsdatum (bei Angeboten) bzw. Lieferdatum (bei + Preisanfragen) - serialnumber + transdate - Seriennummer + Angebots- bzw. Anfragedatum + + + + + Auftragsbestätigungen und Lieferantenaufträge + - tax_rate + ordnumber - Steuersatz + Auftragsnummer - transdate_oe + reqdate - Auftragsdatum des Originalauftrags, wenn die Rechnung - aus einem Sammelauftrag erstellt wurde + Lieferdatum - unit + transdate - Einheit + Auftragsdatum + + + + + Lieferscheine (Verkauf und Einkauf) + - weight + cusordnumber - Gewicht + Bestellnummer des Kunden (im Verkauf) bzw. Bestellnummer + des Lieferanten (im Einkauf) - - - 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 + donumber - Lieferant + Lieferscheinnummer - model + transdate - Lieferantenartikelnummer + Lieferscheindatum - - - Variablen für die einzelnen Zahlungseingänge + 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: - payment + si_bin - Betrag + Lagerplatz - paymentaccount + si_chargenumber - Konto + Chargennummer - paymentdate + si_bestbefore - Datum + Mindesthaltbarkeit - paymentmemo + si_number - Memo + Artikelnummer - paymentsource + si_qty - Beleg + Anzahl bzw. Menge - - - - - 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 + si_runningnumber - Datum der Mahnung + Positionsnummer (1, 2, 3 etc) - dunning_duedate + si_unit - Fälligkeitsdatum für diese Mahhnung + Einheit - dunning_id + si_warehouse - Mahnungsnummer + Lager + + + + + Variablen für Sammelrechnung + - fee + c0total - Kummulative Mahngebühren + Gesamtbetrag aller Rechnungen mit Fälligkeit < 30 + Tage - interest_rate + c30total - Zinssatz per anno in Prozent + Gesamtbetrag aller Rechnungen mit Fälligkeit >= 30 + und < 60 Tage - total_amount + c60total - Gesamter noch zu zahlender Betrag als - fee + total_interest - + total_open_amount + Gesamtbetrag aller Rechnungen mit Fälligkeit >= 60 + und < 90 Tage - total_interest + c90total - Zinsen per anno über alle Rechnungen + Gesamtbetrag aller Rechnungen mit Fälligkeit >= 90 + Tage - total_open_amount + total - Summe über alle offene Beträge der Rechnungen + Gesamtbetrag aller Rechnungen - - - Variablen für jede gemahnte Rechnung in einer Mahnung + Variablen für jede Rechnungsposition in Sammelrechnung: - dn_amount + invnumber - Rechnungssumme (brutto) + Rechnungsnummer - dn_duedate + invdate - Originales Fälligkeitsdatum der Rechnung + Rechnungsdatum - dn_dunning_date + duedate - Datum der Mahnung + Fälligkeitsdatum - dn_dunning_duedate + amount - Fälligkeitsdatum der Mahnung + Summe der Rechnung - dn_fee + open - Kummulative Mahngebühr + Noch offener Betrag der Rechnung - dn_interest + c0 - Zinsen per anno für diese Rechnung + Noch offener Rechnungsbetrag mit Fälligkeit < 30 + Tage - dn_invnumber + c30 - Rechnungsnummer + Noch offener Rechnungsbetrag mit Fälligkeit >= 30 und + < 60 Tage - dn_linetotal + c60 - Noch zu zahlender Betrag (ergibt sich aus - dn_open_amount + dn_fee - + dn_interest) + Noch offener Rechnungsbetrag mit Fälligkeit >= 60 und + < 90 Tage - dn_netamount + 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. + + Handelt es sich bei der benannten Variable um ein Array, also um einen Variablennamen, über den man mit + <%foreach variablenname%> iteriert, so wird mit diesem Konstrukt darauf getestet, ob das Array Elemente + enthält. Somit würde im folgenden Beispiel nur dann eine Liste von Zahlungseingängen samt ihrer Überschrift "Zahlungseingänge" + ausgegeben, wenn tatsächlich welche getätigt wurden: + + <%if payment%> +Zahlungseingänge: + <%foreach payment%> + Am <%paymentdate%>: <%payment%> € + <%end foreach%> +<%end if%> + + 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 - - Rechnungssumme (netto) - - + <%foreach variablenname%> +... +<%end%> - - dn_open_amount + 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. - - Offener Rechnungsbetrag - - + Die Syntax sieht normalerweise wie folgt aus: - - dn_ordnumber + <%foreach number%> +Position: <%runningnumber%> +Anzahl: <%qty%> +Artikelnummer: <%number%> +Beschreibung: <%description%> +... +<%end%> - - Bestellnummer - - + 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. + + - - dn_transdate + + Markup-Code zur Textformatierung innerhalb von + Formularen - - Rechnungsdatum - - + Wenn der Benutzer innhalb von Formularen in kivitendo Text + anders formatiert haben möchte, so ist dies begrenzt möglich. + kivitendo 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. - - dn_curr + Die unterstützen Formatierungen sind: - - Währung, in der die Rechnung erstellt wurde. (Die - Rechnungsbeträge sind aber immer in der Hauptwährung) - - - - + + + <b>Text</b> - - Variablen in automatisch erzeugten Rechnungen über - Mahngebühren + + Text wird in Fettdruck gesetzt. + + - 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. + + <i>Text</i> - Weitere Variablen beinhalten: + + Text wird kursiv gesetzt. + + - - - duedate + + <u>Text</u> - - Fälligkeitsdatum der Rechnung - - + + Text wird unterstrichen. + + - - dunning_id + + <s>Text</s> - - Mahnungsnummer - - + + Text wird durchgestrichen. Diese Formatierung ist nicht + bei der Ausgabe als PDF über LaTeX verfügbar. + + - - fee + + <bullet> - - Mahngebühren - - + + Erzeugt einen ausgefüllten Kreis für Aufzählungen (siehe + unten). + + + - - interest + Der Befehl <bullet> funktioniert + momentan auch nur in Latex-Vorlagen. + + - - Zinsen - - + + Excel-Vorlagen - - invamount + + Zusammenfassung - - Rechnungssumme (ergibt sich aus fee + - interest) - - + Dieses Dokument beschreibt den Mechanismus, mit dem + Exceltemplates abgearbeitet werden, und die Einschränkungen, die damit + einhergehen. + - - invdate + + Bedienung - - Rechnungsdatum - - + Der Excel Mechanismus muss in der Konfigurationsdatei aktiviert + werden. Die Konfigurationsoption heißt excel_templates = + 1 im Abschnitt [print_templates]. - - invnumber + 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. - - Rechnungsnummer - - - - + Der Sonderfall der Angebote aus der Kundenmaske ist ebenfalls + eine Angebotsvorlage und wird unter dem internen Namen der Angebote + sales_quotation.xls gespeichert. - - Variablen in anderen Vorlagen + + Variablensyntax - - Einführung + Einfache Syntax: + <<varname>> - 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. + 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: - 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. + <<<<<varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> - Im Folgenden werden nur wichtige Unterschiede zu den Variablen - in Rechnungen aufgeführt. - + Um die Limitierung der festen Breite zu reduzieren, können + weitere Variablen in einem Block interpoliert werden. Whitespace wird + dazwishen dann erhalten. Beispiel: - - Angebote und Preisanfragen + <<<<<varname1 varname2 varname3>>>>>>>>>>>>>>>>>>>>>>>>>> - - - quonumber + 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. - - Angebots- bzw. Anfragenummer - - + Es ist ausserdem möglich, Daten rechtsbündig darzustellen, wenn + der Block mit einem Leerzeichen anfängt. Beispiel: - - reqdate + <<<<<< varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> - - Gültigkeitsdatum (bei Angeboten) bzw. Lieferdatum (bei - Preisanfragen) - - + Dies würde rechtsbündig triggern. Wenn bei rechtsbündiger + Ausrichtung Text abgeschnitten werden muss, wird er vom linken Ende + entfernt. + - - transdate + + Einschränkungen - - Angebots- bzw. Anfragedatum - - - - + 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. - - Auftragsbestätigungen und Lieferantenaufträge + 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. + + + - - - ordnumber + + Entwicklerdokumentation - - Auftragsnummer - - + + Globale Variablen - - reqdate + + Wie sehen globale Variablen in Perl aus? - - Lieferdatum - - + 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. - - transdate + Daraus ergeben sich folgende Formen: - - Auftragsdatum - - - - + + + $main::form - - Lieferscheine (Verkauf und Einkauf) + + expliziter Namespace "main" + + - - - cusordnumber + + $::form - - Bestellnummer des Kunden (im Verkauf) bzw. Bestellnummer - des Lieferanten (im Einkauf) - - + + impliziter Namespace "main" + + - - donumber + + open FILE, "file.txt" - - Lieferscheinnummer - - + + FILE ist global + + - - transdate + + $_ - - Lieferscheindatum - - - + + speziell + + + - 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: + Im Gegensatz zu PHP gibt es kein + Schlüsselwort wie "global", mit dem man + importieren kann. my, our + und local machen was anderes. - - - si_bin + + + my $form - - Lagerplatz - - + + lexikalische Variable, gültig bis zum Ende des + Scopes + + - - si_chargenumber + + our $form - - Chargennummer - - + + $form referenziert ab hier + $PACKAGE::form. + + - - si_bestbefore + + local $form - - Mindesthaltbarkeit - - + + Alle Änderungen an $form werden am Ende + des scopes zurückgesetzt + + + + - - si_number + + Warum sind globale Variablen ein Problem? - - Artikelnummer - - + Das erste Problem ist FCGI. - - si_qty + SQL-Ledger hat fast alles im globalen + namespace abgelegt, und erwartet, dass es da auch wiederzufinden ist. + Unter FCGI müssen diese Sachen aber 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 sehr lange zum Initialisieren + brauchen. - - Anzahl bzw. Menge - - + Das zweite Problem ist strict. Unter + strict werden alle Variablen die nicht explizit + mit Package, my oder + our angegeben werden als Tippfehler angemarkert, + dies hat, seit der Einführung, u.a. schon so manche langwierige + Bug-Suche verkürzt. Da globale Variablen aber implizit mit Package + angegeben werden, werden die nicht geprüft, und somit kann sich + schnell ein Tippfehler einschleichen. + - - si_runningnumber + + Kanonische globale Variablen - - Positionsnummer (1, 2, 3 etc) - - + Um dieses Problem im Griff zu halten gibt es einige wenige + globale Variablen, die kanonisch sind, d.h. sie haben bestimmte + vorgegebenen Eigenschaften, und alles andere sollte anderweitig + umhergereicht werden. - - si_unit + Diese Variablen sind im Moment die folgenden neun: - - Einheit - - + + + $::form + - - si_warehouse + + %::myconfig + - - Lager - - - - + + $::locale + - - Variablen für Sammelrechnung + + $::lxdebug + - - - c0total + + $::auth + - - Gesamtbetrag aller Rechnungen mit Fälligkeit < 30 - Tage - - + + $::lx_office_conf + - - c30total + + $::instance_conf + - - Gesamtbetrag aller Rechnungen mit Fälligkeit >= 30 - und < 60 Tage - - + + $::dispatcher + - - c60total + + $::request + + - - Gesamtbetrag aller Rechnungen mit Fälligkeit >= 60 - und < 90 Tage - - + Damit diese nicht erneut als Müllhalde missbraucht werden, im + Folgenden eine kurze Erläuterung der bestimmten vorgegebenen + Eigenschaften (Konventionen): - - c90total + + $::form - - Gesamtbetrag aller Rechnungen mit Fälligkeit >= 90 - Tage - - + + + Ist ein Objekt der Klasse + "Form" + - - total + + Wird nach jedem Request gelöscht + - - Gesamtbetrag aller Rechnungen - - - + + Muss auch in Tests und Konsolenscripts vorhanden + sein. + - Variablen für jede Rechnungsposition in Sammelrechnung: + + Enthält am Anfang eines Requests die Requestparameter vom + User + - - - invnumber + + Kann zwar intern über Requestgrenzen ein Datenbankhandle + cachen, das wird aber momentan absichtlich zerstört + + - - Rechnungsnummer - - + $::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 (alle Variablen die einem ans Herz + gewachsen sind), sollte man vor einem Aufruf (!) von zum Beispiel + IS->retrieve_customer() in Sicherheit + bringen. - - invdate + Z.B. das vom Benutzer eingestellte Zahlenformat, bevor man + Berechnung in einem bestimmten Format durchführt (SL/Form.pm Zeile + 3552, Stand version 2.7beta), um dies hinterher wieder auf den + richtigen Wert zu setzen: - - Rechnungsdatum - - + my $saved_numberformat = $::myconfig{numberformat}; + $::myconfig{numberformat} = $numberformat; + # (...) div Berechnungen + $::myconfig{numberformat} = $saved_numberformat; - - duedate + Das Objekt der Klasse Form hat leider im Moment noch viele + zentrale Funktionen die vom internen Zustand abhängen, deshalb bitte + nie einfach zerstören oder überschreiben (zumindestens nicht kurz + vor einem Release oder in Absprache über bspw. die devel-Liste ;-). + Es geht ziemlich sicher etwas kaputt. - - Fälligkeitsdatum - - + $::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}. Nochmal von der anderen Seite + erläutert, innerhalb von (Web-)Templates sieht man häufiger solche + Konstrukte: - - amount + [%- IF business %] +# (... Zeig die Auswahlliste Kunden-/Lieferantentyp an) +[%- END %] - - Summe der Rechnung - - + Entweder wird hier dann $::form->{business} ausgewertet + oder aber der Funktion + $form->parse_html_template wird explizit + noch ein zusätzlicher Hash übergeben, der dann auch in den + (Web-)Templates zu Verfügung steht, bspw. so: - - open + $form->parse_html_template("is/form_header", \%TMPL_VAR); - - Noch offener Betrag der Rechnung - - + Innerhalb von Schleifen wird + $::form->{TEMPLATE_ARRAYS}{var}[$index] + bevorzugt, wenn vorhanden. Ein Beispiel findet sich in SL/DO.pm, + welches über alle Positionen eines Lieferscheins in Schleife + läuft: + + for $i (1 .. $form->{rowcount}) { + # ... + push @{ $form->{TEMPLATE_ARRAYS}{runningnumber} }, $position; + push @{ $form->{TEMPLATE_ARRAYS}{number} }, $form->{"partnumber_$i"}; + push @{ $form->{TEMPLATE_ARRAYS}{description} }, $form->{"description_$i"}; + # ... +} + - - c0 + + %::myconfig - - Noch offener Rechnungsbetrag mit Fälligkeit < 30 - Tage - - + + + Das einzige Hash unter den globalen Variablen + - - c30 + + Wird spätestens benötigt wenn auf die Datenbank + zugegriffen wird + - - Noch offener Rechnungsbetrag mit Fälligkeit >= 30 und - < 60 Tage - - + + Wird bei jedem Request neu erstellt. + - - c60 + + Enthält die Userdaten des aktuellen Logins + - - Noch offener Rechnungsbetrag mit Fälligkeit >= 60 und - < 90 Tage - - + + Sollte nicht ohne Filterung irgendwo gedumpt werden oder + extern serialisiert werden, weil da auch der Datenbankzugriff + für diesen user drinsteht. + - - c90 + + Enthält unter anderem Listenbegrenzung vclimit, + Datumsformat dateformat und Nummernformat numberformat + - - Noch offener Rechnungsbetrag mit Fälligkeit >= 90 - Tage - - - + + 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. Innerhalb der Anwendungen sind dies + überwiegend die Daten, die sich unter Programm + -> Einstellungen befinden, bzw. die + Informationen über den Benutzer die über die + Administrator-Schnittstelle (admin.pl) eingegeben wurden. - - - Blöcke, bedingte Anweisungen und Schleifen + + $::locale - - Einfürhung + + + Objekt der Klasse "Locale" + - Der Parser kennt neben den Variablen einige weitere - Konstrukte, die gesondert behandelt werden. Diese sind wie - Variablennamen in spezieller Weise markiert: - <%anweisung%> ... <%end%> + + Wird pro Request erstellt + - 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. + + Muss auch für Tests und Scripte immer verfügbar + sein. + - 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"%>. + + Cached intern über Requestgrenzen hinweg benutzte + Locales + + + + Lokalisierung für den aktuellen User. Alle Übersetzungen, + Zahlen- und Datumsformatierungen laufen über dieses Objekt. - - Der if-Block + + $::lxdebug - <%if variablenname%> -... -<%end%> + + + Objekt der Klasse "LXDebug" + - 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. + + Wird global gecached + - Die Bedingung kann auch negiert werden, indem das Wort - not nach dem if verwendet - wird. Beispiel: + + Muss immer verfügbar sein, in nahezu allen + Funktionen + + - <%if not cp_greeting%> -... -<%end%> + $::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 (tmp/kivitendo-debug.log) + packen kann. - 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: + Beispielsweise so: - <%if var1 == "Wert"%> + $main::lxdebug->message(0, 'Meine Konfig:' . Dumper (%::myconfig)); +$main::lxdebug->message(0, 'Wer bin ich? Kunde oder Lieferant:' . $form->{vc}); + - Testet die Variable var1 auf - übereinstimmung mit der Zeichenkette Wert. - Mittels != anstelle von == - würde auf Ungleichheit getestet. + + $::auth - %if var1 == var2%> + + + Objekt der Klasse "SL::Auth" + - Testet die Variable var1 auf - übereinstimmung mit der Variablen var2. Mittel - != anstelle von == würde - auf Ungleichheit getestet. + + Wird global gecached + - 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. + + Hat eine permanente DB Verbindung zur Authdatenbank + - Beispiel für einen Test, ob die Variable - intnotes (interne Bemerkungen) das Wort - schwierig enthält: + + Wird nach jedem Request resettet. + + - <%if intnotes =~ "schwierig"%> + $::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. - - 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. + + $::lx_office_conf - Die Syntax sieht normalerweise wie folgt aus: + + + Objekt der Klasse + "SL::LxOfficeConf" + - <%foreach number%> -Position: <%runningnumber%> -Anzahl: <%qty%> -Artikelnummer: <%number%> -Beschreibung: <%description%> -... -<%end%> + + Global gecached + - 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. - - + + Repräsentation der + config/kivitendo.conf[.default]-Dateien + + - - Markup-Code zur Textformatierung innerhalb von - Formularen + Globale Konfiguration. Configdateien werden zum Start gelesen + und danach nicht mehr angefasst. Es ist derzeit nicht geplant, dass + das Programm die Konfiguration ändern kann oder sollte. - 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. + Beispielsweise ist über den Konfigurationseintrag [debug] die + Debug- und Trace-Log-Datei wie folgt konfiguriert und + verfügbar: - Die unterstützen Formatierungen sind: + [debug] +file = /tmp/kivitendo-debug.log - - - <b>Text</b> + 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 + - Text wird in Fettdruck gesetzt. + Objekt der Klasse + "SL::InstanceConfiguration" - - - - <i>Text</i> - Text wird kursiv gesetzt. + wird pro Request neu erstellt - + - - <u>Text</u> + Funktioniert wie $::lx_office_conf, + speichert aber Daten die von der Instanz abhängig sind. Eine Instanz + ist hier eine Mandantendatenbank. Beispielsweise überprüft + $::instance_conf->get_inventory_system eq 'perpetual' + ob die berüchtigte Bestandsmethode zur Anwendung kommt. + + + + $::dispatcher + - Text wird unterstrichen. + Objekt der Klasse + "SL::Dispatcher" - - - <s>Text</s> + + wird pro Serverprozess erstellt. + - Text wird durchgestrichen. Diese Formatierung ist nicht - bei der Ausgabe als PDF über LaTeX verfügbar. + enthält Informationen über die technische Verbindung zum + Server - + - - <bullet> + Der dritte Punkt ist auch der einzige Grund warum das Objekt + global gespeichert wird. Wird vermutlich irgendwann in einem anderen + Objekt untergebracht. + + + + $::request + - Erzeugt einen ausgefüllten Kreis für Aufzählungen (siehe - unten). + Hashref (evtl später Objekt) - - - - Der Befehl <bullet> funktioniert - momentan auch nur in Latex-Vorlagen. - - - - Excel-Vorlagen + + Wird pro Request neu initialisiert. + - - Zusammenfassung + + Keine Unterstruktur garantiert. + + - Dieses Dokument beschreibt den Mechanismus, mit dem - Exceltemplates abgearbeitet werden, und die Einschränkungen, die damit - einhergehen. - + $::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. - - Bedienung + Vieles von dem, was im moment in $::form + liegt, sollte eigentlich hier liegen. Die groben + Differentialkriterien sind: - Der Excel Mechanismus muss in der Konfigurationsdatei aktiviert - werden. Die Konfigurationsoption heißt excel_templates = - 1 im Abschnitt [print_templates]. + + + Kommt es vom User, und soll unverändert wieder an den + User? Dann $::form, steht da eh schon + - 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. + + Sind es Daten aus der Datenbank, die nur bis zum Ende des + Requests gebraucht werden? Dann + $::request + - Der Sonderfall der Angebote aus der Kundenmaske ist ebenfalls - eine Angebotsvorlage und wird unter dem internen Namen der Angebote - sales_quotation.xls gespeichert. + + Muss ich von anderen Teilen des Programms lesend drauf + zugreifen? Dann $::request, aber Zugriff über + Wrappermethode + + + - - Variablensyntax + + Ehemalige globale Variablen - Einfache Syntax: - <<varname>> + Die folgenden Variablen waren einmal im Programm, und wurden + entfernt. - 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: + + $::cgi - <<<<<varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> + + + war nötig, weil cookie Methoden nicht als + Klassenfunktionen funktionieren + - Um die Limitierung der festen Breite zu reduzieren, können - weitere Variablen in einem Block interpoliert werden. Whitespace wird - dazwishen dann erhalten. Beispiel: + + Aufruf als Klasse erzeugt Dummyobjekt was im + Klassennamespace gehalten wird und über Requestgrenzen + leaked + - <<<<<varname1 varname2 varname3>>>>>>>>>>>>>>>>>>>>>>>>>> + + liegt jetzt unter + $::request->{cgi} + + + - 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. + + $::all_units - Es ist ausserdem möglich, Daten rechtsbündig darzustellen, wenn - der Block mit einem Leerzeichen anfängt. Beispiel: + + + 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. + - <<<<<< varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> + + Liegt jetzt unter + $::request->{cache}{all_units} + - Dies würde rechtsbündig triggern. Wenn bei rechtsbündiger - Ausrichtung Text abgeschnitten werden muss, wird er vom linken Ende - entfernt. - + + Wird nur in + AM->retrieve_all_units() gesetzt oder + gelesen. + + + - - Einschränkungen + + %::called_subs - 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. + + + wurde benutzt um callsub deep recursions + abzufangen. + - 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. + + Wurde entfernt, weil callsub nur einen Bruchteil der + möglichen Rekursioenen darstellt, und da nie welche + auftreten. + + + + komplette recursion protection wurde entfernt. + + + @@ -4706,7 +5298,7 @@ Beschreibung: <%description%> Allgemeines - Wenn Änderungen in der Konfiguration von Lx-Office gemacht + Wenn Änderungen in der Konfiguration von kivitendo gemacht werden, muss der Webserver neu gestartet werden. Bei der Entwicklung für FastCGI ist auf ein paar Fallstricke zu @@ -4725,13 +5317,13 @@ Beschreibung: <%description%> 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 + ausgeben, die dann vom Dispatcher angezeigt werden. Die kivitendo 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 + Warnungen in das kivitendo Log umgeleitet wurden), und exit wird die Ausführung beenden. Prinzipiell ist es kein Beinbruch, wenn sich der Prozess @@ -4764,7 +5356,7 @@ Beschreibung: <%description%> 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 + Rechnungsmaske in kivitendo 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. @@ -4790,208 +5382,231 @@ Beschreibung: <%description%> - 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. - + SQL-Upgradedateien - - 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. - - + + Einführung - - Format der Kontrollinformationen + 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 kivitendo 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. + + kivitendo 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. + - - Die Kontrollinformationen sollten sich am Anfang der jeweiligen Upgradedatei befinden. Jede Zeile, die Kontrollinformationen enthält, - hat dabei das folgende Format: - + + Format der Kontrollinformationen - - Für SQL-Upgradedateien: - + Die Kontrollinformationen sollten sich am Anfang der jeweiligen + Upgradedatei befinden. Jede Zeile, die Kontrollinformationen enthält, + hat dabei das folgende Format: - -- @key: value + Für SQL-Upgradedateien: - - Für Perl-Upgradedateien: - + -- @key: value - # @key: value + Für Perl-Upgradedateien: - - Leerzeichen vor "value" werden entfernt. - + # @key: value - - Die folgenden Schlüsselworte werden verarbeitet: - + Leerzeichen vor "value" werden + entfernt. - - - 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. - + Die folgenden Schlüsselworte werden verarbeitet: - - Normalerweise sollte die Kontrolldatei genau so heißen wie der "tag", nur mit der Endung ".sql" bzw. "pl". - + + + tag - - Ein Tag darf nur aus alphanumerischen Zeichen sowie den Zeichen _ - ( ) bestehen. Insbesondere sind Leerzeichen nicht erlaubt und - sollten stattdessen mit Unterstrichen ersetzt werden. - - - + + 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. - - - + + charset - - 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. - - - + + 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. + + - - 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. - + + description - - 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. - + + 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. + + - - Es ist nicht erlaubt, sich selbst referenzierende Abhängigkeiten zu definieren (z.B. "a" -> "b", - "b" -> "c" und "c" -> "a"). - - - + + depends - - 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. - + + Optional. Eine mit Leerzeichen getrennte Liste von "tags", + von denen dieses Upgradescript abhängt. kivitendo 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"). + + - - 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". - - - - - + + priority - - Hilfsscript dbupgrade2_tool.pl + + 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. kivitendo 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". + + - - 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. - + + ignore - - 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: - + + Optional. Falls der Wert auf 1 (true) steht, wird das + Skript bei der Anmeldung ignoriert und entsprechend nicht + ausgeführt. + + + + - - - Listenform: "./scripts/dbupgrade2_tool.pl --list" + + Hilfsscript dbupgrade2_tool.pl - - 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. - - + Um die Arbeit mit den Abhängigkeiten etwas zu erleichtern, + existiert ein Hilfsscript namens + "scripts/dbupgrade2_tool.pl". Es muss aus dem + kivitendo-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 kivitendo selber, sodass alle Fehlersituationen + von der Kommandozeile überprüft werden können. - - Baumform: "./scripts/dbupgrade2_tool.pl --tree" + 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: - - 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. - - + + + Listenform: "./scripts/dbupgrade2_tool.pl + --list" - - Umgekehrte Baumform: "./scripts/dbupgrade2_tool.pl --rtree" + Gibt eine Liste aller Scripte aus. Die Liste ist in der + Reihenfolge sortiert, in der kivitendo die Scripte ausführen + würde. Es werden neben der Listenposition der Tag, die + Abhängigkeitstiefe und die Priorität ausgegeben. + - - 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: "./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. + - - Baumform mit Postscriptausgabe: "./scripts/dbupgrade2_tool.pl --graphviz" + + Umgekehrte Baumform: "./scripts/dbupgrade2_tool.pl + --rtree" - - 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. - - + 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. + - - - Scripte, von denen kein anderes Script abhängt: "./scripts/dbupgrade2_tool.pl --nodeps" - + + 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. + - - Listet die Tags aller Scripte auf, von denen keine anderen Scripte abhängen. - - - - + + 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. + + + @@ -5006,7 +5621,7 @@ Beschreibung: <%description%> internationalen Übersetzern die Arbeit zu erleichtern. - This section describes how localization packages in Lx-Office + This section describes how localization packages in kivitendo 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. @@ -5019,9 +5634,9 @@ Beschreibung: <%description%> xreflabel="File structure"> File structure - The structure of locales in Lx-Office is: + The structure of locales in kivitendo is: - lx-office/locale/<langcode>/ + kivitendo/locale/<langcode>/ where <langcode> stands for an abbreviation of the language package. The builtin packages use two letter special_chars - Lx-Office comes with a lot of interfaces to different + kivitendo 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 @@ -5202,37 +5817,178 @@ filenames + + + + Die kivitendo-Test-Suite + + + Einführung + + kivitendo enthält eine Suite für automatisierte Tests. Sie basiert auf dem Standard-Perl-Modul Test::More. + + Die grundlegenden Fakten sind: + + + Alle Tests liegen im Unterverzeichnis t/. + + Ein Script (bzw. ein Test) in f/ enthält einen oder mehrere Testfälle. + + Alle Dateinamen von Tests enden auf .t. Es sind selbstständig ausführbare Perl-Scripte. + + Die Test-Suite besteht aus der Gesamtheit aller Tests, sprich aller Scripte in f/, deren + Dateiname auf .t endet. + + + + + Voraussetzungen + + Für die Ausführung werden neben den für kivitendo eh schon benötigten Module noch weitere Perl-Module benötigt. Diese sind: + + + Test::Deep (Debian-Paketname: libtest-deep-perl; Fedora Core: + perl-Test-Deep; openSUSE: perl-Test-Deep) + Test::Harness 3.0.0 oder höher. Dieses Modul ist ab Perl 5.10.1 Bestandteil der + Perl-Distribution und kann für frühere Versionen aus dem CPAN bezogen + werden. + + + + + + Existierende Tests ausführen + + + Es gibt mehrere Möglichkeiten zum Ausführen der Tests: entweder, man lässt alle Tests auf einmal ausführen, oder man führt + gezielt einzelne Scripte aus. Für beide Fälle gibt es das Helferscript t/test.sh. + + Will man die komplette Test-Suite ausführen, so muss man einfach nur t/test.sh ohne weitere Parameter aus + dem kivitendo-Basisverzeichnis heraus ausführen. + + Um einzelne Test-Scripte auszuführen, übergibt man deren Namen an t/test.sh. Beispielsweise: + + t/test.sh t/form/format_amount.t t/background_job/known_jobs.t + + + + + + Bedeutung der verschiedenen Test-Scripte + + + Die Test-Suite umfasst Tests sowohl für Funktionen als auch für Programmierstil. Einige besonders zu erwähnende, weil auch + während der Entwicklung nützliche Tests sind: + + + t/001compile.t -- compiliert alle Quelldateien und bricht bei Fehlern sofort ab + t/002goodperl.t -- überprüft alle Perl-Dateien auf Anwesenheit von 'use strict'-Anweisungen + t/003safesys.t -- überprüft Aufrufe von system() und exec() auf Gültigkeit + t/005no_tabs.t -- überprüft, ob Dateien Tab-Zeichen enthalten + t/006spelling.t -- sucht nach häufigen Rechtschreibfehlern + t/011pod.t -- überprüft die Syntax von Dokumentation im POD-Format auf Gültigkeit + + + Weitere Test-Scripte überprüfen primär die Funktionsweise einzelner Funktionen und Module. + + + + + Neue Test-Scripte erstellen + + + Es wird sehr gern gesehen, wenn neue Funktionalität auch gleich mit einem Test-Script abgesichert wird. Auch bestehende + Funktion darf und soll ausdrücklich nachträglich mit Test-Scripten abgesichert werden. + + + + Ideen für neue Test-Scripte, die keine konkreten Funktionen testen + + + Ideen, die abgesehen von Funktions noch nicht umgesetzt wurden: + + + Überprüfung auf fehlende symbolische Links + Suche nach Nicht-ASCII-Zeichen in Perl-Code-Dateien (mit gewissen Einschränkungen wie das Erlauben von deutschen Umlauten) + Test auf DOS-Zeilenenden (\r\n anstelle von nur \n) + Überprüfung auf Leerzeichen am Ende von Zeilen + Test, ob alle zu übersetzenden Strings in locale/de/all vorhanden sind + Test, ob alle Webseiten-Templates in templates/webpages mit vom Perl-Modul Template compiliert werden können + + + + + + Konvention für Verzeichnis- und Dateinamen + + + Es gibt momentan eine wenige Richtlinien, wie Test-Scripte zu benennen sind. Bitte die folgenden Punkte als Richtlinie betrachten und ihnen soweit es geht folgen: + + + Die Dateiendung muss .t lauten. + + Namen sind englisch, komplett klein geschrieben und einzelne Wörter mit Unterstrichten getrennt (beispielsweise + bad_function_params.t). + + Unterverzeichnisse sollten grob nach dem Themenbereich benannt sind, mit dem sich die Scripte darin befassen + (beispielsweise background_jobs für Tests rund um Hintergrund-Jobs). + + Test-Scripte sollten einen überschaubaren Bereich von Funktionalität testen, der logisch zusammenhängend ist + (z.B. nur Tests für eine einzelne Funktion in einem Modul). Lieber mehrere Test-Scripte schreiben. + + + + + + Minimales Skelett für eigene Scripte + + + Der folgenden Programmcode enthält das kleinstmögliche Testscript und kann als Ausgangspunkt für eigene Tests verwendet werden: + + use Test::More tests => 0; + +use lib 't'; + +use Support::TestSetup; + +Support::TestSetup::login(); + + Wird eine vollständig initialisierte kivitendo-Umgebung benötigt (Stichwort: alle globalen Variablen wie + $::auth, $::form oder $::lxdebug), so muss in der Konfigurationsdatei + config/kivitendo.conf im Abschnitt testing.login ein gültiger Login-Name eingetragen + sein. Dieser wird für die Datenbankverbindung benötigt. + + Wir keine vollständig initialisierte Umgebung benötigt, so kann die letzte Zeile Support::TestSetup::login(); + weggelassen werden, was die Ausführungszeit des Scripts leicht verringert. + + + - - Stil-Richtlinien + + 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"). - + 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! - + 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. - + 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. - + Es werden keine echten Tabs sondern Leerzeichen + verwendet. - - Die Einrückung beträgt zwei Leerzeichen. Beispiel: - + Die Einrückung beträgt zwei Leerzeichen. Beispiel: - foreach my $row (@data) { + foreach my $row (@data) { if ($flag) { # do something with $row } @@ -5249,33 +6005,34 @@ filenames - Öffnende geschweifte Klammern befinden sich auf der gleichen Zeile wie der letzte Befehl. Beispiele: + Öffnende geschweifte Klammern befinden sich auf der gleichen + Zeile wie der letzte Befehl. Beispiele: - sub debug { + sub debug { ... } - oder + oder - if ($form->{item_rows} > 0) { + 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. - + 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: - + Die Wörter "else", + "elsif", "while" befinden + sich auf der gleichen Zeile wie schließende geschweifte Klammern. + Beispiele: - if ($form->{sum} > 1000) { + if ($form->{sum} > 1000) { ... } elsif ($form->{sum} > 0) { ... @@ -5289,86 +6046,80 @@ do { - - Parameter von Funktionsaufrufen müssen mit runden Klammern versehen werden. Davon nicht betroffen sind interne Perl-Funktionen, - und grep-ähnliche Operatoren. Beispiel: - + 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."); + $main::lxdebug->message("Could not find file."); %options = map { $_ => 1 } grep { !/^#/ } @config_file; - - Verschiedene Klammern, Ihre Ausdrücke und Leerzeichen: - + 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: - + 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)) { + if (($form->{debug} == 1) && ($form->{sum} - 100 < 0)) { ... } $array[$i + 1] = 4; -$form->{sum} += $form->{"row_$i"}; +$form->{sum} += $form->{"row_$i"}; $form->{ $form->{index} } += 1; -map { $form->{sum} += $form->{"row_$_"} } 1..$rowcount; +map { $form->{sum} += $form->{"row_$_"} } 1..$rowcount; - - Mehrzeilige Befehle - + 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: - + + + 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}); - + $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: - + + Ein Spezialfall ist der ternäre Oprator "?:", der am + besten in einer übersichtlichen Tabellenstruktur organisiert + wird. Beispiel: - my $rowcount = $form->{"row_$i"} ? $i + my $rowcount = $form->{"row_$i"} ? $i : $form->{oldcount} ? $form->{oldcount} + 1 : $form->{rowcount} - $form->{rowbase}; - - + + - - Kommentare - + Kommentare - - - Kommentare, die alleine in einer Zeile stehen, sollten soweit wie der Code eingerückt sein. - + + + Kommentare, die alleine in einer Zeile stehen, sollten + soweit wie der Code eingerückt sein. + - - Seitliche hängende Kommentare sollten einheitlich formatiert werden. - + + 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: - + + 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 kivitendo + Quelltext für nicht-Deutschsprachige lesbar sein. + Beispiel: - my $found = 0; + my $found = 0; while (1) { last if $found; @@ -5376,94 +6127,181 @@ while (1) { $found = 1 if // } -$i = 0 # initialize $i -$n = $i; # save $i +$i = 0 # initialize $i +$n = $i; # save $i $i *= $const; # do something crazy -$i = $n; # recover $i - - +$i = $n; # recover $i + + - - Hashkeys sollten nur in Anführungszeichen stehen, wenn die Interpolation gewünscht ist. Beispiel: - + Hashkeys sollten nur in Anführungszeichen stehen, wenn die + Interpolation gewünscht ist. Beispiel: - $form->{sum} = 0; -$form->{"row_$i"} = $form->{"row_$i"} - 5; + $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. - + Die maximale Zeilenlänge ist nicht beschrä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. - + 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 + 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. - + STDERR ist tabu. Unkonditionale + Debugmeldungen auch. + + kivitendo 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. - + 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. - + $form, $auth, + $locale, $lxdebug und + %myconfig werden derzeit aus dem main package + importiert (siehe . Alle anderen + Konstrukte sollten lexikalisch lokal gehalten werden. - + + + + + Dokumentation erstellen + + + Einführung + + Diese Dokumentation ist in DocBook + XML geschrieben. Zum Bearbeiten reicht grundsätzlich ein Text-Editor. + Mehr Komfort bekommt man, wenn man einen dedizierten XML-fähigen + Editor nutzt, der spezielle Unterstützung für + DocBook mitbringt. Wir empfehlen dafür den + XMLmind XML + Editor, der bei nicht kommerzieller Nutzung kostenlos + ist. + + + + Benötigte Software + + Bei DocBook ist Prinzip, dass + ausschließlich die XML-Quelldatei bearbeitet wird. Aus dieser werden + dann mit entsprechenden Stylesheets andere Formate wie PDF oder HTML + erzeugt. Bei kivitendo übernimmt diese Aufgabe das Shell-Script + scripts/build_doc.sh. + + Das Script benötigt zur Konvertierung verschiedene + Softwarekomponenten, die im normalen kivitendo-Betrieb nicht benötigt + werden: + + + + Java + in einer halbwegs aktuellen Version + + + + Das Java-Build-System Apache Ant + + + + Das Dokumentations-System Dobudish für + DocBook 4.5, eine Zusammenstellung + diverser Stylesheets und Grafiken zur Konvertierung von + DocBook XML in andere Formate. Das + Paket, das benötigt wird, ist zum Zeitpunkt der + Dokumentationserstellung + dobudish-nojre-1.1.4.zip, aus auf code.google.com + bereitsteht. + + + + Apache Ant sowie ein dazu passendes Java Runtime Environment + sind auf allen gängigen Plattformen verfügbar. Beispiel für + Debian/Ubuntu: + + apt-get install ant openjdk-7-jre + + Nach dem Download von Dobudish muss Dobudish im Unterverzeichnis + doc/build entpackt werden. Beispiel unter der + Annahme, das Dobudish in + $HOME/Downloads heruntergeladen wurde: + + cd doc/build +unzip $HOME/Downloads/dobudish-nojre-1.1.4.zip + + + + PDFs und HTML-Seiten erstellen + + Die eigentliche Konvertierung erfolgt nach Installation der + benötigten Software mit einem einfachen Aufruf direkt aus dem + kivitendo-Installationsverzeichnis heraus: + + ./scripts/build_doc.sh + + + + Einchecken in das Git-Repository + + Sowohl die XML-Datei als auch die erzeugten PDF- und + HTML-Dateien sind Bestandteil des Git-Repositories. Daraus folgt, dass + nach Änderungen am XML die PDF- und HTML-Dokumente ebenfalls gebaut + und alles zusammen in einem Commit eingecheckt werden sollten. + + Die "dobudish"-Verzeichnisse bzw. + symbolischen Links gehören hingegen nicht in das Repository.