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.5.5: 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 15.0</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>CGI</literal></para>
171 <para><literal>Clone</literal></para>
175 <para><literal>Config::Std</literal></para>
179 <para><literal>Daemon::Generic</literal></para>
183 <para><literal>DateTime</literal></para>
187 <para><literal>DateTime::Event::Cron</literal></para>
191 <para><literal>DateTime::Format::Strptime</literal></para>
195 <para><literal>DateTime::Set</literal></para>
199 <para><literal>DBI</literal></para>
203 <para><literal>DBD::Pg</literal></para>
207 <para><literal>Email::Address</literal></para>
211 <para><literal>Email::MIME</literal></para>
215 <para><literal>Exception::Class</literal></para>
219 <para><literal>FCGI</literal> (nicht Versionen 0.68 bis 0.71
220 inklusive; siehe <xref
221 linkend="Apache-Konfiguration.FCGI.WebserverUndPlugin"/>)</para>
225 <para><literal>File::Copy::Recursive</literal></para>
229 <para><literal>File::Flock</literal></para>
233 <para><literal>File::MimeInfo</literal></para>
237 <para><literal>File::Slurp</literal></para>
241 <para><literal>GD</literal></para>
245 <para><literal>HTML::Parser</literal></para>
249 <para><literal>HTML::Restrict</literal></para>
253 <para><literal>Image::Info</literal></para>
257 <para><literal>JSON</literal></para>
261 <para><literal>List::MoreUtils</literal></para>
265 <para><literal>List::UtilsBy</literal></para>
269 <para>LWP::Authen::Digest</para>
273 <para>LWP::UserAgent</para>
277 <para><literal>Net::SMTP::SSL</literal> (optional, bei
278 E-Mail-Versand über SSL; siehe Abschnitt "<xref
279 linkend="config.sending-email.smtp"/>")</para>
283 <para><literal>Net::SSLGlue</literal> (optional, bei
284 E-Mail-Versand über TLS; siehe Abschnitt "<xref
285 linkend="config.sending-email.smtp"/>")</para>
289 <para><literal>Params::Validate</literal></para>
293 <para><literal>PBKDF2::Tiny</literal></para>
297 <para><literal>PDF::API2</literal></para>
301 <para><literal>Regexp::IPv6</literal></para>
305 <para><literal>Rose::Object</literal></para>
309 <para><literal>Rose::DB</literal></para>
313 <para><literal>Rose::DB::Object</literal> Version 0.788 oder
318 <para><literal>Set::Infinite</literal></para>
322 <para><literal>String::ShellQuote</literal></para>
326 <para><literal>Sort::Naturally</literal></para>
330 <para><literal>Template</literal></para>
334 <para><literal>Text::CSV_XS</literal></para>
338 <para><literal>Text::Iconv</literal></para>
342 <para><literal>Text::Unidecode</literal></para>
346 <para><literal>URI</literal></para>
350 <para><literal>XML::Writer</literal></para>
354 <para><literal>YAML::XS</literal> oder <literal>YAML</literal></para>
358 <para>Seit Version größer v3.5.3 sind die folgenden Pakete hinzugekommen: <literal>Exception::Class</literal></para>
360 <para>Seit Version größer v3.5.1 sind die folgenden Pakete hinzugekommen: <literal>Set::Infinite</literal>,
361 <literal>List::UtilsBy</literal>, <literal>DateTime::Set</literal>, <literal>DateTime::Event::Cron</literal>
362 <literal>Daemon::Generic</literal>, <literal>DateTime::Event::Cron</literal>, <literal>File::Flock</literal>,
363 <literal>File::Slurp</literal></para>
365 <para>Seit Version größer v3.5.0 sind die folgenden Pakete
366 hinzugekommen: <literal>Text::Unidecode</literal>,
367 <literal>LWP::Authen::Digest</literal>,
368 <literal>LWP::UserAgent</literal></para>
370 <para>Seit Version v3.4.0 sind die folgenden Pakete hinzugekommen:
371 <literal>Algorithm::CheckDigits</literal>,
372 <literal>PBKDF2::Tiny</literal></para>
374 <para>Seit Version v3.2.0 sind die folgenden Pakete hinzugekommen:
375 <literal>GD</literal>, <literal>HTML::Restrict</literal>,
376 <literal>Image::Info</literal></para>
378 <para>Seit v3.0.0 sind die folgenden Pakete hinzugekommen:
379 <literal>File::Copy::Recursive</literal>.</para>
381 <para>Seit v2.7.0 sind die folgenden Pakete hinzugekommen:
382 <literal>Email::MIME</literal>, <literal>Net::SMTP::SSL</literal>,
383 <literal>Net::SSLGlue</literal>.</para>
385 <para>Gegenüber Version 2.6.0 sind zu dieser Liste 2 Pakete
386 hinzugekommen, <literal>URI</literal> und
387 <literal>XML::Writer</literal> sind notwendig. Ohne startet kivitendo
390 <para>Gegenüber Version 2.6.1 sind <literal>parent</literal>,
391 <literal>DateTime</literal>, <literal>Rose::Object</literal>,
392 <literal>Rose::DB</literal> und <literal>Rose::DB::Object</literal>
393 neu hinzugekommen. <literal>IO::Wrap</literal> wurde entfernt.</para>
395 <para>Gegenüber Version 2.6.3 ist <literal>JSON</literal> neu
396 hinzugekommen.</para>
398 <para><literal>Email::Address</literal> und
399 <literal>List::MoreUtils</literal> sind schon länger feste
400 Abhängigkeiten, wurden aber bisher mit kivitendo mitgeliefert. Beide
401 sind auch in 2.6.1 weiterhin mit ausgeliefert, wurden in einer
402 zukünftigen Version aber aus dem Paket entfernt werden. Es wird
403 empfohlen diese Module zusammen mit den anderen als Bibliotheken zu
407 <title>Debian und Ubuntu</title>
408 <para>Für Debian und Ubuntu stehen die meisten der benötigten
409 Pakete als Debian-Pakete zur Verfügung. Sie können mit
410 folgendem Befehl installiert werden:</para>
412 <programlisting>apt install apache2 libarchive-zip-perl libclone-perl \
413 libconfig-std-perl libdatetime-perl libdbd-pg-perl libdbi-perl \
414 libemail-address-perl libemail-mime-perl libfcgi-perl libjson-perl \
415 liblist-moreutils-perl libnet-smtp-ssl-perl libnet-sslglue-perl \
416 libparams-validate-perl libpdf-api2-perl librose-db-object-perl \
417 librose-db-perl librose-object-perl libsort-naturally-perl \
418 libstring-shellquote-perl libtemplate-perl libtext-csv-xs-perl \
419 libtext-iconv-perl liburi-perl libxml-writer-perl libyaml-perl \
420 libimage-info-perl libgd-gd2-perl libapache2-mod-fcgid \
421 libfile-copy-recursive-perl postgresql libalgorithm-checkdigits-perl \
422 libcrypt-pbkdf2-perl git libcgi-pm-perl libtext-unidecode-perl libwww-perl\
423 postgresql-contrib aqbanking-tools poppler-utils libhtml-restrict-perl\
424 libdatetime-set-perl libset-infinite-perl liblist-utilsby-perl\
425 libdaemon-generic-perl libfile-flock-perl libfile-slurp-perl\
426 libfile-mimeinfo-perl libpbkdf2-tiny-perl libregexp-ipv6-perl \
427 libdatetime-event-cron-perl libexception-class-perl libcam-pdf-perl \
430 <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>
431 <note id="ubuntu-universe">
432 <para>Die Perl Pakete für Ubuntu befinden sich im "Universe" Repository. Falls dies nicht aktiv ist, kann dies mit folgendem Aufruf aktiviert werden:
433 <programlisting>add-apt-repository universe</programlisting></para>
435 <note id="build-essential">
436 <para>Für ältere Ubuntu/Debians müßen einige Pakete per CPAN installiert werden.
437 Das geht bspw. für das benötige Paket HTML::Restrict mit:</para>
438 <programlisting>apt-get install build-essential
439 cpan HTML::Restrict</programlisting>
444 <title>Fedora</title>
446 <para>Für Fedora stehen die meisten der benötigten Perl-Pakete als
447 RPM-Pakete zur Verfügung. Sie können mit folgendem Befehl
448 installiert werden:</para>
450 <programlisting>dnf install httpd mod_fcgid postgresql-server postgresql-contrib\
451 perl-Algorithm-CheckDigits perl-Archive-Zip perl-CPAN perl-Class-XSAccessor \
452 perl-Clone perl-Config-Std perl-DBD-Pg perl-DBI perl-Daemon-Generic \
453 perl-DateTime perl-DateTime-Set perl-Email-Address perl-Email-MIME perl-FCGI \
454 perl-File-Copy-Recursive perl-File-Flock perl-File-MimeInfo perl-File-Slurp \
455 perl-GD perl-HTML-Restrict perl-JSON perl-List-MoreUtils perl-List-UtilsBy \
456 perl-Net-SMTP-SSL perl-Net-SSLGlue perl-PBKDF2-Tiny perl-PDF-API2 \
457 perl-Params-Validate perl-Regexp-IPv6 perl-Rose-DB perl-Rose-DB-Object \
458 perl-Rose-Object perl-Sort-Naturally perl-String-ShellQuote \
459 perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv perl-URI perl-XML-Writer \
460 perl-YAML perl-libwww-perl</programlisting>
464 <title>openSUSE</title>
466 <para>Für openSUSE stehen die meisten der benötigten Perl-Pakete als RPM-Pakete zur Verfügung.</para>
467 <para>Dies setzt voraus, das eben die erforderlichen Repositories dem System bekannt gemacht worden sind.</para>
468 <para>Um zusätzliche 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. Da wahrscheinlich für die Administration eine SSH-Verbindung zum Server benutzt wird.</para>
469 <para>Dazu geben wir folgenden Befehl ein:</para>
470 <programlisting>zypper addrepo -f \
471 http://download.opensuse.org/repositories/devel:languages:perl/openSUSE_Leap_15.0/ \
472 "devel:languages:perl"
474 <programlisting>zypper addrepo -f \
475 https://download.opensuse.org/repositories/devel:languages:haskell:lts:13/\
476 openSUSE_Leap_15.0/ "devel:languages:haskell:lts:13"
478 <programlisting>zypper addrepo -f \
479 https://download.opensuse.org/repositories/devel:languages:haskell:lts:13/\
480 openSUSE_Leap_15.0/ "devel:languages:haskell:lts:13"
482 <para>Danach geben wir noch die beiden folgenden Befehle ein:</para>
483 <programlisting>zypper clean</programlisting>
484 <programlisting>zypper refresh</programlisting>
485 <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>
486 <programlisting>zypper --help</programlisting>
488 <para>Offiziell wird von openSUSE nur noch Versionen ab 15.0 unterstützt. Die SuSE Macher haben ab Version 15.0 einen größen Umbau in der Verwaltung der Pakete vorgenommen, das heißt, der Paketumfang ist der SLES 15 als kleinsten Nenner angepasst. Dies gilt besonders der openSUE Distribution. Es gibt ja einmal die openSUSE Distri und die Professionelle SLES Version. Dadurch sind viele Pakete aus dem Repositorie enfernt worden, aber auch viele auf aktuellen Stand gehalten.</para>
490 <para>Das überprüfen wir mit YaST. Sollte openSUSE bis zur Version 15.0 zum Einsatz kommen und der Administrator bei der Installation der Distribution die KDE Oberfläche aktiviert hat, loggen wir uns am Server direkt ein, starten das Verwaltungsprogram in einer Konsole wie folgt:</para>
491 <para>yast2 return.</para>
492 <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>
493 <para>Sie können mit folgendem Befehl installiert werden:</para>
494 <para>zypper install Paketname</para>
495 <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>
497 <programlisting>zypper install perl-threads-shared ghc-pdfinfo apache2-mod_fcgid \
498 yast2-http-server postgresql-server postgresql-contrib perl-Algorithm-CheckDigits \
499 perl-Archive-Zip perl-CGI perl-CGI-Ajax perl-Clone \
500 perl-Config-Std perl-Class-XSAccessor perl-Daemon-Generic perl-DateTime \
501 perl-DateTime-Event-Cron perl-DateTime-Format-Strptime perl-DateTime-Set \
502 perl-DBI perl-DBD-Pg perl-Devel-REPL perl-FastCGI perl-Email-Address \
503 perl-Email-MIME perl-Email-MIME-ContentType perl-Email-MIME-Encodings \
504 perl-FCGI perl-File-Copy-Recursive perl-File-Flock perl-File-MimeInfo \
505 perl-File-Slurp perl-GD perl-HTML-Restrict perl-Image-Info \
506 perl-JSON perl-List-MoreUtils perl-List-UtilsBy perl-Log-Log4perl perl-Net-LDAP-Server \
507 perl-Net-SSLGlue perl-Net-SMTP-SSL perl-PBKDF2-Tiny perl-PDF-API2 \
508 perl-Params-Validate perl-Regexp-IPv6 perl-Rose-DB perl-Rose-Object \
509 perl-Rose-DB-Object perl-MooseX-Role-Cmd perl-Set-Crontab perl-Set-Infinite \
510 perl-Sort-Naturally perl-String-ShellQuote perl-Sys-CPU perl-Template-Toolkit \
511 perl-Text-CSV_XS perl-Test-Deep perl-Test-Output perl-Text-Iconv \
512 perl-Text-Unidecode perl-URI perl-URI-Find perl-XML-Writer \
513 perl-YAML perl-libwww-perl
516 <para>Für die Entwickler installiert man noch die folgenden Pakete:</para>
518 <programlisting>zypper install ghc-mtl-devel ghc-old-locale-devel \
519 ghc-process-extras-devel ghc-rpm-macros ghc-text-devel ghc-time-devel \
520 ghc-Cabal-devel ghc-time-locale-compat-devel perl-Log-Log4perl ghc-pdfinfo \
521 ghc-pdfinfo-devel perl-Devel-REPL perl-URI-Find perl-Class-Utils \
522 perl-Error-Pure perl-File-Object perl-Readonly perl-Test-Warnings \
523 perl-Test-NoWarnings perl-Test-Deep perl-Test-Output perl-Test-Strict \
524 perl-Test-LongString perl-File-Find-Rule
527 <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 plazieren, der Vollständigkeit halber hier für die Installation mit angegeben.
528 Dazu können Sie die folgenden Befehle nutzen:</para>
530 <programlisting>zypper install texlive-wallpaper texlive-colortbl \
531 texlive-scrlttr2copy texlive-eurosym \
532 texlive-geometry texlive-german texlive-graphbox texlive-hyperref \
533 texlive-xifthen texlive-luainputenc texlive-lastpage texlive-ltabptch \
534 texlive-nomentbl texlive-threeparttablex texlive-substr texlive-tabulary \
535 texlive-ulem texlive-wallpaper texlive-xcolor texlive-xstring \
536 texlive-xypic texlive-mwe texlive-mweights texlive-barcodes \
537 texlive-GS1 texlive-ean texlive-makebarcode texlive-pst-barcode \
541 <para>Zusätzlich müssen einige Pakete aus dem CPAN installiert
542 werden. Dazu können Sie die folgenden Befehle nutzen:</para>
544 <programlisting>cpan DateTime::event::Cron DateTime::Set FCGI \
545 HTML::Restrict PBKDF2::Tiny Rose::Db::Object Set::Infinite</programlisting>
550 <title>Andere Pakete installieren</title>
554 <para><literal>aqbanking-tools</literal> Für das Parsen des MT940 Bankformats (Version 6 oder höher)</para>
557 <para><literal>poppler-utils</literal> 'pdfinfo' zum Erkennen der Seitenanzahl bei der PDF-Generierung</para>
560 <para><literal>Postgres Trigram-Index</literal> Für datenbankoptimierte Suchanfragen. Bspw. im Paket <literal>postgresql-contrib</literal> enthalten</para>
563 <para>Debian und Ubuntu: <programlisting>apt install aqbanking-tools postgresql-contrib poppler-utils</programlisting></para>
564 <para>Fedora: <programlisting>dnf install aqbanking poppler-utils postgresql-contrib</programlisting></para>
565 <para>openSUSE: <programlisting>zypper install aqbanking-tools poppler-tools</programlisting></para>
569 <sect1 id="Manuelle-Installation-des-Programmpaketes"
570 xreflabel="Manuelle Installation des Programmpaketes">
571 <title>Manuelle Installation des Programmpaketes</title>
573 <para>Der aktuelle Stable-Release, bzw. beta Release wird bei github
574 gehostet und kann <ulink
575 url="https://github.com/kivitendo/kivitendo-erp/releases">hier</ulink>
576 heruntergeladen werden.</para>
578 <para>Das aktuelleste kivitendo ERP-Archiv
579 (<filename>kivitendo-erp-*.tgz</filename>) wird dann im
580 Dokumentenverzeichnis des Webservers (z.B.
581 <filename>/var/www/html/</filename>,
582 <filename>/srv/www/htdocs</filename> oder
583 <filename>/var/www/</filename>) entpackt:</para>
585 <programlisting>cd /var/www
586 tar xvzf kivitendo-erp-*.tgz</programlisting>
588 <para>Wechseln Sie in das entpackte Verzeichnis:</para>
590 <programlisting>cd kivitendo-erp</programlisting>
592 <para>Alternativ können Sie auch einen Alias in der
593 Webserverkonfiguration benutzen, um auf das tatsächliche
594 Installationsverzeichnis zu verweisen.</para>
596 <para>Bei einer Neuinstallation von Version 3.1.0 oder später muß das
597 WebDAV Verzeichnis derzeit manuell angelegt werden:</para>
599 <programlisting>mkdir webdav</programlisting>
601 <para>Die Verzeichnisse <filename>users</filename>,
602 <filename>spool</filename> und <filename>webdav</filename> müssen für
603 den Benutzer beschreibbar sein, unter dem der Webserver läuft. Die
604 restlichen Dateien müssen für diesen Benutzer lesbar sein. Die Benutzer-
605 und Gruppennamen sind bei verschiedenen Distributionen unterschiedlich
606 (z.B. bei Debian/Ubuntu <constant>www-data</constant>, bei Fedora
607 <constant>apache</constant> oder bei openSUSE
608 <constant>wwwrun</constant>).</para>
610 <para>Der folgende Befehl ändert den Besitzer für die oben genannten
611 Verzeichnisse auf einem Debian/Ubuntu-System:</para>
613 <programlisting>chown -R www-data users spool webdav</programlisting>
615 <para>Weiterhin muss der Webserver-Benutzer in den Verzeichnissen
616 <filename>templates</filename> und <filename>users</filename>
617 Unterverzeichnisse für jeden neuen Benutzer anlegen dürfen, der in
618 kivitendo angelegt wird:</para>
620 <programlisting>chown www-data templates users</programlisting>
623 <para>Wir empfehlen eine Installation mittels des Versionsmanagager
624 git. Hierfür muss ein git-Client installiert sein. Damit ist man sehr
625 viel flexibler für zukünftige Upgrades. Installations-Anleitung (bitte
626 die Pfade anpassen) bspw. wie folgt: <programlisting>cd /var/www/
627 git clone https://github.com/kivitendo/kivitendo-erp.git
629 git checkout `git tag -l | egrep -ve "(alpha|beta|rc)" | tail -1`</programlisting>
630 Erläuterung: Der Befehl wechselt zur letzten Stable-Version (git tag
631 -l listet alle Tags auf, das egrep schmeisst alle Einträge mit alpha,
632 beta oder rc raus und das tail gibt davon den obersten Treffer
633 zurück). Sehr sinnvoll ist es, direkt im Anschluss einen eigenen
634 Branch zu erzeugen, um bspw. seine eigenen Druckvorlagen-Anpassungen
635 damit zu verwalten. Hierfür reicht ein simples <programlisting> git checkout -b meine_eigenen_änderungen</programlisting>
636 nach dem letzten Kommando (weiterführende Informationen <ulink
637 url="http://www-cs-students.stanford.edu/~blynn/gitmagic/index.html">
638 Git Magic</ulink>).</para>
640 <para>Ein beispielhafter Workflow für Druckvorlagen-Anpassungen von
641 3.4.1 nach 3.5: <programlisting>
642 $ git clone https://github.com/kivitendo/kivitendo-erp.git
644 $ git checkout release-3.4.1 # das ist ein alter release aus dem wir starten ...
645 $ git checkout -b meine_eigene_änderungen # unser lokaler branch - unabhängig von allen anderen
646 $ git add templates/mein_druck # das sind unsere druckvorlagen inkl. produktbilder
647 $ git commit -m "juhu tolle änderungen"
649 [meine_aenderungen 1d89e41] juhu tolle ändernungen
650 4 files changed, 380 insertions(+)
651 create mode 100644 templates/mein_druck/img/webdav/tesla.png
652 create mode 100644 templates/mein_druck/mahnung.tex
653 create mode 100644 templates/mein_druck/zahlungserinnerung_zwei.tex
654 create mode 100644 templates/mein_druck/zahlungserinnerung_zwei_invoice.tex
657 # webserver abschalten!
659 $ git checkout master
660 $ git pull # oder git fetch und danach ein stable release tag auswählen (s.o.)
661 $ git checkout meine_eigenen_änderungen
664 Zunächst wird der Branch zurückgespult, um Ihre Änderungen
665 darauf neu anzuwenden ...
666 Wende an: juhu tolle änderungen
667 $ service apache2 restart # webserver starten!
668 </programlisting></para>
672 <sect1 id="config.config-file">
673 <title>kivitendo-Konfigurationsdatei</title>
675 <sect2 id="config.config-file.introduction"
676 xreflabel="Einführung in die Konfigurationsdatei">
677 <title>Einführung</title>
679 <para>In kivitendo gibt es nur noch eine Konfigurationsdatei, die
680 benötigt wird: <filename>config/kivitendo.conf</filename> (kurz: "die
681 Hauptkonfigurationsdatei"). Diese muss bei der Erstinstallation von
682 kivitendo bzw. der Migration von älteren Versionen angelegt
685 <para>Als Vorlage dient die Datei
686 <filename>config/kivitendo.conf.default</filename> (kurz: "die
687 Default-Datei"):</para>
689 <programlisting>$ cp config/kivitendo.conf.default config/kivitendo.conf</programlisting>
691 <para>Die Default-Datei wird immer zuerst eingelesen. Werte, die in
692 der Hauptkonfigurationsdatei stehen, überschreiben die Werte aus der
693 Default-Datei. Die Hauptkonfigurationsdatei muss also nur die
694 Abschnitte und Werte enthalten, die von denen der Default-Datei
698 <para>Vor der Umbenennung in kivitendo hieß diese Datei noch
699 <filename>config/lx_office.conf</filename>. Aus Gründen der
700 Kompatibilität wird diese Datei eingelesen, sofern die Datei
701 <filename>config/kivitendo.conf</filename> nicht existiert.</para>
704 <para>Diese Hauptkonfigurationsdatei ist dann eine
705 installationsspezifische Datei, d.h. sie enthält bspw. lokale
706 Passwörter und wird auch nicht im Versionsmanagement (git)
709 <para>Die Konfiguration ist ferner serverabhängig, d.h. für alle
710 Mandaten, bzw. Datenbanken gleich.</para>
713 <sect2 id="config.config-file.sections-parameters">
714 <title>Abschnitte und Parameter</title>
716 <para>Die Konfigurationsdatei besteht aus mehreren Teilen, die
717 entsprechend kommentiert sind:</para>
721 <para><literal>authentication</literal> (siehe Abschnitt "<xref
722 linkend="Benutzerauthentifizierung-und-Administratorpasswort"/>"
723 in diesem Kapitel)</para>
727 <para><literal>authentication/database</literal></para>
731 <para><literal>authentication/ldap</literal></para>
735 <para><literal>system</literal></para>
739 <para><literal>paths</literal></para>
743 <para><literal>mail_delivery</literal> (siehe Abschnitt "<xref
744 linkend="config.sending-email.smtp"/>)</para>
748 <para><literal>applications</literal></para>
752 <para><literal>environment</literal></para>
756 <para><literal>print_templates</literal></para>
760 <para><literal>task_server</literal></para>
764 <para><literal>periodic_invoices</literal></para>
768 <para><literal>self_tests</literal></para>
772 <para><literal>console</literal></para>
776 <para><literal>testing</literal></para>
780 <para><literal>testing/database</literal></para>
784 <para><literal>debug</literal></para>
788 <para>Die üblicherweise wichtigsten Parameter, die am Anfang
789 einzustellen oder zu kontrollieren sind, sind:</para>
791 <programlisting>[authentication]
792 admin_password = geheim
794 [authentication/database]
802 default_manager = german</programlisting>
804 <para>Für kivitendo Installationen in der Schweiz sollte hier
805 <varname>german</varname> durch <varname>swiss</varname> ersetzt
808 <para>Die Einstellung <varname>default_manager = swiss</varname>
813 <para>Beim Erstellen einer neuen Datenbank in der kivitendo
814 Administration werden automatisch die Standard-Werte für die
815 Schweiz voreingestellt: Währung CHF, 5er-Rundung, Schweizer
816 KMU-Kontenplan, Sollversteuerung, Aufwandsmethode, Bilanzierung
817 (die Werte können aber manuell angepasst werden).</para>
821 <para>Einstellen der Standardkonten für Rundungserträge und
822 -aufwendungen (unter Mandantenkonfiguration → Standardkonten
827 <para>das verwendete Zahlenformat wird auf
828 <varname>1'000.00</varname> eingestellt (unter Programm →
829 Benutzereinstellungen veränderbar)</para>
833 <para>DATEV-Automatik und UStVA werden nicht angezeigt,
834 Erfolgsrechnung ersetzt GUV ( unter Mandantenkonfiguration →
835 Features veränderbar)</para>
839 <para>Nutzt man wiederkehrende Rechnungen, kann man unter
840 <varname>[periodic_invoices]</varname> den Login eines Benutzers
841 angeben, der nach Erstellung der Rechnungen eine entsprechende E-Mail
842 mit Informationen über die erstellten Rechnungen bekommt.</para>
844 <para>kivitendo bringt eine eigene Komponente zur zeitgesteuerten
845 Ausführung bestimmter Aufgaben mit, den <link
846 linkend="config.task-server">Task-Server</link>. Er wird u.a. für
847 Features wie die <link
848 linkend="features.periodic-invoices">wiederkehrenden Rechnungen</link>
849 benötigt, erledigt aber auch andere erforderliche Aufgaben und muss
850 daher in Betrieb genommen werden. Seine Einrichtung wird im Abschnitt
851 <link linkend="config.task-server">Task-Server</link> genauer
854 <para>Für Entwickler finden sich unter <varname>[debug]</varname>
855 wichtige Funktionen, um die Fehlersuche zu erleichtern.</para>
858 <sect2 id="config.config-file.prior-versions">
859 <title>Versionen vor 2.6.3</title>
861 <para>In älteren kivitendo Versionen gab es im Verzeichnis
862 <filename>config</filename> die Dateien
863 <filename>authentication.pl</filename> und
864 <filename>lx-erp.conf</filename>, die jeweils Perl-Dateien waren. Es
865 gab auch die Möglichkeit, eine lokale Version der Konfigurationsdatei
866 zu erstellen (<filename>lx-erp-local.conf</filename>). Dies ist ab
867 2.6.3 nicht mehr möglich, aber auch nicht mehr nötig.</para>
869 <para>Beim Update von einer kivitendo-Version vor 2.6.3 auf 2.6.3 oder
870 jünger müssen die Einstellungen aus den alten Konfigurationsdateien
871 manuell übertragen und die alten Konfigurationsdateien anschließend
872 gelöscht oder verschoben werden. Ansonsten zeigt kivitendo eine
873 entsprechende Fehlermeldung an.</para>
877 <sect1 id="Anpassung-der-PostgreSQL-Konfiguration">
878 <title>Anpassung der PostgreSQL-Konfiguration</title>
880 <para>PostgreSQL muss auf verschiedene Weisen angepasst werden.</para>
881 <para>Dies variert je nach eingesetzter Distribution, da distributionsabhängig unterschiedliche Strategien beim Upgrade der Postgres Version eingesetzt werden.
882 Als Hinweis einige Links zu den drei Distribution (Stand Dezember 2018):</para>
885 <para><ulink url="https://fedoraproject.org/wiki/PostgreSQL">Fedora (Postgres-Installation unter Fedora)</ulink></para>
888 <para><ulink url="https://help.ubuntu.com/lts/serverguide/postgresql.html">Ubuntu (Infos für Postgres für die aktuelle LTS Version)</ulink></para>
891 <para><ulink url="https://de.opensuse.org/PostgreSQL">OpenSuSE (aktuell nur bis Version OpenSuSE 13 verifiziert)</ulink></para>
894 <sect2 id="Zeichensätze-die-Verwendung-von-UTF-8">
895 <title>Zeichensätze/die Verwendung von Unicode/UTF-8</title>
897 <para>kivitendo setzt zwingend voraus, dass die Datenbank
898 Unicode/UTF-8 als Encoding einsetzt. Bei aktuellen
899 Serverinstallationen braucht man hier meist nicht einzugreifen.</para>
901 <para>Das Encoding des Datenbankservers kann überprüft werden. Ist das
902 Encoding der Datenbank "template1" "Unicode" bzw. "UTF-8", so braucht
903 man nichts weiteres diesbezüglich unternehmen. Zum Testen:</para>
905 <programlisting>su postgres
907 exit </programlisting>
909 <para>Andernfalls ist es notwendig, einen neuen Datenbankcluster mit
910 Unicode-Encoding anzulegen und diesen zu verwenden. Unter Debian und
911 Ubuntu kann dies z.B. für PostgreSQL 9.3 mit dem folgenden Befehl
914 <programlisting>pg_createcluster --locale=de_DE.UTF-8 --encoding=UTF-8 9.3 clustername</programlisting>
916 <para>Die Datenbankversionsnummer muss an die tatsächlich verwendete
917 Versionsnummer angepasst werden.</para>
919 <para>Unter anderen Distributionen gibt es ähnliche Methoden.</para>
921 <para>Das Encoding einer Datenbank kann in <command>psql</command> mit
922 <literal>\l</literal> geprüft werden.</para>
925 <sect2 id="Änderungen-an-Konfigurationsdateien">
926 <title>Änderungen an Konfigurationsdateien</title>
928 <para>In der Datei <filename>postgresql.conf</filename>, die je nach
929 Distribution in verschiedenen Verzeichnissen liegen kann (z.B.
930 <filename>/var/lib/pgsql/data/</filename> oder
931 <filename>/etc/postgresql/</filename>), muss sichergestellt werden,
932 dass TCP/IP-Verbindungen aktiviert sind. Das Verhalten wird über den
933 Parameter <varname>listen_address</varname> gesteuert. Laufen
934 PostgreSQL und kivitendo auf demselben Rechner, so kann dort der Wert
935 <literal>localhost</literal> verwendet werden. Andernfalls müssen
936 Datenbankverbindungen auch von anderen Rechnern aus zugelassen werden,
937 was mit dem Wert <literal>*</literal> geschieht.</para>
939 <para>In der Datei <filename>pg_hba.conf</filename>, die im gleichen
940 Verzeichnis wie die <filename>postgresql.conf</filename> zu finden
941 sein sollte, müssen die Berechtigungen für den Zugriff geändert
942 werden. Hier gibt es mehrere Möglichkeiten. Sinnvoll ist es nur die
943 nötigen Verbindungen immer zuzulassen, für eine lokal laufende
944 Datenbank zum Beispiel:</para>
946 <programlisting>local all kivitendo password
947 host all kivitendo 127.0.0.1 255.255.255.255 password</programlisting>
950 <sect2 id="Erweiterung-für-servergespeicherte-Prozeduren">
951 <title>Erweiterung für servergespeicherte Prozeduren</title>
953 <para>In der Datenbank <literal>template1</literal> muss die
954 Unterstützung für servergespeicherte Prozeduren eingerichet werden.
955 Melden Sie sich dafür als Benutzer “postgres” an der Datenbank an:
956 <programlisting>su - postgres
957 psql template1</programlisting> führen Sie die folgenden Kommandos aus:</para>
959 <programlisting>CREATE EXTENSION IF NOT EXISTS plpgsql;
963 <para><literal>CREATE EXTENSION</literal> ist seit Version 9.1 die
964 bevorzugte Syntax um die Sprache <literal>plpgsql</literal>
965 anzulegen. In diesen Versionen ist die Extension meist auch schon
966 vorhanden. Sollten Sie eine ältere Version von Postgres haben,
967 benutzen Sie stattdessen den folgenden Befehl.</para>
969 <programlisting>CREATE LANGUAGE 'plpgsql';
974 <sect2 id="Erweiterung-für-trigram">
975 <title>Erweiterung für Trigram Prozeduren</title>
977 <para>Ab Version 3.5.1 wird die Trigram-Index-Erweiterung benötigt.
978 Diese wird mit dem SQL-Updatescript
979 sql/Pg-upgrade2/trigram_extension.sql und Datenbank-Super-Benutzer
980 Rechten automatisch installiert. Dazu braucht der
981 DatenbankSuperbenutzer "postgres" ein Passwort.</para>
983 <programlisting>su - postgres
990 <para>Benutzername Postgres und Passwort können jetzt beim Anlegen
991 einer Datenbank bzw. bei Updatescripten, die SuperuserRechte
992 benötigen, eingegeben werden.</para>
995 <para><literal>pg_trgm</literal> ist je nach Distribution nicht im
996 Standard-Paket von Postgres enthalten. Ein <programlisting>select * from pg_available_extensions where name ='pg_trgm';</programlisting>
997 in template1 sollte entsprechend erfolgreich sein. Andernfalls muss
998 das Paket nachinstalliert werden, bspw. bei debian/ubuntu
999 <programlisting>apt install postgresql-contrib</programlisting></para>
1003 <sect2 id="Datenbankbenutzer-anlegen">
1004 <title>Datenbankbenutzer anlegen</title>
1006 <para>Wenn Sie nicht den Datenbanksuperuser “postgres” zum Zugriff
1007 benutzen wollen, so sollten Sie bei PostgreSQL einen neuen Benutzer
1008 anlegen. Ein Beispiel, wie Sie einen neuen Benutzer anlegen
1011 <para>Die Frage, ob der neue User Superuser sein soll, können Sie mit
1012 nein beantworten, genauso ist die Berechtigung neue User (Roles) zu
1013 generieren nicht nötig.</para>
1015 <programlisting>su - postgres
1016 createuser -d -P kivitendo
1017 exit</programlisting>
1019 <para>Wenn Sie später einen Datenbankzugriff konfigurieren, verändern
1020 Sie den evtl. voreingestellten Benutzer “postgres” auf “kivitendo”
1021 bzw. den hier gewählten Benutzernamen.</para>
1025 <sect1 id="Apache-Konfiguration">
1026 <title>Webserver-Konfiguration</title>
1029 <title>Grundkonfiguration mittels CGI</title>
1032 <para>Für einen deutlichen Performanceschub sorgt die Ausführung
1033 mittels FastCGI/FCGI. Die Einrichtung wird ausführlich im Abschnitt
1034 <xref linkend="Apache-Konfiguration.FCGI"/> beschrieben.</para>
1037 <para>Der Zugriff auf das Programmverzeichnis muss in der Apache
1038 Webserverkonfigurationsdatei <literal>httpd.conf</literal> eingestellt
1039 werden. Fügen Sie den folgenden Abschnitt dieser Datei oder einer
1040 anderen Datei hinzu, die beim Starten des Webservers eingelesen
1043 <programlisting>AliasMatch ^/kivitendo-erp/[^/]+\.pl /var/www/kivitendo-erp/dispatcher.pl
1044 Alias /kivitendo-erp/ /var/www/kivitendo-erp/
1046 <Directory /var/www/kivitendo-erp>
1047 AddHandler cgi-script .pl
1048 Options ExecCGI Includes FollowSymlinks
1051 <Directory /var/www/kivitendo-erp/users>
1053 </Directory></programlisting>
1055 <para>Ersetzen Sie dabei die Pfade durch diejenigen, in die Sie vorher
1056 das kivitendo-Archiv entpacket haben.</para>
1059 <para>Vor den einzelnen Optionen muss bei einigen Distributionen ein
1060 Plus ‘<literal>+</literal>’ gesetzt werden.</para>
1062 <para>Bei einigen Distribution (Ubuntu ab 14.04, Debian ab 8.2) muss
1063 noch explizit das cgi-Modul mittels <programlisting>a2enmod cgi</programlisting>
1064 aktiviert werden.</para>
1067 <para>Auf einigen Webservern werden manchmal die Grafiken und
1068 Style-Sheets nicht ausgeliefert. In solchen Fällen hat es oft
1069 geholfen, die folgende Option in die Konfiguration aufzunehmen:</para>
1071 <programlisting>EnableSendfile Off</programlisting>
1074 <sect2 id="Apache-Konfiguration.FCGI"
1075 xreflabel="Konfiguration für FastCGI/FCGI">
1076 <title>Konfiguration für FastCGI/FCGI</title>
1078 <sect3 id="Apache-Konfiguration.FCGI.WasIstEs">
1079 <title>Was ist FastCGI?</title>
1081 <para>Direkt aus <ulink
1082 url="http://de.wikipedia.org/wiki/FastCGI">Wikipedia</ulink>
1085 <para><citation> FastCGI ist ein Standard für die Einbindung
1086 externer Software zur Generierung dynamischer Webseiten in einem
1087 Webserver. FastCGI ist vergleichbar zum Common Gateway Interface
1088 (CGI), wurde jedoch entwickelt, um dessen Performance-Probleme zu
1089 umgehen. </citation></para>
1092 <sect3 id="Apache-Konfiguration.FCGI.Warum">
1093 <title>Warum FastCGI?</title>
1095 <para>Perl Programme (wie kivitendo eines ist) werden nicht statisch
1096 kompiliert. Stattdessen werden die Quelldateien bei jedem Start
1097 übersetzt, was bei kurzen Laufzeiten einen Großteil der Laufzeit
1098 ausmacht. Während SQL Ledger einen Großteil der Funktionalität in
1099 einzelne Module kapselt, um immer nur einen kleinen Teil laden zu
1100 müssen, ist die Funktionalität von kivitendo soweit gewachsen, dass
1101 immer mehr Module auf den Rest des Programms zugreifen. Zusätzlich
1102 benutzen wir umfangreiche Bibliotheken um Funktionaltät nicht selber
1103 entwickeln zu müssen, die zusätzliche Ladezeit kosten. All dies
1104 führt dazu dass ein kivitendo Aufruf der Kernmasken mittlerweile
1105 deutlich länger dauert als früher, und dass davon 90% für das Laden
1106 der Module verwendet wird.</para>
1108 <para>Mit FastCGI werden nun die Module einmal geladen, und danach
1109 wird nur die eigentliche Programmlogik ausgeführt.</para>
1112 <sect3 id="Apache-Konfiguration.FCGI.WebserverUndPlugin">
1113 <title>Getestete Kombinationen aus Webservern und Plugin</title>
1115 <para>Folgende Kombinationen sind getestet:</para>
1119 <para>Apache 2.4.7 (Ubuntu 14.04.2 LTS) und mod_fcgid.</para>
1122 <para>Apache 2.4.18 (Ubuntu 16.04 LTS) und mod_fcgid</para>
1125 <para>Apache 2.4.29 (Ubuntu 18.04 LTS) und mod_fcgid</para>
1129 <para>Als Perl Backend wird das Modul <filename>FCGI.pm</filename>
1133 <para>FCGI-Versionen ab 0.69 und bis zu 0.71 inklusive sind extrem
1134 strict in der Behandlung von Unicode, und verweigern bestimmte
1135 Eingaben von kivitendo. Falls es Probleme mit Umlauten in Ihrer
1136 Installation gibt, muss zwingend Version 0.68 oder aber Version
1137 0.72 und neuer eingesetzt werden.</para>
1139 <para>Mit <ulink url="http://www.cpan.org">CPAN</ulink> lässt sie
1140 sich die Vorgängerversion wie folgt installieren:</para>
1142 <programlisting>force install M/MS/MSTROUT/FCGI-0.68.tar.gz</programlisting>
1146 <sect3 id="Apache-Konfiguration.FCGI.Konfiguration">
1147 <title>Konfiguration des Webservers</title>
1149 <para>Bevor Sie versuchen, eine kivitendo Installation unter FCGI
1150 laufen zu lassen, empfiehlt es sich die Installation ersteinmal
1151 unter CGI aufzusetzen. FCGI macht es nicht einfach Fehler zu
1152 debuggen die beim ersten aufsetzen auftreten können. Sollte die
1153 Installation schon funktionieren, lesen Sie weiter.</para>
1155 <para>Zuerst muss das FastCGI-Modul aktiviert werden. Dies kann
1156 unter Debian/Ubuntu z.B. mit folgendem Befehl geschehen:</para>
1158 <programlisting>a2enmod fcgid</programlisting>
1160 <para>Die Konfiguration für die Verwendung von kivitendo mit FastCGI
1161 erfolgt durch Anpassung der vorhandenen <function>Alias</function>-
1162 und <function>Directory</function>-Direktiven. Dabei wird zwischen
1163 dem Installationspfad von kivitendo im Dateisystem
1164 ("<filename>/path/to/kivitendo-erp</filename>") und der URL
1165 unterschieden, unter der kivitendo im Webbrowser erreichbar ist
1166 ("<filename>/url/for/kivitendo-erp</filename>").</para>
1168 <para>Folgender Konfigurationsschnipsel funktioniert mit
1171 <programlisting>AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fcgi
1172 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
1174 <Directory /path/to/kivitendo-erp>
1176 Options ExecCGI Includes FollowSymlinks
1180 <DirectoryMatch /path/to/kivitendo-erp/users>
1182 </DirectoryMatch></programlisting>
1185 <para>Wer einen älteren Apache als Version 2.4 im Einsatz hat,
1186 muss entsprechend die Syntax der Directorydirektiven verändert.
1189 <programlisting>Require all granted</programlisting>
1191 <para>muß man Folgendes einstellen:</para>
1195 Allow from All </programlisting>
1197 <para>und statt</para>
1199 <programlisting>Require all denied</programlisting>
1201 <para>muss stehen:</para>
1205 Deny from All </programlisting>
1208 <para>Seit mod_fcgid-Version 2.3.6 gelten sehr kleine Grenzen für
1209 die maximale Größe eines Requests. Diese sollte wie folgt
1210 hochgesetzt werden:</para>
1212 <programlisting>FcgidMaxRequestLen 10485760</programlisting>
1214 <para>Das Ganze sollte dann so aussehen:</para>
1216 <programlisting>AddHandler fcgid-script .fpl
1217 AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
1218 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
1219 FcgidMaxRequestLen 10485760
1221 <Directory /path/to/kivitendo-erp>
1223 Options ExecCGI Includes FollowSymlinks
1227 <DirectoryMatch /path/to/kivitendo-erp/users>
1229 </DirectoryMatch></programlisting>
1231 <para>Hierdurch wird nur ein zentraler Dispatcher gestartet. Alle
1232 Zugriffe auf die einzelnen Scripte werden auf diesen umgeleitet.
1233 Dadurch, dass zur Laufzeit öfter mal Scripte neu geladen werden,
1234 gibt es hier kleine Performance-Einbußen.</para>
1236 <para>Es ist möglich, die gleiche kivitendo Version parallel unter
1237 CGI und FastCGI zu betreiben. Dafür bleiben die Directorydirektiven
1238 wie oben beschrieben, die URLs werden aber umgeleitet:</para>
1240 <programlisting># Zugriff über CGI
1241 Alias /url/for/kivitendo-erp /path/to/kivitendo-erp
1243 # Zugriff mit mod_fcgid:
1244 AliasMatch ^/url/for/kivitendo-erp-fcgid/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
1245 Alias /url/for/kivitendo-erp-fcgid/ /path/to/kivitendo-erp/</programlisting>
1247 <para>Dann ist unter <filename>/url/for/kivitendo-erp/</filename>
1248 die normale Version erreichbar, und unter
1249 <constant>/url/for/kivitendo-erp-fcgid/</constant> die
1250 FastCGI-Version.</para>
1255 <title>Authentifizierung mittels HTTP Basic Authentication</title>
1258 Kivitendo unterstützt, dass Benutzerauthentifizierung über den Webserver mittels des »Basic«-HTTP-Authentifizierungs-Schema erfolgt
1259 (siehe <ulink url="https://tools.ietf.org/html/rfc7617">RFC 7617</ulink>). Dazu ist es aber nötig, dass der dabei vom Client
1260 mitgeschickte Header <constant>Authorization</constant> vom Webserver an Kivitendo über die Umgebungsvariable
1261 <constant>HTTP_AUTHORIZATION</constant> weitergegeben wird, was standardmäßig nicht der Fall ist. Für Apache kann dies über die
1262 folgende Konfigurationsoption aktiviert werden:
1265 <programlisting>SetEnvIf Authorization "(.*)" HTTP_AUTHORIZATION=$1</programlisting>
1269 <title>Weitergehende Konfiguration</title>
1271 <para>Für einen deutlichen Sicherheitsmehrwert sorgt die Ausführung
1272 von kivitendo nur über https-verschlüsselten Verbindungen, sowie
1273 weiteren Zusatzmassnahmen, wie beispielsweise Basic Authenticate. Die
1274 Konfigurationsmöglichkeiten sprengen allerdings den Rahmen dieser
1275 Anleitung, hier ein Hinweis auf einen entsprechenden <ulink
1276 url="http://redmine.kivitendo-premium.de/boards/1/topics/142">Foreneintrag
1277 (Stand Sept. 2015)</ulink> und einen aktuellen (Stand Mai 2017) <ulink
1278 url="https://mozilla.github.io/server-side-tls/ssl-config-generator/">
1279 SSL-Konfigurations-Generator</ulink>.</para>
1283 <sect1 id="config.task-server">
1284 <title>Der Task-Server</title>
1286 <para>Der Task-Server ist ein Prozess, der im Hintergrund läuft, in
1287 regelmäßigen Abständen nach abzuarbeitenden Aufgaben sucht und diese zu
1288 festgelegten Zeitpunkten abarbeitet (ähnlich wie Cron). Dieser Prozess
1289 wird u.a. für die Erzeugung der wiederkehrenden Rechnungen und weitere
1290 essenzielle Aufgaben benutzt.</para>
1292 <para>Der Task-Server muss einmalig global in der Konfigurationsdatei
1293 konfiguriert werden. Danach wird er für jeden Mandanten, für den er
1294 laufen soll, in der Adminsitrationsmaske eingeschaltet.</para>
1296 <para>Beachten Sie, dass der Task-Server in den Boot-Vorgang Ihres
1297 Servers integriert werden muss, damit er automatisch gestartet wird.
1298 Dies kann kivitendo nicht für Sie erledigen.</para>
1300 <para>Da der Task-Server als Perlscript läuft, wird Arbeitsspeicher, der
1301 einmal benötigt wurde, nicht mehr an das Betriebssystem zurückgegeben,
1302 solange der Task-Server läuft. Dies kann dazu führen, dass ein länger
1303 laufender Task-Server mit der Zeit immer mehr Arbeitsspeicher für sich
1304 beansprucht. Es ist deshalb sinnvoll, dass der Task-Server in
1305 regelmässigen Abständen neu gestartet wird. Allerdings berücksichtigt der
1306 Task-Server ein Memory-Limit, wenn dieses in der Konfigurationsdatei
1307 angegeben ist. Bei Überschreiten dieses Limits beendet sich der
1308 Task-Server. Sofern der Task-Server als systemd-Service mit dem
1309 mitgelieferten Skript eingerichtet wurde, startet dieser danach
1310 automatisch erneut.</para>
1312 <sect2 id="Konfiguration-des-Task-Servers">
1313 <title>Verfügbare und notwendige Konfigurationsoptionen</title>
1315 <para>Die Konfiguration erfolgt über den Abschnitt
1316 <literal>[task_server]</literal> in der Datei
1317 <filename>config/kivitendo.conf</filename>. Die dort verfügbaren
1318 Optionen sind:</para>
1322 <term><varname>run_as</varname></term>
1325 <para>Wird der Server vom Systembenutzer <literal>root</literal>
1326 gestartet, so wechselt er auf den mit <literal>run_as</literal>
1327 angegebenen Systembenutzer. Der Systembenutzer muss dieselben
1328 Lese- und Schreibrechte haben, wie auch der Webserverbenutzer
1330 linkend="Manuelle-Installation-des-Programmpaketes"/>). Daher
1331 ist es erforderlich, hier denselben Systembenutzer einzutragen,
1332 unter dem auch der Webserver läuft.</para>
1337 <term><varname>debug</varname></term>
1340 <para>Schaltet Debug-Informationen an und aus.</para>
1346 <sect2 id="Konfiguration-der-Mandanten-fuer-den-Task-Servers">
1347 <title>Konfiguration der Mandanten für den Task-Server</title>
1349 <para>Ist der Task-Server grundlegend konfiguriert, so muss
1350 anschließend jeder Mandant, für den der Task-Server laufen soll,
1351 einmalig konfiguriert werden. Dazu kann in der Maske zum Bearbeiten
1352 von Mandanten im Administrationsbereich eine kivitendo-Benutzerkennung
1353 ausgewählt werden, unter der der Task-Server seine Arbeit
1356 <para>Ist in dieser Einstellung keine Benutzerkennung ausgewählt, so
1357 wird der Task-Server für diesen Mandanten keine Aufgaben
1361 <sect2 id="Einbinden-in-den-Boot-Prozess">
1362 <title>Automatisches Starten des Task-Servers beim Booten</title>
1364 <para>Der Task-Server verhält sich von seinen Optionen her wie ein
1365 reguläres SystemV-kompatibles Boot-Script. Außerdem wechselt er beim
1366 Starten automatisch in das kivitendo-Installationsverzeichnis.</para>
1368 <para>Deshalb ist es möglich, ihn durch Setzen eines symbolischen
1369 Links aus einem der Runlevel-Verzeichnisse heraus in den Boot-Prozess
1370 einzubinden. Da das bei neueren Linux-Distributionen aber nicht
1371 zwangsläufig funktioniert, werden auch Start-Scripte mitgeliefert, die
1372 anstelle eines symbolischen Links verwendet werden können.</para>
1375 <title>SystemV-basierende Systeme (z.B. ältere Debian, ältere
1376 openSUSE, ältere Fedora)</title>
1378 <para>Kopieren Sie die Datei
1379 <filename>scripts/boot/system-v/kivitendo-task-server</filename>
1380 nach <filename>/etc/init.d/kivitendo-task-server</filename>. Passen
1381 Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
1382 <literal>DAEMON=....</literal>). Binden Sie das Script in den
1383 Boot-Prozess ein. Dies ist distributionsabhängig:</para>
1387 <para>Debian-basierende Systeme:</para>
1389 <programlisting>update-rc.d kivitendo-task-server defaults
1390 insserv kivitendo-task-server</programlisting>
1394 <para>Ältere openSUSE und ältere Fedora:</para>
1396 <programlisting>chkconfig --add kivitendo-task-server</programlisting>
1400 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
1403 <programlisting>/etc/init.d/kivitendo-task-server start</programlisting>
1407 <title>Upstart-basierende Systeme (z.B. Ubuntu bis 14.04)</title>
1409 <para>Kopieren Sie die Datei
1410 <filename>scripts/boot/upstart/kivitendo-task-server.conf</filename>
1411 nach <filename>/etc/init/kivitendo-task-server.conf</filename>.
1412 Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
1413 <literal>exec ....</literal>).</para>
1415 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
1418 <programlisting>service kivitendo-task-server start</programlisting>
1422 <title>systemd-basierende Systeme (z.B. neure openSUSE, neuere
1423 Fedora, neuere Ubuntu und neuere Debians)</title>
1425 <para>Kopieren Sie die Datei
1426 <filename>scripts/boot/systemd/kivitendo-task-server.service</filename>
1427 nach <filename>/etc/systemd/system/</filename>. Passen Sie in der
1428 kopierten Datei den Pfad zum Task-Server an (Zeilen
1429 <literal>ExecStart=....</literal> und
1430 <literal>ExecStop=...</literal>).</para>
1432 <para>Machen Sie anschließend das Script systemd bekannt, und binden
1433 Sie es in den Boot-Prozess ein. Dazu führen Sie die folgenden Befehl
1436 <programlisting>systemctl daemon-reload
1437 systemctl enable kivitendo-task-server.service</programlisting>
1439 <para>Wenn Sie den Task-Server jetzt sofort starten möchten, anstatt
1440 den Server neu zu starten, so können Sie das mit dem folgenden
1443 <programlisting>systemctl start kivitendo-task-server.service</programlisting>
1445 <para>Ein so eingerichteter Task-Server startet nach Beendigung
1446 automatisch erneut. Das betrifft eine Beendigung über die Oberfläche,
1447 eine Beendingung über die Prozesskontrolle und eine Beendigung bei
1448 Überschreiten des Memory-Limits. Soll der Task-Server nicht erneut
1449 starten, so können Sie ihn mit folgendem Befehl stoppen:</para>
1451 <programlisting>systemctl stop kivitendo-task-server.service</programlisting>
1456 <sect2 id="Prozesskontrolle">
1457 <title>Wie der Task-Server gestartet und beendet wird</title>
1459 <para>Der Task-Server wird wie folgt kontrolliert:</para>
1461 <programlisting>./scripts/task_server.pl Befehl</programlisting>
1463 <para><literal>Befehl</literal> ist dabei eine der folgenden
1468 <para><literal>start</literal> startet eine neue Instanz des
1469 Task-Servers. Die Prozess-ID wird innerhalb des
1470 <filename>users</filename>-Verzeichnisses abgelegt.</para>
1474 <para><literal>stop</literal> beendet einen laufenden
1479 <para><literal>restart</literal> beendet und startet ihn
1484 <para><literal>status</literal> berichtet, ob der Task-Server
1489 <para>Der Task-Server wechselt beim Starten automatisch in das
1490 kivitendo-Installationsverzeichnis.</para>
1492 <para>Dieselben Optionen können auch für die SystemV-basierenden
1493 Runlevel-Scripte benutzt werden (siehe oben).</para>
1495 <para>Wurde der Task-Server als systemd-Service eingerichtet (s.o.),
1496 so startet dieser nach Beendigung automatisch erneut.</para>
1499 <sect2 id="Tasks konfigurieren">
1500 <title>Exemplarische Konfiguration eines Hintergrund-Jobs, der die Jahreszahl in allen Nummernkreisen zum Jahreswechsel erhöht</title>
1502 <para>Hintergrund-Jobs werden über System -> Hintergrund-Jobs und Task-Server -> Aktuelle Hintergrund-Jobs anzeigen -> Aktions-Knopf 'erfassen' angelegt. </para>
1503 <para>Nachdem wir über das Menü dort angelangt sind, legen wir unseren exemplarischen Hintergrund-Jobs "Erhöhung der Nummernkreise" mit folgenden Werten an:</para>
1506 <para><literal>Aktiv:</literal> Hier ein 'Ja' auswählen</para>
1509 <para><literal>Ausführungsart:</literal> 'wiederholte Ausführung' auswählen</para>
1512 <para><literal>Paketname:</literal> 'SetNumberRange' auswählen</para>
1515 <para><literal>Ausführungszeitplan:</literal> Hier entsprechend Werte wie in der crontab eingeben.</para><para>Syntax:</para>
1516 <programlisting>* * * * *
1519 │ │ │ │ └──── Wochentag (0-7, Sonntag ist 0 oder 7)
1520 │ │ │ └────── Monat (1-12)
1521 │ │ └──────── Tag (1-31)
1522 │ └────────── Stunde (0-23)
1523 └──────────── Minute (0-59) </programlisting>
1524 <para>Die Sterne können folgende Werte haben:</para>
1532 5 = Wochentag (0-7, Sonntag ist 0 oder 7)
1534 <para>Um die Ausführung auf eine Minute vor Sylvester zu setzen, müssen die folgenden Werte eingetragen werden:</para>
1535 <programlisting>59 23 31 12 *</programlisting>
1538 <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>
1540 multiplier Nummernkreis 2020
1545 <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>
1546 <literal>Daten:</literal><programlisting>multiplier: 100
1547 digits_year: 4</programlisting>
1552 <sect1 id="Benutzerauthentifizierung-und-Administratorpasswort">
1553 <title>Benutzerauthentifizierung und Administratorpasswort</title>
1555 <para>Informationen über die Einrichtung der Benutzerauthentifizierung,
1556 über die Verwaltung von Gruppen und weitere Einstellungen</para>
1558 <sect2 id="Grundlagen-zur-Benutzerauthentifizierung">
1559 <title>Grundlagen zur Benutzerauthentifizierung</title>
1561 <para>kivitendo verwaltet die Benutzerinformationen in einer
1562 Datenbank, die im folgenden “Authentifizierungsdatenbank” genannt
1563 wird. Für jeden Benutzer kann dort eine eigene Datenbank für die
1564 eigentlichen Finanzdaten hinterlegt sein. Diese beiden Datenbanken
1565 können, müssen aber nicht unterschiedlich sein.</para>
1567 <para>Im einfachsten Fall gibt es für kivitendo nur eine einzige
1568 Datenbank, in der sowohl die Benutzerinformationen als auch die Daten
1569 abgelegt werden.</para>
1571 <para>Zusätzlich ermöglicht es kivitendo, dass die Benutzerpasswörter gegen die Authentifizierungsdatenbank oder gegen einen oder
1572 mehrere LDAP-Server überprüft werden.</para>
1574 <para>Welche Art der Passwortüberprüfung kivitendo benutzt und wie
1575 kivitendo die Authentifizierungsdatenbank erreichen kann, wird in der
1576 Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1577 festgelegt. Diese muss bei der Installation und bei einem Upgrade von
1578 einer Version vor v2.6.0 angelegt werden. Eine
1579 Beispielkonfigurationsdatei
1580 <filename>config/kivitendo.conf.default</filename> existiert, die als
1581 Vorlage benutzt werden kann.</para>
1584 <sect2 id="Administratorpasswort">
1585 <title>Administratorpasswort</title>
1587 <para>Das Passwort, das zum Zugriff auf das Administrationsinterface
1588 von kivitendo benutzt wird, wird ebenfalls in dieser Datei
1589 gespeichert. Es kann auch nur dort und nicht mehr im
1590 Administrationsinterface selber geändert werden. Der Parameter dazu
1591 heißt <varname>admin_password</varname> im Abschnitt
1592 <varname>[authentication]</varname>.</para>
1595 <sect2 id="Authentifizierungsdatenbank">
1596 <title>Authentifizierungsdatenbank</title>
1598 <para>Die Verbindung zur Authentifizierungsdatenbank wird mit den
1599 Parametern in <varname>[authentication/database]</varname>
1600 konfiguriert. Hier sind die folgenden Parameter anzugeben:</para>
1604 <term><literal>host</literal></term>
1607 <para>Der Rechnername oder die IP-Adresse des
1608 Datenbankservers</para>
1613 <term><literal>port</literal></term>
1616 <para>Die Portnummer des Datenbankservers, meist 5432</para>
1621 <term><literal>db</literal></term>
1624 <para>Der Name der Authentifizierungsdatenbank</para>
1629 <term><literal>user</literal></term>
1632 <para>Der Benutzername, mit dem sich kivitendo beim
1633 Datenbankserver anmeldet (z.B.
1634 "<literal>postgres</literal>")</para>
1639 <term><literal>password</literal></term>
1642 <para>Das Passwort für den Datenbankbenutzer</para>
1647 <para>Die Datenbank muss noch nicht existieren. kivitendo kann sie
1648 automatisch anlegen (mehr dazu siehe unten).</para>
1651 <sect2 id="Passwortüberprüfung">
1652 <title>Passwortüberprüfung</title>
1654 <para>kivitendo unterstützt Passwortüberprüfung auf zwei Arten: gegen
1655 die Authentifizierungsdatenbank und gegen externe LDAP- oder
1656 Active-Directory-Server. Welche davon benutzt wird, regelt der
1657 Parameter <varname>module</varname> im Abschnitt
1658 <varname>[authentication]</varname>.</para>
1660 <para>Dieser Parameter listet die zu verwendenden Authentifizierungsmodule auf. Es muss mindestens ein Modul angegeben werden, es
1661 können aber auch mehrere angegeben werden. Weiterhin ist es möglich, das LDAP-Modul mehrfach zu verwenden und für jede Verwendung
1662 eine unterschiedliche Konfiguration zu nutzen, z.B. um einen Fallback-Server anzugeben, der benutzt wird, sofern der Hauptserver
1663 nicht erreichbar ist.</para>
1665 <para>Sollen die Benutzerpasswörter in der Authentifizierungsdatenbank geprüft werden, so muss der Parameter
1666 <varname>module</varname> das Modul <literal>DB</literal> enthalten. Sofern das Modul in der Liste enthalten ist, egal an welcher
1667 Position, können sowohl der Administrator als auch die Benutzer selber ihre Passwörter in kivitendo ändern.</para>
1669 <para>Wenn Passwörter gegen einen oder mehrere externe LDAP- oder Active-Directory-Server geprüft werden, so muss der Parameter
1670 <varname>module</varname> den Wert <literal>LDAP</literal> enthalten. In diesem Fall müssen zusätzliche Informationen über den
1671 LDAP-Server im Abschnitt <literal>[authentication/ldap]</literal> angegeben werden. Das Modul kann auch mehrfach angegeben werden,
1672 wobei jedes Modul eine eigene Konfiguration bekommen sollte. Der Name der Konfiguration wird dabei mit einem Doppelpunkt getrennt an
1673 den Modulnamen angehängt (<literal>LDAP:Name-der-Konfiguration</literal>). Der entsprechende Abschnitt in der Konfigurationsdatei
1674 lautet dann <literal>[authentication/Name-der-Konfiguration]</literal>.</para>
1676 <para>Die verfügbaren Parameter für die LDAP-Konfiguration lauten:</para>
1680 <term><literal>host</literal></term>
1683 <para>Der Rechnername oder die IP-Adresse des LDAP- oder
1684 Active-Directory-Servers. Diese Angabe ist zwingend
1685 erforderlich.</para>
1690 <term><literal>port</literal></term>
1693 <para>Die Portnummer des LDAP-Servers; meist 389.</para>
1698 <term><literal>tls</literal></term>
1701 <para>Wenn Verbindungsverschlüsselung gewünscht ist, so diesen
1702 Wert auf ‘<literal>1</literal>’ setzen, andernfalls auf
1703 ‘<literal>0</literal>’ belassen</para>
1708 <term><literal>verify</literal></term>
1711 <para>Wenn Verbindungsverschlüsselung gewünscht und der Parameter <parameter>tls</parameter> gesetzt ist, so gibt dieser
1712 Parameter an, ob das Serverzertifikat auf Gültigkeit geprüft wird. Mögliche Werte sind <literal>require</literal> (Zertifikat
1713 wird überprüft und muss gültig sei; dies ist der Standard) und <literal>none</literal> (Zertifikat wird nicht
1719 <term><literal>attribute</literal></term>
1722 <para>Das LDAP-Attribut, in dem der Benutzername steht, den der
1723 Benutzer eingegeben hat. Für Active-Directory-Server ist dies
1724 meist ‘<literal>sAMAccountName</literal>’, für andere
1725 LDAP-Server hingegen ‘<literal>uid</literal>’. Diese Angabe ist
1726 zwingend erforderlich.</para>
1731 <term><literal>base_dn</literal></term>
1734 <para>Der Abschnitt des LDAP-Baumes, der durchsucht werden soll.
1735 Diese Angabe ist zwingend erforderlich.</para>
1740 <term><literal>filter</literal></term>
1743 <para>Ein optionaler LDAP-Filter. Enthält dieser Filter das Wort
1744 <literal><%login%></literal>, so wird dieses durch den vom
1745 Benutzer eingegebenen Benutzernamen ersetzt. Andernfalls wird
1746 der LDAP-Baum nach einem Element durchsucht, bei dem das oben
1747 angegebene Attribut mit dem Benutzernamen identisch ist.</para>
1752 <term><literal>bind_dn</literal> und
1753 <literal>bind_password</literal></term>
1756 <para>Wenn der LDAP-Server eine Anmeldung erfordert, bevor er
1757 durchsucht werden kann (z.B. ist dies bei
1758 Active-Directory-Servern der Fall), so kann diese hier angegeben
1759 werden. Für Active-Directory-Server kann als
1760 ‘<literal>bind_dn</literal>’ entweder eine komplette LDAP-DN wie
1761 z.B. ‘<literal>cn=Martin
1762 Mustermann,cn=Users,dc=firmendomain</literal>’ auch nur der
1763 volle Name des Benutzers eingegeben werden; in diesem Beispiel
1764 also ‘<literal>Martin Mustermann</literal>’.</para>
1769 <term><literal>timeout</literal></term>
1772 <para>Timeout beim Verbindungsversuch, bevor der Server als nicht erreichbar gilt; Standardwert: 10</para>
1778 <sect2 id="Name-des-Session-Cookies">
1779 <title>Name des Session-Cookies</title>
1781 <para>Sollen auf einem Server mehrere kivitendo-Installationen
1782 aufgesetzt werden, so müssen die Namen der Session-Cookies für alle
1783 Installationen unterschiedlich sein. Der Name des Cookies wird mit dem
1784 Parameter <varname>cookie_name</varname> im Abschnitt
1785 <varname>[authentication]</varname>gesetzt.</para>
1787 <para>Diese Angabe ist optional, wenn nur eine Installation auf dem
1788 Server existiert.</para>
1791 <sect2 id="Anlegen-der-Authentifizierungsdatenbank">
1792 <title>Anlegen der Authentifizierungsdatenbank</title>
1794 <para>Nachdem alle Einstellungen in
1795 <filename>config/kivitendo.conf</filename> vorgenommen wurden, muss
1796 kivitendo die Authentifizierungsdatenbank anlegen. Dieses geschieht
1797 automatisch, wenn Sie sich im Administrationsmodul anmelden, das unter
1798 der folgenden URL erreichbar sein sollte:</para>
1801 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
1805 <sect1 id="Benutzer--und-Gruppenverwaltung">
1806 <title>Mandanten-, Benutzer- und Gruppenverwaltung</title>
1808 <para>Nach der Installation müssen Mandanten, Benutzer, Gruppen und
1809 Datenbanken angelegt werden. Dieses geschieht im Administrationsmenü,
1810 das Sie unter folgender URL finden:</para>
1813 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
1815 <para>Verwenden Sie zur Anmeldung das Passwort, das Sie in der Datei
1816 <filename>config/kivitendo.conf</filename> eingetragen haben.</para>
1818 <sect2 id="Zusammenhänge">
1819 <title>Zusammenhänge</title>
1821 <para>kivitendo verwaltet zwei Sets von Daten, die je nach Einrichtung
1822 in einer oder zwei Datenbanken gespeichert werden.</para>
1824 <para>Das erste Set besteht aus Anmeldeinformationen: welche Benutzer
1825 und Mandanten gibt es, welche Gruppen, welche BenutzerIn hat Zugriff
1826 auf welche Mandanten, und welche Gruppe verfügt über welche Rechte.
1827 Diese Informationen werden in der Authentifizierungsdatenbank
1828 gespeichert. Dies ist diejenige Datenbank, deren Verbindungsparameter
1829 in der Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1830 gespeichert werden.</para>
1832 <para>Das zweite Set besteht aus den eigentlichen Verkehrsdaten eines
1833 Mandanten, wie beispielsweise die Stammdaten (Kunden, Lieferanten,
1834 Waren) und Belege (Angebote, Lieferscheine, Rechnungen). Diese werden
1835 in einer Mandantendatenbank gespeichert. Die Verbindungsinformationen
1836 einer solchen Mandantendatenbank werden im Administrationsbereich
1837 konfiguriert, indem man einen Mandanten anlegt und dort die Parameter
1838 einträgt. Dabei hat jeder Mandant eine eigene Datenbank.</para>
1840 <para>Aufgrund des Datenbankdesigns ist es für einfache Fälle möglich,
1841 die Authentifizierungsdatenbank und eine der Mandantendatenbanken in
1842 ein und derselben Datenbank zu speichern. Arbeitet man hingegen mit
1843 mehr als einem Mandanten, wird empfohlen, für die
1844 Authentifizierungsdatenbank eine eigene Datenbank zu verwenden, die
1845 nicht gleichzeitig für einen Mandanten verwendet wird.</para>
1848 <sect2 id="Mandanten-Benutzer-Gruppen">
1849 <title>Mandanten, Benutzer und Gruppen</title>
1851 <para>kivitendos Administration kennt Mandanten, Benutzer und Gruppen,
1852 die sich frei zueinander zuordnen lassen.</para>
1854 <para>kivitendo kann mehrere Mandaten aus einer Installation heraus
1855 verwalten. Welcher Mandant benutzt wird, kann direkt beim Login
1856 ausgewählt werden. Für jeden Mandanten wird ein eindeutiger Name
1857 vergeben, der beim Login angezeigt wird. Weiterhin benötigt der
1858 Mandant Datenbankverbindungsparameter für seine Mandantendatenbank.
1859 Diese sollte über die <link
1860 linkend="Datenbanken-anlegen">Datenbankverwaltung</link>
1863 <para>Ein Benutzer ist eine Person, die Zugriff auf kivitendo erhalten
1864 soll. Sie erhält einen Loginnamen sowie ein Passwort. Weiterhin legt
1865 der Administrator fest, an welchen Mandanten sich ein Benutzer
1866 anmelden kann, was beim Login verifiziert wird.</para>
1868 <para>Gruppen dienen dazu, Benutzern innerhalb eines Mandanten Zugriff
1869 auf bestimmte Funktionen zu geben. Einer Gruppe werden dafür vom
1870 Administrator gewisse Rechte zugeordnet. Weiterhin legt der
1871 Administrator fest, für welche Mandanten eine Gruppe gilt, und welche
1872 Benutzer Mitglieder in dieser Gruppe sind. Meldet sich ein Benutzer
1873 dann an einem Mandanten an, so erhält er alle Rechte von allen
1874 denjenigen Gruppen, die zum Einen dem Mandanten zugeordnet sind und in
1875 denen der Benutzer zum Anderen Mitglied ist,</para>
1877 <para>Die Reihenfolge, in der Datenbanken, Mandanten, Gruppen und
1878 Benutzer angelegt werden, kann im Prinzip beliebig gewählt werden. Die
1879 folgende Reihenfolge beinhaltet die wenigsten Arbeitsschritte:</para>
1881 <orderedlist numeration="arabic">
1883 <para>Datenbank anlegen</para>
1887 <para>Gruppen anlegen</para>
1891 <para>Benutzer anlegen und Gruppen als Mitglied zuordnen</para>
1895 <para>Mandanten anlegen und Gruppen sowie Benutzer zuweisen</para>
1900 <sect2 id="Datenbanken-anlegen">
1901 <title>Datenbanken anlegen</title>
1903 <para>Zuerst muss eine Datenbank angelegt werden. Verwenden Sie für
1904 den Datenbankzugriff den vorhin angelegten Benutzer (in unseren
1905 Beispielen ist dies ‘<literal>kivitendo</literal>’).</para>
1908 <sect2 id="Gruppen-anlegen">
1909 <title>Gruppen anlegen</title>
1911 <para>Eine Gruppe wird in der Gruppenverwaltung angelegt. Ihr muss ein
1912 Name gegeben werden, eine Beschreibung ist hingegen optional. Nach dem
1913 Anlegen können Sie die verschiedenen Bereiche wählen, auf die
1914 Mitglieder dieser Gruppe Zugriff haben sollen.</para>
1916 <para>Benutzergruppen werden zwar in der Authentifizierungsdatenbank
1917 gespeichert, gelten aber nicht automatisch für alle Mandanten. Der
1918 Administrator legt vielmehr fest, für welche Mandanten eine Gruppe
1919 gültig ist. Dies kann entweder beim Bearbeiten der Gruppe geschehen
1920 ("diese Gruppe ist gültig für Mandanten X, Y und Z"), oder aber wenn
1921 man einen Mandanten bearbeitet ("für diesen Mandanten sind die Gruppen
1922 A, B und C gültig").</para>
1924 <para>Wurden bereits Benutzer angelegt, so können hier die Mitglieder
1925 dieser Gruppe festgelegt werden ("in dieser Gruppe sind die Benutzer
1926 X, Y und Z Mitglieder"). Dies kann auch nachträglich beim Bearbeiten
1927 eines Benutzers geschehen ("dieser Benutzer ist Mitglied in den
1928 Gruppen A, B und C").</para>
1931 <sect2 id="Benutzer-anlegen">
1932 <title>Benutzer anlegen</title>
1934 <para>Beim Anlegen von Benutzern werden für viele Parameter
1935 Standardeinstellungen vorgenommen, die den Gepflogenheiten des
1936 deutschen Raumes entsprechen.</para>
1938 <para>Zwingend anzugeben ist der Loginname. Wenn die
1939 Passwortauthentifizierung über die Datenbank eingestellt ist, so kann
1940 hier auch das Benutzerpasswort gesetzt bzw. geändert werden. Ist
1941 hingegen die LDAP-Authentifizierung aktiv, so ist das Passwort-Feld
1944 <para>Hat man bereits Mandanten und Gruppen angelegt, so kann hier
1945 auch konfiguriert werden, auf welche Mandanten der Benutzer Zugriff
1946 hat bzw. in welchen Gruppen er Mitglied ist. Beide Zuweisungen können
1947 sowohl beim Benutzer vorgenommen werden ("dieser Benutzer hat Zugriff
1948 auf Mandanten X, Y, Z" bzw. "dieser Benutzer ist Mitglied in Gruppen
1949 X, Y und Z") als auch beim Mandanten ("auf diesen Mandanten haben
1950 Benutzer A, B und C Zugriff") bzw. bei der Gruppe ("in dieser Gruppe
1951 sind Benutzer A, B und C Mitglieder").</para>
1954 <sect2 id="Mandanten-anlegen">
1955 <title>Mandanten anlegen</title>
1957 <para>Ein Mandant besteht aus Administrationssicht primär aus einem
1958 eindeutigen Namen. Weiterhin wird hier hinterlegt, welche Datenbank
1959 als Mandantendatenbank benutzt wird. Hier müssen die Zugriffsdaten
1960 einer der eben angelegten Datenbanken eingetragen werden.</para>
1962 <para>Hat man bereits Benutzer und Gruppen angelegt, so kann hier auch
1963 konfiguriert werden, welche Benutzer Zugriff auf den Mandanten haben
1964 bzw. welche Gruppen für den Mandanten gültig sind. Beide Zuweisungen
1965 können sowohl beim Mandanten vorgenommen werden ("auf diesen Mandanten
1966 haben Benutzer X, Y und Z Zugriff" bzw. "für diesen Mandanten sind die
1967 Gruppen X, Y und Z gültig") als auch beim Benutzer ("dieser Benutzer
1968 hat Zugriff auf Mandanten A, B und C") bzw. bei der Gruppe ("diese
1969 Gruppe ist für Mandanten A, B und C gültig").</para>
1973 <sect1 id="Drucker--Systemverwaltung">
1974 <title>Drucker- und Systemverwaltung</title>
1976 <para>Im Administrationsmenü gibt es ferner noch die beiden Menüpunkte
1977 Druckeradministration und System.</para>
1979 <sect2 id="Druckeradministration">
1980 <title>Druckeradministration</title>
1982 <para>Unter dem Menüpunkt Druckeradministration lassen sich beliebig
1983 viele "Druckbefehle" im System verwalten. Diese Befehle werden
1984 mandantenweise zugeordnet. Unter Druckerbeschreibung wird der Namen
1985 des Druckbefehls festgelegt, der dann in der Druckerauswahl des Belegs
1986 angezeigt wird.</para>
1988 <para>Unter Druckbefehl definiert man den eigentlichen Druckbefehl,
1989 der direkt auf dem Webserver ausgeführt wird, bspw. 'lpr -P
1990 meinDrucker' oder ein kompletter Pfad zu einem Skript
1991 (/usr/local/src/kivitendo/scripts/pdf_druck_in_verzeichnis.sh). Wird
1992 ferner noch ein optionales Vorlagenkürzel verwendet, wird dieses
1993 Kürzel bei der Auswahl der Druckvorlagendatei mit einem Unterstrich
1994 ergänzt, ist bspw. das Kürzel 'epson_drucker' definiert, so wird beim
1995 Ausdruck eines Angebots folgende Vorlage geparst:
1996 sales_quotation_epson_drucker.tex.</para>
2000 <title>System sperren / entsperren</title>
2002 <para>Unter dem Menüpunkt System gibt es den Eintrag 'Installation
2003 sperren/entsperren'. Setzt man diese Sperre so ist der Zugang zu der
2004 gesamten kivitendo Installation gesperrt.</para>
2006 <para>Falls die Sperre gesetzt ist, erscheint anstelle der
2007 Anmeldemaske die Information: 'kivitendo ist momentan zwecks
2008 Wartungsarbeiten nicht zugänglich.'.</para>
2010 <para>Wichtig zu erwähnen ist hierbei noch, dass sich kivitendo
2011 automatisch 'sperrt', falls es bei einem Versionsupdate zu einem
2012 Datenbankfehler kam. Somit kann hier nicht aus Versehen mit einem
2013 inkonsistenten Datenbestand weitergearbeitet werden.</para>
2017 <sect1 id="config.sending-email"
2018 xreflabel="E-Mail-Versand aus kivitendo heraus">
2019 <title>E-Mail-Versand aus kivitendo heraus</title>
2021 <para>kivitendo kann direkt aus dem Programm heraus E-Mails versenden,
2022 z.B. um ein Angebot direkt an einen Kunden zu verschicken. Damit dies
2023 funktioniert, muss eingestellt werden, über welchen Server die E-Mails
2024 verschickt werden sollen. kivitendo unterstützt dabei zwei Mechanismen:
2025 Versand über einen lokalen E-Mail-Server (z.B. mit
2026 <productname>Postfix</productname> oder <productname>Exim</productname>,
2027 was auch die standardmäßig aktive Methode ist) sowie Versand über einen
2028 SMTP-Server (z.B. der des eigenen Internet-Providers).</para>
2030 <para>Welche Methode und welcher Server verwendet werden, wird über die
2031 Konfigurationsdatei <filename>config/kivitendo.conf</filename>
2032 festgelegt. Dort befinden sich alle Einstellungen zu diesem Thema im
2033 Abschnitt '<literal>[mail_delivery]</literal>'.</para>
2035 <sect2 id="config.sending-email.sendmail"
2036 xreflabel="E-Mail-Versand über lokalen E-Mail-Server">
2037 <title>Versand über lokalen E-Mail-Server</title>
2039 <para>Diese Methode bietet sich an, wenn auf dem Server, auf dem
2040 kivitendo läuft, bereits ein funktionsfähiger E-Mail-Server wie z.B.
2041 <productname>Postfix</productname>, <productname>Exim</productname>
2042 oder <productname>Sendmail</productname> läuft.</para>
2044 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter
2045 '<literal>method = sendmail</literal>' gesetzt sein. Dies ist
2046 gleichzeitig der Standardwert, falls er nicht verändert wird.</para>
2048 <para>Um zu kontrollieren, wie das Programm zum Einliefern gestartet
2049 wird, dient der Parameter '<literal>sendmail = ...</literal>'. Der
2050 Standardwert verweist auf das Programm
2051 <filename>/usr/bin/sendmail</filename>, das bei allen oben genannten
2052 E-Mail-Serverprodukten für diesen Zweck funktionieren sollte.</para>
2054 <para>Die Konfiguration des E-Mail-Servers selber würde den Rahmen
2055 dieses sprengen. Hierfür sei auf die Dokumentation des E-Mail-Servers
2059 <sect2 id="config.sending-email.smtp"
2060 xreflabel="E-Mail-Versand über einen SMTP-Server">
2061 <title>Versand über einen SMTP-Server</title>
2063 <para>Diese Methode bietet sich an, wenn kein lokaler E-Mail-Server
2064 vorhanden oder zwar einer vorhanden, dieser aber nicht konfiguriert
2067 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter
2068 '<literal>method = smtp</literal>' gesetzt sein. Die folgenden
2069 Parameter dienen dabei der weiteren Konfiguration:</para>
2073 <term><varname>hostname</varname></term>
2076 <para>Name oder IP-Adresse des SMTP-Servers. Standardwert:
2077 '<literal>localhost</literal>'</para>
2082 <term><varname>port</varname></term>
2085 <para>Portnummer. Der Standardwert hängt von der verwendeten
2086 Verschlüsselungsmethode ab. Gilt '<literal>security =
2087 none</literal>' oder '<literal>security = tls</literal>', so ist
2088 25 die Standardportnummer. Für '<literal>security =
2089 ssl</literal>' ist 465 die Portnummer. Muss normalerweise nicht
2090 geändert werden.</para>
2095 <term><varname>security</varname></term>
2098 <para>Wahl der zu verwendenden Verschlüsselung der Verbindung
2099 mit dem Server. Standardwert ist '<literal>none</literal>',
2100 wodurch keine Verschlüsselung verwendet wird. Mit
2101 '<literal>tls</literal>' wird TLS-Verschlüsselung eingeschaltet,
2102 und mit '<literal>ssl</literal>' wird Verschlüsselung via SSL
2103 eingeschaltet. Achtung: Für '<literal>tls</literal>' und
2104 '<literal>ssl</literal>' werden zusätzliche Perl-Module benötigt
2105 (siehe unten).</para>
2110 <term><varname>login</varname> und
2111 <varname>password</varname></term>
2114 <para>Falls der E-Mail-Server eine Authentifizierung verlangt,
2115 so können mit diesen zwei Parametern der Benutzername und das
2116 Passwort angegeben werden. Wird Authentifizierung verwendet, so
2117 sollte aus Sicherheitsgründen auch eine Form von Verschlüsselung
2118 aktiviert werden.</para>
2125 <sect1 id="Drucken-mit-kivitendo">
2126 <title>Drucken mit kivitendo</title>
2128 <para>Das Drucksystem von kivitendo benutzt von Haus aus LaTeX-Vorlagen.
2129 Um drucken zu können, braucht der Server ein geeignetes LaTeX System. Am
2130 einfachsten ist dazu eine <literal>texlive</literal> Installation. Unter
2131 debianoiden Betriebssystemen installiert man die Pakete mit:</para>
2133 <para><programlisting>apt install texlive-base-bin texlive-latex-recommended texlive-fonts-recommended \
2134 texlive-latex-extra texlive-lang-german texlive-generic-extra texlive-xetex ghostscript</programlisting></para>
2136 <para>Für Fedora benötigen Sie die folgenden Pakete:</para>
2138 <para><programlisting>dnf install texlive-collection-latex texlive-collection-latexextra \
2139 texlive-collection-latexrecommended texlive-collection-langgerman \
2140 texlive-collection-langenglish</programlisting></para>
2142 <para>Für openSUSE benötigen Sie die folgenden Pakete:</para>
2144 <para><programlisting>zypper install texlive-collection-latex texlive-collection-latexextra \
2145 texlive-collection-latexrecommended texlive-collection-langgerman \
2146 texlive-collection-langenglish</programlisting></para>
2148 <para>kivitendo bringt drei alternative Vorlagensätze mit:</para>
2160 <para>rev-odt</para>
2164 <para>Der ehemalige Druckvorlagensatz "Standard" wurde mit der Version
2165 3.3 entfernt, da er nicht mehr gepflegt wurde.</para>
2167 <sect2 id="Vorlagenverzeichnis-anlegen"
2168 xreflabel="Vorlagenverzeichnis anlegen">
2169 <title>Vorlagenverzeichnis anlegen</title>
2171 <para>Es lässt sich ein initialer Vorlagensatz erstellen. Die
2172 LaTeX-System-Abhängigkeiten hierfür kann man prüfen mit:</para>
2174 <programlisting>./scripts/installation_check.pl -lv</programlisting>
2176 <para>Der Angemeldete Benutzer muss in einer Gruppe sein, die über das
2177 Recht "Konfiguration -> Mandantenverwaltung" verfügt. Siehe auch
2178 <xref linkend="Gruppen-anlegen"/>.</para>
2180 <para>Im Userbereich lässt sich unter: "<guimenu>System</guimenu>
2181 -> <guisubmenu>Mandantenverwaltung</guisubmenu> ->
2182 <guimenuitem>Verschiedenes</guimenuitem>" die Option "Neue
2183 Druckvorlagen aus Vorlagensatz erstellen" auswählen.</para>
2187 <para><option>Vorlagen auswählen</option>: Wählen Sie hier den
2188 Vorlagensatz aus, der kopiert werden soll
2189 (<filename>RB</filename>, <filename>f-tex</filename> oder
2190 <filename>odt-rev</filename>.)</para>
2194 <para><option>Neuer Name</option>: Der Verzeichnisname für den
2195 neuen Vorlagensatz. Dieser kann im Rahmen der üblichen Bedingungen
2196 für Verzeichnisnamen frei gewählt werden.</para>
2200 <para>Nach dem Speichern wird das Vorlagenverzeichnis angelegt und ist
2201 für den aktuellen Mandanten ausgewählt. Der gleiche Vorlagensatz kann,
2202 wenn er mal angelegt ist, bei mehreren Mandanten verwendet werden.
2203 Eventuell müssen Anpassungen (Logo, Erscheinungsbild, etc) noch
2204 vorgenommen werden. Den Ordner findet man im Dateisystem unter
2205 <filename>./templates/[Neuer Name]</filename></para>
2208 <sect2 id="Vorlagen-RB">
2209 <title>Der Druckvorlagensatz RB</title>
2211 <para>Hierbei handelt es sich um einen vollständigen LaTeX
2212 Dokumentensatz mit alternativem Design. Die odt oder html-Varianten
2213 sind nicht gepflegt.</para>
2215 <para>Die konzeptionelle Idee der Vorlagen wird <ulink
2216 url="http://www.kivitendo-support.de/vortraege/Lx-Office%20Anwendertreffen%20LaTeX-Druckvorlagen-Teil3-finale.pdf">hier</ulink>
2217 auf Folie 5 bis 10 vorgestellt. Informationen zur Anpassung an die
2218 eigenen Firmendaten finden sich in der Datei Readme.tex im
2219 Vorlagenverzeichnis.</para>
2221 <para>Eine kurze Übersicht der Features:</para>
2225 <para>Mehrsprachenfähig, mit Deutscher und Englischer
2230 <para>Zentrale Konfigurationsdateien, die für alle Belege benutzt
2231 werden, z.B. für Kopf- und Fußzeilen, und Infos wie
2236 <para>mehrere vordefinierte Varianten für
2237 Logos/Hintergrundbilder</para>
2241 <para>Berücksichtigung für Steuerzonen "EU mit USt-ID Nummer" oder
2242 "Außerhalb EU"</para>
2248 <title>f-tex</title>
2250 <para>Ein Vorlagensatz, der in wenigen Minuten alle Dokumente zur
2251 Verfügung stellt.</para>
2253 <sect3 id="f-tex-Feature-Übersicht">
2254 <title>Feature-Übersicht</title>
2258 <para>Keine Redundanz. Es wird ein- und dieselbe LaTeX-Vorlage
2259 für alle briefartigen Dokumente verwendet. Also Angebot,
2260 Rechnung, Proformarechnung, Lieferschein, aber eben nicht für
2261 Paketaufkleber etc.</para>
2265 <para>Leichte Anpassung an das Firmen-Layout durch Verwendung
2266 eines Hintergrund-PDFs. Dieses kann leicht mit dem eigenen
2267 Lieblingsprogramm erstellt werden (Openoffice, Inkscape, Gimp,
2272 <para>Hintergrund-PDF umschaltbar auf "nur erste Seite"
2273 (Standard) oder "alle Seiten" (Option
2274 "<option>bgPdfFirstPageOnly</option>" in Datei
2275 <filename>letter.lco</filename>)</para>
2279 <para>Hintergrund-PDF für Ausdruck auf bereits bedrucktem
2280 Briefpapier abschaltbar. Es wird dann nur bei per E-Mail
2281 versendeten Dokumenten eingebunden (Option
2282 "<option>bgPdfEmailOnly</option>" in Datei
2283 <filename>letter.lco</filename>).</para>
2287 <para>Nutzung der Layout-Funktionen von LaTeX für Seitenumbruch,
2288 Wiederholung von Kopfzeilen, Zwischensummen etc. (danke an
2289 Kai-Martin Knaak für die Vorarbeit)</para>
2293 <para>Anzeige des Empfängerlandes im Adressfeld nur, wenn es vom
2294 Land des eigenen Unternehmens abweicht (also die Rechnung das
2295 Land verlässt).</para>
2299 <para>Multisprachfähig leicht um weitere Sprachen zu erweitern,
2300 alle Übersetzungen in der Datei
2301 <filename>translatinos.tex</filename>.</para>
2305 <para>Auflistung von Bruttopreisen für Endverbraucher.</para>
2310 <sect3 id="f-tex-Installation">
2311 <title>Die Installation</title>
2315 <para>Vorlagenverzeichnis mit Option f-tex anlegen, siehe: <xref
2316 linkend="Vorlagenverzeichnis-anlegen"/>. Das Vorlagensystem
2317 funktioniert jetzt schon, hat allerdings noch einen
2318 Beispiel-Briefkopf.</para>
2322 <para>Erstelle eine pdf-Hintergrund Datei und verlinke sie nach
2323 <filename>./letter_head.pdf</filename>.</para>
2327 <para>Editiere den Bereich "<option>settings</option>" in der
2328 datei <filename>letter.lco</filename>.</para>
2332 <para>oder etwas detaillierter:</para>
2334 <para>Es wird eine Datei <filename>sample.lco</filename> erstellt
2335 und diese nach <filename>letter.lco</filename> verlinkt. Eigentlich
2336 ist dies die Datei die für die firmenspezifischen Anpassungen
2337 gedacht ist. Da die Einstiegshürde in LaTeX nicht ganz niedrig ist,
2338 wird in dieser Datei auf ein Hintergrund-PDF verwiesen. Ich empfehle
2339 über dieses PDF die persönlichen Layoutanpassungen vorzunehmen und
2340 <filename>sample.lco</filename> unverändert zu lassen. Die Anpassung
2341 über eine <filename>*.lco</filename>-Datei, die letztlich auf
2342 <filename>letter.lco</filename> verlinkt ist ist aber auch
2345 <para>Es wird eine Datei <filename>sample_head.pdf</filename> mit
2346 ausgeliefert, diese wird nach <filename>letter_head.pdf</filename>
2347 verlinkt. Damit gibt es schon mal eine funktionsfähige Vorlage.
2348 Schau Dir nach Abschluss der Installation die Datei
2349 <filename>sample_head.pdf</filename> an und erstelle ein
2350 entsprechendes PDF passend zum Briefkopf Deiner Firma, diese dann im
2351 Template Verzeichniss ablegen und statt
2352 <filename>sample_head.pdf</filename> nach
2353 <filename>letter_head.pdf</filename> verlinken.</para>
2355 <para>Letzlich muss <filename>letter_head.pdf</filename> auf das
2356 passende Hintergrund-PDF verweisen, welches gewünschten Briefkopf
2359 <para>Es wird eine Datei <filename>mydata.tex.example</filename>
2360 ausgeliefert, die nach <filename>mytdata.tex</filename> verlinkt
2361 ist. Bei verwendetem Hintergrund-PDF wird nur der Eintrag für das
2362 Land verwendet. Die Datei muss also nicht angefasst werden. Die
2363 anderen Werte sind für das Modul 'lp' (Label Print in erp - zur Zeit
2364 nicht im öffentlichen Zweig).</para>
2366 <para>Alle Anpassungen zum Briefkopf, Fusszeilen, Firmenlogos, etc.
2367 sollten über die Hintergrund-PDF-Datei oder die
2368 <filename>*.lco</filename>-Datei erfolgen.</para>
2371 <sect3 id="f-tex-Funktionsübersicht">
2372 <title>f-tex Funktionsübersicht</title>
2374 <para>Das Konzept von kivitendo sieht vor, für jedes Dokument
2375 (Auftragsbestätigung, Lieferschein, Rechnung, etc.) eine
2376 LaTeX-Vorlage vorzuhalten, dies ist sehr wartungsunfreundlich. Auch
2377 das Einlesen einer einheitlichen Quelle für den Briefkopf bringt nur
2378 bedingte Vorteile, da hier leicht die Pflege der Artikel-Tabellen
2379 aus dem Ruder läuft. Bei dem vorliegenden Ansatz wird für alle
2380 briefartigen Dokumente mit Artikel-Tabellen eine einheitliche
2381 LaTeX-Vorlage verwendet, welche über Codeweichen die Besonderheiten
2382 der jeweiligen Dokumente berücksichtigt:</para>
2386 <para>Tabellen mit oder ohne Preis</para>
2390 <para>Sprache der Tabellenüberschriften etc.</para>
2394 <para>Anpassung der Bezugs-Zeile (z.B. Rechnungsnummer versus
2395 Angebotsnummer)</para>
2399 <para>Darstellung von Brutto oder Netto-Preisen in der
2400 Auflistung (Endverbraucher versus gewerblicher Kunde)</para>
2404 <para>Nachteil:</para>
2406 <para>LaTeX hat ohnehin eine sehr steile Lehrnkurve. Die Datei
2407 <filename>letter.tex</filename> ist sehr komplex und verstärkt damit
2408 diesen Effekt noch einmal erheblich. Wer LaTeX-Erfahrung hat, oder
2409 geübt ist Scriptsparachen nachzuvollziehen kann natürlich auch
2410 innerhalb der Tabellendarstellung gut persönliche Anpassungen
2411 vornehmen. Aber man kann sich hier bei Veränderungen sehr schnell
2412 heftig in den Fuss schiessen.</para>
2414 <para>Wer nicht so tief in die Materie einsteigen will oder leicht
2415 zu frustrieren ist, sollte sein Hintergrund-PDF auf Basis der
2416 mitglieferten Datei <filename>sample_head.pdf</filename> erstellen,
2417 und sich an der Form der dargestellten Tabellen, wie sie
2418 ausgeliefert werden, erfreuen.</para>
2420 <para>Kleiner Tipp: Nicht zu viel auf einmal wollen, lieber kleine,
2421 kontinuierliche Schritte gehen.</para>
2424 <sect3 id="f-tex-Bruttopreise">
2425 <title>Bruttopreise für Endverbraucher</title>
2427 <para>Der auszuweisende Bruttopreis wird innerhalb der
2428 LaTeX-Umgebung berechnet. Es gibt zwar ein Feld, um bei Aufträgen
2429 "alle Preise Brutto" auszuwählen, aber:</para>
2433 <para>hierfür müssen die Preise auch in Brutto in der Datenbank
2434 stehen (ja - das lässt sich über die Preisgruppen und die
2435 Zuordung einer Default-Preisgruppe handhaben)</para>
2439 <para>man darf beim Anlegen des Vorgangs nicht vergessen, dieses
2440 Häkchen zu setzen. (Das ist in der Praxis, wenn man sowohl
2441 Endverbraucher als auch Gewerbekunden beliefert, der eigentliche
2446 <para>Es gibt mit f-tex eine weitere Alternative. Die Information ob
2447 Brutto oder Nettorechnung wird mit den Zahlarten verknüpft.
2448 Zahlarten bei denen Rechnungen, Angebote, etc, in Brutto ausgegeben
2449 werden sollen, enden mit "_E" (für Endverbraucher). Falls identische
2450 Zahlarten für Gewerbekunden und Endverbraucher vorhanden sind, legt
2451 man diese einfach doppelt an (einmal mit der Namensendung "_E").
2456 <para>Die Entscheidung, ob Nettopreise ausgewiesen werden, ist
2457 nicht mehr fix mit einer Preisliste verbunden.</para>
2461 <para>Die Default-Zahlart kann im Kundendatensatz hinterlegt
2462 werden, und man muss nicht mehr daran denken, "alle Preise
2463 Netto" auszuwählen.</para>
2467 <para>Die Entscheidung, ob Netto- oder Bruttopreise ausgewiesen
2468 werden, kann direkt beim Drucken revidiert werden, ohne dass
2469 sich der Auftragswert ändert.</para>
2474 <sect3 id="f-tex-lieferadressen">
2475 <title>Lieferadressen</title>
2477 <para>In Lieferscheinen kommen <varname>shipto*</varname>-Variablen
2478 im Adressfeld zum Einsatz. Wenn die
2479 <varname>shipto*</varname>-Variable leer ist, wird die entsprechende
2480 Adressvariable eingesetzt. Wenn also die Lieferadresse in Straße,
2481 Hausnummer und Ort abweicht, müssen auch nur diese Felder in der
2482 Lieferadresse ausgefüllt werden. Für den Firmenname wird der Wert
2483 der Hauptadresse angezeigt.</para>
2487 <sect2 id="Vorlagen-rev-odt">
2488 <title>Der Druckvorlagensatz rev-odt</title>
2490 <para>Hierbei handelt es sich um einen Dokumentensatz der mit
2491 odt-Vorlagen erstellt wurde. Es gibt in dem Verzeichnis eine
2492 Readme-Datei, die eventuell aktueller als die Dokumentation hier ist.
2493 Die odt-Vorlagen in diesem Verzeichnis "rev-odt" wurden von revamp-it,
2494 Zürich erstellt und werden laufend aktualisiert. Ein paar der
2495 Formulierungen in den Druckvorlagen entsprechen dem Schweizer
2496 Sprachgebrauch, z.B. "Offerte" oder "allfällig".</para>
2498 <para>Hinweis zum Einsatz des Feldes "Land" bei den Stammdaten für
2499 KundInnen und LieferantInnen, sowie bei Lieferadressen: Die in diesem
2500 Vorlagensatz vorhandenen Vorlagen erwarten für "Land" das
2501 entsprechende Kürzel, das in Adressen vor die Postleitzahl gesetzt
2502 wird. Das Feld kann auch komplett leer bleiben. Wer dies anders
2503 handhaben möchte, muss die Vorlagen entsprechend anpassen.</para>
2505 <para>odt-Vorlagen können mit LibreOffice oder OpenOffice editiert und
2506 den eigenen Bedürfnissen angepasst werden. Wichtig beim Editieren von
2507 if-Blöcken ist, dass immer der gesamte Block überschrieben werden muss
2508 und nicht nur Teile davon, da dies sonst oft zu einer odt-Datei führt,
2509 die vom Parser nicht korrekt gelesen werden kann.</para>
2511 <para>Mahnungen können unter folgenden Einschränkungen mit den
2512 odt-Vorlagen im Vorlagensatz rev-odt erzeugt werden:</para>
2516 <para>als Druckoption steht nur 'PDF(OpenDocument/OASIS)' zur
2517 Verfügung, das heisst, die Mahnungen werden als PDF-Datei
2522 <para>für jede Rechnung muss eine eigene Mahnung erzeugt werden
2523 (auch wenn bei einzelnen KundInnen mehrere überfällige Rechnungen
2524 vorhanden sind).</para>
2528 <para>Mehrere Mahnungen für eine Kundin / einen Kunden werden zu einer
2529 PDF-Datei zusammengefasst</para>
2531 <para>Die Vorlagen zahlungserinnerung.odt sowie mahnung.odt sind für
2532 das Erstellen einer Zahlungserinnerung bzw. Mahnung selbst vorgesehen,
2533 die Vorlage mahnung_invoice.odt für das Erstellen einer Rechnung über
2534 die verrechneten Mahngebühren und Verzugszinsen.</para>
2536 <para>Zur Zeit gibt es in kivitendo noch keine Möglichkeit,
2537 odt-Vorlagen bei Briefen und Pflichtenheften einzusetzen.
2538 Entsprechende Vorlagen sind deshalb nicht vorhanden.</para>
2540 <para>Fehlermeldungen, Anregungen und Wünsche bitte senden an:
2541 empfang@revamp-it.ch</para>
2544 <sect2 id="allgemeine-hinweise-zu-latex">
2545 <title>Allgemeine Hinweise zu LaTeX Vorlagen</title>
2547 <para>In den allermeisten Installationen sollte das Drucken jetzt
2548 schon funktionieren. Sollte ein Fehler auftreten, wirft TeX sehr lange
2549 Fehlerbeschreibungen, der eigentliche Fehler ist immer die erste
2550 Zeile, die mit einem Ausrufezeichen anfängt. Häufig auftretende Fehler
2551 sind zum Beispiel:</para>
2555 <para>! LaTeX Error: File `eurosym.sty' not found. Die
2556 entsprechende LaTeX-Bibliothek wurde nicht gefunden. Das tritt vor
2557 allem bei Vorlagen aus der Community auf. Installieren Sie die
2558 entsprechenden Pakete.</para>
2562 <para>! Package inputenc Error: Unicode char \u8:... set up for
2563 use with LaTeX. Dieser Fehler tritt auf, wenn sie versuchen mit
2564 einer Standardinstallation exotische utf8 Zeichen zu drucken.
2565 TeXLive unterstützt von Haus nur romanische Schriften und muss mit
2566 diversen Tricks dazu gebracht werden andere Zeichen zu
2567 akzeptieren. Adere TeX Systeme wie XeTeX schaffen hier
2572 <para>Wird gar kein Fehler angezeigt, sondern nur der Name des
2573 Templates, heißt das normalerweise, dass das LaTeX Binary nicht
2574 gefunden wurde. Prüfen Sie den Namen in der Konfiguration (Standard:
2575 <literal>pdflatex</literal>), und stellen Sie sicher, dass pdflatex
2576 (oder das von Ihnen verwendete System) vom Webserver ausgeführt werden
2579 <para>Wenn sich das Problem nicht auf Grund der Ausgabe im Webbrowser
2580 verifizieren lässt:</para>
2584 <para>editiere [kivitendo-home]/config/kivitendo.conf und ändere
2585 "keep_temp_files" auf 1</para>
2587 <para><programlisting>keep_temp_files = 1;</programlisting></para>
2591 <para>bei fastcgi oder mod_perl den Webserver neu Starten</para>
2595 <para>Nochmal einen Druckversuch im Webfrontend auslösen</para>
2599 <para>wechsel in das users Verzeichnis von kivitendo</para>
2601 <para><programlisting>cd [kivitendo-home]/users</programlisting></para>
2605 <para>LaTeX Suchpfad anpassen:</para>
2607 <para><programlisting>export TEXINPUTS=".:[kivitendo-home]/templates/[aktuelles_template_verzeichniss]:"</programlisting></para>
2611 <para>Finde heraus, welche Datei kivitendo beim letzten Durchlauf
2614 <para><programlisting>ls -lahtr ./1*.tex</programlisting></para>
2616 <para>Es sollte die letzte Datei ganz unten sein</para>
2620 <para>für besseren Hinweis auf Fehler texdatei nochmals
2623 <para><programlisting>pdflatex ./1*.tex</programlisting></para>
2625 <para>in der *.tex datei nach dem Fehler suchen.</para>
2631 <sect1 id="OpenDocument-Vorlagen">
2632 <title>OpenDocument-Vorlagen</title>
2634 <para>kivitendo unterstützt die Verwendung von Vorlagen im
2635 OpenDocument-Format, wie es LibreOffice oder OpenOffice (ab Version 2)
2636 erzeugen. kivitendo kann dabei sowohl neue OpenDocument-Dokumente als
2637 auch aus diesen direkt PDF-Dateien erzeugen. Um die Unterstützung von
2638 OpenDocument-Vorlagen zu aktivieren muss in der Datei
2639 <filename>config/kivitendo.conf</filename> die Variable
2640 <literal>opendocument</literal> im Abschnitt
2641 <literal>print_templates</literal> auf ‘<literal>1</literal>’ stehen.
2642 Dieses ist die Standardeinstellung.</para>
2644 <para>Während die Erzeugung von reinen OpenDocument-Dateien keinerlei
2645 weitere Software benötigt, wird zur Umwandlung dieser Dateien in PDF
2646 LibreOffice oder OpenOffice benötigt. Soll dieses Feature genutzt
2647 werden, so muss neben LibreOffice oder OpenOffice auch der “X virtual
2648 frame buffer” (xvfb) installiert werden. Bei Debian ist er im Paket
2649 “xvfb” enthalten. Andere Distributionen enthalten ihn in anderen
2652 <para>Nach der Installation müssen in der Datei
2653 <filename>config/kivitendo.conf</filename> im Abschnitt
2654 <literal>applications</literal> zwei weitere Variablen angepasst
2657 <para><literal>openofficeorg_writer</literal> muss den vollständigen
2658 Pfad zu LibreOffice oder OpenOffice enthalten. Dabei dürfen keine
2659 Anführungszeichen eingesetzt werden.</para>
2661 <para>Beispiel für Debian oder Ubuntu:</para>
2663 <programlisting>openofficeorg_writer = /usr/bin/libreoffice</programlisting>
2665 <para><literal>xvfb</literal> muss den Pfad zum “X virtual frame buffer”
2668 <para>Zusätzlich gibt es zwei verschiedene Arten, wie kivitendo mit
2669 LibreOffice bzw. OpenOffice kommuniziert. Die erste Variante, die
2670 benutzt wird, wenn die Variable <literal>$openofficeorg_daemon</literal>
2671 gesetzt ist, startet ein LibreOffice oder OpenOffice, das auch nach der
2672 Umwandlung des Dokumentes gestartet bleibt. Bei weiteren Umwandlungen
2673 wird dann diese laufende Instanz benutzt. Der Vorteil ist, dass die Zeit
2674 zur Umwandlung deutlich reduziert wird, weil nicht für jedes Dokument
2675 ein LibreOffice bzw. OpenOffice gestartet werden muss. Der Nachteil ist,
2676 dass diese Methode Python und die Python-UNO-Bindings benötigt, die
2677 Bestandteil von LibreOffice bzw. OpenOffice sind.</para>
2680 <para>Für die Verbindung zu LibreOffice bzw. OpenOffice wird
2681 normalerweise der Python-Interpreter
2682 <filename>/usr/bin/python</filename> benutzt. Sollte dies nicht der
2683 richtige sein, so kann man mit zwei Konfigurationsvariablen
2684 entscheiden, welcher Python-Interpreter genutzt wird. Mit der Option
2685 <literal>python_uno</literal> aus dem Abschnitt
2686 <literal>applications</literal> wird der Interpreter selber
2687 festgelegt; sie steht standardmäßig auf dem eben erwähnten Wert
2688 <literal>/usr/bin/python</literal>.</para>
2690 <para>Zusätzlich ist es möglich, Pfade anzugeben, in denen Python
2691 neben seinen normalen Suchpfaden ebenfalls nach Modulen gesucht wird,
2692 z.B. falls sich diese in einem gesonderten LibreOffice- bzw.
2693 OpenOffice-Verzeichnis befinden. Diese zweite Variable heißt
2694 <literal>python_uno_path</literal> und befindet sich im Abschnitt
2695 <literal>environment</literal>. Sie ist standardmäßig leer. Werden
2696 hier mehrere Pfade angegeben, so müssen diese durch Doppelpunkte
2697 voneinander getrennt werden. Der Inhalt wird an den Python-Interpreter
2698 über die Umgebungsvariable <literal>PYTHONPATH</literal>
2702 <para>Ist <literal>$openofficeorg_daemon</literal> nicht gesetzt, so
2703 wird für jedes Dokument LibreOffice bzw. OpenOffice neu gestartet und
2704 die Konvertierung mit Hilfe eines Makros durchgeführt. Dieses Makro muss
2705 in der Dokumentenvorlage enthalten sein und
2706 “Standard.Conversion.ConvertSelfToPDF()” heißen. Die Beispielvorlage
2707 ‘<literal>templates/print/rev-odt/invoice.odt</literal>’ enthält ein
2708 solches Makro, das in jeder anderen Dokumentenvorlage ebenfalls
2709 enthalten sein muss.</para>
2711 <para>Als letztes muss herausgefunden werden, welchen Namen OpenOffice
2712 bzw. LibreOffice dem Verzeichnis mit den Benutzereinstellungen gibt.
2713 Unter Debian ist dies momentan <literal>~/.config/libreoffice</literal>.
2714 kivitendo verwendet das Verzeichnis
2715 <literal>users/.openoffice.org2</literal>. Eventuell muss dieses
2716 Verzeichnis umbenannt werden.</para>
2718 <para>Dieses Verzeichnis, wie auch das komplette
2719 <literal>users</literal>-Verzeichnis, muss vom Webserver beschreibbar
2720 sein. Dieses wurde bereits erledigt (siehe <xref
2721 linkend="Manuelle-Installation-des-Programmpaketes"/>), kann aber erneut
2722 überprüft werden, wenn die Konvertierung nach PDF fehlschlägt.</para>
2725 <title>OpenDocument (odt) Druckvorlagen mit Makros</title>
2727 <para>OpenDocument Vorlagen können Makros enthalten, welche komplexere
2728 Aufgaben erfüllen.</para>
2730 <para>Der Vorlagensatz "rev-odt" enthält solche Vorlagen mit <emphasis
2731 role="bold">Schweizer Bank-Einzahlungsscheinen (BESR)</emphasis>.
2732 Diese Makros haben die Aufgabe, die in den Einzahlungsscheinen
2733 benötigte Referenznummer und Kodierzeile zu erzeugen. Hier eine kurze
2734 Beschreibung, wie die Makros aufgebaut sind, und was bei ihrer Nutzung
2735 zu beachten ist (<emphasis role="bold">in fett sind nötige einmalige
2736 Anpassungen aufgeführt</emphasis>):</para>
2739 <title>Bezeichnung der Vorlagen</title>
2741 <para>Rechnung: invoice_besr.odt, Auftrag:
2742 sales_order_besr.odt</para>
2746 <title>Vorbereitungen im Adminbereich</title>
2748 <para>Damit beim Erstellen von Rechnungen und Aufträgen neben der
2749 Standardvorlage ohne Einzahlungsschein weitere Vorlagen (z.B. mit
2750 Einzahlungsschein) auswählbar sind, muss für jedes Vorlagen-Suffix
2751 ein Drucker eingerichtet werden:</para>
2755 <para>Druckeradministration → Drucker hinzufügen</para>
2759 <para>Mandant wählen</para>
2763 <para>Druckerbeschreibung → aussagekräftiger Text: wird in der
2764 Auftrags- bzw. Rechnungsmaske als Auswahl angezeigt (z.B. mit
2765 Einzahlungsschein Bank xy)</para>
2769 <para>Druckbefehl → beliebiger Text (hat für das Erzeugen von
2770 Aufträgen oder Rechnungen als odt-Datei keine Bedeutung, darf
2771 aber nicht leer sein)</para>
2775 <para>Vorlagenkürzel → besr bzw. selbst gewähltes Vorlagensuffix
2776 (muss genau der Zeichenfolge entsprechen, die zwischen
2777 "invoice_" bzw. "sales_order_" und ".odt" steht.)</para>
2781 <para>speichern</para>
2787 <title>Benutzereinstellungen</title>
2789 <para>Wer den Ausdruck mit Einzahlungsschein als Standardeinstellung
2790 im Rechnungs- bzw. Auftragsformular angezeigt haben möchte, kann
2791 dies persönlich für sich bei den Benutzereinstellungen
2792 konfigurieren:</para>
2796 <para>Programm → Benutzereinstellungen → Druckoptionen</para>
2800 <para>Standardvorlagenformat → OpenDocument/OASIS</para>
2804 <para>Standardausgabekanal → Bildschirm</para>
2808 <para>Standarddrucker → gewünschte Druckerbeschreibung auswählen
2809 (z.B. mit Einzahlungsschein Bank xy)</para>
2813 <para>Anzahl Kopien → leer</para>
2817 <para>speichern</para>
2823 <title>Aufbau und nötige Anpassungen der Vorlagen</title>
2825 <para>In der Vorlage sind als Modul "BESR" 4 Makros gespeichert, die
2826 aus dem von kivitendo erzeugten odt-Dokument die korrekte
2827 Referenznummer inklusive Prüfziffer sowie die Kodierzeile in
2828 OCRB-Schrift erzeugen und am richtigen Ort ins Dokument
2833 <para>Für den Einzahlungsschein ist die letzte Seite des
2834 Dokuments reserviert</para>
2838 <para>Direkt über dem Einzahlungsschein enthält die Vorlage eine
2839 Zeile mit folgenden Angaben (<emphasis
2840 role="bold">Bank-Konto-Identifikationsnummer und
2841 Postkonto-Nummer der Bank müssen gemäss Angaben der jeweiligen
2842 Bank angepasst werden</emphasis>):<itemizedlist>
2844 <para>DDDREF: 4 Werte zum Bilden der Referenznummer
2845 (jeweils durch einen Leerschlag getrennt): <itemizedlist>
2847 <para>erster Wert: <emphasis
2848 role="bold">Bank-Konto-Identifikation</emphasis>
2849 (nur Ziffern, maximal 6), <emphasis role="bold">muss
2850 angepasst werden</emphasis>.</para>
2854 <para>zweiter Wert: <%customernumber%>
2855 (Kundennummer: nur Ziffern, maximal 6)</para>
2859 <para>dritter Wert: <%ordnumber%>
2860 (Auftragsnummer bei Auftragsvorlage
2861 sales_oder_besr.odt, sonst 0) maximal 7 Ziffern,
2862 führende Buchstaben werden vom Makro entfernt</para>
2866 <para>vierter Wert: <%invnumber%>
2867 (Rechnungsnummer bei Rechnungsvorlage
2868 invoice_besr.odt, sonst 0) maximal 7 Ziffern,
2869 führende Buchstaben werden vom Makro entfernt</para>
2871 </itemizedlist></para>
2875 <para>DDDKONTO: <emphasis role="bold">Postkonto-Nummer der
2876 Bank, muss angepasst werden</emphasis>.</para>
2880 <para>DDDBETRAG: <%total%> Einzahlungsbetrag oder 0,
2881 falls Einzahlungsschein ohne Betrag</para>
2885 <para>DDDEND: muss am Ende der Zeile vorhanden sein</para>
2887 </itemizedlist></para>
2891 <para><emphasis role="bold">Im Einzahlungsschein selbst müssen
2892 der Name und die Adresse der Bank, die Postkonto-Nummer der
2893 Bank, sowie der eigene Firmenname und die Firmenadresse
2894 angepasst werden.</emphasis> Dabei ist darauf zu achten, dass
2895 sich die Positionen der Postkonto-Nummern der Bank, sowie der
2896 Zeichenfolgen dddfr, DDDREF1, DDDREF2, 609, DDDKODIERZEILE nicht
2902 <screeninfo>Rechnungsvorlage Schweizer Bank-Einzahlungsschein - zu
2903 ändernde Einträge in rot</screeninfo>
2907 <imagedata fileref="images/Einzahlungsschein_Makro.png"/>
2914 <title>Auswahl der Druckvorlage in kivitendo beim Erzeugen einer
2915 odt-Rechnung (analog bei Auftrag)</title>
2917 <para>Im Fussbereich der Rechnungsmaske muss neben Rechnung,
2918 OpenDocument/OASIS und Bildschirm die im Adminbereich erstellte
2919 Druckerbeschreibung ausgewählt werden, falls diese nicht bereits bei
2920 den Benutzereinstellungen als persönlicher Standard gewählt
2925 <title>Makroeinstellungen in LibreOffice anpassen</title>
2927 <para>Falls beim Öffnen einer von kivitendo erzeugten odt-Rechnung
2928 die Meldung kommt, dass Makros aus Sicherheitsgründen nicht
2929 ausgeführt werden, so müssen folgende Einstellungen in LibreOffice
2930 angepasst werden:</para>
2934 <para>Extras → Optionen → Sicherheit → Makrosicherheit</para>
2938 <para>Sicherheitslevel auf "Mittel" einstellen (Diese
2939 Einstellung muss auf jedem Computer durchgeführt werden, mit dem
2940 von kivitendo erzeugte odt-Rechnungen oder Aufträge geöffnet
2945 <para>Beim Öffnen einer odt-Rechnung oder eines odt-Auftrags bei
2946 der entsprechenden Nachfrage "Makros ausführen"
2949 <para><emphasis role="bold">Wichtig</emphasis>: die Makros sind
2950 so eingestellt, dass sie beim Öffnen der Vorlagen selbst nicht
2951 ausgeführt werden. Das heisst für das Ansehen und Bearbeiten der
2952 Vorlagen sind keine speziellen Einstellungen in LibreOffice
2960 <sect1 id="nomenclature">
2961 <title>Nomenklatur</title>
2963 <sect2 id="booking.dates">
2964 <title>Datum bei Buchungen</title>
2966 <para>Seit der Version 3.5 werden für Buchungen in kivitendo
2967 einheitlich folgende Bezeichnungen verwendet:</para>
2971 <para><option>Erfassungsdatum</option> (en: <option>Entry
2972 Date</option>, code: <option>Gldate</option>)</para>
2974 <para>bezeichnet das Datum, an dem die Buchung in kivitendo
2975 erfasst wurde.</para>
2979 <para><option>Buchungsdatum</option> (en: <option>Booking
2980 Date</option>, code: <option>Transdate</option>)</para>
2982 <para>bezeichnet das buchhaltungstechnisch für eine Buchung
2983 relevante Datum</para>
2985 <para>Das <option>Rechnungsdatum</option> bei Verkaufs- und
2986 Einkaufsrechnungen entspricht dem Buchungsdatum. Das heisst, in
2987 Berichten wie dem Buchungsjournal, in denen eine Spalte
2988 <option>Buchungsdatum</option> angezeigt werden kann, erscheint
2989 hier im Fall von Rechnungen das Rechnungsdatum.</para>
2993 <para>Bezieht sich ein verbuchter Beleg auf einen Zeitpunkt, der
2994 nicht mit dem Buchungsdatum übereinstimmt, so kann dieses Datum
2995 momentan in kivitendo nur unter Bemerkungen erfasst werden.</para>
2997 <para>Möglicherweise wird für solche Fälle in einer späteren
2998 Version von kivitendo ein dritter Datumswert für Buchungen
2999 erstellt. (Beispiel: Einkaufsbeleg stammt aus einem früheren Jahr,
3000 das bereits buchhaltungstechnisch abgeschlossen wurde, und muss
3001 deshalb später verbucht werden.)</para>
3007 <sect1 id="config.eur">
3008 <title>Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung:
3011 <sect2 id="config.eur.introduction"
3012 xreflabel="Einführung in die Konfiguration zur EUR">
3013 <title>Einführung</title>
3015 <para>kivitendo besaß bis inklusive Version 2.6.3 einen
3016 Konfigurationsparameter namens <varname>eur</varname>, der sich in der
3017 Konfigurationsdatei <filename>config/kivitendo.conf</filename> (damals
3018 noch <filename>config/lx_office.conf</filename>) befand. Somit galt er
3019 für alle Mandanten, die in dieser Installation benutzt wurden.</para>
3021 <para>Mit der nachfolgenden Version wurde der Parameter zum Einen in
3022 die Mandantendatenbank verschoben und dabei auch gleich in drei
3023 Einzelparameter aufgeteilt, mit denen sich das Verhalten genauer
3024 steuern lässt.</para>
3027 <sect2 id="config.eur.parameters"
3028 xreflabel="Konfigurationsparameter für EUR">
3029 <title>Konfigurationsparameter</title>
3031 <para>Es gibt drei Parameter, die die Gewinnermittlungsart,
3032 Versteuerungsart und die Warenbuchungsmethode regeln:</para>
3036 <term><varname>profit_determination</varname></term>
3039 <para>Dieser Parameter legt die Berechnungsmethode für die
3040 Gewinnermittlung fest. Er enthält entweder
3041 <literal>balance</literal> für
3042 Betriebsvermögensvergleich/Bilanzierung oder
3043 <literal>income</literal> für die
3044 Einnahmen-Überschuss-Rechnung.</para>
3049 <term><varname>accounting_method</varname></term>
3052 <para>Dieser Parameter steuert die Buchungs- und
3053 Berechnungsmethoden für die Versteuerungsart. Er enthält
3054 entweder <literal>accrual</literal> für die Soll-Versteuerung
3055 oder <literal>cash</literal> für die Ist-Versteuerung.</para>
3060 <term><varname>inventory_system</varname></term>
3063 <para>Dieser Parameter legt die Warenbuchungsmethode fest. Er
3064 enthält entweder <literal>perpetual</literal> für die
3065 Bestandsmethode oder <literal>periodic</literal> für die
3066 Aufwandsmethode.</para>
3071 <para>Zum Vergleich der Funktionalität bis und nach 2.6.3:
3072 <varname>eur</varname> = 1 bedeutete Einnahmen-Überschuss-Rechnung,
3073 Ist-Versteuerung und Aufwandsmethode. <varname>eur</varname> = 0
3074 bedeutete hingegen Bilanzierung, Soll-Versteuerung und
3075 Bestandsmethode.</para>
3077 <para>Die Konfiguration "<varname>eur</varname>" unter
3078 <varname>[system]</varname> in der <link
3079 linkend="config.config-file">Konfigurationsdatei</link>
3080 <filename>config/kivitendo.conf</filename> wird nun nicht mehr
3081 benötigt und kann entfernt werden. Dies muss manuell geschehen.</para>
3084 <sect2 id="config.eur.setting-parameters">
3085 <title>Festlegen der Parameter</title>
3087 <para>Beim Anlegen eines neuen Mandanten bzw. einer neuen Datenbank in
3088 der Admininstration können diese Optionen nun unabhängig voneinander
3089 eingestellt werden.</para>
3091 <para>Für die Schweiz sind folgende Einstellungen üblich:
3094 <para>Sollversteuerung</para>
3098 <para>Aufwandsmethode</para>
3102 <para>Bilanzierung</para>
3104 </itemizedlist> Diese Einstellungen werden automatisch beim
3105 Erstellen einer neuen Datenbank vorausgewählt, wenn in
3106 <filename>config/kivitendo.conf</filename> unter
3107 <varname>[system]</varname> <literal>default_manager = swiss</literal>
3108 eingestellt ist.</para>
3110 <para>Beim Upgrade bestehender Mandanten wird eur ausgelesen und die
3111 Variablen werden so gesetzt, daß sich an der Funktionalität nichts
3114 <para>Die aktuelle Konfiguration wird unter Nummernkreise und
3115 Standardkonten unter dem neuen Punkt "Einstellungen" (read-only)
3116 angezeigt. Unter <guimenu>System</guimenu> →
3117 <guisubmenu>Mandantenkonfiguration</guisubmenu> können die
3118 Einstellungen auch geändert werden. Dabei ist zu beachten, dass eine
3119 Änderung vorhandene Daten so belässt und damit evtl. die Ergebnisse
3120 verfälscht. Dies gilt vor Allem für die Warenbuchungsmethode (siehe
3121 auch <link linkend="config.eur.inventory-system-perpetual">
3122 Bemerkungen zur Bestandsmethode</link>).</para>
3125 <sect2 id="config.eur.inventory-system-perpetual">
3126 <title>Bemerkungen zur Bestandsmethode</title>
3128 <para>Die Bestandsmethode ist eigentlich eine sehr elegante Methode,
3129 funktioniert in kivitendo aber nur unter bestimmten Bedingungen:
3130 Voraussetzung ist, daß auch immer alle Einkaufsrechnungen gepflegt
3131 werden, und man beim Jahreswechsel nicht mit einer leeren Datenbank
3132 anfängt, da bei jedem Verkauf anhand der gesamten Rechnungshistorie
3133 der Einkaufswert der Ware nach dem FIFO-Prinzip aus den
3134 Einkaufsrechnungen berechnet wird.</para>
3136 <para>Die Bestandsmethode kann vom Prinzip her also nur funktioneren,
3137 wenn man mit den Buchungen bei Null anfängt, und man kann auch nicht
3138 im laufenden Betrieb von der Aufwandsmethode zur Bestandsmethode
3142 <sect2 id="config.eur.knonw-issues">
3143 <title>Bekannte Probleme</title>
3145 <para>Bei bestimmten Berichten kann man derzeit noch inviduell
3146 einstellen, ob man nach Ist- oder Sollversteuerung auswertet, und es
3147 werden im Code Variablen wie $accrual oder $cash gesetzt. Diese
3148 Codestellen wurden noch nicht angepasst, sondern nur die, wo bisher
3149 die Konfigurationsvariable
3150 <varname>$::lx_office_conf{system}->{eur}</varname> ausgewertet
3153 <para>Es fehlen Hilfetext beim Neuanlegen eines Mandanten, was die
3154 Optionen bewirken, z.B. mit zwei Standardfällen.</para>
3158 <sect1 id="config.skr04-update-3804">
3159 <title>SKR04 19% Umstellung für innergemeinschaftlichen Erwerb</title>
3161 <sect2 id="config.skr04-update-3804.introduction">
3162 <title>Einführung</title>
3164 <para>Die Umsatzsteuerumstellung auf 19% für SKR04 für die
3165 Steuerschlüssel "EU ohne USt-ID Nummer" ist erst 2010 erfolgt.
3166 kivitendo beinhaltet ein Upgradeskript, das das Konto 3804 automatisch
3167 erstellt und die Steuereinstellungen korrekt einstellt. Hat der
3168 Benutzer aber schon selber das Konto 3804 angelegt, oder gab es schon
3169 Buchungen im Zeitraum nach dem 01.01.2007 auf das Konto 3803, wird das
3170 Upgradeskript vorsichtshalber nicht ausgeführt, da der Benutzer sich
3171 vielleicht schon selbst geholfen hat und mit seinen Änderungen
3172 zufrieden ist. Die korrekten Einstellungen kann man aber auch per Hand
3173 ausführen. Nachfolgend werden die entsprechenden Schritte anhand von
3174 Screenshots dargestellt.</para>
3176 <para>Für den Fall, daß Buchungen mit der Steuerschlüssel "EU ohne
3177 USt.-IdNr." nach dem 01.01.2007 erfolgt sind, ist davon auszugehen,
3178 dass diese mit dem alten Umsatzsteuersatz von 16% gebucht worden sind,
3179 und diese Buchungen sollten entsprechend kontrolliert werden.</para>
3182 <sect2 id="config.skr04-update-3804.create-chart">
3183 <title>Konto 3804 manuell anlegen</title>
3185 <para>Die folgenden Schritte sind notwendig, um das Konto manuell
3186 anzulegen und zu konfigurieren. Zuerst wird in
3187 <guimenu>System</guimenu> → <guisubmenu>Kontenübersicht</guisubmenu> →
3188 <guimenuitem>Konto erfassen</guimenuitem> das Konto angelegt.</para>
3191 <screeninfo>Konto 3804 erfassen</screeninfo>
3195 <imagedata fileref="images/skr04-update-3804/konto3804.png"/>
3200 <para>Als Zweites muss Steuergruppe 13 für Konto 3803 angepasst
3201 werden. Dazu unter <guimenu>System</guimenu> →
3202 <guisubmenu>Steuern</guisubmenu> →
3203 <guimenuitem>Bearbeiten</guimenuitem> den Eintrag mit Steuerschlüssel
3204 13 auswählen und ihn wie im folgenden Screenshot angezeigt
3208 <screeninfo>Steuerschlüssel 13 für 3803 (16%) anpassen</screeninfo>
3212 <imagedata fileref="images/skr04-update-3804/steuer3803.png"/>
3217 <para>Als Drittes wird ein neuer Eintrag mit Steuerschlüssel 13 für
3218 Konto 3804 (19%) angelegt. Dazu unter <guimenu>System</guimenu> →
3219 <guisubmenu>Steuern</guisubmenu> → <guimenuitem>Erfassen</guimenuitem>
3220 auswählen und die Werte aus dem Screenshot übernehmen.</para>
3223 <screeninfo>Steuerschlüssel 13 für 3804 (19%) anlegen</screeninfo>
3227 <imagedata fileref="images/skr04-update-3804/steuer3804.png"/>
3232 <para>Als Nächstes sind alle Konten anzupassen, die als
3233 Steuerautomatikkonto die 3803 haben, sodass sie ab dem 1.1.2007 auch
3234 Steuerautomatik auf 3804 bekommen. Dies betrifft in der
3235 Standardkonfiguration die Konten 4315 und 4726. Als Beispiel für 4315
3236 müssen Sie dazu unter <guimenu>System</guimenu> →
3237 <guisubmenu>Kontenübersicht</guisubmenu> → <guimenuitem>Konten
3238 anzeigen</guimenuitem> das Konto 4315 anklicken und die Einstellungen
3239 wie im Screenshot gezeigt vornehmen.</para>
3242 <screeninfo>Konto 4315 anpassen</screeninfo>
3246 <imagedata fileref="images/skr04-update-3804/konto4315.png"/>
3251 <para>Als Letztes sollte die Steuerliste unter
3252 <guimenu>System</guimenu> → <guisubmenu>Steuern</guisubmenu> →
3253 <guimenuitem>Bearbeiten</guimenuitem> kontrolliert werden. Zum
3254 Vergleich der Screenshot.</para>
3257 <screeninfo>Steuerliste vergleichen</screeninfo>
3261 <imagedata fileref="images/skr04-update-3804/steuerliste.png"/>
3268 <sect1 id="config.bilanz">
3269 <title>Verhalten des Bilanzberichts</title>
3271 <para>Bis Version 3.0 wurde "closedto" ("Bücher schließen zum") als
3272 Grundlage für das Startdatum benutzt. Schließt man die Bücher allerdings
3273 monatsweise führt dies zu falschen Werten.</para>
3275 <para>In der Mandantenkonfiguration kann man dieses Verhalten genau
3276 einstellen indem man:</para>
3280 <para>weiterhin closed_to benutzt (Default, es ändert sich nichts zu
3285 <para>immer den Jahresanfang nimmt (1.1. relativ zum
3290 <para>immer die letzte Eröffnungsbuchung als Startdatum nimmt</para>
3292 <para>- mit Jahresanfang als Alternative wenn es keine EB-Buchungen
3295 <para>- oder mit "alle Buchungen" als Alternative"</para>
3299 <para>mit Jahresanfang als Alternative wenn es keine EB-Buchungen
3304 <para>immer alle Buchungen seit Beginn der Datenbank nimmt</para>
3308 <para>Folgende Hinweise zu den Optionen: Das "Bücher schließen Datum"
3309 ist sinnvoll, wenn man nur komplette Jahre schließt. Bei Wirtschaftsjahr
3310 = Kalendarjahr entspricht dies aber auch dem Jahresanfang. "Alle
3311 Buchungen" kann z.B. sinnvoll sein wenn man ohne Jahresabschluß
3312 durchbucht. Eröffnungsbuchung mit "alle Buchungen" als Fallback ist z.B.
3313 sinnvoll, wenn man am sich Anfang des zweiten Buchungsjahres befindet,
3314 und noch keinen Jahreswechsel und auch noch keine EB-Buchungen hat. Bei
3315 den Optionen mit EB-Buchungen wird vorausgesetzt, daß diese immer am 1.
3316 Tag des Wirtschaftsjahres gebucht werden. Zur Sicherheit wird das
3317 Startdatum im Bilanzbericht jetzt zusätzlich zum Stichtag mit angezeigt.
3318 Das hilft auch bei der Kontrolle für den Abgleich mit der GuV bzw.
3319 Erfolgsrechnung.</para>
3322 <sect1 id="config.erfolgsrechnung">
3323 <title>Erfolgsrechnung</title>
3325 <para>Seit der Version 3.4.1 existiert in kivitendo der Bericht
3326 <emphasis role="bold"> Erfolgsrechnung</emphasis>.</para>
3328 <para>Die Erfolgsrechnung kann in der Mandantenkonfiguration unter
3329 Features an- oder abgeschaltet werden. Mit der Einstellung
3330 <varname>default_manager = swiss </varname> in der
3331 <filename>config/kivitendo.conf</filename> wird beim neu Erstellen einer
3332 Datenbank automatisch die Anzeige der Erfolgsrechnung im Menü
3333 <guimenu>Berichte </guimenu> ausgewählt und ersetzt dort die GUV.</para>
3335 <para>Im Gegensatz zur GUV werden bei der Erfolgsrechnung sämtliche
3336 Aufwands- und Erlöskonten einzeln aufgelistet (analog zur Bilanz),
3337 sortiert nach ERTRAG und AUFWAND.</para>
3339 <para>Bei den Konteneinstellungen muss bei jedem Konto, das in der
3340 Erfolgsrechnung erscheinen soll, unter <varname>Sonstige
3341 Einstellungen/Erfolgsrechnung</varname> entweder
3342 <literal>01.Ertrag</literal> oder <literal>06.Aufwand</literal>
3343 ausgewählt werden.</para>
3345 <para>Wird bei einem Erlöskonto <literal>06.Aufwand</literal>
3346 ausgewählt, so wird dieses Konto als Aufwandsminderung unter AUFWAND
3349 <para>Wird bei einem Aufwandskonto <literal>01.Ertrag</literal>
3350 ausgewählt, so wird dieses Konto als Ertragsminderung unter ERTRAG
3353 <para>Soll bei einer bereits bestehenden Buchhaltung in Zukunft
3354 zusätzlich die Erfolgsrechnung als Bericht verwendet werden, so müssen
3355 die Einstellungen zu allen Erlös- und Aufwandskonten unter
3356 <varname>Sonstige Einstellungen/Erfolgsrechnung</varname> überprüft und
3357 allenfalls neu gesetzt werden.</para>
3360 <sect1 id="config.rounding">
3361 <title>Rundung in Verkaufsbelegen</title>
3363 <para>In der Schweiz hat die kleinste aktuell benutzte Münze den Wert
3364 von 5 Rappen (0.05 CHF).</para>
3366 <para>Auch wenn im elektronischen Zahlungsverkehr Beträge mit einer
3367 Genauigkeit von 0.01 CHF verwendet werden können, ist es trotzdem nach
3368 wie vor üblich, Rechnungen mit auf 0.05 CHF gerundeten Beträgen
3369 auszustellen.</para>
3371 <para>In kivitendo kann seit der Version 3.4.1 die Einstellung für eine
3372 solche Rundung pro Mandant / Datenbank festgelegt werden.</para>
3374 <para>Die Einstellung wird beim Erstellen der Datenbank bei
3375 <literal>Genauigkeit</literal> festgelegt. Sie kann anschliessend über
3376 das Webinterface von kivitendo nicht mehr verändert werden.</para>
3378 <para>Abhängig vom Wert für <varname>default_manager</varname> in
3379 <filename>config/kivitendo.conf</filename> werden dabei folgende Werte
3380 voreingestellt:</para>
3384 <para>0.05 (default_manager = swiss)</para>
3388 <para>0.01 (default_manager = german)</para>
3392 <para>Der Wert wird in der Datenbank in der Tabelle <varname>defaults
3393 </varname>in der Spalte <varname>precision</varname> gespeichert.</para>
3395 <para>In allen Verkaufsangeboten, Verkaufsaufträgen, Verkaufsrechnungen
3396 und Verkaufsgutschriften wird der Endbetrag inkl. MWST gerundet, wenn
3397 dieser nicht der eingestellten Genauigkeit entspricht.</para>
3399 <para>Beim Buchen einer Verkaufsrechnung wird der Rundungsbetrag
3400 automatisch auf die in der Mandantenkonfiguration festgelegten
3401 Standardkonten für Rundungserträge bzw. Rundungsaufwendungen
3404 <para>(Die berechnete MWST wird durch den Rundungsbetrag nicht mehr
3407 <para>Die in den Druckvorlagen zur Verfügung stehenden Variablen
3408 <varname>quototal</varname>, <varname>ordtotal</varname> bzw.
3409 <varname>invtotal</varname> enthalten den gerundeten Betrag.</para>
3411 <para><emphasis role="bold">Achtung:</emphasis> Werden Verkaufsbelege in
3412 anderen Währungen als der Standardwährung erstellt, so muss in kivitendo
3413 ab Version 3.4.1 die Genauigkeit 0.01 verwendet werden.</para>
3415 <para>Das heisst, Firmen in der Schweiz, die teilweise
3416 Verkaufsrechnungen in Euro oder anderen Währungen erstellen wollen,
3417 müssen beim Erstellen der Datenbank als Genauigkeit 0.01 wählen und
3418 können zur Zeit die 5er Rundung noch nicht nutzen.</para>
3421 <sect1 id="config.client">
3422 <title>Einstellungen pro Mandant</title>
3424 <para>Einige Einstellungen können von einem Benutzer mit dem <link
3425 linkend="Zusammenhänge">Recht</link> "Administration (Für die Verwaltung
3426 der aktuellen Instanz aus einem Userlogin heraus)" gemacht werden. Diese
3427 Einstellungen sind dann für die aktuellen Mandanten-Datenbank gültig.
3428 Die Einstellungen sind unter <guimenu>System</guimenu> →
3429 <guisubmenu>Mandantenkonfiguration</guisubmenu> erreichbar.</para>
3431 <para>Bitte beachten Sie die Hinweise zu den einzelnen Einstellungen.
3432 Einige Einstellungen sollten nicht ohne Weiteres im laufenden Betrieb
3433 geändert werden (siehe auch <link
3434 linkend="config.eur.inventory-system-perpetual">Bemerkungen zu
3435 Bestandsmethode</link>).</para>
3437 <para>Die Einstellungen <literal>show_bestbefore</literal> und
3438 <literal>payments_changeable</literal> aus dem Abschnitt
3439 <literal>features</literal> und die Einstellungen im Abschnitt
3440 <literal>datev_check</literal> (sofern schon vorhanden) der <link
3441 linkend="config.config-file">kivitendo-Konfigurationsdatei</link> werden
3442 bei einem Datenbankupdate einer älteren Version automatisch übernommen.
3443 Diese Einträge können danach aus der Konfigurationsdatei entfernt
3447 <sect1 id="kivitendo-ERP-verwenden">
3448 <title>kivitendo ERP verwenden</title>
3450 <para>Nach erfolgreicher Installation ist der Loginbildschirm unter
3451 folgender URL erreichbar:</para>
3454 url="http://localhost/kivitendo-erp/login.pl">http://localhost/kivitendo-erp/login.pl</ulink></para>
3456 <para>Die Administrationsseite erreichen Sie unter:</para>
3459 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
3463 <chapter id="features" xreflabel="Features und Funktionen">
3464 <title>Features und Funktionen</title>
3466 <sect1 id="features.periodic-invoices"
3467 xreflabel="Wiederkehrende Rechnungen">
3468 <title>Wiederkehrende Rechnungen</title>
3470 <sect2 id="features.periodic-invoices.introduction"
3471 xreflabel="Einführung in wiederkehrende Rechnungen">
3472 <title>Einführung</title>
3474 <para>Wiederkehrende Rechnungen werden als normale Aufträge definiert
3475 und konfiguriert, mit allen dazugehörigen Kunden- und Artikelangaben.
3476 Die konfigurierten Aufträge werden später automatisch in Rechnungen
3477 umgewandelt, so als ob man den Workflow benutzen würde, und auch die
3478 Auftragsnummer wird übernommen, sodass alle wiederkehrenden
3479 Rechnungen, die aus einem Auftrag erstellt wurden, später leicht
3480 wiederzufinden sind.</para>
3483 <sect2 id="features.periodic-invoices.configuration"
3484 xreflabel="Konfiguration von wiederkehrenden Rechnungen">
3485 <title>Konfiguration</title>
3487 <para>Um einen Auftrag für wiederkehrende Rechnung zu konfigurieren,
3488 findet sich beim Bearbeiten des Auftrags ein neuer Knopf
3489 "Konfigurieren", der ein neues Fenster öffnet, in dem man die nötigen
3490 Parameter einstellen kann. Hinter dem Knopf wird außerdem noch
3491 angezeigt, ob der Auftrag als wiederkehrende Rechnung konfiguriert ist
3494 <para>Folgende Parameter kann man konfigurieren:</para>
3501 <para>Bei aktiven Rechnungen wird automatisch eine Rechnung
3502 erstellt, wenn die Periodizität erreicht ist (z.B. am Anfang
3503 eines neuen Monats).</para>
3505 <para>Ist ein Auftrag nicht aktiv, so werden für ihn auch keine
3506 wiederkehrenden Rechnungen erzeugt. Stellt man nach längerer
3507 nicht-aktiver Zeit einen Auftrag wieder auf aktiv, wird beim
3508 nächsten Periodenwechsel für alle Perioden, seit der letzten
3509 aktiven Periode, jeweils eine Rechnung erstellt. Möchte man dies
3510 verhindern, muss man vorher das Startdatum neu setzen.</para>
3512 <para>Für gekündigte Aufträge werden nie mehr Rechnungen
3513 erstellt. Man kann sich diese Aufträge aber gesondert in den
3514 Berichten anzeigen lassen.</para>
3519 <term>Periodizität</term>
3522 <para>Ob monatlich, quartalsweise oder jährlich auf neue
3523 Rechnungen überprüft werden soll. Für jede Periode seit dem
3524 Startdatum wird überprüft, ob für die Periode (beginnend immer
3525 mit dem ersten Tag der Periode) schon eine Rechnung erstellt
3526 wurde. Unter Umständen können bei einem Startdatum in der
3527 Vergangenheit gleich mehrere Rechnungen erstellt werden.</para>
3532 <term>Buchen auf</term>
3535 <para>Das Forderungskonto, in der Regel "Forderungen aus
3536 Lieferungen und Leistungen". Das Gegenkonto ergibt sich aus den
3537 Buchungsgruppen der betreffenden Waren.</para>
3542 <term>Startdatum</term>
3545 <para>ab welchem Datum auf Rechnungserstellung geprüft werden
3551 <term>Enddatum</term>
3554 <para>ab wann keine Rechnungen mehr erstellt werden
3560 <term>Automatische Verlängerung um x Monate</term>
3563 <para>Sollen die wiederkehrenden Rechnungen bei Erreichen des
3564 eingetragenen Enddatums weiterhin erstellt werden, so kann man
3565 hier die Anzahl der Monate eingeben, um die das Enddatum
3566 automatisch nach hinten geschoben wird.</para>
3571 <term>Drucken</term>
3574 <para>Sind Drucker konfiguriert, so kann man sich die erstellten
3575 Rechnungen auch gleich ausdrucken lassen.</para>
3580 <para>Nach Erstellung der Rechnungen kann eine E-Mail mit
3581 Informationen zu den erstellten Rechnungen verschickt werden.
3582 Konfiguriert wird dies in der <link
3583 linkend="config.config-file.sections-parameters">Konfigurationsdatei</link>
3584 <filename>config/kivitendo.conf</filename> im Abschnitt
3585 <varname>[periodic_invoices]</varname>.</para>
3588 <sect2 id="features.periodic-invoices.variables">
3589 <title>Spezielle Variablen</title>
3591 <para>Um die erzeugten Rechnungen individualisieren zu können, werden
3592 beim Umwandeln des Auftrags in eine Rechnung einige speziell
3593 formatierte Variablen durch für die jeweils aktuelle
3594 Abrechnungsperiode gültigen Werte ersetzt. Damit ist es möglich, z.B.
3595 den Abrechnungszeitraum explizit auszuweisen. Eine Variable hat dabei
3596 die Syntax <literal><%variablenname%></literal>.</para>
3598 <para>Sofern es sich um eine Datumsvariable handelt, kann das
3599 Ausgabeformat weiter bestimmt werden, indem an den Variablennamen
3600 Formatoptionen angehängt werden. Die Syntax sieht dabei wie folgt aus:
3601 <literal><%variablenname FORMAT=Formatinformation%></literal>.
3602 Die zur verfügung stehenden Formatinformationen werden unten genauer
3605 <para>Diese Variablen können auch beim automatischen Versand der
3606 erzeugten Rechnungen per E-Mail genutzt werden, indem sie in den
3607 Feldern für den Betreff oder die Nachricht verwendet werden.</para>
3609 <para>Diese Variablen werden in den folgenden Elementen des Auftrags
3614 <para>Bemerkungen</para>
3618 <para>Interne Bemerkungen</para>
3622 <para>Vorgangsbezeichnung</para>
3626 <para>In den Beschreibungs- und Langtextfeldern aller
3631 <para>Die zur Verfügung stehenden Variablen sind die Folgenden:</para>
3635 <term><varname><%current_quarter%></varname>,
3636 <varname><%previous_quarter%></varname>,
3637 <varname><%next_quarter%></varname></term>
3640 <para>Aktuelles, vorheriges und nächstes Quartal als Zahl
3641 zwischen <literal>1</literal> und <literal>4</literal>.</para>
3646 <term><varname><%current_month%></varname>,
3647 <varname><%previous_month%></varname>,
3648 <varname><%next_month%></varname></term>
3651 <para>Aktueller, vorheriger und nächster Monat als Zahl zwischen
3652 <literal>1</literal> und <literal>12</literal>.</para>
3657 <term><varname><%current_month_long%></varname>,
3658 <varname><%previous_month_long%></varname>,
3659 <varname><%next_month_long%></varname></term>
3662 <para>Aktueller, vorheriger und nächster Monat als Name
3663 (<literal>Januar</literal>, <literal>Februar</literal>
3669 <term><varname><%current_year%></varname>,
3670 <varname><%previous_year%></varname>,
3671 <varname><%next_year%></varname></term>
3674 <para>Aktuelles, vorheriges und nächstes Jahr als vierstellige
3675 Jahreszahl (<literal>2013</literal> etc.).</para>
3680 <term><varname><%period_start_date%></varname>,
3681 <varname><%period_end_date%></varname></term>
3684 <para>Formatiertes Datum des ersten und letzten Tages im
3685 Abrechnungszeitraum (z.B. bei quartalsweiser Abrechnung und im
3686 ersten Quartal von 2013 wären dies der
3687 <literal>01.01.2013</literal> und
3688 <literal>31.03.2013</literal>).</para>
3693 <para>Die invidiuellen Formatinformationen bestehen aus Paaren von
3694 Prozentzeichen und einem Buchstaben, welche beide zusammen durch den
3695 dazugehörigen Wert ersetzt werden. So wird z.B. <literal>%Y</literal>
3696 durch das viertstellige Jahr ersetzt. Alle möglichen Platzhalter
3701 <term><varname>%a</varname></term>
3704 <para>Der abgekürzte Wochentagsname.</para>
3709 <term><varname>%A</varname></term>
3712 <para>Der ausgeschriebene Wochentagsname.</para>
3717 <term><varname>%b</varname></term>
3720 <para>Der abgekürzte Monatsname.</para>
3725 <term><varname>%B</varname></term>
3728 <para>Der ausgeschriebene Monatsname.</para>
3733 <term><varname>%C</varname></term>
3736 <para>Das Jahrhundert (Jahr/100) als eine zweistellige
3742 <term><varname>%d</varname></term>
3745 <para>Der Monatstag als Zahl zwischen 01 und 31.</para>
3750 <term><varname>%D</varname></term>
3753 <para>Entspricht %m/%d/%y (amerikanisches Datumsformat).</para>
3758 <term><varname>%e</varname></term>
3761 <para>Wie %d (Monatstag als Zahl zwischen 1 und 31), allerdings
3762 werden führende Nullen durch Leerzeichen ersetzt.</para>
3767 <term><varname>%F</varname></term>
3770 <para>Entspricht %Y-%m-%d (das ISO-8601-Datumsformat).</para>
3775 <term><varname>%j</varname></term>
3778 <para>Der Tag im Jahr als Zahl zwischen 001 und 366
3784 <term><varname>%m</varname></term>
3787 <para>Der Monat als Zahl zwischen 01 und 12 inklusive.</para>
3792 <term><varname>%u</varname></term>
3795 <para>Der Wochentag als Zahl zwischen 1 und 7 inklusive, wobei
3796 die 1 dem Montag entspricht.</para>
3801 <term><varname>%U</varname></term>
3804 <para>Die Wochennummer als Zahl zwischen 00 und 53 inklusive,
3805 wobei der erste Sonntag im Jahr das Startdatum von Woche 01
3811 <term><varname>%V</varname></term>
3814 <para>Die ISO-8601:1988-Wochennummer als Zahl zwischen 01 und 53
3815 inklusive, wobei Woche 01 die erste Woche, von der mindestens
3816 vier Tage im Jahr liegen; Montag ist erster Tag der
3822 <term><varname>%w</varname></term>
3825 <para>Der Wochentag als Zahl zwischen 0 und 6 inklusive, wobei
3826 die 0 dem Sonntag entspricht.</para>
3831 <term><varname>%W</varname></term>
3834 <para>Die Wochennummer als Zahl zwischen 00 und 53 inklusive,
3835 wobei der erste Montag im Jahr das Startdatum von Woche 01
3841 <term><varname>%y</varname></term>
3844 <para>Das Jahr als zweistellige Zahl zwischen 00 und 99
3850 <term><varname>%Y</varname></term>
3853 <para>Das Jahr als vierstellige Zahl.</para>
3858 <term><varname>%%</varname></term>
3861 <para>Das Prozentzeichen selber.</para>
3866 <para>Anwendungsbeispiel für die Ausgabe, von welchem Monat und Jahr
3867 bis zu welchem Monat und Jahr die aktuelle Abrechnungsperiode dauert:
3868 <literal>Abrechnungszeitrum: <%period_start_date FORMAT=%m/%Y%>
3869 bis <%period_end_date FORMAT=%m/%Y%></literal></para>
3872 <sect2 id="features.periodic-invoices.reports">
3873 <title>Auflisten</title>
3875 <para>Unter Verkauf->Berichte->Aufträge finden sich zwei neue
3876 Checkboxen, "Wiederkehrende Rechnungen aktiv" und "Wiederkehrende
3877 Rechnungen inaktiv", mit denen man sich einen Überglick über die
3878 wiederkehrenden Rechnungen verschaffen kann.</para>
3881 <sect2 id="features.periodic-invoices.task-server">
3882 <title>Erzeugung der eigentlichen Rechnungen</title>
3884 <para>Die zeitliche und periodische Überprüfung, ob eine
3885 wiederkehrende Rechnung automatisch erstellt werden soll, geschieht
3886 durch den <link linkend="config.task-server">Task-Server</link>, einen
3887 externen Dienst, der automatisch beim Start des Servers gestartet
3888 werden sollte.</para>
3891 <sect2 id="features.periodic-invoices.create-for-current-month">
3892 <title>Erste Rechnung für aktuellen Monat erstellen</title>
3894 <para>Will man im laufenden Monat eine monatlich wiederkehrende
3895 Rechnung inkl. des laufenden Monats starten, stellt man das Startdatum
3896 auf den Monatsanfang und wartet ein paar Minuten, bis der Task-Server
3897 den neu konfigurieren Auftrag erkennt und daraus eine Rechnung
3898 generiert hat. Alternativ setzt man das Startdatum auf den
3899 Monatsersten des Folgemonats und erstellt die erste Rechnung direkt
3900 manuell über den Workflow.</para>
3904 <sect1 id="features.bank" xreflabel="bankerweiterung">
3905 <title>Bankerweiterung</title>
3907 <sect2 id="features.bank.introduction"
3908 xreflabel="Einführung in die Bankerweiterung">
3909 <title>Einführung</title>
3911 <para>Die Beschreibung der Bankerweiterung befindet sich derzeit noch
3912 im Wiki und soll von dort später hierhin übernommen werden:</para>
3915 url="http://redmine.kivitendo-premium.de/projects/forum/wiki/Bankerweiterung">http://redmine.kivitendo-premium.de/projects/forum/wiki/Bankerweiterung</ulink></para>
3919 <sect1 id="dokumentenvorlagen-und-variablen">
3920 <title>Dokumentenvorlagen und verfügbare Variablen</title>
3922 <sect2 id="dokumentenvorlagen-und-variablen.einführung">
3923 <title>Einführung</title>
3925 <para>Dies ist eine Auflistung der Standard-Dokumentenvorlagen und
3926 aller zur Bearbeitung verfügbaren Variablen. Eine Variable wird in
3927 einer Vorlage durch ihren Inhalt ersetzt, wenn sie in der Form
3928 <function><%variablenname%></function> verwendet wird. Für
3929 LaTeX- und HTML-Vorlagen kann man die Form dieser Tags auch verändern
3931 linkend="dokumentenvorlagen-und-variablen.tag-style"/>).</para>
3933 <para>kivitendo unterstützt LaTeX-, HTML- und OpenDocument-Vorlagen.
3934 Sofern es nicht ausdrücklich eingeschränkt wird, gilt das im Folgenden
3935 gesagte für alle Vorlagenarten.</para>
3937 <para>Insgesamt sind technisch gesehen eine ganze Menge mehr Variablen
3938 verfügbar als hier aufgelistet werden. Die meisten davon können
3939 allerdings innerhalb einer solchen Vorlage nicht sinnvoll verwendet
3940 werden. Wenn eine Auflistung dieser Variablen gewollt ist, so kann
3941 diese wie folgt erhalten werden:</para>
3945 <para><filename>SL/Form.pm</filename> öffnen und am Anfang die
3946 Zeile "<command>use Data::Dumper;</command>" einfügen.</para>
3950 <para>In <filename>Form.pm</filename> die Funktion
3951 <function>parse_template</function> suchen und hier die Zeile
3952 <command>print(STDERR Dumper($self));</command> einfügen.</para>
3956 <para>Einmal per Browser die gewünschte Vorlage "benutzen", z.B.
3957 ein PDF für eine Rechnung erzeugen.</para>
3961 <para>Im <filename>error.log</filename> Apache steht die Ausgabe
3962 der Variablen <varname>$self</varname> in der Form <varname>'key'
3963 => 'value',</varname>. Alle <varname>key</varname>s sind
3969 <sect2 id="dokumentenvorlagen-und-variablen.variablen-ausgeben">
3970 <title>Variablen ausgeben</title>
3972 <para>Um eine Variable auszugeben, müssen sie einfach nur zwischen die
3973 Tags geschrieben werden, also z.B.
3974 <varname><%variablenname%></varname>.</para>
3976 <para>Optional kann man auch mit Leerzeichen getrennte Flags angeben,
3977 die man aber nur selten brauchen wird. Die Syntax sieht also so aus:
3978 <varname><%variablenname FLAG1 FLAG2%></varname>. Momentan
3979 werden die folgenden Flags unterstützt:</para>
3983 <para><option>NOFORMAT</option> gilt nur für Zahlenwerte und gibt
3984 den Wert ohne Formatierung, also ohne Tausendertrennzeichen mit
3985 mit einem Punkt als Dezimaltrennzeichen aus. Nützlich z.B., wenn
3986 damit in der Vorlage z.B. von LaTeX gerechnet werden soll.</para>
3990 <para><option>NOESCAPE</option> unterdrückt das Escapen von
3991 Sonderzeichen für die Vorlagensprache. Wenn also in einer
3992 Variablen bereits gültiger LaTeX-Code steht und dieser von LaTeX
3993 auch ausgewertet und nicht wortwörtlich angezeigt werden soll, so
3994 ist dieses Flag sinnvoll.</para>
3998 <para>Beispiel:</para>
4000 <programlisting><%quototal NOFORMAT%></programlisting>
4003 <sect2 id="dokumentenvorlagen-und-variablen.verwendung-in-druckbefehlen">
4004 <title>Verwendung in Druckbefehlen</title>
4006 <para>In der Admininstration können Drucker definiert werden. Auch im
4007 dort eingebbaren Druckbefehl können die hier aufgelisteten Variablen
4008 und Kontrollstrukturen verwendet werden. Ihr Inhalt wird dabei nach
4009 den Regeln der gängigen Shells formatiert, sodass Sonderzeichen wie
4010 <function>`...`</function> nicht zu unerwünschtem Verhalten
4013 <para>Dies erlaubt z.B. die Definition eines Faxes als Druckerbefehl,
4014 für das die Telefonnummer eines Ansprechpartners als Teil der
4015 Kommandozeile verwendet wird. Für ein fiktives Kommando könnte das
4016 z.B. wie folgt aussehen:</para>
4018 <programlisting>send_fax --number <%if cp_phone2%><%cp_phone2%><%else%><%cp_phone1%><%end%></programlisting>
4021 <sect2 id="dokumentenvorlagen-und-variablen.tag-style"
4022 xreflabel="Anfang und Ende der Tags verändern">
4023 <title>Anfang und Ende der Tags verändern</title>
4025 <para>Der Standardstil für Tags sieht vor, dass ein Tag mit dem
4026 Kleinerzeichen und einem Prozentzeichen beginnt und mit dem
4027 Prozentzeichen und dem Größerzeichen endet, beispielsweise
4028 <function><%customer%></function>. Da diese Form aber z.B. in
4029 LaTeX zu Problemen führen kann, weil das Prozentzeichen dort
4030 Kommentare einleitet, kann pro HTML- oder LaTeX-Dokumentenvorlage der
4031 Stil umgestellt werden.</para>
4033 <para>Dazu werden in die Datei Zeilen geschrieben, die mit dem für das
4034 Format gültigen Kommentarzeichen anfangen, dann
4035 <function>config:</function> enthalten, die entsprechende Option
4036 setzen und bei HTML-Dokumentenvorlagen mit dem Kommentarendzeichen
4037 enden. Beispiel für LaTeX:</para>
4039 <programlisting>% config: tag-style=($ $)</programlisting>
4041 <para>Dies würde kivitendo dazu veranlassen, Variablen zu ersetzen,
4042 wenn sie wie folgt aussehen: <function>($customer$)</function>. Das
4043 äquivalente Beispiel für HTML-Dokumentenvorlagen sieht so aus:</para>
4045 <programlisting><!-- config: tag-style=($ $) --></programlisting>
4048 <sect2 id="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">
4049 <title>Zuordnung von den Dateinamen zu den Funktionen</title>
4051 <para>Diese folgende kurze Auflistung zeigt, welche Vorlage bei
4052 welcher Funktion ausgelesen wird. Dabei ist die Dateiendung
4053 "<filename>.ext</filename>" geeignet zu ersetzen:
4054 "<filename>.tex</filename>" für LaTeX-Vorlagen und
4055 "<filename>.odt</filename>" für OpenDocument-Vorlagen.</para>
4059 <term><filename>bin_list.ext</filename></term>
4062 <para>Lagerliste</para>
4067 <term><filename>check.ext</filename></term>
4075 <term><filename>invoice.ext</filename></term>
4078 <para>Rechnung</para>
4083 <term><filename>packing_list.ext</filename></term>
4086 <para>Packliste</para>
4091 <term><filename>pick_list.ext</filename></term>
4094 <para>Sammelliste</para>
4099 <term><filename>purchase_delivery_order.ext</filename></term>
4102 <para>Lieferschein (Einkauf)</para>
4107 <term><filename>purcharse_order.ext</filename></term>
4110 <para>Bestellung an Lieferanten</para>
4115 <term><filename>request_quotation.ext</filename></term>
4118 <para>Anfrage an Lieferanten</para>
4123 <term><filename>sales_delivery_order.ext</filename></term>
4126 <para>Lieferschein (Verkauf)</para>
4131 <term><filename>sales_order.ext</filename></term>
4134 <para>Bestellung</para>
4139 <term><filename>sales_quotation.ext</filename></term>
4142 <para>Angebot an Kunden</para>
4147 <term><filename>zahlungserinnerung.ext</filename></term>
4150 <para>Mahnung (Dateiname im Programm konfigurierbar)</para>
4155 <term><filename>zahlungserinnerung_invoice.ext</filename></term>
4158 <para>Rechnung über Mahngebühren (Dateiname im Programm
4159 konfigurierbar)</para>
4165 <sect2 id="dokumentenvorlagen-und-variablen.dateinamen-erweitert">
4166 <title>Sprache, Drucker und E-Mail</title>
4168 <para>Angeforderte Sprache und Druckerkürzel in den Dateinamen mit
4169 eingearbeitet. So wird aus der Vorlage
4170 <filename>sales_order.ext</filename> bei Sprache
4171 <function>de</function> und Druckerkürzel <function>lpr2</function>
4172 der Vorlagenname <filename>sales_order_de_lpr2.ext</filename>.
4173 Zusätzlich können für E-Mails andere Vorlagen erstellt werden, diese
4174 bekommen dann noch das Kürzel <filename>_email</filename>, der
4175 vollständige Vorlagenname wäre dann
4176 <filename>sales_order_email_de_lpr2.ext</filename>. In allen Fällen
4177 kann eine Standarddatei <filename>default.ext</filename> hinterlegt
4178 werden. Diese wird verwendet, wenn keine der anderen Varianten
4179 gefunden wird.</para>
4181 <para>Die vollständige Suchreihenfolge für einen Verkaufsauftrag mit
4182 der Sprache "de" und dem Drucker "lpr2", der per E-Mail im Format PDF
4183 verschickt wird, ist:</para>
4187 <para><filename>sales_order_email_de_lpr2.tex</filename></para>
4191 <para><filename>sales_order_de_lpr2.tex</filename></para>
4195 <para><filename>sales_order.tex</filename></para>
4199 <para><filename>default.tex</filename></para>
4203 <para>Die kurzen Varianten dieser Vorlagentitel müssen dann entweder
4204 Standardwerte anzeigen, oder die angeforderten Werte selbst auswerten,
4206 linkend="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"/>.</para>
4209 <sect2 id="dokumentenvorlagen-und-variablen.allgemeine-variablen">
4210 <title>Allgemeine Variablen, die in allen Vorlagen vorhanden
4213 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"
4214 xreflabel="Metainformationen zur angeforderten Vorlage">
4215 <title>Metainformationen zur angeforderten Vorlage</title>
4217 <para>Diese Variablen liefern Informationen darüber welche Variante
4218 einer Vorlage der Benutzer angefragt hat. Sie sind nützlich für
4219 Vorlagenautoren, die aus einer zentralen Layoutvorlage die einzelnen
4220 Formulare einbinden möchten.</para>
4224 <term><varname>template_meta.formname</varname></term>
4227 <para>Basisname der Vorlage. Identisch mit der <link
4228 linkend="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">Zurordnung
4229 zu den Dateinamen</link> ohne die Erweiterung. Ein
4230 Verkaufsauftrag enthält hier
4231 <constant>sales_order</constant>.</para>
4236 <term><varname>template_meta.language.description</varname></term>
4239 <para>Beschreibung der verwendeten Sprache</para>
4244 <term><varname>template_meta.language.template_code</varname></term>
4247 <para>Vorlagenkürzel der verwendeten Sprache, identisch mit
4248 dem Kürzel das im Dateinamen verwendetet wird.</para>
4253 <term><varname>template_meta.language.output_numberformat</varname></term>
4256 <para>Zahlenformat der verwendeten Sprache in der Form
4257 "<constant>1.000,00</constant>". Experimentell! Nur
4258 interessant für Vorlagen die mit unformatierten Werten
4264 <term><varname>template_meta.language.output_dateformat</varname></term>
4267 <para>Datumsformat der verwendeten Sprache in der Form
4268 "<constant>dd.mm.yyyy</constant>". Experimentell! Nur
4269 interessant für Vorlagen die mit unformatierten Werten
4275 <term><varname>template_meta.format</varname></term>
4278 <para>Das angeforderte Format. Kann im Moment die Werte
4279 <constant>pdf</constant>, <constant>postscript</constant>,
4280 <constant>html</constant>, <constant>opendocument</constant>,
4281 <constant>opendocument_pdf</constant> und
4282 <constant>excel</constant> enthalten.</para>
4287 <term><varname>template_meta.extension</varname></term>
4290 <para>Dateierweiterung, wie im Dateinamen. Wird aus
4291 <constant>format</constant> entschieden.</para>
4296 <term><varname>template_meta.media</varname></term>
4299 <para>Ausgabemedium. Kann zur Zeit die Werte
4300 <constant>screen</constant> für Bildschirm,
4301 <constant>email</constant> für E-Mail (triggert das
4302 <constant>_email</constant> Kürzel im Dateinamen),
4303 <constant>printer</constant> für Drucker, und
4304 <constant>queue</constant> für Warteschlange enthalten.</para>
4309 <term><varname>template_meta.printer.description</varname></term>
4312 <para>Beschreibung des ausgewählten Druckers</para>
4317 <term><varname>template_meta.printer.template_code</varname></term>
4320 <para>Vorlagenürzel des ausgewählten Druckers, identisch mit
4321 dem Kürzel das im Dateinamen verwendetet wird.</para>
4326 <term><varname>template_meta.tmpfile</varname></term>
4329 <para>Datei-Prefix für temporäre Dateien.</para>
4335 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.kunden-lieferanten">
4336 <title>Stammdaten von Kunden und Lieferanten</title>
4340 <term><varname>account_number</varname></term>
4343 <para>Kontonummer</para>
4348 <term><varname>bank</varname></term>
4351 <para>Name der Bank</para>
4356 <term><varname>bank_code</varname></term>
4359 <para>Bankleitzahl</para>
4364 <term><varname>bic</varname></term>
4367 <para>Bank-Identifikations-Code (Bank Identifier Code,
4373 <term><varname>business</varname></term>
4376 <para>Kunden-/Lieferantentyp</para>
4381 <term><varname>city</varname></term>
4389 <term><varname>contact</varname></term>
4392 <para>Kontakt</para>
4397 <term><varname>country</varname></term>
4405 <term><varname>c_vendor_id</varname></term>
4408 <para>Lieferantennummer beim Kunden (nur Kunden)</para>
4413 <term><varname>v_customer_id</varname></term>
4416 <para>Kundennummer beim Lieferanten (nur Lieferanten)</para>
4421 <term><varname>cp_email</varname></term>
4424 <para>Email des Ansprechpartners</para>
4429 <term><varname>cp_givenname</varname></term>
4432 <para>Vorname des Ansprechpartners</para>
4437 <term><varname>cp_greeting</varname></term>
4440 <para>Anrede des Ansprechpartners</para>
4445 <term><varname>cp_name</varname></term>
4448 <para>Name des Ansprechpartners</para>
4453 <term><varname>cp_phone1</varname></term>
4456 <para>Telefonnummer 1 des Ansprechpartners</para>
4461 <term><varname>cp_phone2</varname></term>
4464 <para>Telefonnummer 2 des Ansprechpartners</para>
4469 <term><varname>cp_title</varname></term>
4472 <para>Titel des Ansprechpartners</para>
4477 <term><varname>creditlimit</varname></term>
4480 <para>Kreditlimit</para>
4485 <term><varname>customeremail</varname></term>
4488 <para>Email des Kunden; nur für Kunden</para>
4493 <term><varname>customerfax</varname></term>
4496 <para>Faxnummer des Kunden; nur für Kunden</para>
4501 <term><varname>customernotes</varname></term>
4504 <para>Bemerkungen beim Kunden; nur für Kunden</para>
4509 <term><varname>customernumber</varname></term>
4512 <para>Kundennummer; nur für Kunden</para>
4517 <term><varname>customerphone</varname></term>
4520 <para>Telefonnummer des Kunden; nur für Kunden</para>
4525 <term><varname>discount</varname></term>
4533 <term><varname>email</varname></term>
4536 <para>Emailadresse</para>
4541 <term><varname>fax</varname></term>
4544 <para>Faxnummer</para>
4549 <term><varname>gln</varname></term>
4552 <para>GLN (Globale Lokationsnummer)</para>
4557 <term><varname>greeting</varname></term>
4565 <term><varname>homepage</varname></term>
4568 <para>Homepage</para>
4573 <term><varname>iban</varname></term>
4576 <para>Internationale Kontonummer (International Bank Account
4577 Number, IBAN)</para>
4582 <term><varname>language</varname></term>
4585 <para>Sprache</para>
4590 <term><varname>name</varname></term>
4593 <para>Firmenname</para>
4598 <term><varname>natural_person</varname></term>
4601 <para>Flag "natürliche Person"; Siehe auch
4602 <xref linkend="dokumentenvorlagen-und-variablen.anrede"/></para>
4607 <term><varname>payment_description</varname></term>
4610 <para>Name der Zahlart</para>
4615 <term><varname>payment_terms</varname></term>
4618 <para>Zahlungskonditionen</para>
4623 <term><varname>phone</varname></term>
4626 <para>Telefonnummer</para>
4631 <term><varname>shiptocity</varname></term>
4634 <para>Stadt (Lieferadresse) <link
4635 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4640 <term><varname>shiptocontact</varname></term>
4643 <para>Kontakt (Lieferadresse) <link
4644 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4649 <term><varname>shiptocountry</varname></term>
4652 <para>Land (Lieferadresse) <link
4653 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4658 <term><varname>shiptodepartment_1</varname></term>
4661 <para>Abteilung 1 (Lieferadresse) <link
4662 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4667 <term><varname>shiptodepartment_2</varname></term>
4670 <para>Abteilung 2 (Lieferadresse) <link
4671 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4676 <term><varname>shiptoemail</varname></term>
4679 <para>Email (Lieferadresse) <link
4680 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4685 <term><varname>shiptofax</varname></term>
4688 <para>Fax (Lieferadresse) <link
4689 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4694 <term><varname>shiptogln</varname></term>
4697 <para>GLN (Globale Lokationsnummer) (Lieferadresse) <link
4698 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4703 <term><varname>shiptoname</varname></term>
4706 <para>Firmenname (Lieferadresse) <link
4707 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4712 <term><varname>shiptophone</varname></term>
4715 <para>Telefonnummer (Lieferadresse) <link
4716 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4721 <term><varname>shiptostreet</varname></term>
4724 <para>Straße und Hausnummer (Lieferadresse) <link
4725 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4730 <term><varname>shiptozipcode</varname></term>
4733 <para>Postleitzahl (Lieferadresse) <link
4734 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4739 <term><varname>street</varname></term>
4742 <para>Straße und Hausnummer</para>
4747 <term><varname>taxnumber</varname></term>
4750 <para>Steuernummer</para>
4755 <term><varname>ustid</varname></term>
4758 <para>Umsatzsteuer-Identifikationsnummer</para>
4763 <term><varname>vendoremail</varname></term>
4766 <para>Email des Lieferanten; nur für Lieferanten</para>
4771 <term><varname>vendorfax</varname></term>
4774 <para>Faxnummer des Lieferanten; nur für Lieferanten</para>
4779 <term><varname>vendornotes</varname></term>
4782 <para>Bemerkungen beim Lieferanten; nur für Lieferanten</para>
4787 <term><varname>vendornumber</varname></term>
4790 <para>Lieferantennummer; nur für Lieferanten</para>
4795 <term><varname>vendorphone</varname></term>
4798 <para>Telefonnummer des Lieferanten; nur für
4804 <term><varname>zipcode</varname></term>
4807 <para>Postleitzahl</para>
4812 <note id="dokumentenvorlagen-und-variablen.anmerkung-shipto">
4813 <para>Anmerkung: Sind die <varname>shipto*</varname>-Felder in den
4814 Stammdaten nicht eingetragen, so haben die Variablen
4815 <varname>shipto*</varname> den gleichen Wert wie die die
4816 entsprechenden Variablen der Lieferdaten. Das bedeutet, dass sich
4817 einige <varname>shipto*</varname>-Variablen so nicht in den
4818 Stammdaten wiederfinden sondern schlicht Kopien der
4819 Lieferdatenvariablen sind (z.B.
4820 <varname>shiptocontact</varname>).</para>
4824 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-bearbeiter">
4825 <title>Informationen über den Bearbeiter</title>
4829 <term><varname>employee_address</varname></term>
4832 <para>Adressfeld</para>
4837 <term><varname>employee_businessnumber</varname></term>
4840 <para>Firmennummer</para>
4845 <term><varname>employee_company</varname></term>
4848 <para>Firmenname</para>
4853 <term><varname>employee_co_ustid</varname></term>
4856 <para>Usatzsteuer-Identifikationsnummer</para>
4861 <term><varname>employee_duns</varname></term>
4864 <para>DUNS-Nummer</para>
4869 <term><varname>employee_email</varname></term>
4877 <term><varname>employee_fax</varname></term>
4885 <term><varname>employee_name</varname></term>
4888 <para>voller Name</para>
4893 <term><varname>employee_signature</varname></term>
4896 <para>Signatur</para>
4901 <term><varname>employee_taxnumber</varname></term>
4904 <para>Steuernummer</para>
4909 <term><varname>employee_tel</varname></term>
4912 <para>Telefonnummer</para>
4918 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-verkaeufer">
4919 <title>Informationen über den Verkäufer</title>
4923 <term><varname>salesman_address</varname></term>
4926 <para>Adressfeld</para>
4931 <term><varname>salesman_businessnumber</varname></term>
4934 <para>Firmennummer</para>
4939 <term><varname>salesman_company</varname></term>
4942 <para>Firmenname</para>
4947 <term><varname>salesman_co_ustid</varname></term>
4950 <para>Usatzsteuer-Identifikationsnummer</para>
4955 <term><varname>salesman_duns</varname></term>
4958 <para>DUNS-Nummer</para>
4963 <term><varname>salesman_email</varname></term>
4971 <term><varname>salesman_fax</varname></term>
4979 <term><varname>salesman_name</varname></term>
4982 <para>voller Name</para>
4987 <term><varname>salesman_signature</varname></term>
4990 <para>Signatur</para>
4995 <term><varname>salesman_taxnumber</varname></term>
4998 <para>Steuernummer</para>
5003 <term><varname>salesman_tel</varname></term>
5006 <para>Telefonnummer</para>
5012 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-steuern">
5013 <title>Variablen für die einzelnen Steuern</title>
5017 <term><varname>tax</varname></term>
5025 <term><varname>taxbase</varname></term>
5028 <para>zu versteuernder Betrag</para>
5033 <term><varname>taxdescription</varname></term>
5036 <para>Name der Steuer</para>
5041 <term><varname>taxrate</varname></term>
5044 <para>Steuersatz</para>
5050 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-lieferbedingungen">
5051 <title>Variablen für Lieferbedingungen</title>
5055 <term><varname>delivery_term</varname></term>
5058 <para>Datenbank-Objekt der Lieferbedingung</para>
5063 <term><varname>delivery_term.description</varname></term>
5066 <para>Beschreibung der Lieferbedingung</para>
5071 <term><varname>delivery_term.description_long</varname></term>
5074 <para>Langtext bzw. übersetzter Langtext der
5075 Lieferbedingung</para>
5082 <sect2 id="dokumentenvorlagen-und-variablen.invoice">
5083 <title>Variablen in Rechnungen</title>
5085 <sect3 id="dokumentenvorlagen-und-variablen.invoice-allgemein">
5086 <title>Allgemeine Variablen</title>
5090 <term><varname>creditremaining</varname></term>
5093 <para>Verbleibender Kredit</para>
5098 <term><varname>currency</varname></term>
5101 <para>Währung</para>
5106 <term><varname>cusordnumber</varname></term>
5109 <para>Bestellnummer beim Kunden</para>
5114 <term><varname>deliverydate</varname></term>
5117 <para>Lieferdatum</para>
5122 <term><varname>duedate</varname></term>
5125 <para>Fälligkeitsdatum</para>
5130 <term><varname>globalprojectnumber</varname></term>
5133 <para>Projektnummer des ganzen Beleges</para>
5138 <term><varname>globalprojectdescription</varname></term>
5141 <para>Projekbeschreibung des ganzen Beleges</para>
5146 <term><varname>intnotes</varname></term>
5149 <para>Interne Bemerkungen</para>
5154 <term><varname>invdate</varname></term>
5157 <para>Rechnungsdatum</para>
5162 <term><varname>invnumber</varname></term>
5165 <para>Rechnungsnummer</para>
5170 <term><varname>invtotal</varname></term>
5173 <para>gesamter Rechnungsbetrag</para>
5178 <term><varname>notes</varname></term>
5181 <para>Bemerkungen der Rechnung</para>
5186 <term><varname>orddate</varname></term>
5189 <para>Auftragsdatum</para>
5194 <term><varname>ordnumber</varname></term>
5197 <para>Auftragsnummer, wenn die Rechnung aus einem Auftrag
5198 erstellt wurde</para>
5203 <term><varname>payment_description</varname></term>
5206 <para>Name der Zahlart</para>
5211 <term><varname>payment_terms</varname></term>
5214 <para>Zahlungskonditionen</para>
5219 <term><varname>quodate</varname></term>
5222 <para>Angebotsdatum</para>
5227 <term><varname>quonumber</varname></term>
5230 <para>Angebotsnummer</para>
5235 <term><varname>rounding</varname></term>
5238 <para>Betrag, um den <varname>invtotal</varname> gerundet
5239 wurde (kann positiv oder negativ sein)</para>
5244 <term><varname>shippingpoint</varname></term>
5247 <para>Versandort</para>
5252 <term><varname>shipvia</varname></term>
5255 <para>Transportmittel</para>
5260 <term><varname>subtotal</varname></term>
5263 <para>Zwischensumme aller Posten ohne Steuern</para>
5268 <term><varname>total</varname></term>
5271 <para>Restsumme der Rechnung (Summe abzüglich bereits
5272 bezahlter Posten)</para>
5277 <term><varname>transaction_description</varname></term>
5280 <para>Vorgangsbezeichnung</para>
5285 <term><varname>transdate</varname></term>
5288 <para>Auftragsdatum wenn die Rechnung aus einem Auftrag
5289 erstellt wurde</para>
5295 <sect3 id="dokumentenvorlagen-und-variablen.invoice-posten">
5296 <title>Variablen für jeden Posten auf der Rechnung</title>
5300 <term><varname>bin</varname></term>
5303 <para>Stellage</para>
5308 <term><varname>description</varname></term>
5311 <para>Artikelbeschreibung</para>
5316 <term><varname>cusordnumber_oe</varname></term>
5319 <para>Bestellnummer des Kunden aus dem Auftrag, aus dem der
5320 Posten ursprünglich stammt (nur Verkauf)</para>
5325 <term><varname>discount</varname></term>
5328 <para>Rabatt als Betrag</para>
5333 <term><varname>discount_sub</varname></term>
5336 <para>Zwischensumme mit Rabatt</para>
5341 <term><varname>donumber_do</varname></term>
5344 <para>Lieferscheinnummer des Lieferscheins, aus dem die
5345 Position ursprünglich stammt, wenn die Rechnung im Rahmen des
5346 Workflows aus einem Lieferschein erstellt wurde.</para>
5351 <term><varname>drawing</varname></term>
5354 <para>Zeichnung</para>
5359 <term><varname>ean</varname></term>
5362 <para>EAN-Code</para>
5367 <term><varname>image</varname></term>
5375 <term><varname>linetotal</varname></term>
5378 <para>Zeilensumme (Anzahl * Einzelpreis)</para>
5383 <term><varname>longdescription</varname></term>
5386 <para>Langtext, vorbelegt mit dem Feld Bemerkungen der entsprechenden Ware</para>
5391 <term><varname>microfiche</varname></term>
5394 <para>Mikrofilm</para>
5399 <term><varname>netprice</varname></term>
5402 <para>Alternative zu <varname>sellprice</varname>, aber
5403 <varname>netprice</varname> entspricht dem effektiven
5404 Einzelpreis und beinhaltet Zeilenrabatt und Preisfaktor.
5405 <varname>netprice</varname> wird rückgerechnet aus Zeilensumme
5406 / Menge. Diese Variable ist nützlich, wenn man den gewährten
5407 Rabatt in der Druckvorlage nicht anzeigen möchte, aber Menge *
5408 Einzelpreis trotzdem die angezeigte Zeilensumme ergeben soll.
5409 <varname>netprice</varname> hat nichts mit Netto/Brutto im
5410 Sinne von Steuern zu tun.</para>
5415 <term><varname>nodiscount_linetotal</varname></term>
5418 <para>Zeilensumme ohne Rabatt</para>
5423 <term><varname>nodiscount_sub</varname></term>
5426 <para>Zwischensumme ohne Rabatt</para>
5431 <term><varname>number</varname></term>
5434 <para>Artikelnummer</para>
5439 <term><varname>ordnumber_oe</varname></term>
5442 <para>Auftragsnummer des Originalauftrags, aus dem der Posten
5443 ursprünglich stammt. Nützlich, wenn die Rechnung aus mehreren
5444 Lieferscheinen zusammengefasst wurde, oder wenn zwischendurch
5445 eine Sammelauftrag aus mehreren Aufträgen erstellt wurde. In
5446 letzterem Fall wird die unsprüngliche Auftragsnummer
5452 <term><varname>p_discount</varname></term>
5455 <para>Rabatt in Prozent</para>
5460 <term><varname>partnotes</varname></term>
5463 <para>Die beim Artikel gespeicherten Bemerkungen</para>
5468 <term><varname>partsgroup</varname></term>
5471 <para>Warengruppe</para>
5476 <term><varname>price_factor</varname></term>
5479 <para>Der Preisfaktor als Zahl, sofern einer eingestellt
5485 <term><varname>price_factor_name</varname></term>
5488 <para>Der Name des Preisfaktors, sofern einer eingestellt
5494 <term><varname>projectnumber</varname></term>
5497 <para>Projektnummer</para>
5502 <term><varname>projectdescription</varname></term>
5505 <para>Projektbeschreibung</para>
5510 <term><varname>qty</varname></term>
5518 <term><varname>reqdate</varname></term>
5521 <para>Lieferdatum</para>
5526 <term><varname>runningnumber</varname></term>
5529 <para>Position auf der Rechnung (1, 2, 3...)</para>
5534 <term><varname>sellprice</varname></term>
5537 <para>Verkaufspreis</para>
5542 <term><varname>serialnumber</varname></term>
5545 <para>Seriennummer</para>
5550 <term><varname>tax_rate</varname></term>
5553 <para>Steuersatz</para>
5558 <term><varname>transdate_do</varname></term>
5561 <para>Datum des Lieferscheins, wenn die Rechnung im Rahmen des
5562 Workflows aus einem Lieferschein stammte.</para>
5567 <term><varname>transdate_oe</varname></term>
5570 <para>Datum des Auftrags, wenn die Rechnung im Rahmen des
5571 Workflows aus einem Auftrag erstellt wurde. Wenn es
5572 Sammelaufträge gab wird das Datum des ursprünglichen Auftrags
5578 <term><varname>transdate_quo</varname></term>
5581 <para>Datum des Angebots, wenn die Position im Rahmen des
5582 Workflows aus einem Angebot stammte.</para>
5587 <term><varname>unit</varname></term>
5590 <para>Einheit</para>
5595 <term><varname>weight</varname></term>
5598 <para>Gewicht</para>
5603 <para>Für jeden Posten gibt es ein Unterarray mit den Informationen
5604 über Lieferanten und Lieferantenartikelnummer. Diese müssen mit
5605 einer <function>foreach</function>-Schleife ausgegeben werden, da
5606 für jeden Artikel mehrere Lieferanteninformationen hinterlegt sein
5607 können. Die Variablen dafür lauten:</para>
5611 <term><varname>make</varname></term>
5614 <para>Lieferant</para>
5619 <term><varname>model</varname></term>
5622 <para>Lieferantenartikelnummer</para>
5628 <sect3 id="dokumentenvorlagen-und-variablen.invoice-zahlungen">
5629 <title>Variablen für die einzelnen Zahlungseingänge</title>
5633 <term><varname>payment</varname></term>
5641 <term><varname>paymentaccount</varname></term>
5649 <term><varname>paymentdate</varname></term>
5657 <term><varname>paymentmemo</varname></term>
5665 <term><varname>paymentsource</varname></term>
5674 <sect3 id="dokumentenvorlagen-und-variablen.benutzerdefinierte-variablen-vc">
5675 <title>Benutzerdefinierte Kunden- und Lieferantenvariablen</title>
5677 <para>Die vom Benutzer definierten Variablen für Kunden und
5678 Lieferanten stehen beim Ausdruck von Einkaufs- und Verkaufsbelegen
5679 ebenfalls zur Verfügung. Ihre Namen setzen sich aus dem Präfix
5680 <varname>vc_cvar_</varname> und dem vom Benutzer festgelegten
5681 Variablennamen zusammen.</para>
5683 <para>Beispiel: Der Benutzer hat eine Variable namens
5684 <varname>number_of_employees</varname> definiert, die die Anzahl der
5685 Mitarbeiter des Unternehmens enthält. Diese Variable steht dann
5686 unter dem Namen <varname>vc_cvar_number_of_employees</varname> zur
5689 <para>Die benutzerdefinierten Variablen der Lieferadressen stehen
5690 unter einem ähnlichen Namensschema zur Verfügung. Hier lautet der
5691 Präfix <varname>shiptocvar_</varname>.</para>
5693 <para>Analog stehen die benutzerdefinierten Variablen für
5694 Ansprechpersonen mit dem Namenspräfix <varname>cp_cvar_</varname>
5695 zur Verfügung.</para>
5699 <sect2 id="dokumentenvorlagen-und-variablen.dunning">
5700 <title>Variablen in Mahnungen und Rechnungen über Mahngebühren</title>
5702 <sect3 id="dokumentenvorlagen-und-variablen.dunning-vorlagennamen">
5703 <title>Namen der Vorlagen</title>
5705 <para>Die Namen der Vorlagen werden im System-Menü vom Benutzer
5706 eingegeben. Wird für ein Mahnlevel die Option zur automatischen
5707 Erstellung einer Rechnung über die Mahngebühren und Zinsen
5708 aktiviert, so wird der Name der Vorlage für diese Rechnung aus dem
5709 Vorlagenname für diese Mahnstufe mit dem Zusatz
5710 <constant>_invoice</constant> gebildet. Weiterhin werden die Kürzel
5711 für die ausgewählte Sprache und den ausgewählten Drucker
5715 <sect3 id="dokumentenvorlagen-und-variablen.dunning-allgemein">
5716 <title>Allgemeine Variablen in Mahnungen</title>
5718 <para>Die Variablen des Bearbeiters, bzw. Verkäufers stehen wie
5719 gewohnt als <varname>employee_...</varname> bzw.
5720 <varname>salesman_...</varname> zur Verfügung. Werden mehrere
5721 Rechnungen in einer Mahnung zusammengefasst, so werden die Metadaten
5722 (Bearbeiter, Abteilung, etc) der ersten angemahnten Rechnung im
5723 Ausdruck genommen.</para>
5725 <para>Die Adressdaten des Kunden stehen als Variablen
5726 <varname>name</varname>, <varname>street</varname>,
5727 <varname>zipcode</varname>, <varname>city</varname>,
5728 <varname>country</varname>, <varname>department_1</varname>,
5729 <varname>department_2</varname>, und <varname>email</varname> zur
5730 Verfügung. Der Ansprechpartner <varname>cp_...</varname> steht auch
5731 zu Verfügung, wird allerdings auch nur von der ersten angemahnten
5732 Rechnung (s.o.) genommen.</para>
5734 <para>Weitere Variablen beinhalten:</para>
5738 <term><varname>dunning_date</varname></term>
5741 <para>Datum der Mahnung</para>
5746 <term><varname>dunning_duedate</varname></term>
5749 <para>Fälligkeitsdatum für diese Mahhnung</para>
5754 <term><varname>dunning_id</varname></term>
5757 <para>Mahnungsnummer</para>
5762 <term><varname>fee</varname></term>
5765 <para>Kumulative Mahngebühren</para>
5770 <term><varname>interest_rate</varname></term>
5773 <para>Zinssatz per anno in Prozent</para>
5778 <term><varname>total_amount</varname></term>
5781 <para>Gesamter noch zu zahlender Betrag als
5782 <function>fee</function> + <function>total_interest</function>
5783 + <function>total_open_amount</function></para>
5788 <term><varname>total_interest</varname></term>
5791 <para>Zinsen per anno über alle Rechnungen</para>
5796 <term><varname>total_open_amount</varname></term>
5799 <para>Summe über alle offene Beträge der Rechnungen</para>
5805 <sect3 id="dokumentenvorlagen-und-variablen.dunning-details">
5806 <title>Variablen für jede gemahnte Rechnung in einer Mahnung</title>
5810 <term><varname>dn_amount</varname></term>
5813 <para>Rechnungssumme (brutto)</para>
5818 <term><varname>dn_duedate</varname></term>
5821 <para>Originales Fälligkeitsdatum der Rechnung</para>
5826 <term><varname>dn_dunning_date</varname></term>
5829 <para>Datum der Mahnung</para>
5834 <term><varname>dn_dunning_duedate</varname></term>
5837 <para>Fälligkeitsdatum der Mahnung</para>
5842 <term><varname>dn_fee</varname></term>
5845 <para>Kummulative Mahngebühr</para>
5850 <term><varname>dn_interest</varname></term>
5853 <para>Zinsen per anno für diese Rechnung</para>
5858 <term><varname>dn_invnumber</varname></term>
5861 <para>Rechnungsnummer</para>
5866 <term><varname>dn_linetotal</varname></term>
5869 <para>Noch zu zahlender Betrag (ergibt sich aus
5870 <varname>dn_open_amount</varname> + <varname>dn_fee</varname>
5871 + <varname>dn_interest</varname>)</para>
5876 <term><varname>dn_netamount</varname></term>
5879 <para>Rechnungssumme (netto)</para>
5884 <term><varname>dn_open_amount</varname></term>
5887 <para>Offener Rechnungsbetrag</para>
5892 <term><varname>dn_ordnumber</varname></term>
5895 <para>Bestellnummer</para>
5900 <term><varname>dn_transdate</varname></term>
5903 <para>Rechnungsdatum</para>
5908 <term><varname>dn_curr</varname></term>
5911 <para>Währung, in der die Rechnung erstellt wurde. (Die
5912 Rechnungsbeträge sind aber immer in der Hauptwährung)</para>
5918 <sect3 id="dokumentenvorlagen-und-variablen.dunning-invoice">
5919 <title>Variablen in automatisch erzeugten Rechnungen über
5920 Mahngebühren</title>
5922 <para>Die Variablen des Verkäufers stehen wie gewohnt als
5923 <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
5924 Kunden stehen als Variablen <varname>name</varname>,
5925 <varname>street</varname>, <varname>zipcode</varname>,
5926 <varname>city</varname>, <varname>country</varname>,
5927 <varname>department_1</varname>, <varname>department_2</varname>,
5928 und <varname>email</varname> zur Verfügung.</para>
5930 <para>Weitere Variablen beinhalten:</para>
5934 <term><varname>duedate</varname></term>
5937 <para>Fälligkeitsdatum der Rechnung</para>
5942 <term><varname>dunning_id</varname></term>
5945 <para>Mahnungsnummer</para>
5950 <term><varname>fee</varname></term>
5953 <para>Mahngebühren</para>
5958 <term><varname>interest</varname></term>
5966 <term><varname>invamount</varname></term>
5969 <para>Rechnungssumme (ergibt sich aus <varname>fee</varname> +
5970 <varname>interest</varname>)</para>
5975 <term><varname>invdate</varname></term>
5978 <para>Rechnungsdatum</para>
5983 <term><varname>invnumber</varname></term>
5986 <para>Rechnungsnummer</para>
5993 <sect2 id="dokumentenvorlagen-und-variablen.andere-vorlagen">
5994 <title>Variablen in anderen Vorlagen</title>
5997 <title>Einführung</title>
5999 <para>Die Variablen in anderen Vorlagen sind ähnlich wie in der
6000 Rechnung. Allerdings heißen die Variablen, die mit
6001 <varname>inv</varname> beginnen, jetzt anders. Bei den Angeboten
6002 fangen sie mit <varname>quo</varname> für "quotation" an:
6003 <varname>quodate</varname> für Angebotsdatum etc. Bei Bestellungen
6004 wiederum fangen sie mit <varname>ord</varname> für "order" an:
6005 <varname>ordnumber</varname> für Bestellnummer etc.</para>
6007 <para>Manche Variablen sind in anderen Vorlagen hingegen gar nicht
6008 vorhanden wie z.B. die für bereits verbuchte Zahlungseingänge. Dies
6009 sind Variablen, die vom Geschäftsablauf her in der entsprechenden
6010 Vorlage keine Bedeutung haben oder noch nicht belegt sein
6013 <para>Im Folgenden werden nur wichtige Unterschiede zu den Variablen
6014 in Rechnungen aufgeführt.</para>
6017 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-quotations">
6018 <title>Angebote und Preisanfragen</title>
6022 <term><varname>quonumber</varname></term>
6025 <para>Angebots- bzw. Anfragenummer</para>
6030 <term><varname>reqdate</varname></term>
6033 <para>Gültigkeitsdatum (bei Angeboten) bzw. Lieferdatum (bei
6034 Preisanfragen)</para>
6039 <term><varname>transdate</varname></term>
6042 <para>Angebots- bzw. Anfragedatum</para>
6048 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-orders">
6049 <title>Auftragsbestätigungen und Lieferantenaufträge</title>
6053 <term><varname>ordnumber</varname></term>
6056 <para>Auftragsnummer</para>
6061 <term><varname>reqdate</varname></term>
6064 <para>Lieferdatum</para>
6069 <term><varname>transdate</varname></term>
6072 <para>Auftragsdatum</para>
6078 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-delivery-orders">
6079 <title>Lieferscheine (Verkauf und Einkauf)</title>
6083 <term><varname>cusordnumber</varname></term>
6086 <para>Bestellnummer des Kunden (im Verkauf) bzw. Bestellnummer
6087 des Lieferanten (im Einkauf)</para>
6092 <term><varname>donumber</varname></term>
6095 <para>Lieferscheinnummer</para>
6100 <term><varname>transdate</varname></term>
6103 <para>Lieferscheindatum</para>
6108 <para>Für jede Position eines Lieferscheines gibt es ein Unterarray
6109 mit den Informationen darüber, von welchem Lager und Lagerplatz aus
6110 die Waren verschickt wurden (Verkaufslieferscheine) bzw. auf welchen
6111 Lagerplatz sie eingelagert wurden. Diese müssen mittels einer
6112 <function>foreach</function>-Schleife ausgegeben werden. Diese
6113 Variablen sind:</para>
6117 <term><varname>si_bin</varname></term>
6120 <para>Lagerplatz</para>
6125 <term><varname>si_chargenumber</varname></term>
6128 <para>Chargennummer</para>
6133 <term><varname>si_bestbefore</varname></term>
6136 <para>Mindesthaltbarkeit</para>
6141 <term><varname>si_number</varname></term>
6144 <para>Artikelnummer</para>
6149 <term><varname>si_qty</varname></term>
6152 <para>Anzahl bzw. Menge</para>
6157 <term><varname>si_runningnumber</varname></term>
6160 <para>Positionsnummer (1, 2, 3 etc)</para>
6165 <term><varname>si_unit</varname></term>
6168 <para>Einheit</para>
6173 <term><varname>si_warehouse</varname></term>
6182 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-statement">
6183 <title>Variablen für Sammelrechnung</title>
6187 <term><varname>c0total</varname></term>
6190 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit < 30
6196 <term><varname>c30total</varname></term>
6199 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 30
6200 und < 60 Tage</para>
6205 <term><varname>c60total</varname></term>
6208 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 60
6209 und < 90 Tage</para>
6214 <term><varname>c90total</varname></term>
6217 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 90
6223 <term><varname>total</varname></term>
6226 <para>Gesamtbetrag aller Rechnungen</para>
6231 <para>Variablen für jede Rechnungsposition in Sammelrechnung:</para>
6235 <term><varname>invnumber</varname></term>
6238 <para>Rechnungsnummer</para>
6243 <term><varname>invdate</varname></term>
6246 <para>Rechnungsdatum</para>
6251 <term><varname>duedate</varname></term>
6254 <para>Fälligkeitsdatum</para>
6259 <term><varname>amount</varname></term>
6262 <para>Summe der Rechnung</para>
6267 <term><varname>open</varname></term>
6270 <para>Noch offener Betrag der Rechnung</para>
6275 <term><varname>c0</varname></term>
6278 <para>Noch offener Rechnungsbetrag mit Fälligkeit < 30
6284 <term><varname>c30</varname></term>
6287 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 30 und
6293 <term><varname>c60</varname></term>
6296 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 60 und
6302 <term><varname>c90</varname></term>
6305 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 90
6313 <sect2 id="dokumentenvorlagen-und-variablen.bloecke">
6314 <title>Blöcke, bedingte Anweisungen und Schleifen</title>
6316 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.einfuehrung">
6317 <title>Einführung</title>
6319 <para>Der Parser kennt neben den Variablen einige weitere
6320 Konstrukte, die gesondert behandelt werden. Diese sind wie
6321 Variablennamen in spezieller Weise markiert:
6322 <command><%anweisung%> ... <%end%></command></para>
6324 <para>Anmerkung zum <command><%end%></command>: Der besseren
6325 Verständlichkeit halber kann man nach dem <command>end</command>
6326 noch beliebig weitere Wörter schreiben, um so zu markieren, welche
6327 Anweisung (z.B. <command>if</command> oder
6328 <command>foreach</command>) damit abgeschlossen wird.</para>
6330 <para>Beispiel: Lautet der Beginn eines Blockes z.B.
6331 <command><%if type == "sales_quotation"%></command>, so könnte
6332 er mit <command><%end%></command> genauso abgeschlossen werden
6333 wie mit <command><%end if%></command> oder auch
6334 <command><%end type == "sales_quotation"%></command>.</para>
6337 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.if">
6338 <title>Der if-Block</title>
6340 <programlisting><%if variablenname%>
6342 <%end%></programlisting>
6344 <para>Eine normale "if-then"-Bedingung. Die Zeilen zwischen dem "if"
6345 und dem "end" werden nur ausgegeben, wenn die Variable
6346 <varname>variablenname</varname> gesetzt und ungleich 0 ist.</para>
6348 <para>Handelt es sich bei der benannten Variable um ein Array, also
6349 um einen Variablennamen, über den man mit <command><%foreach
6350 variablenname%></command> iteriert, so wird mit diesem Konstrukt
6351 darauf getestet, ob das Array Elemente enthält. Somit würde im
6352 folgenden Beispiel nur dann eine Liste von Zahlungseingängen samt
6353 ihrer Überschrift "Zahlungseingänge" ausgegeben, wenn tatsächlich
6354 welche getätigt wurden:</para>
6356 <programlisting><%if payment%>
6358 <%foreach payment%>
6359 Am <%paymentdate%>: <%payment%> €
6360 <%end foreach%>
6361 <%end if%></programlisting>
6363 <para>Die Bedingung kann auch negiert werden, indem das Wort
6364 <function>not</function> nach dem <filename>if</filename> verwendet
6365 wird. Beispiel:</para>
6367 <programlisting><%if not cp_greeting%>
6369 <%end%></programlisting>
6371 <para>Zusätzlich zu dem einfachen Test, ob eine Variable gesetzt ist
6372 oder nicht, bietet dieser Block auch die Möglichkeit, den Inhalt
6373 einer Variablen mit einer festen Zeichenkette oder einer anderen
6374 Variablen zu vergleichen. Ob der Vergleich mit einer Zeichenkette
6375 oder einer anderen Variablen vorgenommen wird, hängt davon ab, ob
6376 die rechte Seite des Vergleichsoperators in Anführungszeichen
6377 gesetzt wird (Vergleich mit Zeichenkette) oder nicht (Vergleich mit
6378 anderer Variablen). Zwei Beispiele, die beide Vergleiche
6381 <programlisting><%if var1 == "Wert"%></programlisting>
6383 <para>Testet die Variable <varname>var1</varname> auf
6384 übereinstimmung mit der Zeichenkette <constant>Wert</constant>.
6385 Mittels <function>!=</function> anstelle von <function>==</function>
6386 würde auf Ungleichheit getestet.</para>
6388 <programlisting><%if var1 == var2%></programlisting>
6390 <para>Testet die Variable <varname>var1</varname> auf
6391 übereinstimmung mit der Variablen <varname>var2</varname>. Mittel
6392 <function>!=</function> anstelle von <function>==</function> würde
6393 auf Ungleichheit getestet.</para>
6395 <para>Erfahrere Benutzer können neben der Tests auf (Un-)Gleichheit
6396 auch Tests auf Übereinstimmung mit regulären Ausdrücken ohne
6397 Berücksichtung der Groß- und Kleinschreibung durchführen. Dazu dient
6398 dieselbe Syntax wie oben nur mit <function>=~</function> und
6399 <function>!~</function> als Vergleichsoperatoren.</para>
6401 <para>Beispiel für einen Test, ob die Variable
6402 <varname>intnotes</varname> (interne Bemerkungen) das Wort
6403 <constant>schwierig</constant> enthält:</para>
6405 <programlisting><%if intnotes =~ "schwierig"%></programlisting>
6408 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.foreach">
6409 <title>Der foreach-Block</title>
6411 <programlisting><%foreach variablenname%>
6413 <%end%></programlisting>
6415 <para>Fügt die Zeilen zwischen den beiden Anweisungen so oft ein,
6416 wie das Perl-Array der Variablen <varname>variablenname</varname>
6417 Elemente enthät. Dieses Konstrukt wird zur Ausgabe der einzelnen
6418 Posten einer Rechnung / eines Angebots sowie zur Ausgabe der Steuern
6419 benutzt. In jedem Durchlauf werden die <link
6420 linkend="dokumentenvorlagen-und-variablen.invoice-posten">zeilenbezogenen
6421 Variablen</link> jeweils auf den Wert für die aktuelle Position
6424 <para>Die Syntax sieht normalerweise wie folgt aus:</para>
6426 <programlisting><%foreach number%>
6427 Position: <%runningnumber%>
6428 Anzahl: <%qty%>
6429 Artikelnummer: <%number%>
6430 Beschreibung: <%description%>
6432 <%end%></programlisting>
6434 <para>Besonderheit in OpenDocument-Vorlagen: Tritt ein
6435 <function><%foreach%></function>-Block innerhalb einer
6436 Tabellenzelle auf, so wird die komplette Tabellenzeile so oft
6437 wiederholt wie notwendig. Tritt er außerhalb auf, so wird nur der
6438 Inhalt zwischen <function><%foreach%></function> und
6439 <function><%end%></function> wiederholt, nicht aber die
6440 komplette Zeile, in der er steht.</para>
6444 <sect2 id="dokumentenvorlagen-und-variablen.markup">
6445 <title>Markup-Code zur Textformatierung innerhalb von
6448 <para>Wenn der Benutzer innhalb von Formularen in kivitendo Text
6449 anders formatiert haben möchte, so ist dies begrenzt möglich.
6450 kivitendo unterstützt die Textformatierung mit HTML-ähnlichen Tags.
6451 Der Benutzer kann z.B. bei der Artikelbeschreibung auf einer Rechnung
6452 Teile des Texts zwischen Start- und Endtags setzen. Dieser Teil wird
6453 dann automatisch in Anweisungen für das ausgewählte Vorlagenformat
6454 (HTML oder PDF über LaTeX) umgesetzt.</para>
6456 <para>Die unterstützen Formatierungen sind:</para>
6460 <term><b>Text</b></term>
6463 <para>Text wird in Fettdruck gesetzt.</para>
6468 <term><i>Text</i></term>
6471 <para>Text wird kursiv gesetzt.</para>
6476 <term><u>Text</u></term>
6479 <para>Text wird unterstrichen.</para>
6484 <term><s>Text</s></term>
6487 <para>Text wird durchgestrichen. Diese Formatierung ist nicht
6488 bei der Ausgabe als PDF über LaTeX verfügbar.</para>
6493 <term><bullet></term>
6496 <para>Erzeugt einen ausgefüllten Kreis für Aufzählungen (siehe
6502 <para>Der Befehl <command><bullet></command> funktioniert
6503 momentan auch nur in Latex-Vorlagen.</para>
6506 <sect2 id="dokumentenvorlagen-und-variablen.anrede"
6507 xreflabel="Hinweise zur Anrede">
6508 <title>Hinweise zur Anrede</title>
6510 <para>Das Flag "natürliche Person"
6511 (<varname>natural_person</varname>) aus den Kunden- oder
6512 Lieferantenstammdaten kann in den Druckvorlagen zusammen mit
6513 dem Feld "Anrede" (<varname>greeting</varname>) z.B. dafür
6514 verwendet werden, die Anrede zwischen einer allgemeinen und
6515 einer persönlichen Anrede zu unterscheiden.
6516 <programlisting><%if natural_person%><%greeting%> <%name%><%else%>Sehr geehrte Damen und Herren<%end if%></programlisting>
6522 <sect1 id="excel-templates">
6523 <title>Excel-Vorlagen</title>
6525 <sect2 id="excel-templates.summary">
6526 <title>Zusammenfassung</title>
6528 <para>Dieses Dokument beschreibt den Mechanismus, mit dem
6529 Exceltemplates abgearbeitet werden, und die Einschränkungen, die damit
6533 <sect2 id="excel-templates.usage">
6534 <title>Bedienung</title>
6536 <para>Der Excel Mechanismus muss in der Konfigurationsdatei aktiviert
6537 werden. Die Konfigurationsoption heißt <varname>excel_templates =
6538 1</varname> im Abschnitt <varname>[print_templates]</varname>.</para>
6540 <para>Eine Excelvorlage kann dann unter dem Namen einer beliebigen
6541 anderen Vorlage mit der Endung <filename>.xls</filename> gespeichert
6542 werden. In den normalen Verkaufsmasken taucht nun
6543 <constant>Excel</constant> als auswählbares Format auf und kann von da
6544 an wie LaTeX- oder OpenOffice-Vorlagen benutzt werden.</para>
6546 <para>Der Sonderfall der Angebote aus der Kundenmaske ist ebenfalls
6547 eine Angebotsvorlage und wird unter dem internen Namen der Angebote
6548 <filename>sales_quotation.xls</filename> gespeichert.</para>
6551 <sect2 id="excel-templates.syntax">
6552 <title>Variablensyntax</title>
6554 <para>Einfache Syntax:
6555 <command><<varname>></command></para>
6557 <para>Dabei sind <constant><<</constant> und
6558 <constant>>></constant> die Delimiter. Da Excel auf festen
6559 Breiten besteht, kann der Tag künstlich verlängert werden, indem
6560 weitere <constant><</constant> oder <constant>></constant>
6561 eingefügt werden. Der Tag muss nicht symmetrisch sein.
6564 <programlisting><<<<<varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
6566 <para>Um die Limitierung der festen Breite zu reduzieren, können
6567 weitere Variablen in einem Block interpoliert werden. Whitespace wird
6568 dazwishen dann erhalten. Beispiel:</para>
6570 <programlisting><<<<<varname1 varname2 varname3>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
6572 <para>Die Variablen werden interpoliert, und linksbündig mit
6573 Leerzeichen auf die gewünschte Länge aufgefüllt. Ist der String zu
6574 lang, werden überzählige Zeichen abgeschnitten.</para>
6576 <para>Es ist ausserdem möglich, Daten rechtsbündig darzustellen, wenn
6577 der Block mit einem Leerzeichen anfängt. Beispiel:</para>
6579 <programlisting><<<<<< varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
6581 <para>Dies würde rechtsbündig triggern. Wenn bei rechtsbündiger
6582 Ausrichtung Text abgeschnitten werden muss, wird er vom linken Ende
6586 <sect2 id="excel-templates.limitations">
6587 <title>Einschränkungen</title>
6589 <para>Das Excelformat bis 2002 ist ein binäres Format, und kann nicht
6590 mit vertretbarem Aufwand editiert werden. Der Templatemechanismus
6591 beschränkt sich daher darauf, Textstellen exakt durch einen anderen
6592 Text zu ersetzen.</para>
6594 <para>Aus dem gleichen Grund sind die Kontrolllstrukturen
6595 <command><%if%></command> und
6596 <command><%foreach%></command> nicht vorhanden. Der Delimiter
6597 <constant><% %></constant> kommt in den Headerinformationen
6598 evtl. vor. Deshalb wurde auf den sichereren Delimiter
6599 <constant><<</constant> und <constant>>></constant>
6604 <sect1 id="features.warehouse">
6605 <title>Mandantenkonfiguration Lager</title>
6607 <para>Die Lagerverwaltung in kivitendo funktioniert standardmässig wie
6608 folgt: Wird ein Lager mit einem Lagerplatz angelegt, so gibt es die
6609 Möglichkeit hier über den Menüpunkt Lager entsprechende Warenbewegungen
6610 durchzuführen. Ferner kann jede Position eines Lieferscheins ein-, bzw.
6611 ausgelagert werden (Einkauf-, bzw. Verkauf). Es können beliebig viele
6612 Lager mit beliebig vielen Lagerplätzen abgebildet werden. Die
6613 Lagerbewegungen über einen Lieferschein erfolgt durch Anklicken jeder
6614 Einzelposition und das Auswählen dieser Position zu einem Lager mit
6615 Lagerplatz. Dieses Verfahren lässt sich schrittweise vereinfachen, je
6616 nachdem wie die Einstellungen in der Mandatenkonfiguration gesetzt
6621 <para><option>Auslagern über Standardlagerplatz</option> Hier wird
6622 ein zusätzlicher Knopf (Auslagern über Standard-Lagerplatz) in dem
6623 Lieferschein-Beleg hinzugefügt, der dann alle Lagerbewegungen über
6624 den Standardlagerplatz (konfigurierbar pro Ware) durchführt.</para>
6628 <para><option>Auslagern ohne Bestandsprüfung</option> Das obige
6629 Auslagern schlägt fehl, wenn die entsprechende Menge für die
6630 Lagerbewegung nicht vorhanden ist, möchte man dies auch ignorieren
6631 und ggf. dann nachpflegen, so kann man eine Negativ-Warenmenge mit
6632 dieser Option erlauben. Hierfür muss ein entsprechender Lagerplatz
6633 (Fehlbestand, o.ä.) konfiguriert sein.</para>
6637 <para>Zusätzliche Funktionshinweise:</para>
6641 <para><option>Standard-Lagerplatz</option> Ist dieser konfiguriert,
6642 wird dies auch als Standard-Voreinstellung bei der Neuerfassung von
6643 Stammdaten → Waren / Dienstleistung / Erzeugnis verwendet.</para>
6647 <para><option>Standard-Lagerplatz verwenden, falls keiner in
6648 Stammdaten definiert</option> Wird beim 'Auslagern über
6649 Standardlagerplatz' keine Standardlagerplatz zu der Ware gefunden,
6650 so wird mit dieser Option einfach der Standardlagerplatz
6656 <sect1 id="features.swiss-charts-of-accounts">
6657 <title>Schweizer Kontenpläne</title>
6659 <para>Seit der Version 3.5 stehen in kivitendo 3 Kontenpläne für den
6660 Einsatz in der Schweiz zur Verfügung, einer für Firmen und
6661 Organisationen, die nicht mehrwertsteuerpflichtig sind, einer für
6662 Firmen, die mehrwertsteuerpflichtig sind und einer speziell für
6665 <para>Die Kontenpläne orientieren sich am in der Schweiz üblicherweise
6666 verwendeten KMU-Kontenrahmen und sind mit der Revision des
6667 Schweizerischen Obligationenrechts (OR) vom 1.1.2013 kompatibel,
6668 insbesondere <literal>Art.957a Abs.2</literal>.</para>
6670 <para>Beim Vereinskontenplan sind standardmässig nur die Konten 1100
6671 (Debitoren CHF) und 1101 (Debitoren EUR) als Buchungskonten im Verkauf
6672 sowie die Konten 2000 (Kreditoren CHF) und 2001 (Kreditoren EUR) als
6673 Buchungskonten im Einkauf vorgesehen. Weitere Konten können bei Bedarf
6674 in den Konto-Detaileinstellungen als Einkaufs- oder Verkaufskonten
6675 konfiguriert werden.</para>
6677 <para>Die Möglichkeit, Saldosteuersätze zu verwenden ist in der
6678 aktuellen Version von kivitendo noch nicht integriert.</para>
6680 <para>Trotzdem können auch Firmen, die per Saldosteuersatz mit der
6681 Eidgenössischen Steuerverwaltung abrechnen, kivitendo bereits nutzen.
6682 Dazu wird der Kontenplan mit MWST ausgewählt. Anschliessend müssen alle
6683 Aufwandskonten editiert werden und dort der Steuersatz auf 0% gesetzt
6686 <para>So werden bei Kreditorenbuchungen keine Vorsteuern
6689 <para>Bezugssteuern für aus dem Ausland bezogene Dienstleistungen müssen
6690 manuell verbucht werden.</para>
6692 <para>Wünsche für Anpassungen an den Schweizer Kontenplänen sowie
6693 Vorschläge für weitere (z.B. branchenspezifische) Kontenpläne bitte an
6694 <literal>empfang@revamp-it.ch</literal> senden.</para>
6697 <sect1 id="features.part_classification">
6698 <title>Artikelklassifizierung</title>
6701 <title>Übersicht</title>
6703 <para>Die Klassifizierung von Artikeln dient einer weiteren
6704 Gliederung, um zum Beispiel den Einkauf vom Verkauf zu trennen,
6705 gekennzeichnet durch eine Beschreibung (z.B. "Einkauf") und ein Kürzel
6706 (z.B. "E"). Für jede Klassifizierung besteht eine Beschreibung und
6707 eine Abkürzung die normalerweise aus einem Zeichen besteht, kann aber
6708 auf mehrere Zeichen erweitert werden, falls zur Unterscheidung
6709 notwendig. Sinnvoll sind jedoch nur maximal 2 Zeichen.</para>
6713 <title>Basisklassifizierung</title>
6715 <para>Als Basisklassifizierungen gibt es</para>
6719 <para>Einkauf</para>
6723 <para>Verkauf</para>
6727 <para>Handelsware</para>
6731 <para>Produktion</para>
6735 <para>- keine - (diese wird bei einer Aktualisierung für alle
6736 existierenden Artikel verwendet und ist gültig für Verkauf und
6741 <para>Es können weitere Klassifizierungen angelegt werden. So kann es
6742 z.B. für separat auszuweisende Artikel folgende Klassen geben:</para>
6746 <para>Lieferung (Logistik, Transport) mit Kürzel L</para>
6750 <para>Material (Verpackungsmaterial) mit Kürzel M</para>
6756 <title>Attribute</title>
6758 <para>Bisher haben die Klassifizierungen folgende Attribute, die auch
6759 alle gleichzeitg gültig sein können</para>
6763 <para>gültig für Verkauf - dieser Artikel kann im Verkauf genutzt
6768 <para>gültig für Einkauf - dieser Artikel kann im Einkauf genutzt
6773 <para>separat ausweisen - hierzu gibt es zur Dokumentengenerierung
6774 (LaTeX) eine zusätzliche Variable</para>
6778 <para>Für das Attribut "separat ausweisen" stehen in den
6779 LaTeX-Vorlagen die Variable <emphasis
6780 role="bold"><%non_separate_subtotal%> </emphasis>zur Verfügung,
6781 die alle nicht separat auszuweisenden Artikelkosten saldiert, sowie
6782 pro separat auszuweisenden Klassifizierungen die Variable<emphasis
6783 role="bold">< %separate_X_subtotal%></emphasis>, wobei X das
6784 Kürzel der Klassifizierung ist.</para>
6786 <para>Im obigen Beispiel wäre das für Lieferkosten <emphasis
6787 role="bold"><%separate_L_subtotal%></emphasis> und für
6788 Verpackungsmaterial <emphasis role="bold">
6789 <%separate_M_subtotal%></emphasis>.</para>
6793 <title>Zwei-Zeichen Abkürzung</title>
6795 <para>Der Typ des Artikels und die Klassifizierung werden durch zwei
6796 Buchstaben dargestellt. Der erste Buchstabe ist eine Lokalisierung des
6797 Artikel-Typs ('P','A','S'), deutsch 'W', 'E', und 'D' für Ware
6798 Erzeugnis oder Dienstleistung und ggf. weiterer Typen.</para>
6800 <para>Der zweite Buchstabe (und ggf. auch ein dritter, falls nötig)
6801 entspricht der lokalisierten Abkürzung der Klassifizierung.</para>
6803 <para>Diese Abkürzung wird überall beim Auflisten von Artikeln zur
6804 Erleichterung mit dargestellt.</para>
6808 <sect1 id="features.file_managment">
6809 <title>Dateiverwaltung (Mini-DMS)</title>
6812 <title>Übersicht</title>
6814 <para>Parallel zum alten WebDAV gibt es ein Datei-Management-System,
6815 das Dateien verschiedenen Typs verwaltet. Dies können</para>
6819 <para>aus ERP-Daten per LaTeX Template erzeugte
6820 PDF-Dokumente,</para>
6824 <para>zu bestimmten ERP-Daten gehörende Anhangdateien
6825 unterschiedlichen Formats,</para>
6829 <para>per Scanner eingelesene PDF-Dateien,</para>
6833 <para>per E-Mail empfangene Dateianhänge unterschiedlichen
6838 <para>sowie speziel für Artikel hochgeladene Bilder sein.</para>
6843 <screeninfo>Übersicht</screeninfo>
6847 <imagedata contentwidth="600" fileref="images/DMS-Overview.png"/>
6854 <title>Struktur</title>
6856 <para>Über eine vom Speichermedium unabhängige Zwischenschicht werden
6857 die Dateien und ihre Versionen in der Datenbank verwaltet. Darunter
6858 können verschiedene Implementierungen (Backends) gleichzeitig
6863 <para>Dateisystem</para>
6871 <para>Schnittstelle zu externen
6872 Dokumenten-Management-Systemen</para>
6876 <para>andere Datenbank</para>
6880 <para>etc ...</para>
6884 <para>Es gibt unterschiedliche Typen von Dateien. Jedem Typ läßt sich
6885 in der Mandantenkonfiguration ein bestimmtes Backend zuordnen.</para>
6889 <para>"document": Das sind entweder generierte, eingescannte oder
6890 hochgeladene PDF-Dateien, die zu bestimmten ERP-Daten
6891 (ERP-Objekte, wie z.B. Rechnung, Lieferschein) gehören.</para>
6895 <para>"attachment": zusätzlich hochgeladene Dokumente, die an
6896 bestimmte ERP-Objekte angehängt werden, z.B. technische
6897 Zeichnungen, Aufmaße. Diese können auch für Artikel, Lieferanten
6898 und Kunden hinterlegt sein.</para>
6902 <para>"image": Bilder für Artikel. Diese können auch verkleinert
6903 in einer Vorschau (Thumbnail) angezeigt werden.</para>
6907 <para>Zusätzlich werden in der Datenbank zu den Dateien neben der
6908 Zuordnung zu ERP-Objekten, Dateityp Dateinamen und Backend, in dem die
6909 Datei gespeichert ist, auch die Quelle der Datei notiert:</para>
6913 <para>"created": vom System erzeugte Dokumente"</para>
6917 <para>"uploaded": hochgeladene Dokumente</para>
6921 <para>"email": vom Mail-System empfangene Dateien</para>
6925 <para>"scanner[1]": von einem oder mehreren Scannern erzeugte
6926 Dateien. Existieren mehrere Scanner, so sind diese durch
6927 unterschiedliche Quellennamen zu definieren.</para>
6931 <para>Je nach Dateityp sind nur bestimmte Quellen zulässig. So gibt es
6932 für "attachment" und "image" nur die Quelle "uploaded". Für "document"
6933 gibt es auf jeden Fall die Quelle "created". Die Quellen "scanner" und
6934 "email" müssen derzeit in der Datenbank konfiguriert werden (siehe
6935 <xref linkend="file_management.dbconfig"/>).</para>
6939 <title>Anwendung</title>
6941 <para>Die Daten werden bei den ERP-Objekten als extra Reiter
6942 dargestellt. Eine Verkaufsrechnung z.B. hat die Reiter "Dokumente" und
6943 "Dateianhänge".</para>
6946 <screeninfo>Reiter "Dateianhänge"</screeninfo>
6950 <imagedata fileref="images/DMS-Anhaenge.png" scale="50"/>
6955 <para>Bei den Dateianhängen wird immer nur die aktuelle Version einer
6956 Datei angezeigt. Wird eine Datei mit gleichem Namen hochgeladen, so
6957 wird eine neue Version der Datei erstellt. Vorher wird der Anwender
6958 durch einen Dialog gefragt, ob er eine neue Version anlegen will oder
6959 ob er die Datei umbenennen will, falls es eine neue Datei sein
6963 <screeninfo>Reiter "Dateianhänge"</screeninfo>
6967 <imagedata contentwidth="40"
6968 fileref="images/DMS-Anhaenge-hochladen.png"
6974 <para>Es können mehrere Dateien gleichzeitig hochgeladen werden,
6975 solange in Summe die maximale Größe nicht überschritten wird (siehe
6976 <xref linkend="file_management.clientconfig"/>).</para>
6979 <screeninfo>Reiter "Dokumente"</screeninfo>
6983 <imagedata fileref="images/DMS-Dokumente.png" width="500"/>
6988 <para>Sind keine weiteren Quellen für Dokumente konfiguriert, so gibt
6989 es nur "erzeugte Dokumente". Es werden alle Versionen der generierten
6990 Datei angezeigt. Für Verkaufsrechnungen kommen keine anderen Quellen
6991 zur Geltung. Werden entsprechend der <xref
6992 linkend="file_management.dbconfig"/> zusätzliche Quellen konfiguriert,
6993 so sind diese z.B. bei Einkaufsrechnungen sichtbar:</para>
6996 <screeninfo>Reiter "Dokumente"</screeninfo>
7000 <imagedata contentwidth="600"
7001 fileref="images/DMS-Dokumente-Scanner.png"/>
7006 <para>Statt des Löschens wird hier die Datei zurück zur Quelle
7007 verschoben. Somit kann die Datei anschließend an ein anderes
7008 ERP-Objekt angehängt werden.</para>
7010 <para>Derzeit sind "Titel" und "Beschreibung" noch nicht genutzt. Sie
7011 sind bisher nur bei Bildern relevant.</para>
7015 <title>Konfigurierung</title>
7017 <sect3 id="file_management.clientconfig"
7018 xreflabel="Mandantenkonfigurierung">
7019 <title>Mandantenkonfiguration</title>
7022 <title>Reiter "Features"</title>
7024 <para>Unter dem Reiter <emphasis role="bold">Features</emphasis>
7025 im Abschnitt Dateimanagement ist neben dem "alten" WebDAV das
7026 Dateimangement generell zu- und abschaltbar, sowie die Zuordnung
7027 der Dateitypen zu Backends. Die Löschbarkeit von Dateien, sowie
7028 die maximale Uploadgröße sind Backend-unabhängig</para>
7031 <screeninfo>Mandantenkonfig Reiter "Features"</screeninfo>
7035 <imagedata fileref="images/DMS-ClientConfig.png" width="500"/>
7040 <para>Die einzelnen Backends sind einzeln einschaltbar.
7041 Spezifische Backend-Konfigurierungen sind hier noch
7046 <title>Reiter "Allgemeine Dokumentenanhänge"</title>
7048 <para>Unter dem Reiter <emphasis role="bold">Allgemeine
7049 Dokumentenanhänge</emphasis> kann für alle ERP-Dokumente (
7050 Angebote, Aufträge, Lieferscheine, Rechnungen im Verkauf und
7051 Einkauf ) allgemeingültige Anhänge hochgeladen werden.</para>
7054 <screeninfo>Mandantenkonfig Reiter "Allgemeine
7055 Dokumentenanhänge"</screeninfo>
7059 <imagedata fileref="images/DMS-Allgemeine-Dokumentenanhaenge.png"
7065 <para>Diese Anhänge werden beim Generieren von PDF-Dateien an die
7066 ERP-Dokumente angehängt, z.B. AGBs oder aktuelle Angebote. Es
7067 werden in dem Fall die Daten kopiert, sodass an den ERP-Dokumenten
7068 immer die Anhänge zum Generierungszeitpunkt eingebettet
7073 <sect3 id="file_management.dbconfig"
7074 xreflabel="Datenbank-Konfigurierung">
7075 <title>Datenbank-Konfigurierung</title>
7077 <para>Die zusätzlichen Quellen für "email" oder ein oder mehrere
7078 Scanner sind derzeit vom Administrator direkt in der
7079 Datenbanktabelle "user_preferences" einzurichten. Die "value" ist im
7080 JSON-Format mit den jeweiligen Werten des Verzeichnisses und der
7081 Beschreibung der Quelle.</para>
7084 id | login | namespace | version | key | value
7085 ----+-----------+--------------+---------+----------+---------------------------
7086 1 | #default# | file_sources | 0.00000 | scanner1 |
7087 {"dir":"/var/tmp/scanner1","desc":"Scanner Einkauf"}
7088 2 | #default# | file_sources | 0.00000 | scanner2 |
7089 {"dir":"/var/tmp/scanner2","desc":"Scanner Verkauf"}
7090 3 | #default# | file_sources | 0.00000 | emails |
7091 {"dir":"/var/tmp/emails","desc":"Empfangene Mails" }
7094 <para>Es ist daran gedacht, statt dem Default-Eintrag später für
7095 bestimmte Benutzer ('login') bestimmte Quellen zuzulassen. Dies wird
7096 nach Bedarf implementiert.</para>
7099 <sect3 id="file_management.kiviconfig"
7100 xreflabel="kivitendo-Konfigurationsdatei">
7101 <title>kivitendo-Konfigurationsdatei</title>
7103 <para>Dort ist im Abschnitt [paths] der relative oder absolute Pfad
7104 zum Dokumentenwurzelverzeichnis einzutragen. Dieser muss für den
7105 Webserver schreib- und lesbar sein, jedoch nicht ausführbar.</para>
7109 document_path = /var/local/kivi_documents
7112 <para>Unter diesem Wurzelverzeichnis wird pro Mandant automatisch
7113 ein Unterverzeichnis mit der ID des Mandanten angelegt.</para>
7119 <title>Webshop-Api</title>
7121 <para>Das Shopmodul bietet die Möglichkeit Onlineshopartikel und
7122 Onlineshopbestellungen zu verwalten und zu bearbeiten.</para>
7124 <para>Es ist Multishopfähig, d.h. Artikel können mehreren oder
7125 unterschiedlichen Shops zugeordnet werden. Bestellungen können aus
7126 mehreren Shops geholt werden.</para>
7128 <para>Zur Zeit bietet das Modul nur einen Connector zur REST-Api von
7129 Shopware. Weitere Connectoren können dazu programmiert und eingerichtet
7133 <title>Rechte für die Webshopapi</title>
7135 <para>In der Administration können folgende Rechte vergeben
7140 <para>Webshopartikel anlegen und bearbeiten</para>
7144 <para>Shopbestellungen holen und bearbeiten</para>
7148 <para>Shop anlegen und bearbeiten</para>
7154 <title>Konfiguration</title>
7156 <para>Unter System->Webshops können Shops angelegt und konfiguriert
7161 <imagedata contentdepth="500" contentwidth="700"
7162 fileref="images/Shop_Listing.png"/>
7168 <title>Webshopartikel</title>
7171 <title>Shopvariablenreiter in Artikelstammdaten</title>
7173 <para>Mit dem Recht "Shopartikel anlegen und bearbeiten" und des
7174 Markers <emphasis role="bold">"Shopartikel" in den Basisdaten
7175 </emphasis>zeigt sich der Reiter "Shopvariablen" in den
7176 Artikelstammdaten. Hier können jetzt die Artikel mit
7177 unterschiedlichen Beschreibung und/oder Preisen für die
7178 konfigutierten Shops angelegt und bearbeitet werden. An dieser
7179 Stelle können auch beliebig viele Bilder dem Shopartikel zugeordnet
7180 werden. Artikelbilder gelten für alle Shops.</para>
7184 <imagedata contentdepth="500" contentwidth="600"
7185 fileref="images/Shop_Artikel.png"/>
7189 <para>Die Artikelgruppen werden direkt vom Shopsystem geholt somit
7190 ist es möglich einen Artikel auch mehreren Gruppen
7195 <title>Shopartikelliste</title>
7197 <para>Unter dem Menu Webshop->Webshop Artikel hat man nochmal
7198 eine Gesamtübersicht. Von hier aus ist es möglich Artikel im Stapel
7199 unter verschiedenen Kriterien <alles><nur Preis><nur
7200 Bestand><Preis und Bestand> an die jeweiligen Shops
7205 <imagedata fileref="images/Shop_Artikel_Listing.png"/>
7212 <title>Bestellimport</title>
7214 <para>Unter dem Menupunkt Webshop->Webshop Import öffnet sich die
7215 Bestellimportsliste. Hier ist sind Möglichkeiten gegeben Neue
7216 Bestellungen vom Shop abzuholen, geholte Bestellungen im Stapel oder
7217 einzeln als Auftrag zu transferieren. Die Liste kann nach
7218 verschiedenen Kriterien gefiltert werden.</para>
7222 <imagedata fileref="images/Shop_Bestell.png"/>
7226 <para>Bei Einträgen in der Liste.</para>
7230 <para>keine Kundennummer: Es gibt ähnliche Kundendatensätze und
7231 der Datensatz konnte nicht eindeutig zugewiesen werden.</para>
7235 <para>Kundennummer und Rechnungen rot hinterlegt: Der Kunde hat
7236 offene Posten und kann deswegen nicht im Stapel übernommen
7241 <para>Rechnungsadresse grün hinterlegt: Der Kunde konnte eindeutig
7242 einem Datensatz zugeordnet werden. Die Shopbestellung kann im
7243 Stapel mit dem Button "Anwenden" und wenn markiert als Auftrag
7244 übernommen werden.</para>
7248 <para>Kundennummer vorhanden, aber die Checkbox "Auftrag
7249 erstellen" fehlt. Der Kunde hat vermutlich eine
7250 Shopauftragssperre.</para>
7254 <para>Lieferadresse grau hinterlegt: Optische Anzeige, dass es
7255 sich um eine unterschiedliche Lieferadresse handelt.
7256 Lieferadressen werden aber grundsätzlich beim Transferieren zu
7257 Aufträgen mit übernommen.</para>
7261 <para>In der Spalte Positionen/Betrag/Versandkosten zeigt sich ein
7262 tooltip zu den Positionen.</para>
7266 <para>Maske Auftrag erstellen</para>
7268 <para>Viele Shopsysteme haben drei verschieden Adresstypen Kunden-,
7269 Rechnungs-, und Lieferadresse, die sich auch alle unterscheiden
7270 können. Diese werden im oberen Bereich angezeigt. Es ist möglich jede
7271 dieser Adresse einzeln in kivitendo als Kunde zu übernehmen. Es werden
7272 die Werte Formulareingabe übernommen. Es wird bei einer Änderung
7273 allerdings nur diese in die kivitendo Kundenstammdaten übernommen, die
7274 Shopbestellung bleibt bestehen.</para>
7276 <para>Mit der mittleren Adresse(Rechnungsadresse) im oberen Bereich,
7277 kann ich den ausgewählten kivitendodatensatz des mittleren Bereich
7278 überschreiben. Das ist sinnvoll, wenn ich erkenne, das der Kunde z.B.
7279 umgezogen ist.</para>
7281 <para>Im mittleren Bereich das Adresslisting zeigt:</para>
7285 <para>Rot hinterlegt: Kunde hat eine Shopauftragssperre, diese
7286 muss zuerst deaktiviert werden bevor ich diesem Kunden eine
7287 Shopbestellung zuordnen kann.</para>
7291 <para>Kundenname fett und rot: Hier hat der Kunde eine Bemerkung
7292 in den Stammdaten. Ein Tooltip zeigt diese Bemerkung. Das kann dan
7293 auch der Grund für die Auftragssperre sein.</para>
7297 <para>Die Buttons "Auftrag erstellen" und "Kunde mit
7298 Rechnungsadresse überschreiben" zeigen sich erst, wenn ein Kunde
7299 aus dem Listing ausgewählt ist.</para>
7303 <para>Es ist aber möglich die Shopbestellung zu löschen.</para>
7307 <para>Ist eine Bestellung schon übernommen, zeigen sich an dieser
7308 Stelle, die dazugehörigen Belegverknüpfungen.</para>
7314 <title>Mapping der Daten</title>
7316 <para>Das Mapping der kivitendo Daten mit den Shopdaten geschieht in
7317 der Datei SL/ShopConnector/<SHOPCONNECTORNAME>.pm
7318 z.B.:SL/ShopConnector/Shopware.pm</para>
7320 <para>In dieser Datei gibt es einen Bereich wo die Bestellpostionen,
7321 die Bestellkopfdaten und die Artikeldaten gemapt werden. In dieser
7322 Datei kann ein individelles Mapping dann gemacht werden. Zu Shopware
7323 gibt es hier eine sehr gute Dokumentation: <ulink
7324 url="https://developers.shopware.com/developers-guide/rest-api/">https://developers.shopware.com/developers-guide/rest-api/</ulink></para>
7327 <sect1 id="features.zugferd">
7328 <title>ZUGFeRD Rechnungen</title>
7329 <sect2 id="features.zugferd.preamble">
7330 <title>Vorbedingung</title>
7332 Für die Erstellung von ZUGFeRD PDFs wird TexLive2018 oder höher benötigt.
7336 Wer kein TexLive2018 oder höher installieren kann, kann eine lokale Umgebung nur für kivitendo wie folgt erzeugen:
7339 1. Download des offiziellen Installers von https://www.tug.org/texlive/quickinstall.html
7341 2. Installer ausführen, Standard-Ort für Installation belassen, evtl. ein paar Pakete abwählen, installieren lassen
7343 3. Ein kleine Script »run_pdflatex.sh« anlegen, das den PATH auf das Installationsverezichnis setzt und pdflatex ausführt:
7345 ------------------------------------------------------------
7348 export PATH=/usr/local/texlive/2020/bin/x86_64-linux:$PATH
7352 ------------------------------------------------------------
7354 4. In config/kivitendo.conf den Parameter »latex« auf den Pfad zu »run_pdflatex.sh« setzen
7356 5. Webserver neu starten
7360 <sect2 id="features.zugferd.summary">
7361 <title>Übersicht</title>
7363 <para>Mit der Version 3.5.6 bietet kivitendo die Möglichkeit ZUGFeRD
7364 Rechnungen zu erstellen, sowie auch ZUGFeRD Rechnungen direkt in
7365 kivitendo einzulesen. </para>
7367 <para>Bei ZUGFeRD Rechnungen handelt es sich um eine PDF Datei in
7368 der eine XML-Datei eingebettet ist. Der Aufbau der XML-Datei ist
7369 standardisiert und ermöglicht so den Austausch zwischen
7370 den verschiedenen Softwareprodukten. Kivitendo setzt mit der
7371 Version 3.5.6 den ZUGFeRD 2.1 Standard um.</para>
7373 <para>Weiter Details zu ZUGFeRD sind unter diesem Link zu finden:
7374 <ulink>https://www.ferd-net.de/standards/was-ist-zugferd/index.html</ulink>
7378 <sect2 id="features.zugferd.create_zugferd_bills">
7380 <title>Erstellen von ZUGFeRD Rechnungen in Kivitendo</title>
7381 <para>Für die Erstellung von ZUGFeRD Rechnungen bedarf es in
7382 kivitendo zwei Dinge:</para>
7387 <para>Die Erstellung muss in der Mandantenkonfiguration
7388 aktiviert sein</para>
7392 <para>Beim mindestens einem Bankkonto muss die Option
7393 „Nutzung von ZUGFeRD“ aktiviert sein</para>
7398 <title>Mandantenkonfiguration</title>
7400 <para>Die Einstellung für die Erstellung von ZUGFeRD Rechnungen
7401 erfolgt unter „System“ → „Mandatenkonfiguration“ → „Features“.
7402 Im Abschnitt „Einkauf und Verkauf“ finden Sie die Einstellung
7403 „Verkaufsrechnungen mit ZUGFeRD-Daten erzeugen“.
7404 Hier besteht die Auswahl zwischen:</para>
7408 <para>ZUGFeRD-Rechnungen erzeugen</para>
7412 <para>ZUGFeRD-Rechnungen im Testmodus erzeugen</para>
7416 <para>Keine ZUGFeRD Rechnungen erzeugen</para>
7421 <para>Rechnungen die als PDF erzeugt werden, werden je nach
7422 Einstellung nun im ZUGFeRD Format ausgegeben.</para>
7427 <title>Konfiguration der Bankkonten</title>
7429 <para>Unter „System → Bankonten“ muss bei mindestens einem
7430 Bankkonto die Option „Nutzung mit ZUGFeRD“ auf „Ja“ gestellt
7436 <sect2 id="features.zugferd.read_zugferd_bills">
7438 <title>Einlesen von ZUGFeRD Rechnungen in Kivitendo</title>
7440 <para>Es lassen sich auch Rechnungen von Kreditoren, die im
7441 ZUGFeRD Format erstellt wurden im Kivitendo importieren.
7442 Hierfür müssen auch zwei Voraussetzungen erfüllt werden:
7448 <para>Beim Lieferanten muss die Umsatzsteuer-ID und das
7449 Bankkonto hinterlegt sein</para>
7453 <para>Für den Kreditoren muss eine Buchungsvorlage existieren.</para>
7458 <para>Wenn diese Voraussetzungen erfüllt sind, kann die Rechnung
7459 über „Finanzbuchhaltung“ → „ZUGFeRD Import“ über die „Durchsuchen“
7460 Schaltfläche ausgewählt werden und über die Schaltfläche „Import“
7461 eingeladen werden. Es öffnet sich daraufhin die Kreditorenbuchung.
7462 Die auslesbaren Daten aus dem eingebetteten XML der PDF Datei
7463 werden in der Kreditorenbuchung ergänzt.</para>
7472 <title>Entwicklerdokumentation</title>
7474 <sect1 id="devel.globals" xreflabel="Globale Variablen">
7475 <title>Globale Variablen</title>
7478 <title>Wie sehen globale Variablen in Perl aus?</title>
7480 <para>Globale Variablen liegen in einem speziellen namespace namens
7481 "main", der von überall erreichbar ist. Darüber hinaus sind bareword
7482 globs global und die meisten speziellen Variablen sind...
7485 <para>Daraus ergeben sich folgende Formen:</para>
7489 <term><literal>$main::form</literal></term>
7492 <para>expliziter Namespace "main"</para>
7497 <term><literal>$::form</literal></term>
7500 <para>impliziter Namespace "main"</para>
7505 <term><literal>open FILE, "file.txt"</literal></term>
7508 <para><varname>FILE</varname> ist global</para>
7513 <term><literal>$_</literal></term>
7516 <para>speziell</para>
7521 <para>Im Gegensatz zu <productname>PHP</productname> gibt es kein
7522 Schlüsselwort wie "<function>global</function>", mit dem man
7523 importieren kann. <function>my</function>, <function>our</function>
7524 und <function>local</function> machen was anderes.</para>
7528 <term><literal>my $form</literal></term>
7531 <para>lexikalische Variable, gültig bis zum Ende des
7537 <term><literal>our $form</literal></term>
7540 <para><varname>$form</varname> referenziert ab hier
7541 <varname>$PACKAGE::form</varname>.</para>
7546 <term><literal>local $form</literal></term>
7549 <para>Alle Änderungen an <varname>$form</varname> werden am Ende
7550 des scopes zurückgesetzt</para>
7557 <title>Warum sind globale Variablen ein Problem?</title>
7559 <para>Das erste Problem ist <productname>FCGI</productname>.</para>
7561 <para><productname>SQL-Ledger</productname> hat fast alles im globalen
7562 namespace abgelegt, und erwartet, dass es da auch wiederzufinden ist.
7563 Unter <productname>FCGI</productname> müssen diese Sachen aber wieder
7564 aufgeräumt werden, damit sie nicht in den nächsten Request kommen.
7565 Einige Sachen wiederum sollen nicht gelöscht werden, wie zum Beispiel
7566 Datenbankverbindungen, weil die sehr lange zum Initialisieren
7569 <para>Das zweite Problem ist <function>strict</function>. Unter
7570 <function>strict</function> werden alle Variablen die nicht explizit
7571 mit <function>Package</function>, <function>my</function> oder
7572 <function>our</function> angegeben werden als Tippfehler angemarkert,
7573 dies hat, seit der Einführung, u.a. schon so manche langwierige
7574 Bug-Suche verkürzt. Da globale Variablen aber implizit mit Package
7575 angegeben werden, werden die nicht geprüft, und somit kann sich
7576 schnell ein Tippfehler einschleichen.</para>
7580 <title>Kanonische globale Variablen</title>
7582 <para>Um dieses Problem im Griff zu halten gibt es einige wenige
7583 globale Variablen, die kanonisch sind, d.h. sie haben bestimmte
7584 vorgegebenen Eigenschaften, und alles andere sollte anderweitig
7585 umhergereicht werden.</para>
7587 <para>Diese Variablen sind im Moment die folgenden neun:</para>
7591 <para><varname>$::form</varname></para>
7595 <para><varname>%::myconfig</varname></para>
7599 <para><varname>$::locale</varname></para>
7603 <para><varname>$::lxdebug</varname></para>
7607 <para><varname>$::auth</varname></para>
7611 <para><varname>$::lx_office_conf</varname></para>
7615 <para><varname>$::instance_conf</varname></para>
7619 <para><varname>$::dispatcher</varname></para>
7623 <para><varname>$::request</varname></para>
7627 <para>Damit diese nicht erneut als Müllhalde missbraucht werden, im
7628 Folgenden eine kurze Erläuterung der bestimmten vorgegebenen
7629 Eigenschaften (Konventionen):</para>
7632 <title>$::form</title>
7636 <para>Ist ein Objekt der Klasse
7637 "<classname>Form</classname>"</para>
7641 <para>Wird nach jedem Request gelöscht</para>
7645 <para>Muss auch in Tests und Konsolenscripts vorhanden
7650 <para>Enthält am Anfang eines Requests die Requestparameter vom
7655 <para>Kann zwar intern über Requestgrenzen ein Datenbankhandle
7656 cachen, das wird aber momentan absichtlich zerstört</para>
7660 <para><varname>$::form</varname> wurde unter <productname>SQL
7661 Ledger</productname> als Gottobjekt für alles missbraucht. Sämtliche
7662 alten Funktionen unter SL/ mutieren <varname>$::form</varname>, das
7663 heißt, alles was einem lieb ist (alle Variablen die einem ans Herz
7664 gewachsen sind), sollte man vor einem Aufruf (!) von zum Beispiel
7665 <function>IS->retrieve_customer()</function> in Sicherheit
7668 <para>Z.B. das vom Benutzer eingestellte Zahlenformat, bevor man
7669 Berechnung in einem bestimmten Format durchführt (SL/Form.pm Zeile
7670 3552, Stand version 2.7beta), um dies hinterher wieder auf den
7671 richtigen Wert zu setzen:</para>
7673 <programlisting> my $saved_numberformat = $::myconfig{numberformat};
7674 $::myconfig{numberformat} = $numberformat;
7675 # (...) div Berechnungen
7676 $::myconfig{numberformat} = $saved_numberformat;</programlisting>
7678 <para>Das Objekt der Klasse Form hat leider im Moment noch viele
7679 zentrale Funktionen die vom internen Zustand abhängen, deshalb bitte
7680 nie einfach zerstören oder überschreiben (zumindestens nicht kurz
7681 vor einem Release oder in Absprache über bspw. die devel-Liste ;-).
7682 Es geht ziemlich sicher etwas kaputt.</para>
7684 <para><varname>$::form</varname> ist gleichzeitig der Standard Scope
7685 in den <productname>Template::Toolkit</productname> Templates
7686 außerhalb der Controller: der Ausdruck <function>[% var
7687 %]</function> greift auf <varname>$::form->{var}</varname> zu.
7688 Unter Controllern ist der Standard Scope anders, da lautet der
7689 Zugriff <function>[% FORM.var %]</function>. In Druckvorlagen sind
7690 normale Variablen ebenfall im <varname>$::form</varname> Scope, d.h.
7691 <function><%var%></function> zeigt auf
7692 <varname>$::form->{var}</varname>. Nochmal von der anderen Seite
7693 erläutert, innerhalb von (Web-)Templates sieht man häufiger solche
7696 <programlisting>[%- IF business %]
7697 # (... Zeig die Auswahlliste Kunden-/Lieferantentyp an)
7698 [%- END %]</programlisting>
7700 <para>Entweder wird hier dann $::form->{business} ausgewertet
7701 oder aber der Funktion
7702 <function>$form->parse_html_template</function> wird explizit
7703 noch ein zusätzlicher Hash übergeben, der dann auch in den
7704 (Web-)Templates zu Verfügung steht, bspw. so:</para>
7706 <programlisting>$form->parse_html_template("is/form_header", \%TMPL_VAR);</programlisting>
7708 <para>Innerhalb von Schleifen wird
7709 <varname>$::form->{TEMPLATE_ARRAYS}{var}[$index]</varname>
7710 bevorzugt, wenn vorhanden. Ein Beispiel findet sich in SL/DO.pm,
7711 welches über alle Positionen eines Lieferscheins in Schleife
7714 <programlisting>for $i (1 .. $form->{rowcount}) {
7716 push @{ $form->{TEMPLATE_ARRAYS}{runningnumber} }, $position;
7717 push @{ $form->{TEMPLATE_ARRAYS}{number} }, $form->{"partnumber_$i"};
7718 push @{ $form->{TEMPLATE_ARRAYS}{description} }, $form->{"description_$i"};
7724 <title>%::myconfig</title>
7728 <para>Das einzige Hash unter den globalen Variablen</para>
7732 <para>Wird spätestens benötigt wenn auf die Datenbank
7733 zugegriffen wird</para>
7737 <para>Wird bei jedem Request neu erstellt.</para>
7741 <para>Enthält die Userdaten des aktuellen Logins</para>
7745 <para>Sollte nicht ohne Filterung irgendwo gedumpt werden oder
7746 extern serialisiert werden, weil da auch der Datenbankzugriff
7747 für diesen user drinsteht.</para>
7751 <para>Enthält unter anderem Datumsformat dateformat und
7752 Nummernformat numberformat</para>
7756 <para>Enthält Datenbankzugriffinformationen</para>
7760 <para><varname>%::myconfig</varname> ist im Moment der Ersatz für
7761 ein Userobjekt. Die meisten Funktionen, die etwas anhand des
7762 aktuellen Users entscheiden müssen, befragen
7763 <varname>%::myconfig</varname>. Innerhalb der Anwendungen sind dies
7764 überwiegend die Daten, die sich unter <guimenu>Programm</guimenu>
7765 -> <guimenuitem>Einstellungen</guimenuitem> befinden, bzw. die
7766 Informationen über den Benutzer die über die
7767 Administrator-Schnittstelle eingegeben wurden.</para>
7771 <title>$::locale</title>
7775 <para>Objekt der Klasse "Locale"</para>
7779 <para>Wird pro Request erstellt</para>
7783 <para>Muss auch für Tests und Scripte immer verfügbar
7788 <para>Cached intern über Requestgrenzen hinweg benutzte
7793 <para>Lokalisierung für den aktuellen User. Alle Übersetzungen,
7794 Zahlen- und Datumsformatierungen laufen über dieses Objekt.</para>
7798 <title>$::lxdebug</title>
7802 <para>Objekt der Klasse "LXDebug"</para>
7806 <para>Wird global gecached</para>
7810 <para>Muss immer verfügbar sein, in nahezu allen
7815 <para><varname>$::lxdebug</varname> stellt Debuggingfunktionen
7816 bereit, wie "<function>enter_sub</function>" und
7817 "<function>leave_sub</function>", mit denen in den alten Modulen ein
7818 brauchbares Tracing gebaut ist, "<function>log_time</function>", mit
7819 der man die Wallclockzeit seit Requeststart loggen kann, sowie
7820 "<function>message</function>" und "<function>dump</function>" mit
7821 denen man flott Informationen ins Log (tmp/kivitendo-debug.log)
7824 <para>Beispielsweise so:</para>
7826 <programlisting>$main::lxdebug->message(0, 'Meine Konfig:' . Dumper (%::myconfig));
7827 $main::lxdebug->message(0, 'Wer bin ich? Kunde oder Lieferant:' . $form->{vc});</programlisting>
7831 <title>$::auth</title>
7835 <para>Objekt der Klasse "SL::Auth"</para>
7839 <para>Wird global gecached</para>
7843 <para>Hat eine permanente DB Verbindung zur Authdatenbank</para>
7847 <para>Wird nach jedem Request resettet.</para>
7851 <para><varname>$::auth</varname> stellt Funktionen bereit um die
7852 Rechte des aktuellen Users abzufragen. Obwohl diese Informationen
7853 vom aktuellen User abhängen wird das Objekt aus
7854 Geschwindigkeitsgründen nur einmal angelegt und dann nach jedem
7855 Request kurz resettet.</para>
7857 <para>Dieses Objekt kapselt auch den gerade aktiven Mandanten.
7858 Dessen Einstellungen können über
7859 <literal>$::auth->client</literal> abgefragt werden; Rückgabewert
7860 ist ein Hash mit den Werten aus der Tabelle
7861 <literal>auth.clients</literal>.</para>
7865 <title>$::lx_office_conf</title>
7869 <para>Objekt der Klasse
7870 "<classname>SL::LxOfficeConf</classname>"</para>
7874 <para>Global gecached</para>
7878 <para>Repräsentation der
7879 <filename>config/kivitendo.conf[.default]</filename>-Dateien</para>
7883 <para>Globale Konfiguration. Configdateien werden zum Start gelesen
7884 und danach nicht mehr angefasst. Es ist derzeit nicht geplant, dass
7885 das Programm die Konfiguration ändern kann oder sollte.</para>
7887 <para>Beispielsweise ist über den Konfigurationseintrag [debug] die
7888 Debug- und Trace-Log-Datei wie folgt konfiguriert und
7891 <programlisting>[debug]
7892 file_name = /tmp/kivitendo-debug.log</programlisting>
7894 <para>ist der Key <varname>file</varname> im Programm als
7895 <varname>$::lx_office_conf->{debug}{file}</varname>
7899 <para>Zugriff auf die Konfiguration erfolgt im Moment über
7900 Hashkeys, sind also nicht gegen Tippfehler abgesichert.</para>
7905 <title>$::instance_conf</title>
7909 <para>Objekt der Klasse
7910 "<classname>SL::InstanceConfiguration</classname>"</para>
7914 <para>wird pro Request neu erstellt</para>
7918 <para>Funktioniert wie <varname>$::lx_office_conf</varname>,
7919 speichert aber Daten die von der Instanz abhängig sind. Eine Instanz
7920 ist hier eine Mandantendatenbank. Beispielsweise überprüft
7921 <programlisting>$::instance_conf->get_inventory_system eq 'perpetual'</programlisting>
7922 ob die berüchtigte Bestandsmethode zur Anwendung kommt.</para>
7926 <title>$::dispatcher</title>
7930 <para>Objekt der Klasse
7931 "<varname>SL::Dispatcher</varname>"</para>
7935 <para>wird pro Serverprozess erstellt.</para>
7939 <para>enthält Informationen über die technische Verbindung zum
7944 <para>Der dritte Punkt ist auch der einzige Grund warum das Objekt
7945 global gespeichert wird. Wird vermutlich irgendwann in einem anderen
7946 Objekt untergebracht.</para>
7950 <title>$::request</title>
7954 <para>Hashref (evtl später Objekt)</para>
7958 <para>Wird pro Request neu initialisiert.</para>
7962 <para>Keine Unterstruktur garantiert.</para>
7966 <para><varname>$::request</varname> ist ein generischer Platz um
7967 Daten "für den aktuellen Request" abzulegen. Sollte nicht für action
7968 at a distance benutzt werden, sondern um lokales memoizing zu
7969 ermöglichen, das garantiert am Ende des Requests zerstört
7972 <para>Vieles von dem, was im moment in <varname>$::form</varname>
7973 liegt, sollte eigentlich hier liegen. Die groben
7974 Differentialkriterien sind:</para>
7978 <para>Kommt es vom User, und soll unverändert wieder an den
7979 User? Dann <varname>$::form</varname>, steht da eh schon</para>
7983 <para>Sind es Daten aus der Datenbank, die nur bis zum Ende des
7984 Requests gebraucht werden? Dann
7985 <varname>$::request</varname></para>
7989 <para>Muss ich von anderen Teilen des Programms lesend drauf
7990 zugreifen? Dann <varname>$::request</varname>, aber Zugriff über
7991 Wrappermethode</para>
7998 <title>Ehemalige globale Variablen</title>
8000 <para>Die folgenden Variablen waren einmal im Programm, und wurden
8004 <title>$::cgi</title>
8008 <para>war nötig, weil cookie Methoden nicht als
8009 Klassenfunktionen funktionieren</para>
8013 <para>Aufruf als Klasse erzeugt Dummyobjekt was im
8014 Klassennamespace gehalten wird und über Requestgrenzen
8019 <para>liegt jetzt unter
8020 <varname>$::request->{cgi}</varname></para>
8026 <title>$::all_units</title>
8030 <para>war nötig, weil einige Funktionen in Schleifen zum Teil
8031 ein paar hundert mal pro Request eine Liste der Einheiten
8032 brauchen, und de als Parameter durch einen Riesenstack von
8033 Funktionen geschleift werden müssten.</para>
8037 <para>Liegt jetzt unter
8038 <varname>$::request->{cache}{all_units}</varname></para>
8043 <function>AM->retrieve_all_units()</function> gesetzt oder
8050 <title>%::called_subs</title>
8054 <para>wurde benutzt um callsub deep recursions
8059 <para>Wurde entfernt, weil callsub nur einen Bruchteil der
8060 möglichen Rekursioenen darstellt, und da nie welche
8065 <para>komplette recursion protection wurde entfernt.</para>
8072 <sect1 id="devel.fcgi">
8073 <title>Entwicklung unter FastCGI</title>
8075 <sect2 id="devel.fcgi.general">
8076 <title>Allgemeines</title>
8078 <para>Wenn Änderungen in der Konfiguration von kivitendo gemacht
8079 werden, muss der Webserver neu gestartet werden.</para>
8081 <para>Bei der Entwicklung für FastCGI ist auf ein paar Fallstricke zu
8082 achten. Dadurch, dass das Programm in einer Endlosschleife läuft,
8083 müssen folgende Aspekte beachtet werden.</para>
8086 <sect2 id="devel.fcgi.exiting">
8087 <title>Programmende und Ausnahmen</title>
8089 <para>Betrifft die Funktionen <function>warn</function>,
8090 <function>die</function>, <function>exit</function>,
8091 <function>carp</function> und <function>confess</function>.</para>
8093 <para>Fehler, die dass Programm normalerweise sofort beenden (fatale
8094 Fehler), werden mit dem FastCGI Dispatcher abgefangen, um das Programm
8095 am Laufen zu halten. Man kann mit <function>die</function>,
8096 <function>confess</function> oder <function>carp</function> Fehler
8097 ausgeben, die dann vom Dispatcher angezeigt werden. Die kivitendo
8098 eigene <function>$::form-</function>error()> tut im Prinzip das
8099 Gleiche, mit ein paar Extraoptionen. <function>warn</function> und
8100 <function>exit</function> hingegen werden nicht abgefangen.
8101 <function>warn</function> wird direkt nach STDERR, also in Server Log
8102 eine Nachricht schreiben (sofern in der Konfiguration nicht die
8103 Warnungen in das kivitendo Log umgeleitet wurden), und
8104 <function>exit</function> wird die Ausführung beenden.</para>
8106 <para>Prinzipiell ist es kein Beinbruch, wenn sich der Prozess
8107 beendet, fcgi wird ihn sofort neu starten. Allerdings sollte das die
8108 Ausnahme sein. Quintessenz: Bitte kein <function>exit</function>
8109 benutzen, alle anderen Exceptionmechanismen sind ok.</para>
8112 <sect2 id="devel.fcgi.globals">
8113 <title>Globale Variablen</title>
8115 <para>Um zu vermeiden, dass Informationen von einem Request in einen
8116 anderen gelangen, müssen alle globalen Variablen vor einem Request
8117 sauber initialisiert werden. Das ist besonders wichtig im
8118 <varname>$::cgi</varname> und <varname>$::auth</varname> Objekt, weil
8119 diese nicht gelöscht werden pro Instanz, sondern persistent gehalten
8122 <para>In <classname>SL::Dispatcher</classname> gibt es einen sauber
8123 abgetrennten Block, der alle kanonischen globalen Variablen listet und
8124 erklärt. Bitte keine anderen einführen ohne das sauber zu
8125 dokumentieren.</para>
8127 <para>Datenbankverbindungen wird noch ein Guide verfasst werden, wie
8128 man sicher geht, dass man die richtige erwischt.</para>
8131 <sect2 id="devel.fcgi.performance">
8132 <title>Performance und Statistiken</title>
8134 <para>Die kritischen Pfade des Programms sind die Belegmasken, und
8135 unter diesen ganz besonders die Verkaufsrechnungsmaske. Ein Aufruf der
8136 Rechnungsmaske in kivitendo 2.4.3 stable dauert auf einem Core2duo mit
8137 4GB Arbeitsspeicher und Ubuntu 9.10 eine halbe Sekunde. In der 2.6.0
8138 sind es je nach Menge der definierten Variablen 1-2s. Ab der
8139 Moose/Rose::DB Version sind es 5-6s.</para>
8141 <para>Mit FastCGI ist die neuste Version auf 0,26 Sekunden selbst in
8142 den kritischen Pfaden, unter 0,15 sonst.</para>
8146 <sect1 id="dev-programmatic-api-calls" xreflabel="Programmatische API-Aufrufe">
8147 <title>Programmatische API-Aufrufe</title>
8149 <sect2 id="dev-programmatic-api-calls.introduction" xreflabel="Einführung in programmatische API-Aufrufe">
8150 <title>Einführung</title>
8153 Es ist möglich, Funktionen in kivitendo programmatisch aus anderen Programmen aufzurufen. Dazu ist nötig, dass
8154 Authentifizierungsinformationen in jedem Aufruf mitgegeben werden. Dafür gibt es zwei Methoden: die HTTP-»Basic«-Authentifizierung
8155 oder die Übergabe als spziell benannte GET-Parameter. Neben den Authentifizierungsinformationen muss auch der zu verwendende Mandant
8160 <sect2 id="dev-programmatic-api-calls.client_selection" xreflabel="Mandantenauswahl bei programmatischen API-Aufrufen">
8161 <title>Wahl des Mandanten</title>
8164 Der zu verwendende Mandant kann als Parameter <varname>{AUTH}client_id</varname> mit jedem Request mitgeschickt werden. Der Wert
8165 muss dabei die Datenbank-ID des Mandanten sein. kivitendo prüft, ob der Account, der über die Authentifizierungsinformationen
8166 übergeben wurde, Zugriff auf den angegebenen Mandanten hat.
8170 Wird in einem Request kein Mandant mitgegeben, so wird derjenige Mandant genommen, wer als Standardmandant markiert wurde. Gibt es
8171 keinen solchen, kommt es zu einer Fehlermeldung.
8175 <sect2 id="dev-programmatic-api-calls.http_basic_authentication" xreflabel="Programmatische API-Aufrufe mit HTTP-»Basic« authentifizieren">
8176 <title>HTTP-»Basic«-Authentifizierung</title>
8179 Für diese Methode muss jedem Request der bekannte HTTP-Header <constant>Authorization</constant> mitgeschickt werden (siehe <ulink
8180 url="https://tools.ietf.org/html/rfc7617">RFC 7617</ulink>). Unterstützt wird ausschließlich die »Basic«-Methode. Loginname und
8181 Passwort werden bei dieser Methode durch einen Doppelpunkt getrennt und Base64-encodiert im genannten HTTP-Header übertragen.
8185 Diese Informationen müssen einen vorhandenen Account benennen. kivitendo prüft genau wie bei Benutzung über den Webbrowser, ob
8186 dieser Account Zugriff auf den Mandanten sowie auf die angeforderte Funktion hat.
8190 Da die Logininformationen im Klartext im Request stehen, sollte der Zugriff auf kivitendo ausschließlich über HTTPS verschlüsselt
8195 <sect2 id="dev-programmatic-api-calls.authentication_via_parameters" xreflabel="Programmatische API-Aufrufe mit Parametern authentifizieren">
8196 <title>Authentifizierung mit Parametern</title>
8199 Für diese Methode müssen jedem Request zwei Parameter mitgegeben werden: <varname>{AUTH}login</varname> und
8200 <varname>{AUTH}password</varname>. Diese Informationen müssen einen vorhandenen Account benennen. kivitendo prüft genau wie bei
8201 Benutzung über den Webbrowser, ob dieser Account Zugriff auf den Mandanten sowie auf die angeforderte Funktion hat.
8205 Da die Logininformationen im Klartext im Request stehen, sollte der Zugriff auf kivitendo ausschließlich über HTTPS verschlüsselt
8211 Die Verwendung dieser Methode ist veraltet. Statt dessen sollte die oben erwähnte HTTP-»Basic«-Authentifizierung verwendet werden.
8216 <sect2 id="dev-programmatic-api-calls.examples">
8217 <title>Beispiele</title>
8220 Das folgende Beispiel nutzt das Kommandozeilenprogramm »curl« und ruft die Funktion auf, die eine vorhandene Telefonnummer in den
8221 Ansprechpersonen sucht und dazu Informationen zurückliefert. Dabei wird die HTTP-»Basic«-Authentifizierung genutzt.
8224 <programlisting>$ curl --silent --user 'jdoe:SecretPassword!' \
8225 'https://…/controller.pl?action=PhoneNumber/look_up&number=053147110815'</programlisting>
8229 <sect1 id="db-upgrade-files" xreflabel="Datenbank-Upgradedateien">
8230 <title>SQL-Upgradedateien</title>
8232 <sect2 id="db-upgrade-files.introduction"
8233 xreflabel="Einführung in die Datenbank-Upgradedateien">
8234 <title>Einführung</title>
8236 <para>Datenbankupgrades werden über einzelne Upgrade-Scripte
8237 gesteuert, die sich im Verzeichnis
8238 <filename>sql/Pg-upgrade2</filename> befinden. In diesem Verzeichnis
8239 muss pro Datenbankupgrade eine Datei existieren, die neben den
8240 eigentlich auszuführenden SQL- oder Perl-Befehlen einige
8241 Kontrollinformationen enthält.</para>
8243 <para>Kontrollinformationen definieren Abhängigkeiten und Prioritäten,
8244 sodass Datenbankscripte zwar in einer sicheren Reihenfolge ausgeführt
8245 werden (z.B. darf ein <literal>ALTER TABLE</literal> erst ausgeführt
8246 werden, wenn die Tabelle mit <literal>CREATE TABLE</literal> angelegt
8247 wurde), diese Reihenfolge aber so flexibel ist, dass man keine
8248 Versionsnummern braucht.</para>
8250 <para>kivitendo merkt sich dabei, welches der Upgradescripte in
8251 <filename>sql/Pg-upgrade2</filename> bereits durchgeführt wurde und
8252 führt diese nicht erneut aus. Dazu dient die Tabelle
8253 "<literal>schema_info</literal>", die bei der Anmeldung automatisch
8254 angelegt wird.</para>
8257 <sect2 id="db-upgrade-files.format"
8258 xreflabel="Format der Upgradedateien">
8259 <title>Format der Kontrollinformationen</title>
8261 <para>Die Kontrollinformationen sollten sich am Anfang der jeweiligen
8262 Upgradedatei befinden. Jede Zeile, die Kontrollinformationen enthält,
8263 hat dabei das folgende Format:</para>
8265 <para>Für SQL-Upgradedateien:</para>
8267 <programlisting>-- @key: value</programlisting>
8269 <para>Für Perl-Upgradedateien:</para>
8271 <programlisting># @key: value</programlisting>
8273 <para>Leerzeichen vor "<varname>value</varname>" werden
8276 <para>Die folgenden Schlüsselworte werden verarbeitet:</para>
8280 <term><varname>tag</varname></term>
8283 <para>Wird zwingend benötigt. Dies ist der "Name" des Upgrades.
8284 Dieser "tag" kann von anderen Kontrolldateien in ihren
8285 Abhängigkeiten verwendet werden (Schlüsselwort
8286 "<varname>depends</varname>"). Der "tag" ist auch der Name, der
8287 in der Datenbank eingetragen wird.</para>
8289 <para>Normalerweise sollte die Kontrolldatei genau so heißen wie
8290 der "tag", nur mit der Endung ".sql" bzw. "pl".</para>
8292 <para>Ein Tag darf nur aus alphanumerischen Zeichen sowie den
8293 Zeichen _ - ( ) bestehen. Insbesondere sind Leerzeichen nicht
8294 erlaubt und sollten stattdessen mit Unterstrichen ersetzt
8300 <term><varname>charset</varname></term>
8303 <para>Empfohlen. Gibt den Zeichensatz an, in dem das Script
8304 geschrieben wurde, z.B. "<literal>UTF-8</literal>". Aus
8305 Kompatibilitätsgründen mit alten Upgrade-Scripten wird bei
8306 Abwesenheit des Tags für SQL-Upgradedateien der Zeichensatz
8307 "<literal>ISO-8859-15</literal>" angenommen. Perl-Upgradescripte
8308 hingegen müssen immer in UTF-8 encodiert sein und sollten
8309 demnach auch ein "<literal>use utf8;</literal>"
8315 <term><varname>description</varname></term>
8318 <para>Benötigt. Eine Beschreibung, was in diesem Update
8319 passiert. Diese wird dem Benutzer beim eigentlichen
8320 Datenbankupdate angezeigt. Während der Tag in Englisch gehalten
8321 sein sollte, sollte die Beschreibung auf Deutsch
8327 <term><varname>depends</varname></term>
8330 <para>Optional. Eine mit Leerzeichen getrennte Liste von "tags",
8331 von denen dieses Upgradescript abhängt. kivitendo stellt sicher,
8332 dass die in dieser Liste aufgeführten Scripte bereits
8333 durchgeführt wurden, bevor dieses Script ausgeführt wird.</para>
8335 <para>Abhängigkeiten werden rekursiv betrachtet. Wenn also ein
8336 Script "b" existiert, das von Änderungen in "a" abhängt, und
8337 eine neue Kontrolldatei für "c" erstellt wird, die von
8338 Änderungen in "a" und "b" abhängt, so genügt es, in "c" nur den
8339 Tag "b" als Abhängigkeit zu definieren.</para>
8341 <para>Es ist nicht erlaubt, sich selbst referenzierende
8342 Abhängigkeiten zu definieren (z.B. "a" -> "b", "b" -> "c"
8343 und "c" -> "a").</para>
8348 <term><varname>priority</varname></term>
8351 <para>Optional. Ein Zahlenwert, der die Reihenfolge bestimmt, in
8352 der Scripte ausgeführt werden, die die gleichen
8353 Abhängigkeitstiefen besitzen. Fehlt dieser Parameter, so wird
8354 der Wert 1000 benutzt.</para>
8356 <para>Dies ist reine Kosmetik. Für echte Reihenfolgen muss
8357 "depends" benutzt werden. kivitendo sortiert die auszuführenden
8358 Scripte zuerst nach der Abhängigkeitstiefe (wenn "z" von "y"
8359 abhängt und "y" von "x", so hat "z" eine Abhängigkeitstiefe von
8360 2, "y" von 1 und "x" von 0. "x" würde hier zuerst ausgeführt,
8361 dann "y", dann "z"), dann nach der Priorität und bei gleicher
8362 Priorität alphabetisch nach dem "tag".</para>
8367 <term><varname>ignore</varname></term>
8370 <para>Optional. Falls der Wert auf 1 (true) steht, wird das
8371 Skript bei der Anmeldung ignoriert und entsprechend nicht
8378 <sect2 id="db-upgrade-files.format-perl-files"
8379 xreflabel="Format von Perl-Upgradedateien">
8380 <title>Format von in Perl geschriebenen
8381 Datenbankupgradescripten</title>
8383 <para>In Perl geschriebene Datenbankscripte werden nicht einfach so
8384 ausgeführt sondern müssen sich an gewisse Konventionen halten. Dafür
8385 bekommen sie aber auch einige Komfortfunktionen bereitgestellt.</para>
8387 <para>Ein Upgradescript stellt dabei eine vollständige Objektklasse
8388 dar, die vom Elternobjekt "<literal>SL::DBUpgrade2::Base</literal>"
8389 erben und eine Funktion namens "<literal>run</literal>" zur Verfügung
8390 stellen muss. Das Script wird ausgeführt, indem eine Instanz dieser
8391 Klasse erzeugt und darauf die erwähnte "<literal>run</literal>"
8392 aufgerufen wird.</para>
8394 <para>Zu beachten ist, dass sich der Paketname der Datei aus dem Wert
8395 für "<literal>@tag</literal>" ableitet. Dabei werden alle Zeichen, die
8396 in Paketnamen ungültig wären (gerade Bindestriche), durch Unterstriche
8397 ersetzt. Insgesamt sieht der Paketname wie folgt aus:
8398 "<literal>SL::DBUpgrade2::tag</literal>".</para>
8400 <para>Welche Komfortfunktionen zur Verfügung stehen, erfahren Sie in
8401 der Perl-Dokumentation zum oben genannten Modul; aufzurufen mit
8402 "<command>perldoc SL/DBUpgrade2/Base.pm</command>".</para>
8404 <para>Ein Mindestgerüst eines gültigen Perl-Upgradescriptes sieht wie
8407 <programlisting># @tag: beispiel-upgrade-file42
8408 # @description: Ein schönes Beispielscript
8409 # @depends: release_3_1_0
8410 package SL::DBUpgrade2::beispiel_upgrade_file42;
8415 use parent qw(SL::DBUpgrade2::Base);
8420 # hier Aktionen ausführen
8429 <sect2 id="db-upgrade-files.dbupgrade-tool"
8430 xreflabel="Hilfsscript dbupgrade2_tool.pl">
8431 <title>Hilfsscript dbupgrade2_tool.pl</title>
8433 <para>Um die Arbeit mit den Abhängigkeiten etwas zu erleichtern,
8434 existiert ein Hilfsscript namens
8435 "<filename>scripts/dbupgrade2_tool.pl</filename>". Es muss aus dem
8436 kivitendo-ERP-Basisverzeichnis heraus aufgerufen werden. Dieses Tool
8437 liest alle Datenbankupgradescripte aus dem Verzeichnis
8438 <filename>sql/Pg-upgrade2</filename> aus. Es benutzt dafür die
8439 gleichen Methoden wie kivitendo selber, sodass alle Fehlersituationen
8440 von der Kommandozeile überprüft werden können.</para>
8442 <para>Wird dem Script kein weiterer Parameter übergeben, so wird nur
8443 eine Überprüfung der Felder und Abhängigkeiten vorgenommen. Man kann
8444 sich aber auch Informationen auf verschiedene Art ausgeben
8449 <para>Listenform: "<command>./scripts/dbupgrade2_tool.pl
8450 --list</command>"</para>
8452 <para>Gibt eine Liste aller Scripte aus. Die Liste ist in der
8453 Reihenfolge sortiert, in der kivitendo die Scripte ausführen
8454 würde. Es werden neben der Listenposition der Tag, die
8455 Abhängigkeitstiefe und die Priorität ausgegeben.</para>
8459 <para>Baumform: "<command>./scripts/dbupgrade2_tool.pl
8460 --tree</command>"</para>
8462 <para>Listet alle Tags in Baumform basierend auf den
8463 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte, von
8464 denen keine anderen abhängen. Die Unterknoten sind Scripte, die
8465 beim übergeordneten Script als Abhängigkeit eingetragen
8469 <listitem id="db-upgrade-files.dbupgrade-tool.reverse-tree">
8470 <para>Umgekehrte Baumform: "<command>./scripts/dbupgrade2_tool.pl
8471 --rtree</command>"</para>
8473 <para>Listet alle Tags in Baumform basierend auf den
8474 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte mit
8475 der geringsten Abhängigkeitstiefe. Die Unterknoten sind Scripte,
8476 die das übergeordnete Script als Abhängigkeit eingetragen
8481 <para>Baumform mit Postscriptausgabe:
8482 "<command>./scripts/dbupgrade2_tool.pl
8483 --graphviz</command>"</para>
8485 <para>Benötigt das Tool "<command>graphviz</command>", um mit
8486 seiner Hilfe die <link
8487 linkend="db-upgrade-files.dbupgrade-tool.reverse-tree">umgekehrte
8488 Baumform</link> in eine Postscriptdatei namens
8489 "<filename>db_dependencies.ps</filename>" auszugeben. Dies ist
8490 vermutlich die übersichtlichste Form, weil hierbei jeder Knoten
8491 nur einmal ausgegeben wird. Bei den Textmodusbaumformen hingegen
8492 können Knoten und all ihre Abhängigkeiten mehrfach ausgegeben
8497 <para>Scripte, von denen kein anderes Script abhängt:
8498 "<command>./scripts/dbupgrade2_tool.pl --nodeps</command>"</para>
8500 <para>Listet die Tags aller Scripte auf, von denen keine anderen
8501 Scripte abhängen.</para>
8507 <sect1 id="translations-languages" xreflabel="Translations and languages">
8508 <title>Translations and languages</title>
8510 <sect2 id="translations-languages.introduction"
8511 xreflabel="Introduction to translations and languages">
8512 <title>Introduction</title>
8515 <para>Dieser Abschnitt ist in Englisch geschrieben, um
8516 internationalen Übersetzern die Arbeit zu erleichtern.</para>
8519 <para>This section describes how localization packages in kivitendo
8520 are built. Currently the only language fully supported is German, and
8521 since most of the internal messages are held in English the English
8522 version is usable too.</para>
8525 <sect2 id="translations-languages.character-set"
8526 xreflabel="Character set">
8527 <title>Character set</title>
8529 <para>All files included in a language pack must use UTF-8 as their
8533 <sect2 id="translations-languages.file-structure"
8534 xreflabel="File structure">
8535 <title>File structure</title>
8537 <para>The structure of locales in kivitendo is:</para>
8539 <programlisting>kivitendo/locale/<langcode>/</programlisting>
8541 <para>where <langcode> stands for an abbreviation of the
8542 language package. The builtin packages use two letter <ulink
8543 url="http://en.wikipedia.org/wiki/ISO_639-1">ISO 639-1</ulink> codes,
8544 but the actual name is not relevant for the program and can easily be
8546 url="http://en.wikipedia.org/wiki/IETF_language_tag">IETF language
8547 tags</ulink> (i.e. "en_GB"). In fact the original language packages
8548 from SQL Ledger are named in this way.</para>
8550 <para>In such a language directory the following files are
8555 <term>LANGUAGE</term>
8558 <para>This file is mandatory.</para>
8560 <para>The <filename>LANGUAGE</filename> file contains the self
8561 descripted name of the language. It should contain a native
8562 representation first, and in parenthesis an english translation
8563 after that. Example:</para>
8565 <programlisting>Deutsch (German)</programlisting>
8573 <para>This file is mandatory.</para>
8575 <para>The central translation file. It is essentially an inline
8576 Perl script autogenerated by <command>locales.pl</command>. To
8577 generate it, generate the directory and the two files mentioned
8578 above, and execute the following command:</para>
8580 <programlisting>scripts/locales.pl <langcode></programlisting>
8582 <para>Otherwise you can simply copy one of the other languages.
8583 You will be told how many are missing like this:</para>
8585 <programlisting>$ scripts/locales.pl en
8586 English - 0.6% - 2015/2028 missing</programlisting>
8588 <para>A file named "<filename>missing</filename>" will be
8589 generated and can be edited. You can also edit the
8590 "<filename>all</filename>" file directly. Edit everything you
8591 like to fit the target language and execute
8592 <command>locales.pl</command> again. See how the missing words
8598 <term>Num2text</term>
8601 <para>Legacy code from SQL Ledger. It provides a means for
8602 numbers to be converted into natural language, like
8603 <literal>1523 => one thousand five hundred twenty
8604 three</literal>. If you want to provide it, it must be inlinable
8605 Perl code which provides a <function>num2text</function> sub. If
8606 an <function>init</function> sub exists it will be executed
8609 <para>Only used in the check and receipt printing module.</para>
8614 <term>special_chars</term>
8617 <para>kivitendo comes with a lot of interfaces to different
8618 formats, some of which are rather picky with their accepted
8619 charset. The <filename>special_chars</filename> file contains a
8620 listing of chars not suited for different file format and
8621 provides substitutions. It is written in "Simple Ini" style,
8622 containing a block for every file format.</para>
8624 <para>First entry should be the order of substitution for
8625 entries as a whitespace separated list. All entries are
8626 interpolated, so <literal>\n</literal>, <literal>\x20</literal>
8627 and <literal>\\</literal> all work.</para>
8629 <para>After that every entry is a special char that should be
8630 translated when writing text into such a file.</para>
8632 <para>Example:</para>
8634 <programlisting>[Template/XML]
8635 order=& < > \n
8639 \n=<br></programlisting>
8641 <para>Note the importance of the order in this example.
8642 Substituting < and > befor & would lead to $gt; become
8645 <para>For a list of valid formats, see the German
8646 <filename>special_chars</filename> entry. As of this writing the
8647 following are recognized:</para>
8649 <programlisting>HTML
8654 Template/OpenDocument
8655 filenames</programlisting>
8657 <para>The last of which is very machine dependent. Remember that
8658 a lot of characters are forbidden by some filesystems, for
8659 example MS Windows doesn't like ':' in its files where Linux
8660 doesn't mind that. If you want the files created with your
8661 language pack to be portable, find all chars that could cause
8667 <term>missing</term>
8670 <para>This file is not a part of the language package
8673 <para>This is a file generated by
8674 <command>scripts/locales.pl</command> while processing your
8675 locales. It's only to have the missing entries singled out and
8676 does not belong to a language package.</para>
8684 <para>This file is not a part of the language package
8687 <para>Another file generated by
8688 <command>scripts/locales.pl</command>. If for any reason a
8689 translation does not appear anymore and can be deleted, it gets
8690 moved here. The last 50 or so entries deleted are saved here in
8691 case you made a typo, so that you don't have to translate
8692 everything again. If a tranlsation is missing, the lost file is
8693 checked first. If you maintain a language package, you might
8694 want to keep this safe somewhere.</para>
8699 <term>more/all</term>
8702 <para>This subdir and file is not a part of the language package
8705 <para>If the directory more exists and contains a file called
8706 all it will be parsed in addition to the mandatory all (see
8707 above). The file is useful if you want to change some
8708 translations for the current installation without conflicting
8709 further upgrades. The file is not autogenerated and has the same
8710 format as the all, but needs another key (more_texts). See the
8711 german translation for an example or copy the following code:
8714 # -*- coding: utf-8; -*-
8719 # These are additional texts for custom translations.
8720 # The format is the same as for the normal file all, only
8721 # with another key (more_texts instead of texts).
8722 # The file has the form of 'english text' => 'foreign text',
8724 $self->{more_texts} = {
8726 'Ship via' => 'Terms of delivery',
8727 'Shipping Point' => 'Delivery time',
8729 </programlisting></para>
8736 <sect1 id="devel.testsuite">
8737 <title>Die kivitendo-Test-Suite</title>
8739 <sect2 id="devel.testsuite.intro">
8740 <title>Einführung</title>
8742 <para>kivitendo enthält eine Suite für automatisierte Tests. Sie
8743 basiert auf dem Standard-Perl-Modul
8744 <literal>Test::More</literal>.</para>
8746 <para>Die grundlegenden Fakten sind:</para>
8750 <para>Alle Tests liegen im Unterverzeichnis
8751 <filename>t/</filename>.</para>
8755 <para>Ein Script (bzw. ein Test) in <filename>t/</filename>
8756 enthält einen oder mehrere Testfälle.</para>
8760 <para>Alle Dateinamen von Tests enden auf <literal>.t</literal>.
8761 Es sind selbstständig ausführbare Perl-Scripte.</para>
8765 <para>Die Test-Suite besteht aus der Gesamtheit aller Tests,
8766 sprich aller Scripte in <filename>t/</filename>, deren Dateiname
8767 auf <literal>.t</literal> endet.</para>
8772 <sect2 id="devel.testsuite.prerequisites">
8773 <title>Voraussetzungen</title>
8775 <para>Für die Ausführung werden neben den für kivitendo eh schon
8776 benötigten Module noch weitere Perl-Module benötigt. Diese
8781 <para><literal>Test::Deep</literal> (Debian-Paketname:
8782 <literal>libtest-deep-perl</literal>; Fedora:
8783 <literal>perl-Test-Deep</literal>; openSUSE:
8784 <literal>perl-Test-Deep</literal>)</para>
8788 <para><literal>Test::Exception</literal> (Debian-Paketname:
8789 <literal>libtest-exception-perl</literal>; Fedora:
8790 <literal>perl-Test-Exception</literal>; openSUSE:
8791 <literal>perl-Test-Exception</literal>)</para>
8795 <para><literal>Test::Output</literal> (Debian-Paketname:
8796 <literal>libtest-output-perl</literal>; Fedora:
8797 <literal>perl-Test-Output</literal>; openSUSE:
8798 <literal>perl-Test-Output</literal>)</para>
8802 <para><literal>Test::Harness</literal> 3.0.0 oder höher. Dieses
8803 Modul ist ab Perl 5.10.1 Bestandteil der Perl-Distribution und
8804 kann für frühere Versionen aus dem <ulink
8805 url="http://www.cpan.org">CPAN</ulink> bezogen werden.</para>
8809 <para><literal>LWP::Simple</literal> aus dem Paket
8810 <literal>libwww-perl</literal> (Debian-Panetname:
8811 <literal>libwww-perl</literal>; Fedora:
8812 <literal>perl-libwww-perl</literal>; openSUSE:
8813 <literal>perl-libwww-perl</literal>)</para>
8817 <para><literal>URI::Find</literal> (Debian-Panetname:
8818 <literal>liburi-find-perl</literal>; Fedora:
8819 <literal>perl-URI-Find</literal>; openSUSE:
8820 <literal>perl-URI-Find</literal>)</para>
8824 <para><literal>Sys::CPU</literal> (Debian-Panetname:
8825 <literal>libsys-cpu-perl</literal>; Fedora und openSUSE: nicht
8830 <para><literal>Thread::Pool::Simple</literal> (Debian-Panetname:
8831 <literal>libthread-pool-simple-perl</literal>; Fedora und
8832 openSUSE: nicht vorhanden)</para>
8836 <para>Weitere Voraussetzung ist, dass die Testsuite ihre eigene
8837 Datenbank anlegen kann, um Produktivdaten nicht zu gefährden. Dazu
8838 müssen in der Konfigurationsdatei im Abschnit
8839 <literal>testing/database</literal> Datenbankverbindungsparameter
8840 angegeben werden. Der hier angegebene Benutzer muss weiterhin das
8841 Recht haben, Datenbanken anzulegen und zu löschen.</para>
8843 <para>Der so angegebene Benutzer muss nicht zwingend über
8844 Super-User-Rechte verfügen. Allerdings gibt es einige
8845 Datenbank-Upgrades, die genau diese Rechte benötigen. Für den Fall
8846 kann man in diesem Konfigurationsabschnitt einen weiteren
8847 Benutzeraccount angeben, der dann über Super-User-Rechte verfügt, und
8848 mit dem die betroffenen Upgrades durchgeführt werden. In der
8849 Beispiel-Konfigurationsdatei finden Sie die benötigten
8853 <sect2 id="devel.testsuite.execution">
8854 <title>Existierende Tests ausführen</title>
8856 <para>Es gibt mehrere Möglichkeiten zum Ausführen der Tests: entweder,
8857 man lässt alle Tests auf einmal ausführen, oder man führt gezielt
8858 einzelne Scripte aus. Für beide Fälle gibt es das Helferscript
8859 <filename>t/test.pl</filename>.</para>
8861 <para>Will man die komplette Test-Suite ausführen, so muss man einfach
8862 nur <filename>t/test.pl</filename> ohne weitere Parameter aus dem
8863 kivitendo-Basisverzeichnis heraus ausführen.</para>
8865 <para>Um einzelne Test-Scripte auszuführen, übergibt man deren Namen
8866 an <filename>t/test.pl</filename>. Beispielsweise:</para>
8868 <programlisting>t/test.pl t/form/format_amount.t t/background_job/known_jobs.t</programlisting>
8871 <sect2 id="devel.testsuite.meaning_of_scripts">
8872 <title>Bedeutung der verschiedenen Test-Scripte</title>
8874 <para>Die Test-Suite umfasst Tests sowohl für Funktionen als auch für
8875 Programmierstil. Einige besonders zu erwähnende, weil auch während der
8876 Entwicklung nützliche Tests sind:</para>
8880 <para><filename>t/001compile.t</filename> -- compiliert alle
8881 Quelldateien und bricht bei Fehlern sofort ab</para>
8885 <para><filename>t/002goodperl.t</filename> -- überprüft alle
8886 Perl-Dateien auf Anwesenheit von '<literal>use
8887 strict</literal>'-Anweisungen</para>
8891 <para><filename>t/003safesys.t</filename> -- überprüft Aufrufe von
8892 <function>system()</function> und <function>exec()</function> auf
8897 <para><filename>t/005no_tabs.t</filename> -- überprüft, ob Dateien
8898 Tab-Zeichen enthalten</para>
8902 <para><filename>t/006spelling.t</filename> -- sucht nach häufigen
8903 Rechtschreibfehlern</para>
8907 <para><filename>t/011pod.t</filename> -- überprüft die Syntax von
8908 Dokumentation im POD-Format auf Gültigkeit</para>
8912 <para>Weitere Test-Scripte überprüfen primär die Funktionsweise
8913 einzelner Funktionen und Module.</para>
8916 <sect2 id="devel.testsuite.create_new">
8917 <title>Neue Test-Scripte erstellen</title>
8919 <para>Es wird sehr gern gesehen, wenn neue Funktionalität auch gleich
8920 mit einem Test-Script abgesichert wird. Auch bestehende Funktion darf
8921 und soll ausdrücklich nachträglich mit Test-Scripten abgesichert
8924 <sect3 id="devel.testsuite.ideas_for_non_function_tests">
8925 <title>Ideen für neue Test-Scripte, die keine konkreten Funktionen
8928 <para>Ideen, die abgesehen von Funktionen noch nicht umgesetzt
8933 <para>Überprüfung auf fehlende symbolische Links</para>
8937 <para>Suche nach Nicht-ASCII-Zeichen in Perl-Code-Dateien (mit
8938 gewissen Einschränkungen wie das Erlauben von deutschen
8943 <para>Test auf DOS-Zeilenenden (\r\n anstelle von nur \n)</para>
8947 <para>Überprüfung auf Leerzeichen am Ende von Zeilen</para>
8951 <para>Test, ob alle zu übersetzenden Strings in
8952 <filename>locale/de/all</filename> vorhanden sind</para>
8956 <para>Test, ob alle Webseiten-Templates in
8957 <filename>templates/webpages</filename> mit vom Perl-Modul
8958 <literal>Template</literal> compiliert werden können</para>
8963 <sect3 id="devel.testsuite.directory_and_test_names">
8964 <title>Konvention für Verzeichnis- und Dateinamen</title>
8966 <para>Es gibt momentan eine wenige Richtlinien, wie Test-Scripte zu
8967 benennen sind. Bitte die folgenden Punkte als Richtlinie betrachten
8968 und ihnen soweit es geht folgen:</para>
8972 <para>Die Dateiendung muss <filename>.t</filename>
8977 <para>Namen sind englisch, komplett klein geschrieben und
8978 einzelne Wörter mit Unterstrichten getrennt (beispielsweise
8979 <filename>bad_function_params.t</filename>).</para>
8983 <para>Unterverzeichnisse sollten grob nach dem Themenbereich
8984 benannt sein, mit dem sich die Scripte darin befassen
8985 (beispielsweise <filename>background_jobs</filename> für Tests
8986 rund um Hintergrund-Jobs).</para>
8990 <para>Test-Scripte sollten einen überschaubaren Bereich von
8991 Funktionalität testen, der logisch zusammenhängend ist (z.B. nur
8992 Tests für eine einzelne Funktion in einem Modul). Lieber mehrere
8993 Test-Scripte schreiben.</para>
8998 <sect3 id="devel.testsuite.minimal_example">
8999 <title>Minimales Skelett für eigene Scripte</title>
9001 <para>Der folgenden Programmcode enthält das kleinstmögliche
9002 Testscript und kann als Ausgangspunkt für eigene Tests verwendet
9005 <programlisting>use Test::More tests => 0;
9009 use Support::TestSetup;
9011 Support::TestSetup::login();</programlisting>
9013 <para>Wird eine vollständig initialisierte kivitendo-Umgebung
9014 benötigt (Stichwort: alle globalen Variablen wie
9015 <varname>$::auth</varname>, <varname>$::form</varname> oder
9016 <varname>$::lxdebug</varname>), so muss in der Konfigurationsdatei
9017 <filename>config/kivitendo.conf</filename> im Abschnitt
9018 <literal>testing.login</literal> ein gültiger Login-Name eingetragen
9019 sein. Dieser wird für die Datenbankverbindung benötigt.</para>
9021 <para>Wir keine vollständig initialisierte Umgebung benötigt, so
9022 kann die letzte Zeile <programlisting>Support::TestSetup::login();</programlisting>
9023 weggelassen werden, was die Ausführungszeit des Scripts leicht
9029 <sect1 id="devel.style-guide">
9030 <title>Stil-Richtlinien</title>
9032 <para>Die folgenden Regeln haben das Ziel, den Code möglichst gut les-
9033 und wartbar zu machen. Dazu gehört zum Einen, dass der Code einheitlich
9034 eingerückt ist, aber auch, dass Mehrdeutigkeit so weit es geht vermieden
9035 wird (Stichworte "Klammern" oder "Hash-Keys").</para>
9037 <para>Diese Regeln sind keine Schikane sondern erleichtern allen das
9040 <para>Jeder, der einen Patch schickt, sollte seinen Code vorher
9041 überprüfen. Einige der Regeln lassen sich automatisch überprüfen, andere
9046 <para>Es werden keine echten Tabs sondern Leerzeichen
9051 <para>Die Einrückung beträgt zwei Leerzeichen. Beispiel:</para>
9053 <programlisting>foreach my $row (@data) {
9055 # do something with $row
9059 $row->{modules} = MODULE->retrieve(
9060 id => $row->{id},
9061 date => $use_now ? localtime() : $row->{time},
9065 $report->add($row);
9070 <para>Öffnende geschweifte Klammern befinden sich auf der gleichen
9071 Zeile wie der letzte Befehl. Beispiele:</para>
9073 <programlisting>sub debug {
9079 <programlisting>if ($form->{item_rows} > 0) {
9085 <para>Schließende geschweifte Klammern sind so weit eingerückt wie
9086 der Befehl / die öffnende schließende Klammer, die den Block
9087 gestartet hat, und nicht auf der Ebene des Inhalts. Die gleichen
9088 Beispiele wie bei 3. gelten.</para>
9092 <para>Die Wörter "<function>else</function>",
9093 "<function>elsif</function>", "<function>while</function>" befinden
9094 sich auf der gleichen Zeile wie schließende geschweifte Klammern.
9097 <programlisting>if ($form->{sum} > 1000) {
9099 } elsif ($form->{sum} > 0) {
9107 } until ($a > 0);</programlisting>
9111 <para>Parameter von Funktionsaufrufen müssen mit runden Klammern
9112 versehen werden. Davon nicht betroffen sind interne Perl-Funktionen,
9113 und grep-ähnliche Operatoren. Beispiel:</para>
9115 <programlisting>$main::lxdebug->message("Could not find file.");
9116 %options = map { $_ => 1 } grep { !/^#/ } @config_file;</programlisting>
9120 <para>Verschiedene Klammern, Ihre Ausdrücke und Leerzeichen:</para>
9122 <para>Generell gilt: Hashkeys und Arrayindices sollten nicht durch
9123 Leerzeichen abgesetzt werden. Logische Klammerungen ebensowenig,
9124 Blöcke schon. Beispiel:</para>
9126 <programlisting>if (($form->{debug} == 1) && ($form->{sum} - 100 < 0)) {
9131 $form->{sum} += $form->{"row_$i"};
9132 $form->{ $form->{index} } += 1;
9134 map { $form->{sum} += $form->{"row_$_"} } 1..$rowcount;</programlisting>
9138 <para>Mehrzeilige Befehle</para>
9142 <para>Werden die Parameter eines Funktionsaufrufes auf mehrere
9143 Zeilen aufgeteilt, so sollten diese bis zu der Spalte eingerückt
9144 werden, in der die ersten Funktionsparameter in der ersten Zeile
9145 stehen. Beispiel:</para>
9147 <programlisting>$sth = $dbh->prepare("SELECT * FROM some_table WHERE col = ?",
9148 $form->{some_col_value});</programlisting>
9152 <para>Ein Spezialfall ist der ternäre Operator "?:", der am
9153 besten in einer übersichtlichen Tabellenstruktur organisiert
9154 wird. Beispiel:</para>
9156 <programlisting>my $rowcount = $form->{"row_$i"} ? $i
9157 : $form->{oldcount} ? $form->{oldcount} + 1
9158 : $form->{rowcount} - $form->{rowbase};</programlisting>
9164 <para>Kommentare</para>
9168 <para>Kommentare, die alleine in einer Zeile stehen, sollten
9169 soweit wie der Code eingerückt sein.</para>
9173 <para>Seitliche hängende Kommentare sollten einheitlich
9174 formatiert werden.</para>
9178 <para>Sämtliche Kommentare und Sonstiges im Quellcode ist bitte
9179 auf Englisch zu verfassen. So wie ich keine Lust habe,
9180 französischen Quelltext zu lesen, sollte auch der kivitendo
9181 Quelltext für nicht-Deutschsprachige lesbar sein.
9184 <programlisting>my $found = 0;
9192 $i = 0 # initialize $i
9194 $i *= $const; # do something crazy
9195 $i = $n; # recover $i</programlisting>
9201 <para>Hashkeys sollten nur in Anführungszeichen stehen, wenn die
9202 Interpolation gewünscht ist. Beispiel:</para>
9204 <programlisting>$form->{sum} = 0;
9205 $form->{"row_$i"} = $form->{"row_$i"} - 5;
9206 $some_hash{42} = 54;</programlisting>
9210 <para>Die maximale Zeilenlänge ist nicht beschränkt. Zeilenlängen
9211 unterhalb von 79 Zeichen helfen unter bestimmten Bedingungen, aber
9212 wenn die Lesbarkeit unter kurzen Zeilen leidet (wie zum Biespiel in
9213 grossen Tabellen), dann ist Lesbarkeit vorzuziehen.</para>
9215 <para>Als Beispiel sei die Funktion
9216 <function>print_options</function> aus
9217 <filename>bin/mozilla/io.pl</filename> angeführt.</para>
9221 <para>Trailing Whitespace, d.h. Leerzeichen am Ende von Zeilen sind
9222 unerwünscht. Sie führen zu unnötigen Whitespaceänderungen, die diffs
9225 <para>Emacs und vim haben beide recht einfache Methoden zur
9226 Entfernung von trailing whitespace. Emacs kennt das Kommande
9227 <command>nuke-trailing-whitespace</command>, vim macht das gleiche
9228 manuell über <literal>:%s/\s\+$//e</literal> Mit <literal>:au
9229 BufWritePre * :%s/\s\+$//e</literal> wird das an Speichern
9234 <para>Es wird kein <command>perltidy</command> verwendet.</para>
9236 <para>In der Vergangenheit wurde versucht,
9237 <command>perltidy</command> zu verwenden, um einen einheitlichen
9238 Stil zu erlangen. Es hat sich aber gezeigt, dass
9239 <command>perltidy</command>s sehr eigenwilliges Verhalten, was
9240 Zeilenumbrüche angeht, oftmals gut formatierten Code zerstört. Für
9241 den Interessierten sind hier die
9242 <command>perltidy</command>-Optionen, die grob den beschriebenen
9243 Richtlinien entsprechen:</para>
9245 <programlisting>-syn -i=2 -nt -pt=2 -sbt=2 -ci=2 -ibc -hsc -noll -nsts -nsfs -asc -dsm
9246 -aws -bbc -bbs -bbb -mbl=1 -nsob -ce -nbl -nsbl -cti=0 -bbt=0 -bar -l=79
9247 -lp -vt=1 -vtc=1</programlisting>
9251 <para><varname>STDERR</varname> ist tabu. Unkonditionale
9252 Debugmeldungen auch.</para>
9254 <para>kivitendo bietet mit dem Modul <classname>LXDebug</classname>
9255 einen brauchbaren Trace-/Debug-Mechanismus. Es gibt also keinen
9256 Grund, nach <varname>STDERR</varname> zu schreiben.</para>
9258 <para>Die <classname>LXDebug</classname>-Methode
9259 "<function>message</function>" nimmt als ersten Paramter außerdem
9260 eine Flagmaske, für die die Meldung angezeigt wird, wobei "0" immer
9261 angezeigt wird. Solche Meldungen sollten nicht eingecheckt werden
9262 und werden in den meisten Fällen auch vom Repository
9263 zurückgewiesen.</para>
9267 <para>Alle neuen Module müssen use strict verwenden.</para>
9269 <para><varname>$form</varname>, <varname>$auth</varname>,
9270 <varname>$locale</varname>, <varname>$lxdebug</varname> und
9271 <varname>%myconfig</varname> werden derzeit aus dem main package
9272 importiert (siehe <xref linkend="devel.globals"/>. Alle anderen
9273 Konstrukte sollten lexikalisch lokal gehalten werden.</para>
9278 <sect1 id="devel.build-doc" xreflabel="Dokumentation erstellen">
9279 <title>Dokumentation erstellen</title>
9281 <sect2 id="devel.build-doc.introduction">
9282 <title>Einführung</title>
9284 <para>Diese Dokumentation ist in <productname>DocBook</productname>
9285 XML geschrieben. Zum Bearbeiten reicht grundsätzlich ein Text-Editor.
9286 Mehr Komfort bekommt man, wenn man einen dedizierten XML-fähigen
9287 Editor nutzt, der spezielle Unterstützung für
9288 <productname>DocBook</productname> mitbringt. Wir empfehlen dafür den
9289 <ulink url="http://www.xmlmind.com/xmleditor/">XMLmind XML
9290 Editor</ulink>, der bei nicht kommerzieller Nutzung kostenlos
9294 <sect2 id="devel.build-doc.required-software">
9295 <title>Benötigte Software</title>
9297 <para>Bei <productname>DocBook</productname> ist Prinzip, dass
9298 ausschließlich die XML-Quelldatei bearbeitet wird. Aus dieser werden
9299 dann mit entsprechenden Stylesheets andere Formate wie PDF oder HTML
9300 erzeugt. Bei kivitendo übernimmt diese Aufgabe das Shell-Script
9301 <command>scripts/build_doc.sh</command>.</para>
9303 <para>Das Script benötigt zur Konvertierung verschiedene
9304 Softwarekomponenten, die im normalen kivitendo-Betrieb nicht benötigt
9310 url="http://www.oracle.com/technetwork/java/index.html">Java</ulink>
9311 in einer halbwegs aktuellen Version</para>
9315 <para>Das Java-Build-System <ulink
9316 url="http://ant.apache.org/">Apache Ant</ulink></para>
9320 <para>Das Dokumentations-System Dobudish für
9321 <productname>DocBook</productname> 4.5, eine Zusammenstellung
9322 diverser Stylesheets und Grafiken zur Konvertierung von
9323 <productname>DocBook</productname> XML in andere Formate. Das
9324 Paket, das benötigt wird, ist zum Zeitpunkt der
9325 Dokumentationserstellung
9326 <filename>dobudish-nojre-1.1.4.zip</filename>, aus auf <ulink
9327 url="http://code.google.com/p/dobudish/downloads/list">code.google.com</ulink>
9332 <para>Apache Ant sowie ein dazu passendes Java Runtime Environment
9333 sind auf allen gängigen Plattformen verfügbar. Beispiel für
9334 Debian/Ubuntu:</para>
9336 <programlisting>apt-get install ant openjdk-7-jre</programlisting>
9338 <para>Nach dem Download von Dobudish muss Dobudish im Unterverzeichnis
9339 <filename>doc/build</filename> entpackt werden. Beispiel unter der
9340 Annahme, das <productname>Dobudish</productname> in
9341 <filename>$HOME/Downloads</filename> heruntergeladen wurde:</para>
9343 <programlisting>cd doc/build
9344 unzip $HOME/Downloads/dobudish-nojre-1.1.4.zip</programlisting>
9347 <sect2 id="devel.build-doc.build">
9348 <title>PDFs und HTML-Seiten erstellen</title>
9350 <para>Die eigentliche Konvertierung erfolgt nach Installation der
9351 benötigten Software mit einem einfachen Aufruf direkt aus dem
9352 kivitendo-Installationsverzeichnis heraus:</para>
9354 <programlisting>./scripts/build_doc.sh</programlisting>
9357 <sect2 id="devel.build-doc.repository">
9358 <title>Einchecken in das Git-Repository</title>
9360 <para>Sowohl die XML-Datei als auch die erzeugten PDF- und
9361 HTML-Dateien sind Bestandteil des Git-Repositories. Daraus folgt, dass
9362 nach Änderungen am XML die PDF- und HTML-Dokumente ebenfalls gebaut
9363 und alles zusammen in einem Commit eingecheckt werden sollten.</para>
9365 <para>Die "<filename>dobudish</filename>"-Verzeichnisse bzw.
9366 symbolischen Links gehören hingegen nicht in das Repository.</para>