From: Andreas Zenklusen Date: Thu, 28 Apr 2016 07:19:52 +0000 (+0200) Subject: Dokumentation zum Makroeinsatz in OpenDocument Vorlagen mit Anleitung zur Konfigurati... X-Git-Tag: release-3.4.1~169 X-Git-Url: http://wagnertech.de/git?a=commitdiff_plain;h=0e14ae06e360e5560c691ddfc66068de3c0ed8f8;p=kivitendo-erp.git Dokumentation zum Makroeinsatz in OpenDocument Vorlagen mit Anleitung zur Konfiguration für den Druck von CH-Einzahlungsscheinen --- diff --git a/doc/dokumentation.xml b/doc/dokumentation.xml index bc8405df3..46aee3c5f 100644 --- a/doc/dokumentation.xml +++ b/doc/dokumentation.xml @@ -14,15 +14,20 @@ im Community-Forum: https://forum.kivitendo.de:32443 + im Kunden-Forum: http://redmine.kivitendo-premium.de/projects/forum/boards/ + - in der doc/UPGRADE Datei im doc-Verzeichnis der Installation + in der doc/UPGRADE Datei im doc-Verzeichnis der + Installation + - Im Schulungs- und Dienstleistungsangebot der entsprechenden kivitendo-Partner: Im Schulungs- und Dienstleistungsangebot der entsprechenden + kivitendo-Partner: http://www.kivitendo.de/partner.html @@ -34,39 +39,57 @@ Ü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. - + 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. + + 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. + + Installation von kivitendo: Diese umfasst + die "" + sowie grundlegende Einstellungen, die der "" erläutert. + - Konfiguration externer Programme: hierzu gehören die Datenbank ("") und der Webserver (""). + + 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 "". + + 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 "". + + Benutzer, Gruppen und Datenbanken + anlegen: wie dies alles zusammenspielt erläutert "". + - Los geht's: alles soweit erledigt? Dann kann es losgehen: "" + + 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. - + Alle weiteren Unterkapitel in diesem Kapitel sind ebenfalls + wichtig und sollten vor einer ernsthaften Inbetriebnahme gelesen + werden. @@ -86,21 +109,24 @@ dass kivitendo auf ihnen läuft: - Debian + - - 7.0 "Wheezy" - - - 8.0 "Jessie" - + + 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 + Ubuntu 12.04 LTS "Precise Pangolin", 14.04 "Trusty Tahr" + LTS, 15.10 "Wily Werewolf" und 16.04 "Xenial Xerus" LTS + Alpha @@ -120,97 +146,184 @@ Apache) und ein Datenbankserver (PostgreSQL, mindestens v8.4) 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: + 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: - parent (nur bei Perl vor 5.10.1) + + parent (nur bei Perl vor 5.10.1) + - Archive::Zip + + Archive::Zip + - Algorithm::CheckDigits + + Algorithm::CheckDigits + - CGI + + CGI + - Clone + + Clone + - Config::Std + + Config::Std + - DateTime + + DateTime + - DateTime::Format::Strptime + + DateTime::Format::Strptime + - DBI + + DBI + - DBD::Pg + + DBD::Pg + - Email::Address + + Email::Address + - Email::MIME + + Email::MIME + - FCGI (nicht Versionen 0.68 bis 0.71 inklusive; siehe ) + + FCGI (nicht Versionen 0.68 bis 0.71 + inklusive; siehe ) + - File::Copy::Recursive + + File::Copy::Recursive + - GD + + GD + - HTML::Parser + + HTML::Parser + - HTML::Restrict + + HTML::Restrict + - Image::Info + + Image::Info + - JSON + + JSON + - List::MoreUtils + + List::MoreUtils + - List::UtilsBy + + List::UtilsBy + - Net::SMTP::SSL (optional, bei E-Mail-Versand über SSL; siehe Abschnitt "") + + Net::SMTP::SSL (optional, bei + E-Mail-Versand über SSL; siehe Abschnitt "") + - Net::SSLGlue (optional, bei E-Mail-Versand über TLS; siehe Abschnitt "") + + Net::SSLGlue (optional, bei + E-Mail-Versand über TLS; siehe Abschnitt "") + - Params::Validate + + Params::Validate + - PBKDF2::Tiny + + PBKDF2::Tiny + - PDF::API2 + + PDF::API2 + - Rose::Object + + Rose::Object + - Rose::DB + + Rose::DB + - Rose::DB::Object Version 0.788 oder neuer + + Rose::DB::Object Version 0.788 oder + neuer + - String::ShellQuote + + String::ShellQuote + - Sort::Naturally + + 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 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 v2.7.0 sind die folgenden Pakete hinzugekommen: Email::MIME, Net::SMTP::SSL, + 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 @@ -237,7 +350,9 @@ 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: + 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 \ @@ -252,7 +367,10 @@ 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: + 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 @@ -260,7 +378,9 @@ cpan HTML::Restrict Fedora - 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: + 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: 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 \ @@ -271,16 +391,17 @@ cpan HTML::Restrict 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: + Zusätzlich müssen einige Pakete aus dem CPAN installiert + werden. Dazu können Sie die folgenden Befehle nutzen: cpan Config::Std HTML::Restrict - openSUSE - Für openSUSE stehen die meisten der benötigten Perl-Pakete als RPM-Pakete zur Verfügung. Sie können mit folgendem Befehl + 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: zypper install apache2 apache2-mod_fcgid perl-Archive-Zip perl-Clone \ @@ -291,10 +412,10 @@ cpan HTML::Restrict perl-URI perl-XML-Writer perl-YAML perl-CPAN \ perl-Algorithm-CheckDigits perl-GD perl-Class-XSAccessor postgresql-server - Zusätzlich müssen einige Pakete aus dem CPAN installiert werden. Dazu können Sie die folgenden Befehle nutzen: + Zusätzlich müssen einige Pakete aus dem CPAN installiert + werden. Dazu können Sie die folgenden Befehle nutzen: cpan Rose::Db::Object - @@ -302,10 +423,18 @@ cpan HTML::Restrict Manuelle Installation des Programmpaketes - Der aktuelle Stable-Release, bzw. beta Release wird bei github gehostet und kann - hier heruntergeladen werden. - Die kivitendo ERP Installationsdatei (kivitendo-erp-3.4.0.tgz) wird im Dokumentenverzeichnis des Webservers - (z.B. /var/www/html/, /srv/www/htdocs oder /var/www/) entpackt: + + Der aktuelle Stable-Release, bzw. beta Release wird bei github + gehostet und kann hier + heruntergeladen werden. + + Die kivitendo ERP Installationsdatei + (kivitendo-erp-3.4.0.tgz) wird im + Dokumentenverzeichnis des Webservers (z.B. + /var/www/html/, + /srv/www/htdocs oder + /var/www/) entpackt: cd /var/www tar xvzf kivitendo-erp-3.4.0.tgz @@ -318,39 +447,47 @@ tar xvzf kivitendo-erp-3.4.0.tgz 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: + 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. Die Benutzer- und - Gruppennamen sind bei verschiedenen Distributionen unterschiedlich (z.B. bei Debian/Ubuntu www-data, bei Fedora - apache oder bei OpenSUSE wwwrun). + Die Verzeichnisse users, + spool und webdav müssen für + den Benutzer beschreibbar sein, unter dem der Webserver läuft. Die + restlichen Dateien müssen für diesen Benutzer lesbar sein. Die Benutzer- + und Gruppennamen sind bei verschiedenen Distributionen unterschiedlich + (z.B. bei Debian/Ubuntu www-data, bei Fedora + 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 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: + 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/ + + + 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). - - + 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). + @@ -360,10 +497,10 @@ git checkout `git tag -l | egrep -ve "(beta|rc)" | tail -1` xreflabel="Einführung in die Konfigurationsdatei"> 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 + In kivitendo gibt es nur noch eine Konfigurationsdatei, die + benötigt wird: config/kivitendo.conf (kurz: "die + Hauptkonfigurationsdatei"). Diese muss bei der Erstinstallation von + kivitendo bzw. der Migration von älteren Versionen angelegt werden. Als Vorlage dient die Datei @@ -379,10 +516,10 @@ git checkout `git tag -l | egrep -ve "(beta|rc)" | tail -1` 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. - + 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 @@ -401,39 +538,72 @@ git checkout `git tag -l | egrep -ve "(beta|rc)" | tail -1` entsprechend kommentiert sind: - authentication (siehe Abschnitt "" in diesem Kapitel) - - authentication/database + + authentication (siehe Abschnitt "" + in diesem Kapitel) + - authentication/ldap + + authentication/database + - system + + authentication/ldap + - paths + + system + - mail_delivery (siehe Abschnitt ") + + paths + - applications + + mail_delivery (siehe Abschnitt ") + - environment + + applications + + + environment + - print_templates + + print_templates + - task_server + + task_server + - periodic_invoices + + periodic_invoices + - self_tests + + self_tests + - console + + console + - testing + + testing + - testing/database + + testing/database + - debug + + debug + Die üblicherweise wichtigsten Parameter, die am Anfang @@ -454,11 +624,15 @@ password = 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. + 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. @@ -491,11 +665,13 @@ password = Zeichensätze/die Verwendung von Unicode/UTF-8 - kivitendo setzt zwingend voraus, dass die Datenbank Unicode/UTF-8 als Encoding einsetzt. Bei aktuellen Serverinstallationen - braucht man hier meist nicht einzugreifen. + kivitendo setzt zwingend voraus, dass die Datenbank + Unicode/UTF-8 als Encoding einsetzt. Bei aktuellen + Serverinstallationen braucht man hier meist nicht einzugreifen. - 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: + 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: su postgres echo '\l' | psql @@ -534,9 +710,9 @@ exit In der Datei pg_hba.conf, die im gleichen 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: + 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 @@ -549,19 +725,21 @@ host all kivitendo 127.0.0.1 255.255.255.255 password Unterstützung für servergespeicherte Prozeduren eingerichet werden. Melden Sie sich dafür als Benutzer “postgres” an der Datenbank an: su - postgres -psql template1 - - führen Sie die folgenden Kommandos aus: +psql template1 führen Sie die folgenden Kommandos aus: 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 - + + 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 + @@ -572,16 +750,17 @@ psql template1 anlegen. Ein Beispiel, wie Sie einen neuen Benutzer anlegen können: - 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 + 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 “kivitendo” bzw. - den hier gewählten Benutzernamen. + Sie den evtl. voreingestellten Benutzer “postgres” auf “kivitendo” + bzw. den hier gewählten Benutzernamen. @@ -594,7 +773,7 @@ exit Für einen deutlichen Performanceschub sorgt die Ausführung mittels FastCGI/FCGI. Die Einrichtung wird ausführlich im Abschnitt - beschrieben. + beschrieben. Der Zugriff auf das Programmverzeichnis muss in der Apache @@ -622,9 +801,10 @@ Alias /kivitendo-erp/ /var/www/kivitendo-erp/ 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. + + 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 @@ -699,12 +879,14 @@ Alias /kivitendo-erp/ /var/www/kivitendo-erp/ verwendet. - 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. + 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 @@ -749,10 +931,15 @@ Require all granted </DirectoryMatch> - 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: - + 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 @@ -763,7 +950,6 @@ Require all granted FcgidMaxRequestLen 10485760 - Das Ganze sollte dann so aussehen: AddHandler fcgid-script .fpl @@ -805,29 +991,36 @@ Alias /url/for/kivitendo-erp-fcgid/ /path/to/kivitendo-erp/ + 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) + + 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) Der Task-Server - Der Task-Server ist ein Prozess, der im Hintergrund läuft, in regelmäßigen Abständen nach abzuarbeitenden Aufgaben sucht und - diese zu festgelegten Zeitpunkten abarbeitet (ähnlich wie Cron). Dieser Prozess wird u.a. für die Erzeugung der wiederkehrenden - Rechnungen und weitere essenzielle Aufgaben benutzt. + 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 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. + 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. + 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 @@ -847,7 +1040,7 @@ Alias /url/for/kivitendo-erp-fcgid/ /path/to/kivitendo-erp/). Daher + linkend="Manuelle-Installation-des-Programmpaketes"/>). Daher ist es erforderlich, hier denselben Systembenutzer einzutragen, unter dem auch der Webserver läuft. @@ -866,11 +1059,15 @@ Alias /url/for/kivitendo-erp-fcgid/ /path/to/kivitendo-erp/ 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 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 + Ist in dieser Einstellung keine Benutzerkennung ausgewählt, so + wird der Task-Server für diesen Mandanten keine Aufgaben ausführen. @@ -888,7 +1085,8 @@ Alias /url/for/kivitendo-erp-fcgid/ /path/to/kivitendo-erp/ - SystemV-basierende Systeme (z.B. Debian, ältere OpenSUSE, ältere Fedora) + SystemV-basierende Systeme (z.B. Debian, ältere OpenSUSE, + ältere Fedora) Kopieren Sie die Datei scripts/boot/system-v/kivitendo-task-server @@ -935,12 +1133,16 @@ insserv kivitendo-task-server - systemd-basierende Systeme (z.B. neure OpenSUSE, neuere Fedora, neuere Ubuntu) + systemd-basierende Systeme (z.B. neure OpenSUSE, neuere + Fedora, neuere Ubuntu) - Verlinken Sie die Datei scripts/boot/systemd/kivitendo-task-server.service nach - /etc/systemd/system/. Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile - ExecStart=.... und ExecStop=...). Binden Sie das Script in den Boot-Prozess ein. - + Verlinken Sie die Datei + scripts/boot/systemd/kivitendo-task-server.service + nach /etc/systemd/system/. Passen Sie in der + kopierten Datei den Pfad zum Task-Server an (Zeile + ExecStart=.... und + ExecStop=...). Binden Sie das Script in den + Boot-Prozess ein. Alle hierzu benötigten Befehle sehen so aus: @@ -1031,11 +1233,12 @@ ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/ Administratorpasswort - 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]. + 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]. @@ -1226,8 +1429,9 @@ ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/ Mandanten-, Benutzer- und Gruppenverwaltung - Nach der Installation müssen Mandanten, 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/kivitendo-erp/controller.pl?action=Admin/login @@ -1238,45 +1442,65 @@ ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/ Zusammenhänge - 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. - + 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: + 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: @@ -1313,138 +1537,210 @@ ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/ Anlegen können Sie die verschiedenen Bereiche wählen, auf die Mitglieder dieser Gruppe Zugriff haben sollen. - 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"). + 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"). Benutzer anlegen - Beim Anlegen von Benutzern werden für viele Parameter Standardeinstellungen vorgenommen, die den Gepflogenheiten des deutschen - Raumes entsprechen. + Beim Anlegen von Benutzern werden für viele Parameter + Standardeinstellungen vorgenommen, die den Gepflogenheiten des + deutschen Raumes entsprechen. - 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 + 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"). + 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"). 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"). + 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"). + Drucker- und Systemverwaltung - Im Administrationsmenü gibt es ferner noch die beiden Menüpunkte Druckeradministration und System. + + 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. - + + 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. + + System sperren / entsperren - 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. - 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. - - + 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. - - E-Mail-Versand aus kivitendo heraus + Falls die Sperre gesetzt ist, erscheint anstelle der + Anmeldemaske die Information: 'kivitendo ist momentan zwecks + Wartungsarbeiten nicht zugänglich.'. - 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). + 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. + + - 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]'. + + 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. + 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 + 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 + 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. + 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. + 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 + 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' + + 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. + + 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). + + 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 + login und + password - Falls der E-Mail-Server eine Authentifizierung verlangt, so können mit diesen zwei Parametern der Benutzername - und das Passwort angegeben werden. Wird Authentifizierung verwendet, so sollte aus Sicherheitsgründen auch eine Form von - Verschlüsselung aktiviert werden. + + 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. + @@ -1453,9 +1749,10 @@ ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/ Drucken mit kivitendo - Das Drucksystem von kivitendo benutzt von Haus aus LaTeX-Vorlagen. Um drucken zu können, braucht der Server ein geeignetes - LaTeX System. Am einfachsten ist dazu eine texlive Installation. Unter debianoiden Betriebssystemen installiert man - die Pakete mit: + Das Drucksystem von kivitendo benutzt von Haus aus LaTeX-Vorlagen. + Um drucken zu können, braucht der Server ein geeignetes LaTeX System. Am + einfachsten ist dazu eine texlive Installation. Unter + debianoiden Betriebssystemen installiert man die Pakete mit: apt-get install texlive-base-bin texlive-latex-recommended texlive-fonts-recommended \ exlive-latex-extra texlive-lang-german texlive-generic-extra @@ -1473,317 +1770,463 @@ ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/ texlive-collection-langenglish kivitendo bringt drei alternative Vorlagensätze mit: + - RB - f-tex - rev-odt + + RB + + + + f-tex + + + + rev-odt + - Der ehemalige Druckvorlagensatz "Standard" wurde mit der Version 3.3 entfernt, da er nicht mehr gepflegt wurde. + Der ehemalige Druckvorlagensatz "Standard" wurde mit der Version + 3.3 entfernt, da er nicht mehr gepflegt wurde. - + Vorlagenverzeichnis anlegen - Es lässt sich ein initialer Vorlagensatz erstellen. Die LaTeX-System-Abhängigkeiten hierfür kann man prüfen mit: + + Es lässt sich ein initialer Vorlagensatz erstellen. Die + LaTeX-System-Abhängigkeiten hierfür kann man prüfen mit: ./scripts/installation_check.pl -lv - Der Angemeldete Benutzer muss in einer Gruppe sein, die über das - Recht "Konfiguration -> Mandantenverwaltung" verfügt. Siehe auch . - - Im Userbereich lässt sich unter: - "System -> - Mandantenverwaltung -> Verschiedenes" die Option - "Neue Druckvorlagen aus Vorlagensatz erstellen" auswählen. + Der Angemeldete Benutzer muss in einer Gruppe sein, die über das + Recht "Konfiguration -> Mandantenverwaltung" verfügt. Siehe auch + . - - : Wählen Sie hier den Vorlagensatz aus, der kopiert werden soll - (RB, f-tex oder odt-rev.) - : Der Verzeichnisname für den neuen Vorlagensatz. Dieser kann im Rahmen der üblichen - Bedingungen für Verzeichnisnamen frei gewählt werden. - + Im Userbereich lässt sich unter: "System + -> Mandantenverwaltung -> + Verschiedenes" die Option "Neue + Druckvorlagen aus Vorlagensatz erstellen" auswählen. - 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] + + + : Wählen Sie hier den + Vorlagensatz aus, der kopiert werden soll + (RB, f-tex oder + odt-rev.) + + + : Der Verzeichnisname für den + neuen Vorlagensatz. Dieser kann im Rahmen der üblichen Bedingungen + für Verzeichnisnamen frei gewählt werden. + + + 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] Der Druckvorlagensatz RB - Hierbei handelt es sich um einen vollständigen LaTeX Dokumentensatz mit alternativem Design. Die odt oder html-Varianten sind nicht gepflegt. + 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. + url="http://www.kivitendo-support.de/vortraege/Lx-Office%20Anwendertreffen%20LaTeX-Druckvorlagen-Teil3-finale.pdf">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" - + + + 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. + 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. + + 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*) + + 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 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). + + 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) + + 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). + + 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. + + Multisprachfähig leicht um weitere Sprachen zu erweitern, + alle Übersetzungen in der Datei + translatinos.tex. + - Auflistung von Bruttopreisen für Endverbraucher. + + 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. + + 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. + - Erstelle eine pdf-Hintergrund Datei und verlinke sie nach ./letter_head.pdf. - Editiere den Bereich "" in der datei letter.lco. + + 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. - + 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: - + + 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) - + + Tabellen mit oder ohne Preis + - Nachteil: + + Sprache der Tabellenüberschriften etc. + - - 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. - + + Anpassung der Bezugs-Zeile (z.B. Rechnungsnummer versus + Angebotsnummer) + - 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. - + + 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. - Kleiner Tipp: Nicht zu viel auf einmal wollen, lieber kleine, kontinuierliche Schritte gehen. + Wer nicht so tief in die Materie einsteigen will oder leicht + zu frustrieren ist, sollte sein Hintergrund-PDF auf Basis der + mitglieferten Datei sample_head.pdf erstellen, + und sich an der Form der dargestellten Tabellen, wie sie + ausgeliefert werden, erfreuen. + Kleiner Tipp: Nicht zu viel auf einmal wollen, lieber kleine, + kontinuierliche Schritte gehen. Bruttopreise für Endverbraucher - Der auszuweisende Bruttopreis wird innerhalb der LaTeX-Umgebung berechnet. Es gibt zwar ein Feld, um bei Aufträgen "alle - Preise Brutto" auszuwählen, aber: + Der auszuweisende Bruttopreis wird innerhalb der + LaTeX-Umgebung berechnet. Es gibt zwar ein Feld, um bei Aufträgen + "alle Preise Brutto" auszuwählen, aber: + - hierfür müssen die Preise auch in Brutto in der Datenbank stehen (ja - das lässt sich über die Preisgruppen und die + 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) + 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: + 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. + + 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. - + 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 -einzusetzen. Entsprechende Vorlagen sind deshalb nicht vorhanden. - - -Inwieweit es möglich ist, für die in Version 3.2.0 neu eingeführten Pflichtenhefte -odt-Vorlagen zu erstellen, sind wir am abklären. -Wenn dies möglich ist, werden wir in Zukunft auch eine odt-Vorlage für Pflichtenhefte -in diesem Vorlagensatz zur Verfügung stellen. - - -Fehlermeldungen, Anregungen und Wünsche bitte senden an: -empfang@revamp-it.ch - - + 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 einzusetzen. Entsprechende Vorlagen sind + deshalb nicht vorhanden. + + Inwieweit es möglich ist, für die in Version 3.2.0 neu + eingeführten Pflichtenhefte odt-Vorlagen zu erstellen, sind wir am + abklären. Wenn dies möglich ist, werden wir in Zukunft auch eine + odt-Vorlage für Pflichtenhefte in diesem Vorlagensatz zur Verfügung + stellen. + + Fehlermeldungen, Anregungen und Wünsche bitte senden an: + empfang@revamp-it.ch 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: + + 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. + ! 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. + 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: + 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: + 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; + 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 + 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 + 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 + für besseren Hinweis auf Fehler texdatei nochmals + übersetzen + pdflatex ./1*.tex + in der *.tex datei nach dem Fehler suchen. @@ -1830,20 +2273,25 @@ empfang@revamp-it.ch sind. - - Für die Verbindung zu 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 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. - + Für die Verbindung zu 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 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 @@ -1870,9 +2318,242 @@ empfang@revamp-it.ch Dieses Verzeichnis, wie auch das komplette users-Verzeichnis, muss vom Webserver beschreibbar sein. Dieses wurde bereits erledigt (siehe ), kann aber - erneut überprüft werden, wenn die Konvertierung nach PDF - fehlschlägt. + linkend="Manuelle-Installation-des-Programmpaketes"/>), kann aber erneut + überprüft werden, wenn die Konvertierung nach PDF fehlschlägt. + + + 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 + + + + + + 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. + + + + @@ -1883,9 +2564,11 @@ empfang@revamp-it.ch xreflabel="Einführung in die Konfiguration zur 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. + 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 @@ -1963,13 +2646,12 @@ empfang@revamp-it.ch 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 - + 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). @@ -2044,143 +2726,157 @@ empfang@revamp-it.ch - + - - 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. - + 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. - + 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. - + 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. - + 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. - + 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. + 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 + 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. + 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. @@ -2238,8 +2934,8 @@ empfang@revamp-it.ch Bei aktiven Rechnungen wird automatisch eine Rechnung - erstellt, wenn die Periodizität erreicht ist (z.B. am Anfang eines - neuen Monats). + 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 @@ -2327,254 +3023,285 @@ empfang@revamp-it.ch 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%>. - + 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. - + 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 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: - + Diese Variablen werden in den folgenden Elementen des Auftrags + ersetzt: - Bemerkungen - Interne Bemerkungen - Vorgangsbezeichnung - In den Beschreibungs- und Langtextfeldern aller Positionen + + 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%> + <%current_quarter%>, + <%previous_quarter%>, + <%next_quarter%> - - Aktuelles, vorheriges und nächstes Quartal als Zahl zwischen 1 und 4. - + Aktuelles, vorheriges und nächstes Quartal als Zahl + zwischen 1 und 4. - <%current_month%>, <%previous_month%>, <%next_month%> + <%current_month%>, + <%previous_month%>, + <%next_month%> - - Aktueller, vorheriger und nächster Monat als Zahl zwischen 1 und 12. - + Aktueller, vorheriger und nächster Monat als Zahl zwischen + 1 und 12. - <%current_month_long%>, <%previous_month_long%>, <%next_month_long%> + <%current_month_long%>, + <%previous_month_long%>, + <%next_month_long%> - - Aktueller, vorheriger und nächster Monat als Name (Januar, Februar etc.). - + Aktueller, vorheriger und nächster Monat als Name + (Januar, Februar + etc.). - <%current_year%>, <%previous_year%>, <%next_year%> + <%current_year%>, + <%previous_year%>, + <%next_year%> - - Aktuelles, vorheriges und nächstes Jahr als vierstellige Jahreszahl (2013 etc.). - + Aktuelles, vorheriges und nächstes Jahr als vierstellige + Jahreszahl (2013 etc.). - <%period_start_date%>, <%period_end_date%> + <%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). - + 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: - - + 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 + + %a - - Der abgekürzte Wochentagsname. - - + + Der abgekürzte Wochentagsname. + + - - %A + + %A - - Der ausgeschriebene Wochentagsname. - - + + Der ausgeschriebene Wochentagsname. + + - - %b + + %b - - Der abgekürzte Monatsname. - - + + Der abgekürzte Monatsname. + + - - %B + + %B - - Der ausgeschriebene Monatsname. - - + + Der ausgeschriebene Monatsname. + + - - %C + + %C - - Das Jahrhundert (Jahr/100) als eine zweistellige Zahl. - - + + Das Jahrhundert (Jahr/100) als eine zweistellige + Zahl. + + - - %d + + %d - - Der Monatstag als Zahl zwischen 01 und 31. - - + + Der Monatstag als Zahl zwischen 01 und 31. + + - - %D + + %D - - Entspricht %m/%d/%y (amerikanisches Datumsformat). - - + + Entspricht %m/%d/%y (amerikanisches Datumsformat). + + - - %e + + %e - - Wie %d (Monatstag als Zahl zwischen 1 und 31), allerdings werden führende Nullen durch Leerzeichen ersetzt. - - + + Wie %d (Monatstag als Zahl zwischen 1 und 31), allerdings + werden führende Nullen durch Leerzeichen ersetzt. + + - - %F + + %F - - Entspricht %Y-%m-%d (das ISO-8601-Datumsformat). - - + + Entspricht %Y-%m-%d (das ISO-8601-Datumsformat). + + - - %j + + %j - - Der Tag im Jahr als Zahl zwischen 001 und 366 inklusive. - - + + Der Tag im Jahr als Zahl zwischen 001 und 366 + inklusive. + + - - %m + + %m - - Der Monat als Zahl zwischen 01 und 12 inklusive. - - + + Der Monat als Zahl zwischen 01 und 12 inklusive. + + - - %u + + %u - - Der Wochentag als Zahl zwischen 1 und 7 inklusive, wobei die 1 dem Montag entspricht. - - + + Der Wochentag als Zahl zwischen 1 und 7 inklusive, wobei + die 1 dem Montag entspricht. + + - - %U + + %U - - Die Wochennummer als Zahl zwischen 00 und 53 inklusive, wobei der erste Sonntag im Jahr das Startdatum von Woche 01 ist. - - + + Die Wochennummer als Zahl zwischen 00 und 53 inklusive, + wobei der erste Sonntag im Jahr das Startdatum von Woche 01 + ist. + + - - %V + + %V - - 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. - - + + 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. + + - - %w + + %w - - Der Wochentag als Zahl zwischen 0 und 6 inklusive, wobei die 0 dem Sonntag entspricht. - - + + Der Wochentag als Zahl zwischen 0 und 6 inklusive, wobei + die 0 dem Sonntag entspricht. + + - - %W + + %W - - Die Wochennummer als Zahl zwischen 00 und 53 inklusive, wobei der erste Montag im Jahr das Startdatum von Woche 01 ist. - - + + Die Wochennummer als Zahl zwischen 00 und 53 inklusive, + wobei der erste Montag im Jahr das Startdatum von Woche 01 + ist. + + - - %y + + %y - - Das Jahr als zweistellige Zahl zwischen 00 und 99 inklusive. - - + + Das Jahr als zweistellige Zahl zwischen 00 und 99 + inklusive. + + - - %Y + + %Y - - Das Jahr als vierstellige Zahl. - - + + Das Jahr als vierstellige Zahl. + + - - %% + + %% - - Das Prozentzeichen selber. - - + + 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%> - + 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%> @@ -2608,20 +3335,22 @@ empfang@revamp-it.ch manuell über den Workflow. - + + Bankerweiterung Einführung - Die Beschreibung der Bankerweiterung befindet sich derzeit noch im Wiki und soll von dort später hierhin übernommen werden: + Die Beschreibung der Bankerweiterung befindet sich derzeit noch + im Wiki und soll von dort später hierhin übernommen werden: http://redmine.kivitendo-premium.de/projects/forum/wiki/Bankerweiterung + Dokumentenvorlagen und verfügbare Variablen @@ -2634,7 +3363,7 @@ empfang@revamp-it.ch <%variablenname%> verwendet wird. Für LaTeX- und HTML-Vorlagen kann man die Form dieser Tags auch verändern (siehe ). + linkend="dokumentenvorlagen-und-variablen.tag-style"/>). Früher wurde hier nur über LaTeX gesprochen. Inzwischen unterstützt kivitendo aber auch OpenDocument-Vorlagen. Sofern es nicht @@ -2910,7 +3639,7 @@ empfang@revamp-it.ch Die kurzen Varianten dieser Vorlagentitel müssen dann entweder Standardwerte anzeigen, oder die angeforderten Werte selbst auswerten, siehe dazu . + linkend="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"/>. @@ -2951,8 +3680,8 @@ empfang@revamp-it.ch template_meta.language.template_code - Vorlagenkü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. @@ -3260,7 +3989,6 @@ empfang@revamp-it.ch - greeting @@ -3752,15 +4480,27 @@ empfang@revamp-it.ch delivery_term - Datenbank-Objekt der Lieferbedingung + + + Datenbank-Objekt der Lieferbedingung + + delivery_term.description - Beschreibung der Lieferbedingung + + + Beschreibung der Lieferbedingung + + delivery_term.description_long - Langtext bzw. übersetzter Langtext der Lieferbedingung + + + Langtext bzw. übersetzter Langtext der + Lieferbedingung + @@ -3994,7 +4734,8 @@ empfang@revamp-it.ch cusordnumber_oe - Bestellnummer des Kunden aus dem Auftrag, aus dem der Posten ursprünglich stammt (nur Verkauf) + Bestellnummer des Kunden aus dem Auftrag, aus dem der + Posten ursprünglich stammt (nur Verkauf) @@ -4018,7 +4759,9 @@ empfang@revamp-it.ch donumber_do - Lieferscheinnummer des Lieferscheins, aus dem die Position ursprünglich stammt, wenn die Rechnung im Rahmen des Workflows aus einem Lieferschein erstellt wurde. + Lieferscheinnummer des Lieferscheins, aus dem die + Position ursprünglich stammt, wenn die Rechnung im Rahmen des + Workflows aus einem Lieferschein erstellt wurde. @@ -4074,7 +4817,15 @@ empfang@revamp-it.ch netprice - 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. + 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. @@ -4106,7 +4857,12 @@ empfang@revamp-it.ch ordnumber_oe - 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. + 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. @@ -4220,7 +4976,8 @@ empfang@revamp-it.ch transdate_do - Datum des Lieferscheins, wenn die Rechnung im Rahmen des Workflows aus einem Lieferschein stammte. + Datum des Lieferscheins, wenn die Rechnung im Rahmen des + Workflows aus einem Lieferschein stammte. @@ -4228,7 +4985,10 @@ empfang@revamp-it.ch transdate_oe - 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. + 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. @@ -4236,7 +4996,8 @@ empfang@revamp-it.ch transdate_quo - Datum des Angebots, wenn die Position im Rahmen des Workflows aus einem Angebot stammte. + Datum des Angebots, wenn die Position im Rahmen des + Workflows aus einem Angebot stammte. @@ -4343,7 +5104,9 @@ empfang@revamp-it.ch 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_. + Die benutzerdefinierten Variablen der Lieferadressen stehen + unter einem ähnlichen Namensschema zur Verfügung. Hier lautet der + Präfix shiptocvar_. @@ -4988,10 +5751,13 @@ empfang@revamp-it.ch 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: + 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: @@ -5225,40 +5991,51 @@ 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. - - - + + + 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. + + + + @@ -5648,8 +6425,10 @@ $main::lxdebug->message(0, 'Wer bin ich? Kunde oder Lieferant:' . $form->{ 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 + 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. @@ -5942,17 +6721,25 @@ file_name = /tmp/kivitendo-debug.log xreflabel="Einführung in die Datenbank-Upgradedateien"> Einführung - 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. + 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. 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 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. + 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. @@ -6072,27 +6863,36 @@ file_name = /tmp/kivitendo-debug.log - - Format von in Perl geschriebenen Datenbankupgradescripten + + Format von in Perl geschriebenen + Datenbankupgradescripten - 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. + 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. - 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. + 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. - 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". + 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". + 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: + Ein Mindestgerüst eines gültigen Perl-Upgradescriptes sieht wie + folgt aus: - # @tag: beispiel-upgrade-file42 + # @tag: beispiel-upgrade-file42 # @description: Ein schönes Beispielscript # @depends: release_3_1_0 package SL::DBUpgrade2::beispiel_upgrade_file42; @@ -6214,7 +7014,8 @@ sub run { xreflabel="Character set"> Character set - All files included in a language pack must use UTF-8 as their encoding. + All files included in a language pack must use UTF-8 as their + encoding. want to keep this safe somewhere. + more/all @@ -6388,13 +7190,13 @@ filenames 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: + 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; -*- @@ -6405,19 +7207,16 @@ 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', +# The file has the form of 'english text' => 'foreign text', -$self->{more_texts} = { +$self->{more_texts} = { - 'Ship via' => 'Terms of delivery', - 'Shipping Point' => 'Delivery time', + 'Ship via' => 'Terms of delivery', + 'Shipping Point' => 'Delivery time', } - - + - - @@ -6428,138 +7227,247 @@ $self->{more_texts} = { Einführung - kivitendo enthält eine Suite für automatisierte Tests. Sie basiert auf dem Standard-Perl-Modul Test::More. + 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/. + + Alle Tests liegen im Unterverzeichnis + t/. + - Ein Script (bzw. ein Test) in t/ enthält einen oder mehrere Testfälle. + + 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. + + 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. + + 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: + 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) + + 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. + 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 - + 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. + 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. + 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: + 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 - + 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: + 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 + + 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. + Weitere Test-Scripte überprüfen primär die Funktionsweise + einzelner Funktionen und Module. - - Neue Test-Scripte erstellen - + 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. + 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 für neue Test-Scripte, die keine konkreten Funktionen + testen - Ideen, die abgesehen von Funktionen noch nicht umgesetzt wurden: + 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 + + Ü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 - + 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: + 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. + + Die Dateiendung muss .t + lauten. + - Namen sind englisch, komplett klein geschrieben und einzelne Wörter mit Unterstrichten getrennt (beispielsweise - bad_function_params.t). + + 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). + + 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. + + 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 - + 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: + Der folgenden Programmcode enthält das kleinstmögliche + Testscript und kann als Ausgangspunkt für eigene Tests verwendet + werden: use Test::More tests => 0; @@ -6569,13 +7477,18 @@ 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 + 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. + 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. @@ -6823,7 +7736,7 @@ $some_hash{42} = 54; $form, $auth, $locale, $lxdebug und %myconfig werden derzeit aus dem main package - importiert (siehe . Alle anderen + importiert (siehe . Alle anderen Konstrukte sollten lexikalisch lokal gehalten werden. diff --git a/doc/html/ch01.html b/doc/html/ch01.html index 8038c4944..1fb827f7c 100644 --- a/doc/html/ch01.html +++ b/doc/html/ch01.html @@ -2,5 +2,7 @@ Kapitel 1. Aktuelle Hinweise
Kapitel 1. Aktuelle Hinweise
Zurück   Weiter

