From: Moritz Bunkus
Date: Fri, 10 Feb 2017 15:48:30 +0000 (+0100)
Subject: Dokumentation: neue Perl-Modul-Abhängigkeiten für Entwickler dokumentiert
X-Git-Tag: release-3.5.4~1489
X-Git-Url: http://wagnertech.de/git?a=commitdiff_plain;h=19f088317edda90c2c050761a2e0127c3b0629e3;p=kivitendo-erp.git
Dokumentation: neue Perl-Modul-Abhängigkeiten für Entwickler dokumentiert
---
diff --git a/doc/changelog b/doc/changelog
index dd0f68dbf..1ebd25b59 100644
--- a/doc/changelog
+++ b/doc/changelog
@@ -151,6 +151,9 @@ Administrative Ãnderungen
beschleunigt. Dafür wird die benötigte Minimalversion von Postgres auf 9.1
angehoben.
+ - Entwickler benötigen neu die zwei Perl-Module "Sys::CPU" und
+ "Thread::Pool::Simple".
+
Bugfixes:
- Pflichtenheftmodul: Es wurde eine Fehlermeldung angezeigt, wenn im
diff --git a/doc/dokumentation.xml b/doc/dokumentation.xml
index 76ba624b1..00511138b 100644
--- a/doc/dokumentation.xml
+++ b/doc/dokumentation.xml
@@ -6555,7 +6555,7 @@ Beschreibung: <%description%>
direkt in der Datenbanktablle "user_preferences" einzurichten. Die "value" ist im JSON-Format
mit den jeweiligen Werten des Verzeichnisses und der Beschreibung der Quelle.
- id | login | namespace | version | key | value
+ id | login | namespace | version | key | value
----+-----------+--------------+---------+----------+---------------------------
1 | #default# | file_sources | 0.00000 | scanner1 |
{"dir":"/var/tmp/scanner1","desc":"Scanner Einkauf"}
@@ -7838,6 +7838,16 @@ $self->{more_texts} = {
perl-URI-Find; openSUSE:
perl-URI-Find)
+
+
+ Sys::CPU (Debian-Panetname: libsys-cpu-perl; Fedora und openSUSE: nicht
+ vorhanden)
+
+
+
+ Thread::Pool::Simple (Debian-Panetname: libthread-pool-simple-perl; Fedora und
+ openSUSE: nicht vorhanden)
+ Weitere Voraussetzung ist, dass die Testsuite ihre eigene
diff --git a/doc/html/ch02s02.html b/doc/html/ch02s02.html
index eca6e5d4a..b01f89da6 100644
--- a/doc/html/ch02s02.html
+++ b/doc/html/ch02s02.html
@@ -36,14 +36,12 @@
Email::Address
@@ -113,7 +111,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
+ 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:
Zusätzlich müssen einige Pakete aus dem CPAN installiert
- werden. Dazu können Sie die folgenden Befehle nutzen:
cpan Rose::Db::Object
2.2.3. Andere Pakete installieren
Seit Version v3.4.0 wird für den Bankimport optional das Paket
+ werden. Dazu können Sie die folgenden Befehle nutzen:
cpan Rose::Db::Object
2.2.3. Andere Pakete installieren
Seit Version v3.4.0 wird für den Bankimport optional das Paket
'aqbanking-tools' benötigt.
Ubuntu:
apt install aqbanking-tools
OpenSuSE:
zypper install aqbanking-tools
Seit Version v3.4.1 wird generell zum Feststellen der
diff --git a/doc/html/ch02s06.html b/doc/html/ch02s06.html
index 95e5bef1a..791663224 100644
--- a/doc/html/ch02s06.html
+++ b/doc/html/ch02s06.html
@@ -1,6 +1,6 @@
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
@@ -109,7 +109,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
+ 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
diff --git a/doc/html/ch02s07.html b/doc/html/ch02s07.html
index b62bffcf7..be366a0d1 100644
--- a/doc/html/ch02s07.html
+++ b/doc/html/ch02s07.html
@@ -34,7 +34,7 @@
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,
+ anstelle eines symbolischen Links verwendet werden können.
Kopieren Sie die Datei
scripts/boot/system-v/kivitendo-task-server
nach /etc/init.d/kivitendo-task-server. Passen
@@ -43,12 +43,12 @@
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:
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
+ 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:
Kopieren Sie die Datei scripts/boot/systemd/kivitendo-task-server.service nach
/etc/systemd/system/. Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeilen
ExecStart=.... und ExecStop=...).
Machen Sie anschlieÃend das Script systemd bekannt, und binden Sie es in den Boot-Prozess ein. Dazu führen Sie die folgenden
diff --git a/doc/html/ch02s13.html b/doc/html/ch02s13.html
index fb87364bb..390327ff2 100644
--- a/doc/html/ch02s13.html
+++ b/doc/html/ch02s13.html
@@ -63,14 +63,14 @@
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.
2.13.1. OpenDocument (odt) Druckvorlagen mit Makros
OpenDocument Vorlagen können Makros enthalten, welche komplexere
+ 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):
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
@@ -80,12 +80,12 @@
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
+ 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
+ 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
@@ -114,12 +114,12 @@
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
+ 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
+ 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:
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/ch03s07.html b/doc/html/ch03s07.html
index ec0c0f2a1..3cd48d5a4 100644
--- a/doc/html/ch03s07.html
+++ b/doc/html/ch03s07.html
@@ -1,15 +1,15 @@
Die Klassifizierung von Artikeln dient einer weiteren Gliederung
um zum Beispiel den Einkauf vom Verkauf zu trennen, gekennzeichnet
durch eine Beschreibung (z.B. "Einkauf") und ein Kürzel (z.B. "E").
Für jede Klassifizierung besteht eine Beschreibung und eine Abkürzung
die normalerweise aus einem Zeichen besteht, kann aber auf mehrere
Zeichen erweitert werden, falls zur Unterscheidung notwendig, sinnvoll
- sind jedoch nur maximal 2 Zeichen.
3.7.2. Basisklassifizierung
Als Basisklassifizierungen gibt es
Einkauf
Verkauf
Handelsware
Produktion
- keine - (diese wird bei einer Aktualisierung für alle
+ sind jedoch nur maximal 2 Zeichen.
3.7.2. Basisklassifizierung
Als Basisklassifizierungen gibt es
Einkauf
Verkauf
Handelsware
Produktion
- keine - (diese wird bei einer Aktualisierung für alle
existierenden Artikel genommen, gültig für Verkauf und
Einkauf)
Es können weitere Klassifizierungen angelegt werden. So kann es
- z.B. für separat auszuweisende Artikel folgened Klassen geben:
Lieferung (Logistik, Transport) mit Kürzel L
Material (Verpackungsmaterial) mit Kürzel M
3.7.3. Attribute
Bisher haben die Klassifizierungen folgende Attribute, die auch
+ z.B. für separat auszuweisende Artikel folgened Klassen geben:
Lieferung (Logistik, Transport) mit Kürzel L
Material (Verpackungsmaterial) mit Kürzel M
3.7.3. Attribute
Bisher haben die Klassifizierungen folgende Attribute, die auch
alle gleichzeitg gültig sein können
gültig für Verkauf - dieser Artikel kann im Verkauf genutzt
werden
gültig für Einkauf - dieser Artikel kann im Einkauf genutzt
werden
separat ausweisen - hierzu gibt es zur Dokumentengenerierung
@@ -17,7 +17,7 @@
die alle nicht separat auszuweisenden Artikelkosten saldiert, sowie
pro separat auszuweisenden Klassifizierungen die Variable <%separate_X_subtotal%> wobei X das
Kürzel der Klassifizierung ist.
Im obigen Beispiel wäre das für Lieferkosten <%separate_L_subtotal%> und für
- Verpackungsmaterial <%separate_M_subtotal%> .
3.7.4. Zwei-Zeichen Abkürzung
Der Typ des Artikel und die Klassifizierung werden durch zwei
+ Verpackungsmaterial <%separate_M_subtotal%> .
3.7.4. Zwei-Zeichen Abkürzung
Der Typ des Artikel und die Klassifizierung werden durch zwei
Buchstaben dargestellt. Der erste Buchstabe ist eine Lokalisierung des
Typs des Artikel ('P','A','S') , deutch 'W', 'E', und 'D' für Ware
Erzeugnis oder Dienstleistung, ggf. weitere Typen.
Der zweite (und ggf. auch ein dritter Buchstabe, falls nötig)
diff --git a/doc/html/ch03s08.html b/doc/html/ch03s08.html
index 16d46485a..b6d451abb 100644
--- a/doc/html/ch03s08.html
+++ b/doc/html/ch03s08.html
@@ -1,7 +1,7 @@
Parallel zum alten WebDAV gibt es eine Datei-Management-Sytem, daà Dateien
- verschiedenen Typs verwaltet. Dies können
aus ERP-Daten per LaTeX Template erzeugte PDF-Dokumente,
zu bestimmten ERP-Daten gehörende Anhangdateien unterschiedlichen Formats,
per Scanner eingelesene PDF-Dateien,
per Email empfangene Dateianhänge unterschiedlichen Formats,
sowie speziel an Artikel hochgeladene Bilder sein.
3.8.2. Struktur
Ãber eine vom Speichermedium unabhängige Zwischenschicht werden die Dateien und ihre Versionen in der Datenbank verwaltet. Darunter können verschiedene Implementierungen (Backends) gleichzeitig existieren:
+
Parallel zum alten WebDAV gibt es eine Datei-Management-Sytem, daà Dateien
+ verschiedenen Typs verwaltet. Dies können
aus ERP-Daten per LaTeX Template erzeugte PDF-Dokumente,
zu bestimmten ERP-Daten gehörende Anhangdateien unterschiedlichen Formats,
per Scanner eingelesene PDF-Dateien,
per Email empfangene Dateianhänge unterschiedlichen Formats,
sowie speziel an Artikel hochgeladene Bilder sein.
3.8.2. Struktur
Ãber eine vom Speichermedium unabhängige Zwischenschicht werden die Dateien und ihre Versionen in der Datenbank verwaltet. Darunter können verschiedene Implementierungen (Backends) gleichzeitig existieren:
Dateisystem,
WebDAV,
Schnittstelle zu externem Dokumenten-Management-System,
andere Datenbank,
etc ...
Es gibt unterschiedliche Typen von Dateien, jedem Typ läÃt sich in der
Mandantenkonfigurierung ein bestimmtes Backend zuordnen.
"document", das sind entweder generierte,eingescannte oder hochgeladene PDF-Dateien,
@@ -13,7 +13,7 @@
"created" , vom System erzeugte Dokumente"
"uploaded", hochgeladene Dokumente
"email", vom Mailsystem empfangene Dateien
"scanner[1]", von einem oder mehreren Scannern erzeugte Dateien. Existieren mehrere Scanner,
so sind diese durch unterschiedliche Quellennamen zu definieren
Je nach Dateityp sind nur bestimmte Quellen zulässig. So gibt es für "attachment" und "image" nur
die Quelle "uploaded". Für "document" gibt es auf jeden Fall die Quelle "created".
- Die Quellen "scanner" und "email" müssen derzeit in der Datenbank konfiguriert werden (siehe Datenbank-Konfigurierung.
3.8.3. Anwendung
Die Daten werden bei den ERP-Objekten als extra Reiter dargestellt.
+ Die Quellen "scanner" und "email" müssen derzeit in der Datenbank konfiguriert werden (siehe Datenbank-Konfigurierung.
3.8.3. Anwendung
Die Daten werden bei den ERP-Objekten als extra Reiter dargestellt.
Eine Verkaufsrechnung z.B. hat die
Reiter "Dokumente" und "Dateianhänge.
Bei den Dateianhängen wird immer nur die aktuelle Version einer Datei angezeigt.
Wird eine Datei mit gleichem Namen hochgeladen, so wird eine neue Version der Datei erstellt.
@@ -26,10 +26,10 @@
anderen Quellen zur Geltung. Werden entsprechend
Datenbank-Konfigurierung zusätzliche Quellen konfiguriert, so sind diese z.B. bei
Einkaufsrechnungen sichtbar:
Statt des Löschens wird hier die Datei zurück zur Quelle verschoben. Somit kann die Datei anschlieÃend
- an ein anderes ERP-Objekt angehängt werden.
Derzeit sind "Titel" und "Beschreibung" noch nicht genutzt. Sie sind bisher nur bei Bildern relevant.
3.8.4. Konfigurierung
3.8.4.1. Mandantenkonfigurierung
3.8.4.1.1. Reiter "Features"
Unter dem Reiter Features im Abschnit Dateimanagement ist
+ an ein anderes ERP-Objekt angehängt werden.
Derzeit sind "Titel" und "Beschreibung" noch nicht genutzt. Sie sind bisher nur bei Bildern relevant.
3.8.4. Konfigurierung
3.8.4.1. Mandantenkonfigurierung
3.8.4.1.1. Reiter "Features"
Unter dem Reiter Features im Abschnit Dateimanagement ist
neben dem "alten" WebDAV das Dateimangement general zu- und abschaltbar, sowie die Zuordnung der
Dateitypen zu Backends. Die Löschbarkeit von Dateien sowie die maximale UploadgröÃe sind Backend-unabhängig
Die einzelnen Backends sind einzeln einschaltbar. Spezifische Backend-Konfigurierungen sind hier
- noch ergänzbar. Für das Backend Dateisystem ist das Wurzelverzeichnis für den Mandanten einzugeben.
3.8.4.1.2. Reiter "Allgemeine Dokumentenanhänge"
Unter dem Reiter Allgemeine Dokumentenanhänge
+ noch ergänzbar. Für das Backend Dateisystem ist das Wurzelverzeichnis für den Mandanten einzugeben.
3.8.4.1.2. Reiter "Allgemeine Dokumentenanhänge"
Unter dem Reiter Allgemeine Dokumentenanhänge
kann für alle ERP-Dokumente ( Angebote, Aufträge, Lieferscheine, Rechnungen im Verkauf und Einkauf )
allgemeingültige Anhänge hochgeladen werden.
Diese Anhänge werden beim Generieren von PDF-Dateien an die ERP-Dokumente angehängt,
z.B. AGBs oder aktuelle Angebote. Es werden in dem Fall die Daten kopiert, sodaà an den ERP-Dokumenten immer
@@ -37,7 +37,7 @@
3.8.4.2. Datenbank-Konfigurierung
Die zusätzlichen Quellen für email oder ein oder mehrere Scanner sind derzeit vom Administrator
direkt in der Datenbanktablle "user_preferences" einzurichten. Die "value" ist im JSON-Format
mit den jeweiligen Werten des Verzeichnisses und der Beschreibung der Quelle.
- id | login | namespace | version | key | value
+ id | login | namespace | version | key | value
----+-----------+--------------+---------+----------+---------------------------
1 | #default# | file_sources | 0.00000 | scanner1 |
{"dir":"/var/tmp/scanner1","desc":"Scanner Einkauf"}
diff --git a/doc/html/ch04.html b/doc/html/ch04.html
index 9c3282318..cfe02b471 100644
--- a/doc/html/ch04.html
+++ b/doc/html/ch04.html
@@ -1,6 +1,6 @@
- Kapitel 4. Entwicklerdokumentation
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 Datumsformat dateformat und Nummernformat numberformat
Enthält Datenbankzugriffinformationen
@@ -121,10 +121,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.
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
@@ -134,7 +134,7 @@
"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
@@ -143,7 +143,7 @@ $main::lxdebug->message(0, 'Wer bin ich? Kunde oder Lieferant:' . $form->{
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
@@ -153,16 +153,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
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
- 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
@@ -175,20 +175,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.
\ No newline at end of file
diff --git a/doc/html/ch04s05.html b/doc/html/ch04s05.html
index 2e9b01b5b..0e8ab67cc 100644
--- a/doc/html/ch04s05.html
+++ b/doc/html/ch04s05.html
@@ -33,7 +33,11 @@
URI::Find (Debian-Panetname:
liburi-find-perl; Fedora:
perl-URI-Find; openSUSE:
- perl-URI-Find)
Weitere Voraussetzung ist, dass die Testsuite ihre eigene
+ perl-URI-Find)
+ Sys::CPU (Debian-Panetname: libsys-cpu-perl; Fedora und openSUSE: nicht
+ vorhanden)
+ Thread::Pool::Simple (Debian-Panetname: libthread-pool-simple-perl; Fedora und
+ openSUSE: nicht vorhanden)
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
diff --git a/doc/html/index.html b/doc/html/index.html
index 053d5d410..bb86e8dd8 100644
--- a/doc/html/index.html
+++ b/doc/html/index.html
@@ -1,7 +1,7 @@
- kivitendo 3.4.1: Installation, Konfiguration, Entwicklung
kivitendo 3.4.1: Installation, Konfiguration, Entwicklung
\ No newline at end of file
diff --git a/doc/kivitendo-Dokumentation.pdf b/doc/kivitendo-Dokumentation.pdf
index 1d09b849c..3f14a34c4 100644
Binary files a/doc/kivitendo-Dokumentation.pdf and b/doc/kivitendo-Dokumentation.pdf differ