X-Git-Url: http://wagnertech.de/git?a=blobdiff_plain;f=doc%2Fdokumentation.xml;h=0ca34e5a7be2fc09183b602dd224d896ae18a366;hb=7beb6d704f6112989396b3a6f7c110033fecff3d;hp=92686bd3cdb403dc726cf9631ca533af9b6f06cb;hpb=c4184d5483ff4ae6c38e36976b7f323cbc27086a;p=kivitendo-erp.git diff --git a/doc/dokumentation.xml b/doc/dokumentation.xml index 92686bd3c..0ca34e5a7 100644 --- a/doc/dokumentation.xml +++ b/doc/dokumentation.xml @@ -1,8 +1,8 @@ - - Lx-Office: Installation, Konfiguration, Entwicklung + + kivitendo 3.4.1: Installation, Konfiguration, Entwicklung Aktuelle Hinweise @@ -11,18 +11,24 @@ - auf der Lx-Office-Homepage unter http://lx-office.org/index.php?id=dokumentation + im Community-Forum: https://forum.kivitendo.de:32443 - im Lx-Office-Wiki unter Dokumentation (http://wiki.lx-office.org/index.php/Lx-Office_ERP) + im Kunden-Forum: http://redmine.kivitendo-premium.de/projects/forum/boards/ - im Lx-Office-Forum: http://www.lx-office.org/forum/ + in der doc/UPGRADE Datei im doc-Verzeichnis der + Installation + + + + Im Schulungs- und Dienstleistungsangebot der entsprechenden + kivitendo-Partner: http://www.kivitendo.de/partner.html @@ -30,166 +36,299 @@ 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 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 2012 sind das folgende Systeme, von denen bekannt ist, dass Lx-Office auf ihnen läuft: + Anfang 2016 sind das folgende Systeme, von denen bekannt ist, + dass kivitendo auf ihnen läuft: - Ubuntu 8.04 LTS Hardy Heron, 10.04 LTS Lucid Lynx bis 11.10 Oneiric Ocelot + Debian + + + + 7.0 "Wheezy" + + + + 8.0 "Jessie" + + + + + + Ubuntu 12.04 LTS "Precise Pangolin", 14.04 "Trusty Tahr" + LTS, 15.10 "Wily Werewolf" und 16.04 "Xenial Xerus" LTS + Alpha - Debian 5.0 Lenny und 6.0 Squeeze + openSUSE LEAP 42.1 - openSUSE 11.2 und 11.3 + Fedora 22 + + + + + Benötigte Perl-Pakete installieren + Zum Betrieb von kivitendo werden zwingend ein Webserver (meist + Apache) und ein Datenbankserver (PostgreSQL) in einer aktuellen Version + (s.a. Liste der unterstützten Betriebssysteme) benötigt. + + 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: + + ./scripts/installation_check.pl + + Die vollständige Liste der benötigten Perl-Module lautet: + + - SuSE Linux Enterprice Server 11 + parent (nur bei Perl vor 5.10.1) - Fedora 13 bis 15 + Archive::Zip - - 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. + + Algorithm::CheckDigits + - 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. + + CGI + - Zur Installation das Paket in das entpackte Lx-Office - Verzeichnis entpacken: + + Clone + - tar xzf lx-erp-perl-libs-compat-v2.tar.gz /path/to/lx-office/ + + Config::Std + - Zusätzlich müssen dann noch die folgenden Pakete installiert - weerden + + DateTime + - apt-get install libbit-vector-perl libsub-exporter-perl libclone-perl libclass-factory-util-perl + + DateTime::Format::Strptime + - Danach sollte der Installationscheck (siehe ) die enthaltenen Pakete erkennen. - + + DBI + - - Pakete + + DBD::Pg + - Zum Betrieb von Lx-Office werden zwingend ein Webserver (meist - Apache) und ein Datenbankserver (PostgreSQL, mindestens v8.2) - benötigt. + + Email::Address + - Zusätzlich benötigt Lx-Office die folgenden Perl-Pakete, die - nicht Bestandteil einer Standard-Perl-Installation sind: + + Email::MIME + + + + FCGI (nicht Versionen 0.68 bis 0.71 + inklusive; siehe ) + + + + File::Copy::Recursive + - - parent + GD - Archive::Zip + HTML::Parser - Config::Std + HTML::Restrict - DateTime + Image::Info - DBI + JSON + + + + List::MoreUtils + + + -> + List::UtilsBy - DBD::Pg + Net::SMTP::SSL (optional, bei + E-Mail-Versand über SSL; siehe Abschnitt "") - Email::Address + Net::SSLGlue (optional, bei + E-Mail-Versand über TLS; siehe Abschnitt "") - JSON + Params::Validate - List::MoreUtils + PBKDF2::Tiny - Params::Validate + PDF::API2 - PDF::API2 + Rose::Object + +-> + + Rose::DB - Rose::Object + Rose::DB::Object Version 0.788 oder + neuer - Rose::DB + String::ShellQuote - Rose::DB::Object + Sort::Naturally - Template + Template - Text::CSV_XS + Text::CSV_XS - Text::Iconv + Text::Iconv - URI + URI-> - XML::Writer + XML::Writer - YAML + YAML + Seit Version v3.4.0 sind die folgenden Pakete hinzugekommen: + Algorithm::CheckDigitsPBKDF2::Tiny + + Seit Version v3.2.0 sind die folgenden Pakete hinzugekommen: + GD, HTML::Restrict, + Image::Info + + Seit v3.0.0 sind die folgenden Pakete hinzugekommen: + File::Copy::Recursive. + + 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, @@ -202,50 +341,82 @@ 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. - - Für Debian oder Ubuntu benötigen Sie diese Pakete: + + Debian und Ubuntu + + Für Debian und Ubuntu stehen die meisten der benötigten + Perl-Pakete 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 \ + libimage-info-perl libgd-gd2-perl libapache2-mod-fcgid \ + libfile-copy-recursive-perl postgresql libalgorithm-checkdigits-perl \ + libcrypt-pbkdf2-perl git + + + Für das Paket HTML::Restrict gibt es kein Debian-Paket, dies + muß per CPAN installiert werden. Unter Ubuntu funktioniert das + mit: + + apt-get install build-essential +cpan HTML::Restrict + - apt-get install 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 + + Fedora - Für Fedora Core benötigen Sie diese Pakete: + Für Fedora stehen die meisten der benötigten Perl-Pakete als + RPM-Pakete zur Verfügung. Sie können mit folgendem Befehl + installiert werden: - yum install 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 \ + dnf install httpd mod_fcgid perl-Archive-Zip perl-Clone perl-DBD-Pg \ + perl-DBI perl-DateTime perl-Email-Address perl-Email-MIME perl-FCGI \ + perl-File-Copy-Recursive 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-XML-Writer perl-YAML perl-parent postgresql-server perl-CPAN \ + perl-Algorithm-CheckDigits perl-GD perl-Class-XSAccessor perl-Text-Balanced + + Zusätzlich müssen einige Pakete aus dem CPAN installiert + werden. Dazu können Sie die folgenden Befehle nutzen: - Für OpenSuSE benötigen Sie diese Pakete: + cpan Config::Std HTML::Restrict + + + + openSUSE - zypper install 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 + 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: - 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. + zypper install apache2 apache2-mod_fcgid perl-Archive-Zip perl-Clone \ + perl-Config-Std perl-DBD-Pg perl-DBI perl-DateTime perl-Email-Address \ + perl-Email-MIME perl-FastCGI perl-File-Copy-Recursive 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 perl-CPAN \ + perl-Algorithm-CheckDigits perl-GD perl-Class-XSAccessor postgresql-server - 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: + Zusätzlich müssen einige Pakete aus dem CPAN installiert + werden. Dazu können Sie die folgenden Befehle nutzen: - ./scripts/installation_check.pl + cpan Rose::Db::Object + @@ -253,152 +424,264 @@ xreflabel="Manuelle Installation des Programmpaketes"> Manuelle Installation des Programmpaketes - Die Lx-Office ERP Installationsdatei (lxoffice-erp-2.6.3.tgz) wird - im Dokumentenverzeichnis des Webservers (z.B. + Der aktuelle Stable-Release, bzw. beta Release wird bei github + gehostet und kann hier + heruntergeladen werden. + + Die kivitendo ERP Installationsdatei + (kivitendo-erp-3.4.1.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.4.1.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. + Bei einer Neuinstallation von Version 3.1.0 oder später muß das + WebDAV Verzeichnis derzeit manuell angelegt werden: + + mkdir webdav + 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 + 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 + apache oder bei OpenSUSE wwwrun). Der folgende Befehl ändert den Besitzer für die oben genannten Verzeichnisse auf einem Debian/Ubuntu-System: - chown -R www-data lx-office-erp/users lx-office-erp/spool lx-office-erp/webdav - - Weiterhin muss der Webserver-Benutzer im Verzeichnis - templates Verzeichnisse für jeden neuen Benutzer, - der in lx-office angelegt wird, anlegen dürfen: - - chgrp www-data lx-office-erp/templates -chmod g+w lx-office-erp/templates + chown -R www-data users spool webdav + + 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: + + chown www-data templates users + + + Wir empfehlen eine Installation mittels des Versionsmanagager + git. Hierfür muss ein git-Client installiert sein. Damit ist man sehr + viel flexibler für zukünftige Upgrades. Installations-Anleitung (bitte + die Pfade anpassen) bspw. wie folgt: cd /usr/local/src/ +git clone https://github.com/kivitendo/kivitendo-erp.git +cd kivitendo-erp/ +git checkout `git tag -l | egrep -ve "(beta|rc)" | tail -1` + Sehr sinnvoll ist es, direkt im Anschluss einen eigenen Branch zu + erzeugen, um bspw. seine eigenen Druckvorlagen-Anpassungen damit zu + verwalten. Hierfür reicht ein simples git checkout -b meine_eigenen_änderungen + nach dem letzten Kommando (weiterführende Informationen getting + started with git). + - Lx-Office-Konfigurationsdatei + kivitendo-Konfigurationsdatei + + + Einführung - - Einführung + 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. - - Seit Lx-Office 2.6.3. gibt es nur noch eine Konfigurationsdatei die benötigt wird: config/lx_office.conf (kurz: - "die Hauptkonfigurationsdatei"). Diese muss bei der Erstinstallation von Lx-Office bzw. der Migration von älteren Versionen angelegt - werden. - + Als Vorlage dient die Datei + config/kivitendo.conf.default (kurz: "die + Default-Datei"): - - Als Vorlage dient die Datei config/lx_office.conf.default (kurz: "die Default-Datei"): - + $ cp config/kivitendo.conf.default config/kivitendo.conf - $ cp config/lx_office.conf.default config/lx_office.conf + Die Default-Datei wird immer zuerst eingelesen. Werte, die in + der Hauptkonfigurationsdatei stehen, überschreiben die Werte aus der + Default-Datei. Die Hauptkonfigurationsdatei muss also nur die + Abschnitte 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 Abschintte und Werte - enthalten, die von denen der Default-Datei abweichen. - + + 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. + - - Diese Hauptkonfigurationsdatei ist dann eine installationsspezifische Datei, d.h. sie enthält bspw. lokale Passwörter und wird auch - nicht im Versionsmanagement (git) verwaltet. - + 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. - - + 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) + + + + authentication/database + + + + authentication/ldap + + + + system + + + + paths + + + + mail_delivery (siehe Abschnitt ") + - - Die üblicherweise wichtigsten Parameter, die am Anfang einzustellen oder zu kontrollieren sind, sind: - + + applications + + + + environment + + + + print_templates + + + + task_server + + + + periodic_invoices + + + + self_tests + + + + console + + + + testing + + + + testing/database + + + + debug + + - [authentication] + 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. - - - - - Versionen vor 2.6.3 - - - In älteren Lx-Office Versionen gab es im Verzeichnis config die Dateien authentication.pl - und lx-erp.conf, die jeweils Perl-Dateien waren. Es gab auch die Möglichkeit, eine lokale Version der - Konfigurationsdatei zu erstellen (lx-erp-local.conf). Dies ist ab 2.6.3 nicht mehr möglich, aber auch nicht mehr - nötig. - - - - Beim Update von einer Lx-Office-Version vor 2.6.3 auf 2.6.3 oder jünger müssen die Einstellungen aus den alten Konfigurationsdateien - manuell übertragen und die alten Konfigurationsdateien anschließend gelöscht oder verschoben werden. Ansonsten zeigt Lx-Office eine - entsprechende Fehlermeldung an. - - +default_manager = german + + Für kivitendo Installationen in der Schweiz sollte hier german + durch swiss ersetzt werden. + Die Einstellung default_manager = swiss bewirkt: + + + Beim Erstellen einer neuen Datenbank in der kivitendo Administration + werden automatisch die Standard-Werte für die Schweiz voreingestellt: + Währung CHF, 5er-Rundung, Schweizer KMU-Kontenplan, Sollversteuerung, + Aufwandsmethode, Bilanzierung (die Werte können aber manuell angepasst werden). + + + Einstellen der Standardkonten für Rundungserträge und -aufwendungen + (unter Mandantenkonfiguration → Standardkonten veränderbar) + + + das verwendete Zahlenformat wird auf 1'000.00 eingestellt + (unter Programm → Benutzereinstellungen veränderbar) + + + DATEV-Automatik und UStVA werden nicht angezeigt, Erfolgsrechnung + ersetzt GUV ( unter Mandantenkonfiguration → Features veränderbar) + + + + 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. + + kivitendo bringt eine eigene Komponente zur zeitgesteuerten + Ausführung bestimmter Aufgaben mit, den Taskserver. Er wird u.a. für + Features wie die wiederkehrenden Rechnungen + benötigt, erledigt aber auch andere erforderliche Aufgaben und muss + daher in Betrieb genommen werden. Seine Einrichtung wird im Abschnitt + Task-Server genauer + beschrieben. + + Für Entwickler finden sich unter [debug] + wichtige Funktionen, um die Fehlersuche zu erleichtern. + + + + 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. + @@ -407,29 +690,34 @@ dbcharset = UTF-8 PostgreSQL muss auf verschiedene Weisen angepasst werden. - Zeichensätze/die Verwendung von UTF-8 + Zeichensätze/die Verwendung von Unicode/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.2 oder neuer benutzt werden, und der - PostgreSQL-Datenbankcluster muss ebenfalls mit UTF-8 als Locale - angelegt worden sein. + kivitendo setzt zwingend voraus, dass die Datenbank + Unicode/UTF-8 als Encoding einsetzt. Bei aktuellen + Serverinstallationen braucht man hier meist nicht einzugreifen. - 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. für PostgreSQL 8.2 mit dem folgenden Befehl getan werden: + Das Encoding des Datenbankservers kann überprüft werden. Ist das + Encoding der Datenbank "template1" "Unicode" bzw. "UTF-8", so braucht + man nichts weiteres diesbezüglich unternehmen. Zum Testen: - pg_createcluster --locale=de_DE.UTF-8 --encoding=UTF-8 8.2 clustername + su postgres +echo '\l' | psql +exit - Die Datenbankversionsnummer muss an die tatsächlich verwendete Versionsnummer angepasst werden. + Andernfalls ist es notwendig, einen neuen Datenbankcluster mit + Unicode-Encoding anzulegen und diesen zu verwenden. Unter Debian und + Ubuntu kann dies z.B. für PostgreSQL 9.3 mit dem folgenden Befehl + getan werden: - Unter anderen Distributionen gibt es ähnliche Methoden. + pg_createcluster --locale=de_DE.UTF-8 --encoding=UTF-8 9.3 clustername + + Die Datenbankversionsnummer muss an die tatsächlich verwendete + Versionsnummer angepasst werden. - 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. + Unter anderen Distributionen gibt es ähnliche Methoden. - Das Encoding einer Datenbank kann in psql mit \l geprüft werden. + Das Encoding einer Datenbank kann in psql mit + \l geprüft werden. @@ -438,28 +726,23 @@ dbcharset = UTF-8 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 + /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 + 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: - - local all lxoffice password -host all lxoffice 127.0.0.1 255.255.255.255 password + Verzeichnis wie die postgresql.conf zu finden + sein sollte, müssen die Berechtigungen für den Zugriff geändert + werden. Hier gibt es mehrere Möglichkeiten. Sinnvoll ist es nur die + nötigen Verbindungen immer zuzulassen, für eine lokal laufende + Datenbank zum Beispiel: + + local all kivitendo password +host all kivitendo 127.0.0.1 255.255.255.255 password @@ -467,10 +750,23 @@ host all lxoffice 127.0.0.1 255.255.255.255 password 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: + Melden Sie sich dafür als Benutzer “postgres” an der Datenbank an: + su - postgres +psql template1 führen Sie die folgenden Kommandos aus: - create language 'plpgsql'; + CREATE EXTENSION IF NOT EXISTS plpgsql; +\q + + + CREATE EXTENSION ist seit Version 9.1 die + bevorzugte Syntax um die Sprache plpgsql + anzulegen. In diesen Versionen ist die Extension meist auch schon + vorhanden. Sollten Sie eine ältere Version von Postgres haben, + benutzen Sie stattdessen den folgenden Befehl. + + CREATE LANGUAGE 'plpgsql'; +\q + @@ -481,11 +777,17 @@ host all lxoffice 127.0.0.1 255.255.255.255 password 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. - den hier gewählten Benutzernamen. + Sie den evtl. voreingestellten Benutzer “postgres” auf “kivitendo” + bzw. den hier gewählten Benutzernamen. @@ -507,24 +809,29 @@ host all lxoffice 127.0.0.1 255.255.255.255 password anderen Datei hinzu, die beim Starten des Webservers eingelesen wird: - AddHandler cgi-script .pl -Alias /lx-erp/ /var/www/lx-erp/ + AliasMatch ^/kivitendo-erp/[^/]+\.pl /var/www/kivitendo-erp/dispatcher.pl +Alias /kivitendo-erp/ /var/www/kivitendo-erp/ -<Directory /var/www/lx-erp> - Options ExecCGI - Includes FollowSymlinks +<Directory /var/www/kivitendo-erp> + AddHandler cgi-script .pl + Options ExecCGI Includes FollowSymlinks </Directory> -<Directory /var/www/lx-erp/users> +<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. - Vor den einzelnen Optionen muss bei einigen Distributionen ein Plus ‘+’ gesetzt werden. + Vor den einzelnen Optionen muss bei einigen Distributionen ein + Plus ‘+’ gesetzt werden. + + Bei einigen Distribution (Ubuntu ab 14.04, Debian ab 8.2) muss + noch explizit das cgi-Modul mittels a2enmod cgi + aktiviert werden. Auf einigen Webservern werden manchmal die Grafiken und @@ -555,16 +862,16 @@ Alias /lx-erp/ /var/www/lx-erp/ 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. @@ -583,7 +890,11 @@ Alias /lx-erp/ /var/www/lx-erp/ - Apache 2.2.11 (Ubuntu) und mod_fastcgi. + Apache 2.2.11 / 2.2.22 (Ubuntu) und mod_fastcgi. + + + + Apache 2.4.7 (Ubuntu 14.04.2 LTS) und mod_fcgid. @@ -595,14 +906,14 @@ Alias /lx-erp/ /var/www/lx-erp/ 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 Ihrer + 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 @@ -611,8 +922,8 @@ Alias /lx-erp/ /var/www/lx-erp/ Konfiguration des Webservers - Bevor Sie versuchen, eine Lx-Office Installation unter FCGI - laufen zu lassen, empfliehlt es sich die Installation ersteinmal + Bevor Sie versuchen, eine kivitendo Installation unter FCGI + laufen zu lassen, empfiehlt es sich die Installation ersteinmal unter CGI aufzusetzen. FCGI macht es nicht einfach Fehler zu debuggen die beim ersten aufsetzen auftreten können. Sollte die Installation schon funktionieren, lesen Sie weiter. @@ -622,53 +933,65 @@ Alias /lx-erp/ /var/www/lx-erp/ 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 - ("/url/for/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 ^/url/for/lx-office-erp/[^/]+\.pl /path/to/lx-office-erp/dispatcher.fcgi -Alias /url/for/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 + Require all granted </Directory> -<DirectoryMatch /path/to/lx-office-erp/users> - Order Deny,Allow - Deny from All +<DirectoryMatch /path/to/kivitendo-erp/users> +Require all granted </DirectoryMatch> - Seit mod_fcgid-Version 2.6.3 gelten sehr kleine Grenzen für + + Wer einen älteren Apache als Version 2.4 im Einsatz hat, + muss entsprechend die Syntax der Directorydirektiven verändert. + Statt + + Require all granted + + muß man Folgendes einstellen: + + + Order Allow,Deny + Allow from All + + + Seit mod_fcgid-Version 2.3.6 gelten sehr kleine Grenzen für die maximale Größe eines Requests. Diese sollte wie folgt hochgesetzt werden: FcgidMaxRequestLen 10485760 - Das ganze sollte dann so aussehen: + Das Ganze sollte dann so aussehen: AddHandler fcgid-script .fpl -AliasMatch ^/url/for/lx-office-erp/[^/]+\.pl /path/to/lx-office-erp/dispatcher.fpl -Alias /url/for/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> @@ -678,21 +1001,35 @@ 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 /url/for/lx-office-erp /path/to/lx-office-erp +Alias /url/for/kivitendo-erp /path/to/kivitendo-erp # Zugriff mit mod_fcgid: -AliasMatch ^/url/for/lx-office-erp-fcgid/[^/]+\.pl /path/to/lx-office-erp/dispatcher.fpl -Alias /url/for/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 /url/for/lx-office-erp/ die normale Version erreichbar, und unter - /url/for/lx-office-erp-fcgid/ die FastCGI-Version. + Dann ist unter /url/for/kivitendo-erp/ + die normale Version erreichbar, und unter + /url/for/kivitendo-erp-fcgid/ die + FastCGI-Version. + + + Weitergehende Konfiguration + + Für einen deutlichen Sicherheitsmehrwert sorgt die Ausführung + von kivitendo nur über https-verschlüsselten Verbindungen, sowie + weiteren Zusatzmassnahmen, wie beispielsweise Basic Authenticate. Die + Konfigurationsmöglichkeiten sprengen allerdings den Rahmen dieser + Anleitung, hier ein Hinweis auf einen entsprechenden Foreneintrag + (Stand Sept. 2015) + @@ -701,58 +1038,72 @@ Alias /url/for/lx-office-erp-fcgid/ /path/to/lx-office-erp/Der Task-Server ist ein Prozess, der im Hintergrund läuft, in regelmäßigen Abständen nach abzuarbeitenden Aufgaben sucht und diese zu festgelegten Zeitpunkten abarbeitet (ähnlich wie Cron). Dieser Prozess - wird bisher nur für die Erzeugung der wiederkehrenden Rechnungen - benutzt, wird aber in Zukunft deutlich mehr Aufgaben übertragen - bekommen. + wird u.a. für die Erzeugung der wiederkehrenden Rechnungen und weitere + essenzielle Aufgaben benutzt. + + Der Task-Server muss einmalig global in der Konfigurationsdatei + konfiguriert werden. Danach wird er für jeden Mandanten, für den er + laufen soll, in der Adminsitrationsmaske eingeschaltet. + + Beachten Sie, dass der Task-Server in den Boot-Vorgang Ihres + Servers integriert werden muss, damit er automatisch gestartet wird. + Dies kann kivitendo nicht für Sie erledigen. Verfügbare und notwendige Konfigurationsoptionen 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. - - - + + run_as - - 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. - - - + + 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 erforderlich, hier denselben Systembenutzer einzutragen, + unter dem auch der Webserver läuft. + + - - debug - - - Schaltet Debug-Informationen an und aus. - - - + + debug + + + Schaltet Debug-Informationen an und aus. + + + + Konfiguration der Mandanten für den Task-Server + + Ist der Task-Server grundlegend konfiguriert, so muss + anschließend jeder Mandant, für den der Task-Server laufen soll, + einmalig konfiguriert werden. Dazu kann in der Maske zum Bearbeiten + von Mandanten im Administrationsbereich eine kivitendo-Benutzerkennung + ausgewählt werden, unter der der Task-Server seine Arbeit + verrichtet. + + Ist in dieser Einstellung keine Benutzerkennung ausgewählt, so + wird der Task-Server für diesen Mandanten keine Aufgaben + ausführen. + + Automatisches Starten des Task-Servers beim Booten Der Task-Server verhält sich von seinen Optionen her wie ein reguläres SystemV-kompatibles Boot-Script. Außerdem wechselt er beim - Starten automatisch in das Lx-Office-Installationsverzeichnis. + 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 @@ -761,12 +1112,12 @@ Alias /url/for/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) 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-task-server + nach /etc/init.d/kivitendo-task-server. Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile DAEMON=....). Binden Sie das Script in den Boot-Prozess ein. Dies ist distributionsabhängig: @@ -775,33 +1126,57 @@ Alias /url/for/lx-office-erp-fcgid/ /path/to/lx-office-erp/ Debian-basierende Systeme: - update-rc.d lx-office-task-server defaults + update-rc.d kivitendo-task-server defaults # Nur bei Debian Squeeze und neuer: -insserv lx-office-task-server +insserv kivitendo-task-server - OpenSuSE und Fedora Core: + Ältere OpenSUSE und ältere Fedora: - 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 + Danach kann der Task-Server mit dem folgenden Befehl gestartet + werden: + + /etc/init.d/kivitendo-task-server start - Upstart-basierende Systeme (z.B. Ubuntu) + Upstart-basierende Systeme (z.B. Ubuntu bis 14.04) 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 + Danach kann der Task-Server mit dem folgenden Befehl gestartet + werden: + + service kivitendo-task-server start + + + + systemd-basierende Systeme (z.B. neure openSUSE, neuere + Fedora, neuere Ubuntu und Debians) + + Kopieren 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 (Zeilen + ExecStart=.... und ExecStop=...). + + Machen Sie anschließend das Script systemd bekannt, und binden Sie es in den Boot-Prozess ein. Dazu führen Sie die folgenden + Befehl aus: + + systemctl daemon-reload +systemctl enable kivitendo-task-server.service + + Wenn Sie den Task-Server jetzt sofort starten möchten, anstatt den Server neu zu starten, so können Sie das mit dem + folgenden Befehl tun: + + systemctl start kivitendo-task-server.service @@ -839,7 +1214,7 @@ insserv lx-office-task-server 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). @@ -855,166 +1230,206 @@ insserv lx-office-task-server 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. Administratorpasswort - Das Passwort, das zum Zugriff auf das Aministrationsinterface benutzt wird, wird ebenfalls in dieser Datei gespeichert. Es - kann auch nur dort und nicht mehr im Administrationsinterface selber geändert werden. Der Parameter dazu heißt - admin_password im Abschnitt [authentication]. + Das Passwort, das zum Zugriff auf das Administrationsinterface + von kivitendo 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 admin_password im Abschnitt + [authentication]. Authentifizierungsdatenbank - Die Verbindung zur Authentifizierungsdatenbank wird mit den Parametern in [authentication/database] - konfiguriert. Hier sind die folgenden Parameter anzugeben: + Die Verbindung zur Authentifizierungsdatenbank wird mit den + 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 - Die Datenbank muss noch nicht existieren. Lx-Office kann sie - automatisch anlegen (mehr dazu siehe unten). - + + Der Name der Authentifizierungsdatenbank + + - - Passwortüberprüfung + + user - Lx-Office unterstützt Passwortüberprüfung auf zwei Arten: gegen die Authentifizierungsdatenbank und gegen einen externen LDAP- - oder Active-Directory-Server. Welche davon benutzt wird, regelt der Parameter module im Abschnitt - [authentication]. + + Der Benutzername, mit dem sich kivitendo beim + Datenbankserver anmeldet (z.B. + "postgres") + + - Sollen die Benutzerpasswörter in der Authentifizierungsdatenbank 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 Lx-Office ändern. + + password + + + Das Passwort für den Datenbankbenutzer + + + + + Die Datenbank muss noch nicht existieren. kivitendo kann sie + automatisch anlegen (mehr dazu siehe unten). + + + + Passwortüberprüfung - Soll hingegen ein externer LDAP- oder Active-Directory-Server 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 + 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 module im Abschnitt + [authentication]. + + Sollen die Benutzerpasswörter in der Authentifizierungsdatenbank + 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 Passwörter in + kivitendo ändern. + + Soll hingegen ein externer LDAP- oder Active-Directory-Server + 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 aufgesetzt werden, so müssen die Namen der Session-Cookies für alle - Installationen unterschiedlich sein. Der Name des Cookies wird mit dem Parameter cookie_name im Abschnitt + 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 cookie_name im Abschnitt [authentication]gesetzt. Diese Angabe ist optional, wenn nur eine Installation auf dem @@ -1025,64 +1440,91 @@ insserv lx-office-task-server 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/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login - Benutzer- und Gruppenverwaltung + Mandanten-, Benutzer- und Gruppenverwaltung - Nach der Installation müssen Benutzer, Gruppen und Datenbanken - angelegt werden. Dieses geschieht im Administrationsmenü, das Sie unter - folgender URL finden: + Nach der Installation müssen Mandanten, Benutzer, Gruppen und + Datenbanken angelegt werden. Dieses geschieht im Administrationsmenü, + das Sie unter folgender URL finden: http://localhost/lx-erp/admin.pl + url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login - Verwenden Sie zur Anmeldung das Password, dass Sie in der Datei - config/lx_office.conf eingetragen haben. + Verwenden Sie zur Anmeldung das Passwort, das Sie in der Datei + config/kivitendo.conf eingetragen haben. Zusammenhänge - Lx-Office verwendet eine Datenbank zum Speichern all seiner - Informationen wie Kundendaten, Artikel, Angebote, Rechnungen etc. Um - mit Lx-Office arbeiten zu können, muss eine Person einen - Benutzeraccount haben. Jedem Benutzeraccount wiederum wird genau eine - Datenbank zugewiesen, mit der dieser Benutzer arbeiten kann. Es ist - möglich und normal, dass mehreren Benutzern die selbe Datenbank - zugewiesen wird, sodass sie alle mit den selben Daten arbeiten - können. - - Die Basisdaten der Benutzer, die in der Administration - eingegeben werden können, werden in einer zweiten Datenbank - gespeichert, der bereits erwähnten Authentifizierungsdatenbank. Diese - ist also den Produktivdaten enthaltenden Datenbanken vorgeschaltet. - Pro Lx-Office-Installation gibt es nur eine - Authentifizierungsdatenbank, aber beliebig viele Datenbanken mit - Firmendaten. - - Lx-Office kann seinen Benutzern Zugriff auf bestimmte - Funktionsbereiche erlauben oder verbieten. Wird der Zugriff nicht - gestattet, so werden der entsprechenden Menüpunkte auch nicht - angezeigt. Diese Rechte werden ebenfalls in der - Authentifizierungsdatenbank gespeichert. - - Um Rechte verteilen zu können, verwendet Lx-Office ein - Gruppen-Prinzip. Einer Gruppe kann der Zugriff auf bestimmte Bereiche - erlaubt werden. Ein Benutzer wiederum kann Mitglied in einer oder - mehrerer Gruppen sein. Der Benutzer hat Zugriff auf alle diejenigen - Funktionen, die mindestens einer Gruppe erlaubt sind, in der der - Benutzer Mitglied ist. - - Die allgemeine Reihenfolge, in der Datenbanken, Gruppen und - Benutzer angelegt werden sollten, lautet: + kivitendo verwaltet zwei Sets von Daten, die je nach Einrichtung + in einer oder zwei Datenbanken gespeichert werden. + + Das erste Set besteht aus Anmeldeinformationen: welche Benutzer + und Mandanten gibt es, welche Gruppen, welche BenutzerIn hat Zugriff + auf welche Mandanten, und welche Gruppe verfügt über welche Rechte. + Diese Informationen werden in der Authentifizierungsdatenbank + gespeichert. Dies ist diejenige Datenbank, deren Verbindungsparameter + in der Konfigurationsdatei config/kivitendo.conf + gespeichert werden. + + Das zweite Set besteht aus den eigentlichen Verkehrsdaten eines + Mandanten, wie beispielsweise die Stammdaten (Kunden, Lieferanten, + Waren) und Belege (Angebote, Lieferscheine, Rechnungen). Diese werden + in einer Mandantendatenbank gespeichert. Die Verbindungsinformationen + einer solchen Mandantendatenbank werden im Administrationsbereich + konfiguriert, indem man einen Mandanten anlegt und dort die Parameter + einträgt. Dabei hat jeder Mandant eine eigene Datenbank. + + Aufgrund des Datenbankdesigns ist es für einfache Fälle möglich, + die Authentifizierungsdatenbank und eine der Mandantendatenbanken in + ein und derselben Datenbank zu speichern. Arbeitet man hingegen mit + mehr als einem Mandanten, wird empfohlen, für die + Authentifizierungsdatenbank eine eigene Datenbank zu verwenden, die + nicht gleichzeitig für einen Mandanten verwendet wird. + + + + Mandanten, Benutzer und Gruppen + + kivitendos Administration kennt Mandanten, Benutzer und Gruppen, + die sich frei zueinander zuordnen lassen. + + kivitendo kann mehrere Mandaten aus einer Installation heraus + verwalten. Welcher Mandant benutzt wird, kann direkt beim Login + ausgewählt werden. Für jeden Mandanten wird ein eindeutiger Name + vergeben, der beim Login angezeigt wird. Weiterhin benötigt der + Mandant Datenbankverbindungsparameter für seine Mandantendatenbank. + Diese sollte über die Datenbankverwaltung + geschehen. + + Ein Benutzer ist eine Person, die Zugriff auf kivitendo erhalten + soll. Sie erhält einen Loginnamen sowie ein Passwort. Weiterhin legt + der Administrator fest, an welchen Mandanten sich ein Benutzer + anmelden kann, was beim Login verifiziert wird. + + Gruppen dienen dazu, Benutzern innerhalb eines Mandanten Zugriff + auf bestimmte Funktionen zu geben. Einer Gruppe werden dafür vom + Administrator gewisse Rechte zugeordnet. Weiterhin legt der + Administrator fest, für welche Mandanten eine Gruppe gilt, und welche + Benutzer Mitglieder in dieser Gruppe sind. Meldet sich ein Benutzer + dann an einem Mandanten an, so erhält er alle Rechte von allen + denjenigen Gruppen, die zum Einen dem Mandanten zugeordnet sind und in + denen der Benutzer zum Anderen Mitglied ist, + + Die Reihenfolge, in der Datenbanken, Mandanten, Gruppen und + Benutzer angelegt werden, kann im Prinzip beliebig gewählt werden. Die + folgende Reihenfolge beinhaltet die wenigsten Arbeitsschritte: @@ -1094,11 +1536,11 @@ insserv lx-office-task-server - Benutzer anlegen + Benutzer anlegen und Gruppen als Mitglied zuordnen - Benutzer den Gruppen zuordnen + Mandanten anlegen und Gruppen sowie Benutzer zuweisen @@ -1108,22 +1550,7 @@ insserv lx-office-task-server Zuerst muss eine Datenbank angelegt werden. Verwenden Sie für den Datenbankzugriff den vorhin angelegten Benutzer (in unseren - Beispielen ist dies ‘lxoffice’). - - Wenn Sie für die Lx-Office-Installation nicht den europäischen - Schriftsatz ISO-8859-15 sondern UTF-8 (Unicode) benutzen wollen, so - müssen Sie vor dem Anlegen der Datenbank in der Datei - config/lx_office.conf die Variable - dbcharset im Abschnitt system - auf den Wert ‘UTF-8’ setzen. Zusätzlich muss beim - Anlegen der Datenbank ‘UTF-8 Unicode’ als - Schriftsatz ausgewählt werden. - - Bitte beachten Sie, dass alle Datenbanken den selben Zeichensatz - verwenden müssen, da diese Einstellungen momentan global in Lx-Office - vorgenommen wird und nicht nach Datenbank unterschieden werden kann. - Auch die Authentifizierungsdatenbank muss mit diesem Zeichensatz - angelegt worden sein. + Beispielen ist dies ‘kivitendo’). @@ -1134,9 +1561,19 @@ insserv lx-office-task-server Anlegen können Sie die verschiedenen Bereiche wählen, auf die Mitglieder dieser Gruppe Zugriff haben sollen. - Benutzergruppen sind unabhängig von Datenbanken, da sie in der - Authentifizierungsdatenbank gespeichert werden. Sie gelten für alle - Datenbanken, die in dieser Installation verwaltet werden. + Benutzergruppen werden zwar in der Authentifizierungsdatenbank + gespeichert, gelten aber nicht automatisch für alle Mandanten. Der + Administrator legt vielmehr fest, für welche Mandanten eine Gruppe + gültig ist. Dies kann entweder beim Bearbeiten der Gruppe geschehen + ("diese Gruppe ist gültig für Mandanten X, Y und Z"), oder aber wenn + man einen Mandanten bearbeitet ("für diesen Mandanten sind die Gruppen + A, B und C gültig"). + + Wurden bereits Benutzer angelegt, so können hier die Mitglieder + dieser Gruppe festgelegt werden ("in dieser Gruppe sind die Benutzer + X, Y und Z Mitglieder"). Dies kann auch nachträglich beim Bearbeiten + eines Benutzers geschehen ("dieser Benutzer ist Mitglied in den + Gruppen A, B und C"). @@ -1146,471 +1583,1898 @@ insserv lx-office-task-server Standardeinstellungen vorgenommen, die den Gepflogenheiten des deutschen Raumes entsprechen. - Zwingend anzugeben sind der Loginname sowie die komplette - Datenbankkonfiguration. Wenn die Passwortauthentifizierung über die - Datenbank eingestellt ist, so kann hier auch das Benutzerpasswort - gesetzt bzw. geändert werden. Ist hingegen die LDAP-Authentifizierung - aktiv, so ist das Passwort-Feld deaktiviert. + Zwingend anzugeben ist der Loginname. Wenn die + Passwortauthentifizierung über die Datenbank eingestellt ist, so kann + hier auch das Benutzerpasswort gesetzt bzw. geändert werden. Ist + hingegen die LDAP-Authentifizierung aktiv, so ist das Passwort-Feld + deaktiviert. + + Hat man bereits Mandanten und Gruppen angelegt, so kann hier + auch konfiguriert werden, auf welche Mandanten der Benutzer Zugriff + hat bzw. in welchen Gruppen er Mitglied ist. Beide Zuweisungen können + sowohl beim Benutzer vorgenommen werden ("dieser Benutzer hat Zugriff + auf Mandanten X, Y, Z" bzw. "dieser Benutzer ist Mitglied in Gruppen + X, Y und Z") als auch beim Mandanten ("auf diesen Mandanten haben + Benutzer A, B und C Zugriff") bzw. bei der Gruppe ("in dieser Gruppe + sind Benutzer A, B und C Mitglieder"). + - In der Datenbankkonfiguration müssen die Zugriffsdaten einer der - eben angelegten Datenbanken eingetragen werden. + + Mandanten anlegen + + Ein Mandant besteht aus Administrationssicht primär aus einem + eindeutigen Namen. Weiterhin wird hier hinterlegt, welche Datenbank + als Mandantendatenbank benutzt wird. Hier müssen die Zugriffsdaten + einer der eben angelegten Datenbanken eingetragen werden. + + Hat man bereits Benutzer und Gruppen angelegt, so kann hier auch + konfiguriert werden, welche Benutzer Zugriff auf den Mandanten haben + bzw. welche Gruppen für den Mandanten gültig sind. Beide Zuweisungen + können sowohl beim Mandanten vorgenommen werden ("auf diesen Mandanten + haben Benutzer X, Y und Z Zugriff" bzw. "für diesen Mandanten sind die + Gruppen X, Y und Z gültig") als auch beim Benutzer ("dieser Benutzer + hat Zugriff auf Mandanten A, B und C") bzw. bei der Gruppe ("diese + Gruppe ist für Mandanten A, B und C gültig"). + - - Gruppenmitgliedschaften verwalten + + Drucker- und Systemverwaltung + + Im Administrationsmenü gibt es ferner noch die beiden Menüpunkte + Druckeradministration und System. + + + Druckeradministration + + Unter dem Menüpunkt Druckeradministration lassen sich beliebig + viele "Druckbefehle" im System verwalten. Diese Befehle werden + mandantenweise zugeordnet. Unter Druckerbeschreibung wird der Namen + des Druckbefehls festgelegt, der dann in der Druckerauswahl des Belegs + angezeigt wird. + + Unter Druckbefehl definiert man den eigentlichen Druckbefehl, + der direkt auf dem Webserver ausgeführt wird, bspw. 'lpr -P + meinDrucker' oder ein kompletter Pfad zu einem Skript + (/usr/local/src/kivitendo/scripts/pdf_druck_in_verzeichnis.sh). Wird + ferner noch ein optionales Vorlagenkürzel verwendet, wird dieses + Kürzel bei der Auswahl der Druckvorlagendatei mit einem Unterstrich + ergänzt, ist bspw. das Kürzel 'epson_drucker' definiert, so wird beim + Ausdruck eines Angebots folgende Vorlage geparst: + sales_quotation_epson_drucker.tex. + - Nach dem Anlegen von Benutzern und Gruppen müssen Benutzer den - Gruppen zugewiesen werden. Dazu gibt es zwei Möglichkeiten: + + System sperren / entsperren - - - In der Gruppenverwaltung wählt man eine Gruppe aus. Im - folgenden Dialog kann man dann einzeln die Benutzer der Gruppe - hinzufügen. - + Unter dem Menüpunkt System gibt es den Eintrag 'Installation + sperren/entsperren'. Setzt man diese Sperre so ist der Zugang zu der + gesamten kivitendo Installation gesperrt. - - In der Gruppenverwaltung wählt man das Tool zur Verwaltung - der Gruppenmitgliedschaft. Hier wird eine Matrix angezeigt, die - alle im System angelegten Gruppen und Benutzer enthält. Durch - Setzen der Häkchen wird der Benutzer in der ausgewählten Zeile der - Gruppe in der ausgewählten Spalte hinzugefügt. - - + Falls die Sperre gesetzt ist, erscheint anstelle der + Anmeldemaske die Information: 'kivitendo ist momentan zwecks + Wartungsarbeiten nicht zugänglich.'. + + Wichtig zu erwähnen ist hierbei noch, dass sich kivitendo + automatisch 'sperrt', falls es bei einem Versionsupdate zu einem + Datenbankfehler kam. Somit kann hier nicht aus Versehen mit einem + inkonsistenten Datenbestand weitergearbeitet werden. + + + + E-Mail-Versand aus kivitendo heraus + + 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). + + 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]'. + + + Versand über lokalen E-Mail-Server + + 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. + + Um diese Methode auszuwählen, muss der Konfigurationsparameter + 'method = sendmail' gesetzt sein. Dies ist + gleichzeitig der Standardwert, falls er nicht verändert wird. + + 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. + + 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 - - Migration alter Installationen - - Wenn Lx-Office 2.6.2 über eine ältere Version installiert wird, - in der die Benutzerdaten noch im Dateisystem im Verzeichnis - users verwaltet wurden, so bietet Lx-Office die - Möglichkeit, diese Benutzerdaten automatisch in die - Authentifizierungsdatenbank zu übernehmen. Dies geschieht, wenn man - sich nach dem Update der Installation das erste Mal im - Administrationsbereich anmeldet. Findet Lx-Office die Datei - users/members, so wird der Migrationsprozess - gestartet. - - Der Migrationsprozess ist nahezu vollautomatisch. Alle - Benutzerdaten können übernommen werden. Nach den Benutzerdaten bietet - Lx-Office noch die Möglichkeit an, dass automatisch eine - Benutzergruppe angelegt wird. Dieser Gruppe wird Zugriff auf alle - Funktionen von Lx-Office gewährt. Alle migrierten Benutzern werden - Mitglied in dieser Gruppe. Damit wird das Verhalten von Lx-Office bis - Version 2.4.3 inklusive wiederhergestellt, und die Benutzer können - sich sofort wieder anmelden und mit dem System arbeiten. + + 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. + + + - - Drucken mit Lx-Office + + Drucken mit kivitendo - Das Drucksystem von Lx-Office benutzt von Haus aus LaTeX Vorlagen. + 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 sind das die Pakete: + debianoiden Betriebssystemen installiert man die Pakete mit: + + apt-get install texlive-base-bin texlive-latex-recommended texlive-fonts-recommended \ + exlive-latex-extra texlive-lang-german texlive-generic-extra - texlive-latex-base texlive-latex-extra - texlive-fonts-recommended + Für Fedora benötigen Sie die folgenden Pakete: - Diese hinteren beiden enthalten Bibliotheken und Schriftarten die - von den Standardvorlagen verwendet werden. + dnf install texlive-collection-latex texlive-collection-latexextra \ + texlive-collection-latexrecommended texlive-collection-langgerman \ + texlive-collection-langenglish - TODO: rpm Pakete. + Für openSUSE benötigen Sie die folgenden Pakete: - In den allermeisten Installationen sollte drucken jetzt schon - funktionieren. Sollte ein Fehler auftreten wirft TeX sehr lange - Fehlerbeschreibungen, der eigentliche Fehler ist immer die erste Zeite - die mit einem Ausrufezeichen anfängt. Häufig auftretende Fehler sind zum - Beispiel: + zypper install texlive-collection-latex texlive-collection-latexextra \ + texlive-collection-latexrecommended texlive-collection-langgerman \ + texlive-collection-langenglish + + kivitendo bringt drei alternative Vorlagensätze mit: - ! 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. + RB + + + + f-tex - ! 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. + rev-odt - 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. - + Der ehemalige Druckvorlagensatz "Standard" wurde mit der Version + 3.3 entfernt, da er nicht mehr gepflegt wurde. - - OpenDocument-Vorlagen + + Vorlagenverzeichnis anlegen - Lx-Office unterstützt die Verwendung von Vorlagen im - OpenDocument-Format, wie es OpenOffice.org ab Version 2 erzeugt. - Lx-Office kann dabei sowohl neue OpenDocument-Dokumente als auch aus - diesen direkt PDF-Dateien erzeugen. Um die Unterstützung von - OpenDocument-Vorlagen zu aktivieren muss in der Datei - config/lx_office.conf die Variable - opendocument im Abschnitt - print_templates auf ‘1’ stehen. - Dieses ist die Standardeinstellung. + Es lässt sich ein initialer Vorlagensatz erstellen. Die + LaTeX-System-Abhängigkeiten hierfür kann man prüfen mit: - Weiterhin muss in der Datei - config/lx_office.conf die Variable - dbcharset im Abschnitt system auf - die Zeichenkodierung gesetzt werden, die auch bei der Speicherung der - Daten in der Datenbank verwendet wird. Diese ist in den meisten Fällen - "UTF-8". + ./scripts/installation_check.pl -lv - Während die Erzeugung von reinen OpenDocument-Dateien keinerlei - weitere Software benötigt, wird zur Umwandlung dieser Dateien in PDF - OpenOffice.org benötigt. Soll dieses Feature genutzt werden, so muss - neben OpenOffice.org ab Version 2 auch der “X virtual frame buffer” - (xvfb) installiert werden. Bei Debian ist er im Paket “xvfb” enthalten. - Andere Distributionen enthalten ihn in anderen Paketen. + Der Angemeldete Benutzer muss in einer Gruppe sein, die über das + Recht "Konfiguration -> Mandantenverwaltung" verfügt. Siehe auch + . - Nach der Installation müssen in der Datei - config/lx_config.conf zwei weitere Variablen - angepasst werden: openofficeorg_writer muss den - vollständigen Pfad zur OpenOffice.org Writer-Anwendung enthalten. - xvfb muss den Pfad zum “X virtual frame buffer” - enthalten. Beide stehen im Abschnitt - applications. - - Zusätzlich gibt es zwei verschiedene Arten, wie Lx-Office mit - OpenOffice kommuniziert. Die erste Variante, die benutzt wird, wenn die - Variable $openofficeorg_daemon gesetzt ist, startet - ein OpenOffice, das auch nach der Umwandlung des Dokumentes gestartet - bleibt. Bei weiteren Umwandlungen wird dann diese laufende Instanz - benutzt. Der Vorteil ist, dass die Zeit zur Umwandlung deutlich - reduziert wird, weil nicht für jedes Dokument ein OpenOffice gestartet - werden muss. Der Nachteil ist, dass diese Methode Python und die - Python-UNO-Bindings benötigt, die Bestandteil von OpenOffice 2 - sind. + Im Userbereich lässt sich unter: "System + -> Mandantenverwaltung -> + Verschiedenes" die Option "Neue + Druckvorlagen aus Vorlagensatz erstellen" auswählen. - Ist $openofficeorg_daemon nicht gesetzt, so - wird für jedes Dokument OpenOffice neu gestartet und die Konvertierung - mit Hilfe eines Makros durchgeführt. Dieses Makro muss in der - Dokumentenvorlage enthalten sein und - “Standard.Conversion.ConvertSelfToPDF()” heißen. Die Beispielvorlage - ‘templates/mastertemplates/German/invoice.odt’ - enthält ein solches Makro, das in jeder anderen Dokumentenvorlage - ebenfalls enthalten sein muss. + + + : Wählen Sie hier den + Vorlagensatz aus, der kopiert werden soll + (RB, f-tex oder + odt-rev.) + - Als letztes muss herausgefunden werden, welchen Namen - OpenOffice.org Writer dem Verzeichnis mit den Benutzereinstellungen - gibt. Unter Debian ist dies momentan - ~/.openoffice.org2. Sollte der Name bei Ihrer - OpenOffice.org-Installation anders sein, so muss das Verzeichnis - users/.openoffice.org2 entsprechend umbenannt werden. - Ist der Name z.B. einfach nur .openoffice, so wäre - folgender Befehl auszuführen: + + : Der Verzeichnisname für den + neuen Vorlagensatz. Dieser kann im Rahmen der üblichen Bedingungen + für Verzeichnisnamen frei gewählt werden. + + - mv users/.openoffice.org2 - users/.openoffice + Nach dem Speichern wird das Vorlagenverzeichnis angelegt und ist + für den aktuellen Mandanten ausgewählt. Der gleiche Vorlagensatz kann, + wenn er mal angelegt ist, bei mehreren Mandanten verwendet werden. + Eventuell müssen Anpassungen (Logo, Erscheinungsbild, etc) noch + vorgenommen werden. Den Ordner findet man im Dateisystem unter + ./templates/[Neuer Name] + - 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. - + + Der Druckvorlagensatz RB - - Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung: EUR + Hierbei handelt es sich um einen vollständigen LaTeX + Dokumentensatz mit alternativem Design. Die odt oder html-Varianten + sind nicht gepflegt. + + Die konzeptionelle Idee der Vorlagen wird hier + auf Folie 5 bis 10 vorgestellt. Informationen zur Anpassung an die + eigenen Firmendaten finden sich in der Datei Readme.tex im + Vorlagenverzeichnis. + + Eine kurze Übersicht der Features: + + + + Mehrsprachenfähig, mit Deutscher und Englischer + Übersetzung + + + + Zentrale Konfigurationsdateien, die für alle Belege benutzt + werden, z.B. für Kopf- und Fußzeilen, und Infos wie + Bankdaten + + + + mehrere vordefinierte Varianten für + Logos/Hintergrundbilder + + + + Berücksichtigung für Steuerzonen "EU mit USt-ID Nummer" oder + "Außerhalb EU" + + + + + + 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, Proformarechnung, Lieferschein, aber eben nicht für + Paketaufkleber etc. + + + + Leichte Anpassung an das Firmen-Layout durch Verwendung + eines Hintergrund-PDFs. 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 Hintergrund-PDF verwiesen. Ich empfehle + über dieses PDF die persönlichen Layoutanpassungen vorzunehmen und + sample.lco unverändert zu lassen. 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_head.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. + + 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 + heftig 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. + - - Einführung + + Bruttopreise für Endverbraucher - - 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. - + Der auszuweisende Bruttopreis wird innerhalb der + LaTeX-Umgebung berechnet. Es gibt zwar ein Feld, um bei Aufträgen + "alle Preise Brutto" auszuwählen, aber: - - 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. - + + + 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 als auch 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 Nettopreise 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 revidiert 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. + + + + + Der Druckvorlagensatz rev-odt + + Hierbei handelt es sich um einen Dokumentensatz der mit + odt-Vorlagen erstellt wurde. Es gibt in dem Verzeichnis eine + Readme-Datei, die eventuell aktueller als die Dokumentation hier ist. + Die odt-Vorlagen in diesem Verzeichnis "rev-odt" wurden von revamp-it, + Zürich erstellt und werden laufend aktualisiert. Ein paar der + Formulierungen in den Druckvorlagen entsprechen dem Schweizer + Sprachgebrauch, z.B. "Offerte" oder "allfällig". + + Hinweis zum Einsatz des Feldes "Land" bei den Stammdaten für + KundInnen und LieferantInnen, sowie bei Lieferadressen: Die in diesem + Vorlagensatz vorhandenen Vorlagen erwarten für "Land" das + entsprechende Kürzel, das in Adressen vor die Postleitzahl gesetzt + wird. Das Feld kann auch komplett leer bleiben. Wer dies anders + handhaben möchte, muss die Vorlagen entsprechend anpassen. + + odt-Vorlagen können mit LibreOffice oder OpenOffice editiert und + den eigenen Bedürfnissen angepasst werden. Wichtig beim Editieren von + if-Blöcken ist, dass immer der gesamte Block überschrieben werden muss + und nicht nur Teile davon, da dies sonst oft zu einer odt-Datei führt, + die vom Parser nicht korrekt gelesen werden kann. + + Zur Zeit gibt es in kivitendo noch keine Möglichkeit, + odt-Vorlagen bei Mahnungen, Briefen und Pflichtenheften einzusetzen. + Entsprechende Vorlagen sind deshalb nicht vorhanden. + + Fehlermeldungen, Anregungen und Wünsche bitte senden an: + empfang@revamp-it.ch - - Konfigurationsparameter - - - 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. - - - - - - 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/lx_office.conf wird nun nicht mehr benötigt und - kann entfernt werden. Dies muss manuell geschehen. - - + + Allgemeine Hinweise zu LaTeX Vorlagen + + In den allermeisten Installationen sollte das Drucken jetzt + schon funktionieren. Sollte ein Fehler auftreten, wirft TeX sehr lange + Fehlerbeschreibungen, der eigentliche Fehler ist immer die erste + Zeile, 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 gar kein 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_temp_files" auf 1 + + keep_temp_files = 1; + + + + bei fastcgi oder mod_perl den Webserver neu Starten + + + + Nochmal einen Druckversuch im Webfrontend auslösen + + + + wechsel in das users Verzeichnis von kivitendo + + cd [kivitendo-home]/users + + + + LaTeX Suchpfad anpassen: + + export TEXINPUTS=".:[kivitendo-home]/templates/[aktuelles_template_verzeichniss]:" + + + + Finde heraus, 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 + + kivitendo unterstützt die Verwendung von Vorlagen im + OpenDocument-Format, wie es LibreOffice oder OpenOffice (ab Version 2) erzeugen. + 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/kivitendo.conf die Variable + opendocument im Abschnitt + print_templates auf ‘1’ stehen. + Dieses ist die Standardeinstellung. + + Während die Erzeugung von reinen OpenDocument-Dateien keinerlei + weitere Software benötigt, wird zur Umwandlung dieser Dateien in PDF + LibreOffice oder OpenOffice benötigt. Soll dieses Feature genutzt werden, so muss + neben LibreOffice oder OpenOffice auch der “X virtual frame buffer” + (xvfb) installiert werden. Bei Debian ist er im Paket “xvfb” enthalten. + Andere Distributionen enthalten ihn in anderen Paketen. + + Nach der Installation müssen in der Datei + config/kivitendo.conf im Abschnitt + applications zwei weitere Variablen + angepasst werden: + openofficeorg_writer muss den + vollständigen Pfad zu LibreOffice oder OpenOffice enthalten. + Dabei dürfen keine Anführungszeichen eingesetzt werden. + Beispiel für Debian oder Ubuntu: + openofficeorg_writer = /usr/bin/libreoffice + xvfb muss den Pfad zum “X virtual frame buffer” + enthalten. + + Zusätzlich gibt es zwei verschiedene Arten, wie kivitendo mit + LibreOffice bzw. OpenOffice kommuniziert. Die erste Variante, die benutzt + wird, wenn die Variable $openofficeorg_daemon gesetzt + ist, startet ein LibreOffice oder OpenOffice, das auch nach der Umwandlung + des Dokumentes gestartet bleibt. Bei weiteren Umwandlungen wird dann diese + laufende Instanz benutzt. Der Vorteil ist, dass die Zeit zur Umwandlung + deutlich reduziert wird, weil nicht für jedes Dokument ein LibreOffice bzw. + OpenOffice gestartet werden muss. Der Nachteil ist, dass diese Methode + Python und die Python-UNO-Bindings benötigt, die Bestandteil von LibreOffice + bzw. OpenOffice sind. + + + Für die Verbindung zu LibreOffice bzw. OpenOffice wird + normalerweise der Python-Interpreter + /usr/bin/python benutzt. + Sollte dies nicht der richtige sein, so kann man mit zwei + Konfigurationsvariablen entscheiden, welcher Python-Interpreter + genutzt wird. Mit der Option python_uno aus dem + Abschnitt applications wird der Interpreter selber + festgelegt; sie steht standardmäßig auf dem eben erwähnten Wert + /usr/bin/python. + + Zusätzlich ist es möglich, Pfade anzugeben, in denen Python + neben seinen normalen Suchpfaden ebenfalls nach Modulen gesucht wird, + z.B. falls sich diese in einem gesonderten LibreOffice- bzw. + OpenOffice-Verzeichnis befinden. Diese zweite Variable heißt + python_uno_path und befindet sich im Abschnitt + environment. Sie ist standardmäßig leer. Werden + hier mehrere Pfade angegeben, so müssen diese durch Doppelpunkte + voneinander getrennt werden. Der Inhalt wird an den Python-Interpreter + über die Umgebungsvariable PYTHONPATH + übergeben. + + + Ist $openofficeorg_daemon nicht gesetzt, so + wird für jedes Dokument LibreOffice bzw. OpenOffice neu gestartet + und die Konvertierung mit Hilfe eines Makros durchgeführt. Dieses + Makro muss in der Dokumentenvorlage enthalten sein und + “Standard.Conversion.ConvertSelfToPDF()” heißen. Die Beispielvorlage + ‘templates/print/rev-odt/invoice.odt’ + enthält ein solches Makro, das in jeder anderen Dokumentenvorlage + ebenfalls enthalten sein muss. + + Als letztes muss herausgefunden werden, welchen Namen + OpenOffice bzw. LibreOffice dem Verzeichnis mit den Benutzereinstellungen + gibt. Unter Debian ist dies momentan + ~/.config/libreoffice. kivitendo verwendet das + Verzeichnis users/.openoffice.org2. + Eventuell muss dieses Verzeichnis umbenannt werden. + + 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. + + + OpenDocument (odt) Druckvorlagen mit Makros + + OpenDocument Vorlagen können Makros enthalten, welche komplexere + Aufgaben erfüllen. + + Der Vorlagensatz "rev-odt" enthält solche Vorlagen mit Schweizer Bank-Einzahlungsscheinen (BESR). + Diese Makros haben die Aufgabe, die in den Einzahlungsscheinen + benötigte Referenznummer und Kodierzeile zu erzeugen. Hier eine kurze + Beschreibung, wie die Makros aufgebaut sind, und was bei ihrer Nutzung + zu beachten ist (in fett sind nötige einmalige + Anpassungen aufgeführt): + + + Bezeichnung der Vorlagen + + Rechnung: invoice_besr.odt, Auftrag: + sales_order_besr.odt + + + + Vorbereitungen im Adminbereich + + Damit beim Erstellen von Rechnungen und Aufträgen neben der + Standardvorlage ohne Einzahlungsschein weitere Vorlagen (z.B. mit + Einzahlungsschein) auswählbar sind, muss für jedes Vorlagen-Suffix + ein Drucker eingerichtet werden: + + + + Druckeradministration → Drucker hinzufügen + + + + Mandant wählen + + + + Druckerbeschreibung → aussagekräftiger Text: wird in + der Auftrags- bzw. Rechnungsmaske als Auswahl angezeigt (z.B. + mit Einzahlungsschein Bank xy) + + + + Druckbefehl → beliebiger Text (hat für das Erzeugen + von Aufträgen oder Rechnungen als odt-Datei keine Bedeutung, + darf aber nicht leer sein) + + + + Vorlagenkürzel → besr bzw. selbst gewähltes + Vorlagensuffix (muss genau der Zeichenfolge entsprechen, die + zwischen "invoice_" bzw. "sales_order_" und ".odt" + steht.) + + + + speichern + + + + + + Benutzereinstellungen + + Wer den Ausdruck mit Einzahlungsschein als Standardeinstellung + im Rechnungs- bzw. Auftragsformular angezeigt haben möchte, kann + dies persönlich für sich bei den Benutzereinstellungen + konfigurieren: + + + + Programm → Benutzereinstellungen → + Druckoptionen + + + + Standardvorlagenformat → OpenDocument/OASIS + + + + Standardausgabekanal → Bildschirm + + + + Standarddrucker → gewünschte Druckerbeschreibung + auswählen (z.B. mit Einzahlungsschein Bank xy) + + + + Anzahl Kopien → leer + + + + speichern + + + + + + Aufbau und nötige Anpassungen der Vorlagen + + In der Vorlage sind als Modul "BESR" 4 Makros gespeichert, die + aus dem von kivitendo erzeugten odt-Dokument die korrekte + Referenznummer inklusive Prüfziffer sowie die Kodierzeile in + OCRB-Schrift erzeugen und am richtigen Ort ins Dokument + schreiben. + + + + Für den Einzahlungsschein ist die letzte Seite des + Dokuments reserviert + + + + Direkt über dem Einzahlungsschein enthält die Vorlage eine + Zeile mit folgenden Angaben (Bank-Konto-Identifikationsnummer und + Postkonto-Nummer der Bank müssen gemäss Angaben der jeweiligen + Bank angepasst werden): + + DDDREF: 4 Werte zum Bilden der Referenznummer + (jeweils durch einen Leerschlag getrennt): + + erster Wert: Bank-Konto-Identifikation + (nur Ziffern, maximal 6), muss + angepasst werden. + + + + zweiter Wert: <%customernumber%> + (Kundennummer: nur Ziffern, maximal 6) + + + + dritter Wert: <%ordnumber%> + (Auftragsnummer bei Auftragsvorlage + sales_oder_besr.odt, sonst 0) maximal 7 Ziffern, + führende Buchstaben werden vom Makro entfernt + + + + vierter Wert: <%invnumber%> + (Rechnungsnummer bei Rechnungsvorlage + invoice_besr.odt, sonst 0) maximal 7 Ziffern, + führende Buchstaben werden vom Makro entfernt + + + + + + DDDKONTO: Postkonto-Nummer der + Bank, muss angepasst werden. + + + + DDDBETRAG: <%total%> Einzahlungsbetrag oder 0, + falls Einzahlungsschein ohne Betrag + + + + DDDEND: muss am Ende der Zeile vorhanden sein + + + + + + Im Einzahlungsschein selbst müssen + der Name und die Adresse der Bank, die Postkonto-Nummer der + Bank, sowie der eigene Firmenname und die Firmenadresse + angepasst werden. Dabei ist darauf zu achten, dass + sich die Positionen der Postkonto-Nummern der Bank, sowie der + Zeichenfolgen dddfr, DDDREF1, DDDREF2, 609, DDDKODIERZEILE nicht + verschieben. + + + + + Rechnungsvorlage Schweizer Bank-Einzahlungsschein - zu + ändernde Einträge in rot + + + + + + + + + + + Auswahl der Druckvorlage in kivitendo beim Erzeugen einer + odt-Rechnung (analog bei Auftrag) + + Im Fussbereich der Rechnungsmaske muss neben Rechnung, + OpenDocument/OASIS und Bildschirm die im Adminbereich erstellte + Druckerbeschreibung ausgewählt werden, falls diese nicht bereits bei + den Benutzereinstellungen als persönlicher Standard gewählt + wurde. + + + + Makroeinstellungen in LibreOffice anpassen + + Falls beim Öffnen einer von kivitendo erzeugten odt-Rechnung + die Meldung kommt, dass Makros aus Sicherheitsgründen nicht + ausgeführt werden, so müssen folgende Einstellungen in LibreOffice + angepasst werden: + + + + Extras → Optionen → Sicherheit → + Makrosicherheit + + + + Sicherheitslevel auf "Mittel" einstellen (Diese + Einstellung muss auf jedem Computer durchgeführt werden, mit dem + von kivitendo erzeugte odt-Rechnungen oder Aufträge geöffnet + werden.) + + + + Beim Öffnen einer odt-Rechnung oder eines odt-Auftrags bei + der entsprechenden Nachfrage "Makros ausführen" auswählen. + + + Wichtig: die Makros sind + so eingestellt, dass sie beim Öffnen der Vorlagen selbst nicht + ausgeführt werden. Das heisst für das Ansehen und Bearbeiten der + Vorlagen sind keine speziellen Einstellungen in LibreOffice + nötig. + + + + + + + + Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung: + EUR + + + Einführung + + 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. + + + + Konfigurationsparameter + + 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. + + + + + 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. + + Für die Schweiz sind folgende Einstellungen üblich: + + + Sollversteuerung + + + Aufwandsmethode + + + Bilanzierung + + + Diese Einstellungen werden automatisch beim Erstellen einer neuen + Datenbank vorausgewählt, wenn in config/kivitendo.conf unter + [system] default_manager = swiss eingestellt ist. + + + 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 zur Bestandsmethode). + + + + Bemerkungen zur 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 + + 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. + + + + + SKR04 19% Umstellung für innergemeinschaftlichen Erwerb + + + Einführung + + 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. + + + + Konto 3804 manuell anlegen + + Die folgenden Schritte sind notwendig, um das Konto manuell + anzulegen und zu konfigurieren. Zuerst wird in + System → + Kontenübersicht → Konto + erfassen das Konto angelegt. + + + Konto 3804 erfassen + + + + + + + + + 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. + + + Steuerschlüssel 13 für 3803 (16%) anpassen + + + + + + + + + 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. + + + Steuerschlüssel 13 für 3804 (19%) anlegen + + + + + + + + + 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. + + + Konto 4315 anpassen + + + + + + + + + Als Letztes sollte die Steuerliste unter + System → Steuern → + Bearbeiten kontrolliert werden. Zum + Vergleich der Screenshot. + + + Steuerliste vergleichen + + + + + + + + + + + + Verhalten des Bilanzberichts + + Bis Version 3.0 wurde "closedto" ("Bücher schließen zum") als + Grundlage für das Startdatum benutzt. Schließt man die Bücher allerdings + monatsweise führt dies zu falschen Werten. + + In der Mandantenkonfiguration kann man dieses Verhalten genau + einstellen indem man: + + + + weiterhin closed_to benutzt (Default, es ändert sich nichts zu + vorher) + + + + immer den Jahresanfang nimmt (1.1. relativ zum + Stichtag) + + + + immer die letzte Eröffnungsbuchung als Startdatum nimmt + + - mit Jahresanfang als Alternative wenn es keine EB-Buchungen + gibt + + - oder mit "alle Buchungen" als Alternative" + + + + mit Jahresanfang als Alternative wenn es keine EB-Buchungen + gibt + + + + immer alle Buchungen seit Beginn der Datenbank nimmt + + + + Folgende Hinweise zu den Optionen: Das "Bücher schließen Datum" + ist sinnvoll, wenn man nur komplette Jahre schließt. Bei Wirtschaftsjahr + = Kalendarjahr entspricht dies aber auch dem Jahresanfang. "Alle + Buchungen" kann z.B. sinnvoll sein wenn man ohne Jahresabschluß + durchbucht. Eröffnungsbuchung mit "alle Buchungen" als Fallback ist z.B. + sinnvoll, wenn man am sich Anfang des zweiten Buchungsjahres befindet, + und noch keinen Jahreswechsel und auch noch keine EB-Buchungen hat. Bei + den Optionen mit EB-Buchungen wird vorausgesetzt, daß diese immer am 1. + Tag des Wirtschaftsjahres gebucht werden. Zur Sicherheit wird das + Startdatum im Bilanzbericht jetzt zusätzlich zum Stichtag mit angezeigt. + Das hilft auch bei der Kontrolle für den Abgleich mit der GuV bzw. + Erfolgsrechnung. + + + + Erfolgsrechnung + + Seit der Version 3.4.1 existiert in kivitendo der Bericht + Erfolgsrechnung. + + Die Erfolgsrechnung kann in der Mandantenkonfiguration unter Features + an- oder abgeschaltet werden. Mit der Einstellung default_manager = swiss + in der config/kivitendo.conf wird beim neu Erstellen + einer Datenbank automatisch die Anzeige der Erfolgsrechnung im Menü Berichte + ausgewählt und ersetzt dort die GUV. + + Im Gegensatz zur GUV werden bei der Erfolgsrechnung sämtliche Aufwands- und + Erlöskonten einzeln aufgelistet (analog zur Bilanz), sortiert nach ERTRAG und AUFWAND. + + Bei den Konteneinstellungen muss bei jedem Konto, das in der Erfolgsrechnung + erscheinen soll, unter Sonstige Einstellungen/Erfolgsrechnung + entweder 01.Ertrag oder 06.Aufwand ausgewählt + werden. + + Wird bei einem Erlöskonto 06.Aufwand ausgewählt, + so wird dieses Konto als Aufwandsminderung unter AUFWAND aufgelistet. + + Wird bei einem Aufwandskonto 01.Ertrag ausgewählt, + so wird dieses Konto als Ertragsminderung unter ERTRAG aufgelistet. + + Soll bei einer bereits bestehenden Buchhaltung in Zukunft zusätzlich + die Erfolgsrechnung als Bericht verwendet werden, so müssen die Einstellungen + zu allen Erlös- und Aufwandskonten unter Sonstige + Einstellungen/Erfolgsrechnung überprüft und allenfalls neu gesetzt werden. + + + + Rundung in Verkaufsbelegen + + In der Schweiz hat die kleinste aktuell benutzte Münze den Wert von 5 Rappen (0.05 CHF). + + Auch wenn im elektronischen Zahlungsverkehr Beträge mit einer Genauigkeit + von 0.01 CHF verwendet werden können, ist es trotzdem nach wie vor üblich, + Rechnungen mit auf 0.05 CHF gerundeten Beträgen auszustellen. + + In kivitendo kann seit der Version 3.4.1 die Einstellung für eine solche + Rundung pro Mandant / Datenbank festgelegt werden. + + Die Einstellung wird beim Erstellen der Datenbank bei Genauigkeit + festgelegt. Sie kann anschliessend über das Webinterface von kivitendo nicht mehr + verändert werden. + + Abhängig vom Wert für default_manager in + config/kivitendo.conf werden dabei folgende + Werte voreingestellt: + + + 0.05 (default_manager = swiss) + + + 0.01 (default_manager = german) + + + Der Wert wird in der Datenbank in der Tabelle defaults + in der Spalte precision gespeichert. + + In allen Verkaufsangeboten, Verkaufsaufträgen, Verkaufsrechnungen + und Verkaufsgutschriften wird der Endbetrag inkl. MWST gerundet, + wenn dieser nicht der eingestellten Genauigkeit entspricht. + + Beim Buchen einer Verkaufsrechnung wird der Rundungsbetrag + automatisch auf die in der Mandantenkonfiguration festgelegten + Standardkonten für Rundungserträge bzw. Rundungsaufwendungen gebucht. + + (Die berechnete MWST wird durch den Rundungsbetrag nicht mehr verändert.) + + Die in den Druckvorlagen zur Verfügung stehenden Variablen + quototal, ordtotal bzw. + invtotal enthalten den gerundeten Betrag. + + Achtung: Werden Verkaufsbelege + in anderen Währungen als der Standardwährung erstellt, so muss in + kivitendo 3.4.1 die Genauigkeit 0.01 verwendet werden. + Das heisst, Firmen in der Schweiz, die teilweise Verkaufsrechnungen + in Euro oder anderen Währungen erstellen wollen, müssen beim Erstellen + der Datenbank als Genauigkeit 0.01 wählen und können zur Zeit die + 5er Rundung noch nicht nutzen. + + + + 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. + + + + kivitendo ERP verwenden + + Nach erfolgreicher Installation ist der Loginbildschirm unter + folgender URL erreichbar: + + http://localhost/kivitendo-erp/login.pl + + Die Administrationsseite erreichen Sie unter: + + http://localhost/kivitendo-erp/controller.pl?action=Admin/login + + + + + Features und Funktionen + + + Wiederkehrende Rechnungen + + + Einführung + + 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. + + + + 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: + + + + Status + + + Bei aktiven Rechnungen wird automatisch eine Rechnung + erstellt, wenn die Periodizität erreicht ist (z.B. am 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. + + + + + 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. + + + + + Drucken + + + 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]. + + + + Spezielle Variablen + + Um die erzeugten Rechnungen individualisieren zu können, werden + beim Umwandeln des Auftrags in eine Rechnung einige speziell + formatierte Variablen durch für die jeweils aktuelle + Abrechnungsperiode gültigen Werte ersetzt. Damit ist es möglich, z.B. + den Abrechnungszeitraum explizit auszuweisen. Eine Variable hat dabei + die Syntax <%variablenname%>. + + Sofern es sich um eine Datumsvariable handelt, kann das + Ausgabeformat weiter bestimmt werden, indem an den Variablennamen + Formatoptionen angehängt werden. Die Syntax sieht dabei wie folgt aus: + <%variablenname FORMAT=Formatinformation%>. + Die zur verfügung stehenden Formatinformationen werden unten genauer + beschrieben. + + Diese Variablen können auch beim automatischen Versand der + erzeugten Rechnungen per E-Mail genutzt werden, indem sie in den + Feldern für den Betreff oder die Nachricht verwendet werden. + + Diese Variablen werden in den folgenden Elementen des Auftrags + ersetzt: + + + + Bemerkungen + + + + Interne Bemerkungen + + + + Vorgangsbezeichnung + + + + In den Beschreibungs- und Langtextfeldern aller + Positionen + + + + Die zur Verfügung stehenden Variablen sind die Folgenden: + + + + <%current_quarter%>, + <%previous_quarter%>, + <%next_quarter%> + + + Aktuelles, vorheriges und nächstes Quartal als Zahl + zwischen 1 und 4. + + + + + <%current_month%>, + <%previous_month%>, + <%next_month%> + + + Aktueller, vorheriger und nächster Monat als Zahl zwischen + 1 und 12. + + + + + <%current_month_long%>, + <%previous_month_long%>, + <%next_month_long%> + + + Aktueller, vorheriger und nächster Monat als Name + (Januar, Februar + etc.). + + + + + <%current_year%>, + <%previous_year%>, + <%next_year%> + + + Aktuelles, vorheriges und nächstes Jahr als vierstellige + Jahreszahl (2013 etc.). + + + + + <%period_start_date%>, + <%period_end_date%> + + + Formatiertes Datum des ersten und letzten Tages im + Abrechnungszeitraum (z.B. bei quartalsweiser Abrechnung und im + ersten Quartal von 2013 wären dies der + 01.01.2013 und + 31.03.2013). + + + + + Die invidiuellen Formatinformationen bestehen aus Paaren von + Prozentzeichen und einem Buchstaben, welche beide zusammen durch den + dazugehörigen Wert ersetzt werden. So wird z.B. %Y + durch das viertstellige Jahr ersetzt. Alle möglichen Platzhalter + sind: + + + + %a + + + Der abgekürzte Wochentagsname. + + + + + %A + + + Der ausgeschriebene Wochentagsname. + + + + + %b + + + Der abgekürzte Monatsname. + + + + + %B + + + Der ausgeschriebene Monatsname. + + + + + %C + + + Das Jahrhundert (Jahr/100) als eine zweistellige + Zahl. + + + + + %d + + + Der Monatstag als Zahl zwischen 01 und 31. + + + + + %D + + + Entspricht %m/%d/%y (amerikanisches Datumsformat). + + + + + %e + + + Wie %d (Monatstag als Zahl zwischen 1 und 31), allerdings + werden führende Nullen durch Leerzeichen ersetzt. + + + + + %F + + + Entspricht %Y-%m-%d (das ISO-8601-Datumsformat). + + + + + %j + + + Der Tag im Jahr als Zahl zwischen 001 und 366 + inklusive. + + + + + %m + + + Der Monat als Zahl zwischen 01 und 12 inklusive. + + + + + %u + + + Der Wochentag als Zahl zwischen 1 und 7 inklusive, wobei + die 1 dem Montag entspricht. + + - - 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. - - + + %U - - 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. - - + + Die Wochennummer als Zahl zwischen 00 und 53 inklusive, + wobei der erste Sonntag im Jahr das Startdatum von Woche 01 + ist. + + - - Bekannte Probleme + + %V - - 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. - + + Die ISO-8601:1988-Wochennummer als Zahl zwischen 01 und 53 + inklusive, wobei Woche 01 die erste Woche, von der mindestens + vier Tage im Jahr liegen; Montag ist erster Tag der + Woche. + + - - Es fehlen Hilfetext beim Neuanlegen eines Mandanten, was die Optionen bewirken, z.B. mit zwei Standardfällen. - - - + + %w - - Lx-Office ERP verwenden + + Der Wochentag als Zahl zwischen 0 und 6 inklusive, wobei + die 0 dem Sonntag entspricht. + + - Nach erfolgreicher Installation ist der Loginbildschirm unter - folgender URL erreichbar: + + %W - http://localhost/lx-office-erp/login.pl + + Die Wochennummer als Zahl zwischen 00 und 53 inklusive, + wobei der erste Montag im Jahr das Startdatum von Woche 01 + ist. + + - Die Administrationsseite erreichen Sie unter: + + %y - http://localhost/lx-office-erp/admin.pl - - + + Das Jahr als zweistellige Zahl zwischen 00 und 99 + inklusive. + + - - Features und Funktionen + + %Y - - Wiederkehrende Rechnungen + + Das Jahr als vierstellige Zahl. + + - - Einführung + + %% - - 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. - + + Das Prozentzeichen selber. + + + - + Anwendungsbeispiel für die Ausgabe, von welchem Monat und Jahr + bis zu welchem Monat und Jahr die aktuelle Abrechnungsperiode dauert: + Abrechnungszeitrum: <%period_start_date FORMAT=%m/%Y%> + bis <%period_end_date FORMAT=%m/%Y%> + - - Konfiguration + + Auflisten - - 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. - + 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. + - - Folgende Parameter kann man konfigurieren: - + + Erzeugung der eigentlichen Rechnungen - - - Status - - - 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. - - - + 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. + - - 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. - - - + + Erste Rechnung für aktuellen Monat erstellen - - Buchen auf - - - Das Forderungskonto, in der Regel "Forderungen aus Lieferungen und Leistungen". Das Gegenkonto ergibt sich aus den Buchungsgruppen - der betreffenden Waren. - - - + 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. + + - - Startdatum - - - ab welchem Datum auf Rechnungserstellung geprüft werden soll - - - + + Bankerweiterung - - Enddatum - - - ab wann keine Rechnungen mehr erstellt werden sollen - - - + + Einführung - - 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. - - - + Die Beschreibung der Bankerweiterung befindet sich derzeit noch + im Wiki und soll von dort später hierhin übernommen werden: - - Drucken - - - 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/lx_office.conf im Abschnitt [periodic_invoices]. - - - - - Auflisten - - - 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. - - - - - Erzeugung der eigentlichen Rechnungen - - - 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. - - - - - Erste Rechnung für aktuellen Monat erstellen - - - 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://redmine.kivitendo-premium.de/projects/forum/wiki/Bankerweiterung + @@ -1627,10 +3491,9 @@ insserv lx-office-task-server (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. + kivitendo unterstützt LaTeX-, HTML- und 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 @@ -1736,7 +3599,7 @@ insserv lx-office-task-server % config: tag-style=($ $) - Dies würde Lx-Office dazu veranlassen, Variablen zu ersetzen, + 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: @@ -1942,8 +3805,8 @@ insserv lx-office-task-server template_meta.language.template_code - Vorlagenürzel der verwendeten Sprache, identisch mit dem - Kürzel das im Dateinamen verwendetet wird. + Vorlagenkürzel der verwendeten Sprache, identisch mit + dem Kürzel das im Dateinamen verwendetet wird. @@ -1996,7 +3859,7 @@ insserv lx-office-task-server Ausgabemedium. Kann zur Zeit die Werte screen für Bildschirm, - email für E-Mmail (triggert das + email für E-Mail (triggert das _email Kürzel im Dateinamen), printer für Drucker, und queue für Warteschlange enthalten. @@ -2019,6 +3882,14 @@ insserv lx-office-task-server dem Kürzel das im Dateinamen verwendetet wird. + + + template_meta.tmpfile + + + Datei-Prefix für temporäre Dateien. + + @@ -2091,6 +3962,22 @@ insserv lx-office-task-server + + c_vendor_id + + + Lieferantennummer beim Kunden (nur Kunden) + + + + + v_customer_id + + + Kundennummer beim Lieferanten (nur Lieferanten) + + + cp_email @@ -2219,6 +4106,22 @@ insserv lx-office-task-server + + gln + + + GLN (Globale Lokationsnummer) + + + + + greeting + + + Anrede + + + homepage @@ -2304,7 +4207,7 @@ insserv lx-office-task-server - shiptodepartment1 + shiptodepartment_1 Abteilung 1 (Lieferadresse) - shiptodepartment2 + shiptodepartment_2 Abteilung 2 (Lieferadresse) + + shiptogln + + + GLN (Globale Lokationsnummer) (Lieferadresse) * + + + shiptoname @@ -2556,7 +4468,7 @@ insserv lx-office-task-server - Informationen über den Bearbeiter + Informationen über den Verkäufer @@ -2686,6 +4598,37 @@ insserv lx-office-task-server + + + Variablen für Lieferbedingungen + + + + delivery_term + + + Datenbank-Objekt der Lieferbedingung + + + + + delivery_term.description + + + Beschreibung der Lieferbedingung + + + + + delivery_term.description_long + + + Langtext bzw. übersetzter Langtext der + Lieferbedingung + + + + @@ -2840,6 +4783,15 @@ insserv lx-office-task-server + + rounding + + + Betrag, um den invtotal gerundet wurde + (kann positiv oder negativ sein) + + + shippingpoint @@ -2912,6 +4864,15 @@ insserv lx-office-task-server + + cusordnumber_oe + + + Bestellnummer des Kunden aus dem Auftrag, aus dem der + Posten ursprünglich stammt (nur Verkauf) + + + discount @@ -2928,6 +4889,16 @@ insserv lx-office-task-server + + donumber_do + + + Lieferscheinnummer des Lieferscheins, aus dem die + Position ursprünglich stammt, wenn die Rechnung im Rahmen des + Workflows aus einem Lieferschein erstellt wurde. + + + drawing @@ -2980,7 +4951,15 @@ insserv lx-office-task-server netprice - Nettopreis + Alternative zu sellprice, aber + netprice entspricht dem effektiven + Einzelpreis und beinhaltet Zeilenrabatt und Preisfaktor. + netprice wird rückgerechnet aus Zeilensumme + / Menge. Diese Variable ist nützlich, wenn man den gewährten + Rabatt in der Druckvorlage nicht anzeigen möchte, aber Menge * + Einzelpreis trotzdem die angezeigte Zeilensumme ergeben soll. + netprice hat nichts mit Netto/Brutto im + Sinne von Steuern zu tun. @@ -3012,8 +4991,12 @@ insserv lx-office-task-server ordnumber_oe - Auftragsnummer des Originalauftrags, wenn die Rechnung - aus einem Sammelauftrag erstellt wurde + Auftragsnummer des Originalauftrags, aus dem der Posten + ursprünglich stammt. Nützlich, wenn die Rechnung aus mehreren + Lieferscheinen zusammengefasst wurde, oder wenn zwischendurch + eine Sammelauftrag aus mehreren Aufträgen erstellt wurde. In + letzterem Fall wird die unsprüngliche Auftragsnummer + angezeigt. @@ -3123,12 +5106,32 @@ insserv lx-office-task-server + + transdate_do + + + Datum des Lieferscheins, wenn die Rechnung im Rahmen des + Workflows aus einem Lieferschein stammte. + + + transdate_oe - Auftragsdatum des Originalauftrags, wenn die Rechnung - aus einem Sammelauftrag erstellt wurde + Datum des Auftrags, wenn die Rechnung im Rahmen des + Workflows aus einem Auftrag erstellt wurde. Wenn es + Sammelaufträge gab wird das Datum des ursprünglichen Auftrags + genommen. + + + + + transdate_quo + + + Datum des Angebots, wenn die Position im Rahmen des + Workflows aus einem Angebot stammte. @@ -3234,6 +5237,10 @@ insserv lx-office-task-server Mitarbeiter des Unternehmens enthält. Diese Variable steht dann unter dem Namen vc_cvar_number_of_employees zur Verfügung. + + Die benutzerdefinierten Variablen der Lieferadressen stehen + unter einem ähnlichen Namensschema zur Verfügung. Hier lautet der + Präfix shiptocvar_. @@ -3295,7 +5302,7 @@ insserv lx-office-task-server fee - Kummulative Mahngebühren + Kumulative Mahngebühren @@ -3847,7 +5854,7 @@ insserv lx-office-task-server Blöcke, bedingte Anweisungen und Schleifen - Einfürhung + Einführung Der Parser kennt neben den Variablen einige weitere Konstrukte, die gesondert behandelt werden. Diese sind wie @@ -3878,6 +5885,21 @@ insserv lx-office-task-server 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: @@ -3903,7 +5925,7 @@ insserv lx-office-task-server Mittels != anstelle von == würde auf Ungleichheit getestet. - %if var1 == var2%> + <%if var1 == var2%> Testet die Variable var1 auf übereinstimmung mit der Variablen var2. Mittel @@ -3911,7 +5933,7 @@ insserv lx-office-task-server auf Ungleichheit getestet. Erfahrere Benutzer können neben der Tests auf (Un-)Gleichheit - auch Tests auf übereinstimmung mit regulären Ausdrücken ohne + 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. @@ -3963,9 +5985,9 @@ Beschreibung: <%description%> Markup-Code zur Textformatierung innerhalb von Formularen - Wenn der Benutzer innhalb von Formularen in Lx-Office Text + Wenn der Benutzer innhalb von Formularen in kivitendo Text anders formatiert haben möchte, so ist dies begrenzt möglich. - Lx-Office unterstützt die Textformatierung mit HTML-ähnlichen Tags. + 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 @@ -4103,6 +6125,90 @@ Beschreibung: <%description%> gewechselt. + + + + + Mandantenkonfiguration Lager + + Die Lagerverwaltung in kivitendo funktioniert standardmässig wie folgt: + Wird ein Lager mit einem Lagerplatz angelegt, so gibt es die Möglichkeit + hier über den Menüpunkt Lager entsprechende Warenbewegungen durchzuführen. + Ferner kann jede Position eines Lieferscheins ein-, bzw. ausgelagert werden + (Einkauf-, bzw. Verkauf). Es können beliebig viele Lager mit beliebig vielen + Lagerplätzen abgebildet werden. Die Lagerbewegungen über einen Lieferschein + erfolgt durch Anklicken jeder Einzelposition und das Auswählen dieser Position + zu einem Lager mit Lagerplatz. Dieses Verfahren lässt sich schrittweise + vereinfachen, je nachdem wie die Einstellungen in der Mandatenkonfiguration + gesetzt werden. + + + + Hier wird + ein zusätzlicher Knopf (Auslagern über Standard-Lagerplatz) in dem + Lieferschein-Beleg hinzugefügt, der dann alle Lagerbewegungen über + den Standardlagerplatz (konfigurierbar pro Ware) durchführt. + + + + Das obige + Auslagern schlägt fehl, wenn die entsprechende Menge für die + Lagerbewegung nicht vorhanden ist, möchte man dies auch ignorieren + und ggf. dann nachpflegen, so kann man eine Negativ-Warenmenge mit + dieser Option erlauben. Hierfür muss ein entsprechender Lagerplatz + (Fehlbestand, o.ä.) konfiguriert sein. + + + + Zusätzliche Funktionshinweise: + + + + Ist dieser konfiguriert, + wird dies auch als Standard-Voreinstellung bei der Neuerfassung von + Stammdaten → Waren / Dienstleistung / Erzeugnis verwendet. + + + + Wird beim 'Auslagern über + Standardlagerplatz' keine Standardlagerplatz zu der Ware gefunden, + so wird mit dieser Option einfach der Standardlagerplatz + verwendet. + + + + + + + + Schweizer Kontenpläne + + Seit der Version 3.4.1 stehen in kivitendo 2 Kontenpläne für + den Einsatz in der Schweiz zur Verfügung, einer für Firmen und + Organisationen, die nicht mehrwertsteuerpflichtig sind, und einer + für Firmen, die mehrwertsteuerpflichtig sind. + + Die Kontenpläne orientieren sich am in der Schweiz üblicherweise + verwendeten KMU-Kontenrahmen und sind mit der Revision des Schweizerischen + Obligationenrechts (OR) vom 1.1.2013 kompatibel, insbesondere + Art.957a Abs.2. + + Die Möglichkeit, Saldosteuersätze zu verwenden ist in der aktuellen + Version von kivitendo noch nicht integriert. + + Trotzdem können auch Firmen, die per Saldosteuersatz mit der + Eidgenössischen Steuerverwaltung abrechnen, kivitendo bereits nutzen. + Dazu wird der Kontenplan mit MWST ausgewählt. Anschliessend müssen + alle Aufwandskonten editiert werden und dort der Steuersatz auf 0% + gesetzt werden. + + So werden bei Kreditorenbuchungen keine Vorsteuern verbucht. + + Wünsche für Anpassungen an den Schweizer Kontenplänen sowie + Vorschläge für weitere (z.B. branchenspezifische) Kontenpläne + bitte an empfang@revamp-it.ch senden. + @@ -4207,17 +6313,19 @@ Beschreibung: <%description%> 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. + 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. Kanonische globale Variablen 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. + globale Variablen, die kanonisch sind, d.h. sie haben bestimmte + vorgegebenen Eigenschaften, und alles andere sollte anderweitig + umhergereicht werden. Diese Variablen sind im Moment die folgenden neun: @@ -4259,8 +6367,9 @@ Beschreibung: <%description%> - Damit diese nicht erneut als Müllhalde missbraucht werden, im Folgenden - eine kurze Erläuterung der bestimmten vorgegebenen Eigenschaften (Konventionen): + Damit diese nicht erneut als Müllhalde missbraucht werden, im + Folgenden eine kurze Erläuterung der bestimmten vorgegebenen + Eigenschaften (Konventionen): $::form @@ -4292,54 +6401,58 @@ Beschreibung: <%description%> $::form wurde unter SQL - Ledger als Gottobjekt für alles misbraucht. Sämtliche + Ledger als Gottobjekt für alles missbraucht. 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. + gewachsen sind), sollte man vor einem Aufruf (!) von zum Beispiel + IS->retrieve_customer() in Sicherheit + bringen. - - 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: - + 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: my $saved_numberformat = $::myconfig{numberformat}; $::myconfig{numberformat} = $numberformat; # (...) div Berechnungen $::myconfig{numberformat} = $saved_numberformat; - - 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. - - - - $::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: - + 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. + + $::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: [%- IF business %] # (... Zeig die Auswahlliste Kunden-/Lieferantentyp an) [%- END %] - - 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: - + 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: $form->parse_html_template("is/form_header", \%TMPL_VAR); - - 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: - + 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}) { # ... @@ -4387,12 +6500,14 @@ Beschreibung: <%description%> - - %::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. - + %::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 eingegeben wurden. @@ -4440,17 +6555,16 @@ Beschreibung: <%description%> - - $::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/lx-office-debug.log) packen kann. - + $::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. - - Beispielsweise so: - + Beispielsweise so: $main::lxdebug->message(0, 'Meine Konfig:' . Dumper (%::myconfig)); $main::lxdebug->message(0, 'Wer bin ich? Kunde oder Lieferant:' . $form->{vc}); @@ -4482,6 +6596,12 @@ $main::lxdebug->message(0, 'Wer bin ich? Kunde oder Lieferant:' . $form->{ vom aktuellen User abhängen wird das Objekt aus Geschwindigkeitsgründen nur einmal angelegt und dann nach jedem Request kurz resettet. + + Dieses Objekt kapselt auch den gerade aktiven Mandanten. + Dessen Einstellungen können über + $::auth->client abgefragt werden; Rückgabewert + ist ein Hash mit den Werten aus der Tabelle + auth.clients. @@ -4499,19 +6619,20 @@ $main::lxdebug->message(0, 'Wer bin ich? Kunde oder Lieferant:' . $form->{ Repräsentation der - config/lx_office.conf[.default]-Dateien + config/kivitendo.conf[.default]-Dateien 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. + und danach nicht mehr angefasst. Es ist derzeit nicht geplant, dass + das Programm die Konfiguration ändern kann oder sollte. - Beispielsweise ist über den Konfigurationseintrag [debug] - die Debug- und Trace-Log-Datei wie folgt konfiguriert und verfügbar: + Beispielsweise ist über den Konfigurationseintrag [debug] die + Debug- und Trace-Log-Datei wie folgt konfiguriert und + verfügbar: [debug] -file = /tmp/lx-office-debug.log +file_name = /tmp/kivitendo-debug.log ist der Key file im Programm als $::lx_office_conf->{debug}{file} @@ -4539,8 +6660,7 @@ file = /tmp/lx-office-debug.log Funktioniert wie $::lx_office_conf, speichert aber Daten die von der Instanz abhängig sind. Eine Instanz - ist hier eine Mandantendatenbank. - Beispielsweise überprüft + ist hier eine Mandantendatenbank. Beispielsweise überprüft $::instance_conf->get_inventory_system eq 'perpetual' ob die berüchtigte Bestandsmethode zur Anwendung kommt. @@ -4598,16 +6718,19 @@ file = /tmp/lx-office-debug.log - Kommt es vom User, und soll unverändert wieder an den User? Dann $::form, steht da eh schon + 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 + 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 + Muss ich von anderen Teilen des Programms lesend drauf + zugreifen? Dann $::request, aber Zugriff über Wrappermethode @@ -4695,7 +6818,7 @@ file = /tmp/lx-office-debug.log 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 @@ -4714,13 +6837,13 @@ file = /tmp/lx-office-debug.log 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 @@ -4753,7 +6876,7 @@ file = /tmp/lx-office-debug.log 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. @@ -4761,234 +6884,284 @@ file = /tmp/lx-office-debug.log Mit FastCGI ist die neuste Version auf 0,26 Sekunden selbst in den kritischen Pfaden, unter 0,15 sonst. + - - Bekannte Probleme + + SQL-Upgradedateien - - Encoding Awareness + + Einführung - UTF-8 kodierte Installationen sind sehr anfällig gegen - fehlerhfate Encodings unter FCGI. latin9 Installationen behandeln - falsch kodierte Zeichen eher unwissend, und geben sie einfach - weiter. UTF-8 verweigert bei fehlerhaften Programmpfaden kurzerhand - das Ausliefern. Es wird noch daran gearbeitet, alle Fehler da zu - beseitigen. - + Datenbankupgrades werden über einzelne Upgrade-Scripte + gesteuert, die sich im Verzeichnis + sql/Pg-upgrade2 befinden. In diesem Verzeichnis + muss pro Datenbankupgrade eine Datei existieren, die neben den + eigentlich auszuführenden SQL- oder Perl-Befehlen einige + Kontrollinformationen enthält. + + Kontrollinformationen definieren Abhängigkeiten und Prioritäten, + 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 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. - - - SQL-Upgradedateien + + Format der Kontrollinformationen - - Einführung + Die Kontrollinformationen sollten sich am Anfang der jeweiligen + Upgradedatei befinden. Jede Zeile, die Kontrollinformationen enthält, + hat dabei das folgende Format: - - 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. - + Für SQL-Upgradedateien: - - 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. - + -- @key: value - - 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. - + Für Perl-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. - - + # @key: value - - Format der Kontrollinformationen + Leerzeichen vor "value" werden + entfernt. - - Die Kontrollinformationen sollten sich am Anfang der jeweiligen Upgradedatei befinden. Jede Zeile, die Kontrollinformationen enthält, - hat dabei das folgende Format: - + Die folgenden Schlüsselworte werden verarbeitet: - - Für SQL-Upgradedateien: - + + + tag - -- @key: value + + 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. + + - - Für Perl-Upgradedateien: - + + charset - # @key: value + + 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 für SQL-Upgradedateien der Zeichensatz + "ISO-8859-15" angenommen. Perl-Upgradescripte + hingegen müssen immer in UTF-8 encodiert sein und sollten + demnach auch ein "use utf8;" + enthalten. + + - - Leerzeichen vor "value" werden entfernt. - + + description - - Die folgenden Schlüsselworte werden verarbeitet: - + + 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. + + - - - tag - - - Wird zwingend benötigt. Dies ist der "Name" des Upgrades. Dieser "tag" kann von anderen Kontrolldateien in ihren Abhängigkeiten - verwendet werden (Schlüsselwort "depends"). Der "tag" ist auch der Name, der in der Datenbank eingetragen wird. - - - - Normalerweise sollte die Kontrolldatei genau so heißen wie der "tag", nur mit der Endung ".sql" bzw. "pl". - - - - Ein Tag darf nur aus alphanumerischen Zeichen sowie den Zeichen _ - ( ) bestehen. Insbesondere sind Leerzeichen nicht erlaubt und - sollten stattdessen mit Unterstrichen ersetzt werden. - - - + + depends - - 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. - - - + + 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"). + + - - 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. - - - + + priority - - depends - - - Optional. Eine mit Leerzeichen getrennte Liste von "tags", von denen dieses Upgradescript abhängt. Lx-Office stellt sicher, dass - die in dieser Liste aufgeführten Scripte bereits durchgeführt wurden, bevor dieses Script ausgeführt wird. - - - - Abhängigkeiten werden rekursiv betrachtet. Wenn also ein Script "b" existiert, das von Änderungen in "a" abhängt, und eine neue - Kontrolldatei für "c" erstellt wird, die von Änderungen in "a" und "b" abhängt, so genügt es, in "c" nur den Tag "b" als - Abhängigkeit zu definieren. - - - - Es ist nicht erlaubt, sich selbst referenzierende Abhängigkeiten zu definieren (z.B. "a" -> "b", - "b" -> "c" und "c" -> "a"). - - - + + 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". + + - - priority - - - Optional. Ein Zahlenwert, der die Reihenfolge bestimmt, in der Scripte ausgeführt werden, die die gleichen Abhängigkeitstiefen - besitzen. Fehlt dieser Parameter, so wird der Wert 1000 benutzt. - - - - Dies ist reine Kosmetik. Für echte Reihenfolgen muss "depends" benutzt werden. Lx-Office sortiert die auszuführenden Scripte - zuerst nach der Abhängigkeitstiefe (wenn "z" von "y" abhängt und "y" von "x", so hat "z" eine Abhängigkeitstiefe von 2, "y" von 1 - und "x" von 0. "x" würde hier zuerst ausgeführt, dann "y", dann "z"), dann nach der Priorität und bei gleicher Priorität - alphabetisch nach dem "tag". - - - - - ignore - - - Optional. Falls der Wert auf 1 (true) steht, wird das Skript bei der Anmeldung ignoriert und entsprechend nicht ausgeführt. - - - - - + + ignore - - Hilfsscript dbupgrade2_tool.pl + + Optional. Falls der Wert auf 1 (true) steht, wird das + Skript bei der Anmeldung ignoriert und entsprechend nicht + ausgeführt. + + + + - - 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. - + + Format von in Perl geschriebenen + Datenbankupgradescripten - - 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: - + In Perl geschriebene Datenbankscripte werden nicht einfach so + ausgeführt sondern müssen sich an gewisse Konventionen halten. Dafür + bekommen sie aber auch einige Komfortfunktionen bereitgestellt. - - - Listenform: "./scripts/dbupgrade2_tool.pl --list" + Ein Upgradescript stellt dabei eine vollständige Objektklasse + dar, die vom Elternobjekt "SL::DBUpgrade2::Base" + erben und eine Funktion namens "run" zur Verfügung + stellen muss. Das Script wird ausgeführt, indem eine Instanz dieser + Klasse erzeugt und darauf die erwähnte "run" + aufgerufen wird. - - 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. - - + Zu beachten ist, dass sich der Paketname der Datei aus dem Wert + für "@tag" ableitet. Dabei werden alle Zeichen, die + in Paketnamen ungültig wären (gerade Bindestriche), durch Unterstriche + ersetzt. Insgesamt sieht der Paketname wie folgt aus: + "SL::DBUpgrade2::tag". + + Welche Komfortfunktionen zur Verfügung stehen, erfahren Sie in + der Perl-Dokumentation zum oben genannten Modul; aufzurufen mit + "perldoc SL/DBUpgrade2/Base.pm". + + Ein Mindestgerüst eines gültigen Perl-Upgradescriptes sieht wie + folgt aus: + + # @tag: beispiel-upgrade-file42 +# @description: Ein schönes Beispielscript +# @depends: release_3_1_0 +package SL::DBUpgrade2::beispiel_upgrade_file42; + +use strict; +use utf8; + +use parent qw(SL::DBUpgrade2::Base); + +sub run { + my ($self) = @_; + + # hier Aktionen ausführen - - Baumform: "./scripts/dbupgrade2_tool.pl --tree" + return 1; +} + +1; + + + + + Hilfsscript dbupgrade2_tool.pl + + Um die Arbeit mit den Abhängigkeiten etwas zu erleichtern, + existiert ein Hilfsscript namens + "scripts/dbupgrade2_tool.pl". Es muss aus dem + 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. + + Wird dem Script kein weiterer Parameter übergeben, so wird nur + eine Überprüfung der Felder und Abhängigkeiten vorgenommen. Man kann + sich aber auch Informationen auf verschiedene Art ausgeben + lassen: + + + + Listenform: "./scripts/dbupgrade2_tool.pl + --list" - - 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. - - + 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. + - - Umgekehrte Baumform: "./scripts/dbupgrade2_tool.pl --rtree" + + 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. + - - 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. - - + + Umgekehrte Baumform: "./scripts/dbupgrade2_tool.pl + --rtree" - - Baumform mit Postscriptausgabe: "./scripts/dbupgrade2_tool.pl --graphviz" + 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. + - - 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. - - + + Baumform mit Postscriptausgabe: + "./scripts/dbupgrade2_tool.pl + --graphviz" + + Benötigt das Tool "graphviz", um mit + seiner Hilfe die umgekehrte + Baumform in eine Postscriptdatei namens + "db_dependencies.ps" auszugeben. Dies ist + vermutlich die übersichtlichste Form, weil hierbei jeder Knoten + nur einmal ausgegeben wird. Bei den Textmodusbaumformen hingegen + können Knoten und all ihre Abhängigkeiten mehrfach ausgegeben + werden. + - - - Scripte, von denen kein anderes Script abhängt: "./scripts/dbupgrade2_tool.pl --nodeps" - + + 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. - - - - + Listet die Tags aller Scripte auf, von denen keine anderen + Scripte abhängen. + + + @@ -5003,22 +7176,27 @@ file = /tmp/lx-office-debug.log 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. + - A stub version of French is included but not functunal at this - point. + + Character set + + All files included in a language pack must use UTF-8 as their + encoding. 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 - - charset - - - This file should be present. - - The charset file describes which - charset a language package is written in and applies to all - other language files in the package. It is possible to write - some language packages without an explicit charset, but it is - still strongly recommended. You'll never know in what - environment your language package will be used, and neither - UTF-8 nor Latin1 are guaranteed. - - The whole content of this file is a string that can be - recognized as a valid charset encoding. Example: - - UTF-8 - - - all @@ -5117,7 +7274,7 @@ English - 0.6% - 2015/2028 missing 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 @@ -5159,7 +7316,7 @@ filenames The last of which is very machine dependant. Remember that a lot of characters are forbidden by some filesystems, for - exmaple MS Windows doesn't like ':' in its files where Linux + example MS Windows doesn't like ':' in its files where Linux doesn't mind that. If you want the files created with your language pack to be portable, find all chars that could cause trouble. @@ -5197,40 +7354,342 @@ filenames want to keep this safe somewhere. + + + more/all + + + This subdir and file is not a part of the language package + itself. + + If the directory more exists and contains a file called + all it will be parsed in addition to the mandatory all (see + above). The file is useful if you want to change some + translations for the current installation without conflicting + further upgrades. The file is not autogenerated and has the same + format as the all, but needs another key (more_texts). See the + german translation for an example or copy the following code: + +#!/usr/bin/perl +# -*- coding: utf-8; -*- +# vim: fenc=utf-8 + +use utf8; + +# These are additional texts for custom translations. +# The format is the same as for the normal file all, only +# with another key (more_texts instead of texts). +# The file has the form of 'english text' => 'foreign text', + +$self->{more_texts} = { + + 'Ship via' => 'Terms of delivery', + 'Shipping Point' => 'Delivery time', +} + + + - + + 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 t/ + 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 t/, 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: + perl-Test-Deep; openSUSE: + perl-Test-Deep) + + + + Test::Exception (Debian-Paketname: + libtest-exception-perl; Fedora: + perl-Test-Exception; openSUSE: + perl-Test-Exception) + + + + Test::Output (Debian-Paketname: + libtest-output-perl; Fedora: + perl-Test-Output; openSUSE: + perl-Test-Output) + + + + 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. + + + + LWP::Simple aus dem Paket + libwww-perl (Debian-Panetname: + libwww-perl; Fedora: + perl-libwww-perl; openSUSE: + perl-libwww-perl) + + + + URI::Find (Debian-Panetname: + liburi-find-perl; Fedora: + perl-URI-Find; openSUSE: + perl-URI-Find) + + + + Weitere Voraussetzung ist, dass die Testsuite ihre eigene + Datenbank anlegen kann, um Produktivdaten nicht zu gefährden. Dazu + müssen in der Konfigurationsdatei im Abschnit + testing/database Datenbankverbindungsparameter + angegeben werden. Der hier angegebene Benutzer muss weiterhin das + Recht haben, Datenbanken anzulegen und zu löschen. + + + + 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.pl. + + Will man die komplette Test-Suite ausführen, so muss man einfach + nur t/test.pl ohne weitere Parameter aus dem + kivitendo-Basisverzeichnis heraus ausführen. + + Um einzelne Test-Scripte auszuführen, übergibt man deren Namen + an t/test.pl. Beispielsweise: + + t/test.pl 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 Funktionen 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 sein, 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 - - 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 } @@ -5244,36 +7703,37 @@ filenames $report->add($row); } - + - - Ö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) { ... @@ -5284,89 +7744,83 @@ filenames do { ... } until ($a > 0); - + - - - Parameter von Funktionsaufrufen müssen mit runden Klammern versehen werden. Davon nicht betroffen sind interne Perl-Funktionen, - und grep-ähnliche Operatoren. Beispiel: - + + 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 = ?", + $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 Operator "?:", 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; @@ -5378,181 +7832,178 @@ $i = 0 # initialize $i $n = $i; # save $i $i *= $const; # do something crazy $i = $n; # recover $i - - - + + + - - - Hashkeys sollten nur in Anführungszeichen stehen, wenn die Interpolation gewünscht ist. Beispiel: - + + 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 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. - - + - - - Es wird kein perltidy verwendet. - + + 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. + - - 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: - + + 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. + - -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 + Dokumentation erstellen - - Einführung + + 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. - - + 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 + + 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 Lx-Office übernimmt diese Aufgabe das Shell-Script - scripts/build_doc.sh. - + 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 Lx-Office-Betrieb nicht benötigt werden: - + Das Script benötigt zur Konvertierung verschiedene + Softwarekomponenten, die im normalen kivitendo-Betrieb nicht benötigt + werden: - - - - Java in einer halbwegs aktuellen Version - - + + + 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. - - - + + 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: - + 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 + 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: - + 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 + cd doc/build unzip $HOME/Downloads/dobudish-nojre-1.1.4.zip - + - - PDFs und HTML-Seiten erstellen + + PDFs und HTML-Seiten erstellen - - Die eigentliche Konvertierung erfolgt nach Installation der benötigten Software mit einem einfachen Aufruf direkt aus dem - Lx-Office-Installationsverzeichnis heraus: - + Die eigentliche Konvertierung erfolgt nach Installation der + benötigten Software mit einem einfachen Aufruf direkt aus dem + kivitendo-Installationsverzeichnis heraus: - ./scripts/build_doc.sh - + ./scripts/build_doc.sh + - - Einchecken in das Git-Repository + + 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. - + 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. - - + Die "dobudish"-Verzeichnisse bzw. + symbolischen Links gehören hingegen nicht in das Repository. +