Kapitel 1. Aktuelle Hinweise

Aktuelle Installations- und Konfigurationshinweise gibt es:

Zurück   Weiter
kivitendo 3.4.0: Installation, Konfiguration, Entwicklung Zum Anfang Kapitel 2. Installation und Grundkonfiguration
\ No newline at end of file diff --git a/doc/html/ch02.html b/doc/html/ch02.html index 58bed7b7c..6801a1124 100644 --- a/doc/html/ch02.html +++ b/doc/html/ch02.html @@ -1,18 +1,27 @@ - Kapitel 2. Installation und Grundkonfiguration
Kapitel 2. Installation und Grundkonfiguration
Zurück   Weiter

Kapitel 2. Installation und Grundkonfiguration

2.1. Ü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. -

  1. - Voraussetzungen überprüfen: kivitendo benötigt gewisse Ressourcen und benutzt weitere - Programme. Das Kapitel "Abschnitt 2.2, „Benötigte Software und Pakete“" erläutert diese. Auch die Liste der benötigten Perl-Module - befindet sich hier.

  2. - Installation von kivitendo: Diese umfasst die "Manuelle Installation des Programmpaketes" sowie grundlegende Einstellungen, die der "Abschnitt 2.4, „kivitendo-Konfigurationsdatei“" erläutert.

  3. - Konfiguration externer Programme: hierzu gehören die Datenbank ("Abschnitt 2.5, „Anpassung der PostgreSQL-Konfiguration“") und der Webserver ("Abschnitt 2.6, „Webserver-Konfiguration“").

  4. - 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 "Abschnitt 2.8, „Benutzerauthentifizierung und Administratorpasswort“".

  5. - Benutzer, Gruppen und Datenbanken anlegen: wie dies alles zusammenspielt erläutert "Abschnitt 2.9, „Mandanten-, Benutzer- und Gruppenverwaltung“".

  6. - Los geht's: alles soweit erledigt? Dann kann es losgehen: "Abschnitt 2.18, „kivitendo ERP verwenden“"

