From: Martin Helmling martin.helmling@octosoft.eu Date: Wed, 14 Jun 2017 05:43:49 +0000 (+0200) Subject: Dokumentation neu generiert X-Git-Tag: release-3.5.4~1046 X-Git-Url: http://wagnertech.de/git?a=commitdiff_plain;h=0d70422712e7f5b41ca26d39e66f183c33603614;p=kivitendo-erp.git Dokumentation neu generiert --- diff --git a/doc/html/ch03s08.html b/doc/html/ch03s08.html index 1b1310e8a..b4e013060 100644 --- a/doc/html/ch03s08.html +++ b/doc/html/ch03s08.html @@ -29,7 +29,7 @@ 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.

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 @@ -46,4 +46,8 @@ 3 | #default# | file_sources | 0.00000 | emails | {"dir":"/var/tmp/emails","desc":"Empfangene Mails" }

Es ist daran gedacht, statt dem default Eintrag später für bestimmte Benutzer ('login') bestimmte Quellen zuzulassen, - dies wird nach Bedarf implementiert.

Zurück Nach oben Weiter
3.7. Artikelklassifizierung Zum Anfang Kapitel 4. Entwicklerdokumentation
\ No newline at end of file + dies wird nach Bedarf implementiert.

3.8.4.3. kivitendo-Konfigurationsdatei

Dort ist im Abschnitt [paths] der relative oder absolute Pfad zum Dokumentenwurzelverzeichnis einzutragen. + Dieser muss für den Webserver schreib- und lesbar sein, jedoch nicht ausführbar.

+[paths]
+document_path = /var/local/kivi_documents
+

Unter diesem Wurzelverzeichnis wird pro Mandant automatisch ein Unterverzeichnis mit der ID des Mandanten angelegt

Zurück Nach oben Weiter
3.7. Artikelklassifizierung Zum Anfang Kapitel 4. Entwicklerdokumentation
\ No newline at end of file diff --git a/doc/html/ch04.html b/doc/html/ch04.html index dec11c579..06f840350 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/images/DMS-ClientConfig.png b/doc/html/images/DMS-ClientConfig.png index 1e1fc12e1..6bf721faa 100644 Binary files a/doc/html/images/DMS-ClientConfig.png and b/doc/html/images/DMS-ClientConfig.png differ diff --git a/doc/html/index.html b/doc/html/index.html index faf4255ab..3727423d0 100644 --- a/doc/html/index.html +++ b/doc/html/index.html @@ -3,5 +3,5 @@ kivitendo 3.5.0-beta: Installation, Konfiguration, Entwicklung
kivitendo 3.5.0-beta: Installation, Konfiguration, Entwicklung
   Weiter

kivitendo 3.5.0-beta: 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/images/DMS-ClientConfig.png b/doc/images/DMS-ClientConfig.png index 1e1fc12e1..6bf721faa 100644 Binary files a/doc/images/DMS-ClientConfig.png and b/doc/images/DMS-ClientConfig.png differ diff --git a/doc/kivitendo-Dokumentation.pdf b/doc/kivitendo-Dokumentation.pdf index 833489e58..afc13cca1 100644 Binary files a/doc/kivitendo-Dokumentation.pdf and b/doc/kivitendo-Dokumentation.pdf differ