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>7.0 "Wheezy"</para>
122 <para>8.0 "Jessie"</para>
125 <para>9.0 "Stretch"</para>
132 <para>Ubuntu 14.04 "Trusty Tahr" LTS, 15.10 "Wily Werewolf", 16.04 "Xenial Xerus" LTS
133 und 18.04 "Bionic Beaver" LTS
138 <para>openSUSE LEAP 42.1</para>
142 <para>Fedora 22</para>
147 <sect2 id="Pakete" xreflabel="Pakete">
148 <title>Benötigte Perl-Pakete installieren</title>
150 <para>Zum Betrieb von kivitendo werden zwingend ein Webserver (meist
151 Apache) und ein Datenbankserver (PostgreSQL) in einer aktuellen
152 Version (s.a. Liste der unterstützten Betriebssysteme)
155 <para>Zusätzlich benötigt kivitendo einige Perl-Pakete, die nicht
156 Bestandteil einer Standard-Perl-Installation sind. Um zu überprüfen,
157 ob die erforderlichen Pakete installiert und aktuell genug sind, wird
158 ein Script mitgeliefert, das wie folgt aufgerufen wird:</para>
160 <programlisting>./scripts/installation_check.pl</programlisting>
162 <para>Die vollständige Liste der benötigten Perl-Module lautet:</para>
166 <para><literal>parent</literal> (nur bei Perl vor 5.10.1)</para>
170 <para><literal>Archive::Zip</literal></para>
174 <para><literal>Algorithm::CheckDigits</literal></para>
178 <para><literal>CGI</literal></para>
182 <para><literal>Clone</literal></para>
186 <para><literal>Config::Std</literal></para>
190 <para><literal>DateTime</literal></para>
194 <para><literal>DateTime::Format::Strptime</literal></para>
198 <para><literal>DBI</literal></para>
202 <para><literal>DBD::Pg</literal></para>
206 <para><literal>Email::Address</literal></para>
210 <para><literal>Email::MIME</literal></para>
214 <para><literal>FCGI</literal> (nicht Versionen 0.68 bis 0.71
215 inklusive; siehe <xref
216 linkend="Apache-Konfiguration.FCGI.WebserverUndPlugin"/>)</para>
220 <para><literal>File::Copy::Recursive</literal></para>
224 <para><literal>File::MimeInfo</literal></para>
228 <para><literal>GD</literal></para>
232 <para><literal>HTML::Parser</literal></para>
236 <para><literal>HTML::Restrict</literal></para>
240 <para><literal>Image::Info</literal></para>
244 <para><literal>JSON</literal></para>
248 <para><literal>List::MoreUtils</literal></para>
252 <para><literal>List::UtilsBy</literal></para>
256 <para>LWP::Authen::Digest</para>
260 <para>LWP::UserAgent</para>
264 <para><literal>Net::SMTP::SSL</literal> (optional, bei
265 E-Mail-Versand über SSL; siehe Abschnitt "<xref
266 linkend="config.sending-email.smtp"/>")</para>
270 <para><literal>Net::SSLGlue</literal> (optional, bei
271 E-Mail-Versand über TLS; siehe Abschnitt "<xref
272 linkend="config.sending-email.smtp"/>")</para>
276 <para><literal>Params::Validate</literal></para>
280 <para><literal>PBKDF2::Tiny</literal></para>
284 <para><literal>PDF::API2</literal></para>
288 <para><literal>Rose::Object</literal></para>
292 <para><literal>Rose::DB</literal></para>
296 <para><literal>Rose::DB::Object</literal> Version 0.788 oder
301 <para><literal>String::ShellQuote</literal></para>
305 <para><literal>Sort::Naturally</literal></para>
309 <para><literal>Template</literal></para>
313 <para><literal>Text::CSV_XS</literal></para>
317 <para><literal>Text::Iconv</literal></para>
321 <para><literal>Text::Unidecode</literal></para>
325 <para><literal>URI</literal></para>
329 <para><literal>XML::Writer</literal></para>
333 <para><literal>YAML</literal></para>
336 <para>Seit Version größer v3.5.1 sind die folgenden Pakete
338 <literal>Set::Infinite</literal>,
339 <literal>List::UtilsBy</literal>,
340 <literal>DateTime::Set</literal>,
341 <literal>DateTime::Event::Cron</literal>
342 <literal>Daemon::Generic</literal>
343 <literal>DateTime::Event::Cron</literal>
344 <literal>File::Flock</literal>
345 <literal>File::Slurp</literal>
346 <literal>Set::Crontab</literal>
347 <literal>Exception::Lite</literal>
348 </para>Für die letzten beiden Module liefert kivitendo fallback-Module aus, da
349 diese überhaupt nicht in debian oder in der benötigten Version zu Verfügung stehen (Stand Anfang 2019).
351 <para>Seit Version größer v3.5.0 sind die folgenden Pakete
352 hinzugekommen: <literal>Text::Unidecode</literal>,
353 <literal>LWP::Authen::Digest</literal>,
354 <literal>LWP::UserAgent</literal></para>
356 <para>Seit Version v3.4.0 sind die folgenden Pakete hinzugekommen:
357 <literal>Algorithm::CheckDigits</literal>,
358 <literal>PBKDF2::Tiny</literal></para>
360 <para>Seit Version v3.2.0 sind die folgenden Pakete hinzugekommen:
361 <literal>GD</literal>, <literal>HTML::Restrict</literal>,
362 <literal>Image::Info</literal></para>
364 <para>Seit v3.0.0 sind die folgenden Pakete hinzugekommen:
365 <literal>File::Copy::Recursive</literal>.</para>
367 <para>Seit v2.7.0 sind die folgenden Pakete hinzugekommen:
368 <literal>Email::MIME</literal>, <literal>Net::SMTP::SSL</literal>,
369 <literal>Net::SSLGlue</literal>.</para>
371 <para>Gegenüber Version 2.6.0 sind zu dieser Liste 2 Pakete
372 hinzugekommen, <literal>URI</literal> und
373 <literal>XML::Writer</literal> sind notwendig. Ohne startet kivitendo
376 <para>Gegenüber Version 2.6.1 sind <literal>parent</literal>,
377 <literal>DateTime</literal>, <literal>Rose::Object</literal>,
378 <literal>Rose::DB</literal> und <literal>Rose::DB::Object</literal>
379 neu hinzugekommen. <literal>IO::Wrap</literal> wurde entfernt.</para>
381 <para>Gegenüber Version 2.6.3 ist <literal>JSON</literal> neu
382 hinzugekommen.</para>
384 <para><literal>Email::Address</literal> und
385 <literal>List::MoreUtils</literal> sind schon länger feste
386 Abhängigkeiten, wurden aber bisher mit kivitendo mitgeliefert. Beide
387 sind auch in 2.6.1 weiterhin mit ausgeliefert, wurden in einer
388 zukünftigen Version aber aus dem Paket entfernt werden. Es wird
389 empfohlen diese Module zusammen mit den anderen als Bibliotheken zu
393 <title>Debian und Ubuntu</title>
395 <para>Für Debian und Ubuntu stehen die meisten der benötigten
396 Pakete als Debian-Pakete zur Verfügung. Sie können mit
397 folgendem Befehl installiert werden:</para>
399 <programlisting>apt install apache2 libarchive-zip-perl libclone-perl \
400 libconfig-std-perl libdatetime-perl libdbd-pg-perl libdbi-perl \
401 libemail-address-perl libemail-mime-perl libfcgi-perl libjson-perl \
402 liblist-moreutils-perl libnet-smtp-ssl-perl libnet-sslglue-perl \
403 libparams-validate-perl libpdf-api2-perl librose-db-object-perl \
404 librose-db-perl librose-object-perl libsort-naturally-perl \
405 libstring-shellquote-perl libtemplate-perl libtext-csv-xs-perl \
406 libtext-iconv-perl liburi-perl libxml-writer-perl libyaml-perl \
407 libimage-info-perl libgd-gd2-perl libapache2-mod-fcgid \
408 libfile-copy-recursive-perl postgresql libalgorithm-checkdigits-perl \
409 libcrypt-pbkdf2-perl git libcgi-pm-perl libtext-unidecode-perl libwww-perl\
410 postgresql-contrib aqbanking-tools poppler-utils libhtml-restrict-perl\
411 libdatetime-set-perl libset-infinite-perl liblist-utilsby-perl\
412 libdaemon-generic-perl libfile-flock-perl libfile-slurp-perl
415 <para>Ab Ubuntu Version 18.04 LTS sind alle benötigten Pakete in der Distributions verfügbar.</para>
416 <para>Für ältere Ubuntu/Debians müßen einige Pakete per CPAN installiert werden.
417 Das geht bspw. für das benötige Paket HTML::Restrict mit:</para>
419 <programlisting>apt-get install build-essential
420 cpan HTML::Restrict</programlisting>
424 <title>Fedora</title>
426 <para>Für Fedora stehen die meisten der benötigten Perl-Pakete als
427 RPM-Pakete zur Verfügung. Sie können mit folgendem Befehl
428 installiert werden:</para>
430 <programlisting>dnf install httpd mod_fcgid perl-Archive-Zip perl-Clone perl-DBD-Pg \
431 perl-DBI perl-DateTime perl-Email-Address perl-Email-MIME perl-FCGI \
432 perl-File-Copy-Recursive perl-JSON perl-List-MoreUtils perl-Net-SMTP-SSL perl-Net-SSLGlue \
433 perl-PDF-API2 perl-Params-Validate perl-Rose-DB perl-Rose-DB-Object \
434 perl-Rose-Object perl-Sort-Naturally perl-String-ShellQuote \
435 perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv perl-URI \
436 perl-XML-Writer perl-YAML perl-parent postgresql-server perl-CPAN \
437 perl-Algorithm-CheckDigits perl-GD perl-Class-XSAccessor perl-Text-Balanced perl-libwww-perl</programlisting>
439 <para>Zusätzlich müssen einige Pakete aus dem CPAN installiert
440 werden. Dazu können Sie die folgenden Befehle nutzen:</para>
442 <programlisting>cpan Config::Std HTML::Restrict</programlisting>
446 <title>openSUSE</title>
448 <para>Für openSUSE stehen die meisten der benötigten Perl-Pakete als
449 RPM-Pakete zur Verfügung. Sie können mit folgendem Befehl
450 installiert werden:</para>
452 <programlisting>zypper install apache2 apache2-mod_fcgid perl-Archive-Zip perl-Clone \
453 perl-Config-Std perl-DBD-Pg perl-DBI perl-DateTime perl-Email-Address \
454 perl-Email-MIME perl-FastCGI perl-File-Copy-Recursive perl-JSON perl-List-MoreUtils \
455 perl-Net-SMTP-SSL perl-Net-SSLGlue perl-PDF-API2 perl-Params-Validate \
456 perl-Sort-Naturally perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv \
457 perl-URI perl-XML-Writer perl-YAML perl-CPAN \
458 perl-Algorithm-CheckDigits perl-GD perl-Class-XSAccessor postgresql-server perl-libwwww-perl</programlisting>
460 <para>Zusätzlich müssen einige Pakete aus dem CPAN installiert
461 werden. Dazu können Sie die folgenden Befehle nutzen:</para>
463 <programlisting>cpan Rose::Db::Object</programlisting>
468 <title>Andere Pakete installieren</title>
470 <para>Seit Version v3.4.0 wird für den Bankimport optional das Paket
471 'aqbanking-tools' benötigt.</para>
473 <para>Debian und Ubuntu: <programlisting>apt install aqbanking-tools
474 </programlisting></para>
476 <para>Fedora: <programlisting>dnf install aqbanking</programlisting></para>
478 <para>openSUSE: <programlisting>zypper install aqbanking-tools</programlisting></para>
480 <para>Seit Version v3.4.1 wird generell zum Feststellen der
481 Seitenanzahl von PDF_Dokumenten 'pdfinfo' benötigt was im Paket
482 'poppler-utils' enthalten ist.</para>
484 <para>Debian und Ubuntu: <programlisting>apt install poppler-utils
485 </programlisting></para>
487 <para>Fedora: <programlisting>dnf install poppler-utils</programlisting></para>
489 <para>openSUSE: <programlisting>zypper install poppler-tools</programlisting></para>
493 <sect1 id="Manuelle-Installation-des-Programmpaketes"
494 xreflabel="Manuelle Installation des Programmpaketes">
495 <title>Manuelle Installation des Programmpaketes</title>
497 <para>Der aktuelle Stable-Release, bzw. beta Release wird bei github
498 gehostet und kann <ulink
499 url="https://github.com/kivitendo/kivitendo-erp/releases">hier</ulink>
500 heruntergeladen werden.</para>
502 <para>Die kivitendo ERP Installationsdatei
503 (<filename>kivitendo-erp-3.4.1.tgz</filename>) wird im
504 Dokumentenverzeichnis des Webservers (z.B.
505 <filename>/var/www/html/</filename>,
506 <filename>/srv/www/htdocs</filename> oder
507 <filename>/var/www/</filename>) entpackt:</para>
509 <programlisting>cd /var/www
510 tar xvzf kivitendo-erp-3.4.1.tgz</programlisting>
512 <para>Wechseln Sie in das entpackte Verzeichnis:</para>
514 <programlisting>cd kivitendo-erp</programlisting>
516 <para>Alternativ können Sie auch einen Alias in der
517 Webserverkonfiguration benutzen, um auf das tatsächliche
518 Installationsverzeichnis zu verweisen.</para>
520 <para>Bei einer Neuinstallation von Version 3.1.0 oder später muß das
521 WebDAV Verzeichnis derzeit manuell angelegt werden:</para>
523 <programlisting>mkdir webdav</programlisting>
525 <para>Die Verzeichnisse <filename>users</filename>,
526 <filename>spool</filename> und <filename>webdav</filename> müssen für
527 den Benutzer beschreibbar sein, unter dem der Webserver läuft. Die
528 restlichen Dateien müssen für diesen Benutzer lesbar sein. Die Benutzer-
529 und Gruppennamen sind bei verschiedenen Distributionen unterschiedlich
530 (z.B. bei Debian/Ubuntu <constant>www-data</constant>, bei Fedora
531 <constant>apache</constant> oder bei openSUSE
532 <constant>wwwrun</constant>).</para>
534 <para>Der folgende Befehl ändert den Besitzer für die oben genannten
535 Verzeichnisse auf einem Debian/Ubuntu-System:</para>
537 <programlisting>chown -R www-data users spool webdav</programlisting>
539 <para>Weiterhin muss der Webserver-Benutzer in den Verzeichnissen
540 <filename>templates</filename> und <filename>users</filename>
541 Unterverzeichnisse für jeden neuen Benutzer anlegen dürfen, der in
542 kivitendo angelegt wird:</para>
544 <programlisting>chown www-data templates users</programlisting>
547 <para>Wir empfehlen eine Installation mittels des Versionsmanagager
548 git. Hierfür muss ein git-Client installiert sein. Damit ist man sehr
549 viel flexibler für zukünftige Upgrades. Installations-Anleitung (bitte
550 die Pfade anpassen) bspw. wie folgt: <programlisting>cd /var/www/
551 git clone https://github.com/kivitendo/kivitendo-erp.git
553 git checkout `git tag -l | egrep -ve "(alpha|beta|rc)" | tail -1`</programlisting>
554 Erläuterung: Der Befehl wechselt zur letzten Stable-Version (git tag
555 -l listet alle Tags auf, das egrep schmeisst alle Einträge mit alpha,
556 beta oder rc raus und das tail gibt davon den obersten Treffer
557 zurück). Sehr sinnvoll ist es, direkt im Anschluss einen eigenen
558 Branch zu erzeugen, um bspw. seine eigenen Druckvorlagen-Anpassungen
559 damit zu verwalten. Hierfür reicht ein simples <programlisting> git checkout -b meine_eigenen_änderungen</programlisting>
560 nach dem letzten Kommando (weiterführende Informationen <ulink
561 url="http://www-cs-students.stanford.edu/~blynn/gitmagic/index.html">
562 Git Magic</ulink>).</para>
564 <para>Ein beispielhafter Workflow für Druckvorlagen-Anpassungen von
565 3.4.1 nach 3.5: <programlisting>
566 $ git clone https://github.com/kivitendo/kivitendo-erp.git
568 $ git checkout release-3.4.1 # das ist der aktuelle release, den wir wollen
569 $ git add templates/fullhouse # das sind unsere druckvorlagen inkl. produktbilder
570 $ git commit -m "juhu tolle ändernungen"
571 [meine_aenderungen 1d89e41] juhu tolle ändernungen
572 4 files changed, 380 insertions(+)
573 create mode 100644 templates/fullhouse/img/webdav/tesla.png
574 create mode 100644 templates/fullhouse/mahnung.tex
575 create mode 100644 templates/fullhouse/zahlungserinnerung_zwei.tex
576 create mode 100644 templates/fullhouse/zahlungserinnerung_zwei_invoice.tex
581 $ git rebase --onto release-3.5.0 release-3.4.1 meine_aenderungen
582 Zunächst wird der Branch zurückgespult, um Ihre Änderungen
583 darauf neu anzuwenden ...
584 Wende an: juhu tolle ändernungen
585 $ service apache2 restart
586 </programlisting></para>
590 <sect1 id="config.config-file">
591 <title>kivitendo-Konfigurationsdatei</title>
593 <sect2 id="config.config-file.introduction"
594 xreflabel="Einführung in die Konfigurationsdatei">
595 <title>Einführung</title>
597 <para>In kivitendo gibt es nur noch eine Konfigurationsdatei, die
598 benötigt wird: <filename>config/kivitendo.conf</filename> (kurz: "die
599 Hauptkonfigurationsdatei"). Diese muss bei der Erstinstallation von
600 kivitendo bzw. der Migration von älteren Versionen angelegt
603 <para>Als Vorlage dient die Datei
604 <filename>config/kivitendo.conf.default</filename> (kurz: "die
605 Default-Datei"):</para>
607 <programlisting>$ cp config/kivitendo.conf.default config/kivitendo.conf</programlisting>
609 <para>Die Default-Datei wird immer zuerst eingelesen. Werte, die in
610 der Hauptkonfigurationsdatei stehen, überschreiben die Werte aus der
611 Default-Datei. Die Hauptkonfigurationsdatei muss also nur die
612 Abschnitte und Werte enthalten, die von denen der Default-Datei
616 <para>Vor der Umbenennung in kivitendo hieß diese Datei noch
617 <filename>config/lx_office.conf</filename>. Aus Gründen der
618 Kompatibilität wird diese Datei eingelesen, sofern die Datei
619 <filename>config/kivitendo.conf</filename> nicht existiert.</para>
622 <para>Diese Hauptkonfigurationsdatei ist dann eine
623 installationsspezifische Datei, d.h. sie enthält bspw. lokale
624 Passwörter und wird auch nicht im Versionsmanagement (git)
627 <para>Die Konfiguration ist ferner serverabhängig, d.h. für alle
628 Mandaten, bzw. Datenbanken gleich.</para>
631 <sect2 id="config.config-file.sections-parameters">
632 <title>Abschnitte und Parameter</title>
634 <para>Die Konfigurationsdatei besteht aus mehreren Teilen, die
635 entsprechend kommentiert sind:</para>
639 <para><literal>authentication</literal> (siehe Abschnitt "<xref
640 linkend="Benutzerauthentifizierung-und-Administratorpasswort"/>"
641 in diesem Kapitel)</para>
645 <para><literal>authentication/database</literal></para>
649 <para><literal>authentication/ldap</literal></para>
653 <para><literal>system</literal></para>
657 <para><literal>paths</literal></para>
661 <para><literal>mail_delivery</literal> (siehe Abschnitt "<xref
662 linkend="config.sending-email.smtp"/>)</para>
666 <para><literal>applications</literal></para>
670 <para><literal>environment</literal></para>
674 <para><literal>print_templates</literal></para>
678 <para><literal>task_server</literal></para>
682 <para><literal>periodic_invoices</literal></para>
686 <para><literal>self_tests</literal></para>
690 <para><literal>console</literal></para>
694 <para><literal>testing</literal></para>
698 <para><literal>testing/database</literal></para>
702 <para><literal>debug</literal></para>
706 <para>Die üblicherweise wichtigsten Parameter, die am Anfang
707 einzustellen oder zu kontrollieren sind, sind:</para>
709 <programlisting>[authentication]
710 admin_password = geheim
712 [authentication/database]
720 default_manager = german</programlisting>
722 <para>Für kivitendo Installationen in der Schweiz sollte hier
723 <varname>german</varname> durch <varname>swiss</varname> ersetzt
726 <para>Die Einstellung <varname>default_manager = swiss</varname>
731 <para>Beim Erstellen einer neuen Datenbank in der kivitendo
732 Administration werden automatisch die Standard-Werte für die
733 Schweiz voreingestellt: Währung CHF, 5er-Rundung, Schweizer
734 KMU-Kontenplan, Sollversteuerung, Aufwandsmethode, Bilanzierung
735 (die Werte können aber manuell angepasst werden).</para>
739 <para>Einstellen der Standardkonten für Rundungserträge und
740 -aufwendungen (unter Mandantenkonfiguration → Standardkonten
745 <para>das verwendete Zahlenformat wird auf
746 <varname>1'000.00</varname> eingestellt (unter Programm →
747 Benutzereinstellungen veränderbar)</para>
751 <para>DATEV-Automatik und UStVA werden nicht angezeigt,
752 Erfolgsrechnung ersetzt GUV ( unter Mandantenkonfiguration →
753 Features veränderbar)</para>
757 <para>Nutzt man wiederkehrende Rechnungen, kann man unter
758 <varname>[periodic_invoices]</varname> den Login eines Benutzers
759 angeben, der nach Erstellung der Rechnungen eine entsprechende E-Mail
760 mit Informationen über die erstellten Rechnungen bekommt.</para>
762 <para>kivitendo bringt eine eigene Komponente zur zeitgesteuerten
763 Ausführung bestimmter Aufgaben mit, den <link
764 linkend="config.task-server">Taskserver</link>. Er wird u.a. für
765 Features wie die <link
766 linkend="features.periodic-invoices">wiederkehrenden Rechnungen</link>
767 benötigt, erledigt aber auch andere erforderliche Aufgaben und muss
768 daher in Betrieb genommen werden. Seine Einrichtung wird im Abschnitt
769 <link linkend="config.task-server">Task-Server</link> genauer
772 <para>Für Entwickler finden sich unter <varname>[debug]</varname>
773 wichtige Funktionen, um die Fehlersuche zu erleichtern.</para>
776 <sect2 id="config.config-file.prior-versions">
777 <title>Versionen vor 2.6.3</title>
779 <para>In älteren kivitendo Versionen gab es im Verzeichnis
780 <filename>config</filename> die Dateien
781 <filename>authentication.pl</filename> und
782 <filename>lx-erp.conf</filename>, die jeweils Perl-Dateien waren. Es
783 gab auch die Möglichkeit, eine lokale Version der Konfigurationsdatei
784 zu erstellen (<filename>lx-erp-local.conf</filename>). Dies ist ab
785 2.6.3 nicht mehr möglich, aber auch nicht mehr nötig.</para>
787 <para>Beim Update von einer kivitendo-Version vor 2.6.3 auf 2.6.3 oder
788 jünger müssen die Einstellungen aus den alten Konfigurationsdateien
789 manuell übertragen und die alten Konfigurationsdateien anschließend
790 gelöscht oder verschoben werden. Ansonsten zeigt kivitendo eine
791 entsprechende Fehlermeldung an.</para>
795 <sect1 id="Anpassung-der-PostgreSQL-Konfiguration">
796 <title>Anpassung der PostgreSQL-Konfiguration</title>
798 <para>PostgreSQL muss auf verschiedene Weisen angepasst werden.</para>
800 <sect2 id="Zeichensätze-die-Verwendung-von-UTF-8">
801 <title>Zeichensätze/die Verwendung von Unicode/UTF-8</title>
803 <para>kivitendo setzt zwingend voraus, dass die Datenbank
804 Unicode/UTF-8 als Encoding einsetzt. Bei aktuellen
805 Serverinstallationen braucht man hier meist nicht einzugreifen.</para>
807 <para>Das Encoding des Datenbankservers kann überprüft werden. Ist das
808 Encoding der Datenbank "template1" "Unicode" bzw. "UTF-8", so braucht
809 man nichts weiteres diesbezüglich unternehmen. Zum Testen:</para>
811 <programlisting>su postgres
813 exit </programlisting>
815 <para>Andernfalls ist es notwendig, einen neuen Datenbankcluster mit
816 Unicode-Encoding anzulegen und diesen zu verwenden. Unter Debian und
817 Ubuntu kann dies z.B. für PostgreSQL 9.3 mit dem folgenden Befehl
820 <programlisting>pg_createcluster --locale=de_DE.UTF-8 --encoding=UTF-8 9.3 clustername</programlisting>
822 <para>Die Datenbankversionsnummer muss an die tatsächlich verwendete
823 Versionsnummer angepasst werden.</para>
825 <para>Unter anderen Distributionen gibt es ähnliche Methoden.</para>
827 <para>Das Encoding einer Datenbank kann in <command>psql</command> mit
828 <literal>\l</literal> geprüft werden.</para>
831 <sect2 id="Änderungen-an-Konfigurationsdateien">
832 <title>Änderungen an Konfigurationsdateien</title>
834 <para>In der Datei <filename>postgresql.conf</filename>, die je nach
835 Distribution in verschiedenen Verzeichnissen liegen kann (z.B.
836 <filename>/var/lib/pgsql/data/</filename> oder
837 <filename>/etc/postgresql/</filename>), muss sichergestellt werden,
838 dass TCP/IP-Verbindungen aktiviert sind. Das Verhalten wird über den
839 Parameter <varname>listen_address</varname> gesteuert. Laufen
840 PostgreSQL und kivitendo auf demselben Rechner, so kann dort der Wert
841 <literal>localhost</literal> verwendet werden. Andernfalls müssen
842 Datenbankverbindungen auch von anderen Rechnern aus zugelassen werden,
843 was mit dem Wert <literal>*</literal> geschieht.</para>
845 <para>In der Datei <filename>pg_hba.conf</filename>, die im gleichen
846 Verzeichnis wie die <filename>postgresql.conf</filename> zu finden
847 sein sollte, müssen die Berechtigungen für den Zugriff geändert
848 werden. Hier gibt es mehrere Möglichkeiten. Sinnvoll ist es nur die
849 nötigen Verbindungen immer zuzulassen, für eine lokal laufende
850 Datenbank zum Beispiel:</para>
852 <programlisting>local all kivitendo password
853 host all kivitendo 127.0.0.1 255.255.255.255 password</programlisting>
856 <sect2 id="Erweiterung-für-servergespeicherte-Prozeduren">
857 <title>Erweiterung für servergespeicherte Prozeduren</title>
859 <para>In der Datenbank <literal>template1</literal> muss die
860 Unterstützung für servergespeicherte Prozeduren eingerichet werden.
861 Melden Sie sich dafür als Benutzer “postgres” an der Datenbank an:
862 <programlisting>su - postgres
863 psql template1</programlisting> führen Sie die folgenden Kommandos aus:</para>
865 <programlisting>CREATE EXTENSION IF NOT EXISTS plpgsql;
869 <para><literal>CREATE EXTENSION</literal> ist seit Version 9.1 die
870 bevorzugte Syntax um die Sprache <literal>plpgsql</literal>
871 anzulegen. In diesen Versionen ist die Extension meist auch schon
872 vorhanden. Sollten Sie eine ältere Version von Postgres haben,
873 benutzen Sie stattdessen den folgenden Befehl.</para>
875 <programlisting>CREATE LANGUAGE 'plpgsql';
880 <sect2 id="Erweiterung-für-trigram">
881 <title>Erweiterung für Trigram Prozeduren</title>
883 <para>Ab Version 3.5.1 wird die Trigram-Index-Erweiterung benötigt.
884 Diese wird mit dem SQL-Updatescript
885 sql/Pg-upgrade2/trigram_extension.sql und Datenbank-Super-Benutzer
886 Rechten automatisch installiert. Dazu braucht der
887 DatenbankSuperbenutzer "postgres" ein Passwort.</para>
889 <programlisting>su - postgres
896 <para>Benutzername Postgres und Passwort können jetzt beim Anlegen
897 einer Datenbank bzw. bei Updatescripten, die SuperuserRechte
898 benötigen, eingegeben werden.</para>
901 <para><literal>pg_trgm</literal> ist je nach Distribution nicht im
902 Standard-Paket von Postgres enthalten. Ein <programlisting>select * from pg_available_extensions where name ='pg_trgm';</programlisting>
903 in template1 sollte entsprechend erfolgreich sein. Andernfalls muss
904 das Paket nachinstalliert werden, bspw. bei debian/ubuntu
905 <programlisting>apt install postgresql-contrib</programlisting></para>
909 <sect2 id="Datenbankbenutzer-anlegen">
910 <title>Datenbankbenutzer anlegen</title>
912 <para>Wenn Sie nicht den Datenbanksuperuser “postgres” zum Zugriff
913 benutzen wollen, so sollten Sie bei PostgreSQL einen neuen Benutzer
914 anlegen. Ein Beispiel, wie Sie einen neuen Benutzer anlegen
917 <para>Die Frage, ob der neue User Superuser sein soll, können Sie mit
918 nein beantworten, genauso ist die Berechtigung neue User (Roles) zu
919 generieren nicht nötig.</para>
921 <programlisting>su - postgres
922 createuser -d -P kivitendo
923 exit</programlisting>
925 <para>Wenn Sie später einen Datenbankzugriff konfigurieren, verändern
926 Sie den evtl. voreingestellten Benutzer “postgres” auf “kivitendo”
927 bzw. den hier gewählten Benutzernamen.</para>
931 <sect1 id="Apache-Konfiguration">
932 <title>Webserver-Konfiguration</title>
935 <title>Grundkonfiguration mittels CGI</title>
938 <para>Für einen deutlichen Performanceschub sorgt die Ausführung
939 mittels FastCGI/FCGI. Die Einrichtung wird ausführlich im Abschnitt
940 <xref linkend="Apache-Konfiguration.FCGI"/> beschrieben.</para>
943 <para>Der Zugriff auf das Programmverzeichnis muss in der Apache
944 Webserverkonfigurationsdatei <literal>httpd.conf</literal> eingestellt
945 werden. Fügen Sie den folgenden Abschnitt dieser Datei oder einer
946 anderen Datei hinzu, die beim Starten des Webservers eingelesen
949 <programlisting>AliasMatch ^/kivitendo-erp/[^/]+\.pl /var/www/kivitendo-erp/dispatcher.pl
950 Alias /kivitendo-erp/ /var/www/kivitendo-erp/
952 <Directory /var/www/kivitendo-erp>
953 AddHandler cgi-script .pl
954 Options ExecCGI Includes FollowSymlinks
957 <Directory /var/www/kivitendo-erp/users>
959 </Directory></programlisting>
961 <para>Ersetzen Sie dabei die Pfade durch diejenigen, in die Sie vorher
962 das kivitendo-Archiv entpacket haben.</para>
965 <para>Vor den einzelnen Optionen muss bei einigen Distributionen ein
966 Plus ‘<literal>+</literal>’ gesetzt werden.</para>
968 <para>Bei einigen Distribution (Ubuntu ab 14.04, Debian ab 8.2) muss
969 noch explizit das cgi-Modul mittels <programlisting>a2enmod cgi</programlisting>
970 aktiviert werden.</para>
973 <para>Auf einigen Webservern werden manchmal die Grafiken und
974 Style-Sheets nicht ausgeliefert. In solchen Fällen hat es oft
975 geholfen, die folgende Option in die Konfiguration aufzunehmen:</para>
977 <programlisting>EnableSendfile Off</programlisting>
980 <sect2 id="Apache-Konfiguration.FCGI"
981 xreflabel="Konfiguration für FastCGI/FCGI">
982 <title>Konfiguration für FastCGI/FCGI</title>
984 <sect3 id="Apache-Konfiguration.FCGI.WasIstEs">
985 <title>Was ist FastCGI?</title>
987 <para>Direkt aus <ulink
988 url="http://de.wikipedia.org/wiki/FastCGI">Wikipedia</ulink>
991 <para><citation> FastCGI ist ein Standard für die Einbindung
992 externer Software zur Generierung dynamischer Webseiten in einem
993 Webserver. FastCGI ist vergleichbar zum Common Gateway Interface
994 (CGI), wurde jedoch entwickelt, um dessen Performance-Probleme zu
995 umgehen. </citation></para>
998 <sect3 id="Apache-Konfiguration.FCGI.Warum">
999 <title>Warum FastCGI?</title>
1001 <para>Perl Programme (wie kivitendo eines ist) werden nicht statisch
1002 kompiliert. Stattdessen werden die Quelldateien bei jedem Start
1003 übersetzt, was bei kurzen Laufzeiten einen Großteil der Laufzeit
1004 ausmacht. Während SQL Ledger einen Großteil der Funktionalität in
1005 einzelne Module kapselt, um immer nur einen kleinen Teil laden zu
1006 müssen, ist die Funktionalität von kivitendo soweit gewachsen, dass
1007 immer mehr Module auf den Rest des Programms zugreifen. Zusätzlich
1008 benutzen wir umfangreiche Bibliotheken um Funktionaltät nicht selber
1009 entwickeln zu müssen, die zusätzliche Ladezeit kosten. All dies
1010 führt dazu dass ein kivitendo Aufruf der Kernmasken mittlerweile
1011 deutlich länger dauert als früher, und dass davon 90% für das Laden
1012 der Module verwendet wird.</para>
1014 <para>Mit FastCGI werden nun die Module einmal geladen, und danach
1015 wird nur die eigentliche Programmlogik ausgeführt.</para>
1018 <sect3 id="Apache-Konfiguration.FCGI.WebserverUndPlugin">
1019 <title>Getestete Kombinationen aus Webservern und Plugin</title>
1021 <para>Folgende Kombinationen sind getestet:</para>
1025 <para>Apache 2.4.7 (Ubuntu 14.04.2 LTS) und mod_fcgid.</para>
1028 <para>Apache 2.4.18 (Ubuntu 16.04 LTS) und mod_fcgid</para>
1031 <para>Apache 2.4.29 (Ubuntu 18.04 LTS) und mod_fcgid</para>
1035 <para>Als Perl Backend wird das Modul <filename>FCGI.pm</filename>
1039 <para>FCGI-Versionen ab 0.69 und bis zu 0.71 inklusive sind extrem
1040 strict in der Behandlung von Unicode, und verweigern bestimmte
1041 Eingaben von kivitendo. Falls es Probleme mit Umlauten in Ihrer
1042 Installation gibt, muss zwingend Version 0.68 oder aber Version
1043 0.72 und neuer eingesetzt werden.</para>
1045 <para>Mit <ulink url="http://www.cpan.org">CPAN</ulink> lässt sie
1046 sich die Vorgängerversion wie folgt installieren:</para>
1048 <programlisting>force install M/MS/MSTROUT/FCGI-0.68.tar.gz</programlisting>
1052 <sect3 id="Apache-Konfiguration.FCGI.Konfiguration">
1053 <title>Konfiguration des Webservers</title>
1055 <para>Bevor Sie versuchen, eine kivitendo Installation unter FCGI
1056 laufen zu lassen, empfiehlt es sich die Installation ersteinmal
1057 unter CGI aufzusetzen. FCGI macht es nicht einfach Fehler zu
1058 debuggen die beim ersten aufsetzen auftreten können. Sollte die
1059 Installation schon funktionieren, lesen Sie weiter.</para>
1061 <para>Zuerst muss das FastCGI-Modul aktiviert werden. Dies kann
1062 unter Debian/Ubuntu z.B. mit folgendem Befehl geschehen:</para>
1064 <programlisting>a2enmod fcgid</programlisting>
1066 <para>Die Konfiguration für die Verwendung von kivitendo mit FastCGI
1067 erfolgt durch Anpassung der vorhandenen <function>Alias</function>-
1068 und <function>Directory</function>-Direktiven. Dabei wird zwischen
1069 dem Installationspfad von kivitendo im Dateisystem
1070 ("<filename>/path/to/kivitendo-erp</filename>") und der URL
1071 unterschieden, unter der kivitendo im Webbrowser erreichbar ist
1072 ("<filename>/url/for/kivitendo-erp</filename>").</para>
1074 <para>Folgender Konfigurationsschnipsel funktioniert mit
1077 <programlisting>AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fcgi
1078 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
1080 <Directory /path/to/kivitendo-erp>
1082 Options ExecCGI Includes FollowSymlinks
1086 <DirectoryMatch /path/to/kivitendo-erp/users>
1088 </DirectoryMatch></programlisting>
1091 <para>Wer einen älteren Apache als Version 2.4 im Einsatz hat,
1092 muss entsprechend die Syntax der Directorydirektiven verändert.
1095 <programlisting>Require all granted</programlisting>
1097 <para>muß man Folgendes einstellen:</para>
1101 Allow from All </programlisting>
1103 <para>und statt</para>
1105 <programlisting>Require all denied</programlisting>
1107 <para>muss stehen:</para>
1111 Deny from All </programlisting>
1114 <para>Seit mod_fcgid-Version 2.3.6 gelten sehr kleine Grenzen für
1115 die maximale Größe eines Requests. Diese sollte wie folgt
1116 hochgesetzt werden:</para>
1118 <programlisting>FcgidMaxRequestLen 10485760</programlisting>
1120 <para>Das Ganze sollte dann so aussehen:</para>
1122 <programlisting>AddHandler fcgid-script .fpl
1123 AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
1124 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
1125 FcgidMaxRequestLen 10485760
1127 <Directory /path/to/kivitendo-erp>
1129 Options ExecCGI Includes FollowSymlinks
1134 <DirectoryMatch /path/to/kivitendo-erp/users>
1137 </DirectoryMatch></programlisting>
1139 <para>Hierdurch wird nur ein zentraler Dispatcher gestartet. Alle
1140 Zugriffe auf die einzelnen Scripte werden auf diesen umgeleitet.
1141 Dadurch, dass zur Laufzeit öfter mal Scripte neu geladen werden,
1142 gibt es hier kleine Performance-Einbußen.</para>
1144 <para>Es ist möglich, die gleiche kivitendo Version parallel unter
1145 CGI und FastCGI zu betreiben. Dafür bleiben die Directorydirektiven
1146 wie oben beschrieben, die URLs werden aber umgeleitet:</para>
1148 <programlisting># Zugriff über CGI
1149 Alias /url/for/kivitendo-erp /path/to/kivitendo-erp
1151 # Zugriff mit mod_fcgid:
1152 AliasMatch ^/url/for/kivitendo-erp-fcgid/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
1153 Alias /url/for/kivitendo-erp-fcgid/ /path/to/kivitendo-erp/</programlisting>
1155 <para>Dann ist unter <filename>/url/for/kivitendo-erp/</filename>
1156 die normale Version erreichbar, und unter
1157 <constant>/url/for/kivitendo-erp-fcgid/</constant> die
1158 FastCGI-Version.</para>
1163 <title>Weitergehende Konfiguration</title>
1165 <para>Für einen deutlichen Sicherheitsmehrwert sorgt die Ausführung
1166 von kivitendo nur über https-verschlüsselten Verbindungen, sowie
1167 weiteren Zusatzmassnahmen, wie beispielsweise Basic Authenticate. Die
1168 Konfigurationsmöglichkeiten sprengen allerdings den Rahmen dieser
1169 Anleitung, hier ein Hinweis auf einen entsprechenden <ulink
1170 url="http://redmine.kivitendo-premium.de/boards/1/topics/142">Foreneintrag
1171 (Stand Sept. 2015)</ulink> und einen aktuellen (Stand Mai 2017) <ulink
1172 url="https://mozilla.github.io/server-side-tls/ssl-config-generator/">
1173 SSL-Konfigurations-Generator</ulink>.</para>
1177 <sect1 id="config.task-server">
1178 <title>Der Task-Server</title>
1180 <para>Der Task-Server ist ein Prozess, der im Hintergrund läuft, in
1181 regelmäßigen Abständen nach abzuarbeitenden Aufgaben sucht und diese zu
1182 festgelegten Zeitpunkten abarbeitet (ähnlich wie Cron). Dieser Prozess
1183 wird u.a. für die Erzeugung der wiederkehrenden Rechnungen und weitere
1184 essenzielle Aufgaben benutzt.</para>
1186 <para>Der Task-Server muss einmalig global in der Konfigurationsdatei
1187 konfiguriert werden. Danach wird er für jeden Mandanten, für den er
1188 laufen soll, in der Adminsitrationsmaske eingeschaltet.</para>
1190 <para>Beachten Sie, dass der Task-Server in den Boot-Vorgang Ihres
1191 Servers integriert werden muss, damit er automatisch gestartet wird.
1192 Dies kann kivitendo nicht für Sie erledigen.</para>
1194 <para>Da der Taskserver als Perlscript läuft, wird Arbeitsspeicher, der
1195 einmal benötigt wurde, nicht mehr an das Betriebssystem zurückgegeben,
1196 solange der Taskserver läuft. Dies kann dazu führen, dass ein länger
1197 laufender Taskserver mit der Zeit immer mehr Arbeitsspeicher für sich
1198 beansprucht. Es ist deshalb sinnvoll, dass der Taskserver in
1199 regelmässigen Abständen neu gestartet wird.</para>
1201 <sect2 id="Konfiguration-des-Task-Servers">
1202 <title>Verfügbare und notwendige Konfigurationsoptionen</title>
1204 <para>Die Konfiguration erfolgt über den Abschnitt
1205 <literal>[task_server]</literal> in der Datei
1206 <filename>config/kivitendo.conf</filename>. Die dort verfügbaren
1207 Optionen sind:</para>
1211 <term><varname>run_as</varname></term>
1214 <para>Wird der Server vom Systembenutzer <literal>root</literal>
1215 gestartet, so wechselt er auf den mit <literal>run_as</literal>
1216 angegebenen Systembenutzer. Der Systembenutzer muss dieselben
1217 Lese- und Schreibrechte haben, wie auch der Webserverbenutzer
1219 linkend="Manuelle-Installation-des-Programmpaketes"/>). Daher
1220 ist es erforderlich, hier denselben Systembenutzer einzutragen,
1221 unter dem auch der Webserver läuft.</para>
1226 <term><varname>debug</varname></term>
1229 <para>Schaltet Debug-Informationen an und aus.</para>
1235 <sect2 id="Konfiguration-der-Mandanten-fuer-den-Task-Servers">
1236 <title>Konfiguration der Mandanten für den Task-Server</title>
1238 <para>Ist der Task-Server grundlegend konfiguriert, so muss
1239 anschließend jeder Mandant, für den der Task-Server laufen soll,
1240 einmalig konfiguriert werden. Dazu kann in der Maske zum Bearbeiten
1241 von Mandanten im Administrationsbereich eine kivitendo-Benutzerkennung
1242 ausgewählt werden, unter der der Task-Server seine Arbeit
1245 <para>Ist in dieser Einstellung keine Benutzerkennung ausgewählt, so
1246 wird der Task-Server für diesen Mandanten keine Aufgaben
1250 <sect2 id="Einbinden-in-den-Boot-Prozess">
1251 <title>Automatisches Starten des Task-Servers beim Booten</title>
1253 <para>Der Task-Server verhält sich von seinen Optionen her wie ein
1254 reguläres SystemV-kompatibles Boot-Script. Außerdem wechselt er beim
1255 Starten automatisch in das kivitendo-Installationsverzeichnis.</para>
1257 <para>Deshalb ist es möglich, ihn durch Setzen eines symbolischen
1258 Links aus einem der Runlevel-Verzeichnisse heraus in den Boot-Prozess
1259 einzubinden. Da das bei neueren Linux-Distributionen aber nicht
1260 zwangsläufig funktioniert, werden auch Start-Scripte mitgeliefert, die
1261 anstelle eines symbolischen Links verwendet werden können.</para>
1264 <title>SystemV-basierende Systeme (z.B. ältere Debian, ältere
1265 openSUSE, ältere Fedora)</title>
1267 <para>Kopieren Sie die Datei
1268 <filename>scripts/boot/system-v/kivitendo-task-server</filename>
1269 nach <filename>/etc/init.d/kivitendo-task-server</filename>. Passen
1270 Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
1271 <literal>DAEMON=....</literal>). Binden Sie das Script in den
1272 Boot-Prozess ein. Dies ist distributionsabhängig:</para>
1276 <para>Debian-basierende Systeme:</para>
1278 <programlisting>update-rc.d kivitendo-task-server defaults
1279 insserv kivitendo-task-server</programlisting>
1283 <para>Ältere openSUSE und ältere Fedora:</para>
1285 <programlisting>chkconfig --add kivitendo-task-server</programlisting>
1289 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
1292 <programlisting>/etc/init.d/kivitendo-task-server start</programlisting>
1296 <title>Upstart-basierende Systeme (z.B. Ubuntu bis 14.04)</title>
1298 <para>Kopieren Sie die Datei
1299 <filename>scripts/boot/upstart/kivitendo-task-server.conf</filename>
1300 nach <filename>/etc/init/kivitendo-task-server.conf</filename>.
1301 Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
1302 <literal>exec ....</literal>).</para>
1304 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
1307 <programlisting>service kivitendo-task-server start</programlisting>
1311 <title>systemd-basierende Systeme (z.B. neure openSUSE, neuere
1312 Fedora, neuere Ubuntu und neuere Debians)</title>
1314 <para>Kopieren Sie die Datei
1315 <filename>scripts/boot/systemd/kivitendo-task-server.service</filename>
1316 nach <filename>/etc/systemd/system/</filename>. Passen Sie in der
1317 kopierten Datei den Pfad zum Task-Server an (Zeilen
1318 <literal>ExecStart=....</literal> und
1319 <literal>ExecStop=...</literal>).</para>
1321 <para>Machen Sie anschließend das Script systemd bekannt, und binden
1322 Sie es in den Boot-Prozess ein. Dazu führen Sie die folgenden Befehl
1325 <programlisting>systemctl daemon-reload
1326 systemctl enable kivitendo-task-server.service</programlisting>
1328 <para>Wenn Sie den Task-Server jetzt sofort starten möchten, anstatt
1329 den Server neu zu starten, so können Sie das mit dem folgenden
1332 <programlisting>systemctl start kivitendo-task-server.service</programlisting>
1336 <sect2 id="Prozesskontrolle">
1337 <title>Wie der Task-Server gestartet und beendet wird</title>
1339 <para>Der Task-Server wird wie folgt kontrolliert:</para>
1341 <programlisting>./scripts/task_server.pl Befehl</programlisting>
1343 <para><literal>Befehl</literal> ist dabei eine der folgenden
1348 <para><literal>start</literal> startet eine neue Instanz des
1349 Task-Servers. Die Prozess-ID wird innerhalb des
1350 <filename>users</filename>-Verzeichnisses abgelegt.</para>
1354 <para><literal>stop</literal> beendet einen laufenden
1359 <para><literal>restart</literal> beendet und startet ihn
1364 <para><literal>status</literal> berichtet, ob der Task-Server
1369 <para>Der Task-Server wechselt beim Starten automatisch in das
1370 kivitendo-Installationsverzeichnis.</para>
1372 <para>Dieselben Optionen können auch für die SystemV-basierenden
1373 Runlevel-Scripte benutzt werden (siehe oben).</para>
1377 <sect1 id="Benutzerauthentifizierung-und-Administratorpasswort">
1378 <title>Benutzerauthentifizierung und Administratorpasswort</title>
1380 <para>Informationen über die Einrichtung der Benutzerauthentifizierung,
1381 über die Verwaltung von Gruppen und weitere Einstellungen</para>
1383 <sect2 id="Grundlagen-zur-Benutzerauthentifizierung">
1384 <title>Grundlagen zur Benutzerauthentifizierung</title>
1386 <para>kivitendo verwaltet die Benutzerinformationen in einer
1387 Datenbank, die im folgenden “Authentifizierungsdatenbank” genannt
1388 wird. Für jeden Benutzer kann dort eine eigene Datenbank für die
1389 eigentlichen Finanzdaten hinterlegt sein. Diese beiden Datenbanken
1390 können, müssen aber nicht unterschiedlich sein.</para>
1392 <para>Im einfachsten Fall gibt es für kivitendo nur eine einzige
1393 Datenbank, in der sowohl die Benutzerinformationen als auch die Daten
1394 abgelegt werden.</para>
1396 <para>Zusätzlich ermöglicht es kivitendo, dass die Benutzerpasswörter
1397 entweder gegen die Authentifizierungsdatenbank oder gegen einen
1398 LDAP-Server überprüft werden.</para>
1400 <para>Welche Art der Passwortüberprüfung kivitendo benutzt und wie
1401 kivitendo die Authentifizierungsdatenbank erreichen kann, wird in der
1402 Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1403 festgelegt. Diese muss bei der Installation und bei einem Upgrade von
1404 einer Version vor v2.6.0 angelegt werden. Eine
1405 Beispielkonfigurationsdatei
1406 <filename>config/kivitendo.conf.default</filename> existiert, die als
1407 Vorlage benutzt werden kann.</para>
1410 <sect2 id="Administratorpasswort">
1411 <title>Administratorpasswort</title>
1413 <para>Das Passwort, das zum Zugriff auf das Administrationsinterface
1414 von kivitendo benutzt wird, wird ebenfalls in dieser Datei
1415 gespeichert. Es kann auch nur dort und nicht mehr im
1416 Administrationsinterface selber geändert werden. Der Parameter dazu
1417 heißt <varname>admin_password</varname> im Abschnitt
1418 <varname>[authentication]</varname>.</para>
1421 <sect2 id="Authentifizierungsdatenbank">
1422 <title>Authentifizierungsdatenbank</title>
1424 <para>Die Verbindung zur Authentifizierungsdatenbank wird mit den
1425 Parametern in <varname>[authentication/database]</varname>
1426 konfiguriert. Hier sind die folgenden Parameter anzugeben:</para>
1430 <term><literal>host</literal></term>
1433 <para>Der Rechnername oder die IP-Adresse des
1434 Datenbankservers</para>
1439 <term><literal>port</literal></term>
1442 <para>Die Portnummer des Datenbankservers, meist 5432</para>
1447 <term><literal>db</literal></term>
1450 <para>Der Name der Authentifizierungsdatenbank</para>
1455 <term><literal>user</literal></term>
1458 <para>Der Benutzername, mit dem sich kivitendo beim
1459 Datenbankserver anmeldet (z.B.
1460 "<literal>postgres</literal>")</para>
1465 <term><literal>password</literal></term>
1468 <para>Das Passwort für den Datenbankbenutzer</para>
1473 <para>Die Datenbank muss noch nicht existieren. kivitendo kann sie
1474 automatisch anlegen (mehr dazu siehe unten).</para>
1477 <sect2 id="Passwortüberprüfung">
1478 <title>Passwortüberprüfung</title>
1480 <para>kivitendo unterstützt Passwortüberprüfung auf zwei Arten: gegen
1481 die Authentifizierungsdatenbank und gegen einen externen LDAP- oder
1482 Active-Directory-Server. Welche davon benutzt wird, regelt der
1483 Parameter <varname>module</varname> im Abschnitt
1484 <varname>[authentication]</varname>.</para>
1486 <para>Sollen die Benutzerpasswörter in der Authentifizierungsdatenbank
1487 gespeichert werden, so muss der Parameter <varname>module</varname>
1488 den Wert <literal>DB</literal> enthalten. In diesem Fall können sowohl
1489 der Administrator als auch die Benutzer selber ihre Passwörter in
1490 kivitendo ändern.</para>
1492 <para>Soll hingegen ein externer LDAP- oder Active-Directory-Server
1493 benutzt werden, so muss der Parameter <varname>module</varname> auf
1494 <literal>LDAP</literal> gesetzt werden. In diesem Fall müssen
1495 zusätzliche Informationen über den LDAP-Server im Abschnitt
1496 <literal>[authentication/ldap]</literal> angegeben werden:</para>
1500 <term><literal>host</literal></term>
1503 <para>Der Rechnername oder die IP-Adresse des LDAP- oder
1504 Active-Directory-Servers. Diese Angabe ist zwingend
1505 erforderlich.</para>
1510 <term><literal>port</literal></term>
1513 <para>Die Portnummer des LDAP-Servers; meist 389.</para>
1518 <term><literal>tls</literal></term>
1521 <para>Wenn Verbindungsverschlüsselung gewünscht ist, so diesen
1522 Wert auf ‘<literal>1</literal>’ setzen, andernfalls auf
1523 ‘<literal>0</literal>’ belassen</para>
1528 <term><literal>attribute</literal></term>
1531 <para>Das LDAP-Attribut, in dem der Benutzername steht, den der
1532 Benutzer eingegeben hat. Für Active-Directory-Server ist dies
1533 meist ‘<literal>sAMAccountName</literal>’, für andere
1534 LDAP-Server hingegen ‘<literal>uid</literal>’. Diese Angabe ist
1535 zwingend erforderlich.</para>
1540 <term><literal>base_dn</literal></term>
1543 <para>Der Abschnitt des LDAP-Baumes, der durchsucht werden soll.
1544 Diese Angabe ist zwingend erforderlich.</para>
1549 <term><literal>filter</literal></term>
1552 <para>Ein optionaler LDAP-Filter. Enthält dieser Filter das Wort
1553 <literal><%login%></literal>, so wird dieses durch den vom
1554 Benutzer eingegebenen Benutzernamen ersetzt. Andernfalls wird
1555 der LDAP-Baum nach einem Element durchsucht, bei dem das oben
1556 angegebene Attribut mit dem Benutzernamen identisch ist.</para>
1561 <term><literal>bind_dn</literal> und
1562 <literal>bind_password</literal></term>
1565 <para>Wenn der LDAP-Server eine Anmeldung erfordert, bevor er
1566 durchsucht werden kann (z.B. ist dies bei
1567 Active-Directory-Servern der Fall), so kann diese hier angegeben
1568 werden. Für Active-Directory-Server kann als
1569 ‘<literal>bind_dn</literal>’ entweder eine komplette LDAP-DN wie
1570 z.B. ‘<literal>cn=Martin
1571 Mustermann,cn=Users,dc=firmendomain</literal>’ auch nur der
1572 volle Name des Benutzers eingegeben werden; in diesem Beispiel
1573 also ‘<literal>Martin Mustermann</literal>’.</para>
1579 <sect2 id="Name-des-Session-Cookies">
1580 <title>Name des Session-Cookies</title>
1582 <para>Sollen auf einem Server mehrere kivitendo-Installationen
1583 aufgesetzt werden, so müssen die Namen der Session-Cookies für alle
1584 Installationen unterschiedlich sein. Der Name des Cookies wird mit dem
1585 Parameter <varname>cookie_name</varname> im Abschnitt
1586 <varname>[authentication]</varname>gesetzt.</para>
1588 <para>Diese Angabe ist optional, wenn nur eine Installation auf dem
1589 Server existiert.</para>
1592 <sect2 id="Anlegen-der-Authentifizierungsdatenbank">
1593 <title>Anlegen der Authentifizierungsdatenbank</title>
1595 <para>Nachdem alle Einstellungen in
1596 <filename>config/kivitendo.conf</filename> vorgenommen wurden, muss
1597 kivitendo die Authentifizierungsdatenbank anlegen. Dieses geschieht
1598 automatisch, wenn Sie sich im Administrationsmodul anmelden, das unter
1599 der folgenden URL erreichbar sein sollte:</para>
1602 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
1606 <sect1 id="Benutzer--und-Gruppenverwaltung">
1607 <title>Mandanten-, Benutzer- und Gruppenverwaltung</title>
1609 <para>Nach der Installation müssen Mandanten, Benutzer, Gruppen und
1610 Datenbanken angelegt werden. Dieses geschieht im Administrationsmenü,
1611 das Sie unter folgender URL finden:</para>
1614 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
1616 <para>Verwenden Sie zur Anmeldung das Passwort, das Sie in der Datei
1617 <filename>config/kivitendo.conf</filename> eingetragen haben.</para>
1619 <sect2 id="Zusammenhänge">
1620 <title>Zusammenhänge</title>
1622 <para>kivitendo verwaltet zwei Sets von Daten, die je nach Einrichtung
1623 in einer oder zwei Datenbanken gespeichert werden.</para>
1625 <para>Das erste Set besteht aus Anmeldeinformationen: welche Benutzer
1626 und Mandanten gibt es, welche Gruppen, welche BenutzerIn hat Zugriff
1627 auf welche Mandanten, und welche Gruppe verfügt über welche Rechte.
1628 Diese Informationen werden in der Authentifizierungsdatenbank
1629 gespeichert. Dies ist diejenige Datenbank, deren Verbindungsparameter
1630 in der Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1631 gespeichert werden.</para>
1633 <para>Das zweite Set besteht aus den eigentlichen Verkehrsdaten eines
1634 Mandanten, wie beispielsweise die Stammdaten (Kunden, Lieferanten,
1635 Waren) und Belege (Angebote, Lieferscheine, Rechnungen). Diese werden
1636 in einer Mandantendatenbank gespeichert. Die Verbindungsinformationen
1637 einer solchen Mandantendatenbank werden im Administrationsbereich
1638 konfiguriert, indem man einen Mandanten anlegt und dort die Parameter
1639 einträgt. Dabei hat jeder Mandant eine eigene Datenbank.</para>
1641 <para>Aufgrund des Datenbankdesigns ist es für einfache Fälle möglich,
1642 die Authentifizierungsdatenbank und eine der Mandantendatenbanken in
1643 ein und derselben Datenbank zu speichern. Arbeitet man hingegen mit
1644 mehr als einem Mandanten, wird empfohlen, für die
1645 Authentifizierungsdatenbank eine eigene Datenbank zu verwenden, die
1646 nicht gleichzeitig für einen Mandanten verwendet wird.</para>
1649 <sect2 id="Mandanten-Benutzer-Gruppen">
1650 <title>Mandanten, Benutzer und Gruppen</title>
1652 <para>kivitendos Administration kennt Mandanten, Benutzer und Gruppen,
1653 die sich frei zueinander zuordnen lassen.</para>
1655 <para>kivitendo kann mehrere Mandaten aus einer Installation heraus
1656 verwalten. Welcher Mandant benutzt wird, kann direkt beim Login
1657 ausgewählt werden. Für jeden Mandanten wird ein eindeutiger Name
1658 vergeben, der beim Login angezeigt wird. Weiterhin benötigt der
1659 Mandant Datenbankverbindungsparameter für seine Mandantendatenbank.
1660 Diese sollte über die <link
1661 linkend="Datenbanken-anlegen">Datenbankverwaltung</link>
1664 <para>Ein Benutzer ist eine Person, die Zugriff auf kivitendo erhalten
1665 soll. Sie erhält einen Loginnamen sowie ein Passwort. Weiterhin legt
1666 der Administrator fest, an welchen Mandanten sich ein Benutzer
1667 anmelden kann, was beim Login verifiziert wird.</para>
1669 <para>Gruppen dienen dazu, Benutzern innerhalb eines Mandanten Zugriff
1670 auf bestimmte Funktionen zu geben. Einer Gruppe werden dafür vom
1671 Administrator gewisse Rechte zugeordnet. Weiterhin legt der
1672 Administrator fest, für welche Mandanten eine Gruppe gilt, und welche
1673 Benutzer Mitglieder in dieser Gruppe sind. Meldet sich ein Benutzer
1674 dann an einem Mandanten an, so erhält er alle Rechte von allen
1675 denjenigen Gruppen, die zum Einen dem Mandanten zugeordnet sind und in
1676 denen der Benutzer zum Anderen Mitglied ist,</para>
1678 <para>Die Reihenfolge, in der Datenbanken, Mandanten, Gruppen und
1679 Benutzer angelegt werden, kann im Prinzip beliebig gewählt werden. Die
1680 folgende Reihenfolge beinhaltet die wenigsten Arbeitsschritte:</para>
1682 <orderedlist numeration="arabic">
1684 <para>Datenbank anlegen</para>
1688 <para>Gruppen anlegen</para>
1692 <para>Benutzer anlegen und Gruppen als Mitglied zuordnen</para>
1696 <para>Mandanten anlegen und Gruppen sowie Benutzer zuweisen</para>
1701 <sect2 id="Datenbanken-anlegen">
1702 <title>Datenbanken anlegen</title>
1704 <para>Zuerst muss eine Datenbank angelegt werden. Verwenden Sie für
1705 den Datenbankzugriff den vorhin angelegten Benutzer (in unseren
1706 Beispielen ist dies ‘<literal>kivitendo</literal>’).</para>
1709 <sect2 id="Gruppen-anlegen">
1710 <title>Gruppen anlegen</title>
1712 <para>Eine Gruppe wird in der Gruppenverwaltung angelegt. Ihr muss ein
1713 Name gegeben werden, eine Beschreibung ist hingegen optional. Nach dem
1714 Anlegen können Sie die verschiedenen Bereiche wählen, auf die
1715 Mitglieder dieser Gruppe Zugriff haben sollen.</para>
1717 <para>Benutzergruppen werden zwar in der Authentifizierungsdatenbank
1718 gespeichert, gelten aber nicht automatisch für alle Mandanten. Der
1719 Administrator legt vielmehr fest, für welche Mandanten eine Gruppe
1720 gültig ist. Dies kann entweder beim Bearbeiten der Gruppe geschehen
1721 ("diese Gruppe ist gültig für Mandanten X, Y und Z"), oder aber wenn
1722 man einen Mandanten bearbeitet ("für diesen Mandanten sind die Gruppen
1723 A, B und C gültig").</para>
1725 <para>Wurden bereits Benutzer angelegt, so können hier die Mitglieder
1726 dieser Gruppe festgelegt werden ("in dieser Gruppe sind die Benutzer
1727 X, Y und Z Mitglieder"). Dies kann auch nachträglich beim Bearbeiten
1728 eines Benutzers geschehen ("dieser Benutzer ist Mitglied in den
1729 Gruppen A, B und C").</para>
1732 <sect2 id="Benutzer-anlegen">
1733 <title>Benutzer anlegen</title>
1735 <para>Beim Anlegen von Benutzern werden für viele Parameter
1736 Standardeinstellungen vorgenommen, die den Gepflogenheiten des
1737 deutschen Raumes entsprechen.</para>
1739 <para>Zwingend anzugeben ist der Loginname. Wenn die
1740 Passwortauthentifizierung über die Datenbank eingestellt ist, so kann
1741 hier auch das Benutzerpasswort gesetzt bzw. geändert werden. Ist
1742 hingegen die LDAP-Authentifizierung aktiv, so ist das Passwort-Feld
1745 <para>Hat man bereits Mandanten und Gruppen angelegt, so kann hier
1746 auch konfiguriert werden, auf welche Mandanten der Benutzer Zugriff
1747 hat bzw. in welchen Gruppen er Mitglied ist. Beide Zuweisungen können
1748 sowohl beim Benutzer vorgenommen werden ("dieser Benutzer hat Zugriff
1749 auf Mandanten X, Y, Z" bzw. "dieser Benutzer ist Mitglied in Gruppen
1750 X, Y und Z") als auch beim Mandanten ("auf diesen Mandanten haben
1751 Benutzer A, B und C Zugriff") bzw. bei der Gruppe ("in dieser Gruppe
1752 sind Benutzer A, B und C Mitglieder").</para>
1755 <sect2 id="Mandanten-anlegen">
1756 <title>Mandanten anlegen</title>
1758 <para>Ein Mandant besteht aus Administrationssicht primär aus einem
1759 eindeutigen Namen. Weiterhin wird hier hinterlegt, welche Datenbank
1760 als Mandantendatenbank benutzt wird. Hier müssen die Zugriffsdaten
1761 einer der eben angelegten Datenbanken eingetragen werden.</para>
1763 <para>Hat man bereits Benutzer und Gruppen angelegt, so kann hier auch
1764 konfiguriert werden, welche Benutzer Zugriff auf den Mandanten haben
1765 bzw. welche Gruppen für den Mandanten gültig sind. Beide Zuweisungen
1766 können sowohl beim Mandanten vorgenommen werden ("auf diesen Mandanten
1767 haben Benutzer X, Y und Z Zugriff" bzw. "für diesen Mandanten sind die
1768 Gruppen X, Y und Z gültig") als auch beim Benutzer ("dieser Benutzer
1769 hat Zugriff auf Mandanten A, B und C") bzw. bei der Gruppe ("diese
1770 Gruppe ist für Mandanten A, B und C gültig").</para>
1774 <sect1 id="Drucker--Systemverwaltung">
1775 <title>Drucker- und Systemverwaltung</title>
1777 <para>Im Administrationsmenü gibt es ferner noch die beiden Menüpunkte
1778 Druckeradministration und System.</para>
1780 <sect2 id="Druckeradministration">
1781 <title>Druckeradministration</title>
1783 <para>Unter dem Menüpunkt Druckeradministration lassen sich beliebig
1784 viele "Druckbefehle" im System verwalten. Diese Befehle werden
1785 mandantenweise zugeordnet. Unter Druckerbeschreibung wird der Namen
1786 des Druckbefehls festgelegt, der dann in der Druckerauswahl des Belegs
1787 angezeigt wird.</para>
1789 <para>Unter Druckbefehl definiert man den eigentlichen Druckbefehl,
1790 der direkt auf dem Webserver ausgeführt wird, bspw. 'lpr -P
1791 meinDrucker' oder ein kompletter Pfad zu einem Skript
1792 (/usr/local/src/kivitendo/scripts/pdf_druck_in_verzeichnis.sh). Wird
1793 ferner noch ein optionales Vorlagenkürzel verwendet, wird dieses
1794 Kürzel bei der Auswahl der Druckvorlagendatei mit einem Unterstrich
1795 ergänzt, ist bspw. das Kürzel 'epson_drucker' definiert, so wird beim
1796 Ausdruck eines Angebots folgende Vorlage geparst:
1797 sales_quotation_epson_drucker.tex.</para>
1801 <title>System sperren / entsperren</title>
1803 <para>Unter dem Menüpunkt System gibt es den Eintrag 'Installation
1804 sperren/entsperren'. Setzt man diese Sperre so ist der Zugang zu der
1805 gesamten kivitendo Installation gesperrt.</para>
1807 <para>Falls die Sperre gesetzt ist, erscheint anstelle der
1808 Anmeldemaske die Information: 'kivitendo ist momentan zwecks
1809 Wartungsarbeiten nicht zugänglich.'.</para>
1811 <para>Wichtig zu erwähnen ist hierbei noch, dass sich kivitendo
1812 automatisch 'sperrt', falls es bei einem Versionsupdate zu einem
1813 Datenbankfehler kam. Somit kann hier nicht aus Versehen mit einem
1814 inkonsistenten Datenbestand weitergearbeitet werden.</para>
1818 <sect1 id="config.sending-email"
1819 xreflabel="E-Mail-Versand aus kivitendo heraus">
1820 <title>E-Mail-Versand aus kivitendo heraus</title>
1822 <para>kivitendo kann direkt aus dem Programm heraus E-Mails versenden,
1823 z.B. um ein Angebot direkt an einen Kunden zu verschicken. Damit dies
1824 funktioniert, muss eingestellt werden, über welchen Server die E-Mails
1825 verschickt werden sollen. kivitendo unterstützt dabei zwei Mechanismen:
1826 Versand über einen lokalen E-Mail-Server (z.B. mit
1827 <productname>Postfix</productname> oder <productname>Exim</productname>,
1828 was auch die standardmäßig aktive Methode ist) sowie Versand über einen
1829 SMTP-Server (z.B. der des eigenen Internet-Providers).</para>
1831 <para>Welche Methode und welcher Server verwendet werden, wird über die
1832 Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1833 festgelegt. Dort befinden sich alle Einstellungen zu diesem Thema im
1834 Abschnitt '<literal>[mail_delivery]</literal>'.</para>
1836 <sect2 id="config.sending-email.sendmail"
1837 xreflabel="E-Mail-Versand über lokalen E-Mail-Server">
1838 <title>Versand über lokalen E-Mail-Server</title>
1840 <para>Diese Methode bietet sich an, wenn auf dem Server, auf dem
1841 kivitendo läuft, bereits ein funktionsfähiger E-Mail-Server wie z.B.
1842 <productname>Postfix</productname>, <productname>Exim</productname>
1843 oder <productname>Sendmail</productname> läuft.</para>
1845 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter
1846 '<literal>method = sendmail</literal>' gesetzt sein. Dies ist
1847 gleichzeitig der Standardwert, falls er nicht verändert wird.</para>
1849 <para>Um zu kontrollieren, wie das Programm zum Einliefern gestartet
1850 wird, dient der Parameter '<literal>sendmail = ...</literal>'. Der
1851 Standardwert verweist auf das Programm
1852 <filename>/usr/bin/sendmail</filename>, das bei allen oben genannten
1853 E-Mail-Serverprodukten für diesen Zweck funktionieren sollte.</para>
1855 <para>Die Konfiguration des E-Mail-Servers selber würde den Rahmen
1856 dieses sprengen. Hierfür sei auf die Dokumentation des E-Mail-Servers
1860 <sect2 id="config.sending-email.smtp"
1861 xreflabel="E-Mail-Versand über einen SMTP-Server">
1862 <title>Versand über einen SMTP-Server</title>
1864 <para>Diese Methode bietet sich an, wenn kein lokaler E-Mail-Server
1865 vorhanden oder zwar einer vorhanden, dieser aber nicht konfiguriert
1868 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter
1869 '<literal>method = smtp</literal>' gesetzt sein. Die folgenden
1870 Parameter dienen dabei der weiteren Konfiguration:</para>
1874 <term><varname>hostname</varname></term>
1877 <para>Name oder IP-Adresse des SMTP-Servers. Standardwert:
1878 '<literal>localhost</literal>'</para>
1883 <term><varname>port</varname></term>
1886 <para>Portnummer. Der Standardwert hängt von der verwendeten
1887 Verschlüsselungsmethode ab. Gilt '<literal>security =
1888 none</literal>' oder '<literal>security = tls</literal>', so ist
1889 25 die Standardportnummer. Für '<literal>security =
1890 ssl</literal>' ist 465 die Portnummer. Muss normalerweise nicht
1891 geändert werden.</para>
1896 <term><varname>security</varname></term>
1899 <para>Wahl der zu verwendenden Verschlüsselung der Verbindung
1900 mit dem Server. Standardwert ist '<literal>none</literal>',
1901 wodurch keine Verschlüsselung verwendet wird. Mit
1902 '<literal>tls</literal>' wird TLS-Verschlüsselung eingeschaltet,
1903 und mit '<literal>ssl</literal>' wird Verschlüsselung via SSL
1904 eingeschaltet. Achtung: Für '<literal>tls</literal>' und
1905 '<literal>ssl</literal>' werden zusätzliche Perl-Module benötigt
1906 (siehe unten).</para>
1911 <term><varname>login</varname> und
1912 <varname>password</varname></term>
1915 <para>Falls der E-Mail-Server eine Authentifizierung verlangt,
1916 so können mit diesen zwei Parametern der Benutzername und das
1917 Passwort angegeben werden. Wird Authentifizierung verwendet, so
1918 sollte aus Sicherheitsgründen auch eine Form von Verschlüsselung
1919 aktiviert werden.</para>
1926 <sect1 id="Drucken-mit-kivitendo">
1927 <title>Drucken mit kivitendo</title>
1929 <para>Das Drucksystem von kivitendo benutzt von Haus aus LaTeX-Vorlagen.
1930 Um drucken zu können, braucht der Server ein geeignetes LaTeX System. Am
1931 einfachsten ist dazu eine <literal>texlive</literal> Installation. Unter
1932 debianoiden Betriebssystemen installiert man die Pakete mit:</para>
1934 <para><programlisting>apt install texlive-base-bin texlive-latex-recommended texlive-fonts-recommended \
1935 texlive-latex-extra texlive-lang-german texlive-generic-extra texlive-xetex </programlisting></para>
1937 <para>Für Fedora benötigen Sie die folgenden Pakete:</para>
1939 <para><programlisting>dnf install texlive-collection-latex texlive-collection-latexextra \
1940 texlive-collection-latexrecommended texlive-collection-langgerman \
1941 texlive-collection-langenglish</programlisting></para>
1943 <para>Für openSUSE benötigen Sie die folgenden Pakete:</para>
1945 <para><programlisting>zypper install texlive-collection-latex texlive-collection-latexextra \
1946 texlive-collection-latexrecommended texlive-collection-langgerman \
1947 texlive-collection-langenglish</programlisting></para>
1949 <para>kivitendo bringt drei alternative Vorlagensätze mit:</para>
1961 <para>rev-odt</para>
1965 <para>Der ehemalige Druckvorlagensatz "Standard" wurde mit der Version
1966 3.3 entfernt, da er nicht mehr gepflegt wurde.</para>
1968 <sect2 id="Vorlagenverzeichnis-anlegen"
1969 xreflabel="Vorlagenverzeichnis anlegen">
1970 <title>Vorlagenverzeichnis anlegen</title>
1972 <para>Es lässt sich ein initialer Vorlagensatz erstellen. Die
1973 LaTeX-System-Abhängigkeiten hierfür kann man prüfen mit:</para>
1975 <programlisting>./scripts/installation_check.pl -lv</programlisting>
1977 <para>Der Angemeldete Benutzer muss in einer Gruppe sein, die über das
1978 Recht "Konfiguration -> Mandantenverwaltung" verfügt. Siehe auch
1979 <xref linkend="Gruppen-anlegen"/>.</para>
1981 <para>Im Userbereich lässt sich unter: "<guimenu>System</guimenu>
1982 -> <guisubmenu>Mandantenverwaltung</guisubmenu> ->
1983 <guimenuitem>Verschiedenes</guimenuitem>" die Option "Neue
1984 Druckvorlagen aus Vorlagensatz erstellen" auswählen.</para>
1988 <para><option>Vorlagen auswählen</option>: Wählen Sie hier den
1989 Vorlagensatz aus, der kopiert werden soll
1990 (<filename>RB</filename>, <filename>f-tex</filename> oder
1991 <filename>odt-rev</filename>.)</para>
1995 <para><option>Neuer Name</option>: Der Verzeichnisname für den
1996 neuen Vorlagensatz. Dieser kann im Rahmen der üblichen Bedingungen
1997 für Verzeichnisnamen frei gewählt werden.</para>
2001 <para>Nach dem Speichern wird das Vorlagenverzeichnis angelegt und ist
2002 für den aktuellen Mandanten ausgewählt. Der gleiche Vorlagensatz kann,
2003 wenn er mal angelegt ist, bei mehreren Mandanten verwendet werden.
2004 Eventuell müssen Anpassungen (Logo, Erscheinungsbild, etc) noch
2005 vorgenommen werden. Den Ordner findet man im Dateisystem unter
2006 <filename>./templates/[Neuer Name]</filename></para>
2009 <sect2 id="Vorlagen-RB">
2010 <title>Der Druckvorlagensatz RB</title>
2012 <para>Hierbei handelt es sich um einen vollständigen LaTeX
2013 Dokumentensatz mit alternativem Design. Die odt oder html-Varianten
2014 sind nicht gepflegt.</para>
2016 <para>Die konzeptionelle Idee der Vorlagen wird <ulink
2017 url="http://www.kivitendo-support.de/vortraege/Lx-Office%20Anwendertreffen%20LaTeX-Druckvorlagen-Teil3-finale.pdf">hier</ulink>
2018 auf Folie 5 bis 10 vorgestellt. Informationen zur Anpassung an die
2019 eigenen Firmendaten finden sich in der Datei Readme.tex im
2020 Vorlagenverzeichnis.</para>
2022 <para>Eine kurze Übersicht der Features:</para>
2026 <para>Mehrsprachenfähig, mit Deutscher und Englischer
2031 <para>Zentrale Konfigurationsdateien, die für alle Belege benutzt
2032 werden, z.B. für Kopf- und Fußzeilen, und Infos wie
2037 <para>mehrere vordefinierte Varianten für
2038 Logos/Hintergrundbilder</para>
2042 <para>Berücksichtigung für Steuerzonen "EU mit USt-ID Nummer" oder
2043 "Außerhalb EU"</para>
2049 <title>f-tex</title>
2051 <para>Ein Vorlagensatz, der in wenigen Minuten alle Dokumente zur
2052 Verfügung stellt.</para>
2054 <sect3 id="f-tex-Feature-Übersicht">
2055 <title>Feature-Übersicht</title>
2059 <para>Keine Redundanz. Es wird ein- und dieselbe LaTeX-Vorlage
2060 für alle briefartigen Dokumente verwendet. Also Angebot,
2061 Rechnung, Proformarechnung, Lieferschein, aber eben nicht für
2062 Paketaufkleber etc.</para>
2066 <para>Leichte Anpassung an das Firmen-Layout durch Verwendung
2067 eines Hintergrund-PDFs. Dieses kann leicht mit dem eigenen
2068 Lieblingsprogramm erstellt werden (Openoffice, Inkscape, Gimp,
2073 <para>Hintergrund-PDF umschaltbar auf "nur erste Seite"
2074 (Standard) oder "alle Seiten" (Option
2075 "<option>bgPdfFirstPageOnly</option>" in Datei
2076 <filename>letter.lco</filename>)</para>
2080 <para>Hintergrund-PDF für Ausdruck auf bereits bedrucktem
2081 Briefpapier abschaltbar. Es wird dann nur bei per E-Mail
2082 versendeten Dokumenten eingebunden (Option
2083 "<option>bgPdfEmailOnly</option>" in Datei
2084 <filename>letter.lco</filename>).</para>
2088 <para>Nutzung der Layout-Funktionen von LaTeX für Seitenumbruch,
2089 Wiederholung von Kopfzeilen, Zwischensummen etc. (danke an
2090 Kai-Martin Knaak für die Vorarbeit)</para>
2094 <para>Anzeige des Empfängerlandes im Adressfeld nur, wenn es vom
2095 Land des eigenen Unternehmens abweicht (also die Rechnung das
2096 Land verlässt).</para>
2100 <para>Multisprachfähig leicht um weitere Sprachen zu erweitern,
2101 alle Übersetzungen in der Datei
2102 <filename>translatinos.tex</filename>.</para>
2106 <para>Auflistung von Bruttopreisen für Endverbraucher.</para>
2111 <sect3 id="f-tex-Installation">
2112 <title>Die Installation</title>
2116 <para>Vorlagenverzeichnis mit Option f-tex anlegen, siehe: <xref
2117 linkend="Vorlagenverzeichnis-anlegen"/>. Das Vorlagensystem
2118 funktioniert jetzt schon, hat allerdings noch einen
2119 Beispiel-Briefkopf.</para>
2123 <para>Erstelle eine pdf-Hintergrund Datei und verlinke sie nach
2124 <filename>./letter_head.pdf</filename>.</para>
2128 <para>Editiere den Bereich "<option>settings</option>" in der
2129 datei <filename>letter.lco</filename>.</para>
2133 <para>oder etwas detaillierter:</para>
2135 <para>Es wird eine Datei <filename>sample.lco</filename> erstellt
2136 und diese nach <filename>letter.lco</filename> verlinkt. Eigentlich
2137 ist dies die Datei die für die firmenspezifischen Anpassungen
2138 gedacht ist. Da die Einstiegshürde in LaTeX nicht ganz niedrig ist,
2139 wird in dieser Datei auf ein Hintergrund-PDF verwiesen. Ich empfehle
2140 über dieses PDF die persönlichen Layoutanpassungen vorzunehmen und
2141 <filename>sample.lco</filename> unverändert zu lassen. Die Anpassung
2142 über eine <filename>*.lco</filename>-Datei, die letztlich auf
2143 <filename>letter.lco</filename> verlinkt ist ist aber auch
2146 <para>Es wird eine Datei <filename>sample_head.pdf</filename> mit
2147 ausgeliefert, diese wird nach <filename>letter_head.pdf</filename>
2148 verlinkt. Damit gibt es schon mal eine funktionsfähige Vorlage.
2149 Schau Dir nach Abschluss der Installation die Datei
2150 <filename>sample_head.pdf</filename> an und erstelle ein
2151 entsprechendes PDF passend zum Briefkopf Deiner Firma, diese dann im
2152 Template Verzeichniss ablegen und statt
2153 <filename>sample_head.pdf</filename> nach
2154 <filename>letter_head.pdf</filename> verlinken.</para>
2156 <para>Letzlich muss <filename>letter_head.pdf</filename> auf das
2157 passende Hintergrund-PDF verweisen, welches gewünschten Briefkopf
2160 <para>Es wird eine Datei <filename>mydata.tex.example</filename>
2161 ausgeliefert, die nach <filename>mytdata.tex</filename> verlinkt
2162 ist. Bei verwendetem Hintergrund-PDF wird nur der Eintrag für das
2163 Land verwendet. Die Datei muss also nicht angefasst werden. Die
2164 anderen Werte sind für das Modul 'lp' (Label Print in erp - zur Zeit
2165 nicht im öffentlichen Zweig).</para>
2167 <para>Alle Anpassungen zum Briefkopf, Fusszeilen, Firmenlogos, etc.
2168 sollten über die Hintergrund-PDF-Datei oder die
2169 <filename>*.lco</filename>-Datei erfolgen.</para>
2172 <sect3 id="f-tex-Funktionsübersicht">
2173 <title>f-tex Funktionsübersicht</title>
2175 <para>Das Konzept von kivitendo sieht vor, für jedes Dokument
2176 (Auftragsbestätigung, Lieferschein, Rechnung, etc.) eine
2177 LaTeX-Vorlage vorzuhalten, dies ist sehr wartungsunfreundlich. Auch
2178 das Einlesen einer einheitlichen Quelle für den Briefkopf bringt nur
2179 bedingte Vorteile, da hier leicht die Pflege der Artikel-Tabellen
2180 aus dem Ruder läuft. Bei dem vorliegenden Ansatz wird für alle
2181 briefartigen Dokumente mit Artikel-Tabellen eine einheitliche
2182 LaTeX-Vorlage verwendet, welche über Codeweichen die Besonderheiten
2183 der jeweiligen Dokumente berücksichtigt:</para>
2187 <para>Tabellen mit oder ohne Preis</para>
2191 <para>Sprache der Tabellenüberschriften etc.</para>
2195 <para>Anpassung der Bezugs-Zeile (z.B. Rechnungsnummer versus
2196 Angebotsnummer)</para>
2200 <para>Darstellung von Brutto oder Netto-Preisen in der
2201 Auflistung (Endverbraucher versus gewerblicher Kunde)</para>
2205 <para>Nachteil:</para>
2207 <para>LaTeX hat ohnehin eine sehr steile Lehrnkurve. Die Datei
2208 <filename>letter.tex</filename> ist sehr komplex und verstärkt damit
2209 diesen Effekt noch einmal erheblich. Wer LaTeX-Erfahrung hat, oder
2210 geübt ist Scriptsparachen nachzuvollziehen kann natürlich auch
2211 innerhalb der Tabellendarstellung gut persönliche Anpassungen
2212 vornehmen. Aber man kann sich hier bei Veränderungen sehr schnell
2213 heftig in den Fuss schiessen.</para>
2215 <para>Wer nicht so tief in die Materie einsteigen will oder leicht
2216 zu frustrieren ist, sollte sein Hintergrund-PDF auf Basis der
2217 mitglieferten Datei <filename>sample_head.pdf</filename> erstellen,
2218 und sich an der Form der dargestellten Tabellen, wie sie
2219 ausgeliefert werden, erfreuen.</para>
2221 <para>Kleiner Tipp: Nicht zu viel auf einmal wollen, lieber kleine,
2222 kontinuierliche Schritte gehen.</para>
2225 <sect3 id="f-tex-Bruttopreise">
2226 <title>Bruttopreise für Endverbraucher</title>
2228 <para>Der auszuweisende Bruttopreis wird innerhalb der
2229 LaTeX-Umgebung berechnet. Es gibt zwar ein Feld, um bei Aufträgen
2230 "alle Preise Brutto" auszuwählen, aber:</para>
2234 <para>hierfür müssen die Preise auch in Brutto in der Datenbank
2235 stehen (ja - das lässt sich über die Preisgruppen und die
2236 Zuordung einer Default-Preisgruppe handhaben)</para>
2240 <para>man darf beim Anlegen des Vorgangs nicht vergessen, dieses
2241 Häkchen zu setzen. (Das ist in der Praxis, wenn man sowohl
2242 Endverbraucher als auch Gewerbekunden beliefert, der eigentliche
2247 <para>Es gibt mit f-tex eine weitere Alternative. Die Information ob
2248 Brutto oder Nettorechnung wird mit den Zahlarten verknüpft.
2249 Zahlarten bei denen Rechnungen, Angebote, etc, in Brutto ausgegeben
2250 werden sollen, enden mit "_E" (für Endverbraucher). Falls identische
2251 Zahlarten für Gewerbekunden und Endverbraucher vorhanden sind, legt
2252 man diese einfach doppelt an (einmal mit der Namensendung "_E").
2257 <para>Die Entscheidung, ob Nettopreise ausgewiesen werden, ist
2258 nicht mehr fix mit einer Preisliste verbunden.</para>
2262 <para>Die Default-Zahlart kann im Kundendatensatz hinterlegt
2263 werden, und man muss nicht mehr daran denken, "alle Preise
2264 Netto" auszuwählen.</para>
2268 <para>Die Entscheidung, ob Netto- oder Bruttopreise ausgewiesen
2269 werden, kann direkt beim Drucken revidiert werden, ohne dass
2270 sich der Auftragswert ändert.</para>
2275 <sect3 id="f-tex-lieferadressen">
2276 <title>Lieferadressen</title>
2278 <para>In Lieferscheinen kommen <varname>shipto*</varname>-Variablen
2279 im Adressfeld zum Einsatz. Wenn die
2280 <varname>shipto*</varname>-Variable leer ist, wird die entsprechende
2281 Adressvariable eingesetzt. Wenn also die Lieferadresse in Straße,
2282 Hausnummer und Ort abweicht, müssen auch nur diese Felder in der
2283 Lieferadresse ausgefüllt werden. Für den Firmenname wird der Wert
2284 der Hauptadresse angezeigt.</para>
2288 <sect2 id="Vorlagen-rev-odt">
2289 <title>Der Druckvorlagensatz rev-odt</title>
2291 <para>Hierbei handelt es sich um einen Dokumentensatz der mit
2292 odt-Vorlagen erstellt wurde. Es gibt in dem Verzeichnis eine
2293 Readme-Datei, die eventuell aktueller als die Dokumentation hier ist.
2294 Die odt-Vorlagen in diesem Verzeichnis "rev-odt" wurden von revamp-it,
2295 Zürich erstellt und werden laufend aktualisiert. Ein paar der
2296 Formulierungen in den Druckvorlagen entsprechen dem Schweizer
2297 Sprachgebrauch, z.B. "Offerte" oder "allfällig".</para>
2299 <para>Hinweis zum Einsatz des Feldes "Land" bei den Stammdaten für
2300 KundInnen und LieferantInnen, sowie bei Lieferadressen: Die in diesem
2301 Vorlagensatz vorhandenen Vorlagen erwarten für "Land" das
2302 entsprechende Kürzel, das in Adressen vor die Postleitzahl gesetzt
2303 wird. Das Feld kann auch komplett leer bleiben. Wer dies anders
2304 handhaben möchte, muss die Vorlagen entsprechend anpassen.</para>
2306 <para>odt-Vorlagen können mit LibreOffice oder OpenOffice editiert und
2307 den eigenen Bedürfnissen angepasst werden. Wichtig beim Editieren von
2308 if-Blöcken ist, dass immer der gesamte Block überschrieben werden muss
2309 und nicht nur Teile davon, da dies sonst oft zu einer odt-Datei führt,
2310 die vom Parser nicht korrekt gelesen werden kann.</para>
2312 <para>Mahnungen können unter folgenden Einschränkungen mit den
2313 odt-Vorlagen im Vorlagensatz rev-odt erzeugt werden:</para>
2317 <para>als Druckoption steht nur 'PDF(OpenDocument/OASIS)' zur
2318 Verfügung, das heisst, die Mahnungen werden als PDF-Datei
2323 <para>für jede Rechnung muss eine eigene Mahnung erzeugt werden
2324 (auch wenn bei einzelnen KundInnen mehrere überfällige Rechnungen
2325 vorhanden sind).</para>
2329 <para>Mehrere Mahnungen für eine Kundin / einen Kunden werden zu einer
2330 PDF-Datei zusammengefasst</para>
2332 <para>Die Vorlagen zahlungserinnerung.odt sowie mahnung.odt sind für
2333 das Erstellen einer Zahlungserinnerung bzw. Mahnung selbst vorgesehen,
2334 die Vorlage mahnung_invoice.odt für das Erstellen einer Rechnung über
2335 die verrechneten Mahngebühren und Verzugszinsen.</para>
2337 <para>Zur Zeit gibt es in kivitendo noch keine Möglichkeit,
2338 odt-Vorlagen bei Briefen und Pflichtenheften einzusetzen.
2339 Entsprechende Vorlagen sind deshalb nicht vorhanden.</para>
2341 <para>Fehlermeldungen, Anregungen und Wünsche bitte senden an:
2342 empfang@revamp-it.ch</para>
2345 <sect2 id="allgemeine-hinweise-zu-latex">
2346 <title>Allgemeine Hinweise zu LaTeX Vorlagen</title>
2348 <para>In den allermeisten Installationen sollte das Drucken jetzt
2349 schon funktionieren. Sollte ein Fehler auftreten, wirft TeX sehr lange
2350 Fehlerbeschreibungen, der eigentliche Fehler ist immer die erste
2351 Zeile, die mit einem Ausrufezeichen anfängt. Häufig auftretende Fehler
2352 sind zum Beispiel:</para>
2356 <para>! LaTeX Error: File `eurosym.sty' not found. Die
2357 entsprechende LaTeX-Bibliothek wurde nicht gefunden. Das tritt vor
2358 allem bei Vorlagen aus der Community auf. Installieren Sie die
2359 entsprechenden Pakete.</para>
2363 <para>! Package inputenc Error: Unicode char \u8:... set up for
2364 use with LaTeX. Dieser Fehler tritt auf, wenn sie versuchen mit
2365 einer Standardinstallation exotische utf8 Zeichen zu drucken.
2366 TeXLive unterstützt von Haus nur romanische Schriften und muss mit
2367 diversen Tricks dazu gebracht werden andere Zeichen zu
2368 akzeptieren. Adere TeX Systeme wie XeTeX schaffen hier
2373 <para>Wird gar kein Fehler angezeigt, sondern nur der Name des
2374 Templates, heißt das normalerweise, dass das LaTeX Binary nicht
2375 gefunden wurde. Prüfen Sie den Namen in der Konfiguration (Standard:
2376 <literal>pdflatex</literal>), und stellen Sie sicher, dass pdflatex
2377 (oder das von Ihnen verwendete System) vom Webserver ausgeführt werden
2380 <para>Wenn sich das Problem nicht auf Grund der Ausgabe im Webbrowser
2381 verifizieren lässt:</para>
2385 <para>editiere [kivitendo-home]/config/kivitendo.conf und ändere
2386 "keep_temp_files" auf 1</para>
2388 <para><programlisting>keep_temp_files = 1;</programlisting></para>
2392 <para>bei fastcgi oder mod_perl den Webserver neu Starten</para>
2396 <para>Nochmal einen Druckversuch im Webfrontend auslösen</para>
2400 <para>wechsel in das users Verzeichnis von kivitendo</para>
2402 <para><programlisting>cd [kivitendo-home]/users</programlisting></para>
2406 <para>LaTeX Suchpfad anpassen:</para>
2408 <para><programlisting>export TEXINPUTS=".:[kivitendo-home]/templates/[aktuelles_template_verzeichniss]:"</programlisting></para>
2412 <para>Finde heraus, welche Datei kivitendo beim letzten Durchlauf
2415 <para><programlisting>ls -lahtr ./1*.tex</programlisting></para>
2417 <para>Es sollte die letzte Datei ganz unten sein</para>
2421 <para>für besseren Hinweis auf Fehler texdatei nochmals
2424 <para><programlisting>pdflatex ./1*.tex</programlisting></para>
2426 <para>in der *.tex datei nach dem Fehler suchen.</para>
2432 <sect1 id="OpenDocument-Vorlagen">
2433 <title>OpenDocument-Vorlagen</title>
2435 <para>kivitendo unterstützt die Verwendung von Vorlagen im
2436 OpenDocument-Format, wie es LibreOffice oder OpenOffice (ab Version 2)
2437 erzeugen. kivitendo kann dabei sowohl neue OpenDocument-Dokumente als
2438 auch aus diesen direkt PDF-Dateien erzeugen. Um die Unterstützung von
2439 OpenDocument-Vorlagen zu aktivieren muss in der Datei
2440 <filename>config/kivitendo.conf</filename> die Variable
2441 <literal>opendocument</literal> im Abschnitt
2442 <literal>print_templates</literal> auf ‘<literal>1</literal>’ stehen.
2443 Dieses ist die Standardeinstellung.</para>
2445 <para>Während die Erzeugung von reinen OpenDocument-Dateien keinerlei
2446 weitere Software benötigt, wird zur Umwandlung dieser Dateien in PDF
2447 LibreOffice oder OpenOffice benötigt. Soll dieses Feature genutzt
2448 werden, so muss neben LibreOffice oder OpenOffice auch der “X virtual
2449 frame buffer” (xvfb) installiert werden. Bei Debian ist er im Paket
2450 “xvfb” enthalten. Andere Distributionen enthalten ihn in anderen
2453 <para>Nach der Installation müssen in der Datei
2454 <filename>config/kivitendo.conf</filename> im Abschnitt
2455 <literal>applications</literal> zwei weitere Variablen angepasst
2458 <para><literal>openofficeorg_writer</literal> muss den vollständigen
2459 Pfad zu LibreOffice oder OpenOffice enthalten. Dabei dürfen keine
2460 Anführungszeichen eingesetzt werden.</para>
2462 <para>Beispiel für Debian oder Ubuntu:</para>
2464 <programlisting>openofficeorg_writer = /usr/bin/libreoffice</programlisting>
2466 <para><literal>xvfb</literal> muss den Pfad zum “X virtual frame buffer”
2469 <para>Zusätzlich gibt es zwei verschiedene Arten, wie kivitendo mit
2470 LibreOffice bzw. OpenOffice kommuniziert. Die erste Variante, die
2471 benutzt wird, wenn die Variable <literal>$openofficeorg_daemon</literal>
2472 gesetzt ist, startet ein LibreOffice oder OpenOffice, das auch nach der
2473 Umwandlung des Dokumentes gestartet bleibt. Bei weiteren Umwandlungen
2474 wird dann diese laufende Instanz benutzt. Der Vorteil ist, dass die Zeit
2475 zur Umwandlung deutlich reduziert wird, weil nicht für jedes Dokument
2476 ein LibreOffice bzw. OpenOffice gestartet werden muss. Der Nachteil ist,
2477 dass diese Methode Python und die Python-UNO-Bindings benötigt, die
2478 Bestandteil von LibreOffice bzw. OpenOffice sind.</para>
2481 <para>Für die Verbindung zu LibreOffice bzw. OpenOffice wird
2482 normalerweise der Python-Interpreter
2483 <filename>/usr/bin/python</filename> benutzt. Sollte dies nicht der
2484 richtige sein, so kann man mit zwei Konfigurationsvariablen
2485 entscheiden, welcher Python-Interpreter genutzt wird. Mit der Option
2486 <literal>python_uno</literal> aus dem Abschnitt
2487 <literal>applications</literal> wird der Interpreter selber
2488 festgelegt; sie steht standardmäßig auf dem eben erwähnten Wert
2489 <literal>/usr/bin/python</literal>.</para>
2491 <para>Zusätzlich ist es möglich, Pfade anzugeben, in denen Python
2492 neben seinen normalen Suchpfaden ebenfalls nach Modulen gesucht wird,
2493 z.B. falls sich diese in einem gesonderten LibreOffice- bzw.
2494 OpenOffice-Verzeichnis befinden. Diese zweite Variable heißt
2495 <literal>python_uno_path</literal> und befindet sich im Abschnitt
2496 <literal>environment</literal>. Sie ist standardmäßig leer. Werden
2497 hier mehrere Pfade angegeben, so müssen diese durch Doppelpunkte
2498 voneinander getrennt werden. Der Inhalt wird an den Python-Interpreter
2499 über die Umgebungsvariable <literal>PYTHONPATH</literal>
2503 <para>Ist <literal>$openofficeorg_daemon</literal> nicht gesetzt, so
2504 wird für jedes Dokument LibreOffice bzw. OpenOffice neu gestartet und
2505 die Konvertierung mit Hilfe eines Makros durchgeführt. Dieses Makro muss
2506 in der Dokumentenvorlage enthalten sein und
2507 “Standard.Conversion.ConvertSelfToPDF()” heißen. Die Beispielvorlage
2508 ‘<literal>templates/print/rev-odt/invoice.odt</literal>’ enthält ein
2509 solches Makro, das in jeder anderen Dokumentenvorlage ebenfalls
2510 enthalten sein muss.</para>
2512 <para>Als letztes muss herausgefunden werden, welchen Namen OpenOffice
2513 bzw. LibreOffice dem Verzeichnis mit den Benutzereinstellungen gibt.
2514 Unter Debian ist dies momentan <literal>~/.config/libreoffice</literal>.
2515 kivitendo verwendet das Verzeichnis
2516 <literal>users/.openoffice.org2</literal>. Eventuell muss dieses
2517 Verzeichnis umbenannt werden.</para>
2519 <para>Dieses Verzeichnis, wie auch das komplette
2520 <literal>users</literal>-Verzeichnis, muss vom Webserver beschreibbar
2521 sein. Dieses wurde bereits erledigt (siehe <xref
2522 linkend="Manuelle-Installation-des-Programmpaketes"/>), kann aber erneut
2523 überprüft werden, wenn die Konvertierung nach PDF fehlschlägt.</para>
2526 <title>OpenDocument (odt) Druckvorlagen mit Makros</title>
2528 <para>OpenDocument Vorlagen können Makros enthalten, welche komplexere
2529 Aufgaben erfüllen.</para>
2531 <para>Der Vorlagensatz "rev-odt" enthält solche Vorlagen mit <emphasis
2532 role="bold">Schweizer Bank-Einzahlungsscheinen (BESR)</emphasis>.
2533 Diese Makros haben die Aufgabe, die in den Einzahlungsscheinen
2534 benötigte Referenznummer und Kodierzeile zu erzeugen. Hier eine kurze
2535 Beschreibung, wie die Makros aufgebaut sind, und was bei ihrer Nutzung
2536 zu beachten ist (<emphasis role="bold">in fett sind nötige einmalige
2537 Anpassungen aufgeführt</emphasis>):</para>
2540 <title>Bezeichnung der Vorlagen</title>
2542 <para>Rechnung: invoice_besr.odt, Auftrag:
2543 sales_order_besr.odt</para>
2547 <title>Vorbereitungen im Adminbereich</title>
2549 <para>Damit beim Erstellen von Rechnungen und Aufträgen neben der
2550 Standardvorlage ohne Einzahlungsschein weitere Vorlagen (z.B. mit
2551 Einzahlungsschein) auswählbar sind, muss für jedes Vorlagen-Suffix
2552 ein Drucker eingerichtet werden:</para>
2556 <para>Druckeradministration → Drucker hinzufügen</para>
2560 <para>Mandant wählen</para>
2564 <para>Druckerbeschreibung → aussagekräftiger Text: wird in der
2565 Auftrags- bzw. Rechnungsmaske als Auswahl angezeigt (z.B. mit
2566 Einzahlungsschein Bank xy)</para>
2570 <para>Druckbefehl → beliebiger Text (hat für das Erzeugen von
2571 Aufträgen oder Rechnungen als odt-Datei keine Bedeutung, darf
2572 aber nicht leer sein)</para>
2576 <para>Vorlagenkürzel → besr bzw. selbst gewähltes Vorlagensuffix
2577 (muss genau der Zeichenfolge entsprechen, die zwischen
2578 "invoice_" bzw. "sales_order_" und ".odt" steht.)</para>
2582 <para>speichern</para>
2588 <title>Benutzereinstellungen</title>
2590 <para>Wer den Ausdruck mit Einzahlungsschein als Standardeinstellung
2591 im Rechnungs- bzw. Auftragsformular angezeigt haben möchte, kann
2592 dies persönlich für sich bei den Benutzereinstellungen
2593 konfigurieren:</para>
2597 <para>Programm → Benutzereinstellungen → Druckoptionen</para>
2601 <para>Standardvorlagenformat → OpenDocument/OASIS</para>
2605 <para>Standardausgabekanal → Bildschirm</para>
2609 <para>Standarddrucker → gewünschte Druckerbeschreibung auswählen
2610 (z.B. mit Einzahlungsschein Bank xy)</para>
2614 <para>Anzahl Kopien → leer</para>
2618 <para>speichern</para>
2624 <title>Aufbau und nötige Anpassungen der Vorlagen</title>
2626 <para>In der Vorlage sind als Modul "BESR" 4 Makros gespeichert, die
2627 aus dem von kivitendo erzeugten odt-Dokument die korrekte
2628 Referenznummer inklusive Prüfziffer sowie die Kodierzeile in
2629 OCRB-Schrift erzeugen und am richtigen Ort ins Dokument
2634 <para>Für den Einzahlungsschein ist die letzte Seite des
2635 Dokuments reserviert</para>
2639 <para>Direkt über dem Einzahlungsschein enthält die Vorlage eine
2640 Zeile mit folgenden Angaben (<emphasis
2641 role="bold">Bank-Konto-Identifikationsnummer und
2642 Postkonto-Nummer der Bank müssen gemäss Angaben der jeweiligen
2643 Bank angepasst werden</emphasis>):<itemizedlist>
2645 <para>DDDREF: 4 Werte zum Bilden der Referenznummer
2646 (jeweils durch einen Leerschlag getrennt): <itemizedlist>
2648 <para>erster Wert: <emphasis
2649 role="bold">Bank-Konto-Identifikation</emphasis>
2650 (nur Ziffern, maximal 6), <emphasis role="bold">muss
2651 angepasst werden</emphasis>.</para>
2655 <para>zweiter Wert: <%customernumber%>
2656 (Kundennummer: nur Ziffern, maximal 6)</para>
2660 <para>dritter Wert: <%ordnumber%>
2661 (Auftragsnummer bei Auftragsvorlage
2662 sales_oder_besr.odt, sonst 0) maximal 7 Ziffern,
2663 führende Buchstaben werden vom Makro entfernt</para>
2667 <para>vierter Wert: <%invnumber%>
2668 (Rechnungsnummer bei Rechnungsvorlage
2669 invoice_besr.odt, sonst 0) maximal 7 Ziffern,
2670 führende Buchstaben werden vom Makro entfernt</para>
2672 </itemizedlist></para>
2676 <para>DDDKONTO: <emphasis role="bold">Postkonto-Nummer der
2677 Bank, muss angepasst werden</emphasis>.</para>
2681 <para>DDDBETRAG: <%total%> Einzahlungsbetrag oder 0,
2682 falls Einzahlungsschein ohne Betrag</para>
2686 <para>DDDEND: muss am Ende der Zeile vorhanden sein</para>
2688 </itemizedlist></para>
2692 <para><emphasis role="bold">Im Einzahlungsschein selbst müssen
2693 der Name und die Adresse der Bank, die Postkonto-Nummer der
2694 Bank, sowie der eigene Firmenname und die Firmenadresse
2695 angepasst werden.</emphasis> Dabei ist darauf zu achten, dass
2696 sich die Positionen der Postkonto-Nummern der Bank, sowie der
2697 Zeichenfolgen dddfr, DDDREF1, DDDREF2, 609, DDDKODIERZEILE nicht
2703 <screeninfo>Rechnungsvorlage Schweizer Bank-Einzahlungsschein - zu
2704 ändernde Einträge in rot</screeninfo>
2708 <imagedata fileref="images/Einzahlungsschein_Makro.png"/>
2715 <title>Auswahl der Druckvorlage in kivitendo beim Erzeugen einer
2716 odt-Rechnung (analog bei Auftrag)</title>
2718 <para>Im Fussbereich der Rechnungsmaske muss neben Rechnung,
2719 OpenDocument/OASIS und Bildschirm die im Adminbereich erstellte
2720 Druckerbeschreibung ausgewählt werden, falls diese nicht bereits bei
2721 den Benutzereinstellungen als persönlicher Standard gewählt
2726 <title>Makroeinstellungen in LibreOffice anpassen</title>
2728 <para>Falls beim Öffnen einer von kivitendo erzeugten odt-Rechnung
2729 die Meldung kommt, dass Makros aus Sicherheitsgründen nicht
2730 ausgeführt werden, so müssen folgende Einstellungen in LibreOffice
2731 angepasst werden:</para>
2735 <para>Extras → Optionen → Sicherheit → Makrosicherheit</para>
2739 <para>Sicherheitslevel auf "Mittel" einstellen (Diese
2740 Einstellung muss auf jedem Computer durchgeführt werden, mit dem
2741 von kivitendo erzeugte odt-Rechnungen oder Aufträge geöffnet
2746 <para>Beim Öffnen einer odt-Rechnung oder eines odt-Auftrags bei
2747 der entsprechenden Nachfrage "Makros ausführen"
2750 <para><emphasis role="bold">Wichtig</emphasis>: die Makros sind
2751 so eingestellt, dass sie beim Öffnen der Vorlagen selbst nicht
2752 ausgeführt werden. Das heisst für das Ansehen und Bearbeiten der
2753 Vorlagen sind keine speziellen Einstellungen in LibreOffice
2761 <sect1 id="nomenclature">
2762 <title>Nomenklatur</title>
2764 <sect2 id="booking.dates">
2765 <title>Datum bei Buchungen</title>
2767 <para>Seit der Version 3.5 werden für Buchungen in kivitendo
2768 einheitlich folgende Bezeichnungen verwendet:</para>
2772 <para><option>Erfassungsdatum</option> (en: <option>Entry
2773 Date</option>, code: <option>Gldate</option>)</para>
2775 <para>bezeichnet das Datum, an dem die Buchung in kivitendo
2776 erfasst wurde.</para>
2780 <para><option>Buchungsdatum</option> (en: <option>Booking
2781 Date</option>, code: <option>Transdate</option>)</para>
2783 <para>bezeichnet das buchhaltungstechnisch für eine Buchung
2784 relevante Datum</para>
2786 <para>Das <option>Rechnungsdatum</option> bei Verkaufs- und
2787 Einkaufsrechnungen entspricht dem Buchungsdatum. Das heisst, in
2788 Berichten wie dem Buchungsjournal, in denen eine Spalte
2789 <option>Buchungsdatum</option> angezeigt werden kann, erscheint
2790 hier im Fall von Rechnungen das Rechnungsdatum.</para>
2794 <para>Bezieht sich ein verbuchter Beleg auf einen Zeitpunkt, der
2795 nicht mit dem Buchungsdatum übereinstimmt, so kann dieses Datum
2796 momentan in kivitendo nur unter Bemerkungen erfasst werden.</para>
2798 <para>Möglicherweise wird für solche Fälle in einer späteren
2799 Version von kivitendo ein dritter Datumswert für Buchungen
2800 erstellt. (Beispiel: Einkaufsbeleg stammt aus einem früheren Jahr,
2801 das bereits buchhaltungstechnisch abgeschlossen wurde, und muss
2802 deshalb später verbucht werden.)</para>
2808 <sect1 id="config.eur">
2809 <title>Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung:
2812 <sect2 id="config.eur.introduction"
2813 xreflabel="Einführung in die Konfiguration zur EUR">
2814 <title>Einführung</title>
2816 <para>kivitendo besaß bis inklusive Version 2.6.3 einen
2817 Konfigurationsparameter namens <varname>eur</varname>, der sich in der
2818 Konfigurationsdatei <filename>config/kivitendo.conf</filename> (damals
2819 noch <filename>config/lx_office.conf</filename>) befand. Somit galt er
2820 für alle Mandanten, die in dieser Installation benutzt wurden.</para>
2822 <para>Mit der nachfolgenden Version wurde der Parameter zum Einen in
2823 die Mandantendatenbank verschoben und dabei auch gleich in drei
2824 Einzelparameter aufgeteilt, mit denen sich das Verhalten genauer
2825 steuern lässt.</para>
2828 <sect2 id="config.eur.parameters"
2829 xreflabel="Konfigurationsparameter für EUR">
2830 <title>Konfigurationsparameter</title>
2832 <para>Es gibt drei Parameter, die die Gewinnermittlungsart,
2833 Versteuerungsart und die Warenbuchungsmethode regeln:</para>
2837 <term><varname>profit_determination</varname></term>
2840 <para>Dieser Parameter legt die Berechnungsmethode für die
2841 Gewinnermittlung fest. Er enthält entweder
2842 <literal>balance</literal> für
2843 Betriebsvermögensvergleich/Bilanzierung oder
2844 <literal>income</literal> für die
2845 Einnahmen-Überschuss-Rechnung.</para>
2850 <term><varname>accounting_method</varname></term>
2853 <para>Dieser Parameter steuert die Buchungs- und
2854 Berechnungsmethoden für die Versteuerungsart. Er enthält
2855 entweder <literal>accrual</literal> für die Soll-Versteuerung
2856 oder <literal>cash</literal> für die Ist-Versteuerung.</para>
2861 <term><varname>inventory_system</varname></term>
2864 <para>Dieser Parameter legt die Warenbuchungsmethode fest. Er
2865 enthält entweder <literal>perpetual</literal> für die
2866 Bestandsmethode oder <literal>periodic</literal> für die
2867 Aufwandsmethode.</para>
2872 <para>Zum Vergleich der Funktionalität bis und nach 2.6.3:
2873 <varname>eur</varname> = 1 bedeutete Einnahmen-Überschuss-Rechnung,
2874 Ist-Versteuerung und Aufwandsmethode. <varname>eur</varname> = 0
2875 bedeutete hingegen Bilanzierung, Soll-Versteuerung und
2876 Bestandsmethode.</para>
2878 <para>Die Konfiguration "<varname>eur</varname>" unter
2879 <varname>[system]</varname> in der <link
2880 linkend="config.config-file">Konfigurationsdatei</link>
2881 <filename>config/kivitendo.conf</filename> wird nun nicht mehr
2882 benötigt und kann entfernt werden. Dies muss manuell geschehen.</para>
2885 <sect2 id="config.eur.setting-parameters">
2886 <title>Festlegen der Parameter</title>
2888 <para>Beim Anlegen eines neuen Mandanten bzw. einer neuen Datenbank in
2889 der Admininstration können diese Optionen nun unabhängig voneinander
2890 eingestellt werden.</para>
2892 <para>Für die Schweiz sind folgende Einstellungen üblich:
2895 <para>Sollversteuerung</para>
2899 <para>Aufwandsmethode</para>
2903 <para>Bilanzierung</para>
2905 </itemizedlist> Diese Einstellungen werden automatisch beim
2906 Erstellen einer neuen Datenbank vorausgewählt, wenn in
2907 <filename>config/kivitendo.conf</filename> unter
2908 <varname>[system]</varname> <literal>default_manager = swiss</literal>
2909 eingestellt ist.</para>
2911 <para>Beim Upgrade bestehender Mandanten wird eur ausgelesen und die
2912 Variablen werden so gesetzt, daß sich an der Funktionalität nichts
2915 <para>Die aktuelle Konfiguration wird unter Nummernkreise und
2916 Standardkonten unter dem neuen Punkt "Einstellungen" (read-only)
2917 angezeigt. Unter <guimenu>System</guimenu> →
2918 <guisubmenu>Mandantenkonfiguration</guisubmenu> können die
2919 Einstellungen auch geändert werden. Dabei ist zu beachten, dass eine
2920 Änderung vorhandene Daten so belässt und damit evtl. die Ergebnisse
2921 verfälscht. Dies gilt vor Allem für die Warenbuchungsmethode (siehe
2922 auch <link linkend="config.eur.inventory-system-perpetual">
2923 Bemerkungen zur Bestandsmethode</link>).</para>
2926 <sect2 id="config.eur.inventory-system-perpetual">
2927 <title>Bemerkungen zur Bestandsmethode</title>
2929 <para>Die Bestandsmethode ist eigentlich eine sehr elegante Methode,
2930 funktioniert in kivitendo aber nur unter bestimmten Bedingungen:
2931 Voraussetzung ist, daß auch immer alle Einkaufsrechnungen gepflegt
2932 werden, und man beim Jahreswechsel nicht mit einer leeren Datenbank
2933 anfängt, da bei jedem Verkauf anhand der gesamten Rechnungshistorie
2934 der Einkaufswert der Ware nach dem FIFO-Prinzip aus den
2935 Einkaufsrechnungen berechnet wird.</para>
2937 <para>Die Bestandsmethode kann vom Prinzip her also nur funktioneren,
2938 wenn man mit den Buchungen bei Null anfängt, und man kann auch nicht
2939 im laufenden Betrieb von der Aufwandsmethode zur Bestandsmethode
2943 <sect2 id="config.eur.knonw-issues">
2944 <title>Bekannte Probleme</title>
2946 <para>Bei bestimmten Berichten kann man derzeit noch inviduell
2947 einstellen, ob man nach Ist- oder Sollversteuerung auswertet, und es
2948 werden im Code Variablen wie $accrual oder $cash gesetzt. Diese
2949 Codestellen wurden noch nicht angepasst, sondern nur die, wo bisher
2950 die Konfigurationsvariable
2951 <varname>$::lx_office_conf{system}->{eur}</varname> ausgewertet
2954 <para>Es fehlen Hilfetext beim Neuanlegen eines Mandanten, was die
2955 Optionen bewirken, z.B. mit zwei Standardfällen.</para>
2959 <sect1 id="config.skr04-update-3804">
2960 <title>SKR04 19% Umstellung für innergemeinschaftlichen Erwerb</title>
2962 <sect2 id="config.skr04-update-3804.introduction">
2963 <title>Einführung</title>
2965 <para>Die Umsatzsteuerumstellung auf 19% für SKR04 für die
2966 Steuerschlüssel "EU ohne USt-ID Nummer" ist erst 2010 erfolgt.
2967 kivitendo beinhaltet ein Upgradeskript, das das Konto 3804 automatisch
2968 erstellt und die Steuereinstellungen korrekt einstellt. Hat der
2969 Benutzer aber schon selber das Konto 3804 angelegt, oder gab es schon
2970 Buchungen im Zeitraum nach dem 01.01.2007 auf das Konto 3803, wird das
2971 Upgradeskript vorsichtshalber nicht ausgeführt, da der Benutzer sich
2972 vielleicht schon selbst geholfen hat und mit seinen Änderungen
2973 zufrieden ist. Die korrekten Einstellungen kann man aber auch per Hand
2974 ausführen. Nachfolgend werden die entsprechenden Schritte anhand von
2975 Screenshots dargestellt.</para>
2977 <para>Für den Fall, daß Buchungen mit der Steuerschlüssel "EU ohne
2978 USt.-IdNr." nach dem 01.01.2007 erfolgt sind, ist davon auszugehen,
2979 dass diese mit dem alten Umsatzsteuersatz von 16% gebucht worden sind,
2980 und diese Buchungen sollten entsprechend kontrolliert werden.</para>
2983 <sect2 id="config.skr04-update-3804.create-chart">
2984 <title>Konto 3804 manuell anlegen</title>
2986 <para>Die folgenden Schritte sind notwendig, um das Konto manuell
2987 anzulegen und zu konfigurieren. Zuerst wird in
2988 <guimenu>System</guimenu> → <guisubmenu>Kontenübersicht</guisubmenu> →
2989 <guimenuitem>Konto erfassen</guimenuitem> das Konto angelegt.</para>
2992 <screeninfo>Konto 3804 erfassen</screeninfo>
2996 <imagedata fileref="images/skr04-update-3804/konto3804.png"/>
3001 <para>Als Zweites muss Steuergruppe 13 für Konto 3803 angepasst
3002 werden. Dazu unter <guimenu>System</guimenu> →
3003 <guisubmenu>Steuern</guisubmenu> →
3004 <guimenuitem>Bearbeiten</guimenuitem> den Eintrag mit Steuerschlüssel
3005 13 auswählen und ihn wie im folgenden Screenshot angezeigt
3009 <screeninfo>Steuerschlüssel 13 für 3803 (16%) anpassen</screeninfo>
3013 <imagedata fileref="images/skr04-update-3804/steuer3803.png"/>
3018 <para>Als Drittes wird ein neuer Eintrag mit Steuerschlüssel 13 für
3019 Konto 3804 (19%) angelegt. Dazu unter <guimenu>System</guimenu> →
3020 <guisubmenu>Steuern</guisubmenu> → <guimenuitem>Erfassen</guimenuitem>
3021 auswählen und die Werte aus dem Screenshot übernehmen.</para>
3024 <screeninfo>Steuerschlüssel 13 für 3804 (19%) anlegen</screeninfo>
3028 <imagedata fileref="images/skr04-update-3804/steuer3804.png"/>
3033 <para>Als Nächstes sind alle Konten anzupassen, die als
3034 Steuerautomatikkonto die 3803 haben, sodass sie ab dem 1.1.2007 auch
3035 Steuerautomatik auf 3804 bekommen. Dies betrifft in der
3036 Standardkonfiguration die Konten 4315 und 4726. Als Beispiel für 4315
3037 müssen Sie dazu unter <guimenu>System</guimenu> →
3038 <guisubmenu>Kontenübersicht</guisubmenu> → <guimenuitem>Konten
3039 anzeigen</guimenuitem> das Konto 4315 anklicken und die Einstellungen
3040 wie im Screenshot gezeigt vornehmen.</para>
3043 <screeninfo>Konto 4315 anpassen</screeninfo>
3047 <imagedata fileref="images/skr04-update-3804/konto4315.png"/>
3052 <para>Als Letztes sollte die Steuerliste unter
3053 <guimenu>System</guimenu> → <guisubmenu>Steuern</guisubmenu> →
3054 <guimenuitem>Bearbeiten</guimenuitem> kontrolliert werden. Zum
3055 Vergleich der Screenshot.</para>
3058 <screeninfo>Steuerliste vergleichen</screeninfo>
3062 <imagedata fileref="images/skr04-update-3804/steuerliste.png"/>
3069 <sect1 id="config.bilanz">
3070 <title>Verhalten des Bilanzberichts</title>
3072 <para>Bis Version 3.0 wurde "closedto" ("Bücher schließen zum") als
3073 Grundlage für das Startdatum benutzt. Schließt man die Bücher allerdings
3074 monatsweise führt dies zu falschen Werten.</para>
3076 <para>In der Mandantenkonfiguration kann man dieses Verhalten genau
3077 einstellen indem man:</para>
3081 <para>weiterhin closed_to benutzt (Default, es ändert sich nichts zu
3086 <para>immer den Jahresanfang nimmt (1.1. relativ zum
3091 <para>immer die letzte Eröffnungsbuchung als Startdatum nimmt</para>
3093 <para>- mit Jahresanfang als Alternative wenn es keine EB-Buchungen
3096 <para>- oder mit "alle Buchungen" als Alternative"</para>
3100 <para>mit Jahresanfang als Alternative wenn es keine EB-Buchungen
3105 <para>immer alle Buchungen seit Beginn der Datenbank nimmt</para>
3109 <para>Folgende Hinweise zu den Optionen: Das "Bücher schließen Datum"
3110 ist sinnvoll, wenn man nur komplette Jahre schließt. Bei Wirtschaftsjahr
3111 = Kalendarjahr entspricht dies aber auch dem Jahresanfang. "Alle
3112 Buchungen" kann z.B. sinnvoll sein wenn man ohne Jahresabschluß
3113 durchbucht. Eröffnungsbuchung mit "alle Buchungen" als Fallback ist z.B.
3114 sinnvoll, wenn man am sich Anfang des zweiten Buchungsjahres befindet,
3115 und noch keinen Jahreswechsel und auch noch keine EB-Buchungen hat. Bei
3116 den Optionen mit EB-Buchungen wird vorausgesetzt, daß diese immer am 1.
3117 Tag des Wirtschaftsjahres gebucht werden. Zur Sicherheit wird das
3118 Startdatum im Bilanzbericht jetzt zusätzlich zum Stichtag mit angezeigt.
3119 Das hilft auch bei der Kontrolle für den Abgleich mit der GuV bzw.
3120 Erfolgsrechnung.</para>
3123 <sect1 id="config.erfolgsrechnung">
3124 <title>Erfolgsrechnung</title>
3126 <para>Seit der Version 3.4.1 existiert in kivitendo der Bericht
3127 <emphasis role="bold"> Erfolgsrechnung</emphasis>.</para>
3129 <para>Die Erfolgsrechnung kann in der Mandantenkonfiguration unter
3130 Features an- oder abgeschaltet werden. Mit der Einstellung
3131 <varname>default_manager = swiss </varname> in der
3132 <filename>config/kivitendo.conf</filename> wird beim neu Erstellen einer
3133 Datenbank automatisch die Anzeige der Erfolgsrechnung im Menü
3134 <guimenu>Berichte </guimenu> ausgewählt und ersetzt dort die GUV.</para>
3136 <para>Im Gegensatz zur GUV werden bei der Erfolgsrechnung sämtliche
3137 Aufwands- und Erlöskonten einzeln aufgelistet (analog zur Bilanz),
3138 sortiert nach ERTRAG und AUFWAND.</para>
3140 <para>Bei den Konteneinstellungen muss bei jedem Konto, das in der
3141 Erfolgsrechnung erscheinen soll, unter <varname>Sonstige
3142 Einstellungen/Erfolgsrechnung</varname> entweder
3143 <literal>01.Ertrag</literal> oder <literal>06.Aufwand</literal>
3144 ausgewählt werden.</para>
3146 <para>Wird bei einem Erlöskonto <literal>06.Aufwand</literal>
3147 ausgewählt, so wird dieses Konto als Aufwandsminderung unter AUFWAND
3150 <para>Wird bei einem Aufwandskonto <literal>01.Ertrag</literal>
3151 ausgewählt, so wird dieses Konto als Ertragsminderung unter ERTRAG
3154 <para>Soll bei einer bereits bestehenden Buchhaltung in Zukunft
3155 zusätzlich die Erfolgsrechnung als Bericht verwendet werden, so müssen
3156 die Einstellungen zu allen Erlös- und Aufwandskonten unter
3157 <varname>Sonstige Einstellungen/Erfolgsrechnung</varname> überprüft und
3158 allenfalls neu gesetzt werden.</para>
3161 <sect1 id="config.rounding">
3162 <title>Rundung in Verkaufsbelegen</title>
3164 <para>In der Schweiz hat die kleinste aktuell benutzte Münze den Wert
3165 von 5 Rappen (0.05 CHF).</para>
3167 <para>Auch wenn im elektronischen Zahlungsverkehr Beträge mit einer
3168 Genauigkeit von 0.01 CHF verwendet werden können, ist es trotzdem nach
3169 wie vor üblich, Rechnungen mit auf 0.05 CHF gerundeten Beträgen
3170 auszustellen.</para>
3172 <para>In kivitendo kann seit der Version 3.4.1 die Einstellung für eine
3173 solche Rundung pro Mandant / Datenbank festgelegt werden.</para>
3175 <para>Die Einstellung wird beim Erstellen der Datenbank bei
3176 <literal>Genauigkeit</literal> festgelegt. Sie kann anschliessend über
3177 das Webinterface von kivitendo nicht mehr verändert werden.</para>
3179 <para>Abhängig vom Wert für <varname>default_manager</varname> in
3180 <filename>config/kivitendo.conf</filename> werden dabei folgende Werte
3181 voreingestellt:</para>
3185 <para>0.05 (default_manager = swiss)</para>
3189 <para>0.01 (default_manager = german)</para>
3193 <para>Der Wert wird in der Datenbank in der Tabelle <varname>defaults
3194 </varname>in der Spalte <varname>precision</varname> gespeichert.</para>
3196 <para>In allen Verkaufsangeboten, Verkaufsaufträgen, Verkaufsrechnungen
3197 und Verkaufsgutschriften wird der Endbetrag inkl. MWST gerundet, wenn
3198 dieser nicht der eingestellten Genauigkeit entspricht.</para>
3200 <para>Beim Buchen einer Verkaufsrechnung wird der Rundungsbetrag
3201 automatisch auf die in der Mandantenkonfiguration festgelegten
3202 Standardkonten für Rundungserträge bzw. Rundungsaufwendungen
3205 <para>(Die berechnete MWST wird durch den Rundungsbetrag nicht mehr
3208 <para>Die in den Druckvorlagen zur Verfügung stehenden Variablen
3209 <varname>quototal</varname>, <varname>ordtotal</varname> bzw.
3210 <varname>invtotal</varname> enthalten den gerundeten Betrag.</para>
3212 <para><emphasis role="bold">Achtung:</emphasis> Werden Verkaufsbelege in
3213 anderen Währungen als der Standardwährung erstellt, so muss in kivitendo
3214 ab Version 3.4.1 die Genauigkeit 0.01 verwendet werden.</para>
3216 <para>Das heisst, Firmen in der Schweiz, die teilweise
3217 Verkaufsrechnungen in Euro oder anderen Währungen erstellen wollen,
3218 müssen beim Erstellen der Datenbank als Genauigkeit 0.01 wählen und
3219 können zur Zeit die 5er Rundung noch nicht nutzen.</para>
3222 <sect1 id="config.client">
3223 <title>Einstellungen pro Mandant</title>
3225 <para>Einige Einstellungen können von einem Benutzer mit dem <link
3226 linkend="Zusammenhänge">Recht</link> "Administration (Für die Verwaltung
3227 der aktuellen Instanz aus einem Userlogin heraus)" gemacht werden. Diese
3228 Einstellungen sind dann für die aktuellen Mandanten-Datenbank gültig.
3229 Die Einstellungen sind unter <guimenu>System</guimenu> →
3230 <guisubmenu>Mandantenkonfiguration</guisubmenu> erreichbar.</para>
3232 <para>Bitte beachten Sie die Hinweise zu den einzelnen Einstellungen.
3233 Einige Einstellungen sollten nicht ohne Weiteres im laufenden Betrieb
3234 geändert werden (siehe auch <link
3235 linkend="config.eur.inventory-system-perpetual">Bemerkungen zu
3236 Bestandsmethode</link>).</para>
3238 <para>Die Einstellungen <literal>show_bestbefore</literal> und
3239 <literal>payments_changeable</literal> aus dem Abschnitt
3240 <literal>features</literal> und die Einstellungen im Abschnitt
3241 <literal>datev_check</literal> (sofern schon vorhanden) der <link
3242 linkend="config.config-file">kivitendo-Konfigurationsdatei</link> werden
3243 bei einem Datenbankupdate einer älteren Version automatisch übernommen.
3244 Diese Einträge können danach aus der Konfigurationsdatei entfernt
3248 <sect1 id="kivitendo-ERP-verwenden">
3249 <title>kivitendo ERP verwenden</title>
3251 <para>Nach erfolgreicher Installation ist der Loginbildschirm unter
3252 folgender URL erreichbar:</para>
3255 url="http://localhost/kivitendo-erp/login.pl">http://localhost/kivitendo-erp/login.pl</ulink></para>
3257 <para>Die Administrationsseite erreichen Sie unter:</para>
3260 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
3264 <chapter id="features" xreflabel="Features und Funktionen">
3265 <title>Features und Funktionen</title>
3267 <sect1 id="features.periodic-invoices"
3268 xreflabel="Wiederkehrende Rechnungen">
3269 <title>Wiederkehrende Rechnungen</title>
3271 <sect2 id="features.periodic-invoices.introduction"
3272 xreflabel="Einführung in wiederkehrende Rechnungen">
3273 <title>Einführung</title>
3275 <para>Wiederkehrende Rechnungen werden als normale Aufträge definiert
3276 und konfiguriert, mit allen dazugehörigen Kunden- und Artikelangaben.
3277 Die konfigurierten Aufträge werden später automatisch in Rechnungen
3278 umgewandelt, so als ob man den Workflow benutzen würde, und auch die
3279 Auftragsnummer wird übernommen, sodass alle wiederkehrenden
3280 Rechnungen, die aus einem Auftrag erstellt wurden, später leicht
3281 wiederzufinden sind.</para>
3284 <sect2 id="features.periodic-invoices.configuration"
3285 xreflabel="Konfiguration von wiederkehrenden Rechnungen">
3286 <title>Konfiguration</title>
3288 <para>Um einen Auftrag für wiederkehrende Rechnung zu konfigurieren,
3289 findet sich beim Bearbeiten des Auftrags ein neuer Knopf
3290 "Konfigurieren", der ein neues Fenster öffnet, in dem man die nötigen
3291 Parameter einstellen kann. Hinter dem Knopf wird außerdem noch
3292 angezeigt, ob der Auftrag als wiederkehrende Rechnung konfiguriert ist
3295 <para>Folgende Parameter kann man konfigurieren:</para>
3302 <para>Bei aktiven Rechnungen wird automatisch eine Rechnung
3303 erstellt, wenn die Periodizität erreicht ist (z.B. am Anfang
3304 eines neuen Monats).</para>
3306 <para>Ist ein Auftrag nicht aktiv, so werden für ihn auch keine
3307 wiederkehrenden Rechnungen erzeugt. Stellt man nach längerer
3308 nicht-aktiver Zeit einen Auftrag wieder auf aktiv, wird beim
3309 nächsten Periodenwechsel für alle Perioden, seit der letzten
3310 aktiven Periode, jeweils eine Rechnung erstellt. Möchte man dies
3311 verhindern, muss man vorher das Startdatum neu setzen.</para>
3313 <para>Für gekündigte Aufträge werden nie mehr Rechnungen
3314 erstellt. Man kann sich diese Aufträge aber gesondert in den
3315 Berichten anzeigen lassen.</para>
3320 <term>Periodizität</term>
3323 <para>Ob monatlich, quartalsweise oder jährlich auf neue
3324 Rechnungen überprüft werden soll. Für jede Periode seit dem
3325 Startdatum wird überprüft, ob für die Periode (beginnend immer
3326 mit dem ersten Tag der Periode) schon eine Rechnung erstellt
3327 wurde. Unter Umständen können bei einem Startdatum in der
3328 Vergangenheit gleich mehrere Rechnungen erstellt werden.</para>
3333 <term>Buchen auf</term>
3336 <para>Das Forderungskonto, in der Regel "Forderungen aus
3337 Lieferungen und Leistungen". Das Gegenkonto ergibt sich aus den
3338 Buchungsgruppen der betreffenden Waren.</para>
3343 <term>Startdatum</term>
3346 <para>ab welchem Datum auf Rechnungserstellung geprüft werden
3352 <term>Enddatum</term>
3355 <para>ab wann keine Rechnungen mehr erstellt werden
3361 <term>Automatische Verlängerung um x Monate</term>
3364 <para>Sollen die wiederkehrenden Rechnungen bei Erreichen des
3365 eingetragenen Enddatums weiterhin erstellt werden, so kann man
3366 hier die Anzahl der Monate eingeben, um die das Enddatum
3367 automatisch nach hinten geschoben wird.</para>
3372 <term>Drucken</term>
3375 <para>Sind Drucker konfiguriert, so kann man sich die erstellten
3376 Rechnungen auch gleich ausdrucken lassen.</para>
3381 <para>Nach Erstellung der Rechnungen kann eine E-Mail mit
3382 Informationen zu den erstellten Rechnungen verschickt werden.
3383 Konfiguriert wird dies in der <link
3384 linkend="config.config-file.sections-parameters">Konfigurationsdatei</link>
3385 <filename>config/kivitendo.conf</filename> im Abschnitt
3386 <varname>[periodic_invoices]</varname>.</para>
3389 <sect2 id="features.periodic-invoices.variables">
3390 <title>Spezielle Variablen</title>
3392 <para>Um die erzeugten Rechnungen individualisieren zu können, werden
3393 beim Umwandeln des Auftrags in eine Rechnung einige speziell
3394 formatierte Variablen durch für die jeweils aktuelle
3395 Abrechnungsperiode gültigen Werte ersetzt. Damit ist es möglich, z.B.
3396 den Abrechnungszeitraum explizit auszuweisen. Eine Variable hat dabei
3397 die Syntax <literal><%variablenname%></literal>.</para>
3399 <para>Sofern es sich um eine Datumsvariable handelt, kann das
3400 Ausgabeformat weiter bestimmt werden, indem an den Variablennamen
3401 Formatoptionen angehängt werden. Die Syntax sieht dabei wie folgt aus:
3402 <literal><%variablenname FORMAT=Formatinformation%></literal>.
3403 Die zur verfügung stehenden Formatinformationen werden unten genauer
3406 <para>Diese Variablen können auch beim automatischen Versand der
3407 erzeugten Rechnungen per E-Mail genutzt werden, indem sie in den
3408 Feldern für den Betreff oder die Nachricht verwendet werden.</para>
3410 <para>Diese Variablen werden in den folgenden Elementen des Auftrags
3415 <para>Bemerkungen</para>
3419 <para>Interne Bemerkungen</para>
3423 <para>Vorgangsbezeichnung</para>
3427 <para>In den Beschreibungs- und Langtextfeldern aller
3432 <para>Die zur Verfügung stehenden Variablen sind die Folgenden:</para>
3436 <term><varname><%current_quarter%></varname>,
3437 <varname><%previous_quarter%></varname>,
3438 <varname><%next_quarter%></varname></term>
3441 <para>Aktuelles, vorheriges und nächstes Quartal als Zahl
3442 zwischen <literal>1</literal> und <literal>4</literal>.</para>
3447 <term><varname><%current_month%></varname>,
3448 <varname><%previous_month%></varname>,
3449 <varname><%next_month%></varname></term>
3452 <para>Aktueller, vorheriger und nächster Monat als Zahl zwischen
3453 <literal>1</literal> und <literal>12</literal>.</para>
3458 <term><varname><%current_month_long%></varname>,
3459 <varname><%previous_month_long%></varname>,
3460 <varname><%next_month_long%></varname></term>
3463 <para>Aktueller, vorheriger und nächster Monat als Name
3464 (<literal>Januar</literal>, <literal>Februar</literal>
3470 <term><varname><%current_year%></varname>,
3471 <varname><%previous_year%></varname>,
3472 <varname><%next_year%></varname></term>
3475 <para>Aktuelles, vorheriges und nächstes Jahr als vierstellige
3476 Jahreszahl (<literal>2013</literal> etc.).</para>
3481 <term><varname><%period_start_date%></varname>,
3482 <varname><%period_end_date%></varname></term>
3485 <para>Formatiertes Datum des ersten und letzten Tages im
3486 Abrechnungszeitraum (z.B. bei quartalsweiser Abrechnung und im
3487 ersten Quartal von 2013 wären dies der
3488 <literal>01.01.2013</literal> und
3489 <literal>31.03.2013</literal>).</para>
3494 <para>Die invidiuellen Formatinformationen bestehen aus Paaren von
3495 Prozentzeichen und einem Buchstaben, welche beide zusammen durch den
3496 dazugehörigen Wert ersetzt werden. So wird z.B. <literal>%Y</literal>
3497 durch das viertstellige Jahr ersetzt. Alle möglichen Platzhalter
3502 <term><varname>%a</varname></term>
3505 <para>Der abgekürzte Wochentagsname.</para>
3510 <term><varname>%A</varname></term>
3513 <para>Der ausgeschriebene Wochentagsname.</para>
3518 <term><varname>%b</varname></term>
3521 <para>Der abgekürzte Monatsname.</para>
3526 <term><varname>%B</varname></term>
3529 <para>Der ausgeschriebene Monatsname.</para>
3534 <term><varname>%C</varname></term>
3537 <para>Das Jahrhundert (Jahr/100) als eine zweistellige
3543 <term><varname>%d</varname></term>
3546 <para>Der Monatstag als Zahl zwischen 01 und 31.</para>
3551 <term><varname>%D</varname></term>
3554 <para>Entspricht %m/%d/%y (amerikanisches Datumsformat).</para>
3559 <term><varname>%e</varname></term>
3562 <para>Wie %d (Monatstag als Zahl zwischen 1 und 31), allerdings
3563 werden führende Nullen durch Leerzeichen ersetzt.</para>
3568 <term><varname>%F</varname></term>
3571 <para>Entspricht %Y-%m-%d (das ISO-8601-Datumsformat).</para>
3576 <term><varname>%j</varname></term>
3579 <para>Der Tag im Jahr als Zahl zwischen 001 und 366
3585 <term><varname>%m</varname></term>
3588 <para>Der Monat als Zahl zwischen 01 und 12 inklusive.</para>
3593 <term><varname>%u</varname></term>
3596 <para>Der Wochentag als Zahl zwischen 1 und 7 inklusive, wobei
3597 die 1 dem Montag entspricht.</para>
3602 <term><varname>%U</varname></term>
3605 <para>Die Wochennummer als Zahl zwischen 00 und 53 inklusive,
3606 wobei der erste Sonntag im Jahr das Startdatum von Woche 01
3612 <term><varname>%V</varname></term>
3615 <para>Die ISO-8601:1988-Wochennummer als Zahl zwischen 01 und 53
3616 inklusive, wobei Woche 01 die erste Woche, von der mindestens
3617 vier Tage im Jahr liegen; Montag ist erster Tag der
3623 <term><varname>%w</varname></term>
3626 <para>Der Wochentag als Zahl zwischen 0 und 6 inklusive, wobei
3627 die 0 dem Sonntag entspricht.</para>
3632 <term><varname>%W</varname></term>
3635 <para>Die Wochennummer als Zahl zwischen 00 und 53 inklusive,
3636 wobei der erste Montag im Jahr das Startdatum von Woche 01
3642 <term><varname>%y</varname></term>
3645 <para>Das Jahr als zweistellige Zahl zwischen 00 und 99
3651 <term><varname>%Y</varname></term>
3654 <para>Das Jahr als vierstellige Zahl.</para>
3659 <term><varname>%%</varname></term>
3662 <para>Das Prozentzeichen selber.</para>
3667 <para>Anwendungsbeispiel für die Ausgabe, von welchem Monat und Jahr
3668 bis zu welchem Monat und Jahr die aktuelle Abrechnungsperiode dauert:
3669 <literal>Abrechnungszeitrum: <%period_start_date FORMAT=%m/%Y%>
3670 bis <%period_end_date FORMAT=%m/%Y%></literal></para>
3673 <sect2 id="features.periodic-invoices.reports">
3674 <title>Auflisten</title>
3676 <para>Unter Verkauf->Berichte->Aufträge finden sich zwei neue
3677 Checkboxen, "Wiederkehrende Rechnungen aktiv" und "Wiederkehrende
3678 Rechnungen inaktiv", mit denen man sich einen Überglick über die
3679 wiederkehrenden Rechnungen verschaffen kann.</para>
3682 <sect2 id="features.periodic-invoices.task-server">
3683 <title>Erzeugung der eigentlichen Rechnungen</title>
3685 <para>Die zeitliche und periodische Überprüfung, ob eine
3686 wiederkehrende Rechnung automatisch erstellt werden soll, geschieht
3687 durch den <link linkend="config.task-server">Taskserver</link>, einen
3688 externen Dienst, der automatisch beim Start des Servers gestartet
3689 werden sollte.</para>
3692 <sect2 id="features.periodic-invoices.create-for-current-month">
3693 <title>Erste Rechnung für aktuellen Monat erstellen</title>
3695 <para>Will man im laufenden Monat eine monatlich wiederkehrende
3696 Rechnung inkl. des laufenden Monats starten, stellt man das Startdatum
3697 auf den Monatsanfang und wartet ein paar Minuten, bis der Taskserver
3698 den neu konfigurieren Auftrag erkennt und daraus eine Rechnung
3699 generiert hat. Alternativ setzt man das Startdatum auf den
3700 Monatsersten des Folgemonats und erstellt die erste Rechnung direkt
3701 manuell über den Workflow.</para>
3705 <sect1 id="features.bank" xreflabel="bankerweiterung">
3706 <title>Bankerweiterung</title>
3708 <sect2 id="features.bank.introduction"
3709 xreflabel="Einführung in die Bankerweiterung">
3710 <title>Einführung</title>
3712 <para>Die Beschreibung der Bankerweiterung befindet sich derzeit noch
3713 im Wiki und soll von dort später hierhin übernommen werden:</para>
3716 url="http://redmine.kivitendo-premium.de/projects/forum/wiki/Bankerweiterung">http://redmine.kivitendo-premium.de/projects/forum/wiki/Bankerweiterung</ulink></para>
3720 <sect1 id="dokumentenvorlagen-und-variablen">
3721 <title>Dokumentenvorlagen und verfügbare Variablen</title>
3723 <sect2 id="dokumentenvorlagen-und-variablen.einführung">
3724 <title>Einführung</title>
3726 <para>Dies ist eine Auflistung der Standard-Dokumentenvorlagen und
3727 aller zur Bearbeitung verfügbaren Variablen. Eine Variable wird in
3728 einer Vorlage durch ihren Inhalt ersetzt, wenn sie in der Form
3729 <function><%variablenname%></function> verwendet wird. Für
3730 LaTeX- und HTML-Vorlagen kann man die Form dieser Tags auch verändern
3732 linkend="dokumentenvorlagen-und-variablen.tag-style"/>).</para>
3734 <para>kivitendo unterstützt LaTeX-, HTML- und OpenDocument-Vorlagen.
3735 Sofern es nicht ausdrücklich eingeschränkt wird, gilt das im Folgenden
3736 gesagte für alle Vorlagenarten.</para>
3738 <para>Insgesamt sind technisch gesehen eine ganze Menge mehr Variablen
3739 verfügbar als hier aufgelistet werden. Die meisten davon können
3740 allerdings innerhalb einer solchen Vorlage nicht sinnvoll verwendet
3741 werden. Wenn eine Auflistung dieser Variablen gewollt ist, so kann
3742 diese wie folgt erhalten werden:</para>
3746 <para><filename>SL/Form.pm</filename> öffnen und am Anfang die
3747 Zeile "<command>use Data::Dumper;</command>" einfügen.</para>
3751 <para>In <filename>Form.pm</filename> die Funktion
3752 <function>parse_template</function> suchen und hier die Zeile
3753 <command>print(STDERR Dumper($self));</command> einfügen.</para>
3757 <para>Einmal per Browser die gewünschte Vorlage "benutzen", z.B.
3758 ein PDF für eine Rechnung erzeugen.</para>
3762 <para>Im <filename>error.log</filename> Apache steht die Ausgabe
3763 der Variablen <varname>$self</varname> in der Form <varname>'key'
3764 => 'value',</varname>. Alle <varname>key</varname>s sind
3770 <sect2 id="dokumentenvorlagen-und-variablen.variablen-ausgeben">
3771 <title>Variablen ausgeben</title>
3773 <para>Um eine Variable auszugeben, müssen sie einfach nur zwischen die
3774 Tags geschrieben werden, also z.B.
3775 <varname><%variablenname%></varname>.</para>
3777 <para>Optional kann man auch mit Leerzeichen getrennte Flags angeben,
3778 die man aber nur selten brauchen wird. Die Syntax sieht also so aus:
3779 <varname><%variablenname FLAG1 FLAG2%></varname>. Momentan
3780 werden die folgenden Flags unterstützt:</para>
3784 <para><option>NOFORMAT</option> gilt nur für Zahlenwerte und gibt
3785 den Wert ohne Formatierung, also ohne Tausendertrennzeichen mit
3786 mit einem Punkt als Dezimaltrennzeichen aus. Nützlich z.B., wenn
3787 damit in der Vorlage z.B. von LaTeX gerechnet werden soll.</para>
3791 <para><option>NOESCAPE</option> unterdrückt das Escapen von
3792 Sonderzeichen für die Vorlagensprache. Wenn also in einer
3793 Variablen bereits gültiger LaTeX-Code steht und dieser von LaTeX
3794 auch ausgewertet und nicht wortwörtlich angezeigt werden soll, so
3795 ist dieses Flag sinnvoll.</para>
3799 <para>Beispiel:</para>
3801 <programlisting><%quototal NOFORMAT%></programlisting>
3804 <sect2 id="dokumentenvorlagen-und-variablen.verwendung-in-druckbefehlen">
3805 <title>Verwendung in Druckbefehlen</title>
3807 <para>In der Admininstration können Drucker definiert werden. Auch im
3808 dort eingebbaren Druckbefehl können die hier aufgelisteten Variablen
3809 und Kontrollstrukturen verwendet werden. Ihr Inhalt wird dabei nach
3810 den Regeln der gängigen Shells formatiert, sodass Sonderzeichen wie
3811 <function>`...`</function> nicht zu unerwünschtem Verhalten
3814 <para>Dies erlaubt z.B. die Definition eines Faxes als Druckerbefehl,
3815 für das die Telefonnummer eines Ansprechpartners als Teil der
3816 Kommandozeile verwendet wird. Für ein fiktives Kommando könnte das
3817 z.B. wie folgt aussehen:</para>
3819 <programlisting>send_fax --number <%if cp_phone2%><%cp_phone2%><%else%><%cp_phone1%><%end%></programlisting>
3822 <sect2 id="dokumentenvorlagen-und-variablen.tag-style"
3823 xreflabel="Anfang und Ende der Tags verändern">
3824 <title>Anfang und Ende der Tags verändern</title>
3826 <para>Der Standardstil für Tags sieht vor, dass ein Tag mit dem
3827 Kleinerzeichen und einem Prozentzeichen beginnt und mit dem
3828 Prozentzeichen und dem Größerzeichen endet, beispielsweise
3829 <function><%customer%></function>. Da diese Form aber z.B. in
3830 LaTeX zu Problemen führen kann, weil das Prozentzeichen dort
3831 Kommentare einleitet, kann pro HTML- oder LaTeX-Dokumentenvorlage der
3832 Stil umgestellt werden.</para>
3834 <para>Dazu werden in die Datei Zeilen geschrieben, die mit dem für das
3835 Format gültigen Kommentarzeichen anfangen, dann
3836 <function>config:</function> enthalten, die entsprechende Option
3837 setzen und bei HTML-Dokumentenvorlagen mit dem Kommentarendzeichen
3838 enden. Beispiel für LaTeX:</para>
3840 <programlisting>% config: tag-style=($ $)</programlisting>
3842 <para>Dies würde kivitendo dazu veranlassen, Variablen zu ersetzen,
3843 wenn sie wie folgt aussehen: <function>($customer$)</function>. Das
3844 äquivalente Beispiel für HTML-Dokumentenvorlagen sieht so aus:</para>
3846 <programlisting><!-- config: tag-style=($ $) --></programlisting>
3849 <sect2 id="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">
3850 <title>Zuordnung von den Dateinamen zu den Funktionen</title>
3852 <para>Diese folgende kurze Auflistung zeigt, welche Vorlage bei
3853 welcher Funktion ausgelesen wird. Dabei ist die Dateiendung
3854 "<filename>.ext</filename>" geeignet zu ersetzen:
3855 "<filename>.tex</filename>" für LaTeX-Vorlagen und
3856 "<filename>.odt</filename>" für OpenDocument-Vorlagen.</para>
3860 <term><filename>bin_list.ext</filename></term>
3863 <para>Lagerliste</para>
3868 <term><filename>check.ext</filename></term>
3876 <term><filename>invoice.ext</filename></term>
3879 <para>Rechnung</para>
3884 <term><filename>packing_list.ext</filename></term>
3887 <para>Packliste</para>
3892 <term><filename>pick_list.ext</filename></term>
3895 <para>Sammelliste</para>
3900 <term><filename>purchase_delivery_order.ext</filename></term>
3903 <para>Lieferschein (Einkauf)</para>
3908 <term><filename>purcharse_order.ext</filename></term>
3911 <para>Bestellung an Lieferanten</para>
3916 <term><filename>request_quotation.ext</filename></term>
3919 <para>Anfrage an Lieferanten</para>
3924 <term><filename>sales_delivery_order.ext</filename></term>
3927 <para>Lieferschein (Verkauf)</para>
3932 <term><filename>sales_order.ext</filename></term>
3935 <para>Bestellung</para>
3940 <term><filename>sales_quotation.ext</filename></term>
3943 <para>Angebot an Kunden</para>
3948 <term><filename>zahlungserinnerung.ext</filename></term>
3951 <para>Mahnung (Dateiname im Programm konfigurierbar)</para>
3956 <term><filename>zahlungserinnerung_invoice.ext</filename></term>
3959 <para>Rechnung über Mahngebühren (Dateiname im Programm
3960 konfigurierbar)</para>
3966 <sect2 id="dokumentenvorlagen-und-variablen.dateinamen-erweitert">
3967 <title>Sprache, Drucker und E-Mail</title>
3969 <para>Angeforderte Sprache und Druckerkürzel in den Dateinamen mit
3970 eingearbeitet. So wird aus der Vorlage
3971 <filename>sales_order.ext</filename> bei Sprache
3972 <function>de</function> und Druckerkürzel <function>lpr2</function>
3973 der Vorlagenname <filename>sales_order_de_lpr2.ext</filename>.
3974 Zusätzlich können für E-Mails andere Vorlagen erstellt werden, diese
3975 bekommen dann noch das Kürzel <filename>_email</filename>, der
3976 vollständige Vorlagenname wäre dann
3977 <filename>sales_order_email_de_lpr2.ext</filename>. In allen Fällen
3978 kann eine Standarddatei <filename>default.ext</filename> hinterlegt
3979 werden. Diese wird verwendet, wenn keine der anderen Varianten
3980 gefunden wird.</para>
3982 <para>Die vollständige Suchreihenfolge für einen Verkaufsauftrag mit
3983 der Sprache "de" und dem Drucker "lpr2", der per E-Mail im Format PDF
3984 verschickt wird, ist:</para>
3988 <para><filename>sales_order_email_de_lpr2.tex</filename></para>
3992 <para><filename>sales_order_de_lpr2.tex</filename></para>
3996 <para><filename>sales_order.tex</filename></para>
4000 <para><filename>default.tex</filename></para>
4004 <para>Die kurzen Varianten dieser Vorlagentitel müssen dann entweder
4005 Standardwerte anzeigen, oder die angeforderten Werte selbst auswerten,
4007 linkend="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"/>.</para>
4010 <sect2 id="dokumentenvorlagen-und-variablen.allgemeine-variablen">
4011 <title>Allgemeine Variablen, die in allen Vorlagen vorhanden
4014 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"
4015 xreflabel="Metainformationen zur angeforderten Vorlage">
4016 <title>Metainformationen zur angeforderten Vorlage</title>
4018 <para>Diese Variablen liefern Informationen darüber welche Variante
4019 einer Vorlage der Benutzer angefragt hat. Sie sind nützlich für
4020 Vorlagenautoren, die aus einer zentralen Layoutvorlage die einzelnen
4021 Formulare einbinden möchten.</para>
4025 <term><varname>template_meta.formname</varname></term>
4028 <para>Basisname der Vorlage. Identisch mit der <link
4029 linkend="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">Zurordnung
4030 zu den Dateinamen</link> ohne die Erweiterung. Ein
4031 Verkaufsauftrag enthält hier
4032 <constant>sales_order</constant>.</para>
4037 <term><varname>template_meta.language.description</varname></term>
4040 <para>Beschreibung der verwendeten Sprache</para>
4045 <term><varname>template_meta.language.template_code</varname></term>
4048 <para>Vorlagenkürzel der verwendeten Sprache, identisch mit
4049 dem Kürzel das im Dateinamen verwendetet wird.</para>
4054 <term><varname>template_meta.language.output_numberformat</varname></term>
4057 <para>Zahlenformat der verwendeten Sprache in der Form
4058 "<constant>1.000,00</constant>". Experimentell! Nur
4059 interessant für Vorlagen die mit unformatierten Werten
4065 <term><varname>template_meta.language.output_dateformat</varname></term>
4068 <para>Datumsformat der verwendeten Sprache in der Form
4069 "<constant>dd.mm.yyyy</constant>". Experimentell! Nur
4070 interessant für Vorlagen die mit unformatierten Werten
4076 <term><varname>template_meta.format</varname></term>
4079 <para>Das angeforderte Format. Kann im Moment die Werte
4080 <constant>pdf</constant>, <constant>postscript</constant>,
4081 <constant>html</constant>, <constant>opendocument</constant>,
4082 <constant>opendocument_pdf</constant> und
4083 <constant>excel</constant> enthalten.</para>
4088 <term><varname>template_meta.extension</varname></term>
4091 <para>Dateierweiterung, wie im Dateinamen. Wird aus
4092 <constant>format</constant> entschieden.</para>
4097 <term><varname>template_meta.media</varname></term>
4100 <para>Ausgabemedium. Kann zur Zeit die Werte
4101 <constant>screen</constant> für Bildschirm,
4102 <constant>email</constant> für E-Mail (triggert das
4103 <constant>_email</constant> Kürzel im Dateinamen),
4104 <constant>printer</constant> für Drucker, und
4105 <constant>queue</constant> für Warteschlange enthalten.</para>
4110 <term><varname>template_meta.printer.description</varname></term>
4113 <para>Beschreibung des ausgewählten Druckers</para>
4118 <term><varname>template_meta.printer.template_code</varname></term>
4121 <para>Vorlagenürzel des ausgewählten Druckers, identisch mit
4122 dem Kürzel das im Dateinamen verwendetet wird.</para>
4127 <term><varname>template_meta.tmpfile</varname></term>
4130 <para>Datei-Prefix für temporäre Dateien.</para>
4136 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.kunden-lieferanten">
4137 <title>Stammdaten von Kunden und Lieferanten</title>
4141 <term><varname>account_number</varname></term>
4144 <para>Kontonummer</para>
4149 <term><varname>bank</varname></term>
4152 <para>Name der Bank</para>
4157 <term><varname>bank_code</varname></term>
4160 <para>Bankleitzahl</para>
4165 <term><varname>bic</varname></term>
4168 <para>Bank-Identifikations-Code (Bank Identifier Code,
4174 <term><varname>business</varname></term>
4177 <para>Kunden-/Lieferantentyp</para>
4182 <term><varname>city</varname></term>
4190 <term><varname>contact</varname></term>
4193 <para>Kontakt</para>
4198 <term><varname>country</varname></term>
4206 <term><varname>c_vendor_id</varname></term>
4209 <para>Lieferantennummer beim Kunden (nur Kunden)</para>
4214 <term><varname>v_customer_id</varname></term>
4217 <para>Kundennummer beim Lieferanten (nur Lieferanten)</para>
4222 <term><varname>cp_email</varname></term>
4225 <para>Email des Ansprechpartners</para>
4230 <term><varname>cp_givenname</varname></term>
4233 <para>Vorname des Ansprechpartners</para>
4238 <term><varname>cp_greeting</varname></term>
4241 <para>Anrede des Ansprechpartners</para>
4246 <term><varname>cp_name</varname></term>
4249 <para>Name des Ansprechpartners</para>
4254 <term><varname>cp_phone1</varname></term>
4257 <para>Telefonnummer 1 des Ansprechpartners</para>
4262 <term><varname>cp_phone2</varname></term>
4265 <para>Telefonnummer 2 des Ansprechpartners</para>
4270 <term><varname>cp_title</varname></term>
4273 <para>Titel des Ansprechpartners</para>
4278 <term><varname>creditlimit</varname></term>
4281 <para>Kreditlimit</para>
4286 <term><varname>customeremail</varname></term>
4289 <para>Email des Kunden; nur für Kunden</para>
4294 <term><varname>customerfax</varname></term>
4297 <para>Faxnummer des Kunden; nur für Kunden</para>
4302 <term><varname>customernotes</varname></term>
4305 <para>Bemerkungen beim Kunden; nur für Kunden</para>
4310 <term><varname>customernumber</varname></term>
4313 <para>Kundennummer; nur für Kunden</para>
4318 <term><varname>customerphone</varname></term>
4321 <para>Telefonnummer des Kunden; nur für Kunden</para>
4326 <term><varname>discount</varname></term>
4334 <term><varname>email</varname></term>
4337 <para>Emailadresse</para>
4342 <term><varname>fax</varname></term>
4345 <para>Faxnummer</para>
4350 <term><varname>gln</varname></term>
4353 <para>GLN (Globale Lokationsnummer)</para>
4358 <term><varname>greeting</varname></term>
4366 <term><varname>homepage</varname></term>
4369 <para>Homepage</para>
4374 <term><varname>iban</varname></term>
4377 <para>Internationale Kontonummer (International Bank Account
4378 Number, IBAN)</para>
4383 <term><varname>language</varname></term>
4386 <para>Sprache</para>
4391 <term><varname>name</varname></term>
4394 <para>Firmenname</para>
4399 <term><varname>payment_description</varname></term>
4402 <para>Name der Zahlart</para>
4407 <term><varname>payment_terms</varname></term>
4410 <para>Zahlungskonditionen</para>
4415 <term><varname>phone</varname></term>
4418 <para>Telefonnummer</para>
4423 <term><varname>shiptocity</varname></term>
4426 <para>Stadt (Lieferadresse) <link
4427 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4432 <term><varname>shiptocontact</varname></term>
4435 <para>Kontakt (Lieferadresse) <link
4436 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4441 <term><varname>shiptocountry</varname></term>
4444 <para>Land (Lieferadresse) <link
4445 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4450 <term><varname>shiptodepartment_1</varname></term>
4453 <para>Abteilung 1 (Lieferadresse) <link
4454 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4459 <term><varname>shiptodepartment_2</varname></term>
4462 <para>Abteilung 2 (Lieferadresse) <link
4463 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4468 <term><varname>shiptoemail</varname></term>
4471 <para>Email (Lieferadresse) <link
4472 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4477 <term><varname>shiptofax</varname></term>
4480 <para>Fax (Lieferadresse) <link
4481 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4486 <term><varname>shiptogln</varname></term>
4489 <para>GLN (Globale Lokationsnummer) (Lieferadresse) <link
4490 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4495 <term><varname>shiptoname</varname></term>
4498 <para>Firmenname (Lieferadresse) <link
4499 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4504 <term><varname>shiptophone</varname></term>
4507 <para>Telefonnummer (Lieferadresse) <link
4508 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4513 <term><varname>shiptostreet</varname></term>
4516 <para>Straße und Hausnummer (Lieferadresse) <link
4517 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4522 <term><varname>shiptozipcode</varname></term>
4525 <para>Postleitzahl (Lieferadresse) <link
4526 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4531 <term><varname>street</varname></term>
4534 <para>Straße und Hausnummer</para>
4539 <term><varname>taxnumber</varname></term>
4542 <para>Steuernummer</para>
4547 <term><varname>ustid</varname></term>
4550 <para>Umsatzsteuer-Identifikationsnummer</para>
4555 <term><varname>vendoremail</varname></term>
4558 <para>Email des Lieferanten; nur für Lieferanten</para>
4563 <term><varname>vendorfax</varname></term>
4566 <para>Faxnummer des Lieferanten; nur für Lieferanten</para>
4571 <term><varname>vendornotes</varname></term>
4574 <para>Bemerkungen beim Lieferanten; nur für Lieferanten</para>
4579 <term><varname>vendornumber</varname></term>
4582 <para>Lieferantennummer; nur für Lieferanten</para>
4587 <term><varname>vendorphone</varname></term>
4590 <para>Telefonnummer des Lieferanten; nur für
4596 <term><varname>zipcode</varname></term>
4599 <para>Postleitzahl</para>
4604 <note id="dokumentenvorlagen-und-variablen.anmerkung-shipto">
4605 <para>Anmerkung: Sind die <varname>shipto*</varname>-Felder in den
4606 Stammdaten nicht eingetragen, so haben die Variablen
4607 <varname>shipto*</varname> den gleichen Wert wie die die
4608 entsprechenden Variablen der Lieferdaten. Das bedeutet, dass sich
4609 einige <varname>shipto*</varname>-Variablen so nicht in den
4610 Stammdaten wiederfinden sondern schlicht Kopien der
4611 Lieferdatenvariablen sind (z.B.
4612 <varname>shiptocontact</varname>).</para>
4616 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-bearbeiter">
4617 <title>Informationen über den Bearbeiter</title>
4621 <term><varname>employee_address</varname></term>
4624 <para>Adressfeld</para>
4629 <term><varname>employee_businessnumber</varname></term>
4632 <para>Firmennummer</para>
4637 <term><varname>employee_company</varname></term>
4640 <para>Firmenname</para>
4645 <term><varname>employee_co_ustid</varname></term>
4648 <para>Usatzsteuer-Identifikationsnummer</para>
4653 <term><varname>employee_duns</varname></term>
4656 <para>DUNS-Nummer</para>
4661 <term><varname>employee_email</varname></term>
4669 <term><varname>employee_fax</varname></term>
4677 <term><varname>employee_name</varname></term>
4680 <para>voller Name</para>
4685 <term><varname>employee_signature</varname></term>
4688 <para>Signatur</para>
4693 <term><varname>employee_taxnumber</varname></term>
4696 <para>Steuernummer</para>
4701 <term><varname>employee_tel</varname></term>
4704 <para>Telefonnummer</para>
4710 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-verkaeufer">
4711 <title>Informationen über den Verkäufer</title>
4715 <term><varname>salesman_address</varname></term>
4718 <para>Adressfeld</para>
4723 <term><varname>salesman_businessnumber</varname></term>
4726 <para>Firmennummer</para>
4731 <term><varname>salesman_company</varname></term>
4734 <para>Firmenname</para>
4739 <term><varname>salesman_co_ustid</varname></term>
4742 <para>Usatzsteuer-Identifikationsnummer</para>
4747 <term><varname>salesman_duns</varname></term>
4750 <para>DUNS-Nummer</para>
4755 <term><varname>salesman_email</varname></term>
4763 <term><varname>salesman_fax</varname></term>
4771 <term><varname>salesman_name</varname></term>
4774 <para>voller Name</para>
4779 <term><varname>salesman_signature</varname></term>
4782 <para>Signatur</para>
4787 <term><varname>salesman_taxnumber</varname></term>
4790 <para>Steuernummer</para>
4795 <term><varname>salesman_tel</varname></term>
4798 <para>Telefonnummer</para>
4804 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-steuern">
4805 <title>Variablen für die einzelnen Steuern</title>
4809 <term><varname>tax</varname></term>
4817 <term><varname>taxbase</varname></term>
4820 <para>zu versteuernder Betrag</para>
4825 <term><varname>taxdescription</varname></term>
4828 <para>Name der Steuer</para>
4833 <term><varname>taxrate</varname></term>
4836 <para>Steuersatz</para>
4842 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-lieferbedingungen">
4843 <title>Variablen für Lieferbedingungen</title>
4847 <term><varname>delivery_term</varname></term>
4850 <para>Datenbank-Objekt der Lieferbedingung</para>
4855 <term><varname>delivery_term.description</varname></term>
4858 <para>Beschreibung der Lieferbedingung</para>
4863 <term><varname>delivery_term.description_long</varname></term>
4866 <para>Langtext bzw. übersetzter Langtext der
4867 Lieferbedingung</para>
4874 <sect2 id="dokumentenvorlagen-und-variablen.invoice">
4875 <title>Variablen in Rechnungen</title>
4877 <sect3 id="dokumentenvorlagen-und-variablen.invoice-allgemein">
4878 <title>Allgemeine Variablen</title>
4882 <term><varname>creditremaining</varname></term>
4885 <para>Verbleibender Kredit</para>
4890 <term><varname>currency</varname></term>
4893 <para>Währung</para>
4898 <term><varname>cusordnumber</varname></term>
4901 <para>Bestellnummer beim Kunden</para>
4906 <term><varname>deliverydate</varname></term>
4909 <para>Lieferdatum</para>
4914 <term><varname>duedate</varname></term>
4917 <para>Fälligkeitsdatum</para>
4922 <term><varname>globalprojectnumber</varname></term>
4925 <para>Projektnummer des ganzen Beleges</para>
4930 <term><varname>globalprojectdescription</varname></term>
4933 <para>Projekbeschreibung des ganzen Beleges</para>
4938 <term><varname>intnotes</varname></term>
4941 <para>Interne Bemerkungen</para>
4946 <term><varname>invdate</varname></term>
4949 <para>Rechnungsdatum</para>
4954 <term><varname>invnumber</varname></term>
4957 <para>Rechnungsnummer</para>
4962 <term><varname>invtotal</varname></term>
4965 <para>gesamter Rechnungsbetrag</para>
4970 <term><varname>notes</varname></term>
4973 <para>Bemerkungen der Rechnung</para>
4978 <term><varname>orddate</varname></term>
4981 <para>Auftragsdatum</para>
4986 <term><varname>ordnumber</varname></term>
4989 <para>Auftragsnummer, wenn die Rechnung aus einem Auftrag
4990 erstellt wurde</para>
4995 <term><varname>payment_description</varname></term>
4998 <para>Name der Zahlart</para>
5003 <term><varname>payment_terms</varname></term>
5006 <para>Zahlungskonditionen</para>
5011 <term><varname>quodate</varname></term>
5014 <para>Angebotsdatum</para>
5019 <term><varname>quonumber</varname></term>
5022 <para>Angebotsnummer</para>
5027 <term><varname>rounding</varname></term>
5030 <para>Betrag, um den <varname>invtotal</varname> gerundet
5031 wurde (kann positiv oder negativ sein)</para>
5036 <term><varname>shippingpoint</varname></term>
5039 <para>Versandort</para>
5044 <term><varname>shipvia</varname></term>
5047 <para>Transportmittel</para>
5052 <term><varname>subtotal</varname></term>
5055 <para>Zwischensumme aller Posten ohne Steuern</para>
5060 <term><varname>total</varname></term>
5063 <para>Restsumme der Rechnung (Summe abzüglich bereits
5064 bezahlter Posten)</para>
5069 <term><varname>transaction_description</varname></term>
5072 <para>Vorgangsbezeichnung</para>
5077 <term><varname>transdate</varname></term>
5080 <para>Auftragsdatum wenn die Rechnung aus einem Auftrag
5081 erstellt wurde</para>
5087 <sect3 id="dokumentenvorlagen-und-variablen.invoice-posten">
5088 <title>Variablen für jeden Posten auf der Rechnung</title>
5092 <term><varname>bin</varname></term>
5095 <para>Stellage</para>
5100 <term><varname>description</varname></term>
5103 <para>Artikelbeschreibung</para>
5108 <term><varname>cusordnumber_oe</varname></term>
5111 <para>Bestellnummer des Kunden aus dem Auftrag, aus dem der
5112 Posten ursprünglich stammt (nur Verkauf)</para>
5117 <term><varname>discount</varname></term>
5120 <para>Rabatt als Betrag</para>
5125 <term><varname>discount_sub</varname></term>
5128 <para>Zwischensumme mit Rabatt</para>
5133 <term><varname>donumber_do</varname></term>
5136 <para>Lieferscheinnummer des Lieferscheins, aus dem die
5137 Position ursprünglich stammt, wenn die Rechnung im Rahmen des
5138 Workflows aus einem Lieferschein erstellt wurde.</para>
5143 <term><varname>drawing</varname></term>
5146 <para>Zeichnung</para>
5151 <term><varname>ean</varname></term>
5154 <para>EAN-Code</para>
5159 <term><varname>image</varname></term>
5167 <term><varname>linetotal</varname></term>
5170 <para>Zeilensumme (Anzahl * Einzelpreis)</para>
5175 <term><varname>longdescription</varname></term>
5178 <para>Langtext</para>
5183 <term><varname>microfiche</varname></term>
5186 <para>Mikrofilm</para>
5191 <term><varname>netprice</varname></term>
5194 <para>Alternative zu <varname>sellprice</varname>, aber
5195 <varname>netprice</varname> entspricht dem effektiven
5196 Einzelpreis und beinhaltet Zeilenrabatt und Preisfaktor.
5197 <varname>netprice</varname> wird rückgerechnet aus Zeilensumme
5198 / Menge. Diese Variable ist nützlich, wenn man den gewährten
5199 Rabatt in der Druckvorlage nicht anzeigen möchte, aber Menge *
5200 Einzelpreis trotzdem die angezeigte Zeilensumme ergeben soll.
5201 <varname>netprice</varname> hat nichts mit Netto/Brutto im
5202 Sinne von Steuern zu tun.</para>
5207 <term><varname>nodiscount_linetotal</varname></term>
5210 <para>Zeilensumme ohne Rabatt</para>
5215 <term><varname>nodiscount_sub</varname></term>
5218 <para>Zwischensumme ohne Rabatt</para>
5223 <term><varname>number</varname></term>
5226 <para>Artikelnummer</para>
5231 <term><varname>ordnumber_oe</varname></term>
5234 <para>Auftragsnummer des Originalauftrags, aus dem der Posten
5235 ursprünglich stammt. Nützlich, wenn die Rechnung aus mehreren
5236 Lieferscheinen zusammengefasst wurde, oder wenn zwischendurch
5237 eine Sammelauftrag aus mehreren Aufträgen erstellt wurde. In
5238 letzterem Fall wird die unsprüngliche Auftragsnummer
5244 <term><varname>p_discount</varname></term>
5247 <para>Rabatt in Prozent</para>
5252 <term><varname>partnotes</varname></term>
5255 <para>Die beim Artikel gespeicherten Bemerkungen</para>
5260 <term><varname>partsgroup</varname></term>
5263 <para>Warengruppe</para>
5268 <term><varname>price_factor</varname></term>
5271 <para>Der Preisfaktor als Zahl, sofern einer eingestellt
5277 <term><varname>price_factor_name</varname></term>
5280 <para>Der Name des Preisfaktors, sofern einer eingestellt
5286 <term><varname>projectnumber</varname></term>
5289 <para>Projektnummer</para>
5294 <term><varname>projectdescription</varname></term>
5297 <para>Projektbeschreibung</para>
5302 <term><varname>qty</varname></term>
5310 <term><varname>reqdate</varname></term>
5313 <para>Lieferdatum</para>
5318 <term><varname>runningnumber</varname></term>
5321 <para>Position auf der Rechnung (1, 2, 3...)</para>
5326 <term><varname>sellprice</varname></term>
5329 <para>Verkaufspreis</para>
5334 <term><varname>serialnumber</varname></term>
5337 <para>Seriennummer</para>
5342 <term><varname>tax_rate</varname></term>
5345 <para>Steuersatz</para>
5350 <term><varname>transdate_do</varname></term>
5353 <para>Datum des Lieferscheins, wenn die Rechnung im Rahmen des
5354 Workflows aus einem Lieferschein stammte.</para>
5359 <term><varname>transdate_oe</varname></term>
5362 <para>Datum des Auftrags, wenn die Rechnung im Rahmen des
5363 Workflows aus einem Auftrag erstellt wurde. Wenn es
5364 Sammelaufträge gab wird das Datum des ursprünglichen Auftrags
5370 <term><varname>transdate_quo</varname></term>
5373 <para>Datum des Angebots, wenn die Position im Rahmen des
5374 Workflows aus einem Angebot stammte.</para>
5379 <term><varname>unit</varname></term>
5382 <para>Einheit</para>
5387 <term><varname>weight</varname></term>
5390 <para>Gewicht</para>
5395 <para>Für jeden Posten gibt es ein Unterarray mit den Informationen
5396 über Lieferanten und Lieferantenartikelnummer. Diese müssen mit
5397 einer <function>foreach</function>-Schleife ausgegeben werden, da
5398 für jeden Artikel mehrere Lieferanteninformationen hinterlegt sein
5399 können. Die Variablen dafür lauten:</para>
5403 <term><varname>make</varname></term>
5406 <para>Lieferant</para>
5411 <term><varname>model</varname></term>
5414 <para>Lieferantenartikelnummer</para>
5420 <sect3 id="dokumentenvorlagen-und-variablen.invoice-zahlungen">
5421 <title>Variablen für die einzelnen Zahlungseingänge</title>
5425 <term><varname>payment</varname></term>
5433 <term><varname>paymentaccount</varname></term>
5441 <term><varname>paymentdate</varname></term>
5449 <term><varname>paymentmemo</varname></term>
5457 <term><varname>paymentsource</varname></term>
5466 <sect3 id="dokumentenvorlagen-und-variablen.benutzerdefinierte-variablen-vc">
5467 <title>Benutzerdefinierte Kunden- und Lieferantenvariablen</title>
5469 <para>Die vom Benutzer definierten Variablen für Kunden und
5470 Lieferanten stehen beim Ausdruck von Einkaufs- und Verkaufsbelegen
5471 ebenfalls zur Verfügung. Ihre Namen setzen sich aus dem Präfix
5472 <varname>vc_cvar_</varname> und dem vom Benutzer festgelegten
5473 Variablennamen zusammen.</para>
5475 <para>Beispiel: Der Benutzer hat eine Variable namens
5476 <varname>number_of_employees</varname> definiert, die die Anzahl der
5477 Mitarbeiter des Unternehmens enthält. Diese Variable steht dann
5478 unter dem Namen <varname>vc_cvar_number_of_employees</varname> zur
5481 <para>Die benutzerdefinierten Variablen der Lieferadressen stehen
5482 unter einem ähnlichen Namensschema zur Verfügung. Hier lautet der
5483 Präfix <varname>shiptocvar_</varname>.</para>
5485 <para>Analog stehen die benutzerdefinierten Variablen für
5486 Ansprechpersonen mit dem Namenspräfix <varname>cp_cvar_</varname>
5487 zur Verfügung.</para>
5491 <sect2 id="dokumentenvorlagen-und-variablen.dunning">
5492 <title>Variablen in Mahnungen und Rechnungen über Mahngebühren</title>
5494 <sect3 id="dokumentenvorlagen-und-variablen.dunning-vorlagennamen">
5495 <title>Namen der Vorlagen</title>
5497 <para>Die Namen der Vorlagen werden im System-Menü vom Benutzer
5498 eingegeben. Wird für ein Mahnlevel die Option zur automatischen
5499 Erstellung einer Rechnung über die Mahngebühren und Zinsen
5500 aktiviert, so wird der Name der Vorlage für diese Rechnung aus dem
5501 Vorlagenname für diese Mahnstufe mit dem Zusatz
5502 <constant>_invoice</constant> gebildet. Weiterhin werden die Kürzel
5503 für die ausgewählte Sprache und den ausgewählten Drucker
5507 <sect3 id="dokumentenvorlagen-und-variablen.dunning-allgemein">
5508 <title>Allgemeine Variablen in Mahnungen</title>
5510 <para>Die Variablen des Bearbeiters, bzw. Verkäufers stehen wie
5511 gewohnt als <varname>employee_...</varname> bzw.
5512 <varname>salesman_...</varname> zur Verfügung. Werden mehrere
5513 Rechnungen in einer Mahnung zusammengefasst, so werden die Metadaten
5514 (Bearbeiter, Abteilung, etc) der ersten angemahnten Rechnung im
5515 Ausdruck genommen.</para>
5517 <para>Die Adressdaten des Kunden stehen als Variablen
5518 <varname>name</varname>, <varname>street</varname>,
5519 <varname>zipcode</varname>, <varname>city</varname>,
5520 <varname>country</varname>, <varname>department_1</varname>,
5521 <varname>department_2</varname>, und <varname>email</varname> zur
5522 Verfügung. Der Ansprechpartner <varname>cp_...</varname> steht auch
5523 zu Verfügung, wird allerdings auch nur von der ersten angemahnten
5524 Rechnung (s.o.) genommen.</para>
5526 <para>Weitere Variablen beinhalten:</para>
5530 <term><varname>dunning_date</varname></term>
5533 <para>Datum der Mahnung</para>
5538 <term><varname>dunning_duedate</varname></term>
5541 <para>Fälligkeitsdatum für diese Mahhnung</para>
5546 <term><varname>dunning_id</varname></term>
5549 <para>Mahnungsnummer</para>
5554 <term><varname>fee</varname></term>
5557 <para>Kumulative Mahngebühren</para>
5562 <term><varname>interest_rate</varname></term>
5565 <para>Zinssatz per anno in Prozent</para>
5570 <term><varname>total_amount</varname></term>
5573 <para>Gesamter noch zu zahlender Betrag als
5574 <function>fee</function> + <function>total_interest</function>
5575 + <function>total_open_amount</function></para>
5580 <term><varname>total_interest</varname></term>
5583 <para>Zinsen per anno über alle Rechnungen</para>
5588 <term><varname>total_open_amount</varname></term>
5591 <para>Summe über alle offene Beträge der Rechnungen</para>
5597 <sect3 id="dokumentenvorlagen-und-variablen.dunning-details">
5598 <title>Variablen für jede gemahnte Rechnung in einer Mahnung</title>
5602 <term><varname>dn_amount</varname></term>
5605 <para>Rechnungssumme (brutto)</para>
5610 <term><varname>dn_duedate</varname></term>
5613 <para>Originales Fälligkeitsdatum der Rechnung</para>
5618 <term><varname>dn_dunning_date</varname></term>
5621 <para>Datum der Mahnung</para>
5626 <term><varname>dn_dunning_duedate</varname></term>
5629 <para>Fälligkeitsdatum der Mahnung</para>
5634 <term><varname>dn_fee</varname></term>
5637 <para>Kummulative Mahngebühr</para>
5642 <term><varname>dn_interest</varname></term>
5645 <para>Zinsen per anno für diese Rechnung</para>
5650 <term><varname>dn_invnumber</varname></term>
5653 <para>Rechnungsnummer</para>
5658 <term><varname>dn_linetotal</varname></term>
5661 <para>Noch zu zahlender Betrag (ergibt sich aus
5662 <varname>dn_open_amount</varname> + <varname>dn_fee</varname>
5663 + <varname>dn_interest</varname>)</para>
5668 <term><varname>dn_netamount</varname></term>
5671 <para>Rechnungssumme (netto)</para>
5676 <term><varname>dn_open_amount</varname></term>
5679 <para>Offener Rechnungsbetrag</para>
5684 <term><varname>dn_ordnumber</varname></term>
5687 <para>Bestellnummer</para>
5692 <term><varname>dn_transdate</varname></term>
5695 <para>Rechnungsdatum</para>
5700 <term><varname>dn_curr</varname></term>
5703 <para>Währung, in der die Rechnung erstellt wurde. (Die
5704 Rechnungsbeträge sind aber immer in der Hauptwährung)</para>
5710 <sect3 id="dokumentenvorlagen-und-variablen.dunning-invoice">
5711 <title>Variablen in automatisch erzeugten Rechnungen über
5712 Mahngebühren</title>
5714 <para>Die Variablen des Verkäufers stehen wie gewohnt als
5715 <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
5716 Kunden stehen als Variablen <varname>name</varname>,
5717 <varname>street</varname>, <varname>zipcode</varname>,
5718 <varname>city</varname>, <varname>country</varname>,
5719 <varname>department_1</varname>, <varname>department_2</varname>,
5720 und <varname>email</varname> zur Verfügung.</para>
5722 <para>Weitere Variablen beinhalten:</para>
5726 <term><varname>duedate</varname></term>
5729 <para>Fälligkeitsdatum der Rechnung</para>
5734 <term><varname>dunning_id</varname></term>
5737 <para>Mahnungsnummer</para>
5742 <term><varname>fee</varname></term>
5745 <para>Mahngebühren</para>
5750 <term><varname>interest</varname></term>
5758 <term><varname>invamount</varname></term>
5761 <para>Rechnungssumme (ergibt sich aus <varname>fee</varname> +
5762 <varname>interest</varname>)</para>
5767 <term><varname>invdate</varname></term>
5770 <para>Rechnungsdatum</para>
5775 <term><varname>invnumber</varname></term>
5778 <para>Rechnungsnummer</para>
5785 <sect2 id="dokumentenvorlagen-und-variablen.andere-vorlagen">
5786 <title>Variablen in anderen Vorlagen</title>
5789 <title>Einführung</title>
5791 <para>Die Variablen in anderen Vorlagen sind ähnlich wie in der
5792 Rechnung. Allerdings heißen die Variablen, die mit
5793 <varname>inv</varname> beginnen, jetzt anders. Bei den Angeboten
5794 fangen sie mit <varname>quo</varname> für "quotation" an:
5795 <varname>quodate</varname> für Angebotsdatum etc. Bei Bestellungen
5796 wiederum fangen sie mit <varname>ord</varname> für "order" an:
5797 <varname>ordnumber</varname> für Bestellnummer etc.</para>
5799 <para>Manche Variablen sind in anderen Vorlagen hingegen gar nicht
5800 vorhanden wie z.B. die für bereits verbuchte Zahlungseingänge. Dies
5801 sind Variablen, die vom Geschäftsablauf her in der entsprechenden
5802 Vorlage keine Bedeutung haben oder noch nicht belegt sein
5805 <para>Im Folgenden werden nur wichtige Unterschiede zu den Variablen
5806 in Rechnungen aufgeführt.</para>
5809 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-quotations">
5810 <title>Angebote und Preisanfragen</title>
5814 <term><varname>quonumber</varname></term>
5817 <para>Angebots- bzw. Anfragenummer</para>
5822 <term><varname>reqdate</varname></term>
5825 <para>Gültigkeitsdatum (bei Angeboten) bzw. Lieferdatum (bei
5826 Preisanfragen)</para>
5831 <term><varname>transdate</varname></term>
5834 <para>Angebots- bzw. Anfragedatum</para>
5840 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-orders">
5841 <title>Auftragsbestätigungen und Lieferantenaufträge</title>
5845 <term><varname>ordnumber</varname></term>
5848 <para>Auftragsnummer</para>
5853 <term><varname>reqdate</varname></term>
5856 <para>Lieferdatum</para>
5861 <term><varname>transdate</varname></term>
5864 <para>Auftragsdatum</para>
5870 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-delivery-orders">
5871 <title>Lieferscheine (Verkauf und Einkauf)</title>
5875 <term><varname>cusordnumber</varname></term>
5878 <para>Bestellnummer des Kunden (im Verkauf) bzw. Bestellnummer
5879 des Lieferanten (im Einkauf)</para>
5884 <term><varname>donumber</varname></term>
5887 <para>Lieferscheinnummer</para>
5892 <term><varname>transdate</varname></term>
5895 <para>Lieferscheindatum</para>
5900 <para>Für jede Position eines Lieferscheines gibt es ein Unterarray
5901 mit den Informationen darüber, von welchem Lager und Lagerplatz aus
5902 die Waren verschickt wurden (Verkaufslieferscheine) bzw. auf welchen
5903 Lagerplatz sie eingelagert wurden. Diese müssen mittels einer
5904 <function>foreach</function>-Schleife ausgegeben werden. Diese
5905 Variablen sind:</para>
5909 <term><varname>si_bin</varname></term>
5912 <para>Lagerplatz</para>
5917 <term><varname>si_chargenumber</varname></term>
5920 <para>Chargennummer</para>
5925 <term><varname>si_bestbefore</varname></term>
5928 <para>Mindesthaltbarkeit</para>
5933 <term><varname>si_number</varname></term>
5936 <para>Artikelnummer</para>
5941 <term><varname>si_qty</varname></term>
5944 <para>Anzahl bzw. Menge</para>
5949 <term><varname>si_runningnumber</varname></term>
5952 <para>Positionsnummer (1, 2, 3 etc)</para>
5957 <term><varname>si_unit</varname></term>
5960 <para>Einheit</para>
5965 <term><varname>si_warehouse</varname></term>
5974 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-statement">
5975 <title>Variablen für Sammelrechnung</title>
5979 <term><varname>c0total</varname></term>
5982 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit < 30
5988 <term><varname>c30total</varname></term>
5991 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 30
5992 und < 60 Tage</para>
5997 <term><varname>c60total</varname></term>
6000 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 60
6001 und < 90 Tage</para>
6006 <term><varname>c90total</varname></term>
6009 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 90
6015 <term><varname>total</varname></term>
6018 <para>Gesamtbetrag aller Rechnungen</para>
6023 <para>Variablen für jede Rechnungsposition in Sammelrechnung:</para>
6027 <term><varname>invnumber</varname></term>
6030 <para>Rechnungsnummer</para>
6035 <term><varname>invdate</varname></term>
6038 <para>Rechnungsdatum</para>
6043 <term><varname>duedate</varname></term>
6046 <para>Fälligkeitsdatum</para>
6051 <term><varname>amount</varname></term>
6054 <para>Summe der Rechnung</para>
6059 <term><varname>open</varname></term>
6062 <para>Noch offener Betrag der Rechnung</para>
6067 <term><varname>c0</varname></term>
6070 <para>Noch offener Rechnungsbetrag mit Fälligkeit < 30
6076 <term><varname>c30</varname></term>
6079 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 30 und
6085 <term><varname>c60</varname></term>
6088 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 60 und
6094 <term><varname>c90</varname></term>
6097 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 90
6105 <sect2 id="dokumentenvorlagen-und-variablen.bloecke">
6106 <title>Blöcke, bedingte Anweisungen und Schleifen</title>
6108 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.einfuehrung">
6109 <title>Einführung</title>
6111 <para>Der Parser kennt neben den Variablen einige weitere
6112 Konstrukte, die gesondert behandelt werden. Diese sind wie
6113 Variablennamen in spezieller Weise markiert:
6114 <command><%anweisung%> ... <%end%></command></para>
6116 <para>Anmerkung zum <command><%end%></command>: Der besseren
6117 Verständlichkeit halber kann man nach dem <command>end</command>
6118 noch beliebig weitere Wörter schreiben, um so zu markieren, welche
6119 Anweisung (z.B. <command>if</command> oder
6120 <command>foreach</command>) damit abgeschlossen wird.</para>
6122 <para>Beispiel: Lautet der Beginn eines Blockes z.B.
6123 <command><%if type == "sales_quotation"%></command>, so könnte
6124 er mit <command><%end%></command> genauso abgeschlossen werden
6125 wie mit <command><%end if%></command> oder auch
6126 <command><%end type == "sales_quotation"%></command>.</para>
6129 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.if">
6130 <title>Der if-Block</title>
6132 <programlisting><%if variablenname%>
6134 <%end%></programlisting>
6136 <para>Eine normale "if-then"-Bedingung. Die Zeilen zwischen dem "if"
6137 und dem "end" werden nur ausgegeben, wenn die Variable
6138 <varname>variablenname</varname> gesetzt und ungleich 0 ist.</para>
6140 <para>Handelt es sich bei der benannten Variable um ein Array, also
6141 um einen Variablennamen, über den man mit <command><%foreach
6142 variablenname%></command> iteriert, so wird mit diesem Konstrukt
6143 darauf getestet, ob das Array Elemente enthält. Somit würde im
6144 folgenden Beispiel nur dann eine Liste von Zahlungseingängen samt
6145 ihrer Überschrift "Zahlungseingänge" ausgegeben, wenn tatsächlich
6146 welche getätigt wurden:</para>
6148 <programlisting><%if payment%>
6150 <%foreach payment%>
6151 Am <%paymentdate%>: <%payment%> €
6152 <%end foreach%>
6153 <%end if%></programlisting>
6155 <para>Die Bedingung kann auch negiert werden, indem das Wort
6156 <function>not</function> nach dem <filename>if</filename> verwendet
6157 wird. Beispiel:</para>
6159 <programlisting><%if not cp_greeting%>
6161 <%end%></programlisting>
6163 <para>Zusätzlich zu dem einfachen Test, ob eine Variable gesetzt ist
6164 oder nicht, bietet dieser Block auch die Möglichkeit, den Inhalt
6165 einer Variablen mit einer festen Zeichenkette oder einer anderen
6166 Variablen zu vergleichen. Ob der Vergleich mit einer Zeichenkette
6167 oder einer anderen Variablen vorgenommen wird, hängt davon ab, ob
6168 die rechte Seite des Vergleichsoperators in Anführungszeichen
6169 gesetzt wird (Vergleich mit Zeichenkette) oder nicht (Vergleich mit
6170 anderer Variablen). Zwei Beispiele, die beide Vergleiche
6173 <programlisting><%if var1 == "Wert"%></programlisting>
6175 <para>Testet die Variable <varname>var1</varname> auf
6176 übereinstimmung mit der Zeichenkette <constant>Wert</constant>.
6177 Mittels <function>!=</function> anstelle von <function>==</function>
6178 würde auf Ungleichheit getestet.</para>
6180 <programlisting><%if var1 == var2%></programlisting>
6182 <para>Testet die Variable <varname>var1</varname> auf
6183 übereinstimmung mit der Variablen <varname>var2</varname>. Mittel
6184 <function>!=</function> anstelle von <function>==</function> würde
6185 auf Ungleichheit getestet.</para>
6187 <para>Erfahrere Benutzer können neben der Tests auf (Un-)Gleichheit
6188 auch Tests auf Übereinstimmung mit regulären Ausdrücken ohne
6189 Berücksichtung der Groß- und Kleinschreibung durchführen. Dazu dient
6190 dieselbe Syntax wie oben nur mit <function>=~</function> und
6191 <function>!~</function> als Vergleichsoperatoren.</para>
6193 <para>Beispiel für einen Test, ob die Variable
6194 <varname>intnotes</varname> (interne Bemerkungen) das Wort
6195 <constant>schwierig</constant> enthält:</para>
6197 <programlisting><%if intnotes =~ "schwierig"%></programlisting>
6200 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.foreach">
6201 <title>Der foreach-Block</title>
6203 <programlisting><%foreach variablenname%>
6205 <%end%></programlisting>
6207 <para>Fügt die Zeilen zwischen den beiden Anweisungen so oft ein,
6208 wie das Perl-Array der Variablen <varname>variablenname</varname>
6209 Elemente enthät. Dieses Konstrukt wird zur Ausgabe der einzelnen
6210 Posten einer Rechnung / eines Angebots sowie zur Ausgabe der Steuern
6211 benutzt. In jedem Durchlauf werden die <link
6212 linkend="dokumentenvorlagen-und-variablen.invoice-posten">zeilenbezogenen
6213 Variablen</link> jeweils auf den Wert für die aktuelle Position
6216 <para>Die Syntax sieht normalerweise wie folgt aus:</para>
6218 <programlisting><%foreach number%>
6219 Position: <%runningnumber%>
6220 Anzahl: <%qty%>
6221 Artikelnummer: <%number%>
6222 Beschreibung: <%description%>
6224 <%end%></programlisting>
6226 <para>Besonderheit in OpenDocument-Vorlagen: Tritt ein
6227 <function><%foreach%></function>-Block innerhalb einer
6228 Tabellenzelle auf, so wird die komplette Tabellenzeile so oft
6229 wiederholt wie notwendig. Tritt er außerhalb auf, so wird nur der
6230 Inhalt zwischen <function><%foreach%></function> und
6231 <function><%end%></function> wiederholt, nicht aber die
6232 komplette Zeile, in der er steht.</para>
6236 <sect2 id="dokumentenvorlagen-und-variablen.markup">
6237 <title>Markup-Code zur Textformatierung innerhalb von
6240 <para>Wenn der Benutzer innhalb von Formularen in kivitendo Text
6241 anders formatiert haben möchte, so ist dies begrenzt möglich.
6242 kivitendo unterstützt die Textformatierung mit HTML-ähnlichen Tags.
6243 Der Benutzer kann z.B. bei der Artikelbeschreibung auf einer Rechnung
6244 Teile des Texts zwischen Start- und Endtags setzen. Dieser Teil wird
6245 dann automatisch in Anweisungen für das ausgewählte Vorlagenformat
6246 (HTML oder PDF über LaTeX) umgesetzt.</para>
6248 <para>Die unterstützen Formatierungen sind:</para>
6252 <term><b>Text</b></term>
6255 <para>Text wird in Fettdruck gesetzt.</para>
6260 <term><i>Text</i></term>
6263 <para>Text wird kursiv gesetzt.</para>
6268 <term><u>Text</u></term>
6271 <para>Text wird unterstrichen.</para>
6276 <term><s>Text</s></term>
6279 <para>Text wird durchgestrichen. Diese Formatierung ist nicht
6280 bei der Ausgabe als PDF über LaTeX verfügbar.</para>
6285 <term><bullet></term>
6288 <para>Erzeugt einen ausgefüllten Kreis für Aufzählungen (siehe
6294 <para>Der Befehl <command><bullet></command> funktioniert
6295 momentan auch nur in Latex-Vorlagen.</para>
6299 <sect1 id="excel-templates">
6300 <title>Excel-Vorlagen</title>
6302 <sect2 id="excel-templates.summary">
6303 <title>Zusammenfassung</title>
6305 <para>Dieses Dokument beschreibt den Mechanismus, mit dem
6306 Exceltemplates abgearbeitet werden, und die Einschränkungen, die damit
6310 <sect2 id="excel-templates.usage">
6311 <title>Bedienung</title>
6313 <para>Der Excel Mechanismus muss in der Konfigurationsdatei aktiviert
6314 werden. Die Konfigurationsoption heißt <varname>excel_templates =
6315 1</varname> im Abschnitt <varname>[print_templates]</varname>.</para>
6317 <para>Eine Excelvorlage kann dann unter dem Namen einer beliebigen
6318 anderen Vorlage mit der Endung <filename>.xls</filename> gespeichert
6319 werden. In den normalen Verkaufsmasken taucht nun
6320 <constant>Excel</constant> als auswählbares Format auf und kann von da
6321 an wie LaTeX- oder OpenOffice-Vorlagen benutzt werden.</para>
6323 <para>Der Sonderfall der Angebote aus der Kundenmaske ist ebenfalls
6324 eine Angebotsvorlage und wird unter dem internen Namen der Angebote
6325 <filename>sales_quotation.xls</filename> gespeichert.</para>
6328 <sect2 id="excel-templates.syntax">
6329 <title>Variablensyntax</title>
6331 <para>Einfache Syntax:
6332 <command><<varname>></command></para>
6334 <para>Dabei sind <constant><<</constant> und
6335 <constant>>></constant> die Delimiter. Da Excel auf festen
6336 Breiten besteht, kann der Tag künstlich verlängert werden, indem
6337 weitere <constant><</constant> oder <constant>></constant>
6338 eingefügt werden. Der Tag muss nicht symmetrisch sein.
6341 <programlisting><<<<<varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
6343 <para>Um die Limitierung der festen Breite zu reduzieren, können
6344 weitere Variablen in einem Block interpoliert werden. Whitespace wird
6345 dazwishen dann erhalten. Beispiel:</para>
6347 <programlisting><<<<<varname1 varname2 varname3>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
6349 <para>Die Variablen werden interpoliert, und linksbündig mit
6350 Leerzeichen auf die gewünschte Länge aufgefüllt. Ist der String zu
6351 lang, werden überzählige Zeichen abgeschnitten.</para>
6353 <para>Es ist ausserdem möglich, Daten rechtsbündig darzustellen, wenn
6354 der Block mit einem Leerzeichen anfängt. Beispiel:</para>
6356 <programlisting><<<<<< varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
6358 <para>Dies würde rechtsbündig triggern. Wenn bei rechtsbündiger
6359 Ausrichtung Text abgeschnitten werden muss, wird er vom linken Ende
6363 <sect2 id="excel-templates.limitations">
6364 <title>Einschränkungen</title>
6366 <para>Das Excelformat bis 2002 ist ein binäres Format, und kann nicht
6367 mit vertretbarem Aufwand editiert werden. Der Templatemechanismus
6368 beschränkt sich daher darauf, Textstellen exakt durch einen anderen
6369 Text zu ersetzen.</para>
6371 <para>Aus dem gleichen Grund sind die Kontrolllstrukturen
6372 <command><%if%></command> und
6373 <command><%foreach%></command> nicht vorhanden. Der Delimiter
6374 <constant><% %></constant> kommt in den Headerinformationen
6375 evtl. vor. Deshalb wurde auf den sichereren Delimiter
6376 <constant><<</constant> und <constant>>></constant>
6381 <sect1 id="features.warehouse">
6382 <title>Mandantenkonfiguration Lager</title>
6384 <para>Die Lagerverwaltung in kivitendo funktioniert standardmässig wie
6385 folgt: Wird ein Lager mit einem Lagerplatz angelegt, so gibt es die
6386 Möglichkeit hier über den Menüpunkt Lager entsprechende Warenbewegungen
6387 durchzuführen. Ferner kann jede Position eines Lieferscheins ein-, bzw.
6388 ausgelagert werden (Einkauf-, bzw. Verkauf). Es können beliebig viele
6389 Lager mit beliebig vielen Lagerplätzen abgebildet werden. Die
6390 Lagerbewegungen über einen Lieferschein erfolgt durch Anklicken jeder
6391 Einzelposition und das Auswählen dieser Position zu einem Lager mit
6392 Lagerplatz. Dieses Verfahren lässt sich schrittweise vereinfachen, je
6393 nachdem wie die Einstellungen in der Mandatenkonfiguration gesetzt
6398 <para><option>Auslagern über Standardlagerplatz</option> Hier wird
6399 ein zusätzlicher Knopf (Auslagern über Standard-Lagerplatz) in dem
6400 Lieferschein-Beleg hinzugefügt, der dann alle Lagerbewegungen über
6401 den Standardlagerplatz (konfigurierbar pro Ware) durchführt.</para>
6405 <para><option>Auslagern ohne Bestandsprüfung</option> Das obige
6406 Auslagern schlägt fehl, wenn die entsprechende Menge für die
6407 Lagerbewegung nicht vorhanden ist, möchte man dies auch ignorieren
6408 und ggf. dann nachpflegen, so kann man eine Negativ-Warenmenge mit
6409 dieser Option erlauben. Hierfür muss ein entsprechender Lagerplatz
6410 (Fehlbestand, o.ä.) konfiguriert sein.</para>
6414 <para>Zusätzliche Funktionshinweise:</para>
6418 <para><option>Standard-Lagerplatz</option> Ist dieser konfiguriert,
6419 wird dies auch als Standard-Voreinstellung bei der Neuerfassung von
6420 Stammdaten → Waren / Dienstleistung / Erzeugnis verwendet.</para>
6424 <para><option>Standard-Lagerplatz verwenden, falls keiner in
6425 Stammdaten definiert</option> Wird beim 'Auslagern über
6426 Standardlagerplatz' keine Standardlagerplatz zu der Ware gefunden,
6427 so wird mit dieser Option einfach der Standardlagerplatz
6433 <sect1 id="features.swiss-charts-of-accounts">
6434 <title>Schweizer Kontenpläne</title>
6436 <para>Seit der Version 3.5 stehen in kivitendo 3 Kontenpläne für den
6437 Einsatz in der Schweiz zur Verfügung, einer für Firmen und
6438 Organisationen, die nicht mehrwertsteuerpflichtig sind, einer für
6439 Firmen, die mehrwertsteuerpflichtig sind und einer speziell für
6442 <para>Die Kontenpläne orientieren sich am in der Schweiz üblicherweise
6443 verwendeten KMU-Kontenrahmen und sind mit der Revision des
6444 Schweizerischen Obligationenrechts (OR) vom 1.1.2013 kompatibel,
6445 insbesondere <literal>Art.957a Abs.2</literal>.</para>
6447 <para>Beim Vereinskontenplan sind standardmässig nur die Konten 1100
6448 (Debitoren CHF) und 1101 (Debitoren EUR) als Buchungskonten im Verkauf
6449 sowie die Konten 2000 (Kreditoren CHF) und 2001 (Kreditoren EUR) als
6450 Buchungskonten im Einkauf vorgesehen. Weitere Konten können bei Bedarf
6451 in den Konto-Detaileinstellungen als Einkaufs- oder Verkaufskonten
6452 konfiguriert werden.</para>
6454 <para>Die Möglichkeit, Saldosteuersätze zu verwenden ist in der
6455 aktuellen Version von kivitendo noch nicht integriert.</para>
6457 <para>Trotzdem können auch Firmen, die per Saldosteuersatz mit der
6458 Eidgenössischen Steuerverwaltung abrechnen, kivitendo bereits nutzen.
6459 Dazu wird der Kontenplan mit MWST ausgewählt. Anschliessend müssen alle
6460 Aufwandskonten editiert werden und dort der Steuersatz auf 0% gesetzt
6463 <para>So werden bei Kreditorenbuchungen keine Vorsteuern
6466 <para>Bezugssteuern für aus dem Ausland bezogene Dienstleistungen müssen
6467 manuell verbucht werden.</para>
6469 <para>Wünsche für Anpassungen an den Schweizer Kontenplänen sowie
6470 Vorschläge für weitere (z.B. branchenspezifische) Kontenpläne bitte an
6471 <literal>empfang@revamp-it.ch</literal> senden.</para>
6474 <sect1 id="features.part_classification">
6475 <title>Artikelklassifizierung</title>
6478 <title>Übersicht</title>
6480 <para>Die Klassifizierung von Artikeln dient einer weiteren
6481 Gliederung, um zum Beispiel den Einkauf vom Verkauf zu trennen,
6482 gekennzeichnet durch eine Beschreibung (z.B. "Einkauf") und ein Kürzel
6483 (z.B. "E"). Für jede Klassifizierung besteht eine Beschreibung und
6484 eine Abkürzung die normalerweise aus einem Zeichen besteht, kann aber
6485 auf mehrere Zeichen erweitert werden, falls zur Unterscheidung
6486 notwendig. Sinnvoll sind jedoch nur maximal 2 Zeichen.</para>
6490 <title>Basisklassifizierung</title>
6492 <para>Als Basisklassifizierungen gibt es</para>
6496 <para>Einkauf</para>
6500 <para>Verkauf</para>
6504 <para>Handelsware</para>
6508 <para>Produktion</para>
6512 <para>- keine - (diese wird bei einer Aktualisierung für alle
6513 existierenden Artikel verwendet und ist gültig für Verkauf und
6518 <para>Es können weitere Klassifizierungen angelegt werden. So kann es
6519 z.B. für separat auszuweisende Artikel folgende Klassen geben:</para>
6523 <para>Lieferung (Logistik, Transport) mit Kürzel L</para>
6527 <para>Material (Verpackungsmaterial) mit Kürzel M</para>
6533 <title>Attribute</title>
6535 <para>Bisher haben die Klassifizierungen folgende Attribute, die auch
6536 alle gleichzeitg gültig sein können</para>
6540 <para>gültig für Verkauf - dieser Artikel kann im Verkauf genutzt
6545 <para>gültig für Einkauf - dieser Artikel kann im Einkauf genutzt
6550 <para>separat ausweisen - hierzu gibt es zur Dokumentengenerierung
6551 (LaTeX) eine zusätzliche Variable</para>
6555 <para>Für das Attribut "separat ausweisen" stehen in den
6556 LaTeX-Vorlagen die Variable <emphasis
6557 role="bold"><%non_separate_subtotal%> </emphasis>zur Verfügung,
6558 die alle nicht separat auszuweisenden Artikelkosten saldiert, sowie
6559 pro separat auszuweisenden Klassifizierungen die Variable<emphasis
6560 role="bold">< %separate_X_subtotal%></emphasis>, wobei X das
6561 Kürzel der Klassifizierung ist.</para>
6563 <para>Im obigen Beispiel wäre das für Lieferkosten <emphasis
6564 role="bold"><%separate_L_subtotal%></emphasis> und für
6565 Verpackungsmaterial <emphasis role="bold">
6566 <%separate_M_subtotal%></emphasis>.</para>
6570 <title>Zwei-Zeichen Abkürzung</title>
6572 <para>Der Typ des Artikels und die Klassifizierung werden durch zwei
6573 Buchstaben dargestellt. Der erste Buchstabe ist eine Lokalisierung des
6574 Artikel-Typs ('P','A','S'), deutsch 'W', 'E', und 'D' für Ware
6575 Erzeugnis oder Dienstleistung und ggf. weiterer Typen.</para>
6577 <para>Der zweite Buchstabe (und ggf. auch ein dritter, falls nötig)
6578 entspricht der lokalisierten Abkürzung der Klassifizierung.</para>
6580 <para>Diese Abkürzung wird überall beim Auflisten von Artikeln zur
6581 Erleichterung mit dargestellt.</para>
6585 <sect1 id="features.file_managment">
6586 <title>Dateiverwaltung (Mini-DMS)</title>
6589 <title>Übersicht</title>
6591 <para>Parallel zum alten WebDAV gibt es ein Datei-Management-System,
6592 das Dateien verschiedenen Typs verwaltet. Dies können</para>
6596 <para>aus ERP-Daten per LaTeX Template erzeugte
6597 PDF-Dokumente,</para>
6601 <para>zu bestimmten ERP-Daten gehörende Anhangdateien
6602 unterschiedlichen Formats,</para>
6606 <para>per Scanner eingelesene PDF-Dateien,</para>
6610 <para>per E-Mail empfangene Dateianhänge unterschiedlichen
6615 <para>sowie speziel für Artikel hochgeladene Bilder sein.</para>
6620 <screeninfo>Übersicht</screeninfo>
6624 <imagedata contentwidth="600" fileref="images/DMS-Overview.png"/>
6631 <title>Struktur</title>
6633 <para>Über eine vom Speichermedium unabhängige Zwischenschicht werden
6634 die Dateien und ihre Versionen in der Datenbank verwaltet. Darunter
6635 können verschiedene Implementierungen (Backends) gleichzeitig
6640 <para>Dateisystem</para>
6648 <para>Schnittstelle zu externen
6649 Dokumenten-Management-Systemen</para>
6653 <para>andere Datenbank</para>
6657 <para>etc ...</para>
6661 <para>Es gibt unterschiedliche Typen von Dateien. Jedem Typ läßt sich
6662 in der Mandantenkonfiguration ein bestimmtes Backend zuordnen.</para>
6666 <para>"document": Das sind entweder generierte, eingescannte oder
6667 hochgeladene PDF-Dateien, die zu bestimmten ERP-Daten
6668 (ERP-Objekte, wie z.B. Rechnung, Lieferschein) gehören.</para>
6672 <para>"attachment": zusätzlich hochgeladene Dokumente, die an
6673 bestimmte ERP-Objekte angehängt werden, z.B. technische
6674 Zeichnungen, Aufmaße. Diese können auch für Artikel, Lieferanten
6675 und Kunden hinterlegt sein.</para>
6679 <para>"image": Bilder für Artikel. Diese können auch verkleinert
6680 in einer Vorschau (Thumbnail) angezeigt werden.</para>
6684 <para>Zusätzlich werden in der Datenbank zu den Dateien neben der
6685 Zuordnung zu ERP-Objekten, Dateityp Dateinamen und Backend, in dem die
6686 Datei gespeichert ist, auch die Quelle der Datei notiert:</para>
6690 <para>"created": vom System erzeugte Dokumente"</para>
6694 <para>"uploaded": hochgeladene Dokumente</para>
6698 <para>"email": vom Mail-System empfangene Dateien</para>
6702 <para>"scanner[1]": von einem oder mehreren Scannern erzeugte
6703 Dateien. Existieren mehrere Scanner, so sind diese durch
6704 unterschiedliche Quellennamen zu definieren.</para>
6708 <para>Je nach Dateityp sind nur bestimmte Quellen zulässig. So gibt es
6709 für "attachment" und "image" nur die Quelle "uploaded". Für "document"
6710 gibt es auf jeden Fall die Quelle "created". Die Quellen "scanner" und
6711 "email" müssen derzeit in der Datenbank konfiguriert werden (siehe
6712 <xref linkend="file_management.dbconfig"/>).</para>
6716 <title>Anwendung</title>
6718 <para>Die Daten werden bei den ERP-Objekten als extra Reiter
6719 dargestellt. Eine Verkaufsrechnung z.B. hat die Reiter "Dokumente" und
6720 "Dateianhänge".</para>
6723 <screeninfo>Reiter "Dateianhänge"</screeninfo>
6727 <imagedata fileref="images/DMS-Anhaenge.png" scale="50"/>
6732 <para>Bei den Dateianhängen wird immer nur die aktuelle Version einer
6733 Datei angezeigt. Wird eine Datei mit gleichem Namen hochgeladen, so
6734 wird eine neue Version der Datei erstellt. Vorher wird der Anwender
6735 durch einen Dialog gefragt, ob er eine neue Version anlegen will oder
6736 ob er die Datei umbenennen will, falls es eine neue Datei sein
6740 <screeninfo>Reiter "Dateianhänge"</screeninfo>
6744 <imagedata contentwidth="40"
6745 fileref="images/DMS-Anhaenge-hochladen.png"
6751 <para>Es können mehrere Dateien gleichzeitig hochgeladen werden,
6752 solange in Summe die maximale Größe nicht überschritten wird (siehe
6753 <xref linkend="file_management.clientconfig"/>).</para>
6756 <screeninfo>Reiter "Dokumente"</screeninfo>
6760 <imagedata fileref="images/DMS-Dokumente.png" width="500"/>
6765 <para>Sind keine weiteren Quellen für Dokumente konfiguriert, so gibt
6766 es nur "erzeugte Dokumente". Es werden alle Versionen der generierten
6767 Datei angezeigt. Für Verkaufsrechnungen kommen keine anderen Quellen
6768 zur Geltung. Werden entsprechend der <xref
6769 linkend="file_management.dbconfig"/> zusätzliche Quellen konfiguriert,
6770 so sind diese z.B. bei Einkaufsrechnungen sichtbar:</para>
6773 <screeninfo>Reiter "Dokumente"</screeninfo>
6777 <imagedata contentwidth="600"
6778 fileref="images/DMS-Dokumente-Scanner.png"/>
6783 <para>Statt des Löschens wird hier die Datei zurück zur Quelle
6784 verschoben. Somit kann die Datei anschließend an ein anderes
6785 ERP-Objekt angehängt werden.</para>
6787 <para>Derzeit sind "Titel" und "Beschreibung" noch nicht genutzt. Sie
6788 sind bisher nur bei Bildern relevant.</para>
6792 <title>Konfigurierung</title>
6794 <sect3 id="file_management.clientconfig"
6795 xreflabel="Mandantenkonfigurierung">
6796 <title>Mandantenkonfiguration</title>
6799 <title>Reiter "Features"</title>
6801 <para>Unter dem Reiter <emphasis role="bold">Features</emphasis>
6802 im Abschnitt Dateimanagement ist neben dem "alten" WebDAV das
6803 Dateimangement generell zu- und abschaltbar, sowie die Zuordnung
6804 der Dateitypen zu Backends. Die Löschbarkeit von Dateien, sowie
6805 die maximale Uploadgröße sind Backend-unabhängig</para>
6808 <screeninfo>Mandantenkonfig Reiter "Features"</screeninfo>
6812 <imagedata fileref="images/DMS-ClientConfig.png" width="500"/>
6817 <para>Die einzelnen Backends sind einzeln einschaltbar.
6818 Spezifische Backend-Konfigurierungen sind hier noch
6823 <title>Reiter "Allgemeine Dokumentenanhänge"</title>
6825 <para>Unter dem Reiter <emphasis role="bold">Allgemeine
6826 Dokumentenanhänge</emphasis> kann für alle ERP-Dokumente (
6827 Angebote, Aufträge, Lieferscheine, Rechnungen im Verkauf und
6828 Einkauf ) allgemeingültige Anhänge hochgeladen werden.</para>
6831 <screeninfo>Mandantenkonfig Reiter "Allgemeine
6832 Dokumentenanhänge"</screeninfo>
6836 <imagedata fileref="images/DMS-Allgemeine-Dokumentenanhaenge.png"
6842 <para>Diese Anhänge werden beim Generieren von PDF-Dateien an die
6843 ERP-Dokumente angehängt, z.B. AGBs oder aktuelle Angebote. Es
6844 werden in dem Fall die Daten kopiert, sodass an den ERP-Dokumenten
6845 immer die Anhänge zum Generierungszeitpunkt eingebettet
6850 <sect3 id="file_management.dbconfig"
6851 xreflabel="Datenbank-Konfigurierung">
6852 <title>Datenbank-Konfigurierung</title>
6854 <para>Die zusätzlichen Quellen für "email" oder ein oder mehrere
6855 Scanner sind derzeit vom Administrator direkt in der
6856 Datenbanktabelle "user_preferences" einzurichten. Die "value" ist im
6857 JSON-Format mit den jeweiligen Werten des Verzeichnisses und der
6858 Beschreibung der Quelle.</para>
6861 id | login | namespace | version | key | value
6862 ----+-----------+--------------+---------+----------+---------------------------
6863 1 | #default# | file_sources | 0.00000 | scanner1 |
6864 {"dir":"/var/tmp/scanner1","desc":"Scanner Einkauf"}
6865 2 | #default# | file_sources | 0.00000 | scanner2 |
6866 {"dir":"/var/tmp/scanner2","desc":"Scanner Verkauf"}
6867 3 | #default# | file_sources | 0.00000 | emails |
6868 {"dir":"/var/tmp/emails","desc":"Empfangene Mails" }
6871 <para>Es ist daran gedacht, statt dem Default-Eintrag später für
6872 bestimmte Benutzer ('login') bestimmte Quellen zuzulassen. Dies wird
6873 nach Bedarf implementiert.</para>
6876 <sect3 id="file_management.kiviconfig"
6877 xreflabel="kivitendo-Konfigurationsdatei">
6878 <title>kivitendo-Konfigurationsdatei</title>
6880 <para>Dort ist im Abschnitt [paths] der relative oder absolute Pfad
6881 zum Dokumentenwurzelverzeichnis einzutragen. Dieser muss für den
6882 Webserver schreib- und lesbar sein, jedoch nicht ausführbar.</para>
6886 document_path = /var/local/kivi_documents
6889 <para>Unter diesem Wurzelverzeichnis wird pro Mandant automatisch
6890 ein Unterverzeichnis mit der ID des Mandanten angelegt.</para>
6896 <title>Webshop-Api</title>
6898 <para>Das Shopmodul bietet die Möglichkeit Onlineshopartikel und
6899 Onlineshopbestellungen zu verwalten und zu bearbeiten.</para>
6901 <para>Es ist Multishopfähig, d.h. Artikel können mehreren oder
6902 unterschiedlichen Shops zugeordnet werden. Bestellungen können aus
6903 mehreren Shops geholt werden.</para>
6905 <para>Zur Zeit bietet das Modul nur einen Connector zur REST-Api von
6906 Shopware. Weitere Connectoren können dazu programmiert und eingerichtet
6910 <title>Rechte für die Webshopapi</title>
6912 <para>In der Administration können folgende Rechte vergeben
6917 <para>Webshopartikel anlegen und bearbeiten</para>
6921 <para>Shopbestellungen holen und bearbeiten</para>
6925 <para>Shop anlegen und bearbeiten</para>
6931 <title>Konfiguration</title>
6933 <para>Unter System->Webshops können Shops angelegt und konfiguriert
6938 <imagedata contentdepth="500" contentwidth="700"
6939 fileref="images/Shop_Listing.png"/>
6945 <title>Webshopartikel</title>
6948 <title>Shopvariablenreiter in Artikelstammdaten</title>
6950 <para>Mit dem Recht "Shopartikel anlegen und bearbeiten" und des
6951 Markers <emphasis role="bold">"Shopartikel" in den Basisdaten
6952 </emphasis>zeigt sich der Reiter "Shopvariablen" in den
6953 Artikelstammdaten. Hier können jetzt die Artikel mit
6954 unterschiedlichen Beschreibung und/oder Preisen für die
6955 konfigutierten Shops angelegt und bearbeitet werden. An dieser
6956 Stelle können auch beliebig viele Bilder dem Shopartikel zugeordnet
6957 werden. Artikelbilder gelten für alle Shops.</para>
6961 <imagedata contentdepth="500" contentwidth="600"
6962 fileref="images/Shop_Artikel.png"/>
6966 <para>Die Artikelgruppen werden direkt vom Shopsystem geholt somit
6967 ist es möglich einen Artikel auch mehreren Gruppen
6972 <title>Shopartikelliste</title>
6974 <para>Unter dem Menu Webshop->Webshop Artikel hat man nochmal
6975 eine Gesamtübersicht. Von hier aus ist es möglich Artikel im Stapel
6976 unter verschiedenen Kriterien <alles><nur Preis><nur
6977 Bestand><Preis und Bestand> an die jeweiligen Shops
6982 <imagedata fileref="images/Shop_Artikel_Listing.png"/>
6989 <title>Bestellimport</title>
6991 <para>Unter dem Menupunkt Webshop->Webshop Import öffnet sich die
6992 Bestellimportsliste. Hier ist sind Möglichkeiten gegeben Neue
6993 Bestellungen vom Shop abzuholen, geholte Bestellungen im Stapel oder
6994 einzeln als Auftrag zu transferieren. Die Liste kann nach
6995 verschiedenen Kriterien gefiltert werden.</para>
6999 <imagedata fileref="images/Shop_Bestell.png"/>
7003 <para>Bei Einträgen in der Liste.</para>
7007 <para>keine Kundennummer: Es gibt ähnliche Kundendatensätze und
7008 der Datensatz konnte nicht eindeutig zugewiesen werden.</para>
7012 <para>Kundennummer und Rechnungen rot hinterlegt: Der Kunde hat
7013 offene Posten und kann deswegen nicht im Stapel übernommen
7018 <para>Rechnungsadresse grün hinterlegt: Der Kunde konnte eindeutig
7019 einem Datensatz zugeordnet werden. Die Shopbestellung kann im
7020 Stapel mit dem Button "Anwenden" und wenn markiert als Auftrag
7021 übernommen werden.</para>
7025 <para>Kundennummer vorhanden, aber die Checkbox "Auftrag
7026 erstellen" fehlt. Der Kunde hat vermutlich eine
7027 Shopauftragssperre.</para>
7031 <para>Lieferadresse grau hinterlegt: Optische Anzeige, dass es
7032 sich um eine unterschiedliche Lieferadresse handelt.
7033 Lieferadressen werden aber grundsätzlich beim Transferieren zu
7034 Aufträgen mit übernommen.</para>
7038 <para>In der Spalte Positionen/Betrag/Versandkosten zeigt sich ein
7039 tooltip zu den Positionen.</para>
7043 <para>Maske Auftrag erstellen</para>
7045 <para>Viele Shopsysteme haben drei verschieden Adresstypen Kunden-,
7046 Rechnungs-, und Lieferadresse, die sich auch alle unterscheiden
7047 können. Diese werden im oberen Bereich angezeigt. Es ist möglich jede
7048 dieser Adresse einzeln in kivitendo als Kunde zu übernehmen. Es werden
7049 die Werte Formulareingabe übernommen. Es wird bei einer Änderung
7050 allerdings nur diese in die kivitendo Kundenstammdaten übernommen, die
7051 Shopbestellung bleibt bestehen.</para>
7053 <para>Mit der mittleren Adresse(Rechnungsadresse) im oberen Bereich,
7054 kann ich den ausgewählten kivitendodatensatz des mittleren Bereich
7055 überschreiben. Das ist sinnvoll, wenn ich erkenne, das der Kunde z.B.
7056 umgezogen ist.</para>
7058 <para>Im mittleren Bereich das Adresslisting zeigt:</para>
7062 <para>Rot hinterlegt: Kunde hat eine Shopauftragssperre, diese
7063 muss zuerst deaktiviert werden bevor ich diesem Kunden eine
7064 Shopbestellung zuordnen kann.</para>
7068 <para>Kundenname fett und rot: Hier hat der Kunde eine Bemerkung
7069 in den Stammdaten. Ein Tooltip zeigt diese Bemerkung. Das kann dan
7070 auch der Grund für die Auftragssperre sein.</para>
7074 <para>Die Buttons "Auftrag erstellen" und "Kunde mit
7075 Rechnungsadresse überschreiben" zeigen sich erst, wenn ein Kunde
7076 aus dem Listing ausgewählt ist.</para>
7080 <para>Es ist aber möglich die Shopbestellung zu löschen.</para>
7084 <para>Ist eine Bestellung schon übernommen, zeigen sich an dieser
7085 Stelle, die dazugehörigen Belegverknüpfungen.</para>
7091 <title>Mapping der Daten</title>
7093 <para>Das Mapping der kivitendo Daten mit den Shopdaten geschieht in
7094 der Datei SL/ShopConnector/<SHOPCONNECTORNAME>.pm
7095 z.B.:SL/ShopConnector/Shopware.pm</para>
7097 <para>In dieser Datei gibt es einen Bereich wo die Bestellpostionen,
7098 die Bestellkopfdaten und die Artikeldaten gemapt werden. In dieser
7099 Datei kann ein individelles Mapping dann gemacht werden. Zu Shopware
7100 gibt es hier eine sehr gute Dokumentation: <ulink
7101 url="https://developers.shopware.com/developers-guide/rest-api/">https://developers.shopware.com/developers-guide/rest-api/</ulink></para>
7107 <title>Entwicklerdokumentation</title>
7109 <sect1 id="devel.globals" xreflabel="Globale Variablen">
7110 <title>Globale Variablen</title>
7113 <title>Wie sehen globale Variablen in Perl aus?</title>
7115 <para>Globale Variablen liegen in einem speziellen namespace namens
7116 "main", der von überall erreichbar ist. Darüber hinaus sind bareword
7117 globs global und die meisten speziellen Variablen sind...
7120 <para>Daraus ergeben sich folgende Formen:</para>
7124 <term><literal>$main::form</literal></term>
7127 <para>expliziter Namespace "main"</para>
7132 <term><literal>$::form</literal></term>
7135 <para>impliziter Namespace "main"</para>
7140 <term><literal>open FILE, "file.txt"</literal></term>
7143 <para><varname>FILE</varname> ist global</para>
7148 <term><literal>$_</literal></term>
7151 <para>speziell</para>
7156 <para>Im Gegensatz zu <productname>PHP</productname> gibt es kein
7157 Schlüsselwort wie "<function>global</function>", mit dem man
7158 importieren kann. <function>my</function>, <function>our</function>
7159 und <function>local</function> machen was anderes.</para>
7163 <term><literal>my $form</literal></term>
7166 <para>lexikalische Variable, gültig bis zum Ende des
7172 <term><literal>our $form</literal></term>
7175 <para><varname>$form</varname> referenziert ab hier
7176 <varname>$PACKAGE::form</varname>.</para>
7181 <term><literal>local $form</literal></term>
7184 <para>Alle Änderungen an <varname>$form</varname> werden am Ende
7185 des scopes zurückgesetzt</para>
7192 <title>Warum sind globale Variablen ein Problem?</title>
7194 <para>Das erste Problem ist <productname>FCGI</productname>.</para>
7196 <para><productname>SQL-Ledger</productname> hat fast alles im globalen
7197 namespace abgelegt, und erwartet, dass es da auch wiederzufinden ist.
7198 Unter <productname>FCGI</productname> müssen diese Sachen aber wieder
7199 aufgeräumt werden, damit sie nicht in den nächsten Request kommen.
7200 Einige Sachen wiederum sollen nicht gelöscht werden, wie zum Beispiel
7201 Datenbankverbindungen, weil die sehr lange zum Initialisieren
7204 <para>Das zweite Problem ist <function>strict</function>. Unter
7205 <function>strict</function> werden alle Variablen die nicht explizit
7206 mit <function>Package</function>, <function>my</function> oder
7207 <function>our</function> angegeben werden als Tippfehler angemarkert,
7208 dies hat, seit der Einführung, u.a. schon so manche langwierige
7209 Bug-Suche verkürzt. Da globale Variablen aber implizit mit Package
7210 angegeben werden, werden die nicht geprüft, und somit kann sich
7211 schnell ein Tippfehler einschleichen.</para>
7215 <title>Kanonische globale Variablen</title>
7217 <para>Um dieses Problem im Griff zu halten gibt es einige wenige
7218 globale Variablen, die kanonisch sind, d.h. sie haben bestimmte
7219 vorgegebenen Eigenschaften, und alles andere sollte anderweitig
7220 umhergereicht werden.</para>
7222 <para>Diese Variablen sind im Moment die folgenden neun:</para>
7226 <para><varname>$::form</varname></para>
7230 <para><varname>%::myconfig</varname></para>
7234 <para><varname>$::locale</varname></para>
7238 <para><varname>$::lxdebug</varname></para>
7242 <para><varname>$::auth</varname></para>
7246 <para><varname>$::lx_office_conf</varname></para>
7250 <para><varname>$::instance_conf</varname></para>
7254 <para><varname>$::dispatcher</varname></para>
7258 <para><varname>$::request</varname></para>
7262 <para>Damit diese nicht erneut als Müllhalde missbraucht werden, im
7263 Folgenden eine kurze Erläuterung der bestimmten vorgegebenen
7264 Eigenschaften (Konventionen):</para>
7267 <title>$::form</title>
7271 <para>Ist ein Objekt der Klasse
7272 "<classname>Form</classname>"</para>
7276 <para>Wird nach jedem Request gelöscht</para>
7280 <para>Muss auch in Tests und Konsolenscripts vorhanden
7285 <para>Enthält am Anfang eines Requests die Requestparameter vom
7290 <para>Kann zwar intern über Requestgrenzen ein Datenbankhandle
7291 cachen, das wird aber momentan absichtlich zerstört</para>
7295 <para><varname>$::form</varname> wurde unter <productname>SQL
7296 Ledger</productname> als Gottobjekt für alles missbraucht. Sämtliche
7297 alten Funktionen unter SL/ mutieren <varname>$::form</varname>, das
7298 heißt, alles was einem lieb ist (alle Variablen die einem ans Herz
7299 gewachsen sind), sollte man vor einem Aufruf (!) von zum Beispiel
7300 <function>IS->retrieve_customer()</function> in Sicherheit
7303 <para>Z.B. das vom Benutzer eingestellte Zahlenformat, bevor man
7304 Berechnung in einem bestimmten Format durchführt (SL/Form.pm Zeile
7305 3552, Stand version 2.7beta), um dies hinterher wieder auf den
7306 richtigen Wert zu setzen:</para>
7308 <programlisting> my $saved_numberformat = $::myconfig{numberformat};
7309 $::myconfig{numberformat} = $numberformat;
7310 # (...) div Berechnungen
7311 $::myconfig{numberformat} = $saved_numberformat;</programlisting>
7313 <para>Das Objekt der Klasse Form hat leider im Moment noch viele
7314 zentrale Funktionen die vom internen Zustand abhängen, deshalb bitte
7315 nie einfach zerstören oder überschreiben (zumindestens nicht kurz
7316 vor einem Release oder in Absprache über bspw. die devel-Liste ;-).
7317 Es geht ziemlich sicher etwas kaputt.</para>
7319 <para><varname>$::form</varname> ist gleichzeitig der Standard Scope
7320 in den <productname>Template::Toolkit</productname> Templates
7321 außerhalb der Controller: der Ausdruck <function>[% var
7322 %]</function> greift auf <varname>$::form->{var}</varname> zu.
7323 Unter Controllern ist der Standard Scope anders, da lautet der
7324 Zugriff <function>[% FORM.var %]</function>. In Druckvorlagen sind
7325 normale Variablen ebenfall im <varname>$::form</varname> Scope, d.h.
7326 <function><%var%></function> zeigt auf
7327 <varname>$::form->{var}</varname>. Nochmal von der anderen Seite
7328 erläutert, innerhalb von (Web-)Templates sieht man häufiger solche
7331 <programlisting>[%- IF business %]
7332 # (... Zeig die Auswahlliste Kunden-/Lieferantentyp an)
7333 [%- END %]</programlisting>
7335 <para>Entweder wird hier dann $::form->{business} ausgewertet
7336 oder aber der Funktion
7337 <function>$form->parse_html_template</function> wird explizit
7338 noch ein zusätzlicher Hash übergeben, der dann auch in den
7339 (Web-)Templates zu Verfügung steht, bspw. so:</para>
7341 <programlisting>$form->parse_html_template("is/form_header", \%TMPL_VAR);</programlisting>
7343 <para>Innerhalb von Schleifen wird
7344 <varname>$::form->{TEMPLATE_ARRAYS}{var}[$index]</varname>
7345 bevorzugt, wenn vorhanden. Ein Beispiel findet sich in SL/DO.pm,
7346 welches über alle Positionen eines Lieferscheins in Schleife
7349 <programlisting>for $i (1 .. $form->{rowcount}) {
7351 push @{ $form->{TEMPLATE_ARRAYS}{runningnumber} }, $position;
7352 push @{ $form->{TEMPLATE_ARRAYS}{number} }, $form->{"partnumber_$i"};
7353 push @{ $form->{TEMPLATE_ARRAYS}{description} }, $form->{"description_$i"};
7359 <title>%::myconfig</title>
7363 <para>Das einzige Hash unter den globalen Variablen</para>
7367 <para>Wird spätestens benötigt wenn auf die Datenbank
7368 zugegriffen wird</para>
7372 <para>Wird bei jedem Request neu erstellt.</para>
7376 <para>Enthält die Userdaten des aktuellen Logins</para>
7380 <para>Sollte nicht ohne Filterung irgendwo gedumpt werden oder
7381 extern serialisiert werden, weil da auch der Datenbankzugriff
7382 für diesen user drinsteht.</para>
7386 <para>Enthält unter anderem Datumsformat dateformat und
7387 Nummernformat numberformat</para>
7391 <para>Enthält Datenbankzugriffinformationen</para>
7395 <para><varname>%::myconfig</varname> ist im Moment der Ersatz für
7396 ein Userobjekt. Die meisten Funktionen, die etwas anhand des
7397 aktuellen Users entscheiden müssen, befragen
7398 <varname>%::myconfig</varname>. Innerhalb der Anwendungen sind dies
7399 überwiegend die Daten, die sich unter <guimenu>Programm</guimenu>
7400 -> <guimenuitem>Einstellungen</guimenuitem> befinden, bzw. die
7401 Informationen über den Benutzer die über die
7402 Administrator-Schnittstelle eingegeben wurden.</para>
7406 <title>$::locale</title>
7410 <para>Objekt der Klasse "Locale"</para>
7414 <para>Wird pro Request erstellt</para>
7418 <para>Muss auch für Tests und Scripte immer verfügbar
7423 <para>Cached intern über Requestgrenzen hinweg benutzte
7428 <para>Lokalisierung für den aktuellen User. Alle Übersetzungen,
7429 Zahlen- und Datumsformatierungen laufen über dieses Objekt.</para>
7433 <title>$::lxdebug</title>
7437 <para>Objekt der Klasse "LXDebug"</para>
7441 <para>Wird global gecached</para>
7445 <para>Muss immer verfügbar sein, in nahezu allen
7450 <para><varname>$::lxdebug</varname> stellt Debuggingfunktionen
7451 bereit, wie "<function>enter_sub</function>" und
7452 "<function>leave_sub</function>", mit denen in den alten Modulen ein
7453 brauchbares Tracing gebaut ist, "<function>log_time</function>", mit
7454 der man die Wallclockzeit seit Requeststart loggen kann, sowie
7455 "<function>message</function>" und "<function>dump</function>" mit
7456 denen man flott Informationen ins Log (tmp/kivitendo-debug.log)
7459 <para>Beispielsweise so:</para>
7461 <programlisting>$main::lxdebug->message(0, 'Meine Konfig:' . Dumper (%::myconfig));
7462 $main::lxdebug->message(0, 'Wer bin ich? Kunde oder Lieferant:' . $form->{vc});</programlisting>
7466 <title>$::auth</title>
7470 <para>Objekt der Klasse "SL::Auth"</para>
7474 <para>Wird global gecached</para>
7478 <para>Hat eine permanente DB Verbindung zur Authdatenbank</para>
7482 <para>Wird nach jedem Request resettet.</para>
7486 <para><varname>$::auth</varname> stellt Funktionen bereit um die
7487 Rechte des aktuellen Users abzufragen. Obwohl diese Informationen
7488 vom aktuellen User abhängen wird das Objekt aus
7489 Geschwindigkeitsgründen nur einmal angelegt und dann nach jedem
7490 Request kurz resettet.</para>
7492 <para>Dieses Objekt kapselt auch den gerade aktiven Mandanten.
7493 Dessen Einstellungen können über
7494 <literal>$::auth->client</literal> abgefragt werden; Rückgabewert
7495 ist ein Hash mit den Werten aus der Tabelle
7496 <literal>auth.clients</literal>.</para>
7500 <title>$::lx_office_conf</title>
7504 <para>Objekt der Klasse
7505 "<classname>SL::LxOfficeConf</classname>"</para>
7509 <para>Global gecached</para>
7513 <para>Repräsentation der
7514 <filename>config/kivitendo.conf[.default]</filename>-Dateien</para>
7518 <para>Globale Konfiguration. Configdateien werden zum Start gelesen
7519 und danach nicht mehr angefasst. Es ist derzeit nicht geplant, dass
7520 das Programm die Konfiguration ändern kann oder sollte.</para>
7522 <para>Beispielsweise ist über den Konfigurationseintrag [debug] die
7523 Debug- und Trace-Log-Datei wie folgt konfiguriert und
7526 <programlisting>[debug]
7527 file_name = /tmp/kivitendo-debug.log</programlisting>
7529 <para>ist der Key <varname>file</varname> im Programm als
7530 <varname>$::lx_office_conf->{debug}{file}</varname>
7534 <para>Zugriff auf die Konfiguration erfolgt im Moment über
7535 Hashkeys, sind also nicht gegen Tippfehler abgesichert.</para>
7540 <title>$::instance_conf</title>
7544 <para>Objekt der Klasse
7545 "<classname>SL::InstanceConfiguration</classname>"</para>
7549 <para>wird pro Request neu erstellt</para>
7553 <para>Funktioniert wie <varname>$::lx_office_conf</varname>,
7554 speichert aber Daten die von der Instanz abhängig sind. Eine Instanz
7555 ist hier eine Mandantendatenbank. Beispielsweise überprüft
7556 <programlisting>$::instance_conf->get_inventory_system eq 'perpetual'</programlisting>
7557 ob die berüchtigte Bestandsmethode zur Anwendung kommt.</para>
7561 <title>$::dispatcher</title>
7565 <para>Objekt der Klasse
7566 "<varname>SL::Dispatcher</varname>"</para>
7570 <para>wird pro Serverprozess erstellt.</para>
7574 <para>enthält Informationen über die technische Verbindung zum
7579 <para>Der dritte Punkt ist auch der einzige Grund warum das Objekt
7580 global gespeichert wird. Wird vermutlich irgendwann in einem anderen
7581 Objekt untergebracht.</para>
7585 <title>$::request</title>
7589 <para>Hashref (evtl später Objekt)</para>
7593 <para>Wird pro Request neu initialisiert.</para>
7597 <para>Keine Unterstruktur garantiert.</para>
7601 <para><varname>$::request</varname> ist ein generischer Platz um
7602 Daten "für den aktuellen Request" abzulegen. Sollte nicht für action
7603 at a distance benutzt werden, sondern um lokales memoizing zu
7604 ermöglichen, das garantiert am Ende des Requests zerstört
7607 <para>Vieles von dem, was im moment in <varname>$::form</varname>
7608 liegt, sollte eigentlich hier liegen. Die groben
7609 Differentialkriterien sind:</para>
7613 <para>Kommt es vom User, und soll unverändert wieder an den
7614 User? Dann <varname>$::form</varname>, steht da eh schon</para>
7618 <para>Sind es Daten aus der Datenbank, die nur bis zum Ende des
7619 Requests gebraucht werden? Dann
7620 <varname>$::request</varname></para>
7624 <para>Muss ich von anderen Teilen des Programms lesend drauf
7625 zugreifen? Dann <varname>$::request</varname>, aber Zugriff über
7626 Wrappermethode</para>
7633 <title>Ehemalige globale Variablen</title>
7635 <para>Die folgenden Variablen waren einmal im Programm, und wurden
7639 <title>$::cgi</title>
7643 <para>war nötig, weil cookie Methoden nicht als
7644 Klassenfunktionen funktionieren</para>
7648 <para>Aufruf als Klasse erzeugt Dummyobjekt was im
7649 Klassennamespace gehalten wird und über Requestgrenzen
7654 <para>liegt jetzt unter
7655 <varname>$::request->{cgi}</varname></para>
7661 <title>$::all_units</title>
7665 <para>war nötig, weil einige Funktionen in Schleifen zum Teil
7666 ein paar hundert mal pro Request eine Liste der Einheiten
7667 brauchen, und de als Parameter durch einen Riesenstack von
7668 Funktionen geschleift werden müssten.</para>
7672 <para>Liegt jetzt unter
7673 <varname>$::request->{cache}{all_units}</varname></para>
7678 <function>AM->retrieve_all_units()</function> gesetzt oder
7685 <title>%::called_subs</title>
7689 <para>wurde benutzt um callsub deep recursions
7694 <para>Wurde entfernt, weil callsub nur einen Bruchteil der
7695 möglichen Rekursioenen darstellt, und da nie welche
7700 <para>komplette recursion protection wurde entfernt.</para>
7707 <sect1 id="devel.fcgi">
7708 <title>Entwicklung unter FastCGI</title>
7710 <sect2 id="devel.fcgi.general">
7711 <title>Allgemeines</title>
7713 <para>Wenn Änderungen in der Konfiguration von kivitendo gemacht
7714 werden, muss der Webserver neu gestartet werden.</para>
7716 <para>Bei der Entwicklung für FastCGI ist auf ein paar Fallstricke zu
7717 achten. Dadurch, dass das Programm in einer Endlosschleife läuft,
7718 müssen folgende Aspekte beachtet werden.</para>
7721 <sect2 id="devel.fcgi.exiting">
7722 <title>Programmende und Ausnahmen</title>
7724 <para>Betrifft die Funktionen <function>warn</function>,
7725 <function>die</function>, <function>exit</function>,
7726 <function>carp</function> und <function>confess</function>.</para>
7728 <para>Fehler, die dass Programm normalerweise sofort beenden (fatale
7729 Fehler), werden mit dem FastCGI Dispatcher abgefangen, um das Programm
7730 am Laufen zu halten. Man kann mit <function>die</function>,
7731 <function>confess</function> oder <function>carp</function> Fehler
7732 ausgeben, die dann vom Dispatcher angezeigt werden. Die kivitendo
7733 eigene <function>$::form-</function>error()> tut im Prinzip das
7734 Gleiche, mit ein paar Extraoptionen. <function>warn</function> und
7735 <function>exit</function> hingegen werden nicht abgefangen.
7736 <function>warn</function> wird direkt nach STDERR, also in Server Log
7737 eine Nachricht schreiben (sofern in der Konfiguration nicht die
7738 Warnungen in das kivitendo Log umgeleitet wurden), und
7739 <function>exit</function> wird die Ausführung beenden.</para>
7741 <para>Prinzipiell ist es kein Beinbruch, wenn sich der Prozess
7742 beendet, fcgi wird ihn sofort neu starten. Allerdings sollte das die
7743 Ausnahme sein. Quintessenz: Bitte kein <function>exit</function>
7744 benutzen, alle anderen Exceptionmechanismen sind ok.</para>
7747 <sect2 id="devel.fcgi.globals">
7748 <title>Globale Variablen</title>
7750 <para>Um zu vermeiden, dass Informationen von einem Request in einen
7751 anderen gelangen, müssen alle globalen Variablen vor einem Request
7752 sauber initialisiert werden. Das ist besonders wichtig im
7753 <varname>$::cgi</varname> und <varname>$::auth</varname> Objekt, weil
7754 diese nicht gelöscht werden pro Instanz, sondern persistent gehalten
7757 <para>In <classname>SL::Dispatcher</classname> gibt es einen sauber
7758 abgetrennten Block, der alle kanonischen globalen Variablen listet und
7759 erklärt. Bitte keine anderen einführen ohne das sauber zu
7760 dokumentieren.</para>
7762 <para>Datenbankverbindungen wird noch ein Guide verfasst werden, wie
7763 man sicher geht, dass man die richtige erwischt.</para>
7766 <sect2 id="devel.fcgi.performance">
7767 <title>Performance und Statistiken</title>
7769 <para>Die kritischen Pfade des Programms sind die Belegmasken, und
7770 unter diesen ganz besonders die Verkaufsrechnungsmaske. Ein Aufruf der
7771 Rechnungsmaske in kivitendo 2.4.3 stable dauert auf einem Core2duo mit
7772 4GB Arbeitsspeicher und Ubuntu 9.10 eine halbe Sekunde. In der 2.6.0
7773 sind es je nach Menge der definierten Variablen 1-2s. Ab der
7774 Moose/Rose::DB Version sind es 5-6s.</para>
7776 <para>Mit FastCGI ist die neuste Version auf 0,26 Sekunden selbst in
7777 den kritischen Pfaden, unter 0,15 sonst.</para>
7781 <sect1 id="db-upgrade-files" xreflabel="Datenbank-Upgradedateien">
7782 <title>SQL-Upgradedateien</title>
7784 <sect2 id="db-upgrade-files.introduction"
7785 xreflabel="Einführung in die Datenbank-Upgradedateien">
7786 <title>Einführung</title>
7788 <para>Datenbankupgrades werden über einzelne Upgrade-Scripte
7789 gesteuert, die sich im Verzeichnis
7790 <filename>sql/Pg-upgrade2</filename> befinden. In diesem Verzeichnis
7791 muss pro Datenbankupgrade eine Datei existieren, die neben den
7792 eigentlich auszuführenden SQL- oder Perl-Befehlen einige
7793 Kontrollinformationen enthält.</para>
7795 <para>Kontrollinformationen definieren Abhängigkeiten und Prioritäten,
7796 sodass Datenbankscripte zwar in einer sicheren Reihenfolge ausgeführt
7797 werden (z.B. darf ein <literal>ALTER TABLE</literal> erst ausgeführt
7798 werden, wenn die Tabelle mit <literal>CREATE TABLE</literal> angelegt
7799 wurde), diese Reihenfolge aber so flexibel ist, dass man keine
7800 Versionsnummern braucht.</para>
7802 <para>kivitendo merkt sich dabei, welches der Upgradescripte in
7803 <filename>sql/Pg-upgrade2</filename> bereits durchgeführt wurde und
7804 führt diese nicht erneut aus. Dazu dient die Tabelle
7805 "<literal>schema_info</literal>", die bei der Anmeldung automatisch
7806 angelegt wird.</para>
7809 <sect2 id="db-upgrade-files.format"
7810 xreflabel="Format der Upgradedateien">
7811 <title>Format der Kontrollinformationen</title>
7813 <para>Die Kontrollinformationen sollten sich am Anfang der jeweiligen
7814 Upgradedatei befinden. Jede Zeile, die Kontrollinformationen enthält,
7815 hat dabei das folgende Format:</para>
7817 <para>Für SQL-Upgradedateien:</para>
7819 <programlisting>-- @key: value</programlisting>
7821 <para>Für Perl-Upgradedateien:</para>
7823 <programlisting># @key: value</programlisting>
7825 <para>Leerzeichen vor "<varname>value</varname>" werden
7828 <para>Die folgenden Schlüsselworte werden verarbeitet:</para>
7832 <term><varname>tag</varname></term>
7835 <para>Wird zwingend benötigt. Dies ist der "Name" des Upgrades.
7836 Dieser "tag" kann von anderen Kontrolldateien in ihren
7837 Abhängigkeiten verwendet werden (Schlüsselwort
7838 "<varname>depends</varname>"). Der "tag" ist auch der Name, der
7839 in der Datenbank eingetragen wird.</para>
7841 <para>Normalerweise sollte die Kontrolldatei genau so heißen wie
7842 der "tag", nur mit der Endung ".sql" bzw. "pl".</para>
7844 <para>Ein Tag darf nur aus alphanumerischen Zeichen sowie den
7845 Zeichen _ - ( ) bestehen. Insbesondere sind Leerzeichen nicht
7846 erlaubt und sollten stattdessen mit Unterstrichen ersetzt
7852 <term><varname>charset</varname></term>
7855 <para>Empfohlen. Gibt den Zeichensatz an, in dem das Script
7856 geschrieben wurde, z.B. "<literal>UTF-8</literal>". Aus
7857 Kompatibilitätsgründen mit alten Upgrade-Scripten wird bei
7858 Abwesenheit des Tags für SQL-Upgradedateien der Zeichensatz
7859 "<literal>ISO-8859-15</literal>" angenommen. Perl-Upgradescripte
7860 hingegen müssen immer in UTF-8 encodiert sein und sollten
7861 demnach auch ein "<literal>use utf8;</literal>"
7867 <term><varname>description</varname></term>
7870 <para>Benötigt. Eine Beschreibung, was in diesem Update
7871 passiert. Diese wird dem Benutzer beim eigentlichen
7872 Datenbankupdate angezeigt. Während der Tag in Englisch gehalten
7873 sein sollte, sollte die Beschreibung auf Deutsch
7879 <term><varname>depends</varname></term>
7882 <para>Optional. Eine mit Leerzeichen getrennte Liste von "tags",
7883 von denen dieses Upgradescript abhängt. kivitendo stellt sicher,
7884 dass die in dieser Liste aufgeführten Scripte bereits
7885 durchgeführt wurden, bevor dieses Script ausgeführt wird.</para>
7887 <para>Abhängigkeiten werden rekursiv betrachtet. Wenn also ein
7888 Script "b" existiert, das von Änderungen in "a" abhängt, und
7889 eine neue Kontrolldatei für "c" erstellt wird, die von
7890 Änderungen in "a" und "b" abhängt, so genügt es, in "c" nur den
7891 Tag "b" als Abhängigkeit zu definieren.</para>
7893 <para>Es ist nicht erlaubt, sich selbst referenzierende
7894 Abhängigkeiten zu definieren (z.B. "a" -> "b", "b" -> "c"
7895 und "c" -> "a").</para>
7900 <term><varname>priority</varname></term>
7903 <para>Optional. Ein Zahlenwert, der die Reihenfolge bestimmt, in
7904 der Scripte ausgeführt werden, die die gleichen
7905 Abhängigkeitstiefen besitzen. Fehlt dieser Parameter, so wird
7906 der Wert 1000 benutzt.</para>
7908 <para>Dies ist reine Kosmetik. Für echte Reihenfolgen muss
7909 "depends" benutzt werden. kivitendo sortiert die auszuführenden
7910 Scripte zuerst nach der Abhängigkeitstiefe (wenn "z" von "y"
7911 abhängt und "y" von "x", so hat "z" eine Abhängigkeitstiefe von
7912 2, "y" von 1 und "x" von 0. "x" würde hier zuerst ausgeführt,
7913 dann "y", dann "z"), dann nach der Priorität und bei gleicher
7914 Priorität alphabetisch nach dem "tag".</para>
7919 <term><varname>ignore</varname></term>
7922 <para>Optional. Falls der Wert auf 1 (true) steht, wird das
7923 Skript bei der Anmeldung ignoriert und entsprechend nicht
7930 <sect2 id="db-upgrade-files.format-perl-files"
7931 xreflabel="Format von Perl-Upgradedateien">
7932 <title>Format von in Perl geschriebenen
7933 Datenbankupgradescripten</title>
7935 <para>In Perl geschriebene Datenbankscripte werden nicht einfach so
7936 ausgeführt sondern müssen sich an gewisse Konventionen halten. Dafür
7937 bekommen sie aber auch einige Komfortfunktionen bereitgestellt.</para>
7939 <para>Ein Upgradescript stellt dabei eine vollständige Objektklasse
7940 dar, die vom Elternobjekt "<literal>SL::DBUpgrade2::Base</literal>"
7941 erben und eine Funktion namens "<literal>run</literal>" zur Verfügung
7942 stellen muss. Das Script wird ausgeführt, indem eine Instanz dieser
7943 Klasse erzeugt und darauf die erwähnte "<literal>run</literal>"
7944 aufgerufen wird.</para>
7946 <para>Zu beachten ist, dass sich der Paketname der Datei aus dem Wert
7947 für "<literal>@tag</literal>" ableitet. Dabei werden alle Zeichen, die
7948 in Paketnamen ungültig wären (gerade Bindestriche), durch Unterstriche
7949 ersetzt. Insgesamt sieht der Paketname wie folgt aus:
7950 "<literal>SL::DBUpgrade2::tag</literal>".</para>
7952 <para>Welche Komfortfunktionen zur Verfügung stehen, erfahren Sie in
7953 der Perl-Dokumentation zum oben genannten Modul; aufzurufen mit
7954 "<command>perldoc SL/DBUpgrade2/Base.pm</command>".</para>
7956 <para>Ein Mindestgerüst eines gültigen Perl-Upgradescriptes sieht wie
7959 <programlisting># @tag: beispiel-upgrade-file42
7960 # @description: Ein schönes Beispielscript
7961 # @depends: release_3_1_0
7962 package SL::DBUpgrade2::beispiel_upgrade_file42;
7967 use parent qw(SL::DBUpgrade2::Base);
7972 # hier Aktionen ausführen
7981 <sect2 id="db-upgrade-files.dbupgrade-tool"
7982 xreflabel="Hilfsscript dbupgrade2_tool.pl">
7983 <title>Hilfsscript dbupgrade2_tool.pl</title>
7985 <para>Um die Arbeit mit den Abhängigkeiten etwas zu erleichtern,
7986 existiert ein Hilfsscript namens
7987 "<filename>scripts/dbupgrade2_tool.pl</filename>". Es muss aus dem
7988 kivitendo-ERP-Basisverzeichnis heraus aufgerufen werden. Dieses Tool
7989 liest alle Datenbankupgradescripte aus dem Verzeichnis
7990 <filename>sql/Pg-upgrade2</filename> aus. Es benutzt dafür die
7991 gleichen Methoden wie kivitendo selber, sodass alle Fehlersituationen
7992 von der Kommandozeile überprüft werden können.</para>
7994 <para>Wird dem Script kein weiterer Parameter übergeben, so wird nur
7995 eine Überprüfung der Felder und Abhängigkeiten vorgenommen. Man kann
7996 sich aber auch Informationen auf verschiedene Art ausgeben
8001 <para>Listenform: "<command>./scripts/dbupgrade2_tool.pl
8002 --list</command>"</para>
8004 <para>Gibt eine Liste aller Scripte aus. Die Liste ist in der
8005 Reihenfolge sortiert, in der kivitendo die Scripte ausführen
8006 würde. Es werden neben der Listenposition der Tag, die
8007 Abhängigkeitstiefe und die Priorität ausgegeben.</para>
8011 <para>Baumform: "<command>./scripts/dbupgrade2_tool.pl
8012 --tree</command>"</para>
8014 <para>Listet alle Tags in Baumform basierend auf den
8015 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte, von
8016 denen keine anderen abhängen. Die Unterknoten sind Scripte, die
8017 beim übergeordneten Script als Abhängigkeit eingetragen
8021 <listitem id="db-upgrade-files.dbupgrade-tool.reverse-tree">
8022 <para>Umgekehrte Baumform: "<command>./scripts/dbupgrade2_tool.pl
8023 --rtree</command>"</para>
8025 <para>Listet alle Tags in Baumform basierend auf den
8026 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte mit
8027 der geringsten Abhängigkeitstiefe. Die Unterknoten sind Scripte,
8028 die das übergeordnete Script als Abhängigkeit eingetragen
8033 <para>Baumform mit Postscriptausgabe:
8034 "<command>./scripts/dbupgrade2_tool.pl
8035 --graphviz</command>"</para>
8037 <para>Benötigt das Tool "<command>graphviz</command>", um mit
8038 seiner Hilfe die <link
8039 linkend="db-upgrade-files.dbupgrade-tool.reverse-tree">umgekehrte
8040 Baumform</link> in eine Postscriptdatei namens
8041 "<filename>db_dependencies.ps</filename>" auszugeben. Dies ist
8042 vermutlich die übersichtlichste Form, weil hierbei jeder Knoten
8043 nur einmal ausgegeben wird. Bei den Textmodusbaumformen hingegen
8044 können Knoten und all ihre Abhängigkeiten mehrfach ausgegeben
8049 <para>Scripte, von denen kein anderes Script abhängt:
8050 "<command>./scripts/dbupgrade2_tool.pl --nodeps</command>"</para>
8052 <para>Listet die Tags aller Scripte auf, von denen keine anderen
8053 Scripte abhängen.</para>
8059 <sect1 id="translations-languages" xreflabel="Translations and languages">
8060 <title>Translations and languages</title>
8062 <sect2 id="translations-languages.introduction"
8063 xreflabel="Introduction to translations and languages">
8064 <title>Introduction</title>
8067 <para>Dieser Abschnitt ist in Englisch geschrieben, um
8068 internationalen Übersetzern die Arbeit zu erleichtern.</para>
8071 <para>This section describes how localization packages in kivitendo
8072 are built. Currently the only language fully supported is German, and
8073 since most of the internal messages are held in English the English
8074 version is usable too.</para>
8077 <sect2 id="translations-languages.character-set"
8078 xreflabel="Character set">
8079 <title>Character set</title>
8081 <para>All files included in a language pack must use UTF-8 as their
8085 <sect2 id="translations-languages.file-structure"
8086 xreflabel="File structure">
8087 <title>File structure</title>
8089 <para>The structure of locales in kivitendo is:</para>
8091 <programlisting>kivitendo/locale/<langcode>/</programlisting>
8093 <para>where <langcode> stands for an abbreviation of the
8094 language package. The builtin packages use two letter <ulink
8095 url="http://en.wikipedia.org/wiki/ISO_639-1">ISO 639-1</ulink> codes,
8096 but the actual name is not relevant for the program and can easily be
8098 url="http://en.wikipedia.org/wiki/IETF_language_tag">IETF language
8099 tags</ulink> (i.e. "en_GB"). In fact the original language packages
8100 from SQL Ledger are named in this way.</para>
8102 <para>In such a language directory the following files are
8107 <term>LANGUAGE</term>
8110 <para>This file is mandatory.</para>
8112 <para>The <filename>LANGUAGE</filename> file contains the self
8113 descripted name of the language. It should contain a native
8114 representation first, and in parenthesis an english translation
8115 after that. Example:</para>
8117 <programlisting>Deutsch (German)</programlisting>
8125 <para>This file is mandatory.</para>
8127 <para>The central translation file. It is essentially an inline
8128 Perl script autogenerated by <command>locales.pl</command>. To
8129 generate it, generate the directory and the two files mentioned
8130 above, and execute the following command:</para>
8132 <programlisting>scripts/locales.pl <langcode></programlisting>
8134 <para>Otherwise you can simply copy one of the other languages.
8135 You will be told how many are missing like this:</para>
8137 <programlisting>$ scripts/locales.pl en
8138 English - 0.6% - 2015/2028 missing</programlisting>
8140 <para>A file named "<filename>missing</filename>" will be
8141 generated and can be edited. You can also edit the
8142 "<filename>all</filename>" file directly. Edit everything you
8143 like to fit the target language and execute
8144 <command>locales.pl</command> again. See how the missing words
8150 <term>Num2text</term>
8153 <para>Legacy code from SQL Ledger. It provides a means for
8154 numbers to be converted into natural language, like
8155 <literal>1523 => one thousand five hundred twenty
8156 three</literal>. If you want to provide it, it must be inlinable
8157 Perl code which provides a <function>num2text</function> sub. If
8158 an <function>init</function> sub exists it will be executed
8161 <para>Only used in the check and receipt printing module.</para>
8166 <term>special_chars</term>
8169 <para>kivitendo comes with a lot of interfaces to different
8170 formats, some of which are rather picky with their accepted
8171 charset. The <filename>special_chars</filename> file contains a
8172 listing of chars not suited for different file format and
8173 provides substitutions. It is written in "Simple Ini" style,
8174 containing a block for every file format.</para>
8176 <para>First entry should be the order of substitution for
8177 entries as a whitespace separated list. All entries are
8178 interpolated, so <literal>\n</literal>, <literal>\x20</literal>
8179 and <literal>\\</literal> all work.</para>
8181 <para>After that every entry is a special char that should be
8182 translated when writing text into such a file.</para>
8184 <para>Example:</para>
8186 <programlisting>[Template/XML]
8187 order=& < > \n
8191 \n=<br></programlisting>
8193 <para>Note the importance of the order in this example.
8194 Substituting < and > befor & would lead to $gt; become
8197 <para>For a list of valid formats, see the German
8198 <filename>special_chars</filename> entry. As of this writing the
8199 following are recognized:</para>
8201 <programlisting>HTML
8206 Template/OpenDocument
8207 filenames</programlisting>
8209 <para>The last of which is very machine dependant. Remember that
8210 a lot of characters are forbidden by some filesystems, for
8211 example MS Windows doesn't like ':' in its files where Linux
8212 doesn't mind that. If you want the files created with your
8213 language pack to be portable, find all chars that could cause
8219 <term>missing</term>
8222 <para>This file is not a part of the language package
8225 <para>This is a file generated by
8226 <command>scripts/locales.pl</command> while processing your
8227 locales. It's only to have the missing entries singled out and
8228 does not belong to a language package.</para>
8236 <para>This file is not a part of the language package
8239 <para>Another file generated by
8240 <command>scripts/locales.pl</command>. If for any reason a
8241 translation does not appear anymore and can be deleted, it gets
8242 moved here. The last 50 or so entries deleted are saved here in
8243 case you made a typo, so that you don't have to translate
8244 everything again. If a tranlsation is missing, the lost file is
8245 checked first. If you maintain a language package, you might
8246 want to keep this safe somewhere.</para>
8251 <term>more/all</term>
8254 <para>This subdir and file is not a part of the language package
8257 <para>If the directory more exists and contains a file called
8258 all it will be parsed in addition to the mandatory all (see
8259 above). The file is useful if you want to change some
8260 translations for the current installation without conflicting
8261 further upgrades. The file is not autogenerated and has the same
8262 format as the all, but needs another key (more_texts). See the
8263 german translation for an example or copy the following code:
8266 # -*- coding: utf-8; -*-
8271 # These are additional texts for custom translations.
8272 # The format is the same as for the normal file all, only
8273 # with another key (more_texts instead of texts).
8274 # The file has the form of 'english text' => 'foreign text',
8276 $self->{more_texts} = {
8278 'Ship via' => 'Terms of delivery',
8279 'Shipping Point' => 'Delivery time',
8281 </programlisting></para>
8288 <sect1 id="devel.testsuite">
8289 <title>Die kivitendo-Test-Suite</title>
8291 <sect2 id="devel.testsuite.intro">
8292 <title>Einführung</title>
8294 <para>kivitendo enthält eine Suite für automatisierte Tests. Sie
8295 basiert auf dem Standard-Perl-Modul
8296 <literal>Test::More</literal>.</para>
8298 <para>Die grundlegenden Fakten sind:</para>
8302 <para>Alle Tests liegen im Unterverzeichnis
8303 <filename>t/</filename>.</para>
8307 <para>Ein Script (bzw. ein Test) in <filename>t/</filename>
8308 enthält einen oder mehrere Testfälle.</para>
8312 <para>Alle Dateinamen von Tests enden auf <literal>.t</literal>.
8313 Es sind selbstständig ausführbare Perl-Scripte.</para>
8317 <para>Die Test-Suite besteht aus der Gesamtheit aller Tests,
8318 sprich aller Scripte in <filename>t/</filename>, deren Dateiname
8319 auf <literal>.t</literal> endet.</para>
8324 <sect2 id="devel.testsuite.prerequisites">
8325 <title>Voraussetzungen</title>
8327 <para>Für die Ausführung werden neben den für kivitendo eh schon
8328 benötigten Module noch weitere Perl-Module benötigt. Diese
8333 <para><literal>Test::Deep</literal> (Debian-Paketname:
8334 <literal>libtest-deep-perl</literal>; Fedora:
8335 <literal>perl-Test-Deep</literal>; openSUSE:
8336 <literal>perl-Test-Deep</literal>)</para>
8340 <para><literal>Test::Exception</literal> (Debian-Paketname:
8341 <literal>libtest-exception-perl</literal>; Fedora:
8342 <literal>perl-Test-Exception</literal>; openSUSE:
8343 <literal>perl-Test-Exception</literal>)</para>
8347 <para><literal>Test::Output</literal> (Debian-Paketname:
8348 <literal>libtest-output-perl</literal>; Fedora:
8349 <literal>perl-Test-Output</literal>; openSUSE:
8350 <literal>perl-Test-Output</literal>)</para>
8354 <para><literal>Test::Harness</literal> 3.0.0 oder höher. Dieses
8355 Modul ist ab Perl 5.10.1 Bestandteil der Perl-Distribution und
8356 kann für frühere Versionen aus dem <ulink
8357 url="http://www.cpan.org">CPAN</ulink> bezogen werden.</para>
8361 <para><literal>LWP::Simple</literal> aus dem Paket
8362 <literal>libwww-perl</literal> (Debian-Panetname:
8363 <literal>libwww-perl</literal>; Fedora:
8364 <literal>perl-libwww-perl</literal>; openSUSE:
8365 <literal>perl-libwww-perl</literal>)</para>
8369 <para><literal>URI::Find</literal> (Debian-Panetname:
8370 <literal>liburi-find-perl</literal>; Fedora:
8371 <literal>perl-URI-Find</literal>; openSUSE:
8372 <literal>perl-URI-Find</literal>)</para>
8376 <para><literal>Sys::CPU</literal> (Debian-Panetname:
8377 <literal>libsys-cpu-perl</literal>; Fedora und openSUSE: nicht
8382 <para><literal>Thread::Pool::Simple</literal> (Debian-Panetname:
8383 <literal>libthread-pool-simple-perl</literal>; Fedora und
8384 openSUSE: nicht vorhanden)</para>
8388 <para>Weitere Voraussetzung ist, dass die Testsuite ihre eigene
8389 Datenbank anlegen kann, um Produktivdaten nicht zu gefährden. Dazu
8390 müssen in der Konfigurationsdatei im Abschnit
8391 <literal>testing/database</literal> Datenbankverbindungsparameter
8392 angegeben werden. Der hier angegebene Benutzer muss weiterhin das
8393 Recht haben, Datenbanken anzulegen und zu löschen.</para>
8395 <para>Der so angegebene Benutzer muss nicht zwingend über
8396 Super-User-Rechte verfügen. Allerdings gibt es einige
8397 Datenbank-Upgrades, die genau diese Rechte benötigen. Für den Fall
8398 kann man in diesem Konfigurationsabschnitt einen weiteren
8399 Benutzeraccount angeben, der dann über Super-User-Rechte verfügt, und
8400 mit dem die betroffenen Upgrades durchgeführt werden. In der
8401 Beispiel-Konfigurationsdatei finden Sie die benötigten
8405 <sect2 id="devel.testsuite.execution">
8406 <title>Existierende Tests ausführen</title>
8408 <para>Es gibt mehrere Möglichkeiten zum Ausführen der Tests: entweder,
8409 man lässt alle Tests auf einmal ausführen, oder man führt gezielt
8410 einzelne Scripte aus. Für beide Fälle gibt es das Helferscript
8411 <filename>t/test.pl</filename>.</para>
8413 <para>Will man die komplette Test-Suite ausführen, so muss man einfach
8414 nur <filename>t/test.pl</filename> ohne weitere Parameter aus dem
8415 kivitendo-Basisverzeichnis heraus ausführen.</para>
8417 <para>Um einzelne Test-Scripte auszuführen, übergibt man deren Namen
8418 an <filename>t/test.pl</filename>. Beispielsweise:</para>
8420 <programlisting>t/test.pl t/form/format_amount.t t/background_job/known_jobs.t</programlisting>
8423 <sect2 id="devel.testsuite.meaning_of_scripts">
8424 <title>Bedeutung der verschiedenen Test-Scripte</title>
8426 <para>Die Test-Suite umfasst Tests sowohl für Funktionen als auch für
8427 Programmierstil. Einige besonders zu erwähnende, weil auch während der
8428 Entwicklung nützliche Tests sind:</para>
8432 <para><filename>t/001compile.t</filename> -- compiliert alle
8433 Quelldateien und bricht bei Fehlern sofort ab</para>
8437 <para><filename>t/002goodperl.t</filename> -- überprüft alle
8438 Perl-Dateien auf Anwesenheit von '<literal>use
8439 strict</literal>'-Anweisungen</para>
8443 <para><filename>t/003safesys.t</filename> -- überprüft Aufrufe von
8444 <function>system()</function> und <function>exec()</function> auf
8449 <para><filename>t/005no_tabs.t</filename> -- überprüft, ob Dateien
8450 Tab-Zeichen enthalten</para>
8454 <para><filename>t/006spelling.t</filename> -- sucht nach häufigen
8455 Rechtschreibfehlern</para>
8459 <para><filename>t/011pod.t</filename> -- überprüft die Syntax von
8460 Dokumentation im POD-Format auf Gültigkeit</para>
8464 <para>Weitere Test-Scripte überprüfen primär die Funktionsweise
8465 einzelner Funktionen und Module.</para>
8468 <sect2 id="devel.testsuite.create_new">
8469 <title>Neue Test-Scripte erstellen</title>
8471 <para>Es wird sehr gern gesehen, wenn neue Funktionalität auch gleich
8472 mit einem Test-Script abgesichert wird. Auch bestehende Funktion darf
8473 und soll ausdrücklich nachträglich mit Test-Scripten abgesichert
8476 <sect3 id="devel.testsuite.ideas_for_non_function_tests">
8477 <title>Ideen für neue Test-Scripte, die keine konkreten Funktionen
8480 <para>Ideen, die abgesehen von Funktionen noch nicht umgesetzt
8485 <para>Überprüfung auf fehlende symbolische Links</para>
8489 <para>Suche nach Nicht-ASCII-Zeichen in Perl-Code-Dateien (mit
8490 gewissen Einschränkungen wie das Erlauben von deutschen
8495 <para>Test auf DOS-Zeilenenden (\r\n anstelle von nur \n)</para>
8499 <para>Überprüfung auf Leerzeichen am Ende von Zeilen</para>
8503 <para>Test, ob alle zu übersetzenden Strings in
8504 <filename>locale/de/all</filename> vorhanden sind</para>
8508 <para>Test, ob alle Webseiten-Templates in
8509 <filename>templates/webpages</filename> mit vom Perl-Modul
8510 <literal>Template</literal> compiliert werden können</para>
8515 <sect3 id="devel.testsuite.directory_and_test_names">
8516 <title>Konvention für Verzeichnis- und Dateinamen</title>
8518 <para>Es gibt momentan eine wenige Richtlinien, wie Test-Scripte zu
8519 benennen sind. Bitte die folgenden Punkte als Richtlinie betrachten
8520 und ihnen soweit es geht folgen:</para>
8524 <para>Die Dateiendung muss <filename>.t</filename>
8529 <para>Namen sind englisch, komplett klein geschrieben und
8530 einzelne Wörter mit Unterstrichten getrennt (beispielsweise
8531 <filename>bad_function_params.t</filename>).</para>
8535 <para>Unterverzeichnisse sollten grob nach dem Themenbereich
8536 benannt sein, mit dem sich die Scripte darin befassen
8537 (beispielsweise <filename>background_jobs</filename> für Tests
8538 rund um Hintergrund-Jobs).</para>
8542 <para>Test-Scripte sollten einen überschaubaren Bereich von
8543 Funktionalität testen, der logisch zusammenhängend ist (z.B. nur
8544 Tests für eine einzelne Funktion in einem Modul). Lieber mehrere
8545 Test-Scripte schreiben.</para>
8550 <sect3 id="devel.testsuite.minimal_example">
8551 <title>Minimales Skelett für eigene Scripte</title>
8553 <para>Der folgenden Programmcode enthält das kleinstmögliche
8554 Testscript und kann als Ausgangspunkt für eigene Tests verwendet
8557 <programlisting>use Test::More tests => 0;
8561 use Support::TestSetup;
8563 Support::TestSetup::login();</programlisting>
8565 <para>Wird eine vollständig initialisierte kivitendo-Umgebung
8566 benötigt (Stichwort: alle globalen Variablen wie
8567 <varname>$::auth</varname>, <varname>$::form</varname> oder
8568 <varname>$::lxdebug</varname>), so muss in der Konfigurationsdatei
8569 <filename>config/kivitendo.conf</filename> im Abschnitt
8570 <literal>testing.login</literal> ein gültiger Login-Name eingetragen
8571 sein. Dieser wird für die Datenbankverbindung benötigt.</para>
8573 <para>Wir keine vollständig initialisierte Umgebung benötigt, so
8574 kann die letzte Zeile <programlisting>Support::TestSetup::login();</programlisting>
8575 weggelassen werden, was die Ausführungszeit des Scripts leicht
8581 <sect1 id="devel.style-guide">
8582 <title>Stil-Richtlinien</title>
8584 <para>Die folgenden Regeln haben das Ziel, den Code möglichst gut les-
8585 und wartbar zu machen. Dazu gehört zum Einen, dass der Code einheitlich
8586 eingerückt ist, aber auch, dass Mehrdeutigkeit so weit es geht vermieden
8587 wird (Stichworte "Klammern" oder "Hash-Keys").</para>
8589 <para>Diese Regeln sind keine Schikane sondern erleichtern allen das
8592 <para>Jeder, der einen Patch schickt, sollte seinen Code vorher
8593 überprüfen. Einige der Regeln lassen sich automatisch überprüfen, andere
8598 <para>Es werden keine echten Tabs sondern Leerzeichen
8603 <para>Die Einrückung beträgt zwei Leerzeichen. Beispiel:</para>
8605 <programlisting>foreach my $row (@data) {
8607 # do something with $row
8611 $row->{modules} = MODULE->retrieve(
8612 id => $row->{id},
8613 date => $use_now ? localtime() : $row->{time},
8617 $report->add($row);
8622 <para>Öffnende geschweifte Klammern befinden sich auf der gleichen
8623 Zeile wie der letzte Befehl. Beispiele:</para>
8625 <programlisting>sub debug {
8631 <programlisting>if ($form->{item_rows} > 0) {
8637 <para>Schließende geschweifte Klammern sind so weit eingerückt wie
8638 der Befehl / die öffnende schließende Klammer, die den Block
8639 gestartet hat, und nicht auf der Ebene des Inhalts. Die gleichen
8640 Beispiele wie bei 3. gelten.</para>
8644 <para>Die Wörter "<function>else</function>",
8645 "<function>elsif</function>", "<function>while</function>" befinden
8646 sich auf der gleichen Zeile wie schließende geschweifte Klammern.
8649 <programlisting>if ($form->{sum} > 1000) {
8651 } elsif ($form->{sum} > 0) {
8659 } until ($a > 0);</programlisting>
8663 <para>Parameter von Funktionsaufrufen müssen mit runden Klammern
8664 versehen werden. Davon nicht betroffen sind interne Perl-Funktionen,
8665 und grep-ähnliche Operatoren. Beispiel:</para>
8667 <programlisting>$main::lxdebug->message("Could not find file.");
8668 %options = map { $_ => 1 } grep { !/^#/ } @config_file;</programlisting>
8672 <para>Verschiedene Klammern, Ihre Ausdrücke und Leerzeichen:</para>
8674 <para>Generell gilt: Hashkeys und Arrayindices sollten nicht durch
8675 Leerzeichen abgesetzt werden. Logische Klammerungen ebensowenig,
8676 Blöcke schon. Beispiel:</para>
8678 <programlisting>if (($form->{debug} == 1) && ($form->{sum} - 100 < 0)) {
8683 $form->{sum} += $form->{"row_$i"};
8684 $form->{ $form->{index} } += 1;
8686 map { $form->{sum} += $form->{"row_$_"} } 1..$rowcount;</programlisting>
8690 <para>Mehrzeilige Befehle</para>
8694 <para>Werden die Parameter eines Funktionsaufrufes auf mehrere
8695 Zeilen aufgeteilt, so sollten diese bis zu der Spalte eingerückt
8696 werden, in der die ersten Funktionsparameter in der ersten Zeile
8697 stehen. Beispiel:</para>
8699 <programlisting>$sth = $dbh->prepare("SELECT * FROM some_table WHERE col = ?",
8700 $form->{some_col_value});</programlisting>
8704 <para>Ein Spezialfall ist der ternäre Operator "?:", der am
8705 besten in einer übersichtlichen Tabellenstruktur organisiert
8706 wird. Beispiel:</para>
8708 <programlisting>my $rowcount = $form->{"row_$i"} ? $i
8709 : $form->{oldcount} ? $form->{oldcount} + 1
8710 : $form->{rowcount} - $form->{rowbase};</programlisting>
8716 <para>Kommentare</para>
8720 <para>Kommentare, die alleine in einer Zeile stehen, sollten
8721 soweit wie der Code eingerückt sein.</para>
8725 <para>Seitliche hängende Kommentare sollten einheitlich
8726 formatiert werden.</para>
8730 <para>Sämtliche Kommentare und Sonstiges im Quellcode ist bitte
8731 auf Englisch zu verfassen. So wie ich keine Lust habe,
8732 französischen Quelltext zu lesen, sollte auch der kivitendo
8733 Quelltext für nicht-Deutschsprachige lesbar sein.
8736 <programlisting>my $found = 0;
8744 $i = 0 # initialize $i
8746 $i *= $const; # do something crazy
8747 $i = $n; # recover $i</programlisting>
8753 <para>Hashkeys sollten nur in Anführungszeichen stehen, wenn die
8754 Interpolation gewünscht ist. Beispiel:</para>
8756 <programlisting>$form->{sum} = 0;
8757 $form->{"row_$i"} = $form->{"row_$i"} - 5;
8758 $some_hash{42} = 54;</programlisting>
8762 <para>Die maximale Zeilenlänge ist nicht beschränkt. Zeilenlängen
8763 unterhalb von 79 Zeichen helfen unter bestimmten Bedingungen, aber
8764 wenn die Lesbarkeit unter kurzen Zeilen leidet (wie zum Biespiel in
8765 grossen Tabellen), dann ist Lesbarkeit vorzuziehen.</para>
8767 <para>Als Beispiel sei die Funktion
8768 <function>print_options</function> aus
8769 <filename>bin/mozilla/io.pl</filename> angeführt.</para>
8773 <para>Trailing Whitespace, d.h. Leerzeichen am Ende von Zeilen sind
8774 unerwünscht. Sie führen zu unnötigen Whitespaceänderungen, die diffs
8777 <para>Emacs und vim haben beide recht einfache Methoden zur
8778 Entfernung von trailing whitespace. Emacs kennt das Kommande
8779 <command>nuke-trailing-whitespace</command>, vim macht das gleiche
8780 manuell über <literal>:%s/\s\+$//e</literal> Mit <literal>:au
8781 BufWritePre * :%s/\s\+$//e</literal> wird das an Speichern
8786 <para>Es wird kein <command>perltidy</command> verwendet.</para>
8788 <para>In der Vergangenheit wurde versucht,
8789 <command>perltidy</command> zu verwenden, um einen einheitlichen
8790 Stil zu erlangen. Es hat sich aber gezeigt, dass
8791 <command>perltidy</command>s sehr eigenwilliges Verhalten, was
8792 Zeilenumbrüche angeht, oftmals gut formatierten Code zerstört. Für
8793 den Interessierten sind hier die
8794 <command>perltidy</command>-Optionen, die grob den beschriebenen
8795 Richtlinien entsprechen:</para>
8797 <programlisting>-syn -i=2 -nt -pt=2 -sbt=2 -ci=2 -ibc -hsc -noll -nsts -nsfs -asc -dsm
8798 -aws -bbc -bbs -bbb -mbl=1 -nsob -ce -nbl -nsbl -cti=0 -bbt=0 -bar -l=79
8799 -lp -vt=1 -vtc=1</programlisting>
8803 <para><varname>STDERR</varname> ist tabu. Unkonditionale
8804 Debugmeldungen auch.</para>
8806 <para>kivitendo bietet mit dem Modul <classname>LXDebug</classname>
8807 einen brauchbaren Trace-/Debug-Mechanismus. Es gibt also keinen
8808 Grund, nach <varname>STDERR</varname> zu schreiben.</para>
8810 <para>Die <classname>LXDebug</classname>-Methode
8811 "<function>message</function>" nimmt als ersten Paramter außerdem
8812 eine Flagmaske, für die die Meldung angezeigt wird, wobei "0" immer
8813 angezeigt wird. Solche Meldungen sollten nicht eingecheckt werden
8814 und werden in den meisten Fällen auch vom Repository
8815 zurückgewiesen.</para>
8819 <para>Alle neuen Module müssen use strict verwenden.</para>
8821 <para><varname>$form</varname>, <varname>$auth</varname>,
8822 <varname>$locale</varname>, <varname>$lxdebug</varname> und
8823 <varname>%myconfig</varname> werden derzeit aus dem main package
8824 importiert (siehe <xref linkend="devel.globals"/>. Alle anderen
8825 Konstrukte sollten lexikalisch lokal gehalten werden.</para>
8830 <sect1 id="devel.build-doc" xreflabel="Dokumentation erstellen">
8831 <title>Dokumentation erstellen</title>
8833 <sect2 id="devel.build-doc.introduction">
8834 <title>Einführung</title>
8836 <para>Diese Dokumentation ist in <productname>DocBook</productname>
8837 XML geschrieben. Zum Bearbeiten reicht grundsätzlich ein Text-Editor.
8838 Mehr Komfort bekommt man, wenn man einen dedizierten XML-fähigen
8839 Editor nutzt, der spezielle Unterstützung für
8840 <productname>DocBook</productname> mitbringt. Wir empfehlen dafür den
8841 <ulink url="http://www.xmlmind.com/xmleditor/">XMLmind XML
8842 Editor</ulink>, der bei nicht kommerzieller Nutzung kostenlos
8846 <sect2 id="devel.build-doc.required-software">
8847 <title>Benötigte Software</title>
8849 <para>Bei <productname>DocBook</productname> ist Prinzip, dass
8850 ausschließlich die XML-Quelldatei bearbeitet wird. Aus dieser werden
8851 dann mit entsprechenden Stylesheets andere Formate wie PDF oder HTML
8852 erzeugt. Bei kivitendo übernimmt diese Aufgabe das Shell-Script
8853 <command>scripts/build_doc.sh</command>.</para>
8855 <para>Das Script benötigt zur Konvertierung verschiedene
8856 Softwarekomponenten, die im normalen kivitendo-Betrieb nicht benötigt
8862 url="http://www.oracle.com/technetwork/java/index.html">Java</ulink>
8863 in einer halbwegs aktuellen Version</para>
8867 <para>Das Java-Build-System <ulink
8868 url="http://ant.apache.org/">Apache Ant</ulink></para>
8872 <para>Das Dokumentations-System Dobudish für
8873 <productname>DocBook</productname> 4.5, eine Zusammenstellung
8874 diverser Stylesheets und Grafiken zur Konvertierung von
8875 <productname>DocBook</productname> XML in andere Formate. Das
8876 Paket, das benötigt wird, ist zum Zeitpunkt der
8877 Dokumentationserstellung
8878 <filename>dobudish-nojre-1.1.4.zip</filename>, aus auf <ulink
8879 url="http://code.google.com/p/dobudish/downloads/list">code.google.com</ulink>
8884 <para>Apache Ant sowie ein dazu passendes Java Runtime Environment
8885 sind auf allen gängigen Plattformen verfügbar. Beispiel für
8886 Debian/Ubuntu:</para>
8888 <programlisting>apt-get install ant openjdk-7-jre</programlisting>
8890 <para>Nach dem Download von Dobudish muss Dobudish im Unterverzeichnis
8891 <filename>doc/build</filename> entpackt werden. Beispiel unter der
8892 Annahme, das <productname>Dobudish</productname> in
8893 <filename>$HOME/Downloads</filename> heruntergeladen wurde:</para>
8895 <programlisting>cd doc/build
8896 unzip $HOME/Downloads/dobudish-nojre-1.1.4.zip</programlisting>
8899 <sect2 id="devel.build-doc.build">
8900 <title>PDFs und HTML-Seiten erstellen</title>
8902 <para>Die eigentliche Konvertierung erfolgt nach Installation der
8903 benötigten Software mit einem einfachen Aufruf direkt aus dem
8904 kivitendo-Installationsverzeichnis heraus:</para>
8906 <programlisting>./scripts/build_doc.sh</programlisting>
8909 <sect2 id="devel.build-doc.repository">
8910 <title>Einchecken in das Git-Repository</title>
8912 <para>Sowohl die XML-Datei als auch die erzeugten PDF- und
8913 HTML-Dateien sind Bestandteil des Git-Repositories. Daraus folgt, dass
8914 nach Änderungen am XML die PDF- und HTML-Dokumente ebenfalls gebaut
8915 und alles zusammen in einem Commit eingecheckt werden sollten.</para>
8917 <para>Die "<filename>dobudish</filename>"-Verzeichnisse bzw.
8918 symbolischen Links gehören hingegen nicht in das Repository.</para>