- Alle weiteren Unterkapitel in diesem Kapitel sind ebenfalls wichtig und sollten vor einer ernsthaften Inbetriebnahme gelesen - werden. -

Zurück   Weiter
Kapitel 1. Aktuelle Hinweise Zum Anfang 2.2. Benötigte Software und Pakete
\ No newline at end of file + Kapitel 2. Installation und Grundkonfiguration
Kapitel 2. Installation und Grundkonfiguration
Zurück   Weiter

Kapitel 2. Installation und Grundkonfiguration

2.1. Ü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.

  1. + Voraussetzungen überprüfen: kivitendo + benötigt gewisse Ressourcen und benutzt weitere Programme. Das + Kapitel "Abschnitt 2.2, „Benötigte Software und Pakete“" erläutert + diese. Auch die Liste der benötigten Perl-Module befindet sich + hier.

  2. + Installation von kivitendo: Diese umfasst + die "Manuelle Installation des Programmpaketes" + sowie grundlegende Einstellungen, die der "Abschnitt 2.4, „kivitendo-Konfigurationsdatei“" erläutert.

  3. + Konfiguration externer Programme: hierzu + gehören die Datenbank ("Abschnitt 2.5, „Anpassung der PostgreSQL-Konfiguration“") und der + Webserver ("Abschnitt 2.6, „Webserver-Konfiguration“").

  4. + 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 "Abschnitt 2.8, „Benutzerauthentifizierung und Administratorpasswort“".

  5. + Benutzer, Gruppen und Datenbanken + anlegen: wie dies alles zusammenspielt erläutert "Abschnitt 2.9, „Mandanten-, Benutzer- und Gruppenverwaltung“".

  6. + Los geht's: alles soweit erledigt? Dann + kann es losgehen: "Abschnitt 2.18, „kivitendo ERP verwenden“"

Alle weiteren Unterkapitel in diesem Kapitel sind ebenfalls + wichtig und sollten vor einer ernsthaften Inbetriebnahme gelesen + werden.

Zurück   Weiter
Kapitel 1. Aktuelle Hinweise Zum Anfang 2.2. Benötigte Software und Pakete
\ No newline at end of file diff --git a/doc/html/ch02s02.html b/doc/html/ch02s02.html index 43cccc720..9d138955c 100644 --- a/doc/html/ch02s02.html +++ b/doc/html/ch02s02.html @@ -6,11 +6,14 @@ 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 2016 sind das folgende Systeme, von denen bekannt ist, - dass kivitendo auf ihnen läuft:

2.2.2. Benötigte Perl-Pakete installieren

Zum Betrieb von kivitendo werden zwingend ein Webserver (meist + dass kivitendo auf ihnen läuft:

  • 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

  • openSUSE LEAP 42.1

  • Fedora 22

2.2.2. Benötigte Perl-Pakete installieren

Zum Betrieb von kivitendo werden zwingend ein Webserver (meist Apache) und ein Datenbankserver (PostgreSQL, mindestens v8.4) - 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:

Seit Version v3.4.0 sind die folgenden Pakete hinzugekommen: + Algorithm::CheckDigits PBKDF2::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, +

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 kivitendo @@ -97,7 +109,9 @@ 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.

2.2.2.1. 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 \
+        installieren.
2.2.2.1. 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 \
@@ -108,19 +122,26 @@
   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
2.2.2.2. Fedora
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:
dnf install httpd mod_fcgid perl-Archive-Zip perl-Clone perl-DBD-Pg \
+
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
2.2.2.2. Fedora
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:
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-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:
cpan Config::Std HTML::Restrict
2.2.2.3. openSUSE
Für openSUSE stehen die meisten der benötigten Perl-Pakete als RPM-Pakete zur Verfügung. Sie können mit folgendem Befehl
+  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:

cpan Config::Std HTML::Restrict

2.2.2.3. openSUSE

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:

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

Zusätzlich müssen einige Pakete aus dem CPAN installiert werden. Dazu können Sie die folgenden Befehle nutzen:

cpan Rose::Db::Object
Zurück Nach oben Weiter
Kapitel 2. Installation und Grundkonfiguration Zum Anfang 2.3. Manuelle Installation des Programmpaketes
\ No newline at end of file + perl-Algorithm-CheckDigits perl-GD perl-Class-XSAccessor postgresql-server

Zusätzlich müssen einige Pakete aus dem CPAN installiert + werden. Dazu können Sie die folgenden Befehle nutzen:

cpan Rose::Db::Object
Zurück Nach oben Weiter
Kapitel 2. Installation und Grundkonfiguration Zum Anfang 2.3. Manuelle Installation des Programmpaketes
\ No newline at end of file diff --git a/doc/html/ch02s03.html b/doc/html/ch02s03.html index 1a1d0e923..13d960836 100644 --- a/doc/html/ch02s03.html +++ b/doc/html/ch02s03.html @@ -1,25 +1,36 @@ - 2.3. Manuelle Installation des Programmpaketes
2.3. Manuelle Installation des Programmpaketes
Zurück Kapitel 2. Installation und Grundkonfiguration Weiter

2.3. Manuelle Installation des Programmpaketes

Der aktuelle Stable-Release, bzw. beta Release wird bei github gehostet und kann - hier heruntergeladen werden.

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

cd /var/www
+   2.3. Manuelle Installation des Programmpaketes
2.3. Manuelle Installation des Programmpaketes
Zurück Kapitel 2. Installation und Grundkonfiguration Weiter
2.3. Manuelle Installation des Programmpaketes
Der aktuelle Stable-Release, bzw. beta Release wird bei github
+      gehostet und kann hier
+      heruntergeladen werden.
Die kivitendo ERP Installationsdatei
+      (kivitendo-erp-3.4.0.tgz) wird im
+      Dokumentenverzeichnis des Webservers (z.B.
+      /var/www/html/,
+      /srv/www/htdocs oder
+      /var/www/) entpackt:
cd /var/www
 tar xvzf kivitendo-erp-3.4.0.tgz
Wechseln Sie in das entpackte Verzeichnis:
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. 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 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
[Anmerkung]Anmerkung
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/
+      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. 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 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
[Anmerkung]Anmerkung
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).
-         
Zurück Nach oben Weiter
2.2. Benötigte Software und Pakete Zum Anfang 2.4. kivitendo-Konfigurationsdatei

