X-Git-Url: http://wagnertech.de/git?a=blobdiff_plain;ds=sidebyside;f=doc%2Fdokumentation.xml;h=7e1f7baa3386f79aa1a14c0bbf20220af758c61b;hb=bc0292d97dea8c1bb4acd4194a59462597c5b856;hp=7316c07e40ab6f1a7477228d11d09c6cd8cef382;hpb=e63bbc9fa291b69315dec89dd51e7ef18a2e0448;p=kivitendo-erp.git diff --git a/doc/dokumentation.xml b/doc/dokumentation.xml index 7316c07e4..7e1f7baa3 100644 --- a/doc/dokumentation.xml +++ b/doc/dokumentation.xml @@ -2,7 +2,7 @@ - kivitendo 3.4.1: Installation, Konfiguration, Entwicklung + kivitendo 3.5.0-beta: Installation, Konfiguration, Entwicklung Aktuelle Hinweise @@ -214,6 +214,10 @@ File::Copy::Recursive + + File::MimeInfo::Magic + + GD @@ -354,7 +358,7 @@ 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 \ + apt 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 \ @@ -364,7 +368,7 @@ libtext-iconv-perl liburi-perl libxml-writer-perl libyaml-perl \ libimage-info-perl libgd-gd2-perl libapache2-mod-fcgid \ libfile-copy-recursive-perl postgresql libalgorithm-checkdigits-perl \ - libcrypt-pbkdf2-perl git + libcrypt-pbkdf2-perl git libcgi-pm-perl Für das Paket HTML::Restrict gibt es kein Debian-Paket, dies @@ -418,6 +422,25 @@ cpan HTML::Restrict cpan Rose::Db::Object + + 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 + Seitenanzahl von PDF_Dokumenten 'pdfinfo' benötigt was im Paket + 'poppler-utils' enthalten ist. + + Ubuntu: apt install poppler-utils + + OpenSuSE: zypper install poppler-tools + + Foreneintrag - (Stand Sept. 2015) + (Stand Sept. 2015) und einen aktuellen (Stand Mai 2017) + + SSL-Konfigurations-Generator. @@ -1790,7 +1815,7 @@ systemctl enable kivitendo-task-server.service debianoiden Betriebssystemen installiert man die Pakete mit: apt-get install texlive-base-bin texlive-latex-recommended texlive-fonts-recommended \ - exlive-latex-extra texlive-lang-german texlive-generic-extra + texlive-latex-extra texlive-lang-german texlive-generic-extra Für Fedora benötigen Sie die folgenden Pakete: @@ -2983,7 +3008,7 @@ systemctl enable kivitendo-task-server.service Achtung: Werden Verkaufsbelege in anderen Währungen als der Standardwährung erstellt, so muss in - kivitendo 3.4.1 die Genauigkeit 0.01 verwendet werden. + kivitendo ab Version 3.4.1 die Genauigkeit 0.01 verwendet werden. Das heisst, Firmen in der Schweiz, die teilweise Verkaufsrechnungen in Euro oder anderen Währungen erstellen wollen, müssen beim Erstellen der Datenbank als Genauigkeit 0.01 wählen und können zur Zeit die @@ -5274,13 +5299,18 @@ systemctl enable kivitendo-task-server.service Allgemeine Variablen in Mahnungen - Die Variablen des Verkäufers stehen wie gewohnt als - employee_... zur Verfügung. Die Adressdaten des - Kunden stehen als Variablen name, + Die Variablen des Bearbeiters, bzw. Verkäufers stehen wie gewohnt als + employee_... bzw. salesman_... zur Verfügung. + Werden mehrere Rechnungen in einer Mahnung zusammengefasst, so werden + die Metadaten (Bearbeiter, Abteilung, etc) der ersten angemahnten Rechnung + im Ausdruck genommen. + Die Adressdaten des Kunden stehen als Variablen name, street, zipcode, city, country, department_1, department_2, - und email zur Verfügung. + und email zur Verfügung. Der Ansprechpartner cp_... + steht auch zu Verfügung, wird allerdings auch nur von der ersten angemahnten Rechnung (s.o.) + genommen. Weitere Variablen beinhalten: @@ -6220,6 +6250,337 @@ Beschreibung: <%description%> Vorschläge für weitere (z.B. branchenspezifische) Kontenpläne bitte an empfang@revamp-it.ch senden. + + + Artikelklassifizierung + + + Ü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. + + + + 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 + + + + + + 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 + (LaTeX) zusätzliche Variable + + + + Beim separat ausweisen stehen im LaTeX die Variable <%non_separate_subtotal%> zur Verfügung, + 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%> . + + + + 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) + entspricht der lokalisierten Abkürzung der Klassifizierung. + + Diese Abkürzung wird überall beim Auflisten von Artikeln zur + Erleichterung mit dargestellt. + + + + + Dateiverwaltung (Mini-DMS) + + + Übersicht + 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. + + + + Übersicht + + + + + + + + + + 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, + die zu bestimmten ERP-Daten (ERP-Objekte, wi z.B. Rechnung, Lieferschein) gehören. + + + "attachment", zusätzlich hochgeladene Dokumente, die an bestimmte ERP-Objekte angehängt werden, + z.B. technische Zeichnungen,Aufmaße. Diese können auch an Artikeln, + Lieferanten und Kunden hinterlegt sein + + + "image", Bilder an Artikeln. Diese können auch verkleinert in einer Vorschau (Thumbnail) + angezeigt werden. + + + Zusätzlich werden in der Datenbank zu den Dateien neben der Zuordnung zu ERP-Objekten, des Dateityps + des Dateinamens und des Backends in dem die Datei gespeichert ist auch die Quelle der Datei notiert: + + + + "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 . + + + + Anwendung + Die Daten werden bei den ERP-Objekten als extra Reiter dargestellt. + Eine Verkaufsrechnung z.B. hat die + Reiter "Dokumente" und "Dateianhänge. + + Reiter "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. + Vorher wird der Anwender durch einen Dialog ob er eine neue Version anlegen will oder + ob er die Datei umbenennen will, falls es eine neue Datei sein soll. + + Reiter "Dateianhänge" + + + + + + + Es können mehrere Dateien gleichzeitig hochgeladen werden, + solange in Summe die maximale Größe nicht überschritten wird. + (siehe + + Reiter "Dokumente" + + + + + + + Sind keine weiteren Quellen für Dokumente konfiguriert, so gibt es nur "erzeugte Dokumente". + Es werden alle Versionen der generierten Datei angezeigt. Für Verkaufsrechnungen kommen keine + anderen Quellen zur Geltung. Werden entsprechend + zusätzliche Quellen konfiguriert, so sind diese z.B. bei + Einkaufsrechnungen sichtbar: + + Reiter "Dokumente" + + + + + + + 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. + + + + Konfigurierung + + Mandantenkonfigurierung + + 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 + + Mandantenkonfig Reiter "Features" + + + + + + + Die einzelnen Backends sind einzeln einschaltbar. Spezifische Backend-Konfigurierungen sind hier + noch ergänzbar. + + + 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. + + Mandantenkonfig Reiter "Allgemeine Dokumentenanhänge" + + + + + + + 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 + die Anhänge zum Generierungszeitpunkt eingebettet sind. + + + + + 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 +----+-----------+--------------+---------+----------+--------------------------- + 1 | #default# | file_sources | 0.00000 | scanner1 | + {"dir":"/var/tmp/scanner1","desc":"Scanner Einkauf"} + 2 | #default# | file_sources | 0.00000 | scanner2 | + {"dir":"/var/tmp/scanner2","desc":"Scanner Verkauf"} + 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. + + + 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 + + + @@ -6502,8 +6863,7 @@ Beschreibung: <%description%> - Enthält unter anderem Listenbegrenzung vclimit, - Datumsformat dateformat und Nummernformat numberformat + Enthält unter anderem Datumsformat dateformat und Nummernformat numberformat @@ -7490,6 +7850,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 @@ -7669,7 +8039,7 @@ Support::TestSetup::login(); sein. Dieser wird für die Datenbankverbindung benötigt. Wir keine vollständig initialisierte Umgebung benötigt, so - kann die letzte Zeile Support::TestSetup::login(); + kann die letzte Zeile Support::TestSetup::login(); weggelassen werden, was die Ausführungszeit des Scripts leicht verringert.