X-Git-Url: http://wagnertech.de/git?a=blobdiff_plain;f=doc%2Fdokumentation.xml;h=1a22f0c54723e5609b922d61e47956c089240f7d;hb=ecefbf9abb0a7638241e51b1902b2f830850ce56;hp=6917944bb66c8e61a858b15352eb234615570aa0;hpb=e725668550139cf352547e8eb9c5fa3108f78b42;p=kivitendo-erp.git diff --git a/doc/dokumentation.xml b/doc/dokumentation.xml index 6917944bb..1a22f0c54 100644 --- a/doc/dokumentation.xml +++ b/doc/dokumentation.xml @@ -2,7 +2,7 @@ - kivitendo 3.5.4: Installation, Konfiguration, + <title>kivitendo 3.5.5: Installation, Konfiguration, Entwicklung @@ -13,7 +13,7 @@ im Community-Forum: https://forum.kivitendo.de:32443 + url="https://forum.kivitendo.de">https://forum.kivitendo.de @@ -428,7 +428,8 @@ libdatetime-set-perl libset-infinite-perl liblist-utilsby-perl\ libdaemon-generic-perl libfile-flock-perl libfile-slurp-perl\ libfile-mimeinfo-perl libpbkdf2-tiny-perl libregexp-ipv6-perl \ - libdatetime-event-cron-perl libexception-class-perl + libdatetime-event-cron-perl libexception-class-perl libcam-pdf-perl \ + libxml-libxml-perl Sollten Pakete nicht zu Verfügung stehen, so können diese auch mittels CPAN installiert werden. Ferner muss für Ubuntu das Repository "Universe" aktiv sein (s.a. Anmerkungen). @@ -554,7 +555,7 @@ cpan HTML::Restrict - aqbanking-tools Für das Parsen des MT940 Bankformats + aqbanking-tools Für das Parsen des MT940 Bankformats (Version 6 oder höher) poppler-utils 'pdfinfo' zum Erkennen der Seitenanzahl bei der PDF-Generierung @@ -644,24 +645,30 @@ git checkout `git tag -l | egrep -ve "(alpha|beta|rc)" | tail -1` $ git clone https://github.com/kivitendo/kivitendo-erp.git $ cd kivitendo-erp/ -$ git checkout release-3.4.1 # das ist der aktuelle release, den wir wollen -$ git add templates/fullhouse # das sind unsere druckvorlagen inkl. produktbilder -$ git commit -m "juhu tolle ändernungen" +$ git checkout release-3.4.1 # das ist ein alter release aus dem wir starten ... +$ git checkout -b meine_eigene_änderungen # unser lokaler branch - unabhängig von allen anderen +$ git add templates/mein_druck # das sind unsere druckvorlagen inkl. produktbilder +$ git commit -m "juhu tolle änderungen" + [meine_aenderungen 1d89e41] juhu tolle ändernungen 4 files changed, 380 insertions(+) - create mode 100644 templates/fullhouse/img/webdav/tesla.png - create mode 100644 templates/fullhouse/mahnung.tex - create mode 100644 templates/fullhouse/zahlungserinnerung_zwei.tex - create mode 100644 templates/fullhouse/zahlungserinnerung_zwei_invoice.tex + create mode 100644 templates/mein_druck/img/webdav/tesla.png + create mode 100644 templates/mein_druck/mahnung.tex + create mode 100644 templates/mein_druck/zahlungserinnerung_zwei.tex + create mode 100644 templates/mein_druck/zahlungserinnerung_zwei_invoice.tex # 5 Jahre später ... +# webserver abschalten! + +$ git checkout master +$ git pull # oder git fetch und danach ein stable release tag auswählen (s.o.) +$ git checkout meine_eigenen_änderungen +$ git rebase master -$ git fetch -$ git rebase --onto release-3.5.0 release-3.4.1 meine_aenderungen Zunächst wird der Branch zurückgespult, um Ihre Änderungen darauf neu anzuwenden ... -Wende an: juhu tolle ändernungen -$ service apache2 restart +Wende an: juhu tolle änderungen +$ service apache2 restart # webserver starten! @@ -1480,7 +1487,7 @@ systemctl enable kivitendo-task-server.service status berichtet, ob der Task-Server läuft. - + yy Der Task-Server wechselt beim Starten automatisch in das @@ -1493,8 +1500,59 @@ systemctl enable kivitendo-task-server.service so startet dieser nach Beendigung automatisch erneut. - + + Exemplarische Konfiguration eines Hintergrund-Jobs, der die Jahreszahl in allen Nummernkreisen zum Jahreswechsel erhöht + + Hintergrund-Jobs werden über System -> Hintergrund-Jobs und Task-Server -> Aktuelle Hintergrund-Jobs anzeigen -> Aktions-Knopf 'erfassen' angelegt. + Nachdem wir über das Menü dort angelangt sind, legen wir unseren exemplarischen Hintergrund-Jobs "Erhöhung der Nummernkreise" mit folgenden Werten an: + + + Aktiv: Hier ein 'Ja' auswählen + + + Ausführungsart: 'wiederholte Ausführung' auswählen + + + Paketname: 'SetNumberRange' auswählen + + + Ausführungszeitplan: Hier entsprechend Werte wie in der crontab eingeben.Syntax: +* * * * * +┬ ┬ ┬ ┬ ┬ +│ │ │ │ │ +│ │ │ │ └──── Wochentag (0-7, Sonntag ist 0 oder 7) +│ │ │ └────── Monat (1-12) +│ │ └──────── Tag (1-31) +│ └────────── Stunde (0-23) +└──────────── Minute (0-59) + Die Sterne können folgende Werte haben: + +1 2 3 4 5 +1 = Minute (0-59) +2 = Stunde (0-23) +3 = Tag (0-31) +4 = Monat (1-12) +5 = Wochentag (0-7, Sonntag ist 0 oder 7) + +Um die Ausführung auf eine Minute vor Sylvester zu setzen, müssen die folgenden Werte eingetragen werden: +59 23 31 12 * + + + Daten:In diesem Feld können optionale Parameter für den Hintergrund im JSON-Format gesetzt werden. Der Hintergrund-Job SetNumberRange akzeptiert zwei Variable nämlich digit_year sowieso multiplier. digit_year kann zwei Werte haben entweder 2 oder 4, darüber wird gesteuert ob die Jahreszahl zwei oder vierstellig kodiert wird (für 2019, dann entweder 19 oder 2019). Der Standardwert ist vierstellig. multiplier ist ein Vielfaches von 10, darüber wird die erste Nummer im Nummernkreis (die Anzahl der Stellen) wie folgt bestimmt: + +multiplier Nummernkreis 2020 +10 -> 20200 +100 -> 202000 +1000 -> 2020000 + +Wir gehen jetzt beispielhaft von einer letzten Rechnungsnummer von RE2019456 aus. Demnach sollte ab Januar 2020 die erste Nummer RE2020001 sein. Da der Task auch Präfixe berücksichtigt, kann dies mit folgenden JSON-kodierten Werten umgesetzt werden: +Daten:multiplier: 100 +digits_year: 4 + + + + Benutzerauthentifizierung und Administratorpasswort @@ -1514,9 +1572,8 @@ systemctl enable kivitendo-task-server.service Datenbank, in der sowohl die Benutzerinformationen als auch die Daten abgelegt werden. - Zusätzlich ermöglicht es kivitendo, dass die Benutzerpasswörter - entweder gegen die Authentifizierungsdatenbank oder gegen einen - LDAP-Server überprüft werden. + Zusätzlich ermöglicht es kivitendo, dass die Benutzerpasswörter gegen die Authentifizierungsdatenbank oder gegen einen oder + mehrere LDAP-Server überprüft werden. Welche Art der Passwortüberprüfung kivitendo benutzt und wie kivitendo die Authentifizierungsdatenbank erreichen kann, wird in der @@ -1599,22 +1656,28 @@ systemctl enable kivitendo-task-server.service Passwortüberprüfung kivitendo unterstützt Passwortüberprüfung auf zwei Arten: gegen - die Authentifizierungsdatenbank und gegen einen externen LDAP- oder + die Authentifizierungsdatenbank und gegen externe LDAP- oder Active-Directory-Server. Welche davon benutzt wird, regelt der Parameter module im Abschnitt [authentication]. - Sollen die Benutzerpasswörter in der Authentifizierungsdatenbank - gespeichert werden, so muss der Parameter module - den Wert DB enthalten. In diesem Fall können sowohl - der Administrator als auch die Benutzer selber ihre Passwörter in - kivitendo ändern. + Dieser Parameter listet die zu verwendenden Authentifizierungsmodule auf. Es muss mindestens ein Modul angegeben werden, es + können aber auch mehrere angegeben werden. Weiterhin ist es möglich, das LDAP-Modul mehrfach zu verwenden und für jede Verwendung + eine unterschiedliche Konfiguration zu nutzen, z.B. um einen Fallback-Server anzugeben, der benutzt wird, sofern der Hauptserver + nicht erreichbar ist. + + Sollen die Benutzerpasswörter in der Authentifizierungsdatenbank geprüft werden, so muss der Parameter + module das Modul DB enthalten. Sofern das Modul in der Liste enthalten ist, egal an welcher + Position, können sowohl der Administrator als auch die Benutzer selber ihre Passwörter in kivitendo ändern. - Soll hingegen ein externer LDAP- oder Active-Directory-Server - benutzt werden, so muss der Parameter module auf - LDAP gesetzt werden. In diesem Fall müssen - zusätzliche Informationen über den LDAP-Server im Abschnitt - [authentication/ldap] angegeben werden: + Wenn Passwörter gegen einen oder mehrere externe LDAP- oder Active-Directory-Server geprüft werden, so muss der Parameter + module den Wert LDAP enthalten. In diesem Fall müssen zusätzliche Informationen über den + LDAP-Server im Abschnitt [authentication/ldap] angegeben werden. Das Modul kann auch mehrfach angegeben werden, + wobei jedes Modul eine eigene Konfiguration bekommen sollte. Der Name der Konfiguration wird dabei mit einem Doppelpunkt getrennt an + den Modulnamen angehängt (LDAP:Name-der-Konfiguration). Der entsprechende Abschnitt in der Konfigurationsdatei + lautet dann [authentication/Name-der-Konfiguration]. + + Die verfügbaren Parameter für die LDAP-Konfiguration lauten: @@ -1645,6 +1708,17 @@ systemctl enable kivitendo-task-server.service + + verify + + + Wenn Verbindungsverschlüsselung gewünscht und der Parameter tls gesetzt ist, so gibt dieser + Parameter an, ob das Serverzertifikat auf Gültigkeit geprüft wird. Mögliche Werte sind require (Zertifikat + wird überprüft und muss gültig sei; dies ist der Standard) und none (Zertifikat wird nicht + überpfüft). + + + attribute @@ -1694,6 +1768,14 @@ systemctl enable kivitendo-task-server.service also ‘Martin Mustermann’. + + + timeout + + + Timeout beim Verbindungsversuch, bevor der Server als nicht erreichbar gilt; Standardwert: 10 + + @@ -4516,6 +4598,15 @@ systemctl enable kivitendo-task-server.service + + natural_person + + + Flag "natürliche Person"; Siehe auch + + + + payment_description @@ -5296,7 +5387,7 @@ systemctl enable kivitendo-task-server.service longdescription - Langtext + Langtext, vorbelegt mit dem Feld Bemerkungen der entsprechenden Ware @@ -6415,6 +6506,21 @@ Beschreibung: <%description%> Der Befehl <bullet> funktioniert momentan auch nur in Latex-Vorlagen. + + + Hinweise zur Anrede + + Das Flag "natürliche Person" + (natural_person) aus den Kunden- oder + Lieferantenstammdaten kann in den Druckvorlagen zusammen mit + dem Feld "Anrede" (greeting) z.B. dafür + verwendet werden, die Anrede zwischen einer allgemeinen und + einer persönlichen Anrede zu unterscheiden. + <%if natural_person%><%greeting%> <%name%><%else%>Sehr geehrte Damen und Herren<%end if%> + + + @@ -7222,6 +7328,148 @@ document_path = /var/local/kivi_documents url="https://developers.shopware.com/developers-guide/rest-api/">https://developers.shopware.com/developers-guide/rest-api/ + + ZUGFeRD Rechnungen + + Vorbedingung + + Für die Erstellung von ZUGFeRD PDFs wird TexLive2018 oder höher benötigt. + + + + Wer kein TexLive2018 oder höher installieren kann, kann eine lokale Umgebung nur für kivitendo wie folgt erzeugen: + + + 1. Download des offiziellen Installers von https://www.tug.org/texlive/quickinstall.html + + 2. Installer ausführen, Standard-Ort für Installation belassen, evtl. ein paar Pakete abwählen, installieren lassen + + 3. Ein kleine Script »run_pdflatex.sh« anlegen, das den PATH auf das Installationsverezichnis setzt und pdflatex ausführt: + + ------------------------------------------------------------ + #!/bin/bash + + export PATH=/usr/local/texlive/2020/bin/x86_64-linux:$PATH + hash -r + + exec pdflatex $@ + ------------------------------------------------------------ + + 4. In config/kivitendo.conf den Parameter »latex« auf den Pfad zu »run_pdflatex.sh« setzen + + 5. Webserver neu starten + + + + + Übersicht + + Mit der Version 3.5.6 bietet kivitendo die Möglichkeit ZUGFeRD + Rechnungen zu erstellen, sowie auch ZUGFeRD Rechnungen direkt in + kivitendo einzulesen. + + Bei ZUGFeRD Rechnungen handelt es sich um eine PDF Datei in + der eine XML-Datei eingebettet ist. Der Aufbau der XML-Datei ist + standardisiert und ermöglicht so den Austausch zwischen + den verschiedenen Softwareprodukten. Kivitendo setzt mit der + Version 3.5.6 den ZUGFeRD 2.1 Standard um. + + Weiter Details zu ZUGFeRD sind unter diesem Link zu finden: + https://www.ferd-net.de/standards/was-ist-zugferd/index.html + + + + + + Erstellen von ZUGFeRD Rechnungen in Kivitendo + Für die Erstellung von ZUGFeRD Rechnungen bedarf es in + kivitendo zwei Dinge: + + + + + Die Erstellung muss in der Mandantenkonfiguration + aktiviert sein + + + + Beim mindestens einem Bankkonto muss die Option + „Nutzung von ZUGFeRD“ aktiviert sein + + + + + Mandantenkonfiguration + + Die Einstellung für die Erstellung von ZUGFeRD Rechnungen + erfolgt unter „System“ → „Mandatenkonfiguration“ → „Features“. + Im Abschnitt „Einkauf und Verkauf“ finden Sie die Einstellung + „Verkaufsrechnungen mit ZUGFeRD-Daten erzeugen“. + Hier besteht die Auswahl zwischen: + + + + ZUGFeRD-Rechnungen erzeugen + + + + ZUGFeRD-Rechnungen im Testmodus erzeugen + + + + Keine ZUGFeRD Rechnungen erzeugen + + + + + Rechnungen die als PDF erzeugt werden, werden je nach + Einstellung nun im ZUGFeRD Format ausgegeben. + + + + + Konfiguration der Bankkonten + + Unter „System → Bankonten“ muss bei mindestens einem + Bankkonto die Option „Nutzung mit ZUGFeRD“ auf „Ja“ gestellt + werden. + + + + + + + Einlesen von ZUGFeRD Rechnungen in Kivitendo + + Es lassen sich auch Rechnungen von Kreditoren, die im + ZUGFeRD Format erstellt wurden im Kivitendo importieren. + Hierfür müssen auch zwei Voraussetzungen erfüllt werden: + + + + + + Beim Lieferanten muss die Umsatzsteuer-ID und das + Bankkonto hinterlegt sein + + + + Für den Kreditoren muss eine Buchungsvorlage existieren. + + + + + Wenn diese Voraussetzungen erfüllt sind, kann die Rechnung + über „Finanzbuchhaltung“ → „ZUGFeRD Import“ über die „Durchsuchen“ + Schaltfläche ausgewählt werden und über die Schaltfläche „Import“ + eingeladen werden. Es öffnet sich daraufhin die Kreditorenbuchung. + Die auslesbaren Daten aus dem eingebetteten XML der PDF Datei + werden in der Kreditorenbuchung ergänzt. + + + + + @@ -8410,7 +8658,7 @@ Template/LaTeX Template/OpenDocument filenames - The last of which is very machine dependant. Remember that + The last of which is very machine dependent. Remember that a lot of characters are forbidden by some filesystems, for example MS Windows doesn't like ':' in its files where Linux doesn't mind that. If you want the files created with your