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 2016 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>
128 <para>Ubuntu 12.04 LTS "Precise Pangolin", 14.04 "Trusty Tahr"
129 LTS, 15.10 "Wily Werewolf" und 16.04 "Xenial Xerus" LTS
134 <para>openSUSE LEAP 42.1</para>
138 <para>Fedora 22</para>
143 <sect2 id="Pakete" xreflabel="Pakete">
144 <title>Benötigte Perl-Pakete installieren</title>
146 <para>Zum Betrieb von kivitendo werden zwingend ein Webserver (meist
147 Apache) und ein Datenbankserver (PostgreSQL) in einer aktuellen
148 Version (s.a. Liste der unterstützten Betriebssysteme)
151 <para>Zusätzlich benötigt kivitendo einige Perl-Pakete, die nicht
152 Bestandteil einer Standard-Perl-Installation sind. Um zu überprüfen,
153 ob die erforderlichen Pakete installiert und aktuell genug sind, wird
154 ein Script mitgeliefert, das wie folgt aufgerufen wird:</para>
156 <programlisting>./scripts/installation_check.pl</programlisting>
158 <para>Die vollständige Liste der benötigten Perl-Module lautet:</para>
162 <para><literal>parent</literal> (nur bei Perl vor 5.10.1)</para>
166 <para><literal>Archive::Zip</literal></para>
170 <para><literal>Algorithm::CheckDigits</literal></para>
174 <para><literal>CGI</literal></para>
178 <para><literal>Clone</literal></para>
182 <para><literal>Config::Std</literal></para>
186 <para><literal>DateTime</literal></para>
190 <para><literal>DateTime::Format::Strptime</literal></para>
194 <para><literal>DBI</literal></para>
198 <para><literal>DBD::Pg</literal></para>
202 <para><literal>Email::Address</literal></para>
206 <para><literal>Email::MIME</literal></para>
210 <para><literal>FCGI</literal> (nicht Versionen 0.68 bis 0.71
211 inklusive; siehe <xref
212 linkend="Apache-Konfiguration.FCGI.WebserverUndPlugin"/>)</para>
216 <para><literal>File::Copy::Recursive</literal></para>
220 <para><literal>File::MimeInfo</literal></para>
224 <para><literal>GD</literal></para>
228 <para><literal>HTML::Parser</literal></para>
232 <para><literal>HTML::Restrict</literal></para>
236 <para><literal>Image::Info</literal></para>
240 <para><literal>JSON</literal></para>
244 <para><literal>List::MoreUtils</literal></para>
248 <para><literal>List::UtilsBy</literal></para>
252 <para>LWP::Authen::Digest</para>
256 <para>LWP::UserAgent</para>
260 <para><literal>Net::SMTP::SSL</literal> (optional, bei
261 E-Mail-Versand über SSL; siehe Abschnitt "<xref
262 linkend="config.sending-email.smtp"/>")</para>
266 <para><literal>Net::SSLGlue</literal> (optional, bei
267 E-Mail-Versand über TLS; siehe Abschnitt "<xref
268 linkend="config.sending-email.smtp"/>")</para>
272 <para><literal>Params::Validate</literal></para>
276 <para><literal>PBKDF2::Tiny</literal></para>
280 <para><literal>PDF::API2</literal></para>
284 <para><literal>Rose::Object</literal></para>
288 <para><literal>Rose::DB</literal></para>
292 <para><literal>Rose::DB::Object</literal> Version 0.788 oder
297 <para><literal>String::ShellQuote</literal></para>
301 <para><literal>Sort::Naturally</literal></para>
305 <para><literal>Template</literal></para>
309 <para><literal>Text::CSV_XS</literal></para>
313 <para><literal>Text::Iconv</literal></para>
317 <para><literal>Text::Unidecode</literal></para>
321 <para><literal>URI</literal></para>
325 <para><literal>XML::Writer</literal></para>
329 <para><literal>YAML</literal></para>
333 <para>Seit Version größer v3.5.0 sind die folgenden Pakete
334 hinzugekommen: <literal>Text::Unidecode, LWP::Authen::Digest,
335 LWP::UserAgent</literal></para>
337 <para>Seit Version v3.4.0 sind die folgenden Pakete hinzugekommen:
338 <literal>Algorithm::CheckDigits</literal><literal>PBKDF2::Tiny</literal></para>
340 <para>Seit Version v3.2.0 sind die folgenden Pakete hinzugekommen:
341 <literal>GD</literal>, <literal>HTML::Restrict</literal>,
342 <literal>Image::Info</literal></para>
344 <para>Seit v3.0.0 sind die folgenden Pakete hinzugekommen:
345 <literal>File::Copy::Recursive</literal>.</para>
347 <para>Seit v2.7.0 sind die folgenden Pakete hinzugekommen:
348 <literal>Email::MIME</literal>, <literal>Net::SMTP::SSL</literal>,
349 <literal>Net::SSLGlue</literal>.</para>
351 <para>Gegenüber Version 2.6.0 sind zu dieser Liste 2 Pakete
352 hinzugekommen, <literal>URI</literal> und
353 <literal>XML::Writer</literal> sind notwendig. Ohne startet kivitendo
356 <para>Gegenüber Version 2.6.1 sind <literal>parent</literal>,
357 <literal>DateTime</literal>, <literal>Rose::Object</literal>,
358 <literal>Rose::DB</literal> und <literal>Rose::DB::Object</literal>
359 neu hinzugekommen. <literal>IO::Wrap</literal> wurde entfernt.</para>
361 <para>Gegenüber Version 2.6.3 ist <literal>JSON</literal> neu
362 hinzugekommen.</para>
364 <para><literal>Email::Address</literal> und
365 <literal>List::MoreUtils</literal> sind schon länger feste
366 Abhängigkeiten, wurden aber bisher mit kivitendo mitgeliefert. Beide
367 sind auch in 2.6.1 weiterhin mit ausgeliefert, wurden in einer
368 zukünftigen Version aber aus dem Paket entfernt werden. Es wird
369 empfohlen diese Module zusammen mit den anderen als Bibliotheken zu
373 <title>Debian und Ubuntu</title>
375 <para>Für Debian und Ubuntu stehen die meisten der benötigten
376 Perl-Pakete als Debian-Pakete zur Verfügung. Sie können mit
377 folgendem Befehl installiert werden:</para>
379 <programlisting>apt install apache2 libarchive-zip-perl libclone-perl \
380 libconfig-std-perl libdatetime-perl libdbd-pg-perl libdbi-perl \
381 libemail-address-perl libemail-mime-perl libfcgi-perl libjson-perl \
382 liblist-moreutils-perl libnet-smtp-ssl-perl libnet-sslglue-perl \
383 libparams-validate-perl libpdf-api2-perl librose-db-object-perl \
384 librose-db-perl librose-object-perl libsort-naturally-perl \
385 libstring-shellquote-perl libtemplate-perl libtext-csv-xs-perl \
386 libtext-iconv-perl liburi-perl libxml-writer-perl libyaml-perl \
387 libimage-info-perl libgd-gd2-perl libapache2-mod-fcgid \
388 libfile-copy-recursive-perl postgresql libalgorithm-checkdigits-perl \
389 libcrypt-pbkdf2-perl git libcgi-pm-perl libtext-unidecode-perl libwww-perl
392 <para>Für das Paket HTML::Restrict gibt es kein Debian-Paket, dies
393 muß per CPAN installiert werden. Unter Ubuntu funktioniert das
396 <programlisting>apt-get install build-essential
397 cpan HTML::Restrict</programlisting>
401 <title>Fedora</title>
403 <para>Für Fedora stehen die meisten der benötigten Perl-Pakete als
404 RPM-Pakete zur Verfügung. Sie können mit folgendem Befehl
405 installiert werden:</para>
407 <programlisting>dnf install httpd mod_fcgid perl-Archive-Zip perl-Clone perl-DBD-Pg \
408 perl-DBI perl-DateTime perl-Email-Address perl-Email-MIME perl-FCGI \
409 perl-File-Copy-Recursive perl-JSON perl-List-MoreUtils perl-Net-SMTP-SSL perl-Net-SSLGlue \
410 perl-PDF-API2 perl-Params-Validate perl-Rose-DB perl-Rose-DB-Object \
411 perl-Rose-Object perl-Sort-Naturally perl-String-ShellQuote \
412 perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv perl-URI \
413 perl-XML-Writer perl-YAML perl-parent postgresql-server perl-CPAN \
414 perl-Algorithm-CheckDigits perl-GD perl-Class-XSAccessor perl-Text-Balanced perl-libwww-perl</programlisting>
416 <para>Zusätzlich müssen einige Pakete aus dem CPAN installiert
417 werden. Dazu können Sie die folgenden Befehle nutzen:</para>
419 <programlisting>cpan Config::Std HTML::Restrict</programlisting>
423 <title>openSUSE</title>
425 <para>Für openSUSE stehen die meisten der benötigten Perl-Pakete als
426 RPM-Pakete zur Verfügung. Sie können mit folgendem Befehl
427 installiert werden:</para>
429 <programlisting>zypper install apache2 apache2-mod_fcgid perl-Archive-Zip perl-Clone \
430 perl-Config-Std perl-DBD-Pg perl-DBI perl-DateTime perl-Email-Address \
431 perl-Email-MIME perl-FastCGI perl-File-Copy-Recursive perl-JSON perl-List-MoreUtils \
432 perl-Net-SMTP-SSL perl-Net-SSLGlue perl-PDF-API2 perl-Params-Validate \
433 perl-Sort-Naturally perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv \
434 perl-URI perl-XML-Writer perl-YAML perl-CPAN \
435 perl-Algorithm-CheckDigits perl-GD perl-Class-XSAccessor postgresql-server perl-libwwww-perl</programlisting>
437 <para>Zusätzlich müssen einige Pakete aus dem CPAN installiert
438 werden. Dazu können Sie die folgenden Befehle nutzen:</para>
440 <programlisting>cpan Rose::Db::Object</programlisting>
445 <title>Andere Pakete installieren</title>
447 <para>Seit Version v3.4.0 wird für den Bankimport optional das Paket
448 'aqbanking-tools' benötigt.</para>
450 <para>Debian und Ubuntu: <programlisting>apt install aqbanking-tools
451 </programlisting></para>
453 <para>OpenSuSE: <programlisting>zypper install aqbanking-tools</programlisting></para>
455 <para>Seit Version v3.4.1 wird generell zum Feststellen der
456 Seitenanzahl von PDF_Dokumenten 'pdfinfo' benötigt was im Paket
457 'poppler-utils' enthalten ist.</para>
459 <para>Debian und Ubuntu: <programlisting>apt install poppler-utils
460 </programlisting></para>
462 <para>OpenSuSE: <programlisting>zypper install poppler-tools</programlisting></para>
466 <sect1 id="Manuelle-Installation-des-Programmpaketes"
467 xreflabel="Manuelle Installation des Programmpaketes">
468 <title>Manuelle Installation des Programmpaketes</title>
470 <para>Der aktuelle Stable-Release, bzw. beta Release wird bei github
471 gehostet und kann <ulink
472 url="https://github.com/kivitendo/kivitendo-erp/releases">hier</ulink>
473 heruntergeladen werden.</para>
475 <para>Die kivitendo ERP Installationsdatei
476 (<filename>kivitendo-erp-3.4.1.tgz</filename>) wird im
477 Dokumentenverzeichnis des Webservers (z.B.
478 <filename>/var/www/html/</filename>,
479 <filename>/srv/www/htdocs</filename> oder
480 <filename>/var/www/</filename>) entpackt:</para>
482 <programlisting>cd /var/www
483 tar xvzf kivitendo-erp-3.4.1.tgz</programlisting>
485 <para>Wechseln Sie in das entpackte Verzeichnis:</para>
487 <programlisting>cd kivitendo-erp</programlisting>
489 <para>Alternativ können Sie auch einen Alias in der
490 Webserverkonfiguration benutzen, um auf das tatsächliche
491 Installationsverzeichnis zu verweisen.</para>
493 <para>Bei einer Neuinstallation von Version 3.1.0 oder später muß das
494 WebDAV Verzeichnis derzeit manuell angelegt werden:</para>
496 <programlisting>mkdir webdav</programlisting>
498 <para>Die Verzeichnisse <filename>users</filename>,
499 <filename>spool</filename> und <filename>webdav</filename> müssen für
500 den Benutzer beschreibbar sein, unter dem der Webserver läuft. Die
501 restlichen Dateien müssen für diesen Benutzer lesbar sein. Die Benutzer-
502 und Gruppennamen sind bei verschiedenen Distributionen unterschiedlich
503 (z.B. bei Debian/Ubuntu <constant>www-data</constant>, bei Fedora
504 <constant>apache</constant> oder bei OpenSUSE
505 <constant>wwwrun</constant>).</para>
507 <para>Der folgende Befehl ändert den Besitzer für die oben genannten
508 Verzeichnisse auf einem Debian/Ubuntu-System:</para>
510 <programlisting>chown -R www-data users spool webdav</programlisting>
512 <para>Weiterhin muss der Webserver-Benutzer in den Verzeichnissen
513 <filename>templates</filename> und <filename>users</filename>
514 Unterverzeichnisse für jeden neuen Benutzer anlegen dürfen, der in
515 kivitendo angelegt wird:</para>
517 <programlisting>chown www-data templates users</programlisting>
520 <para>Wir empfehlen eine Installation mittels des Versionsmanagager
521 git. Hierfür muss ein git-Client installiert sein. Damit ist man sehr
522 viel flexibler für zukünftige Upgrades. Installations-Anleitung (bitte
523 die Pfade anpassen) bspw. wie folgt: <programlisting>cd /var/www/
524 git clone https://github.com/kivitendo/kivitendo-erp.git
526 git checkout `git tag -l | egrep -ve "(alpha|beta|rc)" | tail -1`</programlisting>
527 Erläuterung: Der Befehl wechselt zur letzten Stable-Version (git tag
528 -l listet alle Tags auf, das egrep schmeisst alle Einträge mit alpha,
529 beta oder rc raus und das tail gibt davon den obersten Treffer
530 zurück). Sehr sinnvoll ist es, direkt im Anschluss einen eigenen
531 Branch zu erzeugen, um bspw. seine eigenen Druckvorlagen-Anpassungen
532 damit zu verwalten. Hierfür reicht ein simples <programlisting> git checkout -b meine_eigenen_änderungen</programlisting>
533 nach dem letzten Kommando (weiterführende Informationen <ulink
534 url="http://www-cs-students.stanford.edu/~blynn/gitmagic/index.html">
535 Git Magic</ulink>).</para>
537 <para>Ein beispielhafter Workflow für Druckvorlagen-Anpassungen von
538 3.4.1 nach 3.5: <programlisting>
539 $ git clone https://github.com/kivitendo/kivitendo-erp.git
541 $ git checkout release-3.4.1 # das ist der aktuelle release, den wir wollen
542 $ git add templates/fullhouse # das sind unsere druckvorlagen inkl. produktbilder
543 $ git commit -m "juhu tolle ändernungen"
544 [meine_aenderungen 1d89e41] juhu tolle ändernungen
545 4 files changed, 380 insertions(+)
546 create mode 100644 templates/fullhouse/img/webdav/tesla.png
547 create mode 100644 templates/fullhouse/mahnung.tex
548 create mode 100644 templates/fullhouse/zahlungserinnerung_zwei.tex
549 create mode 100644 templates/fullhouse/zahlungserinnerung_zwei_invoice.tex
554 $ git rebase --onto release-3.5.0 release-3.4.1 meine_aenderungen
555 Zunächst wird der Branch zurückgespult, um Ihre Änderungen
556 darauf neu anzuwenden ...
557 Wende an: juhu tolle ändernungen
558 $ service apache2 restart
559 </programlisting></para>
563 <sect1 id="config.config-file">
564 <title>kivitendo-Konfigurationsdatei</title>
566 <sect2 id="config.config-file.introduction"
567 xreflabel="Einführung in die Konfigurationsdatei">
568 <title>Einführung</title>
570 <para>In kivitendo gibt es nur noch eine Konfigurationsdatei, die
571 benötigt wird: <filename>config/kivitendo.conf</filename> (kurz: "die
572 Hauptkonfigurationsdatei"). Diese muss bei der Erstinstallation von
573 kivitendo bzw. der Migration von älteren Versionen angelegt
576 <para>Als Vorlage dient die Datei
577 <filename>config/kivitendo.conf.default</filename> (kurz: "die
578 Default-Datei"):</para>
580 <programlisting>$ cp config/kivitendo.conf.default config/kivitendo.conf</programlisting>
582 <para>Die Default-Datei wird immer zuerst eingelesen. Werte, die in
583 der Hauptkonfigurationsdatei stehen, überschreiben die Werte aus der
584 Default-Datei. Die Hauptkonfigurationsdatei muss also nur die
585 Abschnitte und Werte enthalten, die von denen der Default-Datei
589 <para>Vor der Umbenennung in kivitendo hieß diese Datei noch
590 <filename>config/lx_office.conf</filename>. Aus Gründen der
591 Kompatibilität wird diese Datei eingelesen, sofern die Datei
592 <filename>config/kivitendo.conf</filename> nicht existiert.</para>
595 <para>Diese Hauptkonfigurationsdatei ist dann eine
596 installationsspezifische Datei, d.h. sie enthält bspw. lokale
597 Passwörter und wird auch nicht im Versionsmanagement (git)
600 <para>Die Konfiguration ist ferner serverabhängig, d.h. für alle
601 Mandaten, bzw. Datenbanken gleich.</para>
604 <sect2 id="config.config-file.sections-parameters">
605 <title>Abschnitte und Parameter</title>
607 <para>Die Konfigurationsdatei besteht aus mehreren Teilen, die
608 entsprechend kommentiert sind:</para>
612 <para><literal>authentication</literal> (siehe Abschnitt "<xref
613 linkend="Benutzerauthentifizierung-und-Administratorpasswort"/>"
614 in diesem Kapitel)</para>
618 <para><literal>authentication/database</literal></para>
622 <para><literal>authentication/ldap</literal></para>
626 <para><literal>system</literal></para>
630 <para><literal>paths</literal></para>
634 <para><literal>mail_delivery</literal> (siehe Abschnitt "<xref
635 linkend="config.sending-email.smtp"/>)</para>
639 <para><literal>applications</literal></para>
643 <para><literal>environment</literal></para>
647 <para><literal>print_templates</literal></para>
651 <para><literal>task_server</literal></para>
655 <para><literal>periodic_invoices</literal></para>
659 <para><literal>self_tests</literal></para>
663 <para><literal>console</literal></para>
667 <para><literal>testing</literal></para>
671 <para><literal>testing/database</literal></para>
675 <para><literal>debug</literal></para>
679 <para>Die üblicherweise wichtigsten Parameter, die am Anfang
680 einzustellen oder zu kontrollieren sind, sind:</para>
682 <programlisting>[authentication]
683 admin_password = geheim
685 [authentication/database]
693 default_manager = german</programlisting>
695 <para>Für kivitendo Installationen in der Schweiz sollte hier
696 <varname>german</varname> durch <varname>swiss</varname> ersetzt
699 <para>Die Einstellung <varname>default_manager = swiss</varname>
704 <para>Beim Erstellen einer neuen Datenbank in der kivitendo
705 Administration werden automatisch die Standard-Werte für die
706 Schweiz voreingestellt: Währung CHF, 5er-Rundung, Schweizer
707 KMU-Kontenplan, Sollversteuerung, Aufwandsmethode, Bilanzierung
708 (die Werte können aber manuell angepasst werden).</para>
712 <para>Einstellen der Standardkonten für Rundungserträge und
713 -aufwendungen (unter Mandantenkonfiguration → Standardkonten
718 <para>das verwendete Zahlenformat wird auf
719 <varname>1'000.00</varname> eingestellt (unter Programm →
720 Benutzereinstellungen veränderbar)</para>
724 <para>DATEV-Automatik und UStVA werden nicht angezeigt,
725 Erfolgsrechnung ersetzt GUV ( unter Mandantenkonfiguration →
726 Features veränderbar)</para>
730 <para>Nutzt man wiederkehrende Rechnungen, kann man unter
731 <varname>[periodic_invoices]</varname> den Login eines Benutzers
732 angeben, der nach Erstellung der Rechnungen eine entsprechende E-Mail
733 mit Informationen über die erstellten Rechnungen bekommt.</para>
735 <para>kivitendo bringt eine eigene Komponente zur zeitgesteuerten
736 Ausführung bestimmter Aufgaben mit, den <link
737 linkend="config.task-server">Taskserver</link>. Er wird u.a. für
738 Features wie die <link
739 linkend="features.periodic-invoices">wiederkehrenden Rechnungen</link>
740 benötigt, erledigt aber auch andere erforderliche Aufgaben und muss
741 daher in Betrieb genommen werden. Seine Einrichtung wird im Abschnitt
742 <link linkend="config.task-server">Task-Server</link> genauer
745 <para>Für Entwickler finden sich unter <varname>[debug]</varname>
746 wichtige Funktionen, um die Fehlersuche zu erleichtern.</para>
749 <sect2 id="config.config-file.prior-versions">
750 <title>Versionen vor 2.6.3</title>
752 <para>In älteren kivitendo Versionen gab es im Verzeichnis
753 <filename>config</filename> die Dateien
754 <filename>authentication.pl</filename> und
755 <filename>lx-erp.conf</filename>, die jeweils Perl-Dateien waren. Es
756 gab auch die Möglichkeit, eine lokale Version der Konfigurationsdatei
757 zu erstellen (<filename>lx-erp-local.conf</filename>). Dies ist ab
758 2.6.3 nicht mehr möglich, aber auch nicht mehr nötig.</para>
760 <para>Beim Update von einer kivitendo-Version vor 2.6.3 auf 2.6.3 oder
761 jünger müssen die Einstellungen aus den alten Konfigurationsdateien
762 manuell übertragen und die alten Konfigurationsdateien anschließend
763 gelöscht oder verschoben werden. Ansonsten zeigt kivitendo eine
764 entsprechende Fehlermeldung an.</para>
768 <sect1 id="Anpassung-der-PostgreSQL-Konfiguration">
769 <title>Anpassung der PostgreSQL-Konfiguration</title>
771 <para>PostgreSQL muss auf verschiedene Weisen angepasst werden.</para>
773 <sect2 id="Zeichensätze-die-Verwendung-von-UTF-8">
774 <title>Zeichensätze/die Verwendung von Unicode/UTF-8</title>
776 <para>kivitendo setzt zwingend voraus, dass die Datenbank
777 Unicode/UTF-8 als Encoding einsetzt. Bei aktuellen
778 Serverinstallationen braucht man hier meist nicht einzugreifen.</para>
780 <para>Das Encoding des Datenbankservers kann überprüft werden. Ist das
781 Encoding der Datenbank "template1" "Unicode" bzw. "UTF-8", so braucht
782 man nichts weiteres diesbezüglich unternehmen. Zum Testen:</para>
784 <programlisting>su postgres
786 exit </programlisting>
788 <para>Andernfalls ist es notwendig, einen neuen Datenbankcluster mit
789 Unicode-Encoding anzulegen und diesen zu verwenden. Unter Debian und
790 Ubuntu kann dies z.B. für PostgreSQL 9.3 mit dem folgenden Befehl
793 <programlisting>pg_createcluster --locale=de_DE.UTF-8 --encoding=UTF-8 9.3 clustername</programlisting>
795 <para>Die Datenbankversionsnummer muss an die tatsächlich verwendete
796 Versionsnummer angepasst werden.</para>
798 <para>Unter anderen Distributionen gibt es ähnliche Methoden.</para>
800 <para>Das Encoding einer Datenbank kann in <command>psql</command> mit
801 <literal>\l</literal> geprüft werden.</para>
804 <sect2 id="Änderungen-an-Konfigurationsdateien">
805 <title>Änderungen an Konfigurationsdateien</title>
807 <para>In der Datei <filename>postgresql.conf</filename>, die je nach
808 Distribution in verschiedenen Verzeichnissen liegen kann (z.B.
809 <filename>/var/lib/pgsql/data/</filename> oder
810 <filename>/etc/postgresql/</filename>), muss sichergestellt werden,
811 dass TCP/IP-Verbindungen aktiviert sind. Das Verhalten wird über den
812 Parameter <varname>listen_address</varname> gesteuert. Laufen
813 PostgreSQL und kivitendo auf demselben Rechner, so kann dort der Wert
814 <literal>localhost</literal> verwendet werden. Andernfalls müssen
815 Datenbankverbindungen auch von anderen Rechnern aus zugelassen werden,
816 was mit dem Wert <literal>*</literal> geschieht.</para>
818 <para>In der Datei <filename>pg_hba.conf</filename>, die im gleichen
819 Verzeichnis wie die <filename>postgresql.conf</filename> zu finden
820 sein sollte, müssen die Berechtigungen für den Zugriff geändert
821 werden. Hier gibt es mehrere Möglichkeiten. Sinnvoll ist es nur die
822 nötigen Verbindungen immer zuzulassen, für eine lokal laufende
823 Datenbank zum Beispiel:</para>
825 <programlisting>local all kivitendo password
826 host all kivitendo 127.0.0.1 255.255.255.255 password</programlisting>
829 <sect2 id="Erweiterung-für-servergespeicherte-Prozeduren">
830 <title>Erweiterung für servergespeicherte Prozeduren</title>
832 <para>In der Datenbank <literal>template1</literal> muss die
833 Unterstützung für servergespeicherte Prozeduren eingerichet werden.
834 Melden Sie sich dafür als Benutzer “postgres” an der Datenbank an:
835 <programlisting>su - postgres
836 psql template1</programlisting> führen Sie die folgenden Kommandos aus:</para>
838 <programlisting>CREATE EXTENSION IF NOT EXISTS plpgsql;
842 <para><literal>CREATE EXTENSION</literal> ist seit Version 9.1 die
843 bevorzugte Syntax um die Sprache <literal>plpgsql</literal>
844 anzulegen. In diesen Versionen ist die Extension meist auch schon
845 vorhanden. Sollten Sie eine ältere Version von Postgres haben,
846 benutzen Sie stattdessen den folgenden Befehl.</para>
848 <programlisting>CREATE LANGUAGE 'plpgsql';
853 <sect2 id="Erweiterung-für-trigram">
854 <title>Erweiterung für Trigram Prozeduren</title>
856 <para>Ab Version 3.5.1 wird die Trigram-Index-Erweiterung benötigt.
857 Diese wird mit dem SQL-Updatescript
858 sql/Pg-upgrade2/trigram_extension.sql und Datenbank-Super-Benutzer
859 Rechten automatisch installiert. Dazu braucht der
860 DatenbankSuperbenutzer "postgres" ein Passwort.</para>
862 <programlisting>su - postgres
869 <para>Benutzername Postgres und Passwort können jetzt beim Anlegen
870 einer Datenbank bzw. bei Updatescripten, die SuperuserRechte
871 benötigen, eingegeben werden.</para>
874 <para><literal>pg_trgm</literal> ist je nach Distribution nicht im
875 Standard-Paket von Postgres enthalten. Ein <programlisting>select * from pg_available_extensions where name ='pg_trgm';</programlisting>
876 in template1 sollte entsprechend erfolgreich sein. Andernfalls muss
877 das Paket nachinstalliert werden, bspw. bei debian/ubuntu
878 <programlisting>apt install postgresql-contrib</programlisting></para>
882 <sect2 id="Datenbankbenutzer-anlegen">
883 <title>Datenbankbenutzer anlegen</title>
885 <para>Wenn Sie nicht den Datenbanksuperuser “postgres” zum Zugriff
886 benutzen wollen, so sollten Sie bei PostgreSQL einen neuen Benutzer
887 anlegen. Ein Beispiel, wie Sie einen neuen Benutzer anlegen
890 <para>Die Frage, ob der neue User Superuser sein soll, können Sie mit
891 nein beantworten, genauso ist die Berechtigung neue User (Roles) zu
892 generieren nicht nötig.</para>
894 <programlisting>su - postgres
895 createuser -d -P kivitendo
896 exit</programlisting>
898 <para>Wenn Sie später einen Datenbankzugriff konfigurieren, verändern
899 Sie den evtl. voreingestellten Benutzer “postgres” auf “kivitendo”
900 bzw. den hier gewählten Benutzernamen.</para>
904 <sect1 id="Apache-Konfiguration">
905 <title>Webserver-Konfiguration</title>
908 <title>Grundkonfiguration mittels CGI</title>
911 <para>Für einen deutlichen Performanceschub sorgt die Ausführung
912 mittels FastCGI/FCGI. Die Einrichtung wird ausführlich im Abschnitt
913 <xref linkend="Apache-Konfiguration.FCGI"/> beschrieben.</para>
916 <para>Der Zugriff auf das Programmverzeichnis muss in der Apache
917 Webserverkonfigurationsdatei <literal>httpd.conf</literal> eingestellt
918 werden. Fügen Sie den folgenden Abschnitt dieser Datei oder einer
919 anderen Datei hinzu, die beim Starten des Webservers eingelesen
922 <programlisting>AliasMatch ^/kivitendo-erp/[^/]+\.pl /var/www/kivitendo-erp/dispatcher.pl
923 Alias /kivitendo-erp/ /var/www/kivitendo-erp/
925 <Directory /var/www/kivitendo-erp>
926 AddHandler cgi-script .pl
927 Options ExecCGI Includes FollowSymlinks
930 <Directory /var/www/kivitendo-erp/users>
932 </Directory></programlisting>
934 <para>Ersetzen Sie dabei die Pfade durch diejenigen, in die Sie vorher
935 das kivitendo-Archiv entpacket haben.</para>
938 <para>Vor den einzelnen Optionen muss bei einigen Distributionen ein
939 Plus ‘<literal>+</literal>’ gesetzt werden.</para>
941 <para>Bei einigen Distribution (Ubuntu ab 14.04, Debian ab 8.2) muss
942 noch explizit das cgi-Modul mittels <programlisting>a2enmod cgi</programlisting>
943 aktiviert werden.</para>
946 <para>Auf einigen Webservern werden manchmal die Grafiken und
947 Style-Sheets nicht ausgeliefert. In solchen Fällen hat es oft
948 geholfen, die folgende Option in die Konfiguration aufzunehmen:</para>
950 <programlisting>EnableSendfile Off</programlisting>
953 <sect2 id="Apache-Konfiguration.FCGI"
954 xreflabel="Konfiguration für FastCGI/FCGI">
955 <title>Konfiguration für FastCGI/FCGI</title>
957 <sect3 id="Apache-Konfiguration.FCGI.WasIstEs">
958 <title>Was ist FastCGI?</title>
960 <para>Direkt aus <ulink
961 url="http://de.wikipedia.org/wiki/FastCGI">Wikipedia</ulink>
964 <para><citation> FastCGI ist ein Standard für die Einbindung
965 externer Software zur Generierung dynamischer Webseiten in einem
966 Webserver. FastCGI ist vergleichbar zum Common Gateway Interface
967 (CGI), wurde jedoch entwickelt, um dessen Performance-Probleme zu
968 umgehen. </citation></para>
971 <sect3 id="Apache-Konfiguration.FCGI.Warum">
972 <title>Warum FastCGI?</title>
974 <para>Perl Programme (wie kivitendo eines ist) werden nicht statisch
975 kompiliert. Stattdessen werden die Quelldateien bei jedem Start
976 übersetzt, was bei kurzen Laufzeiten einen Großteil der Laufzeit
977 ausmacht. Während SQL Ledger einen Großteil der Funktionalität in
978 einzelne Module kapselt, um immer nur einen kleinen Teil laden zu
979 müssen, ist die Funktionalität von kivitendo soweit gewachsen, dass
980 immer mehr Module auf den Rest des Programms zugreifen. Zusätzlich
981 benutzen wir umfangreiche Bibliotheken um Funktionaltät nicht selber
982 entwickeln zu müssen, die zusätzliche Ladezeit kosten. All dies
983 führt dazu dass ein kivitendo Aufruf der Kernmasken mittlerweile
984 deutlich länger dauert als früher, und dass davon 90% für das Laden
985 der Module verwendet wird.</para>
987 <para>Mit FastCGI werden nun die Module einmal geladen, und danach
988 wird nur die eigentliche Programmlogik ausgeführt.</para>
991 <sect3 id="Apache-Konfiguration.FCGI.WebserverUndPlugin">
992 <title>Getestete Kombinationen aus Webservern und Plugin</title>
994 <para>Folgende Kombinationen sind getestet:</para>
998 <para>Apache 2.2.11 (Ubuntu) und mod_fcgid.</para>
1002 <para>Apache 2.2.11 / 2.2.22 (Ubuntu) und mod_fastcgi.</para>
1006 <para>Apache 2.4.7 (Ubuntu 14.04.2 LTS) und mod_fcgid.</para>
1010 <para>Dabei wird mod_fcgid empfohlen, weil mod_fastcgi seit geraumer
1011 Zeit nicht mehr weiter entwickelt wird. Im Folgenden wird auf
1012 mod_fastcgi nicht mehr explizit eingegangen.</para>
1014 <para>Als Perl Backend wird das Modul <filename>FCGI.pm</filename>
1018 <para>FCGI-Versionen ab 0.69 und bis zu 0.71 inklusive sind extrem
1019 strict in der Behandlung von Unicode, und verweigern bestimmte
1020 Eingaben von kivitendo. Falls es Probleme mit Umlauten in Ihrer
1021 Installation gibt, muss zwingend Version 0.68 oder aber Version
1022 0.72 und neuer eingesetzt werden.</para>
1024 <para>Mit <ulink url="http://www.cpan.org">CPAN</ulink> lässt sie
1025 sich die Vorgängerversion wie folgt installieren:</para>
1027 <programlisting>force install M/MS/MSTROUT/FCGI-0.68.tar.gz</programlisting>
1031 <sect3 id="Apache-Konfiguration.FCGI.Konfiguration">
1032 <title>Konfiguration des Webservers</title>
1034 <para>Bevor Sie versuchen, eine kivitendo Installation unter FCGI
1035 laufen zu lassen, empfiehlt es sich die Installation ersteinmal
1036 unter CGI aufzusetzen. FCGI macht es nicht einfach Fehler zu
1037 debuggen die beim ersten aufsetzen auftreten können. Sollte die
1038 Installation schon funktionieren, lesen Sie weiter.</para>
1040 <para>Zuerst muss das FastCGI-Modul aktiviert werden. Dies kann
1041 unter Debian/Ubuntu z.B. mit folgendem Befehl geschehen:</para>
1043 <programlisting>a2enmod fcgid</programlisting>
1045 <para>Die Konfiguration für die Verwendung von kivitendo mit FastCGI
1046 erfolgt durch Anpassung der vorhandenen <function>Alias</function>-
1047 und <function>Directory</function>-Direktiven. Dabei wird zwischen
1048 dem Installationspfad von kivitendo im Dateisystem
1049 ("<filename>/path/to/kivitendo-erp</filename>") und der URL
1050 unterschieden, unter der kivitendo im Webbrowser erreichbar ist
1051 ("<filename>/url/for/kivitendo-erp</filename>").</para>
1053 <para>Folgender Konfigurationsschnipsel funktioniert mit
1056 <programlisting>AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fcgi
1057 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
1059 <Directory /path/to/kivitendo-erp>
1061 Options ExecCGI Includes FollowSymlinks
1065 <DirectoryMatch /path/to/kivitendo-erp/users>
1067 </DirectoryMatch></programlisting>
1070 <para>Wer einen älteren Apache als Version 2.4 im Einsatz hat,
1071 muss entsprechend die Syntax der Directorydirektiven verändert.
1074 <programlisting>Require all granted</programlisting>
1076 <para>muß man Folgendes einstellen:</para>
1080 Allow from All </programlisting>
1082 <para>und statt</para>
1084 <programlisting>Require all denied</programlisting>
1086 <para>muss stehen:</para>
1090 Deny from All </programlisting>
1093 <para>Seit mod_fcgid-Version 2.3.6 gelten sehr kleine Grenzen für
1094 die maximale Größe eines Requests. Diese sollte wie folgt
1095 hochgesetzt werden:</para>
1097 <programlisting>FcgidMaxRequestLen 10485760</programlisting>
1099 <para>Das Ganze sollte dann so aussehen:</para>
1101 <programlisting>AddHandler fcgid-script .fpl
1102 AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
1103 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
1104 FcgidMaxRequestLen 10485760
1106 <Directory /path/to/kivitendo-erp>
1108 Options ExecCGI Includes FollowSymlinks
1113 <DirectoryMatch /path/to/kivitendo-erp/users>
1116 </DirectoryMatch></programlisting>
1118 <para>Hierdurch wird nur ein zentraler Dispatcher gestartet. Alle
1119 Zugriffe auf die einzelnen Scripte werden auf diesen umgeleitet.
1120 Dadurch, dass zur Laufzeit öfter mal Scripte neu geladen werden,
1121 gibt es hier kleine Performance-Einbußen.</para>
1123 <para>Es ist möglich, die gleiche kivitendo Version parallel unter
1124 CGI und FastCGI zu betreiben. Dafür bleiben die Directorydirektiven
1125 wie oben beschrieben, die URLs werden aber umgeleitet:</para>
1127 <programlisting># Zugriff über CGI
1128 Alias /url/for/kivitendo-erp /path/to/kivitendo-erp
1130 # Zugriff mit mod_fcgid:
1131 AliasMatch ^/url/for/kivitendo-erp-fcgid/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
1132 Alias /url/for/kivitendo-erp-fcgid/ /path/to/kivitendo-erp/</programlisting>
1134 <para>Dann ist unter <filename>/url/for/kivitendo-erp/</filename>
1135 die normale Version erreichbar, und unter
1136 <constant>/url/for/kivitendo-erp-fcgid/</constant> die
1137 FastCGI-Version.</para>
1142 <title>Weitergehende Konfiguration</title>
1144 <para>Für einen deutlichen Sicherheitsmehrwert sorgt die Ausführung
1145 von kivitendo nur über https-verschlüsselten Verbindungen, sowie
1146 weiteren Zusatzmassnahmen, wie beispielsweise Basic Authenticate. Die
1147 Konfigurationsmöglichkeiten sprengen allerdings den Rahmen dieser
1148 Anleitung, hier ein Hinweis auf einen entsprechenden <ulink
1149 url="http://redmine.kivitendo-premium.de/boards/1/topics/142">Foreneintrag
1150 (Stand Sept. 2015)</ulink> und einen aktuellen (Stand Mai 2017) <ulink
1151 url="https://mozilla.github.io/server-side-tls/ssl-config-generator/">
1152 SSL-Konfigurations-Generator</ulink>.</para>
1156 <sect1 id="config.task-server">
1157 <title>Der Task-Server</title>
1159 <para>Der Task-Server ist ein Prozess, der im Hintergrund läuft, in
1160 regelmäßigen Abständen nach abzuarbeitenden Aufgaben sucht und diese zu
1161 festgelegten Zeitpunkten abarbeitet (ähnlich wie Cron). Dieser Prozess
1162 wird u.a. für die Erzeugung der wiederkehrenden Rechnungen und weitere
1163 essenzielle Aufgaben benutzt.</para>
1165 <para>Der Task-Server muss einmalig global in der Konfigurationsdatei
1166 konfiguriert werden. Danach wird er für jeden Mandanten, für den er
1167 laufen soll, in der Adminsitrationsmaske eingeschaltet.</para>
1169 <para>Beachten Sie, dass der Task-Server in den Boot-Vorgang Ihres
1170 Servers integriert werden muss, damit er automatisch gestartet wird.
1171 Dies kann kivitendo nicht für Sie erledigen.</para>
1173 <para>Da der Taskserver als Perlscript läuft, wird Arbeitsspeicher, der
1174 einmal benötigt wurde, nicht mehr an das Betriebssystem zurückgegeben,
1175 solange der Taskserver läuft. Dies kann dazu führen, dass ein länger
1176 laufender Taskserver mit der Zeit immer mehr Arbeitsspeicher für sich
1177 beansprucht. Es ist deshalb sinnvoll, dass der Taskserver in
1178 regelmässigen Abständen neu gestartet wird.</para>
1180 <sect2 id="Konfiguration-des-Task-Servers">
1181 <title>Verfügbare und notwendige Konfigurationsoptionen</title>
1183 <para>Die Konfiguration erfolgt über den Abschnitt
1184 <literal>[task_server]</literal> in der Datei
1185 <filename>config/kivitendo.conf</filename>. Die dort verfügbaren
1186 Optionen sind:</para>
1190 <term><varname>run_as</varname></term>
1193 <para>Wird der Server vom Systembenutzer <literal>root</literal>
1194 gestartet, so wechselt er auf den mit <literal>run_as</literal>
1195 angegebenen Systembenutzer. Der Systembenutzer muss dieselben
1196 Lese- und Schreibrechte haben, wie auch der Webserverbenutzer
1198 linkend="Manuelle-Installation-des-Programmpaketes"/>). Daher
1199 ist es erforderlich, hier denselben Systembenutzer einzutragen,
1200 unter dem auch der Webserver läuft.</para>
1205 <term><varname>debug</varname></term>
1208 <para>Schaltet Debug-Informationen an und aus.</para>
1214 <sect2 id="Konfiguration-der-Mandanten-fuer-den-Task-Servers">
1215 <title>Konfiguration der Mandanten für den Task-Server</title>
1217 <para>Ist der Task-Server grundlegend konfiguriert, so muss
1218 anschließend jeder Mandant, für den der Task-Server laufen soll,
1219 einmalig konfiguriert werden. Dazu kann in der Maske zum Bearbeiten
1220 von Mandanten im Administrationsbereich eine kivitendo-Benutzerkennung
1221 ausgewählt werden, unter der der Task-Server seine Arbeit
1224 <para>Ist in dieser Einstellung keine Benutzerkennung ausgewählt, so
1225 wird der Task-Server für diesen Mandanten keine Aufgaben
1229 <sect2 id="Einbinden-in-den-Boot-Prozess">
1230 <title>Automatisches Starten des Task-Servers beim Booten</title>
1232 <para>Der Task-Server verhält sich von seinen Optionen her wie ein
1233 reguläres SystemV-kompatibles Boot-Script. Außerdem wechselt er beim
1234 Starten automatisch in das kivitendo-Installationsverzeichnis.</para>
1236 <para>Deshalb ist es möglich, ihn durch Setzen eines symbolischen
1237 Links aus einem der Runlevel-Verzeichnisse heraus in den Boot-Prozess
1238 einzubinden. Da das bei neueren Linux-Distributionen aber nicht
1239 zwangsläufig funktioniert, werden auch Start-Scripte mitgeliefert, die
1240 anstelle eines symbolischen Links verwendet werden können.</para>
1243 <title>SystemV-basierende Systeme (z.B. ältere Debian, ältere
1244 OpenSUSE, ältere Fedora)</title>
1246 <para>Kopieren Sie die Datei
1247 <filename>scripts/boot/system-v/kivitendo-task-server</filename>
1248 nach <filename>/etc/init.d/kivitendo-task-server</filename>. Passen
1249 Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
1250 <literal>DAEMON=....</literal>). Binden Sie das Script in den
1251 Boot-Prozess ein. Dies ist distributionsabhängig:</para>
1255 <para>Debian-basierende Systeme:</para>
1257 <programlisting>update-rc.d kivitendo-task-server defaults
1258 insserv kivitendo-task-server</programlisting>
1262 <para>Ältere OpenSUSE und ältere Fedora:</para>
1264 <programlisting>chkconfig --add kivitendo-task-server</programlisting>
1268 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
1271 <programlisting>/etc/init.d/kivitendo-task-server start</programlisting>
1275 <title>Upstart-basierende Systeme (z.B. Ubuntu bis 14.04)</title>
1277 <para>Kopieren Sie die Datei
1278 <filename>scripts/boot/upstart/kivitendo-task-server.conf</filename>
1279 nach <filename>/etc/init/kivitendo-task-server.conf</filename>.
1280 Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
1281 <literal>exec ....</literal>).</para>
1283 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
1286 <programlisting>service kivitendo-task-server start</programlisting>
1290 <title>systemd-basierende Systeme (z.B. neure openSUSE, neuere
1291 Fedora, neuere Ubuntu und neuere Debians)</title>
1293 <para>Kopieren Sie die Datei
1294 <filename>scripts/boot/systemd/kivitendo-task-server.service</filename>
1295 nach <filename>/etc/systemd/system/</filename>. Passen Sie in der
1296 kopierten Datei den Pfad zum Task-Server an (Zeilen
1297 <literal>ExecStart=....</literal> und
1298 <literal>ExecStop=...</literal>).</para>
1300 <para>Machen Sie anschließend das Script systemd bekannt, und binden
1301 Sie es in den Boot-Prozess ein. Dazu führen Sie die folgenden Befehl
1304 <programlisting>systemctl daemon-reload
1305 systemctl enable kivitendo-task-server.service</programlisting>
1307 <para>Wenn Sie den Task-Server jetzt sofort starten möchten, anstatt
1308 den Server neu zu starten, so können Sie das mit dem folgenden
1311 <programlisting>systemctl start kivitendo-task-server.service</programlisting>
1315 <sect2 id="Prozesskontrolle">
1316 <title>Wie der Task-Server gestartet und beendet wird</title>
1318 <para>Der Task-Server wird wie folgt kontrolliert:</para>
1320 <programlisting>./scripts/task_server.pl Befehl</programlisting>
1322 <para><literal>Befehl</literal> ist dabei eine der folgenden
1327 <para><literal>start</literal> startet eine neue Instanz des
1328 Task-Servers. Die Prozess-ID wird innerhalb des
1329 <filename>users</filename>-Verzeichnisses abgelegt.</para>
1333 <para><literal>stop</literal> beendet einen laufenden
1338 <para><literal>restart</literal> beendet und startet ihn
1343 <para><literal>status</literal> berichtet, ob der Task-Server
1348 <para>Der Task-Server wechselt beim Starten automatisch in das
1349 kivitendo-Installationsverzeichnis.</para>
1351 <para>Dieselben Optionen können auch für die SystemV-basierenden
1352 Runlevel-Scripte benutzt werden (siehe oben).</para>
1356 <sect1 id="Benutzerauthentifizierung-und-Administratorpasswort">
1357 <title>Benutzerauthentifizierung und Administratorpasswort</title>
1359 <para>Informationen über die Einrichtung der Benutzerauthentifizierung,
1360 über die Verwaltung von Gruppen und weitere Einstellungen</para>
1362 <sect2 id="Grundlagen-zur-Benutzerauthentifizierung">
1363 <title>Grundlagen zur Benutzerauthentifizierung</title>
1365 <para>kivitendo verwaltet die Benutzerinformationen in einer
1366 Datenbank, die im folgenden “Authentifizierungsdatenbank” genannt
1367 wird. Für jeden Benutzer kann dort eine eigene Datenbank für die
1368 eigentlichen Finanzdaten hinterlegt sein. Diese beiden Datenbanken
1369 können, müssen aber nicht unterschiedlich sein.</para>
1371 <para>Im einfachsten Fall gibt es für kivitendo nur eine einzige
1372 Datenbank, in der sowohl die Benutzerinformationen als auch die Daten
1373 abgelegt werden.</para>
1375 <para>Zusätzlich ermöglicht es kivitendo, dass die Benutzerpasswörter
1376 entweder gegen die Authentifizierungsdatenbank oder gegen einen
1377 LDAP-Server überprüft werden.</para>
1379 <para>Welche Art der Passwortüberprüfung kivitendo benutzt und wie
1380 kivitendo die Authentifizierungsdatenbank erreichen kann, wird in der
1381 Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1382 festgelegt. Diese muss bei der Installation und bei einem Upgrade von
1383 einer Version vor v2.6.0 angelegt werden. Eine
1384 Beispielkonfigurationsdatei
1385 <filename>config/kivitendo.conf.default</filename> existiert, die als
1386 Vorlage benutzt werden kann.</para>
1389 <sect2 id="Administratorpasswort">
1390 <title>Administratorpasswort</title>
1392 <para>Das Passwort, das zum Zugriff auf das Administrationsinterface
1393 von kivitendo benutzt wird, wird ebenfalls in dieser Datei
1394 gespeichert. Es kann auch nur dort und nicht mehr im
1395 Administrationsinterface selber geändert werden. Der Parameter dazu
1396 heißt <varname>admin_password</varname> im Abschnitt
1397 <varname>[authentication]</varname>.</para>
1400 <sect2 id="Authentifizierungsdatenbank">
1401 <title>Authentifizierungsdatenbank</title>
1403 <para>Die Verbindung zur Authentifizierungsdatenbank wird mit den
1404 Parametern in <varname>[authentication/database]</varname>
1405 konfiguriert. Hier sind die folgenden Parameter anzugeben:</para>
1409 <term><literal>host</literal></term>
1412 <para>Der Rechnername oder die IP-Adresse des
1413 Datenbankservers</para>
1418 <term><literal>port</literal></term>
1421 <para>Die Portnummer des Datenbankservers, meist 5432</para>
1426 <term><literal>db</literal></term>
1429 <para>Der Name der Authentifizierungsdatenbank</para>
1434 <term><literal>user</literal></term>
1437 <para>Der Benutzername, mit dem sich kivitendo beim
1438 Datenbankserver anmeldet (z.B.
1439 "<literal>postgres</literal>")</para>
1444 <term><literal>password</literal></term>
1447 <para>Das Passwort für den Datenbankbenutzer</para>
1452 <para>Die Datenbank muss noch nicht existieren. kivitendo kann sie
1453 automatisch anlegen (mehr dazu siehe unten).</para>
1456 <sect2 id="Passwortüberprüfung">
1457 <title>Passwortüberprüfung</title>
1459 <para>kivitendo unterstützt Passwortüberprüfung auf zwei Arten: gegen
1460 die Authentifizierungsdatenbank und gegen einen externen LDAP- oder
1461 Active-Directory-Server. Welche davon benutzt wird, regelt der
1462 Parameter <varname>module</varname> im Abschnitt
1463 <varname>[authentication]</varname>.</para>
1465 <para>Sollen die Benutzerpasswörter in der Authentifizierungsdatenbank
1466 gespeichert werden, so muss der Parameter <varname>module</varname>
1467 den Wert <literal>DB</literal> enthalten. In diesem Fall können sowohl
1468 der Administrator als auch die Benutzer selber ihre Passwörter in
1469 kivitendo ändern.</para>
1471 <para>Soll hingegen ein externer LDAP- oder Active-Directory-Server
1472 benutzt werden, so muss der Parameter <varname>module</varname> auf
1473 <literal>LDAP</literal> gesetzt werden. In diesem Fall müssen
1474 zusätzliche Informationen über den LDAP-Server im Abschnitt
1475 <literal>[authentication/ldap]</literal> angegeben werden:</para>
1479 <term><literal>host</literal></term>
1482 <para>Der Rechnername oder die IP-Adresse des LDAP- oder
1483 Active-Directory-Servers. Diese Angabe ist zwingend
1484 erforderlich.</para>
1489 <term><literal>port</literal></term>
1492 <para>Die Portnummer des LDAP-Servers; meist 389.</para>
1497 <term><literal>tls</literal></term>
1500 <para>Wenn Verbindungsverschlüsselung gewünscht ist, so diesen
1501 Wert auf ‘<literal>1</literal>’ setzen, andernfalls auf
1502 ‘<literal>0</literal>’ belassen</para>
1507 <term><literal>attribute</literal></term>
1510 <para>Das LDAP-Attribut, in dem der Benutzername steht, den der
1511 Benutzer eingegeben hat. Für Active-Directory-Server ist dies
1512 meist ‘<literal>sAMAccountName</literal>’, für andere
1513 LDAP-Server hingegen ‘<literal>uid</literal>’. Diese Angabe ist
1514 zwingend erforderlich.</para>
1519 <term><literal>base_dn</literal></term>
1522 <para>Der Abschnitt des LDAP-Baumes, der durchsucht werden soll.
1523 Diese Angabe ist zwingend erforderlich.</para>
1528 <term><literal>filter</literal></term>
1531 <para>Ein optionaler LDAP-Filter. Enthält dieser Filter das Wort
1532 <literal><%login%></literal>, so wird dieses durch den vom
1533 Benutzer eingegebenen Benutzernamen ersetzt. Andernfalls wird
1534 der LDAP-Baum nach einem Element durchsucht, bei dem das oben
1535 angegebene Attribut mit dem Benutzernamen identisch ist.</para>
1540 <term><literal>bind_dn</literal> und
1541 <literal>bind_password</literal></term>
1544 <para>Wenn der LDAP-Server eine Anmeldung erfordert, bevor er
1545 durchsucht werden kann (z.B. ist dies bei
1546 Active-Directory-Servern der Fall), so kann diese hier angegeben
1547 werden. Für Active-Directory-Server kann als
1548 ‘<literal>bind_dn</literal>’ entweder eine komplette LDAP-DN wie
1549 z.B. ‘<literal>cn=Martin
1550 Mustermann,cn=Users,dc=firmendomain</literal>’ auch nur der
1551 volle Name des Benutzers eingegeben werden; in diesem Beispiel
1552 also ‘<literal>Martin Mustermann</literal>’.</para>
1558 <sect2 id="Name-des-Session-Cookies">
1559 <title>Name des Session-Cookies</title>
1561 <para>Sollen auf einem Server mehrere kivitendo-Installationen
1562 aufgesetzt werden, so müssen die Namen der Session-Cookies für alle
1563 Installationen unterschiedlich sein. Der Name des Cookies wird mit dem
1564 Parameter <varname>cookie_name</varname> im Abschnitt
1565 <varname>[authentication]</varname>gesetzt.</para>
1567 <para>Diese Angabe ist optional, wenn nur eine Installation auf dem
1568 Server existiert.</para>
1571 <sect2 id="Anlegen-der-Authentifizierungsdatenbank">
1572 <title>Anlegen der Authentifizierungsdatenbank</title>
1574 <para>Nachdem alle Einstellungen in
1575 <filename>config/kivitendo.conf</filename> vorgenommen wurden, muss
1576 kivitendo die Authentifizierungsdatenbank anlegen. Dieses geschieht
1577 automatisch, wenn Sie sich im Administrationsmodul anmelden, das unter
1578 der folgenden URL erreichbar sein sollte:</para>
1581 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
1585 <sect1 id="Benutzer--und-Gruppenverwaltung">
1586 <title>Mandanten-, Benutzer- und Gruppenverwaltung</title>
1588 <para>Nach der Installation müssen Mandanten, Benutzer, Gruppen und
1589 Datenbanken angelegt werden. Dieses geschieht im Administrationsmenü,
1590 das Sie unter folgender URL finden:</para>
1593 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
1595 <para>Verwenden Sie zur Anmeldung das Passwort, das Sie in der Datei
1596 <filename>config/kivitendo.conf</filename> eingetragen haben.</para>
1598 <sect2 id="Zusammenhänge">
1599 <title>Zusammenhänge</title>
1601 <para>kivitendo verwaltet zwei Sets von Daten, die je nach Einrichtung
1602 in einer oder zwei Datenbanken gespeichert werden.</para>
1604 <para>Das erste Set besteht aus Anmeldeinformationen: welche Benutzer
1605 und Mandanten gibt es, welche Gruppen, welche BenutzerIn hat Zugriff
1606 auf welche Mandanten, und welche Gruppe verfügt über welche Rechte.
1607 Diese Informationen werden in der Authentifizierungsdatenbank
1608 gespeichert. Dies ist diejenige Datenbank, deren Verbindungsparameter
1609 in der Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1610 gespeichert werden.</para>
1612 <para>Das zweite Set besteht aus den eigentlichen Verkehrsdaten eines
1613 Mandanten, wie beispielsweise die Stammdaten (Kunden, Lieferanten,
1614 Waren) und Belege (Angebote, Lieferscheine, Rechnungen). Diese werden
1615 in einer Mandantendatenbank gespeichert. Die Verbindungsinformationen
1616 einer solchen Mandantendatenbank werden im Administrationsbereich
1617 konfiguriert, indem man einen Mandanten anlegt und dort die Parameter
1618 einträgt. Dabei hat jeder Mandant eine eigene Datenbank.</para>
1620 <para>Aufgrund des Datenbankdesigns ist es für einfache Fälle möglich,
1621 die Authentifizierungsdatenbank und eine der Mandantendatenbanken in
1622 ein und derselben Datenbank zu speichern. Arbeitet man hingegen mit
1623 mehr als einem Mandanten, wird empfohlen, für die
1624 Authentifizierungsdatenbank eine eigene Datenbank zu verwenden, die
1625 nicht gleichzeitig für einen Mandanten verwendet wird.</para>
1628 <sect2 id="Mandanten-Benutzer-Gruppen">
1629 <title>Mandanten, Benutzer und Gruppen</title>
1631 <para>kivitendos Administration kennt Mandanten, Benutzer und Gruppen,
1632 die sich frei zueinander zuordnen lassen.</para>
1634 <para>kivitendo kann mehrere Mandaten aus einer Installation heraus
1635 verwalten. Welcher Mandant benutzt wird, kann direkt beim Login
1636 ausgewählt werden. Für jeden Mandanten wird ein eindeutiger Name
1637 vergeben, der beim Login angezeigt wird. Weiterhin benötigt der
1638 Mandant Datenbankverbindungsparameter für seine Mandantendatenbank.
1639 Diese sollte über die <link
1640 linkend="Datenbanken-anlegen">Datenbankverwaltung</link>
1643 <para>Ein Benutzer ist eine Person, die Zugriff auf kivitendo erhalten
1644 soll. Sie erhält einen Loginnamen sowie ein Passwort. Weiterhin legt
1645 der Administrator fest, an welchen Mandanten sich ein Benutzer
1646 anmelden kann, was beim Login verifiziert wird.</para>
1648 <para>Gruppen dienen dazu, Benutzern innerhalb eines Mandanten Zugriff
1649 auf bestimmte Funktionen zu geben. Einer Gruppe werden dafür vom
1650 Administrator gewisse Rechte zugeordnet. Weiterhin legt der
1651 Administrator fest, für welche Mandanten eine Gruppe gilt, und welche
1652 Benutzer Mitglieder in dieser Gruppe sind. Meldet sich ein Benutzer
1653 dann an einem Mandanten an, so erhält er alle Rechte von allen
1654 denjenigen Gruppen, die zum Einen dem Mandanten zugeordnet sind und in
1655 denen der Benutzer zum Anderen Mitglied ist,</para>
1657 <para>Die Reihenfolge, in der Datenbanken, Mandanten, Gruppen und
1658 Benutzer angelegt werden, kann im Prinzip beliebig gewählt werden. Die
1659 folgende Reihenfolge beinhaltet die wenigsten Arbeitsschritte:</para>
1661 <orderedlist numeration="arabic">
1663 <para>Datenbank anlegen</para>
1667 <para>Gruppen anlegen</para>
1671 <para>Benutzer anlegen und Gruppen als Mitglied zuordnen</para>
1675 <para>Mandanten anlegen und Gruppen sowie Benutzer zuweisen</para>
1680 <sect2 id="Datenbanken-anlegen">
1681 <title>Datenbanken anlegen</title>
1683 <para>Zuerst muss eine Datenbank angelegt werden. Verwenden Sie für
1684 den Datenbankzugriff den vorhin angelegten Benutzer (in unseren
1685 Beispielen ist dies ‘<literal>kivitendo</literal>’).</para>
1688 <sect2 id="Gruppen-anlegen">
1689 <title>Gruppen anlegen</title>
1691 <para>Eine Gruppe wird in der Gruppenverwaltung angelegt. Ihr muss ein
1692 Name gegeben werden, eine Beschreibung ist hingegen optional. Nach dem
1693 Anlegen können Sie die verschiedenen Bereiche wählen, auf die
1694 Mitglieder dieser Gruppe Zugriff haben sollen.</para>
1696 <para>Benutzergruppen werden zwar in der Authentifizierungsdatenbank
1697 gespeichert, gelten aber nicht automatisch für alle Mandanten. Der
1698 Administrator legt vielmehr fest, für welche Mandanten eine Gruppe
1699 gültig ist. Dies kann entweder beim Bearbeiten der Gruppe geschehen
1700 ("diese Gruppe ist gültig für Mandanten X, Y und Z"), oder aber wenn
1701 man einen Mandanten bearbeitet ("für diesen Mandanten sind die Gruppen
1702 A, B und C gültig").</para>
1704 <para>Wurden bereits Benutzer angelegt, so können hier die Mitglieder
1705 dieser Gruppe festgelegt werden ("in dieser Gruppe sind die Benutzer
1706 X, Y und Z Mitglieder"). Dies kann auch nachträglich beim Bearbeiten
1707 eines Benutzers geschehen ("dieser Benutzer ist Mitglied in den
1708 Gruppen A, B und C").</para>
1711 <sect2 id="Benutzer-anlegen">
1712 <title>Benutzer anlegen</title>
1714 <para>Beim Anlegen von Benutzern werden für viele Parameter
1715 Standardeinstellungen vorgenommen, die den Gepflogenheiten des
1716 deutschen Raumes entsprechen.</para>
1718 <para>Zwingend anzugeben ist der Loginname. Wenn die
1719 Passwortauthentifizierung über die Datenbank eingestellt ist, so kann
1720 hier auch das Benutzerpasswort gesetzt bzw. geändert werden. Ist
1721 hingegen die LDAP-Authentifizierung aktiv, so ist das Passwort-Feld
1724 <para>Hat man bereits Mandanten und Gruppen angelegt, so kann hier
1725 auch konfiguriert werden, auf welche Mandanten der Benutzer Zugriff
1726 hat bzw. in welchen Gruppen er Mitglied ist. Beide Zuweisungen können
1727 sowohl beim Benutzer vorgenommen werden ("dieser Benutzer hat Zugriff
1728 auf Mandanten X, Y, Z" bzw. "dieser Benutzer ist Mitglied in Gruppen
1729 X, Y und Z") als auch beim Mandanten ("auf diesen Mandanten haben
1730 Benutzer A, B und C Zugriff") bzw. bei der Gruppe ("in dieser Gruppe
1731 sind Benutzer A, B und C Mitglieder").</para>
1734 <sect2 id="Mandanten-anlegen">
1735 <title>Mandanten anlegen</title>
1737 <para>Ein Mandant besteht aus Administrationssicht primär aus einem
1738 eindeutigen Namen. Weiterhin wird hier hinterlegt, welche Datenbank
1739 als Mandantendatenbank benutzt wird. Hier müssen die Zugriffsdaten
1740 einer der eben angelegten Datenbanken eingetragen werden.</para>
1742 <para>Hat man bereits Benutzer und Gruppen angelegt, so kann hier auch
1743 konfiguriert werden, welche Benutzer Zugriff auf den Mandanten haben
1744 bzw. welche Gruppen für den Mandanten gültig sind. Beide Zuweisungen
1745 können sowohl beim Mandanten vorgenommen werden ("auf diesen Mandanten
1746 haben Benutzer X, Y und Z Zugriff" bzw. "für diesen Mandanten sind die
1747 Gruppen X, Y und Z gültig") als auch beim Benutzer ("dieser Benutzer
1748 hat Zugriff auf Mandanten A, B und C") bzw. bei der Gruppe ("diese
1749 Gruppe ist für Mandanten A, B und C gültig").</para>
1753 <sect1 id="Drucker--Systemverwaltung">
1754 <title>Drucker- und Systemverwaltung</title>
1756 <para>Im Administrationsmenü gibt es ferner noch die beiden Menüpunkte
1757 Druckeradministration und System.</para>
1759 <sect2 id="Druckeradministration">
1760 <title>Druckeradministration</title>
1762 <para>Unter dem Menüpunkt Druckeradministration lassen sich beliebig
1763 viele "Druckbefehle" im System verwalten. Diese Befehle werden
1764 mandantenweise zugeordnet. Unter Druckerbeschreibung wird der Namen
1765 des Druckbefehls festgelegt, der dann in der Druckerauswahl des Belegs
1766 angezeigt wird.</para>
1768 <para>Unter Druckbefehl definiert man den eigentlichen Druckbefehl,
1769 der direkt auf dem Webserver ausgeführt wird, bspw. 'lpr -P
1770 meinDrucker' oder ein kompletter Pfad zu einem Skript
1771 (/usr/local/src/kivitendo/scripts/pdf_druck_in_verzeichnis.sh). Wird
1772 ferner noch ein optionales Vorlagenkürzel verwendet, wird dieses
1773 Kürzel bei der Auswahl der Druckvorlagendatei mit einem Unterstrich
1774 ergänzt, ist bspw. das Kürzel 'epson_drucker' definiert, so wird beim
1775 Ausdruck eines Angebots folgende Vorlage geparst:
1776 sales_quotation_epson_drucker.tex.</para>
1780 <title>System sperren / entsperren</title>
1782 <para>Unter dem Menüpunkt System gibt es den Eintrag 'Installation
1783 sperren/entsperren'. Setzt man diese Sperre so ist der Zugang zu der
1784 gesamten kivitendo Installation gesperrt.</para>
1786 <para>Falls die Sperre gesetzt ist, erscheint anstelle der
1787 Anmeldemaske die Information: 'kivitendo ist momentan zwecks
1788 Wartungsarbeiten nicht zugänglich.'.</para>
1790 <para>Wichtig zu erwähnen ist hierbei noch, dass sich kivitendo
1791 automatisch 'sperrt', falls es bei einem Versionsupdate zu einem
1792 Datenbankfehler kam. Somit kann hier nicht aus Versehen mit einem
1793 inkonsistenten Datenbestand weitergearbeitet werden.</para>
1797 <sect1 id="config.sending-email"
1798 xreflabel="E-Mail-Versand aus kivitendo heraus">
1799 <title>E-Mail-Versand aus kivitendo heraus</title>
1801 <para>kivitendo kann direkt aus dem Programm heraus E-Mails versenden,
1802 z.B. um ein Angebot direkt an einen Kunden zu verschicken. Damit dies
1803 funktioniert, muss eingestellt werden, über welchen Server die E-Mails
1804 verschickt werden sollen. kivitendo unterstützt dabei zwei Mechanismen:
1805 Versand über einen lokalen E-Mail-Server (z.B. mit
1806 <productname>Postfix</productname> oder <productname>Exim</productname>,
1807 was auch die standardmäßig aktive Methode ist) sowie Versand über einen
1808 SMTP-Server (z.B. der des eigenen Internet-Providers).</para>
1810 <para>Welche Methode und welcher Server verwendet werden, wird über die
1811 Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1812 festgelegt. Dort befinden sich alle Einstellungen zu diesem Thema im
1813 Abschnitt '<literal>[mail_delivery]</literal>'.</para>
1815 <sect2 id="config.sending-email.sendmail"
1816 xreflabel="E-Mail-Versand über lokalen E-Mail-Server">
1817 <title>Versand über lokalen E-Mail-Server</title>
1819 <para>Diese Methode bietet sich an, wenn auf dem Server, auf dem
1820 kivitendo läuft, bereits ein funktionsfähiger E-Mail-Server wie z.B.
1821 <productname>Postfix</productname>, <productname>Exim</productname>
1822 oder <productname>Sendmail</productname> läuft.</para>
1824 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter
1825 '<literal>method = sendmail</literal>' gesetzt sein. Dies ist
1826 gleichzeitig der Standardwert, falls er nicht verändert wird.</para>
1828 <para>Um zu kontrollieren, wie das Programm zum Einliefern gestartet
1829 wird, dient der Parameter '<literal>sendmail = ...</literal>'. Der
1830 Standardwert verweist auf das Programm
1831 <filename>/usr/bin/sendmail</filename>, das bei allen oben genannten
1832 E-Mail-Serverprodukten für diesen Zweck funktionieren sollte.</para>
1834 <para>Die Konfiguration des E-Mail-Servers selber würde den Rahmen
1835 dieses sprengen. Hierfür sei auf die Dokumentation des E-Mail-Servers
1839 <sect2 id="config.sending-email.smtp"
1840 xreflabel="E-Mail-Versand über einen SMTP-Server">
1841 <title>Versand über einen SMTP-Server</title>
1843 <para>Diese Methode bietet sich an, wenn kein lokaler E-Mail-Server
1844 vorhanden oder zwar einer vorhanden, dieser aber nicht konfiguriert
1847 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter
1848 '<literal>method = smtp</literal>' gesetzt sein. Die folgenden
1849 Parameter dienen dabei der weiteren Konfiguration:</para>
1853 <term><varname>hostname</varname></term>
1856 <para>Name oder IP-Adresse des SMTP-Servers. Standardwert:
1857 '<literal>localhost</literal>'</para>
1862 <term><varname>port</varname></term>
1865 <para>Portnummer. Der Standardwert hängt von der verwendeten
1866 Verschlüsselungsmethode ab. Gilt '<literal>security =
1867 none</literal>' oder '<literal>security = tls</literal>', so ist
1868 25 die Standardportnummer. Für '<literal>security =
1869 ssl</literal>' ist 465 die Portnummer. Muss normalerweise nicht
1870 geändert werden.</para>
1875 <term><varname>security</varname></term>
1878 <para>Wahl der zu verwendenden Verschlüsselung der Verbindung
1879 mit dem Server. Standardwert ist '<literal>none</literal>',
1880 wodurch keine Verschlüsselung verwendet wird. Mit
1881 '<literal>tls</literal>' wird TLS-Verschlüsselung eingeschaltet,
1882 und mit '<literal>ssl</literal>' wird Verschlüsselung via SSL
1883 eingeschaltet. Achtung: Für '<literal>tls</literal>' und
1884 '<literal>ssl</literal>' werden zusätzliche Perl-Module benötigt
1885 (siehe unten).</para>
1890 <term><varname>login</varname> und
1891 <varname>password</varname></term>
1894 <para>Falls der E-Mail-Server eine Authentifizierung verlangt,
1895 so können mit diesen zwei Parametern der Benutzername und das
1896 Passwort angegeben werden. Wird Authentifizierung verwendet, so
1897 sollte aus Sicherheitsgründen auch eine Form von Verschlüsselung
1898 aktiviert werden.</para>
1905 <sect1 id="Drucken-mit-kivitendo">
1906 <title>Drucken mit kivitendo</title>
1908 <para>Das Drucksystem von kivitendo benutzt von Haus aus LaTeX-Vorlagen.
1909 Um drucken zu können, braucht der Server ein geeignetes LaTeX System. Am
1910 einfachsten ist dazu eine <literal>texlive</literal> Installation. Unter
1911 debianoiden Betriebssystemen installiert man die Pakete mit:</para>
1913 <para><programlisting>apt-get install texlive-base-bin texlive-latex-recommended texlive-fonts-recommended \
1914 texlive-latex-extra texlive-lang-german texlive-generic-extra</programlisting></para>
1916 <para>Für Fedora benötigen Sie die folgenden Pakete:</para>
1918 <para><programlisting>dnf install texlive-collection-latex texlive-collection-latexextra \
1919 texlive-collection-latexrecommended texlive-collection-langgerman \
1920 texlive-collection-langenglish</programlisting></para>
1922 <para>Für openSUSE benötigen Sie die folgenden Pakete:</para>
1924 <para><programlisting>zypper install texlive-collection-latex texlive-collection-latexextra \
1925 texlive-collection-latexrecommended texlive-collection-langgerman \
1926 texlive-collection-langenglish</programlisting></para>
1928 <para>kivitendo bringt drei alternative Vorlagensätze mit:</para>
1940 <para>rev-odt</para>
1944 <para>Der ehemalige Druckvorlagensatz "Standard" wurde mit der Version
1945 3.3 entfernt, da er nicht mehr gepflegt wurde.</para>
1947 <sect2 id="Vorlagenverzeichnis-anlegen"
1948 xreflabel="Vorlagenverzeichnis anlegen">
1949 <title>Vorlagenverzeichnis anlegen</title>
1951 <para>Es lässt sich ein initialer Vorlagensatz erstellen. Die
1952 LaTeX-System-Abhängigkeiten hierfür kann man prüfen mit:</para>
1954 <programlisting>./scripts/installation_check.pl -lv</programlisting>
1956 <para>Der Angemeldete Benutzer muss in einer Gruppe sein, die über das
1957 Recht "Konfiguration -> Mandantenverwaltung" verfügt. Siehe auch
1958 <xref linkend="Gruppen-anlegen"/>.</para>
1960 <para>Im Userbereich lässt sich unter: "<guimenu>System</guimenu>
1961 -> <guisubmenu>Mandantenverwaltung</guisubmenu> ->
1962 <guimenuitem>Verschiedenes</guimenuitem>" die Option "Neue
1963 Druckvorlagen aus Vorlagensatz erstellen" auswählen.</para>
1967 <para><option>Vorlagen auswählen</option>: Wählen Sie hier den
1968 Vorlagensatz aus, der kopiert werden soll
1969 (<filename>RB</filename>, <filename>f-tex</filename> oder
1970 <filename>odt-rev</filename>.)</para>
1974 <para><option>Neuer Name</option>: Der Verzeichnisname für den
1975 neuen Vorlagensatz. Dieser kann im Rahmen der üblichen Bedingungen
1976 für Verzeichnisnamen frei gewählt werden.</para>
1980 <para>Nach dem Speichern wird das Vorlagenverzeichnis angelegt und ist
1981 für den aktuellen Mandanten ausgewählt. Der gleiche Vorlagensatz kann,
1982 wenn er mal angelegt ist, bei mehreren Mandanten verwendet werden.
1983 Eventuell müssen Anpassungen (Logo, Erscheinungsbild, etc) noch
1984 vorgenommen werden. Den Ordner findet man im Dateisystem unter
1985 <filename>./templates/[Neuer Name]</filename></para>
1988 <sect2 id="Vorlagen-RB">
1989 <title>Der Druckvorlagensatz RB</title>
1991 <para>Hierbei handelt es sich um einen vollständigen LaTeX
1992 Dokumentensatz mit alternativem Design. Die odt oder html-Varianten
1993 sind nicht gepflegt.</para>
1995 <para>Die konzeptionelle Idee der Vorlagen wird <ulink
1996 url="http://www.kivitendo-support.de/vortraege/Lx-Office%20Anwendertreffen%20LaTeX-Druckvorlagen-Teil3-finale.pdf">hier</ulink>
1997 auf Folie 5 bis 10 vorgestellt. Informationen zur Anpassung an die
1998 eigenen Firmendaten finden sich in der Datei Readme.tex im
1999 Vorlagenverzeichnis.</para>
2001 <para>Eine kurze Übersicht der Features:</para>
2005 <para>Mehrsprachenfähig, mit Deutscher und Englischer
2010 <para>Zentrale Konfigurationsdateien, die für alle Belege benutzt
2011 werden, z.B. für Kopf- und Fußzeilen, und Infos wie
2016 <para>mehrere vordefinierte Varianten für
2017 Logos/Hintergrundbilder</para>
2021 <para>Berücksichtigung für Steuerzonen "EU mit USt-ID Nummer" oder
2022 "Außerhalb EU"</para>
2028 <title>f-tex</title>
2030 <para>Ein Vorlagensatz, der in wenigen Minuten alle Dokumente zur
2031 Verfügung stellt.</para>
2033 <sect3 id="f-tex-Feature-Übersicht">
2034 <title>Feature-Übersicht</title>
2038 <para>Keine Redundanz. Es wird ein- und dieselbe LaTeX-Vorlage
2039 für alle briefartigen Dokumente verwendet. Also Angebot,
2040 Rechnung, Proformarechnung, Lieferschein, aber eben nicht für
2041 Paketaufkleber etc.</para>
2045 <para>Leichte Anpassung an das Firmen-Layout durch Verwendung
2046 eines Hintergrund-PDFs. Dieses kann leicht mit dem eigenen
2047 Lieblingsprogramm erstellt werden (Openoffice, Inkscape, Gimp,
2052 <para>Hintergrund-PDF umschaltbar auf "nur erste Seite"
2053 (Standard) oder "alle Seiten" (Option
2054 "<option>bgPdfFirstPageOnly</option>" in Datei
2055 <filename>letter.lco</filename>)</para>
2059 <para>Hintergrund-PDF für Ausdruck auf bereits bedrucktem
2060 Briefpapier abschaltbar. Es wird dann nur bei per E-Mail
2061 versendeten Dokumenten eingebunden (Option
2062 "<option>bgPdfEmailOnly</option>" in Datei
2063 <filename>letter.lco</filename>).</para>
2067 <para>Nutzung der Layout-Funktionen von LaTeX für Seitenumbruch,
2068 Wiederholung von Kopfzeilen, Zwischensummen etc. (danke an
2069 Kai-Martin Knaak für die Vorarbeit)</para>
2073 <para>Anzeige des Empfängerlandes im Adressfeld nur, wenn es vom
2074 Land des eigenen Unternehmens abweicht (also die Rechnung das
2075 Land verlässt).</para>
2079 <para>Multisprachfähig leicht um weitere Sprachen zu erweitern,
2080 alle Übersetzungen in der Datei
2081 <filename>translatinos.tex</filename>.</para>
2085 <para>Auflistung von Bruttopreisen für Endverbraucher.</para>
2090 <sect3 id="f-tex-Installation">
2091 <title>Die Installation</title>
2095 <para>Vorlagenverzeichnis mit Option f-tex anlegen, siehe: <xref
2096 linkend="Vorlagenverzeichnis-anlegen"/>. Das Vorlagensystem
2097 funktioniert jetzt schon, hat allerdings noch einen
2098 Beispiel-Briefkopf.</para>
2102 <para>Erstelle eine pdf-Hintergrund Datei und verlinke sie nach
2103 <filename>./letter_head.pdf</filename>.</para>
2107 <para>Editiere den Bereich "<option>settings</option>" in der
2108 datei <filename>letter.lco</filename>.</para>
2112 <para>oder etwas detaillierter:</para>
2114 <para>Es wird eine Datei <filename>sample.lco</filename> erstellt
2115 und diese nach <filename>letter.lco</filename> verlinkt. Eigentlich
2116 ist dies die Datei die für die firmenspezifischen Anpassungen
2117 gedacht ist. Da die Einstiegshürde in LaTeX nicht ganz niedrig ist,
2118 wird in dieser Datei auf ein Hintergrund-PDF verwiesen. Ich empfehle
2119 über dieses PDF die persönlichen Layoutanpassungen vorzunehmen und
2120 <filename>sample.lco</filename> unverändert zu lassen. Die Anpassung
2121 über eine <filename>*.lco</filename>-Datei, die letztlich auf
2122 <filename>letter.lco</filename> verlinkt ist ist aber auch
2125 <para>Es wird eine Datei <filename>sample_head.pdf</filename> mit
2126 ausgeliefert, diese wird nach <filename>letter_head.pdf</filename>
2127 verlinkt. Damit gibt es schon mal eine funktionsfähige Vorlage.
2128 Schau Dir nach Abschluss der Installation die Datei
2129 <filename>sample_head.pdf</filename> an und erstelle ein
2130 entsprechendes PDF passend zum Briefkopf Deiner Firma, diese dann im
2131 Template Verzeichniss ablegen und statt
2132 <filename>sample_head.pdf</filename> nach
2133 <filename>letter_head.pdf</filename> verlinken.</para>
2135 <para>Letzlich muss <filename>letter_head.pdf</filename> auf das
2136 passende Hintergrund-PDF verweisen, welches gewünschten Briefkopf
2139 <para>Es wird eine Datei <filename>mydata.tex.example</filename>
2140 ausgeliefert, die nach <filename>mytdata.tex</filename> verlinkt
2141 ist. Bei verwendetem Hintergrund-PDF wird nur der Eintrag für das
2142 Land verwendet. Die Datei muss also nicht angefasst werden. Die
2143 anderen Werte sind für das Modul 'lp' (Label Print in erp - zur Zeit
2144 nicht im öffentlichen Zweig).</para>
2146 <para>Alle Anpassungen zum Briefkopf, Fusszeilen, Firmenlogos, etc.
2147 sollten über die Hintergrund-PDF-Datei oder die
2148 <filename>*.lco</filename>-Datei erfolgen.</para>
2151 <sect3 id="f-tex-Funktionsübersicht">
2152 <title>f-tex Funktionsübersicht</title>
2154 <para>Das Konzept von kivitendo sieht vor, für jedes Dokument
2155 (Auftragsbestätigung, Lieferschein, Rechnung, etc.) eine
2156 LaTeX-Vorlage vorzuhalten, dies ist sehr wartungsunfreundlich. Auch
2157 das Einlesen einer einheitlichen Quelle für den Briefkopf bringt nur
2158 bedingte Vorteile, da hier leicht die Pflege der Artikel-Tabellen
2159 aus dem Ruder läuft. Bei dem vorliegenden Ansatz wird für alle
2160 briefartigen Dokumente mit Artikel-Tabellen eine einheitliche
2161 LaTeX-Vorlage verwendet, welche über Codeweichen die Besonderheiten
2162 der jeweiligen Dokumente berücksichtigt:</para>
2166 <para>Tabellen mit oder ohne Preis</para>
2170 <para>Sprache der Tabellenüberschriften etc.</para>
2174 <para>Anpassung der Bezugs-Zeile (z.B. Rechnungsnummer versus
2175 Angebotsnummer)</para>
2179 <para>Darstellung von Brutto oder Netto-Preisen in der
2180 Auflistung (Endverbraucher versus gewerblicher Kunde)</para>
2184 <para>Nachteil:</para>
2186 <para>LaTeX hat ohnehin eine sehr steile Lehrnkurve. Die Datei
2187 <filename>letter.tex</filename> ist sehr komplex und verstärkt damit
2188 diesen Effekt noch einmal erheblich. Wer LaTeX-Erfahrung hat, oder
2189 geübt ist Scriptsparachen nachzuvollziehen kann natürlich auch
2190 innerhalb der Tabellendarstellung gut persönliche Anpassungen
2191 vornehmen. Aber man kann sich hier bei Veränderungen sehr schnell
2192 heftig in den Fuss schiessen.</para>
2194 <para>Wer nicht so tief in die Materie einsteigen will oder leicht
2195 zu frustrieren ist, sollte sein Hintergrund-PDF auf Basis der
2196 mitglieferten Datei <filename>sample_head.pdf</filename> erstellen,
2197 und sich an der Form der dargestellten Tabellen, wie sie
2198 ausgeliefert werden, erfreuen.</para>
2200 <para>Kleiner Tipp: Nicht zu viel auf einmal wollen, lieber kleine,
2201 kontinuierliche Schritte gehen.</para>
2204 <sect3 id="f-tex-Bruttopreise">
2205 <title>Bruttopreise für Endverbraucher</title>
2207 <para>Der auszuweisende Bruttopreis wird innerhalb der
2208 LaTeX-Umgebung berechnet. Es gibt zwar ein Feld, um bei Aufträgen
2209 "alle Preise Brutto" auszuwählen, aber:</para>
2213 <para>hierfür müssen die Preise auch in Brutto in der Datenbank
2214 stehen (ja - das lässt sich über die Preisgruppen und die
2215 Zuordung einer Default-Preisgruppe handhaben)</para>
2219 <para>man darf beim Anlegen des Vorgangs nicht vergessen, dieses
2220 Häkchen zu setzen. (Das ist in der Praxis, wenn man sowohl
2221 Endverbraucher als auch Gewerbekunden beliefert, der eigentliche
2226 <para>Es gibt mit f-tex eine weitere Alternative. Die Information ob
2227 Brutto oder Nettorechnung wird mit den Zahlarten verknüpft.
2228 Zahlarten bei denen Rechnungen, Angebote, etc, in Brutto ausgegeben
2229 werden sollen, enden mit "_E" (für Endverbraucher). Falls identische
2230 Zahlarten für Gewerbekunden und Endverbraucher vorhanden sind, legt
2231 man diese einfach doppelt an (einmal mit der Namensendung "_E").
2236 <para>Die Entscheidung, ob Nettopreise ausgewiesen werden, ist
2237 nicht mehr fix mit einer Preisliste verbunden.</para>
2241 <para>Die Default-Zahlart kann im Kundendatensatz hinterlegt
2242 werden, und man muss nicht mehr daran denken, "alle Preise
2243 Netto" auszuwählen.</para>
2247 <para>Die Entscheidung, ob Netto- oder Bruttopreise ausgewiesen
2248 werden, kann direkt beim Drucken revidiert werden, ohne dass
2249 sich der Auftragswert ändert.</para>
2254 <sect3 id="f-tex-lieferadressen">
2255 <title>Lieferadressen</title>
2257 <para>In Lieferscheinen kommen <varname>shipto*</varname>-Variablen
2258 im Adressfeld zum Einsatz. Wenn die
2259 <varname>shipto*</varname>-Variable leer ist, wird die entsprechende
2260 Adressvariable eingesetzt. Wenn also die Lieferadresse in Straße,
2261 Hausnummer und Ort abweicht, müssen auch nur diese Felder in der
2262 Lieferadresse ausgefüllt werden. Für den Firmenname wird der Wert
2263 der Hauptadresse angezeigt.</para>
2267 <sect2 id="Vorlagen-rev-odt">
2268 <title>Der Druckvorlagensatz rev-odt</title>
2270 <para>Hierbei handelt es sich um einen Dokumentensatz der mit
2271 odt-Vorlagen erstellt wurde. Es gibt in dem Verzeichnis eine
2272 Readme-Datei, die eventuell aktueller als die Dokumentation hier ist.
2273 Die odt-Vorlagen in diesem Verzeichnis "rev-odt" wurden von revamp-it,
2274 Zürich erstellt und werden laufend aktualisiert. Ein paar der
2275 Formulierungen in den Druckvorlagen entsprechen dem Schweizer
2276 Sprachgebrauch, z.B. "Offerte" oder "allfällig".</para>
2278 <para>Hinweis zum Einsatz des Feldes "Land" bei den Stammdaten für
2279 KundInnen und LieferantInnen, sowie bei Lieferadressen: Die in diesem
2280 Vorlagensatz vorhandenen Vorlagen erwarten für "Land" das
2281 entsprechende Kürzel, das in Adressen vor die Postleitzahl gesetzt
2282 wird. Das Feld kann auch komplett leer bleiben. Wer dies anders
2283 handhaben möchte, muss die Vorlagen entsprechend anpassen.</para>
2285 <para>odt-Vorlagen können mit LibreOffice oder OpenOffice editiert und
2286 den eigenen Bedürfnissen angepasst werden. Wichtig beim Editieren von
2287 if-Blöcken ist, dass immer der gesamte Block überschrieben werden muss
2288 und nicht nur Teile davon, da dies sonst oft zu einer odt-Datei führt,
2289 die vom Parser nicht korrekt gelesen werden kann.</para>
2291 <para>Mahnungen können unter folgenden Einschränkungen mit den
2292 odt-Vorlagen im Vorlagensatz rev-odt erzeugt werden:</para>
2296 <para>als Druckoption steht nur 'PDF(OpenDocument/OASIS)' zur
2297 Verfügung, das heisst, die Mahnungen werden als PDF-Datei
2302 <para>für jede Rechnung muss eine eigene Mahnung erzeugt werden
2303 (auch wenn bei einzelnen KundInnen mehrere überfällige Rechnungen
2304 vorhanden sind).</para>
2308 <para>Mehrere Mahnungen für eine Kundin / einen Kunden werden zu einer
2309 PDF-Datei zusammengefasst</para>
2311 <para>Die Vorlagen zahlungserinnerung.odt sowie mahnung.odt sind für
2312 das Erstellen einer Zahlungserinnerung bzw. Mahnung selbst vorgesehen,
2313 die Vorlage mahnung_invoice.odt für das Erstellen einer Rechnung über
2314 die verrechneten Mahngebühren und Verzugszinsen.</para>
2316 <para>Zur Zeit gibt es in kivitendo noch keine Möglichkeit,
2317 odt-Vorlagen bei Briefen und Pflichtenheften einzusetzen.
2318 Entsprechende Vorlagen sind deshalb nicht vorhanden.</para>
2320 <para>Fehlermeldungen, Anregungen und Wünsche bitte senden an:
2321 empfang@revamp-it.ch</para>
2324 <sect2 id="allgemeine-hinweise-zu-latex">
2325 <title>Allgemeine Hinweise zu LaTeX Vorlagen</title>
2327 <para>In den allermeisten Installationen sollte das Drucken jetzt
2328 schon funktionieren. Sollte ein Fehler auftreten, wirft TeX sehr lange
2329 Fehlerbeschreibungen, der eigentliche Fehler ist immer die erste
2330 Zeile, die mit einem Ausrufezeichen anfängt. Häufig auftretende Fehler
2331 sind zum Beispiel:</para>
2335 <para>! LaTeX Error: File `eurosym.sty' not found. Die
2336 entsprechende LaTeX-Bibliothek wurde nicht gefunden. Das tritt vor
2337 allem bei Vorlagen aus der Community auf. Installieren Sie die
2338 entsprechenden Pakete.</para>
2342 <para>! Package inputenc Error: Unicode char \u8:... set up for
2343 use with LaTeX. Dieser Fehler tritt auf, wenn sie versuchen mit
2344 einer Standardinstallation exotische utf8 Zeichen zu drucken.
2345 TeXLive unterstützt von Haus nur romanische Schriften und muss mit
2346 diversen Tricks dazu gebracht werden andere Zeichen zu
2347 akzeptieren. Adere TeX Systeme wie XeTeX schaffen hier
2352 <para>Wird gar kein Fehler angezeigt, sondern nur der Name des
2353 Templates, heißt das normalerweise, dass das LaTeX Binary nicht
2354 gefunden wurde. Prüfen Sie den Namen in der Konfiguration (Standard:
2355 <literal>pdflatex</literal>), und stellen Sie sicher, dass pdflatex
2356 (oder das von Ihnen verwendete System) vom Webserver ausgeführt werden
2359 <para>Wenn sich das Problem nicht auf Grund der Ausgabe im Webbrowser
2360 verifizieren lässt:</para>
2364 <para>editiere [kivitendo-home]/config/kivitendo.conf und ändere
2365 "keep_temp_files" auf 1</para>
2367 <para><programlisting>keep_temp_files = 1;</programlisting></para>
2371 <para>bei fastcgi oder mod_perl den Webserver neu Starten</para>
2375 <para>Nochmal einen Druckversuch im Webfrontend auslösen</para>
2379 <para>wechsel in das users Verzeichnis von kivitendo</para>
2381 <para><programlisting>cd [kivitendo-home]/users</programlisting></para>
2385 <para>LaTeX Suchpfad anpassen:</para>
2387 <para><programlisting>export TEXINPUTS=".:[kivitendo-home]/templates/[aktuelles_template_verzeichniss]:"</programlisting></para>
2391 <para>Finde heraus, welche Datei kivitendo beim letzten Durchlauf
2394 <para><programlisting>ls -lahtr ./1*.tex</programlisting></para>
2396 <para>Es sollte die letzte Datei ganz unten sein</para>
2400 <para>für besseren Hinweis auf Fehler texdatei nochmals
2403 <para><programlisting>pdflatex ./1*.tex</programlisting></para>
2405 <para>in der *.tex datei nach dem Fehler suchen.</para>
2411 <sect1 id="OpenDocument-Vorlagen">
2412 <title>OpenDocument-Vorlagen</title>
2414 <para>kivitendo unterstützt die Verwendung von Vorlagen im
2415 OpenDocument-Format, wie es LibreOffice oder OpenOffice (ab Version 2)
2416 erzeugen. kivitendo kann dabei sowohl neue OpenDocument-Dokumente als
2417 auch aus diesen direkt PDF-Dateien erzeugen. Um die Unterstützung von
2418 OpenDocument-Vorlagen zu aktivieren muss in der Datei
2419 <filename>config/kivitendo.conf</filename> die Variable
2420 <literal>opendocument</literal> im Abschnitt
2421 <literal>print_templates</literal> auf ‘<literal>1</literal>’ stehen.
2422 Dieses ist die Standardeinstellung.</para>
2424 <para>Während die Erzeugung von reinen OpenDocument-Dateien keinerlei
2425 weitere Software benötigt, wird zur Umwandlung dieser Dateien in PDF
2426 LibreOffice oder OpenOffice benötigt. Soll dieses Feature genutzt
2427 werden, so muss neben LibreOffice oder OpenOffice auch der “X virtual
2428 frame buffer” (xvfb) installiert werden. Bei Debian ist er im Paket
2429 “xvfb” enthalten. Andere Distributionen enthalten ihn in anderen
2432 <para>Nach der Installation müssen in der Datei
2433 <filename>config/kivitendo.conf</filename> im Abschnitt
2434 <literal>applications</literal> zwei weitere Variablen angepasst
2437 <para><literal>openofficeorg_writer</literal> muss den vollständigen
2438 Pfad zu LibreOffice oder OpenOffice enthalten. Dabei dürfen keine
2439 Anführungszeichen eingesetzt werden.</para>
2441 <para>Beispiel für Debian oder Ubuntu:</para>
2443 <programlisting>openofficeorg_writer = /usr/bin/libreoffice</programlisting>
2445 <para><literal>xvfb</literal> muss den Pfad zum “X virtual frame buffer”
2448 <para>Zusätzlich gibt es zwei verschiedene Arten, wie kivitendo mit
2449 LibreOffice bzw. OpenOffice kommuniziert. Die erste Variante, die
2450 benutzt wird, wenn die Variable <literal>$openofficeorg_daemon</literal>
2451 gesetzt ist, startet ein LibreOffice oder OpenOffice, das auch nach der
2452 Umwandlung des Dokumentes gestartet bleibt. Bei weiteren Umwandlungen
2453 wird dann diese laufende Instanz benutzt. Der Vorteil ist, dass die Zeit
2454 zur Umwandlung deutlich reduziert wird, weil nicht für jedes Dokument
2455 ein LibreOffice bzw. OpenOffice gestartet werden muss. Der Nachteil ist,
2456 dass diese Methode Python und die Python-UNO-Bindings benötigt, die
2457 Bestandteil von LibreOffice bzw. OpenOffice sind.</para>
2460 <para>Für die Verbindung zu LibreOffice bzw. OpenOffice wird
2461 normalerweise der Python-Interpreter
2462 <filename>/usr/bin/python</filename> benutzt. Sollte dies nicht der
2463 richtige sein, so kann man mit zwei Konfigurationsvariablen
2464 entscheiden, welcher Python-Interpreter genutzt wird. Mit der Option
2465 <literal>python_uno</literal> aus dem Abschnitt
2466 <literal>applications</literal> wird der Interpreter selber
2467 festgelegt; sie steht standardmäßig auf dem eben erwähnten Wert
2468 <literal>/usr/bin/python</literal>.</para>
2470 <para>Zusätzlich ist es möglich, Pfade anzugeben, in denen Python
2471 neben seinen normalen Suchpfaden ebenfalls nach Modulen gesucht wird,
2472 z.B. falls sich diese in einem gesonderten LibreOffice- bzw.
2473 OpenOffice-Verzeichnis befinden. Diese zweite Variable heißt
2474 <literal>python_uno_path</literal> und befindet sich im Abschnitt
2475 <literal>environment</literal>. Sie ist standardmäßig leer. Werden
2476 hier mehrere Pfade angegeben, so müssen diese durch Doppelpunkte
2477 voneinander getrennt werden. Der Inhalt wird an den Python-Interpreter
2478 über die Umgebungsvariable <literal>PYTHONPATH</literal>
2482 <para>Ist <literal>$openofficeorg_daemon</literal> nicht gesetzt, so
2483 wird für jedes Dokument LibreOffice bzw. OpenOffice neu gestartet und
2484 die Konvertierung mit Hilfe eines Makros durchgeführt. Dieses Makro muss
2485 in der Dokumentenvorlage enthalten sein und
2486 “Standard.Conversion.ConvertSelfToPDF()” heißen. Die Beispielvorlage
2487 ‘<literal>templates/print/rev-odt/invoice.odt</literal>’ enthält ein
2488 solches Makro, das in jeder anderen Dokumentenvorlage ebenfalls
2489 enthalten sein muss.</para>
2491 <para>Als letztes muss herausgefunden werden, welchen Namen OpenOffice
2492 bzw. LibreOffice dem Verzeichnis mit den Benutzereinstellungen gibt.
2493 Unter Debian ist dies momentan <literal>~/.config/libreoffice</literal>.
2494 kivitendo verwendet das Verzeichnis
2495 <literal>users/.openoffice.org2</literal>. Eventuell muss dieses
2496 Verzeichnis umbenannt werden.</para>
2498 <para>Dieses Verzeichnis, wie auch das komplette
2499 <literal>users</literal>-Verzeichnis, muss vom Webserver beschreibbar
2500 sein. Dieses wurde bereits erledigt (siehe <xref
2501 linkend="Manuelle-Installation-des-Programmpaketes"/>), kann aber erneut
2502 überprüft werden, wenn die Konvertierung nach PDF fehlschlägt.</para>
2505 <title>OpenDocument (odt) Druckvorlagen mit Makros</title>
2507 <para>OpenDocument Vorlagen können Makros enthalten, welche komplexere
2508 Aufgaben erfüllen.</para>
2510 <para>Der Vorlagensatz "rev-odt" enthält solche Vorlagen mit <emphasis
2511 role="bold">Schweizer Bank-Einzahlungsscheinen (BESR)</emphasis>.
2512 Diese Makros haben die Aufgabe, die in den Einzahlungsscheinen
2513 benötigte Referenznummer und Kodierzeile zu erzeugen. Hier eine kurze
2514 Beschreibung, wie die Makros aufgebaut sind, und was bei ihrer Nutzung
2515 zu beachten ist (<emphasis role="bold">in fett sind nötige einmalige
2516 Anpassungen aufgeführt</emphasis>):</para>
2519 <title>Bezeichnung der Vorlagen</title>
2521 <para>Rechnung: invoice_besr.odt, Auftrag:
2522 sales_order_besr.odt</para>
2526 <title>Vorbereitungen im Adminbereich</title>
2528 <para>Damit beim Erstellen von Rechnungen und Aufträgen neben der
2529 Standardvorlage ohne Einzahlungsschein weitere Vorlagen (z.B. mit
2530 Einzahlungsschein) auswählbar sind, muss für jedes Vorlagen-Suffix
2531 ein Drucker eingerichtet werden:</para>
2535 <para>Druckeradministration → Drucker hinzufügen</para>
2539 <para>Mandant wählen</para>
2543 <para>Druckerbeschreibung → aussagekräftiger Text: wird in der
2544 Auftrags- bzw. Rechnungsmaske als Auswahl angezeigt (z.B. mit
2545 Einzahlungsschein Bank xy)</para>
2549 <para>Druckbefehl → beliebiger Text (hat für das Erzeugen von
2550 Aufträgen oder Rechnungen als odt-Datei keine Bedeutung, darf
2551 aber nicht leer sein)</para>
2555 <para>Vorlagenkürzel → besr bzw. selbst gewähltes Vorlagensuffix
2556 (muss genau der Zeichenfolge entsprechen, die zwischen
2557 "invoice_" bzw. "sales_order_" und ".odt" steht.)</para>
2561 <para>speichern</para>
2567 <title>Benutzereinstellungen</title>
2569 <para>Wer den Ausdruck mit Einzahlungsschein als Standardeinstellung
2570 im Rechnungs- bzw. Auftragsformular angezeigt haben möchte, kann
2571 dies persönlich für sich bei den Benutzereinstellungen
2572 konfigurieren:</para>
2576 <para>Programm → Benutzereinstellungen → Druckoptionen</para>
2580 <para>Standardvorlagenformat → OpenDocument/OASIS</para>
2584 <para>Standardausgabekanal → Bildschirm</para>
2588 <para>Standarddrucker → gewünschte Druckerbeschreibung auswählen
2589 (z.B. mit Einzahlungsschein Bank xy)</para>
2593 <para>Anzahl Kopien → leer</para>
2597 <para>speichern</para>
2603 <title>Aufbau und nötige Anpassungen der Vorlagen</title>
2605 <para>In der Vorlage sind als Modul "BESR" 4 Makros gespeichert, die
2606 aus dem von kivitendo erzeugten odt-Dokument die korrekte
2607 Referenznummer inklusive Prüfziffer sowie die Kodierzeile in
2608 OCRB-Schrift erzeugen und am richtigen Ort ins Dokument
2613 <para>Für den Einzahlungsschein ist die letzte Seite des
2614 Dokuments reserviert</para>
2618 <para>Direkt über dem Einzahlungsschein enthält die Vorlage eine
2619 Zeile mit folgenden Angaben (<emphasis
2620 role="bold">Bank-Konto-Identifikationsnummer und
2621 Postkonto-Nummer der Bank müssen gemäss Angaben der jeweiligen
2622 Bank angepasst werden</emphasis>):<itemizedlist>
2624 <para>DDDREF: 4 Werte zum Bilden der Referenznummer
2625 (jeweils durch einen Leerschlag getrennt): <itemizedlist>
2627 <para>erster Wert: <emphasis
2628 role="bold">Bank-Konto-Identifikation</emphasis>
2629 (nur Ziffern, maximal 6), <emphasis role="bold">muss
2630 angepasst werden</emphasis>.</para>
2634 <para>zweiter Wert: <%customernumber%>
2635 (Kundennummer: nur Ziffern, maximal 6)</para>
2639 <para>dritter Wert: <%ordnumber%>
2640 (Auftragsnummer bei Auftragsvorlage
2641 sales_oder_besr.odt, sonst 0) maximal 7 Ziffern,
2642 führende Buchstaben werden vom Makro entfernt</para>
2646 <para>vierter Wert: <%invnumber%>
2647 (Rechnungsnummer bei Rechnungsvorlage
2648 invoice_besr.odt, sonst 0) maximal 7 Ziffern,
2649 führende Buchstaben werden vom Makro entfernt</para>
2651 </itemizedlist></para>
2655 <para>DDDKONTO: <emphasis role="bold">Postkonto-Nummer der
2656 Bank, muss angepasst werden</emphasis>.</para>
2660 <para>DDDBETRAG: <%total%> Einzahlungsbetrag oder 0,
2661 falls Einzahlungsschein ohne Betrag</para>
2665 <para>DDDEND: muss am Ende der Zeile vorhanden sein</para>
2667 </itemizedlist></para>
2671 <para><emphasis role="bold">Im Einzahlungsschein selbst müssen
2672 der Name und die Adresse der Bank, die Postkonto-Nummer der
2673 Bank, sowie der eigene Firmenname und die Firmenadresse
2674 angepasst werden.</emphasis> Dabei ist darauf zu achten, dass
2675 sich die Positionen der Postkonto-Nummern der Bank, sowie der
2676 Zeichenfolgen dddfr, DDDREF1, DDDREF2, 609, DDDKODIERZEILE nicht
2682 <screeninfo>Rechnungsvorlage Schweizer Bank-Einzahlungsschein - zu
2683 ändernde Einträge in rot</screeninfo>
2687 <imagedata fileref="images/Einzahlungsschein_Makro.png"/>
2694 <title>Auswahl der Druckvorlage in kivitendo beim Erzeugen einer
2695 odt-Rechnung (analog bei Auftrag)</title>
2697 <para>Im Fussbereich der Rechnungsmaske muss neben Rechnung,
2698 OpenDocument/OASIS und Bildschirm die im Adminbereich erstellte
2699 Druckerbeschreibung ausgewählt werden, falls diese nicht bereits bei
2700 den Benutzereinstellungen als persönlicher Standard gewählt
2705 <title>Makroeinstellungen in LibreOffice anpassen</title>
2707 <para>Falls beim Öffnen einer von kivitendo erzeugten odt-Rechnung
2708 die Meldung kommt, dass Makros aus Sicherheitsgründen nicht
2709 ausgeführt werden, so müssen folgende Einstellungen in LibreOffice
2710 angepasst werden:</para>
2714 <para>Extras → Optionen → Sicherheit → Makrosicherheit</para>
2718 <para>Sicherheitslevel auf "Mittel" einstellen (Diese
2719 Einstellung muss auf jedem Computer durchgeführt werden, mit dem
2720 von kivitendo erzeugte odt-Rechnungen oder Aufträge geöffnet
2725 <para>Beim Öffnen einer odt-Rechnung oder eines odt-Auftrags bei
2726 der entsprechenden Nachfrage "Makros ausführen"
2729 <para><emphasis role="bold">Wichtig</emphasis>: die Makros sind
2730 so eingestellt, dass sie beim Öffnen der Vorlagen selbst nicht
2731 ausgeführt werden. Das heisst für das Ansehen und Bearbeiten der
2732 Vorlagen sind keine speziellen Einstellungen in LibreOffice
2740 <sect1 id="nomenclature">
2741 <title>Nomenklatur</title>
2743 <sect2 id="booking.dates">
2744 <title>Datum bei Buchungen</title>
2746 <para>Seit der Version 3.5 werden für Buchungen in kivitendo
2747 einheitlich folgende Bezeichnungen verwendet:</para>
2751 <para><option>Erfassungsdatum</option> (en: <option>Entry
2752 Date</option>, code: <option>Gldate</option>)</para>
2754 <para>bezeichnet das Datum, an dem die Buchung in kivitendo
2755 erfasst wurde.</para>
2759 <para><option>Buchungsdatum</option> (en: <option>Booking
2760 Date</option>, code: <option>Transdate</option>)</para>
2762 <para>bezeichnet das buchhaltungstechnisch für eine Buchung
2763 relevante Datum</para>
2765 <para>Das <option>Rechnungsdatum</option> bei Verkaufs- und
2766 Einkaufsrechnungen entspricht dem Buchungsdatum. Das heisst, in
2767 Berichten wie dem Buchungsjournal, in denen eine Spalte
2768 <option>Buchungsdatum</option> angezeigt werden kann, erscheint
2769 hier im Fall von Rechnungen das Rechnungsdatum.</para>
2773 <para>Bezieht sich ein verbuchter Beleg auf einen Zeitpunkt, der
2774 nicht mit dem Buchungsdatum übereinstimmt, so kann dieses Datum
2775 momentan in kivitendo nur unter Bemerkungen erfasst werden.</para>
2777 <para>Möglicherweise wird für solche Fälle in einer späteren
2778 Version von kivitendo ein dritter Datumswert für Buchungen
2779 erstellt. (Beispiel: Einkaufsbeleg stammt aus einem früheren Jahr,
2780 das bereits buchhaltungstechnisch abgeschlossen wurde, und muss
2781 deshalb später verbucht werden.)</para>
2787 <sect1 id="config.eur">
2788 <title>Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung:
2791 <sect2 id="config.eur.introduction"
2792 xreflabel="Einführung in die Konfiguration zur EUR">
2793 <title>Einführung</title>
2795 <para>kivitendo besaß bis inklusive Version 2.6.3 einen
2796 Konfigurationsparameter namens <varname>eur</varname>, der sich in der
2797 Konfigurationsdatei <filename>config/kivitendo.conf</filename> (damals
2798 noch <filename>config/lx_office.conf</filename>) befand. Somit galt er
2799 für alle Mandanten, die in dieser Installation benutzt wurden.</para>
2801 <para>Mit der nachfolgenden Version wurde der Parameter zum Einen in
2802 die Mandantendatenbank verschoben und dabei auch gleich in drei
2803 Einzelparameter aufgeteilt, mit denen sich das Verhalten genauer
2804 steuern lässt.</para>
2807 <sect2 id="config.eur.parameters"
2808 xreflabel="Konfigurationsparameter für EUR">
2809 <title>Konfigurationsparameter</title>
2811 <para>Es gibt drei Parameter, die die Gewinnermittlungsart,
2812 Versteuerungsart und die Warenbuchungsmethode regeln:</para>
2816 <term><varname>profit_determination</varname></term>
2819 <para>Dieser Parameter legt die Berechnungsmethode für die
2820 Gewinnermittlung fest. Er enthält entweder
2821 <literal>balance</literal> für
2822 Betriebsvermögensvergleich/Bilanzierung oder
2823 <literal>income</literal> für die
2824 Einnahmen-Überschuss-Rechnung.</para>
2829 <term><varname>accounting_method</varname></term>
2832 <para>Dieser Parameter steuert die Buchungs- und
2833 Berechnungsmethoden für die Versteuerungsart. Er enthält
2834 entweder <literal>accrual</literal> für die Soll-Versteuerung
2835 oder <literal>cash</literal> für die Ist-Versteuerung.</para>
2840 <term><varname>inventory_system</varname></term>
2843 <para>Dieser Parameter legt die Warenbuchungsmethode fest. Er
2844 enthält entweder <literal>perpetual</literal> für die
2845 Bestandsmethode oder <literal>periodic</literal> für die
2846 Aufwandsmethode.</para>
2851 <para>Zum Vergleich der Funktionalität bis und nach 2.6.3:
2852 <varname>eur</varname> = 1 bedeutete Einnahmen-Überschuss-Rechnung,
2853 Ist-Versteuerung und Aufwandsmethode. <varname>eur</varname> = 0
2854 bedeutete hingegen Bilanzierung, Soll-Versteuerung und
2855 Bestandsmethode.</para>
2857 <para>Die Konfiguration "<varname>eur</varname>" unter
2858 <varname>[system]</varname> in der <link
2859 linkend="config.config-file">Konfigurationsdatei</link>
2860 <filename>config/kivitendo.conf</filename> wird nun nicht mehr
2861 benötigt und kann entfernt werden. Dies muss manuell geschehen.</para>
2864 <sect2 id="config.eur.setting-parameters">
2865 <title>Festlegen der Parameter</title>
2867 <para>Beim Anlegen eines neuen Mandanten bzw. einer neuen Datenbank in
2868 der Admininstration können diese Optionen nun unabhängig voneinander
2869 eingestellt werden.</para>
2871 <para>Für die Schweiz sind folgende Einstellungen üblich:
2874 <para>Sollversteuerung</para>
2878 <para>Aufwandsmethode</para>
2882 <para>Bilanzierung</para>
2884 </itemizedlist> Diese Einstellungen werden automatisch beim
2885 Erstellen einer neuen Datenbank vorausgewählt, wenn in
2886 <filename>config/kivitendo.conf</filename> unter
2887 <varname>[system]</varname> <literal>default_manager = swiss</literal>
2888 eingestellt ist.</para>
2890 <para>Beim Upgrade bestehender Mandanten wird eur ausgelesen und die
2891 Variablen werden so gesetzt, daß sich an der Funktionalität nichts
2894 <para>Die aktuelle Konfiguration wird unter Nummernkreise und
2895 Standardkonten unter dem neuen Punkt "Einstellungen" (read-only)
2896 angezeigt. Unter <guimenu>System</guimenu> →
2897 <guisubmenu>Mandantenkonfiguration</guisubmenu> können die
2898 Einstellungen auch geändert werden. Dabei ist zu beachten, dass eine
2899 Änderung vorhandene Daten so belässt und damit evtl. die Ergebnisse
2900 verfälscht. Dies gilt vor Allem für die Warenbuchungsmethode (siehe
2901 auch <link linkend="config.eur.inventory-system-perpetual">
2902 Bemerkungen zur Bestandsmethode</link>).</para>
2905 <sect2 id="config.eur.inventory-system-perpetual">
2906 <title>Bemerkungen zur Bestandsmethode</title>
2908 <para>Die Bestandsmethode ist eigentlich eine sehr elegante Methode,
2909 funktioniert in kivitendo aber nur unter bestimmten Bedingungen:
2910 Voraussetzung ist, daß auch immer alle Einkaufsrechnungen gepflegt
2911 werden, und man beim Jahreswechsel nicht mit einer leeren Datenbank
2912 anfängt, da bei jedem Verkauf anhand der gesamten Rechnungshistorie
2913 der Einkaufswert der Ware nach dem FIFO-Prinzip aus den
2914 Einkaufsrechnungen berechnet wird.</para>
2916 <para>Die Bestandsmethode kann vom Prinzip her also nur funktioneren,
2917 wenn man mit den Buchungen bei Null anfängt, und man kann auch nicht
2918 im laufenden Betrieb von der Aufwandsmethode zur Bestandsmethode
2922 <sect2 id="config.eur.knonw-issues">
2923 <title>Bekannte Probleme</title>
2925 <para>Bei bestimmten Berichten kann man derzeit noch inviduell
2926 einstellen, ob man nach Ist- oder Sollversteuerung auswertet, und es
2927 werden im Code Variablen wie $accrual oder $cash gesetzt. Diese
2928 Codestellen wurden noch nicht angepasst, sondern nur die, wo bisher
2929 die Konfigurationsvariable
2930 <varname>$::lx_office_conf{system}->{eur}</varname> ausgewertet
2933 <para>Es fehlen Hilfetext beim Neuanlegen eines Mandanten, was die
2934 Optionen bewirken, z.B. mit zwei Standardfällen.</para>
2938 <sect1 id="config.skr04-update-3804">
2939 <title>SKR04 19% Umstellung für innergemeinschaftlichen Erwerb</title>
2941 <sect2 id="config.skr04-update-3804.introduction">
2942 <title>Einführung</title>
2944 <para>Die Umsatzsteuerumstellung auf 19% für SKR04 für die
2945 Steuerschlüssel "EU ohne USt-ID Nummer" ist erst 2010 erfolgt.
2946 kivitendo beinhaltet ein Upgradeskript, das das Konto 3804 automatisch
2947 erstellt und die Steuereinstellungen korrekt einstellt. Hat der
2948 Benutzer aber schon selber das Konto 3804 angelegt, oder gab es schon
2949 Buchungen im Zeitraum nach dem 01.01.2007 auf das Konto 3803, wird das
2950 Upgradeskript vorsichtshalber nicht ausgeführt, da der Benutzer sich
2951 vielleicht schon selbst geholfen hat und mit seinen Änderungen
2952 zufrieden ist. Die korrekten Einstellungen kann man aber auch per Hand
2953 ausführen. Nachfolgend werden die entsprechenden Schritte anhand von
2954 Screenshots dargestellt.</para>
2956 <para>Für den Fall, daß Buchungen mit der Steuerschlüssel "EU ohne
2957 USt.-IdNr." nach dem 01.01.2007 erfolgt sind, ist davon auszugehen,
2958 dass diese mit dem alten Umsatzsteuersatz von 16% gebucht worden sind,
2959 und diese Buchungen sollten entsprechend kontrolliert werden.</para>
2962 <sect2 id="config.skr04-update-3804.create-chart">
2963 <title>Konto 3804 manuell anlegen</title>
2965 <para>Die folgenden Schritte sind notwendig, um das Konto manuell
2966 anzulegen und zu konfigurieren. Zuerst wird in
2967 <guimenu>System</guimenu> → <guisubmenu>Kontenübersicht</guisubmenu> →
2968 <guimenuitem>Konto erfassen</guimenuitem> das Konto angelegt.</para>
2971 <screeninfo>Konto 3804 erfassen</screeninfo>
2975 <imagedata fileref="images/skr04-update-3804/konto3804.png"/>
2980 <para>Als Zweites muss Steuergruppe 13 für Konto 3803 angepasst
2981 werden. Dazu unter <guimenu>System</guimenu> →
2982 <guisubmenu>Steuern</guisubmenu> →
2983 <guimenuitem>Bearbeiten</guimenuitem> den Eintrag mit Steuerschlüssel
2984 13 auswählen und ihn wie im folgenden Screenshot angezeigt
2988 <screeninfo>Steuerschlüssel 13 für 3803 (16%) anpassen</screeninfo>
2992 <imagedata fileref="images/skr04-update-3804/steuer3803.png"/>
2997 <para>Als Drittes wird ein neuer Eintrag mit Steuerschlüssel 13 für
2998 Konto 3804 (19%) angelegt. Dazu unter <guimenu>System</guimenu> →
2999 <guisubmenu>Steuern</guisubmenu> → <guimenuitem>Erfassen</guimenuitem>
3000 auswählen und die Werte aus dem Screenshot übernehmen.</para>
3003 <screeninfo>Steuerschlüssel 13 für 3804 (19%) anlegen</screeninfo>
3007 <imagedata fileref="images/skr04-update-3804/steuer3804.png"/>
3012 <para>Als Nächstes sind alle Konten anzupassen, die als
3013 Steuerautomatikkonto die 3803 haben, sodass sie ab dem 1.1.2007 auch
3014 Steuerautomatik auf 3804 bekommen. Dies betrifft in der
3015 Standardkonfiguration die Konten 4315 und 4726. Als Beispiel für 4315
3016 müssen Sie dazu unter <guimenu>System</guimenu> →
3017 <guisubmenu>Kontenübersicht</guisubmenu> → <guimenuitem>Konten
3018 anzeigen</guimenuitem> das Konto 4315 anklicken und die Einstellungen
3019 wie im Screenshot gezeigt vornehmen.</para>
3022 <screeninfo>Konto 4315 anpassen</screeninfo>
3026 <imagedata fileref="images/skr04-update-3804/konto4315.png"/>
3031 <para>Als Letztes sollte die Steuerliste unter
3032 <guimenu>System</guimenu> → <guisubmenu>Steuern</guisubmenu> →
3033 <guimenuitem>Bearbeiten</guimenuitem> kontrolliert werden. Zum
3034 Vergleich der Screenshot.</para>
3037 <screeninfo>Steuerliste vergleichen</screeninfo>
3041 <imagedata fileref="images/skr04-update-3804/steuerliste.png"/>
3048 <sect1 id="config.bilanz">
3049 <title>Verhalten des Bilanzberichts</title>
3051 <para>Bis Version 3.0 wurde "closedto" ("Bücher schließen zum") als
3052 Grundlage für das Startdatum benutzt. Schließt man die Bücher allerdings
3053 monatsweise führt dies zu falschen Werten.</para>
3055 <para>In der Mandantenkonfiguration kann man dieses Verhalten genau
3056 einstellen indem man:</para>
3060 <para>weiterhin closed_to benutzt (Default, es ändert sich nichts zu
3065 <para>immer den Jahresanfang nimmt (1.1. relativ zum
3070 <para>immer die letzte Eröffnungsbuchung als Startdatum nimmt</para>
3072 <para>- mit Jahresanfang als Alternative wenn es keine EB-Buchungen
3075 <para>- oder mit "alle Buchungen" als Alternative"</para>
3079 <para>mit Jahresanfang als Alternative wenn es keine EB-Buchungen
3084 <para>immer alle Buchungen seit Beginn der Datenbank nimmt</para>
3088 <para>Folgende Hinweise zu den Optionen: Das "Bücher schließen Datum"
3089 ist sinnvoll, wenn man nur komplette Jahre schließt. Bei Wirtschaftsjahr
3090 = Kalendarjahr entspricht dies aber auch dem Jahresanfang. "Alle
3091 Buchungen" kann z.B. sinnvoll sein wenn man ohne Jahresabschluß
3092 durchbucht. Eröffnungsbuchung mit "alle Buchungen" als Fallback ist z.B.
3093 sinnvoll, wenn man am sich Anfang des zweiten Buchungsjahres befindet,
3094 und noch keinen Jahreswechsel und auch noch keine EB-Buchungen hat. Bei
3095 den Optionen mit EB-Buchungen wird vorausgesetzt, daß diese immer am 1.
3096 Tag des Wirtschaftsjahres gebucht werden. Zur Sicherheit wird das
3097 Startdatum im Bilanzbericht jetzt zusätzlich zum Stichtag mit angezeigt.
3098 Das hilft auch bei der Kontrolle für den Abgleich mit der GuV bzw.
3099 Erfolgsrechnung.</para>
3102 <sect1 id="config.erfolgsrechnung">
3103 <title>Erfolgsrechnung</title>
3105 <para>Seit der Version 3.4.1 existiert in kivitendo der Bericht
3106 <emphasis role="bold"> Erfolgsrechnung</emphasis>.</para>
3108 <para>Die Erfolgsrechnung kann in der Mandantenkonfiguration unter
3109 Features an- oder abgeschaltet werden. Mit der Einstellung
3110 <varname>default_manager = swiss </varname> in der
3111 <filename>config/kivitendo.conf</filename> wird beim neu Erstellen einer
3112 Datenbank automatisch die Anzeige der Erfolgsrechnung im Menü
3113 <guimenu>Berichte </guimenu> ausgewählt und ersetzt dort die GUV.</para>
3115 <para>Im Gegensatz zur GUV werden bei der Erfolgsrechnung sämtliche
3116 Aufwands- und Erlöskonten einzeln aufgelistet (analog zur Bilanz),
3117 sortiert nach ERTRAG und AUFWAND.</para>
3119 <para>Bei den Konteneinstellungen muss bei jedem Konto, das in der
3120 Erfolgsrechnung erscheinen soll, unter <varname>Sonstige
3121 Einstellungen/Erfolgsrechnung</varname> entweder
3122 <literal>01.Ertrag</literal> oder <literal>06.Aufwand</literal>
3123 ausgewählt werden.</para>
3125 <para>Wird bei einem Erlöskonto <literal>06.Aufwand</literal>
3126 ausgewählt, so wird dieses Konto als Aufwandsminderung unter AUFWAND
3129 <para>Wird bei einem Aufwandskonto <literal>01.Ertrag</literal>
3130 ausgewählt, so wird dieses Konto als Ertragsminderung unter ERTRAG
3133 <para>Soll bei einer bereits bestehenden Buchhaltung in Zukunft
3134 zusätzlich die Erfolgsrechnung als Bericht verwendet werden, so müssen
3135 die Einstellungen zu allen Erlös- und Aufwandskonten unter
3136 <varname>Sonstige Einstellungen/Erfolgsrechnung</varname> überprüft und
3137 allenfalls neu gesetzt werden.</para>
3140 <sect1 id="config.rounding">
3141 <title>Rundung in Verkaufsbelegen</title>
3143 <para>In der Schweiz hat die kleinste aktuell benutzte Münze den Wert
3144 von 5 Rappen (0.05 CHF).</para>
3146 <para>Auch wenn im elektronischen Zahlungsverkehr Beträge mit einer
3147 Genauigkeit von 0.01 CHF verwendet werden können, ist es trotzdem nach
3148 wie vor üblich, Rechnungen mit auf 0.05 CHF gerundeten Beträgen
3149 auszustellen.</para>
3151 <para>In kivitendo kann seit der Version 3.4.1 die Einstellung für eine
3152 solche Rundung pro Mandant / Datenbank festgelegt werden.</para>
3154 <para>Die Einstellung wird beim Erstellen der Datenbank bei
3155 <literal>Genauigkeit</literal> festgelegt. Sie kann anschliessend über
3156 das Webinterface von kivitendo nicht mehr verändert werden.</para>
3158 <para>Abhängig vom Wert für <varname>default_manager</varname> in
3159 <filename>config/kivitendo.conf</filename> werden dabei folgende Werte
3160 voreingestellt:</para>
3164 <para>0.05 (default_manager = swiss)</para>
3168 <para>0.01 (default_manager = german)</para>
3172 <para>Der Wert wird in der Datenbank in der Tabelle <varname>defaults
3173 </varname>in der Spalte <varname>precision</varname> gespeichert.</para>
3175 <para>In allen Verkaufsangeboten, Verkaufsaufträgen, Verkaufsrechnungen
3176 und Verkaufsgutschriften wird der Endbetrag inkl. MWST gerundet, wenn
3177 dieser nicht der eingestellten Genauigkeit entspricht.</para>
3179 <para>Beim Buchen einer Verkaufsrechnung wird der Rundungsbetrag
3180 automatisch auf die in der Mandantenkonfiguration festgelegten
3181 Standardkonten für Rundungserträge bzw. Rundungsaufwendungen
3184 <para>(Die berechnete MWST wird durch den Rundungsbetrag nicht mehr
3187 <para>Die in den Druckvorlagen zur Verfügung stehenden Variablen
3188 <varname>quototal</varname>, <varname>ordtotal</varname> bzw.
3189 <varname>invtotal</varname> enthalten den gerundeten Betrag.</para>
3191 <para><emphasis role="bold">Achtung:</emphasis> Werden Verkaufsbelege in
3192 anderen Währungen als der Standardwährung erstellt, so muss in kivitendo
3193 ab Version 3.4.1 die Genauigkeit 0.01 verwendet werden.</para>
3195 <para>Das heisst, Firmen in der Schweiz, die teilweise
3196 Verkaufsrechnungen in Euro oder anderen Währungen erstellen wollen,
3197 müssen beim Erstellen der Datenbank als Genauigkeit 0.01 wählen und
3198 können zur Zeit die 5er Rundung noch nicht nutzen.</para>
3201 <sect1 id="config.client">
3202 <title>Einstellungen pro Mandant</title>
3204 <para>Einige Einstellungen können von einem Benutzer mit dem <link
3205 linkend="Zusammenhänge">Recht</link> "Administration (Für die Verwaltung
3206 der aktuellen Instanz aus einem Userlogin heraus)" gemacht werden. Diese
3207 Einstellungen sind dann für die aktuellen Mandanten-Datenbank gültig.
3208 Die Einstellungen sind unter <guimenu>System</guimenu> →
3209 <guisubmenu>Mandantenkonfiguration</guisubmenu> erreichbar.</para>
3211 <para>Bitte beachten Sie die Hinweise zu den einzelnen Einstellungen.
3212 Einige Einstellungen sollten nicht ohne Weiteres im laufenden Betrieb
3213 geändert werden (siehe auch <link
3214 linkend="config.eur.inventory-system-perpetual">Bemerkungen zu
3215 Bestandsmethode</link>).</para>
3217 <para>Die Einstellungen <literal>show_bestbefore</literal> und
3218 <literal>payments_changeable</literal> aus dem Abschnitt
3219 <literal>features</literal> und die Einstellungen im Abschnitt
3220 <literal>datev_check</literal> (sofern schon vorhanden) der <link
3221 linkend="config.config-file">kivitendo-Konfigurationsdatei</link> werden
3222 bei einem Datenbankupdate einer älteren Version automatisch übernommen.
3223 Diese Einträge können danach aus der Konfigurationsdatei entfernt
3227 <sect1 id="kivitendo-ERP-verwenden">
3228 <title>kivitendo ERP verwenden</title>
3230 <para>Nach erfolgreicher Installation ist der Loginbildschirm unter
3231 folgender URL erreichbar:</para>
3234 url="http://localhost/kivitendo-erp/login.pl">http://localhost/kivitendo-erp/login.pl</ulink></para>
3236 <para>Die Administrationsseite erreichen Sie unter:</para>
3239 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
3243 <chapter id="features" xreflabel="Features und Funktionen">
3244 <title>Features und Funktionen</title>
3246 <sect1 id="features.periodic-invoices"
3247 xreflabel="Wiederkehrende Rechnungen">
3248 <title>Wiederkehrende Rechnungen</title>
3250 <sect2 id="features.periodic-invoices.introduction"
3251 xreflabel="Einführung in wiederkehrende Rechnungen">
3252 <title>Einführung</title>
3254 <para>Wiederkehrende Rechnungen werden als normale Aufträge definiert
3255 und konfiguriert, mit allen dazugehörigen Kunden- und Artikelangaben.
3256 Die konfigurierten Aufträge werden später automatisch in Rechnungen
3257 umgewandelt, so als ob man den Workflow benutzen würde, und auch die
3258 Auftragsnummer wird übernommen, sodass alle wiederkehrenden
3259 Rechnungen, die aus einem Auftrag erstellt wurden, später leicht
3260 wiederzufinden sind.</para>
3263 <sect2 id="features.periodic-invoices.configuration"
3264 xreflabel="Konfiguration von wiederkehrenden Rechnungen">
3265 <title>Konfiguration</title>
3267 <para>Um einen Auftrag für wiederkehrende Rechnung zu konfigurieren,
3268 findet sich beim Bearbeiten des Auftrags ein neuer Knopf
3269 "Konfigurieren", der ein neues Fenster öffnet, in dem man die nötigen
3270 Parameter einstellen kann. Hinter dem Knopf wird außerdem noch
3271 angezeigt, ob der Auftrag als wiederkehrende Rechnung konfiguriert ist
3274 <para>Folgende Parameter kann man konfigurieren:</para>
3281 <para>Bei aktiven Rechnungen wird automatisch eine Rechnung
3282 erstellt, wenn die Periodizität erreicht ist (z.B. am Anfang
3283 eines neuen Monats).</para>
3285 <para>Ist ein Auftrag nicht aktiv, so werden für ihn auch keine
3286 wiederkehrenden Rechnungen erzeugt. Stellt man nach längerer
3287 nicht-aktiver Zeit einen Auftrag wieder auf aktiv, wird beim
3288 nächsten Periodenwechsel für alle Perioden, seit der letzten
3289 aktiven Periode, jeweils eine Rechnung erstellt. Möchte man dies
3290 verhindern, muss man vorher das Startdatum neu setzen.</para>
3292 <para>Für gekündigte Aufträge werden nie mehr Rechnungen
3293 erstellt. Man kann sich diese Aufträge aber gesondert in den
3294 Berichten anzeigen lassen.</para>
3299 <term>Periodizität</term>
3302 <para>Ob monatlich, quartalsweise oder jährlich auf neue
3303 Rechnungen überprüft werden soll. Für jede Periode seit dem
3304 Startdatum wird überprüft, ob für die Periode (beginnend immer
3305 mit dem ersten Tag der Periode) schon eine Rechnung erstellt
3306 wurde. Unter Umständen können bei einem Startdatum in der
3307 Vergangenheit gleich mehrere Rechnungen erstellt werden.</para>
3312 <term>Buchen auf</term>
3315 <para>Das Forderungskonto, in der Regel "Forderungen aus
3316 Lieferungen und Leistungen". Das Gegenkonto ergibt sich aus den
3317 Buchungsgruppen der betreffenden Waren.</para>
3322 <term>Startdatum</term>
3325 <para>ab welchem Datum auf Rechnungserstellung geprüft werden
3331 <term>Enddatum</term>
3334 <para>ab wann keine Rechnungen mehr erstellt werden
3340 <term>Automatische Verlängerung um x Monate</term>
3343 <para>Sollen die wiederkehrenden Rechnungen bei Erreichen des
3344 eingetragenen Enddatums weiterhin erstellt werden, so kann man
3345 hier die Anzahl der Monate eingeben, um die das Enddatum
3346 automatisch nach hinten geschoben wird.</para>
3351 <term>Drucken</term>
3354 <para>Sind Drucker konfiguriert, so kann man sich die erstellten
3355 Rechnungen auch gleich ausdrucken lassen.</para>
3360 <para>Nach Erstellung der Rechnungen kann eine E-Mail mit
3361 Informationen zu den erstellten Rechnungen verschickt werden.
3362 Konfiguriert wird dies in der <link
3363 linkend="config.config-file.sections-parameters">Konfigurationsdatei</link>
3364 <filename>config/kivitendo.conf</filename> im Abschnitt
3365 <varname>[periodic_invoices]</varname>.</para>
3368 <sect2 id="features.periodic-invoices.variables">
3369 <title>Spezielle Variablen</title>
3371 <para>Um die erzeugten Rechnungen individualisieren zu können, werden
3372 beim Umwandeln des Auftrags in eine Rechnung einige speziell
3373 formatierte Variablen durch für die jeweils aktuelle
3374 Abrechnungsperiode gültigen Werte ersetzt. Damit ist es möglich, z.B.
3375 den Abrechnungszeitraum explizit auszuweisen. Eine Variable hat dabei
3376 die Syntax <literal><%variablenname%></literal>.</para>
3378 <para>Sofern es sich um eine Datumsvariable handelt, kann das
3379 Ausgabeformat weiter bestimmt werden, indem an den Variablennamen
3380 Formatoptionen angehängt werden. Die Syntax sieht dabei wie folgt aus:
3381 <literal><%variablenname FORMAT=Formatinformation%></literal>.
3382 Die zur verfügung stehenden Formatinformationen werden unten genauer
3385 <para>Diese Variablen können auch beim automatischen Versand der
3386 erzeugten Rechnungen per E-Mail genutzt werden, indem sie in den
3387 Feldern für den Betreff oder die Nachricht verwendet werden.</para>
3389 <para>Diese Variablen werden in den folgenden Elementen des Auftrags
3394 <para>Bemerkungen</para>
3398 <para>Interne Bemerkungen</para>
3402 <para>Vorgangsbezeichnung</para>
3406 <para>In den Beschreibungs- und Langtextfeldern aller
3411 <para>Die zur Verfügung stehenden Variablen sind die Folgenden:</para>
3415 <term><varname><%current_quarter%></varname>,
3416 <varname><%previous_quarter%></varname>,
3417 <varname><%next_quarter%></varname></term>
3420 <para>Aktuelles, vorheriges und nächstes Quartal als Zahl
3421 zwischen <literal>1</literal> und <literal>4</literal>.</para>
3426 <term><varname><%current_month%></varname>,
3427 <varname><%previous_month%></varname>,
3428 <varname><%next_month%></varname></term>
3431 <para>Aktueller, vorheriger und nächster Monat als Zahl zwischen
3432 <literal>1</literal> und <literal>12</literal>.</para>
3437 <term><varname><%current_month_long%></varname>,
3438 <varname><%previous_month_long%></varname>,
3439 <varname><%next_month_long%></varname></term>
3442 <para>Aktueller, vorheriger und nächster Monat als Name
3443 (<literal>Januar</literal>, <literal>Februar</literal>
3449 <term><varname><%current_year%></varname>,
3450 <varname><%previous_year%></varname>,
3451 <varname><%next_year%></varname></term>
3454 <para>Aktuelles, vorheriges und nächstes Jahr als vierstellige
3455 Jahreszahl (<literal>2013</literal> etc.).</para>
3460 <term><varname><%period_start_date%></varname>,
3461 <varname><%period_end_date%></varname></term>
3464 <para>Formatiertes Datum des ersten und letzten Tages im
3465 Abrechnungszeitraum (z.B. bei quartalsweiser Abrechnung und im
3466 ersten Quartal von 2013 wären dies der
3467 <literal>01.01.2013</literal> und
3468 <literal>31.03.2013</literal>).</para>
3473 <para>Die invidiuellen Formatinformationen bestehen aus Paaren von
3474 Prozentzeichen und einem Buchstaben, welche beide zusammen durch den
3475 dazugehörigen Wert ersetzt werden. So wird z.B. <literal>%Y</literal>
3476 durch das viertstellige Jahr ersetzt. Alle möglichen Platzhalter
3481 <term><varname>%a</varname></term>
3484 <para>Der abgekürzte Wochentagsname.</para>
3489 <term><varname>%A</varname></term>
3492 <para>Der ausgeschriebene Wochentagsname.</para>
3497 <term><varname>%b</varname></term>
3500 <para>Der abgekürzte Monatsname.</para>
3505 <term><varname>%B</varname></term>
3508 <para>Der ausgeschriebene Monatsname.</para>
3513 <term><varname>%C</varname></term>
3516 <para>Das Jahrhundert (Jahr/100) als eine zweistellige
3522 <term><varname>%d</varname></term>
3525 <para>Der Monatstag als Zahl zwischen 01 und 31.</para>
3530 <term><varname>%D</varname></term>
3533 <para>Entspricht %m/%d/%y (amerikanisches Datumsformat).</para>
3538 <term><varname>%e</varname></term>
3541 <para>Wie %d (Monatstag als Zahl zwischen 1 und 31), allerdings
3542 werden führende Nullen durch Leerzeichen ersetzt.</para>
3547 <term><varname>%F</varname></term>
3550 <para>Entspricht %Y-%m-%d (das ISO-8601-Datumsformat).</para>
3555 <term><varname>%j</varname></term>
3558 <para>Der Tag im Jahr als Zahl zwischen 001 und 366
3564 <term><varname>%m</varname></term>
3567 <para>Der Monat als Zahl zwischen 01 und 12 inklusive.</para>
3572 <term><varname>%u</varname></term>
3575 <para>Der Wochentag als Zahl zwischen 1 und 7 inklusive, wobei
3576 die 1 dem Montag entspricht.</para>
3581 <term><varname>%U</varname></term>
3584 <para>Die Wochennummer als Zahl zwischen 00 und 53 inklusive,
3585 wobei der erste Sonntag im Jahr das Startdatum von Woche 01
3591 <term><varname>%V</varname></term>
3594 <para>Die ISO-8601:1988-Wochennummer als Zahl zwischen 01 und 53
3595 inklusive, wobei Woche 01 die erste Woche, von der mindestens
3596 vier Tage im Jahr liegen; Montag ist erster Tag der
3602 <term><varname>%w</varname></term>
3605 <para>Der Wochentag als Zahl zwischen 0 und 6 inklusive, wobei
3606 die 0 dem Sonntag entspricht.</para>
3611 <term><varname>%W</varname></term>
3614 <para>Die Wochennummer als Zahl zwischen 00 und 53 inklusive,
3615 wobei der erste Montag im Jahr das Startdatum von Woche 01
3621 <term><varname>%y</varname></term>
3624 <para>Das Jahr als zweistellige Zahl zwischen 00 und 99
3630 <term><varname>%Y</varname></term>
3633 <para>Das Jahr als vierstellige Zahl.</para>
3638 <term><varname>%%</varname></term>
3641 <para>Das Prozentzeichen selber.</para>
3646 <para>Anwendungsbeispiel für die Ausgabe, von welchem Monat und Jahr
3647 bis zu welchem Monat und Jahr die aktuelle Abrechnungsperiode dauert:
3648 <literal>Abrechnungszeitrum: <%period_start_date FORMAT=%m/%Y%>
3649 bis <%period_end_date FORMAT=%m/%Y%></literal></para>
3652 <sect2 id="features.periodic-invoices.reports">
3653 <title>Auflisten</title>
3655 <para>Unter Verkauf->Berichte->Aufträge finden sich zwei neue
3656 Checkboxen, "Wiederkehrende Rechnungen aktiv" und "Wiederkehrende
3657 Rechnungen inaktiv", mit denen man sich einen Überglick über die
3658 wiederkehrenden Rechnungen verschaffen kann.</para>
3661 <sect2 id="features.periodic-invoices.task-server">
3662 <title>Erzeugung der eigentlichen Rechnungen</title>
3664 <para>Die zeitliche und periodische Überprüfung, ob eine
3665 wiederkehrende Rechnung automatisch erstellt werden soll, geschieht
3666 durch den <link linkend="config.task-server">Taskserver</link>, einen
3667 externen Dienst, der automatisch beim Start des Servers gestartet
3668 werden sollte.</para>
3671 <sect2 id="features.periodic-invoices.create-for-current-month">
3672 <title>Erste Rechnung für aktuellen Monat erstellen</title>
3674 <para>Will man im laufenden Monat eine monatlich wiederkehrende
3675 Rechnung inkl. des laufenden Monats starten, stellt man das Startdatum
3676 auf den Monatsanfang und wartet ein paar Minuten, bis der Taskserver
3677 den neu konfigurieren Auftrag erkennt und daraus eine Rechnung
3678 generiert hat. Alternativ setzt man das Startdatum auf den
3679 Monatsersten des Folgemonats und erstellt die erste Rechnung direkt
3680 manuell über den Workflow.</para>
3684 <sect1 id="features.bank" xreflabel="bankerweiterung">
3685 <title>Bankerweiterung</title>
3687 <sect2 id="features.bank.introduction"
3688 xreflabel="Einführung in die Bankerweiterung">
3689 <title>Einführung</title>
3691 <para>Die Beschreibung der Bankerweiterung befindet sich derzeit noch
3692 im Wiki und soll von dort später hierhin übernommen werden:</para>
3695 url="http://redmine.kivitendo-premium.de/projects/forum/wiki/Bankerweiterung">http://redmine.kivitendo-premium.de/projects/forum/wiki/Bankerweiterung</ulink></para>
3699 <sect1 id="dokumentenvorlagen-und-variablen">
3700 <title>Dokumentenvorlagen und verfügbare Variablen</title>
3702 <sect2 id="dokumentenvorlagen-und-variablen.einführung">
3703 <title>Einführung</title>
3705 <para>Dies ist eine Auflistung der Standard-Dokumentenvorlagen und
3706 aller zur Bearbeitung verfügbaren Variablen. Eine Variable wird in
3707 einer Vorlage durch ihren Inhalt ersetzt, wenn sie in der Form
3708 <function><%variablenname%></function> verwendet wird. Für
3709 LaTeX- und HTML-Vorlagen kann man die Form dieser Tags auch verändern
3711 linkend="dokumentenvorlagen-und-variablen.tag-style"/>).</para>
3713 <para>kivitendo unterstützt LaTeX-, HTML- und OpenDocument-Vorlagen.
3714 Sofern es nicht ausdrücklich eingeschränkt wird, gilt das im Folgenden
3715 gesagte für alle Vorlagenarten.</para>
3717 <para>Insgesamt sind technisch gesehen eine ganze Menge mehr Variablen
3718 verfügbar als hier aufgelistet werden. Die meisten davon können
3719 allerdings innerhalb einer solchen Vorlage nicht sinnvoll verwendet
3720 werden. Wenn eine Auflistung dieser Variablen gewollt ist, so kann
3721 diese wie folgt erhalten werden:</para>
3725 <para><filename>SL/Form.pm</filename> öffnen und am Anfang die
3726 Zeile "<command>use Data::Dumper;</command>" einfügen.</para>
3730 <para>In <filename>Form.pm</filename> die Funktion
3731 <function>parse_template</function> suchen und hier die Zeile
3732 <command>print(STDERR Dumper($self));</command> einfügen.</para>
3736 <para>Einmal per Browser die gewünschte Vorlage "benutzen", z.B.
3737 ein PDF für eine Rechnung erzeugen.</para>
3741 <para>Im <filename>error.log</filename> Apache steht die Ausgabe
3742 der Variablen <varname>$self</varname> in der Form <varname>'key'
3743 => 'value',</varname>. Alle <varname>key</varname>s sind
3749 <sect2 id="dokumentenvorlagen-und-variablen.variablen-ausgeben">
3750 <title>Variablen ausgeben</title>
3752 <para>Um eine Variable auszugeben, müssen sie einfach nur zwischen die
3753 Tags geschrieben werden, also z.B.
3754 <varname><%variablenname%></varname>.</para>
3756 <para>Optional kann man auch mit Leerzeichen getrennte Flags angeben,
3757 die man aber nur selten brauchen wird. Die Syntax sieht also so aus:
3758 <varname><%variablenname FLAG1 FLAG2%></varname>. Momentan
3759 werden die folgenden Flags unterstützt:</para>
3763 <para><option>NOFORMAT</option> gilt nur für Zahlenwerte und gibt
3764 den Wert ohne Formatierung, also ohne Tausendertrennzeichen mit
3765 mit einem Punkt als Dezimaltrennzeichen aus. Nützlich z.B., wenn
3766 damit in der Vorlage z.B. von LaTeX gerechnet werden soll.</para>
3770 <para><option>NOESCAPE</option> unterdrückt das Escapen von
3771 Sonderzeichen für die Vorlagensprache. Wenn also in einer
3772 Variablen bereits gültiger LaTeX-Code steht und dieser von LaTeX
3773 auch ausgewertet und nicht wortwörtlich angezeigt werden soll, so
3774 ist dieses Flag sinnvoll.</para>
3778 <para>Beispiel:</para>
3780 <programlisting><%quototal NOFORMAT%></programlisting>
3783 <sect2 id="dokumentenvorlagen-und-variablen.verwendung-in-druckbefehlen">
3784 <title>Verwendung in Druckbefehlen</title>
3786 <para>In der Admininstration können Drucker definiert werden. Auch im
3787 dort eingebbaren Druckbefehl können die hier aufgelisteten Variablen
3788 und Kontrollstrukturen verwendet werden. Ihr Inhalt wird dabei nach
3789 den Regeln der gängigen Shells formatiert, sodass Sonderzeichen wie
3790 <function>`...`</function> nicht zu unerwünschtem Verhalten
3793 <para>Dies erlaubt z.B. die Definition eines Faxes als Druckerbefehl,
3794 für das die Telefonnummer eines Ansprechpartners als Teil der
3795 Kommandozeile verwendet wird. Für ein fiktives Kommando könnte das
3796 z.B. wie folgt aussehen:</para>
3798 <programlisting>send_fax --number <%if cp_phone2%><%cp_phone2%><%else%><%cp_phone1%><%end%></programlisting>
3801 <sect2 id="dokumentenvorlagen-und-variablen.tag-style"
3802 xreflabel="Anfang und Ende der Tags verändern">
3803 <title>Anfang und Ende der Tags verändern</title>
3805 <para>Der Standardstil für Tags sieht vor, dass ein Tag mit dem
3806 Kleinerzeichen und einem Prozentzeichen beginnt und mit dem
3807 Prozentzeichen und dem Größerzeichen endet, beispielsweise
3808 <function><%customer%></function>. Da diese Form aber z.B. in
3809 LaTeX zu Problemen führen kann, weil das Prozentzeichen dort
3810 Kommentare einleitet, kann pro HTML- oder LaTeX-Dokumentenvorlage der
3811 Stil umgestellt werden.</para>
3813 <para>Dazu werden in die Datei Zeilen geschrieben, die mit dem für das
3814 Format gültigen Kommentarzeichen anfangen, dann
3815 <function>config:</function> enthalten, die entsprechende Option
3816 setzen und bei HTML-Dokumentenvorlagen mit dem Kommentarendzeichen
3817 enden. Beispiel für LaTeX:</para>
3819 <programlisting>% config: tag-style=($ $)</programlisting>
3821 <para>Dies würde kivitendo dazu veranlassen, Variablen zu ersetzen,
3822 wenn sie wie folgt aussehen: <function>($customer$)</function>. Das
3823 äquivalente Beispiel für HTML-Dokumentenvorlagen sieht so aus:</para>
3825 <programlisting><!-- config: tag-style=($ $) --></programlisting>
3828 <sect2 id="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">
3829 <title>Zuordnung von den Dateinamen zu den Funktionen</title>
3831 <para>Diese folgende kurze Auflistung zeigt, welche Vorlage bei
3832 welcher Funktion ausgelesen wird. Dabei ist die Dateiendung
3833 "<filename>.ext</filename>" geeignet zu ersetzen:
3834 "<filename>.tex</filename>" für LaTeX-Vorlagen und
3835 "<filename>.odt</filename>" für OpenDocument-Vorlagen.</para>
3839 <term><filename>bin_list.ext</filename></term>
3842 <para>Lagerliste</para>
3847 <term><filename>check.ext</filename></term>
3855 <term><filename>invoice.ext</filename></term>
3858 <para>Rechnung</para>
3863 <term><filename>packing_list.ext</filename></term>
3866 <para>Packliste</para>
3871 <term><filename>pick_list.ext</filename></term>
3874 <para>Sammelliste</para>
3879 <term><filename>purchase_delivery_order.ext</filename></term>
3882 <para>Lieferschein (Einkauf)</para>
3887 <term><filename>purcharse_order.ext</filename></term>
3890 <para>Bestellung an Lieferanten</para>
3895 <term><filename>request_quotation.ext</filename></term>
3898 <para>Anfrage an Lieferanten</para>
3903 <term><filename>sales_delivery_order.ext</filename></term>
3906 <para>Lieferschein (Verkauf)</para>
3911 <term><filename>sales_order.ext</filename></term>
3914 <para>Bestellung</para>
3919 <term><filename>sales_quotation.ext</filename></term>
3922 <para>Angebot an Kunden</para>
3927 <term><filename>zahlungserinnerung.ext</filename></term>
3930 <para>Mahnung (Dateiname im Programm konfigurierbar)</para>
3935 <term><filename>zahlungserinnerung_invoice.ext</filename></term>
3938 <para>Rechnung über Mahngebühren (Dateiname im Programm
3939 konfigurierbar)</para>
3945 <sect2 id="dokumentenvorlagen-und-variablen.dateinamen-erweitert">
3946 <title>Sprache, Drucker und E-Mail</title>
3948 <para>Angeforderte Sprache und Druckerkürzel in den Dateinamen mit
3949 eingearbeitet. So wird aus der Vorlage
3950 <filename>sales_order.ext</filename> bei Sprache
3951 <function>de</function> und Druckerkürzel <function>lpr2</function>
3952 der Vorlagenname <filename>sales_order_de_lpr2.ext</filename>.
3953 Zusätzlich können für E-Mails andere Vorlagen erstellt werden, diese
3954 bekommen dann noch das Kürzel <filename>_email</filename>, der
3955 vollständige Vorlagenname wäre dann
3956 <filename>sales_order_email_de_lpr2.ext</filename>. In allen Fällen
3957 kann eine Standarddatei <filename>default.ext</filename> hinterlegt
3958 werden. Diese wird verwendet, wenn keine der anderen Varianten
3959 gefunden wird.</para>
3961 <para>Die vollständige Suchreihenfolge für einen Verkaufsauftrag mit
3962 der Sprache "de" und dem Drucker "lpr2", der per E-Mail im Format PDF
3963 verschickt wird, ist:</para>
3967 <para><filename>sales_order_email_de_lpr2.tex</filename></para>
3971 <para><filename>sales_order_de_lpr2.tex</filename></para>
3975 <para><filename>sales_order.tex</filename></para>
3979 <para><filename>default.tex</filename></para>
3983 <para>Die kurzen Varianten dieser Vorlagentitel müssen dann entweder
3984 Standardwerte anzeigen, oder die angeforderten Werte selbst auswerten,
3986 linkend="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"/>.</para>
3989 <sect2 id="dokumentenvorlagen-und-variablen.allgemeine-variablen">
3990 <title>Allgemeine Variablen, die in allen Vorlagen vorhanden
3993 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"
3994 xreflabel="Metainformationen zur angeforderten Vorlage">
3995 <title>Metainformationen zur angeforderten Vorlage</title>
3997 <para>Diese Variablen liefern Informationen darüber welche Variante
3998 einer Vorlage der Benutzer angefragt hat. Sie sind nützlich für
3999 Vorlagenautoren, die aus einer zentralen Layoutvorlage die einzelnen
4000 Formulare einbinden möchten.</para>
4004 <term><varname>template_meta.formname</varname></term>
4007 <para>Basisname der Vorlage. Identisch mit der <link
4008 linkend="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">Zurordnung
4009 zu den Dateinamen</link> ohne die Erweiterung. Ein
4010 Verkaufsauftrag enthält hier
4011 <constant>sales_order</constant>.</para>
4016 <term><varname>template_meta.language.description</varname></term>
4019 <para>Beschreibung der verwendeten Sprache</para>
4024 <term><varname>template_meta.language.template_code</varname></term>
4027 <para>Vorlagenkürzel der verwendeten Sprache, identisch mit
4028 dem Kürzel das im Dateinamen verwendetet wird.</para>
4033 <term><varname>template_meta.language.output_numberformat</varname></term>
4036 <para>Zahlenformat der verwendeten Sprache in der Form
4037 "<constant>1.000,00</constant>". Experimentell! Nur
4038 interessant für Vorlagen die mit unformatierten Werten
4044 <term><varname>template_meta.language.output_dateformat</varname></term>
4047 <para>Datumsformat der verwendeten Sprache in der Form
4048 "<constant>dd.mm.yyyy</constant>". Experimentell! Nur
4049 interessant für Vorlagen die mit unformatierten Werten
4055 <term><varname>template_meta.format</varname></term>
4058 <para>Das angeforderte Format. Kann im Moment die Werte
4059 <constant>pdf</constant>, <constant>postscript</constant>,
4060 <constant>html</constant>, <constant>opendocument</constant>,
4061 <constant>opendocument_pdf</constant> und
4062 <constant>excel</constant> enthalten.</para>
4067 <term><varname>template_meta.extension</varname></term>
4070 <para>Dateierweiterung, wie im Dateinamen. Wird aus
4071 <constant>format</constant> entschieden.</para>
4076 <term><varname>template_meta.media</varname></term>
4079 <para>Ausgabemedium. Kann zur Zeit die Werte
4080 <constant>screen</constant> für Bildschirm,
4081 <constant>email</constant> für E-Mail (triggert das
4082 <constant>_email</constant> Kürzel im Dateinamen),
4083 <constant>printer</constant> für Drucker, und
4084 <constant>queue</constant> für Warteschlange enthalten.</para>
4089 <term><varname>template_meta.printer.description</varname></term>
4092 <para>Beschreibung des ausgewählten Druckers</para>
4097 <term><varname>template_meta.printer.template_code</varname></term>
4100 <para>Vorlagenürzel des ausgewählten Druckers, identisch mit
4101 dem Kürzel das im Dateinamen verwendetet wird.</para>
4106 <term><varname>template_meta.tmpfile</varname></term>
4109 <para>Datei-Prefix für temporäre Dateien.</para>
4115 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.kunden-lieferanten">
4116 <title>Stammdaten von Kunden und Lieferanten</title>
4120 <term><varname>account_number</varname></term>
4123 <para>Kontonummer</para>
4128 <term><varname>bank</varname></term>
4131 <para>Name der Bank</para>
4136 <term><varname>bank_code</varname></term>
4139 <para>Bankleitzahl</para>
4144 <term><varname>bic</varname></term>
4147 <para>Bank-Identifikations-Code (Bank Identifier Code,
4153 <term><varname>business</varname></term>
4156 <para>Kunden-/Lieferantentyp</para>
4161 <term><varname>city</varname></term>
4169 <term><varname>contact</varname></term>
4172 <para>Kontakt</para>
4177 <term><varname>country</varname></term>
4185 <term><varname>c_vendor_id</varname></term>
4188 <para>Lieferantennummer beim Kunden (nur Kunden)</para>
4193 <term><varname>v_customer_id</varname></term>
4196 <para>Kundennummer beim Lieferanten (nur Lieferanten)</para>
4201 <term><varname>cp_email</varname></term>
4204 <para>Email des Ansprechpartners</para>
4209 <term><varname>cp_givenname</varname></term>
4212 <para>Vorname des Ansprechpartners</para>
4217 <term><varname>cp_greeting</varname></term>
4220 <para>Anrede des Ansprechpartners</para>
4225 <term><varname>cp_name</varname></term>
4228 <para>Name des Ansprechpartners</para>
4233 <term><varname>cp_phone1</varname></term>
4236 <para>Telefonnummer 1 des Ansprechpartners</para>
4241 <term><varname>cp_phone2</varname></term>
4244 <para>Telefonnummer 2 des Ansprechpartners</para>
4249 <term><varname>cp_title</varname></term>
4252 <para>Titel des Ansprechpartners</para>
4257 <term><varname>creditlimit</varname></term>
4260 <para>Kreditlimit</para>
4265 <term><varname>customeremail</varname></term>
4268 <para>Email des Kunden; nur für Kunden</para>
4273 <term><varname>customerfax</varname></term>
4276 <para>Faxnummer des Kunden; nur für Kunden</para>
4281 <term><varname>customernotes</varname></term>
4284 <para>Bemerkungen beim Kunden; nur für Kunden</para>
4289 <term><varname>customernumber</varname></term>
4292 <para>Kundennummer; nur für Kunden</para>
4297 <term><varname>customerphone</varname></term>
4300 <para>Telefonnummer des Kunden; nur für Kunden</para>
4305 <term><varname>discount</varname></term>
4313 <term><varname>email</varname></term>
4316 <para>Emailadresse</para>
4321 <term><varname>fax</varname></term>
4324 <para>Faxnummer</para>
4329 <term><varname>gln</varname></term>
4332 <para>GLN (Globale Lokationsnummer)</para>
4337 <term><varname>greeting</varname></term>
4345 <term><varname>homepage</varname></term>
4348 <para>Homepage</para>
4353 <term><varname>iban</varname></term>
4356 <para>Internationale Kontonummer (International Bank Account
4357 Number, IBAN)</para>
4362 <term><varname>language</varname></term>
4365 <para>Sprache</para>
4370 <term><varname>name</varname></term>
4373 <para>Firmenname</para>
4378 <term><varname>payment_description</varname></term>
4381 <para>Name der Zahlart</para>
4386 <term><varname>payment_terms</varname></term>
4389 <para>Zahlungskonditionen</para>
4394 <term><varname>phone</varname></term>
4397 <para>Telefonnummer</para>
4402 <term><varname>shiptocity</varname></term>
4405 <para>Stadt (Lieferadresse) <link
4406 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4411 <term><varname>shiptocontact</varname></term>
4414 <para>Kontakt (Lieferadresse) <link
4415 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4420 <term><varname>shiptocountry</varname></term>
4423 <para>Land (Lieferadresse) <link
4424 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4429 <term><varname>shiptodepartment_1</varname></term>
4432 <para>Abteilung 1 (Lieferadresse) <link
4433 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4438 <term><varname>shiptodepartment_2</varname></term>
4441 <para>Abteilung 2 (Lieferadresse) <link
4442 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4447 <term><varname>shiptoemail</varname></term>
4450 <para>Email (Lieferadresse) <link
4451 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4456 <term><varname>shiptofax</varname></term>
4459 <para>Fax (Lieferadresse) <link
4460 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4465 <term><varname>shiptogln</varname></term>
4468 <para>GLN (Globale Lokationsnummer) (Lieferadresse) <link
4469 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4474 <term><varname>shiptoname</varname></term>
4477 <para>Firmenname (Lieferadresse) <link
4478 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4483 <term><varname>shiptophone</varname></term>
4486 <para>Telefonnummer (Lieferadresse) <link
4487 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4492 <term><varname>shiptostreet</varname></term>
4495 <para>Straße und Hausnummer (Lieferadresse) <link
4496 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4501 <term><varname>shiptozipcode</varname></term>
4504 <para>Postleitzahl (Lieferadresse) <link
4505 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4510 <term><varname>street</varname></term>
4513 <para>Straße und Hausnummer</para>
4518 <term><varname>taxnumber</varname></term>
4521 <para>Steuernummer</para>
4526 <term><varname>ustid</varname></term>
4529 <para>Umsatzsteuer-Identifikationsnummer</para>
4534 <term><varname>vendoremail</varname></term>
4537 <para>Email des Lieferanten; nur für Lieferanten</para>
4542 <term><varname>vendorfax</varname></term>
4545 <para>Faxnummer des Lieferanten; nur für Lieferanten</para>
4550 <term><varname>vendornotes</varname></term>
4553 <para>Bemerkungen beim Lieferanten; nur für Lieferanten</para>
4558 <term><varname>vendornumber</varname></term>
4561 <para>Lieferantennummer; nur für Lieferanten</para>
4566 <term><varname>vendorphone</varname></term>
4569 <para>Telefonnummer des Lieferanten; nur für
4575 <term><varname>zipcode</varname></term>
4578 <para>Postleitzahl</para>
4583 <note id="dokumentenvorlagen-und-variablen.anmerkung-shipto">
4584 <para>Anmerkung: Sind die <varname>shipto*</varname>-Felder in den
4585 Stammdaten nicht eingetragen, so haben die Variablen
4586 <varname>shipto*</varname> den gleichen Wert wie die die
4587 entsprechenden Variablen der Lieferdaten. Das bedeutet, dass sich
4588 einige <varname>shipto*</varname>-Variablen so nicht in den
4589 Stammdaten wiederfinden sondern schlicht Kopien der
4590 Lieferdatenvariablen sind (z.B.
4591 <varname>shiptocontact</varname>).</para>
4595 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-bearbeiter">
4596 <title>Informationen über den Bearbeiter</title>
4600 <term><varname>employee_address</varname></term>
4603 <para>Adressfeld</para>
4608 <term><varname>employee_businessnumber</varname></term>
4611 <para>Firmennummer</para>
4616 <term><varname>employee_company</varname></term>
4619 <para>Firmenname</para>
4624 <term><varname>employee_co_ustid</varname></term>
4627 <para>Usatzsteuer-Identifikationsnummer</para>
4632 <term><varname>employee_duns</varname></term>
4635 <para>DUNS-Nummer</para>
4640 <term><varname>employee_email</varname></term>
4648 <term><varname>employee_fax</varname></term>
4656 <term><varname>employee_name</varname></term>
4659 <para>voller Name</para>
4664 <term><varname>employee_signature</varname></term>
4667 <para>Signatur</para>
4672 <term><varname>employee_taxnumber</varname></term>
4675 <para>Steuernummer</para>
4680 <term><varname>employee_tel</varname></term>
4683 <para>Telefonnummer</para>
4689 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-verkaeufer">
4690 <title>Informationen über den Verkäufer</title>
4694 <term><varname>salesman_address</varname></term>
4697 <para>Adressfeld</para>
4702 <term><varname>salesman_businessnumber</varname></term>
4705 <para>Firmennummer</para>
4710 <term><varname>salesman_company</varname></term>
4713 <para>Firmenname</para>
4718 <term><varname>salesman_co_ustid</varname></term>
4721 <para>Usatzsteuer-Identifikationsnummer</para>
4726 <term><varname>salesman_duns</varname></term>
4729 <para>DUNS-Nummer</para>
4734 <term><varname>salesman_email</varname></term>
4742 <term><varname>salesman_fax</varname></term>
4750 <term><varname>salesman_name</varname></term>
4753 <para>voller Name</para>
4758 <term><varname>salesman_signature</varname></term>
4761 <para>Signatur</para>
4766 <term><varname>salesman_taxnumber</varname></term>
4769 <para>Steuernummer</para>
4774 <term><varname>salesman_tel</varname></term>
4777 <para>Telefonnummer</para>
4783 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-steuern">
4784 <title>Variablen für die einzelnen Steuern</title>
4788 <term><varname>tax</varname></term>
4796 <term><varname>taxbase</varname></term>
4799 <para>zu versteuernder Betrag</para>
4804 <term><varname>taxdescription</varname></term>
4807 <para>Name der Steuer</para>
4812 <term><varname>taxrate</varname></term>
4815 <para>Steuersatz</para>
4821 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-lieferbedingungen">
4822 <title>Variablen für Lieferbedingungen</title>
4826 <term><varname>delivery_term</varname></term>
4829 <para>Datenbank-Objekt der Lieferbedingung</para>
4834 <term><varname>delivery_term.description</varname></term>
4837 <para>Beschreibung der Lieferbedingung</para>
4842 <term><varname>delivery_term.description_long</varname></term>
4845 <para>Langtext bzw. übersetzter Langtext der
4846 Lieferbedingung</para>
4853 <sect2 id="dokumentenvorlagen-und-variablen.invoice">
4854 <title>Variablen in Rechnungen</title>
4856 <sect3 id="dokumentenvorlagen-und-variablen.invoice-allgemein">
4857 <title>Allgemeine Variablen</title>
4861 <term><varname>creditremaining</varname></term>
4864 <para>Verbleibender Kredit</para>
4869 <term><varname>currency</varname></term>
4872 <para>Währung</para>
4877 <term><varname>cusordnumber</varname></term>
4880 <para>Bestellnummer beim Kunden</para>
4885 <term><varname>deliverydate</varname></term>
4888 <para>Lieferdatum</para>
4893 <term><varname>duedate</varname></term>
4896 <para>Fälligkeitsdatum</para>
4901 <term><varname>globalprojectnumber</varname></term>
4904 <para>Projektnummer des ganzen Beleges</para>
4909 <term><varname>globalprojectdescription</varname></term>
4912 <para>Projekbeschreibung des ganzen Beleges</para>
4917 <term><varname>intnotes</varname></term>
4920 <para>Interne Bemerkungen</para>
4925 <term><varname>invdate</varname></term>
4928 <para>Rechnungsdatum</para>
4933 <term><varname>invnumber</varname></term>
4936 <para>Rechnungsnummer</para>
4941 <term><varname>invtotal</varname></term>
4944 <para>gesamter Rechnungsbetrag</para>
4949 <term><varname>notes</varname></term>
4952 <para>Bemerkungen der Rechnung</para>
4957 <term><varname>orddate</varname></term>
4960 <para>Auftragsdatum</para>
4965 <term><varname>ordnumber</varname></term>
4968 <para>Auftragsnummer, wenn die Rechnung aus einem Auftrag
4969 erstellt wurde</para>
4974 <term><varname>payment_description</varname></term>
4977 <para>Name der Zahlart</para>
4982 <term><varname>payment_terms</varname></term>
4985 <para>Zahlungskonditionen</para>
4990 <term><varname>quodate</varname></term>
4993 <para>Angebotsdatum</para>
4998 <term><varname>quonumber</varname></term>
5001 <para>Angebotsnummer</para>
5006 <term><varname>rounding</varname></term>
5009 <para>Betrag, um den <varname>invtotal</varname> gerundet
5010 wurde (kann positiv oder negativ sein)</para>
5015 <term><varname>shippingpoint</varname></term>
5018 <para>Versandort</para>
5023 <term><varname>shipvia</varname></term>
5026 <para>Transportmittel</para>
5031 <term><varname>subtotal</varname></term>
5034 <para>Zwischensumme aller Posten ohne Steuern</para>
5039 <term><varname>total</varname></term>
5042 <para>Restsumme der Rechnung (Summe abzüglich bereits
5043 bezahlter Posten)</para>
5048 <term><varname>transaction_description</varname></term>
5051 <para>Vorgangsbezeichnung</para>
5056 <term><varname>transdate</varname></term>
5059 <para>Auftragsdatum wenn die Rechnung aus einem Auftrag
5060 erstellt wurde</para>
5066 <sect3 id="dokumentenvorlagen-und-variablen.invoice-posten">
5067 <title>Variablen für jeden Posten auf der Rechnung</title>
5071 <term><varname>bin</varname></term>
5074 <para>Stellage</para>
5079 <term><varname>description</varname></term>
5082 <para>Artikelbeschreibung</para>
5087 <term><varname>cusordnumber_oe</varname></term>
5090 <para>Bestellnummer des Kunden aus dem Auftrag, aus dem der
5091 Posten ursprünglich stammt (nur Verkauf)</para>
5096 <term><varname>discount</varname></term>
5099 <para>Rabatt als Betrag</para>
5104 <term><varname>discount_sub</varname></term>
5107 <para>Zwischensumme mit Rabatt</para>
5112 <term><varname>donumber_do</varname></term>
5115 <para>Lieferscheinnummer des Lieferscheins, aus dem die
5116 Position ursprünglich stammt, wenn die Rechnung im Rahmen des
5117 Workflows aus einem Lieferschein erstellt wurde.</para>
5122 <term><varname>drawing</varname></term>
5125 <para>Zeichnung</para>
5130 <term><varname>ean</varname></term>
5133 <para>EAN-Code</para>
5138 <term><varname>image</varname></term>
5146 <term><varname>linetotal</varname></term>
5149 <para>Zeilensumme (Anzahl * Einzelpreis)</para>
5154 <term><varname>longdescription</varname></term>
5157 <para>Langtext</para>
5162 <term><varname>microfiche</varname></term>
5165 <para>Mikrofilm</para>
5170 <term><varname>netprice</varname></term>
5173 <para>Alternative zu <varname>sellprice</varname>, aber
5174 <varname>netprice</varname> entspricht dem effektiven
5175 Einzelpreis und beinhaltet Zeilenrabatt und Preisfaktor.
5176 <varname>netprice</varname> wird rückgerechnet aus Zeilensumme
5177 / Menge. Diese Variable ist nützlich, wenn man den gewährten
5178 Rabatt in der Druckvorlage nicht anzeigen möchte, aber Menge *
5179 Einzelpreis trotzdem die angezeigte Zeilensumme ergeben soll.
5180 <varname>netprice</varname> hat nichts mit Netto/Brutto im
5181 Sinne von Steuern zu tun.</para>
5186 <term><varname>nodiscount_linetotal</varname></term>
5189 <para>Zeilensumme ohne Rabatt</para>
5194 <term><varname>nodiscount_sub</varname></term>
5197 <para>Zwischensumme ohne Rabatt</para>
5202 <term><varname>number</varname></term>
5205 <para>Artikelnummer</para>
5210 <term><varname>ordnumber_oe</varname></term>
5213 <para>Auftragsnummer des Originalauftrags, aus dem der Posten
5214 ursprünglich stammt. Nützlich, wenn die Rechnung aus mehreren
5215 Lieferscheinen zusammengefasst wurde, oder wenn zwischendurch
5216 eine Sammelauftrag aus mehreren Aufträgen erstellt wurde. In
5217 letzterem Fall wird die unsprüngliche Auftragsnummer
5223 <term><varname>p_discount</varname></term>
5226 <para>Rabatt in Prozent</para>
5231 <term><varname>partnotes</varname></term>
5234 <para>Die beim Artikel gespeicherten Bemerkungen</para>
5239 <term><varname>partsgroup</varname></term>
5242 <para>Warengruppe</para>
5247 <term><varname>price_factor</varname></term>
5250 <para>Der Preisfaktor als Zahl, sofern einer eingestellt
5256 <term><varname>price_factor_name</varname></term>
5259 <para>Der Name des Preisfaktors, sofern einer eingestellt
5265 <term><varname>projectnumber</varname></term>
5268 <para>Projektnummer</para>
5273 <term><varname>projectdescription</varname></term>
5276 <para>Projektbeschreibung</para>
5281 <term><varname>qty</varname></term>
5289 <term><varname>reqdate</varname></term>
5292 <para>Lieferdatum</para>
5297 <term><varname>runningnumber</varname></term>
5300 <para>Position auf der Rechnung (1, 2, 3...)</para>
5305 <term><varname>sellprice</varname></term>
5308 <para>Verkaufspreis</para>
5313 <term><varname>serialnumber</varname></term>
5316 <para>Seriennummer</para>
5321 <term><varname>tax_rate</varname></term>
5324 <para>Steuersatz</para>
5329 <term><varname>transdate_do</varname></term>
5332 <para>Datum des Lieferscheins, wenn die Rechnung im Rahmen des
5333 Workflows aus einem Lieferschein stammte.</para>
5338 <term><varname>transdate_oe</varname></term>
5341 <para>Datum des Auftrags, wenn die Rechnung im Rahmen des
5342 Workflows aus einem Auftrag erstellt wurde. Wenn es
5343 Sammelaufträge gab wird das Datum des ursprünglichen Auftrags
5349 <term><varname>transdate_quo</varname></term>
5352 <para>Datum des Angebots, wenn die Position im Rahmen des
5353 Workflows aus einem Angebot stammte.</para>
5358 <term><varname>unit</varname></term>
5361 <para>Einheit</para>
5366 <term><varname>weight</varname></term>
5369 <para>Gewicht</para>
5374 <para>Für jeden Posten gibt es ein Unterarray mit den Informationen
5375 über Lieferanten und Lieferantenartikelnummer. Diese müssen mit
5376 einer <function>foreach</function>-Schleife ausgegeben werden, da
5377 für jeden Artikel mehrere Lieferanteninformationen hinterlegt sein
5378 können. Die Variablen dafür lauten:</para>
5382 <term><varname>make</varname></term>
5385 <para>Lieferant</para>
5390 <term><varname>model</varname></term>
5393 <para>Lieferantenartikelnummer</para>
5399 <sect3 id="dokumentenvorlagen-und-variablen.invoice-zahlungen">
5400 <title>Variablen für die einzelnen Zahlungseingänge</title>
5404 <term><varname>payment</varname></term>
5412 <term><varname>paymentaccount</varname></term>
5420 <term><varname>paymentdate</varname></term>
5428 <term><varname>paymentmemo</varname></term>
5436 <term><varname>paymentsource</varname></term>
5445 <sect3 id="dokumentenvorlagen-und-variablen.benutzerdefinierte-variablen-vc">
5446 <title>Benutzerdefinierte Kunden- und Lieferantenvariablen</title>
5448 <para>Die vom Benutzer definierten Variablen für Kunden und
5449 Lieferanten stehen beim Ausdruck von Einkaufs- und Verkaufsbelegen
5450 ebenfalls zur Verfügung. Ihre Namen setzen sich aus dem Präfix
5451 <varname>vc_cvar_</varname> und dem vom Benutzer festgelegten
5452 Variablennamen zusammen.</para>
5454 <para>Beispiel: Der Benutzer hat eine Variable namens
5455 <varname>number_of_employees</varname> definiert, die die Anzahl der
5456 Mitarbeiter des Unternehmens enthält. Diese Variable steht dann
5457 unter dem Namen <varname>vc_cvar_number_of_employees</varname> zur
5460 <para>Die benutzerdefinierten Variablen der Lieferadressen stehen
5461 unter einem ähnlichen Namensschema zur Verfügung. Hier lautet der
5462 Präfix <varname>shiptocvar_</varname>.</para>
5464 <para>Analog stehen die benutzerdefinierten Variablen für
5465 Ansprechpersonen mit dem Namenspräfix <varname>cp_cvar_</varname>
5466 zur Verfügung.</para>
5470 <sect2 id="dokumentenvorlagen-und-variablen.dunning">
5471 <title>Variablen in Mahnungen und Rechnungen über Mahngebühren</title>
5473 <sect3 id="dokumentenvorlagen-und-variablen.dunning-vorlagennamen">
5474 <title>Namen der Vorlagen</title>
5476 <para>Die Namen der Vorlagen werden im System-Menü vom Benutzer
5477 eingegeben. Wird für ein Mahnlevel die Option zur automatischen
5478 Erstellung einer Rechnung über die Mahngebühren und Zinsen
5479 aktiviert, so wird der Name der Vorlage für diese Rechnung aus dem
5480 Vorlagenname für diese Mahnstufe mit dem Zusatz
5481 <constant>_invoice</constant> gebildet. Weiterhin werden die Kürzel
5482 für die ausgewählte Sprache und den ausgewählten Drucker
5486 <sect3 id="dokumentenvorlagen-und-variablen.dunning-allgemein">
5487 <title>Allgemeine Variablen in Mahnungen</title>
5489 <para>Die Variablen des Bearbeiters, bzw. Verkäufers stehen wie
5490 gewohnt als <varname>employee_...</varname> bzw.
5491 <varname>salesman_...</varname> zur Verfügung. Werden mehrere
5492 Rechnungen in einer Mahnung zusammengefasst, so werden die Metadaten
5493 (Bearbeiter, Abteilung, etc) der ersten angemahnten Rechnung im
5494 Ausdruck genommen.</para>
5496 <para>Die Adressdaten des Kunden stehen als Variablen
5497 <varname>name</varname>, <varname>street</varname>,
5498 <varname>zipcode</varname>, <varname>city</varname>,
5499 <varname>country</varname>, <varname>department_1</varname>,
5500 <varname>department_2</varname>, und <varname>email</varname> zur
5501 Verfügung. Der Ansprechpartner <varname>cp_...</varname> steht auch
5502 zu Verfügung, wird allerdings auch nur von der ersten angemahnten
5503 Rechnung (s.o.) genommen.</para>
5505 <para>Weitere Variablen beinhalten:</para>
5509 <term><varname>dunning_date</varname></term>
5512 <para>Datum der Mahnung</para>
5517 <term><varname>dunning_duedate</varname></term>
5520 <para>Fälligkeitsdatum für diese Mahhnung</para>
5525 <term><varname>dunning_id</varname></term>
5528 <para>Mahnungsnummer</para>
5533 <term><varname>fee</varname></term>
5536 <para>Kumulative Mahngebühren</para>
5541 <term><varname>interest_rate</varname></term>
5544 <para>Zinssatz per anno in Prozent</para>
5549 <term><varname>total_amount</varname></term>
5552 <para>Gesamter noch zu zahlender Betrag als
5553 <function>fee</function> + <function>total_interest</function>
5554 + <function>total_open_amount</function></para>
5559 <term><varname>total_interest</varname></term>
5562 <para>Zinsen per anno über alle Rechnungen</para>
5567 <term><varname>total_open_amount</varname></term>
5570 <para>Summe über alle offene Beträge der Rechnungen</para>
5576 <sect3 id="dokumentenvorlagen-und-variablen.dunning-details">
5577 <title>Variablen für jede gemahnte Rechnung in einer Mahnung</title>
5581 <term><varname>dn_amount</varname></term>
5584 <para>Rechnungssumme (brutto)</para>
5589 <term><varname>dn_duedate</varname></term>
5592 <para>Originales Fälligkeitsdatum der Rechnung</para>
5597 <term><varname>dn_dunning_date</varname></term>
5600 <para>Datum der Mahnung</para>
5605 <term><varname>dn_dunning_duedate</varname></term>
5608 <para>Fälligkeitsdatum der Mahnung</para>
5613 <term><varname>dn_fee</varname></term>
5616 <para>Kummulative Mahngebühr</para>
5621 <term><varname>dn_interest</varname></term>
5624 <para>Zinsen per anno für diese Rechnung</para>
5629 <term><varname>dn_invnumber</varname></term>
5632 <para>Rechnungsnummer</para>
5637 <term><varname>dn_linetotal</varname></term>
5640 <para>Noch zu zahlender Betrag (ergibt sich aus
5641 <varname>dn_open_amount</varname> + <varname>dn_fee</varname>
5642 + <varname>dn_interest</varname>)</para>
5647 <term><varname>dn_netamount</varname></term>
5650 <para>Rechnungssumme (netto)</para>
5655 <term><varname>dn_open_amount</varname></term>
5658 <para>Offener Rechnungsbetrag</para>
5663 <term><varname>dn_ordnumber</varname></term>
5666 <para>Bestellnummer</para>
5671 <term><varname>dn_transdate</varname></term>
5674 <para>Rechnungsdatum</para>
5679 <term><varname>dn_curr</varname></term>
5682 <para>Währung, in der die Rechnung erstellt wurde. (Die
5683 Rechnungsbeträge sind aber immer in der Hauptwährung)</para>
5689 <sect3 id="dokumentenvorlagen-und-variablen.dunning-invoice">
5690 <title>Variablen in automatisch erzeugten Rechnungen über
5691 Mahngebühren</title>
5693 <para>Die Variablen des Verkäufers stehen wie gewohnt als
5694 <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
5695 Kunden stehen als Variablen <varname>name</varname>,
5696 <varname>street</varname>, <varname>zipcode</varname>,
5697 <varname>city</varname>, <varname>country</varname>,
5698 <varname>department_1</varname>, <varname>department_2</varname>,
5699 und <varname>email</varname> zur Verfügung.</para>
5701 <para>Weitere Variablen beinhalten:</para>
5705 <term><varname>duedate</varname></term>
5708 <para>Fälligkeitsdatum der Rechnung</para>
5713 <term><varname>dunning_id</varname></term>
5716 <para>Mahnungsnummer</para>
5721 <term><varname>fee</varname></term>
5724 <para>Mahngebühren</para>
5729 <term><varname>interest</varname></term>
5737 <term><varname>invamount</varname></term>
5740 <para>Rechnungssumme (ergibt sich aus <varname>fee</varname> +
5741 <varname>interest</varname>)</para>
5746 <term><varname>invdate</varname></term>
5749 <para>Rechnungsdatum</para>
5754 <term><varname>invnumber</varname></term>
5757 <para>Rechnungsnummer</para>
5764 <sect2 id="dokumentenvorlagen-und-variablen.andere-vorlagen">
5765 <title>Variablen in anderen Vorlagen</title>
5768 <title>Einführung</title>
5770 <para>Die Variablen in anderen Vorlagen sind ähnlich wie in der
5771 Rechnung. Allerdings heißen die Variablen, die mit
5772 <varname>inv</varname> beginnen, jetzt anders. Bei den Angeboten
5773 fangen sie mit <varname>quo</varname> für "quotation" an:
5774 <varname>quodate</varname> für Angebotsdatum etc. Bei Bestellungen
5775 wiederum fangen sie mit <varname>ord</varname> für "order" an:
5776 <varname>ordnumber</varname> für Bestellnummer etc.</para>
5778 <para>Manche Variablen sind in anderen Vorlagen hingegen gar nicht
5779 vorhanden wie z.B. die für bereits verbuchte Zahlungseingänge. Dies
5780 sind Variablen, die vom Geschäftsablauf her in der entsprechenden
5781 Vorlage keine Bedeutung haben oder noch nicht belegt sein
5784 <para>Im Folgenden werden nur wichtige Unterschiede zu den Variablen
5785 in Rechnungen aufgeführt.</para>
5788 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-quotations">
5789 <title>Angebote und Preisanfragen</title>
5793 <term><varname>quonumber</varname></term>
5796 <para>Angebots- bzw. Anfragenummer</para>
5801 <term><varname>reqdate</varname></term>
5804 <para>Gültigkeitsdatum (bei Angeboten) bzw. Lieferdatum (bei
5805 Preisanfragen)</para>
5810 <term><varname>transdate</varname></term>
5813 <para>Angebots- bzw. Anfragedatum</para>
5819 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-orders">
5820 <title>Auftragsbestätigungen und Lieferantenaufträge</title>
5824 <term><varname>ordnumber</varname></term>
5827 <para>Auftragsnummer</para>
5832 <term><varname>reqdate</varname></term>
5835 <para>Lieferdatum</para>
5840 <term><varname>transdate</varname></term>
5843 <para>Auftragsdatum</para>
5849 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-delivery-orders">
5850 <title>Lieferscheine (Verkauf und Einkauf)</title>
5854 <term><varname>cusordnumber</varname></term>
5857 <para>Bestellnummer des Kunden (im Verkauf) bzw. Bestellnummer
5858 des Lieferanten (im Einkauf)</para>
5863 <term><varname>donumber</varname></term>
5866 <para>Lieferscheinnummer</para>
5871 <term><varname>transdate</varname></term>
5874 <para>Lieferscheindatum</para>
5879 <para>Für jede Position eines Lieferscheines gibt es ein Unterarray
5880 mit den Informationen darüber, von welchem Lager und Lagerplatz aus
5881 die Waren verschickt wurden (Verkaufslieferscheine) bzw. auf welchen
5882 Lagerplatz sie eingelagert wurden. Diese müssen mittels einer
5883 <function>foreach</function>-Schleife ausgegeben werden. Diese
5884 Variablen sind:</para>
5888 <term><varname>si_bin</varname></term>
5891 <para>Lagerplatz</para>
5896 <term><varname>si_chargenumber</varname></term>
5899 <para>Chargennummer</para>
5904 <term><varname>si_bestbefore</varname></term>
5907 <para>Mindesthaltbarkeit</para>
5912 <term><varname>si_number</varname></term>
5915 <para>Artikelnummer</para>
5920 <term><varname>si_qty</varname></term>
5923 <para>Anzahl bzw. Menge</para>
5928 <term><varname>si_runningnumber</varname></term>
5931 <para>Positionsnummer (1, 2, 3 etc)</para>
5936 <term><varname>si_unit</varname></term>
5939 <para>Einheit</para>
5944 <term><varname>si_warehouse</varname></term>
5953 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-statement">
5954 <title>Variablen für Sammelrechnung</title>
5958 <term><varname>c0total</varname></term>
5961 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit < 30
5967 <term><varname>c30total</varname></term>
5970 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 30
5971 und < 60 Tage</para>
5976 <term><varname>c60total</varname></term>
5979 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 60
5980 und < 90 Tage</para>
5985 <term><varname>c90total</varname></term>
5988 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 90
5994 <term><varname>total</varname></term>
5997 <para>Gesamtbetrag aller Rechnungen</para>
6002 <para>Variablen für jede Rechnungsposition in Sammelrechnung:</para>
6006 <term><varname>invnumber</varname></term>
6009 <para>Rechnungsnummer</para>
6014 <term><varname>invdate</varname></term>
6017 <para>Rechnungsdatum</para>
6022 <term><varname>duedate</varname></term>
6025 <para>Fälligkeitsdatum</para>
6030 <term><varname>amount</varname></term>
6033 <para>Summe der Rechnung</para>
6038 <term><varname>open</varname></term>
6041 <para>Noch offener Betrag der Rechnung</para>
6046 <term><varname>c0</varname></term>
6049 <para>Noch offener Rechnungsbetrag mit Fälligkeit < 30
6055 <term><varname>c30</varname></term>
6058 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 30 und
6064 <term><varname>c60</varname></term>
6067 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 60 und
6073 <term><varname>c90</varname></term>
6076 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 90
6084 <sect2 id="dokumentenvorlagen-und-variablen.bloecke">
6085 <title>Blöcke, bedingte Anweisungen und Schleifen</title>
6087 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.einfuehrung">
6088 <title>Einführung</title>
6090 <para>Der Parser kennt neben den Variablen einige weitere
6091 Konstrukte, die gesondert behandelt werden. Diese sind wie
6092 Variablennamen in spezieller Weise markiert:
6093 <command><%anweisung%> ... <%end%></command></para>
6095 <para>Anmerkung zum <command><%end%></command>: Der besseren
6096 Verständlichkeit halber kann man nach dem <command>end</command>
6097 noch beliebig weitere Wörter schreiben, um so zu markieren, welche
6098 Anweisung (z.B. <command>if</command> oder
6099 <command>foreach</command>) damit abgeschlossen wird.</para>
6101 <para>Beispiel: Lautet der Beginn eines Blockes z.B.
6102 <command><%if type == "sales_quotation"%></command>, so könnte
6103 er mit <command><%end%></command> genauso abgeschlossen werden
6104 wie mit <command><%end if%></command> oder auch
6105 <command><%end type == "sales_quotation"%></command>.</para>
6108 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.if">
6109 <title>Der if-Block</title>
6111 <programlisting><%if variablenname%>
6113 <%end%></programlisting>
6115 <para>Eine normale "if-then"-Bedingung. Die Zeilen zwischen dem "if"
6116 und dem "end" werden nur ausgegeben, wenn die Variable
6117 <varname>variablenname</varname> gesetzt und ungleich 0 ist.</para>
6119 <para>Handelt es sich bei der benannten Variable um ein Array, also
6120 um einen Variablennamen, über den man mit <command><%foreach
6121 variablenname%></command> iteriert, so wird mit diesem Konstrukt
6122 darauf getestet, ob das Array Elemente enthält. Somit würde im
6123 folgenden Beispiel nur dann eine Liste von Zahlungseingängen samt
6124 ihrer Überschrift "Zahlungseingänge" ausgegeben, wenn tatsächlich
6125 welche getätigt wurden:</para>
6127 <programlisting><%if payment%>
6129 <%foreach payment%>
6130 Am <%paymentdate%>: <%payment%> €
6131 <%end foreach%>
6132 <%end if%></programlisting>
6134 <para>Die Bedingung kann auch negiert werden, indem das Wort
6135 <function>not</function> nach dem <filename>if</filename> verwendet
6136 wird. Beispiel:</para>
6138 <programlisting><%if not cp_greeting%>
6140 <%end%></programlisting>
6142 <para>Zusätzlich zu dem einfachen Test, ob eine Variable gesetzt ist
6143 oder nicht, bietet dieser Block auch die Möglichkeit, den Inhalt
6144 einer Variablen mit einer festen Zeichenkette oder einer anderen
6145 Variablen zu vergleichen. Ob der Vergleich mit einer Zeichenkette
6146 oder einer anderen Variablen vorgenommen wird, hängt davon ab, ob
6147 die rechte Seite des Vergleichsoperators in Anführungszeichen
6148 gesetzt wird (Vergleich mit Zeichenkette) oder nicht (Vergleich mit
6149 anderer Variablen). Zwei Beispiele, die beide Vergleiche
6152 <programlisting><%if var1 == "Wert"%></programlisting>
6154 <para>Testet die Variable <varname>var1</varname> auf
6155 übereinstimmung mit der Zeichenkette <constant>Wert</constant>.
6156 Mittels <function>!=</function> anstelle von <function>==</function>
6157 würde auf Ungleichheit getestet.</para>
6159 <programlisting><%if var1 == var2%></programlisting>
6161 <para>Testet die Variable <varname>var1</varname> auf
6162 übereinstimmung mit der Variablen <varname>var2</varname>. Mittel
6163 <function>!=</function> anstelle von <function>==</function> würde
6164 auf Ungleichheit getestet.</para>
6166 <para>Erfahrere Benutzer können neben der Tests auf (Un-)Gleichheit
6167 auch Tests auf Übereinstimmung mit regulären Ausdrücken ohne
6168 Berücksichtung der Groß- und Kleinschreibung durchführen. Dazu dient
6169 dieselbe Syntax wie oben nur mit <function>=~</function> und
6170 <function>!~</function> als Vergleichsoperatoren.</para>
6172 <para>Beispiel für einen Test, ob die Variable
6173 <varname>intnotes</varname> (interne Bemerkungen) das Wort
6174 <constant>schwierig</constant> enthält:</para>
6176 <programlisting><%if intnotes =~ "schwierig"%></programlisting>
6179 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.foreach">
6180 <title>Der foreach-Block</title>
6182 <programlisting><%foreach variablenname%>
6184 <%end%></programlisting>
6186 <para>Fügt die Zeilen zwischen den beiden Anweisungen so oft ein,
6187 wie das Perl-Array der Variablen <varname>variablenname</varname>
6188 Elemente enthät. Dieses Konstrukt wird zur Ausgabe der einzelnen
6189 Posten einer Rechnung / eines Angebots sowie zur Ausgabe der Steuern
6190 benutzt. In jedem Durchlauf werden die <link
6191 linkend="dokumentenvorlagen-und-variablen.invoice-posten">zeilenbezogenen
6192 Variablen</link> jeweils auf den Wert für die aktuelle Position
6195 <para>Die Syntax sieht normalerweise wie folgt aus:</para>
6197 <programlisting><%foreach number%>
6198 Position: <%runningnumber%>
6199 Anzahl: <%qty%>
6200 Artikelnummer: <%number%>
6201 Beschreibung: <%description%>
6203 <%end%></programlisting>
6205 <para>Besonderheit in OpenDocument-Vorlagen: Tritt ein
6206 <function><%foreach%></function>-Block innerhalb einer
6207 Tabellenzelle auf, so wird die komplette Tabellenzeile so oft
6208 wiederholt wie notwendig. Tritt er außerhalb auf, so wird nur der
6209 Inhalt zwischen <function><%foreach%></function> und
6210 <function><%end%></function> wiederholt, nicht aber die
6211 komplette Zeile, in der er steht.</para>
6215 <sect2 id="dokumentenvorlagen-und-variablen.markup">
6216 <title>Markup-Code zur Textformatierung innerhalb von
6219 <para>Wenn der Benutzer innhalb von Formularen in kivitendo Text
6220 anders formatiert haben möchte, so ist dies begrenzt möglich.
6221 kivitendo unterstützt die Textformatierung mit HTML-ähnlichen Tags.
6222 Der Benutzer kann z.B. bei der Artikelbeschreibung auf einer Rechnung
6223 Teile des Texts zwischen Start- und Endtags setzen. Dieser Teil wird
6224 dann automatisch in Anweisungen für das ausgewählte Vorlagenformat
6225 (HTML oder PDF über LaTeX) umgesetzt.</para>
6227 <para>Die unterstützen Formatierungen sind:</para>
6231 <term><b>Text</b></term>
6234 <para>Text wird in Fettdruck gesetzt.</para>
6239 <term><i>Text</i></term>
6242 <para>Text wird kursiv gesetzt.</para>
6247 <term><u>Text</u></term>
6250 <para>Text wird unterstrichen.</para>
6255 <term><s>Text</s></term>
6258 <para>Text wird durchgestrichen. Diese Formatierung ist nicht
6259 bei der Ausgabe als PDF über LaTeX verfügbar.</para>
6264 <term><bullet></term>
6267 <para>Erzeugt einen ausgefüllten Kreis für Aufzählungen (siehe
6273 <para>Der Befehl <command><bullet></command> funktioniert
6274 momentan auch nur in Latex-Vorlagen.</para>
6278 <sect1 id="excel-templates">
6279 <title>Excel-Vorlagen</title>
6281 <sect2 id="excel-templates.summary">
6282 <title>Zusammenfassung</title>
6284 <para>Dieses Dokument beschreibt den Mechanismus, mit dem
6285 Exceltemplates abgearbeitet werden, und die Einschränkungen, die damit
6289 <sect2 id="excel-templates.usage">
6290 <title>Bedienung</title>
6292 <para>Der Excel Mechanismus muss in der Konfigurationsdatei aktiviert
6293 werden. Die Konfigurationsoption heißt <varname>excel_templates =
6294 1</varname> im Abschnitt <varname>[print_templates]</varname>.</para>
6296 <para>Eine Excelvorlage kann dann unter dem Namen einer beliebigen
6297 anderen Vorlage mit der Endung <filename>.xls</filename> gespeichert
6298 werden. In den normalen Verkaufsmasken taucht nun
6299 <constant>Excel</constant> als auswählbares Format auf und kann von da
6300 an wie LaTeX- oder OpenOffice-Vorlagen benutzt werden.</para>
6302 <para>Der Sonderfall der Angebote aus der Kundenmaske ist ebenfalls
6303 eine Angebotsvorlage und wird unter dem internen Namen der Angebote
6304 <filename>sales_quotation.xls</filename> gespeichert.</para>
6307 <sect2 id="excel-templates.syntax">
6308 <title>Variablensyntax</title>
6310 <para>Einfache Syntax:
6311 <command><<varname>></command></para>
6313 <para>Dabei sind <constant><<</constant> und
6314 <constant>>></constant> die Delimiter. Da Excel auf festen
6315 Breiten besteht, kann der Tag künstlich verlängert werden, indem
6316 weitere <constant><</constant> oder <constant>></constant>
6317 eingefügt werden. Der Tag muss nicht symmetrisch sein.
6320 <programlisting><<<<<varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
6322 <para>Um die Limitierung der festen Breite zu reduzieren, können
6323 weitere Variablen in einem Block interpoliert werden. Whitespace wird
6324 dazwishen dann erhalten. Beispiel:</para>
6326 <programlisting><<<<<varname1 varname2 varname3>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
6328 <para>Die Variablen werden interpoliert, und linksbündig mit
6329 Leerzeichen auf die gewünschte Länge aufgefüllt. Ist der String zu
6330 lang, werden überzählige Zeichen abgeschnitten.</para>
6332 <para>Es ist ausserdem möglich, Daten rechtsbündig darzustellen, wenn
6333 der Block mit einem Leerzeichen anfängt. Beispiel:</para>
6335 <programlisting><<<<<< varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
6337 <para>Dies würde rechtsbündig triggern. Wenn bei rechtsbündiger
6338 Ausrichtung Text abgeschnitten werden muss, wird er vom linken Ende
6342 <sect2 id="excel-templates.limitations">
6343 <title>Einschränkungen</title>
6345 <para>Das Excelformat bis 2002 ist ein binäres Format, und kann nicht
6346 mit vertretbarem Aufwand editiert werden. Der Templatemechanismus
6347 beschränkt sich daher darauf, Textstellen exakt durch einen anderen
6348 Text zu ersetzen.</para>
6350 <para>Aus dem gleichen Grund sind die Kontrolllstrukturen
6351 <command><%if%></command> und
6352 <command><%foreach%></command> nicht vorhanden. Der Delimiter
6353 <constant><% %></constant> kommt in den Headerinformationen
6354 evtl. vor. Deshalb wurde auf den sichereren Delimiter
6355 <constant><<</constant> und <constant>>></constant>
6360 <sect1 id="features.warehouse">
6361 <title>Mandantenkonfiguration Lager</title>
6363 <para>Die Lagerverwaltung in kivitendo funktioniert standardmässig wie
6364 folgt: Wird ein Lager mit einem Lagerplatz angelegt, so gibt es die
6365 Möglichkeit hier über den Menüpunkt Lager entsprechende Warenbewegungen
6366 durchzuführen. Ferner kann jede Position eines Lieferscheins ein-, bzw.
6367 ausgelagert werden (Einkauf-, bzw. Verkauf). Es können beliebig viele
6368 Lager mit beliebig vielen Lagerplätzen abgebildet werden. Die
6369 Lagerbewegungen über einen Lieferschein erfolgt durch Anklicken jeder
6370 Einzelposition und das Auswählen dieser Position zu einem Lager mit
6371 Lagerplatz. Dieses Verfahren lässt sich schrittweise vereinfachen, je
6372 nachdem wie die Einstellungen in der Mandatenkonfiguration gesetzt
6377 <para><option>Auslagern über Standardlagerplatz</option> Hier wird
6378 ein zusätzlicher Knopf (Auslagern über Standard-Lagerplatz) in dem
6379 Lieferschein-Beleg hinzugefügt, der dann alle Lagerbewegungen über
6380 den Standardlagerplatz (konfigurierbar pro Ware) durchführt.</para>
6384 <para><option>Auslagern ohne Bestandsprüfung</option> Das obige
6385 Auslagern schlägt fehl, wenn die entsprechende Menge für die
6386 Lagerbewegung nicht vorhanden ist, möchte man dies auch ignorieren
6387 und ggf. dann nachpflegen, so kann man eine Negativ-Warenmenge mit
6388 dieser Option erlauben. Hierfür muss ein entsprechender Lagerplatz
6389 (Fehlbestand, o.ä.) konfiguriert sein.</para>
6393 <para>Zusätzliche Funktionshinweise:</para>
6397 <para><option>Standard-Lagerplatz</option> Ist dieser konfiguriert,
6398 wird dies auch als Standard-Voreinstellung bei der Neuerfassung von
6399 Stammdaten → Waren / Dienstleistung / Erzeugnis verwendet.</para>
6403 <para><option>Standard-Lagerplatz verwenden, falls keiner in
6404 Stammdaten definiert</option> Wird beim 'Auslagern über
6405 Standardlagerplatz' keine Standardlagerplatz zu der Ware gefunden,
6406 so wird mit dieser Option einfach der Standardlagerplatz
6412 <sect1 id="features.swiss-charts-of-accounts">
6413 <title>Schweizer Kontenpläne</title>
6415 <para>Seit der Version 3.5 stehen in kivitendo 3 Kontenpläne für den
6416 Einsatz in der Schweiz zur Verfügung, einer für Firmen und
6417 Organisationen, die nicht mehrwertsteuerpflichtig sind, einer für
6418 Firmen, die mehrwertsteuerpflichtig sind und einer speziell für
6421 <para>Die Kontenpläne orientieren sich am in der Schweiz üblicherweise
6422 verwendeten KMU-Kontenrahmen und sind mit der Revision des
6423 Schweizerischen Obligationenrechts (OR) vom 1.1.2013 kompatibel,
6424 insbesondere <literal>Art.957a Abs.2</literal>.</para>
6426 <para>Beim Vereinskontenplan sind standardmässig nur die Konten 1100
6427 (Debitoren CHF) und 1101 (Debitoren EUR) als Buchungskonten im Verkauf
6428 sowie die Konten 2000 (Kreditoren CHF) und 2001 (Kreditoren EUR) als
6429 Buchungskonten im Einkauf vorgesehen. Weitere Konten können bei Bedarf
6430 in den Konto-Detaileinstellungen als Einkaufs- oder Verkaufskonten
6431 konfiguriert werden.</para>
6433 <para>Die Möglichkeit, Saldosteuersätze zu verwenden ist in der
6434 aktuellen Version von kivitendo noch nicht integriert.</para>
6436 <para>Trotzdem können auch Firmen, die per Saldosteuersatz mit der
6437 Eidgenössischen Steuerverwaltung abrechnen, kivitendo bereits nutzen.
6438 Dazu wird der Kontenplan mit MWST ausgewählt. Anschliessend müssen alle
6439 Aufwandskonten editiert werden und dort der Steuersatz auf 0% gesetzt
6442 <para>So werden bei Kreditorenbuchungen keine Vorsteuern
6445 <para>Bezugssteuern für aus dem Ausland bezogene Dienstleistungen müssen
6446 manuell verbucht werden.</para>
6448 <para>Wünsche für Anpassungen an den Schweizer Kontenplänen sowie
6449 Vorschläge für weitere (z.B. branchenspezifische) Kontenpläne bitte an
6450 <literal>empfang@revamp-it.ch</literal> senden.</para>
6453 <sect1 id="features.part_classification">
6454 <title>Artikelklassifizierung</title>
6457 <title>Übersicht</title>
6459 <para>Die Klassifizierung von Artikeln dient einer weiteren
6460 Gliederung, um zum Beispiel den Einkauf vom Verkauf zu trennen,
6461 gekennzeichnet durch eine Beschreibung (z.B. "Einkauf") und ein Kürzel
6462 (z.B. "E"). Für jede Klassifizierung besteht eine Beschreibung und
6463 eine Abkürzung die normalerweise aus einem Zeichen besteht, kann aber
6464 auf mehrere Zeichen erweitert werden, falls zur Unterscheidung
6465 notwendig. Sinnvoll sind jedoch nur maximal 2 Zeichen.</para>
6469 <title>Basisklassifizierung</title>
6471 <para>Als Basisklassifizierungen gibt es</para>
6475 <para>Einkauf</para>
6479 <para>Verkauf</para>
6483 <para>Handelsware</para>
6487 <para>Produktion</para>
6491 <para>- keine - (diese wird bei einer Aktualisierung für alle
6492 existierenden Artikel verwendet und ist gültig für Verkauf und
6497 <para>Es können weitere Klassifizierungen angelegt werden. So kann es
6498 z.B. für separat auszuweisende Artikel folgende Klassen geben:</para>
6502 <para>Lieferung (Logistik, Transport) mit Kürzel L</para>
6506 <para>Material (Verpackungsmaterial) mit Kürzel M</para>
6512 <title>Attribute</title>
6514 <para>Bisher haben die Klassifizierungen folgende Attribute, die auch
6515 alle gleichzeitg gültig sein können</para>
6519 <para>gültig für Verkauf - dieser Artikel kann im Verkauf genutzt
6524 <para>gültig für Einkauf - dieser Artikel kann im Einkauf genutzt
6529 <para>separat ausweisen - hierzu gibt es zur Dokumentengenerierung
6530 (LaTeX) eine zusätzliche Variable</para>
6534 <para>Für das Attribut "separat ausweisen" stehen in den
6535 LaTeX-Vorlagen die Variable <emphasis
6536 role="bold"><%non_separate_subtotal%> </emphasis>zur Verfügung,
6537 die alle nicht separat auszuweisenden Artikelkosten saldiert, sowie
6538 pro separat auszuweisenden Klassifizierungen die Variable<emphasis
6539 role="bold">< %separate_X_subtotal%></emphasis>, wobei X das
6540 Kürzel der Klassifizierung ist.</para>
6542 <para>Im obigen Beispiel wäre das für Lieferkosten <emphasis
6543 role="bold"><%separate_L_subtotal%></emphasis> und für
6544 Verpackungsmaterial <emphasis role="bold">
6545 <%separate_M_subtotal%></emphasis>.</para>
6549 <title>Zwei-Zeichen Abkürzung</title>
6551 <para>Der Typ des Artikels und die Klassifizierung werden durch zwei
6552 Buchstaben dargestellt. Der erste Buchstabe ist eine Lokalisierung des
6553 Artikel-Typs ('P','A','S'), deutsch 'W', 'E', und 'D' für Ware
6554 Erzeugnis oder Dienstleistung und ggf. weiterer Typen.</para>
6556 <para>Der zweite Buchstabe (und ggf. auch ein dritter, falls nötig)
6557 entspricht der lokalisierten Abkürzung der Klassifizierung.</para>
6559 <para>Diese Abkürzung wird überall beim Auflisten von Artikeln zur
6560 Erleichterung mit dargestellt.</para>
6564 <sect1 id="features.file_managment">
6565 <title>Dateiverwaltung (Mini-DMS)</title>
6568 <title>Übersicht</title>
6570 <para>Parallel zum alten WebDAV gibt es ein Datei-Management-System,
6571 das Dateien verschiedenen Typs verwaltet. Dies können</para>
6575 <para>aus ERP-Daten per LaTeX Template erzeugte
6576 PDF-Dokumente,</para>
6580 <para>zu bestimmten ERP-Daten gehörende Anhangdateien
6581 unterschiedlichen Formats,</para>
6585 <para>per Scanner eingelesene PDF-Dateien,</para>
6589 <para>per E-Mail empfangene Dateianhänge unterschiedlichen
6594 <para>sowie speziel für Artikel hochgeladene Bilder sein.</para>
6599 <screeninfo>Übersicht</screeninfo>
6603 <imagedata contentwidth="600" fileref="images/DMS-Overview.png"/>
6610 <title>Struktur</title>
6612 <para>Über eine vom Speichermedium unabhängige Zwischenschicht werden
6613 die Dateien und ihre Versionen in der Datenbank verwaltet. Darunter
6614 können verschiedene Implementierungen (Backends) gleichzeitig
6619 <para>Dateisystem</para>
6627 <para>Schnittstelle zu externen
6628 Dokumenten-Management-Systemen</para>
6632 <para>andere Datenbank</para>
6636 <para>etc ...</para>
6640 <para>Es gibt unterschiedliche Typen von Dateien. Jedem Typ läßt sich
6641 in der Mandantenkonfiguration ein bestimmtes Backend zuordnen.</para>
6645 <para>"document": Das sind entweder generierte, eingescannte oder
6646 hochgeladene PDF-Dateien, die zu bestimmten ERP-Daten
6647 (ERP-Objekte, wie z.B. Rechnung, Lieferschein) gehören.</para>
6651 <para>"attachment": zusätzlich hochgeladene Dokumente, die an
6652 bestimmte ERP-Objekte angehängt werden, z.B. technische
6653 Zeichnungen, Aufmaße. Diese können auch für Artikel, Lieferanten
6654 und Kunden hinterlegt sein.</para>
6658 <para>"image": Bilder für Artikel. Diese können auch verkleinert
6659 in einer Vorschau (Thumbnail) angezeigt werden.</para>
6663 <para>Zusätzlich werden in der Datenbank zu den Dateien neben der
6664 Zuordnung zu ERP-Objekten, Dateityp Dateinamen und Backend, in dem die
6665 Datei gespeichert ist, auch die Quelle der Datei notiert:</para>
6669 <para>"created": vom System erzeugte Dokumente"</para>
6673 <para>"uploaded": hochgeladene Dokumente</para>
6677 <para>"email": vom Mail-System empfangene Dateien</para>
6681 <para>"scanner[1]": von einem oder mehreren Scannern erzeugte
6682 Dateien. Existieren mehrere Scanner, so sind diese durch
6683 unterschiedliche Quellennamen zu definieren.</para>
6687 <para>Je nach Dateityp sind nur bestimmte Quellen zulässig. So gibt es
6688 für "attachment" und "image" nur die Quelle "uploaded". Für "document"
6689 gibt es auf jeden Fall die Quelle "created". Die Quellen "scanner" und
6690 "email" müssen derzeit in der Datenbank konfiguriert werden (siehe
6691 <xref linkend="file_management.dbconfig"/>).</para>
6695 <title>Anwendung</title>
6697 <para>Die Daten werden bei den ERP-Objekten als extra Reiter
6698 dargestellt. Eine Verkaufsrechnung z.B. hat die Reiter "Dokumente" und
6699 "Dateianhänge".</para>
6702 <screeninfo>Reiter "Dateianhänge"</screeninfo>
6706 <imagedata fileref="images/DMS-Anhaenge.png" scale="50"/>
6711 <para>Bei den Dateianhängen wird immer nur die aktuelle Version einer
6712 Datei angezeigt. Wird eine Datei mit gleichem Namen hochgeladen, so
6713 wird eine neue Version der Datei erstellt. Vorher wird der Anwender
6714 durch einen Dialog gefragt, ob er eine neue Version anlegen will oder
6715 ob er die Datei umbenennen will, falls es eine neue Datei sein
6719 <screeninfo>Reiter "Dateianhänge"</screeninfo>
6723 <imagedata contentwidth="40"
6724 fileref="images/DMS-Anhaenge-hochladen.png"
6730 <para>Es können mehrere Dateien gleichzeitig hochgeladen werden,
6731 solange in Summe die maximale Größe nicht überschritten wird (siehe
6732 <xref linkend="file_management.clientconfig"/>).</para>
6735 <screeninfo>Reiter "Dokumente"</screeninfo>
6739 <imagedata fileref="images/DMS-Dokumente.png" width="500"/>
6744 <para>Sind keine weiteren Quellen für Dokumente konfiguriert, so gibt
6745 es nur "erzeugte Dokumente". Es werden alle Versionen der generierten
6746 Datei angezeigt. Für Verkaufsrechnungen kommen keine anderen Quellen
6747 zur Geltung. Werden entsprechend der <xref
6748 linkend="file_management.dbconfig"/> zusätzliche Quellen konfiguriert,
6749 so sind diese z.B. bei Einkaufsrechnungen sichtbar:</para>
6752 <screeninfo>Reiter "Dokumente"</screeninfo>
6756 <imagedata contentwidth="600"
6757 fileref="images/DMS-Dokumente-Scanner.png"/>
6762 <para>Statt des Löschens wird hier die Datei zurück zur Quelle
6763 verschoben. Somit kann die Datei anschließend an ein anderes
6764 ERP-Objekt angehängt werden.</para>
6766 <para>Derzeit sind "Titel" und "Beschreibung" noch nicht genutzt. Sie
6767 sind bisher nur bei Bildern relevant.</para>
6771 <title>Konfigurierung</title>
6773 <sect3 id="file_management.clientconfig"
6774 xreflabel="Mandantenkonfigurierung">
6775 <title>Mandantenkonfiguration</title>
6778 <title>Reiter "Features"</title>
6780 <para>Unter dem Reiter <emphasis role="bold">Features</emphasis>
6781 im Abschnitt Dateimanagement ist neben dem "alten" WebDAV das
6782 Dateimangement generell zu- und abschaltbar, sowie die Zuordnung
6783 der Dateitypen zu Backends. Die Löschbarkeit von Dateien, sowie
6784 die maximale Uploadgröße sind Backend-unabhängig</para>
6787 <screeninfo>Mandantenkonfig Reiter "Features"</screeninfo>
6791 <imagedata fileref="images/DMS-ClientConfig.png" width="500"/>
6796 <para>Die einzelnen Backends sind einzeln einschaltbar.
6797 Spezifische Backend-Konfigurierungen sind hier noch
6802 <title>Reiter "Allgemeine Dokumentenanhänge"</title>
6804 <para>Unter dem Reiter <emphasis role="bold">Allgemeine
6805 Dokumentenanhänge</emphasis> kann für alle ERP-Dokumente (
6806 Angebote, Aufträge, Lieferscheine, Rechnungen im Verkauf und
6807 Einkauf ) allgemeingültige Anhänge hochgeladen werden.</para>
6810 <screeninfo>Mandantenkonfig Reiter "Allgemeine
6811 Dokumentenanhänge"</screeninfo>
6815 <imagedata fileref="images/DMS-Allgemeine-Dokumentenanhaenge.png"
6821 <para>Diese Anhänge werden beim Generieren von PDF-Dateien an die
6822 ERP-Dokumente angehängt, z.B. AGBs oder aktuelle Angebote. Es
6823 werden in dem Fall die Daten kopiert, sodass an den ERP-Dokumenten
6824 immer die Anhänge zum Generierungszeitpunkt eingebettet
6829 <sect3 id="file_management.dbconfig"
6830 xreflabel="Datenbank-Konfigurierung">
6831 <title>Datenbank-Konfigurierung</title>
6833 <para>Die zusätzlichen Quellen für "email" oder ein oder mehrere
6834 Scanner sind derzeit vom Administrator direkt in der
6835 Datenbanktabelle "user_preferences" einzurichten. Die "value" ist im
6836 JSON-Format mit den jeweiligen Werten des Verzeichnisses und der
6837 Beschreibung der Quelle.</para>
6840 id | login | namespace | version | key | value
6841 ----+-----------+--------------+---------+----------+---------------------------
6842 1 | #default# | file_sources | 0.00000 | scanner1 |
6843 {"dir":"/var/tmp/scanner1","desc":"Scanner Einkauf"}
6844 2 | #default# | file_sources | 0.00000 | scanner2 |
6845 {"dir":"/var/tmp/scanner2","desc":"Scanner Verkauf"}
6846 3 | #default# | file_sources | 0.00000 | emails |
6847 {"dir":"/var/tmp/emails","desc":"Empfangene Mails" }
6850 <para>Es ist daran gedacht, statt dem Default-Eintrag später für
6851 bestimmte Benutzer ('login') bestimmte Quellen zuzulassen. Dies wird
6852 nach Bedarf implementiert.</para>
6855 <sect3 id="file_management.kiviconfig"
6856 xreflabel="kivitendo-Konfigurationsdatei">
6857 <title>kivitendo-Konfigurationsdatei</title>
6859 <para>Dort ist im Abschnitt [paths] der relative oder absolute Pfad
6860 zum Dokumentenwurzelverzeichnis einzutragen. Dieser muss für den
6861 Webserver schreib- und lesbar sein, jedoch nicht ausführbar.</para>
6865 document_path = /var/local/kivi_documents
6868 <para>Unter diesem Wurzelverzeichnis wird pro Mandant automatisch
6869 ein Unterverzeichnis mit der ID des Mandanten angelegt.</para>
6875 <title>Webshop-Api</title>
6877 <para>Das Shopmodul bietet die Möglichkeit Onlineshopartikel und
6878 Onlineshopbestellungen zu verwalten und zu bearbeiten.</para>
6880 <para>Es ist Multishopfähig, d.h. Artikel können mehreren oder
6881 unterschiedlichen Shops zugeordnet werden. Bestellungen können aus
6882 mehreren Shops geholt werden.</para>
6884 <para>Zur Zeit bietet das Modul nur einen Connector zur REST-Api von
6885 Shopware. Weitere Connectoren können dazu programmiert und eingerichtet
6889 <title>Rechte für die Webshopapi</title>
6891 <para>In der Administration können folgende Rechte vergeben
6896 <para>Webshopartikel anlegen und bearbeiten</para>
6900 <para>Shopbestellungen holen und bearbeiten</para>
6904 <para>Shop anlegen und bearbeiten</para>
6910 <title>Konfiguration</title>
6912 <para>Unter System->Webshops können Shops angelegt und konfiguriert
6917 <imagedata contentdepth="500" contentwidth="700"
6918 fileref="images/Shop_Listing.png"/>
6924 <title>Webshopartikel</title>
6927 <title>Shopvariablenreiter in Artikelstammdaten</title>
6929 <para>Mit dem Recht "Shopartikel anlegen und bearbeiten" und des
6930 Markers <emphasis role="bold">"Shopartikel" in den Basisdaten
6931 </emphasis>zeigt sich der Reiter "Shopvariablen" in den
6932 Artikelstammdaten. Hier können jetzt die Artikel mit
6933 unterschiedlichen Beschreibung und/oder Preisen für die
6934 konfigutierten Shops angelegt und bearbeitet werden. An dieser
6935 Stelle können auch beliebig viele Bilder dem Shopartikel zugeordnet
6936 werden. Artikelbilder gelten für alle Shops.</para>
6940 <imagedata contentdepth="500" contentwidth="600"
6941 fileref="images/Shop_Artikel.png"/>
6945 <para>Die Artikelgruppen werden direkt vom Shopsystem geholt somit
6946 ist es möglich einen Artikel auch mehreren Gruppen
6951 <title>Shopartikelliste</title>
6953 <para>Unter dem Menu Webshop->Webshop Artikel hat man nochmal
6954 eine Gesamtübersicht. Von hier aus ist es möglich Artikel im Stapel
6955 unter verschiedenen Kriterien <alles><nur Preis><nur
6956 Bestand><Preis und Bestand> an die jeweiligen Shops
6961 <imagedata fileref="images/Shop_Artikel_Listing.png"/>
6968 <title>Bestellimport</title>
6970 <para>Unter dem Menupunkt Webshop->Webshop Import öffnet sich die
6971 Bestellimportsliste. Hier ist sind Möglichkeiten gegeben Neue
6972 Bestellungen vom Shop abzuholen, geholte Bestellungen im Stapel oder
6973 einzeln als Auftrag zu transferieren. Die Liste kann nach
6974 verschiedenen Kriterien gefiltert werden.</para>
6978 <imagedata fileref="images/Shop_Bestell.png"/>
6982 <para>Bei Einträgen in der Liste.</para>
6986 <para>keine Kundennummer: Es gibt ähnliche Kundendatensätze und
6987 der Datensatz konnte nicht eindeutig zugewiesen werden.</para>
6991 <para>Kundennummer und Rechnungen rot hinterlegt: Der Kunde hat
6992 offene Posten und kann deswegen nicht im Stapel übernommen
6997 <para>Rechnungsadresse grün hinterlegt: Der Kunde konnte eindeutig
6998 einem Datensatz zugeordnet werden. Die Shopbestellung kann im
6999 Stapel mit dem Button "Anwenden" und wenn markiert als Auftrag
7000 übernommen werden.</para>
7004 <para>Kundennummer vorhanden, aber die Checkbox "Auftrag
7005 erstellen" fehlt. Der Kunde hat vermutlich eine
7006 Shopauftragssperre.</para>
7010 <para>Lieferadresse grau hinterlegt: Optische Anzeige, dass es
7011 sich um eine unterschiedliche Lieferadresse handelt.
7012 Lieferadressen werden aber grundsätzlich beim Transferieren zu
7013 Aufträgen mit übernommen.</para>
7017 <para>In der Spalte Positionen/Betrag/Versandkosten zeigt sich ein
7018 tooltip zu den Positionen.</para>
7022 <para>Maske Auftrag erstellen</para>
7024 <para>Viele Shopsysteme haben drei verschieden Adresstypen Kunden-,
7025 Rechnungs-, und Lieferadresse, die sich auch alle unterscheiden
7026 können. Diese werden im oberen Bereich angezeigt. Es ist möglich jede
7027 dieser Adresse einzeln in kivitendo als Kunde zu übernehmen. Es werden
7028 die Werte Formulareingabe übernommen. Es wird bei einer Änderung
7029 allerdings nur diese in die kivitendo Kundenstammdaten übernommen, die
7030 Shopbestellung bleibt bestehen.</para>
7032 <para>Mit der mittleren Adresse(Rechnungsadresse) im oberen Bereich,
7033 kann ich den ausgewählten kivitendodatensatz des mittleren Bereich
7034 überschreiben. Das ist sinnvoll, wenn ich erkenne, das der Kunde z.B.
7035 umgezogen ist.</para>
7037 <para>Im mittleren Bereich das Adresslisting zeigt:</para>
7041 <para>Rot hinterlegt: Kunde hat eine Shopauftragssperre, diese
7042 muss zuerst deaktiviert werden bevor ich diesem Kunden eine
7043 Shopbestellung zuordnen kann.</para>
7047 <para>Kundenname fett und rot: Hier hat der Kunde eine Bemerkung
7048 in den Stammdaten. Ein Tooltip zeigt diese Bemerkung. Das kann dan
7049 auch der Grund für die Auftragssperre sein.</para>
7053 <para>Die Buttons "Auftrag erstellen" und "Kunde mit
7054 Rechnungsadresse überschreiben" zeigen sich erst, wenn ein Kunde
7055 aus dem Listing ausgewählt ist.</para>
7059 <para>Es ist aber möglich die Shopbestellung zu löschen.</para>
7063 <para>Ist eine Bestellung schon übernommen, zeigen sich an dieser
7064 Stelle, die dazugehörigen Belegverknüpfungen.</para>
7070 <title>Mapping der Daten</title>
7072 <para>Das Mapping der kivitendo Daten mit den Shopdaten geschieht in
7073 der Datei SL/ShopConnector/<SHOPCONNECTORNAME>.pm
7074 z.B.:SL/ShopConnector/Shopware.pm</para>
7076 <para>In dieser Datei gibt es einen Bereich wo die Bestellpostionen,
7077 die Bestellkopfdaten und die Artikeldaten gemapt werden. In dieser
7078 Datei kann ein individelles Mapping dann gemacht werden. Zu Shopware
7079 gibt es hier eine sehr gute Dokumentation: <ulink
7080 url="https://developers.shopware.com/developers-guide/rest-api/">https://developers.shopware.com/developers-guide/rest-api/</ulink></para>
7086 <title>Entwicklerdokumentation</title>
7088 <sect1 id="devel.globals" xreflabel="Globale Variablen">
7089 <title>Globale Variablen</title>
7092 <title>Wie sehen globale Variablen in Perl aus?</title>
7094 <para>Globale Variablen liegen in einem speziellen namespace namens
7095 "main", der von überall erreichbar ist. Darüber hinaus sind bareword
7096 globs global und die meisten speziellen Variablen sind...
7099 <para>Daraus ergeben sich folgende Formen:</para>
7103 <term><literal>$main::form</literal></term>
7106 <para>expliziter Namespace "main"</para>
7111 <term><literal>$::form</literal></term>
7114 <para>impliziter Namespace "main"</para>
7119 <term><literal>open FILE, "file.txt"</literal></term>
7122 <para><varname>FILE</varname> ist global</para>
7127 <term><literal>$_</literal></term>
7130 <para>speziell</para>
7135 <para>Im Gegensatz zu <productname>PHP</productname> gibt es kein
7136 Schlüsselwort wie "<function>global</function>", mit dem man
7137 importieren kann. <function>my</function>, <function>our</function>
7138 und <function>local</function> machen was anderes.</para>
7142 <term><literal>my $form</literal></term>
7145 <para>lexikalische Variable, gültig bis zum Ende des
7151 <term><literal>our $form</literal></term>
7154 <para><varname>$form</varname> referenziert ab hier
7155 <varname>$PACKAGE::form</varname>.</para>
7160 <term><literal>local $form</literal></term>
7163 <para>Alle Änderungen an <varname>$form</varname> werden am Ende
7164 des scopes zurückgesetzt</para>
7171 <title>Warum sind globale Variablen ein Problem?</title>
7173 <para>Das erste Problem ist <productname>FCGI</productname>.</para>
7175 <para><productname>SQL-Ledger</productname> hat fast alles im globalen
7176 namespace abgelegt, und erwartet, dass es da auch wiederzufinden ist.
7177 Unter <productname>FCGI</productname> müssen diese Sachen aber wieder
7178 aufgeräumt werden, damit sie nicht in den nächsten Request kommen.
7179 Einige Sachen wiederum sollen nicht gelöscht werden, wie zum Beispiel
7180 Datenbankverbindungen, weil die sehr lange zum Initialisieren
7183 <para>Das zweite Problem ist <function>strict</function>. Unter
7184 <function>strict</function> werden alle Variablen die nicht explizit
7185 mit <function>Package</function>, <function>my</function> oder
7186 <function>our</function> angegeben werden als Tippfehler angemarkert,
7187 dies hat, seit der Einführung, u.a. schon so manche langwierige
7188 Bug-Suche verkürzt. Da globale Variablen aber implizit mit Package
7189 angegeben werden, werden die nicht geprüft, und somit kann sich
7190 schnell ein Tippfehler einschleichen.</para>
7194 <title>Kanonische globale Variablen</title>
7196 <para>Um dieses Problem im Griff zu halten gibt es einige wenige
7197 globale Variablen, die kanonisch sind, d.h. sie haben bestimmte
7198 vorgegebenen Eigenschaften, und alles andere sollte anderweitig
7199 umhergereicht werden.</para>
7201 <para>Diese Variablen sind im Moment die folgenden neun:</para>
7205 <para><varname>$::form</varname></para>
7209 <para><varname>%::myconfig</varname></para>
7213 <para><varname>$::locale</varname></para>
7217 <para><varname>$::lxdebug</varname></para>
7221 <para><varname>$::auth</varname></para>
7225 <para><varname>$::lx_office_conf</varname></para>
7229 <para><varname>$::instance_conf</varname></para>
7233 <para><varname>$::dispatcher</varname></para>
7237 <para><varname>$::request</varname></para>
7241 <para>Damit diese nicht erneut als Müllhalde missbraucht werden, im
7242 Folgenden eine kurze Erläuterung der bestimmten vorgegebenen
7243 Eigenschaften (Konventionen):</para>
7246 <title>$::form</title>
7250 <para>Ist ein Objekt der Klasse
7251 "<classname>Form</classname>"</para>
7255 <para>Wird nach jedem Request gelöscht</para>
7259 <para>Muss auch in Tests und Konsolenscripts vorhanden
7264 <para>Enthält am Anfang eines Requests die Requestparameter vom
7269 <para>Kann zwar intern über Requestgrenzen ein Datenbankhandle
7270 cachen, das wird aber momentan absichtlich zerstört</para>
7274 <para><varname>$::form</varname> wurde unter <productname>SQL
7275 Ledger</productname> als Gottobjekt für alles missbraucht. Sämtliche
7276 alten Funktionen unter SL/ mutieren <varname>$::form</varname>, das
7277 heißt, alles was einem lieb ist (alle Variablen die einem ans Herz
7278 gewachsen sind), sollte man vor einem Aufruf (!) von zum Beispiel
7279 <function>IS->retrieve_customer()</function> in Sicherheit
7282 <para>Z.B. das vom Benutzer eingestellte Zahlenformat, bevor man
7283 Berechnung in einem bestimmten Format durchführt (SL/Form.pm Zeile
7284 3552, Stand version 2.7beta), um dies hinterher wieder auf den
7285 richtigen Wert zu setzen:</para>
7287 <programlisting> my $saved_numberformat = $::myconfig{numberformat};
7288 $::myconfig{numberformat} = $numberformat;
7289 # (...) div Berechnungen
7290 $::myconfig{numberformat} = $saved_numberformat;</programlisting>
7292 <para>Das Objekt der Klasse Form hat leider im Moment noch viele
7293 zentrale Funktionen die vom internen Zustand abhängen, deshalb bitte
7294 nie einfach zerstören oder überschreiben (zumindestens nicht kurz
7295 vor einem Release oder in Absprache über bspw. die devel-Liste ;-).
7296 Es geht ziemlich sicher etwas kaputt.</para>
7298 <para><varname>$::form</varname> ist gleichzeitig der Standard Scope
7299 in den <productname>Template::Toolkit</productname> Templates
7300 außerhalb der Controller: der Ausdruck <function>[% var
7301 %]</function> greift auf <varname>$::form->{var}</varname> zu.
7302 Unter Controllern ist der Standard Scope anders, da lautet der
7303 Zugriff <function>[% FORM.var %]</function>. In Druckvorlagen sind
7304 normale Variablen ebenfall im <varname>$::form</varname> Scope, d.h.
7305 <function><%var%></function> zeigt auf
7306 <varname>$::form->{var}</varname>. Nochmal von der anderen Seite
7307 erläutert, innerhalb von (Web-)Templates sieht man häufiger solche
7310 <programlisting>[%- IF business %]
7311 # (... Zeig die Auswahlliste Kunden-/Lieferantentyp an)
7312 [%- END %]</programlisting>
7314 <para>Entweder wird hier dann $::form->{business} ausgewertet
7315 oder aber der Funktion
7316 <function>$form->parse_html_template</function> wird explizit
7317 noch ein zusätzlicher Hash übergeben, der dann auch in den
7318 (Web-)Templates zu Verfügung steht, bspw. so:</para>
7320 <programlisting>$form->parse_html_template("is/form_header", \%TMPL_VAR);</programlisting>
7322 <para>Innerhalb von Schleifen wird
7323 <varname>$::form->{TEMPLATE_ARRAYS}{var}[$index]</varname>
7324 bevorzugt, wenn vorhanden. Ein Beispiel findet sich in SL/DO.pm,
7325 welches über alle Positionen eines Lieferscheins in Schleife
7328 <programlisting>for $i (1 .. $form->{rowcount}) {
7330 push @{ $form->{TEMPLATE_ARRAYS}{runningnumber} }, $position;
7331 push @{ $form->{TEMPLATE_ARRAYS}{number} }, $form->{"partnumber_$i"};
7332 push @{ $form->{TEMPLATE_ARRAYS}{description} }, $form->{"description_$i"};
7338 <title>%::myconfig</title>
7342 <para>Das einzige Hash unter den globalen Variablen</para>
7346 <para>Wird spätestens benötigt wenn auf die Datenbank
7347 zugegriffen wird</para>
7351 <para>Wird bei jedem Request neu erstellt.</para>
7355 <para>Enthält die Userdaten des aktuellen Logins</para>
7359 <para>Sollte nicht ohne Filterung irgendwo gedumpt werden oder
7360 extern serialisiert werden, weil da auch der Datenbankzugriff
7361 für diesen user drinsteht.</para>
7365 <para>Enthält unter anderem Datumsformat dateformat und
7366 Nummernformat numberformat</para>
7370 <para>Enthält Datenbankzugriffinformationen</para>
7374 <para><varname>%::myconfig</varname> ist im Moment der Ersatz für
7375 ein Userobjekt. Die meisten Funktionen, die etwas anhand des
7376 aktuellen Users entscheiden müssen, befragen
7377 <varname>%::myconfig</varname>. Innerhalb der Anwendungen sind dies
7378 überwiegend die Daten, die sich unter <guimenu>Programm</guimenu>
7379 -> <guimenuitem>Einstellungen</guimenuitem> befinden, bzw. die
7380 Informationen über den Benutzer die über die
7381 Administrator-Schnittstelle eingegeben wurden.</para>
7385 <title>$::locale</title>
7389 <para>Objekt der Klasse "Locale"</para>
7393 <para>Wird pro Request erstellt</para>
7397 <para>Muss auch für Tests und Scripte immer verfügbar
7402 <para>Cached intern über Requestgrenzen hinweg benutzte
7407 <para>Lokalisierung für den aktuellen User. Alle Übersetzungen,
7408 Zahlen- und Datumsformatierungen laufen über dieses Objekt.</para>
7412 <title>$::lxdebug</title>
7416 <para>Objekt der Klasse "LXDebug"</para>
7420 <para>Wird global gecached</para>
7424 <para>Muss immer verfügbar sein, in nahezu allen
7429 <para><varname>$::lxdebug</varname> stellt Debuggingfunktionen
7430 bereit, wie "<function>enter_sub</function>" und
7431 "<function>leave_sub</function>", mit denen in den alten Modulen ein
7432 brauchbares Tracing gebaut ist, "<function>log_time</function>", mit
7433 der man die Wallclockzeit seit Requeststart loggen kann, sowie
7434 "<function>message</function>" und "<function>dump</function>" mit
7435 denen man flott Informationen ins Log (tmp/kivitendo-debug.log)
7438 <para>Beispielsweise so:</para>
7440 <programlisting>$main::lxdebug->message(0, 'Meine Konfig:' . Dumper (%::myconfig));
7441 $main::lxdebug->message(0, 'Wer bin ich? Kunde oder Lieferant:' . $form->{vc});</programlisting>
7445 <title>$::auth</title>
7449 <para>Objekt der Klasse "SL::Auth"</para>
7453 <para>Wird global gecached</para>
7457 <para>Hat eine permanente DB Verbindung zur Authdatenbank</para>
7461 <para>Wird nach jedem Request resettet.</para>
7465 <para><varname>$::auth</varname> stellt Funktionen bereit um die
7466 Rechte des aktuellen Users abzufragen. Obwohl diese Informationen
7467 vom aktuellen User abhängen wird das Objekt aus
7468 Geschwindigkeitsgründen nur einmal angelegt und dann nach jedem
7469 Request kurz resettet.</para>
7471 <para>Dieses Objekt kapselt auch den gerade aktiven Mandanten.
7472 Dessen Einstellungen können über
7473 <literal>$::auth->client</literal> abgefragt werden; Rückgabewert
7474 ist ein Hash mit den Werten aus der Tabelle
7475 <literal>auth.clients</literal>.</para>
7479 <title>$::lx_office_conf</title>
7483 <para>Objekt der Klasse
7484 "<classname>SL::LxOfficeConf</classname>"</para>
7488 <para>Global gecached</para>
7492 <para>Repräsentation der
7493 <filename>config/kivitendo.conf[.default]</filename>-Dateien</para>
7497 <para>Globale Konfiguration. Configdateien werden zum Start gelesen
7498 und danach nicht mehr angefasst. Es ist derzeit nicht geplant, dass
7499 das Programm die Konfiguration ändern kann oder sollte.</para>
7501 <para>Beispielsweise ist über den Konfigurationseintrag [debug] die
7502 Debug- und Trace-Log-Datei wie folgt konfiguriert und
7505 <programlisting>[debug]
7506 file_name = /tmp/kivitendo-debug.log</programlisting>
7508 <para>ist der Key <varname>file</varname> im Programm als
7509 <varname>$::lx_office_conf->{debug}{file}</varname>
7513 <para>Zugriff auf die Konfiguration erfolgt im Moment über
7514 Hashkeys, sind also nicht gegen Tippfehler abgesichert.</para>
7519 <title>$::instance_conf</title>
7523 <para>Objekt der Klasse
7524 "<classname>SL::InstanceConfiguration</classname>"</para>
7528 <para>wird pro Request neu erstellt</para>
7532 <para>Funktioniert wie <varname>$::lx_office_conf</varname>,
7533 speichert aber Daten die von der Instanz abhängig sind. Eine Instanz
7534 ist hier eine Mandantendatenbank. Beispielsweise überprüft
7535 <programlisting>$::instance_conf->get_inventory_system eq 'perpetual'</programlisting>
7536 ob die berüchtigte Bestandsmethode zur Anwendung kommt.</para>
7540 <title>$::dispatcher</title>
7544 <para>Objekt der Klasse
7545 "<varname>SL::Dispatcher</varname>"</para>
7549 <para>wird pro Serverprozess erstellt.</para>
7553 <para>enthält Informationen über die technische Verbindung zum
7558 <para>Der dritte Punkt ist auch der einzige Grund warum das Objekt
7559 global gespeichert wird. Wird vermutlich irgendwann in einem anderen
7560 Objekt untergebracht.</para>
7564 <title>$::request</title>
7568 <para>Hashref (evtl später Objekt)</para>
7572 <para>Wird pro Request neu initialisiert.</para>
7576 <para>Keine Unterstruktur garantiert.</para>
7580 <para><varname>$::request</varname> ist ein generischer Platz um
7581 Daten "für den aktuellen Request" abzulegen. Sollte nicht für action
7582 at a distance benutzt werden, sondern um lokales memoizing zu
7583 ermöglichen, das garantiert am Ende des Requests zerstört
7586 <para>Vieles von dem, was im moment in <varname>$::form</varname>
7587 liegt, sollte eigentlich hier liegen. Die groben
7588 Differentialkriterien sind:</para>
7592 <para>Kommt es vom User, und soll unverändert wieder an den
7593 User? Dann <varname>$::form</varname>, steht da eh schon</para>
7597 <para>Sind es Daten aus der Datenbank, die nur bis zum Ende des
7598 Requests gebraucht werden? Dann
7599 <varname>$::request</varname></para>
7603 <para>Muss ich von anderen Teilen des Programms lesend drauf
7604 zugreifen? Dann <varname>$::request</varname>, aber Zugriff über
7605 Wrappermethode</para>
7612 <title>Ehemalige globale Variablen</title>
7614 <para>Die folgenden Variablen waren einmal im Programm, und wurden
7618 <title>$::cgi</title>
7622 <para>war nötig, weil cookie Methoden nicht als
7623 Klassenfunktionen funktionieren</para>
7627 <para>Aufruf als Klasse erzeugt Dummyobjekt was im
7628 Klassennamespace gehalten wird und über Requestgrenzen
7633 <para>liegt jetzt unter
7634 <varname>$::request->{cgi}</varname></para>
7640 <title>$::all_units</title>
7644 <para>war nötig, weil einige Funktionen in Schleifen zum Teil
7645 ein paar hundert mal pro Request eine Liste der Einheiten
7646 brauchen, und de als Parameter durch einen Riesenstack von
7647 Funktionen geschleift werden müssten.</para>
7651 <para>Liegt jetzt unter
7652 <varname>$::request->{cache}{all_units}</varname></para>
7657 <function>AM->retrieve_all_units()</function> gesetzt oder
7664 <title>%::called_subs</title>
7668 <para>wurde benutzt um callsub deep recursions
7673 <para>Wurde entfernt, weil callsub nur einen Bruchteil der
7674 möglichen Rekursioenen darstellt, und da nie welche
7679 <para>komplette recursion protection wurde entfernt.</para>
7686 <sect1 id="devel.fcgi">
7687 <title>Entwicklung unter FastCGI</title>
7689 <sect2 id="devel.fcgi.general">
7690 <title>Allgemeines</title>
7692 <para>Wenn Änderungen in der Konfiguration von kivitendo gemacht
7693 werden, muss der Webserver neu gestartet werden.</para>
7695 <para>Bei der Entwicklung für FastCGI ist auf ein paar Fallstricke zu
7696 achten. Dadurch, dass das Programm in einer Endlosschleife läuft,
7697 müssen folgende Aspekte beachtet werden.</para>
7700 <sect2 id="devel.fcgi.exiting">
7701 <title>Programmende und Ausnahmen</title>
7703 <para>Betrifft die Funktionen <function>warn</function>,
7704 <function>die</function>, <function>exit</function>,
7705 <function>carp</function> und <function>confess</function>.</para>
7707 <para>Fehler, die dass Programm normalerweise sofort beenden (fatale
7708 Fehler), werden mit dem FastCGI Dispatcher abgefangen, um das Programm
7709 am Laufen zu halten. Man kann mit <function>die</function>,
7710 <function>confess</function> oder <function>carp</function> Fehler
7711 ausgeben, die dann vom Dispatcher angezeigt werden. Die kivitendo
7712 eigene <function>$::form-</function>error()> tut im Prinzip das
7713 Gleiche, mit ein paar Extraoptionen. <function>warn</function> und
7714 <function>exit</function> hingegen werden nicht abgefangen.
7715 <function>warn</function> wird direkt nach STDERR, also in Server Log
7716 eine Nachricht schreiben (sofern in der Konfiguration nicht die
7717 Warnungen in das kivitendo Log umgeleitet wurden), und
7718 <function>exit</function> wird die Ausführung beenden.</para>
7720 <para>Prinzipiell ist es kein Beinbruch, wenn sich der Prozess
7721 beendet, fcgi wird ihn sofort neu starten. Allerdings sollte das die
7722 Ausnahme sein. Quintessenz: Bitte kein <function>exit</function>
7723 benutzen, alle anderen Exceptionmechanismen sind ok.</para>
7726 <sect2 id="devel.fcgi.globals">
7727 <title>Globale Variablen</title>
7729 <para>Um zu vermeiden, dass Informationen von einem Request in einen
7730 anderen gelangen, müssen alle globalen Variablen vor einem Request
7731 sauber initialisiert werden. Das ist besonders wichtig im
7732 <varname>$::cgi</varname> und <varname>$::auth</varname> Objekt, weil
7733 diese nicht gelöscht werden pro Instanz, sondern persistent gehalten
7736 <para>In <classname>SL::Dispatcher</classname> gibt es einen sauber
7737 abgetrennten Block, der alle kanonischen globalen Variablen listet und
7738 erklärt. Bitte keine anderen einführen ohne das sauber zu
7739 dokumentieren.</para>
7741 <para>Datenbankverbindungen wird noch ein Guide verfasst werden, wie
7742 man sicher geht, dass man die richtige erwischt.</para>
7745 <sect2 id="devel.fcgi.performance">
7746 <title>Performance und Statistiken</title>
7748 <para>Die kritischen Pfade des Programms sind die Belegmasken, und
7749 unter diesen ganz besonders die Verkaufsrechnungsmaske. Ein Aufruf der
7750 Rechnungsmaske in kivitendo 2.4.3 stable dauert auf einem Core2duo mit
7751 4GB Arbeitsspeicher und Ubuntu 9.10 eine halbe Sekunde. In der 2.6.0
7752 sind es je nach Menge der definierten Variablen 1-2s. Ab der
7753 Moose/Rose::DB Version sind es 5-6s.</para>
7755 <para>Mit FastCGI ist die neuste Version auf 0,26 Sekunden selbst in
7756 den kritischen Pfaden, unter 0,15 sonst.</para>
7760 <sect1 id="db-upgrade-files" xreflabel="Datenbank-Upgradedateien">
7761 <title>SQL-Upgradedateien</title>
7763 <sect2 id="db-upgrade-files.introduction"
7764 xreflabel="Einführung in die Datenbank-Upgradedateien">
7765 <title>Einführung</title>
7767 <para>Datenbankupgrades werden über einzelne Upgrade-Scripte
7768 gesteuert, die sich im Verzeichnis
7769 <filename>sql/Pg-upgrade2</filename> befinden. In diesem Verzeichnis
7770 muss pro Datenbankupgrade eine Datei existieren, die neben den
7771 eigentlich auszuführenden SQL- oder Perl-Befehlen einige
7772 Kontrollinformationen enthält.</para>
7774 <para>Kontrollinformationen definieren Abhängigkeiten und Prioritäten,
7775 sodass Datenbankscripte zwar in einer sicheren Reihenfolge ausgeführt
7776 werden (z.B. darf ein <literal>ALTER TABLE</literal> erst ausgeführt
7777 werden, wenn die Tabelle mit <literal>CREATE TABLE</literal> angelegt
7778 wurde), diese Reihenfolge aber so flexibel ist, dass man keine
7779 Versionsnummern braucht.</para>
7781 <para>kivitendo merkt sich dabei, welches der Upgradescripte in
7782 <filename>sql/Pg-upgrade2</filename> bereits durchgeführt wurde und
7783 führt diese nicht erneut aus. Dazu dient die Tabelle
7784 "<literal>schema_info</literal>", die bei der Anmeldung automatisch
7785 angelegt wird.</para>
7788 <sect2 id="db-upgrade-files.format"
7789 xreflabel="Format der Upgradedateien">
7790 <title>Format der Kontrollinformationen</title>
7792 <para>Die Kontrollinformationen sollten sich am Anfang der jeweiligen
7793 Upgradedatei befinden. Jede Zeile, die Kontrollinformationen enthält,
7794 hat dabei das folgende Format:</para>
7796 <para>Für SQL-Upgradedateien:</para>
7798 <programlisting>-- @key: value</programlisting>
7800 <para>Für Perl-Upgradedateien:</para>
7802 <programlisting># @key: value</programlisting>
7804 <para>Leerzeichen vor "<varname>value</varname>" werden
7807 <para>Die folgenden Schlüsselworte werden verarbeitet:</para>
7811 <term><varname>tag</varname></term>
7814 <para>Wird zwingend benötigt. Dies ist der "Name" des Upgrades.
7815 Dieser "tag" kann von anderen Kontrolldateien in ihren
7816 Abhängigkeiten verwendet werden (Schlüsselwort
7817 "<varname>depends</varname>"). Der "tag" ist auch der Name, der
7818 in der Datenbank eingetragen wird.</para>
7820 <para>Normalerweise sollte die Kontrolldatei genau so heißen wie
7821 der "tag", nur mit der Endung ".sql" bzw. "pl".</para>
7823 <para>Ein Tag darf nur aus alphanumerischen Zeichen sowie den
7824 Zeichen _ - ( ) bestehen. Insbesondere sind Leerzeichen nicht
7825 erlaubt und sollten stattdessen mit Unterstrichen ersetzt
7831 <term><varname>charset</varname></term>
7834 <para>Empfohlen. Gibt den Zeichensatz an, in dem das Script
7835 geschrieben wurde, z.B. "<literal>UTF-8</literal>". Aus
7836 Kompatibilitätsgründen mit alten Upgrade-Scripten wird bei
7837 Abwesenheit des Tags für SQL-Upgradedateien der Zeichensatz
7838 "<literal>ISO-8859-15</literal>" angenommen. Perl-Upgradescripte
7839 hingegen müssen immer in UTF-8 encodiert sein und sollten
7840 demnach auch ein "<literal>use utf8;</literal>"
7846 <term><varname>description</varname></term>
7849 <para>Benötigt. Eine Beschreibung, was in diesem Update
7850 passiert. Diese wird dem Benutzer beim eigentlichen
7851 Datenbankupdate angezeigt. Während der Tag in Englisch gehalten
7852 sein sollte, sollte die Beschreibung auf Deutsch
7858 <term><varname>depends</varname></term>
7861 <para>Optional. Eine mit Leerzeichen getrennte Liste von "tags",
7862 von denen dieses Upgradescript abhängt. kivitendo stellt sicher,
7863 dass die in dieser Liste aufgeführten Scripte bereits
7864 durchgeführt wurden, bevor dieses Script ausgeführt wird.</para>
7866 <para>Abhängigkeiten werden rekursiv betrachtet. Wenn also ein
7867 Script "b" existiert, das von Änderungen in "a" abhängt, und
7868 eine neue Kontrolldatei für "c" erstellt wird, die von
7869 Änderungen in "a" und "b" abhängt, so genügt es, in "c" nur den
7870 Tag "b" als Abhängigkeit zu definieren.</para>
7872 <para>Es ist nicht erlaubt, sich selbst referenzierende
7873 Abhängigkeiten zu definieren (z.B. "a" -> "b", "b" -> "c"
7874 und "c" -> "a").</para>
7879 <term><varname>priority</varname></term>
7882 <para>Optional. Ein Zahlenwert, der die Reihenfolge bestimmt, in
7883 der Scripte ausgeführt werden, die die gleichen
7884 Abhängigkeitstiefen besitzen. Fehlt dieser Parameter, so wird
7885 der Wert 1000 benutzt.</para>
7887 <para>Dies ist reine Kosmetik. Für echte Reihenfolgen muss
7888 "depends" benutzt werden. kivitendo sortiert die auszuführenden
7889 Scripte zuerst nach der Abhängigkeitstiefe (wenn "z" von "y"
7890 abhängt und "y" von "x", so hat "z" eine Abhängigkeitstiefe von
7891 2, "y" von 1 und "x" von 0. "x" würde hier zuerst ausgeführt,
7892 dann "y", dann "z"), dann nach der Priorität und bei gleicher
7893 Priorität alphabetisch nach dem "tag".</para>
7898 <term><varname>ignore</varname></term>
7901 <para>Optional. Falls der Wert auf 1 (true) steht, wird das
7902 Skript bei der Anmeldung ignoriert und entsprechend nicht
7909 <sect2 id="db-upgrade-files.format-perl-files"
7910 xreflabel="Format von Perl-Upgradedateien">
7911 <title>Format von in Perl geschriebenen
7912 Datenbankupgradescripten</title>
7914 <para>In Perl geschriebene Datenbankscripte werden nicht einfach so
7915 ausgeführt sondern müssen sich an gewisse Konventionen halten. Dafür
7916 bekommen sie aber auch einige Komfortfunktionen bereitgestellt.</para>
7918 <para>Ein Upgradescript stellt dabei eine vollständige Objektklasse
7919 dar, die vom Elternobjekt "<literal>SL::DBUpgrade2::Base</literal>"
7920 erben und eine Funktion namens "<literal>run</literal>" zur Verfügung
7921 stellen muss. Das Script wird ausgeführt, indem eine Instanz dieser
7922 Klasse erzeugt und darauf die erwähnte "<literal>run</literal>"
7923 aufgerufen wird.</para>
7925 <para>Zu beachten ist, dass sich der Paketname der Datei aus dem Wert
7926 für "<literal>@tag</literal>" ableitet. Dabei werden alle Zeichen, die
7927 in Paketnamen ungültig wären (gerade Bindestriche), durch Unterstriche
7928 ersetzt. Insgesamt sieht der Paketname wie folgt aus:
7929 "<literal>SL::DBUpgrade2::tag</literal>".</para>
7931 <para>Welche Komfortfunktionen zur Verfügung stehen, erfahren Sie in
7932 der Perl-Dokumentation zum oben genannten Modul; aufzurufen mit
7933 "<command>perldoc SL/DBUpgrade2/Base.pm</command>".</para>
7935 <para>Ein Mindestgerüst eines gültigen Perl-Upgradescriptes sieht wie
7938 <programlisting># @tag: beispiel-upgrade-file42
7939 # @description: Ein schönes Beispielscript
7940 # @depends: release_3_1_0
7941 package SL::DBUpgrade2::beispiel_upgrade_file42;
7946 use parent qw(SL::DBUpgrade2::Base);
7951 # hier Aktionen ausführen
7960 <sect2 id="db-upgrade-files.dbupgrade-tool"
7961 xreflabel="Hilfsscript dbupgrade2_tool.pl">
7962 <title>Hilfsscript dbupgrade2_tool.pl</title>
7964 <para>Um die Arbeit mit den Abhängigkeiten etwas zu erleichtern,
7965 existiert ein Hilfsscript namens
7966 "<filename>scripts/dbupgrade2_tool.pl</filename>". Es muss aus dem
7967 kivitendo-ERP-Basisverzeichnis heraus aufgerufen werden. Dieses Tool
7968 liest alle Datenbankupgradescripte aus dem Verzeichnis
7969 <filename>sql/Pg-upgrade2</filename> aus. Es benutzt dafür die
7970 gleichen Methoden wie kivitendo selber, sodass alle Fehlersituationen
7971 von der Kommandozeile überprüft werden können.</para>
7973 <para>Wird dem Script kein weiterer Parameter übergeben, so wird nur
7974 eine Überprüfung der Felder und Abhängigkeiten vorgenommen. Man kann
7975 sich aber auch Informationen auf verschiedene Art ausgeben
7980 <para>Listenform: "<command>./scripts/dbupgrade2_tool.pl
7981 --list</command>"</para>
7983 <para>Gibt eine Liste aller Scripte aus. Die Liste ist in der
7984 Reihenfolge sortiert, in der kivitendo die Scripte ausführen
7985 würde. Es werden neben der Listenposition der Tag, die
7986 Abhängigkeitstiefe und die Priorität ausgegeben.</para>
7990 <para>Baumform: "<command>./scripts/dbupgrade2_tool.pl
7991 --tree</command>"</para>
7993 <para>Listet alle Tags in Baumform basierend auf den
7994 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte, von
7995 denen keine anderen abhängen. Die Unterknoten sind Scripte, die
7996 beim übergeordneten Script als Abhängigkeit eingetragen
8000 <listitem id="db-upgrade-files.dbupgrade-tool.reverse-tree">
8001 <para>Umgekehrte Baumform: "<command>./scripts/dbupgrade2_tool.pl
8002 --rtree</command>"</para>
8004 <para>Listet alle Tags in Baumform basierend auf den
8005 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte mit
8006 der geringsten Abhängigkeitstiefe. Die Unterknoten sind Scripte,
8007 die das übergeordnete Script als Abhängigkeit eingetragen
8012 <para>Baumform mit Postscriptausgabe:
8013 "<command>./scripts/dbupgrade2_tool.pl
8014 --graphviz</command>"</para>
8016 <para>Benötigt das Tool "<command>graphviz</command>", um mit
8017 seiner Hilfe die <link
8018 linkend="db-upgrade-files.dbupgrade-tool.reverse-tree">umgekehrte
8019 Baumform</link> in eine Postscriptdatei namens
8020 "<filename>db_dependencies.ps</filename>" auszugeben. Dies ist
8021 vermutlich die übersichtlichste Form, weil hierbei jeder Knoten
8022 nur einmal ausgegeben wird. Bei den Textmodusbaumformen hingegen
8023 können Knoten und all ihre Abhängigkeiten mehrfach ausgegeben
8028 <para>Scripte, von denen kein anderes Script abhängt:
8029 "<command>./scripts/dbupgrade2_tool.pl --nodeps</command>"</para>
8031 <para>Listet die Tags aller Scripte auf, von denen keine anderen
8032 Scripte abhängen.</para>
8038 <sect1 id="translations-languages" xreflabel="Translations and languages">
8039 <title>Translations and languages</title>
8041 <sect2 id="translations-languages.introduction"
8042 xreflabel="Introduction to translations and languages">
8043 <title>Introduction</title>
8046 <para>Dieser Abschnitt ist in Englisch geschrieben, um
8047 internationalen Übersetzern die Arbeit zu erleichtern.</para>
8050 <para>This section describes how localization packages in kivitendo
8051 are built. Currently the only language fully supported is German, and
8052 since most of the internal messages are held in English the English
8053 version is usable too.</para>
8056 <sect2 id="translations-languages.character-set"
8057 xreflabel="Character set">
8058 <title>Character set</title>
8060 <para>All files included in a language pack must use UTF-8 as their
8064 <sect2 id="translations-languages.file-structure"
8065 xreflabel="File structure">
8066 <title>File structure</title>
8068 <para>The structure of locales in kivitendo is:</para>
8070 <programlisting>kivitendo/locale/<langcode>/</programlisting>
8072 <para>where <langcode> stands for an abbreviation of the
8073 language package. The builtin packages use two letter <ulink
8074 url="http://en.wikipedia.org/wiki/ISO_639-1">ISO 639-1</ulink> codes,
8075 but the actual name is not relevant for the program and can easily be
8077 url="http://en.wikipedia.org/wiki/IETF_language_tag">IETF language
8078 tags</ulink> (i.e. "en_GB"). In fact the original language packages
8079 from SQL Ledger are named in this way.</para>
8081 <para>In such a language directory the following files are
8086 <term>LANGUAGE</term>
8089 <para>This file is mandatory.</para>
8091 <para>The <filename>LANGUAGE</filename> file contains the self
8092 descripted name of the language. It should contain a native
8093 representation first, and in parenthesis an english translation
8094 after that. Example:</para>
8096 <programlisting>Deutsch (German)</programlisting>
8104 <para>This file is mandatory.</para>
8106 <para>The central translation file. It is essentially an inline
8107 Perl script autogenerated by <command>locales.pl</command>. To
8108 generate it, generate the directory and the two files mentioned
8109 above, and execute the following command:</para>
8111 <programlisting>scripts/locales.pl <langcode></programlisting>
8113 <para>Otherwise you can simply copy one of the other languages.
8114 You will be told how many are missing like this:</para>
8116 <programlisting>$ scripts/locales.pl en
8117 English - 0.6% - 2015/2028 missing</programlisting>
8119 <para>A file named "<filename>missing</filename>" will be
8120 generated and can be edited. You can also edit the
8121 "<filename>all</filename>" file directly. Edit everything you
8122 like to fit the target language and execute
8123 <command>locales.pl</command> again. See how the missing words
8129 <term>Num2text</term>
8132 <para>Legacy code from SQL Ledger. It provides a means for
8133 numbers to be converted into natural language, like
8134 <literal>1523 => one thousand five hundred twenty
8135 three</literal>. If you want to provide it, it must be inlinable
8136 Perl code which provides a <function>num2text</function> sub. If
8137 an <function>init</function> sub exists it will be executed
8140 <para>Only used in the check and receipt printing module.</para>
8145 <term>special_chars</term>
8148 <para>kivitendo comes with a lot of interfaces to different
8149 formats, some of which are rather picky with their accepted
8150 charset. The <filename>special_chars</filename> file contains a
8151 listing of chars not suited for different file format and
8152 provides substitutions. It is written in "Simple Ini" style,
8153 containing a block for every file format.</para>
8155 <para>First entry should be the order of substitution for
8156 entries as a whitespace separated list. All entries are
8157 interpolated, so <literal>\n</literal>, <literal>\x20</literal>
8158 and <literal>\\</literal> all work.</para>
8160 <para>After that every entry is a special char that should be
8161 translated when writing text into such a file.</para>
8163 <para>Example:</para>
8165 <programlisting>[Template/XML]
8166 order=& < > \n
8170 \n=<br></programlisting>
8172 <para>Note the importance of the order in this example.
8173 Substituting < and > befor & would lead to $gt; become
8176 <para>For a list of valid formats, see the German
8177 <filename>special_chars</filename> entry. As of this writing the
8178 following are recognized:</para>
8180 <programlisting>HTML
8185 Template/OpenDocument
8186 filenames</programlisting>
8188 <para>The last of which is very machine dependant. Remember that
8189 a lot of characters are forbidden by some filesystems, for
8190 example MS Windows doesn't like ':' in its files where Linux
8191 doesn't mind that. If you want the files created with your
8192 language pack to be portable, find all chars that could cause
8198 <term>missing</term>
8201 <para>This file is not a part of the language package
8204 <para>This is a file generated by
8205 <command>scripts/locales.pl</command> while processing your
8206 locales. It's only to have the missing entries singled out and
8207 does not belong to a language package.</para>
8215 <para>This file is not a part of the language package
8218 <para>Another file generated by
8219 <command>scripts/locales.pl</command>. If for any reason a
8220 translation does not appear anymore and can be deleted, it gets
8221 moved here. The last 50 or so entries deleted are saved here in
8222 case you made a typo, so that you don't have to translate
8223 everything again. If a tranlsation is missing, the lost file is
8224 checked first. If you maintain a language package, you might
8225 want to keep this safe somewhere.</para>
8230 <term>more/all</term>
8233 <para>This subdir and file is not a part of the language package
8236 <para>If the directory more exists and contains a file called
8237 all it will be parsed in addition to the mandatory all (see
8238 above). The file is useful if you want to change some
8239 translations for the current installation without conflicting
8240 further upgrades. The file is not autogenerated and has the same
8241 format as the all, but needs another key (more_texts). See the
8242 german translation for an example or copy the following code:
8245 # -*- coding: utf-8; -*-
8250 # These are additional texts for custom translations.
8251 # The format is the same as for the normal file all, only
8252 # with another key (more_texts instead of texts).
8253 # The file has the form of 'english text' => 'foreign text',
8255 $self->{more_texts} = {
8257 'Ship via' => 'Terms of delivery',
8258 'Shipping Point' => 'Delivery time',
8260 </programlisting></para>
8267 <sect1 id="devel.testsuite">
8268 <title>Die kivitendo-Test-Suite</title>
8270 <sect2 id="devel.testsuite.intro">
8271 <title>Einführung</title>
8273 <para>kivitendo enthält eine Suite für automatisierte Tests. Sie
8274 basiert auf dem Standard-Perl-Modul
8275 <literal>Test::More</literal>.</para>
8277 <para>Die grundlegenden Fakten sind:</para>
8281 <para>Alle Tests liegen im Unterverzeichnis
8282 <filename>t/</filename>.</para>
8286 <para>Ein Script (bzw. ein Test) in <filename>t/</filename>
8287 enthält einen oder mehrere Testfälle.</para>
8291 <para>Alle Dateinamen von Tests enden auf <literal>.t</literal>.
8292 Es sind selbstständig ausführbare Perl-Scripte.</para>
8296 <para>Die Test-Suite besteht aus der Gesamtheit aller Tests,
8297 sprich aller Scripte in <filename>t/</filename>, deren Dateiname
8298 auf <literal>.t</literal> endet.</para>
8303 <sect2 id="devel.testsuite.prerequisites">
8304 <title>Voraussetzungen</title>
8306 <para>Für die Ausführung werden neben den für kivitendo eh schon
8307 benötigten Module noch weitere Perl-Module benötigt. Diese
8312 <para><literal>Test::Deep</literal> (Debian-Paketname:
8313 <literal>libtest-deep-perl</literal>; Fedora:
8314 <literal>perl-Test-Deep</literal>; openSUSE:
8315 <literal>perl-Test-Deep</literal>)</para>
8319 <para><literal>Test::Exception</literal> (Debian-Paketname:
8320 <literal>libtest-exception-perl</literal>; Fedora:
8321 <literal>perl-Test-Exception</literal>; openSUSE:
8322 <literal>perl-Test-Exception</literal>)</para>
8326 <para><literal>Test::Output</literal> (Debian-Paketname:
8327 <literal>libtest-output-perl</literal>; Fedora:
8328 <literal>perl-Test-Output</literal>; openSUSE:
8329 <literal>perl-Test-Output</literal>)</para>
8333 <para><literal>Test::Harness</literal> 3.0.0 oder höher. Dieses
8334 Modul ist ab Perl 5.10.1 Bestandteil der Perl-Distribution und
8335 kann für frühere Versionen aus dem <ulink
8336 url="http://www.cpan.org">CPAN</ulink> bezogen werden.</para>
8340 <para><literal>LWP::Simple</literal> aus dem Paket
8341 <literal>libwww-perl</literal> (Debian-Panetname:
8342 <literal>libwww-perl</literal>; Fedora:
8343 <literal>perl-libwww-perl</literal>; openSUSE:
8344 <literal>perl-libwww-perl</literal>)</para>
8348 <para><literal>URI::Find</literal> (Debian-Panetname:
8349 <literal>liburi-find-perl</literal>; Fedora:
8350 <literal>perl-URI-Find</literal>; openSUSE:
8351 <literal>perl-URI-Find</literal>)</para>
8355 <para><literal>Sys::CPU</literal> (Debian-Panetname:
8356 <literal>libsys-cpu-perl</literal>; Fedora und openSUSE: nicht
8361 <para><literal>Thread::Pool::Simple</literal> (Debian-Panetname:
8362 <literal>libthread-pool-simple-perl</literal>; Fedora und
8363 openSUSE: nicht vorhanden)</para>
8367 <para>Weitere Voraussetzung ist, dass die Testsuite ihre eigene
8368 Datenbank anlegen kann, um Produktivdaten nicht zu gefährden. Dazu
8369 müssen in der Konfigurationsdatei im Abschnit
8370 <literal>testing/database</literal> Datenbankverbindungsparameter
8371 angegeben werden. Der hier angegebene Benutzer muss weiterhin das
8372 Recht haben, Datenbanken anzulegen und zu löschen.</para>
8374 <para>Der so angegebene Benutzer muss nicht zwingend über
8375 Super-User-Rechte verfügen. Allerdings gibt es einige
8376 Datenbank-Upgrades, die genau diese Rechte benötigen. Für den Fall
8377 kann man in diesem Konfigurationsabschnitt einen weiteren
8378 Benutzeraccount angeben, der dann über Super-User-Rechte verfügt, und
8379 mit dem die betroffenen Upgrades durchgeführt werden. In der
8380 Beispiel-Konfigurationsdatei finden Sie die benötigten
8384 <sect2 id="devel.testsuite.execution">
8385 <title>Existierende Tests ausführen</title>
8387 <para>Es gibt mehrere Möglichkeiten zum Ausführen der Tests: entweder,
8388 man lässt alle Tests auf einmal ausführen, oder man führt gezielt
8389 einzelne Scripte aus. Für beide Fälle gibt es das Helferscript
8390 <filename>t/test.pl</filename>.</para>
8392 <para>Will man die komplette Test-Suite ausführen, so muss man einfach
8393 nur <filename>t/test.pl</filename> ohne weitere Parameter aus dem
8394 kivitendo-Basisverzeichnis heraus ausführen.</para>
8396 <para>Um einzelne Test-Scripte auszuführen, übergibt man deren Namen
8397 an <filename>t/test.pl</filename>. Beispielsweise:</para>
8399 <programlisting>t/test.pl t/form/format_amount.t t/background_job/known_jobs.t</programlisting>
8402 <sect2 id="devel.testsuite.meaning_of_scripts">
8403 <title>Bedeutung der verschiedenen Test-Scripte</title>
8405 <para>Die Test-Suite umfasst Tests sowohl für Funktionen als auch für
8406 Programmierstil. Einige besonders zu erwähnende, weil auch während der
8407 Entwicklung nützliche Tests sind:</para>
8411 <para><filename>t/001compile.t</filename> -- compiliert alle
8412 Quelldateien und bricht bei Fehlern sofort ab</para>
8416 <para><filename>t/002goodperl.t</filename> -- überprüft alle
8417 Perl-Dateien auf Anwesenheit von '<literal>use
8418 strict</literal>'-Anweisungen</para>
8422 <para><filename>t/003safesys.t</filename> -- überprüft Aufrufe von
8423 <function>system()</function> und <function>exec()</function> auf
8428 <para><filename>t/005no_tabs.t</filename> -- überprüft, ob Dateien
8429 Tab-Zeichen enthalten</para>
8433 <para><filename>t/006spelling.t</filename> -- sucht nach häufigen
8434 Rechtschreibfehlern</para>
8438 <para><filename>t/011pod.t</filename> -- überprüft die Syntax von
8439 Dokumentation im POD-Format auf Gültigkeit</para>
8443 <para>Weitere Test-Scripte überprüfen primär die Funktionsweise
8444 einzelner Funktionen und Module.</para>
8447 <sect2 id="devel.testsuite.create_new">
8448 <title>Neue Test-Scripte erstellen</title>
8450 <para>Es wird sehr gern gesehen, wenn neue Funktionalität auch gleich
8451 mit einem Test-Script abgesichert wird. Auch bestehende Funktion darf
8452 und soll ausdrücklich nachträglich mit Test-Scripten abgesichert
8455 <sect3 id="devel.testsuite.ideas_for_non_function_tests">
8456 <title>Ideen für neue Test-Scripte, die keine konkreten Funktionen
8459 <para>Ideen, die abgesehen von Funktionen noch nicht umgesetzt
8464 <para>Überprüfung auf fehlende symbolische Links</para>
8468 <para>Suche nach Nicht-ASCII-Zeichen in Perl-Code-Dateien (mit
8469 gewissen Einschränkungen wie das Erlauben von deutschen
8474 <para>Test auf DOS-Zeilenenden (\r\n anstelle von nur \n)</para>
8478 <para>Überprüfung auf Leerzeichen am Ende von Zeilen</para>
8482 <para>Test, ob alle zu übersetzenden Strings in
8483 <filename>locale/de/all</filename> vorhanden sind</para>
8487 <para>Test, ob alle Webseiten-Templates in
8488 <filename>templates/webpages</filename> mit vom Perl-Modul
8489 <literal>Template</literal> compiliert werden können</para>
8494 <sect3 id="devel.testsuite.directory_and_test_names">
8495 <title>Konvention für Verzeichnis- und Dateinamen</title>
8497 <para>Es gibt momentan eine wenige Richtlinien, wie Test-Scripte zu
8498 benennen sind. Bitte die folgenden Punkte als Richtlinie betrachten
8499 und ihnen soweit es geht folgen:</para>
8503 <para>Die Dateiendung muss <filename>.t</filename>
8508 <para>Namen sind englisch, komplett klein geschrieben und
8509 einzelne Wörter mit Unterstrichten getrennt (beispielsweise
8510 <filename>bad_function_params.t</filename>).</para>
8514 <para>Unterverzeichnisse sollten grob nach dem Themenbereich
8515 benannt sein, mit dem sich die Scripte darin befassen
8516 (beispielsweise <filename>background_jobs</filename> für Tests
8517 rund um Hintergrund-Jobs).</para>
8521 <para>Test-Scripte sollten einen überschaubaren Bereich von
8522 Funktionalität testen, der logisch zusammenhängend ist (z.B. nur
8523 Tests für eine einzelne Funktion in einem Modul). Lieber mehrere
8524 Test-Scripte schreiben.</para>
8529 <sect3 id="devel.testsuite.minimal_example">
8530 <title>Minimales Skelett für eigene Scripte</title>
8532 <para>Der folgenden Programmcode enthält das kleinstmögliche
8533 Testscript und kann als Ausgangspunkt für eigene Tests verwendet
8536 <programlisting>use Test::More tests => 0;
8540 use Support::TestSetup;
8542 Support::TestSetup::login();</programlisting>
8544 <para>Wird eine vollständig initialisierte kivitendo-Umgebung
8545 benötigt (Stichwort: alle globalen Variablen wie
8546 <varname>$::auth</varname>, <varname>$::form</varname> oder
8547 <varname>$::lxdebug</varname>), so muss in der Konfigurationsdatei
8548 <filename>config/kivitendo.conf</filename> im Abschnitt
8549 <literal>testing.login</literal> ein gültiger Login-Name eingetragen
8550 sein. Dieser wird für die Datenbankverbindung benötigt.</para>
8552 <para>Wir keine vollständig initialisierte Umgebung benötigt, so
8553 kann die letzte Zeile <programlisting>Support::TestSetup::login();</programlisting>
8554 weggelassen werden, was die Ausführungszeit des Scripts leicht
8560 <sect1 id="devel.style-guide">
8561 <title>Stil-Richtlinien</title>
8563 <para>Die folgenden Regeln haben das Ziel, den Code möglichst gut les-
8564 und wartbar zu machen. Dazu gehört zum Einen, dass der Code einheitlich
8565 eingerückt ist, aber auch, dass Mehrdeutigkeit so weit es geht vermieden
8566 wird (Stichworte "Klammern" oder "Hash-Keys").</para>
8568 <para>Diese Regeln sind keine Schikane sondern erleichtern allen das
8571 <para>Jeder, der einen Patch schickt, sollte seinen Code vorher
8572 überprüfen. Einige der Regeln lassen sich automatisch überprüfen, andere
8577 <para>Es werden keine echten Tabs sondern Leerzeichen
8582 <para>Die Einrückung beträgt zwei Leerzeichen. Beispiel:</para>
8584 <programlisting>foreach my $row (@data) {
8586 # do something with $row
8590 $row->{modules} = MODULE->retrieve(
8591 id => $row->{id},
8592 date => $use_now ? localtime() : $row->{time},
8596 $report->add($row);
8601 <para>Öffnende geschweifte Klammern befinden sich auf der gleichen
8602 Zeile wie der letzte Befehl. Beispiele:</para>
8604 <programlisting>sub debug {
8610 <programlisting>if ($form->{item_rows} > 0) {
8616 <para>Schließende geschweifte Klammern sind so weit eingerückt wie
8617 der Befehl / die öffnende schließende Klammer, die den Block
8618 gestartet hat, und nicht auf der Ebene des Inhalts. Die gleichen
8619 Beispiele wie bei 3. gelten.</para>
8623 <para>Die Wörter "<function>else</function>",
8624 "<function>elsif</function>", "<function>while</function>" befinden
8625 sich auf der gleichen Zeile wie schließende geschweifte Klammern.
8628 <programlisting>if ($form->{sum} > 1000) {
8630 } elsif ($form->{sum} > 0) {
8638 } until ($a > 0);</programlisting>
8642 <para>Parameter von Funktionsaufrufen müssen mit runden Klammern
8643 versehen werden. Davon nicht betroffen sind interne Perl-Funktionen,
8644 und grep-ähnliche Operatoren. Beispiel:</para>
8646 <programlisting>$main::lxdebug->message("Could not find file.");
8647 %options = map { $_ => 1 } grep { !/^#/ } @config_file;</programlisting>
8651 <para>Verschiedene Klammern, Ihre Ausdrücke und Leerzeichen:</para>
8653 <para>Generell gilt: Hashkeys und Arrayindices sollten nicht durch
8654 Leerzeichen abgesetzt werden. Logische Klammerungen ebensowenig,
8655 Blöcke schon. Beispiel:</para>
8657 <programlisting>if (($form->{debug} == 1) && ($form->{sum} - 100 < 0)) {
8662 $form->{sum} += $form->{"row_$i"};
8663 $form->{ $form->{index} } += 1;
8665 map { $form->{sum} += $form->{"row_$_"} } 1..$rowcount;</programlisting>
8669 <para>Mehrzeilige Befehle</para>
8673 <para>Werden die Parameter eines Funktionsaufrufes auf mehrere
8674 Zeilen aufgeteilt, so sollten diese bis zu der Spalte eingerückt
8675 werden, in der die ersten Funktionsparameter in der ersten Zeile
8676 stehen. Beispiel:</para>
8678 <programlisting>$sth = $dbh->prepare("SELECT * FROM some_table WHERE col = ?",
8679 $form->{some_col_value});</programlisting>
8683 <para>Ein Spezialfall ist der ternäre Operator "?:", der am
8684 besten in einer übersichtlichen Tabellenstruktur organisiert
8685 wird. Beispiel:</para>
8687 <programlisting>my $rowcount = $form->{"row_$i"} ? $i
8688 : $form->{oldcount} ? $form->{oldcount} + 1
8689 : $form->{rowcount} - $form->{rowbase};</programlisting>
8695 <para>Kommentare</para>
8699 <para>Kommentare, die alleine in einer Zeile stehen, sollten
8700 soweit wie der Code eingerückt sein.</para>
8704 <para>Seitliche hängende Kommentare sollten einheitlich
8705 formatiert werden.</para>
8709 <para>Sämtliche Kommentare und Sonstiges im Quellcode ist bitte
8710 auf Englisch zu verfassen. So wie ich keine Lust habe,
8711 französischen Quelltext zu lesen, sollte auch der kivitendo
8712 Quelltext für nicht-Deutschsprachige lesbar sein.
8715 <programlisting>my $found = 0;
8723 $i = 0 # initialize $i
8725 $i *= $const; # do something crazy
8726 $i = $n; # recover $i</programlisting>
8732 <para>Hashkeys sollten nur in Anführungszeichen stehen, wenn die
8733 Interpolation gewünscht ist. Beispiel:</para>
8735 <programlisting>$form->{sum} = 0;
8736 $form->{"row_$i"} = $form->{"row_$i"} - 5;
8737 $some_hash{42} = 54;</programlisting>
8741 <para>Die maximale Zeilenlänge ist nicht beschränkt. Zeilenlängen
8742 unterhalb von 79 Zeichen helfen unter bestimmten Bedingungen, aber
8743 wenn die Lesbarkeit unter kurzen Zeilen leidet (wie zum Biespiel in
8744 grossen Tabellen), dann ist Lesbarkeit vorzuziehen.</para>
8746 <para>Als Beispiel sei die Funktion
8747 <function>print_options</function> aus
8748 <filename>bin/mozilla/io.pl</filename> angeführt.</para>
8752 <para>Trailing Whitespace, d.h. Leerzeichen am Ende von Zeilen sind
8753 unerwünscht. Sie führen zu unnötigen Whitespaceänderungen, die diffs
8756 <para>Emacs und vim haben beide recht einfache Methoden zur
8757 Entfernung von trailing whitespace. Emacs kennt das Kommande
8758 <command>nuke-trailing-whitespace</command>, vim macht das gleiche
8759 manuell über <literal>:%s/\s\+$//e</literal> Mit <literal>:au
8760 BufWritePre * :%s/\s\+$//e</literal> wird das an Speichern
8765 <para>Es wird kein <command>perltidy</command> verwendet.</para>
8767 <para>In der Vergangenheit wurde versucht,
8768 <command>perltidy</command> zu verwenden, um einen einheitlichen
8769 Stil zu erlangen. Es hat sich aber gezeigt, dass
8770 <command>perltidy</command>s sehr eigenwilliges Verhalten, was
8771 Zeilenumbrüche angeht, oftmals gut formatierten Code zerstört. Für
8772 den Interessierten sind hier die
8773 <command>perltidy</command>-Optionen, die grob den beschriebenen
8774 Richtlinien entsprechen:</para>
8776 <programlisting>-syn -i=2 -nt -pt=2 -sbt=2 -ci=2 -ibc -hsc -noll -nsts -nsfs -asc -dsm
8777 -aws -bbc -bbs -bbb -mbl=1 -nsob -ce -nbl -nsbl -cti=0 -bbt=0 -bar -l=79
8778 -lp -vt=1 -vtc=1</programlisting>
8782 <para><varname>STDERR</varname> ist tabu. Unkonditionale
8783 Debugmeldungen auch.</para>
8785 <para>kivitendo bietet mit dem Modul <classname>LXDebug</classname>
8786 einen brauchbaren Trace-/Debug-Mechanismus. Es gibt also keinen
8787 Grund, nach <varname>STDERR</varname> zu schreiben.</para>
8789 <para>Die <classname>LXDebug</classname>-Methode
8790 "<function>message</function>" nimmt als ersten Paramter außerdem
8791 eine Flagmaske, für die die Meldung angezeigt wird, wobei "0" immer
8792 angezeigt wird. Solche Meldungen sollten nicht eingecheckt werden
8793 und werden in den meisten Fällen auch vom Repository
8794 zurückgewiesen.</para>
8798 <para>Alle neuen Module müssen use strict verwenden.</para>
8800 <para><varname>$form</varname>, <varname>$auth</varname>,
8801 <varname>$locale</varname>, <varname>$lxdebug</varname> und
8802 <varname>%myconfig</varname> werden derzeit aus dem main package
8803 importiert (siehe <xref linkend="devel.globals"/>. Alle anderen
8804 Konstrukte sollten lexikalisch lokal gehalten werden.</para>
8809 <sect1 id="devel.build-doc" xreflabel="Dokumentation erstellen">
8810 <title>Dokumentation erstellen</title>
8812 <sect2 id="devel.build-doc.introduction">
8813 <title>Einführung</title>
8815 <para>Diese Dokumentation ist in <productname>DocBook</productname>
8816 XML geschrieben. Zum Bearbeiten reicht grundsätzlich ein Text-Editor.
8817 Mehr Komfort bekommt man, wenn man einen dedizierten XML-fähigen
8818 Editor nutzt, der spezielle Unterstützung für
8819 <productname>DocBook</productname> mitbringt. Wir empfehlen dafür den
8820 <ulink url="http://www.xmlmind.com/xmleditor/">XMLmind XML
8821 Editor</ulink>, der bei nicht kommerzieller Nutzung kostenlos
8825 <sect2 id="devel.build-doc.required-software">
8826 <title>Benötigte Software</title>
8828 <para>Bei <productname>DocBook</productname> ist Prinzip, dass
8829 ausschließlich die XML-Quelldatei bearbeitet wird. Aus dieser werden
8830 dann mit entsprechenden Stylesheets andere Formate wie PDF oder HTML
8831 erzeugt. Bei kivitendo übernimmt diese Aufgabe das Shell-Script
8832 <command>scripts/build_doc.sh</command>.</para>
8834 <para>Das Script benötigt zur Konvertierung verschiedene
8835 Softwarekomponenten, die im normalen kivitendo-Betrieb nicht benötigt
8841 url="http://www.oracle.com/technetwork/java/index.html">Java</ulink>
8842 in einer halbwegs aktuellen Version</para>
8846 <para>Das Java-Build-System <ulink
8847 url="http://ant.apache.org/">Apache Ant</ulink></para>
8851 <para>Das Dokumentations-System Dobudish für
8852 <productname>DocBook</productname> 4.5, eine Zusammenstellung
8853 diverser Stylesheets und Grafiken zur Konvertierung von
8854 <productname>DocBook</productname> XML in andere Formate. Das
8855 Paket, das benötigt wird, ist zum Zeitpunkt der
8856 Dokumentationserstellung
8857 <filename>dobudish-nojre-1.1.4.zip</filename>, aus auf <ulink
8858 url="http://code.google.com/p/dobudish/downloads/list">code.google.com</ulink>
8863 <para>Apache Ant sowie ein dazu passendes Java Runtime Environment
8864 sind auf allen gängigen Plattformen verfügbar. Beispiel für
8865 Debian/Ubuntu:</para>
8867 <programlisting>apt-get install ant openjdk-7-jre</programlisting>
8869 <para>Nach dem Download von Dobudish muss Dobudish im Unterverzeichnis
8870 <filename>doc/build</filename> entpackt werden. Beispiel unter der
8871 Annahme, das <productname>Dobudish</productname> in
8872 <filename>$HOME/Downloads</filename> heruntergeladen wurde:</para>
8874 <programlisting>cd doc/build
8875 unzip $HOME/Downloads/dobudish-nojre-1.1.4.zip</programlisting>
8878 <sect2 id="devel.build-doc.build">
8879 <title>PDFs und HTML-Seiten erstellen</title>
8881 <para>Die eigentliche Konvertierung erfolgt nach Installation der
8882 benötigten Software mit einem einfachen Aufruf direkt aus dem
8883 kivitendo-Installationsverzeichnis heraus:</para>
8885 <programlisting>./scripts/build_doc.sh</programlisting>
8888 <sect2 id="devel.build-doc.repository">
8889 <title>Einchecken in das Git-Repository</title>
8891 <para>Sowohl die XML-Datei als auch die erzeugten PDF- und
8892 HTML-Dateien sind Bestandteil des Git-Repositories. Daraus folgt, dass
8893 nach Änderungen am XML die PDF- und HTML-Dokumente ebenfalls gebaut
8894 und alles zusammen in einem Commit eingecheckt werden sollten.</para>
8896 <para>Die "<filename>dobudish</filename>"-Verzeichnisse bzw.
8897 symbolischen Links gehören hingegen nicht in das Repository.</para>