1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4 <book id="kivitendo-documentation" lang="de">
5 <title>kivitendo 3.6.0: Installation, Konfiguration,
8 <chapter id="Aktuelle-Hinweise">
9 <title>Aktuelle Hinweise</title>
11 <para>Aktuelle Installations- und Konfigurationshinweise gibt es:</para>
15 <para>im Community-Forum: <ulink
16 url="https://forum.kivitendo.de">https://forum.kivitendo.de</ulink></para>
20 <para>im Kunden-Forum: <ulink
21 url="http://redmine.kivitendo-premium.de/projects/forum/boards/">http://redmine.kivitendo-premium.de/projects/forum/boards/</ulink></para>
25 <para>in der doc/UPGRADE Datei im doc-Verzeichnis der
30 <para>Im Schulungs- und Dienstleistungsangebot der entsprechenden
31 kivitendo-Partner: <ulink
32 url="http://www.kivitendo.de/partner.html">http://www.kivitendo.de/partner.html</ulink></para>
38 <title>Installation und Grundkonfiguration</title>
40 <sect1 id="Installation-Übersicht">
41 <title>Übersicht</title>
43 <para>Die Installation von kivitendo umfasst mehrere Schritte. Die
44 folgende Liste kann sowohl für Neulinge als auch für alte Hasen als
45 Übersicht und Stichpunktliste zum Abhaken dienen, um eine Version mit
46 minimalen Features möglichst schnell zum Laufen zu kriegen.</para>
50 <para><emphasis>Voraussetzungen überprüfen</emphasis>: kivitendo
51 benötigt gewisse Ressourcen und benutzt weitere Programme. Das
52 Kapitel "<xref linkend="Benötigte-Software-und-Pakete"/>" erläutert
53 diese. Auch die Liste der benötigten Perl-Module befindet sich
58 <para><emphasis>Installation von kivitendo</emphasis>: Diese umfasst
59 die "<xref linkend="Manuelle-Installation-des-Programmpaketes"/>"
60 sowie grundlegende Einstellungen, die der "<xref
61 linkend="config.config-file"/>" erläutert.</para>
65 <para><emphasis>Konfiguration externer Programme</emphasis>: hierzu
66 gehören die Datenbank ("<xref
67 linkend="Anpassung-der-PostgreSQL-Konfiguration"/>") und der
68 Webserver ("<xref linkend="Apache-Konfiguration"/>").</para>
72 <para><emphasis>Benutzerinformationen speichern können</emphasis>:
73 man benötigt mindestens eine Datenbank, in der Informationen zur
74 Authentifizierung sowie die Nutzdaten gespeichert werden. Wie man
75 das als Administrator macht, verrät "<xref
76 linkend="Benutzerauthentifizierung-und-Administratorpasswort"/>".</para>
80 <para><emphasis>Benutzer, Gruppen und Datenbanken
81 anlegen</emphasis>: wie dies alles zusammenspielt erläutert "<xref
82 linkend="Benutzer--und-Gruppenverwaltung"/>".</para>
86 <para><emphasis>Los geht's</emphasis>: alles soweit erledigt? Dann
87 kann es losgehen: "<xref linkend="kivitendo-ERP-verwenden"/>"</para>
91 <para>Alle weiteren Unterkapitel in diesem Kapitel sind ebenfalls
92 wichtig und sollten vor einer ernsthaften Inbetriebnahme gelesen
96 <sect1 id="Benötigte-Software-und-Pakete">
97 <title>Benötigte Software und Pakete</title>
99 <sect2 id="Betriebssystem">
100 <title>Betriebssystem</title>
102 <para>kivitendo ist für Linux konzipiert, und sollte auf jedem
103 unixoiden Betriebssystem zum Laufen zu kriegen sein. Getestet ist
104 diese Version im speziellen auf Debian und Ubuntu, grundsätzlich wurde
105 bei der Auswahl der Pakete aber darauf Rücksicht genommen, dass es
106 ohne große Probleme auf den derzeit aktuellen verbreiteten
107 Distributionen läuft.</para>
109 <para>Mitte 2020 (ab Version 3.5.6) empfehlen wir:</para>
117 <para>10.0 "Buster"</para>
120 <para>11.0 "Bullseye"</para>
126 <para>20.04 "Focal Fossa" LTS
131 <para>openSUSE Leap 15.x und SUSE Linux Enterprise Server 15 GA</para>
135 <para>Fedora 29</para>
140 <sect2 id="Pakete" xreflabel="Pakete">
141 <title>Benötigte Perl-Pakete installieren</title>
143 <para>Zum Betrieb von kivitendo werden zwingend ein Webserver (meist
144 Apache) und ein Datenbankserver (PostgreSQL) in einer aktuellen
145 Version (s.a. Liste der unterstützten Betriebssysteme)
148 <para>Zusätzlich benötigt kivitendo einige Perl-Pakete, die nicht
149 Bestandteil einer Standard-Perl-Installation sind. Um zu überprüfen,
150 ob die erforderlichen Pakete installiert und aktuell genug sind, wird
151 ein Script mitgeliefert, das wie folgt aufgerufen wird:</para>
153 <programlisting>./scripts/installation_check.pl</programlisting>
155 <para>Die vollständige Liste der benötigten Perl-Module lautet:</para>
159 <para><literal>Algorithm::CheckDigits</literal></para>
163 <para><literal>Archive::Zip</literal></para>
167 <para><literal>CAM::PDF</literal></para>
171 <para><literal>CGI</literal></para>
175 <para><literal>Clone</literal></para>
179 <para><literal>Config::Std</literal></para>
183 <para><literal>Daemon::Generic</literal></para>
187 <para><literal>DateTime</literal></para>
191 <para><literal>DateTime::Event::Cron</literal></para>
195 <para><literal>DateTime::Format::Strptime</literal></para>
199 <para><literal>DateTime::Set</literal></para>
203 <para><literal>DBI</literal></para>
207 <para><literal>DBD::Pg</literal></para>
211 <para><literal>Digest::SHA</literal></para>
215 <para><literal>Email::Address</literal></para>
219 <para><literal>Email::MIME</literal></para>
223 <para><literal>Exception::Class</literal></para>
227 <para><literal>FCGI</literal> (nicht Versionen 0.68 bis 0.71
228 inklusive; siehe <xref
229 linkend="Apache-Konfiguration.FCGI.WebserverUndPlugin"/>)</para>
233 <para><literal>File::Copy::Recursive</literal></para>
237 <para><literal>File::Flock</literal></para>
241 <para><literal>File::MimeInfo</literal></para>
245 <para><literal>File::Slurp</literal></para>
249 <para><literal>GD</literal></para>
253 <para><literal>HTML::Parser</literal></para>
257 <para><literal>HTML::Restrict</literal></para>
261 <para><literal>Image::Info</literal></para>
265 <para><literal>Imager</literal></para>
269 <para><literal>Imager::QRCode</literal></para>
273 <para><literal>JSON</literal></para>
277 <para><literal>List::MoreUtils</literal></para>
281 <para><literal>List::UtilsBy</literal></para>
285 <para>LWP::Authen::Digest</para>
289 <para>LWP::UserAgent</para>
293 <para><literal>Net::SMTP::SSL</literal> (optional, bei
294 E-Mail-Versand über SSL; siehe Abschnitt "<xref
295 linkend="config.sending-email.smtp"/>")</para>
299 <para><literal>Net::SSLGlue</literal> (optional, bei
300 E-Mail-Versand über TLS; siehe Abschnitt "<xref
301 linkend="config.sending-email.smtp"/>")</para>
305 <para><literal>Math::Round</literal></para>
309 <para><literal>Params::Validate</literal></para>
313 <para><literal>PBKDF2::Tiny</literal></para>
317 <para><literal>PDF::API2</literal></para>
321 <para><literal>Regexp::IPv6</literal></para>
325 <para><literal>Rest::Client</literal></para>
329 <para><literal>Rose::Object</literal></para>
333 <para><literal>Rose::DB</literal></para>
337 <para><literal>Rose::DB::Object</literal> Version 0.788 oder
342 <para><literal>Set::Infinite</literal></para>
346 <para><literal>String::ShellQuote</literal></para>
350 <para><literal>Sort::Naturally</literal></para>
354 <para><literal>Template</literal></para>
358 <para><literal>Text::CSV_XS</literal></para>
362 <para><literal>Text::Iconv</literal></para>
366 <para><literal>Text::Unidecode</literal></para>
370 <para><literal>Try::Tiny</literal></para>
374 <para><literal>URI</literal></para>
378 <para><literal>XML::Writer</literal></para>
382 <para><literal>XML::LibXML</literal></para>
386 <para><literal>YAML::XS</literal> oder <literal>YAML</literal></para>
391 <para>Seit Version größer v3.5.8 sind die folgenden Pakete hinzugekommen: <literal>Imager</literal>, <literal>Imager::QRCode</literal>
392 <literal>Rest::Client</literal><literal>Term::ReadLine::Gnu</literal></para>
394 <para>Seit Version größer v3.5.6 sind die folgenden Pakete hinzugekommen: <literal>Try::Tiny</literal>, <literal>Math::Round</literal></para>
395 <para>Seit Version größer v3.5.6 sind die folgenden Pakete hinzugekommen: <literal>XML::LibXML</literal>, <literal>CAM::PDF</literal></para>
396 <para>Seit Version größer v3.5.3 sind die folgenden Pakete hinzugekommen: <literal>Exception::Class</literal></para>
398 <para>Seit Version größer v3.5.1 sind die folgenden Pakete hinzugekommen: <literal>Set::Infinite</literal>,
399 <literal>List::UtilsBy</literal>, <literal>DateTime::Set</literal>, <literal>DateTime::Event::Cron</literal>
400 <literal>Daemon::Generic</literal>, <literal>DateTime::Event::Cron</literal>, <literal>File::Flock</literal>,
401 <literal>File::Slurp</literal></para>
403 <para>Seit Version größer v3.5.0 sind die folgenden Pakete
404 hinzugekommen: <literal>Text::Unidecode</literal>,
405 <literal>LWP::Authen::Digest</literal>,
406 <literal>LWP::UserAgent</literal></para>
408 <para>Seit Version v3.4.0 sind die folgenden Pakete hinzugekommen:
409 <literal>Algorithm::CheckDigits</literal>,
410 <literal>PBKDF2::Tiny</literal></para>
412 <para>Seit Version v3.2.0 sind die folgenden Pakete hinzugekommen:
413 <literal>GD</literal>, <literal>HTML::Restrict</literal>,
414 <literal>Image::Info</literal></para>
416 <para>Seit v3.0.0 sind die folgenden Pakete hinzugekommen:
417 <literal>File::Copy::Recursive</literal>.</para>
419 <para>Seit v2.7.0 sind die folgenden Pakete hinzugekommen:
420 <literal>Email::MIME</literal>, <literal>Net::SMTP::SSL</literal>,
421 <literal>Net::SSLGlue</literal>.</para>
423 <para>Gegenüber Version 2.6.0 sind zu dieser Liste 2 Pakete
424 hinzugekommen, <literal>URI</literal> und
425 <literal>XML::Writer</literal> sind notwendig. Ohne startet kivitendo
428 <para>Gegenüber Version 2.6.1 sind <literal>parent</literal>,
429 <literal>DateTime</literal>, <literal>Rose::Object</literal>,
430 <literal>Rose::DB</literal> und <literal>Rose::DB::Object</literal>
431 neu hinzugekommen. <literal>IO::Wrap</literal> wurde entfernt.</para>
433 <para>Gegenüber Version 2.6.3 ist <literal>JSON</literal> neu
434 hinzugekommen.</para>
436 <para><literal>Email::Address</literal> und
437 <literal>List::MoreUtils</literal> sind schon länger feste
438 Abhängigkeiten, wurden aber bisher mit kivitendo mitgeliefert. Beide
439 sind auch in 2.6.1 weiterhin mit ausgeliefert, wurden in einer
440 zukünftigen Version aber aus dem Paket entfernt werden. Es wird
441 empfohlen diese Module zusammen mit den anderen als Bibliotheken zu
445 <title>Debian und Ubuntu</title>
446 <para>Für Debian und Ubuntu stehen die meisten der benötigten
447 Pakete als Debian-Pakete zur Verfügung. Sie können mit
448 folgendem Befehl installiert werden:</para>
450 <programlisting>apt install apache2 libarchive-zip-perl libclone-perl \
451 libconfig-std-perl libdatetime-perl libdbd-pg-perl libdbi-perl \
452 libemail-address-perl libemail-mime-perl libfcgi-perl libjson-perl \
453 liblist-moreutils-perl libnet-smtp-ssl-perl libnet-sslglue-perl \
454 libparams-validate-perl libpdf-api2-perl librose-db-object-perl \
455 librose-db-perl librose-object-perl libsort-naturally-perl \
456 libstring-shellquote-perl libtemplate-perl libtext-csv-xs-perl \
457 libtext-iconv-perl liburi-perl libxml-writer-perl libyaml-perl \
458 libimage-info-perl libgd-gd2-perl libapache2-mod-fcgid \
459 libfile-copy-recursive-perl postgresql libalgorithm-checkdigits-perl \
460 libcrypt-pbkdf2-perl git libcgi-pm-perl libtext-unidecode-perl libwww-perl \
461 postgresql-contrib poppler-utils libhtml-restrict-perl \
462 libdatetime-set-perl libset-infinite-perl liblist-utilsby-perl \
463 libdaemon-generic-perl libfile-flock-perl libfile-slurp-perl \
464 libfile-mimeinfo-perl libpbkdf2-tiny-perl libregexp-ipv6-perl \
465 libdatetime-event-cron-perl libexception-class-perl libcam-pdf-perl \
466 libxml-libxml-perl libtry-tiny-perl libmath-round-perl \
467 libimager-perl libimager-qrcode-perl librest-client-perl \
469 <para>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).</para>
470 <note id="ubuntu-universe">
471 <para>Die Perl Pakete für Ubuntu befinden sich im "Universe" Repository. Falls dies nicht aktiv ist, kann dies mit folgendem Aufruf aktiviert werden:
472 <programlisting>add-apt-repository universe</programlisting></para>
477 <title>Fedora</title>
479 <para>Für Fedora stehen die meisten der benötigten Perl-Pakete als
480 RPM-Pakete zur Verfügung. Sie können mit folgendem Befehl
481 installiert werden:</para>
483 <programlisting>dnf install httpd mod_fcgid postgresql-server postgresql-contrib\
484 perl-Algorithm-CheckDigits perl-Archive-Zip perl-CPAN perl-Class-XSAccessor \
485 perl-Clone perl-Config-Std perl-DBD-Pg perl-DBI perl-Daemon-Generic \
486 perl-DateTime perl-DateTime-Set perl-Email-Address perl-Email-MIME perl-FCGI \
487 perl-File-Copy-Recursive perl-File-Flock perl-File-MimeInfo perl-File-Slurp \
488 perl-GD perl-HTML-Restrict perl-JSON perl-List-MoreUtils perl-List-UtilsBy \
489 perl-Net-SMTP-SSL perl-Net-SSLGlue perl-PBKDF2-Tiny perl-PDF-API2 \
490 perl-Params-Validate perl-Regexp-IPv6 perl-Rose-DB perl-Rose-DB-Object \
491 perl-Rose-Object perl-Sort-Naturally perl-String-ShellQuote \
492 perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv perl-URI perl-XML-Writer \
493 perl-YAML perl-libwww-perl</programlisting>
497 <title>openSUSE Leap 15.x und SUSE Linux Enterprise Server 15 GA</title>
499 <para>Für openSUSE Leap 15.x stehen die meisten der benötigten Perl-Pakete als RPM-Pakete zur Verfügung.</para>
500 <para>Damit diese installiert werden können, muß das System die erforderlichen Repositories kennen und Zugriff über das Internet darauf haben.</para>
501 <para>Daher machen wir die Repositories dem System bekannt.</para>
502 <para>Um die zusätzlichen Repositories für die Installation zur Verfügung zu stellen, kann man diese mit YaST oder auch in einem Terminal auf der Konsole bekannt geben. Wir beschränken uns hier mit der Eingabe auf der Konsole. In den allermeisten Fällen verwenden die Administratoren eine sichere SSH-Verbindung zum zu administrierenden Server.</para>
503 <para>Dazu geben wir folgenden Befehl ein:</para>
504 <programlisting>zypper addrepo -f \
505 http://download.opensuse.org/repositories/devel:languages:perl/openSUSE_Leap_15.2/ \
506 "devel:languages:perl"
508 <programlisting>zypper addrepo -f \
509 https://download.opensuse.org/repositories/devel:languages:haskell:lts:13/\
510 openSUSE_Leap_15.0/ "devel:languages:haskell:lts:13"
512 <programlisting>zypper addrepo -f \
513 https://download.opensuse.org/repositories/devel:languages:haskell:lts:13/\
514 openSUSE_Leap_15.0/ "devel:languages:haskell:lts:13"
516 <para>Danach geben wir noch die beiden folgenden Befehle ein:</para>
517 <programlisting>zypper clean</programlisting>
518 <programlisting>zypper refresh</programlisting>
519 <para>Sollte zypper eine Meldung ausgeben, ob der Repositorie Key abgelehnt, nicht vertraut oder für immer akzeptiert werden soll, ist die Beantwortung durch drücken der "i" Taste am besten geeignet. Wer noch mehr über zypper erfahren möchte, kann sich einmal die zypper Hilfe anschauen.</para>
520 <programlisting>zypper --help</programlisting>
522 <para>Offiziell wird von openSUSE nur noch Versionen ab 15.2 unterstützt. Die SuSE Macher haben ab Version 15.x einen großen Umbau in der Verwaltung der Pakete vorgenommen, das heißt, der Paketumfang ist der SLES 15 als Programmunterbau angepasst. Dies gilt besonders der openSUSE Distribution. Es gibt ja einmal die openSUSE Distri und die Professionelle SLES Version. Dadurch sind viele Pakete aus dem ursprünglich nur für die openSUSE geltenen Repositorie enfernt worden, aber auch viele auf aktuellem Stand gehalten.</para>
524 <para>Ab openSUSE Leap 15.x kann man die Distribution auch als reine Text Version, also ohne KDE Oberfläche aufsetzen. Vorteil hierbei ist, dass weniger Balast und unnötige Pakte installiert werden.</para>
525 <para>Bei openSUSE Versionen bis 15.x, also 10.x, 11.x, 12.x, 13.x hatte der Administrator die Möglichkeit, bei der Installation der Distribution die KDE Oberfläche zu aktivieren. In dieser Konstellation hat man die Möglichkeit, eine VNC Verbindung vom administrativen Client zu verwenden. Ist das nicht eingerichtet, arbeitet der Admin dann direkt am Bildschirm des Servers. Nun loggen wir uns am Server direkt ein, starten Yast2 in einer Konsole wie folgt:</para>
526 <para>yast2 return.</para>
527 <para>Oder über die Menüführung wie folgt: Ein Klick auf das runde Icon, ganz links unten in der Menüleiste, dann die Maus verfahren auf System und YaST.</para>
528 <para>Im weiteren Verlauf der Installation, beschränken wir uns mit dem Installations Werkzeug zypper. Zypper ist ein Komandozeilen basiertes Installations Tool, welches bei openSUSE Standard ist. Zypper weist ein etwas eigenartiges Verhalten auf, dass sich in etwa wie folgt darstellt. Hat man die Repositories eingerichtet, kann man diese mit Yast als auch mit Zypper benutzen, setzt man einen Befehl wie etwa: zypper up ab, so findet zypper mehr neuere Programmversionen als Yast. Ich habe im allgemeinen noch keine Nachteile damit erlebt.</para>
529 <para>Programmpakete können mit folgendem Befehl installiert werden:</para>
530 <para>zypper install Paketname</para>
531 <para>Es wird empfohlen zusätzliche Pakete nicht direkt mit CPAN zu installieren, da man diese auch über andere Repositories beziehen kann, die bei openSUSE zur Verfügung stehen. Dadurch hat man den Vorteil, dass die Pakete mit YaST verwaltet werden, also wieder deinstalliert oder durch neuere ersetzt werden können. Zudem kann man auch noch eventuelle Bugs an openSUSE senden und diese dem Maintainer melden.</para>
533 <programlisting>zypper install perl-threads-shared ghc-pdfinfo apache2-mod_fcgid \
534 yast2-http-server postgresql-server postgresql-contrib perl-Algorithm-CheckDigits \
535 perl-Archive-Zip perl-CGI perl-CGI-Ajax perl-Clone \
536 perl-Config-Std perl-Class-XSAccessor perl-Daemon-Generic perl-DateTime \
537 perl-DateTime-Event-Cron perl-DateTime-Format-Strptime perl-DateTime-Set \
538 perl-DBI perl-DBD-Pg perl-Devel-REPL perl-FastCGI perl-Email-Address \
539 perl-Email-MIME perl-Email-MIME-ContentType perl-Email-MIME-Encodings \
540 perl-FCGI perl-File-Copy-Recursive perl-File-Flock perl-File-MimeInfo \
541 perl-File-Slurp perl-GD perl-HTML-Restrict perl-Image-Info \
542 perl-JSON perl-List-MoreUtils perl-List-UtilsBy perl-Log-Log4perl perl-Net-LDAP-Server \
543 perl-Net-SSLGlue perl-Net-SMTP-SSL perl-PBKDF2-Tiny perl-PDF-API2 \
544 perl-Params-Validate perl-Regexp-IPv6 perl-Rose-DB perl-Rose-Object \
545 perl-Rose-DB-Object perl-MooseX-Role-Cmd perl-Set-Crontab perl-Set-Infinite \
546 perl-Sort-Naturally perl-String-ShellQuote perl-Sys-CPU perl-Template-Toolkit \
547 perl-Text-CSV_XS perl-Test-Deep perl-Test-Output perl-Text-Iconv \
548 perl-Text-Unidecode perl-URI perl-URI-Find perl-XML-Writer \
549 perl-YAML perl-libwww-perl
552 <para>Für die Entwickler installiert man noch die folgenden Pakete:</para>
554 <programlisting>zypper install ghc-mtl-devel ghc-old-locale-devel \
555 ghc-process-extras-devel ghc-rpm-macros ghc-text-devel ghc-time-devel \
556 ghc-Cabal-devel ghc-time-locale-compat-devel perl-Log-Log4perl ghc-pdfinfo \
557 ghc-pdfinfo-devel perl-Devel-REPL perl-URI-Find perl-Class-Utils \
558 perl-Error-Pure perl-File-Object perl-Readonly perl-Test-Warnings \
559 perl-Test-NoWarnings perl-Test-Deep perl-Test-Output perl-Test-Strict \
560 perl-Test-LongString perl-File-Find-Rule
563 <para>Zusätzlich müssen einige Pakete für den Umgang mit Latex installiert werden. Die Latex Module barcodes sind nützliche Helfer um auch Barcodes im Dokument zu platzieren, der Vollständigkeit halber hier für die Installation mit angegeben.
564 Dazu können Sie die folgenden Befehle nutzen:</para>
566 <programlisting>zypper install texlive-wallpaper texlive-colortbl \
567 texlive-scrlttr2copy texlive-eurosym \
568 texlive-geometry texlive-german texlive-graphbox texlive-hyperref \
569 texlive-xifthen texlive-luainputenc texlive-lastpage texlive-ltabptch \
570 texlive-nomentbl texlive-threeparttablex texlive-substr texlive-tabulary \
571 texlive-ulem texlive-wallpaper texlive-xcolor texlive-xstring \
572 texlive-xypic texlive-mwe texlive-mweights texlive-barcodes \
573 texlive-GS1 texlive-ean texlive-makebarcode texlive-pst-barcode \
577 <para>Zusätzlich müssen einige Pakete aus dem CPAN installiert
578 werden. Dazu können Sie die folgenden Befehle anwenden:</para>
580 <programlisting>cpan DateTime::event::Cron DateTime::Set FCGI \
581 HTML::Restrict PBKDF2::Tiny Rose::Db::Object Set::Infinite</programlisting>
586 <title>Andere Pakete installieren</title>
590 <para><literal>poppler-utils</literal> 'pdfinfo' zum Erkennen der Seitenanzahl bei der PDF-Generierung</para>
593 <para><literal>Postgres Trigram-Index</literal> Für datenbankoptimierte Suchanfragen. Bspw. im Paket <literal>postgresql-contrib</literal> enthalten</para>
596 <para>Debian und Ubuntu: <programlisting>apt install postgresql-contrib poppler-utils</programlisting></para>
597 <para>Fedora: <programlisting>dnf install poppler-utils postgresql-contrib</programlisting></para>
598 <para>openSUSE: <programlisting>zypper install poppler-tools</programlisting></para>
602 <sect1 id="Manuelle-Installation-des-Programmpaketes"
603 xreflabel="Manuelle Installation des Programmpaketes">
604 <title>Manuelle Installation des Programmpaketes</title>
606 <para>Der aktuelle Stable-Release, bzw. beta Release wird bei github
607 gehostet und kann <ulink
608 url="https://github.com/kivitendo/kivitendo-erp/releases">hier</ulink>
609 heruntergeladen werden.</para>
611 <para>Das aktuelleste kivitendo ERP-Archiv
612 (<filename>kivitendo-erp-*.tgz</filename>) wird dann im
613 Dokumentenverzeichnis des Webservers (z.B.
614 <filename>/var/www/html/</filename>,
615 <filename>/srv/www/htdocs</filename> oder
616 <filename>/var/www/</filename>) entpackt:</para>
618 <programlisting>cd /var/www
619 tar xvzf kivitendo-erp-*.tgz</programlisting>
621 <para>Wechseln Sie in das entpackte Verzeichnis:</para>
623 <programlisting>cd kivitendo-erp</programlisting>
625 <para>Alternativ können Sie auch einen Alias in der
626 Webserverkonfiguration benutzen, um auf das tatsächliche
627 Installationsverzeichnis zu verweisen.</para>
629 <para>Bei einer Neuinstallation von Version 3.1.0 oder später muß das
630 WebDAV Verzeichnis derzeit manuell angelegt werden:</para>
632 <programlisting>mkdir webdav</programlisting>
634 <para>Die Verzeichnisse <filename>users</filename>,
635 <filename>spool</filename> und <filename>webdav</filename> müssen für
636 den Benutzer beschreibbar sein, unter dem der Webserver läuft. Die
637 restlichen Dateien müssen für diesen Benutzer lesbar sein. Die Benutzer-
638 und Gruppennamen sind bei verschiedenen Distributionen unterschiedlich
639 (z.B. bei Debian/Ubuntu <constant>www-data</constant>, bei Fedora
640 <constant>apache</constant> oder bei openSUSE
641 <constant>wwwrun</constant>).</para>
643 <para>Der folgende Befehl ändert den Besitzer für die oben genannten
644 Verzeichnisse auf einem Debian/Ubuntu-System:</para>
646 <programlisting>chown -R www-data users spool webdav</programlisting>
648 <para>Weiterhin muss der Webserver-Benutzer in den Verzeichnissen
649 <filename>templates</filename> und <filename>users</filename>
650 Unterverzeichnisse für jeden neuen Benutzer anlegen dürfen, der in
651 kivitendo angelegt wird:</para>
653 <programlisting>chown www-data templates users</programlisting>
656 <para>Wir empfehlen eine Installation mittels des Versionsmanagager
657 git. Hierfür muss ein git-Client installiert sein. Damit ist man sehr
658 viel flexibler für zukünftige Upgrades. Installations-Anleitung (bitte
659 die Pfade anpassen) bspw. wie folgt: <programlisting>cd /var/www/
660 git clone https://github.com/kivitendo/kivitendo-erp.git
662 git checkout `git tag -l | egrep -ve "(alpha|beta|rc)" | tail -1`</programlisting>
663 Erläuterung: Der Befehl wechselt zur letzten Stable-Version (git tag
664 -l listet alle Tags auf, das egrep schmeisst alle Einträge mit alpha,
665 beta oder rc raus und das tail gibt davon den obersten Treffer
666 zurück). Sehr sinnvoll ist es, direkt im Anschluss einen eigenen
667 Branch zu erzeugen, um bspw. seine eigenen Druckvorlagen-Anpassungen
668 damit zu verwalten. Hierfür reicht ein simples <programlisting> git checkout -b meine_eigenen_änderungen</programlisting>
669 nach dem letzten Kommando (weiterführende Informationen <ulink
670 url="http://www-cs-students.stanford.edu/~blynn/gitmagic/index.html">
671 Git Magic</ulink>).</para>
673 <para>Ein beispielhafter Workflow für Druckvorlagen-Anpassungen von
674 3.4.1 nach 3.5: <programlisting>
675 $ git clone https://github.com/kivitendo/kivitendo-erp.git
677 $ git checkout release-3.4.1 # das ist ein alter release aus dem wir starten ...
678 $ git checkout -b meine_eigene_änderungen # unser lokaler branch - unabhängig von allen anderen
679 $ git add templates/mein_druck # das sind unsere druckvorlagen inkl. produktbilder
680 $ git commit -m "juhu tolle änderungen"
682 [meine_aenderungen 1d89e41] juhu tolle ändernungen
683 4 files changed, 380 insertions(+)
684 create mode 100644 templates/mein_druck/img/webdav/tesla.png
685 create mode 100644 templates/mein_druck/mahnung.tex
686 create mode 100644 templates/mein_druck/zahlungserinnerung_zwei.tex
687 create mode 100644 templates/mein_druck/zahlungserinnerung_zwei_invoice.tex
690 # webserver abschalten!
692 $ git checkout master
693 $ git pull # oder git fetch und danach ein stable release tag auswählen (s.o.)
694 $ git checkout meine_eigenen_änderungen
697 Zunächst wird der Branch zurückgespult, um Ihre Änderungen
698 darauf neu anzuwenden ...
699 Wende an: juhu tolle änderungen
700 $ service apache2 restart # webserver starten!
701 </programlisting></para>
705 <sect1 id="config.config-file">
706 <title>kivitendo-Konfigurationsdatei</title>
708 <sect2 id="config.config-file.introduction"
709 xreflabel="Einführung in die Konfigurationsdatei">
710 <title>Einführung</title>
712 <para>In kivitendo gibt es nur noch eine Konfigurationsdatei, die
713 benötigt wird: <filename>config/kivitendo.conf</filename> (kurz: "die
714 Hauptkonfigurationsdatei"). Diese muss bei der Erstinstallation von
715 kivitendo bzw. der Migration von älteren Versionen angelegt
718 <para>Als Vorlage dient die Datei
719 <filename>config/kivitendo.conf.default</filename> (kurz: "die
720 Default-Datei"):</para>
722 <programlisting>$ cp config/kivitendo.conf.default config/kivitendo.conf</programlisting>
724 <para>Die Default-Datei wird immer zuerst eingelesen. Werte, die in
725 der Hauptkonfigurationsdatei stehen, überschreiben die Werte aus der
726 Default-Datei. Die Hauptkonfigurationsdatei muss also nur die
727 Abschnitte und Werte enthalten, die von denen der Default-Datei
731 <para>Vor der Umbenennung in kivitendo hieß diese Datei noch
732 <filename>config/lx_office.conf</filename>. Aus Gründen der
733 Kompatibilität wird diese Datei eingelesen, sofern die Datei
734 <filename>config/kivitendo.conf</filename> nicht existiert.</para>
737 <para>Diese Hauptkonfigurationsdatei ist dann eine
738 installationsspezifische Datei, d.h. sie enthält bspw. lokale
739 Passwörter und wird auch nicht im Versionsmanagement (git)
742 <para>Die Konfiguration ist ferner serverabhängig, d.h. für alle
743 Mandaten, bzw. Datenbanken gleich.</para>
746 <sect2 id="config.config-file.sections-parameters">
747 <title>Abschnitte und Parameter</title>
749 <para>Die Konfigurationsdatei besteht aus mehreren Teilen, die
750 entsprechend kommentiert sind:</para>
754 <para><literal>authentication</literal> (siehe Abschnitt "<xref
755 linkend="Benutzerauthentifizierung-und-Administratorpasswort"/>"
756 in diesem Kapitel)</para>
760 <para><literal>authentication/database</literal></para>
764 <para><literal>authentication/ldap</literal></para>
768 <para><literal>system</literal></para>
772 <para><literal>paths</literal></para>
776 <para><literal>mail_delivery</literal> (siehe Abschnitt "<xref
777 linkend="config.sending-email.smtp"/>)</para>
781 <para><literal>applications</literal></para>
785 <para><literal>environment</literal></para>
789 <para><literal>print_templates</literal></para>
793 <para><literal>task_server</literal></para>
797 <para><literal>periodic_invoices</literal></para>
801 <para><literal>self_tests</literal></para>
805 <para><literal>console</literal></para>
809 <para><literal>testing</literal></para>
813 <para><literal>testing/database</literal></para>
817 <para><literal>debug</literal></para>
821 <para>Die üblicherweise wichtigsten Parameter, die am Anfang
822 einzustellen oder zu kontrollieren sind, sind:</para>
824 <programlisting>[authentication]
825 admin_password = geheim
827 [authentication/database]
835 default_manager = german</programlisting>
837 <para>Für kivitendo Installationen in der Schweiz sollte hier
838 <varname>german</varname> durch <varname>swiss</varname> ersetzt
841 <para>Die Einstellung <varname>default_manager = swiss</varname>
846 <para>Beim Erstellen einer neuen Datenbank in der kivitendo
847 Administration werden automatisch die Standard-Werte für die
848 Schweiz voreingestellt: Währung CHF, 5er-Rundung, Schweizer
849 KMU-Kontenplan, Sollversteuerung, Aufwandsmethode, Bilanzierung
850 (die Werte können aber manuell angepasst werden).</para>
854 <para>Einstellen der Standardkonten für Rundungserträge und
855 -aufwendungen (unter Mandantenkonfiguration → Standardkonten
860 <para>das verwendete Zahlenformat wird auf
861 <varname>1'000.00</varname> eingestellt (unter Programm →
862 Benutzereinstellungen veränderbar)</para>
866 <para>DATEV-Automatik und UStVA werden nicht angezeigt,
867 Erfolgsrechnung ersetzt GUV ( unter Mandantenkonfiguration →
868 Features veränderbar)</para>
872 <para>Nutzt man wiederkehrende Rechnungen, kann man unter
873 <varname>[periodic_invoices]</varname> den Login eines Benutzers
874 angeben, der nach Erstellung der Rechnungen eine entsprechende E-Mail
875 mit Informationen über die erstellten Rechnungen bekommt.</para>
877 <para>kivitendo bringt eine eigene Komponente zur zeitgesteuerten
878 Ausführung bestimmter Aufgaben mit, den <link
879 linkend="config.task-server">Task-Server</link>. Er wird u.a. für
880 Features wie die <link
881 linkend="features.periodic-invoices">wiederkehrenden Rechnungen</link>
882 benötigt, erledigt aber auch andere erforderliche Aufgaben und muss
883 daher in Betrieb genommen werden. Seine Einrichtung wird im Abschnitt
884 <link linkend="config.task-server">Task-Server</link> genauer
887 <para>Für Entwickler finden sich unter <varname>[debug]</varname>
888 wichtige Funktionen, um die Fehlersuche zu erleichtern.</para>
891 <sect2 id="config.config-file.prior-versions">
892 <title>Versionen vor 2.6.3</title>
894 <para>In älteren kivitendo Versionen gab es im Verzeichnis
895 <filename>config</filename> die Dateien
896 <filename>authentication.pl</filename> und
897 <filename>lx-erp.conf</filename>, die jeweils Perl-Dateien waren. Es
898 gab auch die Möglichkeit, eine lokale Version der Konfigurationsdatei
899 zu erstellen (<filename>lx-erp-local.conf</filename>). Dies ist ab
900 2.6.3 nicht mehr möglich, aber auch nicht mehr nötig.</para>
902 <para>Beim Update von einer kivitendo-Version vor 2.6.3 auf 2.6.3 oder
903 jünger müssen die Einstellungen aus den alten Konfigurationsdateien
904 manuell übertragen und die alten Konfigurationsdateien anschließend
905 gelöscht oder verschoben werden. Ansonsten zeigt kivitendo eine
906 entsprechende Fehlermeldung an.</para>
910 <sect1 id="Anpassung-der-PostgreSQL-Konfiguration">
911 <title>Anpassung der PostgreSQL-Konfiguration</title>
913 <para>PostgreSQL muss auf verschiedene Weisen angepasst werden.</para>
914 <para>Dies variert je nach eingesetzter Distribution, da distributionsabhängig unterschiedliche Strategien beim Upgrade der Postgres Version eingesetzt werden.
915 Als Hinweis einige Links zu den drei Distribution (Stand Dezember 2018):</para>
918 <para><ulink url="https://fedoraproject.org/wiki/PostgreSQL">Fedora (Postgres-Installation unter Fedora)</ulink></para>
921 <para><ulink url="https://help.ubuntu.com/lts/serverguide/postgresql.html">Ubuntu (Infos für Postgres für die aktuelle LTS Version)</ulink></para>
924 <para><ulink url="https://de.opensuse.org/PostgreSQL">OpenSuSE (aktuell nur bis Version OpenSuSE 13 verifiziert)</ulink></para>
927 <sect2 id="Zeichensätze-die-Verwendung-von-UTF-8">
928 <title>Zeichensätze/die Verwendung von Unicode/UTF-8</title>
930 <para>kivitendo setzt zwingend voraus, dass die Datenbank
931 Unicode/UTF-8 als Encoding einsetzt. Bei aktuellen
932 Serverinstallationen braucht man hier meist nicht einzugreifen.</para>
934 <para>Das Encoding des Datenbankservers kann überprüft werden. Ist das
935 Encoding der Datenbank "template1" "Unicode" bzw. "UTF-8", so braucht
936 man nichts weiteres diesbezüglich unternehmen. Zum Testen:</para>
938 <programlisting>su postgres
940 exit </programlisting>
942 <para>Andernfalls ist es notwendig, einen neuen Datenbankcluster mit
943 Unicode-Encoding anzulegen und diesen zu verwenden. Unter Debian und
944 Ubuntu kann dies z.B. für PostgreSQL 9.3 mit dem folgenden Befehl
947 <programlisting>pg_createcluster --locale=de_DE.UTF-8 --encoding=UTF-8 9.3 clustername</programlisting>
949 <para>Die Datenbankversionsnummer muss an die tatsächlich verwendete
950 Versionsnummer angepasst werden.</para>
952 <para>Unter anderen Distributionen gibt es ähnliche Methoden.</para>
954 <para>Das Encoding einer Datenbank kann in <command>psql</command> mit
955 <literal>\l</literal> geprüft werden.</para>
958 <sect2 id="Änderungen-an-Konfigurationsdateien">
959 <title>Änderungen an Konfigurationsdateien</title>
961 <para>In der Datei <filename>postgresql.conf</filename>, die je nach
962 Distribution in verschiedenen Verzeichnissen liegen kann (z.B.
963 <filename>/var/lib/pgsql/data/</filename> oder
964 <filename>/etc/postgresql/</filename>), muss sichergestellt werden,
965 dass TCP/IP-Verbindungen aktiviert sind. Das Verhalten wird über den
966 Parameter <varname>listen_address</varname> gesteuert. Laufen
967 PostgreSQL und kivitendo auf demselben Rechner, so kann dort der Wert
968 <literal>localhost</literal> verwendet werden. Andernfalls müssen
969 Datenbankverbindungen auch von anderen Rechnern aus zugelassen werden,
970 was mit dem Wert <literal>*</literal> geschieht.</para>
972 <para>In der Datei <filename>pg_hba.conf</filename>, die im gleichen
973 Verzeichnis wie die <filename>postgresql.conf</filename> zu finden
974 sein sollte, müssen die Berechtigungen für den Zugriff geändert
975 werden. Hier gibt es mehrere Möglichkeiten. Sinnvoll ist es nur die
976 nötigen Verbindungen immer zuzulassen, für eine lokal laufende
977 Datenbank zum Beispiel:</para>
979 <programlisting>local all kivitendo password
980 host all kivitendo 127.0.0.1 255.255.255.255 password</programlisting>
983 <sect2 id="Erweiterung-für-servergespeicherte-Prozeduren">
984 <title>Erweiterung für servergespeicherte Prozeduren</title>
986 <para>In der Datenbank <literal>template1</literal> muss die
987 Unterstützung für servergespeicherte Prozeduren eingerichet werden.
988 Melden Sie sich dafür als Benutzer “postgres” an der Datenbank an:
989 <programlisting>su - postgres
990 psql template1</programlisting> führen Sie die folgenden Kommandos aus:</para>
992 <programlisting>CREATE EXTENSION IF NOT EXISTS plpgsql;
996 <para><literal>CREATE EXTENSION</literal> ist seit Version 9.1 die
997 bevorzugte Syntax um die Sprache <literal>plpgsql</literal>
998 anzulegen. In diesen Versionen ist die Extension meist auch schon
999 vorhanden. Sollten Sie eine ältere Version von Postgres haben,
1000 benutzen Sie stattdessen den folgenden Befehl.</para>
1002 <programlisting>CREATE LANGUAGE 'plpgsql';
1007 <sect2 id="Erweiterung-für-trigram">
1008 <title>Erweiterung für Trigram Prozeduren</title>
1010 <para>Ab Version 3.5.1 wird die Trigram-Index-Erweiterung benötigt.
1011 Diese wird mit dem SQL-Updatescript
1012 sql/Pg-upgrade2/trigram_extension.sql und Datenbank-Super-Benutzer
1013 Rechten automatisch installiert. Dazu braucht der
1014 DatenbankSuperbenutzer "postgres" ein Passwort.</para>
1016 <programlisting>su - postgres
1023 <para>Benutzername Postgres und Passwort können jetzt beim Anlegen
1024 einer Datenbank bzw. bei Updatescripten, die SuperuserRechte
1025 benötigen, eingegeben werden.</para>
1028 <para><literal>pg_trgm</literal> ist je nach Distribution nicht im
1029 Standard-Paket von Postgres enthalten. Ein <programlisting>select * from pg_available_extensions where name ='pg_trgm';</programlisting>
1030 in template1 sollte entsprechend erfolgreich sein. Andernfalls muss
1031 das Paket nachinstalliert werden, bspw. bei debian/ubuntu
1032 <programlisting>apt install postgresql-contrib</programlisting></para>
1036 <sect2 id="Datenbankbenutzer-anlegen">
1037 <title>Datenbankbenutzer anlegen</title>
1039 <para>Wenn Sie nicht den Datenbanksuperuser “postgres” zum Zugriff
1040 benutzen wollen, so sollten Sie bei PostgreSQL einen neuen Benutzer
1041 anlegen. Ein Beispiel, wie Sie einen neuen Benutzer anlegen
1044 <para>Die Frage, ob der neue User Superuser sein soll, können Sie mit
1045 nein beantworten, genauso ist die Berechtigung neue User (Roles) zu
1046 generieren nicht nötig.</para>
1048 <programlisting>su - postgres
1049 createuser -d -P kivitendo
1050 exit</programlisting>
1052 <para>Wenn Sie später einen Datenbankzugriff konfigurieren, verändern
1053 Sie den evtl. voreingestellten Benutzer “postgres” auf “kivitendo”
1054 bzw. den hier gewählten Benutzernamen.</para>
1058 <sect1 id="Apache-Konfiguration">
1059 <title>Webserver-Konfiguration</title>
1062 <title>Grundkonfiguration mittels CGI</title>
1065 <para>Für einen deutlichen Performanceschub sorgt die Ausführung
1066 mittels FastCGI/FCGI. Die Einrichtung wird ausführlich im Abschnitt
1067 <xref linkend="Apache-Konfiguration.FCGI"/> beschrieben.</para>
1070 <para>Der Zugriff auf das Programmverzeichnis muss in der Apache
1071 Webserverkonfigurationsdatei <literal>httpd.conf</literal> eingestellt
1072 werden. Fügen Sie den folgenden Abschnitt dieser Datei oder einer
1073 anderen Datei hinzu, die beim Starten des Webservers eingelesen
1076 <programlisting>AliasMatch ^/kivitendo-erp/[^/]+\.pl /var/www/kivitendo-erp/dispatcher.pl
1077 Alias /kivitendo-erp/ /var/www/kivitendo-erp/
1079 <Directory /var/www/kivitendo-erp>
1080 AddHandler cgi-script .pl
1081 Options ExecCGI Includes FollowSymlinks
1084 <Directory /var/www/kivitendo-erp/users>
1086 </Directory></programlisting>
1088 <para>Ersetzen Sie dabei die Pfade durch diejenigen, in die Sie vorher
1089 das kivitendo-Archiv entpacket haben.</para>
1092 <para>Vor den einzelnen Optionen muss bei einigen Distributionen ein
1093 Plus ‘<literal>+</literal>’ gesetzt werden.</para>
1095 <para>Bei einigen Distribution (Ubuntu ab 14.04, Debian ab 8.2) muss
1096 noch explizit das cgi-Modul mittels <programlisting>a2enmod cgi</programlisting>
1097 aktiviert werden.</para>
1100 <para>Auf einigen Webservern werden manchmal die Grafiken und
1101 Style-Sheets nicht ausgeliefert. In solchen Fällen hat es oft
1102 geholfen, die folgende Option in die Konfiguration aufzunehmen:</para>
1104 <programlisting>EnableSendfile Off</programlisting>
1107 <sect2 id="Apache-Konfiguration.FCGI"
1108 xreflabel="Konfiguration für FastCGI/FCGI">
1109 <title>Konfiguration für FastCGI/FCGI</title>
1111 <sect3 id="Apache-Konfiguration.FCGI.WasIstEs">
1112 <title>Was ist FastCGI?</title>
1114 <para>Direkt aus <ulink
1115 url="http://de.wikipedia.org/wiki/FastCGI">Wikipedia</ulink>
1118 <para><citation> FastCGI ist ein Standard für die Einbindung
1119 externer Software zur Generierung dynamischer Webseiten in einem
1120 Webserver. FastCGI ist vergleichbar zum Common Gateway Interface
1121 (CGI), wurde jedoch entwickelt, um dessen Performance-Probleme zu
1122 umgehen. </citation></para>
1125 <sect3 id="Apache-Konfiguration.FCGI.Warum">
1126 <title>Warum FastCGI?</title>
1128 <para>Perl Programme (wie kivitendo eines ist) werden nicht statisch
1129 kompiliert. Stattdessen werden die Quelldateien bei jedem Start
1130 übersetzt, was bei kurzen Laufzeiten einen Großteil der Laufzeit
1131 ausmacht. Während SQL Ledger einen Großteil der Funktionalität in
1132 einzelne Module kapselt, um immer nur einen kleinen Teil laden zu
1133 müssen, ist die Funktionalität von kivitendo soweit gewachsen, dass
1134 immer mehr Module auf den Rest des Programms zugreifen. Zusätzlich
1135 benutzen wir umfangreiche Bibliotheken um Funktionaltät nicht selber
1136 entwickeln zu müssen, die zusätzliche Ladezeit kosten. All dies
1137 führt dazu dass ein kivitendo Aufruf der Kernmasken mittlerweile
1138 deutlich länger dauert als früher, und dass davon 90% für das Laden
1139 der Module verwendet wird.</para>
1141 <para>Mit FastCGI werden nun die Module einmal geladen, und danach
1142 wird nur die eigentliche Programmlogik ausgeführt.</para>
1145 <sect3 id="Apache-Konfiguration.FCGI.WebserverUndPlugin">
1146 <title>Getestete Kombinationen aus Webservern und Plugin</title>
1148 <para>Folgende Kombinationen sind getestet:</para>
1152 <para>Apache 2.4.7 (Ubuntu 14.04.2 LTS) und mod_fcgid.</para>
1155 <para>Apache 2.4.18 (Ubuntu 16.04 LTS) und mod_fcgid</para>
1158 <para>Apache 2.4.29 (Ubuntu 18.04 LTS) und mod_fcgid</para>
1161 <para>Apache 2.4.41 (Ubuntu 20.04 LTS) und mod_fcgid</para>
1166 <para>Als Perl Backend wird das Modul <filename>FCGI.pm</filename>
1170 <para>FCGI-Versionen ab 0.69 und bis zu 0.71 inklusive sind extrem
1171 strict in der Behandlung von Unicode, und verweigern bestimmte
1172 Eingaben von kivitendo. Falls es Probleme mit Umlauten in Ihrer
1173 Installation gibt, muss zwingend Version 0.68 oder aber Version
1174 0.72 und neuer eingesetzt werden.</para>
1176 <para>Mit <ulink url="http://www.cpan.org">CPAN</ulink> lässt sie
1177 sich die Vorgängerversion wie folgt installieren:</para>
1179 <programlisting>force install M/MS/MSTROUT/FCGI-0.68.tar.gz</programlisting>
1183 <sect3 id="Apache-Konfiguration.FCGI.Konfiguration">
1184 <title>Konfiguration des Webservers</title>
1186 <para>Bevor Sie versuchen, eine kivitendo Installation unter FCGI
1187 laufen zu lassen, empfiehlt es sich die Installation ersteinmal
1188 unter CGI aufzusetzen. FCGI macht es nicht einfach Fehler zu
1189 debuggen die beim ersten aufsetzen auftreten können. Sollte die
1190 Installation schon funktionieren, lesen Sie weiter.</para>
1192 <para>Zuerst muss das FastCGI-Modul aktiviert werden. Dies kann
1193 unter Debian/Ubuntu z.B. mit folgendem Befehl geschehen:</para>
1195 <programlisting>a2enmod fcgid</programlisting>
1197 <para>Die Konfiguration für die Verwendung von kivitendo mit FastCGI
1198 erfolgt durch Anpassung der vorhandenen <function>Alias</function>-
1199 und <function>Directory</function>-Direktiven. Dabei wird zwischen
1200 dem Installationspfad von kivitendo im Dateisystem
1201 ("<filename>/path/to/kivitendo-erp</filename>") und der URL
1202 unterschieden, unter der kivitendo im Webbrowser erreichbar ist
1203 ("<filename>/url/for/kivitendo-erp</filename>").</para>
1205 <para>Folgender Konfigurationsschnipsel funktioniert mit
1208 <programlisting>AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fcgi
1209 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
1211 <Directory /path/to/kivitendo-erp>
1213 Options ExecCGI Includes FollowSymlinks
1217 <DirectoryMatch /path/to/kivitendo-erp/users>
1219 </DirectoryMatch></programlisting>
1222 <para>Wer einen älteren Apache als Version 2.4 im Einsatz hat,
1223 muss entsprechend die Syntax der Directorydirektiven verändert.
1226 <programlisting>Require all granted</programlisting>
1228 <para>muß man Folgendes einstellen:</para>
1232 Allow from All </programlisting>
1234 <para>und statt</para>
1236 <programlisting>Require all denied</programlisting>
1238 <para>muss stehen:</para>
1242 Deny from All </programlisting>
1245 <para>Seit mod_fcgid-Version 2.3.6 gelten sehr kleine Grenzen für
1246 die maximale Größe eines Requests. Diese sollte wie folgt
1247 hochgesetzt werden:</para>
1249 <programlisting>FcgidMaxRequestLen 10485760</programlisting>
1251 <para>Das Ganze sollte dann so aussehen:</para>
1253 <programlisting>AddHandler fcgid-script .fpl
1254 AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
1255 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
1256 FcgidMaxRequestLen 10485760
1258 <Directory /path/to/kivitendo-erp>
1260 Options ExecCGI Includes FollowSymlinks
1264 <DirectoryMatch /path/to/kivitendo-erp/users>
1266 </DirectoryMatch></programlisting>
1268 <para>Hierdurch wird nur ein zentraler Dispatcher gestartet. Alle
1269 Zugriffe auf die einzelnen Scripte werden auf diesen umgeleitet.
1270 Dadurch, dass zur Laufzeit öfter mal Scripte neu geladen werden,
1271 gibt es hier kleine Performance-Einbußen.</para>
1273 <para>Es ist möglich, die gleiche kivitendo Version parallel unter
1274 CGI und FastCGI zu betreiben. Dafür bleiben die Directorydirektiven
1275 wie oben beschrieben, die URLs werden aber umgeleitet:</para>
1277 <programlisting># Zugriff über CGI
1278 Alias /url/for/kivitendo-erp /path/to/kivitendo-erp
1280 # Zugriff mit mod_fcgid:
1281 AliasMatch ^/url/for/kivitendo-erp-fcgid/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
1282 Alias /url/for/kivitendo-erp-fcgid/ /path/to/kivitendo-erp/</programlisting>
1284 <para>Dann ist unter <filename>/url/for/kivitendo-erp/</filename>
1285 die normale Version erreichbar, und unter
1286 <constant>/url/for/kivitendo-erp-fcgid/</constant> die
1287 FastCGI-Version.</para>
1292 <title>Authentifizierung mittels HTTP Basic Authentication</title>
1295 Kivitendo unterstützt, dass Benutzerauthentifizierung über den Webserver mittels des »Basic«-HTTP-Authentifizierungs-Schema erfolgt
1296 (siehe <ulink url="https://tools.ietf.org/html/rfc7617">RFC 7617</ulink>). Dazu ist es aber nötig, dass der dabei vom Client
1297 mitgeschickte Header <constant>Authorization</constant> vom Webserver an Kivitendo über die Umgebungsvariable
1298 <constant>HTTP_AUTHORIZATION</constant> weitergegeben wird, was standardmäßig nicht der Fall ist. Für Apache kann dies über die
1299 folgende Konfigurationsoption aktiviert werden:
1302 <programlisting>SetEnvIf Authorization "(.*)" HTTP_AUTHORIZATION=$1</programlisting>
1305 <title>Aktivierung von mod_rewrite/directory_match für git basierte Installationen</title>
1308 Aufgrund von aktuellen (Mitte 2020) Sicherheitswarnungen für git basierte Webanwendungen ist die mitausgelieferte .htaccess
1309 restriktiver geworden und verhindert somit das Auslesen von git basierten Daten.
1310 Für debian/ubuntu muss das Modul mod_rewrite einmalig so aktiviert werden:
1311 <programlisting>a2enmod rewrite</programlisting>
1312 Alternativ und für Installationen ohne Apache ist folgender Artikel interessant:
1313 <ulink url="https://www.cyberscan.io/blog/git-luecke">git-lücke</ulink>.
1314 Anstelle des dort beschriebenen DirectoryMatch für Apache2 würden wir etwas weitergehend auch noch das Verzeichnis config miteinbeziehen
1315 sowie ferner auch die Möglichkeit nicht ausschließen, dass es in Unterverzeichnissen auch noch .git Repositories geben kann.
1316 Die Empfehlung für Apache 2.4 wäre damit:
1318 <DirectoryMatch "/(\.git|config)/">
1320 </DirectoryMatch></programlisting>
1326 <title>Weitergehende Konfiguration</title>
1328 <para>Für einen deutlichen Sicherheitsmehrwert sorgt die Ausführung
1329 von kivitendo nur über https-verschlüsselten Verbindungen, sowie
1330 weiteren Zusatzmassnahmen, wie beispielsweise Basic Authenticate. Die
1331 Konfigurationsmöglichkeiten sprengen allerdings den Rahmen dieser
1332 Anleitung, hier ein Hinweis auf einen entsprechenden <ulink
1333 url="http://redmine.kivitendo-premium.de/boards/1/topics/142">Foreneintrag
1334 (Stand Sept. 2015)</ulink> und einen aktuellen (Stand Mai 2017) <ulink
1335 url="https://mozilla.github.io/server-side-tls/ssl-config-generator/">
1336 SSL-Konfigurations-Generator</ulink>.</para>
1339 <title>Aktivierung von Apache2 modsecurity</title>
1341 <para>Aufgrund des OpenSource Charakters ist kivitendo nicht "out of the box" sicher.
1342 Organisatorisch empfehlen wir hier die enge Zusammenarbeit mit einem kivitendo Partner der auch in der
1343 Lage ist weiterführende Fragen in Bezug auf Datenschutz und Datensicherheit zu beantworten.
1344 Unabhängig davon empfehlen wir im Webserver Bereich die Aktivierung und Konfiguration des Moduls modsecurity für den Apache2, damit
1345 XSS und SQL-Injections verhindert werden.</para>
1346 <para> Als Idee hierfür sei dieser Blog-Eintrag genannt:
1347 <ulink url="https://doxsec.wordpress.com/2017/06/11/using-modsecurity-web-application-firewall-to-prevent-sql-injection-and-xss-using-blocking-rules/">
1348 Test Apache2 modsecurity for SQL Injection</ulink>.</para>
1353 <sect1 id="config.task-server">
1354 <title>Der Task-Server</title>
1356 <para>Der Task-Server ist ein Prozess, der im Hintergrund läuft, in
1357 regelmäßigen Abständen nach abzuarbeitenden Aufgaben sucht und diese zu
1358 festgelegten Zeitpunkten abarbeitet (ähnlich wie Cron). Dieser Prozess
1359 wird u.a. für die Erzeugung der wiederkehrenden Rechnungen und weitere
1360 essenzielle Aufgaben benutzt.</para>
1362 <para>Der Task-Server muss einmalig global in der Konfigurationsdatei
1363 konfiguriert werden. Danach wird er für jeden Mandanten, für den er
1364 laufen soll, in der Adminsitrationsmaske eingeschaltet.</para>
1366 <para>Beachten Sie, dass der Task-Server in den Boot-Vorgang Ihres
1367 Servers integriert werden muss, damit er automatisch gestartet wird.
1368 Dies kann kivitendo nicht für Sie erledigen.</para>
1370 <para>Da der Task-Server als Perlscript läuft, wird Arbeitsspeicher, der
1371 einmal benötigt wurde, nicht mehr an das Betriebssystem zurückgegeben,
1372 solange der Task-Server läuft. Dies kann dazu führen, dass ein länger
1373 laufender Task-Server mit der Zeit immer mehr Arbeitsspeicher für sich
1374 beansprucht. Es ist deshalb sinnvoll, dass der Task-Server in
1375 regelmässigen Abständen neu gestartet wird. Allerdings berücksichtigt der
1376 Task-Server ein Memory-Limit, wenn dieses in der Konfigurationsdatei
1377 angegeben ist. Bei Überschreiten dieses Limits beendet sich der
1378 Task-Server. Sofern der Task-Server als systemd-Service mit dem
1379 mitgelieferten Skript eingerichtet wurde, startet dieser danach
1380 automatisch erneut.</para>
1382 <sect2 id="Konfiguration-des-Task-Servers">
1383 <title>Verfügbare und notwendige Konfigurationsoptionen</title>
1385 <para>Die Konfiguration erfolgt über den Abschnitt
1386 <literal>[task_server]</literal> in der Datei
1387 <filename>config/kivitendo.conf</filename>. Die dort verfügbaren
1388 Optionen sind:</para>
1392 <term><varname>run_as</varname></term>
1395 <para>Wird der Server vom Systembenutzer <literal>root</literal>
1396 gestartet, so wechselt er auf den mit <literal>run_as</literal>
1397 angegebenen Systembenutzer. Der Systembenutzer muss dieselben
1398 Lese- und Schreibrechte haben, wie auch der Webserverbenutzer
1400 linkend="Manuelle-Installation-des-Programmpaketes"/>). Daher
1401 ist es erforderlich, hier denselben Systembenutzer einzutragen,
1402 unter dem auch der Webserver läuft.</para>
1407 <term><varname>debug</varname></term>
1410 <para>Schaltet Debug-Informationen an und aus.</para>
1416 <sect2 id="Konfiguration-der-Mandanten-fuer-den-Task-Servers">
1417 <title>Konfiguration der Mandanten für den Task-Server</title>
1419 <para>Ist der Task-Server grundlegend konfiguriert, so muss
1420 anschließend jeder Mandant, für den der Task-Server laufen soll,
1421 einmalig konfiguriert werden. Dazu kann in der Maske zum Bearbeiten
1422 von Mandanten im Administrationsbereich eine kivitendo-Benutzerkennung
1423 ausgewählt werden, unter der der Task-Server seine Arbeit
1426 <para>Ist in dieser Einstellung keine Benutzerkennung ausgewählt, so
1427 wird der Task-Server für diesen Mandanten keine Aufgaben
1431 <sect2 id="Einbinden-in-den-Boot-Prozess">
1432 <title>Automatisches Starten des Task-Servers beim Booten</title>
1434 <para>Der Task-Server verhält sich von seinen Optionen her wie ein
1435 reguläres SystemV-kompatibles Boot-Script. Außerdem wechselt er beim
1436 Starten automatisch in das kivitendo-Installationsverzeichnis.</para>
1438 <para>Deshalb ist es möglich, ihn durch Setzen eines symbolischen
1439 Links aus einem der Runlevel-Verzeichnisse heraus in den Boot-Prozess
1440 einzubinden. Da das bei neueren Linux-Distributionen aber nicht
1441 zwangsläufig funktioniert, werden auch Start-Scripte mitgeliefert, die
1442 anstelle eines symbolischen Links verwendet werden können.</para>
1445 <title>SystemV-basierende Systeme (z.B. ältere Debian, ältere
1446 openSUSE, ältere Fedora)</title>
1448 <para>Kopieren Sie die Datei
1449 <filename>scripts/boot/system-v/kivitendo-task-server</filename>
1450 nach <filename>/etc/init.d/kivitendo-task-server</filename>. Passen
1451 Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
1452 <literal>DAEMON=....</literal>). Binden Sie das Script in den
1453 Boot-Prozess ein. Dies ist distributionsabhängig:</para>
1457 <para>Debian-basierende Systeme:</para>
1459 <programlisting>update-rc.d kivitendo-task-server defaults
1460 insserv kivitendo-task-server</programlisting>
1464 <para>Ältere openSUSE und ältere Fedora:</para>
1466 <programlisting>chkconfig --add kivitendo-task-server</programlisting>
1470 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
1473 <programlisting>/etc/init.d/kivitendo-task-server start</programlisting>
1477 <title>Upstart-basierende Systeme (z.B. Ubuntu bis 14.04)</title>
1479 <para>Kopieren Sie die Datei
1480 <filename>scripts/boot/upstart/kivitendo-task-server.conf</filename>
1481 nach <filename>/etc/init/kivitendo-task-server.conf</filename>.
1482 Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
1483 <literal>exec ....</literal>).</para>
1485 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
1488 <programlisting>service kivitendo-task-server start</programlisting>
1492 <title>systemd-basierende Systeme (z.B. neure openSUSE, neuere
1493 Fedora, neuere Ubuntu und neuere Debians)</title>
1495 <para>Kopieren Sie die Datei
1496 <filename>scripts/boot/systemd/kivitendo-task-server.service</filename>
1497 nach <filename>/etc/systemd/system/</filename>. Passen Sie in der
1498 kopierten Datei den Pfad zum Task-Server an (Zeilen
1499 <literal>ExecStart=....</literal> und
1500 <literal>ExecStop=...</literal>).</para>
1502 <para>Machen Sie anschließend das Script systemd bekannt, und binden
1503 Sie es in den Boot-Prozess ein. Dazu führen Sie die folgenden Befehl
1506 <programlisting>systemctl daemon-reload
1507 systemctl enable kivitendo-task-server.service</programlisting>
1509 <para>Wenn Sie den Task-Server jetzt sofort starten möchten, anstatt
1510 den Server neu zu starten, so können Sie das mit dem folgenden
1513 <programlisting>systemctl start kivitendo-task-server.service</programlisting>
1515 <para>Ein so eingerichteter Task-Server startet nach Beendigung
1516 automatisch erneut. Das betrifft eine Beendigung über die Oberfläche,
1517 eine Beendingung über die Prozesskontrolle und eine Beendigung bei
1518 Überschreiten des Memory-Limits. Soll der Task-Server nicht erneut
1519 starten, so können Sie ihn mit folgendem Befehl stoppen:</para>
1521 <programlisting>systemctl stop kivitendo-task-server.service</programlisting>
1526 <sect2 id="Prozesskontrolle">
1527 <title>Wie der Task-Server gestartet und beendet wird</title>
1529 <para>Der Task-Server wird wie folgt kontrolliert:</para>
1531 <programlisting>./scripts/task_server.pl Befehl</programlisting>
1533 <para><literal>Befehl</literal> ist dabei eine der folgenden
1538 <para><literal>start</literal> startet eine neue Instanz des
1539 Task-Servers. Die Prozess-ID wird innerhalb des
1540 <filename>users</filename>-Verzeichnisses abgelegt.</para>
1544 <para><literal>stop</literal> beendet einen laufenden
1549 <para><literal>restart</literal> beendet und startet ihn
1554 <para><literal>status</literal> berichtet, ob der Task-Server
1559 <para>Der Task-Server wechselt beim Starten automatisch in das
1560 kivitendo-Installationsverzeichnis.</para>
1562 <para>Dieselben Optionen können auch für die SystemV-basierenden
1563 Runlevel-Scripte benutzt werden (siehe oben).</para>
1565 <para>Wurde der Task-Server als systemd-Service eingerichtet (s.o.),
1566 so startet dieser nach Beendigung automatisch erneut.</para>
1569 <sect2 id="Tasks-konfigurieren">
1570 <title>Exemplarische Konfiguration eines Hintergrund-Jobs, der die Jahreszahl in allen Nummernkreisen zum Jahreswechsel erhöht</title>
1572 <para>Hintergrund-Jobs werden über System -> Hintergrund-Jobs und Task-Server -> Aktuelle Hintergrund-Jobs anzeigen -> Aktions-Knopf 'erfassen' angelegt. </para>
1573 <para>Nachdem wir über das Menü dort angelangt sind, legen wir unseren exemplarischen Hintergrund-Jobs "Erhöhung der Nummernkreise" mit folgenden Werten an:</para>
1576 <para><literal>Aktiv:</literal> Hier ein 'Ja' auswählen</para>
1579 <para><literal>Ausführungsart:</literal> 'wiederholte Ausführung' auswählen</para>
1582 <para><literal>Paketname:</literal> 'SetNumberRange' auswählen</para>
1585 <para><literal>Ausführungszeitplan:</literal> Hier entsprechend Werte wie in der crontab eingeben.</para><para>Syntax:</para>
1586 <programlisting>* * * * *
1589 │ │ │ │ └──── Wochentag (0-7, Sonntag ist 0 oder 7)
1590 │ │ │ └────── Monat (1-12)
1591 │ │ └──────── Tag (1-31)
1592 │ └────────── Stunde (0-23)
1593 └──────────── Minute (0-59) </programlisting>
1594 <para>Die Sterne können folgende Werte haben:</para>
1602 5 = Wochentag (0-7, Sonntag ist 0 oder 7)
1604 <para>Um die Ausführung auf eine Minute vor Sylvester zu setzen, müssen die folgenden Werte eingetragen werden:</para>
1605 <programlisting>59 23 31 12 *</programlisting>
1608 <para><literal>Daten:</literal>In diesem Feld können optionale Parameter für den Hintergrund im JSON-Format gesetzt werden. Der Hintergrund-Job <literal>SetNumberRange</literal> akzeptiert zwei Variable nämlich <literal>digit_year</literal> sowieso <literal>multiplier</literal>.</para><para> <literal>digit_year</literal> 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.</para><para> <literal>multiplier</literal> ist ein Vielfaches von 10, darüber wird die erste Nummer im Nummernkreis (die Anzahl der Stellen) wie folgt bestimmt:</para>
1610 multiplier Nummernkreis 2020
1615 <para>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:</para>
1616 <para><literal>Daten:</literal></para><programlisting>multiplier: 100
1617 digits_year: 4</programlisting>
1622 <sect1 id="Benutzerauthentifizierung-und-Administratorpasswort">
1623 <title>Benutzerauthentifizierung und Administratorpasswort</title>
1625 <para>Informationen über die Einrichtung der Benutzerauthentifizierung,
1626 über die Verwaltung von Gruppen und weitere Einstellungen</para>
1628 <sect2 id="Grundlagen-zur-Benutzerauthentifizierung">
1629 <title>Grundlagen zur Benutzerauthentifizierung</title>
1631 <para>kivitendo verwaltet die Benutzerinformationen in einer
1632 Datenbank, die im folgenden “Authentifizierungsdatenbank” genannt
1633 wird. Für jeden Benutzer kann dort eine eigene Datenbank für die
1634 eigentlichen Finanzdaten hinterlegt sein. Diese beiden Datenbanken
1635 können, müssen aber nicht unterschiedlich sein.</para>
1637 <para>Im einfachsten Fall gibt es für kivitendo nur eine einzige
1638 Datenbank, in der sowohl die Benutzerinformationen als auch die Daten
1639 abgelegt werden.</para>
1641 <para>Zusätzlich ermöglicht es kivitendo, dass die Benutzerpasswörter gegen die Authentifizierungsdatenbank oder gegen einen oder
1642 mehrere LDAP-Server überprüft werden.</para>
1644 <para>Welche Art der Passwortüberprüfung kivitendo benutzt und wie
1645 kivitendo die Authentifizierungsdatenbank erreichen kann, wird in der
1646 Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1647 festgelegt. Diese muss bei der Installation und bei einem Upgrade von
1648 einer Version vor v2.6.0 angelegt werden. Eine
1649 Beispielkonfigurationsdatei
1650 <filename>config/kivitendo.conf.default</filename> existiert, die als
1651 Vorlage benutzt werden kann.</para>
1654 <sect2 id="Administratorpasswort">
1655 <title>Administratorpasswort</title>
1657 <para>Das Passwort, das zum Zugriff auf das Administrationsinterface
1658 von kivitendo benutzt wird, wird ebenfalls in dieser Datei
1659 gespeichert. Es kann auch nur dort und nicht mehr im
1660 Administrationsinterface selber geändert werden. Der Parameter dazu
1661 heißt <varname>admin_password</varname> im Abschnitt
1662 <varname>[authentication]</varname>.</para>
1665 <sect2 id="Authentifizierungsdatenbank">
1666 <title>Authentifizierungsdatenbank</title>
1668 <para>Die Verbindung zur Authentifizierungsdatenbank wird mit den
1669 Parametern in <varname>[authentication/database]</varname>
1670 konfiguriert. Hier sind die folgenden Parameter anzugeben:</para>
1674 <term><literal>host</literal></term>
1677 <para>Der Rechnername oder die IP-Adresse des
1678 Datenbankservers</para>
1683 <term><literal>port</literal></term>
1686 <para>Die Portnummer des Datenbankservers, meist 5432</para>
1691 <term><literal>db</literal></term>
1694 <para>Der Name der Authentifizierungsdatenbank</para>
1699 <term><literal>user</literal></term>
1702 <para>Der Benutzername, mit dem sich kivitendo beim
1703 Datenbankserver anmeldet (z.B.
1704 "<literal>postgres</literal>")</para>
1709 <term><literal>password</literal></term>
1712 <para>Das Passwort für den Datenbankbenutzer</para>
1717 <para>Die Datenbank muss noch nicht existieren. kivitendo kann sie
1718 automatisch anlegen (mehr dazu siehe unten).</para>
1721 <sect2 id="Passwortüberprüfung">
1722 <title>Passwortüberprüfung</title>
1724 <para>kivitendo unterstützt Passwortüberprüfung auf zwei Arten: gegen
1725 die Authentifizierungsdatenbank und gegen externe LDAP- oder
1726 Active-Directory-Server. Welche davon benutzt wird, regelt der
1727 Parameter <varname>module</varname> im Abschnitt
1728 <varname>[authentication]</varname>.</para>
1730 <para>Dieser Parameter listet die zu verwendenden Authentifizierungsmodule auf. Es muss mindestens ein Modul angegeben werden, es
1731 können aber auch mehrere angegeben werden. Weiterhin ist es möglich, das LDAP-Modul mehrfach zu verwenden und für jede Verwendung
1732 eine unterschiedliche Konfiguration zu nutzen, z.B. um einen Fallback-Server anzugeben, der benutzt wird, sofern der Hauptserver
1733 nicht erreichbar ist.</para>
1735 <para>Sollen die Benutzerpasswörter in der Authentifizierungsdatenbank geprüft werden, so muss der Parameter
1736 <varname>module</varname> das Modul <literal>DB</literal> enthalten. Sofern das Modul in der Liste enthalten ist, egal an welcher
1737 Position, können sowohl der Administrator als auch die Benutzer selber ihre Passwörter in kivitendo ändern.</para>
1739 <para>Wenn Passwörter gegen einen oder mehrere externe LDAP- oder Active-Directory-Server geprüft werden, so muss der Parameter
1740 <varname>module</varname> den Wert <literal>LDAP</literal> enthalten. In diesem Fall müssen zusätzliche Informationen über den
1741 LDAP-Server im Abschnitt <literal>[authentication/ldap]</literal> angegeben werden. Das Modul kann auch mehrfach angegeben werden,
1742 wobei jedes Modul eine eigene Konfiguration bekommen sollte. Der Name der Konfiguration wird dabei mit einem Doppelpunkt getrennt an
1743 den Modulnamen angehängt (<literal>LDAP:Name-der-Konfiguration</literal>). Der entsprechende Abschnitt in der Konfigurationsdatei
1744 lautet dann <literal>[authentication/Name-der-Konfiguration]</literal>.</para>
1746 <para>Die verfügbaren Parameter für die LDAP-Konfiguration lauten:</para>
1750 <term><literal>host</literal></term>
1753 <para>Der Rechnername oder die IP-Adresse des LDAP- oder
1754 Active-Directory-Servers. Diese Angabe ist zwingend
1755 erforderlich.</para>
1760 <term><literal>port</literal></term>
1763 <para>Die Portnummer des LDAP-Servers; meist 389.</para>
1768 <term><literal>tls</literal></term>
1771 <para>Wenn Verbindungsverschlüsselung gewünscht ist, so diesen
1772 Wert auf ‘<literal>1</literal>’ setzen, andernfalls auf
1773 ‘<literal>0</literal>’ belassen</para>
1778 <term><literal>verify</literal></term>
1781 <para>Wenn Verbindungsverschlüsselung gewünscht und der Parameter <parameter>tls</parameter> gesetzt ist, so gibt dieser
1782 Parameter an, ob das Serverzertifikat auf Gültigkeit geprüft wird. Mögliche Werte sind <literal>require</literal> (Zertifikat
1783 wird überprüft und muss gültig sei; dies ist der Standard) und <literal>none</literal> (Zertifikat wird nicht
1789 <term><literal>attribute</literal></term>
1792 <para>Das LDAP-Attribut, in dem der Benutzername steht, den der
1793 Benutzer eingegeben hat. Für Active-Directory-Server ist dies
1794 meist ‘<literal>sAMAccountName</literal>’, für andere
1795 LDAP-Server hingegen ‘<literal>uid</literal>’. Diese Angabe ist
1796 zwingend erforderlich.</para>
1801 <term><literal>base_dn</literal></term>
1804 <para>Der Abschnitt des LDAP-Baumes, der durchsucht werden soll.
1805 Diese Angabe ist zwingend erforderlich.</para>
1810 <term><literal>filter</literal></term>
1813 <para>Ein optionaler LDAP-Filter. Enthält dieser Filter das Wort
1814 <literal><%login%></literal>, so wird dieses durch den vom
1815 Benutzer eingegebenen Benutzernamen ersetzt. Andernfalls wird
1816 der LDAP-Baum nach einem Element durchsucht, bei dem das oben
1817 angegebene Attribut mit dem Benutzernamen identisch ist.</para>
1822 <term><literal>bind_dn</literal> und
1823 <literal>bind_password</literal></term>
1826 <para>Wenn der LDAP-Server eine Anmeldung erfordert, bevor er
1827 durchsucht werden kann (z.B. ist dies bei
1828 Active-Directory-Servern der Fall), so kann diese hier angegeben
1829 werden. Für Active-Directory-Server kann als
1830 ‘<literal>bind_dn</literal>’ entweder eine komplette LDAP-DN wie
1831 z.B. ‘<literal>cn=Martin
1832 Mustermann,cn=Users,dc=firmendomain</literal>’ auch nur der
1833 volle Name des Benutzers eingegeben werden; in diesem Beispiel
1834 also ‘<literal>Martin Mustermann</literal>’.</para>
1839 <term><literal>timeout</literal></term>
1842 <para>Timeout beim Verbindungsversuch, bevor der Server als nicht erreichbar gilt; Standardwert: 10</para>
1848 <sect2 id="Name-des-Session-Cookies">
1849 <title>Name des Session-Cookies</title>
1851 <para>Sollen auf einem Server mehrere kivitendo-Installationen
1852 aufgesetzt werden, so müssen die Namen der Session-Cookies für alle
1853 Installationen unterschiedlich sein. Der Name des Cookies wird mit dem
1854 Parameter <varname>cookie_name</varname> im Abschnitt
1855 <varname>[authentication]</varname>gesetzt.</para>
1857 <para>Diese Angabe ist optional, wenn nur eine Installation auf dem
1858 Server existiert.</para>
1861 <sect2 id="Anlegen-der-Authentifizierungsdatenbank">
1862 <title>Anlegen der Authentifizierungsdatenbank</title>
1864 <para>Nachdem alle Einstellungen in
1865 <filename>config/kivitendo.conf</filename> vorgenommen wurden, muss
1866 kivitendo die Authentifizierungsdatenbank anlegen. Dieses geschieht
1867 automatisch, wenn Sie sich im Administrationsmodul anmelden, das unter
1868 der folgenden URL erreichbar sein sollte:</para>
1871 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
1875 <sect1 id="Benutzer--und-Gruppenverwaltung">
1876 <title>Mandanten-, Benutzer- und Gruppenverwaltung</title>
1878 <para>Nach der Installation müssen Mandanten, Benutzer, Gruppen und
1879 Datenbanken angelegt werden. Dieses geschieht im Administrationsmenü,
1880 das Sie unter folgender URL finden:</para>
1883 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
1885 <para>Verwenden Sie zur Anmeldung das Passwort, das Sie in der Datei
1886 <filename>config/kivitendo.conf</filename> eingetragen haben.</para>
1888 <sect2 id="Zusammenhänge">
1889 <title>Zusammenhänge</title>
1891 <para>kivitendo verwaltet zwei Sets von Daten, die je nach Einrichtung
1892 in einer oder zwei Datenbanken gespeichert werden.</para>
1894 <para>Das erste Set besteht aus Anmeldeinformationen: welche Benutzer
1895 und Mandanten gibt es, welche Gruppen, welche BenutzerIn hat Zugriff
1896 auf welche Mandanten, und welche Gruppe verfügt über welche Rechte.
1897 Diese Informationen werden in der Authentifizierungsdatenbank
1898 gespeichert. Dies ist diejenige Datenbank, deren Verbindungsparameter
1899 in der Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1900 gespeichert werden.</para>
1902 <para>Das zweite Set besteht aus den eigentlichen Verkehrsdaten eines
1903 Mandanten, wie beispielsweise die Stammdaten (Kunden, Lieferanten,
1904 Waren) und Belege (Angebote, Lieferscheine, Rechnungen). Diese werden
1905 in einer Mandantendatenbank gespeichert. Die Verbindungsinformationen
1906 einer solchen Mandantendatenbank werden im Administrationsbereich
1907 konfiguriert, indem man einen Mandanten anlegt und dort die Parameter
1908 einträgt. Dabei hat jeder Mandant eine eigene Datenbank.</para>
1910 <para>Aufgrund des Datenbankdesigns ist es für einfache Fälle möglich,
1911 die Authentifizierungsdatenbank und eine der Mandantendatenbanken in
1912 ein und derselben Datenbank zu speichern. Arbeitet man hingegen mit
1913 mehr als einem Mandanten, wird empfohlen, für die
1914 Authentifizierungsdatenbank eine eigene Datenbank zu verwenden, die
1915 nicht gleichzeitig für einen Mandanten verwendet wird.</para>
1918 <sect2 id="Mandanten-Benutzer-Gruppen">
1919 <title>Mandanten, Benutzer und Gruppen</title>
1921 <para>kivitendos Administration kennt Mandanten, Benutzer und Gruppen,
1922 die sich frei zueinander zuordnen lassen.</para>
1924 <para>kivitendo kann mehrere Mandaten aus einer Installation heraus
1925 verwalten. Welcher Mandant benutzt wird, kann direkt beim Login
1926 ausgewählt werden. Für jeden Mandanten wird ein eindeutiger Name
1927 vergeben, der beim Login angezeigt wird. Weiterhin benötigt der
1928 Mandant Datenbankverbindungsparameter für seine Mandantendatenbank.
1929 Diese sollte über die <link
1930 linkend="Datenbanken-anlegen">Datenbankverwaltung</link>
1933 <para>Ein Benutzer ist eine Person, die Zugriff auf kivitendo erhalten
1934 soll. Sie erhält einen Loginnamen sowie ein Passwort. Weiterhin legt
1935 der Administrator fest, an welchen Mandanten sich ein Benutzer
1936 anmelden kann, was beim Login verifiziert wird.</para>
1938 <para>Gruppen dienen dazu, Benutzern innerhalb eines Mandanten Zugriff
1939 auf bestimmte Funktionen zu geben. Einer Gruppe werden dafür vom
1940 Administrator gewisse Rechte zugeordnet. Weiterhin legt der
1941 Administrator fest, für welche Mandanten eine Gruppe gilt, und welche
1942 Benutzer Mitglieder in dieser Gruppe sind. Meldet sich ein Benutzer
1943 dann an einem Mandanten an, so erhält er alle Rechte von allen
1944 denjenigen Gruppen, die zum Einen dem Mandanten zugeordnet sind und in
1945 denen der Benutzer zum Anderen Mitglied ist,</para>
1947 <para>Die Reihenfolge, in der Datenbanken, Mandanten, Gruppen und
1948 Benutzer angelegt werden, kann im Prinzip beliebig gewählt werden. Die
1949 folgende Reihenfolge beinhaltet die wenigsten Arbeitsschritte:</para>
1951 <orderedlist numeration="arabic">
1953 <para>Datenbank anlegen</para>
1957 <para>Gruppen anlegen</para>
1961 <para>Benutzer anlegen und Gruppen als Mitglied zuordnen</para>
1965 <para>Mandanten anlegen und Gruppen sowie Benutzer zuweisen</para>
1970 <sect2 id="Datenbanken-anlegen">
1971 <title>Datenbanken anlegen</title>
1973 <para>Zuerst muss eine Datenbank angelegt werden. Verwenden Sie für
1974 den Datenbankzugriff den vorhin angelegten Benutzer (in unseren
1975 Beispielen ist dies ‘<literal>kivitendo</literal>’).</para>
1978 <sect2 id="Gruppen-anlegen">
1979 <title>Gruppen anlegen</title>
1981 <para>Eine Gruppe wird in der Gruppenverwaltung angelegt. Ihr muss ein
1982 Name gegeben werden, eine Beschreibung ist hingegen optional. Nach dem
1983 Anlegen können Sie die verschiedenen Bereiche wählen, auf die
1984 Mitglieder dieser Gruppe Zugriff haben sollen.</para>
1986 <para>Benutzergruppen werden zwar in der Authentifizierungsdatenbank
1987 gespeichert, gelten aber nicht automatisch für alle Mandanten. Der
1988 Administrator legt vielmehr fest, für welche Mandanten eine Gruppe
1989 gültig ist. Dies kann entweder beim Bearbeiten der Gruppe geschehen
1990 ("diese Gruppe ist gültig für Mandanten X, Y und Z"), oder aber wenn
1991 man einen Mandanten bearbeitet ("für diesen Mandanten sind die Gruppen
1992 A, B und C gültig").</para>
1994 <para>Wurden bereits Benutzer angelegt, so können hier die Mitglieder
1995 dieser Gruppe festgelegt werden ("in dieser Gruppe sind die Benutzer
1996 X, Y und Z Mitglieder"). Dies kann auch nachträglich beim Bearbeiten
1997 eines Benutzers geschehen ("dieser Benutzer ist Mitglied in den
1998 Gruppen A, B und C").</para>
2001 <sect2 id="Benutzer-anlegen">
2002 <title>Benutzer anlegen</title>
2004 <para>Beim Anlegen von Benutzern werden für viele Parameter
2005 Standardeinstellungen vorgenommen, die den Gepflogenheiten des
2006 deutschen Raumes entsprechen.</para>
2008 <para>Zwingend anzugeben ist der Loginname. Wenn die
2009 Passwortauthentifizierung über die Datenbank eingestellt ist, so kann
2010 hier auch das Benutzerpasswort gesetzt bzw. geändert werden. Ist
2011 hingegen die LDAP-Authentifizierung aktiv, so ist das Passwort-Feld
2014 <para>Hat man bereits Mandanten und Gruppen angelegt, so kann hier
2015 auch konfiguriert werden, auf welche Mandanten der Benutzer Zugriff
2016 hat bzw. in welchen Gruppen er Mitglied ist. Beide Zuweisungen können
2017 sowohl beim Benutzer vorgenommen werden ("dieser Benutzer hat Zugriff
2018 auf Mandanten X, Y, Z" bzw. "dieser Benutzer ist Mitglied in Gruppen
2019 X, Y und Z") als auch beim Mandanten ("auf diesen Mandanten haben
2020 Benutzer A, B und C Zugriff") bzw. bei der Gruppe ("in dieser Gruppe
2021 sind Benutzer A, B und C Mitglieder").</para>
2024 <sect2 id="Mandanten-anlegen">
2025 <title>Mandanten anlegen</title>
2027 <para>Ein Mandant besteht aus Administrationssicht primär aus einem
2028 eindeutigen Namen. Weiterhin wird hier hinterlegt, welche Datenbank
2029 als Mandantendatenbank benutzt wird. Hier müssen die Zugriffsdaten
2030 einer der eben angelegten Datenbanken eingetragen werden.</para>
2032 <para>Hat man bereits Benutzer und Gruppen angelegt, so kann hier auch
2033 konfiguriert werden, welche Benutzer Zugriff auf den Mandanten haben
2034 bzw. welche Gruppen für den Mandanten gültig sind. Beide Zuweisungen
2035 können sowohl beim Mandanten vorgenommen werden ("auf diesen Mandanten
2036 haben Benutzer X, Y und Z Zugriff" bzw. "für diesen Mandanten sind die
2037 Gruppen X, Y und Z gültig") als auch beim Benutzer ("dieser Benutzer
2038 hat Zugriff auf Mandanten A, B und C") bzw. bei der Gruppe ("diese
2039 Gruppe ist für Mandanten A, B und C gültig").</para>
2043 <sect1 id="Drucker--Systemverwaltung">
2044 <title>Drucker- und Systemverwaltung</title>
2046 <para>Im Administrationsmenü gibt es ferner noch die beiden Menüpunkte
2047 Druckeradministration und System.</para>
2049 <sect2 id="Druckeradministration">
2050 <title>Druckeradministration</title>
2052 <para>Unter dem Menüpunkt Druckeradministration lassen sich beliebig
2053 viele "Druckbefehle" im System verwalten. Diese Befehle werden
2054 mandantenweise zugeordnet. Unter Druckerbeschreibung wird der Namen
2055 des Druckbefehls festgelegt, der dann in der Druckerauswahl des Belegs
2056 angezeigt wird.</para>
2058 <para>Unter Druckbefehl definiert man den eigentlichen Druckbefehl,
2059 der direkt auf dem Webserver ausgeführt wird, bspw. 'lpr -P
2060 meinDrucker' oder ein kompletter Pfad zu einem Skript
2061 (/usr/local/src/kivitendo/scripts/pdf_druck_in_verzeichnis.sh). Wird
2062 ferner noch ein optionales Vorlagenkürzel verwendet, wird dieses
2063 Kürzel bei der Auswahl der Druckvorlagendatei mit einem Unterstrich
2064 ergänzt, ist bspw. das Kürzel 'epson_drucker' definiert, so wird beim
2065 Ausdruck eines Angebots folgende Vorlage geparst:
2066 sales_quotation_epson_drucker.tex.</para>
2070 <title>System sperren / entsperren</title>
2072 <para>Unter dem Menüpunkt System gibt es den Eintrag 'Installation
2073 sperren/entsperren'. Setzt man diese Sperre so ist der Zugang zu der
2074 gesamten kivitendo Installation gesperrt.</para>
2076 <para>Falls die Sperre gesetzt ist, erscheint anstelle der
2077 Anmeldemaske die Information: 'kivitendo ist momentan zwecks
2078 Wartungsarbeiten nicht zugänglich.'.</para>
2080 <para>Wichtig zu erwähnen ist hierbei noch, dass sich kivitendo
2081 automatisch 'sperrt', falls es bei einem Versionsupdate zu einem
2082 Datenbankfehler kam. Somit kann hier nicht aus Versehen mit einem
2083 inkonsistenten Datenbestand weitergearbeitet werden.</para>
2087 <sect1 id="config.sending-email"
2088 xreflabel="E-Mail-Versand aus kivitendo heraus">
2089 <title>E-Mail-Versand aus kivitendo heraus</title>
2091 <para>kivitendo kann direkt aus dem Programm heraus E-Mails versenden,
2092 z.B. um ein Angebot direkt an einen Kunden zu verschicken. Damit dies
2093 funktioniert, muss eingestellt werden, über welchen Server die E-Mails
2094 verschickt werden sollen. kivitendo unterstützt dabei zwei Mechanismen:
2095 Versand über einen lokalen E-Mail-Server (z.B. mit
2096 <productname>Postfix</productname> oder <productname>Exim</productname>,
2097 was auch die standardmäßig aktive Methode ist) sowie Versand über einen
2098 SMTP-Server (z.B. der des eigenen Internet-Providers).</para>
2100 <para>Welche Methode und welcher Server verwendet werden, wird über die
2101 Konfigurationsdatei <filename>config/kivitendo.conf</filename>
2102 festgelegt. Dort befinden sich alle Einstellungen zu diesem Thema im
2103 Abschnitt '<literal>[mail_delivery]</literal>'.</para>
2105 <sect2 id="config.sending-email.sendmail"
2106 xreflabel="E-Mail-Versand über lokalen E-Mail-Server">
2107 <title>Versand über lokalen E-Mail-Server</title>
2109 <para>Diese Methode bietet sich an, wenn auf dem Server, auf dem
2110 kivitendo läuft, bereits ein funktionsfähiger E-Mail-Server wie z.B.
2111 <productname>Postfix</productname>, <productname>Exim</productname>
2112 oder <productname>Sendmail</productname> läuft.</para>
2114 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter
2115 '<literal>method = sendmail</literal>' gesetzt sein. Dies ist
2116 gleichzeitig der Standardwert, falls er nicht verändert wird.</para>
2118 <para>Um zu kontrollieren, wie das Programm zum Einliefern gestartet
2119 wird, dient der Parameter '<literal>sendmail = ...</literal>'. Der
2120 Standardwert verweist auf das Programm
2121 <filename>/usr/bin/sendmail</filename>, das bei allen oben genannten
2122 E-Mail-Serverprodukten für diesen Zweck funktionieren sollte.</para>
2124 <para>Die Konfiguration des E-Mail-Servers selber würde den Rahmen
2125 dieses sprengen. Hierfür sei auf die Dokumentation des E-Mail-Servers
2129 <sect2 id="config.sending-email.smtp"
2130 xreflabel="E-Mail-Versand über einen SMTP-Server">
2131 <title>Versand über einen SMTP-Server</title>
2133 <para>Diese Methode bietet sich an, wenn kein lokaler E-Mail-Server
2134 vorhanden oder zwar einer vorhanden, dieser aber nicht konfiguriert
2137 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter
2138 '<literal>method = smtp</literal>' gesetzt sein. Die folgenden
2139 Parameter dienen dabei der weiteren Konfiguration:</para>
2143 <term><varname>hostname</varname></term>
2146 <para>Name oder IP-Adresse des SMTP-Servers. Standardwert:
2147 '<literal>localhost</literal>'</para>
2152 <term><varname>port</varname></term>
2155 <para>Portnummer. Der Standardwert hängt von der verwendeten
2156 Verschlüsselungsmethode ab. Gilt '<literal>security =
2157 none</literal>' oder '<literal>security = tls</literal>', so ist
2158 25 die Standardportnummer. Für '<literal>security =
2159 ssl</literal>' ist 465 die Portnummer. Muss normalerweise nicht
2160 geändert werden.</para>
2165 <term><varname>security</varname></term>
2168 <para>Wahl der zu verwendenden Verschlüsselung der Verbindung
2169 mit dem Server. Standardwert ist '<literal>none</literal>',
2170 wodurch keine Verschlüsselung verwendet wird. Mit
2171 '<literal>tls</literal>' wird TLS-Verschlüsselung eingeschaltet,
2172 und mit '<literal>ssl</literal>' wird Verschlüsselung via SSL
2173 eingeschaltet. Achtung: Für '<literal>tls</literal>' und
2174 '<literal>ssl</literal>' werden zusätzliche Perl-Module benötigt
2175 (siehe unten).</para>
2180 <term><varname>login</varname> und
2181 <varname>password</varname></term>
2184 <para>Falls der E-Mail-Server eine Authentifizierung verlangt,
2185 so können mit diesen zwei Parametern der Benutzername und das
2186 Passwort angegeben werden. Wird Authentifizierung verwendet, so
2187 sollte aus Sicherheitsgründen auch eine Form von Verschlüsselung
2188 aktiviert werden.</para>
2195 <sect1 id="Drucken-mit-kivitendo">
2196 <title>Drucken mit kivitendo</title>
2198 <para>Das Drucksystem von kivitendo benutzt von Haus aus LaTeX-Vorlagen.
2199 Um drucken zu können, braucht der Server ein geeignetes LaTeX System. Am
2200 einfachsten ist dazu eine <literal>texlive</literal> Installation. Unter
2201 debianoiden Betriebssystemen installiert man die Pakete mit:</para>
2203 <para><programlisting>apt install texlive-base-bin texlive-latex-recommended texlive-fonts-recommended \
2204 texlive-latex-extra texlive-lang-german ghostscript</programlisting></para>
2206 <para>Für Fedora benötigen Sie die folgenden Pakete:</para>
2208 <para><programlisting>dnf install texlive-collection-latex texlive-collection-latexextra \
2209 texlive-collection-latexrecommended texlive-collection-langgerman \
2210 texlive-collection-langenglish</programlisting></para>
2212 <para>Für openSUSE benötigen Sie die folgenden Pakete:</para>
2214 <para><programlisting>zypper install texlive-collection-latex texlive-collection-latexextra \
2215 texlive-collection-latexrecommended texlive-collection-langgerman \
2216 texlive-collection-langenglish</programlisting></para>
2218 <note><para>kivitendo erwartet eine aktuelle TeX Live Umgebung, um PDF/A zu erzeugen. Aktuelle Distributionen von 2020 erfüllen diese. Überprüfbar ist dies mit dem Aufruf des installation_check.pl mit Parameter -l:</para><para><programlisting>scripts/installations_check.pl -l</programlisting></para></note>
2219 <para>kivitendo bringt drei alternative Vorlagensätze mit:</para>
2229 <para>rev-odt</para>
2233 <para>Der ehemalige Druckvorlagensatz "f-tex" wurde mit der Version
2234 3.5.6 entfernt, da er nicht mehr gepflegt wird.</para>
2236 <sect2 id="Vorlagenverzeichnis-anlegen"
2237 xreflabel="Vorlagenverzeichnis anlegen">
2238 <title>Vorlagenverzeichnis anlegen</title>
2240 <para>Es lässt sich ein initialer Vorlagensatz erstellen. Die
2241 LaTeX-System-Abhängigkeiten hierfür kann man prüfen mit:</para>
2243 <programlisting>./scripts/installation_check.pl -lv</programlisting>
2245 <para>Der Angemeldete Benutzer muss in einer Gruppe sein, die über das
2246 Recht "Konfiguration -> Mandantenverwaltung" verfügt. Siehe auch
2247 <xref linkend="Gruppen-anlegen"/>.</para>
2249 <para>Im Userbereich lässt sich unter: "<guimenu>System</guimenu>
2250 -> <guisubmenu>Mandantenverwaltung</guisubmenu> ->
2251 <guimenuitem>Verschiedenes</guimenuitem>" die Option "Neue
2252 Druckvorlagen aus Vorlagensatz erstellen" auswählen.</para>
2256 <para><option>Vorlagen auswählen</option>: Wählen Sie hier den
2257 Vorlagensatz aus, der kopiert werden soll
2258 (<filename>RB</filename>, <filename>marei</filename> oder
2259 <filename>odt-rev</filename>.)</para>
2263 <para><option>Neuer Name</option>: Der Verzeichnisname für den
2264 neuen Vorlagensatz. Dieser kann im Rahmen der üblichen Bedingungen
2265 für Verzeichnisnamen frei gewählt werden.</para>
2269 <para>Nach dem Speichern wird das Vorlagenverzeichnis angelegt und ist
2270 für den aktuellen Mandanten ausgewählt. Der gleiche Vorlagensatz kann,
2271 wenn er mal angelegt ist, bei mehreren Mandanten verwendet werden.
2272 Eventuell müssen Anpassungen (Logo, Erscheinungsbild, etc) noch
2273 vorgenommen werden. Den Ordner findet man im Dateisystem unter
2274 <filename>./templates/[Neuer Name]</filename></para>
2277 <sect2 id="Vorlagen-RB">
2278 <title>Der Druckvorlagensatz RB</title>
2280 <para>Hierbei handelt es sich um einen vollständigen LaTeX
2281 Dokumentensatz mit alternativem Design. Die odt oder html-Varianten
2282 sind nicht gepflegt.</para>
2284 <para>Die konzeptionelle Idee der Vorlagen wird <ulink
2285 url="http://www.kivitendo-support.de/vortraege/Lx-Office%20Anwendertreffen%20LaTeX-Druckvorlagen-Teil3-finale.pdf">hier</ulink>
2286 auf Folie 5 bis 10 vorgestellt. Informationen zur Anpassung an die
2287 eigenen Firmendaten finden sich in der Datei Readme.tex im
2288 Vorlagenverzeichnis.</para>
2290 <para>Eine kurze Übersicht der Features:</para>
2294 <para>Mehrsprachenfähig, mit Deutscher und Englischer
2299 <para>Zentrale Konfigurationsdateien, die für alle Belege benutzt
2300 werden, z.B. für Kopf- und Fußzeilen, und Infos wie
2305 <para>mehrere vordefinierte Varianten für
2306 Logos/Hintergrundbilder</para>
2310 <para>Berücksichtigung für Steuerzonen "EU mit USt-ID Nummer" oder
2311 "Außerhalb EU"</para>
2316 <sect2 id="Vorlagen-rev-odt">
2317 <title>Der Druckvorlagensatz rev-odt</title>
2319 <para>Hierbei handelt es sich um einen Dokumentensatz der mit
2320 odt-Vorlagen erstellt wurde. Es gibt in dem Verzeichnis eine
2321 Readme-Datei, die eventuell aktueller als die Dokumentation hier ist.
2322 Die odt-Vorlagen in diesem Verzeichnis "rev-odt" wurden von revamp-it,
2323 Zürich erstellt und werden laufend aktualisiert. Ein paar der
2324 Formulierungen in den Druckvorlagen entsprechen dem Schweizer
2325 Sprachgebrauch, z.B. "Offerte" oder "allfällig".</para>
2327 <para>Hinweis zum Einsatz des Feldes "Land" bei den Stammdaten für
2328 KundInnen und LieferantInnen, sowie bei Lieferadressen: Die in diesem
2329 Vorlagensatz vorhandenen Vorlagen erwarten für "Land" das
2330 entsprechende Kürzel, das in Adressen vor die Postleitzahl gesetzt
2331 wird. Das Feld kann auch komplett leer bleiben. Wer dies anders
2332 handhaben möchte, muss die Vorlagen entsprechend anpassen.</para>
2334 <para>odt-Vorlagen können mit LibreOffice oder OpenOffice editiert und
2335 den eigenen Bedürfnissen angepasst werden. Wichtig beim Editieren von
2336 if-Blöcken ist, dass immer der gesamte Block überschrieben werden muss
2337 und nicht nur Teile davon, da dies sonst oft zu einer odt-Datei führt,
2338 die vom Parser nicht korrekt gelesen werden kann.</para>
2340 <para>Mahnungen können unter folgenden Einschränkungen mit den
2341 odt-Vorlagen im Vorlagensatz rev-odt erzeugt werden:</para>
2345 <para>als Druckoption steht nur 'PDF(OpenDocument/OASIS)' zur
2346 Verfügung, das heisst, die Mahnungen werden als PDF-Datei
2351 <para>für jede Rechnung muss eine eigene Mahnung erzeugt werden
2352 (auch wenn bei einzelnen KundInnen mehrere überfällige Rechnungen
2353 vorhanden sind).</para>
2357 <para>Mehrere Mahnungen für eine Kundin / einen Kunden werden zu einer
2358 PDF-Datei zusammengefasst</para>
2360 <para>Die Vorlagen zahlungserinnerung.odt sowie mahnung.odt sind für
2361 das Erstellen einer Zahlungserinnerung bzw. Mahnung selbst vorgesehen,
2362 die Vorlage mahnung_invoice.odt für das Erstellen einer Rechnung über
2363 die verrechneten Mahngebühren und Verzugszinsen.</para>
2365 <para>Zur Zeit gibt es in kivitendo noch keine Möglichkeit,
2366 odt-Vorlagen bei Briefen und Pflichtenheften einzusetzen.
2367 Entsprechende Vorlagen sind deshalb nicht vorhanden.</para>
2369 <para>Fehlermeldungen, Anregungen und Wünsche bitte senden an:
2370 empfang@revamp-it.ch</para>
2373 <sect2 id="allgemeine-hinweise-zu-latex">
2374 <title>Allgemeine Hinweise zu LaTeX Vorlagen</title>
2376 <para>In den allermeisten Installationen sollte das Drucken jetzt
2377 schon funktionieren. Sollte ein Fehler auftreten, wirft TeX sehr lange
2378 Fehlerbeschreibungen, der eigentliche Fehler ist immer die erste
2379 Zeile, die mit einem Ausrufezeichen anfängt. Häufig auftretende Fehler
2380 sind zum Beispiel:</para>
2384 <para>! LaTeX Error: File `eurosym.sty' not found. Die
2385 entsprechende LaTeX-Bibliothek wurde nicht gefunden. Das tritt vor
2386 allem bei Vorlagen aus der Community auf. Installieren Sie die
2387 entsprechenden Pakete.</para>
2391 <para>! Package inputenc Error: Unicode char \u8:... set up for
2392 use with LaTeX. Dieser Fehler tritt auf, wenn sie versuchen mit
2393 einer Standardinstallation exotische utf8 Zeichen zu drucken.
2394 TeXLive unterstützt von Haus nur romanische Schriften und muss mit
2395 diversen Tricks dazu gebracht werden andere Zeichen zu
2396 akzeptieren. Adere TeX Systeme wie XeTeX schaffen hier
2401 <para>Wird gar kein Fehler angezeigt, sondern nur der Name des
2402 Templates, heißt das normalerweise, dass das LaTeX Binary nicht
2403 gefunden wurde. Prüfen Sie den Namen in der Konfiguration (Standard:
2404 <literal>pdflatex</literal>), und stellen Sie sicher, dass pdflatex
2405 (oder das von Ihnen verwendete System) vom Webserver ausgeführt werden
2408 <para>Wenn sich das Problem nicht auf Grund der Ausgabe im Webbrowser
2409 verifizieren lässt:</para>
2413 <para>editiere [kivitendo-home]/config/kivitendo.conf und ändere
2414 "keep_temp_files" auf 1</para>
2416 <para><programlisting>keep_temp_files = 1;</programlisting></para>
2420 <para>bei fastcgi oder mod_perl den Webserver neu Starten</para>
2424 <para>Nochmal einen Druckversuch im Webfrontend auslösen</para>
2428 <para>wechsel in das users Verzeichnis von kivitendo</para>
2430 <para><programlisting>cd [kivitendo-home]/users</programlisting></para>
2434 <para>LaTeX Suchpfad anpassen:</para>
2436 <para><programlisting>export TEXINPUTS=".:[kivitendo-home]/templates/[aktuelles_template_verzeichniss]:"</programlisting></para>
2440 <para>Finde heraus, welche Datei kivitendo beim letzten Durchlauf
2443 <para><programlisting>ls -lahtr ./1*.tex</programlisting></para>
2445 <para>Es sollte die letzte Datei ganz unten sein</para>
2449 <para>für besseren Hinweis auf Fehler texdatei nochmals
2452 <para><programlisting>pdflatex ./1*.tex</programlisting></para>
2454 <para>in der *.tex datei nach dem Fehler suchen.</para>
2460 <sect1 id="OpenDocument-Vorlagen">
2461 <title>OpenDocument-Vorlagen</title>
2463 <para>kivitendo unterstützt die Verwendung von Vorlagen im
2464 OpenDocument-Format, wie es LibreOffice oder OpenOffice (ab Version 2)
2465 erzeugen. kivitendo kann dabei sowohl neue OpenDocument-Dokumente als
2466 auch aus diesen direkt PDF-Dateien erzeugen. Um die Unterstützung von
2467 OpenDocument-Vorlagen zu aktivieren muss in der Datei
2468 <filename>config/kivitendo.conf</filename> die Variable
2469 <literal>opendocument</literal> im Abschnitt
2470 <literal>print_templates</literal> auf ‘<literal>1</literal>’ stehen.
2471 Dieses ist die Standardeinstellung.</para>
2473 <para>Während die Erzeugung von reinen OpenDocument-Dateien keinerlei
2474 weitere Software benötigt, wird zur Umwandlung dieser Dateien in PDF
2475 LibreOffice oder OpenOffice benötigt. Soll dieses Feature genutzt
2476 werden, so muss neben LibreOffice oder OpenOffice auch der “X virtual
2477 frame buffer” (xvfb) installiert werden. Bei Debian ist er im Paket
2478 “xvfb” enthalten. Andere Distributionen enthalten ihn in anderen
2481 <para>Nach der Installation müssen in der Datei
2482 <filename>config/kivitendo.conf</filename> im Abschnitt
2483 <literal>applications</literal> zwei weitere Variablen angepasst
2486 <para><literal>openofficeorg_writer</literal> muss den vollständigen
2487 Pfad zu LibreOffice oder OpenOffice enthalten. Dabei dürfen keine
2488 Anführungszeichen eingesetzt werden.</para>
2490 <para>Beispiel für Debian oder Ubuntu:</para>
2492 <programlisting>openofficeorg_writer = /usr/bin/libreoffice</programlisting>
2494 <para><literal>xvfb</literal> muss den Pfad zum “X virtual frame buffer”
2497 <para>Zusätzlich gibt es zwei verschiedene Arten, wie kivitendo mit
2498 LibreOffice bzw. OpenOffice kommuniziert. Die erste Variante, die
2499 benutzt wird, wenn die Variable <literal>$openofficeorg_daemon</literal>
2500 gesetzt ist, startet ein LibreOffice oder OpenOffice, das auch nach der
2501 Umwandlung des Dokumentes gestartet bleibt. Bei weiteren Umwandlungen
2502 wird dann diese laufende Instanz benutzt. Der Vorteil ist, dass die Zeit
2503 zur Umwandlung deutlich reduziert wird, weil nicht für jedes Dokument
2504 ein LibreOffice bzw. OpenOffice gestartet werden muss. Der Nachteil ist,
2505 dass diese Methode Python und die Python-UNO-Bindings benötigt, die
2506 Bestandteil von LibreOffice bzw. OpenOffice sind.</para>
2509 <para>Für die Verbindung zu LibreOffice bzw. OpenOffice wird
2510 normalerweise der Python-Interpreter
2511 <filename>/usr/bin/python</filename> benutzt. Sollte dies nicht der
2512 richtige sein, so kann man mit zwei Konfigurationsvariablen
2513 entscheiden, welcher Python-Interpreter genutzt wird. Mit der Option
2514 <literal>python_uno</literal> aus dem Abschnitt
2515 <literal>applications</literal> wird der Interpreter selber
2516 festgelegt; sie steht standardmäßig auf dem eben erwähnten Wert
2517 <literal>/usr/bin/python</literal>.</para>
2519 <para>Zusätzlich ist es möglich, Pfade anzugeben, in denen Python
2520 neben seinen normalen Suchpfaden ebenfalls nach Modulen gesucht wird,
2521 z.B. falls sich diese in einem gesonderten LibreOffice- bzw.
2522 OpenOffice-Verzeichnis befinden. Diese zweite Variable heißt
2523 <literal>python_uno_path</literal> und befindet sich im Abschnitt
2524 <literal>environment</literal>. Sie ist standardmäßig leer. Werden
2525 hier mehrere Pfade angegeben, so müssen diese durch Doppelpunkte
2526 voneinander getrennt werden. Der Inhalt wird an den Python-Interpreter
2527 über die Umgebungsvariable <literal>PYTHONPATH</literal>
2531 <para>Ist <literal>$openofficeorg_daemon</literal> nicht gesetzt, so
2532 wird für jedes Dokument LibreOffice bzw. OpenOffice neu gestartet und
2533 die Konvertierung mit Hilfe eines Makros durchgeführt. Dieses Makro muss
2534 in der Dokumentenvorlage enthalten sein und
2535 “Standard.Conversion.ConvertSelfToPDF()” heißen. Die Beispielvorlage
2536 ‘<literal>templates/print/rev-odt/invoice.odt</literal>’ enthält ein
2537 solches Makro, das in jeder anderen Dokumentenvorlage ebenfalls
2538 enthalten sein muss.</para>
2540 <para>Als letztes muss herausgefunden werden, welchen Namen OpenOffice
2541 bzw. LibreOffice dem Verzeichnis mit den Benutzereinstellungen gibt.
2542 Unter Debian ist dies momentan <literal>~/.config/libreoffice</literal>.
2543 kivitendo verwendet das Verzeichnis
2544 <literal>users/.openoffice.org2</literal>. Eventuell muss dieses
2545 Verzeichnis umbenannt werden.</para>
2547 <para>Dieses Verzeichnis, wie auch das komplette
2548 <literal>users</literal>-Verzeichnis, muss vom Webserver beschreibbar
2549 sein. Dieses wurde bereits erledigt (siehe <xref
2550 linkend="Manuelle-Installation-des-Programmpaketes"/>), kann aber erneut
2551 überprüft werden, wenn die Konvertierung nach PDF fehlschlägt.</para>
2554 <title>OpenDocument (odt) Druckvorlagen mit Makros</title>
2556 <para>OpenDocument Vorlagen können Makros enthalten, welche komplexere
2557 Aufgaben erfüllen.</para>
2559 <para>Der Vorlagensatz "rev-odt" enthält solche Vorlagen mit <emphasis
2560 role="bold">Schweizer Bank-Einzahlungsscheinen (BESR)</emphasis>.
2561 Diese Makros haben die Aufgabe, die in den Einzahlungsscheinen
2562 benötigte Referenznummer und Kodierzeile zu erzeugen. Hier eine kurze
2563 Beschreibung, wie die Makros aufgebaut sind, und was bei ihrer Nutzung
2564 zu beachten ist (<emphasis role="bold">in fett sind nötige einmalige
2565 Anpassungen aufgeführt</emphasis>):</para>
2568 <title>Bezeichnung der Vorlagen</title>
2570 <para>Rechnung: invoice_besr.odt, Auftrag:
2571 sales_order_besr.odt</para>
2574 <sect3 id="opendocument-druckvorlagen-mit-makros.vorbereitungen">
2575 <title>Vorbereitungen im Adminbereich</title>
2577 <para>Damit beim Erstellen von Rechnungen und Aufträgen neben der
2578 Standardvorlage ohne Einzahlungsschein weitere Vorlagen (z.B. mit
2579 Einzahlungsschein) auswählbar sind, muss für jedes Vorlagen-Suffix
2580 ein Drucker eingerichtet werden:</para>
2584 <para>Druckeradministration → Drucker hinzufügen</para>
2588 <para>Mandant wählen</para>
2592 <para>Druckerbeschreibung → aussagekräftiger Text: wird in der
2593 Auftrags- bzw. Rechnungsmaske als Auswahl angezeigt (z.B. mit
2594 Einzahlungsschein Bank xy)</para>
2598 <para>Druckbefehl → beliebiger Text (hat für das Erzeugen von
2599 Aufträgen oder Rechnungen als odt-Datei keine Bedeutung, darf
2600 aber nicht leer sein)</para>
2604 <para>Vorlagenkürzel → besr bzw. selbst gewähltes Vorlagensuffix
2605 (muss genau der Zeichenfolge entsprechen, die zwischen
2606 "invoice_" bzw. "sales_order_" und ".odt" steht.)</para>
2610 <para>speichern</para>
2616 <title>Benutzereinstellungen</title>
2618 <para>Wer den Ausdruck mit Einzahlungsschein als Standardeinstellung
2619 im Rechnungs- bzw. Auftragsformular angezeigt haben möchte, kann
2620 dies persönlich für sich bei den Benutzereinstellungen
2621 konfigurieren:</para>
2625 <para>Programm → Benutzereinstellungen → Druckoptionen</para>
2629 <para>Standardvorlagenformat → OpenDocument/OASIS</para>
2633 <para>Standardausgabekanal → Bildschirm</para>
2637 <para>Standarddrucker → gewünschte Druckerbeschreibung auswählen
2638 (z.B. mit Einzahlungsschein Bank xy)</para>
2642 <para>Anzahl Kopien → leer</para>
2646 <para>speichern</para>
2652 <title>Aufbau und nötige Anpassungen der Vorlagen</title>
2654 <para>In der Vorlage sind als Modul "BESR" 4 Makros gespeichert, die
2655 aus dem von kivitendo erzeugten odt-Dokument die korrekte
2656 Referenznummer inklusive Prüfziffer sowie die Kodierzeile in
2657 OCRB-Schrift erzeugen und am richtigen Ort ins Dokument
2662 <para>Für den Einzahlungsschein ist die letzte Seite des
2663 Dokuments reserviert</para>
2667 <para>Direkt über dem Einzahlungsschein enthält die Vorlage eine
2668 Zeile mit folgenden Angaben (<emphasis
2669 role="bold">Bank-Konto-Identifikationsnummer und
2670 Postkonto-Nummer der Bank müssen gemäss Angaben der jeweiligen
2671 Bank angepasst werden</emphasis>):<itemizedlist>
2673 <para>DDDREF: 4 Werte zum Bilden der Referenznummer
2674 (jeweils durch einen Leerschlag getrennt): <itemizedlist>
2676 <para>erster Wert: <emphasis
2677 role="bold">Bank-Konto-Identifikation</emphasis>
2678 (nur Ziffern, maximal 6), <emphasis role="bold">muss
2679 angepasst werden</emphasis>.</para>
2683 <para>zweiter Wert: <%customernumber%>
2684 (Kundennummer: nur Ziffern, maximal 6)</para>
2688 <para>dritter Wert: <%ordnumber%>
2689 (Auftragsnummer bei Auftragsvorlage
2690 sales_oder_besr.odt, sonst 0) maximal 7 Ziffern,
2691 führende Buchstaben werden vom Makro entfernt</para>
2695 <para>vierter Wert: <%invnumber%>
2696 (Rechnungsnummer bei Rechnungsvorlage
2697 invoice_besr.odt, sonst 0) maximal 7 Ziffern,
2698 führende Buchstaben werden vom Makro entfernt</para>
2700 </itemizedlist></para>
2704 <para>DDDKONTO: <emphasis role="bold">Postkonto-Nummer der
2705 Bank, muss angepasst werden</emphasis>.</para>
2709 <para>DDDBETRAG: <%total%> Einzahlungsbetrag oder 0,
2710 falls Einzahlungsschein ohne Betrag</para>
2714 <para>DDDEND: muss am Ende der Zeile vorhanden sein</para>
2716 </itemizedlist></para>
2720 <para><emphasis role="bold">Im Einzahlungsschein selbst müssen
2721 der Name und die Adresse der Bank, die Postkonto-Nummer der
2722 Bank, sowie der eigene Firmenname und die Firmenadresse
2723 angepasst werden.</emphasis> Dabei ist darauf zu achten, dass
2724 sich die Positionen der Postkonto-Nummern der Bank, sowie der
2725 Zeichenfolgen dddfr, DDDREF1, DDDREF2, 609, DDDKODIERZEILE nicht
2731 <screeninfo>Rechnungsvorlage Schweizer Bank-Einzahlungsschein - zu
2732 ändernde Einträge in rot</screeninfo>
2736 <imagedata fileref="images/Einzahlungsschein_Makro.png"/>
2743 <title>Auswahl der Druckvorlage in kivitendo beim Erzeugen einer
2744 odt-Rechnung (analog bei Auftrag)</title>
2746 <para>Im Fussbereich der Rechnungsmaske muss neben Rechnung,
2747 OpenDocument/OASIS und Bildschirm die im Adminbereich erstellte
2748 Druckerbeschreibung ausgewählt werden, falls diese nicht bereits bei
2749 den Benutzereinstellungen als persönlicher Standard gewählt
2754 <title>Makroeinstellungen in LibreOffice anpassen</title>
2756 <para>Falls beim Öffnen einer von kivitendo erzeugten odt-Rechnung
2757 die Meldung kommt, dass Makros aus Sicherheitsgründen nicht
2758 ausgeführt werden, so müssen folgende Einstellungen in LibreOffice
2759 angepasst werden:</para>
2763 <para>Extras → Optionen → Sicherheit → Makrosicherheit</para>
2767 <para>Sicherheitslevel auf "Mittel" einstellen (Diese
2768 Einstellung muss auf jedem Computer durchgeführt werden, mit dem
2769 von kivitendo erzeugte odt-Rechnungen oder Aufträge geöffnet
2774 <para>Beim Öffnen einer odt-Rechnung oder eines odt-Auftrags bei
2775 der entsprechenden Nachfrage "Makros ausführen"
2778 <para><emphasis role="bold">Wichtig</emphasis>: die Makros sind
2779 so eingestellt, dass sie beim Öffnen der Vorlagen selbst nicht
2780 ausgeführt werden. Das heisst für das Ansehen und Bearbeiten der
2781 Vorlagen sind keine speziellen Einstellungen in LibreOffice
2789 <title>Schweizer QR-Rechnung mit OpenDocument Vorlagen</title>
2792 <title>Übersicht</title>
2794 <para>Mit der Version 3.6.0 unterstützt Kivitendo die Erstellung von
2795 Schweizer QR-Rechnungen gemäss <ulink
2796 url="https://www.paymentstandards.ch/dam/downloads/ig-qr-bill-de.pdf">Swiss
2797 Payment Standards, Version 2.2</ulink>. Implementiert sind hierbei die
2802 <para><emphasis role="bold">QR-IBAN mit
2803 QR-Referenz</emphasis></para>
2807 <para><emphasis role="bold">IBAN ohne Referenz</emphasis></para>
2811 <para>Der Vorlagensatz "rev-odt" enthält die Vorlage
2812 <literal>invoice_qr.odt</literal>, welche für die Erstellung von
2813 QR-Rechnungen vorgesehen ist. Damit diese verwendet werden kann muss
2814 wie obenstehend beschrieben ein Drucker hinzugefügt werden (siehe
2815 <xref linkend="opendocument-druckvorlagen-mit-makros.vorbereitungen"/>
2816 ). Alternativ kann die Vorlage umbenannt werden in
2817 <literal>invoice.odt</literal>.</para>
2819 <para>Die Vorlage <literal>invoice_qr.odt</literal> kann beliebig
2820 angepasst werden. Zwingend muss diese jedoch das QR-Code Platzhalter
2821 Bild, als eingebettetes Bild, enthalten. Da dieses beim
2822 Ausdrucken/Erzeugen der Rechnung durch das neu generierte QR-Code
2823 Bild ersetzt wird.</para>
2827 <title>Einstellungen</title>
2830 <title>Mandantenkonfiguration</title>
2832 <para>Unter <emphasis>System → Mandantenkonfiguration →
2833 Features</emphasis>. Im Abschnitt <emphasis>Einkauf und
2834 Verkauf</emphasis>, beim Punkt <emphasis>Verkaufsrechnungen mit
2835 Schweizer QR-Rechnung erzeugen</emphasis>, die gewünschte Variante
2840 <title>Konfiguration der Bankkonten</title>
2842 <para>Unter <emphasis>System → Bankkonten</emphasis> muss bei
2843 mindestens einem Bankkonto die Option <emphasis>Nutzung mit
2844 Schweizer QR-Rechnung</emphasis> auf <emphasis
2845 role="bold">Ja</emphasis> gestellt werden.</para>
2848 <para>Für die Variante <emphasis role="bold">QR-IBAN mit
2849 QR-Referenz</emphasis> muss dieses Konto unter IBAN eine gültige
2850 <emphasis role="bold">QR-IBAN Nummer</emphasis> enthalten. Diese
2851 unterscheidet sich von der regulären IBAN.</para>
2853 <para>Zusätzlich muss eine gültige <emphasis role="bold">Bankkonto
2854 Identifikationsnummer</emphasis> angegeben werden
2857 <para>Diese werden von der jeweiligen Bank vergeben.</para>
2860 <para>Sind mehrere Konten ausgewählt wird das erste
2865 <title>Rechnungen ohne Betrag</title>
2867 <para>Für Rechnungen ohne Betrag (z.B. Spenden) kann, in der
2868 jeweiligen Rechnung, die Checkbox <emphasis>QR-Rechnung ohne
2869 Betrag</emphasis> aktiviert werden. Diese Checkbox erscheint nur,
2870 wenn QR-Rechnungen in der Mandantenkonfiguration aktiviert sind
2871 (variante ausgewählt).</para>
2873 <para>Dies wirkt sich lediglich auf den erzeugten QR-Code aus. Die
2874 Vorlage muss separat angepasst und ausgewählt werden.</para>
2879 <title>Adressdaten</title>
2881 <para>Die Adressdaten zum Zahlungsempfänger werden aus der
2882 Mandantenkonfiguration entnommen. Unter <emphasis>System →
2883 Mandantenkonfiguration → Verschiedenes</emphasis>, Abschnitt
2884 <emphasis>Firmenname und -adresse.</emphasis></para>
2886 <para>Die Adressdaten zum Zahlungspflichtigen stammen aus den
2887 Kundendaten der jeweiligen Rechnung.</para>
2889 <para>Die Adressen müssen inklusive Land angegeben werden. Akzeptiert
2890 werden Ländername oder Ländercode, also z.B. "Schweiz" oder "CH".
2893 <para>Diese können in der Vorlage mit den jeweiligen Variablen
2894 eingetragen werden. Siehe auch: <xref
2895 linkend="dokumentenvorlagen-und-variablen"/></para>
2897 <para>Der erzeugte QR-Code verwendet Adress-Typ "K" (Kombinierte
2898 Adressfelder, 2 Zeilen).</para>
2902 <title>Referenznummer</title>
2904 <para>Die Referenznummer wird in Kivitendo erzeugt und setzt sich
2905 wiefolgt zusammen:</para>
2909 <para>Bankkonto Identifikationsnummer (6-stellig)</para>
2913 <para>Kundennummer (6-stellig, mit führenden Nullen
2918 <para>Auftragsnummer (7-stellig, mit führenden Nullen
2923 <para>Rechnungsnummer (7-stellig, mit führenden Nullen
2928 <para>Prüfziffer (1-stellig, berechnet mittels modulo 10,
2933 <para>Es sind lediglich Ziffern erlaubt. Allfällige Prefixe mit
2934 Buchstaben werden entfernt und fehlende Stellen werden mit führenden
2935 Nullen aufgefüllt.</para>
2939 <title>Zusätzliche Variablen für Vorlage</title>
2941 <para>Zusätzlich zu den in der Vorlage standardmässig verfügbaren
2942 Variablen (siehe <xref linkend="dokumentenvorlagen-und-variablen"/>),
2943 werden die folgenden Variablen erzeugt:</para>
2947 <term>ref_number_formatted</term>
2950 <para>Referenznummer formatiert mit Leerzeichen, z.B.: 21 00000
2951 00003 13947 14300 09017</para>
2956 <term>iban_formatted</term>
2959 <para>IBAN formatiert mit Leerzeichen</para>
2964 <term>amount_formatted</term>
2967 <para>Betrag formatiert mit Tausendertrennzeichen Leerschlag,
2968 z.B.: 1 005.55</para>
2976 <sect1 id="nomenclature">
2977 <title>Nomenklatur</title>
2979 <sect2 id="booking.dates">
2980 <title>Datum bei Buchungen</title>
2982 <para>Seit der Version 3.5 werden für Buchungen in kivitendo
2983 einheitlich folgende Bezeichnungen verwendet:</para>
2987 <para><option>Erfassungsdatum</option> (en: <option>Entry
2988 Date</option>, code: <option>Gldate</option>)</para>
2990 <para>bezeichnet das Datum, an dem die Buchung in kivitendo
2991 erfasst wurde.</para>
2995 <para><option>Buchungsdatum</option> (en: <option>Booking
2996 Date</option>, code: <option>Transdate</option>)</para>
2998 <para>bezeichnet das buchhaltungstechnisch für eine Buchung
2999 relevante Datum</para>
3001 <para>Das <option>Rechnungsdatum</option> bei Verkaufs- und
3002 Einkaufsrechnungen entspricht dem Buchungsdatum. Das heisst, in
3003 Berichten wie dem Buchungsjournal, in denen eine Spalte
3004 <option>Buchungsdatum</option> angezeigt werden kann, erscheint
3005 hier im Fall von Rechnungen das Rechnungsdatum.</para>
3009 <para>Bezieht sich ein verbuchter Beleg auf einen Zeitpunkt, der
3010 nicht mit dem Buchungsdatum übereinstimmt, so kann dieses Datum
3011 momentan in kivitendo nur unter Bemerkungen erfasst werden.</para>
3013 <para>Möglicherweise wird für solche Fälle in einer späteren
3014 Version von kivitendo ein dritter Datumswert für Buchungen
3015 erstellt. (Beispiel: Einkaufsbeleg stammt aus einem früheren Jahr,
3016 das bereits buchhaltungstechnisch abgeschlossen wurde, und muss
3017 deshalb später verbucht werden.)</para>
3023 <sect1 id="config.eur">
3024 <title>Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung:
3027 <sect2 id="config.eur.introduction"
3028 xreflabel="Einführung in die Konfiguration zur EUR">
3029 <title>Einführung</title>
3031 <para>kivitendo besaß bis inklusive Version 2.6.3 einen
3032 Konfigurationsparameter namens <varname>eur</varname>, der sich in der
3033 Konfigurationsdatei <filename>config/kivitendo.conf</filename> (damals
3034 noch <filename>config/lx_office.conf</filename>) befand. Somit galt er
3035 für alle Mandanten, die in dieser Installation benutzt wurden.</para>
3037 <para>Mit der nachfolgenden Version wurde der Parameter zum Einen in
3038 die Mandantendatenbank verschoben und dabei auch gleich in drei
3039 Einzelparameter aufgeteilt, mit denen sich das Verhalten genauer
3040 steuern lässt.</para>
3043 <sect2 id="config.eur.parameters"
3044 xreflabel="Konfigurationsparameter für EUR">
3045 <title>Konfigurationsparameter</title>
3047 <para>Es gibt drei Parameter, die die Gewinnermittlungsart,
3048 Versteuerungsart und die Warenbuchungsmethode regeln:</para>
3052 <term><varname>profit_determination</varname></term>
3055 <para>Dieser Parameter legt die Berechnungsmethode für die
3056 Gewinnermittlung fest. Er enthält entweder
3057 <literal>balance</literal> für
3058 Betriebsvermögensvergleich/Bilanzierung oder
3059 <literal>income</literal> für die
3060 Einnahmen-Überschuss-Rechnung.</para>
3065 <term><varname>accounting_method</varname></term>
3068 <para>Dieser Parameter steuert die Buchungs- und
3069 Berechnungsmethoden für die Versteuerungsart. Er enthält
3070 entweder <literal>accrual</literal> für die Soll-Versteuerung
3071 oder <literal>cash</literal> für die Ist-Versteuerung.</para>
3076 <term><varname>inventory_system</varname></term>
3079 <para>Dieser Parameter legt die Warenbuchungsmethode fest. Er
3080 enthält entweder <literal>perpetual</literal> für die
3081 Bestandsmethode oder <literal>periodic</literal> für die
3082 Aufwandsmethode.</para>
3087 <para>Zum Vergleich der Funktionalität bis und nach 2.6.3:
3088 <varname>eur</varname> = 1 bedeutete Einnahmen-Überschuss-Rechnung,
3089 Ist-Versteuerung und Aufwandsmethode. <varname>eur</varname> = 0
3090 bedeutete hingegen Bilanzierung, Soll-Versteuerung und
3091 Bestandsmethode.</para>
3093 <para>Die Konfiguration "<varname>eur</varname>" unter
3094 <varname>[system]</varname> in der <link
3095 linkend="config.config-file">Konfigurationsdatei</link>
3096 <filename>config/kivitendo.conf</filename> wird nun nicht mehr
3097 benötigt und kann entfernt werden. Dies muss manuell geschehen.</para>
3100 <sect2 id="config.eur.setting-parameters">
3101 <title>Festlegen der Parameter</title>
3103 <para>Beim Anlegen eines neuen Mandanten bzw. einer neuen Datenbank in
3104 der Admininstration können diese Optionen nun unabhängig voneinander
3105 eingestellt werden.</para>
3107 <para>Für die Schweiz sind folgende Einstellungen üblich:
3110 <para>Sollversteuerung</para>
3114 <para>Aufwandsmethode</para>
3118 <para>Bilanzierung</para>
3120 </itemizedlist> Diese Einstellungen werden automatisch beim
3121 Erstellen einer neuen Datenbank vorausgewählt, wenn in
3122 <filename>config/kivitendo.conf</filename> unter
3123 <varname>[system]</varname> <literal>default_manager = swiss</literal>
3124 eingestellt ist.</para>
3126 <para>Beim Upgrade bestehender Mandanten wird eur ausgelesen und die
3127 Variablen werden so gesetzt, daß sich an der Funktionalität nichts
3130 <para>Die aktuelle Konfiguration wird unter Nummernkreise und
3131 Standardkonten unter dem neuen Punkt "Einstellungen" (read-only)
3132 angezeigt. Unter <guimenu>System</guimenu> →
3133 <guisubmenu>Mandantenkonfiguration</guisubmenu> können die
3134 Einstellungen auch geändert werden. Dabei ist zu beachten, dass eine
3135 Änderung vorhandene Daten so belässt und damit evtl. die Ergebnisse
3136 verfälscht. Dies gilt vor Allem für die Warenbuchungsmethode (siehe
3137 auch <link linkend="config.eur.inventory-system-perpetual">
3138 Bemerkungen zur Bestandsmethode</link>).</para>
3141 <sect2 id="config.eur.inventory-system-perpetual">
3142 <title>Bemerkungen zur Bestandsmethode</title>
3144 <para>Die Bestandsmethode ist eigentlich eine sehr elegante Methode,
3145 funktioniert in kivitendo aber nur unter bestimmten Bedingungen:
3146 Voraussetzung ist, daß auch immer alle Einkaufsrechnungen gepflegt
3147 werden, und man beim Jahreswechsel nicht mit einer leeren Datenbank
3148 anfängt, da bei jedem Verkauf anhand der gesamten Rechnungshistorie
3149 der Einkaufswert der Ware nach dem FIFO-Prinzip aus den
3150 Einkaufsrechnungen berechnet wird.</para>
3152 <para>Die Bestandsmethode kann vom Prinzip her also nur funktioneren,
3153 wenn man mit den Buchungen bei Null anfängt, und man kann auch nicht
3154 im laufenden Betrieb von der Aufwandsmethode zur Bestandsmethode
3158 <sect2 id="config.eur.knonw-issues">
3159 <title>Bekannte Probleme</title>
3161 <para>Bei bestimmten Berichten kann man derzeit noch inviduell
3162 einstellen, ob man nach Ist- oder Sollversteuerung auswertet, und es
3163 werden im Code Variablen wie $accrual oder $cash gesetzt. Diese
3164 Codestellen wurden noch nicht angepasst, sondern nur die, wo bisher
3165 die Konfigurationsvariable
3166 <varname>$::lx_office_conf{system}->{eur}</varname> ausgewertet
3169 <para>Es fehlen Hilfetext beim Neuanlegen eines Mandanten, was die
3170 Optionen bewirken, z.B. mit zwei Standardfällen.</para>
3174 <sect1 id="config.skr04-update-3804">
3175 <title>SKR04 19% Umstellung für innergemeinschaftlichen Erwerb</title>
3177 <sect2 id="config.skr04-update-3804.introduction">
3178 <title>Einführung</title>
3180 <para>Die Umsatzsteuerumstellung auf 19% für SKR04 für die
3181 Steuerschlüssel "EU ohne USt-ID Nummer" ist erst 2010 erfolgt.
3182 kivitendo beinhaltet ein Upgradeskript, das das Konto 3804 automatisch
3183 erstellt und die Steuereinstellungen korrekt einstellt. Hat der
3184 Benutzer aber schon selber das Konto 3804 angelegt, oder gab es schon
3185 Buchungen im Zeitraum nach dem 01.01.2007 auf das Konto 3803, wird das
3186 Upgradeskript vorsichtshalber nicht ausgeführt, da der Benutzer sich
3187 vielleicht schon selbst geholfen hat und mit seinen Änderungen
3188 zufrieden ist. Die korrekten Einstellungen kann man aber auch per Hand
3189 ausführen. Nachfolgend werden die entsprechenden Schritte anhand von
3190 Screenshots dargestellt.</para>
3192 <para>Für den Fall, daß Buchungen mit der Steuerschlüssel "EU ohne
3193 USt.-IdNr." nach dem 01.01.2007 erfolgt sind, ist davon auszugehen,
3194 dass diese mit dem alten Umsatzsteuersatz von 16% gebucht worden sind,
3195 und diese Buchungen sollten entsprechend kontrolliert werden.</para>
3198 <sect2 id="config.skr04-update-3804.create-chart">
3199 <title>Konto 3804 manuell anlegen</title>
3201 <para>Die folgenden Schritte sind notwendig, um das Konto manuell
3202 anzulegen und zu konfigurieren. Zuerst wird in
3203 <guimenu>System</guimenu> → <guisubmenu>Kontenübersicht</guisubmenu> →
3204 <guimenuitem>Konto erfassen</guimenuitem> das Konto angelegt.</para>
3207 <screeninfo>Konto 3804 erfassen</screeninfo>
3211 <imagedata fileref="images/skr04-update-3804/konto3804.png"/>
3216 <para>Als Zweites muss Steuergruppe 13 für Konto 3803 angepasst
3217 werden. Dazu unter <guimenu>System</guimenu> →
3218 <guisubmenu>Steuern</guisubmenu> →
3219 <guimenuitem>Bearbeiten</guimenuitem> den Eintrag mit Steuerschlüssel
3220 13 auswählen und ihn wie im folgenden Screenshot angezeigt
3224 <screeninfo>Steuerschlüssel 13 für 3803 (16%) anpassen</screeninfo>
3228 <imagedata fileref="images/skr04-update-3804/steuer3803.png"/>
3233 <para>Als Drittes wird ein neuer Eintrag mit Steuerschlüssel 13 für
3234 Konto 3804 (19%) angelegt. Dazu unter <guimenu>System</guimenu> →
3235 <guisubmenu>Steuern</guisubmenu> → <guimenuitem>Erfassen</guimenuitem>
3236 auswählen und die Werte aus dem Screenshot übernehmen.</para>
3239 <screeninfo>Steuerschlüssel 13 für 3804 (19%) anlegen</screeninfo>
3243 <imagedata fileref="images/skr04-update-3804/steuer3804.png"/>
3248 <para>Als Nächstes sind alle Konten anzupassen, die als
3249 Steuerautomatikkonto die 3803 haben, sodass sie ab dem 1.1.2007 auch
3250 Steuerautomatik auf 3804 bekommen. Dies betrifft in der
3251 Standardkonfiguration die Konten 4315 und 4726. Als Beispiel für 4315
3252 müssen Sie dazu unter <guimenu>System</guimenu> →
3253 <guisubmenu>Kontenübersicht</guisubmenu> → <guimenuitem>Konten
3254 anzeigen</guimenuitem> das Konto 4315 anklicken und die Einstellungen
3255 wie im Screenshot gezeigt vornehmen.</para>
3258 <screeninfo>Konto 4315 anpassen</screeninfo>
3262 <imagedata fileref="images/skr04-update-3804/konto4315.png"/>
3267 <para>Als Letztes sollte die Steuerliste unter
3268 <guimenu>System</guimenu> → <guisubmenu>Steuern</guisubmenu> →
3269 <guimenuitem>Bearbeiten</guimenuitem> kontrolliert werden. Zum
3270 Vergleich der Screenshot.</para>
3273 <screeninfo>Steuerliste vergleichen</screeninfo>
3277 <imagedata fileref="images/skr04-update-3804/steuerliste.png"/>
3284 <sect1 id="config.bilanz">
3285 <title>Verhalten des Bilanzberichts</title>
3287 <para>Bis Version 3.0 wurde "closedto" ("Bücher schließen zum") als
3288 Grundlage für das Startdatum benutzt. Schließt man die Bücher allerdings
3289 monatsweise führt dies zu falschen Werten.</para>
3291 <para>In der Mandantenkonfiguration kann man dieses Verhalten genau
3292 einstellen indem man:</para>
3296 <para>weiterhin closed_to benutzt (Default, es ändert sich nichts zu
3301 <para>immer den Jahresanfang nimmt (1.1. relativ zum
3306 <para>immer die letzte Eröffnungsbuchung als Startdatum nimmt</para>
3308 <para>- mit Jahresanfang als Alternative wenn es keine EB-Buchungen
3311 <para>- oder mit "alle Buchungen" als Alternative"</para>
3315 <para>mit Jahresanfang als Alternative wenn es keine EB-Buchungen
3320 <para>immer alle Buchungen seit Beginn der Datenbank nimmt</para>
3324 <para>Folgende Hinweise zu den Optionen: Das "Bücher schließen Datum"
3325 ist sinnvoll, wenn man nur komplette Jahre schließt. Bei Wirtschaftsjahr
3326 = Kalendarjahr entspricht dies aber auch dem Jahresanfang. "Alle
3327 Buchungen" kann z.B. sinnvoll sein wenn man ohne Jahresabschluß
3328 durchbucht. Eröffnungsbuchung mit "alle Buchungen" als Fallback ist z.B.
3329 sinnvoll, wenn man am sich Anfang des zweiten Buchungsjahres befindet,
3330 und noch keinen Jahreswechsel und auch noch keine EB-Buchungen hat. Bei
3331 den Optionen mit EB-Buchungen wird vorausgesetzt, daß diese immer am 1.
3332 Tag des Wirtschaftsjahres gebucht werden. Zur Sicherheit wird das
3333 Startdatum im Bilanzbericht jetzt zusätzlich zum Stichtag mit angezeigt.
3334 Das hilft auch bei der Kontrolle für den Abgleich mit der GuV bzw.
3335 Erfolgsrechnung.</para>
3338 <sect1 id="config.erfolgsrechnung">
3339 <title>Erfolgsrechnung</title>
3341 <para>Seit der Version 3.4.1 existiert in kivitendo der Bericht
3342 <emphasis role="bold"> Erfolgsrechnung</emphasis>.</para>
3344 <para>Die Erfolgsrechnung kann in der Mandantenkonfiguration unter
3345 Features an- oder abgeschaltet werden. Mit der Einstellung
3346 <varname>default_manager = swiss </varname> in der
3347 <filename>config/kivitendo.conf</filename> wird beim neu Erstellen einer
3348 Datenbank automatisch die Anzeige der Erfolgsrechnung im Menü
3349 <guimenu>Berichte </guimenu> ausgewählt und ersetzt dort die GUV.</para>
3351 <para>Im Gegensatz zur GUV werden bei der Erfolgsrechnung sämtliche
3352 Aufwands- und Erlöskonten einzeln aufgelistet (analog zur Bilanz),
3353 sortiert nach ERTRAG und AUFWAND.</para>
3355 <para>Bei den Konteneinstellungen muss bei jedem Konto, das in der
3356 Erfolgsrechnung erscheinen soll, unter <varname>Sonstige
3357 Einstellungen/Erfolgsrechnung</varname> entweder
3358 <literal>01.Ertrag</literal> oder <literal>06.Aufwand</literal>
3359 ausgewählt werden.</para>
3361 <para>Wird bei einem Erlöskonto <literal>06.Aufwand</literal>
3362 ausgewählt, so wird dieses Konto als Aufwandsminderung unter AUFWAND
3365 <para>Wird bei einem Aufwandskonto <literal>01.Ertrag</literal>
3366 ausgewählt, so wird dieses Konto als Ertragsminderung unter ERTRAG
3369 <para>Soll bei einer bereits bestehenden Buchhaltung in Zukunft
3370 zusätzlich die Erfolgsrechnung als Bericht verwendet werden, so müssen
3371 die Einstellungen zu allen Erlös- und Aufwandskonten unter
3372 <varname>Sonstige Einstellungen/Erfolgsrechnung</varname> überprüft und
3373 allenfalls neu gesetzt werden.</para>
3376 <sect1 id="config.rounding">
3377 <title>Rundung in Verkaufsbelegen</title>
3379 <para>In der Schweiz hat die kleinste aktuell benutzte Münze den Wert
3380 von 5 Rappen (0.05 CHF).</para>
3382 <para>Auch wenn im elektronischen Zahlungsverkehr Beträge mit einer
3383 Genauigkeit von 0.01 CHF verwendet werden können, ist es trotzdem nach
3384 wie vor üblich, Rechnungen mit auf 0.05 CHF gerundeten Beträgen
3385 auszustellen.</para>
3387 <para>In kivitendo kann seit der Version 3.4.1 die Einstellung für eine
3388 solche Rundung pro Mandant / Datenbank festgelegt werden.</para>
3390 <para>Die Einstellung wird beim Erstellen der Datenbank bei
3391 <literal>Genauigkeit</literal> festgelegt. Sie kann anschliessend über
3392 das Webinterface von kivitendo nicht mehr verändert werden.</para>
3394 <para>Abhängig vom Wert für <varname>default_manager</varname> in
3395 <filename>config/kivitendo.conf</filename> werden dabei folgende Werte
3396 voreingestellt:</para>
3400 <para>0.05 (default_manager = swiss)</para>
3404 <para>0.01 (default_manager = german)</para>
3408 <para>Der Wert wird in der Datenbank in der Tabelle <varname>defaults
3409 </varname>in der Spalte <varname>precision</varname> gespeichert.</para>
3411 <para>In allen Verkaufsangeboten, Verkaufsaufträgen, Verkaufsrechnungen
3412 und Verkaufsgutschriften wird der Endbetrag inkl. MWST gerundet, wenn
3413 dieser nicht der eingestellten Genauigkeit entspricht.</para>
3415 <para>Beim Buchen einer Verkaufsrechnung wird der Rundungsbetrag
3416 automatisch auf die in der Mandantenkonfiguration festgelegten
3417 Standardkonten für Rundungserträge bzw. Rundungsaufwendungen
3420 <para>(Die berechnete MWST wird durch den Rundungsbetrag nicht mehr
3423 <para>Die in den Druckvorlagen zur Verfügung stehenden Variablen
3424 <varname>quototal</varname>, <varname>ordtotal</varname> bzw.
3425 <varname>invtotal</varname> enthalten den gerundeten Betrag.</para>
3427 <para><emphasis role="bold">Achtung:</emphasis> Werden Verkaufsbelege in
3428 anderen Währungen als der Standardwährung erstellt, so muss in kivitendo
3429 ab Version 3.4.1 die Genauigkeit 0.01 verwendet werden.</para>
3431 <para>Das heisst, Firmen in der Schweiz, die teilweise
3432 Verkaufsrechnungen in Euro oder anderen Währungen erstellen wollen,
3433 müssen beim Erstellen der Datenbank als Genauigkeit 0.01 wählen und
3434 können zur Zeit die 5er Rundung noch nicht nutzen.</para>
3437 <sect1 id="config.client">
3438 <title>Einstellungen pro Mandant</title>
3440 <para>Einige Einstellungen können von einem Benutzer mit dem <link
3441 linkend="Zusammenhänge">Recht</link> "Administration (Für die Verwaltung
3442 der aktuellen Instanz aus einem Userlogin heraus)" gemacht werden. Diese
3443 Einstellungen sind dann für die aktuellen Mandanten-Datenbank gültig.
3444 Die Einstellungen sind unter <guimenu>System</guimenu> →
3445 <guisubmenu>Mandantenkonfiguration</guisubmenu> erreichbar.</para>
3447 <para>Bitte beachten Sie die Hinweise zu den einzelnen Einstellungen.
3448 Einige Einstellungen sollten nicht ohne Weiteres im laufenden Betrieb
3449 geändert werden (siehe auch <link
3450 linkend="config.eur.inventory-system-perpetual">Bemerkungen zu
3451 Bestandsmethode</link>).</para>
3453 <para>Die Einstellungen <literal>show_bestbefore</literal> und
3454 <literal>payments_changeable</literal> aus dem Abschnitt
3455 <literal>features</literal> und die Einstellungen im Abschnitt
3456 <literal>datev_check</literal> (sofern schon vorhanden) der <link
3457 linkend="config.config-file">kivitendo-Konfigurationsdatei</link> werden
3458 bei einem Datenbankupdate einer älteren Version automatisch übernommen.
3459 Diese Einträge können danach aus der Konfigurationsdatei entfernt
3463 <sect1 id="kivitendo-ERP-verwenden">
3464 <title>kivitendo ERP verwenden</title>
3466 <para>Nach erfolgreicher Installation ist der Loginbildschirm unter
3467 folgender URL erreichbar:</para>
3470 url="http://localhost/kivitendo-erp/login.pl">http://localhost/kivitendo-erp/login.pl</ulink></para>
3472 <para>Die Administrationsseite erreichen Sie unter:</para>
3475 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
3479 <chapter id="features" xreflabel="Features und Funktionen">
3480 <title>Features und Funktionen</title>
3482 <sect1 id="features.periodic-invoices"
3483 xreflabel="Wiederkehrende Rechnungen">
3484 <title>Wiederkehrende Rechnungen</title>
3486 <sect2 id="features.periodic-invoices.introduction"
3487 xreflabel="Einführung in wiederkehrende Rechnungen">
3488 <title>Einführung</title>
3490 <para>Wiederkehrende Rechnungen werden als normale Aufträge definiert
3491 und konfiguriert, mit allen dazugehörigen Kunden- und Artikelangaben.
3492 Die konfigurierten Aufträge werden später automatisch in Rechnungen
3493 umgewandelt, so als ob man den Workflow benutzen würde, und auch die
3494 Auftragsnummer wird übernommen, sodass alle wiederkehrenden
3495 Rechnungen, die aus einem Auftrag erstellt wurden, später leicht
3496 wiederzufinden sind.</para>
3499 <sect2 id="features.periodic-invoices.configuration"
3500 xreflabel="Konfiguration von wiederkehrenden Rechnungen">
3501 <title>Konfiguration</title>
3503 <para>Um einen Auftrag für wiederkehrende Rechnung zu konfigurieren,
3504 findet sich beim Bearbeiten des Auftrags ein neuer Knopf
3505 "Konfigurieren", der ein neues Fenster öffnet, in dem man die nötigen
3506 Parameter einstellen kann. Hinter dem Knopf wird außerdem noch
3507 angezeigt, ob der Auftrag als wiederkehrende Rechnung konfiguriert ist
3510 <para>Folgende Parameter kann man konfigurieren:</para>
3517 <para>Bei aktiven Rechnungen wird automatisch eine Rechnung
3518 erstellt, wenn die Periodizität erreicht ist (z.B. am Anfang
3519 eines neuen Monats).</para>
3521 <para>Ist ein Auftrag nicht aktiv, so werden für ihn auch keine
3522 wiederkehrenden Rechnungen erzeugt. Stellt man nach längerer
3523 nicht-aktiver Zeit einen Auftrag wieder auf aktiv, wird beim
3524 nächsten Periodenwechsel für alle Perioden, seit der letzten
3525 aktiven Periode, jeweils eine Rechnung erstellt. Möchte man dies
3526 verhindern, muss man vorher das Startdatum neu setzen.</para>
3528 <para>Für gekündigte Aufträge werden nie mehr Rechnungen
3529 erstellt. Man kann sich diese Aufträge aber gesondert in den
3530 Berichten anzeigen lassen.</para>
3535 <term>Periodizität</term>
3538 <para>Ob monatlich, quartalsweise oder jährlich auf neue
3539 Rechnungen überprüft werden soll. Für jede Periode seit dem
3540 Startdatum wird überprüft, ob für die Periode (beginnend immer
3541 mit dem ersten Tag der Periode) schon eine Rechnung erstellt
3542 wurde. Unter Umständen können bei einem Startdatum in der
3543 Vergangenheit gleich mehrere Rechnungen erstellt werden.</para>
3548 <term>Buchen auf</term>
3551 <para>Das Forderungskonto, in der Regel "Forderungen aus
3552 Lieferungen und Leistungen". Das Gegenkonto ergibt sich aus den
3553 Buchungsgruppen der betreffenden Waren.</para>
3558 <term>Startdatum</term>
3561 <para>ab welchem Datum auf Rechnungserstellung geprüft werden
3567 <term>Enddatum</term>
3570 <para>ab wann keine Rechnungen mehr erstellt werden
3576 <term>Automatische Verlängerung um x Monate</term>
3579 <para>Sollen die wiederkehrenden Rechnungen bei Erreichen des
3580 eingetragenen Enddatums weiterhin erstellt werden, so kann man
3581 hier die Anzahl der Monate eingeben, um die das Enddatum
3582 automatisch nach hinten geschoben wird.</para>
3587 <term>Drucken</term>
3590 <para>Sind Drucker konfiguriert, so kann man sich die erstellten
3591 Rechnungen auch gleich ausdrucken lassen.</para>
3596 <para>Nach Erstellung der Rechnungen kann eine E-Mail mit
3597 Informationen zu den erstellten Rechnungen verschickt werden.
3598 Konfiguriert wird dies in der <link
3599 linkend="config.config-file.sections-parameters">Konfigurationsdatei</link>
3600 <filename>config/kivitendo.conf</filename> im Abschnitt
3601 <varname>[periodic_invoices]</varname>.</para>
3604 <sect2 id="features.periodic-invoices.variables">
3605 <title>Spezielle Variablen</title>
3607 <para>Um die erzeugten Rechnungen individualisieren zu können, werden
3608 beim Umwandeln des Auftrags in eine Rechnung einige speziell
3609 formatierte Variablen durch für die jeweils aktuelle
3610 Abrechnungsperiode gültigen Werte ersetzt. Damit ist es möglich, z.B.
3611 den Abrechnungszeitraum explizit auszuweisen. Eine Variable hat dabei
3612 die Syntax <literal><%variablenname%></literal>.</para>
3614 <para>Sofern es sich um eine Datumsvariable handelt, kann das
3615 Ausgabeformat weiter bestimmt werden, indem an den Variablennamen
3616 Formatoptionen angehängt werden. Die Syntax sieht dabei wie folgt aus:
3617 <literal><%variablenname FORMAT=Formatinformation%></literal>.
3618 Die zur verfügung stehenden Formatinformationen werden unten genauer
3621 <para>Diese Variablen können auch beim automatischen Versand der
3622 erzeugten Rechnungen per E-Mail genutzt werden, indem sie in den
3623 Feldern für den Betreff oder die Nachricht verwendet werden.</para>
3625 <para>Diese Variablen werden in den folgenden Elementen des Auftrags
3630 <para>Bemerkungen</para>
3634 <para>Interne Bemerkungen</para>
3638 <para>Vorgangsbezeichnung</para>
3642 <para>In den Beschreibungs- und Langtextfeldern aller
3647 <para>Die zur Verfügung stehenden Variablen sind die Folgenden:</para>
3651 <term><varname><%current_quarter%></varname>,
3652 <varname><%previous_quarter%></varname>,
3653 <varname><%next_quarter%></varname></term>
3656 <para>Aktuelles, vorheriges und nächstes Quartal als Zahl
3657 zwischen <literal>1</literal> und <literal>4</literal>.</para>
3662 <term><varname><%current_month%></varname>,
3663 <varname><%previous_month%></varname>,
3664 <varname><%next_month%></varname></term>
3667 <para>Aktueller, vorheriger und nächster Monat als Zahl zwischen
3668 <literal>1</literal> und <literal>12</literal>.</para>
3673 <term><varname><%current_month_long%></varname>,
3674 <varname><%previous_month_long%></varname>,
3675 <varname><%next_month_long%></varname></term>
3678 <para>Aktueller, vorheriger und nächster Monat als Name
3679 (<literal>Januar</literal>, <literal>Februar</literal>
3685 <term><varname><%current_year%></varname>,
3686 <varname><%previous_year%></varname>,
3687 <varname><%next_year%></varname></term>
3690 <para>Aktuelles, vorheriges und nächstes Jahr als vierstellige
3691 Jahreszahl (<literal>2013</literal> etc.).</para>
3696 <term><varname><%period_start_date%></varname>,
3697 <varname><%period_end_date%></varname></term>
3700 <para>Formatiertes Datum des ersten und letzten Tages im
3701 Abrechnungszeitraum (z.B. bei quartalsweiser Abrechnung und im
3702 ersten Quartal von 2013 wären dies der
3703 <literal>01.01.2013</literal> und
3704 <literal>31.03.2013</literal>).</para>
3709 <para>Die invidiuellen Formatinformationen bestehen aus Paaren von
3710 Prozentzeichen und einem Buchstaben, welche beide zusammen durch den
3711 dazugehörigen Wert ersetzt werden. So wird z.B. <literal>%Y</literal>
3712 durch das viertstellige Jahr ersetzt. Alle möglichen Platzhalter
3717 <term><varname>%a</varname></term>
3720 <para>Der abgekürzte Wochentagsname.</para>
3725 <term><varname>%A</varname></term>
3728 <para>Der ausgeschriebene Wochentagsname.</para>
3733 <term><varname>%b</varname></term>
3736 <para>Der abgekürzte Monatsname.</para>
3741 <term><varname>%B</varname></term>
3744 <para>Der ausgeschriebene Monatsname.</para>
3749 <term><varname>%C</varname></term>
3752 <para>Das Jahrhundert (Jahr/100) als eine zweistellige
3758 <term><varname>%d</varname></term>
3761 <para>Der Monatstag als Zahl zwischen 01 und 31.</para>
3766 <term><varname>%D</varname></term>
3769 <para>Entspricht %m/%d/%y (amerikanisches Datumsformat).</para>
3774 <term><varname>%e</varname></term>
3777 <para>Wie %d (Monatstag als Zahl zwischen 1 und 31), allerdings
3778 werden führende Nullen durch Leerzeichen ersetzt.</para>
3783 <term><varname>%F</varname></term>
3786 <para>Entspricht %Y-%m-%d (das ISO-8601-Datumsformat).</para>
3791 <term><varname>%j</varname></term>
3794 <para>Der Tag im Jahr als Zahl zwischen 001 und 366
3800 <term><varname>%m</varname></term>
3803 <para>Der Monat als Zahl zwischen 01 und 12 inklusive.</para>
3808 <term><varname>%u</varname></term>
3811 <para>Der Wochentag als Zahl zwischen 1 und 7 inklusive, wobei
3812 die 1 dem Montag entspricht.</para>
3817 <term><varname>%U</varname></term>
3820 <para>Die Wochennummer als Zahl zwischen 00 und 53 inklusive,
3821 wobei der erste Sonntag im Jahr das Startdatum von Woche 01
3827 <term><varname>%V</varname></term>
3830 <para>Die ISO-8601:1988-Wochennummer als Zahl zwischen 01 und 53
3831 inklusive, wobei Woche 01 die erste Woche, von der mindestens
3832 vier Tage im Jahr liegen; Montag ist erster Tag der
3838 <term><varname>%w</varname></term>
3841 <para>Der Wochentag als Zahl zwischen 0 und 6 inklusive, wobei
3842 die 0 dem Sonntag entspricht.</para>
3847 <term><varname>%W</varname></term>
3850 <para>Die Wochennummer als Zahl zwischen 00 und 53 inklusive,
3851 wobei der erste Montag im Jahr das Startdatum von Woche 01
3857 <term><varname>%y</varname></term>
3860 <para>Das Jahr als zweistellige Zahl zwischen 00 und 99
3866 <term><varname>%Y</varname></term>
3869 <para>Das Jahr als vierstellige Zahl.</para>
3874 <term><varname>%%</varname></term>
3877 <para>Das Prozentzeichen selber.</para>
3882 <para>Anwendungsbeispiel für die Ausgabe, von welchem Monat und Jahr
3883 bis zu welchem Monat und Jahr die aktuelle Abrechnungsperiode dauert:
3884 <literal>Abrechnungszeitrum: <%period_start_date FORMAT=%m/%Y%>
3885 bis <%period_end_date FORMAT=%m/%Y%></literal></para>
3887 <para>Beim automatischen Versand der Rechnugen via E-Mail können neben diesen speziellen Variablen auch einige Eigenschaften der
3888 Rechnung selber als Variablen im Betreff & dem Text der E-Mails genutzt werden. Beispiele sind
3889 <varname><%invnumber%></varname> für die Rechnungsnummber oder <varname><transaction_description%></varname> für die
3890 Vorgangsbezeichnung. Diese Variablen stehen beim Erzeugen der Rechnung logischerweise noch nicht zur Verfügung.</para>
3893 <sect2 id="features.periodic-invoices.reports">
3894 <title>Auflisten</title>
3896 <para>Unter Verkauf->Berichte->Aufträge finden sich zwei neue
3897 Checkboxen, "Wiederkehrende Rechnungen aktiv" und "Wiederkehrende
3898 Rechnungen inaktiv", mit denen man sich einen Überglick über die
3899 wiederkehrenden Rechnungen verschaffen kann.</para>
3902 <sect2 id="features.periodic-invoices.task-server">
3903 <title>Erzeugung der eigentlichen Rechnungen</title>
3905 <para>Die zeitliche und periodische Überprüfung, ob eine
3906 wiederkehrende Rechnung automatisch erstellt werden soll, geschieht
3907 durch den <link linkend="config.task-server">Task-Server</link>, einen
3908 externen Dienst, der automatisch beim Start des Servers gestartet
3909 werden sollte.</para>
3912 <sect2 id="features.periodic-invoices.create-for-current-month">
3913 <title>Erste Rechnung für aktuellen Monat erstellen</title>
3915 <para>Will man im laufenden Monat eine monatlich wiederkehrende
3916 Rechnung inkl. des laufenden Monats starten, stellt man das Startdatum
3917 auf den Monatsanfang und wartet ein paar Minuten, bis der Task-Server
3918 den neu konfigurieren Auftrag erkennt und daraus eine Rechnung
3919 generiert hat. Alternativ setzt man das Startdatum auf den
3920 Monatsersten des Folgemonats und erstellt die erste Rechnung direkt
3921 manuell über den Workflow.</para>
3925 <sect1 id="features.bank" xreflabel="bankerweiterung">
3926 <title>Bankerweiterung</title>
3928 <sect2 id="features.bank.introduction"
3929 xreflabel="Einführung in die Bankerweiterung">
3930 <title>Einführung</title>
3932 <para>Die Beschreibung der Bankerweiterung befindet sich derzeit noch
3933 im Wiki und soll von dort später hierhin übernommen werden:</para>
3936 url="http://redmine.kivitendo-premium.de/projects/forum/wiki/Bankerweiterung">http://redmine.kivitendo-premium.de/projects/forum/wiki/Bankerweiterung</ulink></para>
3940 <sect1 id="dokumentenvorlagen-und-variablen">
3941 <title>Dokumentenvorlagen und verfügbare Variablen</title>
3943 <sect2 id="dokumentenvorlagen-und-variablen.einführung">
3944 <title>Einführung</title>
3946 <para>Dies ist eine Auflistung der Standard-Dokumentenvorlagen und
3947 aller zur Bearbeitung verfügbaren Variablen. Eine Variable wird in
3948 einer Vorlage durch ihren Inhalt ersetzt, wenn sie in der Form
3949 <function><%variablenname%></function> verwendet wird. Für
3950 LaTeX- und HTML-Vorlagen kann man die Form dieser Tags auch verändern
3952 linkend="dokumentenvorlagen-und-variablen.tag-style"/>).</para>
3954 <para>kivitendo unterstützt LaTeX-, HTML- und OpenDocument-Vorlagen.
3955 Sofern es nicht ausdrücklich eingeschränkt wird, gilt das im Folgenden
3956 gesagte für alle Vorlagenarten.</para>
3958 <para>Insgesamt sind technisch gesehen eine ganze Menge mehr Variablen
3959 verfügbar als hier aufgelistet werden. Die meisten davon können
3960 allerdings innerhalb einer solchen Vorlage nicht sinnvoll verwendet
3961 werden. Wenn eine Auflistung dieser Variablen gewollt ist, so kann
3962 diese wie folgt erhalten werden:</para>
3966 <para><filename>SL/Form.pm</filename> öffnen und am Anfang die
3967 Zeile "<command>use Data::Dumper;</command>" einfügen.</para>
3971 <para>In <filename>Form.pm</filename> die Funktion
3972 <function>parse_template</function> suchen und hier die Zeile
3973 <command>print(STDERR Dumper($self));</command> einfügen.</para>
3977 <para>Einmal per Browser die gewünschte Vorlage "benutzen", z.B.
3978 ein PDF für eine Rechnung erzeugen.</para>
3982 <para>Im <filename>error.log</filename> Apache steht die Ausgabe
3983 der Variablen <varname>$self</varname> in der Form <varname>'key'
3984 => 'value',</varname>. Alle <varname>key</varname>s sind
3990 <sect2 id="dokumentenvorlagen-und-variablen.variablen-ausgeben">
3991 <title>Variablen ausgeben</title>
3993 <para>Um eine Variable auszugeben, müssen sie einfach nur zwischen die
3994 Tags geschrieben werden, also z.B.
3995 <varname><%variablenname%></varname>.</para>
3997 <para>Optional kann man auch mit Leerzeichen getrennte Flags angeben,
3998 die man aber nur selten brauchen wird. Die Syntax sieht also so aus:
3999 <varname><%variablenname FLAG1 FLAG2%></varname>. Momentan
4000 werden die folgenden Flags unterstützt:</para>
4004 <para><option>NOFORMAT</option> gilt nur für Zahlenwerte und gibt
4005 den Wert ohne Formatierung, also ohne Tausendertrennzeichen mit
4006 mit einem Punkt als Dezimaltrennzeichen aus. Nützlich z.B., wenn
4007 damit in der Vorlage z.B. von LaTeX gerechnet werden soll.</para>
4011 <para><option>NOESCAPE</option> unterdrückt das Escapen von
4012 Sonderzeichen für die Vorlagensprache. Wenn also in einer
4013 Variablen bereits gültiger LaTeX-Code steht und dieser von LaTeX
4014 auch ausgewertet und nicht wortwörtlich angezeigt werden soll, so
4015 ist dieses Flag sinnvoll.</para>
4019 <para>Beispiel:</para>
4021 <programlisting><%quototal NOFORMAT%></programlisting>
4024 <sect2 id="dokumentenvorlagen-und-variablen.verwendung-in-druckbefehlen">
4025 <title>Verwendung in Druckbefehlen</title>
4027 <para>In der Admininstration können Drucker definiert werden. Auch im
4028 dort eingebbaren Druckbefehl können die hier aufgelisteten Variablen
4029 und Kontrollstrukturen verwendet werden. Ihr Inhalt wird dabei nach
4030 den Regeln der gängigen Shells formatiert, sodass Sonderzeichen wie
4031 <function>`...`</function> nicht zu unerwünschtem Verhalten
4034 <para>Dies erlaubt z.B. die Definition eines Faxes als Druckerbefehl,
4035 für das die Telefonnummer eines Ansprechpartners als Teil der
4036 Kommandozeile verwendet wird. Für ein fiktives Kommando könnte das
4037 z.B. wie folgt aussehen:</para>
4039 <programlisting>send_fax --number <%if cp_phone2%><%cp_phone2%><%else%><%cp_phone1%><%end%></programlisting>
4042 <sect2 id="dokumentenvorlagen-und-variablen.tag-style"
4043 xreflabel="Anfang und Ende der Tags verändern">
4044 <title>Anfang und Ende der Tags verändern</title>
4046 <para>Der Standardstil für Tags sieht vor, dass ein Tag mit dem
4047 Kleinerzeichen und einem Prozentzeichen beginnt und mit dem
4048 Prozentzeichen und dem Größerzeichen endet, beispielsweise
4049 <function><%customer%></function>. Da diese Form aber z.B. in
4050 LaTeX zu Problemen führen kann, weil das Prozentzeichen dort
4051 Kommentare einleitet, kann pro HTML- oder LaTeX-Dokumentenvorlage der
4052 Stil umgestellt werden.</para>
4054 <para>Dazu werden in die Datei Zeilen geschrieben, die mit dem für das
4055 Format gültigen Kommentarzeichen anfangen, dann
4056 <function>config:</function> enthalten, die entsprechende Option
4057 setzen und bei HTML-Dokumentenvorlagen mit dem Kommentarendzeichen
4058 enden. Beispiel für LaTeX:</para>
4060 <programlisting>% config: tag-style=($ $)</programlisting>
4062 <para>Dies würde kivitendo dazu veranlassen, Variablen zu ersetzen,
4063 wenn sie wie folgt aussehen: <function>($customer$)</function>. Das
4064 äquivalente Beispiel für HTML-Dokumentenvorlagen sieht so aus:</para>
4066 <programlisting><!-- config: tag-style=($ $) --></programlisting>
4069 <sect2 id="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">
4070 <title>Zuordnung von den Dateinamen zu den Funktionen</title>
4072 <para>Diese folgende kurze Auflistung zeigt, welche Vorlage bei
4073 welcher Funktion ausgelesen wird. Dabei ist die Dateiendung
4074 "<filename>.ext</filename>" geeignet zu ersetzen:
4075 "<filename>.tex</filename>" für LaTeX-Vorlagen und
4076 "<filename>.odt</filename>" für OpenDocument-Vorlagen.</para>
4080 <term><filename>bin_list.ext</filename></term>
4083 <para>Lagerliste</para>
4088 <term><filename>check.ext</filename></term>
4096 <term><filename>invoice.ext</filename></term>
4099 <para>Rechnung</para>
4104 <term><filename>packing_list.ext</filename></term>
4107 <para>Packliste</para>
4112 <term><filename>pick_list.ext</filename></term>
4115 <para>Sammelliste</para>
4120 <term><filename>purchase_delivery_order.ext</filename></term>
4123 <para>Lieferschein (Einkauf)</para>
4128 <term><filename>purcharse_order.ext</filename></term>
4131 <para>Bestellung an Lieferanten</para>
4136 <term><filename>request_quotation.ext</filename></term>
4139 <para>Anfrage an Lieferanten</para>
4144 <term><filename>sales_delivery_order.ext</filename></term>
4147 <para>Lieferschein (Verkauf)</para>
4152 <term><filename>sales_order.ext</filename></term>
4155 <para>Bestellung</para>
4160 <term><filename>sales_quotation.ext</filename></term>
4163 <para>Angebot an Kunden</para>
4168 <term><filename>zahlungserinnerung.ext</filename></term>
4171 <para>Mahnung (Dateiname im Programm konfigurierbar)</para>
4176 <term><filename>zahlungserinnerung_invoice.ext</filename></term>
4179 <para>Rechnung über Mahngebühren (Dateiname im Programm
4180 konfigurierbar)</para>
4186 <sect2 id="dokumentenvorlagen-und-variablen.dateinamen-erweitert">
4187 <title>Sprache, Drucker und E-Mail</title>
4189 <para>Angeforderte Sprache und Druckerkürzel in den Dateinamen mit
4190 eingearbeitet. So wird aus der Vorlage
4191 <filename>sales_order.ext</filename> bei Sprache
4192 <function>de</function> und Druckerkürzel <function>lpr2</function>
4193 der Vorlagenname <filename>sales_order_de_lpr2.ext</filename>.
4194 Zusätzlich können für E-Mails andere Vorlagen erstellt werden, diese
4195 bekommen dann noch das Kürzel <filename>_email</filename>, der
4196 vollständige Vorlagenname wäre dann
4197 <filename>sales_order_email_de_lpr2.ext</filename>. In allen Fällen
4198 kann eine Standarddatei <filename>default.ext</filename> hinterlegt
4199 werden. Diese wird verwendet, wenn keine der anderen Varianten
4200 gefunden wird.</para>
4202 <para>Die vollständige Suchreihenfolge für einen Verkaufsauftrag mit
4203 der Sprache "de" und dem Drucker "lpr2", der per E-Mail im Format PDF
4204 verschickt wird, ist:</para>
4208 <para><filename>sales_order_email_de_lpr2.tex</filename></para>
4212 <para><filename>sales_order_de_lpr2.tex</filename></para>
4216 <para><filename>sales_order.tex</filename></para>
4220 <para><filename>default.tex</filename></para>
4224 <para>Die kurzen Varianten dieser Vorlagentitel müssen dann entweder
4225 Standardwerte anzeigen, oder die angeforderten Werte selbst auswerten,
4227 linkend="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"/>.</para>
4230 <sect2 id="dokumentenvorlagen-und-variablen.allgemeine-variablen">
4231 <title>Allgemeine Variablen, die in allen Vorlagen vorhanden
4234 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"
4235 xreflabel="Metainformationen zur angeforderten Vorlage">
4236 <title>Metainformationen zur angeforderten Vorlage</title>
4238 <para>Diese Variablen liefern Informationen darüber welche Variante
4239 einer Vorlage der Benutzer angefragt hat. Sie sind nützlich für
4240 Vorlagenautoren, die aus einer zentralen Layoutvorlage die einzelnen
4241 Formulare einbinden möchten.</para>
4245 <term><varname>template_meta.formname</varname></term>
4248 <para>Basisname der Vorlage. Identisch mit der <link
4249 linkend="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">Zurordnung
4250 zu den Dateinamen</link> ohne die Erweiterung. Ein
4251 Verkaufsauftrag enthält hier
4252 <constant>sales_order</constant>.</para>
4257 <term><varname>template_meta.language.description</varname></term>
4260 <para>Beschreibung der verwendeten Sprache</para>
4265 <term><varname>template_meta.language.template_code</varname></term>
4268 <para>Vorlagenkürzel der verwendeten Sprache, identisch mit
4269 dem Kürzel das im Dateinamen verwendetet wird.</para>
4274 <term><varname>template_meta.language.output_numberformat</varname></term>
4277 <para>Zahlenformat der verwendeten Sprache in der Form
4278 "<constant>1.000,00</constant>". Experimentell! Nur
4279 interessant für Vorlagen die mit unformatierten Werten
4285 <term><varname>template_meta.language.output_dateformat</varname></term>
4288 <para>Datumsformat der verwendeten Sprache in der Form
4289 "<constant>dd.mm.yyyy</constant>". Experimentell! Nur
4290 interessant für Vorlagen die mit unformatierten Werten
4296 <term><varname>template_meta.format</varname></term>
4299 <para>Das angeforderte Format. Kann im Moment die Werte
4300 <constant>pdf</constant>, <constant>postscript</constant>,
4301 <constant>html</constant>, <constant>opendocument</constant>,
4302 <constant>opendocument_pdf</constant> und
4303 <constant>excel</constant> enthalten.</para>
4308 <term><varname>template_meta.extension</varname></term>
4311 <para>Dateierweiterung, wie im Dateinamen. Wird aus
4312 <constant>format</constant> entschieden.</para>
4317 <term><varname>template_meta.media</varname></term>
4320 <para>Ausgabemedium. Kann zur Zeit die Werte
4321 <constant>screen</constant> für Bildschirm,
4322 <constant>email</constant> für E-Mail (triggert das
4323 <constant>_email</constant> Kürzel im Dateinamen),
4324 <constant>printer</constant> für Drucker, und
4325 <constant>queue</constant> für Warteschlange enthalten.</para>
4330 <term><varname>template_meta.printer.description</varname></term>
4333 <para>Beschreibung des ausgewählten Druckers</para>
4338 <term><varname>template_meta.printer.template_code</varname></term>
4341 <para>Vorlagenürzel des ausgewählten Druckers, identisch mit
4342 dem Kürzel das im Dateinamen verwendetet wird.</para>
4347 <term><varname>template_meta.tmpfile</varname></term>
4350 <para>Datei-Prefix für temporäre Dateien.</para>
4356 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.kunden-lieferanten">
4357 <title>Stammdaten von Kunden und Lieferanten</title>
4361 <term><varname>account_number</varname></term>
4364 <para>Kontonummer</para>
4369 <term><varname>bank</varname></term>
4372 <para>Name der Bank</para>
4377 <term><varname>bank_code</varname></term>
4380 <para>Bankleitzahl</para>
4385 <term><varname>bic</varname></term>
4388 <para>Bank-Identifikations-Code (Bank Identifier Code,
4394 <term><varname>business</varname></term>
4397 <para>Kunden-/Lieferantentyp</para>
4402 <term><varname>city</varname></term>
4410 <term><varname>contact</varname></term>
4413 <para>Kontakt</para>
4418 <term><varname>country</varname></term>
4426 <term><varname>c_vendor_id</varname></term>
4429 <para>Lieferantennummer beim Kunden (nur Kunden)</para>
4434 <term><varname>v_customer_id</varname></term>
4437 <para>Kundennummer beim Lieferanten (nur Lieferanten)</para>
4442 <term><varname>cp_email</varname></term>
4445 <para>Email des Ansprechpartners</para>
4450 <term><varname>cp_givenname</varname></term>
4453 <para>Vorname des Ansprechpartners</para>
4458 <term><varname>cp_greeting</varname></term>
4461 <para>Anrede des Ansprechpartners</para>
4466 <term><varname>cp_name</varname></term>
4469 <para>Name des Ansprechpartners</para>
4474 <term><varname>cp_phone1</varname></term>
4477 <para>Telefonnummer 1 des Ansprechpartners</para>
4482 <term><varname>cp_phone2</varname></term>
4485 <para>Telefonnummer 2 des Ansprechpartners</para>
4490 <term><varname>cp_title</varname></term>
4493 <para>Titel des Ansprechpartners</para>
4498 <term><varname>creditlimit</varname></term>
4501 <para>Kreditlimit</para>
4506 <term><varname>customeremail</varname></term>
4509 <para>Email des Kunden; nur für Kunden</para>
4514 <term><varname>customerfax</varname></term>
4517 <para>Faxnummer des Kunden; nur für Kunden</para>
4522 <term><varname>customernotes</varname></term>
4525 <para>Bemerkungen beim Kunden; nur für Kunden</para>
4530 <term><varname>customernumber</varname></term>
4533 <para>Kundennummer; nur für Kunden</para>
4538 <term><varname>customerphone</varname></term>
4541 <para>Telefonnummer des Kunden; nur für Kunden</para>
4546 <term><varname>discount</varname></term>
4554 <term><varname>email</varname></term>
4557 <para>Emailadresse</para>
4562 <term><varname>fax</varname></term>
4565 <para>Faxnummer</para>
4570 <term><varname>gln</varname></term>
4573 <para>GLN (Globale Lokationsnummer)</para>
4578 <term><varname>greeting</varname></term>
4586 <term><varname>homepage</varname></term>
4589 <para>Homepage</para>
4594 <term><varname>iban</varname></term>
4597 <para>Internationale Kontonummer (International Bank Account
4598 Number, IBAN)</para>
4603 <term><varname>language</varname></term>
4606 <para>Sprache</para>
4611 <term><varname>name</varname></term>
4614 <para>Firmenname</para>
4619 <term><varname>natural_person</varname></term>
4622 <para>Flag "natürliche Person"; Siehe auch
4623 <xref linkend="dokumentenvorlagen-und-variablen.anrede"/></para>
4628 <term><varname>payment_description</varname></term>
4631 <para>Name der Zahlart</para>
4636 <term><varname>payment_terms</varname></term>
4639 <para>Zahlungskonditionen</para>
4644 <term><varname>phone</varname></term>
4647 <para>Telefonnummer</para>
4652 <term><varname>shiptocity</varname></term>
4655 <para>Stadt (Lieferadresse) <link
4656 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4661 <term><varname>shiptocontact</varname></term>
4664 <para>Kontakt (Lieferadresse) <link
4665 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4670 <term><varname>shiptocountry</varname></term>
4673 <para>Land (Lieferadresse) <link
4674 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4679 <term><varname>shiptodepartment_1</varname></term>
4682 <para>Abteilung 1 (Lieferadresse) <link
4683 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4688 <term><varname>shiptodepartment_2</varname></term>
4691 <para>Abteilung 2 (Lieferadresse) <link
4692 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4697 <term><varname>shiptoemail</varname></term>
4700 <para>Email (Lieferadresse) <link
4701 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4706 <term><varname>shiptofax</varname></term>
4709 <para>Fax (Lieferadresse) <link
4710 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4715 <term><varname>shiptogln</varname></term>
4718 <para>GLN (Globale Lokationsnummer) (Lieferadresse) <link
4719 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4724 <term><varname>shiptoname</varname></term>
4727 <para>Firmenname (Lieferadresse) <link
4728 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4733 <term><varname>shiptophone</varname></term>
4736 <para>Telefonnummer (Lieferadresse) <link
4737 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4742 <term><varname>shiptostreet</varname></term>
4745 <para>Straße und Hausnummer (Lieferadresse) <link
4746 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4751 <term><varname>shiptozipcode</varname></term>
4754 <para>Postleitzahl (Lieferadresse) <link
4755 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4760 <term><varname>street</varname></term>
4763 <para>Straße und Hausnummer</para>
4768 <term><varname>taxnumber</varname></term>
4771 <para>Steuernummer</para>
4776 <term><varname>ustid</varname></term>
4779 <para>Umsatzsteuer-Identifikationsnummer</para>
4784 <term><varname>vendoremail</varname></term>
4787 <para>Email des Lieferanten; nur für Lieferanten</para>
4792 <term><varname>vendorfax</varname></term>
4795 <para>Faxnummer des Lieferanten; nur für Lieferanten</para>
4800 <term><varname>vendornotes</varname></term>
4803 <para>Bemerkungen beim Lieferanten; nur für Lieferanten</para>
4808 <term><varname>vendornumber</varname></term>
4811 <para>Lieferantennummer; nur für Lieferanten</para>
4816 <term><varname>vendorphone</varname></term>
4819 <para>Telefonnummer des Lieferanten; nur für
4825 <term><varname>zipcode</varname></term>
4828 <para>Postleitzahl</para>
4833 <note id="dokumentenvorlagen-und-variablen.anmerkung-shipto">
4834 <para>Anmerkung: Sind die <varname>shipto*</varname>-Felder in den
4835 Stammdaten nicht eingetragen, so haben die Variablen
4836 <varname>shipto*</varname> den gleichen Wert wie die die
4837 entsprechenden Variablen der Lieferdaten. Das bedeutet, dass sich
4838 einige <varname>shipto*</varname>-Variablen so nicht in den
4839 Stammdaten wiederfinden sondern schlicht Kopien der
4840 Lieferdatenvariablen sind (z.B.
4841 <varname>shiptocontact</varname>).</para>
4845 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-bearbeiter">
4846 <title>Informationen über den Bearbeiter</title>
4850 <term><varname>employee_address</varname></term>
4853 <para>Adressfeld</para>
4858 <term><varname>employee_businessnumber</varname></term>
4861 <para>Firmennummer</para>
4866 <term><varname>employee_company</varname></term>
4869 <para>Firmenname</para>
4874 <term><varname>employee_co_ustid</varname></term>
4877 <para>Usatzsteuer-Identifikationsnummer</para>
4882 <term><varname>employee_duns</varname></term>
4885 <para>DUNS-Nummer</para>
4890 <term><varname>employee_email</varname></term>
4898 <term><varname>employee_fax</varname></term>
4906 <term><varname>employee_name</varname></term>
4909 <para>voller Name</para>
4914 <term><varname>employee_signature</varname></term>
4917 <para>Signatur</para>
4922 <term><varname>employee_taxnumber</varname></term>
4925 <para>Steuernummer</para>
4930 <term><varname>employee_tel</varname></term>
4933 <para>Telefonnummer</para>
4939 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-verkaeufer">
4940 <title>Informationen über den Verkäufer</title>
4944 <term><varname>salesman_address</varname></term>
4947 <para>Adressfeld</para>
4952 <term><varname>salesman_businessnumber</varname></term>
4955 <para>Firmennummer</para>
4960 <term><varname>salesman_company</varname></term>
4963 <para>Firmenname</para>
4968 <term><varname>salesman_co_ustid</varname></term>
4971 <para>Usatzsteuer-Identifikationsnummer</para>
4976 <term><varname>salesman_duns</varname></term>
4979 <para>DUNS-Nummer</para>
4984 <term><varname>salesman_email</varname></term>
4992 <term><varname>salesman_fax</varname></term>
5000 <term><varname>salesman_name</varname></term>
5003 <para>voller Name</para>
5008 <term><varname>salesman_signature</varname></term>
5011 <para>Signatur</para>
5016 <term><varname>salesman_taxnumber</varname></term>
5019 <para>Steuernummer</para>
5024 <term><varname>salesman_tel</varname></term>
5027 <para>Telefonnummer</para>
5033 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-steuern">
5034 <title>Variablen für die einzelnen Steuern</title>
5038 <term><varname>tax</varname></term>
5046 <term><varname>taxbase</varname></term>
5049 <para>zu versteuernder Betrag</para>
5054 <term><varname>taxdescription</varname></term>
5057 <para>Name der Steuer</para>
5062 <term><varname>taxrate</varname></term>
5065 <para>Steuersatz</para>
5071 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-lieferbedingungen">
5072 <title>Variablen für Lieferbedingungen</title>
5076 <term><varname>delivery_term</varname></term>
5079 <para>Datenbank-Objekt der Lieferbedingung</para>
5084 <term><varname>delivery_term.description</varname></term>
5087 <para>Beschreibung der Lieferbedingung</para>
5092 <term><varname>delivery_term.description_long</varname></term>
5095 <para>Langtext bzw. übersetzter Langtext der
5096 Lieferbedingung</para>
5102 <sect3 id="dokumentenvorlagen-und-variablen.abweichende-rechnungsadresse">
5103 <title>Informationen über abweichende Rechnungsadressen (nur Verkaufsbelege)</title>
5106 Abweichende Rechnungsadressen gibt es nur in Verkaufsbelegen. Die entsprechenden Variablen sind nur dann mit Inhalt gefüllt,
5107 wenn im Beleg eine abweichende Rechnungsadresse ausgewählt wurde. Ob eine Adresse überhaupt ausgewählt wurde, kann über die
5108 Variable <literal>billing_address_id</literal> getestet werden, die die Datenbank-ID der abweichenden Rechnungsadresse enthält,
5109 wenn eine ausgewählt ist.
5113 Die Variablennamen starten alle mit dem Präfix <literal>billing_address_</literal> und heißen anschließend so, wie ihre Pendants
5114 aus der Standard-Rechnungsadresse des Kunden. Beispiel: die Postleitzahl, die in der normalen Rechnungsadresse in
5115 <literal>zipcode</literal> steht, steht für die abweichende Rechnungsadresse in <literal>billing_address_zipcode</literal>.
5119 Die folgenden Variablen stehen so zur Verfügung: <literal>billing_address_name</literal>,
5120 <literal>billing_address_department_1</literal>, <literal>billing_address_department_2</literal>,
5121 <literal>billing_address_contact</literal>, <literal>billing_address_street</literal>,
5122 <literal>billing_address_zipcode</literal>, <literal>billing_address_city</literal>, <literal>billing_address_country</literal>,
5123 <literal>billing_address_gln</literal>, <literal>billing_address_email</literal>, <literal>billing_address_phone</literal> und
5124 <literal>billing_address_fax</literal>.
5129 <sect2 id="dokumentenvorlagen-und-variablen.invoice">
5130 <title>Variablen in Rechnungen</title>
5132 <sect3 id="dokumentenvorlagen-und-variablen.invoice-allgemein">
5133 <title>Allgemeine Variablen</title>
5137 <term><varname>creditremaining</varname></term>
5140 <para>Verbleibender Kredit</para>
5145 <term><varname>currency</varname></term>
5148 <para>Währung</para>
5153 <term><varname>cusordnumber</varname></term>
5156 <para>Bestellnummer beim Kunden</para>
5161 <term><varname>deliverydate</varname></term>
5164 <para>Lieferdatum</para>
5169 <term><varname>duedate</varname></term>
5172 <para>Fälligkeitsdatum</para>
5177 <term><varname>globalprojectnumber</varname></term>
5180 <para>Projektnummer des ganzen Beleges</para>
5185 <term><varname>globalprojectdescription</varname></term>
5188 <para>Projekbeschreibung des ganzen Beleges</para>
5193 <term><varname>intnotes</varname></term>
5196 <para>Interne Bemerkungen</para>
5201 <term><varname>invdate</varname></term>
5204 <para>Rechnungsdatum</para>
5209 <term><varname>invnumber</varname></term>
5212 <para>Rechnungsnummer</para>
5217 <term><varname>invtotal</varname></term>
5220 <para>gesamter Rechnungsbetrag</para>
5225 <term><varname>notes</varname></term>
5228 <para>Bemerkungen der Rechnung</para>
5233 <term><varname>orddate</varname></term>
5236 <para>Auftragsdatum</para>
5241 <term><varname>ordnumber</varname></term>
5244 <para>Auftragsnummer, wenn die Rechnung aus einem Auftrag
5245 erstellt wurde</para>
5250 <term><varname>payment_description</varname></term>
5253 <para>Name der Zahlart</para>
5258 <term><varname>payment_terms</varname></term>
5261 <para>Zahlungskonditionen</para>
5266 <term><varname>quodate</varname></term>
5269 <para>Angebotsdatum</para>
5274 <term><varname>quonumber</varname></term>
5277 <para>Angebotsnummer</para>
5282 <term><varname>rounding</varname></term>
5285 <para>Betrag, um den <varname>invtotal</varname> gerundet
5286 wurde (kann positiv oder negativ sein)</para>
5291 <term><varname>shippingpoint</varname></term>
5294 <para>Versandort</para>
5299 <term><varname>shipvia</varname></term>
5302 <para>Transportmittel</para>
5307 <term><varname>subtotal</varname></term>
5310 <para>Zwischensumme aller Posten ohne Steuern</para>
5315 <term><varname>total</varname></term>
5318 <para>Restsumme der Rechnung (Summe abzüglich bereits
5319 bezahlter Posten)</para>
5324 <term><varname>transaction_description</varname></term>
5327 <para>Vorgangsbezeichnung</para>
5332 <term><varname>transdate</varname></term>
5335 <para>Auftragsdatum wenn die Rechnung aus einem Auftrag
5336 erstellt wurde</para>
5342 <sect3 id="dokumentenvorlagen-und-variablen.invoice-posten">
5343 <title>Variablen für jeden Posten auf der Rechnung</title>
5347 <term><varname>bin</varname></term>
5350 <para>Stellage</para>
5355 <term><varname>description</varname></term>
5358 <para>Artikelbeschreibung</para>
5363 <term><varname>cusordnumber_oe</varname></term>
5366 <para>Bestellnummer des Kunden aus dem Auftrag, aus dem der
5367 Posten ursprünglich stammt (nur Verkauf)</para>
5372 <term><varname>discount</varname></term>
5375 <para>Rabatt als Betrag</para>
5380 <term><varname>discount_sub</varname></term>
5383 <para>Zwischensumme mit Rabatt</para>
5388 <term><varname>donumber_do</varname></term>
5391 <para>Lieferscheinnummer des Lieferscheins, aus dem die
5392 Position ursprünglich stammt, wenn die Rechnung im Rahmen des
5393 Workflows aus einem Lieferschein erstellt wurde.</para>
5398 <term><varname>drawing</varname></term>
5401 <para>Zeichnung</para>
5406 <term><varname>ean</varname></term>
5409 <para>EAN-Code</para>
5414 <term><varname>image</varname></term>
5422 <term><varname>linetotal</varname></term>
5425 <para>Zeilensumme (Anzahl * Einzelpreis)</para>
5430 <term><varname>longdescription</varname></term>
5433 <para>Langtext, vorbelegt mit dem Feld Bemerkungen der entsprechenden Ware</para>
5438 <term><varname>microfiche</varname></term>
5441 <para>Mikrofilm</para>
5446 <term><varname>netprice</varname></term>
5449 <para>Alternative zu <varname>sellprice</varname>, aber
5450 <varname>netprice</varname> entspricht dem effektiven
5451 Einzelpreis und beinhaltet Zeilenrabatt und Preisfaktor.
5452 <varname>netprice</varname> wird rückgerechnet aus Zeilensumme
5453 / Menge. Diese Variable ist nützlich, wenn man den gewährten
5454 Rabatt in der Druckvorlage nicht anzeigen möchte, aber Menge *
5455 Einzelpreis trotzdem die angezeigte Zeilensumme ergeben soll.
5456 <varname>netprice</varname> hat nichts mit Netto/Brutto im
5457 Sinne von Steuern zu tun.</para>
5462 <term><varname>nodiscount_linetotal</varname></term>
5465 <para>Zeilensumme ohne Rabatt</para>
5470 <term><varname>nodiscount_sub</varname></term>
5473 <para>Zwischensumme ohne Rabatt</para>
5478 <term><varname>number</varname></term>
5481 <para>Artikelnummer</para>
5486 <term><varname>ordnumber_oe</varname></term>
5489 <para>Auftragsnummer des Originalauftrags, aus dem der Posten
5490 ursprünglich stammt. Nützlich, wenn die Rechnung aus mehreren
5491 Lieferscheinen zusammengefasst wurde, oder wenn zwischendurch
5492 eine Sammelauftrag aus mehreren Aufträgen erstellt wurde. In
5493 letzterem Fall wird die unsprüngliche Auftragsnummer
5499 <term><varname>p_discount</varname></term>
5502 <para>Rabatt in Prozent</para>
5507 <term><varname>partnotes</varname></term>
5510 <para>Die beim Artikel gespeicherten Bemerkungen</para>
5515 <term><varname>partsgroup</varname></term>
5518 <para>Warengruppe</para>
5523 <term><varname>price_factor</varname></term>
5526 <para>Der Preisfaktor als Zahl, sofern einer eingestellt
5532 <term><varname>price_factor_name</varname></term>
5535 <para>Der Name des Preisfaktors, sofern einer eingestellt
5541 <term><varname>projectnumber</varname></term>
5544 <para>Projektnummer</para>
5549 <term><varname>projectdescription</varname></term>
5552 <para>Projektbeschreibung</para>
5557 <term><varname>qty</varname></term>
5565 <term><varname>reqdate</varname></term>
5568 <para>Lieferdatum</para>
5573 <term><varname>runningnumber</varname></term>
5576 <para>Position auf der Rechnung (1, 2, 3...)</para>
5581 <term><varname>sellprice</varname></term>
5584 <para>Verkaufspreis</para>
5589 <term><varname>serialnumber</varname></term>
5592 <para>Seriennummer</para>
5597 <term><varname>tax_rate</varname></term>
5600 <para>Steuersatz</para>
5605 <term><varname>transdate_do</varname></term>
5608 <para>Datum des Lieferscheins, wenn die Rechnung im Rahmen des
5609 Workflows aus einem Lieferschein stammte.</para>
5614 <term><varname>transdate_oe</varname></term>
5617 <para>Datum des Auftrags, wenn die Rechnung im Rahmen des
5618 Workflows aus einem Auftrag erstellt wurde. Wenn es
5619 Sammelaufträge gab wird das Datum des ursprünglichen Auftrags
5625 <term><varname>transdate_quo</varname></term>
5628 <para>Datum des Angebots, wenn die Position im Rahmen des
5629 Workflows aus einem Angebot stammte.</para>
5634 <term><varname>unit</varname></term>
5637 <para>Einheit</para>
5642 <term><varname>weight</varname></term>
5645 <para>Gewicht</para>
5650 <para>Für jeden Posten gibt es ein Unterarray mit den Informationen
5651 über Lieferanten und Lieferantenartikelnummer. Diese müssen mit
5652 einer <function>foreach</function>-Schleife ausgegeben werden, da
5653 für jeden Artikel mehrere Lieferanteninformationen hinterlegt sein
5654 können. Die Variablen dafür lauten:</para>
5658 <term><varname>make</varname></term>
5661 <para>Lieferant</para>
5666 <term><varname>model</varname></term>
5669 <para>Lieferantenartikelnummer</para>
5675 <sect3 id="dokumentenvorlagen-und-variablen.invoice-zahlungen">
5676 <title>Variablen für die einzelnen Zahlungseingänge</title>
5680 <term><varname>payment</varname></term>
5688 <term><varname>paymentaccount</varname></term>
5696 <term><varname>paymentdate</varname></term>
5704 <term><varname>paymentmemo</varname></term>
5712 <term><varname>paymentsource</varname></term>
5721 <sect3 id="dokumentenvorlagen-und-variablen.benutzerdefinierte-variablen-vc">
5722 <title>Benutzerdefinierte Kunden- und Lieferantenvariablen</title>
5724 <para>Die vom Benutzer definierten Variablen für Kunden und
5725 Lieferanten stehen beim Ausdruck von Einkaufs- und Verkaufsbelegen
5726 ebenfalls zur Verfügung. Ihre Namen setzen sich aus dem Präfix
5727 <varname>vc_cvar_</varname> und dem vom Benutzer festgelegten
5728 Variablennamen zusammen.</para>
5730 <para>Beispiel: Der Benutzer hat eine Variable namens
5731 <varname>number_of_employees</varname> definiert, die die Anzahl der
5732 Mitarbeiter des Unternehmens enthält. Diese Variable steht dann
5733 unter dem Namen <varname>vc_cvar_number_of_employees</varname> zur
5736 <para>Die benutzerdefinierten Variablen der Lieferadressen stehen
5737 unter einem ähnlichen Namensschema zur Verfügung. Hier lautet der
5738 Präfix <varname>shiptocvar_</varname>.</para>
5740 <para>Analog stehen die benutzerdefinierten Variablen für
5741 Ansprechpersonen mit dem Namenspräfix <varname>cp_cvar_</varname>
5742 zur Verfügung.</para>
5746 <sect2 id="dokumentenvorlagen-und-variablen.dunning">
5747 <title>Variablen in Mahnungen und Rechnungen über Mahngebühren</title>
5749 <sect3 id="dokumentenvorlagen-und-variablen.dunning-vorlagennamen">
5750 <title>Namen der Vorlagen</title>
5752 <para>Die Namen der Vorlagen werden im System-Menü vom Benutzer
5753 eingegeben. Wird für ein Mahnlevel die Option zur automatischen
5754 Erstellung einer Rechnung über die Mahngebühren und Zinsen
5755 aktiviert, so wird der Name der Vorlage für diese Rechnung aus dem
5756 Vorlagenname für diese Mahnstufe mit dem Zusatz
5757 <constant>_invoice</constant> gebildet. Weiterhin werden die Kürzel
5758 für die ausgewählte Sprache und den ausgewählten Drucker
5762 <sect3 id="dokumentenvorlagen-und-variablen.dunning-allgemein">
5763 <title>Allgemeine Variablen in Mahnungen</title>
5765 <para>Die Variablen des Bearbeiters, bzw. Verkäufers stehen wie
5766 gewohnt als <varname>employee_...</varname> bzw.
5767 <varname>salesman_...</varname> zur Verfügung. Werden mehrere
5768 Rechnungen in einer Mahnung zusammengefasst, so werden die Metadaten
5769 (Bearbeiter, Abteilung, etc) der ersten angemahnten Rechnung im
5770 Ausdruck genommen.</para>
5772 <para>Die Adressdaten des Kunden stehen als Variablen
5773 <varname>name</varname>, <varname>street</varname>,
5774 <varname>zipcode</varname>, <varname>city</varname>,
5775 <varname>country</varname>, <varname>department_1</varname>,
5776 <varname>department_2</varname>, und <varname>email</varname> zur
5777 Verfügung. Der Ansprechpartner <varname>cp_...</varname> steht auch
5778 zu Verfügung, wird allerdings auch nur von der ersten angemahnten
5779 Rechnung (s.o.) genommen.</para>
5781 <para>Weitere Variablen beinhalten:</para>
5785 <term><varname>dunning_date</varname></term>
5788 <para>Datum der Mahnung</para>
5793 <term><varname>dunning_duedate</varname></term>
5796 <para>Fälligkeitsdatum für diese Mahhnung</para>
5801 <term><varname>dunning_id</varname></term>
5804 <para>Mahnungsnummer</para>
5809 <term><varname>fee</varname></term>
5812 <para>Kumulative Mahngebühren</para>
5817 <term><varname>interest_rate</varname></term>
5820 <para>Zinssatz per anno in Prozent</para>
5825 <term><varname>total_amount</varname></term>
5828 <para>Gesamter noch zu zahlender Betrag als
5829 <function>fee</function> + <function>total_interest</function>
5830 + <function>total_open_amount</function></para>
5835 <term><varname>total_interest</varname></term>
5838 <para>Zinsen per anno über alle Rechnungen</para>
5843 <term><varname>total_open_amount</varname></term>
5846 <para>Summe über alle offene Beträge der Rechnungen</para>
5852 <sect3 id="dokumentenvorlagen-und-variablen.dunning-details">
5853 <title>Variablen für jede gemahnte Rechnung in einer Mahnung</title>
5857 <term><varname>dn_amount</varname></term>
5860 <para>Rechnungssumme (brutto)</para>
5865 <term><varname>dn_duedate</varname></term>
5868 <para>Originales Fälligkeitsdatum der Rechnung</para>
5873 <term><varname>dn_dunning_date</varname></term>
5876 <para>Datum der Mahnung</para>
5881 <term><varname>dn_dunning_duedate</varname></term>
5884 <para>Fälligkeitsdatum der Mahnung</para>
5889 <term><varname>dn_fee</varname></term>
5892 <para>Kummulative Mahngebühr</para>
5897 <term><varname>dn_interest</varname></term>
5900 <para>Zinsen per anno für diese Rechnung</para>
5905 <term><varname>dn_invnumber</varname></term>
5908 <para>Rechnungsnummer</para>
5913 <term><varname>dn_linetotal</varname></term>
5916 <para>Noch zu zahlender Betrag (ergibt sich aus
5917 <varname>dn_open_amount</varname> + <varname>dn_fee</varname>
5918 + <varname>dn_interest</varname>)</para>
5923 <term><varname>dn_netamount</varname></term>
5926 <para>Rechnungssumme (netto)</para>
5931 <term><varname>dn_open_amount</varname></term>
5934 <para>Offener Rechnungsbetrag</para>
5939 <term><varname>dn_ordnumber</varname></term>
5942 <para>Bestellnummer</para>
5947 <term><varname>dn_transdate</varname></term>
5950 <para>Rechnungsdatum</para>
5955 <term><varname>dn_curr</varname></term>
5958 <para>Währung, in der die Rechnung erstellt wurde. (Die
5959 Rechnungsbeträge sind aber immer in der Hauptwährung)</para>
5965 <sect3 id="dokumentenvorlagen-und-variablen.dunning-invoice">
5966 <title>Variablen in automatisch erzeugten Rechnungen über
5967 Mahngebühren</title>
5969 <para>Die Variablen des Verkäufers stehen wie gewohnt als
5970 <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
5971 Kunden stehen als Variablen <varname>name</varname>,
5972 <varname>street</varname>, <varname>zipcode</varname>,
5973 <varname>city</varname>, <varname>country</varname>,
5974 <varname>department_1</varname>, <varname>department_2</varname>,
5975 und <varname>email</varname> zur Verfügung.</para>
5977 <para>Weitere Variablen beinhalten:</para>
5981 <term><varname>duedate</varname></term>
5984 <para>Fälligkeitsdatum der Rechnung</para>
5989 <term><varname>dunning_id</varname></term>
5992 <para>Mahnungsnummer</para>
5997 <term><varname>fee</varname></term>
6000 <para>Mahngebühren</para>
6005 <term><varname>interest</varname></term>
6013 <term><varname>invamount</varname></term>
6016 <para>Rechnungssumme (ergibt sich aus <varname>fee</varname> +
6017 <varname>interest</varname>)</para>
6022 <term><varname>invdate</varname></term>
6025 <para>Rechnungsdatum</para>
6030 <term><varname>invnumber</varname></term>
6033 <para>Rechnungsnummer</para>
6040 <sect2 id="dokumentenvorlagen-und-variablen.andere-vorlagen">
6041 <title>Variablen in anderen Vorlagen</title>
6044 <title>Einführung</title>
6046 <para>Die Variablen in anderen Vorlagen sind ähnlich wie in der
6047 Rechnung. Allerdings heißen die Variablen, die mit
6048 <varname>inv</varname> beginnen, jetzt anders. Bei den Angeboten
6049 fangen sie mit <varname>quo</varname> für "quotation" an:
6050 <varname>quodate</varname> für Angebotsdatum etc. Bei Bestellungen
6051 wiederum fangen sie mit <varname>ord</varname> für "order" an:
6052 <varname>ordnumber</varname> für Bestellnummer etc.</para>
6054 <para>Manche Variablen sind in anderen Vorlagen hingegen gar nicht
6055 vorhanden wie z.B. die für bereits verbuchte Zahlungseingänge. Dies
6056 sind Variablen, die vom Geschäftsablauf her in der entsprechenden
6057 Vorlage keine Bedeutung haben oder noch nicht belegt sein
6060 <para>Im Folgenden werden nur wichtige Unterschiede zu den Variablen
6061 in Rechnungen aufgeführt.</para>
6064 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-quotations">
6065 <title>Angebote und Preisanfragen</title>
6069 <term><varname>quonumber</varname></term>
6072 <para>Angebots- bzw. Anfragenummer</para>
6077 <term><varname>reqdate</varname></term>
6080 <para>Gültigkeitsdatum (bei Angeboten) bzw. Lieferdatum (bei
6081 Preisanfragen)</para>
6086 <term><varname>transdate</varname></term>
6089 <para>Angebots- bzw. Anfragedatum</para>
6095 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-orders">
6096 <title>Auftragsbestätigungen und Lieferantenaufträge</title>
6100 <term><varname>ordnumber</varname></term>
6103 <para>Auftragsnummer</para>
6108 <term><varname>reqdate</varname></term>
6111 <para>Lieferdatum</para>
6116 <term><varname>transdate</varname></term>
6119 <para>Auftragsdatum</para>
6125 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-delivery-orders">
6126 <title>Lieferscheine (Verkauf und Einkauf)</title>
6130 <term><varname>cusordnumber</varname></term>
6133 <para>Bestellnummer des Kunden (im Verkauf) bzw. Bestellnummer
6134 des Lieferanten (im Einkauf)</para>
6139 <term><varname>donumber</varname></term>
6142 <para>Lieferscheinnummer</para>
6147 <term><varname>transdate</varname></term>
6150 <para>Lieferscheindatum</para>
6155 <para>Für jede Position eines Lieferscheines gibt es ein Unterarray
6156 mit den Informationen darüber, von welchem Lager und Lagerplatz aus
6157 die Waren verschickt wurden (Verkaufslieferscheine) bzw. auf welchen
6158 Lagerplatz sie eingelagert wurden. Diese müssen mittels einer
6159 <function>foreach</function>-Schleife ausgegeben werden. Diese
6160 Variablen sind:</para>
6164 <term><varname>si_bin</varname></term>
6167 <para>Lagerplatz</para>
6172 <term><varname>si_chargenumber</varname></term>
6175 <para>Chargennummer</para>
6180 <term><varname>si_bestbefore</varname></term>
6183 <para>Mindesthaltbarkeit</para>
6188 <term><varname>si_number</varname></term>
6191 <para>Artikelnummer</para>
6196 <term><varname>si_qty</varname></term>
6199 <para>Anzahl bzw. Menge</para>
6204 <term><varname>si_runningnumber</varname></term>
6207 <para>Positionsnummer (1, 2, 3 etc)</para>
6212 <term><varname>si_unit</varname></term>
6215 <para>Einheit</para>
6220 <term><varname>si_warehouse</varname></term>
6229 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-statement">
6230 <title>Variablen für Sammelrechnung</title>
6234 <term><varname>c0total</varname></term>
6237 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit < 30
6243 <term><varname>c30total</varname></term>
6246 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 30
6247 und < 60 Tage</para>
6252 <term><varname>c60total</varname></term>
6255 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 60
6256 und < 90 Tage</para>
6261 <term><varname>c90total</varname></term>
6264 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 90
6270 <term><varname>total</varname></term>
6273 <para>Gesamtbetrag aller Rechnungen</para>
6278 <para>Variablen für jede Rechnungsposition in Sammelrechnung:</para>
6282 <term><varname>invnumber</varname></term>
6285 <para>Rechnungsnummer</para>
6290 <term><varname>invdate</varname></term>
6293 <para>Rechnungsdatum</para>
6298 <term><varname>duedate</varname></term>
6301 <para>Fälligkeitsdatum</para>
6306 <term><varname>amount</varname></term>
6309 <para>Summe der Rechnung</para>
6314 <term><varname>open</varname></term>
6317 <para>Noch offener Betrag der Rechnung</para>
6322 <term><varname>c0</varname></term>
6325 <para>Noch offener Rechnungsbetrag mit Fälligkeit < 30
6331 <term><varname>c30</varname></term>
6334 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 30 und
6340 <term><varname>c60</varname></term>
6343 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 60 und
6349 <term><varname>c90</varname></term>
6352 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 90
6360 <sect2 id="dokumentenvorlagen-und-variablen.bloecke">
6361 <title>Blöcke, bedingte Anweisungen und Schleifen</title>
6363 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.einfuehrung">
6364 <title>Einführung</title>
6366 <para>Der Parser kennt neben den Variablen einige weitere
6367 Konstrukte, die gesondert behandelt werden. Diese sind wie
6368 Variablennamen in spezieller Weise markiert:
6369 <command><%anweisung%> ... <%end%></command></para>
6371 <para>Anmerkung zum <command><%end%></command>: Der besseren
6372 Verständlichkeit halber kann man nach dem <command>end</command>
6373 noch beliebig weitere Wörter schreiben, um so zu markieren, welche
6374 Anweisung (z.B. <command>if</command> oder
6375 <command>foreach</command>) damit abgeschlossen wird.</para>
6377 <para>Beispiel: Lautet der Beginn eines Blockes z.B.
6378 <command><%if type == "sales_quotation"%></command>, so könnte
6379 er mit <command><%end%></command> genauso abgeschlossen werden
6380 wie mit <command><%end if%></command> oder auch
6381 <command><%end type == "sales_quotation"%></command>.</para>
6384 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.if">
6385 <title>Der if-Block</title>
6387 <programlisting><%if variablenname%>
6389 <%end%></programlisting>
6391 <para>Eine normale "if-then"-Bedingung. Die Zeilen zwischen dem "if"
6392 und dem "end" werden nur ausgegeben, wenn die Variable
6393 <varname>variablenname</varname> gesetzt und ungleich 0 ist.</para>
6395 <para>Handelt es sich bei der benannten Variable um ein Array, also
6396 um einen Variablennamen, über den man mit <command><%foreach
6397 variablenname%></command> iteriert, so wird mit diesem Konstrukt
6398 darauf getestet, ob das Array Elemente enthält. Somit würde im
6399 folgenden Beispiel nur dann eine Liste von Zahlungseingängen samt
6400 ihrer Überschrift "Zahlungseingänge" ausgegeben, wenn tatsächlich
6401 welche getätigt wurden:</para>
6403 <programlisting><%if payment%>
6405 <%foreach payment%>
6406 Am <%paymentdate%>: <%payment%> €
6407 <%end foreach%>
6408 <%end if%></programlisting>
6410 <para>Die Bedingung kann auch negiert werden, indem das Wort
6411 <function>not</function> nach dem <filename>if</filename> verwendet
6412 wird. Beispiel:</para>
6414 <programlisting><%if not cp_greeting%>
6416 <%end%></programlisting>
6418 <para>Zusätzlich zu dem einfachen Test, ob eine Variable gesetzt ist
6419 oder nicht, bietet dieser Block auch die Möglichkeit, den Inhalt
6420 einer Variablen mit einer festen Zeichenkette oder einer anderen
6421 Variablen zu vergleichen. Ob der Vergleich mit einer Zeichenkette
6422 oder einer anderen Variablen vorgenommen wird, hängt davon ab, ob
6423 die rechte Seite des Vergleichsoperators in Anführungszeichen
6424 gesetzt wird (Vergleich mit Zeichenkette) oder nicht (Vergleich mit
6425 anderer Variablen). Zwei Beispiele, die beide Vergleiche
6428 <programlisting><%if var1 == "Wert"%></programlisting>
6430 <para>Testet die Variable <varname>var1</varname> auf
6431 übereinstimmung mit der Zeichenkette <constant>Wert</constant>.
6432 Mittels <function>!=</function> anstelle von <function>==</function>
6433 würde auf Ungleichheit getestet.</para>
6435 <programlisting><%if var1 == var2%></programlisting>
6437 <para>Testet die Variable <varname>var1</varname> auf
6438 übereinstimmung mit der Variablen <varname>var2</varname>. Mittel
6439 <function>!=</function> anstelle von <function>==</function> würde
6440 auf Ungleichheit getestet.</para>
6442 <para>Erfahrere Benutzer können neben der Tests auf (Un-)Gleichheit
6443 auch Tests auf Übereinstimmung mit regulären Ausdrücken ohne
6444 Berücksichtung der Groß- und Kleinschreibung durchführen. Dazu dient
6445 dieselbe Syntax wie oben nur mit <function>=~</function> und
6446 <function>!~</function> als Vergleichsoperatoren.</para>
6448 <para>Beispiel für einen Test, ob die Variable
6449 <varname>intnotes</varname> (interne Bemerkungen) das Wort
6450 <constant>schwierig</constant> enthält:</para>
6452 <programlisting><%if intnotes =~ "schwierig"%></programlisting>
6455 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.foreach">
6456 <title>Der foreach-Block</title>
6458 <programlisting><%foreach variablenname%>
6460 <%end%></programlisting>
6462 <para>Fügt die Zeilen zwischen den beiden Anweisungen so oft ein,
6463 wie das Perl-Array der Variablen <varname>variablenname</varname>
6464 Elemente enthät. Dieses Konstrukt wird zur Ausgabe der einzelnen
6465 Posten einer Rechnung / eines Angebots sowie zur Ausgabe der Steuern
6466 benutzt. In jedem Durchlauf werden die <link
6467 linkend="dokumentenvorlagen-und-variablen.invoice-posten">zeilenbezogenen
6468 Variablen</link> jeweils auf den Wert für die aktuelle Position
6471 <para>Die Syntax sieht normalerweise wie folgt aus:</para>
6473 <programlisting><%foreach number%>
6474 Position: <%runningnumber%>
6475 Anzahl: <%qty%>
6476 Artikelnummer: <%number%>
6477 Beschreibung: <%description%>
6479 <%end%></programlisting>
6481 <para>Besonderheit in OpenDocument-Vorlagen: Tritt ein
6482 <function><%foreach%></function>-Block innerhalb einer
6483 Tabellenzelle auf, so wird die komplette Tabellenzeile so oft
6484 wiederholt wie notwendig. Tritt er außerhalb auf, so wird nur der
6485 Inhalt zwischen <function><%foreach%></function> und
6486 <function><%end%></function> wiederholt, nicht aber die
6487 komplette Zeile, in der er steht.</para>
6491 <sect2 id="dokumentenvorlagen-und-variablen.markup">
6492 <title>Markup-Code zur Textformatierung innerhalb von
6495 <para>Wenn der Benutzer innhalb von Formularen in kivitendo Text
6496 anders formatiert haben möchte, so ist dies begrenzt möglich.
6497 kivitendo unterstützt die Textformatierung mit HTML-ähnlichen Tags.
6498 Der Benutzer kann z.B. bei der Artikelbeschreibung auf einer Rechnung
6499 Teile des Texts zwischen Start- und Endtags setzen. Dieser Teil wird
6500 dann automatisch in Anweisungen für das ausgewählte Vorlagenformat
6501 (HTML oder PDF über LaTeX) umgesetzt.</para>
6503 <para>Die unterstützen Formatierungen sind:</para>
6507 <term><b>Text</b></term>
6510 <para>Text wird in Fettdruck gesetzt.</para>
6515 <term><i>Text</i></term>
6518 <para>Text wird kursiv gesetzt.</para>
6523 <term><u>Text</u></term>
6526 <para>Text wird unterstrichen.</para>
6531 <term><s>Text</s></term>
6534 <para>Text wird durchgestrichen. Diese Formatierung ist nicht
6535 bei der Ausgabe als PDF über LaTeX verfügbar.</para>
6540 <term><bullet></term>
6543 <para>Erzeugt einen ausgefüllten Kreis für Aufzählungen (siehe
6549 <para>Der Befehl <command><bullet></command> funktioniert
6550 momentan auch nur in Latex-Vorlagen.</para>
6553 <sect2 id="dokumentenvorlagen-und-variablen.anrede"
6554 xreflabel="Hinweise zur Anrede">
6555 <title>Hinweise zur Anrede</title>
6557 <para>Das Flag "natürliche Person"
6558 (<varname>natural_person</varname>) aus den Kunden- oder
6559 Lieferantenstammdaten kann in den Druckvorlagen zusammen mit
6560 dem Feld "Anrede" (<varname>greeting</varname>) z.B. dafür
6561 verwendet werden, die Anrede zwischen einer allgemeinen und
6562 einer persönlichen Anrede zu unterscheiden.
6563 <programlisting><%if natural_person%><%greeting%> <%name%><%else%>Sehr geehrte Damen und Herren<%end if%></programlisting>
6569 <sect1 id="excel-templates">
6570 <title>Excel-Vorlagen</title>
6572 <sect2 id="excel-templates.summary">
6573 <title>Zusammenfassung</title>
6575 <para>Dieses Dokument beschreibt den Mechanismus, mit dem
6576 Exceltemplates abgearbeitet werden, und die Einschränkungen, die damit
6580 <sect2 id="excel-templates.usage">
6581 <title>Bedienung</title>
6583 <para>Der Excel Mechanismus muss in der Konfigurationsdatei aktiviert
6584 werden. Die Konfigurationsoption heißt <varname>excel_templates =
6585 1</varname> im Abschnitt <varname>[print_templates]</varname>.</para>
6587 <para>Eine Excelvorlage kann dann unter dem Namen einer beliebigen
6588 anderen Vorlage mit der Endung <filename>.xls</filename> gespeichert
6589 werden. In den normalen Verkaufsmasken taucht nun
6590 <constant>Excel</constant> als auswählbares Format auf und kann von da
6591 an wie LaTeX- oder OpenOffice-Vorlagen benutzt werden.</para>
6593 <para>Der Sonderfall der Angebote aus der Kundenmaske ist ebenfalls
6594 eine Angebotsvorlage und wird unter dem internen Namen der Angebote
6595 <filename>sales_quotation.xls</filename> gespeichert.</para>
6598 <sect2 id="excel-templates.syntax">
6599 <title>Variablensyntax</title>
6601 <para>Einfache Syntax:
6602 <command><<varname>></command></para>
6604 <para>Dabei sind <constant><<</constant> und
6605 <constant>>></constant> die Delimiter. Da Excel auf festen
6606 Breiten besteht, kann der Tag künstlich verlängert werden, indem
6607 weitere <constant><</constant> oder <constant>></constant>
6608 eingefügt werden. Der Tag muss nicht symmetrisch sein.
6611 <programlisting><<<<<varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
6613 <para>Um die Limitierung der festen Breite zu reduzieren, können
6614 weitere Variablen in einem Block interpoliert werden. Whitespace wird
6615 dazwishen dann erhalten. Beispiel:</para>
6617 <programlisting><<<<<varname1 varname2 varname3>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
6619 <para>Die Variablen werden interpoliert, und linksbündig mit
6620 Leerzeichen auf die gewünschte Länge aufgefüllt. Ist der String zu
6621 lang, werden überzählige Zeichen abgeschnitten.</para>
6623 <para>Es ist ausserdem möglich, Daten rechtsbündig darzustellen, wenn
6624 der Block mit einem Leerzeichen anfängt. Beispiel:</para>
6626 <programlisting><<<<<< varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
6628 <para>Dies würde rechtsbündig triggern. Wenn bei rechtsbündiger
6629 Ausrichtung Text abgeschnitten werden muss, wird er vom linken Ende
6633 <sect2 id="excel-templates.limitations">
6634 <title>Einschränkungen</title>
6636 <para>Das Excelformat bis 2002 ist ein binäres Format, und kann nicht
6637 mit vertretbarem Aufwand editiert werden. Der Templatemechanismus
6638 beschränkt sich daher darauf, Textstellen exakt durch einen anderen
6639 Text zu ersetzen.</para>
6641 <para>Aus dem gleichen Grund sind die Kontrolllstrukturen
6642 <command><%if%></command> und
6643 <command><%foreach%></command> nicht vorhanden. Der Delimiter
6644 <constant><% %></constant> kommt in den Headerinformationen
6645 evtl. vor. Deshalb wurde auf den sichereren Delimiter
6646 <constant><<</constant> und <constant>>></constant>
6651 <sect1 id="features.warehouse">
6652 <title>Mandantenkonfiguration Lager</title>
6654 <para>Die Lagerverwaltung in kivitendo funktioniert standardmässig wie
6655 folgt: Wird ein Lager mit einem Lagerplatz angelegt, so gibt es die
6656 Möglichkeit hier über den Menüpunkt Lager entsprechende Warenbewegungen
6657 durchzuführen. Ferner kann jede Position eines Lieferscheins ein-, bzw.
6658 ausgelagert werden (Einkauf-, bzw. Verkauf). Es können beliebig viele
6659 Lager mit beliebig vielen Lagerplätzen abgebildet werden. Die
6660 Lagerbewegungen über einen Lieferschein erfolgt durch Anklicken jeder
6661 Einzelposition und das Auswählen dieser Position zu einem Lager mit
6662 Lagerplatz. Dieses Verfahren lässt sich schrittweise vereinfachen, je
6663 nachdem wie die Einstellungen in der Mandatenkonfiguration gesetzt
6668 <para><option>Auslagern über Standardlagerplatz</option> Hier wird
6669 ein zusätzlicher Knopf (Auslagern über Standard-Lagerplatz) in dem
6670 Lieferschein-Beleg hinzugefügt, der dann alle Lagerbewegungen über
6671 den Standardlagerplatz (konfigurierbar pro Ware) durchführt.</para>
6675 <para><option>Auslagern ohne Bestandsprüfung</option> Das obige
6676 Auslagern schlägt fehl, wenn die entsprechende Menge für die
6677 Lagerbewegung nicht vorhanden ist, möchte man dies auch ignorieren
6678 und ggf. dann nachpflegen, so kann man eine Negativ-Warenmenge mit
6679 dieser Option erlauben. Hierfür muss ein entsprechender Lagerplatz
6680 (Fehlbestand, o.ä.) konfiguriert sein.</para>
6684 <para>Zusätzliche Funktionshinweise:</para>
6688 <para><option>Standard-Lagerplatz</option> Ist dieser konfiguriert,
6689 wird dies auch als Standard-Voreinstellung bei der Neuerfassung von
6690 Stammdaten → Waren / Dienstleistung / Erzeugnis verwendet.</para>
6694 <para><option>Standard-Lagerplatz verwenden, falls keiner in
6695 Stammdaten definiert</option> Wird beim 'Auslagern über
6696 Standardlagerplatz' keine Standardlagerplatz zu der Ware gefunden,
6697 so wird mit dieser Option einfach der Standardlagerplatz
6703 <sect1 id="features.swiss-charts-of-accounts">
6704 <title>Schweizer Kontenpläne</title>
6706 <para>Seit der Version 3.5 stehen in kivitendo 3 Kontenpläne für den
6707 Einsatz in der Schweiz zur Verfügung, einer für Firmen und
6708 Organisationen, die nicht mehrwertsteuerpflichtig sind, einer für
6709 Firmen, die mehrwertsteuerpflichtig sind und einer speziell für
6712 <para>Die Kontenpläne orientieren sich am in der Schweiz üblicherweise
6713 verwendeten KMU-Kontenrahmen und sind mit der Revision des
6714 Schweizerischen Obligationenrechts (OR) vom 1.1.2013 kompatibel,
6715 insbesondere <literal>Art.957a Abs.2</literal>.</para>
6717 <para>Beim Vereinskontenplan sind standardmässig nur die Konten 1100
6718 (Debitoren CHF) und 1101 (Debitoren EUR) als Buchungskonten im Verkauf
6719 sowie die Konten 2000 (Kreditoren CHF) und 2001 (Kreditoren EUR) als
6720 Buchungskonten im Einkauf vorgesehen. Weitere Konten können bei Bedarf
6721 in den Konto-Detaileinstellungen als Einkaufs- oder Verkaufskonten
6722 konfiguriert werden.</para>
6724 <para>Die Möglichkeit, Saldosteuersätze zu verwenden ist in der
6725 aktuellen Version von kivitendo noch nicht integriert.</para>
6727 <para>Trotzdem können auch Firmen, die per Saldosteuersatz mit der
6728 Eidgenössischen Steuerverwaltung abrechnen, kivitendo bereits nutzen.
6729 Dazu wird der Kontenplan mit MWST ausgewählt. Anschliessend müssen alle
6730 Aufwandskonten editiert werden und dort der Steuersatz auf 0% gesetzt
6733 <para>So werden bei Kreditorenbuchungen keine Vorsteuern
6736 <para>Bezugssteuern für aus dem Ausland bezogene Dienstleistungen müssen
6737 manuell verbucht werden.</para>
6739 <para>Wünsche für Anpassungen an den Schweizer Kontenplänen sowie
6740 Vorschläge für weitere (z.B. branchenspezifische) Kontenpläne bitte an
6741 <literal>empfang@revamp-it.ch</literal> senden.</para>
6744 <sect1 id="features.part_classification">
6745 <title>Artikelklassifizierung</title>
6748 <title>Übersicht</title>
6750 <para>Die Klassifizierung von Artikeln dient einer weiteren
6751 Gliederung, um zum Beispiel den Einkauf vom Verkauf zu trennen,
6752 gekennzeichnet durch eine Beschreibung (z.B. "Einkauf") und ein Kürzel
6753 (z.B. "E"). Für jede Klassifizierung besteht eine Beschreibung und
6754 eine Abkürzung die normalerweise aus einem Zeichen besteht, kann aber
6755 auf mehrere Zeichen erweitert werden, falls zur Unterscheidung
6756 notwendig. Sinnvoll sind jedoch nur maximal 2 Zeichen.</para>
6760 <title>Basisklassifizierung</title>
6762 <para>Als Basisklassifizierungen gibt es</para>
6766 <para>Einkauf</para>
6770 <para>Verkauf</para>
6774 <para>Handelsware</para>
6778 <para>Produktion</para>
6782 <para>- keine - (diese wird bei einer Aktualisierung für alle
6783 existierenden Artikel verwendet und ist gültig für Verkauf und
6788 <para>Es können weitere Klassifizierungen angelegt werden. So kann es
6789 z.B. für separat auszuweisende Artikel folgende Klassen geben:</para>
6793 <para>Lieferung (Logistik, Transport) mit Kürzel L</para>
6797 <para>Material (Verpackungsmaterial) mit Kürzel M</para>
6803 <title>Attribute</title>
6805 <para>Bisher haben die Klassifizierungen folgende Attribute, die auch
6806 alle gleichzeitg gültig sein können</para>
6810 <para>gültig für Verkauf - dieser Artikel kann im Verkauf genutzt
6815 <para>gültig für Einkauf - dieser Artikel kann im Einkauf genutzt
6820 <para>separat ausweisen - hierzu gibt es zur Dokumentengenerierung
6821 (LaTeX) eine zusätzliche Variable</para>
6825 <para>Für das Attribut "separat ausweisen" stehen in den
6826 LaTeX-Vorlagen die Variable <emphasis
6827 role="bold"><%non_separate_subtotal%> </emphasis>zur Verfügung,
6828 die alle nicht separat auszuweisenden Artikelkosten saldiert, sowie
6829 pro separat auszuweisenden Klassifizierungen die Variable<emphasis
6830 role="bold">< %separate_X_subtotal%></emphasis>, wobei X das
6831 Kürzel der Klassifizierung ist.</para>
6833 <para>Im obigen Beispiel wäre das für Lieferkosten <emphasis
6834 role="bold"><%separate_L_subtotal%></emphasis> und für
6835 Verpackungsmaterial <emphasis role="bold">
6836 <%separate_M_subtotal%></emphasis>.</para>
6840 <title>Zwei-Zeichen Abkürzung</title>
6842 <para>Der Typ des Artikels und die Klassifizierung werden durch zwei
6843 Buchstaben dargestellt. Der erste Buchstabe ist eine Lokalisierung des
6844 Artikel-Typs ('P','A','S'), deutsch 'W', 'E', und 'D' für Ware
6845 Erzeugnis oder Dienstleistung und ggf. weiterer Typen.</para>
6847 <para>Der zweite Buchstabe (und ggf. auch ein dritter, falls nötig)
6848 entspricht der lokalisierten Abkürzung der Klassifizierung.</para>
6850 <para>Diese Abkürzung wird überall beim Auflisten von Artikeln zur
6851 Erleichterung mit dargestellt.</para>
6855 <sect1 id="features.file_managment">
6856 <title>Dateiverwaltung (Mini-DMS)</title>
6859 <title>Übersicht</title>
6861 <para>Parallel zum alten WebDAV gibt es ein Datei-Management-System,
6862 das Dateien verschiedenen Typs verwaltet. Dies können</para>
6866 <para>aus ERP-Daten per LaTeX Template erzeugte
6867 PDF-Dokumente,</para>
6871 <para>zu bestimmten ERP-Daten gehörende Anhangdateien
6872 unterschiedlichen Formats,</para>
6876 <para>per Scanner eingelesene PDF-Dateien,</para>
6880 <para>per E-Mail empfangene Dateianhänge unterschiedlichen
6885 <para>sowie speziel für Artikel hochgeladene Bilder sein.</para>
6890 <screeninfo>Übersicht</screeninfo>
6894 <imagedata contentwidth="600" fileref="images/DMS-Overview.png"/>
6901 <title>Struktur</title>
6903 <para>Über eine vom Speichermedium unabhängige Zwischenschicht werden
6904 die Dateien und ihre Versionen in der Datenbank verwaltet. Darunter
6905 können verschiedene Implementierungen (Backends) gleichzeitig
6910 <para>Dateisystem</para>
6918 <para>Schnittstelle zu externen
6919 Dokumenten-Management-Systemen</para>
6923 <para>andere Datenbank</para>
6927 <para>etc ...</para>
6931 <para>Es gibt unterschiedliche Typen von Dateien. Jedem Typ läßt sich
6932 in der Mandantenkonfiguration ein bestimmtes Backend zuordnen.</para>
6936 <para>"document": Das sind entweder generierte, eingescannte oder
6937 hochgeladene PDF-Dateien, die zu bestimmten ERP-Daten
6938 (ERP-Objekte, wie z.B. Rechnung, Lieferschein) gehören.</para>
6942 <para>"attachment": zusätzlich hochgeladene Dokumente, die an
6943 bestimmte ERP-Objekte angehängt werden, z.B. technische
6944 Zeichnungen, Aufmaße. Diese können auch für Artikel, Lieferanten
6945 und Kunden hinterlegt sein.</para>
6949 <para>"image": Bilder für Artikel. Diese können auch verkleinert
6950 in einer Vorschau (Thumbnail) angezeigt werden.</para>
6954 <para>Zusätzlich werden in der Datenbank zu den Dateien neben der
6955 Zuordnung zu ERP-Objekten, Dateityp Dateinamen und Backend, in dem die
6956 Datei gespeichert ist, auch die Quelle der Datei notiert:</para>
6960 <para>"created": vom System erzeugte Dokumente"</para>
6964 <para>"uploaded": hochgeladene Dokumente</para>
6968 <para>"email": vom Mail-System empfangene Dateien</para>
6972 <para>"scanner[1]": von einem oder mehreren Scannern erzeugte
6973 Dateien. Existieren mehrere Scanner, so sind diese durch
6974 unterschiedliche Quellennamen zu definieren.</para>
6978 <para>Je nach Dateityp sind nur bestimmte Quellen zulässig. So gibt es
6979 für "attachment" und "image" nur die Quelle "uploaded". Für "document"
6980 gibt es auf jeden Fall die Quelle "created". Die Quellen "scanner" und
6981 "email" müssen derzeit in der Datenbank konfiguriert werden (siehe
6982 <xref linkend="file_management.dbconfig"/>).</para>
6986 <title>Anwendung</title>
6988 <para>Die Daten werden bei den ERP-Objekten als extra Reiter
6989 dargestellt. Eine Verkaufsrechnung z.B. hat die Reiter "Dokumente" und
6990 "Dateianhänge".</para>
6993 <screeninfo>Reiter "Dateianhänge"</screeninfo>
6997 <imagedata fileref="images/DMS-Anhaenge.png" scale="50"/>
7002 <para>Bei den Dateianhängen wird immer nur die aktuelle Version einer
7003 Datei angezeigt. Wird eine Datei mit gleichem Namen hochgeladen, so
7004 wird eine neue Version der Datei erstellt. Vorher wird der Anwender
7005 durch einen Dialog gefragt, ob er eine neue Version anlegen will oder
7006 ob er die Datei umbenennen will, falls es eine neue Datei sein
7010 <screeninfo>Reiter "Dateianhänge"</screeninfo>
7014 <imagedata contentwidth="40"
7015 fileref="images/DMS-Anhaenge-hochladen.png"
7021 <para>Es können mehrere Dateien gleichzeitig hochgeladen werden,
7022 solange in Summe die maximale Größe nicht überschritten wird (siehe
7023 <xref linkend="file_management.clientconfig"/>).</para>
7026 <screeninfo>Reiter "Dokumente"</screeninfo>
7030 <imagedata fileref="images/DMS-Dokumente.png" width="500"/>
7035 <para>Sind keine weiteren Quellen für Dokumente konfiguriert, so gibt
7036 es nur "erzeugte Dokumente". Es werden alle Versionen der generierten
7037 Datei angezeigt. Für Verkaufsrechnungen kommen keine anderen Quellen
7038 zur Geltung. Werden entsprechend der <xref
7039 linkend="file_management.dbconfig"/> zusätzliche Quellen konfiguriert,
7040 so sind diese z.B. bei Einkaufsrechnungen sichtbar:</para>
7043 <screeninfo>Reiter "Dokumente"</screeninfo>
7047 <imagedata contentwidth="600"
7048 fileref="images/DMS-Dokumente-Scanner.png"/>
7053 <para>Statt des Löschens wird hier die Datei zurück zur Quelle
7054 verschoben. Somit kann die Datei anschließend an ein anderes
7055 ERP-Objekt angehängt werden.</para>
7057 <para>Derzeit sind "Titel" und "Beschreibung" noch nicht genutzt. Sie
7058 sind bisher nur bei Bildern relevant.</para>
7062 <title>Konfigurierung</title>
7064 <sect3 id="file_management.clientconfig"
7065 xreflabel="Mandantenkonfigurierung">
7066 <title>Mandantenkonfiguration</title>
7069 <title>Reiter "Features"</title>
7071 <para>Unter dem Reiter <emphasis role="bold">Features</emphasis>
7072 im Abschnitt Dateimanagement ist neben dem "alten" WebDAV das
7073 Dateimangement generell zu- und abschaltbar, sowie die Zuordnung
7074 der Dateitypen zu Backends. Die Löschbarkeit von Dateien, sowie
7075 die maximale Uploadgröße sind Backend-unabhängig</para>
7078 <screeninfo>Mandantenkonfig Reiter "Features"</screeninfo>
7082 <imagedata fileref="images/DMS-ClientConfig.png" width="500"/>
7087 <para>Die einzelnen Backends sind einzeln einschaltbar.
7088 Spezifische Backend-Konfigurierungen sind hier noch
7093 <title>Reiter "Allgemeine Dokumentenanhänge"</title>
7095 <para>Unter dem Reiter <emphasis role="bold">Allgemeine
7096 Dokumentenanhänge</emphasis> kann für alle ERP-Dokumente (
7097 Angebote, Aufträge, Lieferscheine, Rechnungen im Verkauf und
7098 Einkauf ) allgemeingültige Anhänge hochgeladen werden.</para>
7101 <screeninfo>Mandantenkonfig Reiter "Allgemeine
7102 Dokumentenanhänge"</screeninfo>
7106 <imagedata fileref="images/DMS-Allgemeine-Dokumentenanhaenge.png"
7112 <para>Diese Anhänge werden beim Generieren von PDF-Dateien an die
7113 ERP-Dokumente angehängt, z.B. AGBs oder aktuelle Angebote. Es
7114 werden in dem Fall die Daten kopiert, sodass an den ERP-Dokumenten
7115 immer die Anhänge zum Generierungszeitpunkt eingebettet
7120 <sect3 id="file_management.dbconfig"
7121 xreflabel="Datenbank-Konfigurierung">
7122 <title>Datenbank-Konfigurierung</title>
7124 <para>Die zusätzlichen Quellen für "email" oder ein oder mehrere
7125 Scanner sind derzeit vom Administrator direkt in der
7126 Datenbanktabelle "user_preferences" einzurichten. Die "value" ist im
7127 JSON-Format mit den jeweiligen Werten des Verzeichnisses und der
7128 Beschreibung der Quelle.</para>
7131 id | login | namespace | version | key | value
7132 ----+-----------+--------------+---------+----------+---------------------------
7133 1 | #default# | file_sources | 0.00000 | scanner1 |
7134 {"dir":"/var/tmp/scanner1","desc":"Scanner Einkauf"}
7135 2 | #default# | file_sources | 0.00000 | scanner2 |
7136 {"dir":"/var/tmp/scanner2","desc":"Scanner Verkauf"}
7137 3 | #default# | file_sources | 0.00000 | emails |
7138 {"dir":"/var/tmp/emails","desc":"Empfangene Mails" }
7141 <para>Es ist daran gedacht, statt dem Default-Eintrag später für
7142 bestimmte Benutzer ('login') bestimmte Quellen zuzulassen. Dies wird
7143 nach Bedarf implementiert.</para>
7146 <sect3 id="file_management.kiviconfig"
7147 xreflabel="kivitendo-Konfigurationsdatei">
7148 <title>kivitendo-Konfigurationsdatei</title>
7150 <para>Dort ist im Abschnitt [paths] der relative oder absolute Pfad
7151 zum Dokumentenwurzelverzeichnis einzutragen. Dieser muss für den
7152 Webserver schreib- und lesbar sein, jedoch nicht ausführbar.</para>
7156 document_path = /var/local/kivi_documents
7159 <para>Unter diesem Wurzelverzeichnis wird pro Mandant automatisch
7160 ein Unterverzeichnis mit der ID des Mandanten angelegt.</para>
7166 <title>Webshop-Api</title>
7168 <para>Das Shopmodul bietet die Möglichkeit Onlineshopartikel und
7169 Onlineshopbestellungen zu verwalten und zu bearbeiten.</para>
7171 <para>Es ist Multishopfähig, d.h. Artikel können mehreren oder
7172 unterschiedlichen Shops zugeordnet werden. Bestellungen können aus
7173 mehreren Shops geholt werden.</para>
7175 <para>Zur Zeit bietet das Modul nur einen Connector zur REST-Api von
7176 Shopware. Weitere Connectoren können dazu programmiert und eingerichtet
7180 <title>Rechte für die Webshopapi</title>
7182 <para>In der Administration können folgende Rechte vergeben
7187 <para>Webshopartikel anlegen und bearbeiten</para>
7191 <para>Shopbestellungen holen und bearbeiten</para>
7195 <para>Shop anlegen und bearbeiten</para>
7201 <title>Konfiguration</title>
7203 <para>Unter System->Webshops können Shops angelegt und konfiguriert
7208 <imagedata contentdepth="500" contentwidth="700"
7209 fileref="images/Shop_Listing.png"/>
7215 <title>Webshopartikel</title>
7218 <title>Shopvariablenreiter in Artikelstammdaten</title>
7220 <para>Mit dem Recht "Shopartikel anlegen und bearbeiten" und des
7221 Markers <emphasis role="bold">"Shopartikel" in den Basisdaten
7222 </emphasis>zeigt sich der Reiter "Shopvariablen" in den
7223 Artikelstammdaten. Hier können jetzt die Artikel mit
7224 unterschiedlichen Beschreibung und/oder Preisen für die
7225 konfigutierten Shops angelegt und bearbeitet werden. An dieser
7226 Stelle können auch beliebig viele Bilder dem Shopartikel zugeordnet
7227 werden. Artikelbilder gelten für alle Shops.</para>
7231 <imagedata contentdepth="500" contentwidth="600"
7232 fileref="images/Shop_Artikel.png"/>
7236 <para>Die Artikelgruppen werden direkt vom Shopsystem geholt somit
7237 ist es möglich einen Artikel auch mehreren Gruppen
7242 <title>Shopartikelliste</title>
7244 <para>Unter dem Menu Webshop->Webshop Artikel hat man nochmal
7245 eine Gesamtübersicht. Von hier aus ist es möglich Artikel im Stapel
7246 unter verschiedenen Kriterien <alles><nur Preis><nur
7247 Bestand><Preis und Bestand> an die jeweiligen Shops
7252 <imagedata fileref="images/Shop_Artikel_Listing.png"/>
7259 <title>Bestellimport</title>
7261 <para>Unter dem Menupunkt Webshop->Webshop Import öffnet sich die
7262 Bestellimportsliste. Hier ist sind Möglichkeiten gegeben Neue
7263 Bestellungen vom Shop abzuholen, geholte Bestellungen im Stapel oder
7264 einzeln als Auftrag zu transferieren. Die Liste kann nach
7265 verschiedenen Kriterien gefiltert werden.</para>
7269 <imagedata fileref="images/Shop_Bestell.png"/>
7273 <para>Bei Einträgen in der Liste.</para>
7277 <para>keine Kundennummer: Es gibt ähnliche Kundendatensätze und
7278 der Datensatz konnte nicht eindeutig zugewiesen werden.</para>
7282 <para>Kundennummer und Rechnungen rot hinterlegt: Der Kunde hat
7283 offene Posten und kann deswegen nicht im Stapel übernommen
7288 <para>Rechnungsadresse grün hinterlegt: Der Kunde konnte eindeutig
7289 einem Datensatz zugeordnet werden. Die Shopbestellung kann im
7290 Stapel mit dem Button "Anwenden" und wenn markiert als Auftrag
7291 übernommen werden.</para>
7295 <para>Kundennummer vorhanden, aber die Checkbox "Auftrag
7296 erstellen" fehlt. Der Kunde hat vermutlich eine
7297 Shopauftragssperre.</para>
7301 <para>Lieferadresse grau hinterlegt: Optische Anzeige, dass es
7302 sich um eine unterschiedliche Lieferadresse handelt.
7303 Lieferadressen werden aber grundsätzlich beim Transferieren zu
7304 Aufträgen mit übernommen.</para>
7308 <para>In der Spalte Positionen/Betrag/Versandkosten zeigt sich ein
7309 tooltip zu den Positionen.</para>
7313 <para>Maske Auftrag erstellen</para>
7315 <para>Viele Shopsysteme haben drei verschieden Adresstypen Kunden-,
7316 Rechnungs-, und Lieferadresse, die sich auch alle unterscheiden
7317 können. Diese werden im oberen Bereich angezeigt. Es ist möglich jede
7318 dieser Adresse einzeln in kivitendo als Kunde zu übernehmen. Es werden
7319 die Werte Formulareingabe übernommen. Es wird bei einer Änderung
7320 allerdings nur diese in die kivitendo Kundenstammdaten übernommen, die
7321 Shopbestellung bleibt bestehen.</para>
7323 <para>Mit der mittleren Adresse(Rechnungsadresse) im oberen Bereich,
7324 kann ich den ausgewählten kivitendodatensatz des mittleren Bereich
7325 überschreiben. Das ist sinnvoll, wenn ich erkenne, das der Kunde z.B.
7326 umgezogen ist.</para>
7328 <para>Im mittleren Bereich das Adresslisting zeigt:</para>
7332 <para>Rot hinterlegt: Kunde hat eine Shopauftragssperre, diese
7333 muss zuerst deaktiviert werden bevor ich diesem Kunden eine
7334 Shopbestellung zuordnen kann.</para>
7338 <para>Kundenname fett und rot: Hier hat der Kunde eine Bemerkung
7339 in den Stammdaten. Ein Tooltip zeigt diese Bemerkung. Das kann dan
7340 auch der Grund für die Auftragssperre sein.</para>
7344 <para>Die Buttons "Auftrag erstellen" und "Kunde mit
7345 Rechnungsadresse überschreiben" zeigen sich erst, wenn ein Kunde
7346 aus dem Listing ausgewählt ist.</para>
7350 <para>Es ist aber möglich die Shopbestellung zu löschen.</para>
7354 <para>Ist eine Bestellung schon übernommen, zeigen sich an dieser
7355 Stelle, die dazugehörigen Belegverknüpfungen.</para>
7361 <title>Mapping der Daten</title>
7363 <para>Das Mapping der kivitendo Daten mit den Shopdaten geschieht in
7364 der Datei SL/ShopConnector/<SHOPCONNECTORNAME>.pm
7365 z.B.:SL/ShopConnector/Shopware.pm</para>
7367 <para>In dieser Datei gibt es einen Bereich wo die Bestellpostionen,
7368 die Bestellkopfdaten und die Artikeldaten gemapt werden. In dieser
7369 Datei kann ein individelles Mapping dann gemacht werden. Zu Shopware
7370 gibt es hier eine sehr gute Dokumentation: <ulink
7371 url="https://developers.shopware.com/developers-guide/rest-api/">https://developers.shopware.com/developers-guide/rest-api/</ulink></para>
7374 <sect1 id="features.zugferd">
7375 <title>ZUGFeRD Rechnungen</title>
7376 <sect2 id="features.zugferd.preamble">
7377 <title>Vorbedingung</title>
7379 Für die Erstellung von ZUGFeRD PDFs wird TexLive2018 oder höher benötigt.
7383 Wer kein TexLive2018 oder höher installieren kann, kann eine lokale Umgebung nur für kivitendo wie folgt erzeugen:
7386 1. Download des offiziellen Installers von https://www.tug.org/texlive/quickinstall.html
7388 2. Installer ausführen, Standard-Ort für Installation belassen, evtl. ein paar Pakete abwählen, installieren lassen
7390 3. Ein kleine Script »run_pdflatex.sh« anlegen, das den PATH auf das Installationsverezichnis setzt und pdflatex ausführt:
7392 ------------------------------------------------------------
7395 export PATH=/usr/local/texlive/2020/bin/x86_64-linux:$PATH
7398 exec pdflatex "$@"
7399 ------------------------------------------------------------
7401 4. In config/kivitendo.conf den Parameter »latex« auf den Pfad zu »run_pdflatex.sh« setzen
7403 5. Webserver neu starten
7407 <sect2 id="features.zugferd.summary">
7408 <title>Übersicht</title>
7410 <para>Mit der Version 3.5.6 bietet kivitendo die Möglichkeit ZUGFeRD
7411 Rechnungen zu erstellen, sowie auch ZUGFeRD Rechnungen direkt in
7412 kivitendo einzulesen. </para>
7414 <para>Bei ZUGFeRD Rechnungen handelt es sich um eine PDF Datei in
7415 der eine XML-Datei eingebettet ist. Der Aufbau der XML-Datei ist
7416 standardisiert und ermöglicht so den Austausch zwischen
7417 den verschiedenen Softwareprodukten. Kivitendo setzt mit der
7418 Version 3.5.6 den ZUGFeRD 2.1 Standard um.</para>
7420 <para>Weiter Details zu ZUGFeRD sind unter diesem Link zu finden:
7421 <ulink url="https://www.ferd-net.de/standards/was-ist-zugferd/index.html">https://www.ferd-net.de/standards/was-ist-zugferd/index.html</ulink>
7425 <sect2 id="features.zugferd.create_zugferd_bills">
7427 <title>Erstellen von ZUGFeRD Rechnungen in Kivitendo</title>
7428 <para>Für die Erstellung von ZUGFeRD Rechnungen bedarf es in
7429 kivitendo zwei Dinge:</para>
7434 <para>Die Erstellung muss in der Mandantenkonfiguration
7435 aktiviert sein</para>
7439 <para>Beim mindestens einem Bankkonto muss die Option
7440 „Nutzung von ZUGFeRD“ aktiviert sein</para>
7445 <title>Mandantenkonfiguration</title>
7447 <para>Die Einstellung für die Erstellung von ZUGFeRD Rechnungen
7448 erfolgt unter „System“ → „Mandatenkonfiguration“ → „Features“.
7449 Im Abschnitt „Einkauf und Verkauf“ finden Sie die Einstellung
7450 „Verkaufsrechnungen mit ZUGFeRD-Daten erzeugen“.
7451 Hier besteht die Auswahl zwischen:</para>
7455 <para>ZUGFeRD-Rechnungen erzeugen</para>
7459 <para>ZUGFeRD-Rechnungen im Testmodus erzeugen</para>
7463 <para>Keine ZUGFeRD Rechnungen erzeugen</para>
7468 <para>Rechnungen die als PDF erzeugt werden, werden je nach
7469 Einstellung nun im ZUGFeRD Format ausgegeben.</para>
7474 <title>Konfiguration der Bankkonten</title>
7476 <para>Unter „System → Bankkonten“ muss bei mindestens einem
7477 Bankkonto die Option „Nutzung mit ZUGFeRD“ auf „Ja“ gestellt
7483 <sect2 id="features.zugferd.read_zugferd_bills">
7485 <title>Einlesen von ZUGFeRD Rechnungen in Kivitendo</title>
7487 <para>Es lassen sich auch Rechnungen von Kreditoren, die im
7488 ZUGFeRD Format erstellt wurden, nach Kivitendo importieren.
7489 Hierfür müssen auch zwei Voraussetzungen erfüllt werden:
7495 <para>Beim Lieferanten muss die Umsatzsteuer-ID und das
7496 Bankkonto hinterlegt sein</para>
7500 <para>Für den Kreditoren muss eine Buchungsvorlage existieren.</para>
7505 <para>Wenn diese Voraussetzungen erfüllt sind, kann die Rechnung
7506 über „Finanzbuchhaltung“ → „Factur-X-/ZUGFeRD-Import“ über die „Durchsuchen“
7507 Schaltfläche ausgewählt werden und über die Schaltfläche „Import“
7508 eingeladen werden. Es öffnet sich daraufhin die Kreditorenbuchung.
7509 Die auslesbaren Daten aus dem eingebetteten XML der PDF Datei
7510 werden in der Kreditorenbuchung ergänzt.</para>
7519 <title>Entwicklerdokumentation</title>
7521 <sect1 id="devel.globals" xreflabel="Globale Variablen">
7522 <title>Globale Variablen</title>
7525 <title>Wie sehen globale Variablen in Perl aus?</title>
7527 <para>Globale Variablen liegen in einem speziellen namespace namens
7528 "main", der von überall erreichbar ist. Darüber hinaus sind bareword
7529 globs global und die meisten speziellen Variablen sind...
7532 <para>Daraus ergeben sich folgende Formen:</para>
7536 <term><literal>$main::form</literal></term>
7539 <para>expliziter Namespace "main"</para>
7544 <term><literal>$::form</literal></term>
7547 <para>impliziter Namespace "main"</para>
7552 <term><literal>open FILE, "file.txt"</literal></term>
7555 <para><varname>FILE</varname> ist global</para>
7560 <term><literal>$_</literal></term>
7563 <para>speziell</para>
7568 <para>Im Gegensatz zu <productname>PHP</productname> gibt es kein
7569 Schlüsselwort wie "<function>global</function>", mit dem man
7570 importieren kann. <function>my</function>, <function>our</function>
7571 und <function>local</function> machen was anderes.</para>
7575 <term><literal>my $form</literal></term>
7578 <para>lexikalische Variable, gültig bis zum Ende des
7584 <term><literal>our $form</literal></term>
7587 <para><varname>$form</varname> referenziert ab hier
7588 <varname>$PACKAGE::form</varname>.</para>
7593 <term><literal>local $form</literal></term>
7596 <para>Alle Änderungen an <varname>$form</varname> werden am Ende
7597 des scopes zurückgesetzt</para>
7604 <title>Warum sind globale Variablen ein Problem?</title>
7606 <para>Das erste Problem ist <productname>FCGI</productname>.</para>
7608 <para><productname>SQL-Ledger</productname> hat fast alles im globalen
7609 namespace abgelegt, und erwartet, dass es da auch wiederzufinden ist.
7610 Unter <productname>FCGI</productname> müssen diese Sachen aber wieder
7611 aufgeräumt werden, damit sie nicht in den nächsten Request kommen.
7612 Einige Sachen wiederum sollen nicht gelöscht werden, wie zum Beispiel
7613 Datenbankverbindungen, weil die sehr lange zum Initialisieren
7616 <para>Das zweite Problem ist <function>strict</function>. Unter
7617 <function>strict</function> werden alle Variablen die nicht explizit
7618 mit <function>Package</function>, <function>my</function> oder
7619 <function>our</function> angegeben werden als Tippfehler angemarkert,
7620 dies hat, seit der Einführung, u.a. schon so manche langwierige
7621 Bug-Suche verkürzt. Da globale Variablen aber implizit mit Package
7622 angegeben werden, werden die nicht geprüft, und somit kann sich
7623 schnell ein Tippfehler einschleichen.</para>
7627 <title>Kanonische globale Variablen</title>
7629 <para>Um dieses Problem im Griff zu halten gibt es einige wenige
7630 globale Variablen, die kanonisch sind, d.h. sie haben bestimmte
7631 vorgegebenen Eigenschaften, und alles andere sollte anderweitig
7632 umhergereicht werden.</para>
7634 <para>Diese Variablen sind im Moment die folgenden neun:</para>
7638 <para><varname>$::form</varname></para>
7642 <para><varname>%::myconfig</varname></para>
7646 <para><varname>$::locale</varname></para>
7650 <para><varname>$::lxdebug</varname></para>
7654 <para><varname>$::auth</varname></para>
7658 <para><varname>$::lx_office_conf</varname></para>
7662 <para><varname>$::instance_conf</varname></para>
7666 <para><varname>$::dispatcher</varname></para>
7670 <para><varname>$::request</varname></para>
7674 <para>Damit diese nicht erneut als Müllhalde missbraucht werden, im
7675 Folgenden eine kurze Erläuterung der bestimmten vorgegebenen
7676 Eigenschaften (Konventionen):</para>
7679 <title>$::form</title>
7683 <para>Ist ein Objekt der Klasse
7684 "<classname>Form</classname>"</para>
7688 <para>Wird nach jedem Request gelöscht</para>
7692 <para>Muss auch in Tests und Konsolenscripts vorhanden
7697 <para>Enthält am Anfang eines Requests die Requestparameter vom
7702 <para>Kann zwar intern über Requestgrenzen ein Datenbankhandle
7703 cachen, das wird aber momentan absichtlich zerstört</para>
7707 <para><varname>$::form</varname> wurde unter <productname>SQL
7708 Ledger</productname> als Gottobjekt für alles missbraucht. Sämtliche
7709 alten Funktionen unter SL/ mutieren <varname>$::form</varname>, das
7710 heißt, alles was einem lieb ist (alle Variablen die einem ans Herz
7711 gewachsen sind), sollte man vor einem Aufruf (!) von zum Beispiel
7712 <function>IS->retrieve_customer()</function> in Sicherheit
7715 <para>Z.B. das vom Benutzer eingestellte Zahlenformat, bevor man
7716 Berechnung in einem bestimmten Format durchführt (SL/Form.pm Zeile
7717 3552, Stand version 2.7beta), um dies hinterher wieder auf den
7718 richtigen Wert zu setzen:</para>
7720 <programlisting> my $saved_numberformat = $::myconfig{numberformat};
7721 $::myconfig{numberformat} = $numberformat;
7722 # (...) div Berechnungen
7723 $::myconfig{numberformat} = $saved_numberformat;</programlisting>
7725 <para>Das Objekt der Klasse Form hat leider im Moment noch viele
7726 zentrale Funktionen die vom internen Zustand abhängen, deshalb bitte
7727 nie einfach zerstören oder überschreiben (zumindestens nicht kurz
7728 vor einem Release oder in Absprache über bspw. die devel-Liste ;-).
7729 Es geht ziemlich sicher etwas kaputt.</para>
7731 <para><varname>$::form</varname> ist gleichzeitig der Standard Scope
7732 in den <productname>Template::Toolkit</productname> Templates
7733 außerhalb der Controller: der Ausdruck <function>[% var
7734 %]</function> greift auf <varname>$::form->{var}</varname> zu.
7735 Unter Controllern ist der Standard Scope anders, da lautet der
7736 Zugriff <function>[% FORM.var %]</function>. In Druckvorlagen sind
7737 normale Variablen ebenfall im <varname>$::form</varname> Scope, d.h.
7738 <function><%var%></function> zeigt auf
7739 <varname>$::form->{var}</varname>. Nochmal von der anderen Seite
7740 erläutert, innerhalb von (Web-)Templates sieht man häufiger solche
7743 <programlisting>[%- IF business %]
7744 # (... Zeig die Auswahlliste Kunden-/Lieferantentyp an)
7745 [%- END %]</programlisting>
7747 <para>Entweder wird hier dann $::form->{business} ausgewertet
7748 oder aber der Funktion
7749 <function>$form->parse_html_template</function> wird explizit
7750 noch ein zusätzlicher Hash übergeben, der dann auch in den
7751 (Web-)Templates zu Verfügung steht, bspw. so:</para>
7753 <programlisting>$form->parse_html_template("is/form_header", \%TMPL_VAR);</programlisting>
7755 <para>Innerhalb von Schleifen wird
7756 <varname>$::form->{TEMPLATE_ARRAYS}{var}[$index]</varname>
7757 bevorzugt, wenn vorhanden. Ein Beispiel findet sich in SL/DO.pm,
7758 welches über alle Positionen eines Lieferscheins in Schleife
7761 <programlisting>for $i (1 .. $form->{rowcount}) {
7763 push @{ $form->{TEMPLATE_ARRAYS}{runningnumber} }, $position;
7764 push @{ $form->{TEMPLATE_ARRAYS}{number} }, $form->{"partnumber_$i"};
7765 push @{ $form->{TEMPLATE_ARRAYS}{description} }, $form->{"description_$i"};
7771 <title>%::myconfig</title>
7775 <para>Das einzige Hash unter den globalen Variablen</para>
7779 <para>Wird spätestens benötigt wenn auf die Datenbank
7780 zugegriffen wird</para>
7784 <para>Wird bei jedem Request neu erstellt.</para>
7788 <para>Enthält die Userdaten des aktuellen Logins</para>
7792 <para>Sollte nicht ohne Filterung irgendwo gedumpt werden oder
7793 extern serialisiert werden, weil da auch der Datenbankzugriff
7794 für diesen user drinsteht.</para>
7798 <para>Enthält unter anderem Datumsformat dateformat und
7799 Nummernformat numberformat</para>
7803 <para>Enthält Datenbankzugriffinformationen</para>
7807 <para><varname>%::myconfig</varname> ist im Moment der Ersatz für
7808 ein Userobjekt. Die meisten Funktionen, die etwas anhand des
7809 aktuellen Users entscheiden müssen, befragen
7810 <varname>%::myconfig</varname>. Innerhalb der Anwendungen sind dies
7811 überwiegend die Daten, die sich unter <guimenu>Programm</guimenu>
7812 -> <guimenuitem>Einstellungen</guimenuitem> befinden, bzw. die
7813 Informationen über den Benutzer die über die
7814 Administrator-Schnittstelle eingegeben wurden.</para>
7818 <title>$::locale</title>
7822 <para>Objekt der Klasse "Locale"</para>
7826 <para>Wird pro Request erstellt</para>
7830 <para>Muss auch für Tests und Scripte immer verfügbar
7835 <para>Cached intern über Requestgrenzen hinweg benutzte
7840 <para>Lokalisierung für den aktuellen User. Alle Übersetzungen,
7841 Zahlen- und Datumsformatierungen laufen über dieses Objekt.</para>
7845 <title>$::lxdebug</title>
7849 <para>Objekt der Klasse "LXDebug"</para>
7853 <para>Wird global gecached</para>
7857 <para>Muss immer verfügbar sein, in nahezu allen
7862 <para><varname>$::lxdebug</varname> stellt Debuggingfunktionen
7863 bereit, wie "<function>enter_sub</function>" und
7864 "<function>leave_sub</function>", mit denen in den alten Modulen ein
7865 brauchbares Tracing gebaut ist, "<function>log_time</function>", mit
7866 der man die Wallclockzeit seit Requeststart loggen kann, sowie
7867 "<function>message</function>" und "<function>dump</function>" mit
7868 denen man flott Informationen ins Log (tmp/kivitendo-debug.log)
7871 <para>Beispielsweise so:</para>
7873 <programlisting>$main::lxdebug->message(0, 'Meine Konfig:' . Dumper (%::myconfig));
7874 $main::lxdebug->message(0, 'Wer bin ich? Kunde oder Lieferant:' . $form->{vc});</programlisting>
7878 <title>$::auth</title>
7882 <para>Objekt der Klasse "SL::Auth"</para>
7886 <para>Wird global gecached</para>
7890 <para>Hat eine permanente DB Verbindung zur Authdatenbank</para>
7894 <para>Wird nach jedem Request resettet.</para>
7898 <para><varname>$::auth</varname> stellt Funktionen bereit um die
7899 Rechte des aktuellen Users abzufragen. Obwohl diese Informationen
7900 vom aktuellen User abhängen wird das Objekt aus
7901 Geschwindigkeitsgründen nur einmal angelegt und dann nach jedem
7902 Request kurz resettet.</para>
7904 <para>Dieses Objekt kapselt auch den gerade aktiven Mandanten.
7905 Dessen Einstellungen können über
7906 <literal>$::auth->client</literal> abgefragt werden; Rückgabewert
7907 ist ein Hash mit den Werten aus der Tabelle
7908 <literal>auth.clients</literal>.</para>
7912 <title>$::lx_office_conf</title>
7916 <para>Objekt der Klasse
7917 "<classname>SL::LxOfficeConf</classname>"</para>
7921 <para>Global gecached</para>
7925 <para>Repräsentation der
7926 <filename>config/kivitendo.conf[.default]</filename>-Dateien</para>
7930 <para>Globale Konfiguration. Configdateien werden zum Start gelesen
7931 und danach nicht mehr angefasst. Es ist derzeit nicht geplant, dass
7932 das Programm die Konfiguration ändern kann oder sollte.</para>
7934 <para>Beispielsweise ist über den Konfigurationseintrag [debug] die
7935 Debug- und Trace-Log-Datei wie folgt konfiguriert und
7938 <programlisting>[debug]
7939 file_name = /tmp/kivitendo-debug.log</programlisting>
7941 <para>ist der Key <varname>file</varname> im Programm als
7942 <varname>$::lx_office_conf->{debug}{file}</varname>
7946 <para>Zugriff auf die Konfiguration erfolgt im Moment über
7947 Hashkeys, sind also nicht gegen Tippfehler abgesichert.</para>
7952 <title>$::instance_conf</title>
7956 <para>Objekt der Klasse
7957 "<classname>SL::InstanceConfiguration</classname>"</para>
7961 <para>wird pro Request neu erstellt</para>
7965 <para>Funktioniert wie <varname>$::lx_office_conf</varname>,
7966 speichert aber Daten die von der Instanz abhängig sind. Eine Instanz
7967 ist hier eine Mandantendatenbank. Beispielsweise überprüft
7968 <programlisting>$::instance_conf->get_inventory_system eq 'perpetual'</programlisting>
7969 ob die berüchtigte Bestandsmethode zur Anwendung kommt.</para>
7973 <title>$::dispatcher</title>
7977 <para>Objekt der Klasse
7978 "<varname>SL::Dispatcher</varname>"</para>
7982 <para>wird pro Serverprozess erstellt.</para>
7986 <para>enthält Informationen über die technische Verbindung zum
7991 <para>Der dritte Punkt ist auch der einzige Grund warum das Objekt
7992 global gespeichert wird. Wird vermutlich irgendwann in einem anderen
7993 Objekt untergebracht.</para>
7997 <title>$::request</title>
8001 <para>Hashref (evtl später Objekt)</para>
8005 <para>Wird pro Request neu initialisiert.</para>
8009 <para>Keine Unterstruktur garantiert.</para>
8013 <para><varname>$::request</varname> ist ein generischer Platz um
8014 Daten "für den aktuellen Request" abzulegen. Sollte nicht für action
8015 at a distance benutzt werden, sondern um lokales memoizing zu
8016 ermöglichen, das garantiert am Ende des Requests zerstört
8019 <para>Vieles von dem, was im moment in <varname>$::form</varname>
8020 liegt, sollte eigentlich hier liegen. Die groben
8021 Differentialkriterien sind:</para>
8025 <para>Kommt es vom User, und soll unverändert wieder an den
8026 User? Dann <varname>$::form</varname>, steht da eh schon</para>
8030 <para>Sind es Daten aus der Datenbank, die nur bis zum Ende des
8031 Requests gebraucht werden? Dann
8032 <varname>$::request</varname></para>
8036 <para>Muss ich von anderen Teilen des Programms lesend drauf
8037 zugreifen? Dann <varname>$::request</varname>, aber Zugriff über
8038 Wrappermethode</para>
8045 <title>Ehemalige globale Variablen</title>
8047 <para>Die folgenden Variablen waren einmal im Programm, und wurden
8051 <title>$::cgi</title>
8055 <para>war nötig, weil cookie Methoden nicht als
8056 Klassenfunktionen funktionieren</para>
8060 <para>Aufruf als Klasse erzeugt Dummyobjekt was im
8061 Klassennamespace gehalten wird und über Requestgrenzen
8066 <para>liegt jetzt unter
8067 <varname>$::request->{cgi}</varname></para>
8073 <title>$::all_units</title>
8077 <para>war nötig, weil einige Funktionen in Schleifen zum Teil
8078 ein paar hundert mal pro Request eine Liste der Einheiten
8079 brauchen, und de als Parameter durch einen Riesenstack von
8080 Funktionen geschleift werden müssten.</para>
8084 <para>Liegt jetzt unter
8085 <varname>$::request->{cache}{all_units}</varname></para>
8090 <function>AM->retrieve_all_units()</function> gesetzt oder
8097 <title>%::called_subs</title>
8101 <para>wurde benutzt um callsub deep recursions
8106 <para>Wurde entfernt, weil callsub nur einen Bruchteil der
8107 möglichen Rekursioenen darstellt, und da nie welche
8112 <para>komplette recursion protection wurde entfernt.</para>
8119 <sect1 id="devel.fcgi">
8120 <title>Entwicklung unter FastCGI</title>
8122 <sect2 id="devel.fcgi.general">
8123 <title>Allgemeines</title>
8125 <para>Wenn Änderungen in der Konfiguration von kivitendo gemacht
8126 werden, muss der Webserver neu gestartet werden.</para>
8128 <para>Bei der Entwicklung für FastCGI ist auf ein paar Fallstricke zu
8129 achten. Dadurch, dass das Programm in einer Endlosschleife läuft,
8130 müssen folgende Aspekte beachtet werden.</para>
8133 <sect2 id="devel.fcgi.exiting">
8134 <title>Programmende und Ausnahmen</title>
8136 <para>Betrifft die Funktionen <function>warn</function>,
8137 <function>die</function>, <function>exit</function>,
8138 <function>carp</function> und <function>confess</function>.</para>
8140 <para>Fehler, die dass Programm normalerweise sofort beenden (fatale
8141 Fehler), werden mit dem FastCGI Dispatcher abgefangen, um das Programm
8142 am Laufen zu halten. Man kann mit <function>die</function>,
8143 <function>confess</function> oder <function>carp</function> Fehler
8144 ausgeben, die dann vom Dispatcher angezeigt werden. Die kivitendo
8145 eigene <function>$::form-</function>error()> tut im Prinzip das
8146 Gleiche, mit ein paar Extraoptionen. <function>warn</function> und
8147 <function>exit</function> hingegen werden nicht abgefangen.
8148 <function>warn</function> wird direkt nach STDERR, also in Server Log
8149 eine Nachricht schreiben (sofern in der Konfiguration nicht die
8150 Warnungen in das kivitendo Log umgeleitet wurden), und
8151 <function>exit</function> wird die Ausführung beenden.</para>
8153 <para>Prinzipiell ist es kein Beinbruch, wenn sich der Prozess
8154 beendet, fcgi wird ihn sofort neu starten. Allerdings sollte das die
8155 Ausnahme sein. Quintessenz: Bitte kein <function>exit</function>
8156 benutzen, alle anderen Exceptionmechanismen sind ok.</para>
8159 <sect2 id="devel.fcgi.globals">
8160 <title>Globale Variablen</title>
8162 <para>Um zu vermeiden, dass Informationen von einem Request in einen
8163 anderen gelangen, müssen alle globalen Variablen vor einem Request
8164 sauber initialisiert werden. Das ist besonders wichtig im
8165 <varname>$::cgi</varname> und <varname>$::auth</varname> Objekt, weil
8166 diese nicht gelöscht werden pro Instanz, sondern persistent gehalten
8169 <para>In <classname>SL::Dispatcher</classname> gibt es einen sauber
8170 abgetrennten Block, der alle kanonischen globalen Variablen listet und
8171 erklärt. Bitte keine anderen einführen ohne das sauber zu
8172 dokumentieren.</para>
8174 <para>Datenbankverbindungen wird noch ein Guide verfasst werden, wie
8175 man sicher geht, dass man die richtige erwischt.</para>
8178 <sect2 id="devel.fcgi.performance">
8179 <title>Performance und Statistiken</title>
8181 <para>Die kritischen Pfade des Programms sind die Belegmasken, und
8182 unter diesen ganz besonders die Verkaufsrechnungsmaske. Ein Aufruf der
8183 Rechnungsmaske in kivitendo 2.4.3 stable dauert auf einem Core2duo mit
8184 4GB Arbeitsspeicher und Ubuntu 9.10 eine halbe Sekunde. In der 2.6.0
8185 sind es je nach Menge der definierten Variablen 1-2s. Ab der
8186 Moose/Rose::DB Version sind es 5-6s.</para>
8188 <para>Mit FastCGI ist die neuste Version auf 0,26 Sekunden selbst in
8189 den kritischen Pfaden, unter 0,15 sonst.</para>
8193 <sect1 id="dev-programmatic-api-calls" xreflabel="Programmatische API-Aufrufe">
8194 <title>Programmatische API-Aufrufe</title>
8196 <sect2 id="dev-programmatic-api-calls.introduction" xreflabel="Einführung in programmatische API-Aufrufe">
8197 <title>Einführung</title>
8200 Es ist möglich, Funktionen in kivitendo programmatisch aus anderen Programmen aufzurufen. Dazu ist nötig, dass
8201 Authentifizierungsinformationen in jedem Aufruf mitgegeben werden. Dafür gibt es zwei Methoden: die HTTP-»Basic«-Authentifizierung
8202 oder die Übergabe als spziell benannte GET-Parameter. Neben den Authentifizierungsinformationen muss auch der zu verwendende Mandant
8207 <sect2 id="dev-programmatic-api-calls.client_selection" xreflabel="Mandantenauswahl bei programmatischen API-Aufrufen">
8208 <title>Wahl des Mandanten</title>
8211 Der zu verwendende Mandant kann als Parameter <varname>{AUTH}client_id</varname> mit jedem Request mitgeschickt werden. Der Wert
8212 muss dabei die Datenbank-ID des Mandanten sein. kivitendo prüft, ob der Account, der über die Authentifizierungsinformationen
8213 übergeben wurde, Zugriff auf den angegebenen Mandanten hat.
8217 Wird in einem Request kein Mandant mitgegeben, so wird derjenige Mandant genommen, wer als Standardmandant markiert wurde. Gibt es
8218 keinen solchen, kommt es zu einer Fehlermeldung.
8222 <sect2 id="dev-programmatic-api-calls.http_basic_authentication" xreflabel="Programmatische API-Aufrufe mit HTTP-»Basic« authentifizieren">
8223 <title>HTTP-»Basic«-Authentifizierung</title>
8226 Für diese Methode muss jedem Request der bekannte HTTP-Header <constant>Authorization</constant> mitgeschickt werden (siehe <ulink
8227 url="https://tools.ietf.org/html/rfc7617">RFC 7617</ulink>). Unterstützt wird ausschließlich die »Basic«-Methode. Loginname und
8228 Passwort werden bei dieser Methode durch einen Doppelpunkt getrennt und Base64-encodiert im genannten HTTP-Header übertragen.
8232 Diese Informationen müssen einen vorhandenen Account benennen. kivitendo prüft genau wie bei Benutzung über den Webbrowser, ob
8233 dieser Account Zugriff auf den Mandanten sowie auf die angeforderte Funktion hat.
8237 Da die Logininformationen im Klartext im Request stehen, sollte der Zugriff auf kivitendo ausschließlich über HTTPS verschlüsselt
8242 <sect2 id="dev-programmatic-api-calls.authentication_via_parameters" xreflabel="Programmatische API-Aufrufe mit Parametern authentifizieren">
8243 <title>Authentifizierung mit Parametern</title>
8246 Für diese Methode müssen jedem Request zwei Parameter mitgegeben werden: <varname>{AUTH}login</varname> und
8247 <varname>{AUTH}password</varname>. Diese Informationen müssen einen vorhandenen Account benennen. kivitendo prüft genau wie bei
8248 Benutzung über den Webbrowser, ob dieser Account Zugriff auf den Mandanten sowie auf die angeforderte Funktion hat.
8252 Da die Logininformationen im Klartext im Request stehen, sollte der Zugriff auf kivitendo ausschließlich über HTTPS verschlüsselt
8258 Die Verwendung dieser Methode ist veraltet. Statt dessen sollte die oben erwähnte HTTP-»Basic«-Authentifizierung verwendet werden.
8263 <sect2 id="dev-programmatic-api-calls.examples">
8264 <title>Beispiele</title>
8267 Das folgende Beispiel nutzt das Kommandozeilenprogramm »curl« und ruft die Funktion auf, die eine vorhandene Telefonnummer in den
8268 Ansprechpersonen sucht und dazu Informationen zurückliefert. Dabei wird die HTTP-»Basic«-Authentifizierung genutzt.
8271 <programlisting>$ curl --silent --user 'jdoe:SecretPassword!' \
8272 'https://…/controller.pl?action=PhoneNumber/look_up&number=053147110815'</programlisting>
8276 <sect1 id="db-upgrade-files" xreflabel="Datenbank-Upgradedateien">
8277 <title>SQL-Upgradedateien</title>
8279 <sect2 id="db-upgrade-files.introduction"
8280 xreflabel="Einführung in die Datenbank-Upgradedateien">
8281 <title>Einführung</title>
8283 <para>Datenbankupgrades werden über einzelne Upgrade-Scripte
8284 gesteuert, die sich im Verzeichnis
8285 <filename>sql/Pg-upgrade2</filename> befinden. In diesem Verzeichnis
8286 muss pro Datenbankupgrade eine Datei existieren, die neben den
8287 eigentlich auszuführenden SQL- oder Perl-Befehlen einige
8288 Kontrollinformationen enthält.</para>
8290 <para>Kontrollinformationen definieren Abhängigkeiten und Prioritäten,
8291 sodass Datenbankscripte zwar in einer sicheren Reihenfolge ausgeführt
8292 werden (z.B. darf ein <literal>ALTER TABLE</literal> erst ausgeführt
8293 werden, wenn die Tabelle mit <literal>CREATE TABLE</literal> angelegt
8294 wurde), diese Reihenfolge aber so flexibel ist, dass man keine
8295 Versionsnummern braucht.</para>
8297 <para>kivitendo merkt sich dabei, welches der Upgradescripte in
8298 <filename>sql/Pg-upgrade2</filename> bereits durchgeführt wurde und
8299 führt diese nicht erneut aus. Dazu dient die Tabelle
8300 "<literal>schema_info</literal>", die bei der Anmeldung automatisch
8301 angelegt wird.</para>
8304 <sect2 id="db-upgrade-files.format"
8305 xreflabel="Format der Upgradedateien">
8306 <title>Format der Kontrollinformationen</title>
8308 <para>Die Kontrollinformationen sollten sich am Anfang der jeweiligen
8309 Upgradedatei befinden. Jede Zeile, die Kontrollinformationen enthält,
8310 hat dabei das folgende Format:</para>
8312 <para>Für SQL-Upgradedateien:</para>
8314 <programlisting>-- @key: value</programlisting>
8316 <para>Für Perl-Upgradedateien:</para>
8318 <programlisting># @key: value</programlisting>
8320 <para>Leerzeichen vor "<varname>value</varname>" werden
8323 <para>Die folgenden Schlüsselworte werden verarbeitet:</para>
8327 <term><varname>tag</varname></term>
8330 <para>Wird zwingend benötigt. Dies ist der "Name" des Upgrades.
8331 Dieser "tag" kann von anderen Kontrolldateien in ihren
8332 Abhängigkeiten verwendet werden (Schlüsselwort
8333 "<varname>depends</varname>"). Der "tag" ist auch der Name, der
8334 in der Datenbank eingetragen wird.</para>
8336 <para>Normalerweise sollte die Kontrolldatei genau so heißen wie
8337 der "tag", nur mit der Endung ".sql" bzw. "pl".</para>
8339 <para>Ein Tag darf nur aus alphanumerischen Zeichen sowie den
8340 Zeichen _ - ( ) bestehen. Insbesondere sind Leerzeichen nicht
8341 erlaubt und sollten stattdessen mit Unterstrichen ersetzt
8347 <term><varname>charset</varname></term>
8350 <para>Empfohlen. Gibt den Zeichensatz an, in dem das Script
8351 geschrieben wurde, z.B. "<literal>UTF-8</literal>". Aus
8352 Kompatibilitätsgründen mit alten Upgrade-Scripten wird bei
8353 Abwesenheit des Tags für SQL-Upgradedateien der Zeichensatz
8354 "<literal>ISO-8859-15</literal>" angenommen. Perl-Upgradescripte
8355 hingegen müssen immer in UTF-8 encodiert sein und sollten
8356 demnach auch ein "<literal>use utf8;</literal>"
8362 <term><varname>description</varname></term>
8365 <para>Benötigt. Eine Beschreibung, was in diesem Update
8366 passiert. Diese wird dem Benutzer beim eigentlichen
8367 Datenbankupdate angezeigt. Während der Tag in Englisch gehalten
8368 sein sollte, sollte die Beschreibung auf Deutsch
8374 <term><varname>depends</varname></term>
8377 <para>Optional. Eine mit Leerzeichen getrennte Liste von "tags",
8378 von denen dieses Upgradescript abhängt. kivitendo stellt sicher,
8379 dass die in dieser Liste aufgeführten Scripte bereits
8380 durchgeführt wurden, bevor dieses Script ausgeführt wird.</para>
8382 <para>Abhängigkeiten werden rekursiv betrachtet. Wenn also ein
8383 Script "b" existiert, das von Änderungen in "a" abhängt, und
8384 eine neue Kontrolldatei für "c" erstellt wird, die von
8385 Änderungen in "a" und "b" abhängt, so genügt es, in "c" nur den
8386 Tag "b" als Abhängigkeit zu definieren.</para>
8388 <para>Es ist nicht erlaubt, sich selbst referenzierende
8389 Abhängigkeiten zu definieren (z.B. "a" -> "b", "b" -> "c"
8390 und "c" -> "a").</para>
8395 <term><varname>priority</varname></term>
8398 <para>Optional. Ein Zahlenwert, der die Reihenfolge bestimmt, in
8399 der Scripte ausgeführt werden, die die gleichen
8400 Abhängigkeitstiefen besitzen. Fehlt dieser Parameter, so wird
8401 der Wert 1000 benutzt.</para>
8403 <para>Dies ist reine Kosmetik. Für echte Reihenfolgen muss
8404 "depends" benutzt werden. kivitendo sortiert die auszuführenden
8405 Scripte zuerst nach der Abhängigkeitstiefe (wenn "z" von "y"
8406 abhängt und "y" von "x", so hat "z" eine Abhängigkeitstiefe von
8407 2, "y" von 1 und "x" von 0. "x" würde hier zuerst ausgeführt,
8408 dann "y", dann "z"), dann nach der Priorität und bei gleicher
8409 Priorität alphabetisch nach dem "tag".</para>
8414 <term><varname>ignore</varname></term>
8417 <para>Optional. Falls der Wert auf 1 (true) steht, wird das
8418 Skript bei der Anmeldung ignoriert und entsprechend nicht
8425 <sect2 id="db-upgrade-files.format-perl-files"
8426 xreflabel="Format von Perl-Upgradedateien">
8427 <title>Format von in Perl geschriebenen
8428 Datenbankupgradescripten</title>
8430 <para>In Perl geschriebene Datenbankscripte werden nicht einfach so
8431 ausgeführt sondern müssen sich an gewisse Konventionen halten. Dafür
8432 bekommen sie aber auch einige Komfortfunktionen bereitgestellt.</para>
8434 <para>Ein Upgradescript stellt dabei eine vollständige Objektklasse
8435 dar, die vom Elternobjekt "<literal>SL::DBUpgrade2::Base</literal>"
8436 erben und eine Funktion namens "<literal>run</literal>" zur Verfügung
8437 stellen muss. Das Script wird ausgeführt, indem eine Instanz dieser
8438 Klasse erzeugt und darauf die erwähnte "<literal>run</literal>"
8439 aufgerufen wird.</para>
8441 <para>Zu beachten ist, dass sich der Paketname der Datei aus dem Wert
8442 für "<literal>@tag</literal>" ableitet. Dabei werden alle Zeichen, die
8443 in Paketnamen ungültig wären (gerade Bindestriche), durch Unterstriche
8444 ersetzt. Insgesamt sieht der Paketname wie folgt aus:
8445 "<literal>SL::DBUpgrade2::tag</literal>".</para>
8447 <para>Welche Komfortfunktionen zur Verfügung stehen, erfahren Sie in
8448 der Perl-Dokumentation zum oben genannten Modul; aufzurufen mit
8449 "<command>perldoc SL/DBUpgrade2/Base.pm</command>".</para>
8451 <para>Ein Mindestgerüst eines gültigen Perl-Upgradescriptes sieht wie
8454 <programlisting># @tag: beispiel-upgrade-file42
8455 # @description: Ein schönes Beispielscript
8456 # @depends: release_3_1_0
8457 package SL::DBUpgrade2::beispiel_upgrade_file42;
8462 use parent qw(SL::DBUpgrade2::Base);
8467 # hier Aktionen ausführen
8476 <sect2 id="db-upgrade-files.dbupgrade-tool"
8477 xreflabel="Hilfsscript dbupgrade2_tool.pl">
8478 <title>Hilfsscript dbupgrade2_tool.pl</title>
8480 <para>Um die Arbeit mit den Abhängigkeiten etwas zu erleichtern,
8481 existiert ein Hilfsscript namens
8482 "<filename>scripts/dbupgrade2_tool.pl</filename>". Es muss aus dem
8483 kivitendo-ERP-Basisverzeichnis heraus aufgerufen werden. Dieses Tool
8484 liest alle Datenbankupgradescripte aus dem Verzeichnis
8485 <filename>sql/Pg-upgrade2</filename> aus. Es benutzt dafür die
8486 gleichen Methoden wie kivitendo selber, sodass alle Fehlersituationen
8487 von der Kommandozeile überprüft werden können.</para>
8489 <para>Wird dem Script kein weiterer Parameter übergeben, so wird nur
8490 eine Überprüfung der Felder und Abhängigkeiten vorgenommen. Man kann
8491 sich aber auch Informationen auf verschiedene Art ausgeben
8496 <para>Listenform: "<command>./scripts/dbupgrade2_tool.pl
8497 --list</command>"</para>
8499 <para>Gibt eine Liste aller Scripte aus. Die Liste ist in der
8500 Reihenfolge sortiert, in der kivitendo die Scripte ausführen
8501 würde. Es werden neben der Listenposition der Tag, die
8502 Abhängigkeitstiefe und die Priorität ausgegeben.</para>
8506 <para>Baumform: "<command>./scripts/dbupgrade2_tool.pl
8507 --tree</command>"</para>
8509 <para>Listet alle Tags in Baumform basierend auf den
8510 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte, von
8511 denen keine anderen abhängen. Die Unterknoten sind Scripte, die
8512 beim übergeordneten Script als Abhängigkeit eingetragen
8516 <listitem id="db-upgrade-files.dbupgrade-tool.reverse-tree">
8517 <para>Umgekehrte Baumform: "<command>./scripts/dbupgrade2_tool.pl
8518 --rtree</command>"</para>
8520 <para>Listet alle Tags in Baumform basierend auf den
8521 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte mit
8522 der geringsten Abhängigkeitstiefe. Die Unterknoten sind Scripte,
8523 die das übergeordnete Script als Abhängigkeit eingetragen
8528 <para>Baumform mit Postscriptausgabe:
8529 "<command>./scripts/dbupgrade2_tool.pl
8530 --graphviz</command>"</para>
8532 <para>Benötigt das Tool "<command>graphviz</command>", um mit
8533 seiner Hilfe die <link
8534 linkend="db-upgrade-files.dbupgrade-tool.reverse-tree">umgekehrte
8535 Baumform</link> in eine Postscriptdatei namens
8536 "<filename>db_dependencies.ps</filename>" auszugeben. Dies ist
8537 vermutlich die übersichtlichste Form, weil hierbei jeder Knoten
8538 nur einmal ausgegeben wird. Bei den Textmodusbaumformen hingegen
8539 können Knoten und all ihre Abhängigkeiten mehrfach ausgegeben
8544 <para>Scripte, von denen kein anderes Script abhängt:
8545 "<command>./scripts/dbupgrade2_tool.pl --nodeps</command>"</para>
8547 <para>Listet die Tags aller Scripte auf, von denen keine anderen
8548 Scripte abhängen.</para>
8554 <sect1 id="translations-languages" xreflabel="Translations and languages">
8555 <title>Translations and languages</title>
8557 <sect2 id="translations-languages.introduction"
8558 xreflabel="Introduction to translations and languages">
8559 <title>Introduction</title>
8562 <para>Dieser Abschnitt ist in Englisch geschrieben, um
8563 internationalen Übersetzern die Arbeit zu erleichtern.</para>
8566 <para>This section describes how localization packages in kivitendo
8567 are built. Currently the only language fully supported is German, and
8568 since most of the internal messages are held in English the English
8569 version is usable too.</para>
8572 <sect2 id="translations-languages.character-set"
8573 xreflabel="Character set">
8574 <title>Character set</title>
8576 <para>All files included in a language pack must use UTF-8 as their
8580 <sect2 id="translations-languages.file-structure"
8581 xreflabel="File structure">
8582 <title>File structure</title>
8584 <para>The structure of locales in kivitendo is:</para>
8586 <programlisting>kivitendo/locale/<langcode>/</programlisting>
8588 <para>where <langcode> stands for an abbreviation of the
8589 language package. The builtin packages use two letter <ulink
8590 url="http://en.wikipedia.org/wiki/ISO_639-1">ISO 639-1</ulink> codes,
8591 but the actual name is not relevant for the program and can easily be
8593 url="http://en.wikipedia.org/wiki/IETF_language_tag">IETF language
8594 tags</ulink> (i.e. "en_GB"). In fact the original language packages
8595 from SQL Ledger are named in this way.</para>
8597 <para>In such a language directory the following files are
8602 <term>LANGUAGE</term>
8605 <para>This file is mandatory.</para>
8607 <para>The <filename>LANGUAGE</filename> file contains the self
8608 descripted name of the language. It should contain a native
8609 representation first, and in parenthesis an english translation
8610 after that. Example:</para>
8612 <programlisting>Deutsch (German)</programlisting>
8620 <para>This file is mandatory.</para>
8622 <para>The central translation file. It is essentially an inline
8623 Perl script autogenerated by <command>locales.pl</command>. To
8624 generate it, generate the directory and the two files mentioned
8625 above, and execute the following command:</para>
8627 <programlisting>scripts/locales.pl <langcode></programlisting>
8629 <para>Otherwise you can simply copy one of the other languages.
8630 You will be told how many are missing like this:</para>
8632 <programlisting>$ scripts/locales.pl en
8633 English - 0.6% - 2015/2028 missing</programlisting>
8635 <para>A file named "<filename>missing</filename>" will be
8636 generated and can be edited. You can also edit the
8637 "<filename>all</filename>" file directly. Edit everything you
8638 like to fit the target language and execute
8639 <command>locales.pl</command> again. See how the missing words
8645 <term>Num2text</term>
8648 <para>Legacy code from SQL Ledger. It provides a means for
8649 numbers to be converted into natural language, like
8650 <literal>1523 => one thousand five hundred twenty
8651 three</literal>. If you want to provide it, it must be inlinable
8652 Perl code which provides a <function>num2text</function> sub. If
8653 an <function>init</function> sub exists it will be executed
8656 <para>Only used in the check and receipt printing module.</para>
8661 <term>special_chars</term>
8664 <para>kivitendo comes with a lot of interfaces to different
8665 formats, some of which are rather picky with their accepted
8666 charset. The <filename>special_chars</filename> file contains a
8667 listing of chars not suited for different file format and
8668 provides substitutions. It is written in "Simple Ini" style,
8669 containing a block for every file format.</para>
8671 <para>First entry should be the order of substitution for
8672 entries as a whitespace separated list. All entries are
8673 interpolated, so <literal>\n</literal>, <literal>\x20</literal>
8674 and <literal>\\</literal> all work.</para>
8676 <para>After that every entry is a special char that should be
8677 translated when writing text into such a file.</para>
8679 <para>Example:</para>
8681 <programlisting>[Template/XML]
8682 order=& < > \n
8686 \n=<br></programlisting>
8688 <para>Note the importance of the order in this example.
8689 Substituting < and > befor & would lead to $gt; become
8692 <para>For a list of valid formats, see the German
8693 <filename>special_chars</filename> entry. As of this writing the
8694 following are recognized:</para>
8696 <programlisting>HTML
8701 Template/OpenDocument
8702 filenames</programlisting>
8704 <para>The last of which is very machine dependent. Remember that
8705 a lot of characters are forbidden by some filesystems, for
8706 example MS Windows doesn't like ':' in its files where Linux
8707 doesn't mind that. If you want the files created with your
8708 language pack to be portable, find all chars that could cause
8714 <term>missing</term>
8717 <para>This file is not a part of the language package
8720 <para>This is a file generated by
8721 <command>scripts/locales.pl</command> while processing your
8722 locales. It's only to have the missing entries singled out and
8723 does not belong to a language package.</para>
8731 <para>This file is not a part of the language package
8734 <para>Another file generated by
8735 <command>scripts/locales.pl</command>. If for any reason a
8736 translation does not appear anymore and can be deleted, it gets
8737 moved here. The last 50 or so entries deleted are saved here in
8738 case you made a typo, so that you don't have to translate
8739 everything again. If a tranlsation is missing, the lost file is
8740 checked first. If you maintain a language package, you might
8741 want to keep this safe somewhere.</para>
8746 <term>more/all</term>
8749 <para>This subdir and file is not a part of the language package
8752 <para>If the directory more exists and contains a file called
8753 all it will be parsed in addition to the mandatory all (see
8754 above). The file is useful if you want to change some
8755 translations for the current installation without conflicting
8756 further upgrades. The file is not autogenerated and has the same
8757 format as the all, but needs another key (more_texts). See the
8758 german translation for an example or copy the following code:
8761 # -*- coding: utf-8; -*-
8766 # These are additional texts for custom translations.
8767 # The format is the same as for the normal file all, only
8768 # with another key (more_texts instead of texts).
8769 # The file has the form of 'english text' => 'foreign text',
8771 $self->{more_texts} = {
8773 'Ship via' => 'Terms of delivery',
8774 'Shipping Point' => 'Delivery time',
8776 </programlisting></para>
8783 <sect1 id="devel.testsuite">
8784 <title>Die kivitendo-Test-Suite</title>
8786 <sect2 id="devel.testsuite.intro">
8787 <title>Einführung</title>
8789 <para>kivitendo enthält eine Suite für automatisierte Tests. Sie
8790 basiert auf dem Standard-Perl-Modul
8791 <literal>Test::More</literal>.</para>
8793 <para>Die grundlegenden Fakten sind:</para>
8797 <para>Alle Tests liegen im Unterverzeichnis
8798 <filename>t/</filename>.</para>
8802 <para>Ein Script (bzw. ein Test) in <filename>t/</filename>
8803 enthält einen oder mehrere Testfälle.</para>
8807 <para>Alle Dateinamen von Tests enden auf <literal>.t</literal>.
8808 Es sind selbstständig ausführbare Perl-Scripte.</para>
8812 <para>Die Test-Suite besteht aus der Gesamtheit aller Tests,
8813 sprich aller Scripte in <filename>t/</filename>, deren Dateiname
8814 auf <literal>.t</literal> endet.</para>
8819 <sect2 id="devel.testsuite.prerequisites">
8820 <title>Voraussetzungen</title>
8822 <para>Für die Ausführung werden neben den für kivitendo eh schon
8823 benötigten Module noch weitere Perl-Module benötigt. Diese
8828 <para><literal>Test::Deep</literal> (Debian-Paketname:
8829 <literal>libtest-deep-perl</literal>; Fedora:
8830 <literal>perl-Test-Deep</literal>; openSUSE:
8831 <literal>perl-Test-Deep</literal>)</para>
8835 <para><literal>Test::Exception</literal> (Debian-Paketname:
8836 <literal>libtest-exception-perl</literal>; Fedora:
8837 <literal>perl-Test-Exception</literal>; openSUSE:
8838 <literal>perl-Test-Exception</literal>)</para>
8842 <para><literal>Test::Output</literal> (Debian-Paketname:
8843 <literal>libtest-output-perl</literal>; Fedora:
8844 <literal>perl-Test-Output</literal>; openSUSE:
8845 <literal>perl-Test-Output</literal>)</para>
8849 <para><literal>Test::Harness</literal> 3.0.0 oder höher. Dieses
8850 Modul ist ab Perl 5.10.1 Bestandteil der Perl-Distribution und
8851 kann für frühere Versionen aus dem <ulink
8852 url="http://www.cpan.org">CPAN</ulink> bezogen werden.</para>
8856 <para><literal>LWP::Simple</literal> aus dem Paket
8857 <literal>libwww-perl</literal> (Debian-Panetname:
8858 <literal>libwww-perl</literal>; Fedora:
8859 <literal>perl-libwww-perl</literal>; openSUSE:
8860 <literal>perl-libwww-perl</literal>)</para>
8864 <para><literal>URI::Find</literal> (Debian-Panetname:
8865 <literal>liburi-find-perl</literal>; Fedora:
8866 <literal>perl-URI-Find</literal>; openSUSE:
8867 <literal>perl-URI-Find</literal>)</para>
8871 <para><literal>Sys::CPU</literal> (Debian-Panetname:
8872 <literal>libsys-cpu-perl</literal>; Fedora und openSUSE: nicht
8877 <para><literal>Thread::Pool::Simple</literal> (Debian-Panetname:
8878 <literal>libthread-pool-simple-perl</literal>; Fedora und
8879 openSUSE: nicht vorhanden)</para>
8883 <para>Weitere Voraussetzung ist, dass die Testsuite ihre eigene
8884 Datenbank anlegen kann, um Produktivdaten nicht zu gefährden. Dazu
8885 müssen in der Konfigurationsdatei im Abschnit
8886 <literal>testing/database</literal> Datenbankverbindungsparameter
8887 angegeben werden. Der hier angegebene Benutzer muss weiterhin das
8888 Recht haben, Datenbanken anzulegen und zu löschen.</para>
8890 <para>Der so angegebene Benutzer muss nicht zwingend über
8891 Super-User-Rechte verfügen. Allerdings gibt es einige
8892 Datenbank-Upgrades, die genau diese Rechte benötigen. Für den Fall
8893 kann man in diesem Konfigurationsabschnitt einen weiteren
8894 Benutzeraccount angeben, der dann über Super-User-Rechte verfügt, und
8895 mit dem die betroffenen Upgrades durchgeführt werden. In der
8896 Beispiel-Konfigurationsdatei finden Sie die benötigten
8900 <sect2 id="devel.testsuite.execution">
8901 <title>Existierende Tests ausführen</title>
8903 <para>Es gibt mehrere Möglichkeiten zum Ausführen der Tests: entweder,
8904 man lässt alle Tests auf einmal ausführen, oder man führt gezielt
8905 einzelne Scripte aus. Für beide Fälle gibt es das Helferscript
8906 <filename>t/test.pl</filename>.</para>
8908 <para>Will man die komplette Test-Suite ausführen, so muss man einfach
8909 nur <filename>t/test.pl</filename> ohne weitere Parameter aus dem
8910 kivitendo-Basisverzeichnis heraus ausführen.</para>
8912 <para>Um einzelne Test-Scripte auszuführen, übergibt man deren Namen
8913 an <filename>t/test.pl</filename>. Beispielsweise:</para>
8915 <programlisting>t/test.pl t/form/format_amount.t t/background_job/known_jobs.t</programlisting>
8918 <sect2 id="devel.testsuite.meaning_of_scripts">
8919 <title>Bedeutung der verschiedenen Test-Scripte</title>
8921 <para>Die Test-Suite umfasst Tests sowohl für Funktionen als auch für
8922 Programmierstil. Einige besonders zu erwähnende, weil auch während der
8923 Entwicklung nützliche Tests sind:</para>
8927 <para><filename>t/001compile.t</filename> -- compiliert alle
8928 Quelldateien und bricht bei Fehlern sofort ab</para>
8932 <para><filename>t/002goodperl.t</filename> -- überprüft alle
8933 Perl-Dateien auf Anwesenheit von '<literal>use
8934 strict</literal>'-Anweisungen</para>
8938 <para><filename>t/003safesys.t</filename> -- überprüft Aufrufe von
8939 <function>system()</function> und <function>exec()</function> auf
8944 <para><filename>t/005no_tabs.t</filename> -- überprüft, ob Dateien
8945 Tab-Zeichen enthalten</para>
8949 <para><filename>t/006spelling.t</filename> -- sucht nach häufigen
8950 Rechtschreibfehlern</para>
8954 <para><filename>t/011pod.t</filename> -- überprüft die Syntax von
8955 Dokumentation im POD-Format auf Gültigkeit</para>
8959 <para>Weitere Test-Scripte überprüfen primär die Funktionsweise
8960 einzelner Funktionen und Module.</para>
8963 <sect2 id="devel.testsuite.create_new">
8964 <title>Neue Test-Scripte erstellen</title>
8966 <para>Es wird sehr gern gesehen, wenn neue Funktionalität auch gleich
8967 mit einem Test-Script abgesichert wird. Auch bestehende Funktion darf
8968 und soll ausdrücklich nachträglich mit Test-Scripten abgesichert
8971 <sect3 id="devel.testsuite.ideas_for_non_function_tests">
8972 <title>Ideen für neue Test-Scripte, die keine konkreten Funktionen
8975 <para>Ideen, die abgesehen von Funktionen noch nicht umgesetzt
8980 <para>Überprüfung auf fehlende symbolische Links</para>
8984 <para>Suche nach Nicht-ASCII-Zeichen in Perl-Code-Dateien (mit
8985 gewissen Einschränkungen wie das Erlauben von deutschen
8990 <para>Test auf DOS-Zeilenenden (\r\n anstelle von nur \n)</para>
8994 <para>Überprüfung auf Leerzeichen am Ende von Zeilen</para>
8998 <para>Test, ob alle zu übersetzenden Strings in
8999 <filename>locale/de/all</filename> vorhanden sind</para>
9003 <para>Test, ob alle Webseiten-Templates in
9004 <filename>templates/webpages</filename> mit vom Perl-Modul
9005 <literal>Template</literal> compiliert werden können</para>
9010 <sect3 id="devel.testsuite.directory_and_test_names">
9011 <title>Konvention für Verzeichnis- und Dateinamen</title>
9013 <para>Es gibt momentan eine wenige Richtlinien, wie Test-Scripte zu
9014 benennen sind. Bitte die folgenden Punkte als Richtlinie betrachten
9015 und ihnen soweit es geht folgen:</para>
9019 <para>Die Dateiendung muss <filename>.t</filename>
9024 <para>Namen sind englisch, komplett klein geschrieben und
9025 einzelne Wörter mit Unterstrichten getrennt (beispielsweise
9026 <filename>bad_function_params.t</filename>).</para>
9030 <para>Unterverzeichnisse sollten grob nach dem Themenbereich
9031 benannt sein, mit dem sich die Scripte darin befassen
9032 (beispielsweise <filename>background_jobs</filename> für Tests
9033 rund um Hintergrund-Jobs).</para>
9037 <para>Test-Scripte sollten einen überschaubaren Bereich von
9038 Funktionalität testen, der logisch zusammenhängend ist (z.B. nur
9039 Tests für eine einzelne Funktion in einem Modul). Lieber mehrere
9040 Test-Scripte schreiben.</para>
9045 <sect3 id="devel.testsuite.minimal_example">
9046 <title>Minimales Skelett für eigene Scripte</title>
9048 <para>Der folgenden Programmcode enthält das kleinstmögliche
9049 Testscript und kann als Ausgangspunkt für eigene Tests verwendet
9052 <programlisting>use Test::More tests => 0;
9056 use Support::TestSetup;
9058 Support::TestSetup::login();</programlisting>
9060 <para>Wird eine vollständig initialisierte kivitendo-Umgebung
9061 benötigt (Stichwort: alle globalen Variablen wie
9062 <varname>$::auth</varname>, <varname>$::form</varname> oder
9063 <varname>$::lxdebug</varname>), so muss in der Konfigurationsdatei
9064 <filename>config/kivitendo.conf</filename> im Abschnitt
9065 <literal>testing.login</literal> ein gültiger Login-Name eingetragen
9066 sein. Dieser wird für die Datenbankverbindung benötigt.</para>
9068 <para>Wir keine vollständig initialisierte Umgebung benötigt, so
9069 kann die letzte Zeile <programlisting>Support::TestSetup::login();</programlisting>
9070 weggelassen werden, was die Ausführungszeit des Scripts leicht
9076 <sect1 id="devel.style-guide">
9077 <title>Stil-Richtlinien</title>
9079 <para>Die folgenden Regeln haben das Ziel, den Code möglichst gut les-
9080 und wartbar zu machen. Dazu gehört zum Einen, dass der Code einheitlich
9081 eingerückt ist, aber auch, dass Mehrdeutigkeit so weit es geht vermieden
9082 wird (Stichworte "Klammern" oder "Hash-Keys").</para>
9084 <para>Diese Regeln sind keine Schikane sondern erleichtern allen das
9087 <para>Jeder, der einen Patch schickt, sollte seinen Code vorher
9088 überprüfen. Einige der Regeln lassen sich automatisch überprüfen, andere
9093 <para>Es werden keine echten Tabs sondern Leerzeichen
9098 <para>Die Einrückung beträgt zwei Leerzeichen. Beispiel:</para>
9100 <programlisting>foreach my $row (@data) {
9102 # do something with $row
9106 $row->{modules} = MODULE->retrieve(
9107 id => $row->{id},
9108 date => $use_now ? localtime() : $row->{time},
9112 $report->add($row);
9117 <para>Öffnende geschweifte Klammern befinden sich auf der gleichen
9118 Zeile wie der letzte Befehl. Beispiele:</para>
9120 <programlisting>sub debug {
9126 <programlisting>if ($form->{item_rows} > 0) {
9132 <para>Schließende geschweifte Klammern sind so weit eingerückt wie
9133 der Befehl / die öffnende schließende Klammer, die den Block
9134 gestartet hat, und nicht auf der Ebene des Inhalts. Die gleichen
9135 Beispiele wie bei 3. gelten.</para>
9139 <para>Die Wörter "<function>else</function>",
9140 "<function>elsif</function>", "<function>while</function>" befinden
9141 sich auf der gleichen Zeile wie schließende geschweifte Klammern.
9144 <programlisting>if ($form->{sum} > 1000) {
9146 } elsif ($form->{sum} > 0) {
9154 } until ($a > 0);</programlisting>
9158 <para>Parameter von Funktionsaufrufen müssen mit runden Klammern
9159 versehen werden. Davon nicht betroffen sind interne Perl-Funktionen,
9160 und grep-ähnliche Operatoren. Beispiel:</para>
9162 <programlisting>$main::lxdebug->message("Could not find file.");
9163 %options = map { $_ => 1 } grep { !/^#/ } @config_file;</programlisting>
9167 <para>Verschiedene Klammern, Ihre Ausdrücke und Leerzeichen:</para>
9169 <para>Generell gilt: Hashkeys und Arrayindices sollten nicht durch
9170 Leerzeichen abgesetzt werden. Logische Klammerungen ebensowenig,
9171 Blöcke schon. Beispiel:</para>
9173 <programlisting>if (($form->{debug} == 1) && ($form->{sum} - 100 < 0)) {
9178 $form->{sum} += $form->{"row_$i"};
9179 $form->{ $form->{index} } += 1;
9181 map { $form->{sum} += $form->{"row_$_"} } 1..$rowcount;</programlisting>
9185 <para>Mehrzeilige Befehle</para>
9189 <para>Werden die Parameter eines Funktionsaufrufes auf mehrere
9190 Zeilen aufgeteilt, so sollten diese bis zu der Spalte eingerückt
9191 werden, in der die ersten Funktionsparameter in der ersten Zeile
9192 stehen. Beispiel:</para>
9194 <programlisting>$sth = $dbh->prepare("SELECT * FROM some_table WHERE col = ?",
9195 $form->{some_col_value});</programlisting>
9199 <para>Ein Spezialfall ist der ternäre Operator "?:", der am
9200 besten in einer übersichtlichen Tabellenstruktur organisiert
9201 wird. Beispiel:</para>
9203 <programlisting>my $rowcount = $form->{"row_$i"} ? $i
9204 : $form->{oldcount} ? $form->{oldcount} + 1
9205 : $form->{rowcount} - $form->{rowbase};</programlisting>
9211 <para>Kommentare</para>
9215 <para>Kommentare, die alleine in einer Zeile stehen, sollten
9216 soweit wie der Code eingerückt sein.</para>
9220 <para>Seitliche hängende Kommentare sollten einheitlich
9221 formatiert werden.</para>
9225 <para>Sämtliche Kommentare und Sonstiges im Quellcode ist bitte
9226 auf Englisch zu verfassen. So wie ich keine Lust habe,
9227 französischen Quelltext zu lesen, sollte auch der kivitendo
9228 Quelltext für nicht-Deutschsprachige lesbar sein.
9231 <programlisting>my $found = 0;
9239 $i = 0 # initialize $i
9241 $i *= $const; # do something crazy
9242 $i = $n; # recover $i</programlisting>
9248 <para>Hashkeys sollten nur in Anführungszeichen stehen, wenn die
9249 Interpolation gewünscht ist. Beispiel:</para>
9251 <programlisting>$form->{sum} = 0;
9252 $form->{"row_$i"} = $form->{"row_$i"} - 5;
9253 $some_hash{42} = 54;</programlisting>
9257 <para>Die maximale Zeilenlänge ist nicht beschränkt. Zeilenlängen
9258 unterhalb von 79 Zeichen helfen unter bestimmten Bedingungen, aber
9259 wenn die Lesbarkeit unter kurzen Zeilen leidet (wie zum Biespiel in
9260 grossen Tabellen), dann ist Lesbarkeit vorzuziehen.</para>
9262 <para>Als Beispiel sei die Funktion
9263 <function>print_options</function> aus
9264 <filename>bin/mozilla/io.pl</filename> angeführt.</para>
9268 <para>Trailing Whitespace, d.h. Leerzeichen am Ende von Zeilen sind
9269 unerwünscht. Sie führen zu unnötigen Whitespaceänderungen, die diffs
9272 <para>Emacs und vim haben beide recht einfache Methoden zur
9273 Entfernung von trailing whitespace. Emacs kennt das Kommande
9274 <command>nuke-trailing-whitespace</command>, vim macht das gleiche
9275 manuell über <literal>:%s/\s\+$//e</literal> Mit <literal>:au
9276 BufWritePre * :%s/\s\+$//e</literal> wird das an Speichern
9281 <para>Es wird kein <command>perltidy</command> verwendet.</para>
9283 <para>In der Vergangenheit wurde versucht,
9284 <command>perltidy</command> zu verwenden, um einen einheitlichen
9285 Stil zu erlangen. Es hat sich aber gezeigt, dass
9286 <command>perltidy</command>s sehr eigenwilliges Verhalten, was
9287 Zeilenumbrüche angeht, oftmals gut formatierten Code zerstört. Für
9288 den Interessierten sind hier die
9289 <command>perltidy</command>-Optionen, die grob den beschriebenen
9290 Richtlinien entsprechen:</para>
9292 <programlisting>-syn -i=2 -nt -pt=2 -sbt=2 -ci=2 -ibc -hsc -noll -nsts -nsfs -asc -dsm
9293 -aws -bbc -bbs -bbb -mbl=1 -nsob -ce -nbl -nsbl -cti=0 -bbt=0 -bar -l=79
9294 -lp -vt=1 -vtc=1</programlisting>
9298 <para><varname>STDERR</varname> ist tabu. Unkonditionale
9299 Debugmeldungen auch.</para>
9301 <para>kivitendo bietet mit dem Modul <classname>LXDebug</classname>
9302 einen brauchbaren Trace-/Debug-Mechanismus. Es gibt also keinen
9303 Grund, nach <varname>STDERR</varname> zu schreiben.</para>
9305 <para>Die <classname>LXDebug</classname>-Methode
9306 "<function>message</function>" nimmt als ersten Paramter außerdem
9307 eine Flagmaske, für die die Meldung angezeigt wird, wobei "0" immer
9308 angezeigt wird. Solche Meldungen sollten nicht eingecheckt werden
9309 und werden in den meisten Fällen auch vom Repository
9310 zurückgewiesen.</para>
9314 <para>Alle neuen Module müssen use strict verwenden.</para>
9316 <para><varname>$form</varname>, <varname>$auth</varname>,
9317 <varname>$locale</varname>, <varname>$lxdebug</varname> und
9318 <varname>%myconfig</varname> werden derzeit aus dem main package
9319 importiert (siehe <xref linkend="devel.globals"/>. Alle anderen
9320 Konstrukte sollten lexikalisch lokal gehalten werden.</para>
9325 <sect1 id="devel.build-doc" xreflabel="Dokumentation erstellen">
9326 <title>Dokumentation erstellen</title>
9328 <sect2 id="devel.build-doc.introduction">
9329 <title>Einführung</title>
9331 <para>Diese Dokumentation ist in <productname>DocBook</productname>
9332 XML geschrieben. Zum Bearbeiten reicht grundsätzlich ein Text-Editor.
9333 Mehr Komfort bekommt man, wenn man einen dedizierten XML-fähigen
9334 Editor nutzt, der spezielle Unterstützung für
9335 <productname>DocBook</productname> mitbringt. Wir empfehlen dafür den
9336 <ulink url="http://www.xmlmind.com/xmleditor/">XMLmind XML
9337 Editor</ulink>, der bei nicht kommerzieller Nutzung kostenlos
9341 <sect2 id="devel.build-doc.required-software">
9342 <title>Benötigte Software</title>
9344 <para>Bei <productname>DocBook</productname> ist Prinzip, dass
9345 ausschließlich die XML-Quelldatei bearbeitet wird. Aus dieser werden
9346 dann mit entsprechenden Stylesheets andere Formate wie PDF oder HTML
9347 erzeugt. Bei kivitendo übernimmt diese Aufgabe das Shell-Script
9348 <command>scripts/build_doc.sh</command>.</para>
9350 <para>Das Script benötigt zur Konvertierung verschiedene
9351 Softwarekomponenten, die im normalen kivitendo-Betrieb nicht benötigt
9357 url="http://www.oracle.com/technetwork/java/index.html">Java</ulink>
9358 in einer halbwegs aktuellen Version</para>
9362 <para>Das Java-Build-System <ulink
9363 url="http://ant.apache.org/">Apache Ant</ulink></para>
9367 <para>Das Dokumentations-System Dobudish für
9368 <productname>DocBook</productname> 4.5, eine Zusammenstellung
9369 diverser Stylesheets und Grafiken zur Konvertierung von
9370 <productname>DocBook</productname> XML in andere Formate. Das
9371 Paket, das benötigt wird, ist zum Zeitpunkt der
9372 Dokumentationserstellung
9373 <filename>dobudish-nojre-1.1.4.zip</filename>, aus auf <ulink
9374 url="http://code.google.com/p/dobudish/downloads/list">code.google.com</ulink>
9379 <para>Apache Ant sowie ein dazu passendes Java Runtime Environment
9380 sind auf allen gängigen Plattformen verfügbar. Beispiel für
9381 Debian/Ubuntu:</para>
9383 <programlisting>apt-get install ant openjdk-7-jre</programlisting>
9385 <para>Nach dem Download von Dobudish muss Dobudish im Unterverzeichnis
9386 <filename>doc/build</filename> entpackt werden. Beispiel unter der
9387 Annahme, das <productname>Dobudish</productname> in
9388 <filename>$HOME/Downloads</filename> heruntergeladen wurde:</para>
9390 <programlisting>cd doc/build
9391 unzip $HOME/Downloads/dobudish-nojre-1.1.4.zip</programlisting>
9394 <sect2 id="devel.build-doc.build">
9395 <title>PDFs und HTML-Seiten erstellen</title>
9397 <para>Die eigentliche Konvertierung erfolgt nach Installation der
9398 benötigten Software mit einem einfachen Aufruf direkt aus dem
9399 kivitendo-Installationsverzeichnis heraus:</para>
9401 <programlisting>./scripts/build_doc.sh</programlisting>
9404 <sect2 id="devel.build-doc.repository">
9405 <title>Einchecken in das Git-Repository</title>
9407 <para>Sowohl die XML-Datei als auch die erzeugten PDF- und
9408 HTML-Dateien sind Bestandteil des Git-Repositories. Daraus folgt, dass
9409 nach Änderungen am XML die PDF- und HTML-Dokumente ebenfalls gebaut
9410 und alles zusammen in einem Commit eingecheckt werden sollten.</para>
9412 <para>Die "<filename>dobudish</filename>"-Verzeichnisse bzw.
9413 symbolischen Links gehören hingegen nicht in das Repository.</para>