\ No newline at end of file
+        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).
Zurück Nach oben Weiter
2.2. Benötigte Software und Pakete Zum Anfang 2.4. kivitendo-Konfigurationsdatei

\ No newline at end of file
diff --git a/doc/html/ch02s04.html b/doc/html/ch02s04.html
index 6c61bd655..edd47e956 100644
--- a/doc/html/ch02s04.html
+++ b/doc/html/ch02s04.html
@@ -1,25 +1,26 @@
 
       
-   2.4. kivitendo-Konfigurationsdatei
2.4. kivitendo-Konfigurationsdatei
Zurück Kapitel 2. Installation und Grundkonfiguration Weiter
2.4. kivitendo-Konfigurationsdatei
2.4.1. 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
+   2.4. kivitendo-Konfigurationsdatei
2.4. kivitendo-Konfigurationsdatei
Zurück Kapitel 2. Installation und Grundkonfiguration Weiter
2.4. kivitendo-Konfigurationsdatei
2.4.1. 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.
Als Vorlage dient die Datei
         config/kivitendo.conf.default (kurz: "die
         Default-Datei"):
$ cp config/kivitendo.conf.default config/kivitendo.conf
Die Default-Datei wird immer zuerst eingelesen. Werte, die in
         der Hauptkonfigurationsdatei stehen, überschreiben die Werte aus der
         Default-Datei. Die Hauptkonfigurationsdatei muss also nur die
         Abschnitte und Werte enthalten, die von denen der Default-Datei
-        abweichen.
[Anmerkung]Anmerkung

-          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
+        abweichen.
[Anmerkung]Anmerkung
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.
Die Konfiguration ist ferner serverabhängig, d.h. für alle
         Mandaten, bzw. Datenbanken gleich.
2.4.2. Abschnitte und Parameter
Die Konfigurationsdatei besteht aus mehreren Teilen, die
         entsprechend kommentiert sind:

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] + 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.

2.4.3. Versionen vor 2.6.3

In älteren kivitendo Versionen gab es im Verzeichnis config die Dateien authentication.pl und diff --git a/doc/html/ch02s05.html b/doc/html/ch02s05.html index 85fa4ff71..97c4ad50c 100644 --- a/doc/html/ch02s05.html +++ b/doc/html/ch02s05.html @@ -1,8 +1,10 @@ - 2.5. Anpassung der PostgreSQL-Konfiguration

2.5. Anpassung der PostgreSQL-Konfiguration
Zurück Kapitel 2. Installation und Grundkonfiguration Weiter

2.5. Anpassung der PostgreSQL-Konfiguration

PostgreSQL muss auf verschiedene Weisen angepasst werden.

2.5.1. Zeichensätze/die Verwendung von Unicode/UTF-8

kivitendo setzt zwingend voraus, dass die Datenbank Unicode/UTF-8 als Encoding einsetzt. Bei aktuellen Serverinstallationen - braucht man hier meist nicht einzugreifen.

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:

su postgres
+   2.5. Anpassung der PostgreSQL-Konfiguration
2.5. Anpassung der PostgreSQL-Konfiguration
Zurück Kapitel 2. Installation und Grundkonfiguration Weiter
2.5. Anpassung der PostgreSQL-Konfiguration
PostgreSQL muss auf verschiedene Weisen angepasst werden.
2.5.1. Zeichensätze/die Verwendung von Unicode/UTF-8
kivitendo setzt zwingend voraus, dass die Datenbank
+        Unicode/UTF-8 als Encoding einsetzt. Bei aktuellen
+        Serverinstallationen braucht man hier meist nicht einzugreifen.
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:
su postgres
 echo '\l' | psql
 exit 
Andernfalls ist es notwendig, einen neuen Datenbankcluster mit
         Unicode-Encoding anzulegen und diesen zu verwenden. Unter Debian und
@@ -21,25 +23,27 @@ exit

Andernfalls ist es notwendig, einen neuen Datenbankcluster mit 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 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
+        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

2.5.3. Erweiterung für servergespeicherte Prozeduren

In der Datenbank template1 muss die Unterstützung für servergespeicherte Prozeduren eingerichet werden. Melden Sie sich dafür als Benutzer “postgres” an der Datenbank an: 

su - postgres
-psql template1

- - führen Sie die folgenden Kommandos aus:

CREATE EXTENSION IF NOT EXISTS plpgsql;
+psql template1

führen Sie die folgenden Kommandos aus:

CREATE EXTENSION IF NOT EXISTS plpgsql;
 \q
[Anmerkung]Anmerkung

- 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';
+                  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

2.5.4. Datenbankbenutzer anlegen

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

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
+        können:
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 “kivitendo” bzw.
-        den hier gewählten Benutzernamen.
Zurück Nach oben Weiter
2.4. kivitendo-Konfigurationsdatei Zum Anfang 2.6. Webserver-Konfiguration
\ No newline at end of file + Sie den evtl. voreingestellten Benutzer “postgres” auf “kivitendo” + bzw. den hier gewählten Benutzernamen.

Zurück Nach oben Weiter
2.4. kivitendo-Konfigurationsdatei Zum Anfang 2.6. Webserver-Konfiguration
\ No newline at end of file diff --git a/doc/html/ch02s06.html b/doc/html/ch02s06.html index a85dde1ae..5621c4194 100644 --- a/doc/html/ch02s06.html +++ b/doc/html/ch02s06.html @@ -19,9 +19,9 @@ Alias /kivitendo-erp/ /var/www/kivitendo-erp/ Deny from All </Directory>

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

[Anmerkung]Anmerkung

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 + 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 Style-Sheets nicht ausgeliefert. In solchen Fällen hat es oft geholfen, die folgende Option in die Konfiguration aufzunehmen:

EnableSendfile Off

2.6.2. Konfiguration für FastCGI/FCGI

2.6.2.1. Was ist FastCGI?

Direkt aus Wikipedia kopiert:

@@ -45,10 +45,12 @@ Alias /kivitendo-erp/ /var/www/kivitendo-erp/ wird nur die eigentliche Programmlogik ausgeführt.

2.6.2.3. Getestete Kombinationen aus Webservern und Plugin

Folgende Kombinationen sind getestet:

  • Apache 2.2.11 (Ubuntu) und mod_fcgid.

  • Apache 2.2.11 / 2.2.22 (Ubuntu) und mod_fastcgi.

  • Apache 2.4.7 (Ubuntu 14.04.2 LTS) und mod_fcgid.

Dabei wird mod_fcgid empfohlen, weil mod_fastcgi seit geraumer Zeit nicht mehr weiter entwickelt wird. Im Folgenden wird auf mod_fastcgi nicht mehr explizit eingegangen.

Als Perl Backend wird das Modul FCGI.pm - verwendet.

[Warnung]Warnung

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:

force install M/MS/MSTROUT/FCGI-0.68.tar.gz

2.6.2.4. Konfiguration des Webservers

Bevor Sie versuchen, eine kivitendo Installation unter FCGI + verwendet.

[Warnung]Warnung

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:

force install M/MS/MSTROUT/FCGI-0.68.tar.gz

2.6.2.4. Konfiguration des Webservers

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 @@ -71,7 +73,9 @@ Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/ <DirectoryMatch /path/to/kivitendo-erp/users> Require all granted -</DirectoryMatch>

[Warnung]Warnung

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:

+</DirectoryMatch>
[Warnung]Warnung

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 @@ -103,9 +107,10 @@ AliasMatch ^/url/for/kivitendo-erp-fcgid/[^/]+\.pl /path/to/kivitendo-erp/dispat Alias /url/for/kivitendo-erp-fcgid/ /path/to/kivitendo-erp/

Dann ist unter /url/for/kivitendo-erp/ die normale Version erreichbar, und unter /url/for/kivitendo-erp-fcgid/ die - FastCGI-Version.

2.6.3. 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) + FastCGI-Version.

2.6.3. 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)

Zurück Nach oben Weiter
2.5. Anpassung der PostgreSQL-Konfiguration Zum Anfang 2.7. Der Task-Server
\ No newline at end of file diff --git a/doc/html/ch02s07.html b/doc/html/ch02s07.html index 2e4cefe54..124e2d5f4 100644 --- a/doc/html/ch02s07.html +++ b/doc/html/ch02s07.html @@ -1,10 +1,14 @@ - 2.7. Der Task-Server
2.7. Der Task-Server
Zurück Kapitel 2. Installation und Grundkonfiguration Weiter

2.7. Der Task-Server

Der Task-Server ist ein Prozess, der im Hintergrund läuft, in regelmäßigen Abständen nach abzuarbeitenden Aufgaben sucht und - diese zu festgelegten Zeitpunkten abarbeitet (ähnlich wie Cron). Dieser Prozess wird 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.

2.7.1. Verfügbare und notwendige Konfigurationsoptionen

Die Konfiguration erfolgt über den Abschnitt + 2.7. Der Task-Server

2.7. Der Task-Server
Zurück Kapitel 2. Installation und Grundkonfiguration Weiter

2.7. Der Task-Server

Der Task-Server ist ein Prozess, der im Hintergrund läuft, in + regelmäßigen Abständen nach abzuarbeitenden Aufgaben sucht und diese zu + festgelegten Zeitpunkten abarbeitet (ähnlich wie Cron). Dieser Prozess + wird 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.

2.7.1. Verfügbare und notwendige Konfigurationsoptionen

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

@@ -17,16 +21,21 @@ ist es erforderlich, hier denselben Systembenutzer einzutragen, unter dem auch der Webserver läuft.

debug -

Schaltet Debug-Informationen an und aus.

2.7.2. 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 +

Schaltet Debug-Informationen an und aus.

2.7.2. 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.

2.7.3. 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 kivitendo-Installationsverzeichnis.

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

2.7.3.1. SystemV-basierende Systeme (z.B. Debian, ältere OpenSUSE, ältere Fedora)

Kopieren Sie die Datei + anstelle eines symbolischen Links verwendet werden können.

2.7.3.1. SystemV-basierende Systeme (z.B. Debian, ältere OpenSUSE, + ältere Fedora)

Kopieren Sie die Datei 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 @@ -39,10 +48,14 @@ insserv kivitendo-task-server

  • Ältere OpenSUSE 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 kivitendo-task-server start

    • 2.7.3.3. systemd-basierende Systeme (z.B. neure OpenSUSE, neuere Fedora, neuere Ubuntu)

    Verlinken Sie die Datei scripts/boot/systemd/kivitendo-task-server.service nach - /etc/systemd/system/. Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile - ExecStart=.... und ExecStop=...). Binden Sie das Script in den Boot-Prozess ein. -

    Alle hierzu benötigten Befehle sehen so aus:

    cd /var/www/kivitendo-erp/scripts/boot/systemd
