From: Jan Büren Date: Fri, 11 Mar 2016 16:12:51 +0000 (+0100) Subject: Ausgabe der Dokumentation aktualisiert (mosus änderungen) X-Git-Tag: release-3.4.1~310 X-Git-Url: http://wagnertech.de/git?a=commitdiff_plain;h=eb496376260c7360d5bc53d865c38d47a9685fda;p=kivitendo-erp.git Ausgabe der Dokumentation aktualisiert (mosus änderungen) --- diff --git a/doc/html/ch02s02.html b/doc/html/ch02s02.html index 4c4e0dc4a..43cccc720 100644 --- a/doc/html/ch02s02.html +++ b/doc/html/ch02s02.html @@ -6,7 +6,7 @@ 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 @@ -15,10 +15,16 @@ Archive::Zip

  • Algorithm::CheckDigits +

  • + CGI +

  • + Clone

  • Config::Std

  • DateTime +

  • + DateTime::Format::Strptime

  • DBI

  • @@ -30,10 +36,20 @@

  • FCGI (nicht Versionen 0.68 bis 0.71 inklusive; siehe Abschnitt 2.6.2.3, „Getestete Kombinationen aus Webservern und Plugin“)

  • File::Copy::Recursive +

  • + GD +

  • + HTML::Parser +

  • + HTML::Restrict +

  • + Image::Info

  • JSON

  • List::MoreUtils +

  • + List::UtilsBy

  • Net::SMTP::SSL (optional, bei E-Mail-Versand über SSL; siehe Abschnitt "E-Mail-Versand über einen SMTP-Server")

  • Net::SSLGlue (optional, bei E-Mail-Versand über TLS; siehe Abschnitt "E-Mail-Versand über einen SMTP-Server")

  • @@ -48,6 +64,10 @@ Rose::DB

  • Rose::DB::Object Version 0.788 oder neuer

  • + String::ShellQuote +

  • + Sort::Naturally +

  • Template

  • Text::CSV_XS @@ -77,7 +97,7 @@ 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 \
@@ -89,18 +109,18 @@
   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 Core
    Für Fedora Core stehen die meisten der benötigten Perl-Pakete als RPM-Pakete zur Verfügung. Sie können mit folgendem Befehl installiert werden:
    yum install httpd perl-Archive-Zip perl-Clone perl-DBD-Pg \
+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
    Zusätzlich müssen einige Pakete aus dem CPAN installiert werden. Dazu können Sie die folgenden Befehle nutzen:
    yum install perl-CPAN
-cpan Config::Std
    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 perl-Archive-Zip perl-Clone \
+  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
+          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 postgresql-server
    Zusätzlich müssen einige Pakete aus dem CPAN installiert werden. Dazu können Sie die folgenden Befehle nutzen:
    yum install perl-CPAN
-cpan Rose::Db::Object
    • 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-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 diff --git a/doc/html/ch02s03.html b/doc/html/ch02s03.html index daef869ad..1a1d0e923 100644 --- a/doc/html/ch02s03.html +++ b/doc/html/ch02s03.html @@ -8,7 +8,7 @@ tar xvzf kivitendo-erp-3.4.0.tgz

    Wechseln Sie in das entpackte Verzeichn 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 - core apache oder bei OpenSUSE wwwrun).

    Der folgende Befehl ändert den Besitzer für die oben genannten + 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. diff --git a/doc/html/ch02s06.html b/doc/html/ch02s06.html index 217f50e0e..a85dde1ae 100644 --- a/doc/html/ch02s06.html +++ b/doc/html/ch02s06.html @@ -1,6 +1,6 @@ - 2.6. Webserver-Konfiguration

    2.6. Webserver-Konfiguration
    Zurück Kapitel 2. Installation und Grundkonfiguration Weiter

    2.6. Webserver-Konfiguration

    2.6.1. Grundkonfiguration mittels CGI

    [Anmerkung]Anmerkung

    Für einen deutlichen Performanceschub sorgt die Ausführung + 2.6. Webserver-Konfiguration

    2.6. Webserver-Konfiguration
    Zurück Kapitel 2. Installation und Grundkonfiguration Weiter

    2.6. Webserver-Konfiguration

    2.6.1. Grundkonfiguration mittels CGI

    [Anmerkung]Anmerkung

    Für einen deutlichen Performanceschub sorgt die Ausführung mittels FastCGI/FCGI. Die Einrichtung wird ausführlich im Abschnitt Konfiguration für FastCGI/FCGI beschrieben.

    Der Zugriff auf das Programmverzeichnis muss in der Apache Webserverkonfigurationsdatei httpd.conf eingestellt @@ -103,7 +103,7 @@ 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 + 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 diff --git a/doc/html/ch02s07.html b/doc/html/ch02s07.html index 92d31db16..2e4cefe54 100644 --- a/doc/html/ch02s07.html +++ b/doc/html/ch02s07.html @@ -26,20 +26,20 @@ 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 Core)

    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 DAEMON=....). Binden Sie das Script in den Boot-Prozess ein. Dies ist distributionsabhängig:

    • Debian-basierende Systeme:

      update-rc.d kivitendo-task-server defaults
 # Nur bei Debian Squeeze und neuer:
-insserv kivitendo-task-server

    • Ältere OpenSUSE und ältere Fedora Core:

      chkconfig --add kivitendo-task-server

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

    /etc/init.d/kivitendo-task-server start

    2.7.3.2. Upstart-basierende Systeme (z.B. Ubuntu bis 14.04)

    Kopieren Sie die Datei +insserv kivitendo-task-server

  • Ältere OpenSUSE und ältere Fedora:

    chkconfig --add kivitendo-task-server

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

    /etc/init.d/kivitendo-task-server start

    2.7.3.2. Upstart-basierende Systeme (z.B. Ubuntu bis 14.04)

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

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

    service kivitendo-task-server start

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

    Verlinken Sie die Datei scripts/boot/systemd/kivitendo-task-server.service nach + 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
diff --git a/doc/html/ch02s11.html b/doc/html/ch02s11.html
index fa619ec0e..c5838fd3a 100644
--- a/doc/html/ch02s11.html
+++ b/doc/html/ch02s11.html
@@ -27,10 +27,4 @@
                      login und password
                   
    Falls der E-Mail-Server eine Authentifizierung verlangt, so können mit diesen zwei Parametern der Benutzername
             und das Passwort angegeben werden. Wird Authentifizierung verwendet, so sollte aus Sicherheitsgründen auch eine Form von
-            Verschlüsselung aktiviert werden.

    Wird Verschlüsselung über TLS oder SSL aktiviert, so werden zusätzliche Perl-Module benötigt. Diese sind:

    • TLS-Verschlüsselung: Modul Net::SSLGlue (Debian-Paketname - libnet-sslglue-perl, Fedora Core: perl-Net-SSLGlue, openSUSE: - perl-Net-SSLGlue -

    • SSL-Verschlüsselung: Modul Net::SMTP::SSL (Debian-Paketname - libnet-smtp-ssl-perl, Fedora Core: perl-Net-SMTP-SSL, openSUSE: - perl-Net-SMTP-SSL -

    Zurück Nach oben Weiter
    2.10. Drucker- und Systemverwaltung Zum Anfang 2.12. Drucken mit kivitendo
    \ No newline at end of file + 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 0023f1556..b6f9e1c30 100644 --- a/doc/html/ch02s12.html +++ b/doc/html/ch02s12.html @@ -5,7 +5,15 @@ die Pakete mit:

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

    -

    TODO: RPM-Pakete.

    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 +

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

    + 

    dnf install texlive-collection-latex texlive-collection-latexextra \
+  texlive-collection-latexrecommended texlive-collection-langgerman \
+  texlive-collection-langenglish

    +

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

    + 

    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 -> diff --git a/doc/html/ch03s03.html b/doc/html/ch03s03.html index 442cc9020..63da19b35 100644 --- a/doc/html/ch03s03.html +++ b/doc/html/ch03s03.html @@ -579,7 +579,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: diff --git a/doc/html/ch04.html b/doc/html/ch04.html index c3393f091..d365e65a5 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,14 @@ "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 + 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 +152,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 +174,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/ch04s05.html b/doc/html/ch04s05.html index 316136ded..6260a276c 100644 --- a/doc/html/ch04s05.html +++ b/doc/html/ch04s05.html @@ -2,19 +2,19 @@ 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 Core: + Test::Deep (Debian-Paketname: libtest-deep-perl; Fedora: perl-Test-Deep; openSUSE: perl-Test-Deep)

    • - Test::Exception (Debian-Paketname: libtest-exception-perl; Fedora Core: + Test::Exception (Debian-Paketname: libtest-exception-perl; Fedora: perl-Test-Exception; openSUSE: perl-Test-Exception)

    • - Test::Output (Debian-Paketname: libtest-output-perl; Fedora Core: + 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 Core: perl-libwww-perl; openSUSE: + libwww-perl; Fedora: perl-libwww-perl; openSUSE: perl-libwww-perl)

    • - URI::Find (Debian-Panetname: liburi-find-perl; Fedora Core: + 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. diff --git a/doc/html/index.html b/doc/html/index.html index c07ab2105..c69999a84 100644 --- a/doc/html/index.html +++ b/doc/html/index.html @@ -1,9 +1,9 @@ - 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.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. + 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 diff --git a/doc/kivitendo-Dokumentation.pdf b/doc/kivitendo-Dokumentation.pdf index 0132fb25d..a77aa3fd2 100644 Binary files a/doc/kivitendo-Dokumentation.pdf and b/doc/kivitendo-Dokumentation.pdf differ