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>IPC::Run</literal></para>
277 <para><literal>JSON</literal></para>
281 <para><literal>List::MoreUtils</literal></para>
285 <para><literal>List::UtilsBy</literal></para>
289 <para>LWP::Authen::Digest</para>
293 <para>LWP::UserAgent</para>
297 <para><literal>Net::SMTP::SSL</literal> (optional, bei
298 E-Mail-Versand über SSL; siehe Abschnitt "<xref
299 linkend="config.sending-email.smtp"/>")</para>
303 <para><literal>Net::SSLGlue</literal> (optional, bei
304 E-Mail-Versand über TLS; siehe Abschnitt "<xref
305 linkend="config.sending-email.smtp"/>")</para>
309 <para><literal>Math::Round</literal></para>
313 <para><literal>Params::Validate</literal></para>
317 <para><literal>PBKDF2::Tiny</literal></para>
321 <para><literal>PDF::API2</literal></para>
325 <para><literal>Regexp::IPv6</literal></para>
329 <para><literal>Rest::Client</literal></para>
333 <para><literal>Rose::Object</literal></para>
337 <para><literal>Rose::DB</literal></para>
341 <para><literal>Rose::DB::Object</literal> Version 0.788 oder
346 <para><literal>Set::Infinite</literal></para>
350 <para><literal>String::ShellQuote</literal></para>
354 <para><literal>Sort::Naturally</literal></para>
358 <para><literal>Template</literal></para>
362 <para><literal>Text::CSV_XS</literal></para>
366 <para><literal>Text::Iconv</literal></para>
370 <para><literal>Text::Unidecode</literal></para>
374 <para><literal>Try::Tiny</literal></para>
378 <para><literal>URI</literal></para>
382 <para><literal>XML::Writer</literal></para>
386 <para><literal>XML::LibXML</literal></para>
390 <para><literal>YAML::XS</literal> oder <literal>YAML</literal></para>
395 <para>Seit Version größer v3.6.0 sind die folgenden Pakete hinzugekommen: <literal>IPC::Run</literal></para>
397 <para>Seit Version größer v3.5.8 sind die folgenden Pakete hinzugekommen: <literal>Imager</literal>, <literal>Imager::QRCode</literal>
398 <literal>Rest::Client</literal><literal>Term::ReadLine::Gnu</literal></para>
400 <para>Seit Version größer v3.5.6 sind die folgenden Pakete hinzugekommen: <literal>Try::Tiny</literal>, <literal>Math::Round</literal></para>
401 <para>Seit Version größer v3.5.6 sind die folgenden Pakete hinzugekommen: <literal>XML::LibXML</literal>, <literal>CAM::PDF</literal></para>
402 <para>Seit Version größer v3.5.3 sind die folgenden Pakete hinzugekommen: <literal>Exception::Class</literal></para>
404 <para>Seit Version größer v3.5.1 sind die folgenden Pakete hinzugekommen: <literal>Set::Infinite</literal>,
405 <literal>List::UtilsBy</literal>, <literal>DateTime::Set</literal>, <literal>DateTime::Event::Cron</literal>
406 <literal>Daemon::Generic</literal>, <literal>DateTime::Event::Cron</literal>, <literal>File::Flock</literal>,
407 <literal>File::Slurp</literal></para>
409 <para>Seit Version größer v3.5.0 sind die folgenden Pakete
410 hinzugekommen: <literal>Text::Unidecode</literal>,
411 <literal>LWP::Authen::Digest</literal>,
412 <literal>LWP::UserAgent</literal></para>
414 <para>Seit Version v3.4.0 sind die folgenden Pakete hinzugekommen:
415 <literal>Algorithm::CheckDigits</literal>,
416 <literal>PBKDF2::Tiny</literal></para>
418 <para>Seit Version v3.2.0 sind die folgenden Pakete hinzugekommen:
419 <literal>GD</literal>, <literal>HTML::Restrict</literal>,
420 <literal>Image::Info</literal></para>
422 <para>Seit v3.0.0 sind die folgenden Pakete hinzugekommen:
423 <literal>File::Copy::Recursive</literal>.</para>
425 <para>Seit v2.7.0 sind die folgenden Pakete hinzugekommen:
426 <literal>Email::MIME</literal>, <literal>Net::SMTP::SSL</literal>,
427 <literal>Net::SSLGlue</literal>.</para>
429 <para>Gegenüber Version 2.6.0 sind zu dieser Liste 2 Pakete
430 hinzugekommen, <literal>URI</literal> und
431 <literal>XML::Writer</literal> sind notwendig. Ohne startet kivitendo
434 <para>Gegenüber Version 2.6.1 sind <literal>parent</literal>,
435 <literal>DateTime</literal>, <literal>Rose::Object</literal>,
436 <literal>Rose::DB</literal> und <literal>Rose::DB::Object</literal>
437 neu hinzugekommen. <literal>IO::Wrap</literal> wurde entfernt.</para>
439 <para>Gegenüber Version 2.6.3 ist <literal>JSON</literal> neu
440 hinzugekommen.</para>
442 <para><literal>Email::Address</literal> und
443 <literal>List::MoreUtils</literal> sind schon länger feste
444 Abhängigkeiten, wurden aber bisher mit kivitendo mitgeliefert. Beide
445 sind auch in 2.6.1 weiterhin mit ausgeliefert, wurden in einer
446 zukünftigen Version aber aus dem Paket entfernt werden. Es wird
447 empfohlen diese Module zusammen mit den anderen als Bibliotheken zu
451 <title>Debian und Ubuntu</title>
452 <para>Für Debian und Ubuntu stehen die meisten der benötigten
453 Pakete als Debian-Pakete zur Verfügung. Sie können mit
454 folgendem Befehl installiert werden:</para>
456 <programlisting>apt install apache2 libarchive-zip-perl libclone-perl \
457 libconfig-std-perl libdatetime-perl libdbd-pg-perl libdbi-perl \
458 libemail-address-perl libemail-mime-perl libfcgi-perl libjson-perl \
459 liblist-moreutils-perl libnet-smtp-ssl-perl libnet-sslglue-perl \
460 libparams-validate-perl libpdf-api2-perl librose-db-object-perl \
461 librose-db-perl librose-object-perl libsort-naturally-perl \
462 libstring-shellquote-perl libtemplate-perl libtext-csv-xs-perl \
463 libtext-iconv-perl liburi-perl libxml-writer-perl libyaml-perl \
464 libimage-info-perl libgd-gd2-perl libapache2-mod-fcgid \
465 libfile-copy-recursive-perl postgresql libalgorithm-checkdigits-perl \
466 libcrypt-pbkdf2-perl git libcgi-pm-perl libtext-unidecode-perl libwww-perl \
467 postgresql-contrib poppler-utils libhtml-restrict-perl \
468 libdatetime-set-perl libset-infinite-perl liblist-utilsby-perl \
469 libdaemon-generic-perl libfile-flock-perl libfile-slurp-perl \
470 libfile-mimeinfo-perl libpbkdf2-tiny-perl libregexp-ipv6-perl \
471 libdatetime-event-cron-perl libexception-class-perl libcam-pdf-perl \
472 libxml-libxml-perl libtry-tiny-perl libmath-round-perl \
473 libimager-perl libimager-qrcode-perl librest-client-perl libipc-run-perl
476 <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>
477 <note id="ubuntu-universe">
478 <para>Die Perl Pakete für Ubuntu befinden sich im "Universe" Repository. Falls dies nicht aktiv ist, kann dies mit folgendem Aufruf aktiviert werden:
479 <programlisting>add-apt-repository universe</programlisting></para>
484 <title>Fedora</title>
486 <para>Für Fedora stehen die meisten der benötigten Perl-Pakete als
487 RPM-Pakete zur Verfügung. Sie können mit folgendem Befehl
488 installiert werden:</para>
490 <programlisting>dnf install httpd mod_fcgid postgresql-server postgresql-contrib\
491 perl-Algorithm-CheckDigits perl-Archive-Zip perl-CPAN perl-Class-XSAccessor \
492 perl-Clone perl-Config-Std perl-DBD-Pg perl-DBI perl-Daemon-Generic \
493 perl-DateTime perl-DateTime-Set perl-Email-Address perl-Email-MIME perl-FCGI \
494 perl-File-Copy-Recursive perl-File-Flock perl-File-MimeInfo perl-File-Slurp \
495 perl-GD perl-HTML-Restrict perl-JSON perl-List-MoreUtils perl-List-UtilsBy \
496 perl-Net-SMTP-SSL perl-Net-SSLGlue perl-PBKDF2-Tiny perl-PDF-API2 \
497 perl-Params-Validate perl-Regexp-IPv6 perl-Rose-DB perl-Rose-DB-Object \
498 perl-Rose-Object perl-Sort-Naturally perl-String-ShellQuote \
499 perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv perl-URI perl-XML-Writer \
500 perl-YAML perl-libwww-perl</programlisting>
504 <title>openSUSE Leap 15.x und SUSE Linux Enterprise Server 15 GA</title>
506 <para>Für openSUSE Leap 15.x stehen die meisten der benötigten Perl-Pakete als RPM-Pakete zur Verfügung.</para>
507 <para>Damit diese installiert werden können, muß das System die erforderlichen Repositories kennen und Zugriff über das Internet darauf haben.</para>
508 <para>Daher machen wir die Repositories dem System bekannt.</para>
509 <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>
510 <para>Dazu geben wir folgenden Befehl ein:</para>
511 <programlisting>zypper addrepo -f \
512 http://download.opensuse.org/repositories/devel:languages:perl/openSUSE_Leap_15.2/ \
513 "devel:languages:perl"
515 <programlisting>zypper addrepo -f \
516 https://download.opensuse.org/repositories/devel:languages:haskell:lts:13/\
517 openSUSE_Leap_15.0/ "devel:languages:haskell:lts:13"
519 <programlisting>zypper addrepo -f \
520 https://download.opensuse.org/repositories/devel:languages:haskell:lts:13/\
521 openSUSE_Leap_15.0/ "devel:languages:haskell:lts:13"
523 <para>Danach geben wir noch die beiden folgenden Befehle ein:</para>
524 <programlisting>zypper clean</programlisting>
525 <programlisting>zypper refresh</programlisting>
526 <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>
527 <programlisting>zypper --help</programlisting>
529 <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>
531 <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>
532 <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>
533 <para>yast2 return.</para>
534 <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>
535 <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>
536 <para>Programmpakete können mit folgendem Befehl installiert werden:</para>
537 <para>zypper install Paketname</para>
538 <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>
540 <programlisting>zypper install perl-threads-shared ghc-pdfinfo apache2-mod_fcgid \
541 yast2-http-server postgresql-server postgresql-contrib perl-Algorithm-CheckDigits \
542 perl-Archive-Zip perl-CGI perl-CGI-Ajax perl-Clone \
543 perl-Config-Std perl-Class-XSAccessor perl-Daemon-Generic perl-DateTime \
544 perl-DateTime-Event-Cron perl-DateTime-Format-Strptime perl-DateTime-Set \
545 perl-DBI perl-DBD-Pg perl-Devel-REPL perl-FastCGI perl-Email-Address \
546 perl-Email-MIME perl-Email-MIME-ContentType perl-Email-MIME-Encodings \
547 perl-FCGI perl-File-Copy-Recursive perl-File-Flock perl-File-MimeInfo \
548 perl-File-Slurp perl-GD perl-HTML-Restrict perl-Image-Info \
549 perl-JSON perl-List-MoreUtils perl-List-UtilsBy perl-Log-Log4perl perl-Net-LDAP-Server \
550 perl-Net-SSLGlue perl-Net-SMTP-SSL perl-PBKDF2-Tiny perl-PDF-API2 \
551 perl-Params-Validate perl-Regexp-IPv6 perl-Rose-DB perl-Rose-Object \
552 perl-Rose-DB-Object perl-MooseX-Role-Cmd perl-Set-Crontab perl-Set-Infinite \
553 perl-Sort-Naturally perl-String-ShellQuote perl-Sys-CPU perl-Template-Toolkit \
554 perl-Text-CSV_XS perl-Test-Deep perl-Test-Output perl-Text-Iconv \
555 perl-Text-Unidecode perl-URI perl-URI-Find perl-XML-Writer \
556 perl-YAML perl-libwww-perl
559 <para>Für die Entwickler installiert man noch die folgenden Pakete:</para>
561 <programlisting>zypper install ghc-mtl-devel ghc-old-locale-devel \
562 ghc-process-extras-devel ghc-rpm-macros ghc-text-devel ghc-time-devel \
563 ghc-Cabal-devel ghc-time-locale-compat-devel perl-Log-Log4perl ghc-pdfinfo \
564 ghc-pdfinfo-devel perl-Devel-REPL perl-URI-Find perl-Class-Utils \
565 perl-Error-Pure perl-File-Object perl-Readonly perl-Test-Warnings \
566 perl-Test-NoWarnings perl-Test-Deep perl-Test-Output perl-Test-Strict \
567 perl-Test-LongString perl-File-Find-Rule
570 <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.
571 Dazu können Sie die folgenden Befehle nutzen:</para>
573 <programlisting>zypper install texlive-wallpaper texlive-colortbl \
574 texlive-scrlttr2copy texlive-eurosym \
575 texlive-geometry texlive-german texlive-graphbox texlive-hyperref \
576 texlive-xifthen texlive-luainputenc texlive-lastpage texlive-ltabptch \
577 texlive-nomentbl texlive-threeparttablex texlive-substr texlive-tabulary \
578 texlive-ulem texlive-wallpaper texlive-xcolor texlive-xstring \
579 texlive-xypic texlive-mwe texlive-mweights texlive-barcodes \
580 texlive-GS1 texlive-ean texlive-makebarcode texlive-pst-barcode \
584 <para>Zusätzlich müssen einige Pakete aus dem CPAN installiert
585 werden. Dazu können Sie die folgenden Befehle anwenden:</para>
587 <programlisting>cpan DateTime::event::Cron DateTime::Set FCGI \
588 HTML::Restrict PBKDF2::Tiny Rose::Db::Object Set::Infinite</programlisting>
593 <title>Andere Pakete installieren</title>
597 <para><literal>poppler-utils</literal> 'pdfinfo' zum Erkennen der Seitenanzahl bei der PDF-Generierung</para>
600 <para><literal>Postgres Trigram-Index</literal> Für datenbankoptimierte Suchanfragen. Bspw. im Paket <literal>postgresql-contrib</literal> enthalten</para>
603 <para>Debian und Ubuntu: <programlisting>apt install postgresql-contrib poppler-utils</programlisting></para>
604 <para>Fedora: <programlisting>dnf install poppler-utils postgresql-contrib</programlisting></para>
605 <para>openSUSE: <programlisting>zypper install poppler-tools</programlisting></para>
609 <sect1 id="Manuelle-Installation-des-Programmpaketes"
610 xreflabel="Manuelle Installation des Programmpaketes">
611 <title>Manuelle Installation des Programmpaketes</title>
613 <para>Der aktuelle Stable-Release, bzw. beta Release wird bei github
614 gehostet und kann <ulink
615 url="https://github.com/kivitendo/kivitendo-erp/releases">hier</ulink>
616 heruntergeladen werden.</para>
618 <para>Das aktuelleste kivitendo ERP-Archiv
619 (<filename>kivitendo-erp-*.tgz</filename>) wird dann im
620 Dokumentenverzeichnis des Webservers (z.B.
621 <filename>/var/www/html/</filename>,
622 <filename>/srv/www/htdocs</filename> oder
623 <filename>/var/www/</filename>) entpackt:</para>
625 <programlisting>cd /var/www
626 tar xvzf kivitendo-erp-*.tgz</programlisting>
628 <para>Wechseln Sie in das entpackte Verzeichnis:</para>
630 <programlisting>cd kivitendo-erp</programlisting>
632 <para>Alternativ können Sie auch einen Alias in der
633 Webserverkonfiguration benutzen, um auf das tatsächliche
634 Installationsverzeichnis zu verweisen.</para>
636 <para>Bei einer Neuinstallation von Version 3.1.0 oder später muß das
637 WebDAV Verzeichnis derzeit manuell angelegt werden:</para>
639 <programlisting>mkdir webdav</programlisting>
641 <para>Die Verzeichnisse <filename>users</filename>,
642 <filename>spool</filename> und <filename>webdav</filename> müssen für
643 den Benutzer beschreibbar sein, unter dem der Webserver läuft. Die
644 restlichen Dateien müssen für diesen Benutzer lesbar sein. Die Benutzer-
645 und Gruppennamen sind bei verschiedenen Distributionen unterschiedlich
646 (z.B. bei Debian/Ubuntu <constant>www-data</constant>, bei Fedora
647 <constant>apache</constant> oder bei openSUSE
648 <constant>wwwrun</constant>).</para>
650 <para>Der folgende Befehl ändert den Besitzer für die oben genannten
651 Verzeichnisse auf einem Debian/Ubuntu-System:</para>
653 <programlisting>chown -R www-data users spool webdav</programlisting>
655 <para>Weiterhin muss der Webserver-Benutzer in den Verzeichnissen
656 <filename>templates</filename> und <filename>users</filename>
657 Unterverzeichnisse für jeden neuen Benutzer anlegen dürfen, der in
658 kivitendo angelegt wird:</para>
660 <programlisting>chown www-data templates users</programlisting>
663 <para>Wir empfehlen eine Installation mittels des Versionsmanagager
664 git. Hierfür muss ein git-Client installiert sein. Damit ist man sehr
665 viel flexibler für zukünftige Upgrades. Installations-Anleitung (bitte
666 die Pfade anpassen) bspw. wie folgt: <programlisting>cd /var/www/
667 git clone https://github.com/kivitendo/kivitendo-erp.git
669 git checkout `git tag -l | egrep -ve "(alpha|beta|rc)" | tail -1`</programlisting>
670 Erläuterung: Der Befehl wechselt zur letzten Stable-Version (git tag
671 -l listet alle Tags auf, das egrep schmeisst alle Einträge mit alpha,
672 beta oder rc raus und das tail gibt davon den obersten Treffer
673 zurück). Sehr sinnvoll ist es, direkt im Anschluss einen eigenen
674 Branch zu erzeugen, um bspw. seine eigenen Druckvorlagen-Anpassungen
675 damit zu verwalten. Hierfür reicht ein simples <programlisting> git checkout -b meine_eigenen_änderungen</programlisting>
676 nach dem letzten Kommando (weiterführende Informationen <ulink
677 url="http://www-cs-students.stanford.edu/~blynn/gitmagic/index.html">
678 Git Magic</ulink>).</para>
680 <para>Ein beispielhafter Workflow für Druckvorlagen-Anpassungen von
681 3.4.1 nach 3.5: <programlisting>
682 $ git clone https://github.com/kivitendo/kivitendo-erp.git
684 $ git checkout release-3.4.1 # das ist ein alter release aus dem wir starten ...
685 $ git checkout -b meine_eigene_änderungen # unser lokaler branch - unabhängig von allen anderen
686 $ git add templates/mein_druck # das sind unsere druckvorlagen inkl. produktbilder
687 $ git commit -m "juhu tolle änderungen"
689 [meine_aenderungen 1d89e41] juhu tolle ändernungen
690 4 files changed, 380 insertions(+)
691 create mode 100644 templates/mein_druck/img/webdav/tesla.png
692 create mode 100644 templates/mein_druck/mahnung.tex
693 create mode 100644 templates/mein_druck/zahlungserinnerung_zwei.tex
694 create mode 100644 templates/mein_druck/zahlungserinnerung_zwei_invoice.tex
697 # webserver abschalten!
699 $ git checkout master
700 $ git pull # oder git fetch und danach ein stable release tag auswählen (s.o.)
701 $ git checkout meine_eigenen_änderungen
704 Zunächst wird der Branch zurückgespult, um Ihre Änderungen
705 darauf neu anzuwenden ...
706 Wende an: juhu tolle änderungen
707 $ service apache2 restart # webserver starten!
708 </programlisting></para>
712 <sect1 id="config.config-file">
713 <title>kivitendo-Konfigurationsdatei</title>
715 <sect2 id="config.config-file.introduction"
716 xreflabel="Einführung in die Konfigurationsdatei">
717 <title>Einführung</title>
719 <para>In kivitendo gibt es nur noch eine Konfigurationsdatei, die
720 benötigt wird: <filename>config/kivitendo.conf</filename> (kurz: "die
721 Hauptkonfigurationsdatei"). Diese muss bei der Erstinstallation von
722 kivitendo bzw. der Migration von älteren Versionen angelegt
725 <para>Als Vorlage dient die Datei
726 <filename>config/kivitendo.conf.default</filename> (kurz: "die
727 Default-Datei"):</para>
729 <programlisting>$ cp config/kivitendo.conf.default config/kivitendo.conf</programlisting>
731 <para>Die Default-Datei wird immer zuerst eingelesen. Werte, die in
732 der Hauptkonfigurationsdatei stehen, überschreiben die Werte aus der
733 Default-Datei. Die Hauptkonfigurationsdatei muss also nur die
734 Abschnitte und Werte enthalten, die von denen der Default-Datei
738 <para>Vor der Umbenennung in kivitendo hieß diese Datei noch
739 <filename>config/lx_office.conf</filename>. Aus Gründen der
740 Kompatibilität wird diese Datei eingelesen, sofern die Datei
741 <filename>config/kivitendo.conf</filename> nicht existiert.</para>
744 <para>Diese Hauptkonfigurationsdatei ist dann eine
745 installationsspezifische Datei, d.h. sie enthält bspw. lokale
746 Passwörter und wird auch nicht im Versionsmanagement (git)
749 <para>Die Konfiguration ist ferner serverabhängig, d.h. für alle
750 Mandaten, bzw. Datenbanken gleich.</para>
753 <sect2 id="config.config-file.sections-parameters">
754 <title>Abschnitte und Parameter</title>
756 <para>Die Konfigurationsdatei besteht aus mehreren Teilen, die
757 entsprechend kommentiert sind:</para>
761 <para><literal>authentication</literal> (siehe Abschnitt "<xref
762 linkend="Benutzerauthentifizierung-und-Administratorpasswort"/>"
763 in diesem Kapitel)</para>
767 <para><literal>authentication/database</literal></para>
771 <para><literal>authentication/ldap</literal></para>
775 <para><literal>system</literal></para>
779 <para><literal>paths</literal></para>
783 <para><literal>mail_delivery</literal> (siehe Abschnitt "<xref
784 linkend="config.sending-email.smtp"/>)</para>
788 <para><literal>applications</literal></para>
792 <para><literal>environment</literal></para>
796 <para><literal>print_templates</literal></para>
800 <para><literal>task_server</literal></para>
804 <para><literal>periodic_invoices</literal></para>
808 <para><literal>self_tests</literal></para>
812 <para><literal>console</literal></para>
816 <para><literal>testing</literal></para>
820 <para><literal>testing/database</literal></para>
824 <para><literal>debug</literal></para>
828 <para>Die üblicherweise wichtigsten Parameter, die am Anfang
829 einzustellen oder zu kontrollieren sind, sind:</para>
831 <programlisting>[authentication]
832 admin_password = geheim
834 [authentication/database]
842 default_manager = german</programlisting>
844 <para>Für kivitendo Installationen in der Schweiz sollte hier
845 <varname>german</varname> durch <varname>swiss</varname> ersetzt
848 <para>Die Einstellung <varname>default_manager = swiss</varname>
853 <para>Beim Erstellen einer neuen Datenbank in der kivitendo
854 Administration werden automatisch die Standard-Werte für die
855 Schweiz voreingestellt: Währung CHF, 5er-Rundung, Schweizer
856 KMU-Kontenplan, Sollversteuerung, Aufwandsmethode, Bilanzierung
857 (die Werte können aber manuell angepasst werden).</para>
861 <para>Einstellen der Standardkonten für Rundungserträge und
862 -aufwendungen (unter Mandantenkonfiguration → Standardkonten
867 <para>das verwendete Zahlenformat wird auf
868 <varname>1'000.00</varname> eingestellt (unter Programm →
869 Benutzereinstellungen veränderbar)</para>
873 <para>DATEV-Automatik und UStVA werden nicht angezeigt,
874 Erfolgsrechnung ersetzt GUV ( unter Mandantenkonfiguration →
875 Features veränderbar)</para>
879 <para>Nutzt man wiederkehrende Rechnungen, kann man unter
880 <varname>[periodic_invoices]</varname> den Login eines Benutzers
881 angeben, der nach Erstellung der Rechnungen eine entsprechende E-Mail
882 mit Informationen über die erstellten Rechnungen bekommt.</para>
884 <para>kivitendo bringt eine eigene Komponente zur zeitgesteuerten
885 Ausführung bestimmter Aufgaben mit, den <link
886 linkend="config.task-server">Task-Server</link>. Er wird u.a. für
887 Features wie die <link
888 linkend="features.periodic-invoices">wiederkehrenden Rechnungen</link>
889 benötigt, erledigt aber auch andere erforderliche Aufgaben und muss
890 daher in Betrieb genommen werden. Seine Einrichtung wird im Abschnitt
891 <link linkend="config.task-server">Task-Server</link> genauer
894 <para>Für Entwickler finden sich unter <varname>[debug]</varname>
895 wichtige Funktionen, um die Fehlersuche zu erleichtern.</para>
898 <sect2 id="config.config-file.prior-versions">
899 <title>Versionen vor 2.6.3</title>
901 <para>In älteren kivitendo Versionen gab es im Verzeichnis
902 <filename>config</filename> die Dateien
903 <filename>authentication.pl</filename> und
904 <filename>lx-erp.conf</filename>, die jeweils Perl-Dateien waren. Es
905 gab auch die Möglichkeit, eine lokale Version der Konfigurationsdatei
906 zu erstellen (<filename>lx-erp-local.conf</filename>). Dies ist ab
907 2.6.3 nicht mehr möglich, aber auch nicht mehr nötig.</para>
909 <para>Beim Update von einer kivitendo-Version vor 2.6.3 auf 2.6.3 oder
910 jünger müssen die Einstellungen aus den alten Konfigurationsdateien
911 manuell übertragen und die alten Konfigurationsdateien anschließend
912 gelöscht oder verschoben werden. Ansonsten zeigt kivitendo eine
913 entsprechende Fehlermeldung an.</para>
917 <sect1 id="Anpassung-der-PostgreSQL-Konfiguration">
918 <title>Anpassung der PostgreSQL-Konfiguration</title>
920 <para>PostgreSQL muss auf verschiedene Weisen angepasst werden.</para>
921 <para>Dies variert je nach eingesetzter Distribution, da distributionsabhängig unterschiedliche Strategien beim Upgrade der Postgres Version eingesetzt werden.
922 Als Hinweis einige Links zu den drei Distribution (Stand Dezember 2018):</para>
925 <para><ulink url="https://fedoraproject.org/wiki/PostgreSQL">Fedora (Postgres-Installation unter Fedora)</ulink></para>
928 <para><ulink url="https://help.ubuntu.com/lts/serverguide/postgresql.html">Ubuntu (Infos für Postgres für die aktuelle LTS Version)</ulink></para>
931 <para><ulink url="https://de.opensuse.org/PostgreSQL">OpenSuSE (aktuell nur bis Version OpenSuSE 13 verifiziert)</ulink></para>
934 <sect2 id="Zeichensätze-die-Verwendung-von-UTF-8">
935 <title>Zeichensätze/die Verwendung von Unicode/UTF-8</title>
937 <para>kivitendo setzt zwingend voraus, dass die Datenbank
938 Unicode/UTF-8 als Encoding einsetzt. Bei aktuellen
939 Serverinstallationen braucht man hier meist nicht einzugreifen.</para>
941 <para>Das Encoding des Datenbankservers kann überprüft werden. Ist das
942 Encoding der Datenbank "template1" "Unicode" bzw. "UTF-8", so braucht
943 man nichts weiteres diesbezüglich unternehmen. Zum Testen:</para>
945 <programlisting>su postgres
947 exit </programlisting>
949 <para>Andernfalls ist es notwendig, einen neuen Datenbankcluster mit
950 Unicode-Encoding anzulegen und diesen zu verwenden. Unter Debian und
951 Ubuntu kann dies z.B. für PostgreSQL 9.3 mit dem folgenden Befehl
954 <programlisting>pg_createcluster --locale=de_DE.UTF-8 --encoding=UTF-8 9.3 clustername</programlisting>
956 <para>Die Datenbankversionsnummer muss an die tatsächlich verwendete
957 Versionsnummer angepasst werden.</para>
959 <para>Unter anderen Distributionen gibt es ähnliche Methoden.</para>
961 <para>Das Encoding einer Datenbank kann in <command>psql</command> mit
962 <literal>\l</literal> geprüft werden.</para>
965 <sect2 id="Änderungen-an-Konfigurationsdateien">
966 <title>Änderungen an Konfigurationsdateien</title>
968 <para>In der Datei <filename>postgresql.conf</filename>, die je nach
969 Distribution in verschiedenen Verzeichnissen liegen kann (z.B.
970 <filename>/var/lib/pgsql/data/</filename> oder
971 <filename>/etc/postgresql/</filename>), muss sichergestellt werden,
972 dass TCP/IP-Verbindungen aktiviert sind. Das Verhalten wird über den
973 Parameter <varname>listen_address</varname> gesteuert. Laufen
974 PostgreSQL und kivitendo auf demselben Rechner, so kann dort der Wert
975 <literal>localhost</literal> verwendet werden. Andernfalls müssen
976 Datenbankverbindungen auch von anderen Rechnern aus zugelassen werden,
977 was mit dem Wert <literal>*</literal> geschieht.</para>
979 <para>In der Datei <filename>pg_hba.conf</filename>, die im gleichen
980 Verzeichnis wie die <filename>postgresql.conf</filename> zu finden
981 sein sollte, müssen die Berechtigungen für den Zugriff geändert
982 werden. Hier gibt es mehrere Möglichkeiten. Sinnvoll ist es nur die
983 nötigen Verbindungen immer zuzulassen, für eine lokal laufende
984 Datenbank zum Beispiel:</para>
986 <programlisting>local all kivitendo password
987 host all kivitendo 127.0.0.1 255.255.255.255 password</programlisting>
990 <sect2 id="Erweiterung-für-servergespeicherte-Prozeduren">
991 <title>Erweiterung für servergespeicherte Prozeduren</title>
993 <para>In der Datenbank <literal>template1</literal> muss die
994 Unterstützung für servergespeicherte Prozeduren eingerichet werden.
995 Melden Sie sich dafür als Benutzer “postgres” an der Datenbank an:
996 <programlisting>su - postgres
997 psql template1</programlisting> führen Sie die folgenden Kommandos aus:</para>
999 <programlisting>CREATE EXTENSION IF NOT EXISTS plpgsql;
1003 <para><literal>CREATE EXTENSION</literal> ist seit Version 9.1 die
1004 bevorzugte Syntax um die Sprache <literal>plpgsql</literal>
1005 anzulegen. In diesen Versionen ist die Extension meist auch schon
1006 vorhanden. Sollten Sie eine ältere Version von Postgres haben,
1007 benutzen Sie stattdessen den folgenden Befehl.</para>
1009 <programlisting>CREATE LANGUAGE 'plpgsql';
1014 <sect2 id="Erweiterung-für-trigram">
1015 <title>Erweiterung für Trigram Prozeduren</title>
1017 <para>Ab Version 3.5.1 wird die Trigram-Index-Erweiterung benötigt.
1018 Diese wird mit dem SQL-Updatescript
1019 sql/Pg-upgrade2/trigram_extension.sql und Datenbank-Super-Benutzer
1020 Rechten automatisch installiert. Dazu braucht der
1021 DatenbankSuperbenutzer "postgres" ein Passwort.</para>
1023 <programlisting>su - postgres
1030 <para>Benutzername Postgres und Passwort können jetzt beim Anlegen
1031 einer Datenbank bzw. bei Updatescripten, die SuperuserRechte
1032 benötigen, eingegeben werden.</para>
1035 <para><literal>pg_trgm</literal> ist je nach Distribution nicht im
1036 Standard-Paket von Postgres enthalten. Ein <programlisting>select * from pg_available_extensions where name ='pg_trgm';</programlisting>
1037 in template1 sollte entsprechend erfolgreich sein. Andernfalls muss
1038 das Paket nachinstalliert werden, bspw. bei debian/ubuntu
1039 <programlisting>apt install postgresql-contrib</programlisting></para>
1043 <sect2 id="Datenbankbenutzer-anlegen">
1044 <title>Datenbankbenutzer anlegen</title>
1046 <para>Wenn Sie nicht den Datenbanksuperuser “postgres” zum Zugriff
1047 benutzen wollen, so sollten Sie bei PostgreSQL einen neuen Benutzer
1048 anlegen. Ein Beispiel, wie Sie einen neuen Benutzer anlegen
1051 <para>Die Frage, ob der neue User Superuser sein soll, können Sie mit
1052 nein beantworten, genauso ist die Berechtigung neue User (Roles) zu
1053 generieren nicht nötig.</para>
1055 <programlisting>su - postgres
1056 createuser -d -P kivitendo
1057 exit</programlisting>
1059 <para>Wenn Sie später einen Datenbankzugriff konfigurieren, verändern
1060 Sie den evtl. voreingestellten Benutzer “postgres” auf “kivitendo”
1061 bzw. den hier gewählten Benutzernamen.</para>
1065 <sect1 id="Apache-Konfiguration">
1066 <title>Webserver-Konfiguration</title>
1069 <title>Grundkonfiguration mittels CGI</title>
1072 <para>Für einen deutlichen Performanceschub sorgt die Ausführung
1073 mittels FastCGI/FCGI. Die Einrichtung wird ausführlich im Abschnitt
1074 <xref linkend="Apache-Konfiguration.FCGI"/> beschrieben.</para>
1077 <para>Der Zugriff auf das Programmverzeichnis muss in der Apache
1078 Webserverkonfigurationsdatei <literal>httpd.conf</literal> eingestellt
1079 werden. Fügen Sie den folgenden Abschnitt dieser Datei oder einer
1080 anderen Datei hinzu, die beim Starten des Webservers eingelesen
1083 <programlisting>AliasMatch ^/kivitendo-erp/[^/]+\.pl /var/www/kivitendo-erp/dispatcher.pl
1084 Alias /kivitendo-erp/ /var/www/kivitendo-erp/
1086 <Directory /var/www/kivitendo-erp>
1087 AddHandler cgi-script .pl
1088 Options ExecCGI Includes FollowSymlinks
1091 <Directory /var/www/kivitendo-erp/users>
1093 </Directory></programlisting>
1095 <para>Ersetzen Sie dabei die Pfade durch diejenigen, in die Sie vorher
1096 das kivitendo-Archiv entpacket haben.</para>
1099 <para>Vor den einzelnen Optionen muss bei einigen Distributionen ein
1100 Plus ‘<literal>+</literal>’ gesetzt werden.</para>
1102 <para>Bei einigen Distribution (Ubuntu ab 14.04, Debian ab 8.2) muss
1103 noch explizit das cgi-Modul mittels <programlisting>a2enmod cgi</programlisting>
1104 aktiviert werden.</para>
1107 <para>Auf einigen Webservern werden manchmal die Grafiken und
1108 Style-Sheets nicht ausgeliefert. In solchen Fällen hat es oft
1109 geholfen, die folgende Option in die Konfiguration aufzunehmen:</para>
1111 <programlisting>EnableSendfile Off</programlisting>
1114 <sect2 id="Apache-Konfiguration.FCGI"
1115 xreflabel="Konfiguration für FastCGI/FCGI">
1116 <title>Konfiguration für FastCGI/FCGI</title>
1118 <sect3 id="Apache-Konfiguration.FCGI.WasIstEs">
1119 <title>Was ist FastCGI?</title>
1121 <para>Direkt aus <ulink
1122 url="http://de.wikipedia.org/wiki/FastCGI">Wikipedia</ulink>
1125 <para><citation> FastCGI ist ein Standard für die Einbindung
1126 externer Software zur Generierung dynamischer Webseiten in einem
1127 Webserver. FastCGI ist vergleichbar zum Common Gateway Interface
1128 (CGI), wurde jedoch entwickelt, um dessen Performance-Probleme zu
1129 umgehen. </citation></para>
1132 <sect3 id="Apache-Konfiguration.FCGI.Warum">
1133 <title>Warum FastCGI?</title>
1135 <para>Perl Programme (wie kivitendo eines ist) werden nicht statisch
1136 kompiliert. Stattdessen werden die Quelldateien bei jedem Start
1137 übersetzt, was bei kurzen Laufzeiten einen Großteil der Laufzeit
1138 ausmacht. Während SQL Ledger einen Großteil der Funktionalität in
1139 einzelne Module kapselt, um immer nur einen kleinen Teil laden zu
1140 müssen, ist die Funktionalität von kivitendo soweit gewachsen, dass
1141 immer mehr Module auf den Rest des Programms zugreifen. Zusätzlich
1142 benutzen wir umfangreiche Bibliotheken um Funktionaltät nicht selber
1143 entwickeln zu müssen, die zusätzliche Ladezeit kosten. All dies
1144 führt dazu dass ein kivitendo Aufruf der Kernmasken mittlerweile
1145 deutlich länger dauert als früher, und dass davon 90% für das Laden
1146 der Module verwendet wird.</para>
1148 <para>Mit FastCGI werden nun die Module einmal geladen, und danach
1149 wird nur die eigentliche Programmlogik ausgeführt.</para>
1152 <sect3 id="Apache-Konfiguration.FCGI.WebserverUndPlugin">
1153 <title>Getestete Kombinationen aus Webservern und Plugin</title>
1155 <para>Folgende Kombinationen sind getestet:</para>
1159 <para>Apache 2.4.7 (Ubuntu 14.04.2 LTS) und mod_fcgid.</para>
1162 <para>Apache 2.4.18 (Ubuntu 16.04 LTS) und mod_fcgid</para>
1165 <para>Apache 2.4.29 (Ubuntu 18.04 LTS) und mod_fcgid</para>
1168 <para>Apache 2.4.41 (Ubuntu 20.04 LTS) und mod_fcgid</para>
1173 <para>Als Perl Backend wird das Modul <filename>FCGI.pm</filename>
1177 <para>FCGI-Versionen ab 0.69 und bis zu 0.71 inklusive sind extrem
1178 strict in der Behandlung von Unicode, und verweigern bestimmte
1179 Eingaben von kivitendo. Falls es Probleme mit Umlauten in Ihrer
1180 Installation gibt, muss zwingend Version 0.68 oder aber Version
1181 0.72 und neuer eingesetzt werden.</para>
1183 <para>Mit <ulink url="http://www.cpan.org">CPAN</ulink> lässt sie
1184 sich die Vorgängerversion wie folgt installieren:</para>
1186 <programlisting>force install M/MS/MSTROUT/FCGI-0.68.tar.gz</programlisting>
1190 <sect3 id="Apache-Konfiguration.FCGI.Konfiguration">
1191 <title>Konfiguration des Webservers</title>
1193 <para>Bevor Sie versuchen, eine kivitendo Installation unter FCGI
1194 laufen zu lassen, empfiehlt es sich die Installation ersteinmal
1195 unter CGI aufzusetzen. FCGI macht es nicht einfach Fehler zu
1196 debuggen die beim ersten aufsetzen auftreten können. Sollte die
1197 Installation schon funktionieren, lesen Sie weiter.</para>
1199 <para>Zuerst muss das FastCGI-Modul aktiviert werden. Dies kann
1200 unter Debian/Ubuntu z.B. mit folgendem Befehl geschehen:</para>
1202 <programlisting>a2enmod fcgid</programlisting>
1204 <para>Die Konfiguration für die Verwendung von kivitendo mit FastCGI
1205 erfolgt durch Anpassung der vorhandenen <function>Alias</function>-
1206 und <function>Directory</function>-Direktiven. Dabei wird zwischen
1207 dem Installationspfad von kivitendo im Dateisystem
1208 ("<filename>/path/to/kivitendo-erp</filename>") und der URL
1209 unterschieden, unter der kivitendo im Webbrowser erreichbar ist
1210 ("<filename>/url/for/kivitendo-erp</filename>").</para>
1212 <para>Folgender Konfigurationsschnipsel funktioniert mit
1215 <programlisting>AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fcgi
1216 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
1218 <Directory /path/to/kivitendo-erp>
1220 Options ExecCGI Includes FollowSymlinks
1224 <DirectoryMatch /path/to/kivitendo-erp/users>
1226 </DirectoryMatch></programlisting>
1229 <para>Wer einen älteren Apache als Version 2.4 im Einsatz hat,
1230 muss entsprechend die Syntax der Directorydirektiven verändert.
1233 <programlisting>Require all granted</programlisting>
1235 <para>muß man Folgendes einstellen:</para>
1239 Allow from All </programlisting>
1241 <para>und statt</para>
1243 <programlisting>Require all denied</programlisting>
1245 <para>muss stehen:</para>
1249 Deny from All </programlisting>
1252 <para>Seit mod_fcgid-Version 2.3.6 gelten sehr kleine Grenzen für
1253 die maximale Größe eines Requests. Diese sollte wie folgt
1254 hochgesetzt werden:</para>
1256 <programlisting>FcgidMaxRequestLen 10485760</programlisting>
1258 <para>Das Ganze sollte dann so aussehen:</para>
1260 <programlisting>AddHandler fcgid-script .fpl
1261 AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
1262 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
1263 FcgidMaxRequestLen 10485760
1265 <Directory /path/to/kivitendo-erp>
1267 Options ExecCGI Includes FollowSymlinks
1271 <DirectoryMatch /path/to/kivitendo-erp/users>
1273 </DirectoryMatch></programlisting>
1275 <para>Hierdurch wird nur ein zentraler Dispatcher gestartet. Alle
1276 Zugriffe auf die einzelnen Scripte werden auf diesen umgeleitet.
1277 Dadurch, dass zur Laufzeit öfter mal Scripte neu geladen werden,
1278 gibt es hier kleine Performance-Einbußen.</para>
1280 <para>Es ist möglich, die gleiche kivitendo Version parallel unter
1281 CGI und FastCGI zu betreiben. Dafür bleiben die Directorydirektiven
1282 wie oben beschrieben, die URLs werden aber umgeleitet:</para>
1284 <programlisting># Zugriff über CGI
1285 Alias /url/for/kivitendo-erp /path/to/kivitendo-erp
1287 # Zugriff mit mod_fcgid:
1288 AliasMatch ^/url/for/kivitendo-erp-fcgid/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
1289 Alias /url/for/kivitendo-erp-fcgid/ /path/to/kivitendo-erp/</programlisting>
1291 <para>Dann ist unter <filename>/url/for/kivitendo-erp/</filename>
1292 die normale Version erreichbar, und unter
1293 <constant>/url/for/kivitendo-erp-fcgid/</constant> die
1294 FastCGI-Version.</para>
1299 <title>Authentifizierung mittels HTTP Basic Authentication</title>
1302 Kivitendo unterstützt, dass Benutzerauthentifizierung über den Webserver mittels des »Basic«-HTTP-Authentifizierungs-Schema erfolgt
1303 (siehe <ulink url="https://tools.ietf.org/html/rfc7617">RFC 7617</ulink>). Dazu ist es aber nötig, dass der dabei vom Client
1304 mitgeschickte Header <constant>Authorization</constant> vom Webserver an Kivitendo über die Umgebungsvariable
1305 <constant>HTTP_AUTHORIZATION</constant> weitergegeben wird, was standardmäßig nicht der Fall ist. Für Apache kann dies über die
1306 folgende Konfigurationsoption aktiviert werden:
1309 <programlisting>SetEnvIf Authorization "(.*)" HTTP_AUTHORIZATION=$1</programlisting>
1312 <title>Aktivierung von mod_rewrite/directory_match für git basierte Installationen</title>
1315 Aufgrund von aktuellen (Mitte 2020) Sicherheitswarnungen für git basierte Webanwendungen ist die mitausgelieferte .htaccess
1316 restriktiver geworden und verhindert somit das Auslesen von git basierten Daten.
1317 Für debian/ubuntu muss das Modul mod_rewrite einmalig so aktiviert werden:
1318 <programlisting>a2enmod rewrite</programlisting>
1319 Alternativ und für Installationen ohne Apache ist folgender Artikel interessant:
1320 <ulink url="https://www.cyberscan.io/blog/git-luecke">git-lücke</ulink>.
1321 Anstelle des dort beschriebenen DirectoryMatch für Apache2 würden wir etwas weitergehend auch noch das Verzeichnis config miteinbeziehen
1322 sowie ferner auch die Möglichkeit nicht ausschließen, dass es in Unterverzeichnissen auch noch .git Repositories geben kann.
1323 Die Empfehlung für Apache 2.4 wäre damit:
1325 <DirectoryMatch "/(\.git|config)/">
1327 </DirectoryMatch></programlisting>
1333 <title>Weitergehende Konfiguration</title>
1335 <para>Für einen deutlichen Sicherheitsmehrwert sorgt die Ausführung
1336 von kivitendo nur über https-verschlüsselten Verbindungen, sowie
1337 weiteren Zusatzmassnahmen, wie beispielsweise Basic Authenticate. Die
1338 Konfigurationsmöglichkeiten sprengen allerdings den Rahmen dieser
1339 Anleitung, hier ein Hinweis auf einen entsprechenden <ulink
1340 url="http://redmine.kivitendo-premium.de/boards/1/topics/142">Foreneintrag
1341 (Stand Sept. 2015)</ulink> und einen aktuellen (Stand Mai 2017) <ulink
1342 url="https://mozilla.github.io/server-side-tls/ssl-config-generator/">
1343 SSL-Konfigurations-Generator</ulink>.</para>
1346 <title>Aktivierung von Apache2 modsecurity</title>
1348 <para>Aufgrund des OpenSource Charakters ist kivitendo nicht "out of the box" sicher.
1349 Organisatorisch empfehlen wir hier die enge Zusammenarbeit mit einem kivitendo Partner der auch in der
1350 Lage ist weiterführende Fragen in Bezug auf Datenschutz und Datensicherheit zu beantworten.
1351 Unabhängig davon empfehlen wir im Webserver Bereich die Aktivierung und Konfiguration des Moduls modsecurity für den Apache2, damit
1352 XSS und SQL-Injections verhindert werden.</para>
1353 <para> Als Idee hierfür sei dieser Blog-Eintrag genannt:
1354 <ulink url="https://doxsec.wordpress.com/2017/06/11/using-modsecurity-web-application-firewall-to-prevent-sql-injection-and-xss-using-blocking-rules/">
1355 Test Apache2 modsecurity for SQL Injection</ulink>.</para>
1360 <sect1 id="config.task-server">
1361 <title>Der Task-Server</title>
1363 <para>Der Task-Server ist ein Prozess, der im Hintergrund läuft, in
1364 regelmäßigen Abständen nach abzuarbeitenden Aufgaben sucht und diese zu
1365 festgelegten Zeitpunkten abarbeitet (ähnlich wie Cron). Dieser Prozess
1366 wird u.a. für die Erzeugung der wiederkehrenden Rechnungen und weitere
1367 essenzielle Aufgaben benutzt.</para>
1369 <para>Der Task-Server muss einmalig global in der Konfigurationsdatei
1370 konfiguriert werden. Danach wird er für jeden Mandanten, für den er
1371 laufen soll, in der Adminsitrationsmaske eingeschaltet.</para>
1373 <para>Beachten Sie, dass der Task-Server in den Boot-Vorgang Ihres
1374 Servers integriert werden muss, damit er automatisch gestartet wird.
1375 Dies kann kivitendo nicht für Sie erledigen.</para>
1377 <para>Da der Task-Server als Perlscript läuft, wird Arbeitsspeicher, der
1378 einmal benötigt wurde, nicht mehr an das Betriebssystem zurückgegeben,
1379 solange der Task-Server läuft. Dies kann dazu führen, dass ein länger
1380 laufender Task-Server mit der Zeit immer mehr Arbeitsspeicher für sich
1381 beansprucht. Es ist deshalb sinnvoll, dass der Task-Server in
1382 regelmässigen Abständen neu gestartet wird. Allerdings berücksichtigt der
1383 Task-Server ein Memory-Limit, wenn dieses in der Konfigurationsdatei
1384 angegeben ist. Bei Überschreiten dieses Limits beendet sich der
1385 Task-Server. Sofern der Task-Server als systemd-Service mit dem
1386 mitgelieferten Skript eingerichtet wurde, startet dieser danach
1387 automatisch erneut.</para>
1389 <sect2 id="Konfiguration-des-Task-Servers">
1390 <title>Verfügbare und notwendige Konfigurationsoptionen</title>
1392 <para>Die Konfiguration erfolgt über den Abschnitt
1393 <literal>[task_server]</literal> in der Datei
1394 <filename>config/kivitendo.conf</filename>. Die dort verfügbaren
1395 Optionen sind:</para>
1399 <term><varname>run_as</varname></term>
1402 <para>Wird der Server vom Systembenutzer <literal>root</literal>
1403 gestartet, so wechselt er auf den mit <literal>run_as</literal>
1404 angegebenen Systembenutzer. Der Systembenutzer muss dieselben
1405 Lese- und Schreibrechte haben, wie auch der Webserverbenutzer
1407 linkend="Manuelle-Installation-des-Programmpaketes"/>). Daher
1408 ist es erforderlich, hier denselben Systembenutzer einzutragen,
1409 unter dem auch der Webserver läuft.</para>
1414 <term><varname>debug</varname></term>
1417 <para>Schaltet Debug-Informationen an und aus.</para>
1423 <sect2 id="Konfiguration-der-Mandanten-fuer-den-Task-Servers">
1424 <title>Konfiguration der Mandanten für den Task-Server</title>
1426 <para>Ist der Task-Server grundlegend konfiguriert, so muss
1427 anschließend jeder Mandant, für den der Task-Server laufen soll,
1428 einmalig konfiguriert werden. Dazu kann in der Maske zum Bearbeiten
1429 von Mandanten im Administrationsbereich eine kivitendo-Benutzerkennung
1430 ausgewählt werden, unter der der Task-Server seine Arbeit
1433 <para>Ist in dieser Einstellung keine Benutzerkennung ausgewählt, so
1434 wird der Task-Server für diesen Mandanten keine Aufgaben
1438 <sect2 id="Einbinden-in-den-Boot-Prozess">
1439 <title>Automatisches Starten des Task-Servers beim Booten</title>
1441 <para>Der Task-Server verhält sich von seinen Optionen her wie ein
1442 reguläres SystemV-kompatibles Boot-Script. Außerdem wechselt er beim
1443 Starten automatisch in das kivitendo-Installationsverzeichnis.</para>
1445 <para>Deshalb ist es möglich, ihn durch Setzen eines symbolischen
1446 Links aus einem der Runlevel-Verzeichnisse heraus in den Boot-Prozess
1447 einzubinden. Da das bei neueren Linux-Distributionen aber nicht
1448 zwangsläufig funktioniert, werden auch Start-Scripte mitgeliefert, die
1449 anstelle eines symbolischen Links verwendet werden können.</para>
1452 <title>SystemV-basierende Systeme (z.B. ältere Debian, ältere
1453 openSUSE, ältere Fedora)</title>
1455 <para>Kopieren Sie die Datei
1456 <filename>scripts/boot/system-v/kivitendo-task-server</filename>
1457 nach <filename>/etc/init.d/kivitendo-task-server</filename>. Passen
1458 Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
1459 <literal>DAEMON=....</literal>). Binden Sie das Script in den
1460 Boot-Prozess ein. Dies ist distributionsabhängig:</para>
1464 <para>Debian-basierende Systeme:</para>
1466 <programlisting>update-rc.d kivitendo-task-server defaults
1467 insserv kivitendo-task-server</programlisting>
1471 <para>Ältere openSUSE und ältere Fedora:</para>
1473 <programlisting>chkconfig --add kivitendo-task-server</programlisting>
1477 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
1480 <programlisting>/etc/init.d/kivitendo-task-server start</programlisting>
1484 <title>Upstart-basierende Systeme (z.B. Ubuntu bis 14.04)</title>
1486 <para>Kopieren Sie die Datei
1487 <filename>scripts/boot/upstart/kivitendo-task-server.conf</filename>
1488 nach <filename>/etc/init/kivitendo-task-server.conf</filename>.
1489 Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
1490 <literal>exec ....</literal>).</para>
1492 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
1495 <programlisting>service kivitendo-task-server start</programlisting>
1499 <title>systemd-basierende Systeme (z.B. neure openSUSE, neuere
1500 Fedora, neuere Ubuntu und neuere Debians)</title>
1502 <para>Kopieren Sie die Datei
1503 <filename>scripts/boot/systemd/kivitendo-task-server.service</filename>
1504 nach <filename>/etc/systemd/system/</filename>. Passen Sie in der
1505 kopierten Datei den Pfad zum Task-Server an (Zeilen
1506 <literal>ExecStart=....</literal> und
1507 <literal>ExecStop=...</literal>).</para>
1509 <para>Machen Sie anschließend das Script systemd bekannt, und binden
1510 Sie es in den Boot-Prozess ein. Dazu führen Sie die folgenden Befehl
1513 <programlisting>systemctl daemon-reload
1514 systemctl enable kivitendo-task-server.service</programlisting>
1516 <para>Wenn Sie den Task-Server jetzt sofort starten möchten, anstatt
1517 den Server neu zu starten, so können Sie das mit dem folgenden
1520 <programlisting>systemctl start kivitendo-task-server.service</programlisting>
1522 <para>Ein so eingerichteter Task-Server startet nach Beendigung
1523 automatisch erneut. Das betrifft eine Beendigung über die Oberfläche,
1524 eine Beendingung über die Prozesskontrolle und eine Beendigung bei
1525 Überschreiten des Memory-Limits. Soll der Task-Server nicht erneut
1526 starten, so können Sie ihn mit folgendem Befehl stoppen:</para>
1528 <programlisting>systemctl stop kivitendo-task-server.service</programlisting>
1533 <sect2 id="Prozesskontrolle">
1534 <title>Wie der Task-Server gestartet und beendet wird</title>
1536 <para>Der Task-Server wird wie folgt kontrolliert:</para>
1538 <programlisting>./scripts/task_server.pl Befehl</programlisting>
1540 <para><literal>Befehl</literal> ist dabei eine der folgenden
1545 <para><literal>start</literal> startet eine neue Instanz des
1546 Task-Servers. Die Prozess-ID wird innerhalb des
1547 <filename>users</filename>-Verzeichnisses abgelegt.</para>
1551 <para><literal>stop</literal> beendet einen laufenden
1556 <para><literal>restart</literal> beendet und startet ihn
1561 <para><literal>status</literal> berichtet, ob der Task-Server
1566 <para>Der Task-Server wechselt beim Starten automatisch in das
1567 kivitendo-Installationsverzeichnis.</para>
1569 <para>Dieselben Optionen können auch für die SystemV-basierenden
1570 Runlevel-Scripte benutzt werden (siehe oben).</para>
1572 <para>Wurde der Task-Server als systemd-Service eingerichtet (s.o.),
1573 so startet dieser nach Beendigung automatisch erneut.</para>
1576 <sect2 id="Tasks-konfigurieren">
1577 <title>Exemplarische Konfiguration eines Hintergrund-Jobs, der die Jahreszahl in allen Nummernkreisen zum Jahreswechsel erhöht</title>
1579 <para>Hintergrund-Jobs werden über System -> Hintergrund-Jobs und Task-Server -> Aktuelle Hintergrund-Jobs anzeigen -> Aktions-Knopf 'erfassen' angelegt. </para>
1580 <para>Nachdem wir über das Menü dort angelangt sind, legen wir unseren exemplarischen Hintergrund-Jobs "Erhöhung der Nummernkreise" mit folgenden Werten an:</para>
1583 <para><literal>Aktiv:</literal> Hier ein 'Ja' auswählen</para>
1586 <para><literal>Ausführungsart:</literal> 'wiederholte Ausführung' auswählen</para>
1589 <para><literal>Paketname:</literal> 'SetNumberRange' auswählen</para>
1592 <para><literal>Ausführungszeitplan:</literal> Hier entsprechend Werte wie in der crontab eingeben.</para><para>Syntax:</para>
1593 <programlisting>* * * * *
1596 │ │ │ │ └──── Wochentag (0-7, Sonntag ist 0 oder 7)
1597 │ │ │ └────── Monat (1-12)
1598 │ │ └──────── Tag (1-31)
1599 │ └────────── Stunde (0-23)
1600 └──────────── Minute (0-59) </programlisting>
1601 <para>Die Sterne können folgende Werte haben:</para>
1609 5 = Wochentag (0-7, Sonntag ist 0 oder 7)
1611 <para>Um die Ausführung auf eine Minute vor Sylvester zu setzen, müssen die folgenden Werte eingetragen werden:</para>
1612 <programlisting>59 23 31 12 *</programlisting>
1615 <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>
1617 multiplier Nummernkreis 2020
1622 <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>
1623 <para><literal>Daten:</literal></para><programlisting>multiplier: 100
1624 digits_year: 4</programlisting>
1629 <sect1 id="Benutzerauthentifizierung-und-Administratorpasswort">
1630 <title>Benutzerauthentifizierung und Administratorpasswort</title>
1632 <para>Informationen über die Einrichtung der Benutzerauthentifizierung,
1633 über die Verwaltung von Gruppen und weitere Einstellungen</para>
1635 <sect2 id="Grundlagen-zur-Benutzerauthentifizierung">
1636 <title>Grundlagen zur Benutzerauthentifizierung</title>
1638 <para>kivitendo verwaltet die Benutzerinformationen in einer
1639 Datenbank, die im folgenden “Authentifizierungsdatenbank” genannt
1640 wird. Für jeden Benutzer kann dort eine eigene Datenbank für die
1641 eigentlichen Finanzdaten hinterlegt sein. Diese beiden Datenbanken
1642 können, müssen aber nicht unterschiedlich sein.</para>
1644 <para>Im einfachsten Fall gibt es für kivitendo nur eine einzige
1645 Datenbank, in der sowohl die Benutzerinformationen als auch die Daten
1646 abgelegt werden.</para>
1648 <para>Zusätzlich ermöglicht es kivitendo, dass die Benutzerpasswörter gegen die Authentifizierungsdatenbank oder gegen einen oder
1649 mehrere LDAP-Server überprüft werden.</para>
1651 <para>Welche Art der Passwortüberprüfung kivitendo benutzt und wie
1652 kivitendo die Authentifizierungsdatenbank erreichen kann, wird in der
1653 Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1654 festgelegt. Diese muss bei der Installation und bei einem Upgrade von
1655 einer Version vor v2.6.0 angelegt werden. Eine
1656 Beispielkonfigurationsdatei
1657 <filename>config/kivitendo.conf.default</filename> existiert, die als
1658 Vorlage benutzt werden kann.</para>
1661 <sect2 id="Administratorpasswort">
1662 <title>Administratorpasswort</title>
1664 <para>Das Passwort, das zum Zugriff auf das Administrationsinterface
1665 von kivitendo benutzt wird, wird ebenfalls in dieser Datei
1666 gespeichert. Es kann auch nur dort und nicht mehr im
1667 Administrationsinterface selber geändert werden. Der Parameter dazu
1668 heißt <varname>admin_password</varname> im Abschnitt
1669 <varname>[authentication]</varname>.</para>
1672 <sect2 id="Authentifizierungsdatenbank">
1673 <title>Authentifizierungsdatenbank</title>
1675 <para>Die Verbindung zur Authentifizierungsdatenbank wird mit den
1676 Parametern in <varname>[authentication/database]</varname>
1677 konfiguriert. Hier sind die folgenden Parameter anzugeben:</para>
1681 <term><literal>host</literal></term>
1684 <para>Der Rechnername oder die IP-Adresse des
1685 Datenbankservers</para>
1690 <term><literal>port</literal></term>
1693 <para>Die Portnummer des Datenbankservers, meist 5432</para>
1698 <term><literal>db</literal></term>
1701 <para>Der Name der Authentifizierungsdatenbank</para>
1706 <term><literal>user</literal></term>
1709 <para>Der Benutzername, mit dem sich kivitendo beim
1710 Datenbankserver anmeldet (z.B.
1711 "<literal>postgres</literal>")</para>
1716 <term><literal>password</literal></term>
1719 <para>Das Passwort für den Datenbankbenutzer</para>
1724 <para>Die Datenbank muss noch nicht existieren. kivitendo kann sie
1725 automatisch anlegen (mehr dazu siehe unten).</para>
1728 <sect2 id="Passwortüberprüfung">
1729 <title>Passwortüberprüfung</title>
1731 <para>kivitendo unterstützt Passwortüberprüfung auf zwei Arten: gegen
1732 die Authentifizierungsdatenbank und gegen externe LDAP- oder
1733 Active-Directory-Server. Welche davon benutzt wird, regelt der
1734 Parameter <varname>module</varname> im Abschnitt
1735 <varname>[authentication]</varname>.</para>
1737 <para>Dieser Parameter listet die zu verwendenden Authentifizierungsmodule auf. Es muss mindestens ein Modul angegeben werden, es
1738 können aber auch mehrere angegeben werden. Weiterhin ist es möglich, das LDAP-Modul mehrfach zu verwenden und für jede Verwendung
1739 eine unterschiedliche Konfiguration zu nutzen, z.B. um einen Fallback-Server anzugeben, der benutzt wird, sofern der Hauptserver
1740 nicht erreichbar ist.</para>
1742 <para>Sollen die Benutzerpasswörter in der Authentifizierungsdatenbank geprüft werden, so muss der Parameter
1743 <varname>module</varname> das Modul <literal>DB</literal> enthalten. Sofern das Modul in der Liste enthalten ist, egal an welcher
1744 Position, können sowohl der Administrator als auch die Benutzer selber ihre Passwörter in kivitendo ändern.</para>
1746 <para>Wenn Passwörter gegen einen oder mehrere externe LDAP- oder Active-Directory-Server geprüft werden, so muss der Parameter
1747 <varname>module</varname> den Wert <literal>LDAP</literal> enthalten. In diesem Fall müssen zusätzliche Informationen über den
1748 LDAP-Server im Abschnitt <literal>[authentication/ldap]</literal> angegeben werden. Das Modul kann auch mehrfach angegeben werden,
1749 wobei jedes Modul eine eigene Konfiguration bekommen sollte. Der Name der Konfiguration wird dabei mit einem Doppelpunkt getrennt an
1750 den Modulnamen angehängt (<literal>LDAP:Name-der-Konfiguration</literal>). Der entsprechende Abschnitt in der Konfigurationsdatei
1751 lautet dann <literal>[authentication/Name-der-Konfiguration]</literal>.</para>
1753 <para>Die verfügbaren Parameter für die LDAP-Konfiguration lauten:</para>
1757 <term><literal>host</literal></term>
1760 <para>Der Rechnername oder die IP-Adresse des LDAP- oder
1761 Active-Directory-Servers. Diese Angabe ist zwingend
1762 erforderlich.</para>
1767 <term><literal>port</literal></term>
1770 <para>Die Portnummer des LDAP-Servers; meist 389.</para>
1775 <term><literal>tls</literal></term>
1778 <para>Wenn Verbindungsverschlüsselung gewünscht ist, so diesen
1779 Wert auf ‘<literal>1</literal>’ setzen, andernfalls auf
1780 ‘<literal>0</literal>’ belassen</para>
1785 <term><literal>verify</literal></term>
1788 <para>Wenn Verbindungsverschlüsselung gewünscht und der Parameter <parameter>tls</parameter> gesetzt ist, so gibt dieser
1789 Parameter an, ob das Serverzertifikat auf Gültigkeit geprüft wird. Mögliche Werte sind <literal>require</literal> (Zertifikat
1790 wird überprüft und muss gültig sei; dies ist der Standard) und <literal>none</literal> (Zertifikat wird nicht
1796 <term><literal>attribute</literal></term>
1799 <para>Das LDAP-Attribut, in dem der Benutzername steht, den der
1800 Benutzer eingegeben hat. Für Active-Directory-Server ist dies
1801 meist ‘<literal>sAMAccountName</literal>’, für andere
1802 LDAP-Server hingegen ‘<literal>uid</literal>’. Diese Angabe ist
1803 zwingend erforderlich.</para>
1808 <term><literal>base_dn</literal></term>
1811 <para>Der Abschnitt des LDAP-Baumes, der durchsucht werden soll.
1812 Diese Angabe ist zwingend erforderlich.</para>
1817 <term><literal>filter</literal></term>
1820 <para>Ein optionaler LDAP-Filter. Enthält dieser Filter das Wort
1821 <literal><%login%></literal>, so wird dieses durch den vom
1822 Benutzer eingegebenen Benutzernamen ersetzt. Andernfalls wird
1823 der LDAP-Baum nach einem Element durchsucht, bei dem das oben
1824 angegebene Attribut mit dem Benutzernamen identisch ist.</para>
1829 <term><literal>bind_dn</literal> und
1830 <literal>bind_password</literal></term>
1833 <para>Wenn der LDAP-Server eine Anmeldung erfordert, bevor er
1834 durchsucht werden kann (z.B. ist dies bei
1835 Active-Directory-Servern der Fall), so kann diese hier angegeben
1836 werden. Für Active-Directory-Server kann als
1837 ‘<literal>bind_dn</literal>’ entweder eine komplette LDAP-DN wie
1838 z.B. ‘<literal>cn=Martin
1839 Mustermann,cn=Users,dc=firmendomain</literal>’ auch nur der
1840 volle Name des Benutzers eingegeben werden; in diesem Beispiel
1841 also ‘<literal>Martin Mustermann</literal>’.</para>
1846 <term><literal>timeout</literal></term>
1849 <para>Timeout beim Verbindungsversuch, bevor der Server als nicht erreichbar gilt; Standardwert: 10</para>
1855 <sect2 id="Name-des-Session-Cookies">
1856 <title>Name des Session-Cookies</title>
1858 <para>Sollen auf einem Server mehrere kivitendo-Installationen
1859 aufgesetzt werden, so müssen die Namen der Session-Cookies für alle
1860 Installationen unterschiedlich sein. Der Name des Cookies wird mit dem
1861 Parameter <varname>cookie_name</varname> im Abschnitt
1862 <varname>[authentication]</varname>gesetzt.</para>
1864 <para>Diese Angabe ist optional, wenn nur eine Installation auf dem
1865 Server existiert.</para>
1868 <sect2 id="Anlegen-der-Authentifizierungsdatenbank">
1869 <title>Anlegen der Authentifizierungsdatenbank</title>
1871 <para>Nachdem alle Einstellungen in
1872 <filename>config/kivitendo.conf</filename> vorgenommen wurden, muss
1873 kivitendo die Authentifizierungsdatenbank anlegen. Dieses geschieht
1874 automatisch, wenn Sie sich im Administrationsmodul anmelden, das unter
1875 der folgenden URL erreichbar sein sollte:</para>
1878 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
1882 <sect1 id="Benutzer--und-Gruppenverwaltung">
1883 <title>Mandanten-, Benutzer- und Gruppenverwaltung</title>
1885 <para>Nach der Installation müssen Mandanten, Benutzer, Gruppen und
1886 Datenbanken angelegt werden. Dieses geschieht im Administrationsmenü,
1887 das Sie unter folgender URL finden:</para>
1890 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
1892 <para>Verwenden Sie zur Anmeldung das Passwort, das Sie in der Datei
1893 <filename>config/kivitendo.conf</filename> eingetragen haben.</para>
1895 <sect2 id="Zusammenhänge">
1896 <title>Zusammenhänge</title>
1898 <para>kivitendo verwaltet zwei Sets von Daten, die je nach Einrichtung
1899 in einer oder zwei Datenbanken gespeichert werden.</para>
1901 <para>Das erste Set besteht aus Anmeldeinformationen: welche Benutzer
1902 und Mandanten gibt es, welche Gruppen, welche BenutzerIn hat Zugriff
1903 auf welche Mandanten, und welche Gruppe verfügt über welche Rechte.
1904 Diese Informationen werden in der Authentifizierungsdatenbank
1905 gespeichert. Dies ist diejenige Datenbank, deren Verbindungsparameter
1906 in der Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1907 gespeichert werden.</para>
1909 <para>Das zweite Set besteht aus den eigentlichen Verkehrsdaten eines
1910 Mandanten, wie beispielsweise die Stammdaten (Kunden, Lieferanten,
1911 Waren) und Belege (Angebote, Lieferscheine, Rechnungen). Diese werden
1912 in einer Mandantendatenbank gespeichert. Die Verbindungsinformationen
1913 einer solchen Mandantendatenbank werden im Administrationsbereich
1914 konfiguriert, indem man einen Mandanten anlegt und dort die Parameter
1915 einträgt. Dabei hat jeder Mandant eine eigene Datenbank.</para>
1917 <para>Aufgrund des Datenbankdesigns ist es für einfache Fälle möglich,
1918 die Authentifizierungsdatenbank und eine der Mandantendatenbanken in
1919 ein und derselben Datenbank zu speichern. Arbeitet man hingegen mit
1920 mehr als einem Mandanten, wird empfohlen, für die
1921 Authentifizierungsdatenbank eine eigene Datenbank zu verwenden, die
1922 nicht gleichzeitig für einen Mandanten verwendet wird.</para>
1925 <sect2 id="Mandanten-Benutzer-Gruppen">
1926 <title>Mandanten, Benutzer und Gruppen</title>
1928 <para>kivitendos Administration kennt Mandanten, Benutzer und Gruppen,
1929 die sich frei zueinander zuordnen lassen.</para>
1931 <para>kivitendo kann mehrere Mandaten aus einer Installation heraus
1932 verwalten. Welcher Mandant benutzt wird, kann direkt beim Login
1933 ausgewählt werden. Für jeden Mandanten wird ein eindeutiger Name
1934 vergeben, der beim Login angezeigt wird. Weiterhin benötigt der
1935 Mandant Datenbankverbindungsparameter für seine Mandantendatenbank.
1936 Diese sollte über die <link
1937 linkend="Datenbanken-anlegen">Datenbankverwaltung</link>
1940 <para>Ein Benutzer ist eine Person, die Zugriff auf kivitendo erhalten
1941 soll. Sie erhält einen Loginnamen sowie ein Passwort. Weiterhin legt
1942 der Administrator fest, an welchen Mandanten sich ein Benutzer
1943 anmelden kann, was beim Login verifiziert wird.</para>
1945 <para>Gruppen dienen dazu, Benutzern innerhalb eines Mandanten Zugriff
1946 auf bestimmte Funktionen zu geben. Einer Gruppe werden dafür vom
1947 Administrator gewisse Rechte zugeordnet. Weiterhin legt der
1948 Administrator fest, für welche Mandanten eine Gruppe gilt, und welche
1949 Benutzer Mitglieder in dieser Gruppe sind. Meldet sich ein Benutzer
1950 dann an einem Mandanten an, so erhält er alle Rechte von allen
1951 denjenigen Gruppen, die zum Einen dem Mandanten zugeordnet sind und in
1952 denen der Benutzer zum Anderen Mitglied ist,</para>
1954 <para>Die Reihenfolge, in der Datenbanken, Mandanten, Gruppen und
1955 Benutzer angelegt werden, kann im Prinzip beliebig gewählt werden. Die
1956 folgende Reihenfolge beinhaltet die wenigsten Arbeitsschritte:</para>
1958 <orderedlist numeration="arabic">
1960 <para>Datenbank anlegen</para>
1964 <para>Gruppen anlegen</para>
1968 <para>Benutzer anlegen und Gruppen als Mitglied zuordnen</para>
1972 <para>Mandanten anlegen und Gruppen sowie Benutzer zuweisen</para>
1977 <sect2 id="Datenbanken-anlegen">
1978 <title>Datenbanken anlegen</title>
1980 <para>Zuerst muss eine Datenbank angelegt werden. Verwenden Sie für
1981 den Datenbankzugriff den vorhin angelegten Benutzer (in unseren
1982 Beispielen ist dies ‘<literal>kivitendo</literal>’).</para>
1985 <sect2 id="Gruppen-anlegen">
1986 <title>Gruppen anlegen</title>
1988 <para>Eine Gruppe wird in der Gruppenverwaltung angelegt. Ihr muss ein
1989 Name gegeben werden, eine Beschreibung ist hingegen optional. Nach dem
1990 Anlegen können Sie die verschiedenen Bereiche wählen, auf die
1991 Mitglieder dieser Gruppe Zugriff haben sollen.</para>
1993 <para>Benutzergruppen werden zwar in der Authentifizierungsdatenbank
1994 gespeichert, gelten aber nicht automatisch für alle Mandanten. Der
1995 Administrator legt vielmehr fest, für welche Mandanten eine Gruppe
1996 gültig ist. Dies kann entweder beim Bearbeiten der Gruppe geschehen
1997 ("diese Gruppe ist gültig für Mandanten X, Y und Z"), oder aber wenn
1998 man einen Mandanten bearbeitet ("für diesen Mandanten sind die Gruppen
1999 A, B und C gültig").</para>
2001 <para>Wurden bereits Benutzer angelegt, so können hier die Mitglieder
2002 dieser Gruppe festgelegt werden ("in dieser Gruppe sind die Benutzer
2003 X, Y und Z Mitglieder"). Dies kann auch nachträglich beim Bearbeiten
2004 eines Benutzers geschehen ("dieser Benutzer ist Mitglied in den
2005 Gruppen A, B und C").</para>
2008 <sect2 id="Benutzer-anlegen">
2009 <title>Benutzer anlegen</title>
2011 <para>Beim Anlegen von Benutzern werden für viele Parameter
2012 Standardeinstellungen vorgenommen, die den Gepflogenheiten des
2013 deutschen Raumes entsprechen.</para>
2015 <para>Zwingend anzugeben ist der Loginname. Wenn die
2016 Passwortauthentifizierung über die Datenbank eingestellt ist, so kann
2017 hier auch das Benutzerpasswort gesetzt bzw. geändert werden. Ist
2018 hingegen die LDAP-Authentifizierung aktiv, so ist das Passwort-Feld
2021 <para>Hat man bereits Mandanten und Gruppen angelegt, so kann hier
2022 auch konfiguriert werden, auf welche Mandanten der Benutzer Zugriff
2023 hat bzw. in welchen Gruppen er Mitglied ist. Beide Zuweisungen können
2024 sowohl beim Benutzer vorgenommen werden ("dieser Benutzer hat Zugriff
2025 auf Mandanten X, Y, Z" bzw. "dieser Benutzer ist Mitglied in Gruppen
2026 X, Y und Z") als auch beim Mandanten ("auf diesen Mandanten haben
2027 Benutzer A, B und C Zugriff") bzw. bei der Gruppe ("in dieser Gruppe
2028 sind Benutzer A, B und C Mitglieder").</para>
2031 <sect2 id="Mandanten-anlegen">
2032 <title>Mandanten anlegen</title>
2034 <para>Ein Mandant besteht aus Administrationssicht primär aus einem
2035 eindeutigen Namen. Weiterhin wird hier hinterlegt, welche Datenbank
2036 als Mandantendatenbank benutzt wird. Hier müssen die Zugriffsdaten
2037 einer der eben angelegten Datenbanken eingetragen werden.</para>
2039 <para>Hat man bereits Benutzer und Gruppen angelegt, so kann hier auch
2040 konfiguriert werden, welche Benutzer Zugriff auf den Mandanten haben
2041 bzw. welche Gruppen für den Mandanten gültig sind. Beide Zuweisungen
2042 können sowohl beim Mandanten vorgenommen werden ("auf diesen Mandanten
2043 haben Benutzer X, Y und Z Zugriff" bzw. "für diesen Mandanten sind die
2044 Gruppen X, Y und Z gültig") als auch beim Benutzer ("dieser Benutzer
2045 hat Zugriff auf Mandanten A, B und C") bzw. bei der Gruppe ("diese
2046 Gruppe ist für Mandanten A, B und C gültig").</para>
2050 <sect1 id="Drucker--Systemverwaltung">
2051 <title>Drucker- und Systemverwaltung</title>
2053 <para>Im Administrationsmenü gibt es ferner noch die beiden Menüpunkte
2054 Druckeradministration und System.</para>
2056 <sect2 id="Druckeradministration">
2057 <title>Druckeradministration</title>
2059 <para>Unter dem Menüpunkt Druckeradministration lassen sich beliebig
2060 viele "Druckbefehle" im System verwalten. Diese Befehle werden
2061 mandantenweise zugeordnet. Unter Druckerbeschreibung wird der Namen
2062 des Druckbefehls festgelegt, der dann in der Druckerauswahl des Belegs
2063 angezeigt wird.</para>
2065 <para>Unter Druckbefehl definiert man den eigentlichen Druckbefehl,
2066 der direkt auf dem Webserver ausgeführt wird, bspw. 'lpr -P
2067 meinDrucker' oder ein kompletter Pfad zu einem Skript
2068 (/usr/local/src/kivitendo/scripts/pdf_druck_in_verzeichnis.sh). Wird
2069 ferner noch ein optionales Vorlagenkürzel verwendet, wird dieses
2070 Kürzel bei der Auswahl der Druckvorlagendatei mit einem Unterstrich
2071 ergänzt, ist bspw. das Kürzel 'epson_drucker' definiert, so wird beim
2072 Ausdruck eines Angebots folgende Vorlage geparst:
2073 sales_quotation_epson_drucker.tex.</para>
2077 <title>System sperren / entsperren</title>
2079 <para>Unter dem Menüpunkt System gibt es den Eintrag 'Installation
2080 sperren/entsperren'. Setzt man diese Sperre so ist der Zugang zu der
2081 gesamten kivitendo Installation gesperrt.</para>
2083 <para>Falls die Sperre gesetzt ist, erscheint anstelle der
2084 Anmeldemaske die Information: 'kivitendo ist momentan zwecks
2085 Wartungsarbeiten nicht zugänglich.'.</para>
2087 <para>Wichtig zu erwähnen ist hierbei noch, dass sich kivitendo
2088 automatisch 'sperrt', falls es bei einem Versionsupdate zu einem
2089 Datenbankfehler kam. Somit kann hier nicht aus Versehen mit einem
2090 inkonsistenten Datenbestand weitergearbeitet werden.</para>
2094 <sect1 id="config.sending-email"
2095 xreflabel="E-Mail-Versand aus kivitendo heraus">
2096 <title>E-Mail-Versand aus kivitendo heraus</title>
2098 <para>kivitendo kann direkt aus dem Programm heraus E-Mails versenden,
2099 z.B. um ein Angebot direkt an einen Kunden zu verschicken. Damit dies
2100 funktioniert, muss eingestellt werden, über welchen Server die E-Mails
2101 verschickt werden sollen. kivitendo unterstützt dabei zwei Mechanismen:
2102 Versand über einen lokalen E-Mail-Server (z.B. mit
2103 <productname>Postfix</productname> oder <productname>Exim</productname>,
2104 was auch die standardmäßig aktive Methode ist) sowie Versand über einen
2105 SMTP-Server (z.B. der des eigenen Internet-Providers).</para>
2107 <para>Welche Methode und welcher Server verwendet werden, wird über die
2108 Konfigurationsdatei <filename>config/kivitendo.conf</filename>
2109 festgelegt. Dort befinden sich alle Einstellungen zu diesem Thema im
2110 Abschnitt '<literal>[mail_delivery]</literal>'.</para>
2112 <sect2 id="config.sending-email.sendmail"
2113 xreflabel="E-Mail-Versand über lokalen E-Mail-Server">
2114 <title>Versand über lokalen E-Mail-Server</title>
2116 <para>Diese Methode bietet sich an, wenn auf dem Server, auf dem
2117 kivitendo läuft, bereits ein funktionsfähiger E-Mail-Server wie z.B.
2118 <productname>Postfix</productname>, <productname>Exim</productname>
2119 oder <productname>Sendmail</productname> läuft.</para>
2121 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter
2122 '<literal>method = sendmail</literal>' gesetzt sein. Dies ist
2123 gleichzeitig der Standardwert, falls er nicht verändert wird.</para>
2125 <para>Um zu kontrollieren, wie das Programm zum Einliefern gestartet
2126 wird, dient der Parameter '<literal>sendmail = ...</literal>'. Der
2127 Standardwert verweist auf das Programm
2128 <filename>/usr/bin/sendmail</filename>, das bei allen oben genannten
2129 E-Mail-Serverprodukten für diesen Zweck funktionieren sollte.</para>
2131 <para>Die Konfiguration des E-Mail-Servers selber würde den Rahmen
2132 dieses sprengen. Hierfür sei auf die Dokumentation des E-Mail-Servers
2136 <sect2 id="config.sending-email.smtp"
2137 xreflabel="E-Mail-Versand über einen SMTP-Server">
2138 <title>Versand über einen SMTP-Server</title>
2140 <para>Diese Methode bietet sich an, wenn kein lokaler E-Mail-Server
2141 vorhanden oder zwar einer vorhanden, dieser aber nicht konfiguriert
2144 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter
2145 '<literal>method = smtp</literal>' gesetzt sein. Die folgenden
2146 Parameter dienen dabei der weiteren Konfiguration:</para>
2150 <term><varname>hostname</varname></term>
2153 <para>Name oder IP-Adresse des SMTP-Servers. Standardwert:
2154 '<literal>localhost</literal>'</para>
2159 <term><varname>port</varname></term>
2162 <para>Portnummer. Der Standardwert hängt von der verwendeten
2163 Verschlüsselungsmethode ab. Gilt '<literal>security =
2164 none</literal>' oder '<literal>security = tls</literal>', so ist
2165 25 die Standardportnummer. Für '<literal>security =
2166 ssl</literal>' ist 465 die Portnummer. Muss normalerweise nicht
2167 geändert werden.</para>
2172 <term><varname>security</varname></term>
2175 <para>Wahl der zu verwendenden Verschlüsselung der Verbindung
2176 mit dem Server. Standardwert ist '<literal>none</literal>',
2177 wodurch keine Verschlüsselung verwendet wird. Mit
2178 '<literal>tls</literal>' wird TLS-Verschlüsselung eingeschaltet,
2179 und mit '<literal>ssl</literal>' wird Verschlüsselung via SSL
2180 eingeschaltet. Achtung: Für '<literal>tls</literal>' und
2181 '<literal>ssl</literal>' werden zusätzliche Perl-Module benötigt
2182 (siehe unten).</para>
2187 <term><varname>login</varname> und
2188 <varname>password</varname></term>
2191 <para>Falls der E-Mail-Server eine Authentifizierung verlangt,
2192 so können mit diesen zwei Parametern der Benutzername und das
2193 Passwort angegeben werden. Wird Authentifizierung verwendet, so
2194 sollte aus Sicherheitsgründen auch eine Form von Verschlüsselung
2195 aktiviert werden.</para>
2202 <sect1 id="Drucken-mit-kivitendo">
2203 <title>Drucken mit kivitendo</title>
2205 <para>Das Drucksystem von kivitendo benutzt von Haus aus LaTeX-Vorlagen.
2206 Um drucken zu können, braucht der Server ein geeignetes LaTeX System. Am
2207 einfachsten ist dazu eine <literal>texlive</literal> Installation. Unter
2208 debianoiden Betriebssystemen installiert man die Pakete mit:</para>
2210 <para><programlisting>apt install texlive-base-bin texlive-latex-recommended texlive-fonts-recommended \
2211 texlive-latex-extra texlive-lang-german ghostscript</programlisting></para>
2213 <para>Für Fedora benötigen Sie die folgenden Pakete:</para>
2215 <para><programlisting>dnf install texlive-collection-latex texlive-collection-latexextra \
2216 texlive-collection-latexrecommended texlive-collection-langgerman \
2217 texlive-collection-langenglish</programlisting></para>
2219 <para>Für openSUSE benötigen Sie die folgenden Pakete:</para>
2221 <para><programlisting>zypper install texlive-collection-latex texlive-collection-latexextra \
2222 texlive-collection-latexrecommended texlive-collection-langgerman \
2223 texlive-collection-langenglish</programlisting></para>
2225 <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>
2226 <para>kivitendo bringt drei alternative Vorlagensätze mit:</para>
2236 <para>rev-odt</para>
2240 <para>Der ehemalige Druckvorlagensatz "f-tex" wurde mit der Version
2241 3.5.6 entfernt, da er nicht mehr gepflegt wird.</para>
2243 <sect2 id="Vorlagenverzeichnis-anlegen"
2244 xreflabel="Vorlagenverzeichnis anlegen">
2245 <title>Vorlagenverzeichnis anlegen</title>
2247 <para>Es lässt sich ein initialer Vorlagensatz erstellen. Die
2248 LaTeX-System-Abhängigkeiten hierfür kann man prüfen mit:</para>
2250 <programlisting>./scripts/installation_check.pl -lv</programlisting>
2252 <para>Der Angemeldete Benutzer muss in einer Gruppe sein, die über das
2253 Recht "Konfiguration -> Mandantenverwaltung" verfügt. Siehe auch
2254 <xref linkend="Gruppen-anlegen"/>.</para>
2256 <para>Im Userbereich lässt sich unter: "<guimenu>System</guimenu>
2257 -> <guisubmenu>Mandantenverwaltung</guisubmenu> ->
2258 <guimenuitem>Verschiedenes</guimenuitem>" die Option "Neue
2259 Druckvorlagen aus Vorlagensatz erstellen" auswählen.</para>
2263 <para><option>Vorlagen auswählen</option>: Wählen Sie hier den
2264 Vorlagensatz aus, der kopiert werden soll
2265 (<filename>RB</filename>, <filename>marei</filename> oder
2266 <filename>odt-rev</filename>.)</para>
2270 <para><option>Neuer Name</option>: Der Verzeichnisname für den
2271 neuen Vorlagensatz. Dieser kann im Rahmen der üblichen Bedingungen
2272 für Verzeichnisnamen frei gewählt werden.</para>
2276 <para>Nach dem Speichern wird das Vorlagenverzeichnis angelegt und ist
2277 für den aktuellen Mandanten ausgewählt. Der gleiche Vorlagensatz kann,
2278 wenn er mal angelegt ist, bei mehreren Mandanten verwendet werden.
2279 Eventuell müssen Anpassungen (Logo, Erscheinungsbild, etc) noch
2280 vorgenommen werden. Den Ordner findet man im Dateisystem unter
2281 <filename>./templates/[Neuer Name]</filename></para>
2284 <sect2 id="Vorlagen-RB">
2285 <title>Der Druckvorlagensatz RB</title>
2287 <para>Hierbei handelt es sich um einen vollständigen LaTeX
2288 Dokumentensatz mit alternativem Design. Die odt oder html-Varianten
2289 sind nicht gepflegt.</para>
2291 <para>Die konzeptionelle Idee der Vorlagen wird <ulink
2292 url="http://www.kivitendo-support.de/vortraege/Lx-Office%20Anwendertreffen%20LaTeX-Druckvorlagen-Teil3-finale.pdf">hier</ulink>
2293 auf Folie 5 bis 10 vorgestellt. Informationen zur Anpassung an die
2294 eigenen Firmendaten finden sich in der Datei Readme.tex im
2295 Vorlagenverzeichnis.</para>
2297 <para>Eine kurze Übersicht der Features:</para>
2301 <para>Mehrsprachenfähig, mit Deutscher und Englischer
2306 <para>Zentrale Konfigurationsdateien, die für alle Belege benutzt
2307 werden, z.B. für Kopf- und Fußzeilen, und Infos wie
2312 <para>mehrere vordefinierte Varianten für
2313 Logos/Hintergrundbilder</para>
2317 <para>Berücksichtigung für Steuerzonen "EU mit USt-ID Nummer" oder
2318 "Außerhalb EU"</para>
2323 <sect2 id="Vorlagen-rev-odt">
2324 <title>Der Druckvorlagensatz rev-odt</title>
2326 <para>Hierbei handelt es sich um einen Dokumentensatz der mit
2327 odt-Vorlagen erstellt wurde. Es gibt in dem Verzeichnis eine
2328 Readme-Datei, die eventuell aktueller als die Dokumentation hier ist.
2329 Die odt-Vorlagen in diesem Verzeichnis "rev-odt" wurden von revamp-it,
2330 Zürich erstellt und werden laufend aktualisiert. Ein paar der
2331 Formulierungen in den Druckvorlagen entsprechen dem Schweizer
2332 Sprachgebrauch, z.B. "Offerte" oder "allfällig".</para>
2334 <para>Hinweis zum Einsatz des Feldes "Land" bei den Stammdaten für
2335 KundInnen und LieferantInnen, sowie bei Lieferadressen: Die in diesem
2336 Vorlagensatz vorhandenen Vorlagen erwarten für "Land" das
2337 entsprechende Kürzel, das in Adressen vor die Postleitzahl gesetzt
2338 wird. Das Feld kann auch komplett leer bleiben. Wer dies anders
2339 handhaben möchte, muss die Vorlagen entsprechend anpassen.</para>
2341 <para>odt-Vorlagen können mit LibreOffice oder OpenOffice editiert und
2342 den eigenen Bedürfnissen angepasst werden. Wichtig beim Editieren von
2343 if-Blöcken ist, dass immer der gesamte Block überschrieben werden muss
2344 und nicht nur Teile davon, da dies sonst oft zu einer odt-Datei führt,
2345 die vom Parser nicht korrekt gelesen werden kann.</para>
2347 <para>Mahnungen können unter folgenden Einschränkungen mit den
2348 odt-Vorlagen im Vorlagensatz rev-odt erzeugt werden:</para>
2352 <para>als Druckoption steht nur 'PDF(OpenDocument/OASIS)' zur
2353 Verfügung, das heisst, die Mahnungen werden als PDF-Datei
2358 <para>für jede Rechnung muss eine eigene Mahnung erzeugt werden
2359 (auch wenn bei einzelnen KundInnen mehrere überfällige Rechnungen
2360 vorhanden sind).</para>
2364 <para>Mehrere Mahnungen für eine Kundin / einen Kunden werden zu einer
2365 PDF-Datei zusammengefasst</para>
2367 <para>Die Vorlagen zahlungserinnerung.odt sowie mahnung.odt sind für
2368 das Erstellen einer Zahlungserinnerung bzw. Mahnung selbst vorgesehen,
2369 die Vorlage mahnung_invoice.odt für das Erstellen einer Rechnung über
2370 die verrechneten Mahngebühren und Verzugszinsen.</para>
2372 <para>Zur Zeit gibt es in kivitendo noch keine Möglichkeit,
2373 odt-Vorlagen bei Briefen und Pflichtenheften einzusetzen.
2374 Entsprechende Vorlagen sind deshalb nicht vorhanden.</para>
2376 <para>Fehlermeldungen, Anregungen und Wünsche bitte senden an:
2377 empfang@revamp-it.ch</para>
2380 <sect2 id="allgemeine-hinweise-zu-latex">
2381 <title>Allgemeine Hinweise zu LaTeX Vorlagen</title>
2383 <para>In den allermeisten Installationen sollte das Drucken jetzt
2384 schon funktionieren. Sollte ein Fehler auftreten, wirft TeX sehr lange
2385 Fehlerbeschreibungen, der eigentliche Fehler ist immer die erste
2386 Zeile, die mit einem Ausrufezeichen anfängt. Häufig auftretende Fehler
2387 sind zum Beispiel:</para>
2391 <para>! LaTeX Error: File `eurosym.sty' not found. Die
2392 entsprechende LaTeX-Bibliothek wurde nicht gefunden. Das tritt vor
2393 allem bei Vorlagen aus der Community auf. Installieren Sie die
2394 entsprechenden Pakete.</para>
2398 <para>! Package inputenc Error: Unicode char \u8:... set up for
2399 use with LaTeX. Dieser Fehler tritt auf, wenn sie versuchen mit
2400 einer Standardinstallation exotische utf8 Zeichen zu drucken.
2401 TeXLive unterstützt von Haus nur romanische Schriften und muss mit
2402 diversen Tricks dazu gebracht werden andere Zeichen zu
2403 akzeptieren. Adere TeX Systeme wie XeTeX schaffen hier
2408 <para>Wird gar kein Fehler angezeigt, sondern nur der Name des
2409 Templates, heißt das normalerweise, dass das LaTeX Binary nicht
2410 gefunden wurde. Prüfen Sie den Namen in der Konfiguration (Standard:
2411 <literal>pdflatex</literal>), und stellen Sie sicher, dass pdflatex
2412 (oder das von Ihnen verwendete System) vom Webserver ausgeführt werden
2415 <para>Wenn sich das Problem nicht auf Grund der Ausgabe im Webbrowser
2416 verifizieren lässt:</para>
2420 <para>editiere [kivitendo-home]/config/kivitendo.conf und ändere
2421 "keep_temp_files" auf 1</para>
2423 <para><programlisting>keep_temp_files = 1;</programlisting></para>
2427 <para>bei fastcgi oder mod_perl den Webserver neu Starten</para>
2431 <para>Nochmal einen Druckversuch im Webfrontend auslösen</para>
2435 <para>wechsel in das users Verzeichnis von kivitendo</para>
2437 <para><programlisting>cd [kivitendo-home]/users</programlisting></para>
2441 <para>LaTeX Suchpfad anpassen:</para>
2443 <para><programlisting>export TEXINPUTS=".:[kivitendo-home]/templates/[aktuelles_template_verzeichniss]:"</programlisting></para>
2447 <para>Finde heraus, welche Datei kivitendo beim letzten Durchlauf
2450 <para><programlisting>ls -lahtr ./1*.tex</programlisting></para>
2452 <para>Es sollte die letzte Datei ganz unten sein</para>
2456 <para>für besseren Hinweis auf Fehler texdatei nochmals
2459 <para><programlisting>pdflatex ./1*.tex</programlisting></para>
2461 <para>in der *.tex datei nach dem Fehler suchen.</para>
2467 <sect1 id="OpenDocument-Vorlagen">
2468 <title>OpenDocument-Vorlagen</title>
2470 <para>kivitendo unterstützt die Verwendung von Vorlagen im
2471 OpenDocument-Format, wie es LibreOffice oder OpenOffice (ab Version 2)
2472 erzeugen. kivitendo kann dabei sowohl neue OpenDocument-Dokumente als
2473 auch aus diesen direkt PDF-Dateien erzeugen. Um die Unterstützung von
2474 OpenDocument-Vorlagen zu aktivieren muss in der Datei
2475 <filename>config/kivitendo.conf</filename> die Variable
2476 <literal>opendocument</literal> im Abschnitt
2477 <literal>print_templates</literal> auf ‘<literal>1</literal>’ stehen.
2478 Dieses ist die Standardeinstellung.</para>
2480 <para>Während die Erzeugung von reinen OpenDocument-Dateien keinerlei
2481 weitere Software benötigt, wird zur Umwandlung dieser Dateien in PDF
2482 LibreOffice oder OpenOffice benötigt. Soll dieses Feature genutzt
2483 werden, so muss neben LibreOffice oder OpenOffice auch der “X virtual
2484 frame buffer” (xvfb) installiert werden. Bei Debian ist er im Paket
2485 “xvfb” enthalten. Andere Distributionen enthalten ihn in anderen
2488 <para>Nach der Installation müssen in der Datei
2489 <filename>config/kivitendo.conf</filename> im Abschnitt
2490 <literal>applications</literal> zwei weitere Variablen angepasst
2493 <para><literal>openofficeorg_writer</literal> muss den vollständigen
2494 Pfad zu LibreOffice oder OpenOffice enthalten. Dabei dürfen keine
2495 Anführungszeichen eingesetzt werden.</para>
2497 <para>Beispiel für Debian oder Ubuntu:</para>
2499 <programlisting>openofficeorg_writer = /usr/bin/libreoffice</programlisting>
2501 <para><literal>xvfb</literal> muss den Pfad zum “X virtual frame buffer”
2504 <para>Zusätzlich gibt es zwei verschiedene Arten, wie kivitendo mit
2505 LibreOffice bzw. OpenOffice kommuniziert. Die erste Variante, die
2506 benutzt wird, wenn die Variable <literal>$openofficeorg_daemon</literal>
2507 gesetzt ist, startet ein LibreOffice oder OpenOffice, das auch nach der
2508 Umwandlung des Dokumentes gestartet bleibt. Bei weiteren Umwandlungen
2509 wird dann diese laufende Instanz benutzt. Der Vorteil ist, dass die Zeit
2510 zur Umwandlung deutlich reduziert wird, weil nicht für jedes Dokument
2511 ein LibreOffice bzw. OpenOffice gestartet werden muss. Der Nachteil ist,
2512 dass diese Methode Python und die Python-UNO-Bindings benötigt, die
2513 Bestandteil von LibreOffice bzw. OpenOffice sind.</para>
2516 <para>Für die Verbindung zu LibreOffice bzw. OpenOffice wird
2517 normalerweise der Python-Interpreter
2518 <filename>/usr/bin/python</filename> benutzt. Sollte dies nicht der
2519 richtige sein, so kann man mit zwei Konfigurationsvariablen
2520 entscheiden, welcher Python-Interpreter genutzt wird. Mit der Option
2521 <literal>python_uno</literal> aus dem Abschnitt
2522 <literal>applications</literal> wird der Interpreter selber
2523 festgelegt; sie steht standardmäßig auf dem eben erwähnten Wert
2524 <literal>/usr/bin/python</literal>.</para>
2526 <para>Zusätzlich ist es möglich, Pfade anzugeben, in denen Python
2527 neben seinen normalen Suchpfaden ebenfalls nach Modulen gesucht wird,
2528 z.B. falls sich diese in einem gesonderten LibreOffice- bzw.
2529 OpenOffice-Verzeichnis befinden. Diese zweite Variable heißt
2530 <literal>python_uno_path</literal> und befindet sich im Abschnitt
2531 <literal>environment</literal>. Sie ist standardmäßig leer. Werden
2532 hier mehrere Pfade angegeben, so müssen diese durch Doppelpunkte
2533 voneinander getrennt werden. Der Inhalt wird an den Python-Interpreter
2534 über die Umgebungsvariable <literal>PYTHONPATH</literal>
2538 <para>Ist <literal>$openofficeorg_daemon</literal> nicht gesetzt, so
2539 wird für jedes Dokument LibreOffice bzw. OpenOffice neu gestartet und
2540 die Konvertierung mit Hilfe eines Makros durchgeführt. Dieses Makro muss
2541 in der Dokumentenvorlage enthalten sein und
2542 “Standard.Conversion.ConvertSelfToPDF()” heißen. Die Beispielvorlage
2543 ‘<literal>templates/print/rev-odt/invoice.odt</literal>’ enthält ein
2544 solches Makro, das in jeder anderen Dokumentenvorlage ebenfalls
2545 enthalten sein muss.</para>
2547 <para>Als letztes muss herausgefunden werden, welchen Namen OpenOffice
2548 bzw. LibreOffice dem Verzeichnis mit den Benutzereinstellungen gibt.
2549 Unter Debian ist dies momentan <literal>~/.config/libreoffice</literal>.
2550 kivitendo verwendet das Verzeichnis
2551 <literal>users/.openoffice.org2</literal>. Eventuell muss dieses
2552 Verzeichnis umbenannt werden.</para>
2554 <para>Dieses Verzeichnis, wie auch das komplette
2555 <literal>users</literal>-Verzeichnis, muss vom Webserver beschreibbar
2556 sein. Dieses wurde bereits erledigt (siehe <xref
2557 linkend="Manuelle-Installation-des-Programmpaketes"/>), kann aber erneut
2558 überprüft werden, wenn die Konvertierung nach PDF fehlschlägt.</para>
2561 <title>OpenDocument (odt) Druckvorlagen mit Makros</title>
2563 <para>OpenDocument Vorlagen können Makros enthalten, welche komplexere
2564 Aufgaben erfüllen.</para>
2566 <para>Der Vorlagensatz "rev-odt" enthält solche Vorlagen mit <emphasis
2567 role="bold">Schweizer Bank-Einzahlungsscheinen (BESR)</emphasis>.
2568 Diese Makros haben die Aufgabe, die in den Einzahlungsscheinen
2569 benötigte Referenznummer und Kodierzeile zu erzeugen. Hier eine kurze
2570 Beschreibung, wie die Makros aufgebaut sind, und was bei ihrer Nutzung
2571 zu beachten ist (<emphasis role="bold">in fett sind nötige einmalige
2572 Anpassungen aufgeführt</emphasis>):</para>
2575 <title>Bezeichnung der Vorlagen</title>
2577 <para>Rechnung: invoice_besr.odt, Auftrag:
2578 sales_order_besr.odt</para>
2581 <sect3 id="opendocument-druckvorlagen-mit-makros.vorbereitungen">
2582 <title>Vorbereitungen im Adminbereich</title>
2584 <para>Damit beim Erstellen von Rechnungen und Aufträgen neben der
2585 Standardvorlage ohne Einzahlungsschein weitere Vorlagen (z.B. mit
2586 Einzahlungsschein) auswählbar sind, muss für jedes Vorlagen-Suffix
2587 ein Drucker eingerichtet werden:</para>
2591 <para>Druckeradministration → Drucker hinzufügen</para>
2595 <para>Mandant wählen</para>
2599 <para>Druckerbeschreibung → aussagekräftiger Text: wird in der
2600 Auftrags- bzw. Rechnungsmaske als Auswahl angezeigt (z.B. mit
2601 Einzahlungsschein Bank xy)</para>
2605 <para>Druckbefehl → beliebiger Text (hat für das Erzeugen von
2606 Aufträgen oder Rechnungen als odt-Datei keine Bedeutung, darf
2607 aber nicht leer sein)</para>
2611 <para>Vorlagenkürzel → besr bzw. selbst gewähltes Vorlagensuffix
2612 (muss genau der Zeichenfolge entsprechen, die zwischen
2613 "invoice_" bzw. "sales_order_" und ".odt" steht.)</para>
2617 <para>speichern</para>
2623 <title>Benutzereinstellungen</title>
2625 <para>Wer den Ausdruck mit Einzahlungsschein als Standardeinstellung
2626 im Rechnungs- bzw. Auftragsformular angezeigt haben möchte, kann
2627 dies persönlich für sich bei den Benutzereinstellungen
2628 konfigurieren:</para>
2632 <para>Programm → Benutzereinstellungen → Druckoptionen</para>
2636 <para>Standardvorlagenformat → OpenDocument/OASIS</para>
2640 <para>Standardausgabekanal → Bildschirm</para>
2644 <para>Standarddrucker → gewünschte Druckerbeschreibung auswählen
2645 (z.B. mit Einzahlungsschein Bank xy)</para>
2649 <para>Anzahl Kopien → leer</para>
2653 <para>speichern</para>
2659 <title>Aufbau und nötige Anpassungen der Vorlagen</title>
2661 <para>In der Vorlage sind als Modul "BESR" 4 Makros gespeichert, die
2662 aus dem von kivitendo erzeugten odt-Dokument die korrekte
2663 Referenznummer inklusive Prüfziffer sowie die Kodierzeile in
2664 OCRB-Schrift erzeugen und am richtigen Ort ins Dokument
2669 <para>Für den Einzahlungsschein ist die letzte Seite des
2670 Dokuments reserviert</para>
2674 <para>Direkt über dem Einzahlungsschein enthält die Vorlage eine
2675 Zeile mit folgenden Angaben (<emphasis
2676 role="bold">Bank-Konto-Identifikationsnummer und
2677 Postkonto-Nummer der Bank müssen gemäss Angaben der jeweiligen
2678 Bank angepasst werden</emphasis>):<itemizedlist>
2680 <para>DDDREF: 4 Werte zum Bilden der Referenznummer
2681 (jeweils durch einen Leerschlag getrennt): <itemizedlist>
2683 <para>erster Wert: <emphasis
2684 role="bold">Bank-Konto-Identifikation</emphasis>
2685 (nur Ziffern, maximal 6), <emphasis role="bold">muss
2686 angepasst werden</emphasis>.</para>
2690 <para>zweiter Wert: <%customernumber%>
2691 (Kundennummer: nur Ziffern, maximal 6)</para>
2695 <para>dritter Wert: <%ordnumber%>
2696 (Auftragsnummer bei Auftragsvorlage
2697 sales_oder_besr.odt, sonst 0) maximal 7 Ziffern,
2698 führende Buchstaben werden vom Makro entfernt</para>
2702 <para>vierter Wert: <%invnumber%>
2703 (Rechnungsnummer bei Rechnungsvorlage
2704 invoice_besr.odt, sonst 0) maximal 7 Ziffern,
2705 führende Buchstaben werden vom Makro entfernt</para>
2707 </itemizedlist></para>
2711 <para>DDDKONTO: <emphasis role="bold">Postkonto-Nummer der
2712 Bank, muss angepasst werden</emphasis>.</para>
2716 <para>DDDBETRAG: <%total%> Einzahlungsbetrag oder 0,
2717 falls Einzahlungsschein ohne Betrag</para>
2721 <para>DDDEND: muss am Ende der Zeile vorhanden sein</para>
2723 </itemizedlist></para>
2727 <para><emphasis role="bold">Im Einzahlungsschein selbst müssen
2728 der Name und die Adresse der Bank, die Postkonto-Nummer der
2729 Bank, sowie der eigene Firmenname und die Firmenadresse
2730 angepasst werden.</emphasis> Dabei ist darauf zu achten, dass
2731 sich die Positionen der Postkonto-Nummern der Bank, sowie der
2732 Zeichenfolgen dddfr, DDDREF1, DDDREF2, 609, DDDKODIERZEILE nicht
2738 <screeninfo>Rechnungsvorlage Schweizer Bank-Einzahlungsschein - zu
2739 ändernde Einträge in rot</screeninfo>
2743 <imagedata fileref="images/Einzahlungsschein_Makro.png"/>
2750 <title>Auswahl der Druckvorlage in kivitendo beim Erzeugen einer
2751 odt-Rechnung (analog bei Auftrag)</title>
2753 <para>Im Fussbereich der Rechnungsmaske muss neben Rechnung,
2754 OpenDocument/OASIS und Bildschirm die im Adminbereich erstellte
2755 Druckerbeschreibung ausgewählt werden, falls diese nicht bereits bei
2756 den Benutzereinstellungen als persönlicher Standard gewählt
2761 <title>Makroeinstellungen in LibreOffice anpassen</title>
2763 <para>Falls beim Öffnen einer von kivitendo erzeugten odt-Rechnung
2764 die Meldung kommt, dass Makros aus Sicherheitsgründen nicht
2765 ausgeführt werden, so müssen folgende Einstellungen in LibreOffice
2766 angepasst werden:</para>
2770 <para>Extras → Optionen → Sicherheit → Makrosicherheit</para>
2774 <para>Sicherheitslevel auf "Mittel" einstellen (Diese
2775 Einstellung muss auf jedem Computer durchgeführt werden, mit dem
2776 von kivitendo erzeugte odt-Rechnungen oder Aufträge geöffnet
2781 <para>Beim Öffnen einer odt-Rechnung oder eines odt-Auftrags bei
2782 der entsprechenden Nachfrage "Makros ausführen"
2785 <para><emphasis role="bold">Wichtig</emphasis>: die Makros sind
2786 so eingestellt, dass sie beim Öffnen der Vorlagen selbst nicht
2787 ausgeführt werden. Das heisst für das Ansehen und Bearbeiten der
2788 Vorlagen sind keine speziellen Einstellungen in LibreOffice
2796 <title>Schweizer QR-Rechnung mit OpenDocument Vorlagen</title>
2799 <title>Übersicht</title>
2801 <para>Mit der Version 3.6.0 unterstützt Kivitendo die Erstellung von
2802 Schweizer QR-Rechnungen gemäss <ulink
2803 url="https://www.paymentstandards.ch/dam/downloads/ig-qr-bill-de.pdf">Swiss
2804 Payment Standards, Version 2.2</ulink>. Implementiert sind hierbei die
2809 <para><emphasis role="bold">QR-IBAN mit
2810 QR-Referenz</emphasis></para>
2814 <para><emphasis role="bold">IBAN ohne Referenz</emphasis></para>
2818 <para>Der Vorlagensatz "rev-odt" enthält die Vorlage
2819 <literal>invoice_qr.odt</literal>, welche für die Erstellung von
2820 QR-Rechnungen vorgesehen ist. Damit diese verwendet werden kann muss
2821 wie obenstehend beschrieben ein Drucker hinzugefügt werden (siehe
2822 <xref linkend="opendocument-druckvorlagen-mit-makros.vorbereitungen"/>
2823 ). Alternativ kann die Vorlage umbenannt werden in
2824 <literal>invoice.odt</literal>.</para>
2826 <para>Die Vorlage <literal>invoice_qr.odt</literal> kann beliebig
2827 angepasst werden. Zwingend muss diese jedoch das QR-Code Platzhalter
2828 Bild, als eingebettetes Bild, enthalten. Da dieses beim
2829 Ausdrucken/Erzeugen der Rechnung durch das neu generierte QR-Code
2830 Bild ersetzt wird.</para>
2834 <title>Einstellungen</title>
2837 <title>Mandantenkonfiguration</title>
2839 <para>Unter <emphasis>System → Mandantenkonfiguration →
2840 Features</emphasis>. Im Abschnitt <emphasis>Einkauf und
2841 Verkauf</emphasis>, beim Punkt <emphasis>Verkaufsrechnungen mit
2842 Schweizer QR-Rechnung erzeugen</emphasis>, die gewünschte Variante
2847 <title>Konfiguration der Bankkonten</title>
2849 <para>Unter <emphasis>System → Bankkonten</emphasis> muss bei
2850 mindestens einem Bankkonto die Option <emphasis>Nutzung mit
2851 Schweizer QR-Rechnung</emphasis> auf <emphasis
2852 role="bold">Ja</emphasis> gestellt werden.</para>
2855 <para>Für die Variante <emphasis role="bold">QR-IBAN mit
2856 QR-Referenz</emphasis> muss dieses Konto unter IBAN eine gültige
2857 <emphasis role="bold">QR-IBAN Nummer</emphasis> enthalten. Diese
2858 unterscheidet sich von der regulären IBAN.</para>
2860 <para>Zusätzlich muss eine gültige <emphasis role="bold">Bankkonto
2861 Identifikationsnummer</emphasis> angegeben werden
2864 <para>Diese werden von der jeweiligen Bank vergeben.</para>
2867 <para>Sind mehrere Konten ausgewählt wird das erste
2872 <title>Rechnungen ohne Betrag</title>
2874 <para>Für Rechnungen ohne Betrag (z.B. Spenden) kann, in der
2875 jeweiligen Rechnung, die Checkbox <emphasis>QR-Rechnung ohne
2876 Betrag</emphasis> aktiviert werden. Diese Checkbox erscheint nur,
2877 wenn QR-Rechnungen in der Mandantenkonfiguration aktiviert sind
2878 (variante ausgewählt).</para>
2880 <para>Dies wirkt sich lediglich auf den erzeugten QR-Code aus. Die
2881 Vorlage muss separat angepasst und ausgewählt werden.</para>
2886 <title>Adressdaten</title>
2888 <para>Die Adressdaten zum Zahlungsempfänger werden aus der
2889 Mandantenkonfiguration entnommen. Unter <emphasis>System →
2890 Mandantenkonfiguration → Verschiedenes</emphasis>, Abschnitt
2891 <emphasis>Firmenname und -adresse.</emphasis></para>
2893 <para>Die Adressdaten zum Zahlungspflichtigen stammen aus den
2894 Kundendaten der jeweiligen Rechnung.</para>
2896 <para>Die Adressen müssen inklusive Land angegeben werden. Akzeptiert
2897 werden Ländername oder Ländercode, also z.B. "Schweiz" oder "CH".
2900 <para>Diese können in der Vorlage mit den jeweiligen Variablen
2901 eingetragen werden. Siehe auch: <xref
2902 linkend="dokumentenvorlagen-und-variablen"/></para>
2904 <para>Der erzeugte QR-Code verwendet Adress-Typ "K" (Kombinierte
2905 Adressfelder, 2 Zeilen).</para>
2909 <title>Referenznummer</title>
2911 <para>Die Referenznummer wird in Kivitendo erzeugt und setzt sich
2912 wiefolgt zusammen:</para>
2916 <para>Bankkonto Identifikationsnummer (6-stellig)</para>
2920 <para>Kundennummer (6-stellig, mit führenden Nullen
2925 <para>Auftragsnummer (7-stellig, mit führenden Nullen
2930 <para>Rechnungsnummer (7-stellig, mit führenden Nullen
2935 <para>Prüfziffer (1-stellig, berechnet mittels modulo 10,
2940 <para>Es sind lediglich Ziffern erlaubt. Allfällige Prefixe mit
2941 Buchstaben werden entfernt und fehlende Stellen werden mit führenden
2942 Nullen aufgefüllt.</para>
2946 <title>Zusätzliche Variablen für Vorlage</title>
2948 <para>Zusätzlich zu den in der Vorlage standardmässig verfügbaren
2949 Variablen (siehe <xref linkend="dokumentenvorlagen-und-variablen"/>),
2950 werden die folgenden Variablen erzeugt:</para>
2954 <term>ref_number_formatted</term>
2957 <para>Referenznummer formatiert mit Leerzeichen, z.B.: 21 00000
2958 00003 13947 14300 09017</para>
2963 <term>iban_formatted</term>
2966 <para>IBAN formatiert mit Leerzeichen</para>
2971 <term>amount_formatted</term>
2974 <para>Betrag formatiert mit Tausendertrennzeichen Leerschlag,
2975 z.B.: 1 005.55</para>
2983 <sect1 id="nomenclature">
2984 <title>Nomenklatur</title>
2986 <sect2 id="booking.dates">
2987 <title>Datum bei Buchungen</title>
2989 <para>Seit der Version 3.5 werden für Buchungen in kivitendo
2990 einheitlich folgende Bezeichnungen verwendet:</para>
2994 <para><option>Erfassungsdatum</option> (en: <option>Entry
2995 Date</option>, code: <option>Gldate</option>)</para>
2997 <para>bezeichnet das Datum, an dem die Buchung in kivitendo
2998 erfasst wurde.</para>
3002 <para><option>Buchungsdatum</option> (en: <option>Booking
3003 Date</option>, code: <option>Transdate</option>)</para>
3005 <para>bezeichnet das buchhaltungstechnisch für eine Buchung
3006 relevante Datum</para>
3008 <para>Das <option>Rechnungsdatum</option> bei Verkaufs- und
3009 Einkaufsrechnungen entspricht dem Buchungsdatum. Das heisst, in
3010 Berichten wie dem Buchungsjournal, in denen eine Spalte
3011 <option>Buchungsdatum</option> angezeigt werden kann, erscheint
3012 hier im Fall von Rechnungen das Rechnungsdatum.</para>
3016 <para>Bezieht sich ein verbuchter Beleg auf einen Zeitpunkt, der
3017 nicht mit dem Buchungsdatum übereinstimmt, so kann dieses Datum
3018 momentan in kivitendo nur unter Bemerkungen erfasst werden.</para>
3020 <para>Möglicherweise wird für solche Fälle in einer späteren
3021 Version von kivitendo ein dritter Datumswert für Buchungen
3022 erstellt. (Beispiel: Einkaufsbeleg stammt aus einem früheren Jahr,
3023 das bereits buchhaltungstechnisch abgeschlossen wurde, und muss
3024 deshalb später verbucht werden.)</para>
3030 <sect1 id="config.eur">
3031 <title>Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung:
3034 <sect2 id="config.eur.introduction"
3035 xreflabel="Einführung in die Konfiguration zur EUR">
3036 <title>Einführung</title>
3038 <para>kivitendo besaß bis inklusive Version 2.6.3 einen
3039 Konfigurationsparameter namens <varname>eur</varname>, der sich in der
3040 Konfigurationsdatei <filename>config/kivitendo.conf</filename> (damals
3041 noch <filename>config/lx_office.conf</filename>) befand. Somit galt er
3042 für alle Mandanten, die in dieser Installation benutzt wurden.</para>
3044 <para>Mit der nachfolgenden Version wurde der Parameter zum Einen in
3045 die Mandantendatenbank verschoben und dabei auch gleich in drei
3046 Einzelparameter aufgeteilt, mit denen sich das Verhalten genauer
3047 steuern lässt.</para>
3050 <sect2 id="config.eur.parameters"
3051 xreflabel="Konfigurationsparameter für EUR">
3052 <title>Konfigurationsparameter</title>
3054 <para>Es gibt drei Parameter, die die Gewinnermittlungsart,
3055 Versteuerungsart und die Warenbuchungsmethode regeln:</para>
3059 <term><varname>profit_determination</varname></term>
3062 <para>Dieser Parameter legt die Berechnungsmethode für die
3063 Gewinnermittlung fest. Er enthält entweder
3064 <literal>balance</literal> für
3065 Betriebsvermögensvergleich/Bilanzierung oder
3066 <literal>income</literal> für die
3067 Einnahmen-Überschuss-Rechnung.</para>
3072 <term><varname>accounting_method</varname></term>
3075 <para>Dieser Parameter steuert die Buchungs- und
3076 Berechnungsmethoden für die Versteuerungsart. Er enthält
3077 entweder <literal>accrual</literal> für die Soll-Versteuerung
3078 oder <literal>cash</literal> für die Ist-Versteuerung.</para>
3083 <term><varname>inventory_system</varname></term>
3086 <para>Dieser Parameter legt die Warenbuchungsmethode fest. Er
3087 enthält entweder <literal>perpetual</literal> für die
3088 Bestandsmethode oder <literal>periodic</literal> für die
3089 Aufwandsmethode.</para>
3094 <para>Zum Vergleich der Funktionalität bis und nach 2.6.3:
3095 <varname>eur</varname> = 1 bedeutete Einnahmen-Überschuss-Rechnung,
3096 Ist-Versteuerung und Aufwandsmethode. <varname>eur</varname> = 0
3097 bedeutete hingegen Bilanzierung, Soll-Versteuerung und
3098 Bestandsmethode.</para>
3100 <para>Die Konfiguration "<varname>eur</varname>" unter
3101 <varname>[system]</varname> in der <link
3102 linkend="config.config-file">Konfigurationsdatei</link>
3103 <filename>config/kivitendo.conf</filename> wird nun nicht mehr
3104 benötigt und kann entfernt werden. Dies muss manuell geschehen.</para>
3107 <sect2 id="config.eur.setting-parameters">
3108 <title>Festlegen der Parameter</title>
3110 <para>Beim Anlegen eines neuen Mandanten bzw. einer neuen Datenbank in
3111 der Admininstration können diese Optionen nun unabhängig voneinander
3112 eingestellt werden.</para>
3114 <para>Für die Schweiz sind folgende Einstellungen üblich:
3117 <para>Sollversteuerung</para>
3121 <para>Aufwandsmethode</para>
3125 <para>Bilanzierung</para>
3127 </itemizedlist> Diese Einstellungen werden automatisch beim
3128 Erstellen einer neuen Datenbank vorausgewählt, wenn in
3129 <filename>config/kivitendo.conf</filename> unter
3130 <varname>[system]</varname> <literal>default_manager = swiss</literal>
3131 eingestellt ist.</para>
3133 <para>Beim Upgrade bestehender Mandanten wird eur ausgelesen und die
3134 Variablen werden so gesetzt, daß sich an der Funktionalität nichts
3137 <para>Die aktuelle Konfiguration wird unter Nummernkreise und
3138 Standardkonten unter dem neuen Punkt "Einstellungen" (read-only)
3139 angezeigt. Unter <guimenu>System</guimenu> →
3140 <guisubmenu>Mandantenkonfiguration</guisubmenu> können die
3141 Einstellungen auch geändert werden. Dabei ist zu beachten, dass eine
3142 Änderung vorhandene Daten so belässt und damit evtl. die Ergebnisse
3143 verfälscht. Dies gilt vor Allem für die Warenbuchungsmethode (siehe
3144 auch <link linkend="config.eur.inventory-system-perpetual">
3145 Bemerkungen zur Bestandsmethode</link>).</para>
3148 <sect2 id="config.eur.inventory-system-perpetual">
3149 <title>Bemerkungen zur Bestandsmethode</title>
3151 <para>Die Bestandsmethode ist eigentlich eine sehr elegante Methode,
3152 funktioniert in kivitendo aber nur unter bestimmten Bedingungen:
3153 Voraussetzung ist, daß auch immer alle Einkaufsrechnungen gepflegt
3154 werden, und man beim Jahreswechsel nicht mit einer leeren Datenbank
3155 anfängt, da bei jedem Verkauf anhand der gesamten Rechnungshistorie
3156 der Einkaufswert der Ware nach dem FIFO-Prinzip aus den
3157 Einkaufsrechnungen berechnet wird.</para>
3159 <para>Die Bestandsmethode kann vom Prinzip her also nur funktioneren,
3160 wenn man mit den Buchungen bei Null anfängt, und man kann auch nicht
3161 im laufenden Betrieb von der Aufwandsmethode zur Bestandsmethode
3165 <sect2 id="config.eur.knonw-issues">
3166 <title>Bekannte Probleme</title>
3168 <para>Bei bestimmten Berichten kann man derzeit noch inviduell
3169 einstellen, ob man nach Ist- oder Sollversteuerung auswertet, und es
3170 werden im Code Variablen wie $accrual oder $cash gesetzt. Diese
3171 Codestellen wurden noch nicht angepasst, sondern nur die, wo bisher
3172 die Konfigurationsvariable
3173 <varname>$::lx_office_conf{system}->{eur}</varname> ausgewertet
3176 <para>Es fehlen Hilfetext beim Neuanlegen eines Mandanten, was die
3177 Optionen bewirken, z.B. mit zwei Standardfällen.</para>
3181 <sect1 id="config.skr04-update-3804">
3182 <title>SKR04 19% Umstellung für innergemeinschaftlichen Erwerb</title>
3184 <sect2 id="config.skr04-update-3804.introduction">
3185 <title>Einführung</title>
3187 <para>Die Umsatzsteuerumstellung auf 19% für SKR04 für die
3188 Steuerschlüssel "EU ohne USt-ID Nummer" ist erst 2010 erfolgt.
3189 kivitendo beinhaltet ein Upgradeskript, das das Konto 3804 automatisch
3190 erstellt und die Steuereinstellungen korrekt einstellt. Hat der
3191 Benutzer aber schon selber das Konto 3804 angelegt, oder gab es schon
3192 Buchungen im Zeitraum nach dem 01.01.2007 auf das Konto 3803, wird das
3193 Upgradeskript vorsichtshalber nicht ausgeführt, da der Benutzer sich
3194 vielleicht schon selbst geholfen hat und mit seinen Änderungen
3195 zufrieden ist. Die korrekten Einstellungen kann man aber auch per Hand
3196 ausführen. Nachfolgend werden die entsprechenden Schritte anhand von
3197 Screenshots dargestellt.</para>
3199 <para>Für den Fall, daß Buchungen mit der Steuerschlüssel "EU ohne
3200 USt.-IdNr." nach dem 01.01.2007 erfolgt sind, ist davon auszugehen,
3201 dass diese mit dem alten Umsatzsteuersatz von 16% gebucht worden sind,
3202 und diese Buchungen sollten entsprechend kontrolliert werden.</para>
3205 <sect2 id="config.skr04-update-3804.create-chart">
3206 <title>Konto 3804 manuell anlegen</title>
3208 <para>Die folgenden Schritte sind notwendig, um das Konto manuell
3209 anzulegen und zu konfigurieren. Zuerst wird in
3210 <guimenu>System</guimenu> → <guisubmenu>Kontenübersicht</guisubmenu> →
3211 <guimenuitem>Konto erfassen</guimenuitem> das Konto angelegt.</para>
3214 <screeninfo>Konto 3804 erfassen</screeninfo>
3218 <imagedata fileref="images/skr04-update-3804/konto3804.png"/>
3223 <para>Als Zweites muss Steuergruppe 13 für Konto 3803 angepasst
3224 werden. Dazu unter <guimenu>System</guimenu> →
3225 <guisubmenu>Steuern</guisubmenu> →
3226 <guimenuitem>Bearbeiten</guimenuitem> den Eintrag mit Steuerschlüssel
3227 13 auswählen und ihn wie im folgenden Screenshot angezeigt
3231 <screeninfo>Steuerschlüssel 13 für 3803 (16%) anpassen</screeninfo>
3235 <imagedata fileref="images/skr04-update-3804/steuer3803.png"/>
3240 <para>Als Drittes wird ein neuer Eintrag mit Steuerschlüssel 13 für
3241 Konto 3804 (19%) angelegt. Dazu unter <guimenu>System</guimenu> →
3242 <guisubmenu>Steuern</guisubmenu> → <guimenuitem>Erfassen</guimenuitem>
3243 auswählen und die Werte aus dem Screenshot übernehmen.</para>
3246 <screeninfo>Steuerschlüssel 13 für 3804 (19%) anlegen</screeninfo>
3250 <imagedata fileref="images/skr04-update-3804/steuer3804.png"/>
3255 <para>Als Nächstes sind alle Konten anzupassen, die als
3256 Steuerautomatikkonto die 3803 haben, sodass sie ab dem 1.1.2007 auch
3257 Steuerautomatik auf 3804 bekommen. Dies betrifft in der
3258 Standardkonfiguration die Konten 4315 und 4726. Als Beispiel für 4315
3259 müssen Sie dazu unter <guimenu>System</guimenu> →
3260 <guisubmenu>Kontenübersicht</guisubmenu> → <guimenuitem>Konten
3261 anzeigen</guimenuitem> das Konto 4315 anklicken und die Einstellungen
3262 wie im Screenshot gezeigt vornehmen.</para>
3265 <screeninfo>Konto 4315 anpassen</screeninfo>
3269 <imagedata fileref="images/skr04-update-3804/konto4315.png"/>
3274 <para>Als Letztes sollte die Steuerliste unter
3275 <guimenu>System</guimenu> → <guisubmenu>Steuern</guisubmenu> →
3276 <guimenuitem>Bearbeiten</guimenuitem> kontrolliert werden. Zum
3277 Vergleich der Screenshot.</para>
3280 <screeninfo>Steuerliste vergleichen</screeninfo>
3284 <imagedata fileref="images/skr04-update-3804/steuerliste.png"/>
3291 <sect1 id="config.bilanz">
3292 <title>Verhalten des Bilanzberichts</title>
3294 <para>Bis Version 3.0 wurde "closedto" ("Bücher schließen zum") als
3295 Grundlage für das Startdatum benutzt. Schließt man die Bücher allerdings
3296 monatsweise führt dies zu falschen Werten.</para>
3298 <para>In der Mandantenkonfiguration kann man dieses Verhalten genau
3299 einstellen indem man:</para>
3303 <para>weiterhin closed_to benutzt (Default, es ändert sich nichts zu
3308 <para>immer den Jahresanfang nimmt (1.1. relativ zum
3313 <para>immer die letzte Eröffnungsbuchung als Startdatum nimmt</para>
3315 <para>- mit Jahresanfang als Alternative wenn es keine EB-Buchungen
3318 <para>- oder mit "alle Buchungen" als Alternative"</para>
3322 <para>mit Jahresanfang als Alternative wenn es keine EB-Buchungen
3327 <para>immer alle Buchungen seit Beginn der Datenbank nimmt</para>
3331 <para>Folgende Hinweise zu den Optionen: Das "Bücher schließen Datum"
3332 ist sinnvoll, wenn man nur komplette Jahre schließt. Bei Wirtschaftsjahr
3333 = Kalendarjahr entspricht dies aber auch dem Jahresanfang. "Alle
3334 Buchungen" kann z.B. sinnvoll sein wenn man ohne Jahresabschluß
3335 durchbucht. Eröffnungsbuchung mit "alle Buchungen" als Fallback ist z.B.
3336 sinnvoll, wenn man am sich Anfang des zweiten Buchungsjahres befindet,
3337 und noch keinen Jahreswechsel und auch noch keine EB-Buchungen hat. Bei
3338 den Optionen mit EB-Buchungen wird vorausgesetzt, daß diese immer am 1.
3339 Tag des Wirtschaftsjahres gebucht werden. Zur Sicherheit wird das
3340 Startdatum im Bilanzbericht jetzt zusätzlich zum Stichtag mit angezeigt.
3341 Das hilft auch bei der Kontrolle für den Abgleich mit der GuV bzw.
3342 Erfolgsrechnung.</para>
3345 <sect1 id="config.erfolgsrechnung">
3346 <title>Erfolgsrechnung</title>
3348 <para>Seit der Version 3.4.1 existiert in kivitendo der Bericht
3349 <emphasis role="bold"> Erfolgsrechnung</emphasis>.</para>
3351 <para>Die Erfolgsrechnung kann in der Mandantenkonfiguration unter
3352 Features an- oder abgeschaltet werden. Mit der Einstellung
3353 <varname>default_manager = swiss </varname> in der
3354 <filename>config/kivitendo.conf</filename> wird beim neu Erstellen einer
3355 Datenbank automatisch die Anzeige der Erfolgsrechnung im Menü
3356 <guimenu>Berichte </guimenu> ausgewählt und ersetzt dort die GUV.</para>
3358 <para>Im Gegensatz zur GUV werden bei der Erfolgsrechnung sämtliche
3359 Aufwands- und Erlöskonten einzeln aufgelistet (analog zur Bilanz),
3360 sortiert nach ERTRAG und AUFWAND.</para>
3362 <para>Bei den Konteneinstellungen muss bei jedem Konto, das in der
3363 Erfolgsrechnung erscheinen soll, unter <varname>Sonstige
3364 Einstellungen/Erfolgsrechnung</varname> entweder
3365 <literal>01.Ertrag</literal> oder <literal>06.Aufwand</literal>
3366 ausgewählt werden.</para>
3368 <para>Wird bei einem Erlöskonto <literal>06.Aufwand</literal>
3369 ausgewählt, so wird dieses Konto als Aufwandsminderung unter AUFWAND
3372 <para>Wird bei einem Aufwandskonto <literal>01.Ertrag</literal>
3373 ausgewählt, so wird dieses Konto als Ertragsminderung unter ERTRAG
3376 <para>Soll bei einer bereits bestehenden Buchhaltung in Zukunft
3377 zusätzlich die Erfolgsrechnung als Bericht verwendet werden, so müssen
3378 die Einstellungen zu allen Erlös- und Aufwandskonten unter
3379 <varname>Sonstige Einstellungen/Erfolgsrechnung</varname> überprüft und
3380 allenfalls neu gesetzt werden.</para>
3383 <sect1 id="config.rounding">
3384 <title>Rundung in Verkaufsbelegen</title>
3386 <para>In der Schweiz hat die kleinste aktuell benutzte Münze den Wert
3387 von 5 Rappen (0.05 CHF).</para>
3389 <para>Auch wenn im elektronischen Zahlungsverkehr Beträge mit einer
3390 Genauigkeit von 0.01 CHF verwendet werden können, ist es trotzdem nach
3391 wie vor üblich, Rechnungen mit auf 0.05 CHF gerundeten Beträgen
3392 auszustellen.</para>
3394 <para>In kivitendo kann seit der Version 3.4.1 die Einstellung für eine
3395 solche Rundung pro Mandant / Datenbank festgelegt werden.</para>
3397 <para>Die Einstellung wird beim Erstellen der Datenbank bei
3398 <literal>Genauigkeit</literal> festgelegt. Sie kann anschliessend über
3399 das Webinterface von kivitendo nicht mehr verändert werden.</para>
3401 <para>Abhängig vom Wert für <varname>default_manager</varname> in
3402 <filename>config/kivitendo.conf</filename> werden dabei folgende Werte
3403 voreingestellt:</para>
3407 <para>0.05 (default_manager = swiss)</para>
3411 <para>0.01 (default_manager = german)</para>
3415 <para>Der Wert wird in der Datenbank in der Tabelle <varname>defaults
3416 </varname>in der Spalte <varname>precision</varname> gespeichert.</para>
3418 <para>In allen Verkaufsangeboten, Verkaufsaufträgen, Verkaufsrechnungen
3419 und Verkaufsgutschriften wird der Endbetrag inkl. MWST gerundet, wenn
3420 dieser nicht der eingestellten Genauigkeit entspricht.</para>
3422 <para>Beim Buchen einer Verkaufsrechnung wird der Rundungsbetrag
3423 automatisch auf die in der Mandantenkonfiguration festgelegten
3424 Standardkonten für Rundungserträge bzw. Rundungsaufwendungen
3427 <para>(Die berechnete MWST wird durch den Rundungsbetrag nicht mehr
3430 <para>Die in den Druckvorlagen zur Verfügung stehenden Variablen
3431 <varname>quototal</varname>, <varname>ordtotal</varname> bzw.
3432 <varname>invtotal</varname> enthalten den gerundeten Betrag.</para>
3434 <para><emphasis role="bold">Achtung:</emphasis> Werden Verkaufsbelege in
3435 anderen Währungen als der Standardwährung erstellt, so muss in kivitendo
3436 ab Version 3.4.1 die Genauigkeit 0.01 verwendet werden.</para>
3438 <para>Das heisst, Firmen in der Schweiz, die teilweise
3439 Verkaufsrechnungen in Euro oder anderen Währungen erstellen wollen,
3440 müssen beim Erstellen der Datenbank als Genauigkeit 0.01 wählen und
3441 können zur Zeit die 5er Rundung noch nicht nutzen.</para>
3444 <sect1 id="config.client">
3445 <title>Einstellungen pro Mandant</title>
3447 <para>Einige Einstellungen können von einem Benutzer mit dem <link
3448 linkend="Zusammenhänge">Recht</link> "Administration (Für die Verwaltung
3449 der aktuellen Instanz aus einem Userlogin heraus)" gemacht werden. Diese
3450 Einstellungen sind dann für die aktuellen Mandanten-Datenbank gültig.
3451 Die Einstellungen sind unter <guimenu>System</guimenu> →
3452 <guisubmenu>Mandantenkonfiguration</guisubmenu> erreichbar.</para>
3454 <para>Bitte beachten Sie die Hinweise zu den einzelnen Einstellungen.
3455 Einige Einstellungen sollten nicht ohne Weiteres im laufenden Betrieb
3456 geändert werden (siehe auch <link
3457 linkend="config.eur.inventory-system-perpetual">Bemerkungen zu
3458 Bestandsmethode</link>).</para>
3460 <para>Die Einstellungen <literal>show_bestbefore</literal> und
3461 <literal>payments_changeable</literal> aus dem Abschnitt
3462 <literal>features</literal> und die Einstellungen im Abschnitt
3463 <literal>datev_check</literal> (sofern schon vorhanden) der <link
3464 linkend="config.config-file">kivitendo-Konfigurationsdatei</link> werden
3465 bei einem Datenbankupdate einer älteren Version automatisch übernommen.
3466 Diese Einträge können danach aus der Konfigurationsdatei entfernt
3470 <sect1 id="kivitendo-ERP-verwenden">
3471 <title>kivitendo ERP verwenden</title>
3473 <para>Nach erfolgreicher Installation ist der Loginbildschirm unter
3474 folgender URL erreichbar:</para>
3477 url="http://localhost/kivitendo-erp/login.pl">http://localhost/kivitendo-erp/login.pl</ulink></para>
3479 <para>Die Administrationsseite erreichen Sie unter:</para>
3482 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
3486 <chapter id="features" xreflabel="Features und Funktionen">
3487 <title>Features und Funktionen</title>
3489 <sect1 id="features.periodic-invoices"
3490 xreflabel="Wiederkehrende Rechnungen">
3491 <title>Wiederkehrende Rechnungen</title>
3493 <sect2 id="features.periodic-invoices.introduction"
3494 xreflabel="Einführung in wiederkehrende Rechnungen">
3495 <title>Einführung</title>
3497 <para>Wiederkehrende Rechnungen werden als normale Aufträge definiert
3498 und konfiguriert, mit allen dazugehörigen Kunden- und Artikelangaben.
3499 Die konfigurierten Aufträge werden später automatisch in Rechnungen
3500 umgewandelt, so als ob man den Workflow benutzen würde, und auch die
3501 Auftragsnummer wird übernommen, sodass alle wiederkehrenden
3502 Rechnungen, die aus einem Auftrag erstellt wurden, später leicht
3503 wiederzufinden sind.</para>
3506 <sect2 id="features.periodic-invoices.configuration"
3507 xreflabel="Konfiguration von wiederkehrenden Rechnungen">
3508 <title>Konfiguration</title>
3510 <para>Um einen Auftrag für wiederkehrende Rechnung zu konfigurieren,
3511 findet sich beim Bearbeiten des Auftrags ein neuer Knopf
3512 "Konfigurieren", der ein neues Fenster öffnet, in dem man die nötigen
3513 Parameter einstellen kann. Hinter dem Knopf wird außerdem noch
3514 angezeigt, ob der Auftrag als wiederkehrende Rechnung konfiguriert ist
3517 <para>Folgende Parameter kann man konfigurieren:</para>
3524 <para>Bei aktiven Rechnungen wird automatisch eine Rechnung
3525 erstellt, wenn die Periodizität erreicht ist (z.B. am Anfang
3526 eines neuen Monats).</para>
3528 <para>Ist ein Auftrag nicht aktiv, so werden für ihn auch keine
3529 wiederkehrenden Rechnungen erzeugt. Stellt man nach längerer
3530 nicht-aktiver Zeit einen Auftrag wieder auf aktiv, wird beim
3531 nächsten Periodenwechsel für alle Perioden, seit der letzten
3532 aktiven Periode, jeweils eine Rechnung erstellt. Möchte man dies
3533 verhindern, muss man vorher das Startdatum neu setzen.</para>
3535 <para>Für gekündigte Aufträge werden nie mehr Rechnungen
3536 erstellt. Man kann sich diese Aufträge aber gesondert in den
3537 Berichten anzeigen lassen.</para>
3542 <term>Periodizität</term>
3545 <para>Ob monatlich, quartalsweise oder jährlich auf neue
3546 Rechnungen überprüft werden soll. Für jede Periode seit dem
3547 Startdatum wird überprüft, ob für die Periode (beginnend immer
3548 mit dem ersten Tag der Periode) schon eine Rechnung erstellt
3549 wurde. Unter Umständen können bei einem Startdatum in der
3550 Vergangenheit gleich mehrere Rechnungen erstellt werden.</para>
3555 <term>Buchen auf</term>
3558 <para>Das Forderungskonto, in der Regel "Forderungen aus
3559 Lieferungen und Leistungen". Das Gegenkonto ergibt sich aus den
3560 Buchungsgruppen der betreffenden Waren.</para>
3565 <term>Startdatum</term>
3568 <para>ab welchem Datum auf Rechnungserstellung geprüft werden
3574 <term>Enddatum</term>
3577 <para>ab wann keine Rechnungen mehr erstellt werden
3583 <term>Automatische Verlängerung um x Monate</term>
3586 <para>Sollen die wiederkehrenden Rechnungen bei Erreichen des
3587 eingetragenen Enddatums weiterhin erstellt werden, so kann man
3588 hier die Anzahl der Monate eingeben, um die das Enddatum
3589 automatisch nach hinten geschoben wird.</para>
3594 <term>Drucken</term>
3597 <para>Sind Drucker konfiguriert, so kann man sich die erstellten
3598 Rechnungen auch gleich ausdrucken lassen.</para>
3603 <para>Nach Erstellung der Rechnungen kann eine E-Mail mit
3604 Informationen zu den erstellten Rechnungen verschickt werden.
3605 Konfiguriert wird dies in der <link
3606 linkend="config.config-file.sections-parameters">Konfigurationsdatei</link>
3607 <filename>config/kivitendo.conf</filename> im Abschnitt
3608 <varname>[periodic_invoices]</varname>.</para>
3611 <sect2 id="features.periodic-invoices.variables">
3612 <title>Spezielle Variablen</title>
3614 <para>Um die erzeugten Rechnungen individualisieren zu können, werden
3615 beim Umwandeln des Auftrags in eine Rechnung einige speziell
3616 formatierte Variablen durch für die jeweils aktuelle
3617 Abrechnungsperiode gültigen Werte ersetzt. Damit ist es möglich, z.B.
3618 den Abrechnungszeitraum explizit auszuweisen. Eine Variable hat dabei
3619 die Syntax <literal><%variablenname%></literal>.</para>
3621 <para>Sofern es sich um eine Datumsvariable handelt, kann das
3622 Ausgabeformat weiter bestimmt werden, indem an den Variablennamen
3623 Formatoptionen angehängt werden. Die Syntax sieht dabei wie folgt aus:
3624 <literal><%variablenname FORMAT=Formatinformation%></literal>.
3625 Die zur verfügung stehenden Formatinformationen werden unten genauer
3628 <para>Diese Variablen können auch beim automatischen Versand der
3629 erzeugten Rechnungen per E-Mail genutzt werden, indem sie in den
3630 Feldern für den Betreff oder die Nachricht verwendet werden.</para>
3632 <para>Diese Variablen werden in den folgenden Elementen des Auftrags
3637 <para>Bemerkungen</para>
3641 <para>Interne Bemerkungen</para>
3645 <para>Vorgangsbezeichnung</para>
3649 <para>In den Beschreibungs- und Langtextfeldern aller
3654 <para>Die zur Verfügung stehenden Variablen sind die Folgenden:</para>
3658 <term><varname><%current_quarter%></varname>,
3659 <varname><%previous_quarter%></varname>,
3660 <varname><%next_quarter%></varname></term>
3663 <para>Aktuelles, vorheriges und nächstes Quartal als Zahl
3664 zwischen <literal>1</literal> und <literal>4</literal>.</para>
3669 <term><varname><%current_month%></varname>,
3670 <varname><%previous_month%></varname>,
3671 <varname><%next_month%></varname></term>
3674 <para>Aktueller, vorheriger und nächster Monat als Zahl zwischen
3675 <literal>1</literal> und <literal>12</literal>.</para>
3680 <term><varname><%current_month_long%></varname>,
3681 <varname><%previous_month_long%></varname>,
3682 <varname><%next_month_long%></varname></term>
3685 <para>Aktueller, vorheriger und nächster Monat als Name
3686 (<literal>Januar</literal>, <literal>Februar</literal>
3692 <term><varname><%current_year%></varname>,
3693 <varname><%previous_year%></varname>,
3694 <varname><%next_year%></varname></term>
3697 <para>Aktuelles, vorheriges und nächstes Jahr als vierstellige
3698 Jahreszahl (<literal>2013</literal> etc.).</para>
3703 <term><varname><%period_start_date%></varname>,
3704 <varname><%period_end_date%></varname></term>
3707 <para>Formatiertes Datum des ersten und letzten Tages im
3708 Abrechnungszeitraum (z.B. bei quartalsweiser Abrechnung und im
3709 ersten Quartal von 2013 wären dies der
3710 <literal>01.01.2013</literal> und
3711 <literal>31.03.2013</literal>).</para>
3716 <para>Die invidiuellen Formatinformationen bestehen aus Paaren von
3717 Prozentzeichen und einem Buchstaben, welche beide zusammen durch den
3718 dazugehörigen Wert ersetzt werden. So wird z.B. <literal>%Y</literal>
3719 durch das viertstellige Jahr ersetzt. Alle möglichen Platzhalter
3724 <term><varname>%a</varname></term>
3727 <para>Der abgekürzte Wochentagsname.</para>
3732 <term><varname>%A</varname></term>
3735 <para>Der ausgeschriebene Wochentagsname.</para>
3740 <term><varname>%b</varname></term>
3743 <para>Der abgekürzte Monatsname.</para>
3748 <term><varname>%B</varname></term>
3751 <para>Der ausgeschriebene Monatsname.</para>
3756 <term><varname>%C</varname></term>
3759 <para>Das Jahrhundert (Jahr/100) als eine zweistellige
3765 <term><varname>%d</varname></term>
3768 <para>Der Monatstag als Zahl zwischen 01 und 31.</para>
3773 <term><varname>%D</varname></term>
3776 <para>Entspricht %m/%d/%y (amerikanisches Datumsformat).</para>
3781 <term><varname>%e</varname></term>
3784 <para>Wie %d (Monatstag als Zahl zwischen 1 und 31), allerdings
3785 werden führende Nullen durch Leerzeichen ersetzt.</para>
3790 <term><varname>%F</varname></term>
3793 <para>Entspricht %Y-%m-%d (das ISO-8601-Datumsformat).</para>
3798 <term><varname>%j</varname></term>
3801 <para>Der Tag im Jahr als Zahl zwischen 001 und 366
3807 <term><varname>%m</varname></term>
3810 <para>Der Monat als Zahl zwischen 01 und 12 inklusive.</para>
3815 <term><varname>%u</varname></term>
3818 <para>Der Wochentag als Zahl zwischen 1 und 7 inklusive, wobei
3819 die 1 dem Montag entspricht.</para>
3824 <term><varname>%U</varname></term>
3827 <para>Die Wochennummer als Zahl zwischen 00 und 53 inklusive,
3828 wobei der erste Sonntag im Jahr das Startdatum von Woche 01
3834 <term><varname>%V</varname></term>
3837 <para>Die ISO-8601:1988-Wochennummer als Zahl zwischen 01 und 53
3838 inklusive, wobei Woche 01 die erste Woche, von der mindestens
3839 vier Tage im Jahr liegen; Montag ist erster Tag der
3845 <term><varname>%w</varname></term>
3848 <para>Der Wochentag als Zahl zwischen 0 und 6 inklusive, wobei
3849 die 0 dem Sonntag entspricht.</para>
3854 <term><varname>%W</varname></term>
3857 <para>Die Wochennummer als Zahl zwischen 00 und 53 inklusive,
3858 wobei der erste Montag im Jahr das Startdatum von Woche 01
3864 <term><varname>%y</varname></term>
3867 <para>Das Jahr als zweistellige Zahl zwischen 00 und 99
3873 <term><varname>%Y</varname></term>
3876 <para>Das Jahr als vierstellige Zahl.</para>
3881 <term><varname>%%</varname></term>
3884 <para>Das Prozentzeichen selber.</para>
3889 <para>Anwendungsbeispiel für die Ausgabe, von welchem Monat und Jahr
3890 bis zu welchem Monat und Jahr die aktuelle Abrechnungsperiode dauert:
3891 <literal>Abrechnungszeitrum: <%period_start_date FORMAT=%m/%Y%>
3892 bis <%period_end_date FORMAT=%m/%Y%></literal></para>
3894 <para>Beim automatischen Versand der Rechnugen via E-Mail können neben diesen speziellen Variablen auch einige Eigenschaften der
3895 Rechnung selber als Variablen im Betreff & dem Text der E-Mails genutzt werden. Beispiele sind
3896 <varname><%invnumber%></varname> für die Rechnungsnummber oder <varname><transaction_description%></varname> für die
3897 Vorgangsbezeichnung. Diese Variablen stehen beim Erzeugen der Rechnung logischerweise noch nicht zur Verfügung.</para>
3900 <sect2 id="features.periodic-invoices.reports">
3901 <title>Auflisten</title>
3903 <para>Unter Verkauf->Berichte->Aufträge finden sich zwei neue
3904 Checkboxen, "Wiederkehrende Rechnungen aktiv" und "Wiederkehrende
3905 Rechnungen inaktiv", mit denen man sich einen Überglick über die
3906 wiederkehrenden Rechnungen verschaffen kann.</para>
3909 <sect2 id="features.periodic-invoices.task-server">
3910 <title>Erzeugung der eigentlichen Rechnungen</title>
3912 <para>Die zeitliche und periodische Überprüfung, ob eine
3913 wiederkehrende Rechnung automatisch erstellt werden soll, geschieht
3914 durch den <link linkend="config.task-server">Task-Server</link>, einen
3915 externen Dienst, der automatisch beim Start des Servers gestartet
3916 werden sollte.</para>
3919 <sect2 id="features.periodic-invoices.create-for-current-month">
3920 <title>Erste Rechnung für aktuellen Monat erstellen</title>
3922 <para>Will man im laufenden Monat eine monatlich wiederkehrende
3923 Rechnung inkl. des laufenden Monats starten, stellt man das Startdatum
3924 auf den Monatsanfang und wartet ein paar Minuten, bis der Task-Server
3925 den neu konfigurieren Auftrag erkennt und daraus eine Rechnung
3926 generiert hat. Alternativ setzt man das Startdatum auf den
3927 Monatsersten des Folgemonats und erstellt die erste Rechnung direkt
3928 manuell über den Workflow.</para>
3932 <sect1 id="features.bank" xreflabel="bankerweiterung">
3933 <title>Bankerweiterung</title>
3935 <sect2 id="features.bank.introduction"
3936 xreflabel="Einführung in die Bankerweiterung">
3937 <title>Einführung</title>
3939 <para>Die Beschreibung der Bankerweiterung befindet sich derzeit noch
3940 im Wiki und soll von dort später hierhin übernommen werden:</para>
3943 url="http://redmine.kivitendo-premium.de/projects/forum/wiki/Bankerweiterung">http://redmine.kivitendo-premium.de/projects/forum/wiki/Bankerweiterung</ulink></para>
3947 <sect1 id="dokumentenvorlagen-und-variablen">
3948 <title>Dokumentenvorlagen und verfügbare Variablen</title>
3950 <sect2 id="dokumentenvorlagen-und-variablen.einführung">
3951 <title>Einführung</title>
3953 <para>Dies ist eine Auflistung der Standard-Dokumentenvorlagen und
3954 aller zur Bearbeitung verfügbaren Variablen. Eine Variable wird in
3955 einer Vorlage durch ihren Inhalt ersetzt, wenn sie in der Form
3956 <function><%variablenname%></function> verwendet wird. Für
3957 LaTeX- und HTML-Vorlagen kann man die Form dieser Tags auch verändern
3959 linkend="dokumentenvorlagen-und-variablen.tag-style"/>).</para>
3961 <para>kivitendo unterstützt LaTeX-, HTML- und OpenDocument-Vorlagen.
3962 Sofern es nicht ausdrücklich eingeschränkt wird, gilt das im Folgenden
3963 gesagte für alle Vorlagenarten.</para>
3965 <para>Insgesamt sind technisch gesehen eine ganze Menge mehr Variablen
3966 verfügbar als hier aufgelistet werden. Die meisten davon können
3967 allerdings innerhalb einer solchen Vorlage nicht sinnvoll verwendet
3968 werden. Wenn eine Auflistung dieser Variablen gewollt ist, so kann
3969 diese wie folgt erhalten werden:</para>
3973 <para><filename>SL/Form.pm</filename> öffnen und am Anfang die
3974 Zeile "<command>use Data::Dumper;</command>" einfügen.</para>
3978 <para>In <filename>Form.pm</filename> die Funktion
3979 <function>parse_template</function> suchen und hier die Zeile
3980 <command>print(STDERR Dumper($self));</command> einfügen.</para>
3984 <para>Einmal per Browser die gewünschte Vorlage "benutzen", z.B.
3985 ein PDF für eine Rechnung erzeugen.</para>
3989 <para>Im <filename>error.log</filename> Apache steht die Ausgabe
3990 der Variablen <varname>$self</varname> in der Form <varname>'key'
3991 => 'value',</varname>. Alle <varname>key</varname>s sind
3997 <sect2 id="dokumentenvorlagen-und-variablen.variablen-ausgeben">
3998 <title>Variablen ausgeben</title>
4000 <para>Um eine Variable auszugeben, müssen sie einfach nur zwischen die
4001 Tags geschrieben werden, also z.B.
4002 <varname><%variablenname%></varname>.</para>
4004 <para>Optional kann man auch mit Leerzeichen getrennte Flags angeben,
4005 die man aber nur selten brauchen wird. Die Syntax sieht also so aus:
4006 <varname><%variablenname FLAG1 FLAG2%></varname>. Momentan
4007 werden die folgenden Flags unterstützt:</para>
4011 <para><option>NOFORMAT</option> gilt nur für Zahlenwerte und gibt
4012 den Wert ohne Formatierung, also ohne Tausendertrennzeichen mit
4013 mit einem Punkt als Dezimaltrennzeichen aus. Nützlich z.B., wenn
4014 damit in der Vorlage z.B. von LaTeX gerechnet werden soll.</para>
4018 <para><option>NOESCAPE</option> unterdrückt das Escapen von
4019 Sonderzeichen für die Vorlagensprache. Wenn also in einer
4020 Variablen bereits gültiger LaTeX-Code steht und dieser von LaTeX
4021 auch ausgewertet und nicht wortwörtlich angezeigt werden soll, so
4022 ist dieses Flag sinnvoll.</para>
4026 <para>Beispiel:</para>
4028 <programlisting><%quototal NOFORMAT%></programlisting>
4031 <sect2 id="dokumentenvorlagen-und-variablen.verwendung-in-druckbefehlen">
4032 <title>Verwendung in Druckbefehlen</title>
4034 <para>In der Admininstration können Drucker definiert werden. Auch im
4035 dort eingebbaren Druckbefehl können die hier aufgelisteten Variablen
4036 und Kontrollstrukturen verwendet werden. Ihr Inhalt wird dabei nach
4037 den Regeln der gängigen Shells formatiert, sodass Sonderzeichen wie
4038 <function>`...`</function> nicht zu unerwünschtem Verhalten
4041 <para>Dies erlaubt z.B. die Definition eines Faxes als Druckerbefehl,
4042 für das die Telefonnummer eines Ansprechpartners als Teil der
4043 Kommandozeile verwendet wird. Für ein fiktives Kommando könnte das
4044 z.B. wie folgt aussehen:</para>
4046 <programlisting>send_fax --number <%if cp_phone2%><%cp_phone2%><%else%><%cp_phone1%><%end%></programlisting>
4049 <sect2 id="dokumentenvorlagen-und-variablen.tag-style"
4050 xreflabel="Anfang und Ende der Tags verändern">
4051 <title>Anfang und Ende der Tags verändern</title>
4053 <para>Der Standardstil für Tags sieht vor, dass ein Tag mit dem
4054 Kleinerzeichen und einem Prozentzeichen beginnt und mit dem
4055 Prozentzeichen und dem Größerzeichen endet, beispielsweise
4056 <function><%customer%></function>. Da diese Form aber z.B. in
4057 LaTeX zu Problemen führen kann, weil das Prozentzeichen dort
4058 Kommentare einleitet, kann pro HTML- oder LaTeX-Dokumentenvorlage der
4059 Stil umgestellt werden.</para>
4061 <para>Dazu werden in die Datei Zeilen geschrieben, die mit dem für das
4062 Format gültigen Kommentarzeichen anfangen, dann
4063 <function>config:</function> enthalten, die entsprechende Option
4064 setzen und bei HTML-Dokumentenvorlagen mit dem Kommentarendzeichen
4065 enden. Beispiel für LaTeX:</para>
4067 <programlisting>% config: tag-style=($ $)</programlisting>
4069 <para>Dies würde kivitendo dazu veranlassen, Variablen zu ersetzen,
4070 wenn sie wie folgt aussehen: <function>($customer$)</function>. Das
4071 äquivalente Beispiel für HTML-Dokumentenvorlagen sieht so aus:</para>
4073 <programlisting><!-- config: tag-style=($ $) --></programlisting>
4076 <sect2 id="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">
4077 <title>Zuordnung von den Dateinamen zu den Funktionen</title>
4079 <para>Diese folgende kurze Auflistung zeigt, welche Vorlage bei
4080 welcher Funktion ausgelesen wird. Dabei ist die Dateiendung
4081 "<filename>.ext</filename>" geeignet zu ersetzen:
4082 "<filename>.tex</filename>" für LaTeX-Vorlagen und
4083 "<filename>.odt</filename>" für OpenDocument-Vorlagen.</para>
4087 <term><filename>bin_list.ext</filename></term>
4090 <para>Lagerliste</para>
4095 <term><filename>check.ext</filename></term>
4103 <term><filename>invoice.ext</filename></term>
4106 <para>Rechnung</para>
4111 <term><filename>packing_list.ext</filename></term>
4114 <para>Packliste</para>
4119 <term><filename>pick_list.ext</filename></term>
4122 <para>Sammelliste</para>
4127 <term><filename>purchase_delivery_order.ext</filename></term>
4130 <para>Lieferschein (Einkauf)</para>
4135 <term><filename>purcharse_order.ext</filename></term>
4138 <para>Bestellung an Lieferanten</para>
4143 <term><filename>request_quotation.ext</filename></term>
4146 <para>Anfrage an Lieferanten</para>
4151 <term><filename>sales_delivery_order.ext</filename></term>
4154 <para>Lieferschein (Verkauf)</para>
4159 <term><filename>sales_order.ext</filename></term>
4162 <para>Bestellung</para>
4167 <term><filename>sales_quotation.ext</filename></term>
4170 <para>Angebot an Kunden</para>
4175 <term><filename>zahlungserinnerung.ext</filename></term>
4178 <para>Mahnung (Dateiname im Programm konfigurierbar)</para>
4183 <term><filename>zahlungserinnerung_invoice.ext</filename></term>
4186 <para>Rechnung über Mahngebühren (Dateiname im Programm
4187 konfigurierbar)</para>
4193 <sect2 id="dokumentenvorlagen-und-variablen.dateinamen-erweitert">
4194 <title>Sprache, Drucker und E-Mail</title>
4196 <para>Angeforderte Sprache und Druckerkürzel in den Dateinamen mit
4197 eingearbeitet. So wird aus der Vorlage
4198 <filename>sales_order.ext</filename> bei Sprache
4199 <function>de</function> und Druckerkürzel <function>lpr2</function>
4200 der Vorlagenname <filename>sales_order_de_lpr2.ext</filename>.
4201 Zusätzlich können für E-Mails andere Vorlagen erstellt werden, diese
4202 bekommen dann noch das Kürzel <filename>_email</filename>, der
4203 vollständige Vorlagenname wäre dann
4204 <filename>sales_order_email_de_lpr2.ext</filename>. In allen Fällen
4205 kann eine Standarddatei <filename>default.ext</filename> hinterlegt
4206 werden. Diese wird verwendet, wenn keine der anderen Varianten
4207 gefunden wird.</para>
4209 <para>Die vollständige Suchreihenfolge für einen Verkaufsauftrag mit
4210 der Sprache "de" und dem Drucker "lpr2", der per E-Mail im Format PDF
4211 verschickt wird, ist:</para>
4215 <para><filename>sales_order_email_de_lpr2.tex</filename></para>
4219 <para><filename>sales_order_de_lpr2.tex</filename></para>
4223 <para><filename>sales_order.tex</filename></para>
4227 <para><filename>default.tex</filename></para>
4231 <para>Die kurzen Varianten dieser Vorlagentitel müssen dann entweder
4232 Standardwerte anzeigen, oder die angeforderten Werte selbst auswerten,
4234 linkend="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"/>.</para>
4237 <sect2 id="dokumentenvorlagen-und-variablen.allgemeine-variablen">
4238 <title>Allgemeine Variablen, die in allen Vorlagen vorhanden
4241 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"
4242 xreflabel="Metainformationen zur angeforderten Vorlage">
4243 <title>Metainformationen zur angeforderten Vorlage</title>
4245 <para>Diese Variablen liefern Informationen darüber welche Variante
4246 einer Vorlage der Benutzer angefragt hat. Sie sind nützlich für
4247 Vorlagenautoren, die aus einer zentralen Layoutvorlage die einzelnen
4248 Formulare einbinden möchten.</para>
4252 <term><varname>template_meta.formname</varname></term>
4255 <para>Basisname der Vorlage. Identisch mit der <link
4256 linkend="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">Zurordnung
4257 zu den Dateinamen</link> ohne die Erweiterung. Ein
4258 Verkaufsauftrag enthält hier
4259 <constant>sales_order</constant>.</para>
4264 <term><varname>template_meta.language.description</varname></term>
4267 <para>Beschreibung der verwendeten Sprache</para>
4272 <term><varname>template_meta.language.template_code</varname></term>
4275 <para>Vorlagenkürzel der verwendeten Sprache, identisch mit
4276 dem Kürzel das im Dateinamen verwendetet wird.</para>
4281 <term><varname>template_meta.language.output_numberformat</varname></term>
4284 <para>Zahlenformat der verwendeten Sprache in der Form
4285 "<constant>1.000,00</constant>". Experimentell! Nur
4286 interessant für Vorlagen die mit unformatierten Werten
4292 <term><varname>template_meta.language.output_dateformat</varname></term>
4295 <para>Datumsformat der verwendeten Sprache in der Form
4296 "<constant>dd.mm.yyyy</constant>". Experimentell! Nur
4297 interessant für Vorlagen die mit unformatierten Werten
4303 <term><varname>template_meta.format</varname></term>
4306 <para>Das angeforderte Format. Kann im Moment die Werte
4307 <constant>pdf</constant>, <constant>postscript</constant>,
4308 <constant>html</constant>, <constant>opendocument</constant>,
4309 <constant>opendocument_pdf</constant> und
4310 <constant>excel</constant> enthalten.</para>
4315 <term><varname>template_meta.extension</varname></term>
4318 <para>Dateierweiterung, wie im Dateinamen. Wird aus
4319 <constant>format</constant> entschieden.</para>
4324 <term><varname>template_meta.media</varname></term>
4327 <para>Ausgabemedium. Kann zur Zeit die Werte
4328 <constant>screen</constant> für Bildschirm,
4329 <constant>email</constant> für E-Mail (triggert das
4330 <constant>_email</constant> Kürzel im Dateinamen),
4331 <constant>printer</constant> für Drucker, und
4332 <constant>queue</constant> für Warteschlange enthalten.</para>
4337 <term><varname>template_meta.printer.description</varname></term>
4340 <para>Beschreibung des ausgewählten Druckers</para>
4345 <term><varname>template_meta.printer.template_code</varname></term>
4348 <para>Vorlagenürzel des ausgewählten Druckers, identisch mit
4349 dem Kürzel das im Dateinamen verwendetet wird.</para>
4354 <term><varname>template_meta.tmpfile</varname></term>
4357 <para>Datei-Prefix für temporäre Dateien.</para>
4363 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.kunden-lieferanten">
4364 <title>Stammdaten von Kunden und Lieferanten</title>
4368 <term><varname>account_number</varname></term>
4371 <para>Kontonummer</para>
4376 <term><varname>bank</varname></term>
4379 <para>Name der Bank</para>
4384 <term><varname>bank_code</varname></term>
4387 <para>Bankleitzahl</para>
4392 <term><varname>bic</varname></term>
4395 <para>Bank-Identifikations-Code (Bank Identifier Code,
4401 <term><varname>business</varname></term>
4404 <para>Kunden-/Lieferantentyp</para>
4409 <term><varname>city</varname></term>
4417 <term><varname>contact</varname></term>
4420 <para>Kontakt</para>
4425 <term><varname>country</varname></term>
4433 <term><varname>c_vendor_id</varname></term>
4436 <para>Lieferantennummer beim Kunden (nur Kunden)</para>
4441 <term><varname>v_customer_id</varname></term>
4444 <para>Kundennummer beim Lieferanten (nur Lieferanten)</para>
4449 <term><varname>cp_email</varname></term>
4452 <para>Email des Ansprechpartners</para>
4457 <term><varname>cp_givenname</varname></term>
4460 <para>Vorname des Ansprechpartners</para>
4465 <term><varname>cp_greeting</varname></term>
4468 <para>Anrede des Ansprechpartners</para>
4473 <term><varname>cp_name</varname></term>
4476 <para>Name des Ansprechpartners</para>
4481 <term><varname>cp_phone1</varname></term>
4484 <para>Telefonnummer 1 des Ansprechpartners</para>
4489 <term><varname>cp_phone2</varname></term>
4492 <para>Telefonnummer 2 des Ansprechpartners</para>
4497 <term><varname>cp_title</varname></term>
4500 <para>Titel des Ansprechpartners</para>
4505 <term><varname>creditlimit</varname></term>
4508 <para>Kreditlimit</para>
4513 <term><varname>customeremail</varname></term>
4516 <para>Email des Kunden; nur für Kunden</para>
4521 <term><varname>customerfax</varname></term>
4524 <para>Faxnummer des Kunden; nur für Kunden</para>
4529 <term><varname>customernotes</varname></term>
4532 <para>Bemerkungen beim Kunden; nur für Kunden</para>
4537 <term><varname>customernumber</varname></term>
4540 <para>Kundennummer; nur für Kunden</para>
4545 <term><varname>customerphone</varname></term>
4548 <para>Telefonnummer des Kunden; nur für Kunden</para>
4553 <term><varname>discount</varname></term>
4561 <term><varname>email</varname></term>
4564 <para>Emailadresse</para>
4569 <term><varname>fax</varname></term>
4572 <para>Faxnummer</para>
4577 <term><varname>gln</varname></term>
4580 <para>GLN (Globale Lokationsnummer)</para>
4585 <term><varname>greeting</varname></term>
4593 <term><varname>homepage</varname></term>
4596 <para>Homepage</para>
4601 <term><varname>iban</varname></term>
4604 <para>Internationale Kontonummer (International Bank Account
4605 Number, IBAN)</para>
4610 <term><varname>language</varname></term>
4613 <para>Sprache</para>
4618 <term><varname>name</varname></term>
4621 <para>Firmenname</para>
4626 <term><varname>natural_person</varname></term>
4629 <para>Flag "natürliche Person"; Siehe auch
4630 <xref linkend="dokumentenvorlagen-und-variablen.anrede"/></para>
4635 <term><varname>payment_description</varname></term>
4638 <para>Name der Zahlart</para>
4643 <term><varname>payment_terms</varname></term>
4646 <para>Zahlungskonditionen</para>
4651 <term><varname>phone</varname></term>
4654 <para>Telefonnummer</para>
4659 <term><varname>shiptocity</varname></term>
4662 <para>Stadt (Lieferadresse) <link
4663 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4668 <term><varname>shiptocontact</varname></term>
4671 <para>Kontakt (Lieferadresse) <link
4672 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4677 <term><varname>shiptocountry</varname></term>
4680 <para>Land (Lieferadresse) <link
4681 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4686 <term><varname>shiptodepartment_1</varname></term>
4689 <para>Abteilung 1 (Lieferadresse) <link
4690 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4695 <term><varname>shiptodepartment_2</varname></term>
4698 <para>Abteilung 2 (Lieferadresse) <link
4699 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4704 <term><varname>shiptoemail</varname></term>
4707 <para>Email (Lieferadresse) <link
4708 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4713 <term><varname>shiptofax</varname></term>
4716 <para>Fax (Lieferadresse) <link
4717 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4722 <term><varname>shiptogln</varname></term>
4725 <para>GLN (Globale Lokationsnummer) (Lieferadresse) <link
4726 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4731 <term><varname>shiptoname</varname></term>
4734 <para>Firmenname (Lieferadresse) <link
4735 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4740 <term><varname>shiptophone</varname></term>
4743 <para>Telefonnummer (Lieferadresse) <link
4744 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4749 <term><varname>shiptostreet</varname></term>
4752 <para>Straße und Hausnummer (Lieferadresse) <link
4753 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4758 <term><varname>shiptozipcode</varname></term>
4761 <para>Postleitzahl (Lieferadresse) <link
4762 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4767 <term><varname>street</varname></term>
4770 <para>Straße und Hausnummer</para>
4775 <term><varname>taxnumber</varname></term>
4778 <para>Steuernummer</para>
4783 <term><varname>ustid</varname></term>
4786 <para>Umsatzsteuer-Identifikationsnummer</para>
4791 <term><varname>vendoremail</varname></term>
4794 <para>Email des Lieferanten; nur für Lieferanten</para>
4799 <term><varname>vendorfax</varname></term>
4802 <para>Faxnummer des Lieferanten; nur für Lieferanten</para>
4807 <term><varname>vendornotes</varname></term>
4810 <para>Bemerkungen beim Lieferanten; nur für Lieferanten</para>
4815 <term><varname>vendornumber</varname></term>
4818 <para>Lieferantennummer; nur für Lieferanten</para>
4823 <term><varname>vendorphone</varname></term>
4826 <para>Telefonnummer des Lieferanten; nur für
4832 <term><varname>zipcode</varname></term>
4835 <para>Postleitzahl</para>
4840 <note id="dokumentenvorlagen-und-variablen.anmerkung-shipto">
4841 <para>Anmerkung: Sind die <varname>shipto*</varname>-Felder in den
4842 Stammdaten nicht eingetragen, so haben die Variablen
4843 <varname>shipto*</varname> den gleichen Wert wie die die
4844 entsprechenden Variablen der Lieferdaten. Das bedeutet, dass sich
4845 einige <varname>shipto*</varname>-Variablen so nicht in den
4846 Stammdaten wiederfinden sondern schlicht Kopien der
4847 Lieferdatenvariablen sind (z.B.
4848 <varname>shiptocontact</varname>).</para>
4852 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-bearbeiter">
4853 <title>Informationen über den Bearbeiter</title>
4857 <term><varname>employee_address</varname></term>
4860 <para>Adressfeld</para>
4865 <term><varname>employee_businessnumber</varname></term>
4868 <para>Firmennummer</para>
4873 <term><varname>employee_company</varname></term>
4876 <para>Firmenname</para>
4881 <term><varname>employee_co_ustid</varname></term>
4884 <para>Usatzsteuer-Identifikationsnummer</para>
4889 <term><varname>employee_duns</varname></term>
4892 <para>DUNS-Nummer</para>
4897 <term><varname>employee_email</varname></term>
4905 <term><varname>employee_fax</varname></term>
4913 <term><varname>employee_name</varname></term>
4916 <para>voller Name</para>
4921 <term><varname>employee_signature</varname></term>
4924 <para>Signatur</para>
4929 <term><varname>employee_taxnumber</varname></term>
4932 <para>Steuernummer</para>
4937 <term><varname>employee_tel</varname></term>
4940 <para>Telefonnummer</para>
4946 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-verkaeufer">
4947 <title>Informationen über den Verkäufer</title>
4951 <term><varname>salesman_address</varname></term>
4954 <para>Adressfeld</para>
4959 <term><varname>salesman_businessnumber</varname></term>
4962 <para>Firmennummer</para>
4967 <term><varname>salesman_company</varname></term>
4970 <para>Firmenname</para>
4975 <term><varname>salesman_co_ustid</varname></term>
4978 <para>Usatzsteuer-Identifikationsnummer</para>
4983 <term><varname>salesman_duns</varname></term>
4986 <para>DUNS-Nummer</para>
4991 <term><varname>salesman_email</varname></term>
4999 <term><varname>salesman_fax</varname></term>
5007 <term><varname>salesman_name</varname></term>
5010 <para>voller Name</para>
5015 <term><varname>salesman_signature</varname></term>
5018 <para>Signatur</para>
5023 <term><varname>salesman_taxnumber</varname></term>
5026 <para>Steuernummer</para>
5031 <term><varname>salesman_tel</varname></term>
5034 <para>Telefonnummer</para>
5040 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-steuern">
5041 <title>Variablen für die einzelnen Steuern</title>
5045 <term><varname>tax</varname></term>
5053 <term><varname>taxbase</varname></term>
5056 <para>zu versteuernder Betrag</para>
5061 <term><varname>taxdescription</varname></term>
5064 <para>Name der Steuer</para>
5069 <term><varname>taxrate</varname></term>
5072 <para>Steuersatz</para>
5078 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-lieferbedingungen">
5079 <title>Variablen für Lieferbedingungen</title>
5083 <term><varname>delivery_term</varname></term>
5086 <para>Datenbank-Objekt der Lieferbedingung</para>
5091 <term><varname>delivery_term.description</varname></term>
5094 <para>Beschreibung der Lieferbedingung</para>
5099 <term><varname>delivery_term.description_long</varname></term>
5102 <para>Langtext bzw. übersetzter Langtext der
5103 Lieferbedingung</para>
5109 <sect3 id="dokumentenvorlagen-und-variablen.abweichende-rechnungsadresse">
5110 <title>Informationen über abweichende Rechnungsadressen (nur Verkaufsbelege)</title>
5113 Abweichende Rechnungsadressen gibt es nur in Verkaufsbelegen. Die entsprechenden Variablen sind nur dann mit Inhalt gefüllt,
5114 wenn im Beleg eine abweichende Rechnungsadresse ausgewählt wurde. Ob eine Adresse überhaupt ausgewählt wurde, kann über die
5115 Variable <literal>billing_address_id</literal> getestet werden, die die Datenbank-ID der abweichenden Rechnungsadresse enthält,
5116 wenn eine ausgewählt ist.
5120 Die Variablennamen starten alle mit dem Präfix <literal>billing_address_</literal> und heißen anschließend so, wie ihre Pendants
5121 aus der Standard-Rechnungsadresse des Kunden. Beispiel: die Postleitzahl, die in der normalen Rechnungsadresse in
5122 <literal>zipcode</literal> steht, steht für die abweichende Rechnungsadresse in <literal>billing_address_zipcode</literal>.
5126 Die folgenden Variablen stehen so zur Verfügung: <literal>billing_address_name</literal>,
5127 <literal>billing_address_department_1</literal>, <literal>billing_address_department_2</literal>,
5128 <literal>billing_address_contact</literal>, <literal>billing_address_street</literal>,
5129 <literal>billing_address_zipcode</literal>, <literal>billing_address_city</literal>, <literal>billing_address_country</literal>,
5130 <literal>billing_address_gln</literal>, <literal>billing_address_email</literal>, <literal>billing_address_phone</literal> und
5131 <literal>billing_address_fax</literal>.
5136 <sect2 id="dokumentenvorlagen-und-variablen.invoice">
5137 <title>Variablen in Rechnungen</title>
5139 <sect3 id="dokumentenvorlagen-und-variablen.invoice-allgemein">
5140 <title>Allgemeine Variablen</title>
5144 <term><varname>creditremaining</varname></term>
5147 <para>Verbleibender Kredit</para>
5152 <term><varname>currency</varname></term>
5155 <para>Währung</para>
5160 <term><varname>cusordnumber</varname></term>
5163 <para>Bestellnummer beim Kunden</para>
5168 <term><varname>deliverydate</varname></term>
5171 <para>Lieferdatum</para>
5176 <term><varname>duedate</varname></term>
5179 <para>Fälligkeitsdatum</para>
5184 <term><varname>globalprojectnumber</varname></term>
5187 <para>Projektnummer des ganzen Beleges</para>
5192 <term><varname>globalprojectdescription</varname></term>
5195 <para>Projekbeschreibung des ganzen Beleges</para>
5200 <term><varname>intnotes</varname></term>
5203 <para>Interne Bemerkungen</para>
5208 <term><varname>invdate</varname></term>
5211 <para>Rechnungsdatum</para>
5216 <term><varname>invnumber</varname></term>
5219 <para>Rechnungsnummer</para>
5224 <term><varname>invtotal</varname></term>
5227 <para>gesamter Rechnungsbetrag</para>
5232 <term><varname>notes</varname></term>
5235 <para>Bemerkungen der Rechnung</para>
5240 <term><varname>orddate</varname></term>
5243 <para>Auftragsdatum</para>
5248 <term><varname>ordnumber</varname></term>
5251 <para>Auftragsnummer, wenn die Rechnung aus einem Auftrag
5252 erstellt wurde</para>
5257 <term><varname>payment_description</varname></term>
5260 <para>Name der Zahlart</para>
5265 <term><varname>payment_terms</varname></term>
5268 <para>Zahlungskonditionen</para>
5273 <term><varname>quodate</varname></term>
5276 <para>Angebotsdatum</para>
5281 <term><varname>quonumber</varname></term>
5284 <para>Angebotsnummer</para>
5289 <term><varname>rounding</varname></term>
5292 <para>Betrag, um den <varname>invtotal</varname> gerundet
5293 wurde (kann positiv oder negativ sein)</para>
5298 <term><varname>shippingpoint</varname></term>
5301 <para>Versandort</para>
5306 <term><varname>shipvia</varname></term>
5309 <para>Transportmittel</para>
5314 <term><varname>subtotal</varname></term>
5317 <para>Zwischensumme aller Posten ohne Steuern</para>
5322 <term><varname>total</varname></term>
5325 <para>Restsumme der Rechnung (Summe abzüglich bereits
5326 bezahlter Posten)</para>
5331 <term><varname>transaction_description</varname></term>
5334 <para>Vorgangsbezeichnung</para>
5339 <term><varname>transdate</varname></term>
5342 <para>Auftragsdatum wenn die Rechnung aus einem Auftrag
5343 erstellt wurde</para>
5349 <sect3 id="dokumentenvorlagen-und-variablen.invoice-posten">
5350 <title>Variablen für jeden Posten auf der Rechnung</title>
5354 <term><varname>bin</varname></term>
5357 <para>Stellage</para>
5362 <term><varname>description</varname></term>
5365 <para>Artikelbeschreibung</para>
5370 <term><varname>cusordnumber_oe</varname></term>
5373 <para>Bestellnummer des Kunden aus dem Auftrag, aus dem der
5374 Posten ursprünglich stammt (nur Verkauf)</para>
5379 <term><varname>discount</varname></term>
5382 <para>Rabatt als Betrag</para>
5387 <term><varname>discount_sub</varname></term>
5390 <para>Zwischensumme mit Rabatt</para>
5395 <term><varname>donumber_do</varname></term>
5398 <para>Lieferscheinnummer des Lieferscheins, aus dem die
5399 Position ursprünglich stammt, wenn die Rechnung im Rahmen des
5400 Workflows aus einem Lieferschein erstellt wurde.</para>
5405 <term><varname>drawing</varname></term>
5408 <para>Zeichnung</para>
5413 <term><varname>ean</varname></term>
5416 <para>EAN-Code</para>
5421 <term><varname>image</varname></term>
5429 <term><varname>linetotal</varname></term>
5432 <para>Zeilensumme (Anzahl * Einzelpreis)</para>
5437 <term><varname>longdescription</varname></term>
5440 <para>Langtext, vorbelegt mit dem Feld Bemerkungen der entsprechenden Ware</para>
5445 <term><varname>microfiche</varname></term>
5448 <para>Mikrofilm</para>
5453 <term><varname>netprice</varname></term>
5456 <para>Alternative zu <varname>sellprice</varname>, aber
5457 <varname>netprice</varname> entspricht dem effektiven
5458 Einzelpreis und beinhaltet Zeilenrabatt und Preisfaktor.
5459 <varname>netprice</varname> wird rückgerechnet aus Zeilensumme
5460 / Menge. Diese Variable ist nützlich, wenn man den gewährten
5461 Rabatt in der Druckvorlage nicht anzeigen möchte, aber Menge *
5462 Einzelpreis trotzdem die angezeigte Zeilensumme ergeben soll.
5463 <varname>netprice</varname> hat nichts mit Netto/Brutto im
5464 Sinne von Steuern zu tun.</para>
5469 <term><varname>nodiscount_linetotal</varname></term>
5472 <para>Zeilensumme ohne Rabatt</para>
5477 <term><varname>nodiscount_sub</varname></term>
5480 <para>Zwischensumme ohne Rabatt</para>
5485 <term><varname>number</varname></term>
5488 <para>Artikelnummer</para>
5493 <term><varname>ordnumber_oe</varname></term>
5496 <para>Auftragsnummer des Originalauftrags, aus dem der Posten
5497 ursprünglich stammt. Nützlich, wenn die Rechnung aus mehreren
5498 Lieferscheinen zusammengefasst wurde, oder wenn zwischendurch
5499 eine Sammelauftrag aus mehreren Aufträgen erstellt wurde. In
5500 letzterem Fall wird die unsprüngliche Auftragsnummer
5506 <term><varname>p_discount</varname></term>
5509 <para>Rabatt in Prozent</para>
5514 <term><varname>partnotes</varname></term>
5517 <para>Die beim Artikel gespeicherten Bemerkungen</para>
5522 <term><varname>partsgroup</varname></term>
5525 <para>Warengruppe</para>
5530 <term><varname>price_factor</varname></term>
5533 <para>Der Preisfaktor als Zahl, sofern einer eingestellt
5539 <term><varname>price_factor_name</varname></term>
5542 <para>Der Name des Preisfaktors, sofern einer eingestellt
5548 <term><varname>projectnumber</varname></term>
5551 <para>Projektnummer</para>
5556 <term><varname>projectdescription</varname></term>
5559 <para>Projektbeschreibung</para>
5564 <term><varname>qty</varname></term>
5572 <term><varname>reqdate</varname></term>
5575 <para>Lieferdatum</para>
5580 <term><varname>runningnumber</varname></term>
5583 <para>Position auf der Rechnung (1, 2, 3...)</para>
5588 <term><varname>sellprice</varname></term>
5591 <para>Verkaufspreis</para>
5596 <term><varname>serialnumber</varname></term>
5599 <para>Seriennummer</para>
5604 <term><varname>tax_rate</varname></term>
5607 <para>Steuersatz</para>
5612 <term><varname>transdate_do</varname></term>
5615 <para>Datum des Lieferscheins, wenn die Rechnung im Rahmen des
5616 Workflows aus einem Lieferschein stammte.</para>
5621 <term><varname>transdate_oe</varname></term>
5624 <para>Datum des Auftrags, wenn die Rechnung im Rahmen des
5625 Workflows aus einem Auftrag erstellt wurde. Wenn es
5626 Sammelaufträge gab wird das Datum des ursprünglichen Auftrags
5632 <term><varname>transdate_quo</varname></term>
5635 <para>Datum des Angebots, wenn die Position im Rahmen des
5636 Workflows aus einem Angebot stammte.</para>
5641 <term><varname>unit</varname></term>
5644 <para>Einheit</para>
5649 <term><varname>weight</varname></term>
5652 <para>Gewicht</para>
5657 <para>Für jeden Posten gibt es ein Unterarray mit den Informationen
5658 über Lieferanten und Lieferantenartikelnummer. Diese müssen mit
5659 einer <function>foreach</function>-Schleife ausgegeben werden, da
5660 für jeden Artikel mehrere Lieferanteninformationen hinterlegt sein
5661 können. Die Variablen dafür lauten:</para>
5665 <term><varname>make</varname></term>
5668 <para>Lieferant</para>
5673 <term><varname>model</varname></term>
5676 <para>Lieferantenartikelnummer</para>
5682 <sect3 id="dokumentenvorlagen-und-variablen.invoice-zahlungen">
5683 <title>Variablen für die einzelnen Zahlungseingänge</title>
5687 <term><varname>payment</varname></term>
5695 <term><varname>paymentaccount</varname></term>
5703 <term><varname>paymentdate</varname></term>
5711 <term><varname>paymentmemo</varname></term>
5719 <term><varname>paymentsource</varname></term>
5728 <sect3 id="dokumentenvorlagen-und-variablen.benutzerdefinierte-variablen-vc">
5729 <title>Benutzerdefinierte Kunden- und Lieferantenvariablen</title>
5731 <para>Die vom Benutzer definierten Variablen für Kunden und
5732 Lieferanten stehen beim Ausdruck von Einkaufs- und Verkaufsbelegen
5733 ebenfalls zur Verfügung. Ihre Namen setzen sich aus dem Präfix
5734 <varname>vc_cvar_</varname> und dem vom Benutzer festgelegten
5735 Variablennamen zusammen.</para>
5737 <para>Beispiel: Der Benutzer hat eine Variable namens
5738 <varname>number_of_employees</varname> definiert, die die Anzahl der
5739 Mitarbeiter des Unternehmens enthält. Diese Variable steht dann
5740 unter dem Namen <varname>vc_cvar_number_of_employees</varname> zur
5743 <para>Die benutzerdefinierten Variablen der Lieferadressen stehen
5744 unter einem ähnlichen Namensschema zur Verfügung. Hier lautet der
5745 Präfix <varname>shiptocvar_</varname>.</para>
5747 <para>Analog stehen die benutzerdefinierten Variablen für
5748 Ansprechpersonen mit dem Namenspräfix <varname>cp_cvar_</varname>
5749 zur Verfügung.</para>
5753 <sect2 id="dokumentenvorlagen-und-variablen.dunning">
5754 <title>Variablen in Mahnungen und Rechnungen über Mahngebühren</title>
5756 <sect3 id="dokumentenvorlagen-und-variablen.dunning-vorlagennamen">
5757 <title>Namen der Vorlagen</title>
5759 <para>Die Namen der Vorlagen werden im System-Menü vom Benutzer
5760 eingegeben. Wird für ein Mahnlevel die Option zur automatischen
5761 Erstellung einer Rechnung über die Mahngebühren und Zinsen
5762 aktiviert, so wird der Name der Vorlage für diese Rechnung aus dem
5763 Vorlagenname für diese Mahnstufe mit dem Zusatz
5764 <constant>_invoice</constant> gebildet. Weiterhin werden die Kürzel
5765 für die ausgewählte Sprache und den ausgewählten Drucker
5769 <sect3 id="dokumentenvorlagen-und-variablen.dunning-allgemein">
5770 <title>Allgemeine Variablen in Mahnungen</title>
5772 <para>Die Variablen des Bearbeiters, bzw. Verkäufers stehen wie
5773 gewohnt als <varname>employee_...</varname> bzw.
5774 <varname>salesman_...</varname> zur Verfügung. Werden mehrere
5775 Rechnungen in einer Mahnung zusammengefasst, so werden die Metadaten
5776 (Bearbeiter, Abteilung, etc) der ersten angemahnten Rechnung im
5777 Ausdruck genommen.</para>
5779 <para>Die Adressdaten des Kunden stehen als Variablen
5780 <varname>name</varname>, <varname>street</varname>,
5781 <varname>zipcode</varname>, <varname>city</varname>,
5782 <varname>country</varname>, <varname>department_1</varname>,
5783 <varname>department_2</varname>, und <varname>email</varname> zur
5784 Verfügung. Der Ansprechpartner <varname>cp_...</varname> steht auch
5785 zu Verfügung, wird allerdings auch nur von der ersten angemahnten
5786 Rechnung (s.o.) genommen.</para>
5788 <para>Weitere Variablen beinhalten:</para>
5792 <term><varname>dunning_date</varname></term>
5795 <para>Datum der Mahnung</para>
5800 <term><varname>dunning_duedate</varname></term>
5803 <para>Fälligkeitsdatum für diese Mahhnung</para>
5808 <term><varname>dunning_id</varname></term>
5811 <para>Mahnungsnummer</para>
5816 <term><varname>fee</varname></term>
5819 <para>Kumulative Mahngebühren</para>
5824 <term><varname>interest_rate</varname></term>
5827 <para>Zinssatz per anno in Prozent</para>
5832 <term><varname>total_amount</varname></term>
5835 <para>Gesamter noch zu zahlender Betrag als
5836 <function>fee</function> + <function>total_interest</function>
5837 + <function>total_open_amount</function></para>
5842 <term><varname>total_interest</varname></term>
5845 <para>Zinsen per anno über alle Rechnungen</para>
5850 <term><varname>total_open_amount</varname></term>
5853 <para>Summe über alle offene Beträge der Rechnungen</para>
5859 <sect3 id="dokumentenvorlagen-und-variablen.dunning-details">
5860 <title>Variablen für jede gemahnte Rechnung in einer Mahnung</title>
5864 <term><varname>dn_amount</varname></term>
5867 <para>Rechnungssumme (brutto)</para>
5872 <term><varname>dn_duedate</varname></term>
5875 <para>Originales Fälligkeitsdatum der Rechnung</para>
5880 <term><varname>dn_dunning_date</varname></term>
5883 <para>Datum der Mahnung</para>
5888 <term><varname>dn_dunning_duedate</varname></term>
5891 <para>Fälligkeitsdatum der Mahnung</para>
5896 <term><varname>dn_fee</varname></term>
5899 <para>Kummulative Mahngebühr</para>
5904 <term><varname>dn_interest</varname></term>
5907 <para>Zinsen per anno für diese Rechnung</para>
5912 <term><varname>dn_invnumber</varname></term>
5915 <para>Rechnungsnummer</para>
5920 <term><varname>dn_linetotal</varname></term>
5923 <para>Noch zu zahlender Betrag (ergibt sich aus
5924 <varname>dn_open_amount</varname> + <varname>dn_fee</varname>
5925 + <varname>dn_interest</varname>)</para>
5930 <term><varname>dn_netamount</varname></term>
5933 <para>Rechnungssumme (netto)</para>
5938 <term><varname>dn_open_amount</varname></term>
5941 <para>Offener Rechnungsbetrag</para>
5946 <term><varname>dn_ordnumber</varname></term>
5949 <para>Bestellnummer</para>
5954 <term><varname>dn_transdate</varname></term>
5957 <para>Rechnungsdatum</para>
5962 <term><varname>dn_curr</varname></term>
5965 <para>Währung, in der die Rechnung erstellt wurde. (Die
5966 Rechnungsbeträge sind aber immer in der Hauptwährung)</para>
5972 <sect3 id="dokumentenvorlagen-und-variablen.dunning-invoice">
5973 <title>Variablen in automatisch erzeugten Rechnungen über
5974 Mahngebühren</title>
5976 <para>Die Variablen des Verkäufers stehen wie gewohnt als
5977 <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
5978 Kunden stehen als Variablen <varname>name</varname>,
5979 <varname>street</varname>, <varname>zipcode</varname>,
5980 <varname>city</varname>, <varname>country</varname>,
5981 <varname>department_1</varname>, <varname>department_2</varname>,
5982 und <varname>email</varname> zur Verfügung.</para>
5984 <para>Weitere Variablen beinhalten:</para>
5988 <term><varname>duedate</varname></term>
5991 <para>Fälligkeitsdatum der Rechnung</para>
5996 <term><varname>dunning_id</varname></term>
5999 <para>Mahnungsnummer</para>
6004 <term><varname>fee</varname></term>
6007 <para>Mahngebühren</para>
6012 <term><varname>interest</varname></term>
6020 <term><varname>invamount</varname></term>
6023 <para>Rechnungssumme (ergibt sich aus <varname>fee</varname> +
6024 <varname>interest</varname>)</para>
6029 <term><varname>invdate</varname></term>
6032 <para>Rechnungsdatum</para>
6037 <term><varname>invnumber</varname></term>
6040 <para>Rechnungsnummer</para>
6047 <sect2 id="dokumentenvorlagen-und-variablen.andere-vorlagen">
6048 <title>Variablen in anderen Vorlagen</title>
6051 <title>Einführung</title>
6053 <para>Die Variablen in anderen Vorlagen sind ähnlich wie in der
6054 Rechnung. Allerdings heißen die Variablen, die mit
6055 <varname>inv</varname> beginnen, jetzt anders. Bei den Angeboten
6056 fangen sie mit <varname>quo</varname> für "quotation" an:
6057 <varname>quodate</varname> für Angebotsdatum etc. Bei Bestellungen
6058 wiederum fangen sie mit <varname>ord</varname> für "order" an:
6059 <varname>ordnumber</varname> für Bestellnummer etc.</para>
6061 <para>Manche Variablen sind in anderen Vorlagen hingegen gar nicht
6062 vorhanden wie z.B. die für bereits verbuchte Zahlungseingänge. Dies
6063 sind Variablen, die vom Geschäftsablauf her in der entsprechenden
6064 Vorlage keine Bedeutung haben oder noch nicht belegt sein
6067 <para>Im Folgenden werden nur wichtige Unterschiede zu den Variablen
6068 in Rechnungen aufgeführt.</para>
6071 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-quotations">
6072 <title>Angebote und Preisanfragen</title>
6076 <term><varname>quonumber</varname></term>
6079 <para>Angebots- bzw. Anfragenummer</para>
6084 <term><varname>reqdate</varname></term>
6087 <para>Gültigkeitsdatum (bei Angeboten) bzw. Lieferdatum (bei
6088 Preisanfragen)</para>
6093 <term><varname>transdate</varname></term>
6096 <para>Angebots- bzw. Anfragedatum</para>
6102 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-orders">
6103 <title>Auftragsbestätigungen und Lieferantenaufträge</title>
6107 <term><varname>ordnumber</varname></term>
6110 <para>Auftragsnummer</para>
6115 <term><varname>reqdate</varname></term>
6118 <para>Lieferdatum</para>
6123 <term><varname>transdate</varname></term>
6126 <para>Auftragsdatum</para>
6132 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-delivery-orders">
6133 <title>Lieferscheine (Verkauf und Einkauf)</title>
6137 <term><varname>cusordnumber</varname></term>
6140 <para>Bestellnummer des Kunden (im Verkauf) bzw. Bestellnummer
6141 des Lieferanten (im Einkauf)</para>
6146 <term><varname>donumber</varname></term>
6149 <para>Lieferscheinnummer</para>
6154 <term><varname>transdate</varname></term>
6157 <para>Lieferscheindatum</para>
6162 <para>Für jede Position eines Lieferscheines gibt es ein Unterarray
6163 mit den Informationen darüber, von welchem Lager und Lagerplatz aus
6164 die Waren verschickt wurden (Verkaufslieferscheine) bzw. auf welchen
6165 Lagerplatz sie eingelagert wurden. Diese müssen mittels einer
6166 <function>foreach</function>-Schleife ausgegeben werden. Diese
6167 Variablen sind:</para>
6171 <term><varname>si_bin</varname></term>
6174 <para>Lagerplatz</para>
6179 <term><varname>si_chargenumber</varname></term>
6182 <para>Chargennummer</para>
6187 <term><varname>si_bestbefore</varname></term>
6190 <para>Mindesthaltbarkeit</para>
6195 <term><varname>si_number</varname></term>
6198 <para>Artikelnummer</para>
6203 <term><varname>si_qty</varname></term>
6206 <para>Anzahl bzw. Menge</para>
6211 <term><varname>si_runningnumber</varname></term>
6214 <para>Positionsnummer (1, 2, 3 etc)</para>
6219 <term><varname>si_unit</varname></term>
6222 <para>Einheit</para>
6227 <term><varname>si_warehouse</varname></term>
6236 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-statement">
6237 <title>Variablen für Sammelrechnung</title>
6241 <term><varname>c0total</varname></term>
6244 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit < 30
6250 <term><varname>c30total</varname></term>
6253 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 30
6254 und < 60 Tage</para>
6259 <term><varname>c60total</varname></term>
6262 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 60
6263 und < 90 Tage</para>
6268 <term><varname>c90total</varname></term>
6271 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 90
6277 <term><varname>total</varname></term>
6280 <para>Gesamtbetrag aller Rechnungen</para>
6285 <para>Variablen für jede Rechnungsposition in Sammelrechnung:</para>
6289 <term><varname>invnumber</varname></term>
6292 <para>Rechnungsnummer</para>
6297 <term><varname>invdate</varname></term>
6300 <para>Rechnungsdatum</para>
6305 <term><varname>duedate</varname></term>
6308 <para>Fälligkeitsdatum</para>
6313 <term><varname>amount</varname></term>
6316 <para>Summe der Rechnung</para>
6321 <term><varname>open</varname></term>
6324 <para>Noch offener Betrag der Rechnung</para>
6329 <term><varname>c0</varname></term>
6332 <para>Noch offener Rechnungsbetrag mit Fälligkeit < 30
6338 <term><varname>c30</varname></term>
6341 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 30 und
6347 <term><varname>c60</varname></term>
6350 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 60 und
6356 <term><varname>c90</varname></term>
6359 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 90
6367 <sect2 id="dokumentenvorlagen-und-variablen.bloecke">
6368 <title>Blöcke, bedingte Anweisungen und Schleifen</title>
6370 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.einfuehrung">
6371 <title>Einführung</title>
6373 <para>Der Parser kennt neben den Variablen einige weitere
6374 Konstrukte, die gesondert behandelt werden. Diese sind wie
6375 Variablennamen in spezieller Weise markiert:
6376 <command><%anweisung%> ... <%end%></command></para>
6378 <para>Anmerkung zum <command><%end%></command>: Der besseren
6379 Verständlichkeit halber kann man nach dem <command>end</command>
6380 noch beliebig weitere Wörter schreiben, um so zu markieren, welche
6381 Anweisung (z.B. <command>if</command> oder
6382 <command>foreach</command>) damit abgeschlossen wird.</para>
6384 <para>Beispiel: Lautet der Beginn eines Blockes z.B.
6385 <command><%if type == "sales_quotation"%></command>, so könnte
6386 er mit <command><%end%></command> genauso abgeschlossen werden
6387 wie mit <command><%end if%></command> oder auch
6388 <command><%end type == "sales_quotation"%></command>.</para>
6391 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.if">
6392 <title>Der if-Block</title>
6394 <programlisting><%if variablenname%>
6396 <%end%></programlisting>
6398 <para>Eine normale "if-then"-Bedingung. Die Zeilen zwischen dem "if"
6399 und dem "end" werden nur ausgegeben, wenn die Variable
6400 <varname>variablenname</varname> gesetzt und ungleich 0 ist.</para>
6402 <para>Handelt es sich bei der benannten Variable um ein Array, also
6403 um einen Variablennamen, über den man mit <command><%foreach
6404 variablenname%></command> iteriert, so wird mit diesem Konstrukt
6405 darauf getestet, ob das Array Elemente enthält. Somit würde im
6406 folgenden Beispiel nur dann eine Liste von Zahlungseingängen samt
6407 ihrer Überschrift "Zahlungseingänge" ausgegeben, wenn tatsächlich
6408 welche getätigt wurden:</para>
6410 <programlisting><%if payment%>
6412 <%foreach payment%>
6413 Am <%paymentdate%>: <%payment%> €
6414 <%end foreach%>
6415 <%end if%></programlisting>
6417 <para>Die Bedingung kann auch negiert werden, indem das Wort
6418 <function>not</function> nach dem <filename>if</filename> verwendet
6419 wird. Beispiel:</para>
6421 <programlisting><%if not cp_greeting%>
6423 <%end%></programlisting>
6425 <para>Zusätzlich zu dem einfachen Test, ob eine Variable gesetzt ist
6426 oder nicht, bietet dieser Block auch die Möglichkeit, den Inhalt
6427 einer Variablen mit einer festen Zeichenkette oder einer anderen
6428 Variablen zu vergleichen. Ob der Vergleich mit einer Zeichenkette
6429 oder einer anderen Variablen vorgenommen wird, hängt davon ab, ob
6430 die rechte Seite des Vergleichsoperators in Anführungszeichen
6431 gesetzt wird (Vergleich mit Zeichenkette) oder nicht (Vergleich mit
6432 anderer Variablen). Zwei Beispiele, die beide Vergleiche
6435 <programlisting><%if var1 == "Wert"%></programlisting>
6437 <para>Testet die Variable <varname>var1</varname> auf
6438 übereinstimmung mit der Zeichenkette <constant>Wert</constant>.
6439 Mittels <function>!=</function> anstelle von <function>==</function>
6440 würde auf Ungleichheit getestet.</para>
6442 <programlisting><%if var1 == var2%></programlisting>
6444 <para>Testet die Variable <varname>var1</varname> auf
6445 übereinstimmung mit der Variablen <varname>var2</varname>. Mittel
6446 <function>!=</function> anstelle von <function>==</function> würde
6447 auf Ungleichheit getestet.</para>
6449 <para>Erfahrere Benutzer können neben der Tests auf (Un-)Gleichheit
6450 auch Tests auf Übereinstimmung mit regulären Ausdrücken ohne
6451 Berücksichtung der Groß- und Kleinschreibung durchführen. Dazu dient
6452 dieselbe Syntax wie oben nur mit <function>=~</function> und
6453 <function>!~</function> als Vergleichsoperatoren.</para>
6455 <para>Beispiel für einen Test, ob die Variable
6456 <varname>intnotes</varname> (interne Bemerkungen) das Wort
6457 <constant>schwierig</constant> enthält:</para>
6459 <programlisting><%if intnotes =~ "schwierig"%></programlisting>
6462 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.foreach">
6463 <title>Der foreach-Block</title>
6465 <programlisting><%foreach variablenname%>
6467 <%end%></programlisting>
6469 <para>Fügt die Zeilen zwischen den beiden Anweisungen so oft ein,
6470 wie das Perl-Array der Variablen <varname>variablenname</varname>
6471 Elemente enthät. Dieses Konstrukt wird zur Ausgabe der einzelnen
6472 Posten einer Rechnung / eines Angebots sowie zur Ausgabe der Steuern
6473 benutzt. In jedem Durchlauf werden die <link
6474 linkend="dokumentenvorlagen-und-variablen.invoice-posten">zeilenbezogenen
6475 Variablen</link> jeweils auf den Wert für die aktuelle Position
6478 <para>Die Syntax sieht normalerweise wie folgt aus:</para>
6480 <programlisting><%foreach number%>
6481 Position: <%runningnumber%>
6482 Anzahl: <%qty%>
6483 Artikelnummer: <%number%>
6484 Beschreibung: <%description%>
6486 <%end%></programlisting>
6488 <para>Besonderheit in OpenDocument-Vorlagen: Tritt ein
6489 <function><%foreach%></function>-Block innerhalb einer
6490 Tabellenzelle auf, so wird die komplette Tabellenzeile so oft
6491 wiederholt wie notwendig. Tritt er außerhalb auf, so wird nur der
6492 Inhalt zwischen <function><%foreach%></function> und
6493 <function><%end%></function> wiederholt, nicht aber die
6494 komplette Zeile, in der er steht.</para>
6498 <sect2 id="dokumentenvorlagen-und-variablen.markup">
6499 <title>Markup-Code zur Textformatierung innerhalb von
6502 <para>Wenn der Benutzer innhalb von Formularen in kivitendo Text
6503 anders formatiert haben möchte, so ist dies begrenzt möglich.
6504 kivitendo unterstützt die Textformatierung mit HTML-ähnlichen Tags.
6505 Der Benutzer kann z.B. bei der Artikelbeschreibung auf einer Rechnung
6506 Teile des Texts zwischen Start- und Endtags setzen. Dieser Teil wird
6507 dann automatisch in Anweisungen für das ausgewählte Vorlagenformat
6508 (HTML oder PDF über LaTeX) umgesetzt.</para>
6510 <para>Die unterstützen Formatierungen sind:</para>
6514 <term><b>Text</b></term>
6517 <para>Text wird in Fettdruck gesetzt.</para>
6522 <term><i>Text</i></term>
6525 <para>Text wird kursiv gesetzt.</para>
6530 <term><u>Text</u></term>
6533 <para>Text wird unterstrichen.</para>
6538 <term><s>Text</s></term>
6541 <para>Text wird durchgestrichen. Diese Formatierung ist nicht
6542 bei der Ausgabe als PDF über LaTeX verfügbar.</para>
6547 <term><bullet></term>
6550 <para>Erzeugt einen ausgefüllten Kreis für Aufzählungen (siehe
6556 <para>Der Befehl <command><bullet></command> funktioniert
6557 momentan auch nur in Latex-Vorlagen.</para>
6560 <sect2 id="dokumentenvorlagen-und-variablen.anrede"
6561 xreflabel="Hinweise zur Anrede">
6562 <title>Hinweise zur Anrede</title>
6564 <para>Das Flag "natürliche Person"
6565 (<varname>natural_person</varname>) aus den Kunden- oder
6566 Lieferantenstammdaten kann in den Druckvorlagen zusammen mit
6567 dem Feld "Anrede" (<varname>greeting</varname>) z.B. dafür
6568 verwendet werden, die Anrede zwischen einer allgemeinen und
6569 einer persönlichen Anrede zu unterscheiden.
6570 <programlisting><%if natural_person%><%greeting%> <%name%><%else%>Sehr geehrte Damen und Herren<%end if%></programlisting>
6576 <sect1 id="excel-templates">
6577 <title>Excel-Vorlagen</title>
6579 <sect2 id="excel-templates.summary">
6580 <title>Zusammenfassung</title>
6582 <para>Dieses Dokument beschreibt den Mechanismus, mit dem
6583 Exceltemplates abgearbeitet werden, und die Einschränkungen, die damit
6587 <sect2 id="excel-templates.usage">
6588 <title>Bedienung</title>
6590 <para>Der Excel Mechanismus muss in der Konfigurationsdatei aktiviert
6591 werden. Die Konfigurationsoption heißt <varname>excel_templates =
6592 1</varname> im Abschnitt <varname>[print_templates]</varname>.</para>
6594 <para>Eine Excelvorlage kann dann unter dem Namen einer beliebigen
6595 anderen Vorlage mit der Endung <filename>.xls</filename> gespeichert
6596 werden. In den normalen Verkaufsmasken taucht nun
6597 <constant>Excel</constant> als auswählbares Format auf und kann von da
6598 an wie LaTeX- oder OpenOffice-Vorlagen benutzt werden.</para>
6600 <para>Der Sonderfall der Angebote aus der Kundenmaske ist ebenfalls
6601 eine Angebotsvorlage und wird unter dem internen Namen der Angebote
6602 <filename>sales_quotation.xls</filename> gespeichert.</para>
6605 <sect2 id="excel-templates.syntax">
6606 <title>Variablensyntax</title>
6608 <para>Einfache Syntax:
6609 <command><<varname>></command></para>
6611 <para>Dabei sind <constant><<</constant> und
6612 <constant>>></constant> die Delimiter. Da Excel auf festen
6613 Breiten besteht, kann der Tag künstlich verlängert werden, indem
6614 weitere <constant><</constant> oder <constant>></constant>
6615 eingefügt werden. Der Tag muss nicht symmetrisch sein.
6618 <programlisting><<<<<varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
6620 <para>Um die Limitierung der festen Breite zu reduzieren, können
6621 weitere Variablen in einem Block interpoliert werden. Whitespace wird
6622 dazwishen dann erhalten. Beispiel:</para>
6624 <programlisting><<<<<varname1 varname2 varname3>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
6626 <para>Die Variablen werden interpoliert, und linksbündig mit
6627 Leerzeichen auf die gewünschte Länge aufgefüllt. Ist der String zu
6628 lang, werden überzählige Zeichen abgeschnitten.</para>
6630 <para>Es ist ausserdem möglich, Daten rechtsbündig darzustellen, wenn
6631 der Block mit einem Leerzeichen anfängt. Beispiel:</para>
6633 <programlisting><<<<<< varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
6635 <para>Dies würde rechtsbündig triggern. Wenn bei rechtsbündiger
6636 Ausrichtung Text abgeschnitten werden muss, wird er vom linken Ende
6640 <sect2 id="excel-templates.limitations">
6641 <title>Einschränkungen</title>
6643 <para>Das Excelformat bis 2002 ist ein binäres Format, und kann nicht
6644 mit vertretbarem Aufwand editiert werden. Der Templatemechanismus
6645 beschränkt sich daher darauf, Textstellen exakt durch einen anderen
6646 Text zu ersetzen.</para>
6648 <para>Aus dem gleichen Grund sind die Kontrolllstrukturen
6649 <command><%if%></command> und
6650 <command><%foreach%></command> nicht vorhanden. Der Delimiter
6651 <constant><% %></constant> kommt in den Headerinformationen
6652 evtl. vor. Deshalb wurde auf den sichereren Delimiter
6653 <constant><<</constant> und <constant>>></constant>
6658 <sect1 id="features.warehouse">
6659 <title>Mandantenkonfiguration Lager</title>
6661 <para>Die Lagerverwaltung in kivitendo funktioniert standardmässig wie
6662 folgt: Wird ein Lager mit einem Lagerplatz angelegt, so gibt es die
6663 Möglichkeit hier über den Menüpunkt Lager entsprechende Warenbewegungen
6664 durchzuführen. Ferner kann jede Position eines Lieferscheins ein-, bzw.
6665 ausgelagert werden (Einkauf-, bzw. Verkauf). Es können beliebig viele
6666 Lager mit beliebig vielen Lagerplätzen abgebildet werden. Die
6667 Lagerbewegungen über einen Lieferschein erfolgt durch Anklicken jeder
6668 Einzelposition und das Auswählen dieser Position zu einem Lager mit
6669 Lagerplatz. Dieses Verfahren lässt sich schrittweise vereinfachen, je
6670 nachdem wie die Einstellungen in der Mandatenkonfiguration gesetzt
6675 <para><option>Auslagern über Standardlagerplatz</option> Hier wird
6676 ein zusätzlicher Knopf (Auslagern über Standard-Lagerplatz) in dem
6677 Lieferschein-Beleg hinzugefügt, der dann alle Lagerbewegungen über
6678 den Standardlagerplatz (konfigurierbar pro Ware) durchführt.</para>
6682 <para><option>Auslagern ohne Bestandsprüfung</option> Das obige
6683 Auslagern schlägt fehl, wenn die entsprechende Menge für die
6684 Lagerbewegung nicht vorhanden ist, möchte man dies auch ignorieren
6685 und ggf. dann nachpflegen, so kann man eine Negativ-Warenmenge mit
6686 dieser Option erlauben. Hierfür muss ein entsprechender Lagerplatz
6687 (Fehlbestand, o.ä.) konfiguriert sein.</para>
6691 <para>Zusätzliche Funktionshinweise:</para>
6695 <para><option>Standard-Lagerplatz</option> Ist dieser konfiguriert,
6696 wird dies auch als Standard-Voreinstellung bei der Neuerfassung von
6697 Stammdaten → Waren / Dienstleistung / Erzeugnis verwendet.</para>
6701 <para><option>Standard-Lagerplatz verwenden, falls keiner in
6702 Stammdaten definiert</option> Wird beim 'Auslagern über
6703 Standardlagerplatz' keine Standardlagerplatz zu der Ware gefunden,
6704 so wird mit dieser Option einfach der Standardlagerplatz
6710 <sect1 id="features.swiss-charts-of-accounts">
6711 <title>Schweizer Kontenpläne</title>
6713 <para>Seit der Version 3.5 stehen in kivitendo 3 Kontenpläne für den
6714 Einsatz in der Schweiz zur Verfügung, einer für Firmen und
6715 Organisationen, die nicht mehrwertsteuerpflichtig sind, einer für
6716 Firmen, die mehrwertsteuerpflichtig sind und einer speziell für
6719 <para>Die Kontenpläne orientieren sich am in der Schweiz üblicherweise
6720 verwendeten KMU-Kontenrahmen und sind mit der Revision des
6721 Schweizerischen Obligationenrechts (OR) vom 1.1.2013 kompatibel,
6722 insbesondere <literal>Art.957a Abs.2</literal>.</para>
6724 <para>Beim Vereinskontenplan sind standardmässig nur die Konten 1100
6725 (Debitoren CHF) und 1101 (Debitoren EUR) als Buchungskonten im Verkauf
6726 sowie die Konten 2000 (Kreditoren CHF) und 2001 (Kreditoren EUR) als
6727 Buchungskonten im Einkauf vorgesehen. Weitere Konten können bei Bedarf
6728 in den Konto-Detaileinstellungen als Einkaufs- oder Verkaufskonten
6729 konfiguriert werden.</para>
6731 <para>Die Möglichkeit, Saldosteuersätze zu verwenden ist in der
6732 aktuellen Version von kivitendo noch nicht integriert.</para>
6734 <para>Trotzdem können auch Firmen, die per Saldosteuersatz mit der
6735 Eidgenössischen Steuerverwaltung abrechnen, kivitendo bereits nutzen.
6736 Dazu wird der Kontenplan mit MWST ausgewählt. Anschliessend müssen alle
6737 Aufwandskonten editiert werden und dort der Steuersatz auf 0% gesetzt
6740 <para>So werden bei Kreditorenbuchungen keine Vorsteuern
6743 <para>Bezugssteuern für aus dem Ausland bezogene Dienstleistungen müssen
6744 manuell verbucht werden.</para>
6746 <para>Wünsche für Anpassungen an den Schweizer Kontenplänen sowie
6747 Vorschläge für weitere (z.B. branchenspezifische) Kontenpläne bitte an
6748 <literal>empfang@revamp-it.ch</literal> senden.</para>
6751 <sect1 id="features.part_classification">
6752 <title>Artikelklassifizierung</title>
6755 <title>Übersicht</title>
6757 <para>Die Klassifizierung von Artikeln dient einer weiteren
6758 Gliederung, um zum Beispiel den Einkauf vom Verkauf zu trennen,
6759 gekennzeichnet durch eine Beschreibung (z.B. "Einkauf") und ein Kürzel
6760 (z.B. "E"). Für jede Klassifizierung besteht eine Beschreibung und
6761 eine Abkürzung die normalerweise aus einem Zeichen besteht, kann aber
6762 auf mehrere Zeichen erweitert werden, falls zur Unterscheidung
6763 notwendig. Sinnvoll sind jedoch nur maximal 2 Zeichen.</para>
6767 <title>Basisklassifizierung</title>
6769 <para>Als Basisklassifizierungen gibt es</para>
6773 <para>Einkauf</para>
6777 <para>Verkauf</para>
6781 <para>Handelsware</para>
6785 <para>Produktion</para>
6789 <para>- keine - (diese wird bei einer Aktualisierung für alle
6790 existierenden Artikel verwendet und ist gültig für Verkauf und
6795 <para>Es können weitere Klassifizierungen angelegt werden. So kann es
6796 z.B. für separat auszuweisende Artikel folgende Klassen geben:</para>
6800 <para>Lieferung (Logistik, Transport) mit Kürzel L</para>
6804 <para>Material (Verpackungsmaterial) mit Kürzel M</para>
6810 <title>Attribute</title>
6812 <para>Bisher haben die Klassifizierungen folgende Attribute, die auch
6813 alle gleichzeitg gültig sein können</para>
6817 <para>gültig für Verkauf - dieser Artikel kann im Verkauf genutzt
6822 <para>gültig für Einkauf - dieser Artikel kann im Einkauf genutzt
6827 <para>separat ausweisen - hierzu gibt es zur Dokumentengenerierung
6828 (LaTeX) eine zusätzliche Variable</para>
6832 <para>Für das Attribut "separat ausweisen" stehen in den
6833 LaTeX-Vorlagen die Variable <emphasis
6834 role="bold"><%non_separate_subtotal%> </emphasis>zur Verfügung,
6835 die alle nicht separat auszuweisenden Artikelkosten saldiert, sowie
6836 pro separat auszuweisenden Klassifizierungen die Variable<emphasis
6837 role="bold">< %separate_X_subtotal%></emphasis>, wobei X das
6838 Kürzel der Klassifizierung ist.</para>
6840 <para>Im obigen Beispiel wäre das für Lieferkosten <emphasis
6841 role="bold"><%separate_L_subtotal%></emphasis> und für
6842 Verpackungsmaterial <emphasis role="bold">
6843 <%separate_M_subtotal%></emphasis>.</para>
6847 <title>Zwei-Zeichen Abkürzung</title>
6849 <para>Der Typ des Artikels und die Klassifizierung werden durch zwei
6850 Buchstaben dargestellt. Der erste Buchstabe ist eine Lokalisierung des
6851 Artikel-Typs ('P','A','S'), deutsch 'W', 'E', und 'D' für Ware
6852 Erzeugnis oder Dienstleistung und ggf. weiterer Typen.</para>
6854 <para>Der zweite Buchstabe (und ggf. auch ein dritter, falls nötig)
6855 entspricht der lokalisierten Abkürzung der Klassifizierung.</para>
6857 <para>Diese Abkürzung wird überall beim Auflisten von Artikeln zur
6858 Erleichterung mit dargestellt.</para>
6862 <sect1 id="features.file_managment">
6863 <title>Dateiverwaltung (Mini-DMS)</title>
6866 <title>Übersicht</title>
6868 <para>Parallel zum alten WebDAV gibt es ein Datei-Management-System,
6869 das Dateien verschiedenen Typs verwaltet. Dies können</para>
6873 <para>aus ERP-Daten per LaTeX Template erzeugte
6874 PDF-Dokumente,</para>
6878 <para>zu bestimmten ERP-Daten gehörende Anhangdateien
6879 unterschiedlichen Formats,</para>
6883 <para>per Scanner eingelesene PDF-Dateien,</para>
6887 <para>per E-Mail empfangene Dateianhänge unterschiedlichen
6892 <para>sowie speziel für Artikel hochgeladene Bilder sein.</para>
6897 <screeninfo>Übersicht</screeninfo>
6901 <imagedata contentwidth="600" fileref="images/DMS-Overview.png"/>
6908 <title>Struktur</title>
6910 <para>Über eine vom Speichermedium unabhängige Zwischenschicht werden
6911 die Dateien und ihre Versionen in der Datenbank verwaltet. Darunter
6912 können verschiedene Implementierungen (Backends) gleichzeitig
6917 <para>Dateisystem</para>
6925 <para>Schnittstelle zu externen
6926 Dokumenten-Management-Systemen</para>
6930 <para>andere Datenbank</para>
6934 <para>etc ...</para>
6938 <para>Es gibt unterschiedliche Typen von Dateien. Jedem Typ läßt sich
6939 in der Mandantenkonfiguration ein bestimmtes Backend zuordnen.</para>
6943 <para>"document": Das sind entweder generierte, eingescannte oder
6944 hochgeladene PDF-Dateien, die zu bestimmten ERP-Daten
6945 (ERP-Objekte, wie z.B. Rechnung, Lieferschein) gehören.</para>
6949 <para>"attachment": zusätzlich hochgeladene Dokumente, die an
6950 bestimmte ERP-Objekte angehängt werden, z.B. technische
6951 Zeichnungen, Aufmaße. Diese können auch für Artikel, Lieferanten
6952 und Kunden hinterlegt sein.</para>
6956 <para>"image": Bilder für Artikel. Diese können auch verkleinert
6957 in einer Vorschau (Thumbnail) angezeigt werden.</para>
6961 <para>Zusätzlich werden in der Datenbank zu den Dateien neben der
6962 Zuordnung zu ERP-Objekten, Dateityp Dateinamen und Backend, in dem die
6963 Datei gespeichert ist, auch die Quelle der Datei notiert:</para>
6967 <para>"created": vom System erzeugte Dokumente"</para>
6971 <para>"uploaded": hochgeladene Dokumente</para>
6975 <para>"email": vom Mail-System empfangene Dateien</para>
6979 <para>"scanner[1]": von einem oder mehreren Scannern erzeugte
6980 Dateien. Existieren mehrere Scanner, so sind diese durch
6981 unterschiedliche Quellennamen zu definieren.</para>
6985 <para>Je nach Dateityp sind nur bestimmte Quellen zulässig. So gibt es
6986 für "attachment" und "image" nur die Quelle "uploaded". Für "document"
6987 gibt es auf jeden Fall die Quelle "created". Die Quellen "scanner" und
6988 "email" müssen derzeit in der Datenbank konfiguriert werden (siehe
6989 <xref linkend="file_management.dbconfig"/>).</para>
6993 <title>Anwendung</title>
6995 <para>Die Daten werden bei den ERP-Objekten als extra Reiter
6996 dargestellt. Eine Verkaufsrechnung z.B. hat die Reiter "Dokumente" und
6997 "Dateianhänge".</para>
7000 <screeninfo>Reiter "Dateianhänge"</screeninfo>
7004 <imagedata fileref="images/DMS-Anhaenge.png" scale="50"/>
7009 <para>Bei den Dateianhängen wird immer nur die aktuelle Version einer
7010 Datei angezeigt. Wird eine Datei mit gleichem Namen hochgeladen, so
7011 wird eine neue Version der Datei erstellt. Vorher wird der Anwender
7012 durch einen Dialog gefragt, ob er eine neue Version anlegen will oder
7013 ob er die Datei umbenennen will, falls es eine neue Datei sein
7017 <screeninfo>Reiter "Dateianhänge"</screeninfo>
7021 <imagedata contentwidth="40"
7022 fileref="images/DMS-Anhaenge-hochladen.png"
7028 <para>Es können mehrere Dateien gleichzeitig hochgeladen werden,
7029 solange in Summe die maximale Größe nicht überschritten wird (siehe
7030 <xref linkend="file_management.clientconfig"/>).</para>
7033 <screeninfo>Reiter "Dokumente"</screeninfo>
7037 <imagedata fileref="images/DMS-Dokumente.png" width="500"/>
7042 <para>Sind keine weiteren Quellen für Dokumente konfiguriert, so gibt
7043 es nur "erzeugte Dokumente". Es werden alle Versionen der generierten
7044 Datei angezeigt. Für Verkaufsrechnungen kommen keine anderen Quellen
7045 zur Geltung. Werden entsprechend der <xref
7046 linkend="file_management.dbconfig"/> zusätzliche Quellen konfiguriert,
7047 so sind diese z.B. bei Einkaufsrechnungen sichtbar:</para>
7050 <screeninfo>Reiter "Dokumente"</screeninfo>
7054 <imagedata contentwidth="600"
7055 fileref="images/DMS-Dokumente-Scanner.png"/>
7060 <para>Statt des Löschens wird hier die Datei zurück zur Quelle
7061 verschoben. Somit kann die Datei anschließend an ein anderes
7062 ERP-Objekt angehängt werden.</para>
7064 <para>Derzeit sind "Titel" und "Beschreibung" noch nicht genutzt. Sie
7065 sind bisher nur bei Bildern relevant.</para>
7069 <title>Konfigurierung</title>
7071 <sect3 id="file_management.clientconfig"
7072 xreflabel="Mandantenkonfigurierung">
7073 <title>Mandantenkonfiguration</title>
7076 <title>Reiter "Features"</title>
7078 <para>Unter dem Reiter <emphasis role="bold">Features</emphasis>
7079 im Abschnitt Dateimanagement ist neben dem "alten" WebDAV das
7080 Dateimangement generell zu- und abschaltbar, sowie die Zuordnung
7081 der Dateitypen zu Backends. Die Löschbarkeit von Dateien, sowie
7082 die maximale Uploadgröße sind Backend-unabhängig</para>
7085 <screeninfo>Mandantenkonfig Reiter "Features"</screeninfo>
7089 <imagedata fileref="images/DMS-ClientConfig.png" width="500"/>
7094 <para>Die einzelnen Backends sind einzeln einschaltbar.
7095 Spezifische Backend-Konfigurierungen sind hier noch
7100 <title>Reiter "Allgemeine Dokumentenanhänge"</title>
7102 <para>Unter dem Reiter <emphasis role="bold">Allgemeine
7103 Dokumentenanhänge</emphasis> kann für alle ERP-Dokumente (
7104 Angebote, Aufträge, Lieferscheine, Rechnungen im Verkauf und
7105 Einkauf ) allgemeingültige Anhänge hochgeladen werden.</para>
7108 <screeninfo>Mandantenkonfig Reiter "Allgemeine
7109 Dokumentenanhänge"</screeninfo>
7113 <imagedata fileref="images/DMS-Allgemeine-Dokumentenanhaenge.png"
7119 <para>Diese Anhänge werden beim Generieren von PDF-Dateien an die
7120 ERP-Dokumente angehängt, z.B. AGBs oder aktuelle Angebote. Es
7121 werden in dem Fall die Daten kopiert, sodass an den ERP-Dokumenten
7122 immer die Anhänge zum Generierungszeitpunkt eingebettet
7127 <sect3 id="file_management.dbconfig"
7128 xreflabel="Datenbank-Konfigurierung">
7129 <title>Datenbank-Konfigurierung</title>
7131 <para>Die zusätzlichen Quellen für "email" oder ein oder mehrere
7132 Scanner sind derzeit vom Administrator direkt in der
7133 Datenbanktabelle "user_preferences" einzurichten. Die "value" ist im
7134 JSON-Format mit den jeweiligen Werten des Verzeichnisses und der
7135 Beschreibung der Quelle.</para>
7138 id | login | namespace | version | key | value
7139 ----+-----------+--------------+---------+----------+---------------------------
7140 1 | #default# | file_sources | 0.00000 | scanner1 |
7141 {"dir":"/var/tmp/scanner1","desc":"Scanner Einkauf"}
7142 2 | #default# | file_sources | 0.00000 | scanner2 |
7143 {"dir":"/var/tmp/scanner2","desc":"Scanner Verkauf"}
7144 3 | #default# | file_sources | 0.00000 | emails |
7145 {"dir":"/var/tmp/emails","desc":"Empfangene Mails" }
7148 <para>Es ist daran gedacht, statt dem Default-Eintrag später für
7149 bestimmte Benutzer ('login') bestimmte Quellen zuzulassen. Dies wird
7150 nach Bedarf implementiert.</para>
7153 <sect3 id="file_management.kiviconfig"
7154 xreflabel="kivitendo-Konfigurationsdatei">
7155 <title>kivitendo-Konfigurationsdatei</title>
7157 <para>Dort ist im Abschnitt [paths] der relative oder absolute Pfad
7158 zum Dokumentenwurzelverzeichnis einzutragen. Dieser muss für den
7159 Webserver schreib- und lesbar sein, jedoch nicht ausführbar.</para>
7163 document_path = /var/local/kivi_documents
7166 <para>Unter diesem Wurzelverzeichnis wird pro Mandant automatisch
7167 ein Unterverzeichnis mit der ID des Mandanten angelegt.</para>
7173 <title>Webshop-Api</title>
7175 <para>Das Shopmodul bietet die Möglichkeit Onlineshopartikel und
7176 Onlineshopbestellungen zu verwalten und zu bearbeiten.</para>
7178 <para>Es ist Multishopfähig, d.h. Artikel können mehreren oder
7179 unterschiedlichen Shops zugeordnet werden. Bestellungen können aus
7180 mehreren Shops geholt werden.</para>
7182 <para>Zur Zeit bietet das Modul nur einen Connector zur REST-Api von
7183 Shopware. Weitere Connectoren können dazu programmiert und eingerichtet
7187 <title>Rechte für die Webshopapi</title>
7189 <para>In der Administration können folgende Rechte vergeben
7194 <para>Webshopartikel anlegen und bearbeiten</para>
7198 <para>Shopbestellungen holen und bearbeiten</para>
7202 <para>Shop anlegen und bearbeiten</para>
7208 <title>Konfiguration</title>
7210 <para>Unter System->Webshops können Shops angelegt und konfiguriert
7215 <imagedata contentdepth="500" contentwidth="700"
7216 fileref="images/Shop_Listing.png"/>
7222 <title>Webshopartikel</title>
7225 <title>Shopvariablenreiter in Artikelstammdaten</title>
7227 <para>Mit dem Recht "Shopartikel anlegen und bearbeiten" und des
7228 Markers <emphasis role="bold">"Shopartikel" in den Basisdaten
7229 </emphasis>zeigt sich der Reiter "Shopvariablen" in den
7230 Artikelstammdaten. Hier können jetzt die Artikel mit
7231 unterschiedlichen Beschreibung und/oder Preisen für die
7232 konfigutierten Shops angelegt und bearbeitet werden. An dieser
7233 Stelle können auch beliebig viele Bilder dem Shopartikel zugeordnet
7234 werden. Artikelbilder gelten für alle Shops.</para>
7238 <imagedata contentdepth="500" contentwidth="600"
7239 fileref="images/Shop_Artikel.png"/>
7243 <para>Die Artikelgruppen werden direkt vom Shopsystem geholt somit
7244 ist es möglich einen Artikel auch mehreren Gruppen
7249 <title>Shopartikelliste</title>
7251 <para>Unter dem Menu Webshop->Webshop Artikel hat man nochmal
7252 eine Gesamtübersicht. Von hier aus ist es möglich Artikel im Stapel
7253 unter verschiedenen Kriterien <alles><nur Preis><nur
7254 Bestand><Preis und Bestand> an die jeweiligen Shops
7259 <imagedata fileref="images/Shop_Artikel_Listing.png"/>
7266 <title>Bestellimport</title>
7268 <para>Unter dem Menupunkt Webshop->Webshop Import öffnet sich die
7269 Bestellimportsliste. Hier ist sind Möglichkeiten gegeben Neue
7270 Bestellungen vom Shop abzuholen, geholte Bestellungen im Stapel oder
7271 einzeln als Auftrag zu transferieren. Die Liste kann nach
7272 verschiedenen Kriterien gefiltert werden.</para>
7276 <imagedata fileref="images/Shop_Bestell.png"/>
7280 <para>Bei Einträgen in der Liste.</para>
7284 <para>keine Kundennummer: Es gibt ähnliche Kundendatensätze und
7285 der Datensatz konnte nicht eindeutig zugewiesen werden.</para>
7289 <para>Kundennummer und Rechnungen rot hinterlegt: Der Kunde hat
7290 offene Posten und kann deswegen nicht im Stapel übernommen
7295 <para>Rechnungsadresse grün hinterlegt: Der Kunde konnte eindeutig
7296 einem Datensatz zugeordnet werden. Die Shopbestellung kann im
7297 Stapel mit dem Button "Anwenden" und wenn markiert als Auftrag
7298 übernommen werden.</para>
7302 <para>Kundennummer vorhanden, aber die Checkbox "Auftrag
7303 erstellen" fehlt. Der Kunde hat vermutlich eine
7304 Shopauftragssperre.</para>
7308 <para>Lieferadresse grau hinterlegt: Optische Anzeige, dass es
7309 sich um eine unterschiedliche Lieferadresse handelt.
7310 Lieferadressen werden aber grundsätzlich beim Transferieren zu
7311 Aufträgen mit übernommen.</para>
7315 <para>In der Spalte Positionen/Betrag/Versandkosten zeigt sich ein
7316 tooltip zu den Positionen.</para>
7320 <para>Maske Auftrag erstellen</para>
7322 <para>Viele Shopsysteme haben drei verschieden Adresstypen Kunden-,
7323 Rechnungs-, und Lieferadresse, die sich auch alle unterscheiden
7324 können. Diese werden im oberen Bereich angezeigt. Es ist möglich jede
7325 dieser Adresse einzeln in kivitendo als Kunde zu übernehmen. Es werden
7326 die Werte Formulareingabe übernommen. Es wird bei einer Änderung
7327 allerdings nur diese in die kivitendo Kundenstammdaten übernommen, die
7328 Shopbestellung bleibt bestehen.</para>
7330 <para>Mit der mittleren Adresse(Rechnungsadresse) im oberen Bereich,
7331 kann ich den ausgewählten kivitendodatensatz des mittleren Bereich
7332 überschreiben. Das ist sinnvoll, wenn ich erkenne, das der Kunde z.B.
7333 umgezogen ist.</para>
7335 <para>Im mittleren Bereich das Adresslisting zeigt:</para>
7339 <para>Rot hinterlegt: Kunde hat eine Shopauftragssperre, diese
7340 muss zuerst deaktiviert werden bevor ich diesem Kunden eine
7341 Shopbestellung zuordnen kann.</para>
7345 <para>Kundenname fett und rot: Hier hat der Kunde eine Bemerkung
7346 in den Stammdaten. Ein Tooltip zeigt diese Bemerkung. Das kann dan
7347 auch der Grund für die Auftragssperre sein.</para>
7351 <para>Die Buttons "Auftrag erstellen" und "Kunde mit
7352 Rechnungsadresse überschreiben" zeigen sich erst, wenn ein Kunde
7353 aus dem Listing ausgewählt ist.</para>
7357 <para>Es ist aber möglich die Shopbestellung zu löschen.</para>
7361 <para>Ist eine Bestellung schon übernommen, zeigen sich an dieser
7362 Stelle, die dazugehörigen Belegverknüpfungen.</para>
7368 <title>Mapping der Daten</title>
7370 <para>Das Mapping der kivitendo Daten mit den Shopdaten geschieht in
7371 der Datei SL/ShopConnector/<SHOPCONNECTORNAME>.pm
7372 z.B.:SL/ShopConnector/Shopware.pm</para>
7374 <para>In dieser Datei gibt es einen Bereich wo die Bestellpostionen,
7375 die Bestellkopfdaten und die Artikeldaten gemapt werden. In dieser
7376 Datei kann ein individelles Mapping dann gemacht werden. Zu Shopware
7377 gibt es hier eine sehr gute Dokumentation: <ulink
7378 url="https://developers.shopware.com/developers-guide/rest-api/">https://developers.shopware.com/developers-guide/rest-api/</ulink></para>
7381 <sect1 id="features.zugferd">
7382 <title>ZUGFeRD Rechnungen</title>
7383 <sect2 id="features.zugferd.preamble">
7384 <title>Vorbedingung</title>
7386 Für die Erstellung von ZUGFeRD PDFs wird TexLive2018 oder höher benötigt.
7390 Wer kein TexLive2018 oder höher installieren kann, kann eine lokale Umgebung nur für kivitendo wie folgt erzeugen:
7393 1. Download des offiziellen Installers von https://www.tug.org/texlive/quickinstall.html
7395 2. Installer ausführen, Standard-Ort für Installation belassen, evtl. ein paar Pakete abwählen, installieren lassen
7397 3. Ein kleine Script »run_pdflatex.sh« anlegen, das den PATH auf das Installationsverezichnis setzt und pdflatex ausführt:
7399 ------------------------------------------------------------
7402 export PATH=/usr/local/texlive/2020/bin/x86_64-linux:$PATH
7405 exec pdflatex "$@"
7406 ------------------------------------------------------------
7408 4. In config/kivitendo.conf den Parameter »latex« auf den Pfad zu »run_pdflatex.sh« setzen
7410 5. Webserver neu starten
7414 <sect2 id="features.zugferd.summary">
7415 <title>Übersicht</title>
7417 <para>Mit der Version 3.5.6 bietet kivitendo die Möglichkeit ZUGFeRD
7418 Rechnungen zu erstellen, sowie auch ZUGFeRD Rechnungen direkt in
7419 kivitendo einzulesen. </para>
7421 <para>Bei ZUGFeRD Rechnungen handelt es sich um eine PDF Datei in
7422 der eine XML-Datei eingebettet ist. Der Aufbau der XML-Datei ist
7423 standardisiert und ermöglicht so den Austausch zwischen
7424 den verschiedenen Softwareprodukten. Kivitendo setzt mit der
7425 Version 3.5.6 den ZUGFeRD 2.1 Standard um.</para>
7427 <para>Weiter Details zu ZUGFeRD sind unter diesem Link zu finden:
7428 <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>
7432 <sect2 id="features.zugferd.create_zugferd_bills">
7434 <title>Erstellen von ZUGFeRD Rechnungen in Kivitendo</title>
7435 <para>Für die Erstellung von ZUGFeRD Rechnungen bedarf es in
7436 kivitendo zwei Dinge:</para>
7441 <para>Die Erstellung muss in der Mandantenkonfiguration
7442 aktiviert sein</para>
7446 <para>Beim mindestens einem Bankkonto muss die Option
7447 „Nutzung von ZUGFeRD“ aktiviert sein</para>
7452 <title>Mandantenkonfiguration</title>
7454 <para>Die Einstellung für die Erstellung von ZUGFeRD Rechnungen
7455 erfolgt unter „System“ → „Mandatenkonfiguration“ → „Features“.
7456 Im Abschnitt „Einkauf und Verkauf“ finden Sie die Einstellung
7457 „Verkaufsrechnungen mit ZUGFeRD-Daten erzeugen“.
7458 Hier besteht die Auswahl zwischen:</para>
7462 <para>ZUGFeRD-Rechnungen erzeugen</para>
7466 <para>ZUGFeRD-Rechnungen im Testmodus erzeugen</para>
7470 <para>Keine ZUGFeRD Rechnungen erzeugen</para>
7475 <para>Rechnungen die als PDF erzeugt werden, werden je nach
7476 Einstellung nun im ZUGFeRD Format ausgegeben.</para>
7481 <title>Konfiguration der Bankkonten</title>
7483 <para>Unter „System → Bankkonten“ muss bei mindestens einem
7484 Bankkonto die Option „Nutzung mit ZUGFeRD“ auf „Ja“ gestellt
7490 <sect2 id="features.zugferd.read_zugferd_bills">
7492 <title>Einlesen von ZUGFeRD Rechnungen in Kivitendo</title>
7494 <para>Es lassen sich auch Rechnungen von Kreditoren, die im
7495 ZUGFeRD Format erstellt wurden, nach Kivitendo importieren.
7496 Hierfür müssen auch zwei Voraussetzungen erfüllt werden:
7502 <para>Beim Lieferanten muss die Umsatzsteuer-ID und das
7503 Bankkonto hinterlegt sein</para>
7507 <para>Für den Kreditoren muss eine Buchungsvorlage existieren.</para>
7512 <para>Wenn diese Voraussetzungen erfüllt sind, kann die Rechnung
7513 über „Finanzbuchhaltung“ → „Factur-X-/ZUGFeRD-Import“ über die „Durchsuchen“
7514 Schaltfläche ausgewählt werden und über die Schaltfläche „Import“
7515 eingeladen werden. Es öffnet sich daraufhin die Kreditorenbuchung.
7516 Die auslesbaren Daten aus dem eingebetteten XML der PDF Datei
7517 werden in der Kreditorenbuchung ergänzt.</para>
7526 <title>Entwicklerdokumentation</title>
7528 <sect1 id="devel.globals" xreflabel="Globale Variablen">
7529 <title>Globale Variablen</title>
7532 <title>Wie sehen globale Variablen in Perl aus?</title>
7534 <para>Globale Variablen liegen in einem speziellen namespace namens
7535 "main", der von überall erreichbar ist. Darüber hinaus sind bareword
7536 globs global und die meisten speziellen Variablen sind...
7539 <para>Daraus ergeben sich folgende Formen:</para>
7543 <term><literal>$main::form</literal></term>
7546 <para>expliziter Namespace "main"</para>
7551 <term><literal>$::form</literal></term>
7554 <para>impliziter Namespace "main"</para>
7559 <term><literal>open FILE, "file.txt"</literal></term>
7562 <para><varname>FILE</varname> ist global</para>
7567 <term><literal>$_</literal></term>
7570 <para>speziell</para>
7575 <para>Im Gegensatz zu <productname>PHP</productname> gibt es kein
7576 Schlüsselwort wie "<function>global</function>", mit dem man
7577 importieren kann. <function>my</function>, <function>our</function>
7578 und <function>local</function> machen was anderes.</para>
7582 <term><literal>my $form</literal></term>
7585 <para>lexikalische Variable, gültig bis zum Ende des
7591 <term><literal>our $form</literal></term>
7594 <para><varname>$form</varname> referenziert ab hier
7595 <varname>$PACKAGE::form</varname>.</para>
7600 <term><literal>local $form</literal></term>
7603 <para>Alle Änderungen an <varname>$form</varname> werden am Ende
7604 des scopes zurückgesetzt</para>
7611 <title>Warum sind globale Variablen ein Problem?</title>
7613 <para>Das erste Problem ist <productname>FCGI</productname>.</para>
7615 <para><productname>SQL-Ledger</productname> hat fast alles im globalen
7616 namespace abgelegt, und erwartet, dass es da auch wiederzufinden ist.
7617 Unter <productname>FCGI</productname> müssen diese Sachen aber wieder
7618 aufgeräumt werden, damit sie nicht in den nächsten Request kommen.
7619 Einige Sachen wiederum sollen nicht gelöscht werden, wie zum Beispiel
7620 Datenbankverbindungen, weil die sehr lange zum Initialisieren
7623 <para>Das zweite Problem ist <function>strict</function>. Unter
7624 <function>strict</function> werden alle Variablen die nicht explizit
7625 mit <function>Package</function>, <function>my</function> oder
7626 <function>our</function> angegeben werden als Tippfehler angemarkert,
7627 dies hat, seit der Einführung, u.a. schon so manche langwierige
7628 Bug-Suche verkürzt. Da globale Variablen aber implizit mit Package
7629 angegeben werden, werden die nicht geprüft, und somit kann sich
7630 schnell ein Tippfehler einschleichen.</para>
7634 <title>Kanonische globale Variablen</title>
7636 <para>Um dieses Problem im Griff zu halten gibt es einige wenige
7637 globale Variablen, die kanonisch sind, d.h. sie haben bestimmte
7638 vorgegebenen Eigenschaften, und alles andere sollte anderweitig
7639 umhergereicht werden.</para>
7641 <para>Diese Variablen sind im Moment die folgenden neun:</para>
7645 <para><varname>$::form</varname></para>
7649 <para><varname>%::myconfig</varname></para>
7653 <para><varname>$::locale</varname></para>
7657 <para><varname>$::lxdebug</varname></para>
7661 <para><varname>$::auth</varname></para>
7665 <para><varname>$::lx_office_conf</varname></para>
7669 <para><varname>$::instance_conf</varname></para>
7673 <para><varname>$::dispatcher</varname></para>
7677 <para><varname>$::request</varname></para>
7681 <para>Damit diese nicht erneut als Müllhalde missbraucht werden, im
7682 Folgenden eine kurze Erläuterung der bestimmten vorgegebenen
7683 Eigenschaften (Konventionen):</para>
7686 <title>$::form</title>
7690 <para>Ist ein Objekt der Klasse
7691 "<classname>Form</classname>"</para>
7695 <para>Wird nach jedem Request gelöscht</para>
7699 <para>Muss auch in Tests und Konsolenscripts vorhanden
7704 <para>Enthält am Anfang eines Requests die Requestparameter vom
7709 <para>Kann zwar intern über Requestgrenzen ein Datenbankhandle
7710 cachen, das wird aber momentan absichtlich zerstört</para>
7714 <para><varname>$::form</varname> wurde unter <productname>SQL
7715 Ledger</productname> als Gottobjekt für alles missbraucht. Sämtliche
7716 alten Funktionen unter SL/ mutieren <varname>$::form</varname>, das
7717 heißt, alles was einem lieb ist (alle Variablen die einem ans Herz
7718 gewachsen sind), sollte man vor einem Aufruf (!) von zum Beispiel
7719 <function>IS->retrieve_customer()</function> in Sicherheit
7722 <para>Z.B. das vom Benutzer eingestellte Zahlenformat, bevor man
7723 Berechnung in einem bestimmten Format durchführt (SL/Form.pm Zeile
7724 3552, Stand version 2.7beta), um dies hinterher wieder auf den
7725 richtigen Wert zu setzen:</para>
7727 <programlisting> my $saved_numberformat = $::myconfig{numberformat};
7728 $::myconfig{numberformat} = $numberformat;
7729 # (...) div Berechnungen
7730 $::myconfig{numberformat} = $saved_numberformat;</programlisting>
7732 <para>Das Objekt der Klasse Form hat leider im Moment noch viele
7733 zentrale Funktionen die vom internen Zustand abhängen, deshalb bitte
7734 nie einfach zerstören oder überschreiben (zumindestens nicht kurz
7735 vor einem Release oder in Absprache über bspw. die devel-Liste ;-).
7736 Es geht ziemlich sicher etwas kaputt.</para>
7738 <para><varname>$::form</varname> ist gleichzeitig der Standard Scope
7739 in den <productname>Template::Toolkit</productname> Templates
7740 außerhalb der Controller: der Ausdruck <function>[% var
7741 %]</function> greift auf <varname>$::form->{var}</varname> zu.
7742 Unter Controllern ist der Standard Scope anders, da lautet der
7743 Zugriff <function>[% FORM.var %]</function>. In Druckvorlagen sind
7744 normale Variablen ebenfall im <varname>$::form</varname> Scope, d.h.
7745 <function><%var%></function> zeigt auf
7746 <varname>$::form->{var}</varname>. Nochmal von der anderen Seite
7747 erläutert, innerhalb von (Web-)Templates sieht man häufiger solche
7750 <programlisting>[%- IF business %]
7751 # (... Zeig die Auswahlliste Kunden-/Lieferantentyp an)
7752 [%- END %]</programlisting>
7754 <para>Entweder wird hier dann $::form->{business} ausgewertet
7755 oder aber der Funktion
7756 <function>$form->parse_html_template</function> wird explizit
7757 noch ein zusätzlicher Hash übergeben, der dann auch in den
7758 (Web-)Templates zu Verfügung steht, bspw. so:</para>
7760 <programlisting>$form->parse_html_template("is/form_header", \%TMPL_VAR);</programlisting>
7762 <para>Innerhalb von Schleifen wird
7763 <varname>$::form->{TEMPLATE_ARRAYS}{var}[$index]</varname>
7764 bevorzugt, wenn vorhanden. Ein Beispiel findet sich in SL/DO.pm,
7765 welches über alle Positionen eines Lieferscheins in Schleife
7768 <programlisting>for $i (1 .. $form->{rowcount}) {
7770 push @{ $form->{TEMPLATE_ARRAYS}{runningnumber} }, $position;
7771 push @{ $form->{TEMPLATE_ARRAYS}{number} }, $form->{"partnumber_$i"};
7772 push @{ $form->{TEMPLATE_ARRAYS}{description} }, $form->{"description_$i"};
7778 <title>%::myconfig</title>
7782 <para>Das einzige Hash unter den globalen Variablen</para>
7786 <para>Wird spätestens benötigt wenn auf die Datenbank
7787 zugegriffen wird</para>
7791 <para>Wird bei jedem Request neu erstellt.</para>
7795 <para>Enthält die Userdaten des aktuellen Logins</para>
7799 <para>Sollte nicht ohne Filterung irgendwo gedumpt werden oder
7800 extern serialisiert werden, weil da auch der Datenbankzugriff
7801 für diesen user drinsteht.</para>
7805 <para>Enthält unter anderem Datumsformat dateformat und
7806 Nummernformat numberformat</para>
7810 <para>Enthält Datenbankzugriffinformationen</para>
7814 <para><varname>%::myconfig</varname> ist im Moment der Ersatz für
7815 ein Userobjekt. Die meisten Funktionen, die etwas anhand des
7816 aktuellen Users entscheiden müssen, befragen
7817 <varname>%::myconfig</varname>. Innerhalb der Anwendungen sind dies
7818 überwiegend die Daten, die sich unter <guimenu>Programm</guimenu>
7819 -> <guimenuitem>Einstellungen</guimenuitem> befinden, bzw. die
7820 Informationen über den Benutzer die über die
7821 Administrator-Schnittstelle eingegeben wurden.</para>
7825 <title>$::locale</title>
7829 <para>Objekt der Klasse "Locale"</para>
7833 <para>Wird pro Request erstellt</para>
7837 <para>Muss auch für Tests und Scripte immer verfügbar
7842 <para>Cached intern über Requestgrenzen hinweg benutzte
7847 <para>Lokalisierung für den aktuellen User. Alle Übersetzungen,
7848 Zahlen- und Datumsformatierungen laufen über dieses Objekt.</para>
7852 <title>$::lxdebug</title>
7856 <para>Objekt der Klasse "LXDebug"</para>
7860 <para>Wird global gecached</para>
7864 <para>Muss immer verfügbar sein, in nahezu allen
7869 <para><varname>$::lxdebug</varname> stellt Debuggingfunktionen
7870 bereit, wie "<function>enter_sub</function>" und
7871 "<function>leave_sub</function>", mit denen in den alten Modulen ein
7872 brauchbares Tracing gebaut ist, "<function>log_time</function>", mit
7873 der man die Wallclockzeit seit Requeststart loggen kann, sowie
7874 "<function>message</function>" und "<function>dump</function>" mit
7875 denen man flott Informationen ins Log (tmp/kivitendo-debug.log)
7878 <para>Beispielsweise so:</para>
7880 <programlisting>$main::lxdebug->message(0, 'Meine Konfig:' . Dumper (%::myconfig));
7881 $main::lxdebug->message(0, 'Wer bin ich? Kunde oder Lieferant:' . $form->{vc});</programlisting>
7885 <title>$::auth</title>
7889 <para>Objekt der Klasse "SL::Auth"</para>
7893 <para>Wird global gecached</para>
7897 <para>Hat eine permanente DB Verbindung zur Authdatenbank</para>
7901 <para>Wird nach jedem Request resettet.</para>
7905 <para><varname>$::auth</varname> stellt Funktionen bereit um die
7906 Rechte des aktuellen Users abzufragen. Obwohl diese Informationen
7907 vom aktuellen User abhängen wird das Objekt aus
7908 Geschwindigkeitsgründen nur einmal angelegt und dann nach jedem
7909 Request kurz resettet.</para>
7911 <para>Dieses Objekt kapselt auch den gerade aktiven Mandanten.
7912 Dessen Einstellungen können über
7913 <literal>$::auth->client</literal> abgefragt werden; Rückgabewert
7914 ist ein Hash mit den Werten aus der Tabelle
7915 <literal>auth.clients</literal>.</para>
7919 <title>$::lx_office_conf</title>
7923 <para>Objekt der Klasse
7924 "<classname>SL::LxOfficeConf</classname>"</para>
7928 <para>Global gecached</para>
7932 <para>Repräsentation der
7933 <filename>config/kivitendo.conf[.default]</filename>-Dateien</para>
7937 <para>Globale Konfiguration. Configdateien werden zum Start gelesen
7938 und danach nicht mehr angefasst. Es ist derzeit nicht geplant, dass
7939 das Programm die Konfiguration ändern kann oder sollte.</para>
7941 <para>Beispielsweise ist über den Konfigurationseintrag [debug] die
7942 Debug- und Trace-Log-Datei wie folgt konfiguriert und
7945 <programlisting>[debug]
7946 file_name = /tmp/kivitendo-debug.log</programlisting>
7948 <para>ist der Key <varname>file</varname> im Programm als
7949 <varname>$::lx_office_conf->{debug}{file}</varname>
7953 <para>Zugriff auf die Konfiguration erfolgt im Moment über
7954 Hashkeys, sind also nicht gegen Tippfehler abgesichert.</para>
7959 <title>$::instance_conf</title>
7963 <para>Objekt der Klasse
7964 "<classname>SL::InstanceConfiguration</classname>"</para>
7968 <para>wird pro Request neu erstellt</para>
7972 <para>Funktioniert wie <varname>$::lx_office_conf</varname>,
7973 speichert aber Daten die von der Instanz abhängig sind. Eine Instanz
7974 ist hier eine Mandantendatenbank. Beispielsweise überprüft
7975 <programlisting>$::instance_conf->get_inventory_system eq 'perpetual'</programlisting>
7976 ob die berüchtigte Bestandsmethode zur Anwendung kommt.</para>
7980 <title>$::dispatcher</title>
7984 <para>Objekt der Klasse
7985 "<varname>SL::Dispatcher</varname>"</para>
7989 <para>wird pro Serverprozess erstellt.</para>
7993 <para>enthält Informationen über die technische Verbindung zum
7998 <para>Der dritte Punkt ist auch der einzige Grund warum das Objekt
7999 global gespeichert wird. Wird vermutlich irgendwann in einem anderen
8000 Objekt untergebracht.</para>
8004 <title>$::request</title>
8008 <para>Hashref (evtl später Objekt)</para>
8012 <para>Wird pro Request neu initialisiert.</para>
8016 <para>Keine Unterstruktur garantiert.</para>
8020 <para><varname>$::request</varname> ist ein generischer Platz um
8021 Daten "für den aktuellen Request" abzulegen. Sollte nicht für action
8022 at a distance benutzt werden, sondern um lokales memoizing zu
8023 ermöglichen, das garantiert am Ende des Requests zerstört
8026 <para>Vieles von dem, was im moment in <varname>$::form</varname>
8027 liegt, sollte eigentlich hier liegen. Die groben
8028 Differentialkriterien sind:</para>
8032 <para>Kommt es vom User, und soll unverändert wieder an den
8033 User? Dann <varname>$::form</varname>, steht da eh schon</para>
8037 <para>Sind es Daten aus der Datenbank, die nur bis zum Ende des
8038 Requests gebraucht werden? Dann
8039 <varname>$::request</varname></para>
8043 <para>Muss ich von anderen Teilen des Programms lesend drauf
8044 zugreifen? Dann <varname>$::request</varname>, aber Zugriff über
8045 Wrappermethode</para>
8052 <title>Ehemalige globale Variablen</title>
8054 <para>Die folgenden Variablen waren einmal im Programm, und wurden
8058 <title>$::cgi</title>
8062 <para>war nötig, weil cookie Methoden nicht als
8063 Klassenfunktionen funktionieren</para>
8067 <para>Aufruf als Klasse erzeugt Dummyobjekt was im
8068 Klassennamespace gehalten wird und über Requestgrenzen
8073 <para>liegt jetzt unter
8074 <varname>$::request->{cgi}</varname></para>
8080 <title>$::all_units</title>
8084 <para>war nötig, weil einige Funktionen in Schleifen zum Teil
8085 ein paar hundert mal pro Request eine Liste der Einheiten
8086 brauchen, und de als Parameter durch einen Riesenstack von
8087 Funktionen geschleift werden müssten.</para>
8091 <para>Liegt jetzt unter
8092 <varname>$::request->{cache}{all_units}</varname></para>
8097 <function>AM->retrieve_all_units()</function> gesetzt oder
8104 <title>%::called_subs</title>
8108 <para>wurde benutzt um callsub deep recursions
8113 <para>Wurde entfernt, weil callsub nur einen Bruchteil der
8114 möglichen Rekursioenen darstellt, und da nie welche
8119 <para>komplette recursion protection wurde entfernt.</para>
8126 <sect1 id="devel.fcgi">
8127 <title>Entwicklung unter FastCGI</title>
8129 <sect2 id="devel.fcgi.general">
8130 <title>Allgemeines</title>
8132 <para>Wenn Änderungen in der Konfiguration von kivitendo gemacht
8133 werden, muss der Webserver neu gestartet werden.</para>
8135 <para>Bei der Entwicklung für FastCGI ist auf ein paar Fallstricke zu
8136 achten. Dadurch, dass das Programm in einer Endlosschleife läuft,
8137 müssen folgende Aspekte beachtet werden.</para>
8140 <sect2 id="devel.fcgi.exiting">
8141 <title>Programmende und Ausnahmen</title>
8143 <para>Betrifft die Funktionen <function>warn</function>,
8144 <function>die</function>, <function>exit</function>,
8145 <function>carp</function> und <function>confess</function>.</para>
8147 <para>Fehler, die dass Programm normalerweise sofort beenden (fatale
8148 Fehler), werden mit dem FastCGI Dispatcher abgefangen, um das Programm
8149 am Laufen zu halten. Man kann mit <function>die</function>,
8150 <function>confess</function> oder <function>carp</function> Fehler
8151 ausgeben, die dann vom Dispatcher angezeigt werden. Die kivitendo
8152 eigene <function>$::form-</function>error()> tut im Prinzip das
8153 Gleiche, mit ein paar Extraoptionen. <function>warn</function> und
8154 <function>exit</function> hingegen werden nicht abgefangen.
8155 <function>warn</function> wird direkt nach STDERR, also in Server Log
8156 eine Nachricht schreiben (sofern in der Konfiguration nicht die
8157 Warnungen in das kivitendo Log umgeleitet wurden), und
8158 <function>exit</function> wird die Ausführung beenden.</para>
8160 <para>Prinzipiell ist es kein Beinbruch, wenn sich der Prozess
8161 beendet, fcgi wird ihn sofort neu starten. Allerdings sollte das die
8162 Ausnahme sein. Quintessenz: Bitte kein <function>exit</function>
8163 benutzen, alle anderen Exceptionmechanismen sind ok.</para>
8166 <sect2 id="devel.fcgi.globals">
8167 <title>Globale Variablen</title>
8169 <para>Um zu vermeiden, dass Informationen von einem Request in einen
8170 anderen gelangen, müssen alle globalen Variablen vor einem Request
8171 sauber initialisiert werden. Das ist besonders wichtig im
8172 <varname>$::cgi</varname> und <varname>$::auth</varname> Objekt, weil
8173 diese nicht gelöscht werden pro Instanz, sondern persistent gehalten
8176 <para>In <classname>SL::Dispatcher</classname> gibt es einen sauber
8177 abgetrennten Block, der alle kanonischen globalen Variablen listet und
8178 erklärt. Bitte keine anderen einführen ohne das sauber zu
8179 dokumentieren.</para>
8181 <para>Datenbankverbindungen wird noch ein Guide verfasst werden, wie
8182 man sicher geht, dass man die richtige erwischt.</para>
8185 <sect2 id="devel.fcgi.performance">
8186 <title>Performance und Statistiken</title>
8188 <para>Die kritischen Pfade des Programms sind die Belegmasken, und
8189 unter diesen ganz besonders die Verkaufsrechnungsmaske. Ein Aufruf der
8190 Rechnungsmaske in kivitendo 2.4.3 stable dauert auf einem Core2duo mit
8191 4GB Arbeitsspeicher und Ubuntu 9.10 eine halbe Sekunde. In der 2.6.0
8192 sind es je nach Menge der definierten Variablen 1-2s. Ab der
8193 Moose/Rose::DB Version sind es 5-6s.</para>
8195 <para>Mit FastCGI ist die neuste Version auf 0,26 Sekunden selbst in
8196 den kritischen Pfaden, unter 0,15 sonst.</para>
8200 <sect1 id="dev-programmatic-api-calls" xreflabel="Programmatische API-Aufrufe">
8201 <title>Programmatische API-Aufrufe</title>
8203 <sect2 id="dev-programmatic-api-calls.introduction" xreflabel="Einführung in programmatische API-Aufrufe">
8204 <title>Einführung</title>
8207 Es ist möglich, Funktionen in kivitendo programmatisch aus anderen Programmen aufzurufen. Dazu ist nötig, dass
8208 Authentifizierungsinformationen in jedem Aufruf mitgegeben werden. Dafür gibt es zwei Methoden: die HTTP-»Basic«-Authentifizierung
8209 oder die Übergabe als spziell benannte GET-Parameter. Neben den Authentifizierungsinformationen muss auch der zu verwendende Mandant
8214 <sect2 id="dev-programmatic-api-calls.client_selection" xreflabel="Mandantenauswahl bei programmatischen API-Aufrufen">
8215 <title>Wahl des Mandanten</title>
8218 Der zu verwendende Mandant kann als Parameter <varname>{AUTH}client_id</varname> mit jedem Request mitgeschickt werden. Der Wert
8219 muss dabei die Datenbank-ID des Mandanten sein. kivitendo prüft, ob der Account, der über die Authentifizierungsinformationen
8220 übergeben wurde, Zugriff auf den angegebenen Mandanten hat.
8224 Wird in einem Request kein Mandant mitgegeben, so wird derjenige Mandant genommen, wer als Standardmandant markiert wurde. Gibt es
8225 keinen solchen, kommt es zu einer Fehlermeldung.
8229 <sect2 id="dev-programmatic-api-calls.http_basic_authentication" xreflabel="Programmatische API-Aufrufe mit HTTP-»Basic« authentifizieren">
8230 <title>HTTP-»Basic«-Authentifizierung</title>
8233 Für diese Methode muss jedem Request der bekannte HTTP-Header <constant>Authorization</constant> mitgeschickt werden (siehe <ulink
8234 url="https://tools.ietf.org/html/rfc7617">RFC 7617</ulink>). Unterstützt wird ausschließlich die »Basic«-Methode. Loginname und
8235 Passwort werden bei dieser Methode durch einen Doppelpunkt getrennt und Base64-encodiert im genannten HTTP-Header übertragen.
8239 Diese Informationen müssen einen vorhandenen Account benennen. kivitendo prüft genau wie bei Benutzung über den Webbrowser, ob
8240 dieser Account Zugriff auf den Mandanten sowie auf die angeforderte Funktion hat.
8244 Da die Logininformationen im Klartext im Request stehen, sollte der Zugriff auf kivitendo ausschließlich über HTTPS verschlüsselt
8249 <sect2 id="dev-programmatic-api-calls.authentication_via_parameters" xreflabel="Programmatische API-Aufrufe mit Parametern authentifizieren">
8250 <title>Authentifizierung mit Parametern</title>
8253 Für diese Methode müssen jedem Request zwei Parameter mitgegeben werden: <varname>{AUTH}login</varname> und
8254 <varname>{AUTH}password</varname>. Diese Informationen müssen einen vorhandenen Account benennen. kivitendo prüft genau wie bei
8255 Benutzung über den Webbrowser, ob dieser Account Zugriff auf den Mandanten sowie auf die angeforderte Funktion hat.
8259 Da die Logininformationen im Klartext im Request stehen, sollte der Zugriff auf kivitendo ausschließlich über HTTPS verschlüsselt
8265 Die Verwendung dieser Methode ist veraltet. Statt dessen sollte die oben erwähnte HTTP-»Basic«-Authentifizierung verwendet werden.
8270 <sect2 id="dev-programmatic-api-calls.examples">
8271 <title>Beispiele</title>
8274 Das folgende Beispiel nutzt das Kommandozeilenprogramm »curl« und ruft die Funktion auf, die eine vorhandene Telefonnummer in den
8275 Ansprechpersonen sucht und dazu Informationen zurückliefert. Dabei wird die HTTP-»Basic«-Authentifizierung genutzt.
8278 <programlisting>$ curl --silent --user 'jdoe:SecretPassword!' \
8279 'https://…/controller.pl?action=PhoneNumber/look_up&number=053147110815'</programlisting>
8283 <sect1 id="db-upgrade-files" xreflabel="Datenbank-Upgradedateien">
8284 <title>SQL-Upgradedateien</title>
8286 <sect2 id="db-upgrade-files.introduction"
8287 xreflabel="Einführung in die Datenbank-Upgradedateien">
8288 <title>Einführung</title>
8290 <para>Datenbankupgrades werden über einzelne Upgrade-Scripte
8291 gesteuert, die sich im Verzeichnis
8292 <filename>sql/Pg-upgrade2</filename> befinden. In diesem Verzeichnis
8293 muss pro Datenbankupgrade eine Datei existieren, die neben den
8294 eigentlich auszuführenden SQL- oder Perl-Befehlen einige
8295 Kontrollinformationen enthält.</para>
8297 <para>Kontrollinformationen definieren Abhängigkeiten und Prioritäten,
8298 sodass Datenbankscripte zwar in einer sicheren Reihenfolge ausgeführt
8299 werden (z.B. darf ein <literal>ALTER TABLE</literal> erst ausgeführt
8300 werden, wenn die Tabelle mit <literal>CREATE TABLE</literal> angelegt
8301 wurde), diese Reihenfolge aber so flexibel ist, dass man keine
8302 Versionsnummern braucht.</para>
8304 <para>kivitendo merkt sich dabei, welches der Upgradescripte in
8305 <filename>sql/Pg-upgrade2</filename> bereits durchgeführt wurde und
8306 führt diese nicht erneut aus. Dazu dient die Tabelle
8307 "<literal>schema_info</literal>", die bei der Anmeldung automatisch
8308 angelegt wird.</para>
8311 <sect2 id="db-upgrade-files.format"
8312 xreflabel="Format der Upgradedateien">
8313 <title>Format der Kontrollinformationen</title>
8315 <para>Die Kontrollinformationen sollten sich am Anfang der jeweiligen
8316 Upgradedatei befinden. Jede Zeile, die Kontrollinformationen enthält,
8317 hat dabei das folgende Format:</para>
8319 <para>Für SQL-Upgradedateien:</para>
8321 <programlisting>-- @key: value</programlisting>
8323 <para>Für Perl-Upgradedateien:</para>
8325 <programlisting># @key: value</programlisting>
8327 <para>Leerzeichen vor "<varname>value</varname>" werden
8330 <para>Die folgenden Schlüsselworte werden verarbeitet:</para>
8334 <term><varname>tag</varname></term>
8337 <para>Wird zwingend benötigt. Dies ist der "Name" des Upgrades.
8338 Dieser "tag" kann von anderen Kontrolldateien in ihren
8339 Abhängigkeiten verwendet werden (Schlüsselwort
8340 "<varname>depends</varname>"). Der "tag" ist auch der Name, der
8341 in der Datenbank eingetragen wird.</para>
8343 <para>Normalerweise sollte die Kontrolldatei genau so heißen wie
8344 der "tag", nur mit der Endung ".sql" bzw. "pl".</para>
8346 <para>Ein Tag darf nur aus alphanumerischen Zeichen sowie den
8347 Zeichen _ - ( ) bestehen. Insbesondere sind Leerzeichen nicht
8348 erlaubt und sollten stattdessen mit Unterstrichen ersetzt
8354 <term><varname>charset</varname></term>
8357 <para>Empfohlen. Gibt den Zeichensatz an, in dem das Script
8358 geschrieben wurde, z.B. "<literal>UTF-8</literal>". Aus
8359 Kompatibilitätsgründen mit alten Upgrade-Scripten wird bei
8360 Abwesenheit des Tags für SQL-Upgradedateien der Zeichensatz
8361 "<literal>ISO-8859-15</literal>" angenommen. Perl-Upgradescripte
8362 hingegen müssen immer in UTF-8 encodiert sein und sollten
8363 demnach auch ein "<literal>use utf8;</literal>"
8369 <term><varname>description</varname></term>
8372 <para>Benötigt. Eine Beschreibung, was in diesem Update
8373 passiert. Diese wird dem Benutzer beim eigentlichen
8374 Datenbankupdate angezeigt. Während der Tag in Englisch gehalten
8375 sein sollte, sollte die Beschreibung auf Deutsch
8381 <term><varname>depends</varname></term>
8384 <para>Optional. Eine mit Leerzeichen getrennte Liste von "tags",
8385 von denen dieses Upgradescript abhängt. kivitendo stellt sicher,
8386 dass die in dieser Liste aufgeführten Scripte bereits
8387 durchgeführt wurden, bevor dieses Script ausgeführt wird.</para>
8389 <para>Abhängigkeiten werden rekursiv betrachtet. Wenn also ein
8390 Script "b" existiert, das von Änderungen in "a" abhängt, und
8391 eine neue Kontrolldatei für "c" erstellt wird, die von
8392 Änderungen in "a" und "b" abhängt, so genügt es, in "c" nur den
8393 Tag "b" als Abhängigkeit zu definieren.</para>
8395 <para>Es ist nicht erlaubt, sich selbst referenzierende
8396 Abhängigkeiten zu definieren (z.B. "a" -> "b", "b" -> "c"
8397 und "c" -> "a").</para>
8402 <term><varname>priority</varname></term>
8405 <para>Optional. Ein Zahlenwert, der die Reihenfolge bestimmt, in
8406 der Scripte ausgeführt werden, die die gleichen
8407 Abhängigkeitstiefen besitzen. Fehlt dieser Parameter, so wird
8408 der Wert 1000 benutzt.</para>
8410 <para>Dies ist reine Kosmetik. Für echte Reihenfolgen muss
8411 "depends" benutzt werden. kivitendo sortiert die auszuführenden
8412 Scripte zuerst nach der Abhängigkeitstiefe (wenn "z" von "y"
8413 abhängt und "y" von "x", so hat "z" eine Abhängigkeitstiefe von
8414 2, "y" von 1 und "x" von 0. "x" würde hier zuerst ausgeführt,
8415 dann "y", dann "z"), dann nach der Priorität und bei gleicher
8416 Priorität alphabetisch nach dem "tag".</para>
8421 <term><varname>ignore</varname></term>
8424 <para>Optional. Falls der Wert auf 1 (true) steht, wird das
8425 Skript bei der Anmeldung ignoriert und entsprechend nicht
8432 <sect2 id="db-upgrade-files.format-perl-files"
8433 xreflabel="Format von Perl-Upgradedateien">
8434 <title>Format von in Perl geschriebenen
8435 Datenbankupgradescripten</title>
8437 <para>In Perl geschriebene Datenbankscripte werden nicht einfach so
8438 ausgeführt sondern müssen sich an gewisse Konventionen halten. Dafür
8439 bekommen sie aber auch einige Komfortfunktionen bereitgestellt.</para>
8441 <para>Ein Upgradescript stellt dabei eine vollständige Objektklasse
8442 dar, die vom Elternobjekt "<literal>SL::DBUpgrade2::Base</literal>"
8443 erben und eine Funktion namens "<literal>run</literal>" zur Verfügung
8444 stellen muss. Das Script wird ausgeführt, indem eine Instanz dieser
8445 Klasse erzeugt und darauf die erwähnte "<literal>run</literal>"
8446 aufgerufen wird.</para>
8448 <para>Zu beachten ist, dass sich der Paketname der Datei aus dem Wert
8449 für "<literal>@tag</literal>" ableitet. Dabei werden alle Zeichen, die
8450 in Paketnamen ungültig wären (gerade Bindestriche), durch Unterstriche
8451 ersetzt. Insgesamt sieht der Paketname wie folgt aus:
8452 "<literal>SL::DBUpgrade2::tag</literal>".</para>
8454 <para>Welche Komfortfunktionen zur Verfügung stehen, erfahren Sie in
8455 der Perl-Dokumentation zum oben genannten Modul; aufzurufen mit
8456 "<command>perldoc SL/DBUpgrade2/Base.pm</command>".</para>
8458 <para>Ein Mindestgerüst eines gültigen Perl-Upgradescriptes sieht wie
8461 <programlisting># @tag: beispiel-upgrade-file42
8462 # @description: Ein schönes Beispielscript
8463 # @depends: release_3_1_0
8464 package SL::DBUpgrade2::beispiel_upgrade_file42;
8469 use parent qw(SL::DBUpgrade2::Base);
8474 # hier Aktionen ausführen
8483 <sect2 id="db-upgrade-files.dbupgrade-tool"
8484 xreflabel="Hilfsscript dbupgrade2_tool.pl">
8485 <title>Hilfsscript dbupgrade2_tool.pl</title>
8487 <para>Um die Arbeit mit den Abhängigkeiten etwas zu erleichtern,
8488 existiert ein Hilfsscript namens
8489 "<filename>scripts/dbupgrade2_tool.pl</filename>". Es muss aus dem
8490 kivitendo-ERP-Basisverzeichnis heraus aufgerufen werden. Dieses Tool
8491 liest alle Datenbankupgradescripte aus dem Verzeichnis
8492 <filename>sql/Pg-upgrade2</filename> aus. Es benutzt dafür die
8493 gleichen Methoden wie kivitendo selber, sodass alle Fehlersituationen
8494 von der Kommandozeile überprüft werden können.</para>
8496 <para>Wird dem Script kein weiterer Parameter übergeben, so wird nur
8497 eine Überprüfung der Felder und Abhängigkeiten vorgenommen. Man kann
8498 sich aber auch Informationen auf verschiedene Art ausgeben
8503 <para>Listenform: "<command>./scripts/dbupgrade2_tool.pl
8504 --list</command>"</para>
8506 <para>Gibt eine Liste aller Scripte aus. Die Liste ist in der
8507 Reihenfolge sortiert, in der kivitendo die Scripte ausführen
8508 würde. Es werden neben der Listenposition der Tag, die
8509 Abhängigkeitstiefe und die Priorität ausgegeben.</para>
8513 <para>Baumform: "<command>./scripts/dbupgrade2_tool.pl
8514 --tree</command>"</para>
8516 <para>Listet alle Tags in Baumform basierend auf den
8517 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte, von
8518 denen keine anderen abhängen. Die Unterknoten sind Scripte, die
8519 beim übergeordneten Script als Abhängigkeit eingetragen
8523 <listitem id="db-upgrade-files.dbupgrade-tool.reverse-tree">
8524 <para>Umgekehrte Baumform: "<command>./scripts/dbupgrade2_tool.pl
8525 --rtree</command>"</para>
8527 <para>Listet alle Tags in Baumform basierend auf den
8528 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte mit
8529 der geringsten Abhängigkeitstiefe. Die Unterknoten sind Scripte,
8530 die das übergeordnete Script als Abhängigkeit eingetragen
8535 <para>Baumform mit Postscriptausgabe:
8536 "<command>./scripts/dbupgrade2_tool.pl
8537 --graphviz</command>"</para>
8539 <para>Benötigt das Tool "<command>graphviz</command>", um mit
8540 seiner Hilfe die <link
8541 linkend="db-upgrade-files.dbupgrade-tool.reverse-tree">umgekehrte
8542 Baumform</link> in eine Postscriptdatei namens
8543 "<filename>db_dependencies.ps</filename>" auszugeben. Dies ist
8544 vermutlich die übersichtlichste Form, weil hierbei jeder Knoten
8545 nur einmal ausgegeben wird. Bei den Textmodusbaumformen hingegen
8546 können Knoten und all ihre Abhängigkeiten mehrfach ausgegeben
8551 <para>Scripte, von denen kein anderes Script abhängt:
8552 "<command>./scripts/dbupgrade2_tool.pl --nodeps</command>"</para>
8554 <para>Listet die Tags aller Scripte auf, von denen keine anderen
8555 Scripte abhängen.</para>
8561 <sect1 id="translations-languages" xreflabel="Translations and languages">
8562 <title>Translations and languages</title>
8564 <sect2 id="translations-languages.introduction"
8565 xreflabel="Introduction to translations and languages">
8566 <title>Introduction</title>
8569 <para>Dieser Abschnitt ist in Englisch geschrieben, um
8570 internationalen Übersetzern die Arbeit zu erleichtern.</para>
8573 <para>This section describes how localization packages in kivitendo
8574 are built. Currently the only language fully supported is German, and
8575 since most of the internal messages are held in English the English
8576 version is usable too.</para>
8579 <sect2 id="translations-languages.character-set"
8580 xreflabel="Character set">
8581 <title>Character set</title>
8583 <para>All files included in a language pack must use UTF-8 as their
8587 <sect2 id="translations-languages.file-structure"
8588 xreflabel="File structure">
8589 <title>File structure</title>
8591 <para>The structure of locales in kivitendo is:</para>
8593 <programlisting>kivitendo/locale/<langcode>/</programlisting>
8595 <para>where <langcode> stands for an abbreviation of the
8596 language package. The builtin packages use two letter <ulink
8597 url="http://en.wikipedia.org/wiki/ISO_639-1">ISO 639-1</ulink> codes,
8598 but the actual name is not relevant for the program and can easily be
8600 url="http://en.wikipedia.org/wiki/IETF_language_tag">IETF language
8601 tags</ulink> (i.e. "en_GB"). In fact the original language packages
8602 from SQL Ledger are named in this way.</para>
8604 <para>In such a language directory the following files are
8609 <term>LANGUAGE</term>
8612 <para>This file is mandatory.</para>
8614 <para>The <filename>LANGUAGE</filename> file contains the self
8615 descripted name of the language. It should contain a native
8616 representation first, and in parenthesis an english translation
8617 after that. Example:</para>
8619 <programlisting>Deutsch (German)</programlisting>
8627 <para>This file is mandatory.</para>
8629 <para>The central translation file. It is essentially an inline
8630 Perl script autogenerated by <command>locales.pl</command>. To
8631 generate it, generate the directory and the two files mentioned
8632 above, and execute the following command:</para>
8634 <programlisting>scripts/locales.pl <langcode></programlisting>
8636 <para>Otherwise you can simply copy one of the other languages.
8637 You will be told how many are missing like this:</para>
8639 <programlisting>$ scripts/locales.pl en
8640 English - 0.6% - 2015/2028 missing</programlisting>
8642 <para>A file named "<filename>missing</filename>" will be
8643 generated and can be edited. You can also edit the
8644 "<filename>all</filename>" file directly. Edit everything you
8645 like to fit the target language and execute
8646 <command>locales.pl</command> again. See how the missing words
8652 <term>Num2text</term>
8655 <para>Legacy code from SQL Ledger. It provides a means for
8656 numbers to be converted into natural language, like
8657 <literal>1523 => one thousand five hundred twenty
8658 three</literal>. If you want to provide it, it must be inlinable
8659 Perl code which provides a <function>num2text</function> sub. If
8660 an <function>init</function> sub exists it will be executed
8663 <para>Only used in the check and receipt printing module.</para>
8668 <term>special_chars</term>
8671 <para>kivitendo comes with a lot of interfaces to different
8672 formats, some of which are rather picky with their accepted
8673 charset. The <filename>special_chars</filename> file contains a
8674 listing of chars not suited for different file format and
8675 provides substitutions. It is written in "Simple Ini" style,
8676 containing a block for every file format.</para>
8678 <para>First entry should be the order of substitution for
8679 entries as a whitespace separated list. All entries are
8680 interpolated, so <literal>\n</literal>, <literal>\x20</literal>
8681 and <literal>\\</literal> all work.</para>
8683 <para>After that every entry is a special char that should be
8684 translated when writing text into such a file.</para>
8686 <para>Example:</para>
8688 <programlisting>[Template/XML]
8689 order=& < > \n
8693 \n=<br></programlisting>
8695 <para>Note the importance of the order in this example.
8696 Substituting < and > befor & would lead to $gt; become
8699 <para>For a list of valid formats, see the German
8700 <filename>special_chars</filename> entry. As of this writing the
8701 following are recognized:</para>
8703 <programlisting>HTML
8708 Template/OpenDocument
8709 filenames</programlisting>
8711 <para>The last of which is very machine dependent. Remember that
8712 a lot of characters are forbidden by some filesystems, for
8713 example MS Windows doesn't like ':' in its files where Linux
8714 doesn't mind that. If you want the files created with your
8715 language pack to be portable, find all chars that could cause
8721 <term>missing</term>
8724 <para>This file is not a part of the language package
8727 <para>This is a file generated by
8728 <command>scripts/locales.pl</command> while processing your
8729 locales. It's only to have the missing entries singled out and
8730 does not belong to a language package.</para>
8738 <para>This file is not a part of the language package
8741 <para>Another file generated by
8742 <command>scripts/locales.pl</command>. If for any reason a
8743 translation does not appear anymore and can be deleted, it gets
8744 moved here. The last 50 or so entries deleted are saved here in
8745 case you made a typo, so that you don't have to translate
8746 everything again. If a tranlsation is missing, the lost file is
8747 checked first. If you maintain a language package, you might
8748 want to keep this safe somewhere.</para>
8753 <term>more/all</term>
8756 <para>This subdir and file is not a part of the language package
8759 <para>If the directory more exists and contains a file called
8760 all it will be parsed in addition to the mandatory all (see
8761 above). The file is useful if you want to change some
8762 translations for the current installation without conflicting
8763 further upgrades. The file is not autogenerated and has the same
8764 format as the all, but needs another key (more_texts). See the
8765 german translation for an example or copy the following code:
8768 # -*- coding: utf-8; -*-
8773 # These are additional texts for custom translations.
8774 # The format is the same as for the normal file all, only
8775 # with another key (more_texts instead of texts).
8776 # The file has the form of 'english text' => 'foreign text',
8778 $self->{more_texts} = {
8780 'Ship via' => 'Terms of delivery',
8781 'Shipping Point' => 'Delivery time',
8783 </programlisting></para>
8790 <sect1 id="devel.testsuite">
8791 <title>Die kivitendo-Test-Suite</title>
8793 <sect2 id="devel.testsuite.intro">
8794 <title>Einführung</title>
8796 <para>kivitendo enthält eine Suite für automatisierte Tests. Sie
8797 basiert auf dem Standard-Perl-Modul
8798 <literal>Test::More</literal>.</para>
8800 <para>Die grundlegenden Fakten sind:</para>
8804 <para>Alle Tests liegen im Unterverzeichnis
8805 <filename>t/</filename>.</para>
8809 <para>Ein Script (bzw. ein Test) in <filename>t/</filename>
8810 enthält einen oder mehrere Testfälle.</para>
8814 <para>Alle Dateinamen von Tests enden auf <literal>.t</literal>.
8815 Es sind selbstständig ausführbare Perl-Scripte.</para>
8819 <para>Die Test-Suite besteht aus der Gesamtheit aller Tests,
8820 sprich aller Scripte in <filename>t/</filename>, deren Dateiname
8821 auf <literal>.t</literal> endet.</para>
8826 <sect2 id="devel.testsuite.prerequisites">
8827 <title>Voraussetzungen</title>
8829 <para>Für die Ausführung werden neben den für kivitendo eh schon
8830 benötigten Module noch weitere Perl-Module benötigt. Diese
8835 <para><literal>Test::Deep</literal> (Debian-Paketname:
8836 <literal>libtest-deep-perl</literal>; Fedora:
8837 <literal>perl-Test-Deep</literal>; openSUSE:
8838 <literal>perl-Test-Deep</literal>)</para>
8842 <para><literal>Test::Exception</literal> (Debian-Paketname:
8843 <literal>libtest-exception-perl</literal>; Fedora:
8844 <literal>perl-Test-Exception</literal>; openSUSE:
8845 <literal>perl-Test-Exception</literal>)</para>
8849 <para><literal>Test::Output</literal> (Debian-Paketname:
8850 <literal>libtest-output-perl</literal>; Fedora:
8851 <literal>perl-Test-Output</literal>; openSUSE:
8852 <literal>perl-Test-Output</literal>)</para>
8856 <para><literal>Test::Harness</literal> 3.0.0 oder höher. Dieses
8857 Modul ist ab Perl 5.10.1 Bestandteil der Perl-Distribution und
8858 kann für frühere Versionen aus dem <ulink
8859 url="http://www.cpan.org">CPAN</ulink> bezogen werden.</para>
8863 <para><literal>LWP::Simple</literal> aus dem Paket
8864 <literal>libwww-perl</literal> (Debian-Panetname:
8865 <literal>libwww-perl</literal>; Fedora:
8866 <literal>perl-libwww-perl</literal>; openSUSE:
8867 <literal>perl-libwww-perl</literal>)</para>
8871 <para><literal>URI::Find</literal> (Debian-Panetname:
8872 <literal>liburi-find-perl</literal>; Fedora:
8873 <literal>perl-URI-Find</literal>; openSUSE:
8874 <literal>perl-URI-Find</literal>)</para>
8878 <para><literal>Sys::CPU</literal> (Debian-Panetname:
8879 <literal>libsys-cpu-perl</literal>; Fedora und openSUSE: nicht
8884 <para><literal>Thread::Pool::Simple</literal> (Debian-Panetname:
8885 <literal>libthread-pool-simple-perl</literal>; Fedora und
8886 openSUSE: nicht vorhanden)</para>
8890 <para>Weitere Voraussetzung ist, dass die Testsuite ihre eigene
8891 Datenbank anlegen kann, um Produktivdaten nicht zu gefährden. Dazu
8892 müssen in der Konfigurationsdatei im Abschnit
8893 <literal>testing/database</literal> Datenbankverbindungsparameter
8894 angegeben werden. Der hier angegebene Benutzer muss weiterhin das
8895 Recht haben, Datenbanken anzulegen und zu löschen.</para>
8897 <para>Der so angegebene Benutzer muss nicht zwingend über
8898 Super-User-Rechte verfügen. Allerdings gibt es einige
8899 Datenbank-Upgrades, die genau diese Rechte benötigen. Für den Fall
8900 kann man in diesem Konfigurationsabschnitt einen weiteren
8901 Benutzeraccount angeben, der dann über Super-User-Rechte verfügt, und
8902 mit dem die betroffenen Upgrades durchgeführt werden. In der
8903 Beispiel-Konfigurationsdatei finden Sie die benötigten
8907 <sect2 id="devel.testsuite.execution">
8908 <title>Existierende Tests ausführen</title>
8910 <para>Es gibt mehrere Möglichkeiten zum Ausführen der Tests: entweder,
8911 man lässt alle Tests auf einmal ausführen, oder man führt gezielt
8912 einzelne Scripte aus. Für beide Fälle gibt es das Helferscript
8913 <filename>t/test.pl</filename>.</para>
8915 <para>Will man die komplette Test-Suite ausführen, so muss man einfach
8916 nur <filename>t/test.pl</filename> ohne weitere Parameter aus dem
8917 kivitendo-Basisverzeichnis heraus ausführen.</para>
8919 <para>Um einzelne Test-Scripte auszuführen, übergibt man deren Namen
8920 an <filename>t/test.pl</filename>. Beispielsweise:</para>
8922 <programlisting>t/test.pl t/form/format_amount.t t/background_job/known_jobs.t</programlisting>
8925 <sect2 id="devel.testsuite.meaning_of_scripts">
8926 <title>Bedeutung der verschiedenen Test-Scripte</title>
8928 <para>Die Test-Suite umfasst Tests sowohl für Funktionen als auch für
8929 Programmierstil. Einige besonders zu erwähnende, weil auch während der
8930 Entwicklung nützliche Tests sind:</para>
8934 <para><filename>t/001compile.t</filename> -- compiliert alle
8935 Quelldateien und bricht bei Fehlern sofort ab</para>
8939 <para><filename>t/002goodperl.t</filename> -- überprüft alle
8940 Perl-Dateien auf Anwesenheit von '<literal>use
8941 strict</literal>'-Anweisungen</para>
8945 <para><filename>t/003safesys.t</filename> -- überprüft Aufrufe von
8946 <function>system()</function> und <function>exec()</function> auf
8951 <para><filename>t/005no_tabs.t</filename> -- überprüft, ob Dateien
8952 Tab-Zeichen enthalten</para>
8956 <para><filename>t/006spelling.t</filename> -- sucht nach häufigen
8957 Rechtschreibfehlern</para>
8961 <para><filename>t/011pod.t</filename> -- überprüft die Syntax von
8962 Dokumentation im POD-Format auf Gültigkeit</para>
8966 <para>Weitere Test-Scripte überprüfen primär die Funktionsweise
8967 einzelner Funktionen und Module.</para>
8970 <sect2 id="devel.testsuite.create_new">
8971 <title>Neue Test-Scripte erstellen</title>
8973 <para>Es wird sehr gern gesehen, wenn neue Funktionalität auch gleich
8974 mit einem Test-Script abgesichert wird. Auch bestehende Funktion darf
8975 und soll ausdrücklich nachträglich mit Test-Scripten abgesichert
8978 <sect3 id="devel.testsuite.ideas_for_non_function_tests">
8979 <title>Ideen für neue Test-Scripte, die keine konkreten Funktionen
8982 <para>Ideen, die abgesehen von Funktionen noch nicht umgesetzt
8987 <para>Überprüfung auf fehlende symbolische Links</para>
8991 <para>Suche nach Nicht-ASCII-Zeichen in Perl-Code-Dateien (mit
8992 gewissen Einschränkungen wie das Erlauben von deutschen
8997 <para>Test auf DOS-Zeilenenden (\r\n anstelle von nur \n)</para>
9001 <para>Überprüfung auf Leerzeichen am Ende von Zeilen</para>
9005 <para>Test, ob alle zu übersetzenden Strings in
9006 <filename>locale/de/all</filename> vorhanden sind</para>
9010 <para>Test, ob alle Webseiten-Templates in
9011 <filename>templates/webpages</filename> mit vom Perl-Modul
9012 <literal>Template</literal> compiliert werden können</para>
9017 <sect3 id="devel.testsuite.directory_and_test_names">
9018 <title>Konvention für Verzeichnis- und Dateinamen</title>
9020 <para>Es gibt momentan eine wenige Richtlinien, wie Test-Scripte zu
9021 benennen sind. Bitte die folgenden Punkte als Richtlinie betrachten
9022 und ihnen soweit es geht folgen:</para>
9026 <para>Die Dateiendung muss <filename>.t</filename>
9031 <para>Namen sind englisch, komplett klein geschrieben und
9032 einzelne Wörter mit Unterstrichten getrennt (beispielsweise
9033 <filename>bad_function_params.t</filename>).</para>
9037 <para>Unterverzeichnisse sollten grob nach dem Themenbereich
9038 benannt sein, mit dem sich die Scripte darin befassen
9039 (beispielsweise <filename>background_jobs</filename> für Tests
9040 rund um Hintergrund-Jobs).</para>
9044 <para>Test-Scripte sollten einen überschaubaren Bereich von
9045 Funktionalität testen, der logisch zusammenhängend ist (z.B. nur
9046 Tests für eine einzelne Funktion in einem Modul). Lieber mehrere
9047 Test-Scripte schreiben.</para>
9052 <sect3 id="devel.testsuite.minimal_example">
9053 <title>Minimales Skelett für eigene Scripte</title>
9055 <para>Der folgenden Programmcode enthält das kleinstmögliche
9056 Testscript und kann als Ausgangspunkt für eigene Tests verwendet
9059 <programlisting>use Test::More tests => 0;
9063 use Support::TestSetup;
9065 Support::TestSetup::login();</programlisting>
9067 <para>Wird eine vollständig initialisierte kivitendo-Umgebung
9068 benötigt (Stichwort: alle globalen Variablen wie
9069 <varname>$::auth</varname>, <varname>$::form</varname> oder
9070 <varname>$::lxdebug</varname>), so muss in der Konfigurationsdatei
9071 <filename>config/kivitendo.conf</filename> im Abschnitt
9072 <literal>testing.login</literal> ein gültiger Login-Name eingetragen
9073 sein. Dieser wird für die Datenbankverbindung benötigt.</para>
9075 <para>Wir keine vollständig initialisierte Umgebung benötigt, so
9076 kann die letzte Zeile <programlisting>Support::TestSetup::login();</programlisting>
9077 weggelassen werden, was die Ausführungszeit des Scripts leicht
9083 <sect1 id="devel.style-guide">
9084 <title>Stil-Richtlinien</title>
9086 <para>Die folgenden Regeln haben das Ziel, den Code möglichst gut les-
9087 und wartbar zu machen. Dazu gehört zum Einen, dass der Code einheitlich
9088 eingerückt ist, aber auch, dass Mehrdeutigkeit so weit es geht vermieden
9089 wird (Stichworte "Klammern" oder "Hash-Keys").</para>
9091 <para>Diese Regeln sind keine Schikane sondern erleichtern allen das
9094 <para>Jeder, der einen Patch schickt, sollte seinen Code vorher
9095 überprüfen. Einige der Regeln lassen sich automatisch überprüfen, andere
9100 <para>Es werden keine echten Tabs sondern Leerzeichen
9105 <para>Die Einrückung beträgt zwei Leerzeichen. Beispiel:</para>
9107 <programlisting>foreach my $row (@data) {
9109 # do something with $row
9113 $row->{modules} = MODULE->retrieve(
9114 id => $row->{id},
9115 date => $use_now ? localtime() : $row->{time},
9119 $report->add($row);
9124 <para>Öffnende geschweifte Klammern befinden sich auf der gleichen
9125 Zeile wie der letzte Befehl. Beispiele:</para>
9127 <programlisting>sub debug {
9133 <programlisting>if ($form->{item_rows} > 0) {
9139 <para>Schließende geschweifte Klammern sind so weit eingerückt wie
9140 der Befehl / die öffnende schließende Klammer, die den Block
9141 gestartet hat, und nicht auf der Ebene des Inhalts. Die gleichen
9142 Beispiele wie bei 3. gelten.</para>
9146 <para>Die Wörter "<function>else</function>",
9147 "<function>elsif</function>", "<function>while</function>" befinden
9148 sich auf der gleichen Zeile wie schließende geschweifte Klammern.
9151 <programlisting>if ($form->{sum} > 1000) {
9153 } elsif ($form->{sum} > 0) {
9161 } until ($a > 0);</programlisting>
9165 <para>Parameter von Funktionsaufrufen müssen mit runden Klammern
9166 versehen werden. Davon nicht betroffen sind interne Perl-Funktionen,
9167 und grep-ähnliche Operatoren. Beispiel:</para>
9169 <programlisting>$main::lxdebug->message("Could not find file.");
9170 %options = map { $_ => 1 } grep { !/^#/ } @config_file;</programlisting>
9174 <para>Verschiedene Klammern, Ihre Ausdrücke und Leerzeichen:</para>
9176 <para>Generell gilt: Hashkeys und Arrayindices sollten nicht durch
9177 Leerzeichen abgesetzt werden. Logische Klammerungen ebensowenig,
9178 Blöcke schon. Beispiel:</para>
9180 <programlisting>if (($form->{debug} == 1) && ($form->{sum} - 100 < 0)) {
9185 $form->{sum} += $form->{"row_$i"};
9186 $form->{ $form->{index} } += 1;
9188 map { $form->{sum} += $form->{"row_$_"} } 1..$rowcount;</programlisting>
9192 <para>Mehrzeilige Befehle</para>
9196 <para>Werden die Parameter eines Funktionsaufrufes auf mehrere
9197 Zeilen aufgeteilt, so sollten diese bis zu der Spalte eingerückt
9198 werden, in der die ersten Funktionsparameter in der ersten Zeile
9199 stehen. Beispiel:</para>
9201 <programlisting>$sth = $dbh->prepare("SELECT * FROM some_table WHERE col = ?",
9202 $form->{some_col_value});</programlisting>
9206 <para>Ein Spezialfall ist der ternäre Operator "?:", der am
9207 besten in einer übersichtlichen Tabellenstruktur organisiert
9208 wird. Beispiel:</para>
9210 <programlisting>my $rowcount = $form->{"row_$i"} ? $i
9211 : $form->{oldcount} ? $form->{oldcount} + 1
9212 : $form->{rowcount} - $form->{rowbase};</programlisting>
9218 <para>Kommentare</para>
9222 <para>Kommentare, die alleine in einer Zeile stehen, sollten
9223 soweit wie der Code eingerückt sein.</para>
9227 <para>Seitliche hängende Kommentare sollten einheitlich
9228 formatiert werden.</para>
9232 <para>Sämtliche Kommentare und Sonstiges im Quellcode ist bitte
9233 auf Englisch zu verfassen. So wie ich keine Lust habe,
9234 französischen Quelltext zu lesen, sollte auch der kivitendo
9235 Quelltext für nicht-Deutschsprachige lesbar sein.
9238 <programlisting>my $found = 0;
9246 $i = 0 # initialize $i
9248 $i *= $const; # do something crazy
9249 $i = $n; # recover $i</programlisting>
9255 <para>Hashkeys sollten nur in Anführungszeichen stehen, wenn die
9256 Interpolation gewünscht ist. Beispiel:</para>
9258 <programlisting>$form->{sum} = 0;
9259 $form->{"row_$i"} = $form->{"row_$i"} - 5;
9260 $some_hash{42} = 54;</programlisting>
9264 <para>Die maximale Zeilenlänge ist nicht beschränkt. Zeilenlängen
9265 unterhalb von 79 Zeichen helfen unter bestimmten Bedingungen, aber
9266 wenn die Lesbarkeit unter kurzen Zeilen leidet (wie zum Biespiel in
9267 grossen Tabellen), dann ist Lesbarkeit vorzuziehen.</para>
9269 <para>Als Beispiel sei die Funktion
9270 <function>print_options</function> aus
9271 <filename>bin/mozilla/io.pl</filename> angeführt.</para>
9275 <para>Trailing Whitespace, d.h. Leerzeichen am Ende von Zeilen sind
9276 unerwünscht. Sie führen zu unnötigen Whitespaceänderungen, die diffs
9279 <para>Emacs und vim haben beide recht einfache Methoden zur
9280 Entfernung von trailing whitespace. Emacs kennt das Kommande
9281 <command>nuke-trailing-whitespace</command>, vim macht das gleiche
9282 manuell über <literal>:%s/\s\+$//e</literal> Mit <literal>:au
9283 BufWritePre * :%s/\s\+$//e</literal> wird das an Speichern
9288 <para>Es wird kein <command>perltidy</command> verwendet.</para>
9290 <para>In der Vergangenheit wurde versucht,
9291 <command>perltidy</command> zu verwenden, um einen einheitlichen
9292 Stil zu erlangen. Es hat sich aber gezeigt, dass
9293 <command>perltidy</command>s sehr eigenwilliges Verhalten, was
9294 Zeilenumbrüche angeht, oftmals gut formatierten Code zerstört. Für
9295 den Interessierten sind hier die
9296 <command>perltidy</command>-Optionen, die grob den beschriebenen
9297 Richtlinien entsprechen:</para>
9299 <programlisting>-syn -i=2 -nt -pt=2 -sbt=2 -ci=2 -ibc -hsc -noll -nsts -nsfs -asc -dsm
9300 -aws -bbc -bbs -bbb -mbl=1 -nsob -ce -nbl -nsbl -cti=0 -bbt=0 -bar -l=79
9301 -lp -vt=1 -vtc=1</programlisting>
9305 <para><varname>STDERR</varname> ist tabu. Unkonditionale
9306 Debugmeldungen auch.</para>
9308 <para>kivitendo bietet mit dem Modul <classname>LXDebug</classname>
9309 einen brauchbaren Trace-/Debug-Mechanismus. Es gibt also keinen
9310 Grund, nach <varname>STDERR</varname> zu schreiben.</para>
9312 <para>Die <classname>LXDebug</classname>-Methode
9313 "<function>message</function>" nimmt als ersten Paramter außerdem
9314 eine Flagmaske, für die die Meldung angezeigt wird, wobei "0" immer
9315 angezeigt wird. Solche Meldungen sollten nicht eingecheckt werden
9316 und werden in den meisten Fällen auch vom Repository
9317 zurückgewiesen.</para>
9321 <para>Alle neuen Module müssen use strict verwenden.</para>
9323 <para><varname>$form</varname>, <varname>$auth</varname>,
9324 <varname>$locale</varname>, <varname>$lxdebug</varname> und
9325 <varname>%myconfig</varname> werden derzeit aus dem main package
9326 importiert (siehe <xref linkend="devel.globals"/>. Alle anderen
9327 Konstrukte sollten lexikalisch lokal gehalten werden.</para>
9332 <sect1 id="devel.build-doc" xreflabel="Dokumentation erstellen">
9333 <title>Dokumentation erstellen</title>
9335 <sect2 id="devel.build-doc.introduction">
9336 <title>Einführung</title>
9338 <para>Diese Dokumentation ist in <productname>DocBook</productname>
9339 XML geschrieben. Zum Bearbeiten reicht grundsätzlich ein Text-Editor.
9340 Mehr Komfort bekommt man, wenn man einen dedizierten XML-fähigen
9341 Editor nutzt, der spezielle Unterstützung für
9342 <productname>DocBook</productname> mitbringt. Wir empfehlen dafür den
9343 <ulink url="http://www.xmlmind.com/xmleditor/">XMLmind XML
9344 Editor</ulink>, der bei nicht kommerzieller Nutzung kostenlos
9348 <sect2 id="devel.build-doc.required-software">
9349 <title>Benötigte Software</title>
9351 <para>Bei <productname>DocBook</productname> ist Prinzip, dass
9352 ausschließlich die XML-Quelldatei bearbeitet wird. Aus dieser werden
9353 dann mit entsprechenden Stylesheets andere Formate wie PDF oder HTML
9354 erzeugt. Bei kivitendo übernimmt diese Aufgabe das Shell-Script
9355 <command>scripts/build_doc.sh</command>.</para>
9357 <para>Das Script benötigt zur Konvertierung verschiedene
9358 Softwarekomponenten, die im normalen kivitendo-Betrieb nicht benötigt
9364 url="http://www.oracle.com/technetwork/java/index.html">Java</ulink>
9365 in einer halbwegs aktuellen Version</para>
9369 <para>Das Java-Build-System <ulink
9370 url="http://ant.apache.org/">Apache Ant</ulink></para>
9374 <para>Das Dokumentations-System Dobudish für
9375 <productname>DocBook</productname> 4.5, eine Zusammenstellung
9376 diverser Stylesheets und Grafiken zur Konvertierung von
9377 <productname>DocBook</productname> XML in andere Formate. Das
9378 Paket, das benötigt wird, ist zum Zeitpunkt der
9379 Dokumentationserstellung
9380 <filename>dobudish-nojre-1.1.4.zip</filename>, aus auf <ulink
9381 url="http://code.google.com/p/dobudish/downloads/list">code.google.com</ulink>
9386 <para>Apache Ant sowie ein dazu passendes Java Runtime Environment
9387 sind auf allen gängigen Plattformen verfügbar. Beispiel für
9388 Debian/Ubuntu:</para>
9390 <programlisting>apt-get install ant openjdk-7-jre</programlisting>
9392 <para>Nach dem Download von Dobudish muss Dobudish im Unterverzeichnis
9393 <filename>doc/build</filename> entpackt werden. Beispiel unter der
9394 Annahme, das <productname>Dobudish</productname> in
9395 <filename>$HOME/Downloads</filename> heruntergeladen wurde:</para>
9397 <programlisting>cd doc/build
9398 unzip $HOME/Downloads/dobudish-nojre-1.1.4.zip</programlisting>
9401 <sect2 id="devel.build-doc.build">
9402 <title>PDFs und HTML-Seiten erstellen</title>
9404 <para>Die eigentliche Konvertierung erfolgt nach Installation der
9405 benötigten Software mit einem einfachen Aufruf direkt aus dem
9406 kivitendo-Installationsverzeichnis heraus:</para>
9408 <programlisting>./scripts/build_doc.sh</programlisting>
9411 <sect2 id="devel.build-doc.repository">
9412 <title>Einchecken in das Git-Repository</title>
9414 <para>Sowohl die XML-Datei als auch die erzeugten PDF- und
9415 HTML-Dateien sind Bestandteil des Git-Repositories. Daraus folgt, dass
9416 nach Änderungen am XML die PDF- und HTML-Dokumente ebenfalls gebaut
9417 und alles zusammen in einem Commit eingecheckt werden sollten.</para>
9419 <para>Die "<filename>dobudish</filename>"-Verzeichnisse bzw.
9420 symbolischen Links gehören hingegen nicht in das Repository.</para>