+          werden:
    service kivitendo-task-server start

    2.7.3.3. systemd-basierende Systeme (z.B. neure OpenSUSE, neuere + Fedora, neuere Ubuntu)

    Verlinken Sie die Datei + scripts/boot/systemd/kivitendo-task-server.service + nach /etc/systemd/system/. Passen Sie in der + kopierten Datei den Pfad zum Task-Server an (Zeile + ExecStart=.... und + ExecStop=...). Binden Sie das Script in den + Boot-Prozess ein.

    Alle hierzu benötigten Befehle sehen so aus:

    cd /var/www/kivitendo-erp/scripts/boot/systemd
 ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/

    Danach kann der Task-Server mit dem folgenden Befehl gestartet werden:

    systemctl start kivitendo-task-server.service

    2.7.4. Wie der Task-Server gestartet und beendet wird

    Der Task-Server wird wie folgt kontrolliert:

    ./scripts/task_server.pl Befehl

    Befehl ist dabei eine der folgenden diff --git a/doc/html/ch02s08.html b/doc/html/ch02s08.html index e5c836671..8f6979b64 100644 --- a/doc/html/ch02s08.html +++ b/doc/html/ch02s08.html @@ -16,11 +16,12 @@ einer Version vor v2.6.0 angelegt werden. Eine Beispielkonfigurationsdatei config/kivitendo.conf.default existiert, die als - Vorlage benutzt werden kann.

    2.8.2. Administratorpasswort

    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].

    2.8.3. Authentifizierungsdatenbank

    Die Verbindung zur Authentifizierungsdatenbank wird mit den + Vorlage benutzt werden kann.

    2.8.2. Administratorpasswort

    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].

    2.8.3. Authentifizierungsdatenbank

    Die Verbindung zur Authentifizierungsdatenbank wird mit den Parametern in [authentication/database] konfiguriert. Hier sind die folgenden Parameter anzugeben:

    host diff --git a/doc/html/ch02s09.html b/doc/html/ch02s09.html index e3d7cf67e..09b077d0e 100644 --- a/doc/html/ch02s09.html +++ b/doc/html/ch02s09.html @@ -1,47 +1,83 @@ - 2.9. Mandanten-, Benutzer- und Gruppenverwaltung
    2.9. Mandanten-, Benutzer- und Gruppenverwaltung
    Zurück Kapitel 2. Installation und Grundkonfiguration Weiter

    2.9. Mandanten-, Benutzer- und Gruppenverwaltung

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

    + 2.9. Mandanten-, Benutzer- und Gruppenverwaltung

    2.9. Mandanten-, Benutzer- und Gruppenverwaltung
    Zurück Kapitel 2. Installation und Grundkonfiguration Weiter

    2.9. Mandanten-, Benutzer- und Gruppenverwaltung

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

    http://localhost/kivitendo-erp/controller.pl?action=Admin/login

    Verwenden Sie zur Anmeldung das Passwort, das Sie in der Datei - config/kivitendo.conf eingetragen haben.

    2.9.1. Zusammenhänge

    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.

    2.9.2. 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:

    1. Datenbank anlegen

    2. Gruppen anlegen

    3. Benutzer anlegen und Gruppen als Mitglied zuordnen

    4. Mandanten anlegen und Gruppen sowie Benutzer zuweisen

    2.9.3. Datenbanken anlegen

    Zuerst muss eine Datenbank angelegt werden. Verwenden Sie für + config/kivitendo.conf eingetragen haben.

    2.9.1. Zusammenhänge

    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.

    2.9.2. 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:

    1. Datenbank anlegen

    2. Gruppen anlegen

    3. Benutzer anlegen und Gruppen als Mitglied zuordnen

    4. Mandanten anlegen und Gruppen sowie Benutzer zuweisen

    2.9.3. Datenbanken anlegen

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

    2.9.4. Gruppen anlegen

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

    Benutzergruppen 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").

    2.9.5. Benutzer anlegen

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

    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").

    2.9.6. 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").

    Zurück Nach oben Weiter
    2.8. Benutzerauthentifizierung und Administratorpasswort Zum Anfang 2.10. Drucker- und Systemverwaltung
    \ No newline at end of file + Mitglieder dieser Gruppe Zugriff haben sollen.

    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").

    2.9.5. Benutzer anlegen

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

    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").

    2.9.6. 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").

    Zurück Nach oben Weiter
    2.8. Benutzerauthentifizierung und Administratorpasswort Zum Anfang 2.10. Drucker- und Systemverwaltung
    \ No newline at end of file diff --git a/doc/html/ch02s10.html b/doc/html/ch02s10.html index 686808f54..df85a433a 100644 --- a/doc/html/ch02s10.html +++ b/doc/html/ch02s10.html @@ -1,9 +1,23 @@ - 2.10. Drucker- und Systemverwaltung
    2.10. Drucker- und Systemverwaltung
    Zurück Kapitel 2. Installation und Grundkonfiguration Weiter

    2.10. Drucker- und Systemverwaltung

    Im Administrationsmenü gibt es ferner noch die beiden Menüpunkte Druckeradministration und System.

    2.10.1. 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.

    2.10.2. System sperren / entsperren

    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.

    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.

    Zurück Nach oben Weiter
    2.9. Mandanten-, Benutzer- und Gruppenverwaltung Zum Anfang 2.11. E-Mail-Versand aus kivitendo heraus
    \ No newline at end of file + 2.10. Drucker- und Systemverwaltung
    2.10. Drucker- und Systemverwaltung
    Zurück Kapitel 2. Installation und Grundkonfiguration Weiter

    2.10. Drucker- und Systemverwaltung

    Im Administrationsmenü gibt es ferner noch die beiden Menüpunkte + Druckeradministration und System.

    2.10.1. 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.

    2.10.2. System sperren / entsperren

    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.

    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.

    Zurück Nach oben Weiter
    2.9. Mandanten-, Benutzer- und Gruppenverwaltung Zum Anfang 2.11. E-Mail-Versand aus kivitendo heraus
    \ No newline at end of file diff --git a/doc/html/ch02s11.html b/doc/html/ch02s11.html index c5838fd3a..fb206aa25 100644 --- a/doc/html/ch02s11.html +++ b/doc/html/ch02s11.html @@ -1,30 +1,54 @@ - 2.11. E-Mail-Versand aus kivitendo heraus
    2.11. E-Mail-Versand aus kivitendo heraus
    Zurück Kapitel 2. Installation und Grundkonfiguration Weiter

    2.11. 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]'.

    2.11.1. 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.

    2.11.2. 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 + 2.11. E-Mail-Versand aus kivitendo heraus

    2.11. E-Mail-Versand aus kivitendo heraus
    Zurück Kapitel 2. Installation und Grundkonfiguration Weiter

    2.11. 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]'.

    2.11.1. 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.

    2.11.2. 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'

    +

    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.

    +

    Portnummer. Der Standardwert hängt von der verwendeten + Verschlüsselungsmethode ab. Gilt 'security = + none' oder 'security = tls', so ist + 25 die Standardportnummer. Für 'security = + ssl' ist 465 die Portnummer. Muss normalerweise nicht + geändert werden.

    security -

    Wahl der zu verwendenden Verschlüsselung der Verbindung mit dem Server. Standardwert ist - 'none', wodurch keine Verschlüsselung verwendet wird. Mit 'tls' wird TLS-Verschlüsselung - eingeschaltet, und mit 'ssl' wird Verschlüsselung via SSL eingeschaltet. Achtung: Für - 'tls' und 'ssl' werden zusätzliche Perl-Module benötigt (siehe unten).

    - login und password -

    Falls der E-Mail-Server eine Authentifizierung verlangt, so können mit diesen zwei Parametern der Benutzername - und das Passwort angegeben werden. Wird Authentifizierung verwendet, so sollte aus Sicherheitsgründen auch eine Form von - Verschlüsselung aktiviert werden.

    Zurück Nach oben Weiter
    2.10. Drucker- und Systemverwaltung Zum Anfang 2.12. Drucken mit kivitendo
    \ No newline at end of file +

    Wahl der zu verwendenden Verschlüsselung der Verbindung + mit dem Server. Standardwert ist 'none', + wodurch keine Verschlüsselung verwendet wird. Mit + 'tls' wird TLS-Verschlüsselung eingeschaltet, + und mit 'ssl' wird Verschlüsselung via SSL + eingeschaltet. Achtung: Für 'tls' und + 'ssl' werden zusätzliche Perl-Module benötigt + (siehe unten).

    + login und + password +

    Falls der E-Mail-Server eine Authentifizierung verlangt, + so können mit diesen zwei Parametern der Benutzername und das + Passwort angegeben werden. Wird Authentifizierung verwendet, so + sollte aus Sicherheitsgründen auch eine Form von Verschlüsselung + aktiviert werden.

    Zurück Nach oben Weiter
    2.10. Drucker- und Systemverwaltung Zum Anfang 2.12. Drucken mit kivitendo
    \ No newline at end of file diff --git a/doc/html/ch02s12.html b/doc/html/ch02s12.html index b6f9e1c30..509c72063 100644 --- a/doc/html/ch02s12.html +++ b/doc/html/ch02s12.html @@ -1,8 +1,9 @@ - 2.12. Drucken mit kivitendo
    2.12. Drucken mit kivitendo
    Zurück Kapitel 2. Installation und Grundkonfiguration Weiter

    2.12. Drucken mit kivitendo

    Das Drucksystem von kivitendo benutzt von Haus aus LaTeX-Vorlagen. Um drucken zu können, braucht der Server ein geeignetes - LaTeX System. Am einfachsten ist dazu eine texlive Installation. Unter debianoiden Betriebssystemen installiert man - die Pakete mit:

    + 2.12. Drucken mit kivitendo

    2.12. Drucken mit kivitendo
    Zurück Kapitel 2. Installation und Grundkonfiguration Weiter

    2.12. Drucken mit kivitendo

    Das Drucksystem von kivitendo benutzt von Haus aus LaTeX-Vorlagen. + Um drucken zu können, braucht der Server ein geeignetes LaTeX System. Am + einfachsten ist dazu eine texlive Installation. Unter + debianoiden Betriebssystemen installiert man die Pakete mit:

    apt-get install texlive-base-bin texlive-latex-recommended texlive-fonts-recommended \
   exlive-latex-extra texlive-lang-german texlive-generic-extra

    Für Fedora benötigen Sie die folgenden Pakete:

    @@ -13,131 +14,183 @@ 

    zypper install texlive-collection-latex texlive-collection-latexextra \
   texlive-collection-latexrecommended texlive-collection-langgerman \
   texlive-collection-langenglish

    -

    kivitendo bringt drei alternative Vorlagensätze mit:

    • RB

    • f-tex

    • rev-odt

    Der ehemalige Druckvorlagensatz "Standard" wurde mit der Version 3.3 entfernt, da er nicht mehr gepflegt wurde.

    2.12.1. Vorlagenverzeichnis anlegen

    Es lässt sich ein initialer Vorlagensatz erstellen. Die LaTeX-System-Abhängigkeiten hierfür kann man prüfen mit:

    ./scripts/installation_check.pl -lv

    Der Angemeldete Benutzer muss in einer Gruppe sein, die über das - Recht "Konfiguration -> Mandantenverwaltung" verfügt. Siehe auch Abschnitt 2.9.4, „Gruppen anlegen“. -

    Im Userbereich lässt sich unter: - "System -> - Mandantenverwaltung -> Verschiedenes" die Option - "Neue Druckvorlagen aus Vorlagensatz erstellen" auswählen.

    1. - Vorlagen auswählen: Wählen Sie hier den Vorlagensatz aus, der kopiert werden soll - (RB, f-tex oder odt-rev.)

    2. - Neuer Name: Der Verzeichnisname für den neuen Vorlagensatz. Dieser kann im Rahmen der üblichen - Bedingungen für Verzeichnisnamen frei gewählt werden.

    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] -

    2.12.2. Der Druckvorlagensatz RB

    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"

    2.12.3. f-tex

    Ein Vorlagensatz, der in wenigen Minuten alle Dokumente zur Verfügung stellt.

    2.12.3.1. 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 - "bgPdfFirstPageOnly" 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 "bgPdfEmailOnly" 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.

    2.12.3.2. Die Installation

    • Vorlagenverzeichnis mit Option f-tex anlegen, siehe: Vorlagenverzeichnis anlegen. 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 "settings" 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. -

    2.12.3.3. 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.

    2.12.3.4. Bruttopreise für Endverbraucher

    Der auszuweisende Bruttopreis wird innerhalb der LaTeX-Umgebung berechnet. Es gibt zwar ein Feld, um bei Aufträgen "alle - Preise Brutto" auszuwählen, aber:

    • hierfür müssen die Preise auch in Brutto in der Datenbank stehen (ja - das lässt sich über die Preisgruppen und die - Zuordung einer Default-Preisgruppe handhaben)

    • man darf beim Anlegen des Vorgangs nicht vergessen, dieses Häkchen zu setzen. (Das ist in der Praxis, wenn man sowohl - Endverbraucher 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.

    2.12.3.5. 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. -

    2.12.4. 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 -einzusetzen. Entsprechende Vorlagen sind deshalb nicht vorhanden. -

    -Inwieweit es möglich ist, für die in Version 3.2.0 neu eingeführten Pflichtenhefte -odt-Vorlagen zu erstellen, sind wir am abklären. -Wenn dies möglich ist, werden wir in Zukunft auch eine odt-Vorlage für Pflichtenhefte -in diesem Vorlagensatz zur Verfügung stellen. -

    -Fehlermeldungen, Anregungen und Wünsche bitte senden an: -empfang@revamp-it.ch -

    2.12.5. 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 +

      kivitendo bringt drei alternative Vorlagensätze mit:

      • RB

      • f-tex

      • rev-odt

      Der ehemalige Druckvorlagensatz "Standard" wurde mit der Version + 3.3 entfernt, da er nicht mehr gepflegt wurde.

      2.12.1. Vorlagenverzeichnis anlegen

      Es lässt sich ein initialer Vorlagensatz erstellen. Die + LaTeX-System-Abhängigkeiten hierfür kann man prüfen mit:

      ./scripts/installation_check.pl -lv

      Der Angemeldete Benutzer muss in einer Gruppe sein, die über das + Recht "Konfiguration -> Mandantenverwaltung" verfügt. Siehe auch + Abschnitt 2.9.4, „Gruppen anlegen“.

      Im Userbereich lässt sich unter: "System + -> Mandantenverwaltung -> + Verschiedenes" die Option "Neue + Druckvorlagen aus Vorlagensatz erstellen" auswählen.

      1. + Vorlagen auswählen: Wählen Sie hier den + Vorlagensatz aus, der kopiert werden soll + (RB, f-tex oder + odt-rev.)

      2. + Neuer Name: Der Verzeichnisname für den + neuen Vorlagensatz. Dieser kann im Rahmen der üblichen Bedingungen + für Verzeichnisnamen frei gewählt werden.

      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] +

      2.12.2. Der Druckvorlagensatz RB

      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"

      2.12.3. f-tex

      Ein Vorlagensatz, der in wenigen Minuten alle Dokumente zur + Verfügung stellt.

      2.12.3.1. 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 + "bgPdfFirstPageOnly" 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 + "bgPdfEmailOnly" 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.

      2.12.3.2. Die Installation

      • Vorlagenverzeichnis mit Option f-tex anlegen, siehe: Vorlagenverzeichnis anlegen. 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 "settings" 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.

      2.12.3.3. 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.

      2.12.3.4. Bruttopreise für Endverbraucher

      Der auszuweisende Bruttopreis wird innerhalb der + LaTeX-Umgebung berechnet. Es gibt zwar ein Feld, um bei Aufträgen + "alle Preise Brutto" auszuwählen, aber:

      • hierfür müssen die Preise auch in Brutto in der Datenbank + stehen (ja - das lässt sich über die Preisgruppen und die + Zuordung einer Default-Preisgruppe handhaben)

      • man darf beim Anlegen des Vorgangs nicht vergessen, dieses + Häkchen zu setzen. (Das ist in der Praxis, wenn man sowohl + Endverbraucher 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.

      2.12.3.5. 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.

      2.12.4. 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 einzusetzen. Entsprechende Vorlagen sind + deshalb nicht vorhanden.

      Inwieweit es möglich ist, für die in Version 3.2.0 neu + eingeführten Pflichtenhefte odt-Vorlagen zu erstellen, sind wir am + abklären. Wenn dies möglich ist, werden wir in Zukunft auch eine + odt-Vorlage für Pflichtenhefte in diesem Vorlagensatz zur Verfügung + stellen.

      Fehlermeldungen, Anregungen und Wünsche bitte senden an: + empfang@revamp-it.ch

      2.12.5. 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: + 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

      + 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

        +

      • 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

        +

        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.

    Zurück Nach oben Weiter
    2.11. E-Mail-Versand aus kivitendo heraus Zum Anfang 2.13. OpenDocument-Vorlagen
    \ No newline at end of file diff --git a/doc/html/ch02s13.html b/doc/html/ch02s13.html index 236dbaa9e..276e3af03 100644 --- a/doc/html/ch02s13.html +++ b/doc/html/ch02s13.html @@ -28,18 +28,23 @@ 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.

    [Anmerkung]Anmerkung

    - Für die Verbindung zu 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 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 + sind.

    [Anmerkung]Anmerkung

    Für die Verbindung zu 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 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 OpenOffice neu gestartet und die Konvertierung mit Hilfe eines Makros durchgeführt. Dieses Makro muss in der Dokumentenvorlage enthalten sein und @@ -58,7 +63,76 @@ users/.openoffice

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

    Zurück Nach oben Weiter
    2.12. Drucken mit kivitendo Zum Anfang 2.14. Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung: + sein. Dieses wurde bereits erledigt (siehe Manuelle Installation des Programmpaketes), kann aber erneut + überprüft werden, wenn die Konvertierung nach PDF fehlschlägt.

    2.13.1. 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):

    2.13.1.1. Bezeichnung der Vorlagen

    Rechnung: invoice_besr.odt, Auftrag: + sales_order_besr.odt

    2.13.1.2. 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

    2.13.1.3. 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

    2.13.1.4. 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

      +

    • + 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.

    2.13.1.5. 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.

    2.13.1.6. 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.

    Zurück Nach oben Weiter
    2.12. Drucken mit kivitendo Zum Anfang 2.14. Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung: EUR
    \ No newline at end of file diff --git a/doc/html/ch02s14.html b/doc/html/ch02s14.html index 375942ab5..ebbafbf58 100644 --- a/doc/html/ch02s14.html +++ b/doc/html/ch02s14.html @@ -2,9 +2,11 @@ 2.14. Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung: EUR
    2.14. Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung: EUR
    Zurück Kapitel 2. Installation und Grundkonfiguration Weiter

    2.14. Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung: - EUR

    2.14.1. 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 + EUR

    2.14.1. 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.

    2.14.2. Konfigurationsparameter

    Es gibt drei Parameter, die die Gewinnermittlungsart, @@ -39,13 +41,12 @@ 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 - + 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).

    2.14.4. 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 diff --git a/doc/html/ch02s15.html b/doc/html/ch02s15.html index ee622f3d3..eb816d324 100644 --- a/doc/html/ch02s15.html +++ b/doc/html/ch02s15.html @@ -17,20 +17,24 @@ anzulegen und zu konfigurieren. Zuerst wird in System -> Kontenübersicht -> Konto - erfassen das Konto angelegt.

    - 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. -

    - 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. -

    - 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. -

    - Als Letztes sollte die Steuerliste unter System -> Steuern -> - Bearbeiten kontrolliert werden. Zum Vergleich der Screenshot. -

    Zurück Nach oben Weiter
    2.14. Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung: + erfassen das Konto angelegt.

    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.

    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.

    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.

    Als Letztes sollte die Steuerliste unter + System -> Steuern -> + Bearbeiten kontrolliert werden. Zum + Vergleich der Screenshot.

    Zurück Nach oben Weiter
    2.14. Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung: EUR Zum Anfang 2.16. Verhalten des Bilanzberichts
    \ No newline at end of file diff --git a/doc/html/ch02s16.html b/doc/html/ch02s16.html index 44f73c15d..a86e45f0b 100644 --- a/doc/html/ch02s16.html +++ b/doc/html/ch02s16.html @@ -1,21 +1,20 @@ - 2.16. Verhalten des Bilanzberichts
    2.16. Verhalten des Bilanzberichts
    Zurück Kapitel 2. Installation und Grundkonfiguration Weiter

    2.16. 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. -

    Zurück Nach oben Weiter
    2.15. SKR04 19% Umstellung für innergemeinschaftlichen Erwerb Zum Anfang 2.17. Einstellungen pro Mandant
    \ No newline at end of file + 2.16. Verhalten des Bilanzberichts
    2.16. Verhalten des Bilanzberichts
    Zurück Kapitel 2. Installation und Grundkonfiguration Weiter

    2.16. 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.

    Zurück Nach oben Weiter
    2.15. SKR04 19% Umstellung für innergemeinschaftlichen Erwerb Zum Anfang 2.17. Einstellungen pro Mandant
    \ No newline at end of file diff --git a/doc/html/ch02s17.html b/doc/html/ch02s17.html index f97a97c77..006b1ad1b 100644 --- a/doc/html/ch02s17.html +++ b/doc/html/ch02s17.html @@ -1,20 +1,16 @@ - 2.17. Einstellungen pro Mandant
    2.17. Einstellungen pro Mandant
    Zurück Kapitel 2. Installation und Grundkonfiguration Weiter

    2.17. 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.

    Zurück Nach oben Weiter
    2.16. Verhalten des Bilanzberichts Zum Anfang 2.18. kivitendo ERP verwenden
    \ No newline at end of file + 2.17. Einstellungen pro Mandant
    2.17. Einstellungen pro Mandant
    Zurück Kapitel 2. Installation und Grundkonfiguration Weiter

    2.17. 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.

    Zurück Nach oben Weiter
    2.16. Verhalten des Bilanzberichts Zum Anfang 2.18. kivitendo ERP verwenden
    \ No newline at end of file diff --git a/doc/html/ch03.html b/doc/html/ch03.html index b86a6a30c..6b408683c 100644 --- a/doc/html/ch03.html +++ b/doc/html/ch03.html @@ -12,8 +12,8 @@ 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 + 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 @@ -38,42 +38,53 @@ Konfiguriert wird dies in der Konfigurationsdatei config/kivitendo.conf im Abschnitt - [periodic_invoices].

    3.1.3. 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 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: -

    + [periodic_invoices].

    3.1.3. 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 @@ -83,38 +94,51 @@ %B

    Der ausgeschriebene Monatsname.

    %C -

    Das Jahrhundert (Jahr/100) als eine zweistellige Zahl.

    +

    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.

    +

    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.

    +

    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.

    +

    Der Wochentag als Zahl zwischen 1 und 7 inklusive, wobei + die 1 dem Montag entspricht.

    %U -

    Die Wochennummer als Zahl zwischen 00 und 53 inklusive, wobei der erste Sonntag im Jahr das Startdatum von Woche 01 ist.

    +

    Die Wochennummer als Zahl zwischen 00 und 53 inklusive, + wobei der erste Sonntag im Jahr das Startdatum von Woche 01 + ist.

    %V -

    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.

    +

    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.

    %w -

    Der Wochentag als Zahl zwischen 0 und 6 inklusive, wobei die 0 dem Sonntag entspricht.

    +

    Der Wochentag als Zahl zwischen 0 und 6 inklusive, wobei + die 0 dem Sonntag entspricht.

    %W -

    Die Wochennummer als Zahl zwischen 00 und 53 inklusive, wobei der erste Montag im Jahr das Startdatum von Woche 01 ist.

    +

    Die Wochennummer als Zahl zwischen 00 und 53 inklusive, + wobei der erste Montag im Jahr das Startdatum von Woche 01 + ist.

    %y -

    Das Jahr als zweistellige Zahl zwischen 00 und 99 inklusive.

    +

    Das Jahr als zweistellige Zahl zwischen 00 und 99 + inklusive.

    %Y

    Das Jahr als vierstellige Zahl.

    %% -

    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%> - +

    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%>

    3.1.4. 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 diff --git a/doc/html/ch03s02.html b/doc/html/ch03s02.html index 8aa8432f1..d2ea207ed 100644 --- a/doc/html/ch03s02.html +++ b/doc/html/ch03s02.html @@ -1,5 +1,6 @@ - 3.2. Bankerweiterung

    3.2. Bankerweiterung
    Zurück Kapitel 3. Features und Funktionen Weiter

    3.2. Bankerweiterung

    3.2.1. Einführung

    Die Beschreibung der Bankerweiterung befindet sich derzeit noch im Wiki und soll von dort später hierhin übernommen werden:

    + 3.2. Bankerweiterung

    3.2. Bankerweiterung
    Zurück Kapitel 3. Features und Funktionen Weiter

    3.2. Bankerweiterung

    3.2.1. Einführung

    Die Beschreibung der Bankerweiterung befindet sich derzeit noch + im Wiki und soll von dort später hierhin übernommen werden:

    http://redmine.kivitendo-premium.de/projects/forum/wiki/Bankerweiterung

    Zurück Nach oben Weiter
    Kapitel 3. Features und Funktionen Zum Anfang 3.3. Dokumentenvorlagen und verfügbare Variablen
    \ No newline at end of file diff --git a/doc/html/ch03s03.html b/doc/html/ch03s03.html index 8311b8ffe..bf13da09c 100644 --- a/doc/html/ch03s03.html +++ b/doc/html/ch03s03.html @@ -121,8 +121,8 @@ template_meta.language.description

    Beschreibung der verwendeten Sprache

    template_meta.language.template_code -

    Vorlagenkü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.

    template_meta.language.output_numberformat

    Zahlenformat der verwendeten Sprache in der Form "1.000,00". Experimentell! Nur @@ -347,7 +347,8 @@ delivery_term.description

    Beschreibung der Lieferbedingung

    delivery_term.description_long -

    Langtext bzw. übersetzter Langtext der Lieferbedingung

    3.3.8. Variablen in Rechnungen

    3.3.8.1. Allgemeine Variablen

    +

    Langtext bzw. übersetzter Langtext der + Lieferbedingung

    3.3.8. Variablen in Rechnungen

    3.3.8.1. Allgemeine Variablen

    creditremaining

    Verbleibender Kredit

    currency @@ -404,13 +405,16 @@ description

    Artikelbeschreibung

    cusordnumber_oe -

    Bestellnummer des Kunden aus dem Auftrag, aus dem der Posten ursprünglich stammt (nur Verkauf)

    +

    Bestellnummer des Kunden aus dem Auftrag, aus dem der + Posten ursprünglich stammt (nur Verkauf)

    discount

    Rabatt als Betrag

    discount_sub

    Zwischensumme mit Rabatt

    donumber_do -

    Lieferscheinnummer des Lieferscheins, aus dem die Position ursprünglich stammt, wenn die Rechnung im Rahmen des Workflows aus einem Lieferschein erstellt wurde.

    +

    Lieferscheinnummer des Lieferscheins, aus dem die + Position ursprünglich stammt, wenn die Rechnung im Rahmen des + Workflows aus einem Lieferschein erstellt wurde.

    drawing

    Zeichnung

    ean @@ -424,7 +428,15 @@ microfiche

    Mikrofilm

    netprice -

    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.

    +

    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.

    nodiscount_linetotal

    Zeilensumme ohne Rabatt

    nodiscount_sub @@ -432,7 +444,12 @@ number

    Artikelnummer

    ordnumber_oe -

    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.

    +

    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.

    p_discount

    Rabatt in Prozent

    partnotes @@ -462,11 +479,16 @@ tax_rate

    Steuersatz

    transdate_do -

    Datum des Lieferscheins, wenn die Rechnung im Rahmen des Workflows aus einem Lieferschein stammte.

    +

    Datum des Lieferscheins, wenn die Rechnung im Rahmen des + Workflows aus einem Lieferschein stammte.

    transdate_oe -

    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.

    +

    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.

    +

    Datum des Angebots, wenn die Position im Rahmen des + Workflows aus einem Angebot stammte.

    unit

    Einheit

    weight @@ -496,7 +518,9 @@ number_of_employees definiert, die die Anzahl der Mitarbeiter des Unternehmens enthält. Diese Variable steht dann unter dem Namen vc_cvar_number_of_employees zur - Verfügung.

    3.3.9. Variablen in Mahnungen und Rechnungen über Mahngebühren

    3.3.9.1. Namen der Vorlagen

    Die Namen der Vorlagen werden im System-Menü vom Benutzer + Verfügung.

    Die benutzerdefinierten Variablen der Lieferadressen stehen + unter einem ähnlichen Namensschema zur Verfügung. Hier lautet der + Präfix shiptocvar_.

    3.3.9. Variablen in Mahnungen und Rechnungen über Mahngebühren

    3.3.9.1. Namen der Vorlagen

    Die Namen der Vorlagen werden im System-Menü vom Benutzer eingegeben. Wird für ein Mahnlevel die Option zur automatischen Erstellung einer Rechnung über die Mahngebühren und Zinsen aktiviert, so wird der Name der Vorlage für diese Rechnung aus dem @@ -579,7 +603,7 @@ invdate

    Rechnungsdatum

    invnumber -

    Rechnungsnummer

    3.3.10. Variablen in anderen Vorlagen

    3.3.10.1. Einführung

    Die Variablen in anderen Vorlagen sind ähnlich wie in der +

    Rechnungsnummer

    3.3.10. Variablen in anderen Vorlagen

    3.3.10.1. Einführung

    Die Variablen in anderen Vorlagen sind ähnlich wie in der Rechnung. Allerdings heißen die Variablen, die mit inv beginnen, jetzt anders. Bei den Angeboten fangen sie mit quo für "quotation" an: @@ -683,10 +707,13 @@ ... <%end%>

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

    Handelt es sich bei der benannten Variable um ein Array, also um einen Variablennamen, über den man mit - <%foreach variablenname%> iteriert, so wird mit diesem Konstrukt darauf getestet, ob das Array Elemente - enthält. Somit würde im folgenden Beispiel nur dann eine Liste von Zahlungseingängen samt ihrer Überschrift "Zahlungseingänge" - ausgegeben, wenn tatsächlich welche getätigt wurden:

    <%if payment%>
