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>Anfang 2019 sind das folgende Systeme, von denen bekannt ist,
110 dass kivitendo auf ihnen läuft:</para>
118 <para>8.0 "Jessie"</para>
121 <para>9.0 "Stretch"</para>
124 <para>10.0 "Buster"</para>
130 <para>16.04 "Xenial Xerus" LTS und 18.04 "Bionic Beaver" LTS
135 <para>openSUSE 15.0</para>
139 <para>Fedora 29</para>
144 <sect2 id="Pakete" xreflabel="Pakete">
145 <title>Benötigte Perl-Pakete installieren</title>
147 <para>Zum Betrieb von kivitendo werden zwingend ein Webserver (meist
148 Apache) und ein Datenbankserver (PostgreSQL) in einer aktuellen
149 Version (s.a. Liste der unterstützten Betriebssysteme)
152 <para>Zusätzlich benötigt kivitendo einige Perl-Pakete, die nicht
153 Bestandteil einer Standard-Perl-Installation sind. Um zu überprüfen,
154 ob die erforderlichen Pakete installiert und aktuell genug sind, wird
155 ein Script mitgeliefert, das wie folgt aufgerufen wird:</para>
157 <programlisting>./scripts/installation_check.pl</programlisting>
159 <para>Die vollständige Liste der benötigten Perl-Module lautet:</para>
163 <para><literal>Algorithm::CheckDigits</literal></para>
167 <para><literal>Archive::Zip</literal></para>
171 <para><literal>CGI</literal></para>
175 <para><literal>Clone</literal></para>
179 <para><literal>Config::Std</literal></para>
183 <para><literal>Daemon::Generic</literal></para>
187 <para><literal>DateTime</literal></para>
191 <para><literal>DateTime::Event::Cron</literal></para>
195 <para><literal>DateTime::Format::Strptime</literal></para>
199 <para><literal>DateTime::Set</literal></para>
203 <para><literal>DBI</literal></para>
207 <para><literal>DBD::Pg</literal></para>
211 <para><literal>Email::Address</literal></para>
215 <para><literal>Email::MIME</literal></para>
219 <para><literal>Exception::Class</literal></para>
223 <para><literal>FCGI</literal> (nicht Versionen 0.68 bis 0.71
224 inklusive; siehe <xref
225 linkend="Apache-Konfiguration.FCGI.WebserverUndPlugin"/>)</para>
229 <para><literal>File::Copy::Recursive</literal></para>
233 <para><literal>File::Flock</literal></para>
237 <para><literal>File::MimeInfo</literal></para>
241 <para><literal>File::Slurp</literal></para>
245 <para><literal>GD</literal></para>
249 <para><literal>HTML::Parser</literal></para>
253 <para><literal>HTML::Restrict</literal></para>
257 <para><literal>Image::Info</literal></para>
261 <para><literal>JSON</literal></para>
265 <para><literal>List::MoreUtils</literal></para>
269 <para><literal>List::UtilsBy</literal></para>
273 <para>LWP::Authen::Digest</para>
277 <para>LWP::UserAgent</para>
281 <para><literal>Net::SMTP::SSL</literal> (optional, bei
282 E-Mail-Versand über SSL; siehe Abschnitt "<xref
283 linkend="config.sending-email.smtp"/>")</para>
287 <para><literal>Net::SSLGlue</literal> (optional, bei
288 E-Mail-Versand über TLS; siehe Abschnitt "<xref
289 linkend="config.sending-email.smtp"/>")</para>
293 <para><literal>Params::Validate</literal></para>
297 <para><literal>PBKDF2::Tiny</literal></para>
301 <para><literal>PDF::API2</literal></para>
305 <para><literal>Regexp::IPv6</literal></para>
309 <para><literal>Rose::Object</literal></para>
313 <para><literal>Rose::DB</literal></para>
317 <para><literal>Rose::DB::Object</literal> Version 0.788 oder
322 <para><literal>Set::Infinite</literal></para>
326 <para><literal>String::ShellQuote</literal></para>
330 <para><literal>Sort::Naturally</literal></para>
334 <para><literal>Template</literal></para>
338 <para><literal>Text::CSV_XS</literal></para>
342 <para><literal>Text::Iconv</literal></para>
346 <para><literal>Text::Unidecode</literal></para>
350 <para><literal>URI</literal></para>
354 <para><literal>XML::Writer</literal></para>
358 <para><literal>YAML::XS</literal> oder <literal>YAML</literal></para>
362 <para>Seit Version größer v3.5.3 sind die folgenden Pakete hinzugekommen: <literal>Exception::Class</literal></para>
364 <para>Seit Version größer v3.5.1 sind die folgenden Pakete hinzugekommen: <literal>Set::Infinite</literal>,
365 <literal>List::UtilsBy</literal>, <literal>DateTime::Set</literal>, <literal>DateTime::Event::Cron</literal>
366 <literal>Daemon::Generic</literal>, <literal>DateTime::Event::Cron</literal>, <literal>File::Flock</literal>,
367 <literal>File::Slurp</literal></para>
369 <para>Seit Version größer v3.5.0 sind die folgenden Pakete
370 hinzugekommen: <literal>Text::Unidecode</literal>,
371 <literal>LWP::Authen::Digest</literal>,
372 <literal>LWP::UserAgent</literal></para>
374 <para>Seit Version v3.4.0 sind die folgenden Pakete hinzugekommen:
375 <literal>Algorithm::CheckDigits</literal>,
376 <literal>PBKDF2::Tiny</literal></para>
378 <para>Seit Version v3.2.0 sind die folgenden Pakete hinzugekommen:
379 <literal>GD</literal>, <literal>HTML::Restrict</literal>,
380 <literal>Image::Info</literal></para>
382 <para>Seit v3.0.0 sind die folgenden Pakete hinzugekommen:
383 <literal>File::Copy::Recursive</literal>.</para>
385 <para>Seit v2.7.0 sind die folgenden Pakete hinzugekommen:
386 <literal>Email::MIME</literal>, <literal>Net::SMTP::SSL</literal>,
387 <literal>Net::SSLGlue</literal>.</para>
389 <para>Gegenüber Version 2.6.0 sind zu dieser Liste 2 Pakete
390 hinzugekommen, <literal>URI</literal> und
391 <literal>XML::Writer</literal> sind notwendig. Ohne startet kivitendo
394 <para>Gegenüber Version 2.6.1 sind <literal>parent</literal>,
395 <literal>DateTime</literal>, <literal>Rose::Object</literal>,
396 <literal>Rose::DB</literal> und <literal>Rose::DB::Object</literal>
397 neu hinzugekommen. <literal>IO::Wrap</literal> wurde entfernt.</para>
399 <para>Gegenüber Version 2.6.3 ist <literal>JSON</literal> neu
400 hinzugekommen.</para>
402 <para><literal>Email::Address</literal> und
403 <literal>List::MoreUtils</literal> sind schon länger feste
404 Abhängigkeiten, wurden aber bisher mit kivitendo mitgeliefert. Beide
405 sind auch in 2.6.1 weiterhin mit ausgeliefert, wurden in einer
406 zukünftigen Version aber aus dem Paket entfernt werden. Es wird
407 empfohlen diese Module zusammen mit den anderen als Bibliotheken zu
411 <title>Debian und Ubuntu</title>
412 <para>Für Debian und Ubuntu stehen die meisten der benötigten
413 Pakete als Debian-Pakete zur Verfügung. Sie können mit
414 folgendem Befehl installiert werden:</para>
416 <programlisting>apt install apache2 libarchive-zip-perl libclone-perl \
417 libconfig-std-perl libdatetime-perl libdbd-pg-perl libdbi-perl \
418 libemail-address-perl libemail-mime-perl libfcgi-perl libjson-perl \
419 liblist-moreutils-perl libnet-smtp-ssl-perl libnet-sslglue-perl \
420 libparams-validate-perl libpdf-api2-perl librose-db-object-perl \
421 librose-db-perl librose-object-perl libsort-naturally-perl \
422 libstring-shellquote-perl libtemplate-perl libtext-csv-xs-perl \
423 libtext-iconv-perl liburi-perl libxml-writer-perl libyaml-perl \
424 libimage-info-perl libgd-gd2-perl libapache2-mod-fcgid \
425 libfile-copy-recursive-perl postgresql libalgorithm-checkdigits-perl \
426 libcrypt-pbkdf2-perl git libcgi-pm-perl libtext-unidecode-perl libwww-perl\
427 postgresql-contrib aqbanking-tools poppler-utils libhtml-restrict-perl\
428 libdatetime-set-perl libset-infinite-perl liblist-utilsby-perl\
429 libdaemon-generic-perl libfile-flock-perl libfile-slurp-perl\
430 libfile-mimeinfo-perl libpbkdf2-tiny-perl libregexp-ipv6-perl \
431 libdatetime-event-cron-perl libexception-class-perl libcam-pdf-perl \
434 <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>
435 <note id="ubuntu-universe">
436 <para>Die Perl Pakete für Ubuntu befinden sich im "Universe" Repository. Falls dies nicht aktiv ist, kann dies mit folgendem Aufruf aktiviert werden:
437 <programlisting>add-apt-repository universe</programlisting></para>
439 <note id="build-essential">
440 <para>Für ältere Ubuntu/Debians müßen einige Pakete per CPAN installiert werden.
441 Das geht bspw. für das benötige Paket HTML::Restrict mit:</para>
442 <programlisting>apt-get install build-essential
443 cpan HTML::Restrict</programlisting>
448 <title>Fedora</title>
450 <para>Für Fedora stehen die meisten der benötigten Perl-Pakete als
451 RPM-Pakete zur Verfügung. Sie können mit folgendem Befehl
452 installiert werden:</para>
454 <programlisting>dnf install httpd mod_fcgid postgresql-server postgresql-contrib\
455 perl-Algorithm-CheckDigits perl-Archive-Zip perl-CPAN perl-Class-XSAccessor \
456 perl-Clone perl-Config-Std perl-DBD-Pg perl-DBI perl-Daemon-Generic \
457 perl-DateTime perl-DateTime-Set perl-Email-Address perl-Email-MIME perl-FCGI \
458 perl-File-Copy-Recursive perl-File-Flock perl-File-MimeInfo perl-File-Slurp \
459 perl-GD perl-HTML-Restrict perl-JSON perl-List-MoreUtils perl-List-UtilsBy \
460 perl-Net-SMTP-SSL perl-Net-SSLGlue perl-PBKDF2-Tiny perl-PDF-API2 \
461 perl-Params-Validate perl-Regexp-IPv6 perl-Rose-DB perl-Rose-DB-Object \
462 perl-Rose-Object perl-Sort-Naturally perl-String-ShellQuote \
463 perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv perl-URI perl-XML-Writer \
464 perl-YAML perl-libwww-perl</programlisting>
468 <title>openSUSE</title>
470 <para>Für openSUSE stehen die meisten der benötigten Perl-Pakete als RPM-Pakete zur Verfügung.</para>
471 <para>Dies setzt voraus, das eben die erforderlichen Repositories dem System bekannt gemacht worden sind.</para>
472 <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>
473 <para>Dazu geben wir folgenden Befehl ein:</para>
474 <programlisting>zypper addrepo -f \
475 http://download.opensuse.org/repositories/devel:languages:perl/openSUSE_Leap_15.0/ \
476 "devel:languages:perl"
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 <programlisting>zypper addrepo -f \
483 https://download.opensuse.org/repositories/devel:languages:haskell:lts:13/\
484 openSUSE_Leap_15.0/ "devel:languages:haskell:lts:13"
486 <para>Danach geben wir noch die beiden folgenden Befehle ein:</para>
487 <programlisting>zypper clean</programlisting>
488 <programlisting>zypper refresh</programlisting>
489 <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>
490 <programlisting>zypper --help</programlisting>
492 <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>
494 <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>
495 <para>yast2 return.</para>
496 <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>
497 <para>Sie können mit folgendem Befehl installiert werden:</para>
498 <para>zypper install Paketname</para>
499 <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>
501 <programlisting>zypper install perl-threads-shared ghc-pdfinfo apache2-mod_fcgid \
502 yast2-http-server postgresql-server postgresql-contrib perl-Algorithm-CheckDigits \
503 perl-Archive-Zip perl-CGI perl-CGI-Ajax perl-Clone \
504 perl-Config-Std perl-Class-XSAccessor perl-Daemon-Generic perl-DateTime \
505 perl-DateTime-Event-Cron perl-DateTime-Format-Strptime perl-DateTime-Set \
506 perl-DBI perl-DBD-Pg perl-Devel-REPL perl-FastCGI perl-Email-Address \
507 perl-Email-MIME perl-Email-MIME-ContentType perl-Email-MIME-Encodings \
508 perl-FCGI perl-File-Copy-Recursive perl-File-Flock perl-File-MimeInfo \
509 perl-File-Slurp perl-GD perl-HTML-Restrict perl-Image-Info \
510 perl-JSON perl-List-MoreUtils perl-List-UtilsBy perl-Log-Log4perl perl-Net-LDAP-Server \
511 perl-Net-SSLGlue perl-Net-SMTP-SSL perl-PBKDF2-Tiny perl-PDF-API2 \
512 perl-Params-Validate perl-Regexp-IPv6 perl-Rose-DB perl-Rose-Object \
513 perl-Rose-DB-Object perl-MooseX-Role-Cmd perl-Set-Crontab perl-Set-Infinite \
514 perl-Sort-Naturally perl-String-ShellQuote perl-Sys-CPU perl-Template-Toolkit \
515 perl-Text-CSV_XS perl-Test-Deep perl-Test-Output perl-Text-Iconv \
516 perl-Text-Unidecode perl-URI perl-URI-Find perl-XML-Writer \
517 perl-YAML perl-libwww-perl
520 <para>Für die Entwickler installiert man noch die folgenden Pakete:</para>
522 <programlisting>zypper install ghc-mtl-devel ghc-old-locale-devel \
523 ghc-process-extras-devel ghc-rpm-macros ghc-text-devel ghc-time-devel \
524 ghc-Cabal-devel ghc-time-locale-compat-devel perl-Log-Log4perl ghc-pdfinfo \
525 ghc-pdfinfo-devel perl-Devel-REPL perl-URI-Find perl-Class-Utils \
526 perl-Error-Pure perl-File-Object perl-Readonly perl-Test-Warnings \
527 perl-Test-NoWarnings perl-Test-Deep perl-Test-Output perl-Test-Strict \
528 perl-Test-LongString perl-File-Find-Rule
531 <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.
532 Dazu können Sie die folgenden Befehle nutzen:</para>
534 <programlisting>zypper install texlive-wallpaper texlive-colortbl \
535 texlive-scrlttr2copy texlive-eurosym \
536 texlive-geometry texlive-german texlive-graphbox texlive-hyperref \
537 texlive-xifthen texlive-luainputenc texlive-lastpage texlive-ltabptch \
538 texlive-nomentbl texlive-threeparttablex texlive-substr texlive-tabulary \
539 texlive-ulem texlive-wallpaper texlive-xcolor texlive-xstring \
540 texlive-xypic texlive-mwe texlive-mweights texlive-barcodes \
541 texlive-GS1 texlive-ean texlive-makebarcode texlive-pst-barcode \
545 <para>Zusätzlich müssen einige Pakete aus dem CPAN installiert
546 werden. Dazu können Sie die folgenden Befehle nutzen:</para>
548 <programlisting>cpan DateTime::event::Cron DateTime::Set FCGI \
549 HTML::Restrict PBKDF2::Tiny Rose::Db::Object Set::Infinite</programlisting>
554 <title>Andere Pakete installieren</title>
558 <para><literal>aqbanking-tools</literal> Für das Parsen des MT940 Bankformats (Version 6 oder höher)</para>
561 <para><literal>poppler-utils</literal> 'pdfinfo' zum Erkennen der Seitenanzahl bei der PDF-Generierung</para>
564 <para><literal>Postgres Trigram-Index</literal> Für datenbankoptimierte Suchanfragen. Bspw. im Paket <literal>postgresql-contrib</literal> enthalten</para>
567 <para>Debian und Ubuntu: <programlisting>apt install aqbanking-tools postgresql-contrib poppler-utils</programlisting></para>
568 <para>Fedora: <programlisting>dnf install aqbanking poppler-utils postgresql-contrib</programlisting></para>
569 <para>openSUSE: <programlisting>zypper install aqbanking-tools poppler-tools</programlisting></para>
573 <sect1 id="Manuelle-Installation-des-Programmpaketes"
574 xreflabel="Manuelle Installation des Programmpaketes">
575 <title>Manuelle Installation des Programmpaketes</title>
577 <para>Der aktuelle Stable-Release, bzw. beta Release wird bei github
578 gehostet und kann <ulink
579 url="https://github.com/kivitendo/kivitendo-erp/releases">hier</ulink>
580 heruntergeladen werden.</para>
582 <para>Das aktuelleste kivitendo ERP-Archiv
583 (<filename>kivitendo-erp-*.tgz</filename>) wird dann im
584 Dokumentenverzeichnis des Webservers (z.B.
585 <filename>/var/www/html/</filename>,
586 <filename>/srv/www/htdocs</filename> oder
587 <filename>/var/www/</filename>) entpackt:</para>
589 <programlisting>cd /var/www
590 tar xvzf kivitendo-erp-*.tgz</programlisting>
592 <para>Wechseln Sie in das entpackte Verzeichnis:</para>
594 <programlisting>cd kivitendo-erp</programlisting>
596 <para>Alternativ können Sie auch einen Alias in der
597 Webserverkonfiguration benutzen, um auf das tatsächliche
598 Installationsverzeichnis zu verweisen.</para>
600 <para>Bei einer Neuinstallation von Version 3.1.0 oder später muß das
601 WebDAV Verzeichnis derzeit manuell angelegt werden:</para>
603 <programlisting>mkdir webdav</programlisting>
605 <para>Die Verzeichnisse <filename>users</filename>,
606 <filename>spool</filename> und <filename>webdav</filename> müssen für
607 den Benutzer beschreibbar sein, unter dem der Webserver läuft. Die
608 restlichen Dateien müssen für diesen Benutzer lesbar sein. Die Benutzer-
609 und Gruppennamen sind bei verschiedenen Distributionen unterschiedlich
610 (z.B. bei Debian/Ubuntu <constant>www-data</constant>, bei Fedora
611 <constant>apache</constant> oder bei openSUSE
612 <constant>wwwrun</constant>).</para>
614 <para>Der folgende Befehl ändert den Besitzer für die oben genannten
615 Verzeichnisse auf einem Debian/Ubuntu-System:</para>
617 <programlisting>chown -R www-data users spool webdav</programlisting>
619 <para>Weiterhin muss der Webserver-Benutzer in den Verzeichnissen
620 <filename>templates</filename> und <filename>users</filename>
621 Unterverzeichnisse für jeden neuen Benutzer anlegen dürfen, der in
622 kivitendo angelegt wird:</para>
624 <programlisting>chown www-data templates users</programlisting>
627 <para>Wir empfehlen eine Installation mittels des Versionsmanagager
628 git. Hierfür muss ein git-Client installiert sein. Damit ist man sehr
629 viel flexibler für zukünftige Upgrades. Installations-Anleitung (bitte
630 die Pfade anpassen) bspw. wie folgt: <programlisting>cd /var/www/
631 git clone https://github.com/kivitendo/kivitendo-erp.git
633 git checkout `git tag -l | egrep -ve "(alpha|beta|rc)" | tail -1`</programlisting>
634 Erläuterung: Der Befehl wechselt zur letzten Stable-Version (git tag
635 -l listet alle Tags auf, das egrep schmeisst alle Einträge mit alpha,
636 beta oder rc raus und das tail gibt davon den obersten Treffer
637 zurück). Sehr sinnvoll ist es, direkt im Anschluss einen eigenen
638 Branch zu erzeugen, um bspw. seine eigenen Druckvorlagen-Anpassungen
639 damit zu verwalten. Hierfür reicht ein simples <programlisting> git checkout -b meine_eigenen_änderungen</programlisting>
640 nach dem letzten Kommando (weiterführende Informationen <ulink
641 url="http://www-cs-students.stanford.edu/~blynn/gitmagic/index.html">
642 Git Magic</ulink>).</para>
644 <para>Ein beispielhafter Workflow für Druckvorlagen-Anpassungen von
645 3.4.1 nach 3.5: <programlisting>
646 $ git clone https://github.com/kivitendo/kivitendo-erp.git
648 $ git checkout release-3.4.1 # das ist ein alter release aus dem wir starten ...
649 $ git checkout -b meine_eigene_änderungen # unser lokaler branch - unabhängig von allen anderen
650 $ git add templates/mein_druck # das sind unsere druckvorlagen inkl. produktbilder
651 $ git commit -m "juhu tolle änderungen"
653 [meine_aenderungen 1d89e41] juhu tolle ändernungen
654 4 files changed, 380 insertions(+)
655 create mode 100644 templates/mein_druck/img/webdav/tesla.png
656 create mode 100644 templates/mein_druck/mahnung.tex
657 create mode 100644 templates/mein_druck/zahlungserinnerung_zwei.tex
658 create mode 100644 templates/mein_druck/zahlungserinnerung_zwei_invoice.tex
661 # webserver abschalten!
663 $ git checkout master
664 $ git pull # oder git fetch und danach ein stable release tag auswählen (s.o.)
665 $ git checkout meine_eigenen_änderungen
668 Zunächst wird der Branch zurückgespult, um Ihre Änderungen
669 darauf neu anzuwenden ...
670 Wende an: juhu tolle änderungen
671 $ service apache2 restart # webserver starten!
672 </programlisting></para>
676 <sect1 id="config.config-file">
677 <title>kivitendo-Konfigurationsdatei</title>
679 <sect2 id="config.config-file.introduction"
680 xreflabel="Einführung in die Konfigurationsdatei">
681 <title>Einführung</title>
683 <para>In kivitendo gibt es nur noch eine Konfigurationsdatei, die
684 benötigt wird: <filename>config/kivitendo.conf</filename> (kurz: "die
685 Hauptkonfigurationsdatei"). Diese muss bei der Erstinstallation von
686 kivitendo bzw. der Migration von älteren Versionen angelegt
689 <para>Als Vorlage dient die Datei
690 <filename>config/kivitendo.conf.default</filename> (kurz: "die
691 Default-Datei"):</para>
693 <programlisting>$ cp config/kivitendo.conf.default config/kivitendo.conf</programlisting>
695 <para>Die Default-Datei wird immer zuerst eingelesen. Werte, die in
696 der Hauptkonfigurationsdatei stehen, überschreiben die Werte aus der
697 Default-Datei. Die Hauptkonfigurationsdatei muss also nur die
698 Abschnitte und Werte enthalten, die von denen der Default-Datei
702 <para>Vor der Umbenennung in kivitendo hieß diese Datei noch
703 <filename>config/lx_office.conf</filename>. Aus Gründen der
704 Kompatibilität wird diese Datei eingelesen, sofern die Datei
705 <filename>config/kivitendo.conf</filename> nicht existiert.</para>
708 <para>Diese Hauptkonfigurationsdatei ist dann eine
709 installationsspezifische Datei, d.h. sie enthält bspw. lokale
710 Passwörter und wird auch nicht im Versionsmanagement (git)
713 <para>Die Konfiguration ist ferner serverabhängig, d.h. für alle
714 Mandaten, bzw. Datenbanken gleich.</para>
717 <sect2 id="config.config-file.sections-parameters">
718 <title>Abschnitte und Parameter</title>
720 <para>Die Konfigurationsdatei besteht aus mehreren Teilen, die
721 entsprechend kommentiert sind:</para>
725 <para><literal>authentication</literal> (siehe Abschnitt "<xref
726 linkend="Benutzerauthentifizierung-und-Administratorpasswort"/>"
727 in diesem Kapitel)</para>
731 <para><literal>authentication/database</literal></para>
735 <para><literal>authentication/ldap</literal></para>
739 <para><literal>system</literal></para>
743 <para><literal>paths</literal></para>
747 <para><literal>mail_delivery</literal> (siehe Abschnitt "<xref
748 linkend="config.sending-email.smtp"/>)</para>
752 <para><literal>applications</literal></para>
756 <para><literal>environment</literal></para>
760 <para><literal>print_templates</literal></para>
764 <para><literal>task_server</literal></para>
768 <para><literal>periodic_invoices</literal></para>
772 <para><literal>self_tests</literal></para>
776 <para><literal>console</literal></para>
780 <para><literal>testing</literal></para>
784 <para><literal>testing/database</literal></para>
788 <para><literal>debug</literal></para>
792 <para>Die üblicherweise wichtigsten Parameter, die am Anfang
793 einzustellen oder zu kontrollieren sind, sind:</para>
795 <programlisting>[authentication]
796 admin_password = geheim
798 [authentication/database]
806 default_manager = german</programlisting>
808 <para>Für kivitendo Installationen in der Schweiz sollte hier
809 <varname>german</varname> durch <varname>swiss</varname> ersetzt
812 <para>Die Einstellung <varname>default_manager = swiss</varname>
817 <para>Beim Erstellen einer neuen Datenbank in der kivitendo
818 Administration werden automatisch die Standard-Werte für die
819 Schweiz voreingestellt: Währung CHF, 5er-Rundung, Schweizer
820 KMU-Kontenplan, Sollversteuerung, Aufwandsmethode, Bilanzierung
821 (die Werte können aber manuell angepasst werden).</para>
825 <para>Einstellen der Standardkonten für Rundungserträge und
826 -aufwendungen (unter Mandantenkonfiguration → Standardkonten
831 <para>das verwendete Zahlenformat wird auf
832 <varname>1'000.00</varname> eingestellt (unter Programm →
833 Benutzereinstellungen veränderbar)</para>
837 <para>DATEV-Automatik und UStVA werden nicht angezeigt,
838 Erfolgsrechnung ersetzt GUV ( unter Mandantenkonfiguration →
839 Features veränderbar)</para>
843 <para>Nutzt man wiederkehrende Rechnungen, kann man unter
844 <varname>[periodic_invoices]</varname> den Login eines Benutzers
845 angeben, der nach Erstellung der Rechnungen eine entsprechende E-Mail
846 mit Informationen über die erstellten Rechnungen bekommt.</para>
848 <para>kivitendo bringt eine eigene Komponente zur zeitgesteuerten
849 Ausführung bestimmter Aufgaben mit, den <link
850 linkend="config.task-server">Task-Server</link>. Er wird u.a. für
851 Features wie die <link
852 linkend="features.periodic-invoices">wiederkehrenden Rechnungen</link>
853 benötigt, erledigt aber auch andere erforderliche Aufgaben und muss
854 daher in Betrieb genommen werden. Seine Einrichtung wird im Abschnitt
855 <link linkend="config.task-server">Task-Server</link> genauer
858 <para>Für Entwickler finden sich unter <varname>[debug]</varname>
859 wichtige Funktionen, um die Fehlersuche zu erleichtern.</para>
862 <sect2 id="config.config-file.prior-versions">
863 <title>Versionen vor 2.6.3</title>
865 <para>In älteren kivitendo Versionen gab es im Verzeichnis
866 <filename>config</filename> die Dateien
867 <filename>authentication.pl</filename> und
868 <filename>lx-erp.conf</filename>, die jeweils Perl-Dateien waren. Es
869 gab auch die Möglichkeit, eine lokale Version der Konfigurationsdatei
870 zu erstellen (<filename>lx-erp-local.conf</filename>). Dies ist ab
871 2.6.3 nicht mehr möglich, aber auch nicht mehr nötig.</para>
873 <para>Beim Update von einer kivitendo-Version vor 2.6.3 auf 2.6.3 oder
874 jünger müssen die Einstellungen aus den alten Konfigurationsdateien
875 manuell übertragen und die alten Konfigurationsdateien anschließend
876 gelöscht oder verschoben werden. Ansonsten zeigt kivitendo eine
877 entsprechende Fehlermeldung an.</para>
881 <sect1 id="Anpassung-der-PostgreSQL-Konfiguration">
882 <title>Anpassung der PostgreSQL-Konfiguration</title>
884 <para>PostgreSQL muss auf verschiedene Weisen angepasst werden.</para>
885 <para>Dies variert je nach eingesetzter Distribution, da distributionsabhängig unterschiedliche Strategien beim Upgrade der Postgres Version eingesetzt werden.
886 Als Hinweis einige Links zu den drei Distribution (Stand Dezember 2018):</para>
889 <para><ulink url="https://fedoraproject.org/wiki/PostgreSQL">Fedora (Postgres-Installation unter Fedora)</ulink></para>
892 <para><ulink url="https://help.ubuntu.com/lts/serverguide/postgresql.html">Ubuntu (Infos für Postgres für die aktuelle LTS Version)</ulink></para>
895 <para><ulink url="https://de.opensuse.org/PostgreSQL">OpenSuSE (aktuell nur bis Version OpenSuSE 13 verifiziert)</ulink></para>
898 <sect2 id="Zeichensätze-die-Verwendung-von-UTF-8">
899 <title>Zeichensätze/die Verwendung von Unicode/UTF-8</title>
901 <para>kivitendo setzt zwingend voraus, dass die Datenbank
902 Unicode/UTF-8 als Encoding einsetzt. Bei aktuellen
903 Serverinstallationen braucht man hier meist nicht einzugreifen.</para>
905 <para>Das Encoding des Datenbankservers kann überprüft werden. Ist das
906 Encoding der Datenbank "template1" "Unicode" bzw. "UTF-8", so braucht
907 man nichts weiteres diesbezüglich unternehmen. Zum Testen:</para>
909 <programlisting>su postgres
911 exit </programlisting>
913 <para>Andernfalls ist es notwendig, einen neuen Datenbankcluster mit
914 Unicode-Encoding anzulegen und diesen zu verwenden. Unter Debian und
915 Ubuntu kann dies z.B. für PostgreSQL 9.3 mit dem folgenden Befehl
918 <programlisting>pg_createcluster --locale=de_DE.UTF-8 --encoding=UTF-8 9.3 clustername</programlisting>
920 <para>Die Datenbankversionsnummer muss an die tatsächlich verwendete
921 Versionsnummer angepasst werden.</para>
923 <para>Unter anderen Distributionen gibt es ähnliche Methoden.</para>
925 <para>Das Encoding einer Datenbank kann in <command>psql</command> mit
926 <literal>\l</literal> geprüft werden.</para>
929 <sect2 id="Änderungen-an-Konfigurationsdateien">
930 <title>Änderungen an Konfigurationsdateien</title>
932 <para>In der Datei <filename>postgresql.conf</filename>, die je nach
933 Distribution in verschiedenen Verzeichnissen liegen kann (z.B.
934 <filename>/var/lib/pgsql/data/</filename> oder
935 <filename>/etc/postgresql/</filename>), muss sichergestellt werden,
936 dass TCP/IP-Verbindungen aktiviert sind. Das Verhalten wird über den
937 Parameter <varname>listen_address</varname> gesteuert. Laufen
938 PostgreSQL und kivitendo auf demselben Rechner, so kann dort der Wert
939 <literal>localhost</literal> verwendet werden. Andernfalls müssen
940 Datenbankverbindungen auch von anderen Rechnern aus zugelassen werden,
941 was mit dem Wert <literal>*</literal> geschieht.</para>
943 <para>In der Datei <filename>pg_hba.conf</filename>, die im gleichen
944 Verzeichnis wie die <filename>postgresql.conf</filename> zu finden
945 sein sollte, müssen die Berechtigungen für den Zugriff geändert
946 werden. Hier gibt es mehrere Möglichkeiten. Sinnvoll ist es nur die
947 nötigen Verbindungen immer zuzulassen, für eine lokal laufende
948 Datenbank zum Beispiel:</para>
950 <programlisting>local all kivitendo password
951 host all kivitendo 127.0.0.1 255.255.255.255 password</programlisting>
954 <sect2 id="Erweiterung-für-servergespeicherte-Prozeduren">
955 <title>Erweiterung für servergespeicherte Prozeduren</title>
957 <para>In der Datenbank <literal>template1</literal> muss die
958 Unterstützung für servergespeicherte Prozeduren eingerichet werden.
959 Melden Sie sich dafür als Benutzer “postgres” an der Datenbank an:
960 <programlisting>su - postgres
961 psql template1</programlisting> führen Sie die folgenden Kommandos aus:</para>
963 <programlisting>CREATE EXTENSION IF NOT EXISTS plpgsql;
967 <para><literal>CREATE EXTENSION</literal> ist seit Version 9.1 die
968 bevorzugte Syntax um die Sprache <literal>plpgsql</literal>
969 anzulegen. In diesen Versionen ist die Extension meist auch schon
970 vorhanden. Sollten Sie eine ältere Version von Postgres haben,
971 benutzen Sie stattdessen den folgenden Befehl.</para>
973 <programlisting>CREATE LANGUAGE 'plpgsql';
978 <sect2 id="Erweiterung-für-trigram">
979 <title>Erweiterung für Trigram Prozeduren</title>
981 <para>Ab Version 3.5.1 wird die Trigram-Index-Erweiterung benötigt.
982 Diese wird mit dem SQL-Updatescript
983 sql/Pg-upgrade2/trigram_extension.sql und Datenbank-Super-Benutzer
984 Rechten automatisch installiert. Dazu braucht der
985 DatenbankSuperbenutzer "postgres" ein Passwort.</para>
987 <programlisting>su - postgres
994 <para>Benutzername Postgres und Passwort können jetzt beim Anlegen
995 einer Datenbank bzw. bei Updatescripten, die SuperuserRechte
996 benötigen, eingegeben werden.</para>
999 <para><literal>pg_trgm</literal> ist je nach Distribution nicht im
1000 Standard-Paket von Postgres enthalten. Ein <programlisting>select * from pg_available_extensions where name ='pg_trgm';</programlisting>
1001 in template1 sollte entsprechend erfolgreich sein. Andernfalls muss
1002 das Paket nachinstalliert werden, bspw. bei debian/ubuntu
1003 <programlisting>apt install postgresql-contrib</programlisting></para>
1007 <sect2 id="Datenbankbenutzer-anlegen">
1008 <title>Datenbankbenutzer anlegen</title>
1010 <para>Wenn Sie nicht den Datenbanksuperuser “postgres” zum Zugriff
1011 benutzen wollen, so sollten Sie bei PostgreSQL einen neuen Benutzer
1012 anlegen. Ein Beispiel, wie Sie einen neuen Benutzer anlegen
1015 <para>Die Frage, ob der neue User Superuser sein soll, können Sie mit
1016 nein beantworten, genauso ist die Berechtigung neue User (Roles) zu
1017 generieren nicht nötig.</para>
1019 <programlisting>su - postgres
1020 createuser -d -P kivitendo
1021 exit</programlisting>
1023 <para>Wenn Sie später einen Datenbankzugriff konfigurieren, verändern
1024 Sie den evtl. voreingestellten Benutzer “postgres” auf “kivitendo”
1025 bzw. den hier gewählten Benutzernamen.</para>
1029 <sect1 id="Apache-Konfiguration">
1030 <title>Webserver-Konfiguration</title>
1033 <title>Grundkonfiguration mittels CGI</title>
1036 <para>Für einen deutlichen Performanceschub sorgt die Ausführung
1037 mittels FastCGI/FCGI. Die Einrichtung wird ausführlich im Abschnitt
1038 <xref linkend="Apache-Konfiguration.FCGI"/> beschrieben.</para>
1041 <para>Der Zugriff auf das Programmverzeichnis muss in der Apache
1042 Webserverkonfigurationsdatei <literal>httpd.conf</literal> eingestellt
1043 werden. Fügen Sie den folgenden Abschnitt dieser Datei oder einer
1044 anderen Datei hinzu, die beim Starten des Webservers eingelesen
1047 <programlisting>AliasMatch ^/kivitendo-erp/[^/]+\.pl /var/www/kivitendo-erp/dispatcher.pl
1048 Alias /kivitendo-erp/ /var/www/kivitendo-erp/
1050 <Directory /var/www/kivitendo-erp>
1051 AddHandler cgi-script .pl
1052 Options ExecCGI Includes FollowSymlinks
1055 <Directory /var/www/kivitendo-erp/users>
1057 </Directory></programlisting>
1059 <para>Ersetzen Sie dabei die Pfade durch diejenigen, in die Sie vorher
1060 das kivitendo-Archiv entpacket haben.</para>
1063 <para>Vor den einzelnen Optionen muss bei einigen Distributionen ein
1064 Plus ‘<literal>+</literal>’ gesetzt werden.</para>
1066 <para>Bei einigen Distribution (Ubuntu ab 14.04, Debian ab 8.2) muss
1067 noch explizit das cgi-Modul mittels <programlisting>a2enmod cgi</programlisting>
1068 aktiviert werden.</para>
1071 <para>Auf einigen Webservern werden manchmal die Grafiken und
1072 Style-Sheets nicht ausgeliefert. In solchen Fällen hat es oft
1073 geholfen, die folgende Option in die Konfiguration aufzunehmen:</para>
1075 <programlisting>EnableSendfile Off</programlisting>
1078 <sect2 id="Apache-Konfiguration.FCGI"
1079 xreflabel="Konfiguration für FastCGI/FCGI">
1080 <title>Konfiguration für FastCGI/FCGI</title>
1082 <sect3 id="Apache-Konfiguration.FCGI.WasIstEs">
1083 <title>Was ist FastCGI?</title>
1085 <para>Direkt aus <ulink
1086 url="http://de.wikipedia.org/wiki/FastCGI">Wikipedia</ulink>
1089 <para><citation> FastCGI ist ein Standard für die Einbindung
1090 externer Software zur Generierung dynamischer Webseiten in einem
1091 Webserver. FastCGI ist vergleichbar zum Common Gateway Interface
1092 (CGI), wurde jedoch entwickelt, um dessen Performance-Probleme zu
1093 umgehen. </citation></para>
1096 <sect3 id="Apache-Konfiguration.FCGI.Warum">
1097 <title>Warum FastCGI?</title>
1099 <para>Perl Programme (wie kivitendo eines ist) werden nicht statisch
1100 kompiliert. Stattdessen werden die Quelldateien bei jedem Start
1101 übersetzt, was bei kurzen Laufzeiten einen Großteil der Laufzeit
1102 ausmacht. Während SQL Ledger einen Großteil der Funktionalität in
1103 einzelne Module kapselt, um immer nur einen kleinen Teil laden zu
1104 müssen, ist die Funktionalität von kivitendo soweit gewachsen, dass
1105 immer mehr Module auf den Rest des Programms zugreifen. Zusätzlich
1106 benutzen wir umfangreiche Bibliotheken um Funktionaltät nicht selber
1107 entwickeln zu müssen, die zusätzliche Ladezeit kosten. All dies
1108 führt dazu dass ein kivitendo Aufruf der Kernmasken mittlerweile
1109 deutlich länger dauert als früher, und dass davon 90% für das Laden
1110 der Module verwendet wird.</para>
1112 <para>Mit FastCGI werden nun die Module einmal geladen, und danach
1113 wird nur die eigentliche Programmlogik ausgeführt.</para>
1116 <sect3 id="Apache-Konfiguration.FCGI.WebserverUndPlugin">
1117 <title>Getestete Kombinationen aus Webservern und Plugin</title>
1119 <para>Folgende Kombinationen sind getestet:</para>
1123 <para>Apache 2.4.7 (Ubuntu 14.04.2 LTS) und mod_fcgid.</para>
1126 <para>Apache 2.4.18 (Ubuntu 16.04 LTS) und mod_fcgid</para>
1129 <para>Apache 2.4.29 (Ubuntu 18.04 LTS) und mod_fcgid</para>
1133 <para>Als Perl Backend wird das Modul <filename>FCGI.pm</filename>
1137 <para>FCGI-Versionen ab 0.69 und bis zu 0.71 inklusive sind extrem
1138 strict in der Behandlung von Unicode, und verweigern bestimmte
1139 Eingaben von kivitendo. Falls es Probleme mit Umlauten in Ihrer
1140 Installation gibt, muss zwingend Version 0.68 oder aber Version
1141 0.72 und neuer eingesetzt werden.</para>
1143 <para>Mit <ulink url="http://www.cpan.org">CPAN</ulink> lässt sie
1144 sich die Vorgängerversion wie folgt installieren:</para>
1146 <programlisting>force install M/MS/MSTROUT/FCGI-0.68.tar.gz</programlisting>
1150 <sect3 id="Apache-Konfiguration.FCGI.Konfiguration">
1151 <title>Konfiguration des Webservers</title>
1153 <para>Bevor Sie versuchen, eine kivitendo Installation unter FCGI
1154 laufen zu lassen, empfiehlt es sich die Installation ersteinmal
1155 unter CGI aufzusetzen. FCGI macht es nicht einfach Fehler zu
1156 debuggen die beim ersten aufsetzen auftreten können. Sollte die
1157 Installation schon funktionieren, lesen Sie weiter.</para>
1159 <para>Zuerst muss das FastCGI-Modul aktiviert werden. Dies kann
1160 unter Debian/Ubuntu z.B. mit folgendem Befehl geschehen:</para>
1162 <programlisting>a2enmod fcgid</programlisting>
1164 <para>Die Konfiguration für die Verwendung von kivitendo mit FastCGI
1165 erfolgt durch Anpassung der vorhandenen <function>Alias</function>-
1166 und <function>Directory</function>-Direktiven. Dabei wird zwischen
1167 dem Installationspfad von kivitendo im Dateisystem
1168 ("<filename>/path/to/kivitendo-erp</filename>") und der URL
1169 unterschieden, unter der kivitendo im Webbrowser erreichbar ist
1170 ("<filename>/url/for/kivitendo-erp</filename>").</para>
1172 <para>Folgender Konfigurationsschnipsel funktioniert mit
1175 <programlisting>AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fcgi
1176 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
1178 <Directory /path/to/kivitendo-erp>
1180 Options ExecCGI Includes FollowSymlinks
1184 <DirectoryMatch /path/to/kivitendo-erp/users>
1186 </DirectoryMatch></programlisting>
1189 <para>Wer einen älteren Apache als Version 2.4 im Einsatz hat,
1190 muss entsprechend die Syntax der Directorydirektiven verändert.
1193 <programlisting>Require all granted</programlisting>
1195 <para>muß man Folgendes einstellen:</para>
1199 Allow from All </programlisting>
1201 <para>und statt</para>
1203 <programlisting>Require all denied</programlisting>
1205 <para>muss stehen:</para>
1209 Deny from All </programlisting>
1212 <para>Seit mod_fcgid-Version 2.3.6 gelten sehr kleine Grenzen für
1213 die maximale Größe eines Requests. Diese sollte wie folgt
1214 hochgesetzt werden:</para>
1216 <programlisting>FcgidMaxRequestLen 10485760</programlisting>
1218 <para>Das Ganze sollte dann so aussehen:</para>
1220 <programlisting>AddHandler fcgid-script .fpl
1221 AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
1222 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
1223 FcgidMaxRequestLen 10485760
1225 <Directory /path/to/kivitendo-erp>
1227 Options ExecCGI Includes FollowSymlinks
1231 <DirectoryMatch /path/to/kivitendo-erp/users>
1233 </DirectoryMatch></programlisting>
1235 <para>Hierdurch wird nur ein zentraler Dispatcher gestartet. Alle
1236 Zugriffe auf die einzelnen Scripte werden auf diesen umgeleitet.
1237 Dadurch, dass zur Laufzeit öfter mal Scripte neu geladen werden,
1238 gibt es hier kleine Performance-Einbußen.</para>
1240 <para>Es ist möglich, die gleiche kivitendo Version parallel unter
1241 CGI und FastCGI zu betreiben. Dafür bleiben die Directorydirektiven
1242 wie oben beschrieben, die URLs werden aber umgeleitet:</para>
1244 <programlisting># Zugriff über CGI
1245 Alias /url/for/kivitendo-erp /path/to/kivitendo-erp
1247 # Zugriff mit mod_fcgid:
1248 AliasMatch ^/url/for/kivitendo-erp-fcgid/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
1249 Alias /url/for/kivitendo-erp-fcgid/ /path/to/kivitendo-erp/</programlisting>
1251 <para>Dann ist unter <filename>/url/for/kivitendo-erp/</filename>
1252 die normale Version erreichbar, und unter
1253 <constant>/url/for/kivitendo-erp-fcgid/</constant> die
1254 FastCGI-Version.</para>
1259 <title>Authentifizierung mittels HTTP Basic Authentication</title>
1262 Kivitendo unterstützt, dass Benutzerauthentifizierung über den Webserver mittels des »Basic«-HTTP-Authentifizierungs-Schema erfolgt
1263 (siehe <ulink url="https://tools.ietf.org/html/rfc7617">RFC 7617</ulink>). Dazu ist es aber nötig, dass der dabei vom Client
1264 mitgeschickte Header <constant>Authorization</constant> vom Webserver an Kivitendo über die Umgebungsvariable
1265 <constant>HTTP_AUTHORIZATION</constant> weitergegeben wird, was standardmäßig nicht der Fall ist. Für Apache kann dies über die
1266 folgende Konfigurationsoption aktiviert werden:
1269 <programlisting>SetEnvIf Authorization "(.*)" HTTP_AUTHORIZATION=$1</programlisting>
1273 <title>Weitergehende Konfiguration</title>
1275 <para>Für einen deutlichen Sicherheitsmehrwert sorgt die Ausführung
1276 von kivitendo nur über https-verschlüsselten Verbindungen, sowie
1277 weiteren Zusatzmassnahmen, wie beispielsweise Basic Authenticate. Die
1278 Konfigurationsmöglichkeiten sprengen allerdings den Rahmen dieser
1279 Anleitung, hier ein Hinweis auf einen entsprechenden <ulink
1280 url="http://redmine.kivitendo-premium.de/boards/1/topics/142">Foreneintrag
1281 (Stand Sept. 2015)</ulink> und einen aktuellen (Stand Mai 2017) <ulink
1282 url="https://mozilla.github.io/server-side-tls/ssl-config-generator/">
1283 SSL-Konfigurations-Generator</ulink>.</para>
1287 <sect1 id="config.task-server">
1288 <title>Der Task-Server</title>
1290 <para>Der Task-Server ist ein Prozess, der im Hintergrund läuft, in
1291 regelmäßigen Abständen nach abzuarbeitenden Aufgaben sucht und diese zu
1292 festgelegten Zeitpunkten abarbeitet (ähnlich wie Cron). Dieser Prozess
1293 wird u.a. für die Erzeugung der wiederkehrenden Rechnungen und weitere
1294 essenzielle Aufgaben benutzt.</para>
1296 <para>Der Task-Server muss einmalig global in der Konfigurationsdatei
1297 konfiguriert werden. Danach wird er für jeden Mandanten, für den er
1298 laufen soll, in der Adminsitrationsmaske eingeschaltet.</para>
1300 <para>Beachten Sie, dass der Task-Server in den Boot-Vorgang Ihres
1301 Servers integriert werden muss, damit er automatisch gestartet wird.
1302 Dies kann kivitendo nicht für Sie erledigen.</para>
1304 <para>Da der Task-Server als Perlscript läuft, wird Arbeitsspeicher, der
1305 einmal benötigt wurde, nicht mehr an das Betriebssystem zurückgegeben,
1306 solange der Task-Server läuft. Dies kann dazu führen, dass ein länger
1307 laufender Task-Server mit der Zeit immer mehr Arbeitsspeicher für sich
1308 beansprucht. Es ist deshalb sinnvoll, dass der Task-Server in
1309 regelmässigen Abständen neu gestartet wird. Allerdings berücksichtigt der
1310 Task-Server ein Memory-Limit, wenn dieses in der Konfigurationsdatei
1311 angegeben ist. Bei Überschreiten dieses Limits beendet sich der
1312 Task-Server. Sofern der Task-Server als systemd-Service mit dem
1313 mitgelieferten Skript eingerichtet wurde, startet dieser danach
1314 automatisch erneut.</para>
1316 <sect2 id="Konfiguration-des-Task-Servers">
1317 <title>Verfügbare und notwendige Konfigurationsoptionen</title>
1319 <para>Die Konfiguration erfolgt über den Abschnitt
1320 <literal>[task_server]</literal> in der Datei
1321 <filename>config/kivitendo.conf</filename>. Die dort verfügbaren
1322 Optionen sind:</para>
1326 <term><varname>run_as</varname></term>
1329 <para>Wird der Server vom Systembenutzer <literal>root</literal>
1330 gestartet, so wechselt er auf den mit <literal>run_as</literal>
1331 angegebenen Systembenutzer. Der Systembenutzer muss dieselben
1332 Lese- und Schreibrechte haben, wie auch der Webserverbenutzer
1334 linkend="Manuelle-Installation-des-Programmpaketes"/>). Daher
1335 ist es erforderlich, hier denselben Systembenutzer einzutragen,
1336 unter dem auch der Webserver läuft.</para>
1341 <term><varname>debug</varname></term>
1344 <para>Schaltet Debug-Informationen an und aus.</para>
1350 <sect2 id="Konfiguration-der-Mandanten-fuer-den-Task-Servers">
1351 <title>Konfiguration der Mandanten für den Task-Server</title>
1353 <para>Ist der Task-Server grundlegend konfiguriert, so muss
1354 anschließend jeder Mandant, für den der Task-Server laufen soll,
1355 einmalig konfiguriert werden. Dazu kann in der Maske zum Bearbeiten
1356 von Mandanten im Administrationsbereich eine kivitendo-Benutzerkennung
1357 ausgewählt werden, unter der der Task-Server seine Arbeit
1360 <para>Ist in dieser Einstellung keine Benutzerkennung ausgewählt, so
1361 wird der Task-Server für diesen Mandanten keine Aufgaben
1365 <sect2 id="Einbinden-in-den-Boot-Prozess">
1366 <title>Automatisches Starten des Task-Servers beim Booten</title>
1368 <para>Der Task-Server verhält sich von seinen Optionen her wie ein
1369 reguläres SystemV-kompatibles Boot-Script. Außerdem wechselt er beim
1370 Starten automatisch in das kivitendo-Installationsverzeichnis.</para>
1372 <para>Deshalb ist es möglich, ihn durch Setzen eines symbolischen
1373 Links aus einem der Runlevel-Verzeichnisse heraus in den Boot-Prozess
1374 einzubinden. Da das bei neueren Linux-Distributionen aber nicht
1375 zwangsläufig funktioniert, werden auch Start-Scripte mitgeliefert, die
1376 anstelle eines symbolischen Links verwendet werden können.</para>
1379 <title>SystemV-basierende Systeme (z.B. ältere Debian, ältere
1380 openSUSE, ältere Fedora)</title>
1382 <para>Kopieren Sie die Datei
1383 <filename>scripts/boot/system-v/kivitendo-task-server</filename>
1384 nach <filename>/etc/init.d/kivitendo-task-server</filename>. Passen
1385 Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
1386 <literal>DAEMON=....</literal>). Binden Sie das Script in den
1387 Boot-Prozess ein. Dies ist distributionsabhängig:</para>
1391 <para>Debian-basierende Systeme:</para>
1393 <programlisting>update-rc.d kivitendo-task-server defaults
1394 insserv kivitendo-task-server</programlisting>
1398 <para>Ältere openSUSE und ältere Fedora:</para>
1400 <programlisting>chkconfig --add kivitendo-task-server</programlisting>
1404 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
1407 <programlisting>/etc/init.d/kivitendo-task-server start</programlisting>
1411 <title>Upstart-basierende Systeme (z.B. Ubuntu bis 14.04)</title>
1413 <para>Kopieren Sie die Datei
1414 <filename>scripts/boot/upstart/kivitendo-task-server.conf</filename>
1415 nach <filename>/etc/init/kivitendo-task-server.conf</filename>.
1416 Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
1417 <literal>exec ....</literal>).</para>
1419 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
1422 <programlisting>service kivitendo-task-server start</programlisting>
1426 <title>systemd-basierende Systeme (z.B. neure openSUSE, neuere
1427 Fedora, neuere Ubuntu und neuere Debians)</title>
1429 <para>Kopieren Sie die Datei
1430 <filename>scripts/boot/systemd/kivitendo-task-server.service</filename>
1431 nach <filename>/etc/systemd/system/</filename>. Passen Sie in der
1432 kopierten Datei den Pfad zum Task-Server an (Zeilen
1433 <literal>ExecStart=....</literal> und
1434 <literal>ExecStop=...</literal>).</para>
1436 <para>Machen Sie anschließend das Script systemd bekannt, und binden
1437 Sie es in den Boot-Prozess ein. Dazu führen Sie die folgenden Befehl
1440 <programlisting>systemctl daemon-reload
1441 systemctl enable kivitendo-task-server.service</programlisting>
1443 <para>Wenn Sie den Task-Server jetzt sofort starten möchten, anstatt
1444 den Server neu zu starten, so können Sie das mit dem folgenden
1447 <programlisting>systemctl start kivitendo-task-server.service</programlisting>
1449 <para>Ein so eingerichteter Task-Server startet nach Beendigung
1450 automatisch erneut. Das betrifft eine Beendigung über die Oberfläche,
1451 eine Beendingung über die Prozesskontrolle und eine Beendigung bei
1452 Überschreiten des Memory-Limits. Soll der Task-Server nicht erneut
1453 starten, so können Sie ihn mit folgendem Befehl stoppen:</para>
1455 <programlisting>systemctl stop kivitendo-task-server.service</programlisting>
1460 <sect2 id="Prozesskontrolle">
1461 <title>Wie der Task-Server gestartet und beendet wird</title>
1463 <para>Der Task-Server wird wie folgt kontrolliert:</para>
1465 <programlisting>./scripts/task_server.pl Befehl</programlisting>
1467 <para><literal>Befehl</literal> ist dabei eine der folgenden
1472 <para><literal>start</literal> startet eine neue Instanz des
1473 Task-Servers. Die Prozess-ID wird innerhalb des
1474 <filename>users</filename>-Verzeichnisses abgelegt.</para>
1478 <para><literal>stop</literal> beendet einen laufenden
1483 <para><literal>restart</literal> beendet und startet ihn
1488 <para><literal>status</literal> berichtet, ob der Task-Server
1493 <para>Der Task-Server wechselt beim Starten automatisch in das
1494 kivitendo-Installationsverzeichnis.</para>
1496 <para>Dieselben Optionen können auch für die SystemV-basierenden
1497 Runlevel-Scripte benutzt werden (siehe oben).</para>
1499 <para>Wurde der Task-Server als systemd-Service eingerichtet (s.o.),
1500 so startet dieser nach Beendigung automatisch erneut.</para>
1503 <sect2 id="Tasks konfigurieren">
1504 <title>Exemplarische Konfiguration eines Hintergrund-Jobs, der die Jahreszahl in allen Nummernkreisen zum Jahreswechsel erhöht</title>
1506 <para>Hintergrund-Jobs werden über System -> Hintergrund-Jobs und Task-Server -> Aktuelle Hintergrund-Jobs anzeigen -> Aktions-Knopf 'erfassen' angelegt. </para>
1507 <para>Nachdem wir über das Menü dort angelangt sind, legen wir unseren exemplarischen Hintergrund-Jobs "Erhöhung der Nummernkreise" mit folgenden Werten an:</para>
1510 <para><literal>Aktiv:</literal> Hier ein 'Ja' auswählen</para>
1513 <para><literal>Ausführungsart:</literal> 'wiederholte Ausführung' auswählen</para>
1516 <para><literal>Paketname:</literal> 'SetNumberRange' auswählen</para>
1519 <para><literal>Ausführungszeitplan:</literal> Hier entsprechend Werte wie in der crontab eingeben.</para><para>Syntax:</para>
1520 <programlisting>* * * * *
1523 │ │ │ │ └──── Wochentag (0-7, Sonntag ist 0 oder 7)
1524 │ │ │ └────── Monat (1-12)
1525 │ │ └──────── Tag (1-31)
1526 │ └────────── Stunde (0-23)
1527 └──────────── Minute (0-59) </programlisting>
1528 <para>Die Sterne können folgende Werte haben:</para>
1536 5 = Wochentag (0-7, Sonntag ist 0 oder 7)
1538 <para>Um die Ausführung auf eine Minute vor Sylvester zu setzen, müssen die folgenden Werte eingetragen werden:</para>
1539 <programlisting>59 23 31 12 *</programlisting>
1542 <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>
1544 multiplier Nummernkreis 2020
1549 <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>
1550 <literal>Daten:</literal><programlisting>multiplier: 100
1551 digits_year: 4</programlisting>
1556 <sect1 id="Benutzerauthentifizierung-und-Administratorpasswort">
1557 <title>Benutzerauthentifizierung und Administratorpasswort</title>
1559 <para>Informationen über die Einrichtung der Benutzerauthentifizierung,
1560 über die Verwaltung von Gruppen und weitere Einstellungen</para>
1562 <sect2 id="Grundlagen-zur-Benutzerauthentifizierung">
1563 <title>Grundlagen zur Benutzerauthentifizierung</title>
1565 <para>kivitendo verwaltet die Benutzerinformationen in einer
1566 Datenbank, die im folgenden “Authentifizierungsdatenbank” genannt
1567 wird. Für jeden Benutzer kann dort eine eigene Datenbank für die
1568 eigentlichen Finanzdaten hinterlegt sein. Diese beiden Datenbanken
1569 können, müssen aber nicht unterschiedlich sein.</para>
1571 <para>Im einfachsten Fall gibt es für kivitendo nur eine einzige
1572 Datenbank, in der sowohl die Benutzerinformationen als auch die Daten
1573 abgelegt werden.</para>
1575 <para>Zusätzlich ermöglicht es kivitendo, dass die Benutzerpasswörter gegen die Authentifizierungsdatenbank oder gegen einen oder
1576 mehrere LDAP-Server überprüft werden.</para>
1578 <para>Welche Art der Passwortüberprüfung kivitendo benutzt und wie
1579 kivitendo die Authentifizierungsdatenbank erreichen kann, wird in der
1580 Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1581 festgelegt. Diese muss bei der Installation und bei einem Upgrade von
1582 einer Version vor v2.6.0 angelegt werden. Eine
1583 Beispielkonfigurationsdatei
1584 <filename>config/kivitendo.conf.default</filename> existiert, die als
1585 Vorlage benutzt werden kann.</para>
1588 <sect2 id="Administratorpasswort">
1589 <title>Administratorpasswort</title>
1591 <para>Das Passwort, das zum Zugriff auf das Administrationsinterface
1592 von kivitendo benutzt wird, wird ebenfalls in dieser Datei
1593 gespeichert. Es kann auch nur dort und nicht mehr im
1594 Administrationsinterface selber geändert werden. Der Parameter dazu
1595 heißt <varname>admin_password</varname> im Abschnitt
1596 <varname>[authentication]</varname>.</para>
1599 <sect2 id="Authentifizierungsdatenbank">
1600 <title>Authentifizierungsdatenbank</title>
1602 <para>Die Verbindung zur Authentifizierungsdatenbank wird mit den
1603 Parametern in <varname>[authentication/database]</varname>
1604 konfiguriert. Hier sind die folgenden Parameter anzugeben:</para>
1608 <term><literal>host</literal></term>
1611 <para>Der Rechnername oder die IP-Adresse des
1612 Datenbankservers</para>
1617 <term><literal>port</literal></term>
1620 <para>Die Portnummer des Datenbankservers, meist 5432</para>
1625 <term><literal>db</literal></term>
1628 <para>Der Name der Authentifizierungsdatenbank</para>
1633 <term><literal>user</literal></term>
1636 <para>Der Benutzername, mit dem sich kivitendo beim
1637 Datenbankserver anmeldet (z.B.
1638 "<literal>postgres</literal>")</para>
1643 <term><literal>password</literal></term>
1646 <para>Das Passwort für den Datenbankbenutzer</para>
1651 <para>Die Datenbank muss noch nicht existieren. kivitendo kann sie
1652 automatisch anlegen (mehr dazu siehe unten).</para>
1655 <sect2 id="Passwortüberprüfung">
1656 <title>Passwortüberprüfung</title>
1658 <para>kivitendo unterstützt Passwortüberprüfung auf zwei Arten: gegen
1659 die Authentifizierungsdatenbank und gegen externe LDAP- oder
1660 Active-Directory-Server. Welche davon benutzt wird, regelt der
1661 Parameter <varname>module</varname> im Abschnitt
1662 <varname>[authentication]</varname>.</para>
1664 <para>Dieser Parameter listet die zu verwendenden Authentifizierungsmodule auf. Es muss mindestens ein Modul angegeben werden, es
1665 können aber auch mehrere angegeben werden. Weiterhin ist es möglich, das LDAP-Modul mehrfach zu verwenden und für jede Verwendung
1666 eine unterschiedliche Konfiguration zu nutzen, z.B. um einen Fallback-Server anzugeben, der benutzt wird, sofern der Hauptserver
1667 nicht erreichbar ist.</para>
1669 <para>Sollen die Benutzerpasswörter in der Authentifizierungsdatenbank geprüft werden, so muss der Parameter
1670 <varname>module</varname> das Modul <literal>DB</literal> enthalten. Sofern das Modul in der Liste enthalten ist, egal an welcher
1671 Position, können sowohl der Administrator als auch die Benutzer selber ihre Passwörter in kivitendo ändern.</para>
1673 <para>Wenn Passwörter gegen einen oder mehrere externe LDAP- oder Active-Directory-Server geprüft werden, so muss der Parameter
1674 <varname>module</varname> den Wert <literal>LDAP</literal> enthalten. In diesem Fall müssen zusätzliche Informationen über den
1675 LDAP-Server im Abschnitt <literal>[authentication/ldap]</literal> angegeben werden. Das Modul kann auch mehrfach angegeben werden,
1676 wobei jedes Modul eine eigene Konfiguration bekommen sollte. Der Name der Konfiguration wird dabei mit einem Doppelpunkt getrennt an
1677 den Modulnamen angehängt (<literal>LDAP:Name-der-Konfiguration</literal>). Der entsprechende Abschnitt in der Konfigurationsdatei
1678 lautet dann <literal>[authentication/Name-der-Konfiguration]</literal>.</para>
1680 <para>Die verfügbaren Parameter für die LDAP-Konfiguration lauten:</para>
1684 <term><literal>host</literal></term>
1687 <para>Der Rechnername oder die IP-Adresse des LDAP- oder
1688 Active-Directory-Servers. Diese Angabe ist zwingend
1689 erforderlich.</para>
1694 <term><literal>port</literal></term>
1697 <para>Die Portnummer des LDAP-Servers; meist 389.</para>
1702 <term><literal>tls</literal></term>
1705 <para>Wenn Verbindungsverschlüsselung gewünscht ist, so diesen
1706 Wert auf ‘<literal>1</literal>’ setzen, andernfalls auf
1707 ‘<literal>0</literal>’ belassen</para>
1712 <term><literal>verify</literal></term>
1715 <para>Wenn Verbindungsverschlüsselung gewünscht und der Parameter <parameter>tls</parameter> gesetzt ist, so gibt dieser
1716 Parameter an, ob das Serverzertifikat auf Gültigkeit geprüft wird. Mögliche Werte sind <literal>require</literal> (Zertifikat
1717 wird überprüft und muss gültig sei; dies ist der Standard) und <literal>none</literal> (Zertifikat wird nicht
1723 <term><literal>attribute</literal></term>
1726 <para>Das LDAP-Attribut, in dem der Benutzername steht, den der
1727 Benutzer eingegeben hat. Für Active-Directory-Server ist dies
1728 meist ‘<literal>sAMAccountName</literal>’, für andere
1729 LDAP-Server hingegen ‘<literal>uid</literal>’. Diese Angabe ist
1730 zwingend erforderlich.</para>
1735 <term><literal>base_dn</literal></term>
1738 <para>Der Abschnitt des LDAP-Baumes, der durchsucht werden soll.
1739 Diese Angabe ist zwingend erforderlich.</para>
1744 <term><literal>filter</literal></term>
1747 <para>Ein optionaler LDAP-Filter. Enthält dieser Filter das Wort
1748 <literal><%login%></literal>, so wird dieses durch den vom
1749 Benutzer eingegebenen Benutzernamen ersetzt. Andernfalls wird
1750 der LDAP-Baum nach einem Element durchsucht, bei dem das oben
1751 angegebene Attribut mit dem Benutzernamen identisch ist.</para>
1756 <term><literal>bind_dn</literal> und
1757 <literal>bind_password</literal></term>
1760 <para>Wenn der LDAP-Server eine Anmeldung erfordert, bevor er
1761 durchsucht werden kann (z.B. ist dies bei
1762 Active-Directory-Servern der Fall), so kann diese hier angegeben
1763 werden. Für Active-Directory-Server kann als
1764 ‘<literal>bind_dn</literal>’ entweder eine komplette LDAP-DN wie
1765 z.B. ‘<literal>cn=Martin
1766 Mustermann,cn=Users,dc=firmendomain</literal>’ auch nur der
1767 volle Name des Benutzers eingegeben werden; in diesem Beispiel
1768 also ‘<literal>Martin Mustermann</literal>’.</para>
1773 <term><literal>timeout</literal></term>
1776 <para>Timeout beim Verbindungsversuch, bevor der Server als nicht erreichbar gilt; Standardwert: 10</para>
1782 <sect2 id="Name-des-Session-Cookies">
1783 <title>Name des Session-Cookies</title>
1785 <para>Sollen auf einem Server mehrere kivitendo-Installationen
1786 aufgesetzt werden, so müssen die Namen der Session-Cookies für alle
1787 Installationen unterschiedlich sein. Der Name des Cookies wird mit dem
1788 Parameter <varname>cookie_name</varname> im Abschnitt
1789 <varname>[authentication]</varname>gesetzt.</para>
1791 <para>Diese Angabe ist optional, wenn nur eine Installation auf dem
1792 Server existiert.</para>
1795 <sect2 id="Anlegen-der-Authentifizierungsdatenbank">
1796 <title>Anlegen der Authentifizierungsdatenbank</title>
1798 <para>Nachdem alle Einstellungen in
1799 <filename>config/kivitendo.conf</filename> vorgenommen wurden, muss
1800 kivitendo die Authentifizierungsdatenbank anlegen. Dieses geschieht
1801 automatisch, wenn Sie sich im Administrationsmodul anmelden, das unter
1802 der folgenden URL erreichbar sein sollte:</para>
1805 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
1809 <sect1 id="Benutzer--und-Gruppenverwaltung">
1810 <title>Mandanten-, Benutzer- und Gruppenverwaltung</title>
1812 <para>Nach der Installation müssen Mandanten, Benutzer, Gruppen und
1813 Datenbanken angelegt werden. Dieses geschieht im Administrationsmenü,
1814 das Sie unter folgender URL finden:</para>
1817 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
1819 <para>Verwenden Sie zur Anmeldung das Passwort, das Sie in der Datei
1820 <filename>config/kivitendo.conf</filename> eingetragen haben.</para>
1822 <sect2 id="Zusammenhänge">
1823 <title>Zusammenhänge</title>
1825 <para>kivitendo verwaltet zwei Sets von Daten, die je nach Einrichtung
1826 in einer oder zwei Datenbanken gespeichert werden.</para>
1828 <para>Das erste Set besteht aus Anmeldeinformationen: welche Benutzer
1829 und Mandanten gibt es, welche Gruppen, welche BenutzerIn hat Zugriff
1830 auf welche Mandanten, und welche Gruppe verfügt über welche Rechte.
1831 Diese Informationen werden in der Authentifizierungsdatenbank
1832 gespeichert. Dies ist diejenige Datenbank, deren Verbindungsparameter
1833 in der Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1834 gespeichert werden.</para>
1836 <para>Das zweite Set besteht aus den eigentlichen Verkehrsdaten eines
1837 Mandanten, wie beispielsweise die Stammdaten (Kunden, Lieferanten,
1838 Waren) und Belege (Angebote, Lieferscheine, Rechnungen). Diese werden
1839 in einer Mandantendatenbank gespeichert. Die Verbindungsinformationen
1840 einer solchen Mandantendatenbank werden im Administrationsbereich
1841 konfiguriert, indem man einen Mandanten anlegt und dort die Parameter
1842 einträgt. Dabei hat jeder Mandant eine eigene Datenbank.</para>
1844 <para>Aufgrund des Datenbankdesigns ist es für einfache Fälle möglich,
1845 die Authentifizierungsdatenbank und eine der Mandantendatenbanken in
1846 ein und derselben Datenbank zu speichern. Arbeitet man hingegen mit
1847 mehr als einem Mandanten, wird empfohlen, für die
1848 Authentifizierungsdatenbank eine eigene Datenbank zu verwenden, die
1849 nicht gleichzeitig für einen Mandanten verwendet wird.</para>
1852 <sect2 id="Mandanten-Benutzer-Gruppen">
1853 <title>Mandanten, Benutzer und Gruppen</title>
1855 <para>kivitendos Administration kennt Mandanten, Benutzer und Gruppen,
1856 die sich frei zueinander zuordnen lassen.</para>
1858 <para>kivitendo kann mehrere Mandaten aus einer Installation heraus
1859 verwalten. Welcher Mandant benutzt wird, kann direkt beim Login
1860 ausgewählt werden. Für jeden Mandanten wird ein eindeutiger Name
1861 vergeben, der beim Login angezeigt wird. Weiterhin benötigt der
1862 Mandant Datenbankverbindungsparameter für seine Mandantendatenbank.
1863 Diese sollte über die <link
1864 linkend="Datenbanken-anlegen">Datenbankverwaltung</link>
1867 <para>Ein Benutzer ist eine Person, die Zugriff auf kivitendo erhalten
1868 soll. Sie erhält einen Loginnamen sowie ein Passwort. Weiterhin legt
1869 der Administrator fest, an welchen Mandanten sich ein Benutzer
1870 anmelden kann, was beim Login verifiziert wird.</para>
1872 <para>Gruppen dienen dazu, Benutzern innerhalb eines Mandanten Zugriff
1873 auf bestimmte Funktionen zu geben. Einer Gruppe werden dafür vom
1874 Administrator gewisse Rechte zugeordnet. Weiterhin legt der
1875 Administrator fest, für welche Mandanten eine Gruppe gilt, und welche
1876 Benutzer Mitglieder in dieser Gruppe sind. Meldet sich ein Benutzer
1877 dann an einem Mandanten an, so erhält er alle Rechte von allen
1878 denjenigen Gruppen, die zum Einen dem Mandanten zugeordnet sind und in
1879 denen der Benutzer zum Anderen Mitglied ist,</para>
1881 <para>Die Reihenfolge, in der Datenbanken, Mandanten, Gruppen und
1882 Benutzer angelegt werden, kann im Prinzip beliebig gewählt werden. Die
1883 folgende Reihenfolge beinhaltet die wenigsten Arbeitsschritte:</para>
1885 <orderedlist numeration="arabic">
1887 <para>Datenbank anlegen</para>
1891 <para>Gruppen anlegen</para>
1895 <para>Benutzer anlegen und Gruppen als Mitglied zuordnen</para>
1899 <para>Mandanten anlegen und Gruppen sowie Benutzer zuweisen</para>
1904 <sect2 id="Datenbanken-anlegen">
1905 <title>Datenbanken anlegen</title>
1907 <para>Zuerst muss eine Datenbank angelegt werden. Verwenden Sie für
1908 den Datenbankzugriff den vorhin angelegten Benutzer (in unseren
1909 Beispielen ist dies ‘<literal>kivitendo</literal>’).</para>
1912 <sect2 id="Gruppen-anlegen">
1913 <title>Gruppen anlegen</title>
1915 <para>Eine Gruppe wird in der Gruppenverwaltung angelegt. Ihr muss ein
1916 Name gegeben werden, eine Beschreibung ist hingegen optional. Nach dem
1917 Anlegen können Sie die verschiedenen Bereiche wählen, auf die
1918 Mitglieder dieser Gruppe Zugriff haben sollen.</para>
1920 <para>Benutzergruppen werden zwar in der Authentifizierungsdatenbank
1921 gespeichert, gelten aber nicht automatisch für alle Mandanten. Der
1922 Administrator legt vielmehr fest, für welche Mandanten eine Gruppe
1923 gültig ist. Dies kann entweder beim Bearbeiten der Gruppe geschehen
1924 ("diese Gruppe ist gültig für Mandanten X, Y und Z"), oder aber wenn
1925 man einen Mandanten bearbeitet ("für diesen Mandanten sind die Gruppen
1926 A, B und C gültig").</para>
1928 <para>Wurden bereits Benutzer angelegt, so können hier die Mitglieder
1929 dieser Gruppe festgelegt werden ("in dieser Gruppe sind die Benutzer
1930 X, Y und Z Mitglieder"). Dies kann auch nachträglich beim Bearbeiten
1931 eines Benutzers geschehen ("dieser Benutzer ist Mitglied in den
1932 Gruppen A, B und C").</para>
1935 <sect2 id="Benutzer-anlegen">
1936 <title>Benutzer anlegen</title>
1938 <para>Beim Anlegen von Benutzern werden für viele Parameter
1939 Standardeinstellungen vorgenommen, die den Gepflogenheiten des
1940 deutschen Raumes entsprechen.</para>
1942 <para>Zwingend anzugeben ist der Loginname. Wenn die
1943 Passwortauthentifizierung über die Datenbank eingestellt ist, so kann
1944 hier auch das Benutzerpasswort gesetzt bzw. geändert werden. Ist
1945 hingegen die LDAP-Authentifizierung aktiv, so ist das Passwort-Feld
1948 <para>Hat man bereits Mandanten und Gruppen angelegt, so kann hier
1949 auch konfiguriert werden, auf welche Mandanten der Benutzer Zugriff
1950 hat bzw. in welchen Gruppen er Mitglied ist. Beide Zuweisungen können
1951 sowohl beim Benutzer vorgenommen werden ("dieser Benutzer hat Zugriff
1952 auf Mandanten X, Y, Z" bzw. "dieser Benutzer ist Mitglied in Gruppen
1953 X, Y und Z") als auch beim Mandanten ("auf diesen Mandanten haben
1954 Benutzer A, B und C Zugriff") bzw. bei der Gruppe ("in dieser Gruppe
1955 sind Benutzer A, B und C Mitglieder").</para>
1958 <sect2 id="Mandanten-anlegen">
1959 <title>Mandanten anlegen</title>
1961 <para>Ein Mandant besteht aus Administrationssicht primär aus einem
1962 eindeutigen Namen. Weiterhin wird hier hinterlegt, welche Datenbank
1963 als Mandantendatenbank benutzt wird. Hier müssen die Zugriffsdaten
1964 einer der eben angelegten Datenbanken eingetragen werden.</para>
1966 <para>Hat man bereits Benutzer und Gruppen angelegt, so kann hier auch
1967 konfiguriert werden, welche Benutzer Zugriff auf den Mandanten haben
1968 bzw. welche Gruppen für den Mandanten gültig sind. Beide Zuweisungen
1969 können sowohl beim Mandanten vorgenommen werden ("auf diesen Mandanten
1970 haben Benutzer X, Y und Z Zugriff" bzw. "für diesen Mandanten sind die
1971 Gruppen X, Y und Z gültig") als auch beim Benutzer ("dieser Benutzer
1972 hat Zugriff auf Mandanten A, B und C") bzw. bei der Gruppe ("diese
1973 Gruppe ist für Mandanten A, B und C gültig").</para>
1977 <sect1 id="Drucker--Systemverwaltung">
1978 <title>Drucker- und Systemverwaltung</title>
1980 <para>Im Administrationsmenü gibt es ferner noch die beiden Menüpunkte
1981 Druckeradministration und System.</para>
1983 <sect2 id="Druckeradministration">
1984 <title>Druckeradministration</title>
1986 <para>Unter dem Menüpunkt Druckeradministration lassen sich beliebig
1987 viele "Druckbefehle" im System verwalten. Diese Befehle werden
1988 mandantenweise zugeordnet. Unter Druckerbeschreibung wird der Namen
1989 des Druckbefehls festgelegt, der dann in der Druckerauswahl des Belegs
1990 angezeigt wird.</para>
1992 <para>Unter Druckbefehl definiert man den eigentlichen Druckbefehl,
1993 der direkt auf dem Webserver ausgeführt wird, bspw. 'lpr -P
1994 meinDrucker' oder ein kompletter Pfad zu einem Skript
1995 (/usr/local/src/kivitendo/scripts/pdf_druck_in_verzeichnis.sh). Wird
1996 ferner noch ein optionales Vorlagenkürzel verwendet, wird dieses
1997 Kürzel bei der Auswahl der Druckvorlagendatei mit einem Unterstrich
1998 ergänzt, ist bspw. das Kürzel 'epson_drucker' definiert, so wird beim
1999 Ausdruck eines Angebots folgende Vorlage geparst:
2000 sales_quotation_epson_drucker.tex.</para>
2004 <title>System sperren / entsperren</title>
2006 <para>Unter dem Menüpunkt System gibt es den Eintrag 'Installation
2007 sperren/entsperren'. Setzt man diese Sperre so ist der Zugang zu der
2008 gesamten kivitendo Installation gesperrt.</para>
2010 <para>Falls die Sperre gesetzt ist, erscheint anstelle der
2011 Anmeldemaske die Information: 'kivitendo ist momentan zwecks
2012 Wartungsarbeiten nicht zugänglich.'.</para>
2014 <para>Wichtig zu erwähnen ist hierbei noch, dass sich kivitendo
2015 automatisch 'sperrt', falls es bei einem Versionsupdate zu einem
2016 Datenbankfehler kam. Somit kann hier nicht aus Versehen mit einem
2017 inkonsistenten Datenbestand weitergearbeitet werden.</para>
2021 <sect1 id="config.sending-email"
2022 xreflabel="E-Mail-Versand aus kivitendo heraus">
2023 <title>E-Mail-Versand aus kivitendo heraus</title>
2025 <para>kivitendo kann direkt aus dem Programm heraus E-Mails versenden,
2026 z.B. um ein Angebot direkt an einen Kunden zu verschicken. Damit dies
2027 funktioniert, muss eingestellt werden, über welchen Server die E-Mails
2028 verschickt werden sollen. kivitendo unterstützt dabei zwei Mechanismen:
2029 Versand über einen lokalen E-Mail-Server (z.B. mit
2030 <productname>Postfix</productname> oder <productname>Exim</productname>,
2031 was auch die standardmäßig aktive Methode ist) sowie Versand über einen
2032 SMTP-Server (z.B. der des eigenen Internet-Providers).</para>
2034 <para>Welche Methode und welcher Server verwendet werden, wird über die
2035 Konfigurationsdatei <filename>config/kivitendo.conf</filename>
2036 festgelegt. Dort befinden sich alle Einstellungen zu diesem Thema im
2037 Abschnitt '<literal>[mail_delivery]</literal>'.</para>
2039 <sect2 id="config.sending-email.sendmail"
2040 xreflabel="E-Mail-Versand über lokalen E-Mail-Server">
2041 <title>Versand über lokalen E-Mail-Server</title>
2043 <para>Diese Methode bietet sich an, wenn auf dem Server, auf dem
2044 kivitendo läuft, bereits ein funktionsfähiger E-Mail-Server wie z.B.
2045 <productname>Postfix</productname>, <productname>Exim</productname>
2046 oder <productname>Sendmail</productname> läuft.</para>
2048 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter
2049 '<literal>method = sendmail</literal>' gesetzt sein. Dies ist
2050 gleichzeitig der Standardwert, falls er nicht verändert wird.</para>
2052 <para>Um zu kontrollieren, wie das Programm zum Einliefern gestartet
2053 wird, dient der Parameter '<literal>sendmail = ...</literal>'. Der
2054 Standardwert verweist auf das Programm
2055 <filename>/usr/bin/sendmail</filename>, das bei allen oben genannten
2056 E-Mail-Serverprodukten für diesen Zweck funktionieren sollte.</para>
2058 <para>Die Konfiguration des E-Mail-Servers selber würde den Rahmen
2059 dieses sprengen. Hierfür sei auf die Dokumentation des E-Mail-Servers
2063 <sect2 id="config.sending-email.smtp"
2064 xreflabel="E-Mail-Versand über einen SMTP-Server">
2065 <title>Versand über einen SMTP-Server</title>
2067 <para>Diese Methode bietet sich an, wenn kein lokaler E-Mail-Server
2068 vorhanden oder zwar einer vorhanden, dieser aber nicht konfiguriert
2071 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter
2072 '<literal>method = smtp</literal>' gesetzt sein. Die folgenden
2073 Parameter dienen dabei der weiteren Konfiguration:</para>
2077 <term><varname>hostname</varname></term>
2080 <para>Name oder IP-Adresse des SMTP-Servers. Standardwert:
2081 '<literal>localhost</literal>'</para>
2086 <term><varname>port</varname></term>
2089 <para>Portnummer. Der Standardwert hängt von der verwendeten
2090 Verschlüsselungsmethode ab. Gilt '<literal>security =
2091 none</literal>' oder '<literal>security = tls</literal>', so ist
2092 25 die Standardportnummer. Für '<literal>security =
2093 ssl</literal>' ist 465 die Portnummer. Muss normalerweise nicht
2094 geändert werden.</para>
2099 <term><varname>security</varname></term>
2102 <para>Wahl der zu verwendenden Verschlüsselung der Verbindung
2103 mit dem Server. Standardwert ist '<literal>none</literal>',
2104 wodurch keine Verschlüsselung verwendet wird. Mit
2105 '<literal>tls</literal>' wird TLS-Verschlüsselung eingeschaltet,
2106 und mit '<literal>ssl</literal>' wird Verschlüsselung via SSL
2107 eingeschaltet. Achtung: Für '<literal>tls</literal>' und
2108 '<literal>ssl</literal>' werden zusätzliche Perl-Module benötigt
2109 (siehe unten).</para>
2114 <term><varname>login</varname> und
2115 <varname>password</varname></term>
2118 <para>Falls der E-Mail-Server eine Authentifizierung verlangt,
2119 so können mit diesen zwei Parametern der Benutzername und das
2120 Passwort angegeben werden. Wird Authentifizierung verwendet, so
2121 sollte aus Sicherheitsgründen auch eine Form von Verschlüsselung
2122 aktiviert werden.</para>
2129 <sect1 id="Drucken-mit-kivitendo">
2130 <title>Drucken mit kivitendo</title>
2132 <para>Das Drucksystem von kivitendo benutzt von Haus aus LaTeX-Vorlagen.
2133 Um drucken zu können, braucht der Server ein geeignetes LaTeX System. Am
2134 einfachsten ist dazu eine <literal>texlive</literal> Installation. Unter
2135 debianoiden Betriebssystemen installiert man die Pakete mit:</para>
2137 <para><programlisting>apt install texlive-base-bin texlive-latex-recommended texlive-fonts-recommended \
2138 texlive-latex-extra texlive-lang-german texlive-generic-extra texlive-xetex ghostscript</programlisting></para>
2140 <para>Für Fedora benötigen Sie die folgenden Pakete:</para>
2142 <para><programlisting>dnf install texlive-collection-latex texlive-collection-latexextra \
2143 texlive-collection-latexrecommended texlive-collection-langgerman \
2144 texlive-collection-langenglish</programlisting></para>
2146 <para>Für openSUSE benötigen Sie die folgenden Pakete:</para>
2148 <para><programlisting>zypper install texlive-collection-latex texlive-collection-latexextra \
2149 texlive-collection-latexrecommended texlive-collection-langgerman \
2150 texlive-collection-langenglish</programlisting></para>
2152 <para>kivitendo bringt drei alternative Vorlagensätze mit:</para>
2164 <para>rev-odt</para>
2168 <para>Der ehemalige Druckvorlagensatz "Standard" wurde mit der Version
2169 3.3 entfernt, da er nicht mehr gepflegt wurde.</para>
2171 <sect2 id="Vorlagenverzeichnis-anlegen"
2172 xreflabel="Vorlagenverzeichnis anlegen">
2173 <title>Vorlagenverzeichnis anlegen</title>
2175 <para>Es lässt sich ein initialer Vorlagensatz erstellen. Die
2176 LaTeX-System-Abhängigkeiten hierfür kann man prüfen mit:</para>
2178 <programlisting>./scripts/installation_check.pl -lv</programlisting>
2180 <para>Der Angemeldete Benutzer muss in einer Gruppe sein, die über das
2181 Recht "Konfiguration -> Mandantenverwaltung" verfügt. Siehe auch
2182 <xref linkend="Gruppen-anlegen"/>.</para>
2184 <para>Im Userbereich lässt sich unter: "<guimenu>System</guimenu>
2185 -> <guisubmenu>Mandantenverwaltung</guisubmenu> ->
2186 <guimenuitem>Verschiedenes</guimenuitem>" die Option "Neue
2187 Druckvorlagen aus Vorlagensatz erstellen" auswählen.</para>
2191 <para><option>Vorlagen auswählen</option>: Wählen Sie hier den
2192 Vorlagensatz aus, der kopiert werden soll
2193 (<filename>RB</filename>, <filename>f-tex</filename> oder
2194 <filename>odt-rev</filename>.)</para>
2198 <para><option>Neuer Name</option>: Der Verzeichnisname für den
2199 neuen Vorlagensatz. Dieser kann im Rahmen der üblichen Bedingungen
2200 für Verzeichnisnamen frei gewählt werden.</para>
2204 <para>Nach dem Speichern wird das Vorlagenverzeichnis angelegt und ist
2205 für den aktuellen Mandanten ausgewählt. Der gleiche Vorlagensatz kann,
2206 wenn er mal angelegt ist, bei mehreren Mandanten verwendet werden.
2207 Eventuell müssen Anpassungen (Logo, Erscheinungsbild, etc) noch
2208 vorgenommen werden. Den Ordner findet man im Dateisystem unter
2209 <filename>./templates/[Neuer Name]</filename></para>
2212 <sect2 id="Vorlagen-RB">
2213 <title>Der Druckvorlagensatz RB</title>
2215 <para>Hierbei handelt es sich um einen vollständigen LaTeX
2216 Dokumentensatz mit alternativem Design. Die odt oder html-Varianten
2217 sind nicht gepflegt.</para>
2219 <para>Die konzeptionelle Idee der Vorlagen wird <ulink
2220 url="http://www.kivitendo-support.de/vortraege/Lx-Office%20Anwendertreffen%20LaTeX-Druckvorlagen-Teil3-finale.pdf">hier</ulink>
2221 auf Folie 5 bis 10 vorgestellt. Informationen zur Anpassung an die
2222 eigenen Firmendaten finden sich in der Datei Readme.tex im
2223 Vorlagenverzeichnis.</para>
2225 <para>Eine kurze Übersicht der Features:</para>
2229 <para>Mehrsprachenfähig, mit Deutscher und Englischer
2234 <para>Zentrale Konfigurationsdateien, die für alle Belege benutzt
2235 werden, z.B. für Kopf- und Fußzeilen, und Infos wie
2240 <para>mehrere vordefinierte Varianten für
2241 Logos/Hintergrundbilder</para>
2245 <para>Berücksichtigung für Steuerzonen "EU mit USt-ID Nummer" oder
2246 "Außerhalb EU"</para>
2252 <title>f-tex</title>
2254 <para>Ein Vorlagensatz, der in wenigen Minuten alle Dokumente zur
2255 Verfügung stellt.</para>
2257 <sect3 id="f-tex-Feature-Übersicht">
2258 <title>Feature-Übersicht</title>
2262 <para>Keine Redundanz. Es wird ein- und dieselbe LaTeX-Vorlage
2263 für alle briefartigen Dokumente verwendet. Also Angebot,
2264 Rechnung, Proformarechnung, Lieferschein, aber eben nicht für
2265 Paketaufkleber etc.</para>
2269 <para>Leichte Anpassung an das Firmen-Layout durch Verwendung
2270 eines Hintergrund-PDFs. Dieses kann leicht mit dem eigenen
2271 Lieblingsprogramm erstellt werden (Openoffice, Inkscape, Gimp,
2276 <para>Hintergrund-PDF umschaltbar auf "nur erste Seite"
2277 (Standard) oder "alle Seiten" (Option
2278 "<option>bgPdfFirstPageOnly</option>" in Datei
2279 <filename>letter.lco</filename>)</para>
2283 <para>Hintergrund-PDF für Ausdruck auf bereits bedrucktem
2284 Briefpapier abschaltbar. Es wird dann nur bei per E-Mail
2285 versendeten Dokumenten eingebunden (Option
2286 "<option>bgPdfEmailOnly</option>" in Datei
2287 <filename>letter.lco</filename>).</para>
2291 <para>Nutzung der Layout-Funktionen von LaTeX für Seitenumbruch,
2292 Wiederholung von Kopfzeilen, Zwischensummen etc. (danke an
2293 Kai-Martin Knaak für die Vorarbeit)</para>
2297 <para>Anzeige des Empfängerlandes im Adressfeld nur, wenn es vom
2298 Land des eigenen Unternehmens abweicht (also die Rechnung das
2299 Land verlässt).</para>
2303 <para>Multisprachfähig leicht um weitere Sprachen zu erweitern,
2304 alle Übersetzungen in der Datei
2305 <filename>translatinos.tex</filename>.</para>
2309 <para>Auflistung von Bruttopreisen für Endverbraucher.</para>
2314 <sect3 id="f-tex-Installation">
2315 <title>Die Installation</title>
2319 <para>Vorlagenverzeichnis mit Option f-tex anlegen, siehe: <xref
2320 linkend="Vorlagenverzeichnis-anlegen"/>. Das Vorlagensystem
2321 funktioniert jetzt schon, hat allerdings noch einen
2322 Beispiel-Briefkopf.</para>
2326 <para>Erstelle eine pdf-Hintergrund Datei und verlinke sie nach
2327 <filename>./letter_head.pdf</filename>.</para>
2331 <para>Editiere den Bereich "<option>settings</option>" in der
2332 datei <filename>letter.lco</filename>.</para>
2336 <para>oder etwas detaillierter:</para>
2338 <para>Es wird eine Datei <filename>sample.lco</filename> erstellt
2339 und diese nach <filename>letter.lco</filename> verlinkt. Eigentlich
2340 ist dies die Datei die für die firmenspezifischen Anpassungen
2341 gedacht ist. Da die Einstiegshürde in LaTeX nicht ganz niedrig ist,
2342 wird in dieser Datei auf ein Hintergrund-PDF verwiesen. Ich empfehle
2343 über dieses PDF die persönlichen Layoutanpassungen vorzunehmen und
2344 <filename>sample.lco</filename> unverändert zu lassen. Die Anpassung
2345 über eine <filename>*.lco</filename>-Datei, die letztlich auf
2346 <filename>letter.lco</filename> verlinkt ist ist aber auch
2349 <para>Es wird eine Datei <filename>sample_head.pdf</filename> mit
2350 ausgeliefert, diese wird nach <filename>letter_head.pdf</filename>
2351 verlinkt. Damit gibt es schon mal eine funktionsfähige Vorlage.
2352 Schau Dir nach Abschluss der Installation die Datei
2353 <filename>sample_head.pdf</filename> an und erstelle ein
2354 entsprechendes PDF passend zum Briefkopf Deiner Firma, diese dann im
2355 Template Verzeichniss ablegen und statt
2356 <filename>sample_head.pdf</filename> nach
2357 <filename>letter_head.pdf</filename> verlinken.</para>
2359 <para>Letzlich muss <filename>letter_head.pdf</filename> auf das
2360 passende Hintergrund-PDF verweisen, welches gewünschten Briefkopf
2363 <para>Es wird eine Datei <filename>mydata.tex.example</filename>
2364 ausgeliefert, die nach <filename>mytdata.tex</filename> verlinkt
2365 ist. Bei verwendetem Hintergrund-PDF wird nur der Eintrag für das
2366 Land verwendet. Die Datei muss also nicht angefasst werden. Die
2367 anderen Werte sind für das Modul 'lp' (Label Print in erp - zur Zeit
2368 nicht im öffentlichen Zweig).</para>
2370 <para>Alle Anpassungen zum Briefkopf, Fusszeilen, Firmenlogos, etc.
2371 sollten über die Hintergrund-PDF-Datei oder die
2372 <filename>*.lco</filename>-Datei erfolgen.</para>
2375 <sect3 id="f-tex-Funktionsübersicht">
2376 <title>f-tex Funktionsübersicht</title>
2378 <para>Das Konzept von kivitendo sieht vor, für jedes Dokument
2379 (Auftragsbestätigung, Lieferschein, Rechnung, etc.) eine
2380 LaTeX-Vorlage vorzuhalten, dies ist sehr wartungsunfreundlich. Auch
2381 das Einlesen einer einheitlichen Quelle für den Briefkopf bringt nur
2382 bedingte Vorteile, da hier leicht die Pflege der Artikel-Tabellen
2383 aus dem Ruder läuft. Bei dem vorliegenden Ansatz wird für alle
2384 briefartigen Dokumente mit Artikel-Tabellen eine einheitliche
2385 LaTeX-Vorlage verwendet, welche über Codeweichen die Besonderheiten
2386 der jeweiligen Dokumente berücksichtigt:</para>
2390 <para>Tabellen mit oder ohne Preis</para>
2394 <para>Sprache der Tabellenüberschriften etc.</para>
2398 <para>Anpassung der Bezugs-Zeile (z.B. Rechnungsnummer versus
2399 Angebotsnummer)</para>
2403 <para>Darstellung von Brutto oder Netto-Preisen in der
2404 Auflistung (Endverbraucher versus gewerblicher Kunde)</para>
2408 <para>Nachteil:</para>
2410 <para>LaTeX hat ohnehin eine sehr steile Lehrnkurve. Die Datei
2411 <filename>letter.tex</filename> ist sehr komplex und verstärkt damit
2412 diesen Effekt noch einmal erheblich. Wer LaTeX-Erfahrung hat, oder
2413 geübt ist Scriptsparachen nachzuvollziehen kann natürlich auch
2414 innerhalb der Tabellendarstellung gut persönliche Anpassungen
2415 vornehmen. Aber man kann sich hier bei Veränderungen sehr schnell
2416 heftig in den Fuss schiessen.</para>
2418 <para>Wer nicht so tief in die Materie einsteigen will oder leicht
2419 zu frustrieren ist, sollte sein Hintergrund-PDF auf Basis der
2420 mitglieferten Datei <filename>sample_head.pdf</filename> erstellen,
2421 und sich an der Form der dargestellten Tabellen, wie sie
2422 ausgeliefert werden, erfreuen.</para>
2424 <para>Kleiner Tipp: Nicht zu viel auf einmal wollen, lieber kleine,
2425 kontinuierliche Schritte gehen.</para>
2428 <sect3 id="f-tex-Bruttopreise">
2429 <title>Bruttopreise für Endverbraucher</title>
2431 <para>Der auszuweisende Bruttopreis wird innerhalb der
2432 LaTeX-Umgebung berechnet. Es gibt zwar ein Feld, um bei Aufträgen
2433 "alle Preise Brutto" auszuwählen, aber:</para>
2437 <para>hierfür müssen die Preise auch in Brutto in der Datenbank
2438 stehen (ja - das lässt sich über die Preisgruppen und die
2439 Zuordung einer Default-Preisgruppe handhaben)</para>
2443 <para>man darf beim Anlegen des Vorgangs nicht vergessen, dieses
2444 Häkchen zu setzen. (Das ist in der Praxis, wenn man sowohl
2445 Endverbraucher als auch Gewerbekunden beliefert, der eigentliche
2450 <para>Es gibt mit f-tex eine weitere Alternative. Die Information ob
2451 Brutto oder Nettorechnung wird mit den Zahlarten verknüpft.
2452 Zahlarten bei denen Rechnungen, Angebote, etc, in Brutto ausgegeben
2453 werden sollen, enden mit "_E" (für Endverbraucher). Falls identische
2454 Zahlarten für Gewerbekunden und Endverbraucher vorhanden sind, legt
2455 man diese einfach doppelt an (einmal mit der Namensendung "_E").
2460 <para>Die Entscheidung, ob Nettopreise ausgewiesen werden, ist
2461 nicht mehr fix mit einer Preisliste verbunden.</para>
2465 <para>Die Default-Zahlart kann im Kundendatensatz hinterlegt
2466 werden, und man muss nicht mehr daran denken, "alle Preise
2467 Netto" auszuwählen.</para>
2471 <para>Die Entscheidung, ob Netto- oder Bruttopreise ausgewiesen
2472 werden, kann direkt beim Drucken revidiert werden, ohne dass
2473 sich der Auftragswert ändert.</para>
2478 <sect3 id="f-tex-lieferadressen">
2479 <title>Lieferadressen</title>
2481 <para>In Lieferscheinen kommen <varname>shipto*</varname>-Variablen
2482 im Adressfeld zum Einsatz. Wenn die
2483 <varname>shipto*</varname>-Variable leer ist, wird die entsprechende
2484 Adressvariable eingesetzt. Wenn also die Lieferadresse in Straße,
2485 Hausnummer und Ort abweicht, müssen auch nur diese Felder in der
2486 Lieferadresse ausgefüllt werden. Für den Firmenname wird der Wert
2487 der Hauptadresse angezeigt.</para>
2491 <sect2 id="Vorlagen-rev-odt">
2492 <title>Der Druckvorlagensatz rev-odt</title>
2494 <para>Hierbei handelt es sich um einen Dokumentensatz der mit
2495 odt-Vorlagen erstellt wurde. Es gibt in dem Verzeichnis eine
2496 Readme-Datei, die eventuell aktueller als die Dokumentation hier ist.
2497 Die odt-Vorlagen in diesem Verzeichnis "rev-odt" wurden von revamp-it,
2498 Zürich erstellt und werden laufend aktualisiert. Ein paar der
2499 Formulierungen in den Druckvorlagen entsprechen dem Schweizer
2500 Sprachgebrauch, z.B. "Offerte" oder "allfällig".</para>
2502 <para>Hinweis zum Einsatz des Feldes "Land" bei den Stammdaten für
2503 KundInnen und LieferantInnen, sowie bei Lieferadressen: Die in diesem
2504 Vorlagensatz vorhandenen Vorlagen erwarten für "Land" das
2505 entsprechende Kürzel, das in Adressen vor die Postleitzahl gesetzt
2506 wird. Das Feld kann auch komplett leer bleiben. Wer dies anders
2507 handhaben möchte, muss die Vorlagen entsprechend anpassen.</para>
2509 <para>odt-Vorlagen können mit LibreOffice oder OpenOffice editiert und
2510 den eigenen Bedürfnissen angepasst werden. Wichtig beim Editieren von
2511 if-Blöcken ist, dass immer der gesamte Block überschrieben werden muss
2512 und nicht nur Teile davon, da dies sonst oft zu einer odt-Datei führt,
2513 die vom Parser nicht korrekt gelesen werden kann.</para>
2515 <para>Mahnungen können unter folgenden Einschränkungen mit den
2516 odt-Vorlagen im Vorlagensatz rev-odt erzeugt werden:</para>
2520 <para>als Druckoption steht nur 'PDF(OpenDocument/OASIS)' zur
2521 Verfügung, das heisst, die Mahnungen werden als PDF-Datei
2526 <para>für jede Rechnung muss eine eigene Mahnung erzeugt werden
2527 (auch wenn bei einzelnen KundInnen mehrere überfällige Rechnungen
2528 vorhanden sind).</para>
2532 <para>Mehrere Mahnungen für eine Kundin / einen Kunden werden zu einer
2533 PDF-Datei zusammengefasst</para>
2535 <para>Die Vorlagen zahlungserinnerung.odt sowie mahnung.odt sind für
2536 das Erstellen einer Zahlungserinnerung bzw. Mahnung selbst vorgesehen,
2537 die Vorlage mahnung_invoice.odt für das Erstellen einer Rechnung über
2538 die verrechneten Mahngebühren und Verzugszinsen.</para>
2540 <para>Zur Zeit gibt es in kivitendo noch keine Möglichkeit,
2541 odt-Vorlagen bei Briefen und Pflichtenheften einzusetzen.
2542 Entsprechende Vorlagen sind deshalb nicht vorhanden.</para>
2544 <para>Fehlermeldungen, Anregungen und Wünsche bitte senden an:
2545 empfang@revamp-it.ch</para>
2548 <sect2 id="allgemeine-hinweise-zu-latex">
2549 <title>Allgemeine Hinweise zu LaTeX Vorlagen</title>
2551 <para>In den allermeisten Installationen sollte das Drucken jetzt
2552 schon funktionieren. Sollte ein Fehler auftreten, wirft TeX sehr lange
2553 Fehlerbeschreibungen, der eigentliche Fehler ist immer die erste
2554 Zeile, die mit einem Ausrufezeichen anfängt. Häufig auftretende Fehler
2555 sind zum Beispiel:</para>
2559 <para>! LaTeX Error: File `eurosym.sty' not found. Die
2560 entsprechende LaTeX-Bibliothek wurde nicht gefunden. Das tritt vor
2561 allem bei Vorlagen aus der Community auf. Installieren Sie die
2562 entsprechenden Pakete.</para>
2566 <para>! Package inputenc Error: Unicode char \u8:... set up for
2567 use with LaTeX. Dieser Fehler tritt auf, wenn sie versuchen mit
2568 einer Standardinstallation exotische utf8 Zeichen zu drucken.
2569 TeXLive unterstützt von Haus nur romanische Schriften und muss mit
2570 diversen Tricks dazu gebracht werden andere Zeichen zu
2571 akzeptieren. Adere TeX Systeme wie XeTeX schaffen hier
2576 <para>Wird gar kein Fehler angezeigt, sondern nur der Name des
2577 Templates, heißt das normalerweise, dass das LaTeX Binary nicht
2578 gefunden wurde. Prüfen Sie den Namen in der Konfiguration (Standard:
2579 <literal>pdflatex</literal>), und stellen Sie sicher, dass pdflatex
2580 (oder das von Ihnen verwendete System) vom Webserver ausgeführt werden
2583 <para>Wenn sich das Problem nicht auf Grund der Ausgabe im Webbrowser
2584 verifizieren lässt:</para>
2588 <para>editiere [kivitendo-home]/config/kivitendo.conf und ändere
2589 "keep_temp_files" auf 1</para>
2591 <para><programlisting>keep_temp_files = 1;</programlisting></para>
2595 <para>bei fastcgi oder mod_perl den Webserver neu Starten</para>
2599 <para>Nochmal einen Druckversuch im Webfrontend auslösen</para>
2603 <para>wechsel in das users Verzeichnis von kivitendo</para>
2605 <para><programlisting>cd [kivitendo-home]/users</programlisting></para>
2609 <para>LaTeX Suchpfad anpassen:</para>
2611 <para><programlisting>export TEXINPUTS=".:[kivitendo-home]/templates/[aktuelles_template_verzeichniss]:"</programlisting></para>
2615 <para>Finde heraus, welche Datei kivitendo beim letzten Durchlauf
2618 <para><programlisting>ls -lahtr ./1*.tex</programlisting></para>
2620 <para>Es sollte die letzte Datei ganz unten sein</para>
2624 <para>für besseren Hinweis auf Fehler texdatei nochmals
2627 <para><programlisting>pdflatex ./1*.tex</programlisting></para>
2629 <para>in der *.tex datei nach dem Fehler suchen.</para>
2635 <sect1 id="OpenDocument-Vorlagen">
2636 <title>OpenDocument-Vorlagen</title>
2638 <para>kivitendo unterstützt die Verwendung von Vorlagen im
2639 OpenDocument-Format, wie es LibreOffice oder OpenOffice (ab Version 2)
2640 erzeugen. kivitendo kann dabei sowohl neue OpenDocument-Dokumente als
2641 auch aus diesen direkt PDF-Dateien erzeugen. Um die Unterstützung von
2642 OpenDocument-Vorlagen zu aktivieren muss in der Datei
2643 <filename>config/kivitendo.conf</filename> die Variable
2644 <literal>opendocument</literal> im Abschnitt
2645 <literal>print_templates</literal> auf ‘<literal>1</literal>’ stehen.
2646 Dieses ist die Standardeinstellung.</para>
2648 <para>Während die Erzeugung von reinen OpenDocument-Dateien keinerlei
2649 weitere Software benötigt, wird zur Umwandlung dieser Dateien in PDF
2650 LibreOffice oder OpenOffice benötigt. Soll dieses Feature genutzt
2651 werden, so muss neben LibreOffice oder OpenOffice auch der “X virtual
2652 frame buffer” (xvfb) installiert werden. Bei Debian ist er im Paket
2653 “xvfb” enthalten. Andere Distributionen enthalten ihn in anderen
2656 <para>Nach der Installation müssen in der Datei
2657 <filename>config/kivitendo.conf</filename> im Abschnitt
2658 <literal>applications</literal> zwei weitere Variablen angepasst
2661 <para><literal>openofficeorg_writer</literal> muss den vollständigen
2662 Pfad zu LibreOffice oder OpenOffice enthalten. Dabei dürfen keine
2663 Anführungszeichen eingesetzt werden.</para>
2665 <para>Beispiel für Debian oder Ubuntu:</para>
2667 <programlisting>openofficeorg_writer = /usr/bin/libreoffice</programlisting>
2669 <para><literal>xvfb</literal> muss den Pfad zum “X virtual frame buffer”
2672 <para>Zusätzlich gibt es zwei verschiedene Arten, wie kivitendo mit
2673 LibreOffice bzw. OpenOffice kommuniziert. Die erste Variante, die
2674 benutzt wird, wenn die Variable <literal>$openofficeorg_daemon</literal>
2675 gesetzt ist, startet ein LibreOffice oder OpenOffice, das auch nach der
2676 Umwandlung des Dokumentes gestartet bleibt. Bei weiteren Umwandlungen
2677 wird dann diese laufende Instanz benutzt. Der Vorteil ist, dass die Zeit
2678 zur Umwandlung deutlich reduziert wird, weil nicht für jedes Dokument
2679 ein LibreOffice bzw. OpenOffice gestartet werden muss. Der Nachteil ist,
2680 dass diese Methode Python und die Python-UNO-Bindings benötigt, die
2681 Bestandteil von LibreOffice bzw. OpenOffice sind.</para>
2684 <para>Für die Verbindung zu LibreOffice bzw. OpenOffice wird
2685 normalerweise der Python-Interpreter
2686 <filename>/usr/bin/python</filename> benutzt. Sollte dies nicht der
2687 richtige sein, so kann man mit zwei Konfigurationsvariablen
2688 entscheiden, welcher Python-Interpreter genutzt wird. Mit der Option
2689 <literal>python_uno</literal> aus dem Abschnitt
2690 <literal>applications</literal> wird der Interpreter selber
2691 festgelegt; sie steht standardmäßig auf dem eben erwähnten Wert
2692 <literal>/usr/bin/python</literal>.</para>
2694 <para>Zusätzlich ist es möglich, Pfade anzugeben, in denen Python
2695 neben seinen normalen Suchpfaden ebenfalls nach Modulen gesucht wird,
2696 z.B. falls sich diese in einem gesonderten LibreOffice- bzw.
2697 OpenOffice-Verzeichnis befinden. Diese zweite Variable heißt
2698 <literal>python_uno_path</literal> und befindet sich im Abschnitt
2699 <literal>environment</literal>. Sie ist standardmäßig leer. Werden
2700 hier mehrere Pfade angegeben, so müssen diese durch Doppelpunkte
2701 voneinander getrennt werden. Der Inhalt wird an den Python-Interpreter
2702 über die Umgebungsvariable <literal>PYTHONPATH</literal>
2706 <para>Ist <literal>$openofficeorg_daemon</literal> nicht gesetzt, so
2707 wird für jedes Dokument LibreOffice bzw. OpenOffice neu gestartet und
2708 die Konvertierung mit Hilfe eines Makros durchgeführt. Dieses Makro muss
2709 in der Dokumentenvorlage enthalten sein und
2710 “Standard.Conversion.ConvertSelfToPDF()” heißen. Die Beispielvorlage
2711 ‘<literal>templates/print/rev-odt/invoice.odt</literal>’ enthält ein
2712 solches Makro, das in jeder anderen Dokumentenvorlage ebenfalls
2713 enthalten sein muss.</para>
2715 <para>Als letztes muss herausgefunden werden, welchen Namen OpenOffice
2716 bzw. LibreOffice dem Verzeichnis mit den Benutzereinstellungen gibt.
2717 Unter Debian ist dies momentan <literal>~/.config/libreoffice</literal>.
2718 kivitendo verwendet das Verzeichnis
2719 <literal>users/.openoffice.org2</literal>. Eventuell muss dieses
2720 Verzeichnis umbenannt werden.</para>
2722 <para>Dieses Verzeichnis, wie auch das komplette
2723 <literal>users</literal>-Verzeichnis, muss vom Webserver beschreibbar
2724 sein. Dieses wurde bereits erledigt (siehe <xref
2725 linkend="Manuelle-Installation-des-Programmpaketes"/>), kann aber erneut
2726 überprüft werden, wenn die Konvertierung nach PDF fehlschlägt.</para>
2729 <title>OpenDocument (odt) Druckvorlagen mit Makros</title>
2731 <para>OpenDocument Vorlagen können Makros enthalten, welche komplexere
2732 Aufgaben erfüllen.</para>
2734 <para>Der Vorlagensatz "rev-odt" enthält solche Vorlagen mit <emphasis
2735 role="bold">Schweizer Bank-Einzahlungsscheinen (BESR)</emphasis>.
2736 Diese Makros haben die Aufgabe, die in den Einzahlungsscheinen
2737 benötigte Referenznummer und Kodierzeile zu erzeugen. Hier eine kurze
2738 Beschreibung, wie die Makros aufgebaut sind, und was bei ihrer Nutzung
2739 zu beachten ist (<emphasis role="bold">in fett sind nötige einmalige
2740 Anpassungen aufgeführt</emphasis>):</para>
2743 <title>Bezeichnung der Vorlagen</title>
2745 <para>Rechnung: invoice_besr.odt, Auftrag:
2746 sales_order_besr.odt</para>
2750 <title>Vorbereitungen im Adminbereich</title>
2752 <para>Damit beim Erstellen von Rechnungen und Aufträgen neben der
2753 Standardvorlage ohne Einzahlungsschein weitere Vorlagen (z.B. mit
2754 Einzahlungsschein) auswählbar sind, muss für jedes Vorlagen-Suffix
2755 ein Drucker eingerichtet werden:</para>
2759 <para>Druckeradministration → Drucker hinzufügen</para>
2763 <para>Mandant wählen</para>
2767 <para>Druckerbeschreibung → aussagekräftiger Text: wird in der
2768 Auftrags- bzw. Rechnungsmaske als Auswahl angezeigt (z.B. mit
2769 Einzahlungsschein Bank xy)</para>
2773 <para>Druckbefehl → beliebiger Text (hat für das Erzeugen von
2774 Aufträgen oder Rechnungen als odt-Datei keine Bedeutung, darf
2775 aber nicht leer sein)</para>
2779 <para>Vorlagenkürzel → besr bzw. selbst gewähltes Vorlagensuffix
2780 (muss genau der Zeichenfolge entsprechen, die zwischen
2781 "invoice_" bzw. "sales_order_" und ".odt" steht.)</para>
2785 <para>speichern</para>
2791 <title>Benutzereinstellungen</title>
2793 <para>Wer den Ausdruck mit Einzahlungsschein als Standardeinstellung
2794 im Rechnungs- bzw. Auftragsformular angezeigt haben möchte, kann
2795 dies persönlich für sich bei den Benutzereinstellungen
2796 konfigurieren:</para>
2800 <para>Programm → Benutzereinstellungen → Druckoptionen</para>
2804 <para>Standardvorlagenformat → OpenDocument/OASIS</para>
2808 <para>Standardausgabekanal → Bildschirm</para>
2812 <para>Standarddrucker → gewünschte Druckerbeschreibung auswählen
2813 (z.B. mit Einzahlungsschein Bank xy)</para>
2817 <para>Anzahl Kopien → leer</para>
2821 <para>speichern</para>
2827 <title>Aufbau und nötige Anpassungen der Vorlagen</title>
2829 <para>In der Vorlage sind als Modul "BESR" 4 Makros gespeichert, die
2830 aus dem von kivitendo erzeugten odt-Dokument die korrekte
2831 Referenznummer inklusive Prüfziffer sowie die Kodierzeile in
2832 OCRB-Schrift erzeugen und am richtigen Ort ins Dokument
2837 <para>Für den Einzahlungsschein ist die letzte Seite des
2838 Dokuments reserviert</para>
2842 <para>Direkt über dem Einzahlungsschein enthält die Vorlage eine
2843 Zeile mit folgenden Angaben (<emphasis
2844 role="bold">Bank-Konto-Identifikationsnummer und
2845 Postkonto-Nummer der Bank müssen gemäss Angaben der jeweiligen
2846 Bank angepasst werden</emphasis>):<itemizedlist>
2848 <para>DDDREF: 4 Werte zum Bilden der Referenznummer
2849 (jeweils durch einen Leerschlag getrennt): <itemizedlist>
2851 <para>erster Wert: <emphasis
2852 role="bold">Bank-Konto-Identifikation</emphasis>
2853 (nur Ziffern, maximal 6), <emphasis role="bold">muss
2854 angepasst werden</emphasis>.</para>
2858 <para>zweiter Wert: <%customernumber%>
2859 (Kundennummer: nur Ziffern, maximal 6)</para>
2863 <para>dritter Wert: <%ordnumber%>
2864 (Auftragsnummer bei Auftragsvorlage
2865 sales_oder_besr.odt, sonst 0) maximal 7 Ziffern,
2866 führende Buchstaben werden vom Makro entfernt</para>
2870 <para>vierter Wert: <%invnumber%>
2871 (Rechnungsnummer bei Rechnungsvorlage
2872 invoice_besr.odt, sonst 0) maximal 7 Ziffern,
2873 führende Buchstaben werden vom Makro entfernt</para>
2875 </itemizedlist></para>
2879 <para>DDDKONTO: <emphasis role="bold">Postkonto-Nummer der
2880 Bank, muss angepasst werden</emphasis>.</para>
2884 <para>DDDBETRAG: <%total%> Einzahlungsbetrag oder 0,
2885 falls Einzahlungsschein ohne Betrag</para>
2889 <para>DDDEND: muss am Ende der Zeile vorhanden sein</para>
2891 </itemizedlist></para>
2895 <para><emphasis role="bold">Im Einzahlungsschein selbst müssen
2896 der Name und die Adresse der Bank, die Postkonto-Nummer der
2897 Bank, sowie der eigene Firmenname und die Firmenadresse
2898 angepasst werden.</emphasis> Dabei ist darauf zu achten, dass
2899 sich die Positionen der Postkonto-Nummern der Bank, sowie der
2900 Zeichenfolgen dddfr, DDDREF1, DDDREF2, 609, DDDKODIERZEILE nicht
2906 <screeninfo>Rechnungsvorlage Schweizer Bank-Einzahlungsschein - zu
2907 ändernde Einträge in rot</screeninfo>
2911 <imagedata fileref="images/Einzahlungsschein_Makro.png"/>
2918 <title>Auswahl der Druckvorlage in kivitendo beim Erzeugen einer
2919 odt-Rechnung (analog bei Auftrag)</title>
2921 <para>Im Fussbereich der Rechnungsmaske muss neben Rechnung,
2922 OpenDocument/OASIS und Bildschirm die im Adminbereich erstellte
2923 Druckerbeschreibung ausgewählt werden, falls diese nicht bereits bei
2924 den Benutzereinstellungen als persönlicher Standard gewählt
2929 <title>Makroeinstellungen in LibreOffice anpassen</title>
2931 <para>Falls beim Öffnen einer von kivitendo erzeugten odt-Rechnung
2932 die Meldung kommt, dass Makros aus Sicherheitsgründen nicht
2933 ausgeführt werden, so müssen folgende Einstellungen in LibreOffice
2934 angepasst werden:</para>
2938 <para>Extras → Optionen → Sicherheit → Makrosicherheit</para>
2942 <para>Sicherheitslevel auf "Mittel" einstellen (Diese
2943 Einstellung muss auf jedem Computer durchgeführt werden, mit dem
2944 von kivitendo erzeugte odt-Rechnungen oder Aufträge geöffnet
2949 <para>Beim Öffnen einer odt-Rechnung oder eines odt-Auftrags bei
2950 der entsprechenden Nachfrage "Makros ausführen"
2953 <para><emphasis role="bold">Wichtig</emphasis>: die Makros sind
2954 so eingestellt, dass sie beim Öffnen der Vorlagen selbst nicht
2955 ausgeführt werden. Das heisst für das Ansehen und Bearbeiten der
2956 Vorlagen sind keine speziellen Einstellungen in LibreOffice
2964 <sect1 id="nomenclature">
2965 <title>Nomenklatur</title>
2967 <sect2 id="booking.dates">
2968 <title>Datum bei Buchungen</title>
2970 <para>Seit der Version 3.5 werden für Buchungen in kivitendo
2971 einheitlich folgende Bezeichnungen verwendet:</para>
2975 <para><option>Erfassungsdatum</option> (en: <option>Entry
2976 Date</option>, code: <option>Gldate</option>)</para>
2978 <para>bezeichnet das Datum, an dem die Buchung in kivitendo
2979 erfasst wurde.</para>
2983 <para><option>Buchungsdatum</option> (en: <option>Booking
2984 Date</option>, code: <option>Transdate</option>)</para>
2986 <para>bezeichnet das buchhaltungstechnisch für eine Buchung
2987 relevante Datum</para>
2989 <para>Das <option>Rechnungsdatum</option> bei Verkaufs- und
2990 Einkaufsrechnungen entspricht dem Buchungsdatum. Das heisst, in
2991 Berichten wie dem Buchungsjournal, in denen eine Spalte
2992 <option>Buchungsdatum</option> angezeigt werden kann, erscheint
2993 hier im Fall von Rechnungen das Rechnungsdatum.</para>
2997 <para>Bezieht sich ein verbuchter Beleg auf einen Zeitpunkt, der
2998 nicht mit dem Buchungsdatum übereinstimmt, so kann dieses Datum
2999 momentan in kivitendo nur unter Bemerkungen erfasst werden.</para>
3001 <para>Möglicherweise wird für solche Fälle in einer späteren
3002 Version von kivitendo ein dritter Datumswert für Buchungen
3003 erstellt. (Beispiel: Einkaufsbeleg stammt aus einem früheren Jahr,
3004 das bereits buchhaltungstechnisch abgeschlossen wurde, und muss
3005 deshalb später verbucht werden.)</para>
3011 <sect1 id="config.eur">
3012 <title>Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung:
3015 <sect2 id="config.eur.introduction"
3016 xreflabel="Einführung in die Konfiguration zur EUR">
3017 <title>Einführung</title>
3019 <para>kivitendo besaß bis inklusive Version 2.6.3 einen
3020 Konfigurationsparameter namens <varname>eur</varname>, der sich in der
3021 Konfigurationsdatei <filename>config/kivitendo.conf</filename> (damals
3022 noch <filename>config/lx_office.conf</filename>) befand. Somit galt er
3023 für alle Mandanten, die in dieser Installation benutzt wurden.</para>
3025 <para>Mit der nachfolgenden Version wurde der Parameter zum Einen in
3026 die Mandantendatenbank verschoben und dabei auch gleich in drei
3027 Einzelparameter aufgeteilt, mit denen sich das Verhalten genauer
3028 steuern lässt.</para>
3031 <sect2 id="config.eur.parameters"
3032 xreflabel="Konfigurationsparameter für EUR">
3033 <title>Konfigurationsparameter</title>
3035 <para>Es gibt drei Parameter, die die Gewinnermittlungsart,
3036 Versteuerungsart und die Warenbuchungsmethode regeln:</para>
3040 <term><varname>profit_determination</varname></term>
3043 <para>Dieser Parameter legt die Berechnungsmethode für die
3044 Gewinnermittlung fest. Er enthält entweder
3045 <literal>balance</literal> für
3046 Betriebsvermögensvergleich/Bilanzierung oder
3047 <literal>income</literal> für die
3048 Einnahmen-Überschuss-Rechnung.</para>
3053 <term><varname>accounting_method</varname></term>
3056 <para>Dieser Parameter steuert die Buchungs- und
3057 Berechnungsmethoden für die Versteuerungsart. Er enthält
3058 entweder <literal>accrual</literal> für die Soll-Versteuerung
3059 oder <literal>cash</literal> für die Ist-Versteuerung.</para>
3064 <term><varname>inventory_system</varname></term>
3067 <para>Dieser Parameter legt die Warenbuchungsmethode fest. Er
3068 enthält entweder <literal>perpetual</literal> für die
3069 Bestandsmethode oder <literal>periodic</literal> für die
3070 Aufwandsmethode.</para>
3075 <para>Zum Vergleich der Funktionalität bis und nach 2.6.3:
3076 <varname>eur</varname> = 1 bedeutete Einnahmen-Überschuss-Rechnung,
3077 Ist-Versteuerung und Aufwandsmethode. <varname>eur</varname> = 0
3078 bedeutete hingegen Bilanzierung, Soll-Versteuerung und
3079 Bestandsmethode.</para>
3081 <para>Die Konfiguration "<varname>eur</varname>" unter
3082 <varname>[system]</varname> in der <link
3083 linkend="config.config-file">Konfigurationsdatei</link>
3084 <filename>config/kivitendo.conf</filename> wird nun nicht mehr
3085 benötigt und kann entfernt werden. Dies muss manuell geschehen.</para>
3088 <sect2 id="config.eur.setting-parameters">
3089 <title>Festlegen der Parameter</title>
3091 <para>Beim Anlegen eines neuen Mandanten bzw. einer neuen Datenbank in
3092 der Admininstration können diese Optionen nun unabhängig voneinander
3093 eingestellt werden.</para>
3095 <para>Für die Schweiz sind folgende Einstellungen üblich:
3098 <para>Sollversteuerung</para>
3102 <para>Aufwandsmethode</para>
3106 <para>Bilanzierung</para>
3108 </itemizedlist> Diese Einstellungen werden automatisch beim
3109 Erstellen einer neuen Datenbank vorausgewählt, wenn in
3110 <filename>config/kivitendo.conf</filename> unter
3111 <varname>[system]</varname> <literal>default_manager = swiss</literal>
3112 eingestellt ist.</para>
3114 <para>Beim Upgrade bestehender Mandanten wird eur ausgelesen und die
3115 Variablen werden so gesetzt, daß sich an der Funktionalität nichts
3118 <para>Die aktuelle Konfiguration wird unter Nummernkreise und
3119 Standardkonten unter dem neuen Punkt "Einstellungen" (read-only)
3120 angezeigt. Unter <guimenu>System</guimenu> →
3121 <guisubmenu>Mandantenkonfiguration</guisubmenu> können die
3122 Einstellungen auch geändert werden. Dabei ist zu beachten, dass eine
3123 Änderung vorhandene Daten so belässt und damit evtl. die Ergebnisse
3124 verfälscht. Dies gilt vor Allem für die Warenbuchungsmethode (siehe
3125 auch <link linkend="config.eur.inventory-system-perpetual">
3126 Bemerkungen zur Bestandsmethode</link>).</para>
3129 <sect2 id="config.eur.inventory-system-perpetual">
3130 <title>Bemerkungen zur Bestandsmethode</title>
3132 <para>Die Bestandsmethode ist eigentlich eine sehr elegante Methode,
3133 funktioniert in kivitendo aber nur unter bestimmten Bedingungen:
3134 Voraussetzung ist, daß auch immer alle Einkaufsrechnungen gepflegt
3135 werden, und man beim Jahreswechsel nicht mit einer leeren Datenbank
3136 anfängt, da bei jedem Verkauf anhand der gesamten Rechnungshistorie
3137 der Einkaufswert der Ware nach dem FIFO-Prinzip aus den
3138 Einkaufsrechnungen berechnet wird.</para>
3140 <para>Die Bestandsmethode kann vom Prinzip her also nur funktioneren,
3141 wenn man mit den Buchungen bei Null anfängt, und man kann auch nicht
3142 im laufenden Betrieb von der Aufwandsmethode zur Bestandsmethode
3146 <sect2 id="config.eur.knonw-issues">
3147 <title>Bekannte Probleme</title>
3149 <para>Bei bestimmten Berichten kann man derzeit noch inviduell
3150 einstellen, ob man nach Ist- oder Sollversteuerung auswertet, und es
3151 werden im Code Variablen wie $accrual oder $cash gesetzt. Diese
3152 Codestellen wurden noch nicht angepasst, sondern nur die, wo bisher
3153 die Konfigurationsvariable
3154 <varname>$::lx_office_conf{system}->{eur}</varname> ausgewertet
3157 <para>Es fehlen Hilfetext beim Neuanlegen eines Mandanten, was die
3158 Optionen bewirken, z.B. mit zwei Standardfällen.</para>
3162 <sect1 id="config.skr04-update-3804">
3163 <title>SKR04 19% Umstellung für innergemeinschaftlichen Erwerb</title>
3165 <sect2 id="config.skr04-update-3804.introduction">
3166 <title>Einführung</title>
3168 <para>Die Umsatzsteuerumstellung auf 19% für SKR04 für die
3169 Steuerschlüssel "EU ohne USt-ID Nummer" ist erst 2010 erfolgt.
3170 kivitendo beinhaltet ein Upgradeskript, das das Konto 3804 automatisch
3171 erstellt und die Steuereinstellungen korrekt einstellt. Hat der
3172 Benutzer aber schon selber das Konto 3804 angelegt, oder gab es schon
3173 Buchungen im Zeitraum nach dem 01.01.2007 auf das Konto 3803, wird das
3174 Upgradeskript vorsichtshalber nicht ausgeführt, da der Benutzer sich
3175 vielleicht schon selbst geholfen hat und mit seinen Änderungen
3176 zufrieden ist. Die korrekten Einstellungen kann man aber auch per Hand
3177 ausführen. Nachfolgend werden die entsprechenden Schritte anhand von
3178 Screenshots dargestellt.</para>
3180 <para>Für den Fall, daß Buchungen mit der Steuerschlüssel "EU ohne
3181 USt.-IdNr." nach dem 01.01.2007 erfolgt sind, ist davon auszugehen,
3182 dass diese mit dem alten Umsatzsteuersatz von 16% gebucht worden sind,
3183 und diese Buchungen sollten entsprechend kontrolliert werden.</para>
3186 <sect2 id="config.skr04-update-3804.create-chart">
3187 <title>Konto 3804 manuell anlegen</title>
3189 <para>Die folgenden Schritte sind notwendig, um das Konto manuell
3190 anzulegen und zu konfigurieren. Zuerst wird in
3191 <guimenu>System</guimenu> → <guisubmenu>Kontenübersicht</guisubmenu> →
3192 <guimenuitem>Konto erfassen</guimenuitem> das Konto angelegt.</para>
3195 <screeninfo>Konto 3804 erfassen</screeninfo>
3199 <imagedata fileref="images/skr04-update-3804/konto3804.png"/>
3204 <para>Als Zweites muss Steuergruppe 13 für Konto 3803 angepasst
3205 werden. Dazu unter <guimenu>System</guimenu> →
3206 <guisubmenu>Steuern</guisubmenu> →
3207 <guimenuitem>Bearbeiten</guimenuitem> den Eintrag mit Steuerschlüssel
3208 13 auswählen und ihn wie im folgenden Screenshot angezeigt
3212 <screeninfo>Steuerschlüssel 13 für 3803 (16%) anpassen</screeninfo>
3216 <imagedata fileref="images/skr04-update-3804/steuer3803.png"/>
3221 <para>Als Drittes wird ein neuer Eintrag mit Steuerschlüssel 13 für
3222 Konto 3804 (19%) angelegt. Dazu unter <guimenu>System</guimenu> →
3223 <guisubmenu>Steuern</guisubmenu> → <guimenuitem>Erfassen</guimenuitem>
3224 auswählen und die Werte aus dem Screenshot übernehmen.</para>
3227 <screeninfo>Steuerschlüssel 13 für 3804 (19%) anlegen</screeninfo>
3231 <imagedata fileref="images/skr04-update-3804/steuer3804.png"/>
3236 <para>Als Nächstes sind alle Konten anzupassen, die als
3237 Steuerautomatikkonto die 3803 haben, sodass sie ab dem 1.1.2007 auch
3238 Steuerautomatik auf 3804 bekommen. Dies betrifft in der
3239 Standardkonfiguration die Konten 4315 und 4726. Als Beispiel für 4315
3240 müssen Sie dazu unter <guimenu>System</guimenu> →
3241 <guisubmenu>Kontenübersicht</guisubmenu> → <guimenuitem>Konten
3242 anzeigen</guimenuitem> das Konto 4315 anklicken und die Einstellungen
3243 wie im Screenshot gezeigt vornehmen.</para>
3246 <screeninfo>Konto 4315 anpassen</screeninfo>
3250 <imagedata fileref="images/skr04-update-3804/konto4315.png"/>
3255 <para>Als Letztes sollte die Steuerliste unter
3256 <guimenu>System</guimenu> → <guisubmenu>Steuern</guisubmenu> →
3257 <guimenuitem>Bearbeiten</guimenuitem> kontrolliert werden. Zum
3258 Vergleich der Screenshot.</para>
3261 <screeninfo>Steuerliste vergleichen</screeninfo>
3265 <imagedata fileref="images/skr04-update-3804/steuerliste.png"/>
3272 <sect1 id="config.bilanz">
3273 <title>Verhalten des Bilanzberichts</title>
3275 <para>Bis Version 3.0 wurde "closedto" ("Bücher schließen zum") als
3276 Grundlage für das Startdatum benutzt. Schließt man die Bücher allerdings
3277 monatsweise führt dies zu falschen Werten.</para>
3279 <para>In der Mandantenkonfiguration kann man dieses Verhalten genau
3280 einstellen indem man:</para>
3284 <para>weiterhin closed_to benutzt (Default, es ändert sich nichts zu
3289 <para>immer den Jahresanfang nimmt (1.1. relativ zum
3294 <para>immer die letzte Eröffnungsbuchung als Startdatum nimmt</para>
3296 <para>- mit Jahresanfang als Alternative wenn es keine EB-Buchungen
3299 <para>- oder mit "alle Buchungen" als Alternative"</para>
3303 <para>mit Jahresanfang als Alternative wenn es keine EB-Buchungen
3308 <para>immer alle Buchungen seit Beginn der Datenbank nimmt</para>
3312 <para>Folgende Hinweise zu den Optionen: Das "Bücher schließen Datum"
3313 ist sinnvoll, wenn man nur komplette Jahre schließt. Bei Wirtschaftsjahr
3314 = Kalendarjahr entspricht dies aber auch dem Jahresanfang. "Alle
3315 Buchungen" kann z.B. sinnvoll sein wenn man ohne Jahresabschluß
3316 durchbucht. Eröffnungsbuchung mit "alle Buchungen" als Fallback ist z.B.
3317 sinnvoll, wenn man am sich Anfang des zweiten Buchungsjahres befindet,
3318 und noch keinen Jahreswechsel und auch noch keine EB-Buchungen hat. Bei
3319 den Optionen mit EB-Buchungen wird vorausgesetzt, daß diese immer am 1.
3320 Tag des Wirtschaftsjahres gebucht werden. Zur Sicherheit wird das
3321 Startdatum im Bilanzbericht jetzt zusätzlich zum Stichtag mit angezeigt.
3322 Das hilft auch bei der Kontrolle für den Abgleich mit der GuV bzw.
3323 Erfolgsrechnung.</para>
3326 <sect1 id="config.erfolgsrechnung">
3327 <title>Erfolgsrechnung</title>
3329 <para>Seit der Version 3.4.1 existiert in kivitendo der Bericht
3330 <emphasis role="bold"> Erfolgsrechnung</emphasis>.</para>
3332 <para>Die Erfolgsrechnung kann in der Mandantenkonfiguration unter
3333 Features an- oder abgeschaltet werden. Mit der Einstellung
3334 <varname>default_manager = swiss </varname> in der
3335 <filename>config/kivitendo.conf</filename> wird beim neu Erstellen einer
3336 Datenbank automatisch die Anzeige der Erfolgsrechnung im Menü
3337 <guimenu>Berichte </guimenu> ausgewählt und ersetzt dort die GUV.</para>
3339 <para>Im Gegensatz zur GUV werden bei der Erfolgsrechnung sämtliche
3340 Aufwands- und Erlöskonten einzeln aufgelistet (analog zur Bilanz),
3341 sortiert nach ERTRAG und AUFWAND.</para>
3343 <para>Bei den Konteneinstellungen muss bei jedem Konto, das in der
3344 Erfolgsrechnung erscheinen soll, unter <varname>Sonstige
3345 Einstellungen/Erfolgsrechnung</varname> entweder
3346 <literal>01.Ertrag</literal> oder <literal>06.Aufwand</literal>
3347 ausgewählt werden.</para>
3349 <para>Wird bei einem Erlöskonto <literal>06.Aufwand</literal>
3350 ausgewählt, so wird dieses Konto als Aufwandsminderung unter AUFWAND
3353 <para>Wird bei einem Aufwandskonto <literal>01.Ertrag</literal>
3354 ausgewählt, so wird dieses Konto als Ertragsminderung unter ERTRAG
3357 <para>Soll bei einer bereits bestehenden Buchhaltung in Zukunft
3358 zusätzlich die Erfolgsrechnung als Bericht verwendet werden, so müssen
3359 die Einstellungen zu allen Erlös- und Aufwandskonten unter
3360 <varname>Sonstige Einstellungen/Erfolgsrechnung</varname> überprüft und
3361 allenfalls neu gesetzt werden.</para>
3364 <sect1 id="config.rounding">
3365 <title>Rundung in Verkaufsbelegen</title>
3367 <para>In der Schweiz hat die kleinste aktuell benutzte Münze den Wert
3368 von 5 Rappen (0.05 CHF).</para>
3370 <para>Auch wenn im elektronischen Zahlungsverkehr Beträge mit einer
3371 Genauigkeit von 0.01 CHF verwendet werden können, ist es trotzdem nach
3372 wie vor üblich, Rechnungen mit auf 0.05 CHF gerundeten Beträgen
3373 auszustellen.</para>
3375 <para>In kivitendo kann seit der Version 3.4.1 die Einstellung für eine
3376 solche Rundung pro Mandant / Datenbank festgelegt werden.</para>
3378 <para>Die Einstellung wird beim Erstellen der Datenbank bei
3379 <literal>Genauigkeit</literal> festgelegt. Sie kann anschliessend über
3380 das Webinterface von kivitendo nicht mehr verändert werden.</para>
3382 <para>Abhängig vom Wert für <varname>default_manager</varname> in
3383 <filename>config/kivitendo.conf</filename> werden dabei folgende Werte
3384 voreingestellt:</para>
3388 <para>0.05 (default_manager = swiss)</para>
3392 <para>0.01 (default_manager = german)</para>
3396 <para>Der Wert wird in der Datenbank in der Tabelle <varname>defaults
3397 </varname>in der Spalte <varname>precision</varname> gespeichert.</para>
3399 <para>In allen Verkaufsangeboten, Verkaufsaufträgen, Verkaufsrechnungen
3400 und Verkaufsgutschriften wird der Endbetrag inkl. MWST gerundet, wenn
3401 dieser nicht der eingestellten Genauigkeit entspricht.</para>
3403 <para>Beim Buchen einer Verkaufsrechnung wird der Rundungsbetrag
3404 automatisch auf die in der Mandantenkonfiguration festgelegten
3405 Standardkonten für Rundungserträge bzw. Rundungsaufwendungen
3408 <para>(Die berechnete MWST wird durch den Rundungsbetrag nicht mehr
3411 <para>Die in den Druckvorlagen zur Verfügung stehenden Variablen
3412 <varname>quototal</varname>, <varname>ordtotal</varname> bzw.
3413 <varname>invtotal</varname> enthalten den gerundeten Betrag.</para>
3415 <para><emphasis role="bold">Achtung:</emphasis> Werden Verkaufsbelege in
3416 anderen Währungen als der Standardwährung erstellt, so muss in kivitendo
3417 ab Version 3.4.1 die Genauigkeit 0.01 verwendet werden.</para>
3419 <para>Das heisst, Firmen in der Schweiz, die teilweise
3420 Verkaufsrechnungen in Euro oder anderen Währungen erstellen wollen,
3421 müssen beim Erstellen der Datenbank als Genauigkeit 0.01 wählen und
3422 können zur Zeit die 5er Rundung noch nicht nutzen.</para>
3425 <sect1 id="config.client">
3426 <title>Einstellungen pro Mandant</title>
3428 <para>Einige Einstellungen können von einem Benutzer mit dem <link
3429 linkend="Zusammenhänge">Recht</link> "Administration (Für die Verwaltung
3430 der aktuellen Instanz aus einem Userlogin heraus)" gemacht werden. Diese
3431 Einstellungen sind dann für die aktuellen Mandanten-Datenbank gültig.
3432 Die Einstellungen sind unter <guimenu>System</guimenu> →
3433 <guisubmenu>Mandantenkonfiguration</guisubmenu> erreichbar.</para>
3435 <para>Bitte beachten Sie die Hinweise zu den einzelnen Einstellungen.
3436 Einige Einstellungen sollten nicht ohne Weiteres im laufenden Betrieb
3437 geändert werden (siehe auch <link
3438 linkend="config.eur.inventory-system-perpetual">Bemerkungen zu
3439 Bestandsmethode</link>).</para>
3441 <para>Die Einstellungen <literal>show_bestbefore</literal> und
3442 <literal>payments_changeable</literal> aus dem Abschnitt
3443 <literal>features</literal> und die Einstellungen im Abschnitt
3444 <literal>datev_check</literal> (sofern schon vorhanden) der <link
3445 linkend="config.config-file">kivitendo-Konfigurationsdatei</link> werden
3446 bei einem Datenbankupdate einer älteren Version automatisch übernommen.
3447 Diese Einträge können danach aus der Konfigurationsdatei entfernt
3451 <sect1 id="kivitendo-ERP-verwenden">
3452 <title>kivitendo ERP verwenden</title>
3454 <para>Nach erfolgreicher Installation ist der Loginbildschirm unter
3455 folgender URL erreichbar:</para>
3458 url="http://localhost/kivitendo-erp/login.pl">http://localhost/kivitendo-erp/login.pl</ulink></para>
3460 <para>Die Administrationsseite erreichen Sie unter:</para>
3463 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
3467 <chapter id="features" xreflabel="Features und Funktionen">
3468 <title>Features und Funktionen</title>
3470 <sect1 id="features.periodic-invoices"
3471 xreflabel="Wiederkehrende Rechnungen">
3472 <title>Wiederkehrende Rechnungen</title>
3474 <sect2 id="features.periodic-invoices.introduction"
3475 xreflabel="Einführung in wiederkehrende Rechnungen">
3476 <title>Einführung</title>
3478 <para>Wiederkehrende Rechnungen werden als normale Aufträge definiert
3479 und konfiguriert, mit allen dazugehörigen Kunden- und Artikelangaben.
3480 Die konfigurierten Aufträge werden später automatisch in Rechnungen
3481 umgewandelt, so als ob man den Workflow benutzen würde, und auch die
3482 Auftragsnummer wird übernommen, sodass alle wiederkehrenden
3483 Rechnungen, die aus einem Auftrag erstellt wurden, später leicht
3484 wiederzufinden sind.</para>
3487 <sect2 id="features.periodic-invoices.configuration"
3488 xreflabel="Konfiguration von wiederkehrenden Rechnungen">
3489 <title>Konfiguration</title>
3491 <para>Um einen Auftrag für wiederkehrende Rechnung zu konfigurieren,
3492 findet sich beim Bearbeiten des Auftrags ein neuer Knopf
3493 "Konfigurieren", der ein neues Fenster öffnet, in dem man die nötigen
3494 Parameter einstellen kann. Hinter dem Knopf wird außerdem noch
3495 angezeigt, ob der Auftrag als wiederkehrende Rechnung konfiguriert ist
3498 <para>Folgende Parameter kann man konfigurieren:</para>
3505 <para>Bei aktiven Rechnungen wird automatisch eine Rechnung
3506 erstellt, wenn die Periodizität erreicht ist (z.B. am Anfang
3507 eines neuen Monats).</para>
3509 <para>Ist ein Auftrag nicht aktiv, so werden für ihn auch keine
3510 wiederkehrenden Rechnungen erzeugt. Stellt man nach längerer
3511 nicht-aktiver Zeit einen Auftrag wieder auf aktiv, wird beim
3512 nächsten Periodenwechsel für alle Perioden, seit der letzten
3513 aktiven Periode, jeweils eine Rechnung erstellt. Möchte man dies
3514 verhindern, muss man vorher das Startdatum neu setzen.</para>
3516 <para>Für gekündigte Aufträge werden nie mehr Rechnungen
3517 erstellt. Man kann sich diese Aufträge aber gesondert in den
3518 Berichten anzeigen lassen.</para>
3523 <term>Periodizität</term>
3526 <para>Ob monatlich, quartalsweise oder jährlich auf neue
3527 Rechnungen überprüft werden soll. Für jede Periode seit dem
3528 Startdatum wird überprüft, ob für die Periode (beginnend immer
3529 mit dem ersten Tag der Periode) schon eine Rechnung erstellt
3530 wurde. Unter Umständen können bei einem Startdatum in der
3531 Vergangenheit gleich mehrere Rechnungen erstellt werden.</para>
3536 <term>Buchen auf</term>
3539 <para>Das Forderungskonto, in der Regel "Forderungen aus
3540 Lieferungen und Leistungen". Das Gegenkonto ergibt sich aus den
3541 Buchungsgruppen der betreffenden Waren.</para>
3546 <term>Startdatum</term>
3549 <para>ab welchem Datum auf Rechnungserstellung geprüft werden
3555 <term>Enddatum</term>
3558 <para>ab wann keine Rechnungen mehr erstellt werden
3564 <term>Automatische Verlängerung um x Monate</term>
3567 <para>Sollen die wiederkehrenden Rechnungen bei Erreichen des
3568 eingetragenen Enddatums weiterhin erstellt werden, so kann man
3569 hier die Anzahl der Monate eingeben, um die das Enddatum
3570 automatisch nach hinten geschoben wird.</para>
3575 <term>Drucken</term>
3578 <para>Sind Drucker konfiguriert, so kann man sich die erstellten
3579 Rechnungen auch gleich ausdrucken lassen.</para>
3584 <para>Nach Erstellung der Rechnungen kann eine E-Mail mit
3585 Informationen zu den erstellten Rechnungen verschickt werden.
3586 Konfiguriert wird dies in der <link
3587 linkend="config.config-file.sections-parameters">Konfigurationsdatei</link>
3588 <filename>config/kivitendo.conf</filename> im Abschnitt
3589 <varname>[periodic_invoices]</varname>.</para>
3592 <sect2 id="features.periodic-invoices.variables">
3593 <title>Spezielle Variablen</title>
3595 <para>Um die erzeugten Rechnungen individualisieren zu können, werden
3596 beim Umwandeln des Auftrags in eine Rechnung einige speziell
3597 formatierte Variablen durch für die jeweils aktuelle
3598 Abrechnungsperiode gültigen Werte ersetzt. Damit ist es möglich, z.B.
3599 den Abrechnungszeitraum explizit auszuweisen. Eine Variable hat dabei
3600 die Syntax <literal><%variablenname%></literal>.</para>
3602 <para>Sofern es sich um eine Datumsvariable handelt, kann das
3603 Ausgabeformat weiter bestimmt werden, indem an den Variablennamen
3604 Formatoptionen angehängt werden. Die Syntax sieht dabei wie folgt aus:
3605 <literal><%variablenname FORMAT=Formatinformation%></literal>.
3606 Die zur verfügung stehenden Formatinformationen werden unten genauer
3609 <para>Diese Variablen können auch beim automatischen Versand der
3610 erzeugten Rechnungen per E-Mail genutzt werden, indem sie in den
3611 Feldern für den Betreff oder die Nachricht verwendet werden.</para>
3613 <para>Diese Variablen werden in den folgenden Elementen des Auftrags
3618 <para>Bemerkungen</para>
3622 <para>Interne Bemerkungen</para>
3626 <para>Vorgangsbezeichnung</para>
3630 <para>In den Beschreibungs- und Langtextfeldern aller
3635 <para>Die zur Verfügung stehenden Variablen sind die Folgenden:</para>
3639 <term><varname><%current_quarter%></varname>,
3640 <varname><%previous_quarter%></varname>,
3641 <varname><%next_quarter%></varname></term>
3644 <para>Aktuelles, vorheriges und nächstes Quartal als Zahl
3645 zwischen <literal>1</literal> und <literal>4</literal>.</para>
3650 <term><varname><%current_month%></varname>,
3651 <varname><%previous_month%></varname>,
3652 <varname><%next_month%></varname></term>
3655 <para>Aktueller, vorheriger und nächster Monat als Zahl zwischen
3656 <literal>1</literal> und <literal>12</literal>.</para>
3661 <term><varname><%current_month_long%></varname>,
3662 <varname><%previous_month_long%></varname>,
3663 <varname><%next_month_long%></varname></term>
3666 <para>Aktueller, vorheriger und nächster Monat als Name
3667 (<literal>Januar</literal>, <literal>Februar</literal>
3673 <term><varname><%current_year%></varname>,
3674 <varname><%previous_year%></varname>,
3675 <varname><%next_year%></varname></term>
3678 <para>Aktuelles, vorheriges und nächstes Jahr als vierstellige
3679 Jahreszahl (<literal>2013</literal> etc.).</para>
3684 <term><varname><%period_start_date%></varname>,
3685 <varname><%period_end_date%></varname></term>
3688 <para>Formatiertes Datum des ersten und letzten Tages im
3689 Abrechnungszeitraum (z.B. bei quartalsweiser Abrechnung und im
3690 ersten Quartal von 2013 wären dies der
3691 <literal>01.01.2013</literal> und
3692 <literal>31.03.2013</literal>).</para>
3697 <para>Die invidiuellen Formatinformationen bestehen aus Paaren von
3698 Prozentzeichen und einem Buchstaben, welche beide zusammen durch den
3699 dazugehörigen Wert ersetzt werden. So wird z.B. <literal>%Y</literal>
3700 durch das viertstellige Jahr ersetzt. Alle möglichen Platzhalter
3705 <term><varname>%a</varname></term>
3708 <para>Der abgekürzte Wochentagsname.</para>
3713 <term><varname>%A</varname></term>
3716 <para>Der ausgeschriebene Wochentagsname.</para>
3721 <term><varname>%b</varname></term>
3724 <para>Der abgekürzte Monatsname.</para>
3729 <term><varname>%B</varname></term>
3732 <para>Der ausgeschriebene Monatsname.</para>
3737 <term><varname>%C</varname></term>
3740 <para>Das Jahrhundert (Jahr/100) als eine zweistellige
3746 <term><varname>%d</varname></term>
3749 <para>Der Monatstag als Zahl zwischen 01 und 31.</para>
3754 <term><varname>%D</varname></term>
3757 <para>Entspricht %m/%d/%y (amerikanisches Datumsformat).</para>
3762 <term><varname>%e</varname></term>
3765 <para>Wie %d (Monatstag als Zahl zwischen 1 und 31), allerdings
3766 werden führende Nullen durch Leerzeichen ersetzt.</para>
3771 <term><varname>%F</varname></term>
3774 <para>Entspricht %Y-%m-%d (das ISO-8601-Datumsformat).</para>
3779 <term><varname>%j</varname></term>
3782 <para>Der Tag im Jahr als Zahl zwischen 001 und 366
3788 <term><varname>%m</varname></term>
3791 <para>Der Monat als Zahl zwischen 01 und 12 inklusive.</para>
3796 <term><varname>%u</varname></term>
3799 <para>Der Wochentag als Zahl zwischen 1 und 7 inklusive, wobei
3800 die 1 dem Montag entspricht.</para>
3805 <term><varname>%U</varname></term>
3808 <para>Die Wochennummer als Zahl zwischen 00 und 53 inklusive,
3809 wobei der erste Sonntag im Jahr das Startdatum von Woche 01
3815 <term><varname>%V</varname></term>
3818 <para>Die ISO-8601:1988-Wochennummer als Zahl zwischen 01 und 53
3819 inklusive, wobei Woche 01 die erste Woche, von der mindestens
3820 vier Tage im Jahr liegen; Montag ist erster Tag der
3826 <term><varname>%w</varname></term>
3829 <para>Der Wochentag als Zahl zwischen 0 und 6 inklusive, wobei
3830 die 0 dem Sonntag entspricht.</para>
3835 <term><varname>%W</varname></term>
3838 <para>Die Wochennummer als Zahl zwischen 00 und 53 inklusive,
3839 wobei der erste Montag im Jahr das Startdatum von Woche 01
3845 <term><varname>%y</varname></term>
3848 <para>Das Jahr als zweistellige Zahl zwischen 00 und 99
3854 <term><varname>%Y</varname></term>
3857 <para>Das Jahr als vierstellige Zahl.</para>
3862 <term><varname>%%</varname></term>
3865 <para>Das Prozentzeichen selber.</para>
3870 <para>Anwendungsbeispiel für die Ausgabe, von welchem Monat und Jahr
3871 bis zu welchem Monat und Jahr die aktuelle Abrechnungsperiode dauert:
3872 <literal>Abrechnungszeitrum: <%period_start_date FORMAT=%m/%Y%>
3873 bis <%period_end_date FORMAT=%m/%Y%></literal></para>
3876 <sect2 id="features.periodic-invoices.reports">
3877 <title>Auflisten</title>
3879 <para>Unter Verkauf->Berichte->Aufträge finden sich zwei neue
3880 Checkboxen, "Wiederkehrende Rechnungen aktiv" und "Wiederkehrende
3881 Rechnungen inaktiv", mit denen man sich einen Überglick über die
3882 wiederkehrenden Rechnungen verschaffen kann.</para>
3885 <sect2 id="features.periodic-invoices.task-server">
3886 <title>Erzeugung der eigentlichen Rechnungen</title>
3888 <para>Die zeitliche und periodische Überprüfung, ob eine
3889 wiederkehrende Rechnung automatisch erstellt werden soll, geschieht
3890 durch den <link linkend="config.task-server">Task-Server</link>, einen
3891 externen Dienst, der automatisch beim Start des Servers gestartet
3892 werden sollte.</para>
3895 <sect2 id="features.periodic-invoices.create-for-current-month">
3896 <title>Erste Rechnung für aktuellen Monat erstellen</title>
3898 <para>Will man im laufenden Monat eine monatlich wiederkehrende
3899 Rechnung inkl. des laufenden Monats starten, stellt man das Startdatum
3900 auf den Monatsanfang und wartet ein paar Minuten, bis der Task-Server
3901 den neu konfigurieren Auftrag erkennt und daraus eine Rechnung
3902 generiert hat. Alternativ setzt man das Startdatum auf den
3903 Monatsersten des Folgemonats und erstellt die erste Rechnung direkt
3904 manuell über den Workflow.</para>
3908 <sect1 id="features.bank" xreflabel="bankerweiterung">
3909 <title>Bankerweiterung</title>
3911 <sect2 id="features.bank.introduction"
3912 xreflabel="Einführung in die Bankerweiterung">
3913 <title>Einführung</title>
3915 <para>Die Beschreibung der Bankerweiterung befindet sich derzeit noch
3916 im Wiki und soll von dort später hierhin übernommen werden:</para>
3919 url="http://redmine.kivitendo-premium.de/projects/forum/wiki/Bankerweiterung">http://redmine.kivitendo-premium.de/projects/forum/wiki/Bankerweiterung</ulink></para>
3923 <sect1 id="dokumentenvorlagen-und-variablen">
3924 <title>Dokumentenvorlagen und verfügbare Variablen</title>
3926 <sect2 id="dokumentenvorlagen-und-variablen.einführung">
3927 <title>Einführung</title>
3929 <para>Dies ist eine Auflistung der Standard-Dokumentenvorlagen und
3930 aller zur Bearbeitung verfügbaren Variablen. Eine Variable wird in
3931 einer Vorlage durch ihren Inhalt ersetzt, wenn sie in der Form
3932 <function><%variablenname%></function> verwendet wird. Für
3933 LaTeX- und HTML-Vorlagen kann man die Form dieser Tags auch verändern
3935 linkend="dokumentenvorlagen-und-variablen.tag-style"/>).</para>
3937 <para>kivitendo unterstützt LaTeX-, HTML- und OpenDocument-Vorlagen.
3938 Sofern es nicht ausdrücklich eingeschränkt wird, gilt das im Folgenden
3939 gesagte für alle Vorlagenarten.</para>
3941 <para>Insgesamt sind technisch gesehen eine ganze Menge mehr Variablen
3942 verfügbar als hier aufgelistet werden. Die meisten davon können
3943 allerdings innerhalb einer solchen Vorlage nicht sinnvoll verwendet
3944 werden. Wenn eine Auflistung dieser Variablen gewollt ist, so kann
3945 diese wie folgt erhalten werden:</para>
3949 <para><filename>SL/Form.pm</filename> öffnen und am Anfang die
3950 Zeile "<command>use Data::Dumper;</command>" einfügen.</para>
3954 <para>In <filename>Form.pm</filename> die Funktion
3955 <function>parse_template</function> suchen und hier die Zeile
3956 <command>print(STDERR Dumper($self));</command> einfügen.</para>
3960 <para>Einmal per Browser die gewünschte Vorlage "benutzen", z.B.
3961 ein PDF für eine Rechnung erzeugen.</para>
3965 <para>Im <filename>error.log</filename> Apache steht die Ausgabe
3966 der Variablen <varname>$self</varname> in der Form <varname>'key'
3967 => 'value',</varname>. Alle <varname>key</varname>s sind
3973 <sect2 id="dokumentenvorlagen-und-variablen.variablen-ausgeben">
3974 <title>Variablen ausgeben</title>
3976 <para>Um eine Variable auszugeben, müssen sie einfach nur zwischen die
3977 Tags geschrieben werden, also z.B.
3978 <varname><%variablenname%></varname>.</para>
3980 <para>Optional kann man auch mit Leerzeichen getrennte Flags angeben,
3981 die man aber nur selten brauchen wird. Die Syntax sieht also so aus:
3982 <varname><%variablenname FLAG1 FLAG2%></varname>. Momentan
3983 werden die folgenden Flags unterstützt:</para>
3987 <para><option>NOFORMAT</option> gilt nur für Zahlenwerte und gibt
3988 den Wert ohne Formatierung, also ohne Tausendertrennzeichen mit
3989 mit einem Punkt als Dezimaltrennzeichen aus. Nützlich z.B., wenn
3990 damit in der Vorlage z.B. von LaTeX gerechnet werden soll.</para>
3994 <para><option>NOESCAPE</option> unterdrückt das Escapen von
3995 Sonderzeichen für die Vorlagensprache. Wenn also in einer
3996 Variablen bereits gültiger LaTeX-Code steht und dieser von LaTeX
3997 auch ausgewertet und nicht wortwörtlich angezeigt werden soll, so
3998 ist dieses Flag sinnvoll.</para>
4002 <para>Beispiel:</para>
4004 <programlisting><%quototal NOFORMAT%></programlisting>
4007 <sect2 id="dokumentenvorlagen-und-variablen.verwendung-in-druckbefehlen">
4008 <title>Verwendung in Druckbefehlen</title>
4010 <para>In der Admininstration können Drucker definiert werden. Auch im
4011 dort eingebbaren Druckbefehl können die hier aufgelisteten Variablen
4012 und Kontrollstrukturen verwendet werden. Ihr Inhalt wird dabei nach
4013 den Regeln der gängigen Shells formatiert, sodass Sonderzeichen wie
4014 <function>`...`</function> nicht zu unerwünschtem Verhalten
4017 <para>Dies erlaubt z.B. die Definition eines Faxes als Druckerbefehl,
4018 für das die Telefonnummer eines Ansprechpartners als Teil der
4019 Kommandozeile verwendet wird. Für ein fiktives Kommando könnte das
4020 z.B. wie folgt aussehen:</para>
4022 <programlisting>send_fax --number <%if cp_phone2%><%cp_phone2%><%else%><%cp_phone1%><%end%></programlisting>
4025 <sect2 id="dokumentenvorlagen-und-variablen.tag-style"
4026 xreflabel="Anfang und Ende der Tags verändern">
4027 <title>Anfang und Ende der Tags verändern</title>
4029 <para>Der Standardstil für Tags sieht vor, dass ein Tag mit dem
4030 Kleinerzeichen und einem Prozentzeichen beginnt und mit dem
4031 Prozentzeichen und dem Größerzeichen endet, beispielsweise
4032 <function><%customer%></function>. Da diese Form aber z.B. in
4033 LaTeX zu Problemen führen kann, weil das Prozentzeichen dort
4034 Kommentare einleitet, kann pro HTML- oder LaTeX-Dokumentenvorlage der
4035 Stil umgestellt werden.</para>
4037 <para>Dazu werden in die Datei Zeilen geschrieben, die mit dem für das
4038 Format gültigen Kommentarzeichen anfangen, dann
4039 <function>config:</function> enthalten, die entsprechende Option
4040 setzen und bei HTML-Dokumentenvorlagen mit dem Kommentarendzeichen
4041 enden. Beispiel für LaTeX:</para>
4043 <programlisting>% config: tag-style=($ $)</programlisting>
4045 <para>Dies würde kivitendo dazu veranlassen, Variablen zu ersetzen,
4046 wenn sie wie folgt aussehen: <function>($customer$)</function>. Das
4047 äquivalente Beispiel für HTML-Dokumentenvorlagen sieht so aus:</para>
4049 <programlisting><!-- config: tag-style=($ $) --></programlisting>
4052 <sect2 id="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">
4053 <title>Zuordnung von den Dateinamen zu den Funktionen</title>
4055 <para>Diese folgende kurze Auflistung zeigt, welche Vorlage bei
4056 welcher Funktion ausgelesen wird. Dabei ist die Dateiendung
4057 "<filename>.ext</filename>" geeignet zu ersetzen:
4058 "<filename>.tex</filename>" für LaTeX-Vorlagen und
4059 "<filename>.odt</filename>" für OpenDocument-Vorlagen.</para>
4063 <term><filename>bin_list.ext</filename></term>
4066 <para>Lagerliste</para>
4071 <term><filename>check.ext</filename></term>
4079 <term><filename>invoice.ext</filename></term>
4082 <para>Rechnung</para>
4087 <term><filename>packing_list.ext</filename></term>
4090 <para>Packliste</para>
4095 <term><filename>pick_list.ext</filename></term>
4098 <para>Sammelliste</para>
4103 <term><filename>purchase_delivery_order.ext</filename></term>
4106 <para>Lieferschein (Einkauf)</para>
4111 <term><filename>purcharse_order.ext</filename></term>
4114 <para>Bestellung an Lieferanten</para>
4119 <term><filename>request_quotation.ext</filename></term>
4122 <para>Anfrage an Lieferanten</para>
4127 <term><filename>sales_delivery_order.ext</filename></term>
4130 <para>Lieferschein (Verkauf)</para>
4135 <term><filename>sales_order.ext</filename></term>
4138 <para>Bestellung</para>
4143 <term><filename>sales_quotation.ext</filename></term>
4146 <para>Angebot an Kunden</para>
4151 <term><filename>zahlungserinnerung.ext</filename></term>
4154 <para>Mahnung (Dateiname im Programm konfigurierbar)</para>
4159 <term><filename>zahlungserinnerung_invoice.ext</filename></term>
4162 <para>Rechnung über Mahngebühren (Dateiname im Programm
4163 konfigurierbar)</para>
4169 <sect2 id="dokumentenvorlagen-und-variablen.dateinamen-erweitert">
4170 <title>Sprache, Drucker und E-Mail</title>
4172 <para>Angeforderte Sprache und Druckerkürzel in den Dateinamen mit
4173 eingearbeitet. So wird aus der Vorlage
4174 <filename>sales_order.ext</filename> bei Sprache
4175 <function>de</function> und Druckerkürzel <function>lpr2</function>
4176 der Vorlagenname <filename>sales_order_de_lpr2.ext</filename>.
4177 Zusätzlich können für E-Mails andere Vorlagen erstellt werden, diese
4178 bekommen dann noch das Kürzel <filename>_email</filename>, der
4179 vollständige Vorlagenname wäre dann
4180 <filename>sales_order_email_de_lpr2.ext</filename>. In allen Fällen
4181 kann eine Standarddatei <filename>default.ext</filename> hinterlegt
4182 werden. Diese wird verwendet, wenn keine der anderen Varianten
4183 gefunden wird.</para>
4185 <para>Die vollständige Suchreihenfolge für einen Verkaufsauftrag mit
4186 der Sprache "de" und dem Drucker "lpr2", der per E-Mail im Format PDF
4187 verschickt wird, ist:</para>
4191 <para><filename>sales_order_email_de_lpr2.tex</filename></para>
4195 <para><filename>sales_order_de_lpr2.tex</filename></para>
4199 <para><filename>sales_order.tex</filename></para>
4203 <para><filename>default.tex</filename></para>
4207 <para>Die kurzen Varianten dieser Vorlagentitel müssen dann entweder
4208 Standardwerte anzeigen, oder die angeforderten Werte selbst auswerten,
4210 linkend="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"/>.</para>
4213 <sect2 id="dokumentenvorlagen-und-variablen.allgemeine-variablen">
4214 <title>Allgemeine Variablen, die in allen Vorlagen vorhanden
4217 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"
4218 xreflabel="Metainformationen zur angeforderten Vorlage">
4219 <title>Metainformationen zur angeforderten Vorlage</title>
4221 <para>Diese Variablen liefern Informationen darüber welche Variante
4222 einer Vorlage der Benutzer angefragt hat. Sie sind nützlich für
4223 Vorlagenautoren, die aus einer zentralen Layoutvorlage die einzelnen
4224 Formulare einbinden möchten.</para>
4228 <term><varname>template_meta.formname</varname></term>
4231 <para>Basisname der Vorlage. Identisch mit der <link
4232 linkend="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">Zurordnung
4233 zu den Dateinamen</link> ohne die Erweiterung. Ein
4234 Verkaufsauftrag enthält hier
4235 <constant>sales_order</constant>.</para>
4240 <term><varname>template_meta.language.description</varname></term>
4243 <para>Beschreibung der verwendeten Sprache</para>
4248 <term><varname>template_meta.language.template_code</varname></term>
4251 <para>Vorlagenkürzel der verwendeten Sprache, identisch mit
4252 dem Kürzel das im Dateinamen verwendetet wird.</para>
4257 <term><varname>template_meta.language.output_numberformat</varname></term>
4260 <para>Zahlenformat der verwendeten Sprache in der Form
4261 "<constant>1.000,00</constant>". Experimentell! Nur
4262 interessant für Vorlagen die mit unformatierten Werten
4268 <term><varname>template_meta.language.output_dateformat</varname></term>
4271 <para>Datumsformat der verwendeten Sprache in der Form
4272 "<constant>dd.mm.yyyy</constant>". Experimentell! Nur
4273 interessant für Vorlagen die mit unformatierten Werten
4279 <term><varname>template_meta.format</varname></term>
4282 <para>Das angeforderte Format. Kann im Moment die Werte
4283 <constant>pdf</constant>, <constant>postscript</constant>,
4284 <constant>html</constant>, <constant>opendocument</constant>,
4285 <constant>opendocument_pdf</constant> und
4286 <constant>excel</constant> enthalten.</para>
4291 <term><varname>template_meta.extension</varname></term>
4294 <para>Dateierweiterung, wie im Dateinamen. Wird aus
4295 <constant>format</constant> entschieden.</para>
4300 <term><varname>template_meta.media</varname></term>
4303 <para>Ausgabemedium. Kann zur Zeit die Werte
4304 <constant>screen</constant> für Bildschirm,
4305 <constant>email</constant> für E-Mail (triggert das
4306 <constant>_email</constant> Kürzel im Dateinamen),
4307 <constant>printer</constant> für Drucker, und
4308 <constant>queue</constant> für Warteschlange enthalten.</para>
4313 <term><varname>template_meta.printer.description</varname></term>
4316 <para>Beschreibung des ausgewählten Druckers</para>
4321 <term><varname>template_meta.printer.template_code</varname></term>
4324 <para>Vorlagenürzel des ausgewählten Druckers, identisch mit
4325 dem Kürzel das im Dateinamen verwendetet wird.</para>
4330 <term><varname>template_meta.tmpfile</varname></term>
4333 <para>Datei-Prefix für temporäre Dateien.</para>
4339 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.kunden-lieferanten">
4340 <title>Stammdaten von Kunden und Lieferanten</title>
4344 <term><varname>account_number</varname></term>
4347 <para>Kontonummer</para>
4352 <term><varname>bank</varname></term>
4355 <para>Name der Bank</para>
4360 <term><varname>bank_code</varname></term>
4363 <para>Bankleitzahl</para>
4368 <term><varname>bic</varname></term>
4371 <para>Bank-Identifikations-Code (Bank Identifier Code,
4377 <term><varname>business</varname></term>
4380 <para>Kunden-/Lieferantentyp</para>
4385 <term><varname>city</varname></term>
4393 <term><varname>contact</varname></term>
4396 <para>Kontakt</para>
4401 <term><varname>country</varname></term>
4409 <term><varname>c_vendor_id</varname></term>
4412 <para>Lieferantennummer beim Kunden (nur Kunden)</para>
4417 <term><varname>v_customer_id</varname></term>
4420 <para>Kundennummer beim Lieferanten (nur Lieferanten)</para>
4425 <term><varname>cp_email</varname></term>
4428 <para>Email des Ansprechpartners</para>
4433 <term><varname>cp_givenname</varname></term>
4436 <para>Vorname des Ansprechpartners</para>
4441 <term><varname>cp_greeting</varname></term>
4444 <para>Anrede des Ansprechpartners</para>
4449 <term><varname>cp_name</varname></term>
4452 <para>Name des Ansprechpartners</para>
4457 <term><varname>cp_phone1</varname></term>
4460 <para>Telefonnummer 1 des Ansprechpartners</para>
4465 <term><varname>cp_phone2</varname></term>
4468 <para>Telefonnummer 2 des Ansprechpartners</para>
4473 <term><varname>cp_title</varname></term>
4476 <para>Titel des Ansprechpartners</para>
4481 <term><varname>creditlimit</varname></term>
4484 <para>Kreditlimit</para>
4489 <term><varname>customeremail</varname></term>
4492 <para>Email des Kunden; nur für Kunden</para>
4497 <term><varname>customerfax</varname></term>
4500 <para>Faxnummer des Kunden; nur für Kunden</para>
4505 <term><varname>customernotes</varname></term>
4508 <para>Bemerkungen beim Kunden; nur für Kunden</para>
4513 <term><varname>customernumber</varname></term>
4516 <para>Kundennummer; nur für Kunden</para>
4521 <term><varname>customerphone</varname></term>
4524 <para>Telefonnummer des Kunden; nur für Kunden</para>
4529 <term><varname>discount</varname></term>
4537 <term><varname>email</varname></term>
4540 <para>Emailadresse</para>
4545 <term><varname>fax</varname></term>
4548 <para>Faxnummer</para>
4553 <term><varname>gln</varname></term>
4556 <para>GLN (Globale Lokationsnummer)</para>
4561 <term><varname>greeting</varname></term>
4569 <term><varname>homepage</varname></term>
4572 <para>Homepage</para>
4577 <term><varname>iban</varname></term>
4580 <para>Internationale Kontonummer (International Bank Account
4581 Number, IBAN)</para>
4586 <term><varname>language</varname></term>
4589 <para>Sprache</para>
4594 <term><varname>name</varname></term>
4597 <para>Firmenname</para>
4602 <term><varname>natural_person</varname></term>
4605 <para>Flag "natürliche Person"; Siehe auch
4606 <xref linkend="dokumentenvorlagen-und-variablen.anrede"/></para>
4611 <term><varname>payment_description</varname></term>
4614 <para>Name der Zahlart</para>
4619 <term><varname>payment_terms</varname></term>
4622 <para>Zahlungskonditionen</para>
4627 <term><varname>phone</varname></term>
4630 <para>Telefonnummer</para>
4635 <term><varname>shiptocity</varname></term>
4638 <para>Stadt (Lieferadresse) <link
4639 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4644 <term><varname>shiptocontact</varname></term>
4647 <para>Kontakt (Lieferadresse) <link
4648 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4653 <term><varname>shiptocountry</varname></term>
4656 <para>Land (Lieferadresse) <link
4657 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4662 <term><varname>shiptodepartment_1</varname></term>
4665 <para>Abteilung 1 (Lieferadresse) <link
4666 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4671 <term><varname>shiptodepartment_2</varname></term>
4674 <para>Abteilung 2 (Lieferadresse) <link
4675 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4680 <term><varname>shiptoemail</varname></term>
4683 <para>Email (Lieferadresse) <link
4684 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4689 <term><varname>shiptofax</varname></term>
4692 <para>Fax (Lieferadresse) <link
4693 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4698 <term><varname>shiptogln</varname></term>
4701 <para>GLN (Globale Lokationsnummer) (Lieferadresse) <link
4702 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4707 <term><varname>shiptoname</varname></term>
4710 <para>Firmenname (Lieferadresse) <link
4711 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4716 <term><varname>shiptophone</varname></term>
4719 <para>Telefonnummer (Lieferadresse) <link
4720 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4725 <term><varname>shiptostreet</varname></term>
4728 <para>Straße und Hausnummer (Lieferadresse) <link
4729 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4734 <term><varname>shiptozipcode</varname></term>
4737 <para>Postleitzahl (Lieferadresse) <link
4738 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4743 <term><varname>street</varname></term>
4746 <para>Straße und Hausnummer</para>
4751 <term><varname>taxnumber</varname></term>
4754 <para>Steuernummer</para>
4759 <term><varname>ustid</varname></term>
4762 <para>Umsatzsteuer-Identifikationsnummer</para>
4767 <term><varname>vendoremail</varname></term>
4770 <para>Email des Lieferanten; nur für Lieferanten</para>
4775 <term><varname>vendorfax</varname></term>
4778 <para>Faxnummer des Lieferanten; nur für Lieferanten</para>
4783 <term><varname>vendornotes</varname></term>
4786 <para>Bemerkungen beim Lieferanten; nur für Lieferanten</para>
4791 <term><varname>vendornumber</varname></term>
4794 <para>Lieferantennummer; nur für Lieferanten</para>
4799 <term><varname>vendorphone</varname></term>
4802 <para>Telefonnummer des Lieferanten; nur für
4808 <term><varname>zipcode</varname></term>
4811 <para>Postleitzahl</para>
4816 <note id="dokumentenvorlagen-und-variablen.anmerkung-shipto">
4817 <para>Anmerkung: Sind die <varname>shipto*</varname>-Felder in den
4818 Stammdaten nicht eingetragen, so haben die Variablen
4819 <varname>shipto*</varname> den gleichen Wert wie die die
4820 entsprechenden Variablen der Lieferdaten. Das bedeutet, dass sich
4821 einige <varname>shipto*</varname>-Variablen so nicht in den
4822 Stammdaten wiederfinden sondern schlicht Kopien der
4823 Lieferdatenvariablen sind (z.B.
4824 <varname>shiptocontact</varname>).</para>
4828 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-bearbeiter">
4829 <title>Informationen über den Bearbeiter</title>
4833 <term><varname>employee_address</varname></term>
4836 <para>Adressfeld</para>
4841 <term><varname>employee_businessnumber</varname></term>
4844 <para>Firmennummer</para>
4849 <term><varname>employee_company</varname></term>
4852 <para>Firmenname</para>
4857 <term><varname>employee_co_ustid</varname></term>
4860 <para>Usatzsteuer-Identifikationsnummer</para>
4865 <term><varname>employee_duns</varname></term>
4868 <para>DUNS-Nummer</para>
4873 <term><varname>employee_email</varname></term>
4881 <term><varname>employee_fax</varname></term>
4889 <term><varname>employee_name</varname></term>
4892 <para>voller Name</para>
4897 <term><varname>employee_signature</varname></term>
4900 <para>Signatur</para>
4905 <term><varname>employee_taxnumber</varname></term>
4908 <para>Steuernummer</para>
4913 <term><varname>employee_tel</varname></term>
4916 <para>Telefonnummer</para>
4922 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-verkaeufer">
4923 <title>Informationen über den Verkäufer</title>
4927 <term><varname>salesman_address</varname></term>
4930 <para>Adressfeld</para>
4935 <term><varname>salesman_businessnumber</varname></term>
4938 <para>Firmennummer</para>
4943 <term><varname>salesman_company</varname></term>
4946 <para>Firmenname</para>
4951 <term><varname>salesman_co_ustid</varname></term>
4954 <para>Usatzsteuer-Identifikationsnummer</para>
4959 <term><varname>salesman_duns</varname></term>
4962 <para>DUNS-Nummer</para>
4967 <term><varname>salesman_email</varname></term>
4975 <term><varname>salesman_fax</varname></term>
4983 <term><varname>salesman_name</varname></term>
4986 <para>voller Name</para>
4991 <term><varname>salesman_signature</varname></term>
4994 <para>Signatur</para>
4999 <term><varname>salesman_taxnumber</varname></term>
5002 <para>Steuernummer</para>
5007 <term><varname>salesman_tel</varname></term>
5010 <para>Telefonnummer</para>
5016 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-steuern">
5017 <title>Variablen für die einzelnen Steuern</title>
5021 <term><varname>tax</varname></term>
5029 <term><varname>taxbase</varname></term>
5032 <para>zu versteuernder Betrag</para>
5037 <term><varname>taxdescription</varname></term>
5040 <para>Name der Steuer</para>
5045 <term><varname>taxrate</varname></term>
5048 <para>Steuersatz</para>
5054 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-lieferbedingungen">
5055 <title>Variablen für Lieferbedingungen</title>
5059 <term><varname>delivery_term</varname></term>
5062 <para>Datenbank-Objekt der Lieferbedingung</para>
5067 <term><varname>delivery_term.description</varname></term>
5070 <para>Beschreibung der Lieferbedingung</para>
5075 <term><varname>delivery_term.description_long</varname></term>
5078 <para>Langtext bzw. übersetzter Langtext der
5079 Lieferbedingung</para>
5086 <sect2 id="dokumentenvorlagen-und-variablen.invoice">
5087 <title>Variablen in Rechnungen</title>
5089 <sect3 id="dokumentenvorlagen-und-variablen.invoice-allgemein">
5090 <title>Allgemeine Variablen</title>
5094 <term><varname>creditremaining</varname></term>
5097 <para>Verbleibender Kredit</para>
5102 <term><varname>currency</varname></term>
5105 <para>Währung</para>
5110 <term><varname>cusordnumber</varname></term>
5113 <para>Bestellnummer beim Kunden</para>
5118 <term><varname>deliverydate</varname></term>
5121 <para>Lieferdatum</para>
5126 <term><varname>duedate</varname></term>
5129 <para>Fälligkeitsdatum</para>
5134 <term><varname>globalprojectnumber</varname></term>
5137 <para>Projektnummer des ganzen Beleges</para>
5142 <term><varname>globalprojectdescription</varname></term>
5145 <para>Projekbeschreibung des ganzen Beleges</para>
5150 <term><varname>intnotes</varname></term>
5153 <para>Interne Bemerkungen</para>
5158 <term><varname>invdate</varname></term>
5161 <para>Rechnungsdatum</para>
5166 <term><varname>invnumber</varname></term>
5169 <para>Rechnungsnummer</para>
5174 <term><varname>invtotal</varname></term>
5177 <para>gesamter Rechnungsbetrag</para>
5182 <term><varname>notes</varname></term>
5185 <para>Bemerkungen der Rechnung</para>
5190 <term><varname>orddate</varname></term>
5193 <para>Auftragsdatum</para>
5198 <term><varname>ordnumber</varname></term>
5201 <para>Auftragsnummer, wenn die Rechnung aus einem Auftrag
5202 erstellt wurde</para>
5207 <term><varname>payment_description</varname></term>
5210 <para>Name der Zahlart</para>
5215 <term><varname>payment_terms</varname></term>
5218 <para>Zahlungskonditionen</para>
5223 <term><varname>quodate</varname></term>
5226 <para>Angebotsdatum</para>
5231 <term><varname>quonumber</varname></term>
5234 <para>Angebotsnummer</para>
5239 <term><varname>rounding</varname></term>
5242 <para>Betrag, um den <varname>invtotal</varname> gerundet
5243 wurde (kann positiv oder negativ sein)</para>
5248 <term><varname>shippingpoint</varname></term>
5251 <para>Versandort</para>
5256 <term><varname>shipvia</varname></term>
5259 <para>Transportmittel</para>
5264 <term><varname>subtotal</varname></term>
5267 <para>Zwischensumme aller Posten ohne Steuern</para>
5272 <term><varname>total</varname></term>
5275 <para>Restsumme der Rechnung (Summe abzüglich bereits
5276 bezahlter Posten)</para>
5281 <term><varname>transaction_description</varname></term>
5284 <para>Vorgangsbezeichnung</para>
5289 <term><varname>transdate</varname></term>
5292 <para>Auftragsdatum wenn die Rechnung aus einem Auftrag
5293 erstellt wurde</para>
5299 <sect3 id="dokumentenvorlagen-und-variablen.invoice-posten">
5300 <title>Variablen für jeden Posten auf der Rechnung</title>
5304 <term><varname>bin</varname></term>
5307 <para>Stellage</para>
5312 <term><varname>description</varname></term>
5315 <para>Artikelbeschreibung</para>
5320 <term><varname>cusordnumber_oe</varname></term>
5323 <para>Bestellnummer des Kunden aus dem Auftrag, aus dem der
5324 Posten ursprünglich stammt (nur Verkauf)</para>
5329 <term><varname>discount</varname></term>
5332 <para>Rabatt als Betrag</para>
5337 <term><varname>discount_sub</varname></term>
5340 <para>Zwischensumme mit Rabatt</para>
5345 <term><varname>donumber_do</varname></term>
5348 <para>Lieferscheinnummer des Lieferscheins, aus dem die
5349 Position ursprünglich stammt, wenn die Rechnung im Rahmen des
5350 Workflows aus einem Lieferschein erstellt wurde.</para>
5355 <term><varname>drawing</varname></term>
5358 <para>Zeichnung</para>
5363 <term><varname>ean</varname></term>
5366 <para>EAN-Code</para>
5371 <term><varname>image</varname></term>
5379 <term><varname>linetotal</varname></term>
5382 <para>Zeilensumme (Anzahl * Einzelpreis)</para>
5387 <term><varname>longdescription</varname></term>
5390 <para>Langtext, vorbelegt mit dem Feld Bemerkungen der entsprechenden Ware</para>
5395 <term><varname>microfiche</varname></term>
5398 <para>Mikrofilm</para>
5403 <term><varname>netprice</varname></term>
5406 <para>Alternative zu <varname>sellprice</varname>, aber
5407 <varname>netprice</varname> entspricht dem effektiven
5408 Einzelpreis und beinhaltet Zeilenrabatt und Preisfaktor.
5409 <varname>netprice</varname> wird rückgerechnet aus Zeilensumme
5410 / Menge. Diese Variable ist nützlich, wenn man den gewährten
5411 Rabatt in der Druckvorlage nicht anzeigen möchte, aber Menge *
5412 Einzelpreis trotzdem die angezeigte Zeilensumme ergeben soll.
5413 <varname>netprice</varname> hat nichts mit Netto/Brutto im
5414 Sinne von Steuern zu tun.</para>
5419 <term><varname>nodiscount_linetotal</varname></term>
5422 <para>Zeilensumme ohne Rabatt</para>
5427 <term><varname>nodiscount_sub</varname></term>
5430 <para>Zwischensumme ohne Rabatt</para>
5435 <term><varname>number</varname></term>
5438 <para>Artikelnummer</para>
5443 <term><varname>ordnumber_oe</varname></term>
5446 <para>Auftragsnummer des Originalauftrags, aus dem der Posten
5447 ursprünglich stammt. Nützlich, wenn die Rechnung aus mehreren
5448 Lieferscheinen zusammengefasst wurde, oder wenn zwischendurch
5449 eine Sammelauftrag aus mehreren Aufträgen erstellt wurde. In
5450 letzterem Fall wird die unsprüngliche Auftragsnummer
5456 <term><varname>p_discount</varname></term>
5459 <para>Rabatt in Prozent</para>
5464 <term><varname>partnotes</varname></term>
5467 <para>Die beim Artikel gespeicherten Bemerkungen</para>
5472 <term><varname>partsgroup</varname></term>
5475 <para>Warengruppe</para>
5480 <term><varname>price_factor</varname></term>
5483 <para>Der Preisfaktor als Zahl, sofern einer eingestellt
5489 <term><varname>price_factor_name</varname></term>
5492 <para>Der Name des Preisfaktors, sofern einer eingestellt
5498 <term><varname>projectnumber</varname></term>
5501 <para>Projektnummer</para>
5506 <term><varname>projectdescription</varname></term>
5509 <para>Projektbeschreibung</para>
5514 <term><varname>qty</varname></term>
5522 <term><varname>reqdate</varname></term>
5525 <para>Lieferdatum</para>
5530 <term><varname>runningnumber</varname></term>
5533 <para>Position auf der Rechnung (1, 2, 3...)</para>
5538 <term><varname>sellprice</varname></term>
5541 <para>Verkaufspreis</para>
5546 <term><varname>serialnumber</varname></term>
5549 <para>Seriennummer</para>
5554 <term><varname>tax_rate</varname></term>
5557 <para>Steuersatz</para>
5562 <term><varname>transdate_do</varname></term>
5565 <para>Datum des Lieferscheins, wenn die Rechnung im Rahmen des
5566 Workflows aus einem Lieferschein stammte.</para>
5571 <term><varname>transdate_oe</varname></term>
5574 <para>Datum des Auftrags, wenn die Rechnung im Rahmen des
5575 Workflows aus einem Auftrag erstellt wurde. Wenn es
5576 Sammelaufträge gab wird das Datum des ursprünglichen Auftrags
5582 <term><varname>transdate_quo</varname></term>
5585 <para>Datum des Angebots, wenn die Position im Rahmen des
5586 Workflows aus einem Angebot stammte.</para>
5591 <term><varname>unit</varname></term>
5594 <para>Einheit</para>
5599 <term><varname>weight</varname></term>
5602 <para>Gewicht</para>
5607 <para>Für jeden Posten gibt es ein Unterarray mit den Informationen
5608 über Lieferanten und Lieferantenartikelnummer. Diese müssen mit
5609 einer <function>foreach</function>-Schleife ausgegeben werden, da
5610 für jeden Artikel mehrere Lieferanteninformationen hinterlegt sein
5611 können. Die Variablen dafür lauten:</para>
5615 <term><varname>make</varname></term>
5618 <para>Lieferant</para>
5623 <term><varname>model</varname></term>
5626 <para>Lieferantenartikelnummer</para>
5632 <sect3 id="dokumentenvorlagen-und-variablen.invoice-zahlungen">
5633 <title>Variablen für die einzelnen Zahlungseingänge</title>
5637 <term><varname>payment</varname></term>
5645 <term><varname>paymentaccount</varname></term>
5653 <term><varname>paymentdate</varname></term>
5661 <term><varname>paymentmemo</varname></term>
5669 <term><varname>paymentsource</varname></term>
5678 <sect3 id="dokumentenvorlagen-und-variablen.benutzerdefinierte-variablen-vc">
5679 <title>Benutzerdefinierte Kunden- und Lieferantenvariablen</title>
5681 <para>Die vom Benutzer definierten Variablen für Kunden und
5682 Lieferanten stehen beim Ausdruck von Einkaufs- und Verkaufsbelegen
5683 ebenfalls zur Verfügung. Ihre Namen setzen sich aus dem Präfix
5684 <varname>vc_cvar_</varname> und dem vom Benutzer festgelegten
5685 Variablennamen zusammen.</para>
5687 <para>Beispiel: Der Benutzer hat eine Variable namens
5688 <varname>number_of_employees</varname> definiert, die die Anzahl der
5689 Mitarbeiter des Unternehmens enthält. Diese Variable steht dann
5690 unter dem Namen <varname>vc_cvar_number_of_employees</varname> zur
5693 <para>Die benutzerdefinierten Variablen der Lieferadressen stehen
5694 unter einem ähnlichen Namensschema zur Verfügung. Hier lautet der
5695 Präfix <varname>shiptocvar_</varname>.</para>
5697 <para>Analog stehen die benutzerdefinierten Variablen für
5698 Ansprechpersonen mit dem Namenspräfix <varname>cp_cvar_</varname>
5699 zur Verfügung.</para>
5703 <sect2 id="dokumentenvorlagen-und-variablen.dunning">
5704 <title>Variablen in Mahnungen und Rechnungen über Mahngebühren</title>
5706 <sect3 id="dokumentenvorlagen-und-variablen.dunning-vorlagennamen">
5707 <title>Namen der Vorlagen</title>
5709 <para>Die Namen der Vorlagen werden im System-Menü vom Benutzer
5710 eingegeben. Wird für ein Mahnlevel die Option zur automatischen
5711 Erstellung einer Rechnung über die Mahngebühren und Zinsen
5712 aktiviert, so wird der Name der Vorlage für diese Rechnung aus dem
5713 Vorlagenname für diese Mahnstufe mit dem Zusatz
5714 <constant>_invoice</constant> gebildet. Weiterhin werden die Kürzel
5715 für die ausgewählte Sprache und den ausgewählten Drucker
5719 <sect3 id="dokumentenvorlagen-und-variablen.dunning-allgemein">
5720 <title>Allgemeine Variablen in Mahnungen</title>
5722 <para>Die Variablen des Bearbeiters, bzw. Verkäufers stehen wie
5723 gewohnt als <varname>employee_...</varname> bzw.
5724 <varname>salesman_...</varname> zur Verfügung. Werden mehrere
5725 Rechnungen in einer Mahnung zusammengefasst, so werden die Metadaten
5726 (Bearbeiter, Abteilung, etc) der ersten angemahnten Rechnung im
5727 Ausdruck genommen.</para>
5729 <para>Die Adressdaten des Kunden stehen als Variablen
5730 <varname>name</varname>, <varname>street</varname>,
5731 <varname>zipcode</varname>, <varname>city</varname>,
5732 <varname>country</varname>, <varname>department_1</varname>,
5733 <varname>department_2</varname>, und <varname>email</varname> zur
5734 Verfügung. Der Ansprechpartner <varname>cp_...</varname> steht auch
5735 zu Verfügung, wird allerdings auch nur von der ersten angemahnten
5736 Rechnung (s.o.) genommen.</para>
5738 <para>Weitere Variablen beinhalten:</para>
5742 <term><varname>dunning_date</varname></term>
5745 <para>Datum der Mahnung</para>
5750 <term><varname>dunning_duedate</varname></term>
5753 <para>Fälligkeitsdatum für diese Mahhnung</para>
5758 <term><varname>dunning_id</varname></term>
5761 <para>Mahnungsnummer</para>
5766 <term><varname>fee</varname></term>
5769 <para>Kumulative Mahngebühren</para>
5774 <term><varname>interest_rate</varname></term>
5777 <para>Zinssatz per anno in Prozent</para>
5782 <term><varname>total_amount</varname></term>
5785 <para>Gesamter noch zu zahlender Betrag als
5786 <function>fee</function> + <function>total_interest</function>
5787 + <function>total_open_amount</function></para>
5792 <term><varname>total_interest</varname></term>
5795 <para>Zinsen per anno über alle Rechnungen</para>
5800 <term><varname>total_open_amount</varname></term>
5803 <para>Summe über alle offene Beträge der Rechnungen</para>
5809 <sect3 id="dokumentenvorlagen-und-variablen.dunning-details">
5810 <title>Variablen für jede gemahnte Rechnung in einer Mahnung</title>
5814 <term><varname>dn_amount</varname></term>
5817 <para>Rechnungssumme (brutto)</para>
5822 <term><varname>dn_duedate</varname></term>
5825 <para>Originales Fälligkeitsdatum der Rechnung</para>
5830 <term><varname>dn_dunning_date</varname></term>
5833 <para>Datum der Mahnung</para>
5838 <term><varname>dn_dunning_duedate</varname></term>
5841 <para>Fälligkeitsdatum der Mahnung</para>
5846 <term><varname>dn_fee</varname></term>
5849 <para>Kummulative Mahngebühr</para>
5854 <term><varname>dn_interest</varname></term>
5857 <para>Zinsen per anno für diese Rechnung</para>
5862 <term><varname>dn_invnumber</varname></term>
5865 <para>Rechnungsnummer</para>
5870 <term><varname>dn_linetotal</varname></term>
5873 <para>Noch zu zahlender Betrag (ergibt sich aus
5874 <varname>dn_open_amount</varname> + <varname>dn_fee</varname>
5875 + <varname>dn_interest</varname>)</para>
5880 <term><varname>dn_netamount</varname></term>
5883 <para>Rechnungssumme (netto)</para>
5888 <term><varname>dn_open_amount</varname></term>
5891 <para>Offener Rechnungsbetrag</para>
5896 <term><varname>dn_ordnumber</varname></term>
5899 <para>Bestellnummer</para>
5904 <term><varname>dn_transdate</varname></term>
5907 <para>Rechnungsdatum</para>
5912 <term><varname>dn_curr</varname></term>
5915 <para>Währung, in der die Rechnung erstellt wurde. (Die
5916 Rechnungsbeträge sind aber immer in der Hauptwährung)</para>
5922 <sect3 id="dokumentenvorlagen-und-variablen.dunning-invoice">
5923 <title>Variablen in automatisch erzeugten Rechnungen über
5924 Mahngebühren</title>
5926 <para>Die Variablen des Verkäufers stehen wie gewohnt als
5927 <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
5928 Kunden stehen als Variablen <varname>name</varname>,
5929 <varname>street</varname>, <varname>zipcode</varname>,
5930 <varname>city</varname>, <varname>country</varname>,
5931 <varname>department_1</varname>, <varname>department_2</varname>,
5932 und <varname>email</varname> zur Verfügung.</para>
5934 <para>Weitere Variablen beinhalten:</para>
5938 <term><varname>duedate</varname></term>
5941 <para>Fälligkeitsdatum der Rechnung</para>
5946 <term><varname>dunning_id</varname></term>
5949 <para>Mahnungsnummer</para>
5954 <term><varname>fee</varname></term>
5957 <para>Mahngebühren</para>
5962 <term><varname>interest</varname></term>
5970 <term><varname>invamount</varname></term>
5973 <para>Rechnungssumme (ergibt sich aus <varname>fee</varname> +
5974 <varname>interest</varname>)</para>
5979 <term><varname>invdate</varname></term>
5982 <para>Rechnungsdatum</para>
5987 <term><varname>invnumber</varname></term>
5990 <para>Rechnungsnummer</para>
5997 <sect2 id="dokumentenvorlagen-und-variablen.andere-vorlagen">
5998 <title>Variablen in anderen Vorlagen</title>
6001 <title>Einführung</title>
6003 <para>Die Variablen in anderen Vorlagen sind ähnlich wie in der
6004 Rechnung. Allerdings heißen die Variablen, die mit
6005 <varname>inv</varname> beginnen, jetzt anders. Bei den Angeboten
6006 fangen sie mit <varname>quo</varname> für "quotation" an:
6007 <varname>quodate</varname> für Angebotsdatum etc. Bei Bestellungen
6008 wiederum fangen sie mit <varname>ord</varname> für "order" an:
6009 <varname>ordnumber</varname> für Bestellnummer etc.</para>
6011 <para>Manche Variablen sind in anderen Vorlagen hingegen gar nicht
6012 vorhanden wie z.B. die für bereits verbuchte Zahlungseingänge. Dies
6013 sind Variablen, die vom Geschäftsablauf her in der entsprechenden
6014 Vorlage keine Bedeutung haben oder noch nicht belegt sein
6017 <para>Im Folgenden werden nur wichtige Unterschiede zu den Variablen
6018 in Rechnungen aufgeführt.</para>
6021 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-quotations">
6022 <title>Angebote und Preisanfragen</title>
6026 <term><varname>quonumber</varname></term>
6029 <para>Angebots- bzw. Anfragenummer</para>
6034 <term><varname>reqdate</varname></term>
6037 <para>Gültigkeitsdatum (bei Angeboten) bzw. Lieferdatum (bei
6038 Preisanfragen)</para>
6043 <term><varname>transdate</varname></term>
6046 <para>Angebots- bzw. Anfragedatum</para>
6052 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-orders">
6053 <title>Auftragsbestätigungen und Lieferantenaufträge</title>
6057 <term><varname>ordnumber</varname></term>
6060 <para>Auftragsnummer</para>
6065 <term><varname>reqdate</varname></term>
6068 <para>Lieferdatum</para>
6073 <term><varname>transdate</varname></term>
6076 <para>Auftragsdatum</para>
6082 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-delivery-orders">
6083 <title>Lieferscheine (Verkauf und Einkauf)</title>
6087 <term><varname>cusordnumber</varname></term>
6090 <para>Bestellnummer des Kunden (im Verkauf) bzw. Bestellnummer
6091 des Lieferanten (im Einkauf)</para>
6096 <term><varname>donumber</varname></term>
6099 <para>Lieferscheinnummer</para>
6104 <term><varname>transdate</varname></term>
6107 <para>Lieferscheindatum</para>
6112 <para>Für jede Position eines Lieferscheines gibt es ein Unterarray
6113 mit den Informationen darüber, von welchem Lager und Lagerplatz aus
6114 die Waren verschickt wurden (Verkaufslieferscheine) bzw. auf welchen
6115 Lagerplatz sie eingelagert wurden. Diese müssen mittels einer
6116 <function>foreach</function>-Schleife ausgegeben werden. Diese
6117 Variablen sind:</para>
6121 <term><varname>si_bin</varname></term>
6124 <para>Lagerplatz</para>
6129 <term><varname>si_chargenumber</varname></term>
6132 <para>Chargennummer</para>
6137 <term><varname>si_bestbefore</varname></term>
6140 <para>Mindesthaltbarkeit</para>
6145 <term><varname>si_number</varname></term>
6148 <para>Artikelnummer</para>
6153 <term><varname>si_qty</varname></term>
6156 <para>Anzahl bzw. Menge</para>
6161 <term><varname>si_runningnumber</varname></term>
6164 <para>Positionsnummer (1, 2, 3 etc)</para>
6169 <term><varname>si_unit</varname></term>
6172 <para>Einheit</para>
6177 <term><varname>si_warehouse</varname></term>
6186 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-statement">
6187 <title>Variablen für Sammelrechnung</title>
6191 <term><varname>c0total</varname></term>
6194 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit < 30
6200 <term><varname>c30total</varname></term>
6203 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 30
6204 und < 60 Tage</para>
6209 <term><varname>c60total</varname></term>
6212 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 60
6213 und < 90 Tage</para>
6218 <term><varname>c90total</varname></term>
6221 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 90
6227 <term><varname>total</varname></term>
6230 <para>Gesamtbetrag aller Rechnungen</para>
6235 <para>Variablen für jede Rechnungsposition in Sammelrechnung:</para>
6239 <term><varname>invnumber</varname></term>
6242 <para>Rechnungsnummer</para>
6247 <term><varname>invdate</varname></term>
6250 <para>Rechnungsdatum</para>
6255 <term><varname>duedate</varname></term>
6258 <para>Fälligkeitsdatum</para>
6263 <term><varname>amount</varname></term>
6266 <para>Summe der Rechnung</para>
6271 <term><varname>open</varname></term>
6274 <para>Noch offener Betrag der Rechnung</para>
6279 <term><varname>c0</varname></term>
6282 <para>Noch offener Rechnungsbetrag mit Fälligkeit < 30
6288 <term><varname>c30</varname></term>
6291 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 30 und
6297 <term><varname>c60</varname></term>
6300 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 60 und
6306 <term><varname>c90</varname></term>
6309 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 90
6317 <sect2 id="dokumentenvorlagen-und-variablen.bloecke">
6318 <title>Blöcke, bedingte Anweisungen und Schleifen</title>
6320 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.einfuehrung">
6321 <title>Einführung</title>
6323 <para>Der Parser kennt neben den Variablen einige weitere
6324 Konstrukte, die gesondert behandelt werden. Diese sind wie
6325 Variablennamen in spezieller Weise markiert:
6326 <command><%anweisung%> ... <%end%></command></para>
6328 <para>Anmerkung zum <command><%end%></command>: Der besseren
6329 Verständlichkeit halber kann man nach dem <command>end</command>
6330 noch beliebig weitere Wörter schreiben, um so zu markieren, welche
6331 Anweisung (z.B. <command>if</command> oder
6332 <command>foreach</command>) damit abgeschlossen wird.</para>
6334 <para>Beispiel: Lautet der Beginn eines Blockes z.B.
6335 <command><%if type == "sales_quotation"%></command>, so könnte
6336 er mit <command><%end%></command> genauso abgeschlossen werden
6337 wie mit <command><%end if%></command> oder auch
6338 <command><%end type == "sales_quotation"%></command>.</para>
6341 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.if">
6342 <title>Der if-Block</title>
6344 <programlisting><%if variablenname%>
6346 <%end%></programlisting>
6348 <para>Eine normale "if-then"-Bedingung. Die Zeilen zwischen dem "if"
6349 und dem "end" werden nur ausgegeben, wenn die Variable
6350 <varname>variablenname</varname> gesetzt und ungleich 0 ist.</para>
6352 <para>Handelt es sich bei der benannten Variable um ein Array, also
6353 um einen Variablennamen, über den man mit <command><%foreach
6354 variablenname%></command> iteriert, so wird mit diesem Konstrukt
6355 darauf getestet, ob das Array Elemente enthält. Somit würde im
6356 folgenden Beispiel nur dann eine Liste von Zahlungseingängen samt
6357 ihrer Überschrift "Zahlungseingänge" ausgegeben, wenn tatsächlich
6358 welche getätigt wurden:</para>
6360 <programlisting><%if payment%>
6362 <%foreach payment%>
6363 Am <%paymentdate%>: <%payment%> €
6364 <%end foreach%>
6365 <%end if%></programlisting>
6367 <para>Die Bedingung kann auch negiert werden, indem das Wort
6368 <function>not</function> nach dem <filename>if</filename> verwendet
6369 wird. Beispiel:</para>
6371 <programlisting><%if not cp_greeting%>
6373 <%end%></programlisting>
6375 <para>Zusätzlich zu dem einfachen Test, ob eine Variable gesetzt ist
6376 oder nicht, bietet dieser Block auch die Möglichkeit, den Inhalt
6377 einer Variablen mit einer festen Zeichenkette oder einer anderen
6378 Variablen zu vergleichen. Ob der Vergleich mit einer Zeichenkette
6379 oder einer anderen Variablen vorgenommen wird, hängt davon ab, ob
6380 die rechte Seite des Vergleichsoperators in Anführungszeichen
6381 gesetzt wird (Vergleich mit Zeichenkette) oder nicht (Vergleich mit
6382 anderer Variablen). Zwei Beispiele, die beide Vergleiche
6385 <programlisting><%if var1 == "Wert"%></programlisting>
6387 <para>Testet die Variable <varname>var1</varname> auf
6388 übereinstimmung mit der Zeichenkette <constant>Wert</constant>.
6389 Mittels <function>!=</function> anstelle von <function>==</function>
6390 würde auf Ungleichheit getestet.</para>
6392 <programlisting><%if var1 == var2%></programlisting>
6394 <para>Testet die Variable <varname>var1</varname> auf
6395 übereinstimmung mit der Variablen <varname>var2</varname>. Mittel
6396 <function>!=</function> anstelle von <function>==</function> würde
6397 auf Ungleichheit getestet.</para>
6399 <para>Erfahrere Benutzer können neben der Tests auf (Un-)Gleichheit
6400 auch Tests auf Übereinstimmung mit regulären Ausdrücken ohne
6401 Berücksichtung der Groß- und Kleinschreibung durchführen. Dazu dient
6402 dieselbe Syntax wie oben nur mit <function>=~</function> und
6403 <function>!~</function> als Vergleichsoperatoren.</para>
6405 <para>Beispiel für einen Test, ob die Variable
6406 <varname>intnotes</varname> (interne Bemerkungen) das Wort
6407 <constant>schwierig</constant> enthält:</para>
6409 <programlisting><%if intnotes =~ "schwierig"%></programlisting>
6412 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.foreach">
6413 <title>Der foreach-Block</title>
6415 <programlisting><%foreach variablenname%>
6417 <%end%></programlisting>
6419 <para>Fügt die Zeilen zwischen den beiden Anweisungen so oft ein,
6420 wie das Perl-Array der Variablen <varname>variablenname</varname>
6421 Elemente enthät. Dieses Konstrukt wird zur Ausgabe der einzelnen
6422 Posten einer Rechnung / eines Angebots sowie zur Ausgabe der Steuern
6423 benutzt. In jedem Durchlauf werden die <link
6424 linkend="dokumentenvorlagen-und-variablen.invoice-posten">zeilenbezogenen
6425 Variablen</link> jeweils auf den Wert für die aktuelle Position
6428 <para>Die Syntax sieht normalerweise wie folgt aus:</para>
6430 <programlisting><%foreach number%>
6431 Position: <%runningnumber%>
6432 Anzahl: <%qty%>
6433 Artikelnummer: <%number%>
6434 Beschreibung: <%description%>
6436 <%end%></programlisting>
6438 <para>Besonderheit in OpenDocument-Vorlagen: Tritt ein
6439 <function><%foreach%></function>-Block innerhalb einer
6440 Tabellenzelle auf, so wird die komplette Tabellenzeile so oft
6441 wiederholt wie notwendig. Tritt er außerhalb auf, so wird nur der
6442 Inhalt zwischen <function><%foreach%></function> und
6443 <function><%end%></function> wiederholt, nicht aber die
6444 komplette Zeile, in der er steht.</para>
6448 <sect2 id="dokumentenvorlagen-und-variablen.markup">
6449 <title>Markup-Code zur Textformatierung innerhalb von
6452 <para>Wenn der Benutzer innhalb von Formularen in kivitendo Text
6453 anders formatiert haben möchte, so ist dies begrenzt möglich.
6454 kivitendo unterstützt die Textformatierung mit HTML-ähnlichen Tags.
6455 Der Benutzer kann z.B. bei der Artikelbeschreibung auf einer Rechnung
6456 Teile des Texts zwischen Start- und Endtags setzen. Dieser Teil wird
6457 dann automatisch in Anweisungen für das ausgewählte Vorlagenformat
6458 (HTML oder PDF über LaTeX) umgesetzt.</para>
6460 <para>Die unterstützen Formatierungen sind:</para>
6464 <term><b>Text</b></term>
6467 <para>Text wird in Fettdruck gesetzt.</para>
6472 <term><i>Text</i></term>
6475 <para>Text wird kursiv gesetzt.</para>
6480 <term><u>Text</u></term>
6483 <para>Text wird unterstrichen.</para>
6488 <term><s>Text</s></term>
6491 <para>Text wird durchgestrichen. Diese Formatierung ist nicht
6492 bei der Ausgabe als PDF über LaTeX verfügbar.</para>
6497 <term><bullet></term>
6500 <para>Erzeugt einen ausgefüllten Kreis für Aufzählungen (siehe
6506 <para>Der Befehl <command><bullet></command> funktioniert
6507 momentan auch nur in Latex-Vorlagen.</para>
6510 <sect2 id="dokumentenvorlagen-und-variablen.anrede"
6511 xreflabel="Hinweise zur Anrede">
6512 <title>Hinweise zur Anrede</title>
6514 <para>Das Flag "natürliche Person"
6515 (<varname>natural_person</varname>) aus den Kunden- oder
6516 Lieferantenstammdaten kann in den Druckvorlagen zusammen mit
6517 dem Feld "Anrede" (<varname>greeting</varname>) z.B. dafür
6518 verwendet werden, die Anrede zwischen einer allgemeinen und
6519 einer persönlichen Anrede zu unterscheiden.
6520 <programlisting><%if natural_person%><%greeting%> <%name%><%else%>Sehr geehrte Damen und Herren<%end if%></programlisting>
6526 <sect1 id="excel-templates">
6527 <title>Excel-Vorlagen</title>
6529 <sect2 id="excel-templates.summary">
6530 <title>Zusammenfassung</title>
6532 <para>Dieses Dokument beschreibt den Mechanismus, mit dem
6533 Exceltemplates abgearbeitet werden, und die Einschränkungen, die damit
6537 <sect2 id="excel-templates.usage">
6538 <title>Bedienung</title>
6540 <para>Der Excel Mechanismus muss in der Konfigurationsdatei aktiviert
6541 werden. Die Konfigurationsoption heißt <varname>excel_templates =
6542 1</varname> im Abschnitt <varname>[print_templates]</varname>.</para>
6544 <para>Eine Excelvorlage kann dann unter dem Namen einer beliebigen
6545 anderen Vorlage mit der Endung <filename>.xls</filename> gespeichert
6546 werden. In den normalen Verkaufsmasken taucht nun
6547 <constant>Excel</constant> als auswählbares Format auf und kann von da
6548 an wie LaTeX- oder OpenOffice-Vorlagen benutzt werden.</para>
6550 <para>Der Sonderfall der Angebote aus der Kundenmaske ist ebenfalls
6551 eine Angebotsvorlage und wird unter dem internen Namen der Angebote
6552 <filename>sales_quotation.xls</filename> gespeichert.</para>
6555 <sect2 id="excel-templates.syntax">
6556 <title>Variablensyntax</title>
6558 <para>Einfache Syntax:
6559 <command><<varname>></command></para>
6561 <para>Dabei sind <constant><<</constant> und
6562 <constant>>></constant> die Delimiter. Da Excel auf festen
6563 Breiten besteht, kann der Tag künstlich verlängert werden, indem
6564 weitere <constant><</constant> oder <constant>></constant>
6565 eingefügt werden. Der Tag muss nicht symmetrisch sein.
6568 <programlisting><<<<<varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
6570 <para>Um die Limitierung der festen Breite zu reduzieren, können
6571 weitere Variablen in einem Block interpoliert werden. Whitespace wird
6572 dazwishen dann erhalten. Beispiel:</para>
6574 <programlisting><<<<<varname1 varname2 varname3>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
6576 <para>Die Variablen werden interpoliert, und linksbündig mit
6577 Leerzeichen auf die gewünschte Länge aufgefüllt. Ist der String zu
6578 lang, werden überzählige Zeichen abgeschnitten.</para>
6580 <para>Es ist ausserdem möglich, Daten rechtsbündig darzustellen, wenn
6581 der Block mit einem Leerzeichen anfängt. Beispiel:</para>
6583 <programlisting><<<<<< varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
6585 <para>Dies würde rechtsbündig triggern. Wenn bei rechtsbündiger
6586 Ausrichtung Text abgeschnitten werden muss, wird er vom linken Ende
6590 <sect2 id="excel-templates.limitations">
6591 <title>Einschränkungen</title>
6593 <para>Das Excelformat bis 2002 ist ein binäres Format, und kann nicht
6594 mit vertretbarem Aufwand editiert werden. Der Templatemechanismus
6595 beschränkt sich daher darauf, Textstellen exakt durch einen anderen
6596 Text zu ersetzen.</para>
6598 <para>Aus dem gleichen Grund sind die Kontrolllstrukturen
6599 <command><%if%></command> und
6600 <command><%foreach%></command> nicht vorhanden. Der Delimiter
6601 <constant><% %></constant> kommt in den Headerinformationen
6602 evtl. vor. Deshalb wurde auf den sichereren Delimiter
6603 <constant><<</constant> und <constant>>></constant>
6608 <sect1 id="features.warehouse">
6609 <title>Mandantenkonfiguration Lager</title>
6611 <para>Die Lagerverwaltung in kivitendo funktioniert standardmässig wie
6612 folgt: Wird ein Lager mit einem Lagerplatz angelegt, so gibt es die
6613 Möglichkeit hier über den Menüpunkt Lager entsprechende Warenbewegungen
6614 durchzuführen. Ferner kann jede Position eines Lieferscheins ein-, bzw.
6615 ausgelagert werden (Einkauf-, bzw. Verkauf). Es können beliebig viele
6616 Lager mit beliebig vielen Lagerplätzen abgebildet werden. Die
6617 Lagerbewegungen über einen Lieferschein erfolgt durch Anklicken jeder
6618 Einzelposition und das Auswählen dieser Position zu einem Lager mit
6619 Lagerplatz. Dieses Verfahren lässt sich schrittweise vereinfachen, je
6620 nachdem wie die Einstellungen in der Mandatenkonfiguration gesetzt
6625 <para><option>Auslagern über Standardlagerplatz</option> Hier wird
6626 ein zusätzlicher Knopf (Auslagern über Standard-Lagerplatz) in dem
6627 Lieferschein-Beleg hinzugefügt, der dann alle Lagerbewegungen über
6628 den Standardlagerplatz (konfigurierbar pro Ware) durchführt.</para>
6632 <para><option>Auslagern ohne Bestandsprüfung</option> Das obige
6633 Auslagern schlägt fehl, wenn die entsprechende Menge für die
6634 Lagerbewegung nicht vorhanden ist, möchte man dies auch ignorieren
6635 und ggf. dann nachpflegen, so kann man eine Negativ-Warenmenge mit
6636 dieser Option erlauben. Hierfür muss ein entsprechender Lagerplatz
6637 (Fehlbestand, o.ä.) konfiguriert sein.</para>
6641 <para>Zusätzliche Funktionshinweise:</para>
6645 <para><option>Standard-Lagerplatz</option> Ist dieser konfiguriert,
6646 wird dies auch als Standard-Voreinstellung bei der Neuerfassung von
6647 Stammdaten → Waren / Dienstleistung / Erzeugnis verwendet.</para>
6651 <para><option>Standard-Lagerplatz verwenden, falls keiner in
6652 Stammdaten definiert</option> Wird beim 'Auslagern über
6653 Standardlagerplatz' keine Standardlagerplatz zu der Ware gefunden,
6654 so wird mit dieser Option einfach der Standardlagerplatz
6660 <sect1 id="features.swiss-charts-of-accounts">
6661 <title>Schweizer Kontenpläne</title>
6663 <para>Seit der Version 3.5 stehen in kivitendo 3 Kontenpläne für den
6664 Einsatz in der Schweiz zur Verfügung, einer für Firmen und
6665 Organisationen, die nicht mehrwertsteuerpflichtig sind, einer für
6666 Firmen, die mehrwertsteuerpflichtig sind und einer speziell für
6669 <para>Die Kontenpläne orientieren sich am in der Schweiz üblicherweise
6670 verwendeten KMU-Kontenrahmen und sind mit der Revision des
6671 Schweizerischen Obligationenrechts (OR) vom 1.1.2013 kompatibel,
6672 insbesondere <literal>Art.957a Abs.2</literal>.</para>
6674 <para>Beim Vereinskontenplan sind standardmässig nur die Konten 1100
6675 (Debitoren CHF) und 1101 (Debitoren EUR) als Buchungskonten im Verkauf
6676 sowie die Konten 2000 (Kreditoren CHF) und 2001 (Kreditoren EUR) als
6677 Buchungskonten im Einkauf vorgesehen. Weitere Konten können bei Bedarf
6678 in den Konto-Detaileinstellungen als Einkaufs- oder Verkaufskonten
6679 konfiguriert werden.</para>
6681 <para>Die Möglichkeit, Saldosteuersätze zu verwenden ist in der
6682 aktuellen Version von kivitendo noch nicht integriert.</para>
6684 <para>Trotzdem können auch Firmen, die per Saldosteuersatz mit der
6685 Eidgenössischen Steuerverwaltung abrechnen, kivitendo bereits nutzen.
6686 Dazu wird der Kontenplan mit MWST ausgewählt. Anschliessend müssen alle
6687 Aufwandskonten editiert werden und dort der Steuersatz auf 0% gesetzt
6690 <para>So werden bei Kreditorenbuchungen keine Vorsteuern
6693 <para>Bezugssteuern für aus dem Ausland bezogene Dienstleistungen müssen
6694 manuell verbucht werden.</para>
6696 <para>Wünsche für Anpassungen an den Schweizer Kontenplänen sowie
6697 Vorschläge für weitere (z.B. branchenspezifische) Kontenpläne bitte an
6698 <literal>empfang@revamp-it.ch</literal> senden.</para>
6701 <sect1 id="features.part_classification">
6702 <title>Artikelklassifizierung</title>
6705 <title>Übersicht</title>
6707 <para>Die Klassifizierung von Artikeln dient einer weiteren
6708 Gliederung, um zum Beispiel den Einkauf vom Verkauf zu trennen,
6709 gekennzeichnet durch eine Beschreibung (z.B. "Einkauf") und ein Kürzel
6710 (z.B. "E"). Für jede Klassifizierung besteht eine Beschreibung und
6711 eine Abkürzung die normalerweise aus einem Zeichen besteht, kann aber
6712 auf mehrere Zeichen erweitert werden, falls zur Unterscheidung
6713 notwendig. Sinnvoll sind jedoch nur maximal 2 Zeichen.</para>
6717 <title>Basisklassifizierung</title>
6719 <para>Als Basisklassifizierungen gibt es</para>
6723 <para>Einkauf</para>
6727 <para>Verkauf</para>
6731 <para>Handelsware</para>
6735 <para>Produktion</para>
6739 <para>- keine - (diese wird bei einer Aktualisierung für alle
6740 existierenden Artikel verwendet und ist gültig für Verkauf und
6745 <para>Es können weitere Klassifizierungen angelegt werden. So kann es
6746 z.B. für separat auszuweisende Artikel folgende Klassen geben:</para>
6750 <para>Lieferung (Logistik, Transport) mit Kürzel L</para>
6754 <para>Material (Verpackungsmaterial) mit Kürzel M</para>
6760 <title>Attribute</title>
6762 <para>Bisher haben die Klassifizierungen folgende Attribute, die auch
6763 alle gleichzeitg gültig sein können</para>
6767 <para>gültig für Verkauf - dieser Artikel kann im Verkauf genutzt
6772 <para>gültig für Einkauf - dieser Artikel kann im Einkauf genutzt
6777 <para>separat ausweisen - hierzu gibt es zur Dokumentengenerierung
6778 (LaTeX) eine zusätzliche Variable</para>
6782 <para>Für das Attribut "separat ausweisen" stehen in den
6783 LaTeX-Vorlagen die Variable <emphasis
6784 role="bold"><%non_separate_subtotal%> </emphasis>zur Verfügung,
6785 die alle nicht separat auszuweisenden Artikelkosten saldiert, sowie
6786 pro separat auszuweisenden Klassifizierungen die Variable<emphasis
6787 role="bold">< %separate_X_subtotal%></emphasis>, wobei X das
6788 Kürzel der Klassifizierung ist.</para>
6790 <para>Im obigen Beispiel wäre das für Lieferkosten <emphasis
6791 role="bold"><%separate_L_subtotal%></emphasis> und für
6792 Verpackungsmaterial <emphasis role="bold">
6793 <%separate_M_subtotal%></emphasis>.</para>
6797 <title>Zwei-Zeichen Abkürzung</title>
6799 <para>Der Typ des Artikels und die Klassifizierung werden durch zwei
6800 Buchstaben dargestellt. Der erste Buchstabe ist eine Lokalisierung des
6801 Artikel-Typs ('P','A','S'), deutsch 'W', 'E', und 'D' für Ware
6802 Erzeugnis oder Dienstleistung und ggf. weiterer Typen.</para>
6804 <para>Der zweite Buchstabe (und ggf. auch ein dritter, falls nötig)
6805 entspricht der lokalisierten Abkürzung der Klassifizierung.</para>
6807 <para>Diese Abkürzung wird überall beim Auflisten von Artikeln zur
6808 Erleichterung mit dargestellt.</para>
6812 <sect1 id="features.file_managment">
6813 <title>Dateiverwaltung (Mini-DMS)</title>
6816 <title>Übersicht</title>
6818 <para>Parallel zum alten WebDAV gibt es ein Datei-Management-System,
6819 das Dateien verschiedenen Typs verwaltet. Dies können</para>
6823 <para>aus ERP-Daten per LaTeX Template erzeugte
6824 PDF-Dokumente,</para>
6828 <para>zu bestimmten ERP-Daten gehörende Anhangdateien
6829 unterschiedlichen Formats,</para>
6833 <para>per Scanner eingelesene PDF-Dateien,</para>
6837 <para>per E-Mail empfangene Dateianhänge unterschiedlichen
6842 <para>sowie speziel für Artikel hochgeladene Bilder sein.</para>
6847 <screeninfo>Übersicht</screeninfo>
6851 <imagedata contentwidth="600" fileref="images/DMS-Overview.png"/>
6858 <title>Struktur</title>
6860 <para>Über eine vom Speichermedium unabhängige Zwischenschicht werden
6861 die Dateien und ihre Versionen in der Datenbank verwaltet. Darunter
6862 können verschiedene Implementierungen (Backends) gleichzeitig
6867 <para>Dateisystem</para>
6875 <para>Schnittstelle zu externen
6876 Dokumenten-Management-Systemen</para>
6880 <para>andere Datenbank</para>
6884 <para>etc ...</para>
6888 <para>Es gibt unterschiedliche Typen von Dateien. Jedem Typ läßt sich
6889 in der Mandantenkonfiguration ein bestimmtes Backend zuordnen.</para>
6893 <para>"document": Das sind entweder generierte, eingescannte oder
6894 hochgeladene PDF-Dateien, die zu bestimmten ERP-Daten
6895 (ERP-Objekte, wie z.B. Rechnung, Lieferschein) gehören.</para>
6899 <para>"attachment": zusätzlich hochgeladene Dokumente, die an
6900 bestimmte ERP-Objekte angehängt werden, z.B. technische
6901 Zeichnungen, Aufmaße. Diese können auch für Artikel, Lieferanten
6902 und Kunden hinterlegt sein.</para>
6906 <para>"image": Bilder für Artikel. Diese können auch verkleinert
6907 in einer Vorschau (Thumbnail) angezeigt werden.</para>
6911 <para>Zusätzlich werden in der Datenbank zu den Dateien neben der
6912 Zuordnung zu ERP-Objekten, Dateityp Dateinamen und Backend, in dem die
6913 Datei gespeichert ist, auch die Quelle der Datei notiert:</para>
6917 <para>"created": vom System erzeugte Dokumente"</para>
6921 <para>"uploaded": hochgeladene Dokumente</para>
6925 <para>"email": vom Mail-System empfangene Dateien</para>
6929 <para>"scanner[1]": von einem oder mehreren Scannern erzeugte
6930 Dateien. Existieren mehrere Scanner, so sind diese durch
6931 unterschiedliche Quellennamen zu definieren.</para>
6935 <para>Je nach Dateityp sind nur bestimmte Quellen zulässig. So gibt es
6936 für "attachment" und "image" nur die Quelle "uploaded". Für "document"
6937 gibt es auf jeden Fall die Quelle "created". Die Quellen "scanner" und
6938 "email" müssen derzeit in der Datenbank konfiguriert werden (siehe
6939 <xref linkend="file_management.dbconfig"/>).</para>
6943 <title>Anwendung</title>
6945 <para>Die Daten werden bei den ERP-Objekten als extra Reiter
6946 dargestellt. Eine Verkaufsrechnung z.B. hat die Reiter "Dokumente" und
6947 "Dateianhänge".</para>
6950 <screeninfo>Reiter "Dateianhänge"</screeninfo>
6954 <imagedata fileref="images/DMS-Anhaenge.png" scale="50"/>
6959 <para>Bei den Dateianhängen wird immer nur die aktuelle Version einer
6960 Datei angezeigt. Wird eine Datei mit gleichem Namen hochgeladen, so
6961 wird eine neue Version der Datei erstellt. Vorher wird der Anwender
6962 durch einen Dialog gefragt, ob er eine neue Version anlegen will oder
6963 ob er die Datei umbenennen will, falls es eine neue Datei sein
6967 <screeninfo>Reiter "Dateianhänge"</screeninfo>
6971 <imagedata contentwidth="40"
6972 fileref="images/DMS-Anhaenge-hochladen.png"
6978 <para>Es können mehrere Dateien gleichzeitig hochgeladen werden,
6979 solange in Summe die maximale Größe nicht überschritten wird (siehe
6980 <xref linkend="file_management.clientconfig"/>).</para>
6983 <screeninfo>Reiter "Dokumente"</screeninfo>
6987 <imagedata fileref="images/DMS-Dokumente.png" width="500"/>
6992 <para>Sind keine weiteren Quellen für Dokumente konfiguriert, so gibt
6993 es nur "erzeugte Dokumente". Es werden alle Versionen der generierten
6994 Datei angezeigt. Für Verkaufsrechnungen kommen keine anderen Quellen
6995 zur Geltung. Werden entsprechend der <xref
6996 linkend="file_management.dbconfig"/> zusätzliche Quellen konfiguriert,
6997 so sind diese z.B. bei Einkaufsrechnungen sichtbar:</para>
7000 <screeninfo>Reiter "Dokumente"</screeninfo>
7004 <imagedata contentwidth="600"
7005 fileref="images/DMS-Dokumente-Scanner.png"/>
7010 <para>Statt des Löschens wird hier die Datei zurück zur Quelle
7011 verschoben. Somit kann die Datei anschließend an ein anderes
7012 ERP-Objekt angehängt werden.</para>
7014 <para>Derzeit sind "Titel" und "Beschreibung" noch nicht genutzt. Sie
7015 sind bisher nur bei Bildern relevant.</para>
7019 <title>Konfigurierung</title>
7021 <sect3 id="file_management.clientconfig"
7022 xreflabel="Mandantenkonfigurierung">
7023 <title>Mandantenkonfiguration</title>
7026 <title>Reiter "Features"</title>
7028 <para>Unter dem Reiter <emphasis role="bold">Features</emphasis>
7029 im Abschnitt Dateimanagement ist neben dem "alten" WebDAV das
7030 Dateimangement generell zu- und abschaltbar, sowie die Zuordnung
7031 der Dateitypen zu Backends. Die Löschbarkeit von Dateien, sowie
7032 die maximale Uploadgröße sind Backend-unabhängig</para>
7035 <screeninfo>Mandantenkonfig Reiter "Features"</screeninfo>
7039 <imagedata fileref="images/DMS-ClientConfig.png" width="500"/>
7044 <para>Die einzelnen Backends sind einzeln einschaltbar.
7045 Spezifische Backend-Konfigurierungen sind hier noch
7050 <title>Reiter "Allgemeine Dokumentenanhänge"</title>
7052 <para>Unter dem Reiter <emphasis role="bold">Allgemeine
7053 Dokumentenanhänge</emphasis> kann für alle ERP-Dokumente (
7054 Angebote, Aufträge, Lieferscheine, Rechnungen im Verkauf und
7055 Einkauf ) allgemeingültige Anhänge hochgeladen werden.</para>
7058 <screeninfo>Mandantenkonfig Reiter "Allgemeine
7059 Dokumentenanhänge"</screeninfo>
7063 <imagedata fileref="images/DMS-Allgemeine-Dokumentenanhaenge.png"
7069 <para>Diese Anhänge werden beim Generieren von PDF-Dateien an die
7070 ERP-Dokumente angehängt, z.B. AGBs oder aktuelle Angebote. Es
7071 werden in dem Fall die Daten kopiert, sodass an den ERP-Dokumenten
7072 immer die Anhänge zum Generierungszeitpunkt eingebettet
7077 <sect3 id="file_management.dbconfig"
7078 xreflabel="Datenbank-Konfigurierung">
7079 <title>Datenbank-Konfigurierung</title>
7081 <para>Die zusätzlichen Quellen für "email" oder ein oder mehrere
7082 Scanner sind derzeit vom Administrator direkt in der
7083 Datenbanktabelle "user_preferences" einzurichten. Die "value" ist im
7084 JSON-Format mit den jeweiligen Werten des Verzeichnisses und der
7085 Beschreibung der Quelle.</para>
7088 id | login | namespace | version | key | value
7089 ----+-----------+--------------+---------+----------+---------------------------
7090 1 | #default# | file_sources | 0.00000 | scanner1 |
7091 {"dir":"/var/tmp/scanner1","desc":"Scanner Einkauf"}
7092 2 | #default# | file_sources | 0.00000 | scanner2 |
7093 {"dir":"/var/tmp/scanner2","desc":"Scanner Verkauf"}
7094 3 | #default# | file_sources | 0.00000 | emails |
7095 {"dir":"/var/tmp/emails","desc":"Empfangene Mails" }
7098 <para>Es ist daran gedacht, statt dem Default-Eintrag später für
7099 bestimmte Benutzer ('login') bestimmte Quellen zuzulassen. Dies wird
7100 nach Bedarf implementiert.</para>
7103 <sect3 id="file_management.kiviconfig"
7104 xreflabel="kivitendo-Konfigurationsdatei">
7105 <title>kivitendo-Konfigurationsdatei</title>
7107 <para>Dort ist im Abschnitt [paths] der relative oder absolute Pfad
7108 zum Dokumentenwurzelverzeichnis einzutragen. Dieser muss für den
7109 Webserver schreib- und lesbar sein, jedoch nicht ausführbar.</para>
7113 document_path = /var/local/kivi_documents
7116 <para>Unter diesem Wurzelverzeichnis wird pro Mandant automatisch
7117 ein Unterverzeichnis mit der ID des Mandanten angelegt.</para>
7123 <title>Webshop-Api</title>
7125 <para>Das Shopmodul bietet die Möglichkeit Onlineshopartikel und
7126 Onlineshopbestellungen zu verwalten und zu bearbeiten.</para>
7128 <para>Es ist Multishopfähig, d.h. Artikel können mehreren oder
7129 unterschiedlichen Shops zugeordnet werden. Bestellungen können aus
7130 mehreren Shops geholt werden.</para>
7132 <para>Zur Zeit bietet das Modul nur einen Connector zur REST-Api von
7133 Shopware. Weitere Connectoren können dazu programmiert und eingerichtet
7137 <title>Rechte für die Webshopapi</title>
7139 <para>In der Administration können folgende Rechte vergeben
7144 <para>Webshopartikel anlegen und bearbeiten</para>
7148 <para>Shopbestellungen holen und bearbeiten</para>
7152 <para>Shop anlegen und bearbeiten</para>
7158 <title>Konfiguration</title>
7160 <para>Unter System->Webshops können Shops angelegt und konfiguriert
7165 <imagedata contentdepth="500" contentwidth="700"
7166 fileref="images/Shop_Listing.png"/>
7172 <title>Webshopartikel</title>
7175 <title>Shopvariablenreiter in Artikelstammdaten</title>
7177 <para>Mit dem Recht "Shopartikel anlegen und bearbeiten" und des
7178 Markers <emphasis role="bold">"Shopartikel" in den Basisdaten
7179 </emphasis>zeigt sich der Reiter "Shopvariablen" in den
7180 Artikelstammdaten. Hier können jetzt die Artikel mit
7181 unterschiedlichen Beschreibung und/oder Preisen für die
7182 konfigutierten Shops angelegt und bearbeitet werden. An dieser
7183 Stelle können auch beliebig viele Bilder dem Shopartikel zugeordnet
7184 werden. Artikelbilder gelten für alle Shops.</para>
7188 <imagedata contentdepth="500" contentwidth="600"
7189 fileref="images/Shop_Artikel.png"/>
7193 <para>Die Artikelgruppen werden direkt vom Shopsystem geholt somit
7194 ist es möglich einen Artikel auch mehreren Gruppen
7199 <title>Shopartikelliste</title>
7201 <para>Unter dem Menu Webshop->Webshop Artikel hat man nochmal
7202 eine Gesamtübersicht. Von hier aus ist es möglich Artikel im Stapel
7203 unter verschiedenen Kriterien <alles><nur Preis><nur
7204 Bestand><Preis und Bestand> an die jeweiligen Shops
7209 <imagedata fileref="images/Shop_Artikel_Listing.png"/>
7216 <title>Bestellimport</title>
7218 <para>Unter dem Menupunkt Webshop->Webshop Import öffnet sich die
7219 Bestellimportsliste. Hier ist sind Möglichkeiten gegeben Neue
7220 Bestellungen vom Shop abzuholen, geholte Bestellungen im Stapel oder
7221 einzeln als Auftrag zu transferieren. Die Liste kann nach
7222 verschiedenen Kriterien gefiltert werden.</para>
7226 <imagedata fileref="images/Shop_Bestell.png"/>
7230 <para>Bei Einträgen in der Liste.</para>
7234 <para>keine Kundennummer: Es gibt ähnliche Kundendatensätze und
7235 der Datensatz konnte nicht eindeutig zugewiesen werden.</para>
7239 <para>Kundennummer und Rechnungen rot hinterlegt: Der Kunde hat
7240 offene Posten und kann deswegen nicht im Stapel übernommen
7245 <para>Rechnungsadresse grün hinterlegt: Der Kunde konnte eindeutig
7246 einem Datensatz zugeordnet werden. Die Shopbestellung kann im
7247 Stapel mit dem Button "Anwenden" und wenn markiert als Auftrag
7248 übernommen werden.</para>
7252 <para>Kundennummer vorhanden, aber die Checkbox "Auftrag
7253 erstellen" fehlt. Der Kunde hat vermutlich eine
7254 Shopauftragssperre.</para>
7258 <para>Lieferadresse grau hinterlegt: Optische Anzeige, dass es
7259 sich um eine unterschiedliche Lieferadresse handelt.
7260 Lieferadressen werden aber grundsätzlich beim Transferieren zu
7261 Aufträgen mit übernommen.</para>
7265 <para>In der Spalte Positionen/Betrag/Versandkosten zeigt sich ein
7266 tooltip zu den Positionen.</para>
7270 <para>Maske Auftrag erstellen</para>
7272 <para>Viele Shopsysteme haben drei verschieden Adresstypen Kunden-,
7273 Rechnungs-, und Lieferadresse, die sich auch alle unterscheiden
7274 können. Diese werden im oberen Bereich angezeigt. Es ist möglich jede
7275 dieser Adresse einzeln in kivitendo als Kunde zu übernehmen. Es werden
7276 die Werte Formulareingabe übernommen. Es wird bei einer Änderung
7277 allerdings nur diese in die kivitendo Kundenstammdaten übernommen, die
7278 Shopbestellung bleibt bestehen.</para>
7280 <para>Mit der mittleren Adresse(Rechnungsadresse) im oberen Bereich,
7281 kann ich den ausgewählten kivitendodatensatz des mittleren Bereich
7282 überschreiben. Das ist sinnvoll, wenn ich erkenne, das der Kunde z.B.
7283 umgezogen ist.</para>
7285 <para>Im mittleren Bereich das Adresslisting zeigt:</para>
7289 <para>Rot hinterlegt: Kunde hat eine Shopauftragssperre, diese
7290 muss zuerst deaktiviert werden bevor ich diesem Kunden eine
7291 Shopbestellung zuordnen kann.</para>
7295 <para>Kundenname fett und rot: Hier hat der Kunde eine Bemerkung
7296 in den Stammdaten. Ein Tooltip zeigt diese Bemerkung. Das kann dan
7297 auch der Grund für die Auftragssperre sein.</para>
7301 <para>Die Buttons "Auftrag erstellen" und "Kunde mit
7302 Rechnungsadresse überschreiben" zeigen sich erst, wenn ein Kunde
7303 aus dem Listing ausgewählt ist.</para>
7307 <para>Es ist aber möglich die Shopbestellung zu löschen.</para>
7311 <para>Ist eine Bestellung schon übernommen, zeigen sich an dieser
7312 Stelle, die dazugehörigen Belegverknüpfungen.</para>
7318 <title>Mapping der Daten</title>
7320 <para>Das Mapping der kivitendo Daten mit den Shopdaten geschieht in
7321 der Datei SL/ShopConnector/<SHOPCONNECTORNAME>.pm
7322 z.B.:SL/ShopConnector/Shopware.pm</para>
7324 <para>In dieser Datei gibt es einen Bereich wo die Bestellpostionen,
7325 die Bestellkopfdaten und die Artikeldaten gemapt werden. In dieser
7326 Datei kann ein individelles Mapping dann gemacht werden. Zu Shopware
7327 gibt es hier eine sehr gute Dokumentation: <ulink
7328 url="https://developers.shopware.com/developers-guide/rest-api/">https://developers.shopware.com/developers-guide/rest-api/</ulink></para>
7334 <title>Entwicklerdokumentation</title>
7336 <sect1 id="devel.globals" xreflabel="Globale Variablen">
7337 <title>Globale Variablen</title>
7340 <title>Wie sehen globale Variablen in Perl aus?</title>
7342 <para>Globale Variablen liegen in einem speziellen namespace namens
7343 "main", der von überall erreichbar ist. Darüber hinaus sind bareword
7344 globs global und die meisten speziellen Variablen sind...
7347 <para>Daraus ergeben sich folgende Formen:</para>
7351 <term><literal>$main::form</literal></term>
7354 <para>expliziter Namespace "main"</para>
7359 <term><literal>$::form</literal></term>
7362 <para>impliziter Namespace "main"</para>
7367 <term><literal>open FILE, "file.txt"</literal></term>
7370 <para><varname>FILE</varname> ist global</para>
7375 <term><literal>$_</literal></term>
7378 <para>speziell</para>
7383 <para>Im Gegensatz zu <productname>PHP</productname> gibt es kein
7384 Schlüsselwort wie "<function>global</function>", mit dem man
7385 importieren kann. <function>my</function>, <function>our</function>
7386 und <function>local</function> machen was anderes.</para>
7390 <term><literal>my $form</literal></term>
7393 <para>lexikalische Variable, gültig bis zum Ende des
7399 <term><literal>our $form</literal></term>
7402 <para><varname>$form</varname> referenziert ab hier
7403 <varname>$PACKAGE::form</varname>.</para>
7408 <term><literal>local $form</literal></term>
7411 <para>Alle Änderungen an <varname>$form</varname> werden am Ende
7412 des scopes zurückgesetzt</para>
7419 <title>Warum sind globale Variablen ein Problem?</title>
7421 <para>Das erste Problem ist <productname>FCGI</productname>.</para>
7423 <para><productname>SQL-Ledger</productname> hat fast alles im globalen
7424 namespace abgelegt, und erwartet, dass es da auch wiederzufinden ist.
7425 Unter <productname>FCGI</productname> müssen diese Sachen aber wieder
7426 aufgeräumt werden, damit sie nicht in den nächsten Request kommen.
7427 Einige Sachen wiederum sollen nicht gelöscht werden, wie zum Beispiel
7428 Datenbankverbindungen, weil die sehr lange zum Initialisieren
7431 <para>Das zweite Problem ist <function>strict</function>. Unter
7432 <function>strict</function> werden alle Variablen die nicht explizit
7433 mit <function>Package</function>, <function>my</function> oder
7434 <function>our</function> angegeben werden als Tippfehler angemarkert,
7435 dies hat, seit der Einführung, u.a. schon so manche langwierige
7436 Bug-Suche verkürzt. Da globale Variablen aber implizit mit Package
7437 angegeben werden, werden die nicht geprüft, und somit kann sich
7438 schnell ein Tippfehler einschleichen.</para>
7442 <title>Kanonische globale Variablen</title>
7444 <para>Um dieses Problem im Griff zu halten gibt es einige wenige
7445 globale Variablen, die kanonisch sind, d.h. sie haben bestimmte
7446 vorgegebenen Eigenschaften, und alles andere sollte anderweitig
7447 umhergereicht werden.</para>
7449 <para>Diese Variablen sind im Moment die folgenden neun:</para>
7453 <para><varname>$::form</varname></para>
7457 <para><varname>%::myconfig</varname></para>
7461 <para><varname>$::locale</varname></para>
7465 <para><varname>$::lxdebug</varname></para>
7469 <para><varname>$::auth</varname></para>
7473 <para><varname>$::lx_office_conf</varname></para>
7477 <para><varname>$::instance_conf</varname></para>
7481 <para><varname>$::dispatcher</varname></para>
7485 <para><varname>$::request</varname></para>
7489 <para>Damit diese nicht erneut als Müllhalde missbraucht werden, im
7490 Folgenden eine kurze Erläuterung der bestimmten vorgegebenen
7491 Eigenschaften (Konventionen):</para>
7494 <title>$::form</title>
7498 <para>Ist ein Objekt der Klasse
7499 "<classname>Form</classname>"</para>
7503 <para>Wird nach jedem Request gelöscht</para>
7507 <para>Muss auch in Tests und Konsolenscripts vorhanden
7512 <para>Enthält am Anfang eines Requests die Requestparameter vom
7517 <para>Kann zwar intern über Requestgrenzen ein Datenbankhandle
7518 cachen, das wird aber momentan absichtlich zerstört</para>
7522 <para><varname>$::form</varname> wurde unter <productname>SQL
7523 Ledger</productname> als Gottobjekt für alles missbraucht. Sämtliche
7524 alten Funktionen unter SL/ mutieren <varname>$::form</varname>, das
7525 heißt, alles was einem lieb ist (alle Variablen die einem ans Herz
7526 gewachsen sind), sollte man vor einem Aufruf (!) von zum Beispiel
7527 <function>IS->retrieve_customer()</function> in Sicherheit
7530 <para>Z.B. das vom Benutzer eingestellte Zahlenformat, bevor man
7531 Berechnung in einem bestimmten Format durchführt (SL/Form.pm Zeile
7532 3552, Stand version 2.7beta), um dies hinterher wieder auf den
7533 richtigen Wert zu setzen:</para>
7535 <programlisting> my $saved_numberformat = $::myconfig{numberformat};
7536 $::myconfig{numberformat} = $numberformat;
7537 # (...) div Berechnungen
7538 $::myconfig{numberformat} = $saved_numberformat;</programlisting>
7540 <para>Das Objekt der Klasse Form hat leider im Moment noch viele
7541 zentrale Funktionen die vom internen Zustand abhängen, deshalb bitte
7542 nie einfach zerstören oder überschreiben (zumindestens nicht kurz
7543 vor einem Release oder in Absprache über bspw. die devel-Liste ;-).
7544 Es geht ziemlich sicher etwas kaputt.</para>
7546 <para><varname>$::form</varname> ist gleichzeitig der Standard Scope
7547 in den <productname>Template::Toolkit</productname> Templates
7548 außerhalb der Controller: der Ausdruck <function>[% var
7549 %]</function> greift auf <varname>$::form->{var}</varname> zu.
7550 Unter Controllern ist der Standard Scope anders, da lautet der
7551 Zugriff <function>[% FORM.var %]</function>. In Druckvorlagen sind
7552 normale Variablen ebenfall im <varname>$::form</varname> Scope, d.h.
7553 <function><%var%></function> zeigt auf
7554 <varname>$::form->{var}</varname>. Nochmal von der anderen Seite
7555 erläutert, innerhalb von (Web-)Templates sieht man häufiger solche
7558 <programlisting>[%- IF business %]
7559 # (... Zeig die Auswahlliste Kunden-/Lieferantentyp an)
7560 [%- END %]</programlisting>
7562 <para>Entweder wird hier dann $::form->{business} ausgewertet
7563 oder aber der Funktion
7564 <function>$form->parse_html_template</function> wird explizit
7565 noch ein zusätzlicher Hash übergeben, der dann auch in den
7566 (Web-)Templates zu Verfügung steht, bspw. so:</para>
7568 <programlisting>$form->parse_html_template("is/form_header", \%TMPL_VAR);</programlisting>
7570 <para>Innerhalb von Schleifen wird
7571 <varname>$::form->{TEMPLATE_ARRAYS}{var}[$index]</varname>
7572 bevorzugt, wenn vorhanden. Ein Beispiel findet sich in SL/DO.pm,
7573 welches über alle Positionen eines Lieferscheins in Schleife
7576 <programlisting>for $i (1 .. $form->{rowcount}) {
7578 push @{ $form->{TEMPLATE_ARRAYS}{runningnumber} }, $position;
7579 push @{ $form->{TEMPLATE_ARRAYS}{number} }, $form->{"partnumber_$i"};
7580 push @{ $form->{TEMPLATE_ARRAYS}{description} }, $form->{"description_$i"};
7586 <title>%::myconfig</title>
7590 <para>Das einzige Hash unter den globalen Variablen</para>
7594 <para>Wird spätestens benötigt wenn auf die Datenbank
7595 zugegriffen wird</para>
7599 <para>Wird bei jedem Request neu erstellt.</para>
7603 <para>Enthält die Userdaten des aktuellen Logins</para>
7607 <para>Sollte nicht ohne Filterung irgendwo gedumpt werden oder
7608 extern serialisiert werden, weil da auch der Datenbankzugriff
7609 für diesen user drinsteht.</para>
7613 <para>Enthält unter anderem Datumsformat dateformat und
7614 Nummernformat numberformat</para>
7618 <para>Enthält Datenbankzugriffinformationen</para>
7622 <para><varname>%::myconfig</varname> ist im Moment der Ersatz für
7623 ein Userobjekt. Die meisten Funktionen, die etwas anhand des
7624 aktuellen Users entscheiden müssen, befragen
7625 <varname>%::myconfig</varname>. Innerhalb der Anwendungen sind dies
7626 überwiegend die Daten, die sich unter <guimenu>Programm</guimenu>
7627 -> <guimenuitem>Einstellungen</guimenuitem> befinden, bzw. die
7628 Informationen über den Benutzer die über die
7629 Administrator-Schnittstelle eingegeben wurden.</para>
7633 <title>$::locale</title>
7637 <para>Objekt der Klasse "Locale"</para>
7641 <para>Wird pro Request erstellt</para>
7645 <para>Muss auch für Tests und Scripte immer verfügbar
7650 <para>Cached intern über Requestgrenzen hinweg benutzte
7655 <para>Lokalisierung für den aktuellen User. Alle Übersetzungen,
7656 Zahlen- und Datumsformatierungen laufen über dieses Objekt.</para>
7660 <title>$::lxdebug</title>
7664 <para>Objekt der Klasse "LXDebug"</para>
7668 <para>Wird global gecached</para>
7672 <para>Muss immer verfügbar sein, in nahezu allen
7677 <para><varname>$::lxdebug</varname> stellt Debuggingfunktionen
7678 bereit, wie "<function>enter_sub</function>" und
7679 "<function>leave_sub</function>", mit denen in den alten Modulen ein
7680 brauchbares Tracing gebaut ist, "<function>log_time</function>", mit
7681 der man die Wallclockzeit seit Requeststart loggen kann, sowie
7682 "<function>message</function>" und "<function>dump</function>" mit
7683 denen man flott Informationen ins Log (tmp/kivitendo-debug.log)
7686 <para>Beispielsweise so:</para>
7688 <programlisting>$main::lxdebug->message(0, 'Meine Konfig:' . Dumper (%::myconfig));
7689 $main::lxdebug->message(0, 'Wer bin ich? Kunde oder Lieferant:' . $form->{vc});</programlisting>
7693 <title>$::auth</title>
7697 <para>Objekt der Klasse "SL::Auth"</para>
7701 <para>Wird global gecached</para>
7705 <para>Hat eine permanente DB Verbindung zur Authdatenbank</para>
7709 <para>Wird nach jedem Request resettet.</para>
7713 <para><varname>$::auth</varname> stellt Funktionen bereit um die
7714 Rechte des aktuellen Users abzufragen. Obwohl diese Informationen
7715 vom aktuellen User abhängen wird das Objekt aus
7716 Geschwindigkeitsgründen nur einmal angelegt und dann nach jedem
7717 Request kurz resettet.</para>
7719 <para>Dieses Objekt kapselt auch den gerade aktiven Mandanten.
7720 Dessen Einstellungen können über
7721 <literal>$::auth->client</literal> abgefragt werden; Rückgabewert
7722 ist ein Hash mit den Werten aus der Tabelle
7723 <literal>auth.clients</literal>.</para>
7727 <title>$::lx_office_conf</title>
7731 <para>Objekt der Klasse
7732 "<classname>SL::LxOfficeConf</classname>"</para>
7736 <para>Global gecached</para>
7740 <para>Repräsentation der
7741 <filename>config/kivitendo.conf[.default]</filename>-Dateien</para>
7745 <para>Globale Konfiguration. Configdateien werden zum Start gelesen
7746 und danach nicht mehr angefasst. Es ist derzeit nicht geplant, dass
7747 das Programm die Konfiguration ändern kann oder sollte.</para>
7749 <para>Beispielsweise ist über den Konfigurationseintrag [debug] die
7750 Debug- und Trace-Log-Datei wie folgt konfiguriert und
7753 <programlisting>[debug]
7754 file_name = /tmp/kivitendo-debug.log</programlisting>
7756 <para>ist der Key <varname>file</varname> im Programm als
7757 <varname>$::lx_office_conf->{debug}{file}</varname>
7761 <para>Zugriff auf die Konfiguration erfolgt im Moment über
7762 Hashkeys, sind also nicht gegen Tippfehler abgesichert.</para>
7767 <title>$::instance_conf</title>
7771 <para>Objekt der Klasse
7772 "<classname>SL::InstanceConfiguration</classname>"</para>
7776 <para>wird pro Request neu erstellt</para>
7780 <para>Funktioniert wie <varname>$::lx_office_conf</varname>,
7781 speichert aber Daten die von der Instanz abhängig sind. Eine Instanz
7782 ist hier eine Mandantendatenbank. Beispielsweise überprüft
7783 <programlisting>$::instance_conf->get_inventory_system eq 'perpetual'</programlisting>
7784 ob die berüchtigte Bestandsmethode zur Anwendung kommt.</para>
7788 <title>$::dispatcher</title>
7792 <para>Objekt der Klasse
7793 "<varname>SL::Dispatcher</varname>"</para>
7797 <para>wird pro Serverprozess erstellt.</para>
7801 <para>enthält Informationen über die technische Verbindung zum
7806 <para>Der dritte Punkt ist auch der einzige Grund warum das Objekt
7807 global gespeichert wird. Wird vermutlich irgendwann in einem anderen
7808 Objekt untergebracht.</para>
7812 <title>$::request</title>
7816 <para>Hashref (evtl später Objekt)</para>
7820 <para>Wird pro Request neu initialisiert.</para>
7824 <para>Keine Unterstruktur garantiert.</para>
7828 <para><varname>$::request</varname> ist ein generischer Platz um
7829 Daten "für den aktuellen Request" abzulegen. Sollte nicht für action
7830 at a distance benutzt werden, sondern um lokales memoizing zu
7831 ermöglichen, das garantiert am Ende des Requests zerstört
7834 <para>Vieles von dem, was im moment in <varname>$::form</varname>
7835 liegt, sollte eigentlich hier liegen. Die groben
7836 Differentialkriterien sind:</para>
7840 <para>Kommt es vom User, und soll unverändert wieder an den
7841 User? Dann <varname>$::form</varname>, steht da eh schon</para>
7845 <para>Sind es Daten aus der Datenbank, die nur bis zum Ende des
7846 Requests gebraucht werden? Dann
7847 <varname>$::request</varname></para>
7851 <para>Muss ich von anderen Teilen des Programms lesend drauf
7852 zugreifen? Dann <varname>$::request</varname>, aber Zugriff über
7853 Wrappermethode</para>
7860 <title>Ehemalige globale Variablen</title>
7862 <para>Die folgenden Variablen waren einmal im Programm, und wurden
7866 <title>$::cgi</title>
7870 <para>war nötig, weil cookie Methoden nicht als
7871 Klassenfunktionen funktionieren</para>
7875 <para>Aufruf als Klasse erzeugt Dummyobjekt was im
7876 Klassennamespace gehalten wird und über Requestgrenzen
7881 <para>liegt jetzt unter
7882 <varname>$::request->{cgi}</varname></para>
7888 <title>$::all_units</title>
7892 <para>war nötig, weil einige Funktionen in Schleifen zum Teil
7893 ein paar hundert mal pro Request eine Liste der Einheiten
7894 brauchen, und de als Parameter durch einen Riesenstack von
7895 Funktionen geschleift werden müssten.</para>
7899 <para>Liegt jetzt unter
7900 <varname>$::request->{cache}{all_units}</varname></para>
7905 <function>AM->retrieve_all_units()</function> gesetzt oder
7912 <title>%::called_subs</title>
7916 <para>wurde benutzt um callsub deep recursions
7921 <para>Wurde entfernt, weil callsub nur einen Bruchteil der
7922 möglichen Rekursioenen darstellt, und da nie welche
7927 <para>komplette recursion protection wurde entfernt.</para>
7934 <sect1 id="devel.fcgi">
7935 <title>Entwicklung unter FastCGI</title>
7937 <sect2 id="devel.fcgi.general">
7938 <title>Allgemeines</title>
7940 <para>Wenn Änderungen in der Konfiguration von kivitendo gemacht
7941 werden, muss der Webserver neu gestartet werden.</para>
7943 <para>Bei der Entwicklung für FastCGI ist auf ein paar Fallstricke zu
7944 achten. Dadurch, dass das Programm in einer Endlosschleife läuft,
7945 müssen folgende Aspekte beachtet werden.</para>
7948 <sect2 id="devel.fcgi.exiting">
7949 <title>Programmende und Ausnahmen</title>
7951 <para>Betrifft die Funktionen <function>warn</function>,
7952 <function>die</function>, <function>exit</function>,
7953 <function>carp</function> und <function>confess</function>.</para>
7955 <para>Fehler, die dass Programm normalerweise sofort beenden (fatale
7956 Fehler), werden mit dem FastCGI Dispatcher abgefangen, um das Programm
7957 am Laufen zu halten. Man kann mit <function>die</function>,
7958 <function>confess</function> oder <function>carp</function> Fehler
7959 ausgeben, die dann vom Dispatcher angezeigt werden. Die kivitendo
7960 eigene <function>$::form-</function>error()> tut im Prinzip das
7961 Gleiche, mit ein paar Extraoptionen. <function>warn</function> und
7962 <function>exit</function> hingegen werden nicht abgefangen.
7963 <function>warn</function> wird direkt nach STDERR, also in Server Log
7964 eine Nachricht schreiben (sofern in der Konfiguration nicht die
7965 Warnungen in das kivitendo Log umgeleitet wurden), und
7966 <function>exit</function> wird die Ausführung beenden.</para>
7968 <para>Prinzipiell ist es kein Beinbruch, wenn sich der Prozess
7969 beendet, fcgi wird ihn sofort neu starten. Allerdings sollte das die
7970 Ausnahme sein. Quintessenz: Bitte kein <function>exit</function>
7971 benutzen, alle anderen Exceptionmechanismen sind ok.</para>
7974 <sect2 id="devel.fcgi.globals">
7975 <title>Globale Variablen</title>
7977 <para>Um zu vermeiden, dass Informationen von einem Request in einen
7978 anderen gelangen, müssen alle globalen Variablen vor einem Request
7979 sauber initialisiert werden. Das ist besonders wichtig im
7980 <varname>$::cgi</varname> und <varname>$::auth</varname> Objekt, weil
7981 diese nicht gelöscht werden pro Instanz, sondern persistent gehalten
7984 <para>In <classname>SL::Dispatcher</classname> gibt es einen sauber
7985 abgetrennten Block, der alle kanonischen globalen Variablen listet und
7986 erklärt. Bitte keine anderen einführen ohne das sauber zu
7987 dokumentieren.</para>
7989 <para>Datenbankverbindungen wird noch ein Guide verfasst werden, wie
7990 man sicher geht, dass man die richtige erwischt.</para>
7993 <sect2 id="devel.fcgi.performance">
7994 <title>Performance und Statistiken</title>
7996 <para>Die kritischen Pfade des Programms sind die Belegmasken, und
7997 unter diesen ganz besonders die Verkaufsrechnungsmaske. Ein Aufruf der
7998 Rechnungsmaske in kivitendo 2.4.3 stable dauert auf einem Core2duo mit
7999 4GB Arbeitsspeicher und Ubuntu 9.10 eine halbe Sekunde. In der 2.6.0
8000 sind es je nach Menge der definierten Variablen 1-2s. Ab der
8001 Moose/Rose::DB Version sind es 5-6s.</para>
8003 <para>Mit FastCGI ist die neuste Version auf 0,26 Sekunden selbst in
8004 den kritischen Pfaden, unter 0,15 sonst.</para>
8008 <sect1 id="dev-programmatic-api-calls" xreflabel="Programmatische API-Aufrufe">
8009 <title>Programmatische API-Aufrufe</title>
8011 <sect2 id="dev-programmatic-api-calls.introduction" xreflabel="Einführung in programmatische API-Aufrufe">
8012 <title>Einführung</title>
8015 Es ist möglich, Funktionen in kivitendo programmatisch aus anderen Programmen aufzurufen. Dazu ist nötig, dass
8016 Authentifizierungsinformationen in jedem Aufruf mitgegeben werden. Dafür gibt es zwei Methoden: die HTTP-»Basic«-Authentifizierung
8017 oder die Übergabe als spziell benannte GET-Parameter. Neben den Authentifizierungsinformationen muss auch der zu verwendende Mandant
8022 <sect2 id="dev-programmatic-api-calls.client_selection" xreflabel="Mandantenauswahl bei programmatischen API-Aufrufen">
8023 <title>Wahl des Mandanten</title>
8026 Der zu verwendende Mandant kann als Parameter <varname>{AUTH}client_id</varname> mit jedem Request mitgeschickt werden. Der Wert
8027 muss dabei die Datenbank-ID des Mandanten sein. kivitendo prüft, ob der Account, der über die Authentifizierungsinformationen
8028 übergeben wurde, Zugriff auf den angegebenen Mandanten hat.
8032 Wird in einem Request kein Mandant mitgegeben, so wird derjenige Mandant genommen, wer als Standardmandant markiert wurde. Gibt es
8033 keinen solchen, kommt es zu einer Fehlermeldung.
8037 <sect2 id="dev-programmatic-api-calls.http_basic_authentication" xreflabel="Programmatische API-Aufrufe mit HTTP-»Basic« authentifizieren">
8038 <title>HTTP-»Basic«-Authentifizierung</title>
8041 Für diese Methode muss jedem Request der bekannte HTTP-Header <constant>Authorization</constant> mitgeschickt werden (siehe <ulink
8042 url="https://tools.ietf.org/html/rfc7617">RFC 7617</ulink>). Unterstützt wird ausschließlich die »Basic«-Methode. Loginname und
8043 Passwort werden bei dieser Methode durch einen Doppelpunkt getrennt und Base64-encodiert im genannten HTTP-Header übertragen.
8047 Diese Informationen müssen einen vorhandenen Account benennen. kivitendo prüft genau wie bei Benutzung über den Webbrowser, ob
8048 dieser Account Zugriff auf den Mandanten sowie auf die angeforderte Funktion hat.
8052 Da die Logininformationen im Klartext im Request stehen, sollte der Zugriff auf kivitendo ausschließlich über HTTPS verschlüsselt
8057 <sect2 id="dev-programmatic-api-calls.authentication_via_parameters" xreflabel="Programmatische API-Aufrufe mit Parametern authentifizieren">
8058 <title>Authentifizierung mit Parametern</title>
8061 Für diese Methode müssen jedem Request zwei Parameter mitgegeben werden: <varname>{AUTH}login</varname> und
8062 <varname>{AUTH}password</varname>. Diese Informationen müssen einen vorhandenen Account benennen. kivitendo prüft genau wie bei
8063 Benutzung über den Webbrowser, ob dieser Account Zugriff auf den Mandanten sowie auf die angeforderte Funktion hat.
8067 Da die Logininformationen im Klartext im Request stehen, sollte der Zugriff auf kivitendo ausschließlich über HTTPS verschlüsselt
8073 Die Verwendung dieser Methode ist veraltet. Statt dessen sollte die oben erwähnte HTTP-»Basic«-Authentifizierung verwendet werden.
8078 <sect2 id="dev-programmatic-api-calls.examples">
8079 <title>Beispiele</title>
8082 Das folgende Beispiel nutzt das Kommandozeilenprogramm »curl« und ruft die Funktion auf, die eine vorhandene Telefonnummer in den
8083 Ansprechpersonen sucht und dazu Informationen zurückliefert. Dabei wird die HTTP-»Basic«-Authentifizierung genutzt.
8086 <programlisting>$ curl --silent --user 'jdoe:SecretPassword!' \
8087 'https://…/controller.pl?action=PhoneNumber/look_up&number=053147110815'</programlisting>
8091 <sect1 id="db-upgrade-files" xreflabel="Datenbank-Upgradedateien">
8092 <title>SQL-Upgradedateien</title>
8094 <sect2 id="db-upgrade-files.introduction"
8095 xreflabel="Einführung in die Datenbank-Upgradedateien">
8096 <title>Einführung</title>
8098 <para>Datenbankupgrades werden über einzelne Upgrade-Scripte
8099 gesteuert, die sich im Verzeichnis
8100 <filename>sql/Pg-upgrade2</filename> befinden. In diesem Verzeichnis
8101 muss pro Datenbankupgrade eine Datei existieren, die neben den
8102 eigentlich auszuführenden SQL- oder Perl-Befehlen einige
8103 Kontrollinformationen enthält.</para>
8105 <para>Kontrollinformationen definieren Abhängigkeiten und Prioritäten,
8106 sodass Datenbankscripte zwar in einer sicheren Reihenfolge ausgeführt
8107 werden (z.B. darf ein <literal>ALTER TABLE</literal> erst ausgeführt
8108 werden, wenn die Tabelle mit <literal>CREATE TABLE</literal> angelegt
8109 wurde), diese Reihenfolge aber so flexibel ist, dass man keine
8110 Versionsnummern braucht.</para>
8112 <para>kivitendo merkt sich dabei, welches der Upgradescripte in
8113 <filename>sql/Pg-upgrade2</filename> bereits durchgeführt wurde und
8114 führt diese nicht erneut aus. Dazu dient die Tabelle
8115 "<literal>schema_info</literal>", die bei der Anmeldung automatisch
8116 angelegt wird.</para>
8119 <sect2 id="db-upgrade-files.format"
8120 xreflabel="Format der Upgradedateien">
8121 <title>Format der Kontrollinformationen</title>
8123 <para>Die Kontrollinformationen sollten sich am Anfang der jeweiligen
8124 Upgradedatei befinden. Jede Zeile, die Kontrollinformationen enthält,
8125 hat dabei das folgende Format:</para>
8127 <para>Für SQL-Upgradedateien:</para>
8129 <programlisting>-- @key: value</programlisting>
8131 <para>Für Perl-Upgradedateien:</para>
8133 <programlisting># @key: value</programlisting>
8135 <para>Leerzeichen vor "<varname>value</varname>" werden
8138 <para>Die folgenden Schlüsselworte werden verarbeitet:</para>
8142 <term><varname>tag</varname></term>
8145 <para>Wird zwingend benötigt. Dies ist der "Name" des Upgrades.
8146 Dieser "tag" kann von anderen Kontrolldateien in ihren
8147 Abhängigkeiten verwendet werden (Schlüsselwort
8148 "<varname>depends</varname>"). Der "tag" ist auch der Name, der
8149 in der Datenbank eingetragen wird.</para>
8151 <para>Normalerweise sollte die Kontrolldatei genau so heißen wie
8152 der "tag", nur mit der Endung ".sql" bzw. "pl".</para>
8154 <para>Ein Tag darf nur aus alphanumerischen Zeichen sowie den
8155 Zeichen _ - ( ) bestehen. Insbesondere sind Leerzeichen nicht
8156 erlaubt und sollten stattdessen mit Unterstrichen ersetzt
8162 <term><varname>charset</varname></term>
8165 <para>Empfohlen. Gibt den Zeichensatz an, in dem das Script
8166 geschrieben wurde, z.B. "<literal>UTF-8</literal>". Aus
8167 Kompatibilitätsgründen mit alten Upgrade-Scripten wird bei
8168 Abwesenheit des Tags für SQL-Upgradedateien der Zeichensatz
8169 "<literal>ISO-8859-15</literal>" angenommen. Perl-Upgradescripte
8170 hingegen müssen immer in UTF-8 encodiert sein und sollten
8171 demnach auch ein "<literal>use utf8;</literal>"
8177 <term><varname>description</varname></term>
8180 <para>Benötigt. Eine Beschreibung, was in diesem Update
8181 passiert. Diese wird dem Benutzer beim eigentlichen
8182 Datenbankupdate angezeigt. Während der Tag in Englisch gehalten
8183 sein sollte, sollte die Beschreibung auf Deutsch
8189 <term><varname>depends</varname></term>
8192 <para>Optional. Eine mit Leerzeichen getrennte Liste von "tags",
8193 von denen dieses Upgradescript abhängt. kivitendo stellt sicher,
8194 dass die in dieser Liste aufgeführten Scripte bereits
8195 durchgeführt wurden, bevor dieses Script ausgeführt wird.</para>
8197 <para>Abhängigkeiten werden rekursiv betrachtet. Wenn also ein
8198 Script "b" existiert, das von Änderungen in "a" abhängt, und
8199 eine neue Kontrolldatei für "c" erstellt wird, die von
8200 Änderungen in "a" und "b" abhängt, so genügt es, in "c" nur den
8201 Tag "b" als Abhängigkeit zu definieren.</para>
8203 <para>Es ist nicht erlaubt, sich selbst referenzierende
8204 Abhängigkeiten zu definieren (z.B. "a" -> "b", "b" -> "c"
8205 und "c" -> "a").</para>
8210 <term><varname>priority</varname></term>
8213 <para>Optional. Ein Zahlenwert, der die Reihenfolge bestimmt, in
8214 der Scripte ausgeführt werden, die die gleichen
8215 Abhängigkeitstiefen besitzen. Fehlt dieser Parameter, so wird
8216 der Wert 1000 benutzt.</para>
8218 <para>Dies ist reine Kosmetik. Für echte Reihenfolgen muss
8219 "depends" benutzt werden. kivitendo sortiert die auszuführenden
8220 Scripte zuerst nach der Abhängigkeitstiefe (wenn "z" von "y"
8221 abhängt und "y" von "x", so hat "z" eine Abhängigkeitstiefe von
8222 2, "y" von 1 und "x" von 0. "x" würde hier zuerst ausgeführt,
8223 dann "y", dann "z"), dann nach der Priorität und bei gleicher
8224 Priorität alphabetisch nach dem "tag".</para>
8229 <term><varname>ignore</varname></term>
8232 <para>Optional. Falls der Wert auf 1 (true) steht, wird das
8233 Skript bei der Anmeldung ignoriert und entsprechend nicht
8240 <sect2 id="db-upgrade-files.format-perl-files"
8241 xreflabel="Format von Perl-Upgradedateien">
8242 <title>Format von in Perl geschriebenen
8243 Datenbankupgradescripten</title>
8245 <para>In Perl geschriebene Datenbankscripte werden nicht einfach so
8246 ausgeführt sondern müssen sich an gewisse Konventionen halten. Dafür
8247 bekommen sie aber auch einige Komfortfunktionen bereitgestellt.</para>
8249 <para>Ein Upgradescript stellt dabei eine vollständige Objektklasse
8250 dar, die vom Elternobjekt "<literal>SL::DBUpgrade2::Base</literal>"
8251 erben und eine Funktion namens "<literal>run</literal>" zur Verfügung
8252 stellen muss. Das Script wird ausgeführt, indem eine Instanz dieser
8253 Klasse erzeugt und darauf die erwähnte "<literal>run</literal>"
8254 aufgerufen wird.</para>
8256 <para>Zu beachten ist, dass sich der Paketname der Datei aus dem Wert
8257 für "<literal>@tag</literal>" ableitet. Dabei werden alle Zeichen, die
8258 in Paketnamen ungültig wären (gerade Bindestriche), durch Unterstriche
8259 ersetzt. Insgesamt sieht der Paketname wie folgt aus:
8260 "<literal>SL::DBUpgrade2::tag</literal>".</para>
8262 <para>Welche Komfortfunktionen zur Verfügung stehen, erfahren Sie in
8263 der Perl-Dokumentation zum oben genannten Modul; aufzurufen mit
8264 "<command>perldoc SL/DBUpgrade2/Base.pm</command>".</para>
8266 <para>Ein Mindestgerüst eines gültigen Perl-Upgradescriptes sieht wie
8269 <programlisting># @tag: beispiel-upgrade-file42
8270 # @description: Ein schönes Beispielscript
8271 # @depends: release_3_1_0
8272 package SL::DBUpgrade2::beispiel_upgrade_file42;
8277 use parent qw(SL::DBUpgrade2::Base);
8282 # hier Aktionen ausführen
8291 <sect2 id="db-upgrade-files.dbupgrade-tool"
8292 xreflabel="Hilfsscript dbupgrade2_tool.pl">
8293 <title>Hilfsscript dbupgrade2_tool.pl</title>
8295 <para>Um die Arbeit mit den Abhängigkeiten etwas zu erleichtern,
8296 existiert ein Hilfsscript namens
8297 "<filename>scripts/dbupgrade2_tool.pl</filename>". Es muss aus dem
8298 kivitendo-ERP-Basisverzeichnis heraus aufgerufen werden. Dieses Tool
8299 liest alle Datenbankupgradescripte aus dem Verzeichnis
8300 <filename>sql/Pg-upgrade2</filename> aus. Es benutzt dafür die
8301 gleichen Methoden wie kivitendo selber, sodass alle Fehlersituationen
8302 von der Kommandozeile überprüft werden können.</para>
8304 <para>Wird dem Script kein weiterer Parameter übergeben, so wird nur
8305 eine Überprüfung der Felder und Abhängigkeiten vorgenommen. Man kann
8306 sich aber auch Informationen auf verschiedene Art ausgeben
8311 <para>Listenform: "<command>./scripts/dbupgrade2_tool.pl
8312 --list</command>"</para>
8314 <para>Gibt eine Liste aller Scripte aus. Die Liste ist in der
8315 Reihenfolge sortiert, in der kivitendo die Scripte ausführen
8316 würde. Es werden neben der Listenposition der Tag, die
8317 Abhängigkeitstiefe und die Priorität ausgegeben.</para>
8321 <para>Baumform: "<command>./scripts/dbupgrade2_tool.pl
8322 --tree</command>"</para>
8324 <para>Listet alle Tags in Baumform basierend auf den
8325 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte, von
8326 denen keine anderen abhängen. Die Unterknoten sind Scripte, die
8327 beim übergeordneten Script als Abhängigkeit eingetragen
8331 <listitem id="db-upgrade-files.dbupgrade-tool.reverse-tree">
8332 <para>Umgekehrte Baumform: "<command>./scripts/dbupgrade2_tool.pl
8333 --rtree</command>"</para>
8335 <para>Listet alle Tags in Baumform basierend auf den
8336 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte mit
8337 der geringsten Abhängigkeitstiefe. Die Unterknoten sind Scripte,
8338 die das übergeordnete Script als Abhängigkeit eingetragen
8343 <para>Baumform mit Postscriptausgabe:
8344 "<command>./scripts/dbupgrade2_tool.pl
8345 --graphviz</command>"</para>
8347 <para>Benötigt das Tool "<command>graphviz</command>", um mit
8348 seiner Hilfe die <link
8349 linkend="db-upgrade-files.dbupgrade-tool.reverse-tree">umgekehrte
8350 Baumform</link> in eine Postscriptdatei namens
8351 "<filename>db_dependencies.ps</filename>" auszugeben. Dies ist
8352 vermutlich die übersichtlichste Form, weil hierbei jeder Knoten
8353 nur einmal ausgegeben wird. Bei den Textmodusbaumformen hingegen
8354 können Knoten und all ihre Abhängigkeiten mehrfach ausgegeben
8359 <para>Scripte, von denen kein anderes Script abhängt:
8360 "<command>./scripts/dbupgrade2_tool.pl --nodeps</command>"</para>
8362 <para>Listet die Tags aller Scripte auf, von denen keine anderen
8363 Scripte abhängen.</para>
8369 <sect1 id="translations-languages" xreflabel="Translations and languages">
8370 <title>Translations and languages</title>
8372 <sect2 id="translations-languages.introduction"
8373 xreflabel="Introduction to translations and languages">
8374 <title>Introduction</title>
8377 <para>Dieser Abschnitt ist in Englisch geschrieben, um
8378 internationalen Übersetzern die Arbeit zu erleichtern.</para>
8381 <para>This section describes how localization packages in kivitendo
8382 are built. Currently the only language fully supported is German, and
8383 since most of the internal messages are held in English the English
8384 version is usable too.</para>
8387 <sect2 id="translations-languages.character-set"
8388 xreflabel="Character set">
8389 <title>Character set</title>
8391 <para>All files included in a language pack must use UTF-8 as their
8395 <sect2 id="translations-languages.file-structure"
8396 xreflabel="File structure">
8397 <title>File structure</title>
8399 <para>The structure of locales in kivitendo is:</para>
8401 <programlisting>kivitendo/locale/<langcode>/</programlisting>
8403 <para>where <langcode> stands for an abbreviation of the
8404 language package. The builtin packages use two letter <ulink
8405 url="http://en.wikipedia.org/wiki/ISO_639-1">ISO 639-1</ulink> codes,
8406 but the actual name is not relevant for the program and can easily be
8408 url="http://en.wikipedia.org/wiki/IETF_language_tag">IETF language
8409 tags</ulink> (i.e. "en_GB"). In fact the original language packages
8410 from SQL Ledger are named in this way.</para>
8412 <para>In such a language directory the following files are
8417 <term>LANGUAGE</term>
8420 <para>This file is mandatory.</para>
8422 <para>The <filename>LANGUAGE</filename> file contains the self
8423 descripted name of the language. It should contain a native
8424 representation first, and in parenthesis an english translation
8425 after that. Example:</para>
8427 <programlisting>Deutsch (German)</programlisting>
8435 <para>This file is mandatory.</para>
8437 <para>The central translation file. It is essentially an inline
8438 Perl script autogenerated by <command>locales.pl</command>. To
8439 generate it, generate the directory and the two files mentioned
8440 above, and execute the following command:</para>
8442 <programlisting>scripts/locales.pl <langcode></programlisting>
8444 <para>Otherwise you can simply copy one of the other languages.
8445 You will be told how many are missing like this:</para>
8447 <programlisting>$ scripts/locales.pl en
8448 English - 0.6% - 2015/2028 missing</programlisting>
8450 <para>A file named "<filename>missing</filename>" will be
8451 generated and can be edited. You can also edit the
8452 "<filename>all</filename>" file directly. Edit everything you
8453 like to fit the target language and execute
8454 <command>locales.pl</command> again. See how the missing words
8460 <term>Num2text</term>
8463 <para>Legacy code from SQL Ledger. It provides a means for
8464 numbers to be converted into natural language, like
8465 <literal>1523 => one thousand five hundred twenty
8466 three</literal>. If you want to provide it, it must be inlinable
8467 Perl code which provides a <function>num2text</function> sub. If
8468 an <function>init</function> sub exists it will be executed
8471 <para>Only used in the check and receipt printing module.</para>
8476 <term>special_chars</term>
8479 <para>kivitendo comes with a lot of interfaces to different
8480 formats, some of which are rather picky with their accepted
8481 charset. The <filename>special_chars</filename> file contains a
8482 listing of chars not suited for different file format and
8483 provides substitutions. It is written in "Simple Ini" style,
8484 containing a block for every file format.</para>
8486 <para>First entry should be the order of substitution for
8487 entries as a whitespace separated list. All entries are
8488 interpolated, so <literal>\n</literal>, <literal>\x20</literal>
8489 and <literal>\\</literal> all work.</para>
8491 <para>After that every entry is a special char that should be
8492 translated when writing text into such a file.</para>
8494 <para>Example:</para>
8496 <programlisting>[Template/XML]
8497 order=& < > \n
8501 \n=<br></programlisting>
8503 <para>Note the importance of the order in this example.
8504 Substituting < and > befor & would lead to $gt; become
8507 <para>For a list of valid formats, see the German
8508 <filename>special_chars</filename> entry. As of this writing the
8509 following are recognized:</para>
8511 <programlisting>HTML
8516 Template/OpenDocument
8517 filenames</programlisting>
8519 <para>The last of which is very machine dependent. Remember that
8520 a lot of characters are forbidden by some filesystems, for
8521 example MS Windows doesn't like ':' in its files where Linux
8522 doesn't mind that. If you want the files created with your
8523 language pack to be portable, find all chars that could cause
8529 <term>missing</term>
8532 <para>This file is not a part of the language package
8535 <para>This is a file generated by
8536 <command>scripts/locales.pl</command> while processing your
8537 locales. It's only to have the missing entries singled out and
8538 does not belong to a language package.</para>
8546 <para>This file is not a part of the language package
8549 <para>Another file generated by
8550 <command>scripts/locales.pl</command>. If for any reason a
8551 translation does not appear anymore and can be deleted, it gets
8552 moved here. The last 50 or so entries deleted are saved here in
8553 case you made a typo, so that you don't have to translate
8554 everything again. If a tranlsation is missing, the lost file is
8555 checked first. If you maintain a language package, you might
8556 want to keep this safe somewhere.</para>
8561 <term>more/all</term>
8564 <para>This subdir and file is not a part of the language package
8567 <para>If the directory more exists and contains a file called
8568 all it will be parsed in addition to the mandatory all (see
8569 above). The file is useful if you want to change some
8570 translations for the current installation without conflicting
8571 further upgrades. The file is not autogenerated and has the same
8572 format as the all, but needs another key (more_texts). See the
8573 german translation for an example or copy the following code:
8576 # -*- coding: utf-8; -*-
8581 # These are additional texts for custom translations.
8582 # The format is the same as for the normal file all, only
8583 # with another key (more_texts instead of texts).
8584 # The file has the form of 'english text' => 'foreign text',
8586 $self->{more_texts} = {
8588 'Ship via' => 'Terms of delivery',
8589 'Shipping Point' => 'Delivery time',
8591 </programlisting></para>
8598 <sect1 id="devel.testsuite">
8599 <title>Die kivitendo-Test-Suite</title>
8601 <sect2 id="devel.testsuite.intro">
8602 <title>Einführung</title>
8604 <para>kivitendo enthält eine Suite für automatisierte Tests. Sie
8605 basiert auf dem Standard-Perl-Modul
8606 <literal>Test::More</literal>.</para>
8608 <para>Die grundlegenden Fakten sind:</para>
8612 <para>Alle Tests liegen im Unterverzeichnis
8613 <filename>t/</filename>.</para>
8617 <para>Ein Script (bzw. ein Test) in <filename>t/</filename>
8618 enthält einen oder mehrere Testfälle.</para>
8622 <para>Alle Dateinamen von Tests enden auf <literal>.t</literal>.
8623 Es sind selbstständig ausführbare Perl-Scripte.</para>
8627 <para>Die Test-Suite besteht aus der Gesamtheit aller Tests,
8628 sprich aller Scripte in <filename>t/</filename>, deren Dateiname
8629 auf <literal>.t</literal> endet.</para>
8634 <sect2 id="devel.testsuite.prerequisites">
8635 <title>Voraussetzungen</title>
8637 <para>Für die Ausführung werden neben den für kivitendo eh schon
8638 benötigten Module noch weitere Perl-Module benötigt. Diese
8643 <para><literal>Test::Deep</literal> (Debian-Paketname:
8644 <literal>libtest-deep-perl</literal>; Fedora:
8645 <literal>perl-Test-Deep</literal>; openSUSE:
8646 <literal>perl-Test-Deep</literal>)</para>
8650 <para><literal>Test::Exception</literal> (Debian-Paketname:
8651 <literal>libtest-exception-perl</literal>; Fedora:
8652 <literal>perl-Test-Exception</literal>; openSUSE:
8653 <literal>perl-Test-Exception</literal>)</para>
8657 <para><literal>Test::Output</literal> (Debian-Paketname:
8658 <literal>libtest-output-perl</literal>; Fedora:
8659 <literal>perl-Test-Output</literal>; openSUSE:
8660 <literal>perl-Test-Output</literal>)</para>
8664 <para><literal>Test::Harness</literal> 3.0.0 oder höher. Dieses
8665 Modul ist ab Perl 5.10.1 Bestandteil der Perl-Distribution und
8666 kann für frühere Versionen aus dem <ulink
8667 url="http://www.cpan.org">CPAN</ulink> bezogen werden.</para>
8671 <para><literal>LWP::Simple</literal> aus dem Paket
8672 <literal>libwww-perl</literal> (Debian-Panetname:
8673 <literal>libwww-perl</literal>; Fedora:
8674 <literal>perl-libwww-perl</literal>; openSUSE:
8675 <literal>perl-libwww-perl</literal>)</para>
8679 <para><literal>URI::Find</literal> (Debian-Panetname:
8680 <literal>liburi-find-perl</literal>; Fedora:
8681 <literal>perl-URI-Find</literal>; openSUSE:
8682 <literal>perl-URI-Find</literal>)</para>
8686 <para><literal>Sys::CPU</literal> (Debian-Panetname:
8687 <literal>libsys-cpu-perl</literal>; Fedora und openSUSE: nicht
8692 <para><literal>Thread::Pool::Simple</literal> (Debian-Panetname:
8693 <literal>libthread-pool-simple-perl</literal>; Fedora und
8694 openSUSE: nicht vorhanden)</para>
8698 <para>Weitere Voraussetzung ist, dass die Testsuite ihre eigene
8699 Datenbank anlegen kann, um Produktivdaten nicht zu gefährden. Dazu
8700 müssen in der Konfigurationsdatei im Abschnit
8701 <literal>testing/database</literal> Datenbankverbindungsparameter
8702 angegeben werden. Der hier angegebene Benutzer muss weiterhin das
8703 Recht haben, Datenbanken anzulegen und zu löschen.</para>
8705 <para>Der so angegebene Benutzer muss nicht zwingend über
8706 Super-User-Rechte verfügen. Allerdings gibt es einige
8707 Datenbank-Upgrades, die genau diese Rechte benötigen. Für den Fall
8708 kann man in diesem Konfigurationsabschnitt einen weiteren
8709 Benutzeraccount angeben, der dann über Super-User-Rechte verfügt, und
8710 mit dem die betroffenen Upgrades durchgeführt werden. In der
8711 Beispiel-Konfigurationsdatei finden Sie die benötigten
8715 <sect2 id="devel.testsuite.execution">
8716 <title>Existierende Tests ausführen</title>
8718 <para>Es gibt mehrere Möglichkeiten zum Ausführen der Tests: entweder,
8719 man lässt alle Tests auf einmal ausführen, oder man führt gezielt
8720 einzelne Scripte aus. Für beide Fälle gibt es das Helferscript
8721 <filename>t/test.pl</filename>.</para>
8723 <para>Will man die komplette Test-Suite ausführen, so muss man einfach
8724 nur <filename>t/test.pl</filename> ohne weitere Parameter aus dem
8725 kivitendo-Basisverzeichnis heraus ausführen.</para>
8727 <para>Um einzelne Test-Scripte auszuführen, übergibt man deren Namen
8728 an <filename>t/test.pl</filename>. Beispielsweise:</para>
8730 <programlisting>t/test.pl t/form/format_amount.t t/background_job/known_jobs.t</programlisting>
8733 <sect2 id="devel.testsuite.meaning_of_scripts">
8734 <title>Bedeutung der verschiedenen Test-Scripte</title>
8736 <para>Die Test-Suite umfasst Tests sowohl für Funktionen als auch für
8737 Programmierstil. Einige besonders zu erwähnende, weil auch während der
8738 Entwicklung nützliche Tests sind:</para>
8742 <para><filename>t/001compile.t</filename> -- compiliert alle
8743 Quelldateien und bricht bei Fehlern sofort ab</para>
8747 <para><filename>t/002goodperl.t</filename> -- überprüft alle
8748 Perl-Dateien auf Anwesenheit von '<literal>use
8749 strict</literal>'-Anweisungen</para>
8753 <para><filename>t/003safesys.t</filename> -- überprüft Aufrufe von
8754 <function>system()</function> und <function>exec()</function> auf
8759 <para><filename>t/005no_tabs.t</filename> -- überprüft, ob Dateien
8760 Tab-Zeichen enthalten</para>
8764 <para><filename>t/006spelling.t</filename> -- sucht nach häufigen
8765 Rechtschreibfehlern</para>
8769 <para><filename>t/011pod.t</filename> -- überprüft die Syntax von
8770 Dokumentation im POD-Format auf Gültigkeit</para>
8774 <para>Weitere Test-Scripte überprüfen primär die Funktionsweise
8775 einzelner Funktionen und Module.</para>
8778 <sect2 id="devel.testsuite.create_new">
8779 <title>Neue Test-Scripte erstellen</title>
8781 <para>Es wird sehr gern gesehen, wenn neue Funktionalität auch gleich
8782 mit einem Test-Script abgesichert wird. Auch bestehende Funktion darf
8783 und soll ausdrücklich nachträglich mit Test-Scripten abgesichert
8786 <sect3 id="devel.testsuite.ideas_for_non_function_tests">
8787 <title>Ideen für neue Test-Scripte, die keine konkreten Funktionen
8790 <para>Ideen, die abgesehen von Funktionen noch nicht umgesetzt
8795 <para>Überprüfung auf fehlende symbolische Links</para>
8799 <para>Suche nach Nicht-ASCII-Zeichen in Perl-Code-Dateien (mit
8800 gewissen Einschränkungen wie das Erlauben von deutschen
8805 <para>Test auf DOS-Zeilenenden (\r\n anstelle von nur \n)</para>
8809 <para>Überprüfung auf Leerzeichen am Ende von Zeilen</para>
8813 <para>Test, ob alle zu übersetzenden Strings in
8814 <filename>locale/de/all</filename> vorhanden sind</para>
8818 <para>Test, ob alle Webseiten-Templates in
8819 <filename>templates/webpages</filename> mit vom Perl-Modul
8820 <literal>Template</literal> compiliert werden können</para>
8825 <sect3 id="devel.testsuite.directory_and_test_names">
8826 <title>Konvention für Verzeichnis- und Dateinamen</title>
8828 <para>Es gibt momentan eine wenige Richtlinien, wie Test-Scripte zu
8829 benennen sind. Bitte die folgenden Punkte als Richtlinie betrachten
8830 und ihnen soweit es geht folgen:</para>
8834 <para>Die Dateiendung muss <filename>.t</filename>
8839 <para>Namen sind englisch, komplett klein geschrieben und
8840 einzelne Wörter mit Unterstrichten getrennt (beispielsweise
8841 <filename>bad_function_params.t</filename>).</para>
8845 <para>Unterverzeichnisse sollten grob nach dem Themenbereich
8846 benannt sein, mit dem sich die Scripte darin befassen
8847 (beispielsweise <filename>background_jobs</filename> für Tests
8848 rund um Hintergrund-Jobs).</para>
8852 <para>Test-Scripte sollten einen überschaubaren Bereich von
8853 Funktionalität testen, der logisch zusammenhängend ist (z.B. nur
8854 Tests für eine einzelne Funktion in einem Modul). Lieber mehrere
8855 Test-Scripte schreiben.</para>
8860 <sect3 id="devel.testsuite.minimal_example">
8861 <title>Minimales Skelett für eigene Scripte</title>
8863 <para>Der folgenden Programmcode enthält das kleinstmögliche
8864 Testscript und kann als Ausgangspunkt für eigene Tests verwendet
8867 <programlisting>use Test::More tests => 0;
8871 use Support::TestSetup;
8873 Support::TestSetup::login();</programlisting>
8875 <para>Wird eine vollständig initialisierte kivitendo-Umgebung
8876 benötigt (Stichwort: alle globalen Variablen wie
8877 <varname>$::auth</varname>, <varname>$::form</varname> oder
8878 <varname>$::lxdebug</varname>), so muss in der Konfigurationsdatei
8879 <filename>config/kivitendo.conf</filename> im Abschnitt
8880 <literal>testing.login</literal> ein gültiger Login-Name eingetragen
8881 sein. Dieser wird für die Datenbankverbindung benötigt.</para>
8883 <para>Wir keine vollständig initialisierte Umgebung benötigt, so
8884 kann die letzte Zeile <programlisting>Support::TestSetup::login();</programlisting>
8885 weggelassen werden, was die Ausführungszeit des Scripts leicht
8891 <sect1 id="devel.style-guide">
8892 <title>Stil-Richtlinien</title>
8894 <para>Die folgenden Regeln haben das Ziel, den Code möglichst gut les-
8895 und wartbar zu machen. Dazu gehört zum Einen, dass der Code einheitlich
8896 eingerückt ist, aber auch, dass Mehrdeutigkeit so weit es geht vermieden
8897 wird (Stichworte "Klammern" oder "Hash-Keys").</para>
8899 <para>Diese Regeln sind keine Schikane sondern erleichtern allen das
8902 <para>Jeder, der einen Patch schickt, sollte seinen Code vorher
8903 überprüfen. Einige der Regeln lassen sich automatisch überprüfen, andere
8908 <para>Es werden keine echten Tabs sondern Leerzeichen
8913 <para>Die Einrückung beträgt zwei Leerzeichen. Beispiel:</para>
8915 <programlisting>foreach my $row (@data) {
8917 # do something with $row
8921 $row->{modules} = MODULE->retrieve(
8922 id => $row->{id},
8923 date => $use_now ? localtime() : $row->{time},
8927 $report->add($row);
8932 <para>Öffnende geschweifte Klammern befinden sich auf der gleichen
8933 Zeile wie der letzte Befehl. Beispiele:</para>
8935 <programlisting>sub debug {
8941 <programlisting>if ($form->{item_rows} > 0) {
8947 <para>Schließende geschweifte Klammern sind so weit eingerückt wie
8948 der Befehl / die öffnende schließende Klammer, die den Block
8949 gestartet hat, und nicht auf der Ebene des Inhalts. Die gleichen
8950 Beispiele wie bei 3. gelten.</para>
8954 <para>Die Wörter "<function>else</function>",
8955 "<function>elsif</function>", "<function>while</function>" befinden
8956 sich auf der gleichen Zeile wie schließende geschweifte Klammern.
8959 <programlisting>if ($form->{sum} > 1000) {
8961 } elsif ($form->{sum} > 0) {
8969 } until ($a > 0);</programlisting>
8973 <para>Parameter von Funktionsaufrufen müssen mit runden Klammern
8974 versehen werden. Davon nicht betroffen sind interne Perl-Funktionen,
8975 und grep-ähnliche Operatoren. Beispiel:</para>
8977 <programlisting>$main::lxdebug->message("Could not find file.");
8978 %options = map { $_ => 1 } grep { !/^#/ } @config_file;</programlisting>
8982 <para>Verschiedene Klammern, Ihre Ausdrücke und Leerzeichen:</para>
8984 <para>Generell gilt: Hashkeys und Arrayindices sollten nicht durch
8985 Leerzeichen abgesetzt werden. Logische Klammerungen ebensowenig,
8986 Blöcke schon. Beispiel:</para>
8988 <programlisting>if (($form->{debug} == 1) && ($form->{sum} - 100 < 0)) {
8993 $form->{sum} += $form->{"row_$i"};
8994 $form->{ $form->{index} } += 1;
8996 map { $form->{sum} += $form->{"row_$_"} } 1..$rowcount;</programlisting>
9000 <para>Mehrzeilige Befehle</para>
9004 <para>Werden die Parameter eines Funktionsaufrufes auf mehrere
9005 Zeilen aufgeteilt, so sollten diese bis zu der Spalte eingerückt
9006 werden, in der die ersten Funktionsparameter in der ersten Zeile
9007 stehen. Beispiel:</para>
9009 <programlisting>$sth = $dbh->prepare("SELECT * FROM some_table WHERE col = ?",
9010 $form->{some_col_value});</programlisting>
9014 <para>Ein Spezialfall ist der ternäre Operator "?:", der am
9015 besten in einer übersichtlichen Tabellenstruktur organisiert
9016 wird. Beispiel:</para>
9018 <programlisting>my $rowcount = $form->{"row_$i"} ? $i
9019 : $form->{oldcount} ? $form->{oldcount} + 1
9020 : $form->{rowcount} - $form->{rowbase};</programlisting>
9026 <para>Kommentare</para>
9030 <para>Kommentare, die alleine in einer Zeile stehen, sollten
9031 soweit wie der Code eingerückt sein.</para>
9035 <para>Seitliche hängende Kommentare sollten einheitlich
9036 formatiert werden.</para>
9040 <para>Sämtliche Kommentare und Sonstiges im Quellcode ist bitte
9041 auf Englisch zu verfassen. So wie ich keine Lust habe,
9042 französischen Quelltext zu lesen, sollte auch der kivitendo
9043 Quelltext für nicht-Deutschsprachige lesbar sein.
9046 <programlisting>my $found = 0;
9054 $i = 0 # initialize $i
9056 $i *= $const; # do something crazy
9057 $i = $n; # recover $i</programlisting>
9063 <para>Hashkeys sollten nur in Anführungszeichen stehen, wenn die
9064 Interpolation gewünscht ist. Beispiel:</para>
9066 <programlisting>$form->{sum} = 0;
9067 $form->{"row_$i"} = $form->{"row_$i"} - 5;
9068 $some_hash{42} = 54;</programlisting>
9072 <para>Die maximale Zeilenlänge ist nicht beschränkt. Zeilenlängen
9073 unterhalb von 79 Zeichen helfen unter bestimmten Bedingungen, aber
9074 wenn die Lesbarkeit unter kurzen Zeilen leidet (wie zum Biespiel in
9075 grossen Tabellen), dann ist Lesbarkeit vorzuziehen.</para>
9077 <para>Als Beispiel sei die Funktion
9078 <function>print_options</function> aus
9079 <filename>bin/mozilla/io.pl</filename> angeführt.</para>
9083 <para>Trailing Whitespace, d.h. Leerzeichen am Ende von Zeilen sind
9084 unerwünscht. Sie führen zu unnötigen Whitespaceänderungen, die diffs
9087 <para>Emacs und vim haben beide recht einfache Methoden zur
9088 Entfernung von trailing whitespace. Emacs kennt das Kommande
9089 <command>nuke-trailing-whitespace</command>, vim macht das gleiche
9090 manuell über <literal>:%s/\s\+$//e</literal> Mit <literal>:au
9091 BufWritePre * :%s/\s\+$//e</literal> wird das an Speichern
9096 <para>Es wird kein <command>perltidy</command> verwendet.</para>
9098 <para>In der Vergangenheit wurde versucht,
9099 <command>perltidy</command> zu verwenden, um einen einheitlichen
9100 Stil zu erlangen. Es hat sich aber gezeigt, dass
9101 <command>perltidy</command>s sehr eigenwilliges Verhalten, was
9102 Zeilenumbrüche angeht, oftmals gut formatierten Code zerstört. Für
9103 den Interessierten sind hier die
9104 <command>perltidy</command>-Optionen, die grob den beschriebenen
9105 Richtlinien entsprechen:</para>
9107 <programlisting>-syn -i=2 -nt -pt=2 -sbt=2 -ci=2 -ibc -hsc -noll -nsts -nsfs -asc -dsm
9108 -aws -bbc -bbs -bbb -mbl=1 -nsob -ce -nbl -nsbl -cti=0 -bbt=0 -bar -l=79
9109 -lp -vt=1 -vtc=1</programlisting>
9113 <para><varname>STDERR</varname> ist tabu. Unkonditionale
9114 Debugmeldungen auch.</para>
9116 <para>kivitendo bietet mit dem Modul <classname>LXDebug</classname>
9117 einen brauchbaren Trace-/Debug-Mechanismus. Es gibt also keinen
9118 Grund, nach <varname>STDERR</varname> zu schreiben.</para>
9120 <para>Die <classname>LXDebug</classname>-Methode
9121 "<function>message</function>" nimmt als ersten Paramter außerdem
9122 eine Flagmaske, für die die Meldung angezeigt wird, wobei "0" immer
9123 angezeigt wird. Solche Meldungen sollten nicht eingecheckt werden
9124 und werden in den meisten Fällen auch vom Repository
9125 zurückgewiesen.</para>
9129 <para>Alle neuen Module müssen use strict verwenden.</para>
9131 <para><varname>$form</varname>, <varname>$auth</varname>,
9132 <varname>$locale</varname>, <varname>$lxdebug</varname> und
9133 <varname>%myconfig</varname> werden derzeit aus dem main package
9134 importiert (siehe <xref linkend="devel.globals"/>. Alle anderen
9135 Konstrukte sollten lexikalisch lokal gehalten werden.</para>
9140 <sect1 id="devel.build-doc" xreflabel="Dokumentation erstellen">
9141 <title>Dokumentation erstellen</title>
9143 <sect2 id="devel.build-doc.introduction">
9144 <title>Einführung</title>
9146 <para>Diese Dokumentation ist in <productname>DocBook</productname>
9147 XML geschrieben. Zum Bearbeiten reicht grundsätzlich ein Text-Editor.
9148 Mehr Komfort bekommt man, wenn man einen dedizierten XML-fähigen
9149 Editor nutzt, der spezielle Unterstützung für
9150 <productname>DocBook</productname> mitbringt. Wir empfehlen dafür den
9151 <ulink url="http://www.xmlmind.com/xmleditor/">XMLmind XML
9152 Editor</ulink>, der bei nicht kommerzieller Nutzung kostenlos
9156 <sect2 id="devel.build-doc.required-software">
9157 <title>Benötigte Software</title>
9159 <para>Bei <productname>DocBook</productname> ist Prinzip, dass
9160 ausschließlich die XML-Quelldatei bearbeitet wird. Aus dieser werden
9161 dann mit entsprechenden Stylesheets andere Formate wie PDF oder HTML
9162 erzeugt. Bei kivitendo übernimmt diese Aufgabe das Shell-Script
9163 <command>scripts/build_doc.sh</command>.</para>
9165 <para>Das Script benötigt zur Konvertierung verschiedene
9166 Softwarekomponenten, die im normalen kivitendo-Betrieb nicht benötigt
9172 url="http://www.oracle.com/technetwork/java/index.html">Java</ulink>
9173 in einer halbwegs aktuellen Version</para>
9177 <para>Das Java-Build-System <ulink
9178 url="http://ant.apache.org/">Apache Ant</ulink></para>
9182 <para>Das Dokumentations-System Dobudish für
9183 <productname>DocBook</productname> 4.5, eine Zusammenstellung
9184 diverser Stylesheets und Grafiken zur Konvertierung von
9185 <productname>DocBook</productname> XML in andere Formate. Das
9186 Paket, das benötigt wird, ist zum Zeitpunkt der
9187 Dokumentationserstellung
9188 <filename>dobudish-nojre-1.1.4.zip</filename>, aus auf <ulink
9189 url="http://code.google.com/p/dobudish/downloads/list">code.google.com</ulink>
9194 <para>Apache Ant sowie ein dazu passendes Java Runtime Environment
9195 sind auf allen gängigen Plattformen verfügbar. Beispiel für
9196 Debian/Ubuntu:</para>
9198 <programlisting>apt-get install ant openjdk-7-jre</programlisting>
9200 <para>Nach dem Download von Dobudish muss Dobudish im Unterverzeichnis
9201 <filename>doc/build</filename> entpackt werden. Beispiel unter der
9202 Annahme, das <productname>Dobudish</productname> in
9203 <filename>$HOME/Downloads</filename> heruntergeladen wurde:</para>
9205 <programlisting>cd doc/build
9206 unzip $HOME/Downloads/dobudish-nojre-1.1.4.zip</programlisting>
9209 <sect2 id="devel.build-doc.build">
9210 <title>PDFs und HTML-Seiten erstellen</title>
9212 <para>Die eigentliche Konvertierung erfolgt nach Installation der
9213 benötigten Software mit einem einfachen Aufruf direkt aus dem
9214 kivitendo-Installationsverzeichnis heraus:</para>
9216 <programlisting>./scripts/build_doc.sh</programlisting>
9219 <sect2 id="devel.build-doc.repository">
9220 <title>Einchecken in das Git-Repository</title>
9222 <para>Sowohl die XML-Datei als auch die erzeugten PDF- und
9223 HTML-Dateien sind Bestandteil des Git-Repositories. Daraus folgt, dass
9224 nach Änderungen am XML die PDF- und HTML-Dokumente ebenfalls gebaut
9225 und alles zusammen in einem Commit eingecheckt werden sollten.</para>
9227 <para>Die "<filename>dobudish</filename>"-Verzeichnisse bzw.
9228 symbolischen Links gehören hingegen nicht in das Repository.</para>