From: Martin Helmling martin.helmling@octosoft.eu Date: Wed, 1 Feb 2017 08:10:01 +0000 (+0100) Subject: Dokumentation neu generiert X-Git-Tag: release-3.5.4~1581 X-Git-Url: http://wagnertech.de/git?a=commitdiff_plain;h=0c39e6dfa3240afb3199d91327496bdb0a3a6697;p=kivitendo-erp.git Dokumentation neu generiert --- diff --git a/doc/html/ch02s02.html b/doc/html/ch02s02.html index a1f7c0b4a..eca6e5d4a 100644 --- a/doc/html/ch02s02.html +++ b/doc/html/ch02s02.html @@ -36,6 +36,10 @@ Email::Address

  • Email::MIME +

  • + MIME::Entity +

  • + MIME::Parser

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

  • @@ -109,7 +113,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:

    apt install  apache2 libarchive-zip-perl libclone-perl \
   libconfig-std-perl libdatetime-perl libdbd-pg-perl libdbi-perl \
@@ -125,7 +129,7 @@

    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 +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 \
@@ -135,7 +139,7 @@ cpan HTML::Restrict

    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 + 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 \
@@ -144,7 +148,7 @@ cpan HTML::Restrict

    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 d02e9633d..95e5bef1a 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 @@ -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 df19bbb1a..b62bffcf7 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.

    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 @@ -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:

    service kivitendo-task-server start

    2.7.3.3. systemd-basierende Systeme (z.B. neure openSUSE, neuere + werden:

    service kivitendo-task-server start

    2.7.3.3. systemd-basierende Systeme (z.B. neure openSUSE, neuere Fedora, neuere Ubuntu und Debians)

    Kopieren Sie die Datei scripts/boot/systemd/kivitendo-task-server.service nach /etc/systemd/system/. Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeilen ExecStart=.... und ExecStop=...).

    Machen Sie anschließend das Script systemd bekannt, und binden Sie es in den Boot-Prozess ein. Dazu führen Sie die folgenden diff --git a/doc/html/ch02s13.html b/doc/html/ch02s13.html index 328ede849..fb87364bb 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):

    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 + 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 @@ -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:

    • Extras → Optionen → Sicherheit → diff --git a/doc/html/ch03s03.html b/doc/html/ch03s03.html index 04492b121..5421d04f2 100644 --- a/doc/html/ch03s03.html +++ b/doc/html/ch03s03.html @@ -609,7 +609,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/ch03s07.html b/doc/html/ch03s07.html index cd16f283e..ec0c0f2a1 100644 --- a/doc/html/ch03s07.html +++ b/doc/html/ch03s07.html @@ -1,15 +1,15 @@ - 3.7. Artikelklassifizierung

    3.7. Artikelklassifizierung
    Zurück Kapitel 3. Features und Funktionen Weiter

    3.7. Artikelklassifizierung

    3.7.1. Übersicht

    Die Klassifizierung von Artikeln dient einer weiteren Gliederung + 3.7. Artikelklassifizierung

    3.7. Artikelklassifizierung
    Zurück Kapitel 3. Features und Funktionen Weiter

    3.7. Artikelklassifizierung

    3.7.1. Übersicht

    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:

    1. Lieferung (Logistik, Transport) mit Kürzel L

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

    1. Lieferung (Logistik, Transport) mit Kürzel L

    2. 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 f5cf48f9e..16d46485a 100644 --- a/doc/html/ch03s08.html +++ b/doc/html/ch03s08.html @@ -1,7 +1,7 @@ - 3.8. Dateiverwaltung (Mini-DMS)

    3.8. Dateiverwaltung (Mini-DMS)
    Zurück Kapitel 3. Features und Funktionen Weiter

    3.8. Dateiverwaltung (Mini-DMS)

    3.8.1. Übersicht

    Parallel zum alten WebDAV gibt es eine Datei-Management-Sytem, daß Dateien - verschiedenen Typs verwaltet. Dies können

    1. aus ERP-Daten per LaTeX Template erzeugte PDF-Dokumente,

    2. zu bestimmten ERP-Daten gehörende Anhangdateien unterschiedlichen Formats,

    3. per Scanner eingelesene PDF-Dateien,

    4. per Email empfangene Dateianhänge unterschiedlichen Formats,

    5. 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: + 3.8. Dateiverwaltung (Mini-DMS)

    3.8. Dateiverwaltung (Mini-DMS)
    Zurück Kapitel 3. Features und Funktionen Weiter

    3.8. Dateiverwaltung (Mini-DMS)

    3.8.1. Übersicht

    Parallel zum alten WebDAV gibt es eine Datei-Management-Sytem, daß Dateien + verschiedenen Typs verwaltet. Dies können

    1. aus ERP-Daten per LaTeX Template erzeugte PDF-Dokumente,

    2. zu bestimmten ERP-Daten gehörende Anhangdateien unterschiedlichen Formats,

    3. per Scanner eingelesene PDF-Dateien,

    4. per Email empfangene Dateianhänge unterschiedlichen Formats,

    5. 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 diff --git a/doc/html/ch04.html b/doc/html/ch04.html index 72a09267b..9c3282318 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 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.

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

    Zurück   Weiter
    3.8. Dateiverwaltung (Mini-DMS) Zum Anfang 4.2. Entwicklung unter FastCGI
    \ No newline at end of file diff --git a/doc/html/index.html b/doc/html/index.html index c13455101..053d5d410 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
       Weiter

    kivitendo 3.4.1: 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.2.3. Andere 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: + kivitendo 3.4.1: Installation, Konfiguration, Entwicklung
    kivitendo 3.4.1: Installation, Konfiguration, Entwicklung
       Weiter

    kivitendo 3.4.1: 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.2.3. Andere 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. Erfolgsrechnung
    2.18. Rundung in Verkaufsbelegen
    2.19. Einstellungen pro Mandant
    2.20. 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
    3.6. Schweizer Kontenpläne
    3.7. Artikelklassifizierung
    3.7.1. Übersicht
    3.7.2. Basisklassifizierung
    3.7.3. Attribute
    3.7.4. Zwei-Zeichen Abkürzung
    3.8. Dateiverwaltung (Mini-DMS)
    3.8.1. Übersicht
    3.8.2. Struktur
    3.8.3. Anwendung
    3.8.4. Konfigurierung
    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 + 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
    3.6. Schweizer Kontenpläne
    3.7. Artikelklassifizierung
    3.7.1. Übersicht
    3.7.2. Basisklassifizierung
    3.7.3. Attribute
    3.7.4. Zwei-Zeichen Abkürzung
    3.8. Dateiverwaltung (Mini-DMS)
    3.8.1. Übersicht
    3.8.2. Struktur
    3.8.3. Anwendung
    3.8.4. Konfigurierung
    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 cf0c2e112..1d09b849c 100644 Binary files a/doc/kivitendo-Dokumentation.pdf and b/doc/kivitendo-Dokumentation.pdf differ