+          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%> €
diff --git a/doc/html/ch03s05.html b/doc/html/ch03s05.html
index c8612241e..e8a07a86a 100644
--- a/doc/html/ch03s05.html
+++ b/doc/html/ch03s05.html
@@ -1,27 +1,29 @@
 
       
    3.5. Mandantenkonfiguration Lager
    3.5. Mandantenkonfiguration Lager
    Zurück Kapitel 3. Features und Funktionen Weiter
    3.5. 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.
-       
    • 
-                  Auslagern über Standardlagerplatz 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.
-            
    • 
-                  Auslagern ohne Bestandsprüfung 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:
-         
    • 
-                  Standard-Lagerplatz Ist dieser konfiguriert, wird dies auch als Standard-Voreinstellung bei der Neuerfassung von
-          Stammdaten-> Waren / Dienstleistung / Erzeugnis verwendet.
-          
    • 
-                  Standard-Lagerplatz verwenden, falls keiner in Stammdaten definiert Wird beim 'Auslagern über Standardlagerplatz'
-          keine Standardlagerplatz zu der Ware gefunden, so wird mit dieser Option einfach der Standardlagerplatz verwendet.
-          
    Zurück Nach oben Weiter
    3.4. Excel-Vorlagen Zum Anfang Kapitel 4. Entwicklerdokumentation
    
