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.1: 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:32443">https://forum.kivitendo.de:32443</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>
128 <para>16.04 "Xenial Xerus" LTS und 18.04 "Bionic Beaver" LTS
133 <para>openSUSE 15.0</para>
137 <para>Fedora 29</para>
142 <sect2 id="Pakete" xreflabel="Pakete">
143 <title>Benötigte Perl-Pakete installieren</title>
145 <para>Zum Betrieb von kivitendo werden zwingend ein Webserver (meist
146 Apache) und ein Datenbankserver (PostgreSQL) in einer aktuellen
147 Version (s.a. Liste der unterstützten Betriebssysteme)
150 <para>Zusätzlich benötigt kivitendo einige Perl-Pakete, die nicht
151 Bestandteil einer Standard-Perl-Installation sind. Um zu überprüfen,
152 ob die erforderlichen Pakete installiert und aktuell genug sind, wird
153 ein Script mitgeliefert, das wie folgt aufgerufen wird:</para>
155 <programlisting>./scripts/installation_check.pl</programlisting>
157 <para>Die vollständige Liste der benötigten Perl-Module lautet:</para>
161 <para><literal>Algorithm::CheckDigits</literal></para>
165 <para><literal>Archive::Zip</literal></para>
169 <para><literal>CGI</literal></para>
173 <para><literal>Clone</literal></para>
177 <para><literal>Config::Std</literal></para>
181 <para><literal>Daemon::Generic</literal></para>
185 <para><literal>DateTime</literal></para>
189 <para><literal>DateTime::Event::Cron</literal></para>
193 <para><literal>DateTime::Format::Strptime</literal></para>
197 <para><literal>DateTime::Set</literal></para>
201 <para><literal>DBI</literal></para>
205 <para><literal>DBD::Pg</literal></para>
209 <para><literal>Email::Address</literal></para>
213 <para><literal>Email::MIME</literal></para>
217 <para><literal>FCGI</literal> (nicht Versionen 0.68 bis 0.71
218 inklusive; siehe <xref
219 linkend="Apache-Konfiguration.FCGI.WebserverUndPlugin"/>)</para>
223 <para><literal>File::Copy::Recursive</literal></para>
227 <para><literal>File::Flock</literal></para>
231 <para><literal>File::MimeInfo</literal></para>
235 <para><literal>File::Slurp</literal></para>
239 <para><literal>GD</literal></para>
243 <para><literal>HTML::Parser</literal></para>
247 <para><literal>HTML::Restrict</literal></para>
251 <para><literal>Image::Info</literal></para>
255 <para><literal>JSON</literal></para>
259 <para><literal>List::MoreUtils</literal></para>
263 <para><literal>List::UtilsBy</literal></para>
267 <para>LWP::Authen::Digest</para>
271 <para>LWP::UserAgent</para>
275 <para><literal>Net::SMTP::SSL</literal> (optional, bei
276 E-Mail-Versand über SSL; siehe Abschnitt "<xref
277 linkend="config.sending-email.smtp"/>")</para>
281 <para><literal>Net::SSLGlue</literal> (optional, bei
282 E-Mail-Versand über TLS; siehe Abschnitt "<xref
283 linkend="config.sending-email.smtp"/>")</para>
287 <para><literal>Params::Validate</literal></para>
291 <para><literal>PBKDF2::Tiny</literal></para>
295 <para><literal>PDF::API2</literal></para>
299 <para><literal>Regexp::IPv6</literal></para>
303 <para><literal>Rose::Object</literal></para>
307 <para><literal>Rose::DB</literal></para>
311 <para><literal>Rose::DB::Object</literal> Version 0.788 oder
316 <para><literal>Set::Infinite</literal></para>
320 <para><literal>Set::Crontab</literal></para>
324 <para><literal>String::ShellQuote</literal></para>
328 <para><literal>Sort::Naturally</literal></para>
332 <para><literal>Template</literal></para>
336 <para><literal>Text::CSV_XS</literal></para>
340 <para><literal>Text::Iconv</literal></para>
344 <para><literal>Text::Unidecode</literal></para>
348 <para><literal>URI</literal></para>
352 <para><literal>XML::Writer</literal></para>
356 <para><literal>YAML</literal></para>
360 <para>Seit Version größer v3.5.1 sind die folgenden Pakete hinzugekommen: <literal>Set::Infinite</literal>,
361 <literal>List::UtilsBy</literal>, <literal>DateTime::Set</literal>, <literal>DateTime::Event::Cron</literal>
362 <literal>Daemon::Generic</literal> <literal>DateTime::Event::Cron</literal> <literal>File::Flock</literal>
363 <literal>File::Slurp</literal> <literal>Set::Crontab</literal> <literal>Exception::Lite</literal>. Für die letzten beiden Module
364 liefert kivitendo fallback-Module aus, da diese überhaupt nicht in debian oder in der benötigten Version zu Verfügung stehen (Stand
367 <para>Seit Version größer v3.5.0 sind die folgenden Pakete
368 hinzugekommen: <literal>Text::Unidecode</literal>,
369 <literal>LWP::Authen::Digest</literal>,
370 <literal>LWP::UserAgent</literal></para>
372 <para>Seit Version v3.4.0 sind die folgenden Pakete hinzugekommen:
373 <literal>Algorithm::CheckDigits</literal>,
374 <literal>PBKDF2::Tiny</literal></para>
376 <para>Seit Version v3.2.0 sind die folgenden Pakete hinzugekommen:
377 <literal>GD</literal>, <literal>HTML::Restrict</literal>,
378 <literal>Image::Info</literal></para>
380 <para>Seit v3.0.0 sind die folgenden Pakete hinzugekommen:
381 <literal>File::Copy::Recursive</literal>.</para>
383 <para>Seit v2.7.0 sind die folgenden Pakete hinzugekommen:
384 <literal>Email::MIME</literal>, <literal>Net::SMTP::SSL</literal>,
385 <literal>Net::SSLGlue</literal>.</para>
387 <para>Gegenüber Version 2.6.0 sind zu dieser Liste 2 Pakete
388 hinzugekommen, <literal>URI</literal> und
389 <literal>XML::Writer</literal> sind notwendig. Ohne startet kivitendo
392 <para>Gegenüber Version 2.6.1 sind <literal>parent</literal>,
393 <literal>DateTime</literal>, <literal>Rose::Object</literal>,
394 <literal>Rose::DB</literal> und <literal>Rose::DB::Object</literal>
395 neu hinzugekommen. <literal>IO::Wrap</literal> wurde entfernt.</para>
397 <para>Gegenüber Version 2.6.3 ist <literal>JSON</literal> neu
398 hinzugekommen.</para>
400 <para><literal>Email::Address</literal> und
401 <literal>List::MoreUtils</literal> sind schon länger feste
402 Abhängigkeiten, wurden aber bisher mit kivitendo mitgeliefert. Beide
403 sind auch in 2.6.1 weiterhin mit ausgeliefert, wurden in einer
404 zukünftigen Version aber aus dem Paket entfernt werden. Es wird
405 empfohlen diese Module zusammen mit den anderen als Bibliotheken zu
409 <title>Debian und Ubuntu</title>
411 <para>Für Debian und Ubuntu stehen die meisten der benötigten
412 Pakete als Debian-Pakete zur Verfügung. Sie können mit
413 folgendem Befehl installiert werden:</para>
415 <programlisting>apt install apache2 libarchive-zip-perl libclone-perl \
416 libconfig-std-perl libdatetime-perl libdbd-pg-perl libdbi-perl \
417 libemail-address-perl libemail-mime-perl libfcgi-perl libjson-perl \
418 liblist-moreutils-perl libnet-smtp-ssl-perl libnet-sslglue-perl \
419 libparams-validate-perl libpdf-api2-perl librose-db-object-perl \
420 librose-db-perl librose-object-perl libsort-naturally-perl \
421 libstring-shellquote-perl libtemplate-perl libtext-csv-xs-perl \
422 libtext-iconv-perl liburi-perl libxml-writer-perl libyaml-perl \
423 libimage-info-perl libgd-gd2-perl libapache2-mod-fcgid \
424 libfile-copy-recursive-perl postgresql libalgorithm-checkdigits-perl \
425 libcrypt-pbkdf2-perl git libcgi-pm-perl libtext-unidecode-perl libwww-perl\
426 postgresql-contrib aqbanking-tools poppler-utils libhtml-restrict-perl\
427 libdatetime-set-perl libset-infinite-perl liblist-utilsby-perl\
428 libdaemon-generic-perl libfile-flock-perl libfile-slurp-perl
431 <para>Ab Ubuntu Version 18.04 LTS sind alle benötigten Pakete in der Distributions verfügbar.</para>
432 <para>Für ältere Ubuntu/Debians müßen einige Pakete per CPAN installiert werden.
433 Das geht bspw. für das benötige Paket HTML::Restrict mit:</para>
435 <programlisting>apt-get install build-essential
436 cpan HTML::Restrict</programlisting>
440 <title>Fedora</title>
442 <para>Für Fedora stehen die meisten der benötigten Perl-Pakete als
443 RPM-Pakete zur Verfügung. Sie können mit folgendem Befehl
444 installiert werden:</para>
446 <programlisting>dnf install httpd mod_fcgid postgresql-server \
447 perl-Algorithm-CheckDigits perl-Archive-Zip perl-CPAN perl-Class-XSAccessor \
448 perl-Clone perl-Config-Std perl-DBD-Pg perl-DBI perl-Daemon-Generic \
449 perl-DateTime perl-DateTime-Set perl-Email-Address perl-Email-MIME perl-FCGI \
450 perl-File-Copy-Recursive perl-File-Flock perl-File-MimeInfo perl-File-Slurp \
451 perl-GD perl-HTML-Restrict perl-JSON perl-List-MoreUtils perl-List-UtilsBy \
452 perl-Net-SMTP-SSL perl-Net-SSLGlue perl-PBKDF2-Tiny perl-PDF-API2 \
453 perl-Params-Validate perl-Regexp-IPv6 perl-Rose-DB perl-Rose-DB-Object \
454 perl-Rose-Object perl-Sort-Naturally perl-String-ShellQuote \
455 perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv perl-URI perl-XML-Writer \
456 perl-YAML perl-libwww-perl</programlisting>
460 <title>openSUSE</title>
462 <para>Für openSUSE stehen die meisten der benötigten Perl-Pakete als
463 RPM-Pakete zur Verfügung. Sie können mit folgendem Befehl
464 installiert werden:</para>
466 <programlisting>zypper install apache2 apache2-mod_fcgid postgresql-server \
467 perl-Algorithm-CheckDigits perl-Archive-Zip perl-CGI perl-Class-XSAccessor \
468 perl-Clone perl-Config-Std perl-DBD-Pg perl-DBI perl-Daemon-Generic \
469 perl-DateTime perl-DateTime-Format-Strptime perl-Email-Address \
470 perl-Email-MIME perl-FastCGI perl-File-Copy-Recursive perl-File-Flock \
471 perl-File-MimeInfo perl-File-Slurp perl-GD perl-Image-Info perl-JSON \
472 perl-List-MoreUtils perl-List-UtilsBy perl-Net-SMTP-SSL perl-Net-SSLGlue \
473 perl-PDF-API2 perl-Params-Validate perl-Regexp-IPv6 perl-Set-Crontab \
474 perl-Sort-Naturally perl-String-ShellQuote perl-Template-Toolkit \
475 perl-Text-CSV_XS perl-Text-Iconv perl-Text-Unidecode perl-URI \
476 perl-XML-Writer perl-YAML perl-libwww-perl
479 <para>Zusätzlich müssen einige Pakete aus dem CPAN installiert
480 werden. Dazu können Sie die folgenden Befehle nutzen:</para>
482 <programlisting>cpan DateTime::event::Cron DateTime::Set FCGI \
483 HTML::Restrict PBKDF2::Tiny Rose::Db::Object Set::Infinite</programlisting>
488 <title>Andere Pakete installieren</title>
490 <para>Seit Version v3.4.0 wird für den Bankimport optional das Paket
491 'aqbanking-tools' benötigt.</para>
493 <para>Debian und Ubuntu: <programlisting>apt install aqbanking-tools
494 </programlisting></para>
496 <para>Fedora: <programlisting>dnf install aqbanking</programlisting></para>
498 <para>openSUSE: <programlisting>zypper install aqbanking-tools</programlisting></para>
500 <para>Seit Version v3.4.1 wird generell zum Feststellen der
501 Seitenanzahl von PDF_Dokumenten 'pdfinfo' benötigt was im Paket
502 'poppler-utils' enthalten ist.</para>
504 <para>Debian und Ubuntu: <programlisting>apt install poppler-utils
505 </programlisting></para>
507 <para>Fedora: <programlisting>dnf install poppler-utils</programlisting></para>
509 <para>openSUSE: <programlisting>zypper install poppler-tools</programlisting></para>
513 <sect1 id="Manuelle-Installation-des-Programmpaketes"
514 xreflabel="Manuelle Installation des Programmpaketes">
515 <title>Manuelle Installation des Programmpaketes</title>
517 <para>Der aktuelle Stable-Release, bzw. beta Release wird bei github
518 gehostet und kann <ulink
519 url="https://github.com/kivitendo/kivitendo-erp/releases">hier</ulink>
520 heruntergeladen werden.</para>
522 <para>Die kivitendo ERP Installationsdatei
523 (<filename>kivitendo-erp-3.4.1.tgz</filename>) wird im
524 Dokumentenverzeichnis des Webservers (z.B.
525 <filename>/var/www/html/</filename>,
526 <filename>/srv/www/htdocs</filename> oder
527 <filename>/var/www/</filename>) entpackt:</para>
529 <programlisting>cd /var/www
530 tar xvzf kivitendo-erp-3.4.1.tgz</programlisting>
532 <para>Wechseln Sie in das entpackte Verzeichnis:</para>
534 <programlisting>cd kivitendo-erp</programlisting>
536 <para>Alternativ können Sie auch einen Alias in der
537 Webserverkonfiguration benutzen, um auf das tatsächliche
538 Installationsverzeichnis zu verweisen.</para>
540 <para>Bei einer Neuinstallation von Version 3.1.0 oder später muß das
541 WebDAV Verzeichnis derzeit manuell angelegt werden:</para>
543 <programlisting>mkdir webdav</programlisting>
545 <para>Die Verzeichnisse <filename>users</filename>,
546 <filename>spool</filename> und <filename>webdav</filename> müssen für
547 den Benutzer beschreibbar sein, unter dem der Webserver läuft. Die
548 restlichen Dateien müssen für diesen Benutzer lesbar sein. Die Benutzer-
549 und Gruppennamen sind bei verschiedenen Distributionen unterschiedlich
550 (z.B. bei Debian/Ubuntu <constant>www-data</constant>, bei Fedora
551 <constant>apache</constant> oder bei openSUSE
552 <constant>wwwrun</constant>).</para>
554 <para>Der folgende Befehl ändert den Besitzer für die oben genannten
555 Verzeichnisse auf einem Debian/Ubuntu-System:</para>
557 <programlisting>chown -R www-data users spool webdav</programlisting>
559 <para>Weiterhin muss der Webserver-Benutzer in den Verzeichnissen
560 <filename>templates</filename> und <filename>users</filename>
561 Unterverzeichnisse für jeden neuen Benutzer anlegen dürfen, der in
562 kivitendo angelegt wird:</para>
564 <programlisting>chown www-data templates users</programlisting>
567 <para>Wir empfehlen eine Installation mittels des Versionsmanagager
568 git. Hierfür muss ein git-Client installiert sein. Damit ist man sehr
569 viel flexibler für zukünftige Upgrades. Installations-Anleitung (bitte
570 die Pfade anpassen) bspw. wie folgt: <programlisting>cd /var/www/
571 git clone https://github.com/kivitendo/kivitendo-erp.git
573 git checkout `git tag -l | egrep -ve "(alpha|beta|rc)" | tail -1`</programlisting>
574 Erläuterung: Der Befehl wechselt zur letzten Stable-Version (git tag
575 -l listet alle Tags auf, das egrep schmeisst alle Einträge mit alpha,
576 beta oder rc raus und das tail gibt davon den obersten Treffer
577 zurück). Sehr sinnvoll ist es, direkt im Anschluss einen eigenen
578 Branch zu erzeugen, um bspw. seine eigenen Druckvorlagen-Anpassungen
579 damit zu verwalten. Hierfür reicht ein simples <programlisting> git checkout -b meine_eigenen_änderungen</programlisting>
580 nach dem letzten Kommando (weiterführende Informationen <ulink
581 url="http://www-cs-students.stanford.edu/~blynn/gitmagic/index.html">
582 Git Magic</ulink>).</para>
584 <para>Ein beispielhafter Workflow für Druckvorlagen-Anpassungen von
585 3.4.1 nach 3.5: <programlisting>
586 $ git clone https://github.com/kivitendo/kivitendo-erp.git
588 $ git checkout release-3.4.1 # das ist der aktuelle release, den wir wollen
589 $ git add templates/fullhouse # das sind unsere druckvorlagen inkl. produktbilder
590 $ git commit -m "juhu tolle ändernungen"
591 [meine_aenderungen 1d89e41] juhu tolle ändernungen
592 4 files changed, 380 insertions(+)
593 create mode 100644 templates/fullhouse/img/webdav/tesla.png
594 create mode 100644 templates/fullhouse/mahnung.tex
595 create mode 100644 templates/fullhouse/zahlungserinnerung_zwei.tex
596 create mode 100644 templates/fullhouse/zahlungserinnerung_zwei_invoice.tex
601 $ git rebase --onto release-3.5.0 release-3.4.1 meine_aenderungen
602 Zunächst wird der Branch zurückgespult, um Ihre Änderungen
603 darauf neu anzuwenden ...
604 Wende an: juhu tolle ändernungen
605 $ service apache2 restart
606 </programlisting></para>
610 <sect1 id="config.config-file">
611 <title>kivitendo-Konfigurationsdatei</title>
613 <sect2 id="config.config-file.introduction"
614 xreflabel="Einführung in die Konfigurationsdatei">
615 <title>Einführung</title>
617 <para>In kivitendo gibt es nur noch eine Konfigurationsdatei, die
618 benötigt wird: <filename>config/kivitendo.conf</filename> (kurz: "die
619 Hauptkonfigurationsdatei"). Diese muss bei der Erstinstallation von
620 kivitendo bzw. der Migration von älteren Versionen angelegt
623 <para>Als Vorlage dient die Datei
624 <filename>config/kivitendo.conf.default</filename> (kurz: "die
625 Default-Datei"):</para>
627 <programlisting>$ cp config/kivitendo.conf.default config/kivitendo.conf</programlisting>
629 <para>Die Default-Datei wird immer zuerst eingelesen. Werte, die in
630 der Hauptkonfigurationsdatei stehen, überschreiben die Werte aus der
631 Default-Datei. Die Hauptkonfigurationsdatei muss also nur die
632 Abschnitte und Werte enthalten, die von denen der Default-Datei
636 <para>Vor der Umbenennung in kivitendo hieß diese Datei noch
637 <filename>config/lx_office.conf</filename>. Aus Gründen der
638 Kompatibilität wird diese Datei eingelesen, sofern die Datei
639 <filename>config/kivitendo.conf</filename> nicht existiert.</para>
642 <para>Diese Hauptkonfigurationsdatei ist dann eine
643 installationsspezifische Datei, d.h. sie enthält bspw. lokale
644 Passwörter und wird auch nicht im Versionsmanagement (git)
647 <para>Die Konfiguration ist ferner serverabhängig, d.h. für alle
648 Mandaten, bzw. Datenbanken gleich.</para>
651 <sect2 id="config.config-file.sections-parameters">
652 <title>Abschnitte und Parameter</title>
654 <para>Die Konfigurationsdatei besteht aus mehreren Teilen, die
655 entsprechend kommentiert sind:</para>
659 <para><literal>authentication</literal> (siehe Abschnitt "<xref
660 linkend="Benutzerauthentifizierung-und-Administratorpasswort"/>"
661 in diesem Kapitel)</para>
665 <para><literal>authentication/database</literal></para>
669 <para><literal>authentication/ldap</literal></para>
673 <para><literal>system</literal></para>
677 <para><literal>paths</literal></para>
681 <para><literal>mail_delivery</literal> (siehe Abschnitt "<xref
682 linkend="config.sending-email.smtp"/>)</para>
686 <para><literal>applications</literal></para>
690 <para><literal>environment</literal></para>
694 <para><literal>print_templates</literal></para>
698 <para><literal>task_server</literal></para>
702 <para><literal>periodic_invoices</literal></para>
706 <para><literal>self_tests</literal></para>
710 <para><literal>console</literal></para>
714 <para><literal>testing</literal></para>
718 <para><literal>testing/database</literal></para>
722 <para><literal>debug</literal></para>
726 <para>Die üblicherweise wichtigsten Parameter, die am Anfang
727 einzustellen oder zu kontrollieren sind, sind:</para>
729 <programlisting>[authentication]
730 admin_password = geheim
732 [authentication/database]
740 default_manager = german</programlisting>
742 <para>Für kivitendo Installationen in der Schweiz sollte hier
743 <varname>german</varname> durch <varname>swiss</varname> ersetzt
746 <para>Die Einstellung <varname>default_manager = swiss</varname>
751 <para>Beim Erstellen einer neuen Datenbank in der kivitendo
752 Administration werden automatisch die Standard-Werte für die
753 Schweiz voreingestellt: Währung CHF, 5er-Rundung, Schweizer
754 KMU-Kontenplan, Sollversteuerung, Aufwandsmethode, Bilanzierung
755 (die Werte können aber manuell angepasst werden).</para>
759 <para>Einstellen der Standardkonten für Rundungserträge und
760 -aufwendungen (unter Mandantenkonfiguration → Standardkonten
765 <para>das verwendete Zahlenformat wird auf
766 <varname>1'000.00</varname> eingestellt (unter Programm →
767 Benutzereinstellungen veränderbar)</para>
771 <para>DATEV-Automatik und UStVA werden nicht angezeigt,
772 Erfolgsrechnung ersetzt GUV ( unter Mandantenkonfiguration →
773 Features veränderbar)</para>
777 <para>Nutzt man wiederkehrende Rechnungen, kann man unter
778 <varname>[periodic_invoices]</varname> den Login eines Benutzers
779 angeben, der nach Erstellung der Rechnungen eine entsprechende E-Mail
780 mit Informationen über die erstellten Rechnungen bekommt.</para>
782 <para>kivitendo bringt eine eigene Komponente zur zeitgesteuerten
783 Ausführung bestimmter Aufgaben mit, den <link
784 linkend="config.task-server">Taskserver</link>. Er wird u.a. für
785 Features wie die <link
786 linkend="features.periodic-invoices">wiederkehrenden Rechnungen</link>
787 benötigt, erledigt aber auch andere erforderliche Aufgaben und muss
788 daher in Betrieb genommen werden. Seine Einrichtung wird im Abschnitt
789 <link linkend="config.task-server">Task-Server</link> genauer
792 <para>Für Entwickler finden sich unter <varname>[debug]</varname>
793 wichtige Funktionen, um die Fehlersuche zu erleichtern.</para>
796 <sect2 id="config.config-file.prior-versions">
797 <title>Versionen vor 2.6.3</title>
799 <para>In älteren kivitendo Versionen gab es im Verzeichnis
800 <filename>config</filename> die Dateien
801 <filename>authentication.pl</filename> und
802 <filename>lx-erp.conf</filename>, die jeweils Perl-Dateien waren. Es
803 gab auch die Möglichkeit, eine lokale Version der Konfigurationsdatei
804 zu erstellen (<filename>lx-erp-local.conf</filename>). Dies ist ab
805 2.6.3 nicht mehr möglich, aber auch nicht mehr nötig.</para>
807 <para>Beim Update von einer kivitendo-Version vor 2.6.3 auf 2.6.3 oder
808 jünger müssen die Einstellungen aus den alten Konfigurationsdateien
809 manuell übertragen und die alten Konfigurationsdateien anschließend
810 gelöscht oder verschoben werden. Ansonsten zeigt kivitendo eine
811 entsprechende Fehlermeldung an.</para>
815 <sect1 id="Anpassung-der-PostgreSQL-Konfiguration">
816 <title>Anpassung der PostgreSQL-Konfiguration</title>
818 <para>PostgreSQL muss auf verschiedene Weisen angepasst werden.</para>
820 <sect2 id="Zeichensätze-die-Verwendung-von-UTF-8">
821 <title>Zeichensätze/die Verwendung von Unicode/UTF-8</title>
823 <para>kivitendo setzt zwingend voraus, dass die Datenbank
824 Unicode/UTF-8 als Encoding einsetzt. Bei aktuellen
825 Serverinstallationen braucht man hier meist nicht einzugreifen.</para>
827 <para>Das Encoding des Datenbankservers kann überprüft werden. Ist das
828 Encoding der Datenbank "template1" "Unicode" bzw. "UTF-8", so braucht
829 man nichts weiteres diesbezüglich unternehmen. Zum Testen:</para>
831 <programlisting>su postgres
833 exit </programlisting>
835 <para>Andernfalls ist es notwendig, einen neuen Datenbankcluster mit
836 Unicode-Encoding anzulegen und diesen zu verwenden. Unter Debian und
837 Ubuntu kann dies z.B. für PostgreSQL 9.3 mit dem folgenden Befehl
840 <programlisting>pg_createcluster --locale=de_DE.UTF-8 --encoding=UTF-8 9.3 clustername</programlisting>
842 <para>Die Datenbankversionsnummer muss an die tatsächlich verwendete
843 Versionsnummer angepasst werden.</para>
845 <para>Unter anderen Distributionen gibt es ähnliche Methoden.</para>
847 <para>Das Encoding einer Datenbank kann in <command>psql</command> mit
848 <literal>\l</literal> geprüft werden.</para>
851 <sect2 id="Änderungen-an-Konfigurationsdateien">
852 <title>Änderungen an Konfigurationsdateien</title>
854 <para>In der Datei <filename>postgresql.conf</filename>, die je nach
855 Distribution in verschiedenen Verzeichnissen liegen kann (z.B.
856 <filename>/var/lib/pgsql/data/</filename> oder
857 <filename>/etc/postgresql/</filename>), muss sichergestellt werden,
858 dass TCP/IP-Verbindungen aktiviert sind. Das Verhalten wird über den
859 Parameter <varname>listen_address</varname> gesteuert. Laufen
860 PostgreSQL und kivitendo auf demselben Rechner, so kann dort der Wert
861 <literal>localhost</literal> verwendet werden. Andernfalls müssen
862 Datenbankverbindungen auch von anderen Rechnern aus zugelassen werden,
863 was mit dem Wert <literal>*</literal> geschieht.</para>
865 <para>In der Datei <filename>pg_hba.conf</filename>, die im gleichen
866 Verzeichnis wie die <filename>postgresql.conf</filename> zu finden
867 sein sollte, müssen die Berechtigungen für den Zugriff geändert
868 werden. Hier gibt es mehrere Möglichkeiten. Sinnvoll ist es nur die
869 nötigen Verbindungen immer zuzulassen, für eine lokal laufende
870 Datenbank zum Beispiel:</para>
872 <programlisting>local all kivitendo password
873 host all kivitendo 127.0.0.1 255.255.255.255 password</programlisting>
876 <sect2 id="Erweiterung-für-servergespeicherte-Prozeduren">
877 <title>Erweiterung für servergespeicherte Prozeduren</title>
879 <para>In der Datenbank <literal>template1</literal> muss die
880 Unterstützung für servergespeicherte Prozeduren eingerichet werden.
881 Melden Sie sich dafür als Benutzer “postgres” an der Datenbank an:
882 <programlisting>su - postgres
883 psql template1</programlisting> führen Sie die folgenden Kommandos aus:</para>
885 <programlisting>CREATE EXTENSION IF NOT EXISTS plpgsql;
889 <para><literal>CREATE EXTENSION</literal> ist seit Version 9.1 die
890 bevorzugte Syntax um die Sprache <literal>plpgsql</literal>
891 anzulegen. In diesen Versionen ist die Extension meist auch schon
892 vorhanden. Sollten Sie eine ältere Version von Postgres haben,
893 benutzen Sie stattdessen den folgenden Befehl.</para>
895 <programlisting>CREATE LANGUAGE 'plpgsql';
900 <sect2 id="Erweiterung-für-trigram">
901 <title>Erweiterung für Trigram Prozeduren</title>
903 <para>Ab Version 3.5.1 wird die Trigram-Index-Erweiterung benötigt.
904 Diese wird mit dem SQL-Updatescript
905 sql/Pg-upgrade2/trigram_extension.sql und Datenbank-Super-Benutzer
906 Rechten automatisch installiert. Dazu braucht der
907 DatenbankSuperbenutzer "postgres" ein Passwort.</para>
909 <programlisting>su - postgres
916 <para>Benutzername Postgres und Passwort können jetzt beim Anlegen
917 einer Datenbank bzw. bei Updatescripten, die SuperuserRechte
918 benötigen, eingegeben werden.</para>
921 <para><literal>pg_trgm</literal> ist je nach Distribution nicht im
922 Standard-Paket von Postgres enthalten. Ein <programlisting>select * from pg_available_extensions where name ='pg_trgm';</programlisting>
923 in template1 sollte entsprechend erfolgreich sein. Andernfalls muss
924 das Paket nachinstalliert werden, bspw. bei debian/ubuntu
925 <programlisting>apt install postgresql-contrib</programlisting></para>
929 <sect2 id="Datenbankbenutzer-anlegen">
930 <title>Datenbankbenutzer anlegen</title>
932 <para>Wenn Sie nicht den Datenbanksuperuser “postgres” zum Zugriff
933 benutzen wollen, so sollten Sie bei PostgreSQL einen neuen Benutzer
934 anlegen. Ein Beispiel, wie Sie einen neuen Benutzer anlegen
937 <para>Die Frage, ob der neue User Superuser sein soll, können Sie mit
938 nein beantworten, genauso ist die Berechtigung neue User (Roles) zu
939 generieren nicht nötig.</para>
941 <programlisting>su - postgres
942 createuser -d -P kivitendo
943 exit</programlisting>
945 <para>Wenn Sie später einen Datenbankzugriff konfigurieren, verändern
946 Sie den evtl. voreingestellten Benutzer “postgres” auf “kivitendo”
947 bzw. den hier gewählten Benutzernamen.</para>
951 <sect1 id="Apache-Konfiguration">
952 <title>Webserver-Konfiguration</title>
955 <title>Grundkonfiguration mittels CGI</title>
958 <para>Für einen deutlichen Performanceschub sorgt die Ausführung
959 mittels FastCGI/FCGI. Die Einrichtung wird ausführlich im Abschnitt
960 <xref linkend="Apache-Konfiguration.FCGI"/> beschrieben.</para>
963 <para>Der Zugriff auf das Programmverzeichnis muss in der Apache
964 Webserverkonfigurationsdatei <literal>httpd.conf</literal> eingestellt
965 werden. Fügen Sie den folgenden Abschnitt dieser Datei oder einer
966 anderen Datei hinzu, die beim Starten des Webservers eingelesen
969 <programlisting>AliasMatch ^/kivitendo-erp/[^/]+\.pl /var/www/kivitendo-erp/dispatcher.pl
970 Alias /kivitendo-erp/ /var/www/kivitendo-erp/
972 <Directory /var/www/kivitendo-erp>
973 AddHandler cgi-script .pl
974 Options ExecCGI Includes FollowSymlinks
977 <Directory /var/www/kivitendo-erp/users>
979 </Directory></programlisting>
981 <para>Ersetzen Sie dabei die Pfade durch diejenigen, in die Sie vorher
982 das kivitendo-Archiv entpacket haben.</para>
985 <para>Vor den einzelnen Optionen muss bei einigen Distributionen ein
986 Plus ‘<literal>+</literal>’ gesetzt werden.</para>
988 <para>Bei einigen Distribution (Ubuntu ab 14.04, Debian ab 8.2) muss
989 noch explizit das cgi-Modul mittels <programlisting>a2enmod cgi</programlisting>
990 aktiviert werden.</para>
993 <para>Auf einigen Webservern werden manchmal die Grafiken und
994 Style-Sheets nicht ausgeliefert. In solchen Fällen hat es oft
995 geholfen, die folgende Option in die Konfiguration aufzunehmen:</para>
997 <programlisting>EnableSendfile Off</programlisting>
1000 <sect2 id="Apache-Konfiguration.FCGI"
1001 xreflabel="Konfiguration für FastCGI/FCGI">
1002 <title>Konfiguration für FastCGI/FCGI</title>
1004 <sect3 id="Apache-Konfiguration.FCGI.WasIstEs">
1005 <title>Was ist FastCGI?</title>
1007 <para>Direkt aus <ulink
1008 url="http://de.wikipedia.org/wiki/FastCGI">Wikipedia</ulink>
1011 <para><citation> FastCGI ist ein Standard für die Einbindung
1012 externer Software zur Generierung dynamischer Webseiten in einem
1013 Webserver. FastCGI ist vergleichbar zum Common Gateway Interface
1014 (CGI), wurde jedoch entwickelt, um dessen Performance-Probleme zu
1015 umgehen. </citation></para>
1018 <sect3 id="Apache-Konfiguration.FCGI.Warum">
1019 <title>Warum FastCGI?</title>
1021 <para>Perl Programme (wie kivitendo eines ist) werden nicht statisch
1022 kompiliert. Stattdessen werden die Quelldateien bei jedem Start
1023 übersetzt, was bei kurzen Laufzeiten einen Großteil der Laufzeit
1024 ausmacht. Während SQL Ledger einen Großteil der Funktionalität in
1025 einzelne Module kapselt, um immer nur einen kleinen Teil laden zu
1026 müssen, ist die Funktionalität von kivitendo soweit gewachsen, dass
1027 immer mehr Module auf den Rest des Programms zugreifen. Zusätzlich
1028 benutzen wir umfangreiche Bibliotheken um Funktionaltät nicht selber
1029 entwickeln zu müssen, die zusätzliche Ladezeit kosten. All dies
1030 führt dazu dass ein kivitendo Aufruf der Kernmasken mittlerweile
1031 deutlich länger dauert als früher, und dass davon 90% für das Laden
1032 der Module verwendet wird.</para>
1034 <para>Mit FastCGI werden nun die Module einmal geladen, und danach
1035 wird nur die eigentliche Programmlogik ausgeführt.</para>
1038 <sect3 id="Apache-Konfiguration.FCGI.WebserverUndPlugin">
1039 <title>Getestete Kombinationen aus Webservern und Plugin</title>
1041 <para>Folgende Kombinationen sind getestet:</para>
1045 <para>Apache 2.4.7 (Ubuntu 14.04.2 LTS) und mod_fcgid.</para>
1048 <para>Apache 2.4.18 (Ubuntu 16.04 LTS) und mod_fcgid</para>
1051 <para>Apache 2.4.29 (Ubuntu 18.04 LTS) und mod_fcgid</para>
1055 <para>Als Perl Backend wird das Modul <filename>FCGI.pm</filename>
1059 <para>FCGI-Versionen ab 0.69 und bis zu 0.71 inklusive sind extrem
1060 strict in der Behandlung von Unicode, und verweigern bestimmte
1061 Eingaben von kivitendo. Falls es Probleme mit Umlauten in Ihrer
1062 Installation gibt, muss zwingend Version 0.68 oder aber Version
1063 0.72 und neuer eingesetzt werden.</para>
1065 <para>Mit <ulink url="http://www.cpan.org">CPAN</ulink> lässt sie
1066 sich die Vorgängerversion wie folgt installieren:</para>
1068 <programlisting>force install M/MS/MSTROUT/FCGI-0.68.tar.gz</programlisting>
1072 <sect3 id="Apache-Konfiguration.FCGI.Konfiguration">
1073 <title>Konfiguration des Webservers</title>
1075 <para>Bevor Sie versuchen, eine kivitendo Installation unter FCGI
1076 laufen zu lassen, empfiehlt es sich die Installation ersteinmal
1077 unter CGI aufzusetzen. FCGI macht es nicht einfach Fehler zu
1078 debuggen die beim ersten aufsetzen auftreten können. Sollte die
1079 Installation schon funktionieren, lesen Sie weiter.</para>
1081 <para>Zuerst muss das FastCGI-Modul aktiviert werden. Dies kann
1082 unter Debian/Ubuntu z.B. mit folgendem Befehl geschehen:</para>
1084 <programlisting>a2enmod fcgid</programlisting>
1086 <para>Die Konfiguration für die Verwendung von kivitendo mit FastCGI
1087 erfolgt durch Anpassung der vorhandenen <function>Alias</function>-
1088 und <function>Directory</function>-Direktiven. Dabei wird zwischen
1089 dem Installationspfad von kivitendo im Dateisystem
1090 ("<filename>/path/to/kivitendo-erp</filename>") und der URL
1091 unterschieden, unter der kivitendo im Webbrowser erreichbar ist
1092 ("<filename>/url/for/kivitendo-erp</filename>").</para>
1094 <para>Folgender Konfigurationsschnipsel funktioniert mit
1097 <programlisting>AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fcgi
1098 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
1100 <Directory /path/to/kivitendo-erp>
1102 Options ExecCGI Includes FollowSymlinks
1106 <DirectoryMatch /path/to/kivitendo-erp/users>
1108 </DirectoryMatch></programlisting>
1111 <para>Wer einen älteren Apache als Version 2.4 im Einsatz hat,
1112 muss entsprechend die Syntax der Directorydirektiven verändert.
1115 <programlisting>Require all granted</programlisting>
1117 <para>muß man Folgendes einstellen:</para>
1121 Allow from All </programlisting>
1123 <para>und statt</para>
1125 <programlisting>Require all denied</programlisting>
1127 <para>muss stehen:</para>
1131 Deny from All </programlisting>
1134 <para>Seit mod_fcgid-Version 2.3.6 gelten sehr kleine Grenzen für
1135 die maximale Größe eines Requests. Diese sollte wie folgt
1136 hochgesetzt werden:</para>
1138 <programlisting>FcgidMaxRequestLen 10485760</programlisting>
1140 <para>Das Ganze sollte dann so aussehen:</para>
1142 <programlisting>AddHandler fcgid-script .fpl
1143 AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
1144 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
1145 FcgidMaxRequestLen 10485760
1147 <Directory /path/to/kivitendo-erp>
1149 Options ExecCGI Includes FollowSymlinks
1154 <DirectoryMatch /path/to/kivitendo-erp/users>
1157 </DirectoryMatch></programlisting>
1159 <para>Hierdurch wird nur ein zentraler Dispatcher gestartet. Alle
1160 Zugriffe auf die einzelnen Scripte werden auf diesen umgeleitet.
1161 Dadurch, dass zur Laufzeit öfter mal Scripte neu geladen werden,
1162 gibt es hier kleine Performance-Einbußen.</para>
1164 <para>Es ist möglich, die gleiche kivitendo Version parallel unter
1165 CGI und FastCGI zu betreiben. Dafür bleiben die Directorydirektiven
1166 wie oben beschrieben, die URLs werden aber umgeleitet:</para>
1168 <programlisting># Zugriff über CGI
1169 Alias /url/for/kivitendo-erp /path/to/kivitendo-erp
1171 # Zugriff mit mod_fcgid:
1172 AliasMatch ^/url/for/kivitendo-erp-fcgid/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
1173 Alias /url/for/kivitendo-erp-fcgid/ /path/to/kivitendo-erp/</programlisting>
1175 <para>Dann ist unter <filename>/url/for/kivitendo-erp/</filename>
1176 die normale Version erreichbar, und unter
1177 <constant>/url/for/kivitendo-erp-fcgid/</constant> die
1178 FastCGI-Version.</para>
1183 <title>Weitergehende Konfiguration</title>
1185 <para>Für einen deutlichen Sicherheitsmehrwert sorgt die Ausführung
1186 von kivitendo nur über https-verschlüsselten Verbindungen, sowie
1187 weiteren Zusatzmassnahmen, wie beispielsweise Basic Authenticate. Die
1188 Konfigurationsmöglichkeiten sprengen allerdings den Rahmen dieser
1189 Anleitung, hier ein Hinweis auf einen entsprechenden <ulink
1190 url="http://redmine.kivitendo-premium.de/boards/1/topics/142">Foreneintrag
1191 (Stand Sept. 2015)</ulink> und einen aktuellen (Stand Mai 2017) <ulink
1192 url="https://mozilla.github.io/server-side-tls/ssl-config-generator/">
1193 SSL-Konfigurations-Generator</ulink>.</para>
1197 <sect1 id="config.task-server">
1198 <title>Der Task-Server</title>
1200 <para>Der Task-Server ist ein Prozess, der im Hintergrund läuft, in
1201 regelmäßigen Abständen nach abzuarbeitenden Aufgaben sucht und diese zu
1202 festgelegten Zeitpunkten abarbeitet (ähnlich wie Cron). Dieser Prozess
1203 wird u.a. für die Erzeugung der wiederkehrenden Rechnungen und weitere
1204 essenzielle Aufgaben benutzt.</para>
1206 <para>Der Task-Server muss einmalig global in der Konfigurationsdatei
1207 konfiguriert werden. Danach wird er für jeden Mandanten, für den er
1208 laufen soll, in der Adminsitrationsmaske eingeschaltet.</para>
1210 <para>Beachten Sie, dass der Task-Server in den Boot-Vorgang Ihres
1211 Servers integriert werden muss, damit er automatisch gestartet wird.
1212 Dies kann kivitendo nicht für Sie erledigen.</para>
1214 <para>Da der Taskserver als Perlscript läuft, wird Arbeitsspeicher, der
1215 einmal benötigt wurde, nicht mehr an das Betriebssystem zurückgegeben,
1216 solange der Taskserver läuft. Dies kann dazu führen, dass ein länger
1217 laufender Taskserver mit der Zeit immer mehr Arbeitsspeicher für sich
1218 beansprucht. Es ist deshalb sinnvoll, dass der Taskserver in
1219 regelmässigen Abständen neu gestartet wird.</para>
1221 <sect2 id="Konfiguration-des-Task-Servers">
1222 <title>Verfügbare und notwendige Konfigurationsoptionen</title>
1224 <para>Die Konfiguration erfolgt über den Abschnitt
1225 <literal>[task_server]</literal> in der Datei
1226 <filename>config/kivitendo.conf</filename>. Die dort verfügbaren
1227 Optionen sind:</para>
1231 <term><varname>run_as</varname></term>
1234 <para>Wird der Server vom Systembenutzer <literal>root</literal>
1235 gestartet, so wechselt er auf den mit <literal>run_as</literal>
1236 angegebenen Systembenutzer. Der Systembenutzer muss dieselben
1237 Lese- und Schreibrechte haben, wie auch der Webserverbenutzer
1239 linkend="Manuelle-Installation-des-Programmpaketes"/>). Daher
1240 ist es erforderlich, hier denselben Systembenutzer einzutragen,
1241 unter dem auch der Webserver läuft.</para>
1246 <term><varname>debug</varname></term>
1249 <para>Schaltet Debug-Informationen an und aus.</para>
1255 <sect2 id="Konfiguration-der-Mandanten-fuer-den-Task-Servers">
1256 <title>Konfiguration der Mandanten für den Task-Server</title>
1258 <para>Ist der Task-Server grundlegend konfiguriert, so muss
1259 anschließend jeder Mandant, für den der Task-Server laufen soll,
1260 einmalig konfiguriert werden. Dazu kann in der Maske zum Bearbeiten
1261 von Mandanten im Administrationsbereich eine kivitendo-Benutzerkennung
1262 ausgewählt werden, unter der der Task-Server seine Arbeit
1265 <para>Ist in dieser Einstellung keine Benutzerkennung ausgewählt, so
1266 wird der Task-Server für diesen Mandanten keine Aufgaben
1270 <sect2 id="Einbinden-in-den-Boot-Prozess">
1271 <title>Automatisches Starten des Task-Servers beim Booten</title>
1273 <para>Der Task-Server verhält sich von seinen Optionen her wie ein
1274 reguläres SystemV-kompatibles Boot-Script. Außerdem wechselt er beim
1275 Starten automatisch in das kivitendo-Installationsverzeichnis.</para>
1277 <para>Deshalb ist es möglich, ihn durch Setzen eines symbolischen
1278 Links aus einem der Runlevel-Verzeichnisse heraus in den Boot-Prozess
1279 einzubinden. Da das bei neueren Linux-Distributionen aber nicht
1280 zwangsläufig funktioniert, werden auch Start-Scripte mitgeliefert, die
1281 anstelle eines symbolischen Links verwendet werden können.</para>
1284 <title>SystemV-basierende Systeme (z.B. ältere Debian, ältere
1285 openSUSE, ältere Fedora)</title>
1287 <para>Kopieren Sie die Datei
1288 <filename>scripts/boot/system-v/kivitendo-task-server</filename>
1289 nach <filename>/etc/init.d/kivitendo-task-server</filename>. Passen
1290 Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
1291 <literal>DAEMON=....</literal>). Binden Sie das Script in den
1292 Boot-Prozess ein. Dies ist distributionsabhängig:</para>
1296 <para>Debian-basierende Systeme:</para>
1298 <programlisting>update-rc.d kivitendo-task-server defaults
1299 insserv kivitendo-task-server</programlisting>
1303 <para>Ältere openSUSE und ältere Fedora:</para>
1305 <programlisting>chkconfig --add kivitendo-task-server</programlisting>
1309 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
1312 <programlisting>/etc/init.d/kivitendo-task-server start</programlisting>
1316 <title>Upstart-basierende Systeme (z.B. Ubuntu bis 14.04)</title>
1318 <para>Kopieren Sie die Datei
1319 <filename>scripts/boot/upstart/kivitendo-task-server.conf</filename>
1320 nach <filename>/etc/init/kivitendo-task-server.conf</filename>.
1321 Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
1322 <literal>exec ....</literal>).</para>
1324 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
1327 <programlisting>service kivitendo-task-server start</programlisting>
1331 <title>systemd-basierende Systeme (z.B. neure openSUSE, neuere
1332 Fedora, neuere Ubuntu und neuere Debians)</title>
1334 <para>Kopieren Sie die Datei
1335 <filename>scripts/boot/systemd/kivitendo-task-server.service</filename>
1336 nach <filename>/etc/systemd/system/</filename>. Passen Sie in der
1337 kopierten Datei den Pfad zum Task-Server an (Zeilen
1338 <literal>ExecStart=....</literal> und
1339 <literal>ExecStop=...</literal>).</para>
1341 <para>Machen Sie anschließend das Script systemd bekannt, und binden
1342 Sie es in den Boot-Prozess ein. Dazu führen Sie die folgenden Befehl
1345 <programlisting>systemctl daemon-reload
1346 systemctl enable kivitendo-task-server.service</programlisting>
1348 <para>Wenn Sie den Task-Server jetzt sofort starten möchten, anstatt
1349 den Server neu zu starten, so können Sie das mit dem folgenden
1352 <programlisting>systemctl start kivitendo-task-server.service</programlisting>
1356 <sect2 id="Prozesskontrolle">
1357 <title>Wie der Task-Server gestartet und beendet wird</title>
1359 <para>Der Task-Server wird wie folgt kontrolliert:</para>
1361 <programlisting>./scripts/task_server.pl Befehl</programlisting>
1363 <para><literal>Befehl</literal> ist dabei eine der folgenden
1368 <para><literal>start</literal> startet eine neue Instanz des
1369 Task-Servers. Die Prozess-ID wird innerhalb des
1370 <filename>users</filename>-Verzeichnisses abgelegt.</para>
1374 <para><literal>stop</literal> beendet einen laufenden
1379 <para><literal>restart</literal> beendet und startet ihn
1384 <para><literal>status</literal> berichtet, ob der Task-Server
1389 <para>Der Task-Server wechselt beim Starten automatisch in das
1390 kivitendo-Installationsverzeichnis.</para>
1392 <para>Dieselben Optionen können auch für die SystemV-basierenden
1393 Runlevel-Scripte benutzt werden (siehe oben).</para>
1397 <sect1 id="Benutzerauthentifizierung-und-Administratorpasswort">
1398 <title>Benutzerauthentifizierung und Administratorpasswort</title>
1400 <para>Informationen über die Einrichtung der Benutzerauthentifizierung,
1401 über die Verwaltung von Gruppen und weitere Einstellungen</para>
1403 <sect2 id="Grundlagen-zur-Benutzerauthentifizierung">
1404 <title>Grundlagen zur Benutzerauthentifizierung</title>
1406 <para>kivitendo verwaltet die Benutzerinformationen in einer
1407 Datenbank, die im folgenden “Authentifizierungsdatenbank” genannt
1408 wird. Für jeden Benutzer kann dort eine eigene Datenbank für die
1409 eigentlichen Finanzdaten hinterlegt sein. Diese beiden Datenbanken
1410 können, müssen aber nicht unterschiedlich sein.</para>
1412 <para>Im einfachsten Fall gibt es für kivitendo nur eine einzige
1413 Datenbank, in der sowohl die Benutzerinformationen als auch die Daten
1414 abgelegt werden.</para>
1416 <para>Zusätzlich ermöglicht es kivitendo, dass die Benutzerpasswörter
1417 entweder gegen die Authentifizierungsdatenbank oder gegen einen
1418 LDAP-Server überprüft werden.</para>
1420 <para>Welche Art der Passwortüberprüfung kivitendo benutzt und wie
1421 kivitendo die Authentifizierungsdatenbank erreichen kann, wird in der
1422 Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1423 festgelegt. Diese muss bei der Installation und bei einem Upgrade von
1424 einer Version vor v2.6.0 angelegt werden. Eine
1425 Beispielkonfigurationsdatei
1426 <filename>config/kivitendo.conf.default</filename> existiert, die als
1427 Vorlage benutzt werden kann.</para>
1430 <sect2 id="Administratorpasswort">
1431 <title>Administratorpasswort</title>
1433 <para>Das Passwort, das zum Zugriff auf das Administrationsinterface
1434 von kivitendo benutzt wird, wird ebenfalls in dieser Datei
1435 gespeichert. Es kann auch nur dort und nicht mehr im
1436 Administrationsinterface selber geändert werden. Der Parameter dazu
1437 heißt <varname>admin_password</varname> im Abschnitt
1438 <varname>[authentication]</varname>.</para>
1441 <sect2 id="Authentifizierungsdatenbank">
1442 <title>Authentifizierungsdatenbank</title>
1444 <para>Die Verbindung zur Authentifizierungsdatenbank wird mit den
1445 Parametern in <varname>[authentication/database]</varname>
1446 konfiguriert. Hier sind die folgenden Parameter anzugeben:</para>
1450 <term><literal>host</literal></term>
1453 <para>Der Rechnername oder die IP-Adresse des
1454 Datenbankservers</para>
1459 <term><literal>port</literal></term>
1462 <para>Die Portnummer des Datenbankservers, meist 5432</para>
1467 <term><literal>db</literal></term>
1470 <para>Der Name der Authentifizierungsdatenbank</para>
1475 <term><literal>user</literal></term>
1478 <para>Der Benutzername, mit dem sich kivitendo beim
1479 Datenbankserver anmeldet (z.B.
1480 "<literal>postgres</literal>")</para>
1485 <term><literal>password</literal></term>
1488 <para>Das Passwort für den Datenbankbenutzer</para>
1493 <para>Die Datenbank muss noch nicht existieren. kivitendo kann sie
1494 automatisch anlegen (mehr dazu siehe unten).</para>
1497 <sect2 id="Passwortüberprüfung">
1498 <title>Passwortüberprüfung</title>
1500 <para>kivitendo unterstützt Passwortüberprüfung auf zwei Arten: gegen
1501 die Authentifizierungsdatenbank und gegen einen externen LDAP- oder
1502 Active-Directory-Server. Welche davon benutzt wird, regelt der
1503 Parameter <varname>module</varname> im Abschnitt
1504 <varname>[authentication]</varname>.</para>
1506 <para>Sollen die Benutzerpasswörter in der Authentifizierungsdatenbank
1507 gespeichert werden, so muss der Parameter <varname>module</varname>
1508 den Wert <literal>DB</literal> enthalten. In diesem Fall können sowohl
1509 der Administrator als auch die Benutzer selber ihre Passwörter in
1510 kivitendo ändern.</para>
1512 <para>Soll hingegen ein externer LDAP- oder Active-Directory-Server
1513 benutzt werden, so muss der Parameter <varname>module</varname> auf
1514 <literal>LDAP</literal> gesetzt werden. In diesem Fall müssen
1515 zusätzliche Informationen über den LDAP-Server im Abschnitt
1516 <literal>[authentication/ldap]</literal> angegeben werden:</para>
1520 <term><literal>host</literal></term>
1523 <para>Der Rechnername oder die IP-Adresse des LDAP- oder
1524 Active-Directory-Servers. Diese Angabe ist zwingend
1525 erforderlich.</para>
1530 <term><literal>port</literal></term>
1533 <para>Die Portnummer des LDAP-Servers; meist 389.</para>
1538 <term><literal>tls</literal></term>
1541 <para>Wenn Verbindungsverschlüsselung gewünscht ist, so diesen
1542 Wert auf ‘<literal>1</literal>’ setzen, andernfalls auf
1543 ‘<literal>0</literal>’ belassen</para>
1548 <term><literal>attribute</literal></term>
1551 <para>Das LDAP-Attribut, in dem der Benutzername steht, den der
1552 Benutzer eingegeben hat. Für Active-Directory-Server ist dies
1553 meist ‘<literal>sAMAccountName</literal>’, für andere
1554 LDAP-Server hingegen ‘<literal>uid</literal>’. Diese Angabe ist
1555 zwingend erforderlich.</para>
1560 <term><literal>base_dn</literal></term>
1563 <para>Der Abschnitt des LDAP-Baumes, der durchsucht werden soll.
1564 Diese Angabe ist zwingend erforderlich.</para>
1569 <term><literal>filter</literal></term>
1572 <para>Ein optionaler LDAP-Filter. Enthält dieser Filter das Wort
1573 <literal><%login%></literal>, so wird dieses durch den vom
1574 Benutzer eingegebenen Benutzernamen ersetzt. Andernfalls wird
1575 der LDAP-Baum nach einem Element durchsucht, bei dem das oben
1576 angegebene Attribut mit dem Benutzernamen identisch ist.</para>
1581 <term><literal>bind_dn</literal> und
1582 <literal>bind_password</literal></term>
1585 <para>Wenn der LDAP-Server eine Anmeldung erfordert, bevor er
1586 durchsucht werden kann (z.B. ist dies bei
1587 Active-Directory-Servern der Fall), so kann diese hier angegeben
1588 werden. Für Active-Directory-Server kann als
1589 ‘<literal>bind_dn</literal>’ entweder eine komplette LDAP-DN wie
1590 z.B. ‘<literal>cn=Martin
1591 Mustermann,cn=Users,dc=firmendomain</literal>’ auch nur der
1592 volle Name des Benutzers eingegeben werden; in diesem Beispiel
1593 also ‘<literal>Martin Mustermann</literal>’.</para>
1599 <sect2 id="Name-des-Session-Cookies">
1600 <title>Name des Session-Cookies</title>
1602 <para>Sollen auf einem Server mehrere kivitendo-Installationen
1603 aufgesetzt werden, so müssen die Namen der Session-Cookies für alle
1604 Installationen unterschiedlich sein. Der Name des Cookies wird mit dem
1605 Parameter <varname>cookie_name</varname> im Abschnitt
1606 <varname>[authentication]</varname>gesetzt.</para>
1608 <para>Diese Angabe ist optional, wenn nur eine Installation auf dem
1609 Server existiert.</para>
1612 <sect2 id="Anlegen-der-Authentifizierungsdatenbank">
1613 <title>Anlegen der Authentifizierungsdatenbank</title>
1615 <para>Nachdem alle Einstellungen in
1616 <filename>config/kivitendo.conf</filename> vorgenommen wurden, muss
1617 kivitendo die Authentifizierungsdatenbank anlegen. Dieses geschieht
1618 automatisch, wenn Sie sich im Administrationsmodul anmelden, das unter
1619 der folgenden URL erreichbar sein sollte:</para>
1622 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
1626 <sect1 id="Benutzer--und-Gruppenverwaltung">
1627 <title>Mandanten-, Benutzer- und Gruppenverwaltung</title>
1629 <para>Nach der Installation müssen Mandanten, Benutzer, Gruppen und
1630 Datenbanken angelegt werden. Dieses geschieht im Administrationsmenü,
1631 das Sie unter folgender URL finden:</para>
1634 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
1636 <para>Verwenden Sie zur Anmeldung das Passwort, das Sie in der Datei
1637 <filename>config/kivitendo.conf</filename> eingetragen haben.</para>
1639 <sect2 id="Zusammenhänge">
1640 <title>Zusammenhänge</title>
1642 <para>kivitendo verwaltet zwei Sets von Daten, die je nach Einrichtung
1643 in einer oder zwei Datenbanken gespeichert werden.</para>
1645 <para>Das erste Set besteht aus Anmeldeinformationen: welche Benutzer
1646 und Mandanten gibt es, welche Gruppen, welche BenutzerIn hat Zugriff
1647 auf welche Mandanten, und welche Gruppe verfügt über welche Rechte.
1648 Diese Informationen werden in der Authentifizierungsdatenbank
1649 gespeichert. Dies ist diejenige Datenbank, deren Verbindungsparameter
1650 in der Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1651 gespeichert werden.</para>
1653 <para>Das zweite Set besteht aus den eigentlichen Verkehrsdaten eines
1654 Mandanten, wie beispielsweise die Stammdaten (Kunden, Lieferanten,
1655 Waren) und Belege (Angebote, Lieferscheine, Rechnungen). Diese werden
1656 in einer Mandantendatenbank gespeichert. Die Verbindungsinformationen
1657 einer solchen Mandantendatenbank werden im Administrationsbereich
1658 konfiguriert, indem man einen Mandanten anlegt und dort die Parameter
1659 einträgt. Dabei hat jeder Mandant eine eigene Datenbank.</para>
1661 <para>Aufgrund des Datenbankdesigns ist es für einfache Fälle möglich,
1662 die Authentifizierungsdatenbank und eine der Mandantendatenbanken in
1663 ein und derselben Datenbank zu speichern. Arbeitet man hingegen mit
1664 mehr als einem Mandanten, wird empfohlen, für die
1665 Authentifizierungsdatenbank eine eigene Datenbank zu verwenden, die
1666 nicht gleichzeitig für einen Mandanten verwendet wird.</para>
1669 <sect2 id="Mandanten-Benutzer-Gruppen">
1670 <title>Mandanten, Benutzer und Gruppen</title>
1672 <para>kivitendos Administration kennt Mandanten, Benutzer und Gruppen,
1673 die sich frei zueinander zuordnen lassen.</para>
1675 <para>kivitendo kann mehrere Mandaten aus einer Installation heraus
1676 verwalten. Welcher Mandant benutzt wird, kann direkt beim Login
1677 ausgewählt werden. Für jeden Mandanten wird ein eindeutiger Name
1678 vergeben, der beim Login angezeigt wird. Weiterhin benötigt der
1679 Mandant Datenbankverbindungsparameter für seine Mandantendatenbank.
1680 Diese sollte über die <link
1681 linkend="Datenbanken-anlegen">Datenbankverwaltung</link>
1684 <para>Ein Benutzer ist eine Person, die Zugriff auf kivitendo erhalten
1685 soll. Sie erhält einen Loginnamen sowie ein Passwort. Weiterhin legt
1686 der Administrator fest, an welchen Mandanten sich ein Benutzer
1687 anmelden kann, was beim Login verifiziert wird.</para>
1689 <para>Gruppen dienen dazu, Benutzern innerhalb eines Mandanten Zugriff
1690 auf bestimmte Funktionen zu geben. Einer Gruppe werden dafür vom
1691 Administrator gewisse Rechte zugeordnet. Weiterhin legt der
1692 Administrator fest, für welche Mandanten eine Gruppe gilt, und welche
1693 Benutzer Mitglieder in dieser Gruppe sind. Meldet sich ein Benutzer
1694 dann an einem Mandanten an, so erhält er alle Rechte von allen
1695 denjenigen Gruppen, die zum Einen dem Mandanten zugeordnet sind und in
1696 denen der Benutzer zum Anderen Mitglied ist,</para>
1698 <para>Die Reihenfolge, in der Datenbanken, Mandanten, Gruppen und
1699 Benutzer angelegt werden, kann im Prinzip beliebig gewählt werden. Die
1700 folgende Reihenfolge beinhaltet die wenigsten Arbeitsschritte:</para>
1702 <orderedlist numeration="arabic">
1704 <para>Datenbank anlegen</para>
1708 <para>Gruppen anlegen</para>
1712 <para>Benutzer anlegen und Gruppen als Mitglied zuordnen</para>
1716 <para>Mandanten anlegen und Gruppen sowie Benutzer zuweisen</para>
1721 <sect2 id="Datenbanken-anlegen">
1722 <title>Datenbanken anlegen</title>
1724 <para>Zuerst muss eine Datenbank angelegt werden. Verwenden Sie für
1725 den Datenbankzugriff den vorhin angelegten Benutzer (in unseren
1726 Beispielen ist dies ‘<literal>kivitendo</literal>’).</para>
1729 <sect2 id="Gruppen-anlegen">
1730 <title>Gruppen anlegen</title>
1732 <para>Eine Gruppe wird in der Gruppenverwaltung angelegt. Ihr muss ein
1733 Name gegeben werden, eine Beschreibung ist hingegen optional. Nach dem
1734 Anlegen können Sie die verschiedenen Bereiche wählen, auf die
1735 Mitglieder dieser Gruppe Zugriff haben sollen.</para>
1737 <para>Benutzergruppen werden zwar in der Authentifizierungsdatenbank
1738 gespeichert, gelten aber nicht automatisch für alle Mandanten. Der
1739 Administrator legt vielmehr fest, für welche Mandanten eine Gruppe
1740 gültig ist. Dies kann entweder beim Bearbeiten der Gruppe geschehen
1741 ("diese Gruppe ist gültig für Mandanten X, Y und Z"), oder aber wenn
1742 man einen Mandanten bearbeitet ("für diesen Mandanten sind die Gruppen
1743 A, B und C gültig").</para>
1745 <para>Wurden bereits Benutzer angelegt, so können hier die Mitglieder
1746 dieser Gruppe festgelegt werden ("in dieser Gruppe sind die Benutzer
1747 X, Y und Z Mitglieder"). Dies kann auch nachträglich beim Bearbeiten
1748 eines Benutzers geschehen ("dieser Benutzer ist Mitglied in den
1749 Gruppen A, B und C").</para>
1752 <sect2 id="Benutzer-anlegen">
1753 <title>Benutzer anlegen</title>
1755 <para>Beim Anlegen von Benutzern werden für viele Parameter
1756 Standardeinstellungen vorgenommen, die den Gepflogenheiten des
1757 deutschen Raumes entsprechen.</para>
1759 <para>Zwingend anzugeben ist der Loginname. Wenn die
1760 Passwortauthentifizierung über die Datenbank eingestellt ist, so kann
1761 hier auch das Benutzerpasswort gesetzt bzw. geändert werden. Ist
1762 hingegen die LDAP-Authentifizierung aktiv, so ist das Passwort-Feld
1765 <para>Hat man bereits Mandanten und Gruppen angelegt, so kann hier
1766 auch konfiguriert werden, auf welche Mandanten der Benutzer Zugriff
1767 hat bzw. in welchen Gruppen er Mitglied ist. Beide Zuweisungen können
1768 sowohl beim Benutzer vorgenommen werden ("dieser Benutzer hat Zugriff
1769 auf Mandanten X, Y, Z" bzw. "dieser Benutzer ist Mitglied in Gruppen
1770 X, Y und Z") als auch beim Mandanten ("auf diesen Mandanten haben
1771 Benutzer A, B und C Zugriff") bzw. bei der Gruppe ("in dieser Gruppe
1772 sind Benutzer A, B und C Mitglieder").</para>
1775 <sect2 id="Mandanten-anlegen">
1776 <title>Mandanten anlegen</title>
1778 <para>Ein Mandant besteht aus Administrationssicht primär aus einem
1779 eindeutigen Namen. Weiterhin wird hier hinterlegt, welche Datenbank
1780 als Mandantendatenbank benutzt wird. Hier müssen die Zugriffsdaten
1781 einer der eben angelegten Datenbanken eingetragen werden.</para>
1783 <para>Hat man bereits Benutzer und Gruppen angelegt, so kann hier auch
1784 konfiguriert werden, welche Benutzer Zugriff auf den Mandanten haben
1785 bzw. welche Gruppen für den Mandanten gültig sind. Beide Zuweisungen
1786 können sowohl beim Mandanten vorgenommen werden ("auf diesen Mandanten
1787 haben Benutzer X, Y und Z Zugriff" bzw. "für diesen Mandanten sind die
1788 Gruppen X, Y und Z gültig") als auch beim Benutzer ("dieser Benutzer
1789 hat Zugriff auf Mandanten A, B und C") bzw. bei der Gruppe ("diese
1790 Gruppe ist für Mandanten A, B und C gültig").</para>
1794 <sect1 id="Drucker--Systemverwaltung">
1795 <title>Drucker- und Systemverwaltung</title>
1797 <para>Im Administrationsmenü gibt es ferner noch die beiden Menüpunkte
1798 Druckeradministration und System.</para>
1800 <sect2 id="Druckeradministration">
1801 <title>Druckeradministration</title>
1803 <para>Unter dem Menüpunkt Druckeradministration lassen sich beliebig
1804 viele "Druckbefehle" im System verwalten. Diese Befehle werden
1805 mandantenweise zugeordnet. Unter Druckerbeschreibung wird der Namen
1806 des Druckbefehls festgelegt, der dann in der Druckerauswahl des Belegs
1807 angezeigt wird.</para>
1809 <para>Unter Druckbefehl definiert man den eigentlichen Druckbefehl,
1810 der direkt auf dem Webserver ausgeführt wird, bspw. 'lpr -P
1811 meinDrucker' oder ein kompletter Pfad zu einem Skript
1812 (/usr/local/src/kivitendo/scripts/pdf_druck_in_verzeichnis.sh). Wird
1813 ferner noch ein optionales Vorlagenkürzel verwendet, wird dieses
1814 Kürzel bei der Auswahl der Druckvorlagendatei mit einem Unterstrich
1815 ergänzt, ist bspw. das Kürzel 'epson_drucker' definiert, so wird beim
1816 Ausdruck eines Angebots folgende Vorlage geparst:
1817 sales_quotation_epson_drucker.tex.</para>
1821 <title>System sperren / entsperren</title>
1823 <para>Unter dem Menüpunkt System gibt es den Eintrag 'Installation
1824 sperren/entsperren'. Setzt man diese Sperre so ist der Zugang zu der
1825 gesamten kivitendo Installation gesperrt.</para>
1827 <para>Falls die Sperre gesetzt ist, erscheint anstelle der
1828 Anmeldemaske die Information: 'kivitendo ist momentan zwecks
1829 Wartungsarbeiten nicht zugänglich.'.</para>
1831 <para>Wichtig zu erwähnen ist hierbei noch, dass sich kivitendo
1832 automatisch 'sperrt', falls es bei einem Versionsupdate zu einem
1833 Datenbankfehler kam. Somit kann hier nicht aus Versehen mit einem
1834 inkonsistenten Datenbestand weitergearbeitet werden.</para>
1838 <sect1 id="config.sending-email"
1839 xreflabel="E-Mail-Versand aus kivitendo heraus">
1840 <title>E-Mail-Versand aus kivitendo heraus</title>
1842 <para>kivitendo kann direkt aus dem Programm heraus E-Mails versenden,
1843 z.B. um ein Angebot direkt an einen Kunden zu verschicken. Damit dies
1844 funktioniert, muss eingestellt werden, über welchen Server die E-Mails
1845 verschickt werden sollen. kivitendo unterstützt dabei zwei Mechanismen:
1846 Versand über einen lokalen E-Mail-Server (z.B. mit
1847 <productname>Postfix</productname> oder <productname>Exim</productname>,
1848 was auch die standardmäßig aktive Methode ist) sowie Versand über einen
1849 SMTP-Server (z.B. der des eigenen Internet-Providers).</para>
1851 <para>Welche Methode und welcher Server verwendet werden, wird über die
1852 Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1853 festgelegt. Dort befinden sich alle Einstellungen zu diesem Thema im
1854 Abschnitt '<literal>[mail_delivery]</literal>'.</para>
1856 <sect2 id="config.sending-email.sendmail"
1857 xreflabel="E-Mail-Versand über lokalen E-Mail-Server">
1858 <title>Versand über lokalen E-Mail-Server</title>
1860 <para>Diese Methode bietet sich an, wenn auf dem Server, auf dem
1861 kivitendo läuft, bereits ein funktionsfähiger E-Mail-Server wie z.B.
1862 <productname>Postfix</productname>, <productname>Exim</productname>
1863 oder <productname>Sendmail</productname> läuft.</para>
1865 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter
1866 '<literal>method = sendmail</literal>' gesetzt sein. Dies ist
1867 gleichzeitig der Standardwert, falls er nicht verändert wird.</para>
1869 <para>Um zu kontrollieren, wie das Programm zum Einliefern gestartet
1870 wird, dient der Parameter '<literal>sendmail = ...</literal>'. Der
1871 Standardwert verweist auf das Programm
1872 <filename>/usr/bin/sendmail</filename>, das bei allen oben genannten
1873 E-Mail-Serverprodukten für diesen Zweck funktionieren sollte.</para>
1875 <para>Die Konfiguration des E-Mail-Servers selber würde den Rahmen
1876 dieses sprengen. Hierfür sei auf die Dokumentation des E-Mail-Servers
1880 <sect2 id="config.sending-email.smtp"
1881 xreflabel="E-Mail-Versand über einen SMTP-Server">
1882 <title>Versand über einen SMTP-Server</title>
1884 <para>Diese Methode bietet sich an, wenn kein lokaler E-Mail-Server
1885 vorhanden oder zwar einer vorhanden, dieser aber nicht konfiguriert
1888 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter
1889 '<literal>method = smtp</literal>' gesetzt sein. Die folgenden
1890 Parameter dienen dabei der weiteren Konfiguration:</para>
1894 <term><varname>hostname</varname></term>
1897 <para>Name oder IP-Adresse des SMTP-Servers. Standardwert:
1898 '<literal>localhost</literal>'</para>
1903 <term><varname>port</varname></term>
1906 <para>Portnummer. Der Standardwert hängt von der verwendeten
1907 Verschlüsselungsmethode ab. Gilt '<literal>security =
1908 none</literal>' oder '<literal>security = tls</literal>', so ist
1909 25 die Standardportnummer. Für '<literal>security =
1910 ssl</literal>' ist 465 die Portnummer. Muss normalerweise nicht
1911 geändert werden.</para>
1916 <term><varname>security</varname></term>
1919 <para>Wahl der zu verwendenden Verschlüsselung der Verbindung
1920 mit dem Server. Standardwert ist '<literal>none</literal>',
1921 wodurch keine Verschlüsselung verwendet wird. Mit
1922 '<literal>tls</literal>' wird TLS-Verschlüsselung eingeschaltet,
1923 und mit '<literal>ssl</literal>' wird Verschlüsselung via SSL
1924 eingeschaltet. Achtung: Für '<literal>tls</literal>' und
1925 '<literal>ssl</literal>' werden zusätzliche Perl-Module benötigt
1926 (siehe unten).</para>
1931 <term><varname>login</varname> und
1932 <varname>password</varname></term>
1935 <para>Falls der E-Mail-Server eine Authentifizierung verlangt,
1936 so können mit diesen zwei Parametern der Benutzername und das
1937 Passwort angegeben werden. Wird Authentifizierung verwendet, so
1938 sollte aus Sicherheitsgründen auch eine Form von Verschlüsselung
1939 aktiviert werden.</para>
1946 <sect1 id="Drucken-mit-kivitendo">
1947 <title>Drucken mit kivitendo</title>
1949 <para>Das Drucksystem von kivitendo benutzt von Haus aus LaTeX-Vorlagen.
1950 Um drucken zu können, braucht der Server ein geeignetes LaTeX System. Am
1951 einfachsten ist dazu eine <literal>texlive</literal> Installation. Unter
1952 debianoiden Betriebssystemen installiert man die Pakete mit:</para>
1954 <para><programlisting>apt install texlive-base-bin texlive-latex-recommended texlive-fonts-recommended \
1955 texlive-latex-extra texlive-lang-german texlive-generic-extra texlive-xetex </programlisting></para>
1957 <para>Für Fedora benötigen Sie die folgenden Pakete:</para>
1959 <para><programlisting>dnf install texlive-collection-latex texlive-collection-latexextra \
1960 texlive-collection-latexrecommended texlive-collection-langgerman \
1961 texlive-collection-langenglish</programlisting></para>
1963 <para>Für openSUSE benötigen Sie die folgenden Pakete:</para>
1965 <para><programlisting>zypper install texlive-collection-latex texlive-collection-latexextra \
1966 texlive-collection-latexrecommended texlive-collection-langgerman \
1967 texlive-collection-langenglish</programlisting></para>
1969 <para>kivitendo bringt drei alternative Vorlagensätze mit:</para>
1981 <para>rev-odt</para>
1985 <para>Der ehemalige Druckvorlagensatz "Standard" wurde mit der Version
1986 3.3 entfernt, da er nicht mehr gepflegt wurde.</para>
1988 <sect2 id="Vorlagenverzeichnis-anlegen"
1989 xreflabel="Vorlagenverzeichnis anlegen">
1990 <title>Vorlagenverzeichnis anlegen</title>
1992 <para>Es lässt sich ein initialer Vorlagensatz erstellen. Die
1993 LaTeX-System-Abhängigkeiten hierfür kann man prüfen mit:</para>
1995 <programlisting>./scripts/installation_check.pl -lv</programlisting>
1997 <para>Der Angemeldete Benutzer muss in einer Gruppe sein, die über das
1998 Recht "Konfiguration -> Mandantenverwaltung" verfügt. Siehe auch
1999 <xref linkend="Gruppen-anlegen"/>.</para>
2001 <para>Im Userbereich lässt sich unter: "<guimenu>System</guimenu>
2002 -> <guisubmenu>Mandantenverwaltung</guisubmenu> ->
2003 <guimenuitem>Verschiedenes</guimenuitem>" die Option "Neue
2004 Druckvorlagen aus Vorlagensatz erstellen" auswählen.</para>
2008 <para><option>Vorlagen auswählen</option>: Wählen Sie hier den
2009 Vorlagensatz aus, der kopiert werden soll
2010 (<filename>RB</filename>, <filename>f-tex</filename> oder
2011 <filename>odt-rev</filename>.)</para>
2015 <para><option>Neuer Name</option>: Der Verzeichnisname für den
2016 neuen Vorlagensatz. Dieser kann im Rahmen der üblichen Bedingungen
2017 für Verzeichnisnamen frei gewählt werden.</para>
2021 <para>Nach dem Speichern wird das Vorlagenverzeichnis angelegt und ist
2022 für den aktuellen Mandanten ausgewählt. Der gleiche Vorlagensatz kann,
2023 wenn er mal angelegt ist, bei mehreren Mandanten verwendet werden.
2024 Eventuell müssen Anpassungen (Logo, Erscheinungsbild, etc) noch
2025 vorgenommen werden. Den Ordner findet man im Dateisystem unter
2026 <filename>./templates/[Neuer Name]</filename></para>
2029 <sect2 id="Vorlagen-RB">
2030 <title>Der Druckvorlagensatz RB</title>
2032 <para>Hierbei handelt es sich um einen vollständigen LaTeX
2033 Dokumentensatz mit alternativem Design. Die odt oder html-Varianten
2034 sind nicht gepflegt.</para>
2036 <para>Die konzeptionelle Idee der Vorlagen wird <ulink
2037 url="http://www.kivitendo-support.de/vortraege/Lx-Office%20Anwendertreffen%20LaTeX-Druckvorlagen-Teil3-finale.pdf">hier</ulink>
2038 auf Folie 5 bis 10 vorgestellt. Informationen zur Anpassung an die
2039 eigenen Firmendaten finden sich in der Datei Readme.tex im
2040 Vorlagenverzeichnis.</para>
2042 <para>Eine kurze Übersicht der Features:</para>
2046 <para>Mehrsprachenfähig, mit Deutscher und Englischer
2051 <para>Zentrale Konfigurationsdateien, die für alle Belege benutzt
2052 werden, z.B. für Kopf- und Fußzeilen, und Infos wie
2057 <para>mehrere vordefinierte Varianten für
2058 Logos/Hintergrundbilder</para>
2062 <para>Berücksichtigung für Steuerzonen "EU mit USt-ID Nummer" oder
2063 "Außerhalb EU"</para>
2069 <title>f-tex</title>
2071 <para>Ein Vorlagensatz, der in wenigen Minuten alle Dokumente zur
2072 Verfügung stellt.</para>
2074 <sect3 id="f-tex-Feature-Übersicht">
2075 <title>Feature-Übersicht</title>
2079 <para>Keine Redundanz. Es wird ein- und dieselbe LaTeX-Vorlage
2080 für alle briefartigen Dokumente verwendet. Also Angebot,
2081 Rechnung, Proformarechnung, Lieferschein, aber eben nicht für
2082 Paketaufkleber etc.</para>
2086 <para>Leichte Anpassung an das Firmen-Layout durch Verwendung
2087 eines Hintergrund-PDFs. Dieses kann leicht mit dem eigenen
2088 Lieblingsprogramm erstellt werden (Openoffice, Inkscape, Gimp,
2093 <para>Hintergrund-PDF umschaltbar auf "nur erste Seite"
2094 (Standard) oder "alle Seiten" (Option
2095 "<option>bgPdfFirstPageOnly</option>" in Datei
2096 <filename>letter.lco</filename>)</para>
2100 <para>Hintergrund-PDF für Ausdruck auf bereits bedrucktem
2101 Briefpapier abschaltbar. Es wird dann nur bei per E-Mail
2102 versendeten Dokumenten eingebunden (Option
2103 "<option>bgPdfEmailOnly</option>" in Datei
2104 <filename>letter.lco</filename>).</para>
2108 <para>Nutzung der Layout-Funktionen von LaTeX für Seitenumbruch,
2109 Wiederholung von Kopfzeilen, Zwischensummen etc. (danke an
2110 Kai-Martin Knaak für die Vorarbeit)</para>
2114 <para>Anzeige des Empfängerlandes im Adressfeld nur, wenn es vom
2115 Land des eigenen Unternehmens abweicht (also die Rechnung das
2116 Land verlässt).</para>
2120 <para>Multisprachfähig leicht um weitere Sprachen zu erweitern,
2121 alle Übersetzungen in der Datei
2122 <filename>translatinos.tex</filename>.</para>
2126 <para>Auflistung von Bruttopreisen für Endverbraucher.</para>
2131 <sect3 id="f-tex-Installation">
2132 <title>Die Installation</title>
2136 <para>Vorlagenverzeichnis mit Option f-tex anlegen, siehe: <xref
2137 linkend="Vorlagenverzeichnis-anlegen"/>. Das Vorlagensystem
2138 funktioniert jetzt schon, hat allerdings noch einen
2139 Beispiel-Briefkopf.</para>
2143 <para>Erstelle eine pdf-Hintergrund Datei und verlinke sie nach
2144 <filename>./letter_head.pdf</filename>.</para>
2148 <para>Editiere den Bereich "<option>settings</option>" in der
2149 datei <filename>letter.lco</filename>.</para>
2153 <para>oder etwas detaillierter:</para>
2155 <para>Es wird eine Datei <filename>sample.lco</filename> erstellt
2156 und diese nach <filename>letter.lco</filename> verlinkt. Eigentlich
2157 ist dies die Datei die für die firmenspezifischen Anpassungen
2158 gedacht ist. Da die Einstiegshürde in LaTeX nicht ganz niedrig ist,
2159 wird in dieser Datei auf ein Hintergrund-PDF verwiesen. Ich empfehle
2160 über dieses PDF die persönlichen Layoutanpassungen vorzunehmen und
2161 <filename>sample.lco</filename> unverändert zu lassen. Die Anpassung
2162 über eine <filename>*.lco</filename>-Datei, die letztlich auf
2163 <filename>letter.lco</filename> verlinkt ist ist aber auch
2166 <para>Es wird eine Datei <filename>sample_head.pdf</filename> mit
2167 ausgeliefert, diese wird nach <filename>letter_head.pdf</filename>
2168 verlinkt. Damit gibt es schon mal eine funktionsfähige Vorlage.
2169 Schau Dir nach Abschluss der Installation die Datei
2170 <filename>sample_head.pdf</filename> an und erstelle ein
2171 entsprechendes PDF passend zum Briefkopf Deiner Firma, diese dann im
2172 Template Verzeichniss ablegen und statt
2173 <filename>sample_head.pdf</filename> nach
2174 <filename>letter_head.pdf</filename> verlinken.</para>
2176 <para>Letzlich muss <filename>letter_head.pdf</filename> auf das
2177 passende Hintergrund-PDF verweisen, welches gewünschten Briefkopf
2180 <para>Es wird eine Datei <filename>mydata.tex.example</filename>
2181 ausgeliefert, die nach <filename>mytdata.tex</filename> verlinkt
2182 ist. Bei verwendetem Hintergrund-PDF wird nur der Eintrag für das
2183 Land verwendet. Die Datei muss also nicht angefasst werden. Die
2184 anderen Werte sind für das Modul 'lp' (Label Print in erp - zur Zeit
2185 nicht im öffentlichen Zweig).</para>
2187 <para>Alle Anpassungen zum Briefkopf, Fusszeilen, Firmenlogos, etc.
2188 sollten über die Hintergrund-PDF-Datei oder die
2189 <filename>*.lco</filename>-Datei erfolgen.</para>
2192 <sect3 id="f-tex-Funktionsübersicht">
2193 <title>f-tex Funktionsübersicht</title>
2195 <para>Das Konzept von kivitendo sieht vor, für jedes Dokument
2196 (Auftragsbestätigung, Lieferschein, Rechnung, etc.) eine
2197 LaTeX-Vorlage vorzuhalten, dies ist sehr wartungsunfreundlich. Auch
2198 das Einlesen einer einheitlichen Quelle für den Briefkopf bringt nur
2199 bedingte Vorteile, da hier leicht die Pflege der Artikel-Tabellen
2200 aus dem Ruder läuft. Bei dem vorliegenden Ansatz wird für alle
2201 briefartigen Dokumente mit Artikel-Tabellen eine einheitliche
2202 LaTeX-Vorlage verwendet, welche über Codeweichen die Besonderheiten
2203 der jeweiligen Dokumente berücksichtigt:</para>
2207 <para>Tabellen mit oder ohne Preis</para>
2211 <para>Sprache der Tabellenüberschriften etc.</para>
2215 <para>Anpassung der Bezugs-Zeile (z.B. Rechnungsnummer versus
2216 Angebotsnummer)</para>
2220 <para>Darstellung von Brutto oder Netto-Preisen in der
2221 Auflistung (Endverbraucher versus gewerblicher Kunde)</para>
2225 <para>Nachteil:</para>
2227 <para>LaTeX hat ohnehin eine sehr steile Lehrnkurve. Die Datei
2228 <filename>letter.tex</filename> ist sehr komplex und verstärkt damit
2229 diesen Effekt noch einmal erheblich. Wer LaTeX-Erfahrung hat, oder
2230 geübt ist Scriptsparachen nachzuvollziehen kann natürlich auch
2231 innerhalb der Tabellendarstellung gut persönliche Anpassungen
2232 vornehmen. Aber man kann sich hier bei Veränderungen sehr schnell
2233 heftig in den Fuss schiessen.</para>
2235 <para>Wer nicht so tief in die Materie einsteigen will oder leicht
2236 zu frustrieren ist, sollte sein Hintergrund-PDF auf Basis der
2237 mitglieferten Datei <filename>sample_head.pdf</filename> erstellen,
2238 und sich an der Form der dargestellten Tabellen, wie sie
2239 ausgeliefert werden, erfreuen.</para>
2241 <para>Kleiner Tipp: Nicht zu viel auf einmal wollen, lieber kleine,
2242 kontinuierliche Schritte gehen.</para>
2245 <sect3 id="f-tex-Bruttopreise">
2246 <title>Bruttopreise für Endverbraucher</title>
2248 <para>Der auszuweisende Bruttopreis wird innerhalb der
2249 LaTeX-Umgebung berechnet. Es gibt zwar ein Feld, um bei Aufträgen
2250 "alle Preise Brutto" auszuwählen, aber:</para>
2254 <para>hierfür müssen die Preise auch in Brutto in der Datenbank
2255 stehen (ja - das lässt sich über die Preisgruppen und die
2256 Zuordung einer Default-Preisgruppe handhaben)</para>
2260 <para>man darf beim Anlegen des Vorgangs nicht vergessen, dieses
2261 Häkchen zu setzen. (Das ist in der Praxis, wenn man sowohl
2262 Endverbraucher als auch Gewerbekunden beliefert, der eigentliche
2267 <para>Es gibt mit f-tex eine weitere Alternative. Die Information ob
2268 Brutto oder Nettorechnung wird mit den Zahlarten verknüpft.
2269 Zahlarten bei denen Rechnungen, Angebote, etc, in Brutto ausgegeben
2270 werden sollen, enden mit "_E" (für Endverbraucher). Falls identische
2271 Zahlarten für Gewerbekunden und Endverbraucher vorhanden sind, legt
2272 man diese einfach doppelt an (einmal mit der Namensendung "_E").
2277 <para>Die Entscheidung, ob Nettopreise ausgewiesen werden, ist
2278 nicht mehr fix mit einer Preisliste verbunden.</para>
2282 <para>Die Default-Zahlart kann im Kundendatensatz hinterlegt
2283 werden, und man muss nicht mehr daran denken, "alle Preise
2284 Netto" auszuwählen.</para>
2288 <para>Die Entscheidung, ob Netto- oder Bruttopreise ausgewiesen
2289 werden, kann direkt beim Drucken revidiert werden, ohne dass
2290 sich der Auftragswert ändert.</para>
2295 <sect3 id="f-tex-lieferadressen">
2296 <title>Lieferadressen</title>
2298 <para>In Lieferscheinen kommen <varname>shipto*</varname>-Variablen
2299 im Adressfeld zum Einsatz. Wenn die
2300 <varname>shipto*</varname>-Variable leer ist, wird die entsprechende
2301 Adressvariable eingesetzt. Wenn also die Lieferadresse in Straße,
2302 Hausnummer und Ort abweicht, müssen auch nur diese Felder in der
2303 Lieferadresse ausgefüllt werden. Für den Firmenname wird der Wert
2304 der Hauptadresse angezeigt.</para>
2308 <sect2 id="Vorlagen-rev-odt">
2309 <title>Der Druckvorlagensatz rev-odt</title>
2311 <para>Hierbei handelt es sich um einen Dokumentensatz der mit
2312 odt-Vorlagen erstellt wurde. Es gibt in dem Verzeichnis eine
2313 Readme-Datei, die eventuell aktueller als die Dokumentation hier ist.
2314 Die odt-Vorlagen in diesem Verzeichnis "rev-odt" wurden von revamp-it,
2315 Zürich erstellt und werden laufend aktualisiert. Ein paar der
2316 Formulierungen in den Druckvorlagen entsprechen dem Schweizer
2317 Sprachgebrauch, z.B. "Offerte" oder "allfällig".</para>
2319 <para>Hinweis zum Einsatz des Feldes "Land" bei den Stammdaten für
2320 KundInnen und LieferantInnen, sowie bei Lieferadressen: Die in diesem
2321 Vorlagensatz vorhandenen Vorlagen erwarten für "Land" das
2322 entsprechende Kürzel, das in Adressen vor die Postleitzahl gesetzt
2323 wird. Das Feld kann auch komplett leer bleiben. Wer dies anders
2324 handhaben möchte, muss die Vorlagen entsprechend anpassen.</para>
2326 <para>odt-Vorlagen können mit LibreOffice oder OpenOffice editiert und
2327 den eigenen Bedürfnissen angepasst werden. Wichtig beim Editieren von
2328 if-Blöcken ist, dass immer der gesamte Block überschrieben werden muss
2329 und nicht nur Teile davon, da dies sonst oft zu einer odt-Datei führt,
2330 die vom Parser nicht korrekt gelesen werden kann.</para>
2332 <para>Mahnungen können unter folgenden Einschränkungen mit den
2333 odt-Vorlagen im Vorlagensatz rev-odt erzeugt werden:</para>
2337 <para>als Druckoption steht nur 'PDF(OpenDocument/OASIS)' zur
2338 Verfügung, das heisst, die Mahnungen werden als PDF-Datei
2343 <para>für jede Rechnung muss eine eigene Mahnung erzeugt werden
2344 (auch wenn bei einzelnen KundInnen mehrere überfällige Rechnungen
2345 vorhanden sind).</para>
2349 <para>Mehrere Mahnungen für eine Kundin / einen Kunden werden zu einer
2350 PDF-Datei zusammengefasst</para>
2352 <para>Die Vorlagen zahlungserinnerung.odt sowie mahnung.odt sind für
2353 das Erstellen einer Zahlungserinnerung bzw. Mahnung selbst vorgesehen,
2354 die Vorlage mahnung_invoice.odt für das Erstellen einer Rechnung über
2355 die verrechneten Mahngebühren und Verzugszinsen.</para>
2357 <para>Zur Zeit gibt es in kivitendo noch keine Möglichkeit,
2358 odt-Vorlagen bei Briefen und Pflichtenheften einzusetzen.
2359 Entsprechende Vorlagen sind deshalb nicht vorhanden.</para>
2361 <para>Fehlermeldungen, Anregungen und Wünsche bitte senden an:
2362 empfang@revamp-it.ch</para>
2365 <sect2 id="allgemeine-hinweise-zu-latex">
2366 <title>Allgemeine Hinweise zu LaTeX Vorlagen</title>
2368 <para>In den allermeisten Installationen sollte das Drucken jetzt
2369 schon funktionieren. Sollte ein Fehler auftreten, wirft TeX sehr lange
2370 Fehlerbeschreibungen, der eigentliche Fehler ist immer die erste
2371 Zeile, die mit einem Ausrufezeichen anfängt. Häufig auftretende Fehler
2372 sind zum Beispiel:</para>
2376 <para>! LaTeX Error: File `eurosym.sty' not found. Die
2377 entsprechende LaTeX-Bibliothek wurde nicht gefunden. Das tritt vor
2378 allem bei Vorlagen aus der Community auf. Installieren Sie die
2379 entsprechenden Pakete.</para>
2383 <para>! Package inputenc Error: Unicode char \u8:... set up for
2384 use with LaTeX. Dieser Fehler tritt auf, wenn sie versuchen mit
2385 einer Standardinstallation exotische utf8 Zeichen zu drucken.
2386 TeXLive unterstützt von Haus nur romanische Schriften und muss mit
2387 diversen Tricks dazu gebracht werden andere Zeichen zu
2388 akzeptieren. Adere TeX Systeme wie XeTeX schaffen hier
2393 <para>Wird gar kein Fehler angezeigt, sondern nur der Name des
2394 Templates, heißt das normalerweise, dass das LaTeX Binary nicht
2395 gefunden wurde. Prüfen Sie den Namen in der Konfiguration (Standard:
2396 <literal>pdflatex</literal>), und stellen Sie sicher, dass pdflatex
2397 (oder das von Ihnen verwendete System) vom Webserver ausgeführt werden
2400 <para>Wenn sich das Problem nicht auf Grund der Ausgabe im Webbrowser
2401 verifizieren lässt:</para>
2405 <para>editiere [kivitendo-home]/config/kivitendo.conf und ändere
2406 "keep_temp_files" auf 1</para>
2408 <para><programlisting>keep_temp_files = 1;</programlisting></para>
2412 <para>bei fastcgi oder mod_perl den Webserver neu Starten</para>
2416 <para>Nochmal einen Druckversuch im Webfrontend auslösen</para>
2420 <para>wechsel in das users Verzeichnis von kivitendo</para>
2422 <para><programlisting>cd [kivitendo-home]/users</programlisting></para>
2426 <para>LaTeX Suchpfad anpassen:</para>
2428 <para><programlisting>export TEXINPUTS=".:[kivitendo-home]/templates/[aktuelles_template_verzeichniss]:"</programlisting></para>
2432 <para>Finde heraus, welche Datei kivitendo beim letzten Durchlauf
2435 <para><programlisting>ls -lahtr ./1*.tex</programlisting></para>
2437 <para>Es sollte die letzte Datei ganz unten sein</para>
2441 <para>für besseren Hinweis auf Fehler texdatei nochmals
2444 <para><programlisting>pdflatex ./1*.tex</programlisting></para>
2446 <para>in der *.tex datei nach dem Fehler suchen.</para>
2452 <sect1 id="OpenDocument-Vorlagen">
2453 <title>OpenDocument-Vorlagen</title>
2455 <para>kivitendo unterstützt die Verwendung von Vorlagen im
2456 OpenDocument-Format, wie es LibreOffice oder OpenOffice (ab Version 2)
2457 erzeugen. kivitendo kann dabei sowohl neue OpenDocument-Dokumente als
2458 auch aus diesen direkt PDF-Dateien erzeugen. Um die Unterstützung von
2459 OpenDocument-Vorlagen zu aktivieren muss in der Datei
2460 <filename>config/kivitendo.conf</filename> die Variable
2461 <literal>opendocument</literal> im Abschnitt
2462 <literal>print_templates</literal> auf ‘<literal>1</literal>’ stehen.
2463 Dieses ist die Standardeinstellung.</para>
2465 <para>Während die Erzeugung von reinen OpenDocument-Dateien keinerlei
2466 weitere Software benötigt, wird zur Umwandlung dieser Dateien in PDF
2467 LibreOffice oder OpenOffice benötigt. Soll dieses Feature genutzt
2468 werden, so muss neben LibreOffice oder OpenOffice auch der “X virtual
2469 frame buffer” (xvfb) installiert werden. Bei Debian ist er im Paket
2470 “xvfb” enthalten. Andere Distributionen enthalten ihn in anderen
2473 <para>Nach der Installation müssen in der Datei
2474 <filename>config/kivitendo.conf</filename> im Abschnitt
2475 <literal>applications</literal> zwei weitere Variablen angepasst
2478 <para><literal>openofficeorg_writer</literal> muss den vollständigen
2479 Pfad zu LibreOffice oder OpenOffice enthalten. Dabei dürfen keine
2480 Anführungszeichen eingesetzt werden.</para>
2482 <para>Beispiel für Debian oder Ubuntu:</para>
2484 <programlisting>openofficeorg_writer = /usr/bin/libreoffice</programlisting>
2486 <para><literal>xvfb</literal> muss den Pfad zum “X virtual frame buffer”
2489 <para>Zusätzlich gibt es zwei verschiedene Arten, wie kivitendo mit
2490 LibreOffice bzw. OpenOffice kommuniziert. Die erste Variante, die
2491 benutzt wird, wenn die Variable <literal>$openofficeorg_daemon</literal>
2492 gesetzt ist, startet ein LibreOffice oder OpenOffice, das auch nach der
2493 Umwandlung des Dokumentes gestartet bleibt. Bei weiteren Umwandlungen
2494 wird dann diese laufende Instanz benutzt. Der Vorteil ist, dass die Zeit
2495 zur Umwandlung deutlich reduziert wird, weil nicht für jedes Dokument
2496 ein LibreOffice bzw. OpenOffice gestartet werden muss. Der Nachteil ist,
2497 dass diese Methode Python und die Python-UNO-Bindings benötigt, die
2498 Bestandteil von LibreOffice bzw. OpenOffice sind.</para>
2501 <para>Für die Verbindung zu LibreOffice bzw. OpenOffice wird
2502 normalerweise der Python-Interpreter
2503 <filename>/usr/bin/python</filename> benutzt. Sollte dies nicht der
2504 richtige sein, so kann man mit zwei Konfigurationsvariablen
2505 entscheiden, welcher Python-Interpreter genutzt wird. Mit der Option
2506 <literal>python_uno</literal> aus dem Abschnitt
2507 <literal>applications</literal> wird der Interpreter selber
2508 festgelegt; sie steht standardmäßig auf dem eben erwähnten Wert
2509 <literal>/usr/bin/python</literal>.</para>
2511 <para>Zusätzlich ist es möglich, Pfade anzugeben, in denen Python
2512 neben seinen normalen Suchpfaden ebenfalls nach Modulen gesucht wird,
2513 z.B. falls sich diese in einem gesonderten LibreOffice- bzw.
2514 OpenOffice-Verzeichnis befinden. Diese zweite Variable heißt
2515 <literal>python_uno_path</literal> und befindet sich im Abschnitt
2516 <literal>environment</literal>. Sie ist standardmäßig leer. Werden
2517 hier mehrere Pfade angegeben, so müssen diese durch Doppelpunkte
2518 voneinander getrennt werden. Der Inhalt wird an den Python-Interpreter
2519 über die Umgebungsvariable <literal>PYTHONPATH</literal>
2523 <para>Ist <literal>$openofficeorg_daemon</literal> nicht gesetzt, so
2524 wird für jedes Dokument LibreOffice bzw. OpenOffice neu gestartet und
2525 die Konvertierung mit Hilfe eines Makros durchgeführt. Dieses Makro muss
2526 in der Dokumentenvorlage enthalten sein und
2527 “Standard.Conversion.ConvertSelfToPDF()” heißen. Die Beispielvorlage
2528 ‘<literal>templates/print/rev-odt/invoice.odt</literal>’ enthält ein
2529 solches Makro, das in jeder anderen Dokumentenvorlage ebenfalls
2530 enthalten sein muss.</para>
2532 <para>Als letztes muss herausgefunden werden, welchen Namen OpenOffice
2533 bzw. LibreOffice dem Verzeichnis mit den Benutzereinstellungen gibt.
2534 Unter Debian ist dies momentan <literal>~/.config/libreoffice</literal>.
2535 kivitendo verwendet das Verzeichnis
2536 <literal>users/.openoffice.org2</literal>. Eventuell muss dieses
2537 Verzeichnis umbenannt werden.</para>
2539 <para>Dieses Verzeichnis, wie auch das komplette
2540 <literal>users</literal>-Verzeichnis, muss vom Webserver beschreibbar
2541 sein. Dieses wurde bereits erledigt (siehe <xref
2542 linkend="Manuelle-Installation-des-Programmpaketes"/>), kann aber erneut
2543 überprüft werden, wenn die Konvertierung nach PDF fehlschlägt.</para>
2546 <title>OpenDocument (odt) Druckvorlagen mit Makros</title>
2548 <para>OpenDocument Vorlagen können Makros enthalten, welche komplexere
2549 Aufgaben erfüllen.</para>
2551 <para>Der Vorlagensatz "rev-odt" enthält solche Vorlagen mit <emphasis
2552 role="bold">Schweizer Bank-Einzahlungsscheinen (BESR)</emphasis>.
2553 Diese Makros haben die Aufgabe, die in den Einzahlungsscheinen
2554 benötigte Referenznummer und Kodierzeile zu erzeugen. Hier eine kurze
2555 Beschreibung, wie die Makros aufgebaut sind, und was bei ihrer Nutzung
2556 zu beachten ist (<emphasis role="bold">in fett sind nötige einmalige
2557 Anpassungen aufgeführt</emphasis>):</para>
2560 <title>Bezeichnung der Vorlagen</title>
2562 <para>Rechnung: invoice_besr.odt, Auftrag:
2563 sales_order_besr.odt</para>
2567 <title>Vorbereitungen im Adminbereich</title>
2569 <para>Damit beim Erstellen von Rechnungen und Aufträgen neben der
2570 Standardvorlage ohne Einzahlungsschein weitere Vorlagen (z.B. mit
2571 Einzahlungsschein) auswählbar sind, muss für jedes Vorlagen-Suffix
2572 ein Drucker eingerichtet werden:</para>
2576 <para>Druckeradministration → Drucker hinzufügen</para>
2580 <para>Mandant wählen</para>
2584 <para>Druckerbeschreibung → aussagekräftiger Text: wird in der
2585 Auftrags- bzw. Rechnungsmaske als Auswahl angezeigt (z.B. mit
2586 Einzahlungsschein Bank xy)</para>
2590 <para>Druckbefehl → beliebiger Text (hat für das Erzeugen von
2591 Aufträgen oder Rechnungen als odt-Datei keine Bedeutung, darf
2592 aber nicht leer sein)</para>
2596 <para>Vorlagenkürzel → besr bzw. selbst gewähltes Vorlagensuffix
2597 (muss genau der Zeichenfolge entsprechen, die zwischen
2598 "invoice_" bzw. "sales_order_" und ".odt" steht.)</para>
2602 <para>speichern</para>
2608 <title>Benutzereinstellungen</title>
2610 <para>Wer den Ausdruck mit Einzahlungsschein als Standardeinstellung
2611 im Rechnungs- bzw. Auftragsformular angezeigt haben möchte, kann
2612 dies persönlich für sich bei den Benutzereinstellungen
2613 konfigurieren:</para>
2617 <para>Programm → Benutzereinstellungen → Druckoptionen</para>
2621 <para>Standardvorlagenformat → OpenDocument/OASIS</para>
2625 <para>Standardausgabekanal → Bildschirm</para>
2629 <para>Standarddrucker → gewünschte Druckerbeschreibung auswählen
2630 (z.B. mit Einzahlungsschein Bank xy)</para>
2634 <para>Anzahl Kopien → leer</para>
2638 <para>speichern</para>
2644 <title>Aufbau und nötige Anpassungen der Vorlagen</title>
2646 <para>In der Vorlage sind als Modul "BESR" 4 Makros gespeichert, die
2647 aus dem von kivitendo erzeugten odt-Dokument die korrekte
2648 Referenznummer inklusive Prüfziffer sowie die Kodierzeile in
2649 OCRB-Schrift erzeugen und am richtigen Ort ins Dokument
2654 <para>Für den Einzahlungsschein ist die letzte Seite des
2655 Dokuments reserviert</para>
2659 <para>Direkt über dem Einzahlungsschein enthält die Vorlage eine
2660 Zeile mit folgenden Angaben (<emphasis
2661 role="bold">Bank-Konto-Identifikationsnummer und
2662 Postkonto-Nummer der Bank müssen gemäss Angaben der jeweiligen
2663 Bank angepasst werden</emphasis>):<itemizedlist>
2665 <para>DDDREF: 4 Werte zum Bilden der Referenznummer
2666 (jeweils durch einen Leerschlag getrennt): <itemizedlist>
2668 <para>erster Wert: <emphasis
2669 role="bold">Bank-Konto-Identifikation</emphasis>
2670 (nur Ziffern, maximal 6), <emphasis role="bold">muss
2671 angepasst werden</emphasis>.</para>
2675 <para>zweiter Wert: <%customernumber%>
2676 (Kundennummer: nur Ziffern, maximal 6)</para>
2680 <para>dritter Wert: <%ordnumber%>
2681 (Auftragsnummer bei Auftragsvorlage
2682 sales_oder_besr.odt, sonst 0) maximal 7 Ziffern,
2683 führende Buchstaben werden vom Makro entfernt</para>
2687 <para>vierter Wert: <%invnumber%>
2688 (Rechnungsnummer bei Rechnungsvorlage
2689 invoice_besr.odt, sonst 0) maximal 7 Ziffern,
2690 führende Buchstaben werden vom Makro entfernt</para>
2692 </itemizedlist></para>
2696 <para>DDDKONTO: <emphasis role="bold">Postkonto-Nummer der
2697 Bank, muss angepasst werden</emphasis>.</para>
2701 <para>DDDBETRAG: <%total%> Einzahlungsbetrag oder 0,
2702 falls Einzahlungsschein ohne Betrag</para>
2706 <para>DDDEND: muss am Ende der Zeile vorhanden sein</para>
2708 </itemizedlist></para>
2712 <para><emphasis role="bold">Im Einzahlungsschein selbst müssen
2713 der Name und die Adresse der Bank, die Postkonto-Nummer der
2714 Bank, sowie der eigene Firmenname und die Firmenadresse
2715 angepasst werden.</emphasis> Dabei ist darauf zu achten, dass
2716 sich die Positionen der Postkonto-Nummern der Bank, sowie der
2717 Zeichenfolgen dddfr, DDDREF1, DDDREF2, 609, DDDKODIERZEILE nicht
2723 <screeninfo>Rechnungsvorlage Schweizer Bank-Einzahlungsschein - zu
2724 ändernde Einträge in rot</screeninfo>
2728 <imagedata fileref="images/Einzahlungsschein_Makro.png"/>
2735 <title>Auswahl der Druckvorlage in kivitendo beim Erzeugen einer
2736 odt-Rechnung (analog bei Auftrag)</title>
2738 <para>Im Fussbereich der Rechnungsmaske muss neben Rechnung,
2739 OpenDocument/OASIS und Bildschirm die im Adminbereich erstellte
2740 Druckerbeschreibung ausgewählt werden, falls diese nicht bereits bei
2741 den Benutzereinstellungen als persönlicher Standard gewählt
2746 <title>Makroeinstellungen in LibreOffice anpassen</title>
2748 <para>Falls beim Öffnen einer von kivitendo erzeugten odt-Rechnung
2749 die Meldung kommt, dass Makros aus Sicherheitsgründen nicht
2750 ausgeführt werden, so müssen folgende Einstellungen in LibreOffice
2751 angepasst werden:</para>
2755 <para>Extras → Optionen → Sicherheit → Makrosicherheit</para>
2759 <para>Sicherheitslevel auf "Mittel" einstellen (Diese
2760 Einstellung muss auf jedem Computer durchgeführt werden, mit dem
2761 von kivitendo erzeugte odt-Rechnungen oder Aufträge geöffnet
2766 <para>Beim Öffnen einer odt-Rechnung oder eines odt-Auftrags bei
2767 der entsprechenden Nachfrage "Makros ausführen"
2770 <para><emphasis role="bold">Wichtig</emphasis>: die Makros sind
2771 so eingestellt, dass sie beim Öffnen der Vorlagen selbst nicht
2772 ausgeführt werden. Das heisst für das Ansehen und Bearbeiten der
2773 Vorlagen sind keine speziellen Einstellungen in LibreOffice
2781 <sect1 id="nomenclature">
2782 <title>Nomenklatur</title>
2784 <sect2 id="booking.dates">
2785 <title>Datum bei Buchungen</title>
2787 <para>Seit der Version 3.5 werden für Buchungen in kivitendo
2788 einheitlich folgende Bezeichnungen verwendet:</para>
2792 <para><option>Erfassungsdatum</option> (en: <option>Entry
2793 Date</option>, code: <option>Gldate</option>)</para>
2795 <para>bezeichnet das Datum, an dem die Buchung in kivitendo
2796 erfasst wurde.</para>
2800 <para><option>Buchungsdatum</option> (en: <option>Booking
2801 Date</option>, code: <option>Transdate</option>)</para>
2803 <para>bezeichnet das buchhaltungstechnisch für eine Buchung
2804 relevante Datum</para>
2806 <para>Das <option>Rechnungsdatum</option> bei Verkaufs- und
2807 Einkaufsrechnungen entspricht dem Buchungsdatum. Das heisst, in
2808 Berichten wie dem Buchungsjournal, in denen eine Spalte
2809 <option>Buchungsdatum</option> angezeigt werden kann, erscheint
2810 hier im Fall von Rechnungen das Rechnungsdatum.</para>
2814 <para>Bezieht sich ein verbuchter Beleg auf einen Zeitpunkt, der
2815 nicht mit dem Buchungsdatum übereinstimmt, so kann dieses Datum
2816 momentan in kivitendo nur unter Bemerkungen erfasst werden.</para>
2818 <para>Möglicherweise wird für solche Fälle in einer späteren
2819 Version von kivitendo ein dritter Datumswert für Buchungen
2820 erstellt. (Beispiel: Einkaufsbeleg stammt aus einem früheren Jahr,
2821 das bereits buchhaltungstechnisch abgeschlossen wurde, und muss
2822 deshalb später verbucht werden.)</para>
2828 <sect1 id="config.eur">
2829 <title>Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung:
2832 <sect2 id="config.eur.introduction"
2833 xreflabel="Einführung in die Konfiguration zur EUR">
2834 <title>Einführung</title>
2836 <para>kivitendo besaß bis inklusive Version 2.6.3 einen
2837 Konfigurationsparameter namens <varname>eur</varname>, der sich in der
2838 Konfigurationsdatei <filename>config/kivitendo.conf</filename> (damals
2839 noch <filename>config/lx_office.conf</filename>) befand. Somit galt er
2840 für alle Mandanten, die in dieser Installation benutzt wurden.</para>
2842 <para>Mit der nachfolgenden Version wurde der Parameter zum Einen in
2843 die Mandantendatenbank verschoben und dabei auch gleich in drei
2844 Einzelparameter aufgeteilt, mit denen sich das Verhalten genauer
2845 steuern lässt.</para>
2848 <sect2 id="config.eur.parameters"
2849 xreflabel="Konfigurationsparameter für EUR">
2850 <title>Konfigurationsparameter</title>
2852 <para>Es gibt drei Parameter, die die Gewinnermittlungsart,
2853 Versteuerungsart und die Warenbuchungsmethode regeln:</para>
2857 <term><varname>profit_determination</varname></term>
2860 <para>Dieser Parameter legt die Berechnungsmethode für die
2861 Gewinnermittlung fest. Er enthält entweder
2862 <literal>balance</literal> für
2863 Betriebsvermögensvergleich/Bilanzierung oder
2864 <literal>income</literal> für die
2865 Einnahmen-Überschuss-Rechnung.</para>
2870 <term><varname>accounting_method</varname></term>
2873 <para>Dieser Parameter steuert die Buchungs- und
2874 Berechnungsmethoden für die Versteuerungsart. Er enthält
2875 entweder <literal>accrual</literal> für die Soll-Versteuerung
2876 oder <literal>cash</literal> für die Ist-Versteuerung.</para>
2881 <term><varname>inventory_system</varname></term>
2884 <para>Dieser Parameter legt die Warenbuchungsmethode fest. Er
2885 enthält entweder <literal>perpetual</literal> für die
2886 Bestandsmethode oder <literal>periodic</literal> für die
2887 Aufwandsmethode.</para>
2892 <para>Zum Vergleich der Funktionalität bis und nach 2.6.3:
2893 <varname>eur</varname> = 1 bedeutete Einnahmen-Überschuss-Rechnung,
2894 Ist-Versteuerung und Aufwandsmethode. <varname>eur</varname> = 0
2895 bedeutete hingegen Bilanzierung, Soll-Versteuerung und
2896 Bestandsmethode.</para>
2898 <para>Die Konfiguration "<varname>eur</varname>" unter
2899 <varname>[system]</varname> in der <link
2900 linkend="config.config-file">Konfigurationsdatei</link>
2901 <filename>config/kivitendo.conf</filename> wird nun nicht mehr
2902 benötigt und kann entfernt werden. Dies muss manuell geschehen.</para>
2905 <sect2 id="config.eur.setting-parameters">
2906 <title>Festlegen der Parameter</title>
2908 <para>Beim Anlegen eines neuen Mandanten bzw. einer neuen Datenbank in
2909 der Admininstration können diese Optionen nun unabhängig voneinander
2910 eingestellt werden.</para>
2912 <para>Für die Schweiz sind folgende Einstellungen üblich:
2915 <para>Sollversteuerung</para>
2919 <para>Aufwandsmethode</para>
2923 <para>Bilanzierung</para>
2925 </itemizedlist> Diese Einstellungen werden automatisch beim
2926 Erstellen einer neuen Datenbank vorausgewählt, wenn in
2927 <filename>config/kivitendo.conf</filename> unter
2928 <varname>[system]</varname> <literal>default_manager = swiss</literal>
2929 eingestellt ist.</para>
2931 <para>Beim Upgrade bestehender Mandanten wird eur ausgelesen und die
2932 Variablen werden so gesetzt, daß sich an der Funktionalität nichts
2935 <para>Die aktuelle Konfiguration wird unter Nummernkreise und
2936 Standardkonten unter dem neuen Punkt "Einstellungen" (read-only)
2937 angezeigt. Unter <guimenu>System</guimenu> →
2938 <guisubmenu>Mandantenkonfiguration</guisubmenu> können die
2939 Einstellungen auch geändert werden. Dabei ist zu beachten, dass eine
2940 Änderung vorhandene Daten so belässt und damit evtl. die Ergebnisse
2941 verfälscht. Dies gilt vor Allem für die Warenbuchungsmethode (siehe
2942 auch <link linkend="config.eur.inventory-system-perpetual">
2943 Bemerkungen zur Bestandsmethode</link>).</para>
2946 <sect2 id="config.eur.inventory-system-perpetual">
2947 <title>Bemerkungen zur Bestandsmethode</title>
2949 <para>Die Bestandsmethode ist eigentlich eine sehr elegante Methode,
2950 funktioniert in kivitendo aber nur unter bestimmten Bedingungen:
2951 Voraussetzung ist, daß auch immer alle Einkaufsrechnungen gepflegt
2952 werden, und man beim Jahreswechsel nicht mit einer leeren Datenbank
2953 anfängt, da bei jedem Verkauf anhand der gesamten Rechnungshistorie
2954 der Einkaufswert der Ware nach dem FIFO-Prinzip aus den
2955 Einkaufsrechnungen berechnet wird.</para>
2957 <para>Die Bestandsmethode kann vom Prinzip her also nur funktioneren,
2958 wenn man mit den Buchungen bei Null anfängt, und man kann auch nicht
2959 im laufenden Betrieb von der Aufwandsmethode zur Bestandsmethode
2963 <sect2 id="config.eur.knonw-issues">
2964 <title>Bekannte Probleme</title>
2966 <para>Bei bestimmten Berichten kann man derzeit noch inviduell
2967 einstellen, ob man nach Ist- oder Sollversteuerung auswertet, und es
2968 werden im Code Variablen wie $accrual oder $cash gesetzt. Diese
2969 Codestellen wurden noch nicht angepasst, sondern nur die, wo bisher
2970 die Konfigurationsvariable
2971 <varname>$::lx_office_conf{system}->{eur}</varname> ausgewertet
2974 <para>Es fehlen Hilfetext beim Neuanlegen eines Mandanten, was die
2975 Optionen bewirken, z.B. mit zwei Standardfällen.</para>
2979 <sect1 id="config.skr04-update-3804">
2980 <title>SKR04 19% Umstellung für innergemeinschaftlichen Erwerb</title>
2982 <sect2 id="config.skr04-update-3804.introduction">
2983 <title>Einführung</title>
2985 <para>Die Umsatzsteuerumstellung auf 19% für SKR04 für die
2986 Steuerschlüssel "EU ohne USt-ID Nummer" ist erst 2010 erfolgt.
2987 kivitendo beinhaltet ein Upgradeskript, das das Konto 3804 automatisch
2988 erstellt und die Steuereinstellungen korrekt einstellt. Hat der
2989 Benutzer aber schon selber das Konto 3804 angelegt, oder gab es schon
2990 Buchungen im Zeitraum nach dem 01.01.2007 auf das Konto 3803, wird das
2991 Upgradeskript vorsichtshalber nicht ausgeführt, da der Benutzer sich
2992 vielleicht schon selbst geholfen hat und mit seinen Änderungen
2993 zufrieden ist. Die korrekten Einstellungen kann man aber auch per Hand
2994 ausführen. Nachfolgend werden die entsprechenden Schritte anhand von
2995 Screenshots dargestellt.</para>
2997 <para>Für den Fall, daß Buchungen mit der Steuerschlüssel "EU ohne
2998 USt.-IdNr." nach dem 01.01.2007 erfolgt sind, ist davon auszugehen,
2999 dass diese mit dem alten Umsatzsteuersatz von 16% gebucht worden sind,
3000 und diese Buchungen sollten entsprechend kontrolliert werden.</para>
3003 <sect2 id="config.skr04-update-3804.create-chart">
3004 <title>Konto 3804 manuell anlegen</title>
3006 <para>Die folgenden Schritte sind notwendig, um das Konto manuell
3007 anzulegen und zu konfigurieren. Zuerst wird in
3008 <guimenu>System</guimenu> → <guisubmenu>Kontenübersicht</guisubmenu> →
3009 <guimenuitem>Konto erfassen</guimenuitem> das Konto angelegt.</para>
3012 <screeninfo>Konto 3804 erfassen</screeninfo>
3016 <imagedata fileref="images/skr04-update-3804/konto3804.png"/>
3021 <para>Als Zweites muss Steuergruppe 13 für Konto 3803 angepasst
3022 werden. Dazu unter <guimenu>System</guimenu> →
3023 <guisubmenu>Steuern</guisubmenu> →
3024 <guimenuitem>Bearbeiten</guimenuitem> den Eintrag mit Steuerschlüssel
3025 13 auswählen und ihn wie im folgenden Screenshot angezeigt
3029 <screeninfo>Steuerschlüssel 13 für 3803 (16%) anpassen</screeninfo>
3033 <imagedata fileref="images/skr04-update-3804/steuer3803.png"/>
3038 <para>Als Drittes wird ein neuer Eintrag mit Steuerschlüssel 13 für
3039 Konto 3804 (19%) angelegt. Dazu unter <guimenu>System</guimenu> →
3040 <guisubmenu>Steuern</guisubmenu> → <guimenuitem>Erfassen</guimenuitem>
3041 auswählen und die Werte aus dem Screenshot übernehmen.</para>
3044 <screeninfo>Steuerschlüssel 13 für 3804 (19%) anlegen</screeninfo>
3048 <imagedata fileref="images/skr04-update-3804/steuer3804.png"/>
3053 <para>Als Nächstes sind alle Konten anzupassen, die als
3054 Steuerautomatikkonto die 3803 haben, sodass sie ab dem 1.1.2007 auch
3055 Steuerautomatik auf 3804 bekommen. Dies betrifft in der
3056 Standardkonfiguration die Konten 4315 und 4726. Als Beispiel für 4315
3057 müssen Sie dazu unter <guimenu>System</guimenu> →
3058 <guisubmenu>Kontenübersicht</guisubmenu> → <guimenuitem>Konten
3059 anzeigen</guimenuitem> das Konto 4315 anklicken und die Einstellungen
3060 wie im Screenshot gezeigt vornehmen.</para>
3063 <screeninfo>Konto 4315 anpassen</screeninfo>
3067 <imagedata fileref="images/skr04-update-3804/konto4315.png"/>
3072 <para>Als Letztes sollte die Steuerliste unter
3073 <guimenu>System</guimenu> → <guisubmenu>Steuern</guisubmenu> →
3074 <guimenuitem>Bearbeiten</guimenuitem> kontrolliert werden. Zum
3075 Vergleich der Screenshot.</para>
3078 <screeninfo>Steuerliste vergleichen</screeninfo>
3082 <imagedata fileref="images/skr04-update-3804/steuerliste.png"/>
3089 <sect1 id="config.bilanz">
3090 <title>Verhalten des Bilanzberichts</title>
3092 <para>Bis Version 3.0 wurde "closedto" ("Bücher schließen zum") als
3093 Grundlage für das Startdatum benutzt. Schließt man die Bücher allerdings
3094 monatsweise führt dies zu falschen Werten.</para>
3096 <para>In der Mandantenkonfiguration kann man dieses Verhalten genau
3097 einstellen indem man:</para>
3101 <para>weiterhin closed_to benutzt (Default, es ändert sich nichts zu
3106 <para>immer den Jahresanfang nimmt (1.1. relativ zum
3111 <para>immer die letzte Eröffnungsbuchung als Startdatum nimmt</para>
3113 <para>- mit Jahresanfang als Alternative wenn es keine EB-Buchungen
3116 <para>- oder mit "alle Buchungen" als Alternative"</para>
3120 <para>mit Jahresanfang als Alternative wenn es keine EB-Buchungen
3125 <para>immer alle Buchungen seit Beginn der Datenbank nimmt</para>
3129 <para>Folgende Hinweise zu den Optionen: Das "Bücher schließen Datum"
3130 ist sinnvoll, wenn man nur komplette Jahre schließt. Bei Wirtschaftsjahr
3131 = Kalendarjahr entspricht dies aber auch dem Jahresanfang. "Alle
3132 Buchungen" kann z.B. sinnvoll sein wenn man ohne Jahresabschluß
3133 durchbucht. Eröffnungsbuchung mit "alle Buchungen" als Fallback ist z.B.
3134 sinnvoll, wenn man am sich Anfang des zweiten Buchungsjahres befindet,
3135 und noch keinen Jahreswechsel und auch noch keine EB-Buchungen hat. Bei
3136 den Optionen mit EB-Buchungen wird vorausgesetzt, daß diese immer am 1.
3137 Tag des Wirtschaftsjahres gebucht werden. Zur Sicherheit wird das
3138 Startdatum im Bilanzbericht jetzt zusätzlich zum Stichtag mit angezeigt.
3139 Das hilft auch bei der Kontrolle für den Abgleich mit der GuV bzw.
3140 Erfolgsrechnung.</para>
3143 <sect1 id="config.erfolgsrechnung">
3144 <title>Erfolgsrechnung</title>
3146 <para>Seit der Version 3.4.1 existiert in kivitendo der Bericht
3147 <emphasis role="bold"> Erfolgsrechnung</emphasis>.</para>
3149 <para>Die Erfolgsrechnung kann in der Mandantenkonfiguration unter
3150 Features an- oder abgeschaltet werden. Mit der Einstellung
3151 <varname>default_manager = swiss </varname> in der
3152 <filename>config/kivitendo.conf</filename> wird beim neu Erstellen einer
3153 Datenbank automatisch die Anzeige der Erfolgsrechnung im Menü
3154 <guimenu>Berichte </guimenu> ausgewählt und ersetzt dort die GUV.</para>
3156 <para>Im Gegensatz zur GUV werden bei der Erfolgsrechnung sämtliche
3157 Aufwands- und Erlöskonten einzeln aufgelistet (analog zur Bilanz),
3158 sortiert nach ERTRAG und AUFWAND.</para>
3160 <para>Bei den Konteneinstellungen muss bei jedem Konto, das in der
3161 Erfolgsrechnung erscheinen soll, unter <varname>Sonstige
3162 Einstellungen/Erfolgsrechnung</varname> entweder
3163 <literal>01.Ertrag</literal> oder <literal>06.Aufwand</literal>
3164 ausgewählt werden.</para>
3166 <para>Wird bei einem Erlöskonto <literal>06.Aufwand</literal>
3167 ausgewählt, so wird dieses Konto als Aufwandsminderung unter AUFWAND
3170 <para>Wird bei einem Aufwandskonto <literal>01.Ertrag</literal>
3171 ausgewählt, so wird dieses Konto als Ertragsminderung unter ERTRAG
3174 <para>Soll bei einer bereits bestehenden Buchhaltung in Zukunft
3175 zusätzlich die Erfolgsrechnung als Bericht verwendet werden, so müssen
3176 die Einstellungen zu allen Erlös- und Aufwandskonten unter
3177 <varname>Sonstige Einstellungen/Erfolgsrechnung</varname> überprüft und
3178 allenfalls neu gesetzt werden.</para>
3181 <sect1 id="config.rounding">
3182 <title>Rundung in Verkaufsbelegen</title>
3184 <para>In der Schweiz hat die kleinste aktuell benutzte Münze den Wert
3185 von 5 Rappen (0.05 CHF).</para>
3187 <para>Auch wenn im elektronischen Zahlungsverkehr Beträge mit einer
3188 Genauigkeit von 0.01 CHF verwendet werden können, ist es trotzdem nach
3189 wie vor üblich, Rechnungen mit auf 0.05 CHF gerundeten Beträgen
3190 auszustellen.</para>
3192 <para>In kivitendo kann seit der Version 3.4.1 die Einstellung für eine
3193 solche Rundung pro Mandant / Datenbank festgelegt werden.</para>
3195 <para>Die Einstellung wird beim Erstellen der Datenbank bei
3196 <literal>Genauigkeit</literal> festgelegt. Sie kann anschliessend über
3197 das Webinterface von kivitendo nicht mehr verändert werden.</para>
3199 <para>Abhängig vom Wert für <varname>default_manager</varname> in
3200 <filename>config/kivitendo.conf</filename> werden dabei folgende Werte
3201 voreingestellt:</para>
3205 <para>0.05 (default_manager = swiss)</para>
3209 <para>0.01 (default_manager = german)</para>
3213 <para>Der Wert wird in der Datenbank in der Tabelle <varname>defaults
3214 </varname>in der Spalte <varname>precision</varname> gespeichert.</para>
3216 <para>In allen Verkaufsangeboten, Verkaufsaufträgen, Verkaufsrechnungen
3217 und Verkaufsgutschriften wird der Endbetrag inkl. MWST gerundet, wenn
3218 dieser nicht der eingestellten Genauigkeit entspricht.</para>
3220 <para>Beim Buchen einer Verkaufsrechnung wird der Rundungsbetrag
3221 automatisch auf die in der Mandantenkonfiguration festgelegten
3222 Standardkonten für Rundungserträge bzw. Rundungsaufwendungen
3225 <para>(Die berechnete MWST wird durch den Rundungsbetrag nicht mehr
3228 <para>Die in den Druckvorlagen zur Verfügung stehenden Variablen
3229 <varname>quototal</varname>, <varname>ordtotal</varname> bzw.
3230 <varname>invtotal</varname> enthalten den gerundeten Betrag.</para>
3232 <para><emphasis role="bold">Achtung:</emphasis> Werden Verkaufsbelege in
3233 anderen Währungen als der Standardwährung erstellt, so muss in kivitendo
3234 ab Version 3.4.1 die Genauigkeit 0.01 verwendet werden.</para>
3236 <para>Das heisst, Firmen in der Schweiz, die teilweise
3237 Verkaufsrechnungen in Euro oder anderen Währungen erstellen wollen,
3238 müssen beim Erstellen der Datenbank als Genauigkeit 0.01 wählen und
3239 können zur Zeit die 5er Rundung noch nicht nutzen.</para>
3242 <sect1 id="config.client">
3243 <title>Einstellungen pro Mandant</title>
3245 <para>Einige Einstellungen können von einem Benutzer mit dem <link
3246 linkend="Zusammenhänge">Recht</link> "Administration (Für die Verwaltung
3247 der aktuellen Instanz aus einem Userlogin heraus)" gemacht werden. Diese
3248 Einstellungen sind dann für die aktuellen Mandanten-Datenbank gültig.
3249 Die Einstellungen sind unter <guimenu>System</guimenu> →
3250 <guisubmenu>Mandantenkonfiguration</guisubmenu> erreichbar.</para>
3252 <para>Bitte beachten Sie die Hinweise zu den einzelnen Einstellungen.
3253 Einige Einstellungen sollten nicht ohne Weiteres im laufenden Betrieb
3254 geändert werden (siehe auch <link
3255 linkend="config.eur.inventory-system-perpetual">Bemerkungen zu
3256 Bestandsmethode</link>).</para>
3258 <para>Die Einstellungen <literal>show_bestbefore</literal> und
3259 <literal>payments_changeable</literal> aus dem Abschnitt
3260 <literal>features</literal> und die Einstellungen im Abschnitt
3261 <literal>datev_check</literal> (sofern schon vorhanden) der <link
3262 linkend="config.config-file">kivitendo-Konfigurationsdatei</link> werden
3263 bei einem Datenbankupdate einer älteren Version automatisch übernommen.
3264 Diese Einträge können danach aus der Konfigurationsdatei entfernt
3268 <sect1 id="kivitendo-ERP-verwenden">
3269 <title>kivitendo ERP verwenden</title>
3271 <para>Nach erfolgreicher Installation ist der Loginbildschirm unter
3272 folgender URL erreichbar:</para>
3275 url="http://localhost/kivitendo-erp/login.pl">http://localhost/kivitendo-erp/login.pl</ulink></para>
3277 <para>Die Administrationsseite erreichen Sie unter:</para>
3280 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
3284 <chapter id="features" xreflabel="Features und Funktionen">
3285 <title>Features und Funktionen</title>
3287 <sect1 id="features.periodic-invoices"
3288 xreflabel="Wiederkehrende Rechnungen">
3289 <title>Wiederkehrende Rechnungen</title>
3291 <sect2 id="features.periodic-invoices.introduction"
3292 xreflabel="Einführung in wiederkehrende Rechnungen">
3293 <title>Einführung</title>
3295 <para>Wiederkehrende Rechnungen werden als normale Aufträge definiert
3296 und konfiguriert, mit allen dazugehörigen Kunden- und Artikelangaben.
3297 Die konfigurierten Aufträge werden später automatisch in Rechnungen
3298 umgewandelt, so als ob man den Workflow benutzen würde, und auch die
3299 Auftragsnummer wird übernommen, sodass alle wiederkehrenden
3300 Rechnungen, die aus einem Auftrag erstellt wurden, später leicht
3301 wiederzufinden sind.</para>
3304 <sect2 id="features.periodic-invoices.configuration"
3305 xreflabel="Konfiguration von wiederkehrenden Rechnungen">
3306 <title>Konfiguration</title>
3308 <para>Um einen Auftrag für wiederkehrende Rechnung zu konfigurieren,
3309 findet sich beim Bearbeiten des Auftrags ein neuer Knopf
3310 "Konfigurieren", der ein neues Fenster öffnet, in dem man die nötigen
3311 Parameter einstellen kann. Hinter dem Knopf wird außerdem noch
3312 angezeigt, ob der Auftrag als wiederkehrende Rechnung konfiguriert ist
3315 <para>Folgende Parameter kann man konfigurieren:</para>
3322 <para>Bei aktiven Rechnungen wird automatisch eine Rechnung
3323 erstellt, wenn die Periodizität erreicht ist (z.B. am Anfang
3324 eines neuen Monats).</para>
3326 <para>Ist ein Auftrag nicht aktiv, so werden für ihn auch keine
3327 wiederkehrenden Rechnungen erzeugt. Stellt man nach längerer
3328 nicht-aktiver Zeit einen Auftrag wieder auf aktiv, wird beim
3329 nächsten Periodenwechsel für alle Perioden, seit der letzten
3330 aktiven Periode, jeweils eine Rechnung erstellt. Möchte man dies
3331 verhindern, muss man vorher das Startdatum neu setzen.</para>
3333 <para>Für gekündigte Aufträge werden nie mehr Rechnungen
3334 erstellt. Man kann sich diese Aufträge aber gesondert in den
3335 Berichten anzeigen lassen.</para>
3340 <term>Periodizität</term>
3343 <para>Ob monatlich, quartalsweise oder jährlich auf neue
3344 Rechnungen überprüft werden soll. Für jede Periode seit dem
3345 Startdatum wird überprüft, ob für die Periode (beginnend immer
3346 mit dem ersten Tag der Periode) schon eine Rechnung erstellt
3347 wurde. Unter Umständen können bei einem Startdatum in der
3348 Vergangenheit gleich mehrere Rechnungen erstellt werden.</para>
3353 <term>Buchen auf</term>
3356 <para>Das Forderungskonto, in der Regel "Forderungen aus
3357 Lieferungen und Leistungen". Das Gegenkonto ergibt sich aus den
3358 Buchungsgruppen der betreffenden Waren.</para>
3363 <term>Startdatum</term>
3366 <para>ab welchem Datum auf Rechnungserstellung geprüft werden
3372 <term>Enddatum</term>
3375 <para>ab wann keine Rechnungen mehr erstellt werden
3381 <term>Automatische Verlängerung um x Monate</term>
3384 <para>Sollen die wiederkehrenden Rechnungen bei Erreichen des
3385 eingetragenen Enddatums weiterhin erstellt werden, so kann man
3386 hier die Anzahl der Monate eingeben, um die das Enddatum
3387 automatisch nach hinten geschoben wird.</para>
3392 <term>Drucken</term>
3395 <para>Sind Drucker konfiguriert, so kann man sich die erstellten
3396 Rechnungen auch gleich ausdrucken lassen.</para>
3401 <para>Nach Erstellung der Rechnungen kann eine E-Mail mit
3402 Informationen zu den erstellten Rechnungen verschickt werden.
3403 Konfiguriert wird dies in der <link
3404 linkend="config.config-file.sections-parameters">Konfigurationsdatei</link>
3405 <filename>config/kivitendo.conf</filename> im Abschnitt
3406 <varname>[periodic_invoices]</varname>.</para>
3409 <sect2 id="features.periodic-invoices.variables">
3410 <title>Spezielle Variablen</title>
3412 <para>Um die erzeugten Rechnungen individualisieren zu können, werden
3413 beim Umwandeln des Auftrags in eine Rechnung einige speziell
3414 formatierte Variablen durch für die jeweils aktuelle
3415 Abrechnungsperiode gültigen Werte ersetzt. Damit ist es möglich, z.B.
3416 den Abrechnungszeitraum explizit auszuweisen. Eine Variable hat dabei
3417 die Syntax <literal><%variablenname%></literal>.</para>
3419 <para>Sofern es sich um eine Datumsvariable handelt, kann das
3420 Ausgabeformat weiter bestimmt werden, indem an den Variablennamen
3421 Formatoptionen angehängt werden. Die Syntax sieht dabei wie folgt aus:
3422 <literal><%variablenname FORMAT=Formatinformation%></literal>.
3423 Die zur verfügung stehenden Formatinformationen werden unten genauer
3426 <para>Diese Variablen können auch beim automatischen Versand der
3427 erzeugten Rechnungen per E-Mail genutzt werden, indem sie in den
3428 Feldern für den Betreff oder die Nachricht verwendet werden.</para>
3430 <para>Diese Variablen werden in den folgenden Elementen des Auftrags
3435 <para>Bemerkungen</para>
3439 <para>Interne Bemerkungen</para>
3443 <para>Vorgangsbezeichnung</para>
3447 <para>In den Beschreibungs- und Langtextfeldern aller
3452 <para>Die zur Verfügung stehenden Variablen sind die Folgenden:</para>
3456 <term><varname><%current_quarter%></varname>,
3457 <varname><%previous_quarter%></varname>,
3458 <varname><%next_quarter%></varname></term>
3461 <para>Aktuelles, vorheriges und nächstes Quartal als Zahl
3462 zwischen <literal>1</literal> und <literal>4</literal>.</para>
3467 <term><varname><%current_month%></varname>,
3468 <varname><%previous_month%></varname>,
3469 <varname><%next_month%></varname></term>
3472 <para>Aktueller, vorheriger und nächster Monat als Zahl zwischen
3473 <literal>1</literal> und <literal>12</literal>.</para>
3478 <term><varname><%current_month_long%></varname>,
3479 <varname><%previous_month_long%></varname>,
3480 <varname><%next_month_long%></varname></term>
3483 <para>Aktueller, vorheriger und nächster Monat als Name
3484 (<literal>Januar</literal>, <literal>Februar</literal>
3490 <term><varname><%current_year%></varname>,
3491 <varname><%previous_year%></varname>,
3492 <varname><%next_year%></varname></term>
3495 <para>Aktuelles, vorheriges und nächstes Jahr als vierstellige
3496 Jahreszahl (<literal>2013</literal> etc.).</para>
3501 <term><varname><%period_start_date%></varname>,
3502 <varname><%period_end_date%></varname></term>
3505 <para>Formatiertes Datum des ersten und letzten Tages im
3506 Abrechnungszeitraum (z.B. bei quartalsweiser Abrechnung und im
3507 ersten Quartal von 2013 wären dies der
3508 <literal>01.01.2013</literal> und
3509 <literal>31.03.2013</literal>).</para>
3514 <para>Die invidiuellen Formatinformationen bestehen aus Paaren von
3515 Prozentzeichen und einem Buchstaben, welche beide zusammen durch den
3516 dazugehörigen Wert ersetzt werden. So wird z.B. <literal>%Y</literal>
3517 durch das viertstellige Jahr ersetzt. Alle möglichen Platzhalter
3522 <term><varname>%a</varname></term>
3525 <para>Der abgekürzte Wochentagsname.</para>
3530 <term><varname>%A</varname></term>
3533 <para>Der ausgeschriebene Wochentagsname.</para>
3538 <term><varname>%b</varname></term>
3541 <para>Der abgekürzte Monatsname.</para>
3546 <term><varname>%B</varname></term>
3549 <para>Der ausgeschriebene Monatsname.</para>
3554 <term><varname>%C</varname></term>
3557 <para>Das Jahrhundert (Jahr/100) als eine zweistellige
3563 <term><varname>%d</varname></term>
3566 <para>Der Monatstag als Zahl zwischen 01 und 31.</para>
3571 <term><varname>%D</varname></term>
3574 <para>Entspricht %m/%d/%y (amerikanisches Datumsformat).</para>
3579 <term><varname>%e</varname></term>
3582 <para>Wie %d (Monatstag als Zahl zwischen 1 und 31), allerdings
3583 werden führende Nullen durch Leerzeichen ersetzt.</para>
3588 <term><varname>%F</varname></term>
3591 <para>Entspricht %Y-%m-%d (das ISO-8601-Datumsformat).</para>
3596 <term><varname>%j</varname></term>
3599 <para>Der Tag im Jahr als Zahl zwischen 001 und 366
3605 <term><varname>%m</varname></term>
3608 <para>Der Monat als Zahl zwischen 01 und 12 inklusive.</para>
3613 <term><varname>%u</varname></term>
3616 <para>Der Wochentag als Zahl zwischen 1 und 7 inklusive, wobei
3617 die 1 dem Montag entspricht.</para>
3622 <term><varname>%U</varname></term>
3625 <para>Die Wochennummer als Zahl zwischen 00 und 53 inklusive,
3626 wobei der erste Sonntag im Jahr das Startdatum von Woche 01
3632 <term><varname>%V</varname></term>
3635 <para>Die ISO-8601:1988-Wochennummer als Zahl zwischen 01 und 53
3636 inklusive, wobei Woche 01 die erste Woche, von der mindestens
3637 vier Tage im Jahr liegen; Montag ist erster Tag der
3643 <term><varname>%w</varname></term>
3646 <para>Der Wochentag als Zahl zwischen 0 und 6 inklusive, wobei
3647 die 0 dem Sonntag entspricht.</para>
3652 <term><varname>%W</varname></term>
3655 <para>Die Wochennummer als Zahl zwischen 00 und 53 inklusive,
3656 wobei der erste Montag im Jahr das Startdatum von Woche 01
3662 <term><varname>%y</varname></term>
3665 <para>Das Jahr als zweistellige Zahl zwischen 00 und 99
3671 <term><varname>%Y</varname></term>
3674 <para>Das Jahr als vierstellige Zahl.</para>
3679 <term><varname>%%</varname></term>
3682 <para>Das Prozentzeichen selber.</para>
3687 <para>Anwendungsbeispiel für die Ausgabe, von welchem Monat und Jahr
3688 bis zu welchem Monat und Jahr die aktuelle Abrechnungsperiode dauert:
3689 <literal>Abrechnungszeitrum: <%period_start_date FORMAT=%m/%Y%>
3690 bis <%period_end_date FORMAT=%m/%Y%></literal></para>
3693 <sect2 id="features.periodic-invoices.reports">
3694 <title>Auflisten</title>
3696 <para>Unter Verkauf->Berichte->Aufträge finden sich zwei neue
3697 Checkboxen, "Wiederkehrende Rechnungen aktiv" und "Wiederkehrende
3698 Rechnungen inaktiv", mit denen man sich einen Überglick über die
3699 wiederkehrenden Rechnungen verschaffen kann.</para>
3702 <sect2 id="features.periodic-invoices.task-server">
3703 <title>Erzeugung der eigentlichen Rechnungen</title>
3705 <para>Die zeitliche und periodische Überprüfung, ob eine
3706 wiederkehrende Rechnung automatisch erstellt werden soll, geschieht
3707 durch den <link linkend="config.task-server">Taskserver</link>, einen
3708 externen Dienst, der automatisch beim Start des Servers gestartet
3709 werden sollte.</para>
3712 <sect2 id="features.periodic-invoices.create-for-current-month">
3713 <title>Erste Rechnung für aktuellen Monat erstellen</title>
3715 <para>Will man im laufenden Monat eine monatlich wiederkehrende
3716 Rechnung inkl. des laufenden Monats starten, stellt man das Startdatum
3717 auf den Monatsanfang und wartet ein paar Minuten, bis der Taskserver
3718 den neu konfigurieren Auftrag erkennt und daraus eine Rechnung
3719 generiert hat. Alternativ setzt man das Startdatum auf den
3720 Monatsersten des Folgemonats und erstellt die erste Rechnung direkt
3721 manuell über den Workflow.</para>
3725 <sect1 id="features.bank" xreflabel="bankerweiterung">
3726 <title>Bankerweiterung</title>
3728 <sect2 id="features.bank.introduction"
3729 xreflabel="Einführung in die Bankerweiterung">
3730 <title>Einführung</title>
3732 <para>Die Beschreibung der Bankerweiterung befindet sich derzeit noch
3733 im Wiki und soll von dort später hierhin übernommen werden:</para>
3736 url="http://redmine.kivitendo-premium.de/projects/forum/wiki/Bankerweiterung">http://redmine.kivitendo-premium.de/projects/forum/wiki/Bankerweiterung</ulink></para>
3740 <sect1 id="dokumentenvorlagen-und-variablen">
3741 <title>Dokumentenvorlagen und verfügbare Variablen</title>
3743 <sect2 id="dokumentenvorlagen-und-variablen.einführung">
3744 <title>Einführung</title>
3746 <para>Dies ist eine Auflistung der Standard-Dokumentenvorlagen und
3747 aller zur Bearbeitung verfügbaren Variablen. Eine Variable wird in
3748 einer Vorlage durch ihren Inhalt ersetzt, wenn sie in der Form
3749 <function><%variablenname%></function> verwendet wird. Für
3750 LaTeX- und HTML-Vorlagen kann man die Form dieser Tags auch verändern
3752 linkend="dokumentenvorlagen-und-variablen.tag-style"/>).</para>
3754 <para>kivitendo unterstützt LaTeX-, HTML- und OpenDocument-Vorlagen.
3755 Sofern es nicht ausdrücklich eingeschränkt wird, gilt das im Folgenden
3756 gesagte für alle Vorlagenarten.</para>
3758 <para>Insgesamt sind technisch gesehen eine ganze Menge mehr Variablen
3759 verfügbar als hier aufgelistet werden. Die meisten davon können
3760 allerdings innerhalb einer solchen Vorlage nicht sinnvoll verwendet
3761 werden. Wenn eine Auflistung dieser Variablen gewollt ist, so kann
3762 diese wie folgt erhalten werden:</para>
3766 <para><filename>SL/Form.pm</filename> öffnen und am Anfang die
3767 Zeile "<command>use Data::Dumper;</command>" einfügen.</para>
3771 <para>In <filename>Form.pm</filename> die Funktion
3772 <function>parse_template</function> suchen und hier die Zeile
3773 <command>print(STDERR Dumper($self));</command> einfügen.</para>
3777 <para>Einmal per Browser die gewünschte Vorlage "benutzen", z.B.
3778 ein PDF für eine Rechnung erzeugen.</para>
3782 <para>Im <filename>error.log</filename> Apache steht die Ausgabe
3783 der Variablen <varname>$self</varname> in der Form <varname>'key'
3784 => 'value',</varname>. Alle <varname>key</varname>s sind
3790 <sect2 id="dokumentenvorlagen-und-variablen.variablen-ausgeben">
3791 <title>Variablen ausgeben</title>
3793 <para>Um eine Variable auszugeben, müssen sie einfach nur zwischen die
3794 Tags geschrieben werden, also z.B.
3795 <varname><%variablenname%></varname>.</para>
3797 <para>Optional kann man auch mit Leerzeichen getrennte Flags angeben,
3798 die man aber nur selten brauchen wird. Die Syntax sieht also so aus:
3799 <varname><%variablenname FLAG1 FLAG2%></varname>. Momentan
3800 werden die folgenden Flags unterstützt:</para>
3804 <para><option>NOFORMAT</option> gilt nur für Zahlenwerte und gibt
3805 den Wert ohne Formatierung, also ohne Tausendertrennzeichen mit
3806 mit einem Punkt als Dezimaltrennzeichen aus. Nützlich z.B., wenn
3807 damit in der Vorlage z.B. von LaTeX gerechnet werden soll.</para>
3811 <para><option>NOESCAPE</option> unterdrückt das Escapen von
3812 Sonderzeichen für die Vorlagensprache. Wenn also in einer
3813 Variablen bereits gültiger LaTeX-Code steht und dieser von LaTeX
3814 auch ausgewertet und nicht wortwörtlich angezeigt werden soll, so
3815 ist dieses Flag sinnvoll.</para>
3819 <para>Beispiel:</para>
3821 <programlisting><%quototal NOFORMAT%></programlisting>
3824 <sect2 id="dokumentenvorlagen-und-variablen.verwendung-in-druckbefehlen">
3825 <title>Verwendung in Druckbefehlen</title>
3827 <para>In der Admininstration können Drucker definiert werden. Auch im
3828 dort eingebbaren Druckbefehl können die hier aufgelisteten Variablen
3829 und Kontrollstrukturen verwendet werden. Ihr Inhalt wird dabei nach
3830 den Regeln der gängigen Shells formatiert, sodass Sonderzeichen wie
3831 <function>`...`</function> nicht zu unerwünschtem Verhalten
3834 <para>Dies erlaubt z.B. die Definition eines Faxes als Druckerbefehl,
3835 für das die Telefonnummer eines Ansprechpartners als Teil der
3836 Kommandozeile verwendet wird. Für ein fiktives Kommando könnte das
3837 z.B. wie folgt aussehen:</para>
3839 <programlisting>send_fax --number <%if cp_phone2%><%cp_phone2%><%else%><%cp_phone1%><%end%></programlisting>
3842 <sect2 id="dokumentenvorlagen-und-variablen.tag-style"
3843 xreflabel="Anfang und Ende der Tags verändern">
3844 <title>Anfang und Ende der Tags verändern</title>
3846 <para>Der Standardstil für Tags sieht vor, dass ein Tag mit dem
3847 Kleinerzeichen und einem Prozentzeichen beginnt und mit dem
3848 Prozentzeichen und dem Größerzeichen endet, beispielsweise
3849 <function><%customer%></function>. Da diese Form aber z.B. in
3850 LaTeX zu Problemen führen kann, weil das Prozentzeichen dort
3851 Kommentare einleitet, kann pro HTML- oder LaTeX-Dokumentenvorlage der
3852 Stil umgestellt werden.</para>
3854 <para>Dazu werden in die Datei Zeilen geschrieben, die mit dem für das
3855 Format gültigen Kommentarzeichen anfangen, dann
3856 <function>config:</function> enthalten, die entsprechende Option
3857 setzen und bei HTML-Dokumentenvorlagen mit dem Kommentarendzeichen
3858 enden. Beispiel für LaTeX:</para>
3860 <programlisting>% config: tag-style=($ $)</programlisting>
3862 <para>Dies würde kivitendo dazu veranlassen, Variablen zu ersetzen,
3863 wenn sie wie folgt aussehen: <function>($customer$)</function>. Das
3864 äquivalente Beispiel für HTML-Dokumentenvorlagen sieht so aus:</para>
3866 <programlisting><!-- config: tag-style=($ $) --></programlisting>
3869 <sect2 id="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">
3870 <title>Zuordnung von den Dateinamen zu den Funktionen</title>
3872 <para>Diese folgende kurze Auflistung zeigt, welche Vorlage bei
3873 welcher Funktion ausgelesen wird. Dabei ist die Dateiendung
3874 "<filename>.ext</filename>" geeignet zu ersetzen:
3875 "<filename>.tex</filename>" für LaTeX-Vorlagen und
3876 "<filename>.odt</filename>" für OpenDocument-Vorlagen.</para>
3880 <term><filename>bin_list.ext</filename></term>
3883 <para>Lagerliste</para>
3888 <term><filename>check.ext</filename></term>
3896 <term><filename>invoice.ext</filename></term>
3899 <para>Rechnung</para>
3904 <term><filename>packing_list.ext</filename></term>
3907 <para>Packliste</para>
3912 <term><filename>pick_list.ext</filename></term>
3915 <para>Sammelliste</para>
3920 <term><filename>purchase_delivery_order.ext</filename></term>
3923 <para>Lieferschein (Einkauf)</para>
3928 <term><filename>purcharse_order.ext</filename></term>
3931 <para>Bestellung an Lieferanten</para>
3936 <term><filename>request_quotation.ext</filename></term>
3939 <para>Anfrage an Lieferanten</para>
3944 <term><filename>sales_delivery_order.ext</filename></term>
3947 <para>Lieferschein (Verkauf)</para>
3952 <term><filename>sales_order.ext</filename></term>
3955 <para>Bestellung</para>
3960 <term><filename>sales_quotation.ext</filename></term>
3963 <para>Angebot an Kunden</para>
3968 <term><filename>zahlungserinnerung.ext</filename></term>
3971 <para>Mahnung (Dateiname im Programm konfigurierbar)</para>
3976 <term><filename>zahlungserinnerung_invoice.ext</filename></term>
3979 <para>Rechnung über Mahngebühren (Dateiname im Programm
3980 konfigurierbar)</para>
3986 <sect2 id="dokumentenvorlagen-und-variablen.dateinamen-erweitert">
3987 <title>Sprache, Drucker und E-Mail</title>
3989 <para>Angeforderte Sprache und Druckerkürzel in den Dateinamen mit
3990 eingearbeitet. So wird aus der Vorlage
3991 <filename>sales_order.ext</filename> bei Sprache
3992 <function>de</function> und Druckerkürzel <function>lpr2</function>
3993 der Vorlagenname <filename>sales_order_de_lpr2.ext</filename>.
3994 Zusätzlich können für E-Mails andere Vorlagen erstellt werden, diese
3995 bekommen dann noch das Kürzel <filename>_email</filename>, der
3996 vollständige Vorlagenname wäre dann
3997 <filename>sales_order_email_de_lpr2.ext</filename>. In allen Fällen
3998 kann eine Standarddatei <filename>default.ext</filename> hinterlegt
3999 werden. Diese wird verwendet, wenn keine der anderen Varianten
4000 gefunden wird.</para>
4002 <para>Die vollständige Suchreihenfolge für einen Verkaufsauftrag mit
4003 der Sprache "de" und dem Drucker "lpr2", der per E-Mail im Format PDF
4004 verschickt wird, ist:</para>
4008 <para><filename>sales_order_email_de_lpr2.tex</filename></para>
4012 <para><filename>sales_order_de_lpr2.tex</filename></para>
4016 <para><filename>sales_order.tex</filename></para>
4020 <para><filename>default.tex</filename></para>
4024 <para>Die kurzen Varianten dieser Vorlagentitel müssen dann entweder
4025 Standardwerte anzeigen, oder die angeforderten Werte selbst auswerten,
4027 linkend="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"/>.</para>
4030 <sect2 id="dokumentenvorlagen-und-variablen.allgemeine-variablen">
4031 <title>Allgemeine Variablen, die in allen Vorlagen vorhanden
4034 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"
4035 xreflabel="Metainformationen zur angeforderten Vorlage">
4036 <title>Metainformationen zur angeforderten Vorlage</title>
4038 <para>Diese Variablen liefern Informationen darüber welche Variante
4039 einer Vorlage der Benutzer angefragt hat. Sie sind nützlich für
4040 Vorlagenautoren, die aus einer zentralen Layoutvorlage die einzelnen
4041 Formulare einbinden möchten.</para>
4045 <term><varname>template_meta.formname</varname></term>
4048 <para>Basisname der Vorlage. Identisch mit der <link
4049 linkend="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">Zurordnung
4050 zu den Dateinamen</link> ohne die Erweiterung. Ein
4051 Verkaufsauftrag enthält hier
4052 <constant>sales_order</constant>.</para>
4057 <term><varname>template_meta.language.description</varname></term>
4060 <para>Beschreibung der verwendeten Sprache</para>
4065 <term><varname>template_meta.language.template_code</varname></term>
4068 <para>Vorlagenkürzel der verwendeten Sprache, identisch mit
4069 dem Kürzel das im Dateinamen verwendetet wird.</para>
4074 <term><varname>template_meta.language.output_numberformat</varname></term>
4077 <para>Zahlenformat der verwendeten Sprache in der Form
4078 "<constant>1.000,00</constant>". Experimentell! Nur
4079 interessant für Vorlagen die mit unformatierten Werten
4085 <term><varname>template_meta.language.output_dateformat</varname></term>
4088 <para>Datumsformat der verwendeten Sprache in der Form
4089 "<constant>dd.mm.yyyy</constant>". Experimentell! Nur
4090 interessant für Vorlagen die mit unformatierten Werten
4096 <term><varname>template_meta.format</varname></term>
4099 <para>Das angeforderte Format. Kann im Moment die Werte
4100 <constant>pdf</constant>, <constant>postscript</constant>,
4101 <constant>html</constant>, <constant>opendocument</constant>,
4102 <constant>opendocument_pdf</constant> und
4103 <constant>excel</constant> enthalten.</para>
4108 <term><varname>template_meta.extension</varname></term>
4111 <para>Dateierweiterung, wie im Dateinamen. Wird aus
4112 <constant>format</constant> entschieden.</para>
4117 <term><varname>template_meta.media</varname></term>
4120 <para>Ausgabemedium. Kann zur Zeit die Werte
4121 <constant>screen</constant> für Bildschirm,
4122 <constant>email</constant> für E-Mail (triggert das
4123 <constant>_email</constant> Kürzel im Dateinamen),
4124 <constant>printer</constant> für Drucker, und
4125 <constant>queue</constant> für Warteschlange enthalten.</para>
4130 <term><varname>template_meta.printer.description</varname></term>
4133 <para>Beschreibung des ausgewählten Druckers</para>
4138 <term><varname>template_meta.printer.template_code</varname></term>
4141 <para>Vorlagenürzel des ausgewählten Druckers, identisch mit
4142 dem Kürzel das im Dateinamen verwendetet wird.</para>
4147 <term><varname>template_meta.tmpfile</varname></term>
4150 <para>Datei-Prefix für temporäre Dateien.</para>
4156 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.kunden-lieferanten">
4157 <title>Stammdaten von Kunden und Lieferanten</title>
4161 <term><varname>account_number</varname></term>
4164 <para>Kontonummer</para>
4169 <term><varname>bank</varname></term>
4172 <para>Name der Bank</para>
4177 <term><varname>bank_code</varname></term>
4180 <para>Bankleitzahl</para>
4185 <term><varname>bic</varname></term>
4188 <para>Bank-Identifikations-Code (Bank Identifier Code,
4194 <term><varname>business</varname></term>
4197 <para>Kunden-/Lieferantentyp</para>
4202 <term><varname>city</varname></term>
4210 <term><varname>contact</varname></term>
4213 <para>Kontakt</para>
4218 <term><varname>country</varname></term>
4226 <term><varname>c_vendor_id</varname></term>
4229 <para>Lieferantennummer beim Kunden (nur Kunden)</para>
4234 <term><varname>v_customer_id</varname></term>
4237 <para>Kundennummer beim Lieferanten (nur Lieferanten)</para>
4242 <term><varname>cp_email</varname></term>
4245 <para>Email des Ansprechpartners</para>
4250 <term><varname>cp_givenname</varname></term>
4253 <para>Vorname des Ansprechpartners</para>
4258 <term><varname>cp_greeting</varname></term>
4261 <para>Anrede des Ansprechpartners</para>
4266 <term><varname>cp_name</varname></term>
4269 <para>Name des Ansprechpartners</para>
4274 <term><varname>cp_phone1</varname></term>
4277 <para>Telefonnummer 1 des Ansprechpartners</para>
4282 <term><varname>cp_phone2</varname></term>
4285 <para>Telefonnummer 2 des Ansprechpartners</para>
4290 <term><varname>cp_title</varname></term>
4293 <para>Titel des Ansprechpartners</para>
4298 <term><varname>creditlimit</varname></term>
4301 <para>Kreditlimit</para>
4306 <term><varname>customeremail</varname></term>
4309 <para>Email des Kunden; nur für Kunden</para>
4314 <term><varname>customerfax</varname></term>
4317 <para>Faxnummer des Kunden; nur für Kunden</para>
4322 <term><varname>customernotes</varname></term>
4325 <para>Bemerkungen beim Kunden; nur für Kunden</para>
4330 <term><varname>customernumber</varname></term>
4333 <para>Kundennummer; nur für Kunden</para>
4338 <term><varname>customerphone</varname></term>
4341 <para>Telefonnummer des Kunden; nur für Kunden</para>
4346 <term><varname>discount</varname></term>
4354 <term><varname>email</varname></term>
4357 <para>Emailadresse</para>
4362 <term><varname>fax</varname></term>
4365 <para>Faxnummer</para>
4370 <term><varname>gln</varname></term>
4373 <para>GLN (Globale Lokationsnummer)</para>
4378 <term><varname>greeting</varname></term>
4386 <term><varname>homepage</varname></term>
4389 <para>Homepage</para>
4394 <term><varname>iban</varname></term>
4397 <para>Internationale Kontonummer (International Bank Account
4398 Number, IBAN)</para>
4403 <term><varname>language</varname></term>
4406 <para>Sprache</para>
4411 <term><varname>name</varname></term>
4414 <para>Firmenname</para>
4419 <term><varname>payment_description</varname></term>
4422 <para>Name der Zahlart</para>
4427 <term><varname>payment_terms</varname></term>
4430 <para>Zahlungskonditionen</para>
4435 <term><varname>phone</varname></term>
4438 <para>Telefonnummer</para>
4443 <term><varname>shiptocity</varname></term>
4446 <para>Stadt (Lieferadresse) <link
4447 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4452 <term><varname>shiptocontact</varname></term>
4455 <para>Kontakt (Lieferadresse) <link
4456 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4461 <term><varname>shiptocountry</varname></term>
4464 <para>Land (Lieferadresse) <link
4465 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4470 <term><varname>shiptodepartment_1</varname></term>
4473 <para>Abteilung 1 (Lieferadresse) <link
4474 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4479 <term><varname>shiptodepartment_2</varname></term>
4482 <para>Abteilung 2 (Lieferadresse) <link
4483 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4488 <term><varname>shiptoemail</varname></term>
4491 <para>Email (Lieferadresse) <link
4492 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4497 <term><varname>shiptofax</varname></term>
4500 <para>Fax (Lieferadresse) <link
4501 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4506 <term><varname>shiptogln</varname></term>
4509 <para>GLN (Globale Lokationsnummer) (Lieferadresse) <link
4510 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4515 <term><varname>shiptoname</varname></term>
4518 <para>Firmenname (Lieferadresse) <link
4519 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4524 <term><varname>shiptophone</varname></term>
4527 <para>Telefonnummer (Lieferadresse) <link
4528 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4533 <term><varname>shiptostreet</varname></term>
4536 <para>Straße und Hausnummer (Lieferadresse) <link
4537 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4542 <term><varname>shiptozipcode</varname></term>
4545 <para>Postleitzahl (Lieferadresse) <link
4546 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4551 <term><varname>street</varname></term>
4554 <para>Straße und Hausnummer</para>
4559 <term><varname>taxnumber</varname></term>
4562 <para>Steuernummer</para>
4567 <term><varname>ustid</varname></term>
4570 <para>Umsatzsteuer-Identifikationsnummer</para>
4575 <term><varname>vendoremail</varname></term>
4578 <para>Email des Lieferanten; nur für Lieferanten</para>
4583 <term><varname>vendorfax</varname></term>
4586 <para>Faxnummer des Lieferanten; nur für Lieferanten</para>
4591 <term><varname>vendornotes</varname></term>
4594 <para>Bemerkungen beim Lieferanten; nur für Lieferanten</para>
4599 <term><varname>vendornumber</varname></term>
4602 <para>Lieferantennummer; nur für Lieferanten</para>
4607 <term><varname>vendorphone</varname></term>
4610 <para>Telefonnummer des Lieferanten; nur für
4616 <term><varname>zipcode</varname></term>
4619 <para>Postleitzahl</para>
4624 <note id="dokumentenvorlagen-und-variablen.anmerkung-shipto">
4625 <para>Anmerkung: Sind die <varname>shipto*</varname>-Felder in den
4626 Stammdaten nicht eingetragen, so haben die Variablen
4627 <varname>shipto*</varname> den gleichen Wert wie die die
4628 entsprechenden Variablen der Lieferdaten. Das bedeutet, dass sich
4629 einige <varname>shipto*</varname>-Variablen so nicht in den
4630 Stammdaten wiederfinden sondern schlicht Kopien der
4631 Lieferdatenvariablen sind (z.B.
4632 <varname>shiptocontact</varname>).</para>
4636 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-bearbeiter">
4637 <title>Informationen über den Bearbeiter</title>
4641 <term><varname>employee_address</varname></term>
4644 <para>Adressfeld</para>
4649 <term><varname>employee_businessnumber</varname></term>
4652 <para>Firmennummer</para>
4657 <term><varname>employee_company</varname></term>
4660 <para>Firmenname</para>
4665 <term><varname>employee_co_ustid</varname></term>
4668 <para>Usatzsteuer-Identifikationsnummer</para>
4673 <term><varname>employee_duns</varname></term>
4676 <para>DUNS-Nummer</para>
4681 <term><varname>employee_email</varname></term>
4689 <term><varname>employee_fax</varname></term>
4697 <term><varname>employee_name</varname></term>
4700 <para>voller Name</para>
4705 <term><varname>employee_signature</varname></term>
4708 <para>Signatur</para>
4713 <term><varname>employee_taxnumber</varname></term>
4716 <para>Steuernummer</para>
4721 <term><varname>employee_tel</varname></term>
4724 <para>Telefonnummer</para>
4730 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-verkaeufer">
4731 <title>Informationen über den Verkäufer</title>
4735 <term><varname>salesman_address</varname></term>
4738 <para>Adressfeld</para>
4743 <term><varname>salesman_businessnumber</varname></term>
4746 <para>Firmennummer</para>
4751 <term><varname>salesman_company</varname></term>
4754 <para>Firmenname</para>
4759 <term><varname>salesman_co_ustid</varname></term>
4762 <para>Usatzsteuer-Identifikationsnummer</para>
4767 <term><varname>salesman_duns</varname></term>
4770 <para>DUNS-Nummer</para>
4775 <term><varname>salesman_email</varname></term>
4783 <term><varname>salesman_fax</varname></term>
4791 <term><varname>salesman_name</varname></term>
4794 <para>voller Name</para>
4799 <term><varname>salesman_signature</varname></term>
4802 <para>Signatur</para>
4807 <term><varname>salesman_taxnumber</varname></term>
4810 <para>Steuernummer</para>
4815 <term><varname>salesman_tel</varname></term>
4818 <para>Telefonnummer</para>
4824 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-steuern">
4825 <title>Variablen für die einzelnen Steuern</title>
4829 <term><varname>tax</varname></term>
4837 <term><varname>taxbase</varname></term>
4840 <para>zu versteuernder Betrag</para>
4845 <term><varname>taxdescription</varname></term>
4848 <para>Name der Steuer</para>
4853 <term><varname>taxrate</varname></term>
4856 <para>Steuersatz</para>
4862 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-lieferbedingungen">
4863 <title>Variablen für Lieferbedingungen</title>
4867 <term><varname>delivery_term</varname></term>
4870 <para>Datenbank-Objekt der Lieferbedingung</para>
4875 <term><varname>delivery_term.description</varname></term>
4878 <para>Beschreibung der Lieferbedingung</para>
4883 <term><varname>delivery_term.description_long</varname></term>
4886 <para>Langtext bzw. übersetzter Langtext der
4887 Lieferbedingung</para>
4894 <sect2 id="dokumentenvorlagen-und-variablen.invoice">
4895 <title>Variablen in Rechnungen</title>
4897 <sect3 id="dokumentenvorlagen-und-variablen.invoice-allgemein">
4898 <title>Allgemeine Variablen</title>
4902 <term><varname>creditremaining</varname></term>
4905 <para>Verbleibender Kredit</para>
4910 <term><varname>currency</varname></term>
4913 <para>Währung</para>
4918 <term><varname>cusordnumber</varname></term>
4921 <para>Bestellnummer beim Kunden</para>
4926 <term><varname>deliverydate</varname></term>
4929 <para>Lieferdatum</para>
4934 <term><varname>duedate</varname></term>
4937 <para>Fälligkeitsdatum</para>
4942 <term><varname>globalprojectnumber</varname></term>
4945 <para>Projektnummer des ganzen Beleges</para>
4950 <term><varname>globalprojectdescription</varname></term>
4953 <para>Projekbeschreibung des ganzen Beleges</para>
4958 <term><varname>intnotes</varname></term>
4961 <para>Interne Bemerkungen</para>
4966 <term><varname>invdate</varname></term>
4969 <para>Rechnungsdatum</para>
4974 <term><varname>invnumber</varname></term>
4977 <para>Rechnungsnummer</para>
4982 <term><varname>invtotal</varname></term>
4985 <para>gesamter Rechnungsbetrag</para>
4990 <term><varname>notes</varname></term>
4993 <para>Bemerkungen der Rechnung</para>
4998 <term><varname>orddate</varname></term>
5001 <para>Auftragsdatum</para>
5006 <term><varname>ordnumber</varname></term>
5009 <para>Auftragsnummer, wenn die Rechnung aus einem Auftrag
5010 erstellt wurde</para>
5015 <term><varname>payment_description</varname></term>
5018 <para>Name der Zahlart</para>
5023 <term><varname>payment_terms</varname></term>
5026 <para>Zahlungskonditionen</para>
5031 <term><varname>quodate</varname></term>
5034 <para>Angebotsdatum</para>
5039 <term><varname>quonumber</varname></term>
5042 <para>Angebotsnummer</para>
5047 <term><varname>rounding</varname></term>
5050 <para>Betrag, um den <varname>invtotal</varname> gerundet
5051 wurde (kann positiv oder negativ sein)</para>
5056 <term><varname>shippingpoint</varname></term>
5059 <para>Versandort</para>
5064 <term><varname>shipvia</varname></term>
5067 <para>Transportmittel</para>
5072 <term><varname>subtotal</varname></term>
5075 <para>Zwischensumme aller Posten ohne Steuern</para>
5080 <term><varname>total</varname></term>
5083 <para>Restsumme der Rechnung (Summe abzüglich bereits
5084 bezahlter Posten)</para>
5089 <term><varname>transaction_description</varname></term>
5092 <para>Vorgangsbezeichnung</para>
5097 <term><varname>transdate</varname></term>
5100 <para>Auftragsdatum wenn die Rechnung aus einem Auftrag
5101 erstellt wurde</para>
5107 <sect3 id="dokumentenvorlagen-und-variablen.invoice-posten">
5108 <title>Variablen für jeden Posten auf der Rechnung</title>
5112 <term><varname>bin</varname></term>
5115 <para>Stellage</para>
5120 <term><varname>description</varname></term>
5123 <para>Artikelbeschreibung</para>
5128 <term><varname>cusordnumber_oe</varname></term>
5131 <para>Bestellnummer des Kunden aus dem Auftrag, aus dem der
5132 Posten ursprünglich stammt (nur Verkauf)</para>
5137 <term><varname>discount</varname></term>
5140 <para>Rabatt als Betrag</para>
5145 <term><varname>discount_sub</varname></term>
5148 <para>Zwischensumme mit Rabatt</para>
5153 <term><varname>donumber_do</varname></term>
5156 <para>Lieferscheinnummer des Lieferscheins, aus dem die
5157 Position ursprünglich stammt, wenn die Rechnung im Rahmen des
5158 Workflows aus einem Lieferschein erstellt wurde.</para>
5163 <term><varname>drawing</varname></term>
5166 <para>Zeichnung</para>
5171 <term><varname>ean</varname></term>
5174 <para>EAN-Code</para>
5179 <term><varname>image</varname></term>
5187 <term><varname>linetotal</varname></term>
5190 <para>Zeilensumme (Anzahl * Einzelpreis)</para>
5195 <term><varname>longdescription</varname></term>
5198 <para>Langtext</para>
5203 <term><varname>microfiche</varname></term>
5206 <para>Mikrofilm</para>
5211 <term><varname>netprice</varname></term>
5214 <para>Alternative zu <varname>sellprice</varname>, aber
5215 <varname>netprice</varname> entspricht dem effektiven
5216 Einzelpreis und beinhaltet Zeilenrabatt und Preisfaktor.
5217 <varname>netprice</varname> wird rückgerechnet aus Zeilensumme
5218 / Menge. Diese Variable ist nützlich, wenn man den gewährten
5219 Rabatt in der Druckvorlage nicht anzeigen möchte, aber Menge *
5220 Einzelpreis trotzdem die angezeigte Zeilensumme ergeben soll.
5221 <varname>netprice</varname> hat nichts mit Netto/Brutto im
5222 Sinne von Steuern zu tun.</para>
5227 <term><varname>nodiscount_linetotal</varname></term>
5230 <para>Zeilensumme ohne Rabatt</para>
5235 <term><varname>nodiscount_sub</varname></term>
5238 <para>Zwischensumme ohne Rabatt</para>
5243 <term><varname>number</varname></term>
5246 <para>Artikelnummer</para>
5251 <term><varname>ordnumber_oe</varname></term>
5254 <para>Auftragsnummer des Originalauftrags, aus dem der Posten
5255 ursprünglich stammt. Nützlich, wenn die Rechnung aus mehreren
5256 Lieferscheinen zusammengefasst wurde, oder wenn zwischendurch
5257 eine Sammelauftrag aus mehreren Aufträgen erstellt wurde. In
5258 letzterem Fall wird die unsprüngliche Auftragsnummer
5264 <term><varname>p_discount</varname></term>
5267 <para>Rabatt in Prozent</para>
5272 <term><varname>partnotes</varname></term>
5275 <para>Die beim Artikel gespeicherten Bemerkungen</para>
5280 <term><varname>partsgroup</varname></term>
5283 <para>Warengruppe</para>
5288 <term><varname>price_factor</varname></term>
5291 <para>Der Preisfaktor als Zahl, sofern einer eingestellt
5297 <term><varname>price_factor_name</varname></term>
5300 <para>Der Name des Preisfaktors, sofern einer eingestellt
5306 <term><varname>projectnumber</varname></term>
5309 <para>Projektnummer</para>
5314 <term><varname>projectdescription</varname></term>
5317 <para>Projektbeschreibung</para>
5322 <term><varname>qty</varname></term>
5330 <term><varname>reqdate</varname></term>
5333 <para>Lieferdatum</para>
5338 <term><varname>runningnumber</varname></term>
5341 <para>Position auf der Rechnung (1, 2, 3...)</para>
5346 <term><varname>sellprice</varname></term>
5349 <para>Verkaufspreis</para>
5354 <term><varname>serialnumber</varname></term>
5357 <para>Seriennummer</para>
5362 <term><varname>tax_rate</varname></term>
5365 <para>Steuersatz</para>
5370 <term><varname>transdate_do</varname></term>
5373 <para>Datum des Lieferscheins, wenn die Rechnung im Rahmen des
5374 Workflows aus einem Lieferschein stammte.</para>
5379 <term><varname>transdate_oe</varname></term>
5382 <para>Datum des Auftrags, wenn die Rechnung im Rahmen des
5383 Workflows aus einem Auftrag erstellt wurde. Wenn es
5384 Sammelaufträge gab wird das Datum des ursprünglichen Auftrags
5390 <term><varname>transdate_quo</varname></term>
5393 <para>Datum des Angebots, wenn die Position im Rahmen des
5394 Workflows aus einem Angebot stammte.</para>
5399 <term><varname>unit</varname></term>
5402 <para>Einheit</para>
5407 <term><varname>weight</varname></term>
5410 <para>Gewicht</para>
5415 <para>Für jeden Posten gibt es ein Unterarray mit den Informationen
5416 über Lieferanten und Lieferantenartikelnummer. Diese müssen mit
5417 einer <function>foreach</function>-Schleife ausgegeben werden, da
5418 für jeden Artikel mehrere Lieferanteninformationen hinterlegt sein
5419 können. Die Variablen dafür lauten:</para>
5423 <term><varname>make</varname></term>
5426 <para>Lieferant</para>
5431 <term><varname>model</varname></term>
5434 <para>Lieferantenartikelnummer</para>
5440 <sect3 id="dokumentenvorlagen-und-variablen.invoice-zahlungen">
5441 <title>Variablen für die einzelnen Zahlungseingänge</title>
5445 <term><varname>payment</varname></term>
5453 <term><varname>paymentaccount</varname></term>
5461 <term><varname>paymentdate</varname></term>
5469 <term><varname>paymentmemo</varname></term>
5477 <term><varname>paymentsource</varname></term>
5486 <sect3 id="dokumentenvorlagen-und-variablen.benutzerdefinierte-variablen-vc">
5487 <title>Benutzerdefinierte Kunden- und Lieferantenvariablen</title>
5489 <para>Die vom Benutzer definierten Variablen für Kunden und
5490 Lieferanten stehen beim Ausdruck von Einkaufs- und Verkaufsbelegen
5491 ebenfalls zur Verfügung. Ihre Namen setzen sich aus dem Präfix
5492 <varname>vc_cvar_</varname> und dem vom Benutzer festgelegten
5493 Variablennamen zusammen.</para>
5495 <para>Beispiel: Der Benutzer hat eine Variable namens
5496 <varname>number_of_employees</varname> definiert, die die Anzahl der
5497 Mitarbeiter des Unternehmens enthält. Diese Variable steht dann
5498 unter dem Namen <varname>vc_cvar_number_of_employees</varname> zur
5501 <para>Die benutzerdefinierten Variablen der Lieferadressen stehen
5502 unter einem ähnlichen Namensschema zur Verfügung. Hier lautet der
5503 Präfix <varname>shiptocvar_</varname>.</para>
5505 <para>Analog stehen die benutzerdefinierten Variablen für
5506 Ansprechpersonen mit dem Namenspräfix <varname>cp_cvar_</varname>
5507 zur Verfügung.</para>
5511 <sect2 id="dokumentenvorlagen-und-variablen.dunning">
5512 <title>Variablen in Mahnungen und Rechnungen über Mahngebühren</title>
5514 <sect3 id="dokumentenvorlagen-und-variablen.dunning-vorlagennamen">
5515 <title>Namen der Vorlagen</title>
5517 <para>Die Namen der Vorlagen werden im System-Menü vom Benutzer
5518 eingegeben. Wird für ein Mahnlevel die Option zur automatischen
5519 Erstellung einer Rechnung über die Mahngebühren und Zinsen
5520 aktiviert, so wird der Name der Vorlage für diese Rechnung aus dem
5521 Vorlagenname für diese Mahnstufe mit dem Zusatz
5522 <constant>_invoice</constant> gebildet. Weiterhin werden die Kürzel
5523 für die ausgewählte Sprache und den ausgewählten Drucker
5527 <sect3 id="dokumentenvorlagen-und-variablen.dunning-allgemein">
5528 <title>Allgemeine Variablen in Mahnungen</title>
5530 <para>Die Variablen des Bearbeiters, bzw. Verkäufers stehen wie
5531 gewohnt als <varname>employee_...</varname> bzw.
5532 <varname>salesman_...</varname> zur Verfügung. Werden mehrere
5533 Rechnungen in einer Mahnung zusammengefasst, so werden die Metadaten
5534 (Bearbeiter, Abteilung, etc) der ersten angemahnten Rechnung im
5535 Ausdruck genommen.</para>
5537 <para>Die Adressdaten des Kunden stehen als Variablen
5538 <varname>name</varname>, <varname>street</varname>,
5539 <varname>zipcode</varname>, <varname>city</varname>,
5540 <varname>country</varname>, <varname>department_1</varname>,
5541 <varname>department_2</varname>, und <varname>email</varname> zur
5542 Verfügung. Der Ansprechpartner <varname>cp_...</varname> steht auch
5543 zu Verfügung, wird allerdings auch nur von der ersten angemahnten
5544 Rechnung (s.o.) genommen.</para>
5546 <para>Weitere Variablen beinhalten:</para>
5550 <term><varname>dunning_date</varname></term>
5553 <para>Datum der Mahnung</para>
5558 <term><varname>dunning_duedate</varname></term>
5561 <para>Fälligkeitsdatum für diese Mahhnung</para>
5566 <term><varname>dunning_id</varname></term>
5569 <para>Mahnungsnummer</para>
5574 <term><varname>fee</varname></term>
5577 <para>Kumulative Mahngebühren</para>
5582 <term><varname>interest_rate</varname></term>
5585 <para>Zinssatz per anno in Prozent</para>
5590 <term><varname>total_amount</varname></term>
5593 <para>Gesamter noch zu zahlender Betrag als
5594 <function>fee</function> + <function>total_interest</function>
5595 + <function>total_open_amount</function></para>
5600 <term><varname>total_interest</varname></term>
5603 <para>Zinsen per anno über alle Rechnungen</para>
5608 <term><varname>total_open_amount</varname></term>
5611 <para>Summe über alle offene Beträge der Rechnungen</para>
5617 <sect3 id="dokumentenvorlagen-und-variablen.dunning-details">
5618 <title>Variablen für jede gemahnte Rechnung in einer Mahnung</title>
5622 <term><varname>dn_amount</varname></term>
5625 <para>Rechnungssumme (brutto)</para>
5630 <term><varname>dn_duedate</varname></term>
5633 <para>Originales Fälligkeitsdatum der Rechnung</para>
5638 <term><varname>dn_dunning_date</varname></term>
5641 <para>Datum der Mahnung</para>
5646 <term><varname>dn_dunning_duedate</varname></term>
5649 <para>Fälligkeitsdatum der Mahnung</para>
5654 <term><varname>dn_fee</varname></term>
5657 <para>Kummulative Mahngebühr</para>
5662 <term><varname>dn_interest</varname></term>
5665 <para>Zinsen per anno für diese Rechnung</para>
5670 <term><varname>dn_invnumber</varname></term>
5673 <para>Rechnungsnummer</para>
5678 <term><varname>dn_linetotal</varname></term>
5681 <para>Noch zu zahlender Betrag (ergibt sich aus
5682 <varname>dn_open_amount</varname> + <varname>dn_fee</varname>
5683 + <varname>dn_interest</varname>)</para>
5688 <term><varname>dn_netamount</varname></term>
5691 <para>Rechnungssumme (netto)</para>
5696 <term><varname>dn_open_amount</varname></term>
5699 <para>Offener Rechnungsbetrag</para>
5704 <term><varname>dn_ordnumber</varname></term>
5707 <para>Bestellnummer</para>
5712 <term><varname>dn_transdate</varname></term>
5715 <para>Rechnungsdatum</para>
5720 <term><varname>dn_curr</varname></term>
5723 <para>Währung, in der die Rechnung erstellt wurde. (Die
5724 Rechnungsbeträge sind aber immer in der Hauptwährung)</para>
5730 <sect3 id="dokumentenvorlagen-und-variablen.dunning-invoice">
5731 <title>Variablen in automatisch erzeugten Rechnungen über
5732 Mahngebühren</title>
5734 <para>Die Variablen des Verkäufers stehen wie gewohnt als
5735 <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
5736 Kunden stehen als Variablen <varname>name</varname>,
5737 <varname>street</varname>, <varname>zipcode</varname>,
5738 <varname>city</varname>, <varname>country</varname>,
5739 <varname>department_1</varname>, <varname>department_2</varname>,
5740 und <varname>email</varname> zur Verfügung.</para>
5742 <para>Weitere Variablen beinhalten:</para>
5746 <term><varname>duedate</varname></term>
5749 <para>Fälligkeitsdatum der Rechnung</para>
5754 <term><varname>dunning_id</varname></term>
5757 <para>Mahnungsnummer</para>
5762 <term><varname>fee</varname></term>
5765 <para>Mahngebühren</para>
5770 <term><varname>interest</varname></term>
5778 <term><varname>invamount</varname></term>
5781 <para>Rechnungssumme (ergibt sich aus <varname>fee</varname> +
5782 <varname>interest</varname>)</para>
5787 <term><varname>invdate</varname></term>
5790 <para>Rechnungsdatum</para>
5795 <term><varname>invnumber</varname></term>
5798 <para>Rechnungsnummer</para>
5805 <sect2 id="dokumentenvorlagen-und-variablen.andere-vorlagen">
5806 <title>Variablen in anderen Vorlagen</title>
5809 <title>Einführung</title>
5811 <para>Die Variablen in anderen Vorlagen sind ähnlich wie in der
5812 Rechnung. Allerdings heißen die Variablen, die mit
5813 <varname>inv</varname> beginnen, jetzt anders. Bei den Angeboten
5814 fangen sie mit <varname>quo</varname> für "quotation" an:
5815 <varname>quodate</varname> für Angebotsdatum etc. Bei Bestellungen
5816 wiederum fangen sie mit <varname>ord</varname> für "order" an:
5817 <varname>ordnumber</varname> für Bestellnummer etc.</para>
5819 <para>Manche Variablen sind in anderen Vorlagen hingegen gar nicht
5820 vorhanden wie z.B. die für bereits verbuchte Zahlungseingänge. Dies
5821 sind Variablen, die vom Geschäftsablauf her in der entsprechenden
5822 Vorlage keine Bedeutung haben oder noch nicht belegt sein
5825 <para>Im Folgenden werden nur wichtige Unterschiede zu den Variablen
5826 in Rechnungen aufgeführt.</para>
5829 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-quotations">
5830 <title>Angebote und Preisanfragen</title>
5834 <term><varname>quonumber</varname></term>
5837 <para>Angebots- bzw. Anfragenummer</para>
5842 <term><varname>reqdate</varname></term>
5845 <para>Gültigkeitsdatum (bei Angeboten) bzw. Lieferdatum (bei
5846 Preisanfragen)</para>
5851 <term><varname>transdate</varname></term>
5854 <para>Angebots- bzw. Anfragedatum</para>
5860 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-orders">
5861 <title>Auftragsbestätigungen und Lieferantenaufträge</title>
5865 <term><varname>ordnumber</varname></term>
5868 <para>Auftragsnummer</para>
5873 <term><varname>reqdate</varname></term>
5876 <para>Lieferdatum</para>
5881 <term><varname>transdate</varname></term>
5884 <para>Auftragsdatum</para>
5890 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-delivery-orders">
5891 <title>Lieferscheine (Verkauf und Einkauf)</title>
5895 <term><varname>cusordnumber</varname></term>
5898 <para>Bestellnummer des Kunden (im Verkauf) bzw. Bestellnummer
5899 des Lieferanten (im Einkauf)</para>
5904 <term><varname>donumber</varname></term>
5907 <para>Lieferscheinnummer</para>
5912 <term><varname>transdate</varname></term>
5915 <para>Lieferscheindatum</para>
5920 <para>Für jede Position eines Lieferscheines gibt es ein Unterarray
5921 mit den Informationen darüber, von welchem Lager und Lagerplatz aus
5922 die Waren verschickt wurden (Verkaufslieferscheine) bzw. auf welchen
5923 Lagerplatz sie eingelagert wurden. Diese müssen mittels einer
5924 <function>foreach</function>-Schleife ausgegeben werden. Diese
5925 Variablen sind:</para>
5929 <term><varname>si_bin</varname></term>
5932 <para>Lagerplatz</para>
5937 <term><varname>si_chargenumber</varname></term>
5940 <para>Chargennummer</para>
5945 <term><varname>si_bestbefore</varname></term>
5948 <para>Mindesthaltbarkeit</para>
5953 <term><varname>si_number</varname></term>
5956 <para>Artikelnummer</para>
5961 <term><varname>si_qty</varname></term>
5964 <para>Anzahl bzw. Menge</para>
5969 <term><varname>si_runningnumber</varname></term>
5972 <para>Positionsnummer (1, 2, 3 etc)</para>
5977 <term><varname>si_unit</varname></term>
5980 <para>Einheit</para>
5985 <term><varname>si_warehouse</varname></term>
5994 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-statement">
5995 <title>Variablen für Sammelrechnung</title>
5999 <term><varname>c0total</varname></term>
6002 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit < 30
6008 <term><varname>c30total</varname></term>
6011 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 30
6012 und < 60 Tage</para>
6017 <term><varname>c60total</varname></term>
6020 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 60
6021 und < 90 Tage</para>
6026 <term><varname>c90total</varname></term>
6029 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 90
6035 <term><varname>total</varname></term>
6038 <para>Gesamtbetrag aller Rechnungen</para>
6043 <para>Variablen für jede Rechnungsposition in Sammelrechnung:</para>
6047 <term><varname>invnumber</varname></term>
6050 <para>Rechnungsnummer</para>
6055 <term><varname>invdate</varname></term>
6058 <para>Rechnungsdatum</para>
6063 <term><varname>duedate</varname></term>
6066 <para>Fälligkeitsdatum</para>
6071 <term><varname>amount</varname></term>
6074 <para>Summe der Rechnung</para>
6079 <term><varname>open</varname></term>
6082 <para>Noch offener Betrag der Rechnung</para>
6087 <term><varname>c0</varname></term>
6090 <para>Noch offener Rechnungsbetrag mit Fälligkeit < 30
6096 <term><varname>c30</varname></term>
6099 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 30 und
6105 <term><varname>c60</varname></term>
6108 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 60 und
6114 <term><varname>c90</varname></term>
6117 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 90
6125 <sect2 id="dokumentenvorlagen-und-variablen.bloecke">
6126 <title>Blöcke, bedingte Anweisungen und Schleifen</title>
6128 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.einfuehrung">
6129 <title>Einführung</title>
6131 <para>Der Parser kennt neben den Variablen einige weitere
6132 Konstrukte, die gesondert behandelt werden. Diese sind wie
6133 Variablennamen in spezieller Weise markiert:
6134 <command><%anweisung%> ... <%end%></command></para>
6136 <para>Anmerkung zum <command><%end%></command>: Der besseren
6137 Verständlichkeit halber kann man nach dem <command>end</command>
6138 noch beliebig weitere Wörter schreiben, um so zu markieren, welche
6139 Anweisung (z.B. <command>if</command> oder
6140 <command>foreach</command>) damit abgeschlossen wird.</para>
6142 <para>Beispiel: Lautet der Beginn eines Blockes z.B.
6143 <command><%if type == "sales_quotation"%></command>, so könnte
6144 er mit <command><%end%></command> genauso abgeschlossen werden
6145 wie mit <command><%end if%></command> oder auch
6146 <command><%end type == "sales_quotation"%></command>.</para>
6149 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.if">
6150 <title>Der if-Block</title>
6152 <programlisting><%if variablenname%>
6154 <%end%></programlisting>
6156 <para>Eine normale "if-then"-Bedingung. Die Zeilen zwischen dem "if"
6157 und dem "end" werden nur ausgegeben, wenn die Variable
6158 <varname>variablenname</varname> gesetzt und ungleich 0 ist.</para>
6160 <para>Handelt es sich bei der benannten Variable um ein Array, also
6161 um einen Variablennamen, über den man mit <command><%foreach
6162 variablenname%></command> iteriert, so wird mit diesem Konstrukt
6163 darauf getestet, ob das Array Elemente enthält. Somit würde im
6164 folgenden Beispiel nur dann eine Liste von Zahlungseingängen samt
6165 ihrer Überschrift "Zahlungseingänge" ausgegeben, wenn tatsächlich
6166 welche getätigt wurden:</para>
6168 <programlisting><%if payment%>
6170 <%foreach payment%>
6171 Am <%paymentdate%>: <%payment%> €
6172 <%end foreach%>
6173 <%end if%></programlisting>
6175 <para>Die Bedingung kann auch negiert werden, indem das Wort
6176 <function>not</function> nach dem <filename>if</filename> verwendet
6177 wird. Beispiel:</para>
6179 <programlisting><%if not cp_greeting%>
6181 <%end%></programlisting>
6183 <para>Zusätzlich zu dem einfachen Test, ob eine Variable gesetzt ist
6184 oder nicht, bietet dieser Block auch die Möglichkeit, den Inhalt
6185 einer Variablen mit einer festen Zeichenkette oder einer anderen
6186 Variablen zu vergleichen. Ob der Vergleich mit einer Zeichenkette
6187 oder einer anderen Variablen vorgenommen wird, hängt davon ab, ob
6188 die rechte Seite des Vergleichsoperators in Anführungszeichen
6189 gesetzt wird (Vergleich mit Zeichenkette) oder nicht (Vergleich mit
6190 anderer Variablen). Zwei Beispiele, die beide Vergleiche
6193 <programlisting><%if var1 == "Wert"%></programlisting>
6195 <para>Testet die Variable <varname>var1</varname> auf
6196 übereinstimmung mit der Zeichenkette <constant>Wert</constant>.
6197 Mittels <function>!=</function> anstelle von <function>==</function>
6198 würde auf Ungleichheit getestet.</para>
6200 <programlisting><%if var1 == var2%></programlisting>
6202 <para>Testet die Variable <varname>var1</varname> auf
6203 übereinstimmung mit der Variablen <varname>var2</varname>. Mittel
6204 <function>!=</function> anstelle von <function>==</function> würde
6205 auf Ungleichheit getestet.</para>
6207 <para>Erfahrere Benutzer können neben der Tests auf (Un-)Gleichheit
6208 auch Tests auf Übereinstimmung mit regulären Ausdrücken ohne
6209 Berücksichtung der Groß- und Kleinschreibung durchführen. Dazu dient
6210 dieselbe Syntax wie oben nur mit <function>=~</function> und
6211 <function>!~</function> als Vergleichsoperatoren.</para>
6213 <para>Beispiel für einen Test, ob die Variable
6214 <varname>intnotes</varname> (interne Bemerkungen) das Wort
6215 <constant>schwierig</constant> enthält:</para>
6217 <programlisting><%if intnotes =~ "schwierig"%></programlisting>
6220 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.foreach">
6221 <title>Der foreach-Block</title>
6223 <programlisting><%foreach variablenname%>
6225 <%end%></programlisting>
6227 <para>Fügt die Zeilen zwischen den beiden Anweisungen so oft ein,
6228 wie das Perl-Array der Variablen <varname>variablenname</varname>
6229 Elemente enthät. Dieses Konstrukt wird zur Ausgabe der einzelnen
6230 Posten einer Rechnung / eines Angebots sowie zur Ausgabe der Steuern
6231 benutzt. In jedem Durchlauf werden die <link
6232 linkend="dokumentenvorlagen-und-variablen.invoice-posten">zeilenbezogenen
6233 Variablen</link> jeweils auf den Wert für die aktuelle Position
6236 <para>Die Syntax sieht normalerweise wie folgt aus:</para>
6238 <programlisting><%foreach number%>
6239 Position: <%runningnumber%>
6240 Anzahl: <%qty%>
6241 Artikelnummer: <%number%>
6242 Beschreibung: <%description%>
6244 <%end%></programlisting>
6246 <para>Besonderheit in OpenDocument-Vorlagen: Tritt ein
6247 <function><%foreach%></function>-Block innerhalb einer
6248 Tabellenzelle auf, so wird die komplette Tabellenzeile so oft
6249 wiederholt wie notwendig. Tritt er außerhalb auf, so wird nur der
6250 Inhalt zwischen <function><%foreach%></function> und
6251 <function><%end%></function> wiederholt, nicht aber die
6252 komplette Zeile, in der er steht.</para>
6256 <sect2 id="dokumentenvorlagen-und-variablen.markup">
6257 <title>Markup-Code zur Textformatierung innerhalb von
6260 <para>Wenn der Benutzer innhalb von Formularen in kivitendo Text
6261 anders formatiert haben möchte, so ist dies begrenzt möglich.
6262 kivitendo unterstützt die Textformatierung mit HTML-ähnlichen Tags.
6263 Der Benutzer kann z.B. bei der Artikelbeschreibung auf einer Rechnung
6264 Teile des Texts zwischen Start- und Endtags setzen. Dieser Teil wird
6265 dann automatisch in Anweisungen für das ausgewählte Vorlagenformat
6266 (HTML oder PDF über LaTeX) umgesetzt.</para>
6268 <para>Die unterstützen Formatierungen sind:</para>
6272 <term><b>Text</b></term>
6275 <para>Text wird in Fettdruck gesetzt.</para>
6280 <term><i>Text</i></term>
6283 <para>Text wird kursiv gesetzt.</para>
6288 <term><u>Text</u></term>
6291 <para>Text wird unterstrichen.</para>
6296 <term><s>Text</s></term>
6299 <para>Text wird durchgestrichen. Diese Formatierung ist nicht
6300 bei der Ausgabe als PDF über LaTeX verfügbar.</para>
6305 <term><bullet></term>
6308 <para>Erzeugt einen ausgefüllten Kreis für Aufzählungen (siehe
6314 <para>Der Befehl <command><bullet></command> funktioniert
6315 momentan auch nur in Latex-Vorlagen.</para>
6319 <sect1 id="excel-templates">
6320 <title>Excel-Vorlagen</title>
6322 <sect2 id="excel-templates.summary">
6323 <title>Zusammenfassung</title>
6325 <para>Dieses Dokument beschreibt den Mechanismus, mit dem
6326 Exceltemplates abgearbeitet werden, und die Einschränkungen, die damit
6330 <sect2 id="excel-templates.usage">
6331 <title>Bedienung</title>
6333 <para>Der Excel Mechanismus muss in der Konfigurationsdatei aktiviert
6334 werden. Die Konfigurationsoption heißt <varname>excel_templates =
6335 1</varname> im Abschnitt <varname>[print_templates]</varname>.</para>
6337 <para>Eine Excelvorlage kann dann unter dem Namen einer beliebigen
6338 anderen Vorlage mit der Endung <filename>.xls</filename> gespeichert
6339 werden. In den normalen Verkaufsmasken taucht nun
6340 <constant>Excel</constant> als auswählbares Format auf und kann von da
6341 an wie LaTeX- oder OpenOffice-Vorlagen benutzt werden.</para>
6343 <para>Der Sonderfall der Angebote aus der Kundenmaske ist ebenfalls
6344 eine Angebotsvorlage und wird unter dem internen Namen der Angebote
6345 <filename>sales_quotation.xls</filename> gespeichert.</para>
6348 <sect2 id="excel-templates.syntax">
6349 <title>Variablensyntax</title>
6351 <para>Einfache Syntax:
6352 <command><<varname>></command></para>
6354 <para>Dabei sind <constant><<</constant> und
6355 <constant>>></constant> die Delimiter. Da Excel auf festen
6356 Breiten besteht, kann der Tag künstlich verlängert werden, indem
6357 weitere <constant><</constant> oder <constant>></constant>
6358 eingefügt werden. Der Tag muss nicht symmetrisch sein.
6361 <programlisting><<<<<varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
6363 <para>Um die Limitierung der festen Breite zu reduzieren, können
6364 weitere Variablen in einem Block interpoliert werden. Whitespace wird
6365 dazwishen dann erhalten. Beispiel:</para>
6367 <programlisting><<<<<varname1 varname2 varname3>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
6369 <para>Die Variablen werden interpoliert, und linksbündig mit
6370 Leerzeichen auf die gewünschte Länge aufgefüllt. Ist der String zu
6371 lang, werden überzählige Zeichen abgeschnitten.</para>
6373 <para>Es ist ausserdem möglich, Daten rechtsbündig darzustellen, wenn
6374 der Block mit einem Leerzeichen anfängt. Beispiel:</para>
6376 <programlisting><<<<<< varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
6378 <para>Dies würde rechtsbündig triggern. Wenn bei rechtsbündiger
6379 Ausrichtung Text abgeschnitten werden muss, wird er vom linken Ende
6383 <sect2 id="excel-templates.limitations">
6384 <title>Einschränkungen</title>
6386 <para>Das Excelformat bis 2002 ist ein binäres Format, und kann nicht
6387 mit vertretbarem Aufwand editiert werden. Der Templatemechanismus
6388 beschränkt sich daher darauf, Textstellen exakt durch einen anderen
6389 Text zu ersetzen.</para>
6391 <para>Aus dem gleichen Grund sind die Kontrolllstrukturen
6392 <command><%if%></command> und
6393 <command><%foreach%></command> nicht vorhanden. Der Delimiter
6394 <constant><% %></constant> kommt in den Headerinformationen
6395 evtl. vor. Deshalb wurde auf den sichereren Delimiter
6396 <constant><<</constant> und <constant>>></constant>
6401 <sect1 id="features.warehouse">
6402 <title>Mandantenkonfiguration Lager</title>
6404 <para>Die Lagerverwaltung in kivitendo funktioniert standardmässig wie
6405 folgt: Wird ein Lager mit einem Lagerplatz angelegt, so gibt es die
6406 Möglichkeit hier über den Menüpunkt Lager entsprechende Warenbewegungen
6407 durchzuführen. Ferner kann jede Position eines Lieferscheins ein-, bzw.
6408 ausgelagert werden (Einkauf-, bzw. Verkauf). Es können beliebig viele
6409 Lager mit beliebig vielen Lagerplätzen abgebildet werden. Die
6410 Lagerbewegungen über einen Lieferschein erfolgt durch Anklicken jeder
6411 Einzelposition und das Auswählen dieser Position zu einem Lager mit
6412 Lagerplatz. Dieses Verfahren lässt sich schrittweise vereinfachen, je
6413 nachdem wie die Einstellungen in der Mandatenkonfiguration gesetzt
6418 <para><option>Auslagern über Standardlagerplatz</option> Hier wird
6419 ein zusätzlicher Knopf (Auslagern über Standard-Lagerplatz) in dem
6420 Lieferschein-Beleg hinzugefügt, der dann alle Lagerbewegungen über
6421 den Standardlagerplatz (konfigurierbar pro Ware) durchführt.</para>
6425 <para><option>Auslagern ohne Bestandsprüfung</option> Das obige
6426 Auslagern schlägt fehl, wenn die entsprechende Menge für die
6427 Lagerbewegung nicht vorhanden ist, möchte man dies auch ignorieren
6428 und ggf. dann nachpflegen, so kann man eine Negativ-Warenmenge mit
6429 dieser Option erlauben. Hierfür muss ein entsprechender Lagerplatz
6430 (Fehlbestand, o.ä.) konfiguriert sein.</para>
6434 <para>Zusätzliche Funktionshinweise:</para>
6438 <para><option>Standard-Lagerplatz</option> Ist dieser konfiguriert,
6439 wird dies auch als Standard-Voreinstellung bei der Neuerfassung von
6440 Stammdaten → Waren / Dienstleistung / Erzeugnis verwendet.</para>
6444 <para><option>Standard-Lagerplatz verwenden, falls keiner in
6445 Stammdaten definiert</option> Wird beim 'Auslagern über
6446 Standardlagerplatz' keine Standardlagerplatz zu der Ware gefunden,
6447 so wird mit dieser Option einfach der Standardlagerplatz
6453 <sect1 id="features.swiss-charts-of-accounts">
6454 <title>Schweizer Kontenpläne</title>
6456 <para>Seit der Version 3.5 stehen in kivitendo 3 Kontenpläne für den
6457 Einsatz in der Schweiz zur Verfügung, einer für Firmen und
6458 Organisationen, die nicht mehrwertsteuerpflichtig sind, einer für
6459 Firmen, die mehrwertsteuerpflichtig sind und einer speziell für
6462 <para>Die Kontenpläne orientieren sich am in der Schweiz üblicherweise
6463 verwendeten KMU-Kontenrahmen und sind mit der Revision des
6464 Schweizerischen Obligationenrechts (OR) vom 1.1.2013 kompatibel,
6465 insbesondere <literal>Art.957a Abs.2</literal>.</para>
6467 <para>Beim Vereinskontenplan sind standardmässig nur die Konten 1100
6468 (Debitoren CHF) und 1101 (Debitoren EUR) als Buchungskonten im Verkauf
6469 sowie die Konten 2000 (Kreditoren CHF) und 2001 (Kreditoren EUR) als
6470 Buchungskonten im Einkauf vorgesehen. Weitere Konten können bei Bedarf
6471 in den Konto-Detaileinstellungen als Einkaufs- oder Verkaufskonten
6472 konfiguriert werden.</para>
6474 <para>Die Möglichkeit, Saldosteuersätze zu verwenden ist in der
6475 aktuellen Version von kivitendo noch nicht integriert.</para>
6477 <para>Trotzdem können auch Firmen, die per Saldosteuersatz mit der
6478 Eidgenössischen Steuerverwaltung abrechnen, kivitendo bereits nutzen.
6479 Dazu wird der Kontenplan mit MWST ausgewählt. Anschliessend müssen alle
6480 Aufwandskonten editiert werden und dort der Steuersatz auf 0% gesetzt
6483 <para>So werden bei Kreditorenbuchungen keine Vorsteuern
6486 <para>Bezugssteuern für aus dem Ausland bezogene Dienstleistungen müssen
6487 manuell verbucht werden.</para>
6489 <para>Wünsche für Anpassungen an den Schweizer Kontenplänen sowie
6490 Vorschläge für weitere (z.B. branchenspezifische) Kontenpläne bitte an
6491 <literal>empfang@revamp-it.ch</literal> senden.</para>
6494 <sect1 id="features.part_classification">
6495 <title>Artikelklassifizierung</title>
6498 <title>Übersicht</title>
6500 <para>Die Klassifizierung von Artikeln dient einer weiteren
6501 Gliederung, um zum Beispiel den Einkauf vom Verkauf zu trennen,
6502 gekennzeichnet durch eine Beschreibung (z.B. "Einkauf") und ein Kürzel
6503 (z.B. "E"). Für jede Klassifizierung besteht eine Beschreibung und
6504 eine Abkürzung die normalerweise aus einem Zeichen besteht, kann aber
6505 auf mehrere Zeichen erweitert werden, falls zur Unterscheidung
6506 notwendig. Sinnvoll sind jedoch nur maximal 2 Zeichen.</para>
6510 <title>Basisklassifizierung</title>
6512 <para>Als Basisklassifizierungen gibt es</para>
6516 <para>Einkauf</para>
6520 <para>Verkauf</para>
6524 <para>Handelsware</para>
6528 <para>Produktion</para>
6532 <para>- keine - (diese wird bei einer Aktualisierung für alle
6533 existierenden Artikel verwendet und ist gültig für Verkauf und
6538 <para>Es können weitere Klassifizierungen angelegt werden. So kann es
6539 z.B. für separat auszuweisende Artikel folgende Klassen geben:</para>
6543 <para>Lieferung (Logistik, Transport) mit Kürzel L</para>
6547 <para>Material (Verpackungsmaterial) mit Kürzel M</para>
6553 <title>Attribute</title>
6555 <para>Bisher haben die Klassifizierungen folgende Attribute, die auch
6556 alle gleichzeitg gültig sein können</para>
6560 <para>gültig für Verkauf - dieser Artikel kann im Verkauf genutzt
6565 <para>gültig für Einkauf - dieser Artikel kann im Einkauf genutzt
6570 <para>separat ausweisen - hierzu gibt es zur Dokumentengenerierung
6571 (LaTeX) eine zusätzliche Variable</para>
6575 <para>Für das Attribut "separat ausweisen" stehen in den
6576 LaTeX-Vorlagen die Variable <emphasis
6577 role="bold"><%non_separate_subtotal%> </emphasis>zur Verfügung,
6578 die alle nicht separat auszuweisenden Artikelkosten saldiert, sowie
6579 pro separat auszuweisenden Klassifizierungen die Variable<emphasis
6580 role="bold">< %separate_X_subtotal%></emphasis>, wobei X das
6581 Kürzel der Klassifizierung ist.</para>
6583 <para>Im obigen Beispiel wäre das für Lieferkosten <emphasis
6584 role="bold"><%separate_L_subtotal%></emphasis> und für
6585 Verpackungsmaterial <emphasis role="bold">
6586 <%separate_M_subtotal%></emphasis>.</para>
6590 <title>Zwei-Zeichen Abkürzung</title>
6592 <para>Der Typ des Artikels und die Klassifizierung werden durch zwei
6593 Buchstaben dargestellt. Der erste Buchstabe ist eine Lokalisierung des
6594 Artikel-Typs ('P','A','S'), deutsch 'W', 'E', und 'D' für Ware
6595 Erzeugnis oder Dienstleistung und ggf. weiterer Typen.</para>
6597 <para>Der zweite Buchstabe (und ggf. auch ein dritter, falls nötig)
6598 entspricht der lokalisierten Abkürzung der Klassifizierung.</para>
6600 <para>Diese Abkürzung wird überall beim Auflisten von Artikeln zur
6601 Erleichterung mit dargestellt.</para>
6605 <sect1 id="features.file_managment">
6606 <title>Dateiverwaltung (Mini-DMS)</title>
6609 <title>Übersicht</title>
6611 <para>Parallel zum alten WebDAV gibt es ein Datei-Management-System,
6612 das Dateien verschiedenen Typs verwaltet. Dies können</para>
6616 <para>aus ERP-Daten per LaTeX Template erzeugte
6617 PDF-Dokumente,</para>
6621 <para>zu bestimmten ERP-Daten gehörende Anhangdateien
6622 unterschiedlichen Formats,</para>
6626 <para>per Scanner eingelesene PDF-Dateien,</para>
6630 <para>per E-Mail empfangene Dateianhänge unterschiedlichen
6635 <para>sowie speziel für Artikel hochgeladene Bilder sein.</para>
6640 <screeninfo>Übersicht</screeninfo>
6644 <imagedata contentwidth="600" fileref="images/DMS-Overview.png"/>
6651 <title>Struktur</title>
6653 <para>Über eine vom Speichermedium unabhängige Zwischenschicht werden
6654 die Dateien und ihre Versionen in der Datenbank verwaltet. Darunter
6655 können verschiedene Implementierungen (Backends) gleichzeitig
6660 <para>Dateisystem</para>
6668 <para>Schnittstelle zu externen
6669 Dokumenten-Management-Systemen</para>
6673 <para>andere Datenbank</para>
6677 <para>etc ...</para>
6681 <para>Es gibt unterschiedliche Typen von Dateien. Jedem Typ läßt sich
6682 in der Mandantenkonfiguration ein bestimmtes Backend zuordnen.</para>
6686 <para>"document": Das sind entweder generierte, eingescannte oder
6687 hochgeladene PDF-Dateien, die zu bestimmten ERP-Daten
6688 (ERP-Objekte, wie z.B. Rechnung, Lieferschein) gehören.</para>
6692 <para>"attachment": zusätzlich hochgeladene Dokumente, die an
6693 bestimmte ERP-Objekte angehängt werden, z.B. technische
6694 Zeichnungen, Aufmaße. Diese können auch für Artikel, Lieferanten
6695 und Kunden hinterlegt sein.</para>
6699 <para>"image": Bilder für Artikel. Diese können auch verkleinert
6700 in einer Vorschau (Thumbnail) angezeigt werden.</para>
6704 <para>Zusätzlich werden in der Datenbank zu den Dateien neben der
6705 Zuordnung zu ERP-Objekten, Dateityp Dateinamen und Backend, in dem die
6706 Datei gespeichert ist, auch die Quelle der Datei notiert:</para>
6710 <para>"created": vom System erzeugte Dokumente"</para>
6714 <para>"uploaded": hochgeladene Dokumente</para>
6718 <para>"email": vom Mail-System empfangene Dateien</para>
6722 <para>"scanner[1]": von einem oder mehreren Scannern erzeugte
6723 Dateien. Existieren mehrere Scanner, so sind diese durch
6724 unterschiedliche Quellennamen zu definieren.</para>
6728 <para>Je nach Dateityp sind nur bestimmte Quellen zulässig. So gibt es
6729 für "attachment" und "image" nur die Quelle "uploaded". Für "document"
6730 gibt es auf jeden Fall die Quelle "created". Die Quellen "scanner" und
6731 "email" müssen derzeit in der Datenbank konfiguriert werden (siehe
6732 <xref linkend="file_management.dbconfig"/>).</para>
6736 <title>Anwendung</title>
6738 <para>Die Daten werden bei den ERP-Objekten als extra Reiter
6739 dargestellt. Eine Verkaufsrechnung z.B. hat die Reiter "Dokumente" und
6740 "Dateianhänge".</para>
6743 <screeninfo>Reiter "Dateianhänge"</screeninfo>
6747 <imagedata fileref="images/DMS-Anhaenge.png" scale="50"/>
6752 <para>Bei den Dateianhängen wird immer nur die aktuelle Version einer
6753 Datei angezeigt. Wird eine Datei mit gleichem Namen hochgeladen, so
6754 wird eine neue Version der Datei erstellt. Vorher wird der Anwender
6755 durch einen Dialog gefragt, ob er eine neue Version anlegen will oder
6756 ob er die Datei umbenennen will, falls es eine neue Datei sein
6760 <screeninfo>Reiter "Dateianhänge"</screeninfo>
6764 <imagedata contentwidth="40"
6765 fileref="images/DMS-Anhaenge-hochladen.png"
6771 <para>Es können mehrere Dateien gleichzeitig hochgeladen werden,
6772 solange in Summe die maximale Größe nicht überschritten wird (siehe
6773 <xref linkend="file_management.clientconfig"/>).</para>
6776 <screeninfo>Reiter "Dokumente"</screeninfo>
6780 <imagedata fileref="images/DMS-Dokumente.png" width="500"/>
6785 <para>Sind keine weiteren Quellen für Dokumente konfiguriert, so gibt
6786 es nur "erzeugte Dokumente". Es werden alle Versionen der generierten
6787 Datei angezeigt. Für Verkaufsrechnungen kommen keine anderen Quellen
6788 zur Geltung. Werden entsprechend der <xref
6789 linkend="file_management.dbconfig"/> zusätzliche Quellen konfiguriert,
6790 so sind diese z.B. bei Einkaufsrechnungen sichtbar:</para>
6793 <screeninfo>Reiter "Dokumente"</screeninfo>
6797 <imagedata contentwidth="600"
6798 fileref="images/DMS-Dokumente-Scanner.png"/>
6803 <para>Statt des Löschens wird hier die Datei zurück zur Quelle
6804 verschoben. Somit kann die Datei anschließend an ein anderes
6805 ERP-Objekt angehängt werden.</para>
6807 <para>Derzeit sind "Titel" und "Beschreibung" noch nicht genutzt. Sie
6808 sind bisher nur bei Bildern relevant.</para>
6812 <title>Konfigurierung</title>
6814 <sect3 id="file_management.clientconfig"
6815 xreflabel="Mandantenkonfigurierung">
6816 <title>Mandantenkonfiguration</title>
6819 <title>Reiter "Features"</title>
6821 <para>Unter dem Reiter <emphasis role="bold">Features</emphasis>
6822 im Abschnitt Dateimanagement ist neben dem "alten" WebDAV das
6823 Dateimangement generell zu- und abschaltbar, sowie die Zuordnung
6824 der Dateitypen zu Backends. Die Löschbarkeit von Dateien, sowie
6825 die maximale Uploadgröße sind Backend-unabhängig</para>
6828 <screeninfo>Mandantenkonfig Reiter "Features"</screeninfo>
6832 <imagedata fileref="images/DMS-ClientConfig.png" width="500"/>
6837 <para>Die einzelnen Backends sind einzeln einschaltbar.
6838 Spezifische Backend-Konfigurierungen sind hier noch
6843 <title>Reiter "Allgemeine Dokumentenanhänge"</title>
6845 <para>Unter dem Reiter <emphasis role="bold">Allgemeine
6846 Dokumentenanhänge</emphasis> kann für alle ERP-Dokumente (
6847 Angebote, Aufträge, Lieferscheine, Rechnungen im Verkauf und
6848 Einkauf ) allgemeingültige Anhänge hochgeladen werden.</para>
6851 <screeninfo>Mandantenkonfig Reiter "Allgemeine
6852 Dokumentenanhänge"</screeninfo>
6856 <imagedata fileref="images/DMS-Allgemeine-Dokumentenanhaenge.png"
6862 <para>Diese Anhänge werden beim Generieren von PDF-Dateien an die
6863 ERP-Dokumente angehängt, z.B. AGBs oder aktuelle Angebote. Es
6864 werden in dem Fall die Daten kopiert, sodass an den ERP-Dokumenten
6865 immer die Anhänge zum Generierungszeitpunkt eingebettet
6870 <sect3 id="file_management.dbconfig"
6871 xreflabel="Datenbank-Konfigurierung">
6872 <title>Datenbank-Konfigurierung</title>
6874 <para>Die zusätzlichen Quellen für "email" oder ein oder mehrere
6875 Scanner sind derzeit vom Administrator direkt in der
6876 Datenbanktabelle "user_preferences" einzurichten. Die "value" ist im
6877 JSON-Format mit den jeweiligen Werten des Verzeichnisses und der
6878 Beschreibung der Quelle.</para>
6881 id | login | namespace | version | key | value
6882 ----+-----------+--------------+---------+----------+---------------------------
6883 1 | #default# | file_sources | 0.00000 | scanner1 |
6884 {"dir":"/var/tmp/scanner1","desc":"Scanner Einkauf"}
6885 2 | #default# | file_sources | 0.00000 | scanner2 |
6886 {"dir":"/var/tmp/scanner2","desc":"Scanner Verkauf"}
6887 3 | #default# | file_sources | 0.00000 | emails |
6888 {"dir":"/var/tmp/emails","desc":"Empfangene Mails" }
6891 <para>Es ist daran gedacht, statt dem Default-Eintrag später für
6892 bestimmte Benutzer ('login') bestimmte Quellen zuzulassen. Dies wird
6893 nach Bedarf implementiert.</para>
6896 <sect3 id="file_management.kiviconfig"
6897 xreflabel="kivitendo-Konfigurationsdatei">
6898 <title>kivitendo-Konfigurationsdatei</title>
6900 <para>Dort ist im Abschnitt [paths] der relative oder absolute Pfad
6901 zum Dokumentenwurzelverzeichnis einzutragen. Dieser muss für den
6902 Webserver schreib- und lesbar sein, jedoch nicht ausführbar.</para>
6906 document_path = /var/local/kivi_documents
6909 <para>Unter diesem Wurzelverzeichnis wird pro Mandant automatisch
6910 ein Unterverzeichnis mit der ID des Mandanten angelegt.</para>
6916 <title>Webshop-Api</title>
6918 <para>Das Shopmodul bietet die Möglichkeit Onlineshopartikel und
6919 Onlineshopbestellungen zu verwalten und zu bearbeiten.</para>
6921 <para>Es ist Multishopfähig, d.h. Artikel können mehreren oder
6922 unterschiedlichen Shops zugeordnet werden. Bestellungen können aus
6923 mehreren Shops geholt werden.</para>
6925 <para>Zur Zeit bietet das Modul nur einen Connector zur REST-Api von
6926 Shopware. Weitere Connectoren können dazu programmiert und eingerichtet
6930 <title>Rechte für die Webshopapi</title>
6932 <para>In der Administration können folgende Rechte vergeben
6937 <para>Webshopartikel anlegen und bearbeiten</para>
6941 <para>Shopbestellungen holen und bearbeiten</para>
6945 <para>Shop anlegen und bearbeiten</para>
6951 <title>Konfiguration</title>
6953 <para>Unter System->Webshops können Shops angelegt und konfiguriert
6958 <imagedata contentdepth="500" contentwidth="700"
6959 fileref="images/Shop_Listing.png"/>
6965 <title>Webshopartikel</title>
6968 <title>Shopvariablenreiter in Artikelstammdaten</title>
6970 <para>Mit dem Recht "Shopartikel anlegen und bearbeiten" und des
6971 Markers <emphasis role="bold">"Shopartikel" in den Basisdaten
6972 </emphasis>zeigt sich der Reiter "Shopvariablen" in den
6973 Artikelstammdaten. Hier können jetzt die Artikel mit
6974 unterschiedlichen Beschreibung und/oder Preisen für die
6975 konfigutierten Shops angelegt und bearbeitet werden. An dieser
6976 Stelle können auch beliebig viele Bilder dem Shopartikel zugeordnet
6977 werden. Artikelbilder gelten für alle Shops.</para>
6981 <imagedata contentdepth="500" contentwidth="600"
6982 fileref="images/Shop_Artikel.png"/>
6986 <para>Die Artikelgruppen werden direkt vom Shopsystem geholt somit
6987 ist es möglich einen Artikel auch mehreren Gruppen
6992 <title>Shopartikelliste</title>
6994 <para>Unter dem Menu Webshop->Webshop Artikel hat man nochmal
6995 eine Gesamtübersicht. Von hier aus ist es möglich Artikel im Stapel
6996 unter verschiedenen Kriterien <alles><nur Preis><nur
6997 Bestand><Preis und Bestand> an die jeweiligen Shops
7002 <imagedata fileref="images/Shop_Artikel_Listing.png"/>
7009 <title>Bestellimport</title>
7011 <para>Unter dem Menupunkt Webshop->Webshop Import öffnet sich die
7012 Bestellimportsliste. Hier ist sind Möglichkeiten gegeben Neue
7013 Bestellungen vom Shop abzuholen, geholte Bestellungen im Stapel oder
7014 einzeln als Auftrag zu transferieren. Die Liste kann nach
7015 verschiedenen Kriterien gefiltert werden.</para>
7019 <imagedata fileref="images/Shop_Bestell.png"/>
7023 <para>Bei Einträgen in der Liste.</para>
7027 <para>keine Kundennummer: Es gibt ähnliche Kundendatensätze und
7028 der Datensatz konnte nicht eindeutig zugewiesen werden.</para>
7032 <para>Kundennummer und Rechnungen rot hinterlegt: Der Kunde hat
7033 offene Posten und kann deswegen nicht im Stapel übernommen
7038 <para>Rechnungsadresse grün hinterlegt: Der Kunde konnte eindeutig
7039 einem Datensatz zugeordnet werden. Die Shopbestellung kann im
7040 Stapel mit dem Button "Anwenden" und wenn markiert als Auftrag
7041 übernommen werden.</para>
7045 <para>Kundennummer vorhanden, aber die Checkbox "Auftrag
7046 erstellen" fehlt. Der Kunde hat vermutlich eine
7047 Shopauftragssperre.</para>
7051 <para>Lieferadresse grau hinterlegt: Optische Anzeige, dass es
7052 sich um eine unterschiedliche Lieferadresse handelt.
7053 Lieferadressen werden aber grundsätzlich beim Transferieren zu
7054 Aufträgen mit übernommen.</para>
7058 <para>In der Spalte Positionen/Betrag/Versandkosten zeigt sich ein
7059 tooltip zu den Positionen.</para>
7063 <para>Maske Auftrag erstellen</para>
7065 <para>Viele Shopsysteme haben drei verschieden Adresstypen Kunden-,
7066 Rechnungs-, und Lieferadresse, die sich auch alle unterscheiden
7067 können. Diese werden im oberen Bereich angezeigt. Es ist möglich jede
7068 dieser Adresse einzeln in kivitendo als Kunde zu übernehmen. Es werden
7069 die Werte Formulareingabe übernommen. Es wird bei einer Änderung
7070 allerdings nur diese in die kivitendo Kundenstammdaten übernommen, die
7071 Shopbestellung bleibt bestehen.</para>
7073 <para>Mit der mittleren Adresse(Rechnungsadresse) im oberen Bereich,
7074 kann ich den ausgewählten kivitendodatensatz des mittleren Bereich
7075 überschreiben. Das ist sinnvoll, wenn ich erkenne, das der Kunde z.B.
7076 umgezogen ist.</para>
7078 <para>Im mittleren Bereich das Adresslisting zeigt:</para>
7082 <para>Rot hinterlegt: Kunde hat eine Shopauftragssperre, diese
7083 muss zuerst deaktiviert werden bevor ich diesem Kunden eine
7084 Shopbestellung zuordnen kann.</para>
7088 <para>Kundenname fett und rot: Hier hat der Kunde eine Bemerkung
7089 in den Stammdaten. Ein Tooltip zeigt diese Bemerkung. Das kann dan
7090 auch der Grund für die Auftragssperre sein.</para>
7094 <para>Die Buttons "Auftrag erstellen" und "Kunde mit
7095 Rechnungsadresse überschreiben" zeigen sich erst, wenn ein Kunde
7096 aus dem Listing ausgewählt ist.</para>
7100 <para>Es ist aber möglich die Shopbestellung zu löschen.</para>
7104 <para>Ist eine Bestellung schon übernommen, zeigen sich an dieser
7105 Stelle, die dazugehörigen Belegverknüpfungen.</para>
7111 <title>Mapping der Daten</title>
7113 <para>Das Mapping der kivitendo Daten mit den Shopdaten geschieht in
7114 der Datei SL/ShopConnector/<SHOPCONNECTORNAME>.pm
7115 z.B.:SL/ShopConnector/Shopware.pm</para>
7117 <para>In dieser Datei gibt es einen Bereich wo die Bestellpostionen,
7118 die Bestellkopfdaten und die Artikeldaten gemapt werden. In dieser
7119 Datei kann ein individelles Mapping dann gemacht werden. Zu Shopware
7120 gibt es hier eine sehr gute Dokumentation: <ulink
7121 url="https://developers.shopware.com/developers-guide/rest-api/">https://developers.shopware.com/developers-guide/rest-api/</ulink></para>
7127 <title>Entwicklerdokumentation</title>
7129 <sect1 id="devel.globals" xreflabel="Globale Variablen">
7130 <title>Globale Variablen</title>
7133 <title>Wie sehen globale Variablen in Perl aus?</title>
7135 <para>Globale Variablen liegen in einem speziellen namespace namens
7136 "main", der von überall erreichbar ist. Darüber hinaus sind bareword
7137 globs global und die meisten speziellen Variablen sind...
7140 <para>Daraus ergeben sich folgende Formen:</para>
7144 <term><literal>$main::form</literal></term>
7147 <para>expliziter Namespace "main"</para>
7152 <term><literal>$::form</literal></term>
7155 <para>impliziter Namespace "main"</para>
7160 <term><literal>open FILE, "file.txt"</literal></term>
7163 <para><varname>FILE</varname> ist global</para>
7168 <term><literal>$_</literal></term>
7171 <para>speziell</para>
7176 <para>Im Gegensatz zu <productname>PHP</productname> gibt es kein
7177 Schlüsselwort wie "<function>global</function>", mit dem man
7178 importieren kann. <function>my</function>, <function>our</function>
7179 und <function>local</function> machen was anderes.</para>
7183 <term><literal>my $form</literal></term>
7186 <para>lexikalische Variable, gültig bis zum Ende des
7192 <term><literal>our $form</literal></term>
7195 <para><varname>$form</varname> referenziert ab hier
7196 <varname>$PACKAGE::form</varname>.</para>
7201 <term><literal>local $form</literal></term>
7204 <para>Alle Änderungen an <varname>$form</varname> werden am Ende
7205 des scopes zurückgesetzt</para>
7212 <title>Warum sind globale Variablen ein Problem?</title>
7214 <para>Das erste Problem ist <productname>FCGI</productname>.</para>
7216 <para><productname>SQL-Ledger</productname> hat fast alles im globalen
7217 namespace abgelegt, und erwartet, dass es da auch wiederzufinden ist.
7218 Unter <productname>FCGI</productname> müssen diese Sachen aber wieder
7219 aufgeräumt werden, damit sie nicht in den nächsten Request kommen.
7220 Einige Sachen wiederum sollen nicht gelöscht werden, wie zum Beispiel
7221 Datenbankverbindungen, weil die sehr lange zum Initialisieren
7224 <para>Das zweite Problem ist <function>strict</function>. Unter
7225 <function>strict</function> werden alle Variablen die nicht explizit
7226 mit <function>Package</function>, <function>my</function> oder
7227 <function>our</function> angegeben werden als Tippfehler angemarkert,
7228 dies hat, seit der Einführung, u.a. schon so manche langwierige
7229 Bug-Suche verkürzt. Da globale Variablen aber implizit mit Package
7230 angegeben werden, werden die nicht geprüft, und somit kann sich
7231 schnell ein Tippfehler einschleichen.</para>
7235 <title>Kanonische globale Variablen</title>
7237 <para>Um dieses Problem im Griff zu halten gibt es einige wenige
7238 globale Variablen, die kanonisch sind, d.h. sie haben bestimmte
7239 vorgegebenen Eigenschaften, und alles andere sollte anderweitig
7240 umhergereicht werden.</para>
7242 <para>Diese Variablen sind im Moment die folgenden neun:</para>
7246 <para><varname>$::form</varname></para>
7250 <para><varname>%::myconfig</varname></para>
7254 <para><varname>$::locale</varname></para>
7258 <para><varname>$::lxdebug</varname></para>
7262 <para><varname>$::auth</varname></para>
7266 <para><varname>$::lx_office_conf</varname></para>
7270 <para><varname>$::instance_conf</varname></para>
7274 <para><varname>$::dispatcher</varname></para>
7278 <para><varname>$::request</varname></para>
7282 <para>Damit diese nicht erneut als Müllhalde missbraucht werden, im
7283 Folgenden eine kurze Erläuterung der bestimmten vorgegebenen
7284 Eigenschaften (Konventionen):</para>
7287 <title>$::form</title>
7291 <para>Ist ein Objekt der Klasse
7292 "<classname>Form</classname>"</para>
7296 <para>Wird nach jedem Request gelöscht</para>
7300 <para>Muss auch in Tests und Konsolenscripts vorhanden
7305 <para>Enthält am Anfang eines Requests die Requestparameter vom
7310 <para>Kann zwar intern über Requestgrenzen ein Datenbankhandle
7311 cachen, das wird aber momentan absichtlich zerstört</para>
7315 <para><varname>$::form</varname> wurde unter <productname>SQL
7316 Ledger</productname> als Gottobjekt für alles missbraucht. Sämtliche
7317 alten Funktionen unter SL/ mutieren <varname>$::form</varname>, das
7318 heißt, alles was einem lieb ist (alle Variablen die einem ans Herz
7319 gewachsen sind), sollte man vor einem Aufruf (!) von zum Beispiel
7320 <function>IS->retrieve_customer()</function> in Sicherheit
7323 <para>Z.B. das vom Benutzer eingestellte Zahlenformat, bevor man
7324 Berechnung in einem bestimmten Format durchführt (SL/Form.pm Zeile
7325 3552, Stand version 2.7beta), um dies hinterher wieder auf den
7326 richtigen Wert zu setzen:</para>
7328 <programlisting> my $saved_numberformat = $::myconfig{numberformat};
7329 $::myconfig{numberformat} = $numberformat;
7330 # (...) div Berechnungen
7331 $::myconfig{numberformat} = $saved_numberformat;</programlisting>
7333 <para>Das Objekt der Klasse Form hat leider im Moment noch viele
7334 zentrale Funktionen die vom internen Zustand abhängen, deshalb bitte
7335 nie einfach zerstören oder überschreiben (zumindestens nicht kurz
7336 vor einem Release oder in Absprache über bspw. die devel-Liste ;-).
7337 Es geht ziemlich sicher etwas kaputt.</para>
7339 <para><varname>$::form</varname> ist gleichzeitig der Standard Scope
7340 in den <productname>Template::Toolkit</productname> Templates
7341 außerhalb der Controller: der Ausdruck <function>[% var
7342 %]</function> greift auf <varname>$::form->{var}</varname> zu.
7343 Unter Controllern ist der Standard Scope anders, da lautet der
7344 Zugriff <function>[% FORM.var %]</function>. In Druckvorlagen sind
7345 normale Variablen ebenfall im <varname>$::form</varname> Scope, d.h.
7346 <function><%var%></function> zeigt auf
7347 <varname>$::form->{var}</varname>. Nochmal von der anderen Seite
7348 erläutert, innerhalb von (Web-)Templates sieht man häufiger solche
7351 <programlisting>[%- IF business %]
7352 # (... Zeig die Auswahlliste Kunden-/Lieferantentyp an)
7353 [%- END %]</programlisting>
7355 <para>Entweder wird hier dann $::form->{business} ausgewertet
7356 oder aber der Funktion
7357 <function>$form->parse_html_template</function> wird explizit
7358 noch ein zusätzlicher Hash übergeben, der dann auch in den
7359 (Web-)Templates zu Verfügung steht, bspw. so:</para>
7361 <programlisting>$form->parse_html_template("is/form_header", \%TMPL_VAR);</programlisting>
7363 <para>Innerhalb von Schleifen wird
7364 <varname>$::form->{TEMPLATE_ARRAYS}{var}[$index]</varname>
7365 bevorzugt, wenn vorhanden. Ein Beispiel findet sich in SL/DO.pm,
7366 welches über alle Positionen eines Lieferscheins in Schleife
7369 <programlisting>for $i (1 .. $form->{rowcount}) {
7371 push @{ $form->{TEMPLATE_ARRAYS}{runningnumber} }, $position;
7372 push @{ $form->{TEMPLATE_ARRAYS}{number} }, $form->{"partnumber_$i"};
7373 push @{ $form->{TEMPLATE_ARRAYS}{description} }, $form->{"description_$i"};
7379 <title>%::myconfig</title>
7383 <para>Das einzige Hash unter den globalen Variablen</para>
7387 <para>Wird spätestens benötigt wenn auf die Datenbank
7388 zugegriffen wird</para>
7392 <para>Wird bei jedem Request neu erstellt.</para>
7396 <para>Enthält die Userdaten des aktuellen Logins</para>
7400 <para>Sollte nicht ohne Filterung irgendwo gedumpt werden oder
7401 extern serialisiert werden, weil da auch der Datenbankzugriff
7402 für diesen user drinsteht.</para>
7406 <para>Enthält unter anderem Datumsformat dateformat und
7407 Nummernformat numberformat</para>
7411 <para>Enthält Datenbankzugriffinformationen</para>
7415 <para><varname>%::myconfig</varname> ist im Moment der Ersatz für
7416 ein Userobjekt. Die meisten Funktionen, die etwas anhand des
7417 aktuellen Users entscheiden müssen, befragen
7418 <varname>%::myconfig</varname>. Innerhalb der Anwendungen sind dies
7419 überwiegend die Daten, die sich unter <guimenu>Programm</guimenu>
7420 -> <guimenuitem>Einstellungen</guimenuitem> befinden, bzw. die
7421 Informationen über den Benutzer die über die
7422 Administrator-Schnittstelle eingegeben wurden.</para>
7426 <title>$::locale</title>
7430 <para>Objekt der Klasse "Locale"</para>
7434 <para>Wird pro Request erstellt</para>
7438 <para>Muss auch für Tests und Scripte immer verfügbar
7443 <para>Cached intern über Requestgrenzen hinweg benutzte
7448 <para>Lokalisierung für den aktuellen User. Alle Übersetzungen,
7449 Zahlen- und Datumsformatierungen laufen über dieses Objekt.</para>
7453 <title>$::lxdebug</title>
7457 <para>Objekt der Klasse "LXDebug"</para>
7461 <para>Wird global gecached</para>
7465 <para>Muss immer verfügbar sein, in nahezu allen
7470 <para><varname>$::lxdebug</varname> stellt Debuggingfunktionen
7471 bereit, wie "<function>enter_sub</function>" und
7472 "<function>leave_sub</function>", mit denen in den alten Modulen ein
7473 brauchbares Tracing gebaut ist, "<function>log_time</function>", mit
7474 der man die Wallclockzeit seit Requeststart loggen kann, sowie
7475 "<function>message</function>" und "<function>dump</function>" mit
7476 denen man flott Informationen ins Log (tmp/kivitendo-debug.log)
7479 <para>Beispielsweise so:</para>
7481 <programlisting>$main::lxdebug->message(0, 'Meine Konfig:' . Dumper (%::myconfig));
7482 $main::lxdebug->message(0, 'Wer bin ich? Kunde oder Lieferant:' . $form->{vc});</programlisting>
7486 <title>$::auth</title>
7490 <para>Objekt der Klasse "SL::Auth"</para>
7494 <para>Wird global gecached</para>
7498 <para>Hat eine permanente DB Verbindung zur Authdatenbank</para>
7502 <para>Wird nach jedem Request resettet.</para>
7506 <para><varname>$::auth</varname> stellt Funktionen bereit um die
7507 Rechte des aktuellen Users abzufragen. Obwohl diese Informationen
7508 vom aktuellen User abhängen wird das Objekt aus
7509 Geschwindigkeitsgründen nur einmal angelegt und dann nach jedem
7510 Request kurz resettet.</para>
7512 <para>Dieses Objekt kapselt auch den gerade aktiven Mandanten.
7513 Dessen Einstellungen können über
7514 <literal>$::auth->client</literal> abgefragt werden; Rückgabewert
7515 ist ein Hash mit den Werten aus der Tabelle
7516 <literal>auth.clients</literal>.</para>
7520 <title>$::lx_office_conf</title>
7524 <para>Objekt der Klasse
7525 "<classname>SL::LxOfficeConf</classname>"</para>
7529 <para>Global gecached</para>
7533 <para>Repräsentation der
7534 <filename>config/kivitendo.conf[.default]</filename>-Dateien</para>
7538 <para>Globale Konfiguration. Configdateien werden zum Start gelesen
7539 und danach nicht mehr angefasst. Es ist derzeit nicht geplant, dass
7540 das Programm die Konfiguration ändern kann oder sollte.</para>
7542 <para>Beispielsweise ist über den Konfigurationseintrag [debug] die
7543 Debug- und Trace-Log-Datei wie folgt konfiguriert und
7546 <programlisting>[debug]
7547 file_name = /tmp/kivitendo-debug.log</programlisting>
7549 <para>ist der Key <varname>file</varname> im Programm als
7550 <varname>$::lx_office_conf->{debug}{file}</varname>
7554 <para>Zugriff auf die Konfiguration erfolgt im Moment über
7555 Hashkeys, sind also nicht gegen Tippfehler abgesichert.</para>
7560 <title>$::instance_conf</title>
7564 <para>Objekt der Klasse
7565 "<classname>SL::InstanceConfiguration</classname>"</para>
7569 <para>wird pro Request neu erstellt</para>
7573 <para>Funktioniert wie <varname>$::lx_office_conf</varname>,
7574 speichert aber Daten die von der Instanz abhängig sind. Eine Instanz
7575 ist hier eine Mandantendatenbank. Beispielsweise überprüft
7576 <programlisting>$::instance_conf->get_inventory_system eq 'perpetual'</programlisting>
7577 ob die berüchtigte Bestandsmethode zur Anwendung kommt.</para>
7581 <title>$::dispatcher</title>
7585 <para>Objekt der Klasse
7586 "<varname>SL::Dispatcher</varname>"</para>
7590 <para>wird pro Serverprozess erstellt.</para>
7594 <para>enthält Informationen über die technische Verbindung zum
7599 <para>Der dritte Punkt ist auch der einzige Grund warum das Objekt
7600 global gespeichert wird. Wird vermutlich irgendwann in einem anderen
7601 Objekt untergebracht.</para>
7605 <title>$::request</title>
7609 <para>Hashref (evtl später Objekt)</para>
7613 <para>Wird pro Request neu initialisiert.</para>
7617 <para>Keine Unterstruktur garantiert.</para>
7621 <para><varname>$::request</varname> ist ein generischer Platz um
7622 Daten "für den aktuellen Request" abzulegen. Sollte nicht für action
7623 at a distance benutzt werden, sondern um lokales memoizing zu
7624 ermöglichen, das garantiert am Ende des Requests zerstört
7627 <para>Vieles von dem, was im moment in <varname>$::form</varname>
7628 liegt, sollte eigentlich hier liegen. Die groben
7629 Differentialkriterien sind:</para>
7633 <para>Kommt es vom User, und soll unverändert wieder an den
7634 User? Dann <varname>$::form</varname>, steht da eh schon</para>
7638 <para>Sind es Daten aus der Datenbank, die nur bis zum Ende des
7639 Requests gebraucht werden? Dann
7640 <varname>$::request</varname></para>
7644 <para>Muss ich von anderen Teilen des Programms lesend drauf
7645 zugreifen? Dann <varname>$::request</varname>, aber Zugriff über
7646 Wrappermethode</para>
7653 <title>Ehemalige globale Variablen</title>
7655 <para>Die folgenden Variablen waren einmal im Programm, und wurden
7659 <title>$::cgi</title>
7663 <para>war nötig, weil cookie Methoden nicht als
7664 Klassenfunktionen funktionieren</para>
7668 <para>Aufruf als Klasse erzeugt Dummyobjekt was im
7669 Klassennamespace gehalten wird und über Requestgrenzen
7674 <para>liegt jetzt unter
7675 <varname>$::request->{cgi}</varname></para>
7681 <title>$::all_units</title>
7685 <para>war nötig, weil einige Funktionen in Schleifen zum Teil
7686 ein paar hundert mal pro Request eine Liste der Einheiten
7687 brauchen, und de als Parameter durch einen Riesenstack von
7688 Funktionen geschleift werden müssten.</para>
7692 <para>Liegt jetzt unter
7693 <varname>$::request->{cache}{all_units}</varname></para>
7698 <function>AM->retrieve_all_units()</function> gesetzt oder
7705 <title>%::called_subs</title>
7709 <para>wurde benutzt um callsub deep recursions
7714 <para>Wurde entfernt, weil callsub nur einen Bruchteil der
7715 möglichen Rekursioenen darstellt, und da nie welche
7720 <para>komplette recursion protection wurde entfernt.</para>
7727 <sect1 id="devel.fcgi">
7728 <title>Entwicklung unter FastCGI</title>
7730 <sect2 id="devel.fcgi.general">
7731 <title>Allgemeines</title>
7733 <para>Wenn Änderungen in der Konfiguration von kivitendo gemacht
7734 werden, muss der Webserver neu gestartet werden.</para>
7736 <para>Bei der Entwicklung für FastCGI ist auf ein paar Fallstricke zu
7737 achten. Dadurch, dass das Programm in einer Endlosschleife läuft,
7738 müssen folgende Aspekte beachtet werden.</para>
7741 <sect2 id="devel.fcgi.exiting">
7742 <title>Programmende und Ausnahmen</title>
7744 <para>Betrifft die Funktionen <function>warn</function>,
7745 <function>die</function>, <function>exit</function>,
7746 <function>carp</function> und <function>confess</function>.</para>
7748 <para>Fehler, die dass Programm normalerweise sofort beenden (fatale
7749 Fehler), werden mit dem FastCGI Dispatcher abgefangen, um das Programm
7750 am Laufen zu halten. Man kann mit <function>die</function>,
7751 <function>confess</function> oder <function>carp</function> Fehler
7752 ausgeben, die dann vom Dispatcher angezeigt werden. Die kivitendo
7753 eigene <function>$::form-</function>error()> tut im Prinzip das
7754 Gleiche, mit ein paar Extraoptionen. <function>warn</function> und
7755 <function>exit</function> hingegen werden nicht abgefangen.
7756 <function>warn</function> wird direkt nach STDERR, also in Server Log
7757 eine Nachricht schreiben (sofern in der Konfiguration nicht die
7758 Warnungen in das kivitendo Log umgeleitet wurden), und
7759 <function>exit</function> wird die Ausführung beenden.</para>
7761 <para>Prinzipiell ist es kein Beinbruch, wenn sich der Prozess
7762 beendet, fcgi wird ihn sofort neu starten. Allerdings sollte das die
7763 Ausnahme sein. Quintessenz: Bitte kein <function>exit</function>
7764 benutzen, alle anderen Exceptionmechanismen sind ok.</para>
7767 <sect2 id="devel.fcgi.globals">
7768 <title>Globale Variablen</title>
7770 <para>Um zu vermeiden, dass Informationen von einem Request in einen
7771 anderen gelangen, müssen alle globalen Variablen vor einem Request
7772 sauber initialisiert werden. Das ist besonders wichtig im
7773 <varname>$::cgi</varname> und <varname>$::auth</varname> Objekt, weil
7774 diese nicht gelöscht werden pro Instanz, sondern persistent gehalten
7777 <para>In <classname>SL::Dispatcher</classname> gibt es einen sauber
7778 abgetrennten Block, der alle kanonischen globalen Variablen listet und
7779 erklärt. Bitte keine anderen einführen ohne das sauber zu
7780 dokumentieren.</para>
7782 <para>Datenbankverbindungen wird noch ein Guide verfasst werden, wie
7783 man sicher geht, dass man die richtige erwischt.</para>
7786 <sect2 id="devel.fcgi.performance">
7787 <title>Performance und Statistiken</title>
7789 <para>Die kritischen Pfade des Programms sind die Belegmasken, und
7790 unter diesen ganz besonders die Verkaufsrechnungsmaske. Ein Aufruf der
7791 Rechnungsmaske in kivitendo 2.4.3 stable dauert auf einem Core2duo mit
7792 4GB Arbeitsspeicher und Ubuntu 9.10 eine halbe Sekunde. In der 2.6.0
7793 sind es je nach Menge der definierten Variablen 1-2s. Ab der
7794 Moose/Rose::DB Version sind es 5-6s.</para>
7796 <para>Mit FastCGI ist die neuste Version auf 0,26 Sekunden selbst in
7797 den kritischen Pfaden, unter 0,15 sonst.</para>
7801 <sect1 id="db-upgrade-files" xreflabel="Datenbank-Upgradedateien">
7802 <title>SQL-Upgradedateien</title>
7804 <sect2 id="db-upgrade-files.introduction"
7805 xreflabel="Einführung in die Datenbank-Upgradedateien">
7806 <title>Einführung</title>
7808 <para>Datenbankupgrades werden über einzelne Upgrade-Scripte
7809 gesteuert, die sich im Verzeichnis
7810 <filename>sql/Pg-upgrade2</filename> befinden. In diesem Verzeichnis
7811 muss pro Datenbankupgrade eine Datei existieren, die neben den
7812 eigentlich auszuführenden SQL- oder Perl-Befehlen einige
7813 Kontrollinformationen enthält.</para>
7815 <para>Kontrollinformationen definieren Abhängigkeiten und Prioritäten,
7816 sodass Datenbankscripte zwar in einer sicheren Reihenfolge ausgeführt
7817 werden (z.B. darf ein <literal>ALTER TABLE</literal> erst ausgeführt
7818 werden, wenn die Tabelle mit <literal>CREATE TABLE</literal> angelegt
7819 wurde), diese Reihenfolge aber so flexibel ist, dass man keine
7820 Versionsnummern braucht.</para>
7822 <para>kivitendo merkt sich dabei, welches der Upgradescripte in
7823 <filename>sql/Pg-upgrade2</filename> bereits durchgeführt wurde und
7824 führt diese nicht erneut aus. Dazu dient die Tabelle
7825 "<literal>schema_info</literal>", die bei der Anmeldung automatisch
7826 angelegt wird.</para>
7829 <sect2 id="db-upgrade-files.format"
7830 xreflabel="Format der Upgradedateien">
7831 <title>Format der Kontrollinformationen</title>
7833 <para>Die Kontrollinformationen sollten sich am Anfang der jeweiligen
7834 Upgradedatei befinden. Jede Zeile, die Kontrollinformationen enthält,
7835 hat dabei das folgende Format:</para>
7837 <para>Für SQL-Upgradedateien:</para>
7839 <programlisting>-- @key: value</programlisting>
7841 <para>Für Perl-Upgradedateien:</para>
7843 <programlisting># @key: value</programlisting>
7845 <para>Leerzeichen vor "<varname>value</varname>" werden
7848 <para>Die folgenden Schlüsselworte werden verarbeitet:</para>
7852 <term><varname>tag</varname></term>
7855 <para>Wird zwingend benötigt. Dies ist der "Name" des Upgrades.
7856 Dieser "tag" kann von anderen Kontrolldateien in ihren
7857 Abhängigkeiten verwendet werden (Schlüsselwort
7858 "<varname>depends</varname>"). Der "tag" ist auch der Name, der
7859 in der Datenbank eingetragen wird.</para>
7861 <para>Normalerweise sollte die Kontrolldatei genau so heißen wie
7862 der "tag", nur mit der Endung ".sql" bzw. "pl".</para>
7864 <para>Ein Tag darf nur aus alphanumerischen Zeichen sowie den
7865 Zeichen _ - ( ) bestehen. Insbesondere sind Leerzeichen nicht
7866 erlaubt und sollten stattdessen mit Unterstrichen ersetzt
7872 <term><varname>charset</varname></term>
7875 <para>Empfohlen. Gibt den Zeichensatz an, in dem das Script
7876 geschrieben wurde, z.B. "<literal>UTF-8</literal>". Aus
7877 Kompatibilitätsgründen mit alten Upgrade-Scripten wird bei
7878 Abwesenheit des Tags für SQL-Upgradedateien der Zeichensatz
7879 "<literal>ISO-8859-15</literal>" angenommen. Perl-Upgradescripte
7880 hingegen müssen immer in UTF-8 encodiert sein und sollten
7881 demnach auch ein "<literal>use utf8;</literal>"
7887 <term><varname>description</varname></term>
7890 <para>Benötigt. Eine Beschreibung, was in diesem Update
7891 passiert. Diese wird dem Benutzer beim eigentlichen
7892 Datenbankupdate angezeigt. Während der Tag in Englisch gehalten
7893 sein sollte, sollte die Beschreibung auf Deutsch
7899 <term><varname>depends</varname></term>
7902 <para>Optional. Eine mit Leerzeichen getrennte Liste von "tags",
7903 von denen dieses Upgradescript abhängt. kivitendo stellt sicher,
7904 dass die in dieser Liste aufgeführten Scripte bereits
7905 durchgeführt wurden, bevor dieses Script ausgeführt wird.</para>
7907 <para>Abhängigkeiten werden rekursiv betrachtet. Wenn also ein
7908 Script "b" existiert, das von Änderungen in "a" abhängt, und
7909 eine neue Kontrolldatei für "c" erstellt wird, die von
7910 Änderungen in "a" und "b" abhängt, so genügt es, in "c" nur den
7911 Tag "b" als Abhängigkeit zu definieren.</para>
7913 <para>Es ist nicht erlaubt, sich selbst referenzierende
7914 Abhängigkeiten zu definieren (z.B. "a" -> "b", "b" -> "c"
7915 und "c" -> "a").</para>
7920 <term><varname>priority</varname></term>
7923 <para>Optional. Ein Zahlenwert, der die Reihenfolge bestimmt, in
7924 der Scripte ausgeführt werden, die die gleichen
7925 Abhängigkeitstiefen besitzen. Fehlt dieser Parameter, so wird
7926 der Wert 1000 benutzt.</para>
7928 <para>Dies ist reine Kosmetik. Für echte Reihenfolgen muss
7929 "depends" benutzt werden. kivitendo sortiert die auszuführenden
7930 Scripte zuerst nach der Abhängigkeitstiefe (wenn "z" von "y"
7931 abhängt und "y" von "x", so hat "z" eine Abhängigkeitstiefe von
7932 2, "y" von 1 und "x" von 0. "x" würde hier zuerst ausgeführt,
7933 dann "y", dann "z"), dann nach der Priorität und bei gleicher
7934 Priorität alphabetisch nach dem "tag".</para>
7939 <term><varname>ignore</varname></term>
7942 <para>Optional. Falls der Wert auf 1 (true) steht, wird das
7943 Skript bei der Anmeldung ignoriert und entsprechend nicht
7950 <sect2 id="db-upgrade-files.format-perl-files"
7951 xreflabel="Format von Perl-Upgradedateien">
7952 <title>Format von in Perl geschriebenen
7953 Datenbankupgradescripten</title>
7955 <para>In Perl geschriebene Datenbankscripte werden nicht einfach so
7956 ausgeführt sondern müssen sich an gewisse Konventionen halten. Dafür
7957 bekommen sie aber auch einige Komfortfunktionen bereitgestellt.</para>
7959 <para>Ein Upgradescript stellt dabei eine vollständige Objektklasse
7960 dar, die vom Elternobjekt "<literal>SL::DBUpgrade2::Base</literal>"
7961 erben und eine Funktion namens "<literal>run</literal>" zur Verfügung
7962 stellen muss. Das Script wird ausgeführt, indem eine Instanz dieser
7963 Klasse erzeugt und darauf die erwähnte "<literal>run</literal>"
7964 aufgerufen wird.</para>
7966 <para>Zu beachten ist, dass sich der Paketname der Datei aus dem Wert
7967 für "<literal>@tag</literal>" ableitet. Dabei werden alle Zeichen, die
7968 in Paketnamen ungültig wären (gerade Bindestriche), durch Unterstriche
7969 ersetzt. Insgesamt sieht der Paketname wie folgt aus:
7970 "<literal>SL::DBUpgrade2::tag</literal>".</para>
7972 <para>Welche Komfortfunktionen zur Verfügung stehen, erfahren Sie in
7973 der Perl-Dokumentation zum oben genannten Modul; aufzurufen mit
7974 "<command>perldoc SL/DBUpgrade2/Base.pm</command>".</para>
7976 <para>Ein Mindestgerüst eines gültigen Perl-Upgradescriptes sieht wie
7979 <programlisting># @tag: beispiel-upgrade-file42
7980 # @description: Ein schönes Beispielscript
7981 # @depends: release_3_1_0
7982 package SL::DBUpgrade2::beispiel_upgrade_file42;
7987 use parent qw(SL::DBUpgrade2::Base);
7992 # hier Aktionen ausführen
8001 <sect2 id="db-upgrade-files.dbupgrade-tool"
8002 xreflabel="Hilfsscript dbupgrade2_tool.pl">
8003 <title>Hilfsscript dbupgrade2_tool.pl</title>
8005 <para>Um die Arbeit mit den Abhängigkeiten etwas zu erleichtern,
8006 existiert ein Hilfsscript namens
8007 "<filename>scripts/dbupgrade2_tool.pl</filename>". Es muss aus dem
8008 kivitendo-ERP-Basisverzeichnis heraus aufgerufen werden. Dieses Tool
8009 liest alle Datenbankupgradescripte aus dem Verzeichnis
8010 <filename>sql/Pg-upgrade2</filename> aus. Es benutzt dafür die
8011 gleichen Methoden wie kivitendo selber, sodass alle Fehlersituationen
8012 von der Kommandozeile überprüft werden können.</para>
8014 <para>Wird dem Script kein weiterer Parameter übergeben, so wird nur
8015 eine Überprüfung der Felder und Abhängigkeiten vorgenommen. Man kann
8016 sich aber auch Informationen auf verschiedene Art ausgeben
8021 <para>Listenform: "<command>./scripts/dbupgrade2_tool.pl
8022 --list</command>"</para>
8024 <para>Gibt eine Liste aller Scripte aus. Die Liste ist in der
8025 Reihenfolge sortiert, in der kivitendo die Scripte ausführen
8026 würde. Es werden neben der Listenposition der Tag, die
8027 Abhängigkeitstiefe und die Priorität ausgegeben.</para>
8031 <para>Baumform: "<command>./scripts/dbupgrade2_tool.pl
8032 --tree</command>"</para>
8034 <para>Listet alle Tags in Baumform basierend auf den
8035 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte, von
8036 denen keine anderen abhängen. Die Unterknoten sind Scripte, die
8037 beim übergeordneten Script als Abhängigkeit eingetragen
8041 <listitem id="db-upgrade-files.dbupgrade-tool.reverse-tree">
8042 <para>Umgekehrte Baumform: "<command>./scripts/dbupgrade2_tool.pl
8043 --rtree</command>"</para>
8045 <para>Listet alle Tags in Baumform basierend auf den
8046 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte mit
8047 der geringsten Abhängigkeitstiefe. Die Unterknoten sind Scripte,
8048 die das übergeordnete Script als Abhängigkeit eingetragen
8053 <para>Baumform mit Postscriptausgabe:
8054 "<command>./scripts/dbupgrade2_tool.pl
8055 --graphviz</command>"</para>
8057 <para>Benötigt das Tool "<command>graphviz</command>", um mit
8058 seiner Hilfe die <link
8059 linkend="db-upgrade-files.dbupgrade-tool.reverse-tree">umgekehrte
8060 Baumform</link> in eine Postscriptdatei namens
8061 "<filename>db_dependencies.ps</filename>" auszugeben. Dies ist
8062 vermutlich die übersichtlichste Form, weil hierbei jeder Knoten
8063 nur einmal ausgegeben wird. Bei den Textmodusbaumformen hingegen
8064 können Knoten und all ihre Abhängigkeiten mehrfach ausgegeben
8069 <para>Scripte, von denen kein anderes Script abhängt:
8070 "<command>./scripts/dbupgrade2_tool.pl --nodeps</command>"</para>
8072 <para>Listet die Tags aller Scripte auf, von denen keine anderen
8073 Scripte abhängen.</para>
8079 <sect1 id="translations-languages" xreflabel="Translations and languages">
8080 <title>Translations and languages</title>
8082 <sect2 id="translations-languages.introduction"
8083 xreflabel="Introduction to translations and languages">
8084 <title>Introduction</title>
8087 <para>Dieser Abschnitt ist in Englisch geschrieben, um
8088 internationalen Übersetzern die Arbeit zu erleichtern.</para>
8091 <para>This section describes how localization packages in kivitendo
8092 are built. Currently the only language fully supported is German, and
8093 since most of the internal messages are held in English the English
8094 version is usable too.</para>
8097 <sect2 id="translations-languages.character-set"
8098 xreflabel="Character set">
8099 <title>Character set</title>
8101 <para>All files included in a language pack must use UTF-8 as their
8105 <sect2 id="translations-languages.file-structure"
8106 xreflabel="File structure">
8107 <title>File structure</title>
8109 <para>The structure of locales in kivitendo is:</para>
8111 <programlisting>kivitendo/locale/<langcode>/</programlisting>
8113 <para>where <langcode> stands for an abbreviation of the
8114 language package. The builtin packages use two letter <ulink
8115 url="http://en.wikipedia.org/wiki/ISO_639-1">ISO 639-1</ulink> codes,
8116 but the actual name is not relevant for the program and can easily be
8118 url="http://en.wikipedia.org/wiki/IETF_language_tag">IETF language
8119 tags</ulink> (i.e. "en_GB"). In fact the original language packages
8120 from SQL Ledger are named in this way.</para>
8122 <para>In such a language directory the following files are
8127 <term>LANGUAGE</term>
8130 <para>This file is mandatory.</para>
8132 <para>The <filename>LANGUAGE</filename> file contains the self
8133 descripted name of the language. It should contain a native
8134 representation first, and in parenthesis an english translation
8135 after that. Example:</para>
8137 <programlisting>Deutsch (German)</programlisting>
8145 <para>This file is mandatory.</para>
8147 <para>The central translation file. It is essentially an inline
8148 Perl script autogenerated by <command>locales.pl</command>. To
8149 generate it, generate the directory and the two files mentioned
8150 above, and execute the following command:</para>
8152 <programlisting>scripts/locales.pl <langcode></programlisting>
8154 <para>Otherwise you can simply copy one of the other languages.
8155 You will be told how many are missing like this:</para>
8157 <programlisting>$ scripts/locales.pl en
8158 English - 0.6% - 2015/2028 missing</programlisting>
8160 <para>A file named "<filename>missing</filename>" will be
8161 generated and can be edited. You can also edit the
8162 "<filename>all</filename>" file directly. Edit everything you
8163 like to fit the target language and execute
8164 <command>locales.pl</command> again. See how the missing words
8170 <term>Num2text</term>
8173 <para>Legacy code from SQL Ledger. It provides a means for
8174 numbers to be converted into natural language, like
8175 <literal>1523 => one thousand five hundred twenty
8176 three</literal>. If you want to provide it, it must be inlinable
8177 Perl code which provides a <function>num2text</function> sub. If
8178 an <function>init</function> sub exists it will be executed
8181 <para>Only used in the check and receipt printing module.</para>
8186 <term>special_chars</term>
8189 <para>kivitendo comes with a lot of interfaces to different
8190 formats, some of which are rather picky with their accepted
8191 charset. The <filename>special_chars</filename> file contains a
8192 listing of chars not suited for different file format and
8193 provides substitutions. It is written in "Simple Ini" style,
8194 containing a block for every file format.</para>
8196 <para>First entry should be the order of substitution for
8197 entries as a whitespace separated list. All entries are
8198 interpolated, so <literal>\n</literal>, <literal>\x20</literal>
8199 and <literal>\\</literal> all work.</para>
8201 <para>After that every entry is a special char that should be
8202 translated when writing text into such a file.</para>
8204 <para>Example:</para>
8206 <programlisting>[Template/XML]
8207 order=& < > \n
8211 \n=<br></programlisting>
8213 <para>Note the importance of the order in this example.
8214 Substituting < and > befor & would lead to $gt; become
8217 <para>For a list of valid formats, see the German
8218 <filename>special_chars</filename> entry. As of this writing the
8219 following are recognized:</para>
8221 <programlisting>HTML
8226 Template/OpenDocument
8227 filenames</programlisting>
8229 <para>The last of which is very machine dependant. Remember that
8230 a lot of characters are forbidden by some filesystems, for
8231 example MS Windows doesn't like ':' in its files where Linux
8232 doesn't mind that. If you want the files created with your
8233 language pack to be portable, find all chars that could cause
8239 <term>missing</term>
8242 <para>This file is not a part of the language package
8245 <para>This is a file generated by
8246 <command>scripts/locales.pl</command> while processing your
8247 locales. It's only to have the missing entries singled out and
8248 does not belong to a language package.</para>
8256 <para>This file is not a part of the language package
8259 <para>Another file generated by
8260 <command>scripts/locales.pl</command>. If for any reason a
8261 translation does not appear anymore and can be deleted, it gets
8262 moved here. The last 50 or so entries deleted are saved here in
8263 case you made a typo, so that you don't have to translate
8264 everything again. If a tranlsation is missing, the lost file is
8265 checked first. If you maintain a language package, you might
8266 want to keep this safe somewhere.</para>
8271 <term>more/all</term>
8274 <para>This subdir and file is not a part of the language package
8277 <para>If the directory more exists and contains a file called
8278 all it will be parsed in addition to the mandatory all (see
8279 above). The file is useful if you want to change some
8280 translations for the current installation without conflicting
8281 further upgrades. The file is not autogenerated and has the same
8282 format as the all, but needs another key (more_texts). See the
8283 german translation for an example or copy the following code:
8286 # -*- coding: utf-8; -*-
8291 # These are additional texts for custom translations.
8292 # The format is the same as for the normal file all, only
8293 # with another key (more_texts instead of texts).
8294 # The file has the form of 'english text' => 'foreign text',
8296 $self->{more_texts} = {
8298 'Ship via' => 'Terms of delivery',
8299 'Shipping Point' => 'Delivery time',
8301 </programlisting></para>
8308 <sect1 id="devel.testsuite">
8309 <title>Die kivitendo-Test-Suite</title>
8311 <sect2 id="devel.testsuite.intro">
8312 <title>Einführung</title>
8314 <para>kivitendo enthält eine Suite für automatisierte Tests. Sie
8315 basiert auf dem Standard-Perl-Modul
8316 <literal>Test::More</literal>.</para>
8318 <para>Die grundlegenden Fakten sind:</para>
8322 <para>Alle Tests liegen im Unterverzeichnis
8323 <filename>t/</filename>.</para>
8327 <para>Ein Script (bzw. ein Test) in <filename>t/</filename>
8328 enthält einen oder mehrere Testfälle.</para>
8332 <para>Alle Dateinamen von Tests enden auf <literal>.t</literal>.
8333 Es sind selbstständig ausführbare Perl-Scripte.</para>
8337 <para>Die Test-Suite besteht aus der Gesamtheit aller Tests,
8338 sprich aller Scripte in <filename>t/</filename>, deren Dateiname
8339 auf <literal>.t</literal> endet.</para>
8344 <sect2 id="devel.testsuite.prerequisites">
8345 <title>Voraussetzungen</title>
8347 <para>Für die Ausführung werden neben den für kivitendo eh schon
8348 benötigten Module noch weitere Perl-Module benötigt. Diese
8353 <para><literal>Test::Deep</literal> (Debian-Paketname:
8354 <literal>libtest-deep-perl</literal>; Fedora:
8355 <literal>perl-Test-Deep</literal>; openSUSE:
8356 <literal>perl-Test-Deep</literal>)</para>
8360 <para><literal>Test::Exception</literal> (Debian-Paketname:
8361 <literal>libtest-exception-perl</literal>; Fedora:
8362 <literal>perl-Test-Exception</literal>; openSUSE:
8363 <literal>perl-Test-Exception</literal>)</para>
8367 <para><literal>Test::Output</literal> (Debian-Paketname:
8368 <literal>libtest-output-perl</literal>; Fedora:
8369 <literal>perl-Test-Output</literal>; openSUSE:
8370 <literal>perl-Test-Output</literal>)</para>
8374 <para><literal>Test::Harness</literal> 3.0.0 oder höher. Dieses
8375 Modul ist ab Perl 5.10.1 Bestandteil der Perl-Distribution und
8376 kann für frühere Versionen aus dem <ulink
8377 url="http://www.cpan.org">CPAN</ulink> bezogen werden.</para>
8381 <para><literal>LWP::Simple</literal> aus dem Paket
8382 <literal>libwww-perl</literal> (Debian-Panetname:
8383 <literal>libwww-perl</literal>; Fedora:
8384 <literal>perl-libwww-perl</literal>; openSUSE:
8385 <literal>perl-libwww-perl</literal>)</para>
8389 <para><literal>URI::Find</literal> (Debian-Panetname:
8390 <literal>liburi-find-perl</literal>; Fedora:
8391 <literal>perl-URI-Find</literal>; openSUSE:
8392 <literal>perl-URI-Find</literal>)</para>
8396 <para><literal>Sys::CPU</literal> (Debian-Panetname:
8397 <literal>libsys-cpu-perl</literal>; Fedora und openSUSE: nicht
8402 <para><literal>Thread::Pool::Simple</literal> (Debian-Panetname:
8403 <literal>libthread-pool-simple-perl</literal>; Fedora und
8404 openSUSE: nicht vorhanden)</para>
8408 <para>Weitere Voraussetzung ist, dass die Testsuite ihre eigene
8409 Datenbank anlegen kann, um Produktivdaten nicht zu gefährden. Dazu
8410 müssen in der Konfigurationsdatei im Abschnit
8411 <literal>testing/database</literal> Datenbankverbindungsparameter
8412 angegeben werden. Der hier angegebene Benutzer muss weiterhin das
8413 Recht haben, Datenbanken anzulegen und zu löschen.</para>
8415 <para>Der so angegebene Benutzer muss nicht zwingend über
8416 Super-User-Rechte verfügen. Allerdings gibt es einige
8417 Datenbank-Upgrades, die genau diese Rechte benötigen. Für den Fall
8418 kann man in diesem Konfigurationsabschnitt einen weiteren
8419 Benutzeraccount angeben, der dann über Super-User-Rechte verfügt, und
8420 mit dem die betroffenen Upgrades durchgeführt werden. In der
8421 Beispiel-Konfigurationsdatei finden Sie die benötigten
8425 <sect2 id="devel.testsuite.execution">
8426 <title>Existierende Tests ausführen</title>
8428 <para>Es gibt mehrere Möglichkeiten zum Ausführen der Tests: entweder,
8429 man lässt alle Tests auf einmal ausführen, oder man führt gezielt
8430 einzelne Scripte aus. Für beide Fälle gibt es das Helferscript
8431 <filename>t/test.pl</filename>.</para>
8433 <para>Will man die komplette Test-Suite ausführen, so muss man einfach
8434 nur <filename>t/test.pl</filename> ohne weitere Parameter aus dem
8435 kivitendo-Basisverzeichnis heraus ausführen.</para>
8437 <para>Um einzelne Test-Scripte auszuführen, übergibt man deren Namen
8438 an <filename>t/test.pl</filename>. Beispielsweise:</para>
8440 <programlisting>t/test.pl t/form/format_amount.t t/background_job/known_jobs.t</programlisting>
8443 <sect2 id="devel.testsuite.meaning_of_scripts">
8444 <title>Bedeutung der verschiedenen Test-Scripte</title>
8446 <para>Die Test-Suite umfasst Tests sowohl für Funktionen als auch für
8447 Programmierstil. Einige besonders zu erwähnende, weil auch während der
8448 Entwicklung nützliche Tests sind:</para>
8452 <para><filename>t/001compile.t</filename> -- compiliert alle
8453 Quelldateien und bricht bei Fehlern sofort ab</para>
8457 <para><filename>t/002goodperl.t</filename> -- überprüft alle
8458 Perl-Dateien auf Anwesenheit von '<literal>use
8459 strict</literal>'-Anweisungen</para>
8463 <para><filename>t/003safesys.t</filename> -- überprüft Aufrufe von
8464 <function>system()</function> und <function>exec()</function> auf
8469 <para><filename>t/005no_tabs.t</filename> -- überprüft, ob Dateien
8470 Tab-Zeichen enthalten</para>
8474 <para><filename>t/006spelling.t</filename> -- sucht nach häufigen
8475 Rechtschreibfehlern</para>
8479 <para><filename>t/011pod.t</filename> -- überprüft die Syntax von
8480 Dokumentation im POD-Format auf Gültigkeit</para>
8484 <para>Weitere Test-Scripte überprüfen primär die Funktionsweise
8485 einzelner Funktionen und Module.</para>
8488 <sect2 id="devel.testsuite.create_new">
8489 <title>Neue Test-Scripte erstellen</title>
8491 <para>Es wird sehr gern gesehen, wenn neue Funktionalität auch gleich
8492 mit einem Test-Script abgesichert wird. Auch bestehende Funktion darf
8493 und soll ausdrücklich nachträglich mit Test-Scripten abgesichert
8496 <sect3 id="devel.testsuite.ideas_for_non_function_tests">
8497 <title>Ideen für neue Test-Scripte, die keine konkreten Funktionen
8500 <para>Ideen, die abgesehen von Funktionen noch nicht umgesetzt
8505 <para>Überprüfung auf fehlende symbolische Links</para>
8509 <para>Suche nach Nicht-ASCII-Zeichen in Perl-Code-Dateien (mit
8510 gewissen Einschränkungen wie das Erlauben von deutschen
8515 <para>Test auf DOS-Zeilenenden (\r\n anstelle von nur \n)</para>
8519 <para>Überprüfung auf Leerzeichen am Ende von Zeilen</para>
8523 <para>Test, ob alle zu übersetzenden Strings in
8524 <filename>locale/de/all</filename> vorhanden sind</para>
8528 <para>Test, ob alle Webseiten-Templates in
8529 <filename>templates/webpages</filename> mit vom Perl-Modul
8530 <literal>Template</literal> compiliert werden können</para>
8535 <sect3 id="devel.testsuite.directory_and_test_names">
8536 <title>Konvention für Verzeichnis- und Dateinamen</title>
8538 <para>Es gibt momentan eine wenige Richtlinien, wie Test-Scripte zu
8539 benennen sind. Bitte die folgenden Punkte als Richtlinie betrachten
8540 und ihnen soweit es geht folgen:</para>
8544 <para>Die Dateiendung muss <filename>.t</filename>
8549 <para>Namen sind englisch, komplett klein geschrieben und
8550 einzelne Wörter mit Unterstrichten getrennt (beispielsweise
8551 <filename>bad_function_params.t</filename>).</para>
8555 <para>Unterverzeichnisse sollten grob nach dem Themenbereich
8556 benannt sein, mit dem sich die Scripte darin befassen
8557 (beispielsweise <filename>background_jobs</filename> für Tests
8558 rund um Hintergrund-Jobs).</para>
8562 <para>Test-Scripte sollten einen überschaubaren Bereich von
8563 Funktionalität testen, der logisch zusammenhängend ist (z.B. nur
8564 Tests für eine einzelne Funktion in einem Modul). Lieber mehrere
8565 Test-Scripte schreiben.</para>
8570 <sect3 id="devel.testsuite.minimal_example">
8571 <title>Minimales Skelett für eigene Scripte</title>
8573 <para>Der folgenden Programmcode enthält das kleinstmögliche
8574 Testscript und kann als Ausgangspunkt für eigene Tests verwendet
8577 <programlisting>use Test::More tests => 0;
8581 use Support::TestSetup;
8583 Support::TestSetup::login();</programlisting>
8585 <para>Wird eine vollständig initialisierte kivitendo-Umgebung
8586 benötigt (Stichwort: alle globalen Variablen wie
8587 <varname>$::auth</varname>, <varname>$::form</varname> oder
8588 <varname>$::lxdebug</varname>), so muss in der Konfigurationsdatei
8589 <filename>config/kivitendo.conf</filename> im Abschnitt
8590 <literal>testing.login</literal> ein gültiger Login-Name eingetragen
8591 sein. Dieser wird für die Datenbankverbindung benötigt.</para>
8593 <para>Wir keine vollständig initialisierte Umgebung benötigt, so
8594 kann die letzte Zeile <programlisting>Support::TestSetup::login();</programlisting>
8595 weggelassen werden, was die Ausführungszeit des Scripts leicht
8601 <sect1 id="devel.style-guide">
8602 <title>Stil-Richtlinien</title>
8604 <para>Die folgenden Regeln haben das Ziel, den Code möglichst gut les-
8605 und wartbar zu machen. Dazu gehört zum Einen, dass der Code einheitlich
8606 eingerückt ist, aber auch, dass Mehrdeutigkeit so weit es geht vermieden
8607 wird (Stichworte "Klammern" oder "Hash-Keys").</para>
8609 <para>Diese Regeln sind keine Schikane sondern erleichtern allen das
8612 <para>Jeder, der einen Patch schickt, sollte seinen Code vorher
8613 überprüfen. Einige der Regeln lassen sich automatisch überprüfen, andere
8618 <para>Es werden keine echten Tabs sondern Leerzeichen
8623 <para>Die Einrückung beträgt zwei Leerzeichen. Beispiel:</para>
8625 <programlisting>foreach my $row (@data) {
8627 # do something with $row
8631 $row->{modules} = MODULE->retrieve(
8632 id => $row->{id},
8633 date => $use_now ? localtime() : $row->{time},
8637 $report->add($row);
8642 <para>Öffnende geschweifte Klammern befinden sich auf der gleichen
8643 Zeile wie der letzte Befehl. Beispiele:</para>
8645 <programlisting>sub debug {
8651 <programlisting>if ($form->{item_rows} > 0) {
8657 <para>Schließende geschweifte Klammern sind so weit eingerückt wie
8658 der Befehl / die öffnende schließende Klammer, die den Block
8659 gestartet hat, und nicht auf der Ebene des Inhalts. Die gleichen
8660 Beispiele wie bei 3. gelten.</para>
8664 <para>Die Wörter "<function>else</function>",
8665 "<function>elsif</function>", "<function>while</function>" befinden
8666 sich auf der gleichen Zeile wie schließende geschweifte Klammern.
8669 <programlisting>if ($form->{sum} > 1000) {
8671 } elsif ($form->{sum} > 0) {
8679 } until ($a > 0);</programlisting>
8683 <para>Parameter von Funktionsaufrufen müssen mit runden Klammern
8684 versehen werden. Davon nicht betroffen sind interne Perl-Funktionen,
8685 und grep-ähnliche Operatoren. Beispiel:</para>
8687 <programlisting>$main::lxdebug->message("Could not find file.");
8688 %options = map { $_ => 1 } grep { !/^#/ } @config_file;</programlisting>
8692 <para>Verschiedene Klammern, Ihre Ausdrücke und Leerzeichen:</para>
8694 <para>Generell gilt: Hashkeys und Arrayindices sollten nicht durch
8695 Leerzeichen abgesetzt werden. Logische Klammerungen ebensowenig,
8696 Blöcke schon. Beispiel:</para>
8698 <programlisting>if (($form->{debug} == 1) && ($form->{sum} - 100 < 0)) {
8703 $form->{sum} += $form->{"row_$i"};
8704 $form->{ $form->{index} } += 1;
8706 map { $form->{sum} += $form->{"row_$_"} } 1..$rowcount;</programlisting>
8710 <para>Mehrzeilige Befehle</para>
8714 <para>Werden die Parameter eines Funktionsaufrufes auf mehrere
8715 Zeilen aufgeteilt, so sollten diese bis zu der Spalte eingerückt
8716 werden, in der die ersten Funktionsparameter in der ersten Zeile
8717 stehen. Beispiel:</para>
8719 <programlisting>$sth = $dbh->prepare("SELECT * FROM some_table WHERE col = ?",
8720 $form->{some_col_value});</programlisting>
8724 <para>Ein Spezialfall ist der ternäre Operator "?:", der am
8725 besten in einer übersichtlichen Tabellenstruktur organisiert
8726 wird. Beispiel:</para>
8728 <programlisting>my $rowcount = $form->{"row_$i"} ? $i
8729 : $form->{oldcount} ? $form->{oldcount} + 1
8730 : $form->{rowcount} - $form->{rowbase};</programlisting>
8736 <para>Kommentare</para>
8740 <para>Kommentare, die alleine in einer Zeile stehen, sollten
8741 soweit wie der Code eingerückt sein.</para>
8745 <para>Seitliche hängende Kommentare sollten einheitlich
8746 formatiert werden.</para>
8750 <para>Sämtliche Kommentare und Sonstiges im Quellcode ist bitte
8751 auf Englisch zu verfassen. So wie ich keine Lust habe,
8752 französischen Quelltext zu lesen, sollte auch der kivitendo
8753 Quelltext für nicht-Deutschsprachige lesbar sein.
8756 <programlisting>my $found = 0;
8764 $i = 0 # initialize $i
8766 $i *= $const; # do something crazy
8767 $i = $n; # recover $i</programlisting>
8773 <para>Hashkeys sollten nur in Anführungszeichen stehen, wenn die
8774 Interpolation gewünscht ist. Beispiel:</para>
8776 <programlisting>$form->{sum} = 0;
8777 $form->{"row_$i"} = $form->{"row_$i"} - 5;
8778 $some_hash{42} = 54;</programlisting>
8782 <para>Die maximale Zeilenlänge ist nicht beschränkt. Zeilenlängen
8783 unterhalb von 79 Zeichen helfen unter bestimmten Bedingungen, aber
8784 wenn die Lesbarkeit unter kurzen Zeilen leidet (wie zum Biespiel in
8785 grossen Tabellen), dann ist Lesbarkeit vorzuziehen.</para>
8787 <para>Als Beispiel sei die Funktion
8788 <function>print_options</function> aus
8789 <filename>bin/mozilla/io.pl</filename> angeführt.</para>
8793 <para>Trailing Whitespace, d.h. Leerzeichen am Ende von Zeilen sind
8794 unerwünscht. Sie führen zu unnötigen Whitespaceänderungen, die diffs
8797 <para>Emacs und vim haben beide recht einfache Methoden zur
8798 Entfernung von trailing whitespace. Emacs kennt das Kommande
8799 <command>nuke-trailing-whitespace</command>, vim macht das gleiche
8800 manuell über <literal>:%s/\s\+$//e</literal> Mit <literal>:au
8801 BufWritePre * :%s/\s\+$//e</literal> wird das an Speichern
8806 <para>Es wird kein <command>perltidy</command> verwendet.</para>
8808 <para>In der Vergangenheit wurde versucht,
8809 <command>perltidy</command> zu verwenden, um einen einheitlichen
8810 Stil zu erlangen. Es hat sich aber gezeigt, dass
8811 <command>perltidy</command>s sehr eigenwilliges Verhalten, was
8812 Zeilenumbrüche angeht, oftmals gut formatierten Code zerstört. Für
8813 den Interessierten sind hier die
8814 <command>perltidy</command>-Optionen, die grob den beschriebenen
8815 Richtlinien entsprechen:</para>
8817 <programlisting>-syn -i=2 -nt -pt=2 -sbt=2 -ci=2 -ibc -hsc -noll -nsts -nsfs -asc -dsm
8818 -aws -bbc -bbs -bbb -mbl=1 -nsob -ce -nbl -nsbl -cti=0 -bbt=0 -bar -l=79
8819 -lp -vt=1 -vtc=1</programlisting>
8823 <para><varname>STDERR</varname> ist tabu. Unkonditionale
8824 Debugmeldungen auch.</para>
8826 <para>kivitendo bietet mit dem Modul <classname>LXDebug</classname>
8827 einen brauchbaren Trace-/Debug-Mechanismus. Es gibt also keinen
8828 Grund, nach <varname>STDERR</varname> zu schreiben.</para>
8830 <para>Die <classname>LXDebug</classname>-Methode
8831 "<function>message</function>" nimmt als ersten Paramter außerdem
8832 eine Flagmaske, für die die Meldung angezeigt wird, wobei "0" immer
8833 angezeigt wird. Solche Meldungen sollten nicht eingecheckt werden
8834 und werden in den meisten Fällen auch vom Repository
8835 zurückgewiesen.</para>
8839 <para>Alle neuen Module müssen use strict verwenden.</para>
8841 <para><varname>$form</varname>, <varname>$auth</varname>,
8842 <varname>$locale</varname>, <varname>$lxdebug</varname> und
8843 <varname>%myconfig</varname> werden derzeit aus dem main package
8844 importiert (siehe <xref linkend="devel.globals"/>. Alle anderen
8845 Konstrukte sollten lexikalisch lokal gehalten werden.</para>
8850 <sect1 id="devel.build-doc" xreflabel="Dokumentation erstellen">
8851 <title>Dokumentation erstellen</title>
8853 <sect2 id="devel.build-doc.introduction">
8854 <title>Einführung</title>
8856 <para>Diese Dokumentation ist in <productname>DocBook</productname>
8857 XML geschrieben. Zum Bearbeiten reicht grundsätzlich ein Text-Editor.
8858 Mehr Komfort bekommt man, wenn man einen dedizierten XML-fähigen
8859 Editor nutzt, der spezielle Unterstützung für
8860 <productname>DocBook</productname> mitbringt. Wir empfehlen dafür den
8861 <ulink url="http://www.xmlmind.com/xmleditor/">XMLmind XML
8862 Editor</ulink>, der bei nicht kommerzieller Nutzung kostenlos
8866 <sect2 id="devel.build-doc.required-software">
8867 <title>Benötigte Software</title>
8869 <para>Bei <productname>DocBook</productname> ist Prinzip, dass
8870 ausschließlich die XML-Quelldatei bearbeitet wird. Aus dieser werden
8871 dann mit entsprechenden Stylesheets andere Formate wie PDF oder HTML
8872 erzeugt. Bei kivitendo übernimmt diese Aufgabe das Shell-Script
8873 <command>scripts/build_doc.sh</command>.</para>
8875 <para>Das Script benötigt zur Konvertierung verschiedene
8876 Softwarekomponenten, die im normalen kivitendo-Betrieb nicht benötigt
8882 url="http://www.oracle.com/technetwork/java/index.html">Java</ulink>
8883 in einer halbwegs aktuellen Version</para>
8887 <para>Das Java-Build-System <ulink
8888 url="http://ant.apache.org/">Apache Ant</ulink></para>
8892 <para>Das Dokumentations-System Dobudish für
8893 <productname>DocBook</productname> 4.5, eine Zusammenstellung
8894 diverser Stylesheets und Grafiken zur Konvertierung von
8895 <productname>DocBook</productname> XML in andere Formate. Das
8896 Paket, das benötigt wird, ist zum Zeitpunkt der
8897 Dokumentationserstellung
8898 <filename>dobudish-nojre-1.1.4.zip</filename>, aus auf <ulink
8899 url="http://code.google.com/p/dobudish/downloads/list">code.google.com</ulink>
8904 <para>Apache Ant sowie ein dazu passendes Java Runtime Environment
8905 sind auf allen gängigen Plattformen verfügbar. Beispiel für
8906 Debian/Ubuntu:</para>
8908 <programlisting>apt-get install ant openjdk-7-jre</programlisting>
8910 <para>Nach dem Download von Dobudish muss Dobudish im Unterverzeichnis
8911 <filename>doc/build</filename> entpackt werden. Beispiel unter der
8912 Annahme, das <productname>Dobudish</productname> in
8913 <filename>$HOME/Downloads</filename> heruntergeladen wurde:</para>
8915 <programlisting>cd doc/build
8916 unzip $HOME/Downloads/dobudish-nojre-1.1.4.zip</programlisting>
8919 <sect2 id="devel.build-doc.build">
8920 <title>PDFs und HTML-Seiten erstellen</title>
8922 <para>Die eigentliche Konvertierung erfolgt nach Installation der
8923 benötigten Software mit einem einfachen Aufruf direkt aus dem
8924 kivitendo-Installationsverzeichnis heraus:</para>
8926 <programlisting>./scripts/build_doc.sh</programlisting>
8929 <sect2 id="devel.build-doc.repository">
8930 <title>Einchecken in das Git-Repository</title>
8932 <para>Sowohl die XML-Datei als auch die erzeugten PDF- und
8933 HTML-Dateien sind Bestandteil des Git-Repositories. Daraus folgt, dass
8934 nach Änderungen am XML die PDF- und HTML-Dokumente ebenfalls gebaut
8935 und alles zusammen in einem Commit eingecheckt werden sollten.</para>
8937 <para>Die "<filename>dobudish</filename>"-Verzeichnisse bzw.
8938 symbolischen Links gehören hingegen nicht in das Repository.</para>