\ No newline at end of file
+
+       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. 
+
+      
    • 
+                  Auslagern über Standardlagerplatz 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.
    • 
+                  Auslagern ohne Bestandsprüfung 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: 
+
+      
    • 
+                  Standard-Lagerplatz Ist dieser konfiguriert,
+          wird dies auch als Standard-Voreinstellung bei der Neuerfassung von
+          Stammdaten-> Waren / Dienstleistung / Erzeugnis verwendet.
    • 
+                  Standard-Lagerplatz verwenden, falls keiner in
+          Stammdaten definiert Wird beim 'Auslagern über
+          Standardlagerplatz' keine Standardlagerplatz zu der Ware gefunden,
+          so wird mit dieser Option einfach der Standardlagerplatz
+          verwendet.
    Zurück Nach oben Weiter
    3.4. Excel-Vorlagen Zum Anfang Kapitel 4. Entwicklerdokumentation
    \ No newline at end of file diff --git a/doc/html/ch04.html b/doc/html/ch04.html index d365e65a5..7a999076a 100644 --- a/doc/html/ch04.html +++ b/doc/html/ch04.html @@ -1,6 +1,6 @@ - Kapitel 4. Entwicklerdokumentation
    Kapitel 4. Entwicklerdokumentation
    Zurück   Weiter

    Kapitel 4. Entwicklerdokumentation

    4.1. Globale Variablen

    4.1.1. Wie sehen globale Variablen in Perl aus?

    Globale Variablen liegen in einem speziellen namespace namens + Kapitel 4. Entwicklerdokumentation

    Kapitel 4. Entwicklerdokumentation
    Zurück   Weiter

    Kapitel 4. Entwicklerdokumentation

    4.1. Globale Variablen

    4.1.1. Wie sehen globale Variablen in Perl aus?

    Globale Variablen liegen in einem speziellen namespace namens "main", der von überall erreichbar ist. Darüber hinaus sind bareword globs global und die meisten speziellen Variablen sind... speziell.

    Daraus ergeben sich folgende Formen:

    @@ -25,7 +25,7 @@ $PACKAGE::form.

    local $form

    Alle Änderungen an $form werden am Ende - des scopes zurückgesetzt

    4.1.2. Warum sind globale Variablen ein Problem?

    Das erste Problem ist FCGI™.

    + des scopes zurückgesetzt

    4.1.2. Warum sind globale Variablen ein Problem?

    Das erste Problem ist FCGI™.

    SQL-Ledger™ hat fast alles im globalen namespace abgelegt, und erwartet, dass es da auch wiederzufinden ist. Unter FCGI™ müssen diese Sachen aber wieder @@ -39,7 +39,7 @@ 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.

    4.1.3. Kanonische globale Variablen

    Um dieses Problem im Griff zu halten gibt es einige wenige + schnell ein Tippfehler einschleichen.

    4.1.3. 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.

    Diese Variablen sind im Moment die folgenden neun:

    • @@ -62,7 +62,7 @@ $::request

    Damit diese nicht erneut als Müllhalde missbraucht werden, im Folgenden eine kurze Erläuterung der bestimmten vorgegebenen - Eigenschaften (Konventionen):

    4.1.3.1. $::form

    • Ist ein Objekt der Klasse + Eigenschaften (Konventionen):

      4.1.3.1. $::form

      • Ist ein Objekt der Klasse "Form"

      • Wird nach jedem Request gelöscht

      • Muss auch in Tests und Konsolenscripts vorhanden sein.

      • Enthält am Anfang eines Requests die Requestparameter vom User

      • Kann zwar intern über Requestgrenzen ein Datenbankhandle @@ -110,7 +110,7 @@ push @{ $form->{TEMPLATE_ARRAYS}{number} }, $form->{"partnumber_$i"}; push @{ $form->{TEMPLATE_ARRAYS}{description} }, $form->{"description_$i"}; # ... -}

      4.1.3.2. %::myconfig

      • Das einzige Hash unter den globalen Variablen

      • Wird spätestens benötigt wenn auf die Datenbank +}

      4.1.3.2. %::myconfig

      • Das einzige Hash unter den globalen Variablen

      • Wird spätestens benötigt wenn auf die Datenbank zugegriffen wird

      • Wird bei jedem Request neu erstellt.

      • Enthält die Userdaten des aktuellen Logins

      • Sollte nicht ohne Filterung irgendwo gedumpt werden oder extern serialisiert werden, weil da auch der Datenbankzugriff für diesen user drinsteht.

      • Enthält unter anderem Listenbegrenzung vclimit, @@ -122,10 +122,10 @@ überwiegend die Daten, die sich unter Programm -> Einstellungen befinden, bzw. die Informationen über den Benutzer die über die - Administrator-Schnittstelle eingegeben wurden.

      4.1.3.3. $::locale

      • Objekt der Klasse "Locale"

      • Wird pro Request erstellt

      • Muss auch für Tests und Scripte immer verfügbar + Administrator-Schnittstelle eingegeben wurden.

      4.1.3.3. $::locale

      • Objekt der Klasse "Locale"

      • Wird pro Request erstellt

      • Muss auch für Tests und Scripte immer verfügbar sein.

      • Cached intern über Requestgrenzen hinweg benutzte Locales

      Lokalisierung für den aktuellen User. Alle Übersetzungen, - Zahlen- und Datumsformatierungen laufen über dieses Objekt.

      4.1.3.4. $::lxdebug

      • Objekt der Klasse "LXDebug"

      • Wird global gecached

      • Muss immer verfügbar sein, in nahezu allen + Zahlen- und Datumsformatierungen laufen über dieses Objekt.

      4.1.3.4. $::lxdebug

      • Objekt der Klasse "LXDebug"

      • Wird global gecached

      • Muss immer verfügbar sein, in nahezu allen Funktionen

      $::lxdebug stellt Debuggingfunktionen bereit, wie "enter_sub" und @@ -135,14 +135,16 @@ "message" und "dump" mit denen man flott Informationen ins Log (tmp/kivitendo-debug.log) packen kann.

      Beispielsweise so:

      $main::lxdebug->message(0, 'Meine Konfig:' . Dumper (%::myconfig));
-$main::lxdebug->message(0, 'Wer bin ich? Kunde oder Lieferant:' . $form->{vc});

      4.1.3.5. $::auth

      • Objekt der Klasse "SL::Auth"

      • Wird global gecached

      • Hat eine permanente DB Verbindung zur Authdatenbank

      • Wird nach jedem Request resettet.

      +$main::lxdebug->message(0, 'Wer bin ich? Kunde oder Lieferant:' . $form->{vc});

      4.1.3.5. $::auth

      • Objekt der Klasse "SL::Auth"

      • Wird global gecached

      • Hat eine permanente DB Verbindung zur Authdatenbank

      • Wird nach jedem Request resettet.

      $::auth stellt Funktionen bereit um die Rechte des aktuellen Users abzufragen. Obwohl diese Informationen vom aktuellen User abhängen wird das Objekt aus Geschwindigkeitsgründen nur einmal angelegt und dann nach jedem - Request kurz resettet.

      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.

      4.1.3.6. $::lx_office_conf

      • Objekt der Klasse + 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.

      4.1.3.6. $::lx_office_conf

      • Objekt der Klasse "SL::LxOfficeConf"

      • Global gecached

      • Repräsentation der config/kivitendo.conf[.default]-Dateien

      Globale Konfiguration. Configdateien werden zum Start gelesen und danach nicht mehr angefasst. Es ist derzeit nicht geplant, dass @@ -152,16 +154,16 @@ $main::lxdebug->message(0, 'Wer bin ich? Kunde oder Lieferant:' . $form->{ file_name = /tmp/kivitendo-debug.log

      ist der Key file im Programm als $::lx_office_conf->{debug}{file} erreichbar.

      [Warnung]Warnung

      Zugriff auf die Konfiguration erfolgt im Moment über - Hashkeys, sind also nicht gegen Tippfehler abgesichert.

      4.1.3.7. $::instance_conf

      • Objekt der Klasse + Hashkeys, sind also nicht gegen Tippfehler abgesichert.

    4.1.3.7. $::instance_conf

    • Objekt der Klasse "SL::InstanceConfiguration"

    • wird pro Request neu erstellt

    Funktioniert wie $::lx_office_conf, speichert aber Daten die von der Instanz abhängig sind. Eine Instanz ist hier eine Mandantendatenbank. Beispielsweise überprüft 

    $::instance_conf->get_inventory_system eq 'perpetual'

    - ob die berüchtigte Bestandsmethode zur Anwendung kommt.

    4.1.3.8. $::dispatcher

    • Objekt der Klasse + ob die berüchtigte Bestandsmethode zur Anwendung kommt.

    4.1.3.8. $::dispatcher

    • Objekt der Klasse "SL::Dispatcher"

    • wird pro Serverprozess erstellt.

    • enthält Informationen über die technische Verbindung zum Server

    Der dritte Punkt ist auch der einzige Grund warum das Objekt global gespeichert wird. Wird vermutlich irgendwann in einem anderen - Objekt untergebracht.

    4.1.3.9. $::request

    • Hashref (evtl später Objekt)

    • Wird pro Request neu initialisiert.

    • Keine Unterstruktur garantiert.

    + Objekt untergebracht.

    4.1.3.9. $::request

    • Hashref (evtl später Objekt)

    • Wird pro Request neu initialisiert.

    • Keine Unterstruktur garantiert.

    $::request ist ein generischer Platz um Daten "für den aktuellen Request" abzulegen. Sollte nicht für action at a distance benutzt werden, sondern um lokales memoizing zu @@ -174,20 +176,20 @@ file_name = /tmp/kivitendo-debug.log

    ist der Key f $::request

  • Muss ich von anderen Teilen des Programms lesend drauf zugreifen? Dann $::request, aber Zugriff über - Wrappermethode

    • 4.1.4. Ehemalige globale Variablen

    Die folgenden Variablen waren einmal im Programm, und wurden - entfernt.

    4.1.4.1. $::cgi

    • war nötig, weil cookie Methoden nicht als + Wrappermethode

    4.1.4. Ehemalige globale Variablen

    Die folgenden Variablen waren einmal im Programm, und wurden + entfernt.

    4.1.4.1. $::cgi

    • war nötig, weil cookie Methoden nicht als Klassenfunktionen funktionieren

    • Aufruf als Klasse erzeugt Dummyobjekt was im Klassennamespace gehalten wird und über Requestgrenzen leaked

    • liegt jetzt unter $::request->{cgi} -

    4.1.4.2. $::all_units

    • war nötig, weil einige Funktionen in Schleifen zum Teil +

    4.1.4.2. $::all_units

    • war nötig, weil einige Funktionen in Schleifen zum Teil ein paar hundert mal pro Request eine Liste der Einheiten brauchen, und de als Parameter durch einen Riesenstack von Funktionen geschleift werden müssten.

    • Liegt jetzt unter $::request->{cache}{all_units}

    • Wird nur in AM->retrieve_all_units() gesetzt oder - gelesen.

    4.1.4.3. %::called_subs

    • wurde benutzt um callsub deep recursions + gelesen.

    4.1.4.3. %::called_subs

    • wurde benutzt um callsub deep recursions abzufangen.

    • Wurde entfernt, weil callsub nur einen Bruchteil der möglichen Rekursioenen darstellt, und da nie welche auftreten.

    • komplette recursion protection wurde entfernt.

    Zurück   Weiter
    3.5. Mandantenkonfiguration Lager Zum Anfang 4.2. Entwicklung unter FastCGI
    \ No newline at end of file diff --git a/doc/html/ch04s03.html b/doc/html/ch04s03.html index 2d6a35d88..271b12e25 100644 --- a/doc/html/ch04s03.html +++ b/doc/html/ch04s03.html @@ -1,12 +1,20 @@ - 4.3. SQL-Upgradedateien
    4.3. SQL-Upgradedateien
    Zurück Kapitel 4. Entwicklerdokumentation Weiter

    4.3. SQL-Upgradedateien

    4.3.1. Einführung

    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.

    4.3.2. Format der Kontrollinformationen

    Die Kontrollinformationen sollten sich am Anfang der jeweiligen + 4.3. SQL-Upgradedateien

    4.3. SQL-Upgradedateien
    Zurück Kapitel 4. Entwicklerdokumentation Weiter

    4.3. SQL-Upgradedateien

    4.3.1. Einführung

    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.

    4.3.2. Format der Kontrollinformationen

    Die Kontrollinformationen sollten sich am Anfang der jeweiligen Upgradedatei befinden. Jede Zeile, die Kontrollinformationen enthält, hat dabei das folgende Format:

    Für SQL-Upgradedateien:

    -- @key: value

    Für Perl-Upgradedateien:

    # @key: value

    Leerzeichen vor "value" werden entfernt.

    Die folgenden Schlüsselworte werden verarbeitet:

    @@ -21,10 +29,14 @@ erlaubt und sollten stattdessen mit Unterstrichen ersetzt werden.

    charset -

    Empfohlen. Gibt den Zeichensatz an, in dem das Script geschrieben wurde, z.B. "UTF-8". Aus - Kompatibilitätsgründen mit alten Upgrade-Scripten wird bei Abwesenheit des Tags 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.

    +

    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.

    description

    Benötigt. Eine Beschreibung, was in diesem Update passiert. Diese wird dem Benutzer beim eigentlichen @@ -56,14 +68,22 @@ ignore

    Optional. Falls der Wert auf 1 (true) steht, wird das Skript bei der Anmeldung ignoriert und entsprechend nicht - ausgeführt.

    4.3.3. Format von in Perl geschriebenen Datenbankupgradescripten

    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.

    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.

    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
+              ausgeführt.

    4.3.3. Format von in Perl geschriebenen + Datenbankupgradescripten

    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.

    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.

    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;
diff --git a/doc/html/ch04s04.html b/doc/html/ch04s04.html
index 5ab9f74a4..7c7852b2b 100644
--- a/doc/html/ch04s04.html
+++ b/doc/html/ch04s04.html
@@ -4,7 +4,8 @@
           internationalen Übersetzern die Arbeit zu erleichtern.

    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.

    4.4.2. Character set

    All files included in a language pack must use UTF-8 as their encoding.

    4.4.3. File structure

    The structure of locales in kivitendo is:

    kivitendo/locale/<langcode>/

    where <langcode> stands for an abbreviation of the + version is usable too.

    4.4.2. Character set

    All files included in a language pack must use UTF-8 as their + encoding.

    4.4.3. File structure

    The structure of locales in kivitendo is:

    kivitendo/locale/<langcode>/

    where <langcode> stands for an abbreviation of the language package. The builtin packages use two letter ISO 639-1 codes, but the actual name is not relevant for the program and can easily be extended to IETF language @@ -71,13 +72,13 @@ filenames

    The last of which is very machine dependant. Remember that everything again. If a tranlsation is missing, the lost file is checked first. If you maintain a language package, you might want to keep this safe somewhere.

    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: + 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; -*-
@@ -96,5 +97,4 @@ $self->{more_texts} = {
   'Shipping Point'              => 'Delivery time',
 }

    -

    Zurück Nach oben Weiter
    4.3. SQL-Upgradedateien Zum Anfang 4.5. Die kivitendo-Test-Suite
    \ No newline at end of file diff --git a/doc/html/ch04s05.html b/doc/html/ch04s05.html index 6260a276c..8cb315244 100644 --- a/doc/html/ch04s05.html +++ b/doc/html/ch04s05.html @@ -1,55 +1,102 @@ - 4.5. Die kivitendo-Test-Suite
    4.5. Die kivitendo-Test-Suite
    Zurück Kapitel 4. Entwicklerdokumentation Weiter

    4.5. Die kivitendo-Test-Suite

    4.5.1. 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.

    4.5.2. 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.

    4.5.3. - 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

    4.5.4. - 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.

    4.5.5. - 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.

    4.5.5.1. - 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

    4.5.5.2. - 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.

    4.5.5.3. - 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;
+   4.5. Die kivitendo-Test-Suite
    4.5. Die kivitendo-Test-Suite
    Zurück Kapitel 4. Entwicklerdokumentation Weiter
    4.5. Die kivitendo-Test-Suite
    4.5.1. 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.
    4.5.2. 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.
    4.5.3. 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
    4.5.4. 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.
    4.5.5. 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.
    4.5.5.1. 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
    4.5.5.2. 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.
    4.5.5.3. 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.
    Zurück Nach oben Weiter
    4.4. Translations and languages Zum Anfang 4.6. Stil-Richtlinien
    
\ No newline at end of file
+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.

    Zurück Nach oben Weiter
    4.4. Translations and languages Zum Anfang 4.6. Stil-Richtlinien
    \ No newline at end of file diff --git a/doc/html/images/Einzahlungsschein_Makro.png b/doc/html/images/Einzahlungsschein_Makro.png new file mode 100644 index 000000000..435691145 Binary files /dev/null and b/doc/html/images/Einzahlungsschein_Makro.png differ diff --git a/doc/html/index.html b/doc/html/index.html index c69999a84..23949e0ac 100644 --- a/doc/html/index.html +++ b/doc/html/index.html @@ -1,12 +1,7 @@ - kivitendo 3.4.0: Installation, Konfiguration, Entwicklung
    kivitendo 3.4.0: Installation, Konfiguration, Entwicklung
       Weiter

    kivitendo 3.4.0: Installation, Konfiguration, Entwicklung

    Inhaltsverzeichnis

    1. Aktuelle Hinweise
    2. Installation und Grundkonfiguration
    2.1. Übersicht
    2.2. Benötigte Software und Pakete
    2.2.1. Betriebssystem
    2.2.2. Benötigte Perl-Pakete installieren
    2.3. Manuelle Installation des Programmpaketes
    2.4. kivitendo-Konfigurationsdatei
    2.4.1. Einführung
    2.4.2. Abschnitte und Parameter
    2.4.3. Versionen vor 2.6.3
    2.5. Anpassung der PostgreSQL-Konfiguration
    2.5.1. Zeichensätze/die Verwendung von Unicode/UTF-8
    2.5.2. Änderungen an Konfigurationsdateien
    2.5.3. Erweiterung für servergespeicherte Prozeduren
    2.5.4. Datenbankbenutzer anlegen
    2.6. Webserver-Konfiguration
    2.6.1. Grundkonfiguration mittels CGI
    2.6.2. Konfiguration für FastCGI/FCGI
    2.6.3. Weitergehende Konfiguration
    2.7. Der Task-Server
    2.7.1. Verfügbare und notwendige Konfigurationsoptionen
    2.7.2. Konfiguration der Mandanten für den Task-Server
    2.7.3. Automatisches Starten des Task-Servers beim Booten
    2.7.4. Wie der Task-Server gestartet und beendet wird
    2.8. Benutzerauthentifizierung und Administratorpasswort
    2.8.1. Grundlagen zur Benutzerauthentifizierung
    2.8.2. Administratorpasswort
    2.8.3. Authentifizierungsdatenbank
    2.8.4. Passwortüberprüfung
    2.8.5. Name des Session-Cookies
    2.8.6. Anlegen der Authentifizierungsdatenbank
    2.9. Mandanten-, Benutzer- und Gruppenverwaltung
    2.9.1. Zusammenhänge
    2.9.2. Mandanten, Benutzer und Gruppen
    2.9.3. Datenbanken anlegen
    2.9.4. Gruppen anlegen
    2.9.5. Benutzer anlegen
    2.9.6. Mandanten anlegen
    2.10. Drucker- und Systemverwaltung
    2.10.1. Druckeradministration
    2.10.2. System sperren / entsperren
    2.11. E-Mail-Versand aus kivitendo heraus
    2.11.1. Versand über lokalen E-Mail-Server
    2.11.2. Versand über einen SMTP-Server
    2.12. Drucken mit kivitendo
    2.12.1. Vorlagenverzeichnis anlegen
    2.12.2. Der Druckvorlagensatz RB
    2.12.3. f-tex
    2.12.4. Der Druckvorlagensatz rev-odt
    2.12.5. Allgemeine Hinweise zu LaTeX Vorlagen
    2.13. OpenDocument-Vorlagen
    2.14. Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung: + kivitendo 3.4.0: Installation, Konfiguration, Entwicklung
    kivitendo 3.4.0: Installation, Konfiguration, Entwicklung
       Weiter

    kivitendo 3.4.0: Installation, Konfiguration, Entwicklung

    Inhaltsverzeichnis

    1. Aktuelle Hinweise
    2. Installation und Grundkonfiguration
    2.1. Übersicht
    2.2. Benötigte Software und Pakete
    2.2.1. Betriebssystem
    2.2.2. Benötigte Perl-Pakete installieren
    2.3. Manuelle Installation des Programmpaketes
    2.4. kivitendo-Konfigurationsdatei
    2.4.1. Einführung
    2.4.2. Abschnitte und Parameter
    2.4.3. Versionen vor 2.6.3
    2.5. Anpassung der PostgreSQL-Konfiguration
    2.5.1. Zeichensätze/die Verwendung von Unicode/UTF-8
    2.5.2. Änderungen an Konfigurationsdateien
    2.5.3. Erweiterung für servergespeicherte Prozeduren
    2.5.4. Datenbankbenutzer anlegen
    2.6. Webserver-Konfiguration
    2.6.1. Grundkonfiguration mittels CGI
    2.6.2. Konfiguration für FastCGI/FCGI
    2.6.3. Weitergehende Konfiguration
    2.7. Der Task-Server
    2.7.1. Verfügbare und notwendige Konfigurationsoptionen
    2.7.2. Konfiguration der Mandanten für den Task-Server
    2.7.3. Automatisches Starten des Task-Servers beim Booten
    2.7.4. Wie der Task-Server gestartet und beendet wird
    2.8. Benutzerauthentifizierung und Administratorpasswort
    2.8.1. Grundlagen zur Benutzerauthentifizierung
    2.8.2. Administratorpasswort
    2.8.3. Authentifizierungsdatenbank
    2.8.4. Passwortüberprüfung
    2.8.5. Name des Session-Cookies
    2.8.6. Anlegen der Authentifizierungsdatenbank
    2.9. Mandanten-, Benutzer- und Gruppenverwaltung
    2.9.1. Zusammenhänge
    2.9.2. Mandanten, Benutzer und Gruppen
    2.9.3. Datenbanken anlegen
    2.9.4. Gruppen anlegen
    2.9.5. Benutzer anlegen
    2.9.6. Mandanten anlegen
    2.10. Drucker- und Systemverwaltung
    2.10.1. Druckeradministration
    2.10.2. System sperren / entsperren
    2.11. E-Mail-Versand aus kivitendo heraus
    2.11.1. Versand über lokalen E-Mail-Server
    2.11.2. Versand über einen SMTP-Server
    2.12. Drucken mit kivitendo
    2.12.1. Vorlagenverzeichnis anlegen
    2.12.2. Der Druckvorlagensatz RB
    2.12.3. f-tex
    2.12.4. Der Druckvorlagensatz rev-odt
    2.12.5. Allgemeine Hinweise zu LaTeX Vorlagen
    2.13. OpenDocument-Vorlagen
    2.13.1. OpenDocument (odt) Druckvorlagen mit Makros
    2.14. Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung: EUR
    2.14.1. Einführung
    2.14.2. Konfigurationsparameter
    2.14.3. Festlegen der Parameter
    2.14.4. Bemerkungen zur Bestandsmethode
    2.14.5. Bekannte Probleme
    2.15. SKR04 19% Umstellung für innergemeinschaftlichen Erwerb
    2.15.1. Einführung
    2.15.2. Konto 3804 manuell anlegen
    2.16. Verhalten des Bilanzberichts
    2.17. Einstellungen pro Mandant
    2.18. kivitendo ERP verwenden
    3. Features und Funktionen
    3.1. Wiederkehrende Rechnungen
    3.1.1. Einführung
    3.1.2. Konfiguration
    3.1.3. Spezielle Variablen
    3.1.4. Auflisten
    3.1.5. Erzeugung der eigentlichen Rechnungen
    3.1.6. Erste Rechnung für aktuellen Monat erstellen
    3.2. Bankerweiterung
    3.2.1. Einführung
    3.3. Dokumentenvorlagen und verfügbare Variablen
    3.3.1. Einführung
    3.3.2. Variablen ausgeben
    3.3.3. Verwendung in Druckbefehlen
    3.3.4. Anfang und Ende der Tags verändern
    3.3.5. Zuordnung von den Dateinamen zu den Funktionen
    3.3.6. Sprache, Drucker und E-Mail
    3.3.7. Allgemeine Variablen, die in allen Vorlagen vorhanden sind
    3.3.8. Variablen in Rechnungen
    3.3.9. Variablen in Mahnungen und Rechnungen über Mahngebühren
    3.3.10. Variablen in anderen Vorlagen
    3.3.11. Blöcke, bedingte Anweisungen und Schleifen
    3.3.12. Markup-Code zur Textformatierung innerhalb von - Formularen
    3.4. Excel-Vorlagen
    3.4.1. Zusammenfassung
    3.4.2. Bedienung
    3.4.3. Variablensyntax
    3.4.4. Einschränkungen
    3.5. Mandantenkonfiguration Lager
    4. Entwicklerdokumentation
    4.1. Globale Variablen
    4.1.1. Wie sehen globale Variablen in Perl aus?
    4.1.2. Warum sind globale Variablen ein Problem?
    4.1.3. Kanonische globale Variablen
    4.1.4. Ehemalige globale Variablen
    4.2. Entwicklung unter FastCGI
    4.2.1. Allgemeines
    4.2.2. Programmende und Ausnahmen
    4.2.3. Globale Variablen
    4.2.4. Performance und Statistiken
    4.3. SQL-Upgradedateien
    4.3.1. Einführung
    4.3.2. Format der Kontrollinformationen
    4.3.3. Format von in Perl geschriebenen Datenbankupgradescripten
    4.3.4. Hilfsscript dbupgrade2_tool.pl
    4.4. Translations and languages
    4.4.1. Introduction
    4.4.2. Character set
    4.4.3. File structure
    4.5. Die kivitendo-Test-Suite
    4.5.1. Einführung
    4.5.2. Voraussetzungen
    4.5.3. - Existierende Tests ausführen -
    4.5.4. - Bedeutung der verschiedenen Test-Scripte -
    4.5.5. - Neue Test-Scripte erstellen -
    4.6. Stil-Richtlinien
    4.7. Dokumentation erstellen
    4.7.1. Einführung
    4.7.2. Benötigte Software
    4.7.3. PDFs und HTML-Seiten erstellen
    4.7.4. Einchecken in das Git-Repository
       Weiter
       Kapitel 1. Aktuelle Hinweise
    \ No newline at end of file + Formularen
    3.4. Excel-Vorlagen
    3.4.1. Zusammenfassung
    3.4.2. Bedienung
    3.4.3. Variablensyntax
    3.4.4. Einschränkungen
    3.5. Mandantenkonfiguration Lager
    4. Entwicklerdokumentation
    4.1. Globale Variablen
    4.1.1. Wie sehen globale Variablen in Perl aus?
    4.1.2. Warum sind globale Variablen ein Problem?
    4.1.3. Kanonische globale Variablen
    4.1.4. Ehemalige globale Variablen
    4.2. Entwicklung unter FastCGI
    4.2.1. Allgemeines
    4.2.2. Programmende und Ausnahmen
    4.2.3. Globale Variablen
    4.2.4. Performance und Statistiken
    4.3. SQL-Upgradedateien
    4.3.1. Einführung
    4.3.2. Format der Kontrollinformationen
    4.3.3. Format von in Perl geschriebenen + Datenbankupgradescripten
    4.3.4. Hilfsscript dbupgrade2_tool.pl
    4.4. Translations and languages
    4.4.1. Introduction
    4.4.2. Character set
    4.4.3. File structure
    4.5. Die kivitendo-Test-Suite
    4.5.1. Einführung
    4.5.2. Voraussetzungen
    4.5.3. Existierende Tests ausführen
    4.5.4. Bedeutung der verschiedenen Test-Scripte
    4.5.5. Neue Test-Scripte erstellen
    4.6. Stil-Richtlinien
    4.7. Dokumentation erstellen
    4.7.1. Einführung
    4.7.2. Benötigte Software
    4.7.3. PDFs und HTML-Seiten erstellen
    4.7.4. Einchecken in das Git-Repository
       Weiter
       Kapitel 1. Aktuelle Hinweise
    \ No newline at end of file diff --git a/doc/kivitendo-Dokumentation.pdf b/doc/kivitendo-Dokumentation.pdf index ef4a82c19..93cb76afc 100644 Binary files a/doc/kivitendo-Dokumentation.pdf and b/doc/kivitendo-Dokumentation.pdf differ