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.0: Installation, Konfiguration, Entwicklung</title>
7 <chapter id="Aktuelle-Hinweise">
8 <title>Aktuelle Hinweise</title>
10 <para>Aktuelle Installations- und Konfigurationshinweise gibt es:</para>
14 <para>im Community-Forum: <ulink
15 url="https://forum.kivitendo.de:32443">https://forum.kivitendo.de:32443</ulink></para>
19 <para>im Kunden-Forum: <ulink
20 url="http://redmine.kivitendo-premium.de/projects/forum/boards/">http://redmine.kivitendo-premium.de/projects/forum/boards/</ulink></para>
24 <para>in der doc/UPGRADE Datei im doc-Verzeichnis der
29 <para>Im Schulungs- und Dienstleistungsangebot der entsprechenden
30 kivitendo-Partner: <ulink
31 url="http://www.kivitendo.de/partner.html">http://www.kivitendo.de/partner.html</ulink></para>
37 <title>Installation und Grundkonfiguration</title>
39 <sect1 id="Installation-Übersicht">
40 <title>Übersicht</title>
42 <para>Die Installation von kivitendo umfasst mehrere Schritte. Die
43 folgende Liste kann sowohl für Neulinge als auch für alte Hasen als
44 Übersicht und Stichpunktliste zum Abhaken dienen, um eine Version mit
45 minimalen Features möglichst schnell zum Laufen zu kriegen.</para>
49 <para><emphasis>Voraussetzungen überprüfen</emphasis>: kivitendo
50 benötigt gewisse Ressourcen und benutzt weitere Programme. Das
51 Kapitel "<xref linkend="Benötigte-Software-und-Pakete"/>" erläutert
52 diese. Auch die Liste der benötigten Perl-Module befindet sich
57 <para><emphasis>Installation von kivitendo</emphasis>: Diese umfasst
58 die "<xref linkend="Manuelle-Installation-des-Programmpaketes"/>"
59 sowie grundlegende Einstellungen, die der "<xref
60 linkend="config.config-file"/>" erläutert.</para>
64 <para><emphasis>Konfiguration externer Programme</emphasis>: hierzu
65 gehören die Datenbank ("<xref
66 linkend="Anpassung-der-PostgreSQL-Konfiguration"/>") und der
67 Webserver ("<xref linkend="Apache-Konfiguration"/>").</para>
71 <para><emphasis>Benutzerinformationen speichern können</emphasis>:
72 man benötigt mindestens eine Datenbank, in der Informationen zur
73 Authentifizierung sowie die Nutzdaten gespeichert werden. Wie man
74 das als Administrator macht, verrät "<xref
75 linkend="Benutzerauthentifizierung-und-Administratorpasswort"/>".</para>
79 <para><emphasis>Benutzer, Gruppen und Datenbanken
80 anlegen</emphasis>: wie dies alles zusammenspielt erläutert "<xref
81 linkend="Benutzer--und-Gruppenverwaltung"/>".</para>
85 <para><emphasis>Los geht's</emphasis>: alles soweit erledigt? Dann
86 kann es losgehen: "<xref linkend="kivitendo-ERP-verwenden"/>"</para>
90 <para>Alle weiteren Unterkapitel in diesem Kapitel sind ebenfalls
91 wichtig und sollten vor einer ernsthaften Inbetriebnahme gelesen
95 <sect1 id="Benötigte-Software-und-Pakete">
96 <title>Benötigte Software und Pakete</title>
98 <sect2 id="Betriebssystem">
99 <title>Betriebssystem</title>
101 <para>kivitendo ist für Linux konzipiert, und sollte auf jedem
102 unixoiden Betriebssystem zum Laufen zu kriegen sein. Getestet ist
103 diese Version im speziellen auf Debian und Ubuntu, grundsätzlich wurde
104 bei der Auswahl der Pakete aber darauf Rücksicht genommen, dass es
105 ohne große Probleme auf den derzeit aktuellen verbreiteten
106 Distributionen läuft.</para>
108 <para>Anfang 2016 sind das folgende Systeme, von denen bekannt ist,
109 dass kivitendo auf ihnen läuft:</para>
117 <para>7.0 "Wheezy"</para>
121 <para>8.0 "Jessie"</para>
127 <para>Ubuntu 12.04 LTS "Precise Pangolin", 14.04 "Trusty Tahr"
128 LTS, 15.10 "Wily Werewolf" und 16.04 "Xenial Xerus" LTS
133 <para>openSUSE LEAP 42.1</para>
137 <para>Fedora 22</para>
142 <sect2 id="Pakete" xreflabel="Pakete">
143 <title>Benötigte Perl-Pakete installieren</title>
145 <para>Zum Betrieb von kivitendo werden zwingend ein Webserver (meist
146 Apache) und ein Datenbankserver (PostgreSQL) in einer aktuellen
147 Version (s.a. Liste der unterstützten Betriebssysteme)
150 <para>Zusätzlich benötigt kivitendo einige Perl-Pakete, die nicht
151 Bestandteil einer Standard-Perl-Installation sind. Um zu überprüfen,
152 ob die erforderlichen Pakete installiert und aktuell genug sind, wird
153 ein Script mitgeliefert, das wie folgt aufgerufen wird:</para>
155 <programlisting>./scripts/installation_check.pl</programlisting>
157 <para>Die vollständige Liste der benötigten Perl-Module lautet:</para>
161 <para><literal>parent</literal> (nur bei Perl vor 5.10.1)</para>
165 <para><literal>Archive::Zip</literal></para>
169 <para><literal>Algorithm::CheckDigits</literal></para>
173 <para><literal>CGI</literal></para>
177 <para><literal>Clone</literal></para>
181 <para><literal>Config::Std</literal></para>
185 <para><literal>DateTime</literal></para>
189 <para><literal>DateTime::Format::Strptime</literal></para>
193 <para><literal>DBI</literal></para>
197 <para><literal>DBD::Pg</literal></para>
201 <para><literal>Email::Address</literal></para>
205 <para><literal>Email::MIME</literal></para>
209 <para><literal>FCGI</literal> (nicht Versionen 0.68 bis 0.71
210 inklusive; siehe <xref
211 linkend="Apache-Konfiguration.FCGI.WebserverUndPlugin"/>)</para>
215 <para><literal>File::Copy::Recursive</literal></para>
219 <para><literal>File::MimeInfo</literal></para>
223 <para><literal>GD</literal></para>
227 <para><literal>HTML::Parser</literal></para>
231 <para><literal>HTML::Restrict</literal></para>
235 <para><literal>Image::Info</literal></para>
239 <para><literal>JSON</literal></para>
243 <para><literal>List::MoreUtils</literal></para>
247 <para><literal>List::UtilsBy</literal></para>
251 <para>LWP::Authen::Digest</para>
255 <para>LWP::UserAgent</para>
259 <para><literal>Net::SMTP::SSL</literal> (optional, bei
260 E-Mail-Versand über SSL; siehe Abschnitt "<xref
261 linkend="config.sending-email.smtp"/>")</para>
265 <para><literal>Net::SSLGlue</literal> (optional, bei
266 E-Mail-Versand über TLS; siehe Abschnitt "<xref
267 linkend="config.sending-email.smtp"/>")</para>
271 <para><literal>Params::Validate</literal></para>
275 <para><literal>PBKDF2::Tiny</literal></para>
279 <para><literal>PDF::API2</literal></para>
283 <para><literal>Rose::Object</literal></para>
287 <para><literal>Rose::DB</literal></para>
291 <para><literal>Rose::DB::Object</literal> Version 0.788 oder
296 <para><literal>String::ShellQuote</literal></para>
300 <para><literal>Sort::Naturally</literal></para>
304 <para><literal>Template</literal></para>
308 <para><literal>Text::CSV_XS</literal></para>
312 <para><literal>Text::Iconv</literal></para>
316 <para><literal>Text::Unidecode</literal></para>
320 <para><literal>URI</literal></para>
324 <para><literal>XML::Writer</literal></para>
328 <para><literal>YAML</literal></para>
332 <para>Seit Version größer v3.5.0 sind die folgenden Pakete
333 hinzugekommen: <literal>Text::Unidecode, LWP::Authen::Digest,
334 LWP::UserAgent</literal></para>
336 <para>Seit Version v3.4.0 sind die folgenden Pakete hinzugekommen:
337 <literal>Algorithm::CheckDigits</literal><literal>PBKDF2::Tiny</literal></para>
339 <para>Seit Version v3.2.0 sind die folgenden Pakete hinzugekommen:
340 <literal>GD</literal>, <literal>HTML::Restrict</literal>,
341 <literal>Image::Info</literal></para>
343 <para>Seit v3.0.0 sind die folgenden Pakete hinzugekommen:
344 <literal>File::Copy::Recursive</literal>.</para>
346 <para>Seit v2.7.0 sind die folgenden Pakete hinzugekommen:
347 <literal>Email::MIME</literal>, <literal>Net::SMTP::SSL</literal>,
348 <literal>Net::SSLGlue</literal>.</para>
350 <para>Gegenüber Version 2.6.0 sind zu dieser Liste 2 Pakete
351 hinzugekommen, <literal>URI</literal> und
352 <literal>XML::Writer</literal> sind notwendig. Ohne startet kivitendo
355 <para>Gegenüber Version 2.6.1 sind <literal>parent</literal>,
356 <literal>DateTime</literal>, <literal>Rose::Object</literal>,
357 <literal>Rose::DB</literal> und <literal>Rose::DB::Object</literal>
358 neu hinzugekommen. <literal>IO::Wrap</literal> wurde entfernt.</para>
360 <para>Gegenüber Version 2.6.3 ist <literal>JSON</literal> neu
361 hinzugekommen.</para>
363 <para><literal>Email::Address</literal> und
364 <literal>List::MoreUtils</literal> sind schon länger feste
365 Abhängigkeiten, wurden aber bisher mit kivitendo mitgeliefert. Beide
366 sind auch in 2.6.1 weiterhin mit ausgeliefert, wurden in einer
367 zukünftigen Version aber aus dem Paket entfernt werden. Es wird
368 empfohlen diese Module zusammen mit den anderen als Bibliotheken zu
372 <title>Debian und Ubuntu</title>
374 <para>Für Debian und Ubuntu stehen die meisten der benötigten
375 Perl-Pakete als Debian-Pakete zur Verfügung. Sie können mit
376 folgendem Befehl installiert werden:</para>
378 <programlisting>apt install apache2 libarchive-zip-perl libclone-perl \
379 libconfig-std-perl libdatetime-perl libdbd-pg-perl libdbi-perl \
380 libemail-address-perl libemail-mime-perl libfcgi-perl libjson-perl \
381 liblist-moreutils-perl libnet-smtp-ssl-perl libnet-sslglue-perl \
382 libparams-validate-perl libpdf-api2-perl librose-db-object-perl \
383 librose-db-perl librose-object-perl libsort-naturally-perl \
384 libstring-shellquote-perl libtemplate-perl libtext-csv-xs-perl \
385 libtext-iconv-perl liburi-perl libxml-writer-perl libyaml-perl \
386 libimage-info-perl libgd-gd2-perl libapache2-mod-fcgid \
387 libfile-copy-recursive-perl postgresql libalgorithm-checkdigits-perl \
388 libcrypt-pbkdf2-perl git libcgi-pm-perl libtext-unidecode-perl libwww-perl
391 <para>Für das Paket HTML::Restrict gibt es kein Debian-Paket, dies
392 muß per CPAN installiert werden. Unter Ubuntu funktioniert das
395 <programlisting>apt-get install build-essential
396 cpan HTML::Restrict</programlisting>
400 <title>Fedora</title>
402 <para>Für Fedora stehen die meisten der benötigten Perl-Pakete als
403 RPM-Pakete zur Verfügung. Sie können mit folgendem Befehl
404 installiert werden:</para>
406 <programlisting>dnf install httpd mod_fcgid perl-Archive-Zip perl-Clone perl-DBD-Pg \
407 perl-DBI perl-DateTime perl-Email-Address perl-Email-MIME perl-FCGI \
408 perl-File-Copy-Recursive perl-JSON perl-List-MoreUtils perl-Net-SMTP-SSL perl-Net-SSLGlue \
409 perl-PDF-API2 perl-Params-Validate perl-Rose-DB perl-Rose-DB-Object \
410 perl-Rose-Object perl-Sort-Naturally perl-String-ShellQuote \
411 perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv perl-URI \
412 perl-XML-Writer perl-YAML perl-parent postgresql-server perl-CPAN \
413 perl-Algorithm-CheckDigits perl-GD perl-Class-XSAccessor perl-Text-Balanced perl-libwww-perl</programlisting>
415 <para>Zusätzlich müssen einige Pakete aus dem CPAN installiert
416 werden. Dazu können Sie die folgenden Befehle nutzen:</para>
418 <programlisting>cpan Config::Std HTML::Restrict</programlisting>
422 <title>openSUSE</title>
424 <para>Für openSUSE stehen die meisten der benötigten Perl-Pakete als
425 RPM-Pakete zur Verfügung. Sie können mit folgendem Befehl
426 installiert werden:</para>
428 <programlisting>zypper install apache2 apache2-mod_fcgid perl-Archive-Zip perl-Clone \
429 perl-Config-Std perl-DBD-Pg perl-DBI perl-DateTime perl-Email-Address \
430 perl-Email-MIME perl-FastCGI perl-File-Copy-Recursive perl-JSON perl-List-MoreUtils \
431 perl-Net-SMTP-SSL perl-Net-SSLGlue perl-PDF-API2 perl-Params-Validate \
432 perl-Sort-Naturally perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv \
433 perl-URI perl-XML-Writer perl-YAML perl-CPAN \
434 perl-Algorithm-CheckDigits perl-GD perl-Class-XSAccessor postgresql-server perl-libwwww-perl</programlisting>
436 <para>Zusätzlich müssen einige Pakete aus dem CPAN installiert
437 werden. Dazu können Sie die folgenden Befehle nutzen:</para>
439 <programlisting>cpan Rose::Db::Object</programlisting>
444 <title>Andere Pakete installieren</title>
446 <para>Seit Version v3.4.0 wird für den Bankimport optional das Paket
447 'aqbanking-tools' benötigt.</para>
449 <para>Debian und Ubuntu: <programlisting>apt install aqbanking-tools
450 </programlisting></para>
452 <para>OpenSuSE: <programlisting>zypper install aqbanking-tools</programlisting></para>
454 <para>Seit Version v3.4.1 wird generell zum Feststellen der
455 Seitenanzahl von PDF_Dokumenten 'pdfinfo' benötigt was im Paket
456 'poppler-utils' enthalten ist.</para>
458 <para>Debian und Ubuntu: <programlisting>apt install poppler-utils
459 </programlisting></para>
461 <para>OpenSuSE: <programlisting>zypper install poppler-tools</programlisting></para>
465 <sect1 id="Manuelle-Installation-des-Programmpaketes"
466 xreflabel="Manuelle Installation des Programmpaketes">
467 <title>Manuelle Installation des Programmpaketes</title>
469 <para>Der aktuelle Stable-Release, bzw. beta Release wird bei github
470 gehostet und kann <ulink
471 url="https://github.com/kivitendo/kivitendo-erp/releases">hier</ulink>
472 heruntergeladen werden.</para>
474 <para>Die kivitendo ERP Installationsdatei
475 (<filename>kivitendo-erp-3.4.1.tgz</filename>) wird im
476 Dokumentenverzeichnis des Webservers (z.B.
477 <filename>/var/www/html/</filename>,
478 <filename>/srv/www/htdocs</filename> oder
479 <filename>/var/www/</filename>) entpackt:</para>
481 <programlisting>cd /var/www
482 tar xvzf kivitendo-erp-3.4.1.tgz</programlisting>
484 <para>Wechseln Sie in das entpackte Verzeichnis:</para>
486 <programlisting>cd kivitendo-erp</programlisting>
488 <para>Alternativ können Sie auch einen Alias in der
489 Webserverkonfiguration benutzen, um auf das tatsächliche
490 Installationsverzeichnis zu verweisen.</para>
492 <para>Bei einer Neuinstallation von Version 3.1.0 oder später muß das
493 WebDAV Verzeichnis derzeit manuell angelegt werden:</para>
495 <programlisting>mkdir webdav</programlisting>
497 <para>Die Verzeichnisse <filename>users</filename>,
498 <filename>spool</filename> und <filename>webdav</filename> müssen für
499 den Benutzer beschreibbar sein, unter dem der Webserver läuft. Die
500 restlichen Dateien müssen für diesen Benutzer lesbar sein. Die Benutzer-
501 und Gruppennamen sind bei verschiedenen Distributionen unterschiedlich
502 (z.B. bei Debian/Ubuntu <constant>www-data</constant>, bei Fedora
503 <constant>apache</constant> oder bei OpenSUSE
504 <constant>wwwrun</constant>).</para>
506 <para>Der folgende Befehl ändert den Besitzer für die oben genannten
507 Verzeichnisse auf einem Debian/Ubuntu-System:</para>
509 <programlisting>chown -R www-data users spool webdav</programlisting>
511 <para>Weiterhin muss der Webserver-Benutzer in den Verzeichnissen
512 <filename>templates</filename> und <filename>users</filename>
513 Unterverzeichnisse für jeden neuen Benutzer anlegen dürfen, der in
514 kivitendo angelegt wird:</para>
516 <programlisting>chown www-data templates users</programlisting>
519 <para>Wir empfehlen eine Installation mittels des Versionsmanagager
520 git. Hierfür muss ein git-Client installiert sein. Damit ist man sehr
521 viel flexibler für zukünftige Upgrades. Installations-Anleitung (bitte
522 die Pfade anpassen) bspw. wie folgt: <programlisting>cd /var/www/
523 git clone https://github.com/kivitendo/kivitendo-erp.git
525 git checkout `git tag -l | egrep -ve "(beta|rc)" | tail -1`</programlisting>
526 Erläuterung: Der Befehl wechselt zur letzten Stable-Version (git tag
527 -l listet alle Tags auf, das egrep schmeisst alle Einträge mit beta
528 oder rc raus und das tail gibt davon den obersten Treffer zurück).
529 Sehr sinnvoll ist es, direkt im Anschluss einen eigenen Branch zu
530 erzeugen, um bspw. seine eigenen Druckvorlagen-Anpassungen damit zu
531 verwalten. Hierfür reicht ein simples <programlisting> git checkout -b meine_eigenen_änderungen</programlisting>
532 nach dem letzten Kommando (weiterführende Informationen <ulink
533 url="http://www-cs-students.stanford.edu/~blynn/gitmagic/index.html">
534 Git Magic</ulink>).</para>
536 <para>Ein beispielhafter Workflow für Druckvorlagen-Anpassungen von
537 3.4.1 nach 3.5: <programlisting>
538 $ git clone https://github.com/kivitendo/kivitendo-erp.git
540 $ git checkout release-3.4.1 # das ist der aktuelle release, den wir wollen
541 $ git add templates/fullhouse # das sind unsere druckvorlagen inkl. produktbilder
542 $ git commit -m "juhu tolle ändernungen"
543 [meine_aenderungen 1d89e41] juhu tolle ändernungen
544 4 files changed, 380 insertions(+)
545 create mode 100644 templates/fullhouse/img/webdav/tesla.png
546 create mode 100644 templates/fullhouse/mahnung.tex
547 create mode 100644 templates/fullhouse/zahlungserinnerung_zwei.tex
548 create mode 100644 templates/fullhouse/zahlungserinnerung_zwei_invoice.tex
553 $ git rebase --onto release-3.5.0 release-3.4.1 meine_aenderungen
554 Zunächst wird der Branch zurückgespult, um Ihre Änderungen
555 darauf neu anzuwenden ...
556 Wende an: juhu tolle ändernungen
557 $ service apache2 restart
558 </programlisting></para>
562 <sect1 id="config.config-file">
563 <title>kivitendo-Konfigurationsdatei</title>
565 <sect2 id="config.config-file.introduction"
566 xreflabel="Einführung in die Konfigurationsdatei">
567 <title>Einführung</title>
569 <para>In kivitendo gibt es nur noch eine Konfigurationsdatei, die
570 benötigt wird: <filename>config/kivitendo.conf</filename> (kurz: "die
571 Hauptkonfigurationsdatei"). Diese muss bei der Erstinstallation von
572 kivitendo bzw. der Migration von älteren Versionen angelegt
575 <para>Als Vorlage dient die Datei
576 <filename>config/kivitendo.conf.default</filename> (kurz: "die
577 Default-Datei"):</para>
579 <programlisting>$ cp config/kivitendo.conf.default config/kivitendo.conf</programlisting>
581 <para>Die Default-Datei wird immer zuerst eingelesen. Werte, die in
582 der Hauptkonfigurationsdatei stehen, überschreiben die Werte aus der
583 Default-Datei. Die Hauptkonfigurationsdatei muss also nur die
584 Abschnitte und Werte enthalten, die von denen der Default-Datei
588 <para>Vor der Umbenennung in kivitendo hieß diese Datei noch
589 <filename>config/lx_office.conf</filename>. Aus Gründen der
590 Kompatibilität wird diese Datei eingelesen, sofern die Datei
591 <filename>config/kivitendo.conf</filename> nicht existiert.</para>
594 <para>Diese Hauptkonfigurationsdatei ist dann eine
595 installationsspezifische Datei, d.h. sie enthält bspw. lokale
596 Passwörter und wird auch nicht im Versionsmanagement (git)
599 <para>Die Konfiguration ist ferner serverabhängig, d.h. für alle
600 Mandaten, bzw. Datenbanken gleich.</para>
603 <sect2 id="config.config-file.sections-parameters">
604 <title>Abschnitte und Parameter</title>
606 <para>Die Konfigurationsdatei besteht aus mehreren Teilen, die
607 entsprechend kommentiert sind:</para>
611 <para><literal>authentication</literal> (siehe Abschnitt "<xref
612 linkend="Benutzerauthentifizierung-und-Administratorpasswort"/>"
613 in diesem Kapitel)</para>
617 <para><literal>authentication/database</literal></para>
621 <para><literal>authentication/ldap</literal></para>
625 <para><literal>system</literal></para>
629 <para><literal>paths</literal></para>
633 <para><literal>mail_delivery</literal> (siehe Abschnitt "<xref
634 linkend="config.sending-email.smtp"/>)</para>
638 <para><literal>applications</literal></para>
642 <para><literal>environment</literal></para>
646 <para><literal>print_templates</literal></para>
650 <para><literal>task_server</literal></para>
654 <para><literal>periodic_invoices</literal></para>
658 <para><literal>self_tests</literal></para>
662 <para><literal>console</literal></para>
666 <para><literal>testing</literal></para>
670 <para><literal>testing/database</literal></para>
674 <para><literal>debug</literal></para>
678 <para>Die üblicherweise wichtigsten Parameter, die am Anfang
679 einzustellen oder zu kontrollieren sind, sind:</para>
681 <programlisting>[authentication]
682 admin_password = geheim
684 [authentication/database]
692 default_manager = german</programlisting>
694 <para>Für kivitendo Installationen in der Schweiz sollte hier
695 <varname>german</varname> durch <varname>swiss</varname> ersetzt
698 <para>Die Einstellung <varname>default_manager = swiss</varname>
703 <para>Beim Erstellen einer neuen Datenbank in der kivitendo
704 Administration werden automatisch die Standard-Werte für die
705 Schweiz voreingestellt: Währung CHF, 5er-Rundung, Schweizer
706 KMU-Kontenplan, Sollversteuerung, Aufwandsmethode, Bilanzierung
707 (die Werte können aber manuell angepasst werden).</para>
711 <para>Einstellen der Standardkonten für Rundungserträge und
712 -aufwendungen (unter Mandantenkonfiguration → Standardkonten
717 <para>das verwendete Zahlenformat wird auf
718 <varname>1'000.00</varname> eingestellt (unter Programm →
719 Benutzereinstellungen veränderbar)</para>
723 <para>DATEV-Automatik und UStVA werden nicht angezeigt,
724 Erfolgsrechnung ersetzt GUV ( unter Mandantenkonfiguration →
725 Features veränderbar)</para>
729 <para>Nutzt man wiederkehrende Rechnungen, kann man unter
730 <varname>[periodic_invoices]</varname> den Login eines Benutzers
731 angeben, der nach Erstellung der Rechnungen eine entsprechende E-Mail
732 mit Informationen über die erstellten Rechnungen bekommt.</para>
734 <para>kivitendo bringt eine eigene Komponente zur zeitgesteuerten
735 Ausführung bestimmter Aufgaben mit, den <link
736 linkend="config.task-server">Taskserver</link>. Er wird u.a. für
737 Features wie die <link
738 linkend="features.periodic-invoices">wiederkehrenden Rechnungen</link>
739 benötigt, erledigt aber auch andere erforderliche Aufgaben und muss
740 daher in Betrieb genommen werden. Seine Einrichtung wird im Abschnitt
741 <link linkend="config.task-server">Task-Server</link> genauer
744 <para>Für Entwickler finden sich unter <varname>[debug]</varname>
745 wichtige Funktionen, um die Fehlersuche zu erleichtern.</para>
748 <sect2 id="config.config-file.prior-versions">
749 <title>Versionen vor 2.6.3</title>
751 <para>In älteren kivitendo Versionen gab es im Verzeichnis
752 <filename>config</filename> die Dateien
753 <filename>authentication.pl</filename> und
754 <filename>lx-erp.conf</filename>, die jeweils Perl-Dateien waren. Es
755 gab auch die Möglichkeit, eine lokale Version der Konfigurationsdatei
756 zu erstellen (<filename>lx-erp-local.conf</filename>). Dies ist ab
757 2.6.3 nicht mehr möglich, aber auch nicht mehr nötig.</para>
759 <para>Beim Update von einer kivitendo-Version vor 2.6.3 auf 2.6.3 oder
760 jünger müssen die Einstellungen aus den alten Konfigurationsdateien
761 manuell übertragen und die alten Konfigurationsdateien anschließend
762 gelöscht oder verschoben werden. Ansonsten zeigt kivitendo eine
763 entsprechende Fehlermeldung an.</para>
767 <sect1 id="Anpassung-der-PostgreSQL-Konfiguration">
768 <title>Anpassung der PostgreSQL-Konfiguration</title>
770 <para>PostgreSQL muss auf verschiedene Weisen angepasst werden.</para>
772 <sect2 id="Zeichensätze-die-Verwendung-von-UTF-8">
773 <title>Zeichensätze/die Verwendung von Unicode/UTF-8</title>
775 <para>kivitendo setzt zwingend voraus, dass die Datenbank
776 Unicode/UTF-8 als Encoding einsetzt. Bei aktuellen
777 Serverinstallationen braucht man hier meist nicht einzugreifen.</para>
779 <para>Das Encoding des Datenbankservers kann überprüft werden. Ist das
780 Encoding der Datenbank "template1" "Unicode" bzw. "UTF-8", so braucht
781 man nichts weiteres diesbezüglich unternehmen. Zum Testen:</para>
783 <programlisting>su postgres
785 exit </programlisting>
787 <para>Andernfalls ist es notwendig, einen neuen Datenbankcluster mit
788 Unicode-Encoding anzulegen und diesen zu verwenden. Unter Debian und
789 Ubuntu kann dies z.B. für PostgreSQL 9.3 mit dem folgenden Befehl
792 <programlisting>pg_createcluster --locale=de_DE.UTF-8 --encoding=UTF-8 9.3 clustername</programlisting>
794 <para>Die Datenbankversionsnummer muss an die tatsächlich verwendete
795 Versionsnummer angepasst werden.</para>
797 <para>Unter anderen Distributionen gibt es ähnliche Methoden.</para>
799 <para>Das Encoding einer Datenbank kann in <command>psql</command> mit
800 <literal>\l</literal> geprüft werden.</para>
803 <sect2 id="Änderungen-an-Konfigurationsdateien">
804 <title>Änderungen an Konfigurationsdateien</title>
806 <para>In der Datei <filename>postgresql.conf</filename>, die je nach
807 Distribution in verschiedenen Verzeichnissen liegen kann (z.B.
808 <filename>/var/lib/pgsql/data/</filename> oder
809 <filename>/etc/postgresql/</filename>), muss sichergestellt werden,
810 dass TCP/IP-Verbindungen aktiviert sind. Das Verhalten wird über den
811 Parameter <varname>listen_address</varname> gesteuert. Laufen
812 PostgreSQL und kivitendo auf demselben Rechner, so kann dort der Wert
813 <literal>localhost</literal> verwendet werden. Andernfalls müssen
814 Datenbankverbindungen auch von anderen Rechnern aus zugelassen werden,
815 was mit dem Wert <literal>*</literal> geschieht.</para>
817 <para>In der Datei <filename>pg_hba.conf</filename>, die im gleichen
818 Verzeichnis wie die <filename>postgresql.conf</filename> zu finden
819 sein sollte, müssen die Berechtigungen für den Zugriff geändert
820 werden. Hier gibt es mehrere Möglichkeiten. Sinnvoll ist es nur die
821 nötigen Verbindungen immer zuzulassen, für eine lokal laufende
822 Datenbank zum Beispiel:</para>
824 <programlisting>local all kivitendo password
825 host all kivitendo 127.0.0.1 255.255.255.255 password</programlisting>
828 <sect2 id="Erweiterung-für-servergespeicherte-Prozeduren">
829 <title>Erweiterung für servergespeicherte Prozeduren</title>
831 <para>In der Datenbank <literal>template1</literal> muss die
832 Unterstützung für servergespeicherte Prozeduren eingerichet werden.
833 Melden Sie sich dafür als Benutzer “postgres” an der Datenbank an:
834 <programlisting>su - postgres
835 psql template1</programlisting> führen Sie die folgenden Kommandos aus:</para>
837 <programlisting>CREATE EXTENSION IF NOT EXISTS plpgsql;
841 <para><literal>CREATE EXTENSION</literal> ist seit Version 9.1 die
842 bevorzugte Syntax um die Sprache <literal>plpgsql</literal>
843 anzulegen. In diesen Versionen ist die Extension meist auch schon
844 vorhanden. Sollten Sie eine ältere Version von Postgres haben,
845 benutzen Sie stattdessen den folgenden Befehl.</para>
847 <programlisting>CREATE LANGUAGE 'plpgsql';
852 <sect2 id="Datenbankbenutzer-anlegen">
853 <title>Datenbankbenutzer anlegen</title>
855 <para>Wenn Sie nicht den Datenbanksuperuser “postgres” zum Zugriff
856 benutzen wollen, so sollten Sie bei PostgreSQL einen neuen Benutzer
857 anlegen. Ein Beispiel, wie Sie einen neuen Benutzer anlegen
860 <para>Die Frage, ob der neue User Superuser sein soll, können Sie mit
861 nein beantworten, genauso ist die Berechtigung neue User (Roles) zu
862 generieren nicht nötig.</para>
864 <programlisting>su - postgres
865 createuser -d -P kivitendo
866 exit</programlisting>
868 <para>Wenn Sie später einen Datenbankzugriff konfigurieren, verändern
869 Sie den evtl. voreingestellten Benutzer “postgres” auf “kivitendo”
870 bzw. den hier gewählten Benutzernamen.</para>
874 <sect1 id="Apache-Konfiguration">
875 <title>Webserver-Konfiguration</title>
878 <title>Grundkonfiguration mittels CGI</title>
881 <para>Für einen deutlichen Performanceschub sorgt die Ausführung
882 mittels FastCGI/FCGI. Die Einrichtung wird ausführlich im Abschnitt
883 <xref linkend="Apache-Konfiguration.FCGI"/> beschrieben.</para>
886 <para>Der Zugriff auf das Programmverzeichnis muss in der Apache
887 Webserverkonfigurationsdatei <literal>httpd.conf</literal> eingestellt
888 werden. Fügen Sie den folgenden Abschnitt dieser Datei oder einer
889 anderen Datei hinzu, die beim Starten des Webservers eingelesen
892 <programlisting>AliasMatch ^/kivitendo-erp/[^/]+\.pl /var/www/kivitendo-erp/dispatcher.pl
893 Alias /kivitendo-erp/ /var/www/kivitendo-erp/
895 <Directory /var/www/kivitendo-erp>
896 AddHandler cgi-script .pl
897 Options ExecCGI Includes FollowSymlinks
900 <Directory /var/www/kivitendo-erp/users>
902 </Directory></programlisting>
904 <para>Ersetzen Sie dabei die Pfade durch diejenigen, in die Sie vorher
905 das kivitendo-Archiv entpacket haben.</para>
908 <para>Vor den einzelnen Optionen muss bei einigen Distributionen ein
909 Plus ‘<literal>+</literal>’ gesetzt werden.</para>
911 <para>Bei einigen Distribution (Ubuntu ab 14.04, Debian ab 8.2) muss
912 noch explizit das cgi-Modul mittels <programlisting>a2enmod cgi</programlisting>
913 aktiviert werden.</para>
916 <para>Auf einigen Webservern werden manchmal die Grafiken und
917 Style-Sheets nicht ausgeliefert. In solchen Fällen hat es oft
918 geholfen, die folgende Option in die Konfiguration aufzunehmen:</para>
920 <programlisting>EnableSendfile Off</programlisting>
923 <sect2 id="Apache-Konfiguration.FCGI"
924 xreflabel="Konfiguration für FastCGI/FCGI">
925 <title>Konfiguration für FastCGI/FCGI</title>
927 <sect3 id="Apache-Konfiguration.FCGI.WasIstEs">
928 <title>Was ist FastCGI?</title>
930 <para>Direkt aus <ulink
931 url="http://de.wikipedia.org/wiki/FastCGI">Wikipedia</ulink>
934 <para><citation> FastCGI ist ein Standard für die Einbindung
935 externer Software zur Generierung dynamischer Webseiten in einem
936 Webserver. FastCGI ist vergleichbar zum Common Gateway Interface
937 (CGI), wurde jedoch entwickelt, um dessen Performance-Probleme zu
938 umgehen. </citation></para>
941 <sect3 id="Apache-Konfiguration.FCGI.Warum">
942 <title>Warum FastCGI?</title>
944 <para>Perl Programme (wie kivitendo eines ist) werden nicht statisch
945 kompiliert. Stattdessen werden die Quelldateien bei jedem Start
946 übersetzt, was bei kurzen Laufzeiten einen Großteil der Laufzeit
947 ausmacht. Während SQL Ledger einen Großteil der Funktionalität in
948 einzelne Module kapselt, um immer nur einen kleinen Teil laden zu
949 müssen, ist die Funktionalität von kivitendo soweit gewachsen, dass
950 immer mehr Module auf den Rest des Programms zugreifen. Zusätzlich
951 benutzen wir umfangreiche Bibliotheken um Funktionaltät nicht selber
952 entwickeln zu müssen, die zusätzliche Ladezeit kosten. All dies
953 führt dazu dass ein kivitendo Aufruf der Kernmasken mittlerweile
954 deutlich länger dauert als früher, und dass davon 90% für das Laden
955 der Module verwendet wird.</para>
957 <para>Mit FastCGI werden nun die Module einmal geladen, und danach
958 wird nur die eigentliche Programmlogik ausgeführt.</para>
961 <sect3 id="Apache-Konfiguration.FCGI.WebserverUndPlugin">
962 <title>Getestete Kombinationen aus Webservern und Plugin</title>
964 <para>Folgende Kombinationen sind getestet:</para>
968 <para>Apache 2.2.11 (Ubuntu) und mod_fcgid.</para>
972 <para>Apache 2.2.11 / 2.2.22 (Ubuntu) und mod_fastcgi.</para>
976 <para>Apache 2.4.7 (Ubuntu 14.04.2 LTS) und mod_fcgid.</para>
980 <para>Dabei wird mod_fcgid empfohlen, weil mod_fastcgi seit geraumer
981 Zeit nicht mehr weiter entwickelt wird. Im Folgenden wird auf
982 mod_fastcgi nicht mehr explizit eingegangen.</para>
984 <para>Als Perl Backend wird das Modul <filename>FCGI.pm</filename>
988 <para>FCGI-Versionen ab 0.69 und bis zu 0.71 inklusive sind extrem
989 strict in der Behandlung von Unicode, und verweigern bestimmte
990 Eingaben von kivitendo. Falls es Probleme mit Umlauten in Ihrer
991 Installation gibt, muss zwingend Version 0.68 oder aber Version
992 0.72 und neuer eingesetzt werden.</para>
994 <para>Mit <ulink url="http://www.cpan.org">CPAN</ulink> lässt sie
995 sich die Vorgängerversion wie folgt installieren:</para>
997 <programlisting>force install M/MS/MSTROUT/FCGI-0.68.tar.gz</programlisting>
1001 <sect3 id="Apache-Konfiguration.FCGI.Konfiguration">
1002 <title>Konfiguration des Webservers</title>
1004 <para>Bevor Sie versuchen, eine kivitendo Installation unter FCGI
1005 laufen zu lassen, empfiehlt es sich die Installation ersteinmal
1006 unter CGI aufzusetzen. FCGI macht es nicht einfach Fehler zu
1007 debuggen die beim ersten aufsetzen auftreten können. Sollte die
1008 Installation schon funktionieren, lesen Sie weiter.</para>
1010 <para>Zuerst muss das FastCGI-Modul aktiviert werden. Dies kann
1011 unter Debian/Ubuntu z.B. mit folgendem Befehl geschehen:</para>
1013 <programlisting>a2enmod fcgid</programlisting>
1015 <para>Die Konfiguration für die Verwendung von kivitendo mit FastCGI
1016 erfolgt durch Anpassung der vorhandenen <function>Alias</function>-
1017 und <function>Directory</function>-Direktiven. Dabei wird zwischen
1018 dem Installationspfad von kivitendo im Dateisystem
1019 ("<filename>/path/to/kivitendo-erp</filename>") und der URL
1020 unterschieden, unter der kivitendo im Webbrowser erreichbar ist
1021 ("<filename>/url/for/kivitendo-erp</filename>").</para>
1023 <para>Folgender Konfigurationsschnipsel funktioniert mit
1026 <programlisting>AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fcgi
1027 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
1029 <Directory /path/to/kivitendo-erp>
1031 Options ExecCGI Includes FollowSymlinks
1035 <DirectoryMatch /path/to/kivitendo-erp/users>
1037 </DirectoryMatch></programlisting>
1040 <para>Wer einen älteren Apache als Version 2.4 im Einsatz hat,
1041 muss entsprechend die Syntax der Directorydirektiven verändert.
1044 <programlisting>Require all granted</programlisting>
1046 <para>muß man Folgendes einstellen:</para>
1050 Allow from All </programlisting>
1052 <para>und statt</para>
1054 <programlisting>Require all denied</programlisting>
1056 <para>muss stehen:</para>
1060 Deny from All </programlisting>
1063 <para>Seit mod_fcgid-Version 2.3.6 gelten sehr kleine Grenzen für
1064 die maximale Größe eines Requests. Diese sollte wie folgt
1065 hochgesetzt werden:</para>
1067 <programlisting>FcgidMaxRequestLen 10485760</programlisting>
1069 <para>Das Ganze sollte dann so aussehen:</para>
1071 <programlisting>AddHandler fcgid-script .fpl
1072 AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
1073 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
1074 FcgidMaxRequestLen 10485760
1076 <Directory /path/to/kivitendo-erp>
1078 Options ExecCGI Includes FollowSymlinks
1083 <DirectoryMatch /path/to/kivitendo-erp/users>
1086 </DirectoryMatch></programlisting>
1088 <para>Hierdurch wird nur ein zentraler Dispatcher gestartet. Alle
1089 Zugriffe auf die einzelnen Scripte werden auf diesen umgeleitet.
1090 Dadurch, dass zur Laufzeit öfter mal Scripte neu geladen werden,
1091 gibt es hier kleine Performance-Einbußen.</para>
1093 <para>Es ist möglich, die gleiche kivitendo Version parallel unter
1094 CGI und FastCGI zu betreiben. Dafür bleiben die Directorydirektiven
1095 wie oben beschrieben, die URLs werden aber umgeleitet:</para>
1097 <programlisting># Zugriff über CGI
1098 Alias /url/for/kivitendo-erp /path/to/kivitendo-erp
1100 # Zugriff mit mod_fcgid:
1101 AliasMatch ^/url/for/kivitendo-erp-fcgid/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
1102 Alias /url/for/kivitendo-erp-fcgid/ /path/to/kivitendo-erp/</programlisting>
1104 <para>Dann ist unter <filename>/url/for/kivitendo-erp/</filename>
1105 die normale Version erreichbar, und unter
1106 <constant>/url/for/kivitendo-erp-fcgid/</constant> die
1107 FastCGI-Version.</para>
1112 <title>Weitergehende Konfiguration</title>
1114 <para>Für einen deutlichen Sicherheitsmehrwert sorgt die Ausführung
1115 von kivitendo nur über https-verschlüsselten Verbindungen, sowie
1116 weiteren Zusatzmassnahmen, wie beispielsweise Basic Authenticate. Die
1117 Konfigurationsmöglichkeiten sprengen allerdings den Rahmen dieser
1118 Anleitung, hier ein Hinweis auf einen entsprechenden <ulink
1119 url="http://redmine.kivitendo-premium.de/boards/1/topics/142">Foreneintrag
1120 (Stand Sept. 2015)</ulink> und einen aktuellen (Stand Mai 2017) <ulink
1121 url="https://mozilla.github.io/server-side-tls/ssl-config-generator/">
1122 SSL-Konfigurations-Generator</ulink>.</para>
1126 <sect1 id="config.task-server">
1127 <title>Der Task-Server</title>
1129 <para>Der Task-Server ist ein Prozess, der im Hintergrund läuft, in
1130 regelmäßigen Abständen nach abzuarbeitenden Aufgaben sucht und diese zu
1131 festgelegten Zeitpunkten abarbeitet (ähnlich wie Cron). Dieser Prozess
1132 wird u.a. für die Erzeugung der wiederkehrenden Rechnungen und weitere
1133 essenzielle Aufgaben benutzt.</para>
1135 <para>Der Task-Server muss einmalig global in der Konfigurationsdatei
1136 konfiguriert werden. Danach wird er für jeden Mandanten, für den er
1137 laufen soll, in der Adminsitrationsmaske eingeschaltet.</para>
1139 <para>Beachten Sie, dass der Task-Server in den Boot-Vorgang Ihres
1140 Servers integriert werden muss, damit er automatisch gestartet wird.
1141 Dies kann kivitendo nicht für Sie erledigen.</para>
1143 <para>Da der Taskserver als Perlscript läuft, wird Arbeitsspeicher, der
1144 einmal benötigt wurde, nicht mehr an das Betriebssystem zurückgegeben,
1145 solange der Taskserver läuft. Dies kann dazu führen, dass ein länger
1146 laufender Taskserver mit der Zeit immer mehr Arbeitsspeicher für sich
1147 beansprucht. Es ist deshalb sinnvoll, dass der Taskserver in
1148 regelmässigen Abständen neu gestartet wird.</para>
1150 <sect2 id="Konfiguration-des-Task-Servers">
1151 <title>Verfügbare und notwendige Konfigurationsoptionen</title>
1153 <para>Die Konfiguration erfolgt über den Abschnitt
1154 <literal>[task_server]</literal> in der Datei
1155 <filename>config/kivitendo.conf</filename>. Die dort verfügbaren
1156 Optionen sind:</para>
1160 <term><varname>run_as</varname></term>
1163 <para>Wird der Server vom Systembenutzer <literal>root</literal>
1164 gestartet, so wechselt er auf den mit <literal>run_as</literal>
1165 angegebenen Systembenutzer. Der Systembenutzer muss dieselben
1166 Lese- und Schreibrechte haben, wie auch der Webserverbenutzer
1168 linkend="Manuelle-Installation-des-Programmpaketes"/>). Daher
1169 ist es erforderlich, hier denselben Systembenutzer einzutragen,
1170 unter dem auch der Webserver läuft.</para>
1175 <term><varname>debug</varname></term>
1178 <para>Schaltet Debug-Informationen an und aus.</para>
1184 <sect2 id="Konfiguration-der-Mandanten-fuer-den-Task-Servers">
1185 <title>Konfiguration der Mandanten für den Task-Server</title>
1187 <para>Ist der Task-Server grundlegend konfiguriert, so muss
1188 anschließend jeder Mandant, für den der Task-Server laufen soll,
1189 einmalig konfiguriert werden. Dazu kann in der Maske zum Bearbeiten
1190 von Mandanten im Administrationsbereich eine kivitendo-Benutzerkennung
1191 ausgewählt werden, unter der der Task-Server seine Arbeit
1194 <para>Ist in dieser Einstellung keine Benutzerkennung ausgewählt, so
1195 wird der Task-Server für diesen Mandanten keine Aufgaben
1199 <sect2 id="Einbinden-in-den-Boot-Prozess">
1200 <title>Automatisches Starten des Task-Servers beim Booten</title>
1202 <para>Der Task-Server verhält sich von seinen Optionen her wie ein
1203 reguläres SystemV-kompatibles Boot-Script. Außerdem wechselt er beim
1204 Starten automatisch in das kivitendo-Installationsverzeichnis.</para>
1206 <para>Deshalb ist es möglich, ihn durch Setzen eines symbolischen
1207 Links aus einem der Runlevel-Verzeichnisse heraus in den Boot-Prozess
1208 einzubinden. Da das bei neueren Linux-Distributionen aber nicht
1209 zwangsläufig funktioniert, werden auch Start-Scripte mitgeliefert, die
1210 anstelle eines symbolischen Links verwendet werden können.</para>
1213 <title>SystemV-basierende Systeme (z.B. ältere Debian, ältere
1214 OpenSUSE, ältere Fedora)</title>
1216 <para>Kopieren Sie die Datei
1217 <filename>scripts/boot/system-v/kivitendo-task-server</filename>
1218 nach <filename>/etc/init.d/kivitendo-task-server</filename>. Passen
1219 Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
1220 <literal>DAEMON=....</literal>). Binden Sie das Script in den
1221 Boot-Prozess ein. Dies ist distributionsabhängig:</para>
1225 <para>Debian-basierende Systeme:</para>
1227 <programlisting>update-rc.d kivitendo-task-server defaults
1228 insserv kivitendo-task-server</programlisting>
1232 <para>Ältere OpenSUSE und ältere Fedora:</para>
1234 <programlisting>chkconfig --add kivitendo-task-server</programlisting>
1238 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
1241 <programlisting>/etc/init.d/kivitendo-task-server start</programlisting>
1245 <title>Upstart-basierende Systeme (z.B. Ubuntu bis 14.04)</title>
1247 <para>Kopieren Sie die Datei
1248 <filename>scripts/boot/upstart/kivitendo-task-server.conf</filename>
1249 nach <filename>/etc/init/kivitendo-task-server.conf</filename>.
1250 Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
1251 <literal>exec ....</literal>).</para>
1253 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
1256 <programlisting>service kivitendo-task-server start</programlisting>
1260 <title>systemd-basierende Systeme (z.B. neure openSUSE, neuere
1261 Fedora, neuere Ubuntu und neuere Debians)</title>
1263 <para>Kopieren Sie die Datei
1264 <filename>scripts/boot/systemd/kivitendo-task-server.service</filename>
1265 nach <filename>/etc/systemd/system/</filename>. Passen Sie in der
1266 kopierten Datei den Pfad zum Task-Server an (Zeilen
1267 <literal>ExecStart=....</literal> und
1268 <literal>ExecStop=...</literal>).</para>
1270 <para>Machen Sie anschließend das Script systemd bekannt, und binden
1271 Sie es in den Boot-Prozess ein. Dazu führen Sie die folgenden Befehl
1274 <programlisting>systemctl daemon-reload
1275 systemctl enable kivitendo-task-server.service</programlisting>
1277 <para>Wenn Sie den Task-Server jetzt sofort starten möchten, anstatt
1278 den Server neu zu starten, so können Sie das mit dem folgenden
1281 <programlisting>systemctl start kivitendo-task-server.service</programlisting>
1285 <sect2 id="Prozesskontrolle">
1286 <title>Wie der Task-Server gestartet und beendet wird</title>
1288 <para>Der Task-Server wird wie folgt kontrolliert:</para>
1290 <programlisting>./scripts/task_server.pl Befehl</programlisting>
1292 <para><literal>Befehl</literal> ist dabei eine der folgenden
1297 <para><literal>start</literal> startet eine neue Instanz des
1298 Task-Servers. Die Prozess-ID wird innerhalb des
1299 <filename>users</filename>-Verzeichnisses abgelegt.</para>
1303 <para><literal>stop</literal> beendet einen laufenden
1308 <para><literal>restart</literal> beendet und startet ihn
1313 <para><literal>status</literal> berichtet, ob der Task-Server
1318 <para>Der Task-Server wechselt beim Starten automatisch in das
1319 kivitendo-Installationsverzeichnis.</para>
1321 <para>Dieselben Optionen können auch für die SystemV-basierenden
1322 Runlevel-Scripte benutzt werden (siehe oben).</para>
1326 <sect1 id="Benutzerauthentifizierung-und-Administratorpasswort">
1327 <title>Benutzerauthentifizierung und Administratorpasswort</title>
1329 <para>Informationen über die Einrichtung der Benutzerauthentifizierung,
1330 über die Verwaltung von Gruppen und weitere Einstellungen</para>
1332 <sect2 id="Grundlagen-zur-Benutzerauthentifizierung">
1333 <title>Grundlagen zur Benutzerauthentifizierung</title>
1335 <para>kivitendo verwaltet die Benutzerinformationen in einer
1336 Datenbank, die im folgenden “Authentifizierungsdatenbank” genannt
1337 wird. Für jeden Benutzer kann dort eine eigene Datenbank für die
1338 eigentlichen Finanzdaten hinterlegt sein. Diese beiden Datenbanken
1339 können, müssen aber nicht unterschiedlich sein.</para>
1341 <para>Im einfachsten Fall gibt es für kivitendo nur eine einzige
1342 Datenbank, in der sowohl die Benutzerinformationen als auch die Daten
1343 abgelegt werden.</para>
1345 <para>Zusätzlich ermöglicht es kivitendo, dass die Benutzerpasswörter
1346 entweder gegen die Authentifizierungsdatenbank oder gegen einen
1347 LDAP-Server überprüft werden.</para>
1349 <para>Welche Art der Passwortüberprüfung kivitendo benutzt und wie
1350 kivitendo die Authentifizierungsdatenbank erreichen kann, wird in der
1351 Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1352 festgelegt. Diese muss bei der Installation und bei einem Upgrade von
1353 einer Version vor v2.6.0 angelegt werden. Eine
1354 Beispielkonfigurationsdatei
1355 <filename>config/kivitendo.conf.default</filename> existiert, die als
1356 Vorlage benutzt werden kann.</para>
1359 <sect2 id="Administratorpasswort">
1360 <title>Administratorpasswort</title>
1362 <para>Das Passwort, das zum Zugriff auf das Administrationsinterface
1363 von kivitendo benutzt wird, wird ebenfalls in dieser Datei
1364 gespeichert. Es kann auch nur dort und nicht mehr im
1365 Administrationsinterface selber geändert werden. Der Parameter dazu
1366 heißt <varname>admin_password</varname> im Abschnitt
1367 <varname>[authentication]</varname>.</para>
1370 <sect2 id="Authentifizierungsdatenbank">
1371 <title>Authentifizierungsdatenbank</title>
1373 <para>Die Verbindung zur Authentifizierungsdatenbank wird mit den
1374 Parametern in <varname>[authentication/database]</varname>
1375 konfiguriert. Hier sind die folgenden Parameter anzugeben:</para>
1379 <term><literal>host</literal></term>
1382 <para>Der Rechnername oder die IP-Adresse des
1383 Datenbankservers</para>
1388 <term><literal>port</literal></term>
1391 <para>Die Portnummer des Datenbankservers, meist 5432</para>
1396 <term><literal>db</literal></term>
1399 <para>Der Name der Authentifizierungsdatenbank</para>
1404 <term><literal>user</literal></term>
1407 <para>Der Benutzername, mit dem sich kivitendo beim
1408 Datenbankserver anmeldet (z.B.
1409 "<literal>postgres</literal>")</para>
1414 <term><literal>password</literal></term>
1417 <para>Das Passwort für den Datenbankbenutzer</para>
1422 <para>Die Datenbank muss noch nicht existieren. kivitendo kann sie
1423 automatisch anlegen (mehr dazu siehe unten).</para>
1426 <sect2 id="Passwortüberprüfung">
1427 <title>Passwortüberprüfung</title>
1429 <para>kivitendo unterstützt Passwortüberprüfung auf zwei Arten: gegen
1430 die Authentifizierungsdatenbank und gegen einen externen LDAP- oder
1431 Active-Directory-Server. Welche davon benutzt wird, regelt der
1432 Parameter <varname>module</varname> im Abschnitt
1433 <varname>[authentication]</varname>.</para>
1435 <para>Sollen die Benutzerpasswörter in der Authentifizierungsdatenbank
1436 gespeichert werden, so muss der Parameter <varname>module</varname>
1437 den Wert <literal>DB</literal> enthalten. In diesem Fall können sowohl
1438 der Administrator als auch die Benutzer selber ihre Passwörter in
1439 kivitendo ändern.</para>
1441 <para>Soll hingegen ein externer LDAP- oder Active-Directory-Server
1442 benutzt werden, so muss der Parameter <varname>module</varname> auf
1443 <literal>LDAP</literal> gesetzt werden. In diesem Fall müssen
1444 zusätzliche Informationen über den LDAP-Server im Abschnitt
1445 <literal>[authentication/ldap]</literal> angegeben werden:</para>
1449 <term><literal>host</literal></term>
1452 <para>Der Rechnername oder die IP-Adresse des LDAP- oder
1453 Active-Directory-Servers. Diese Angabe ist zwingend
1454 erforderlich.</para>
1459 <term><literal>port</literal></term>
1462 <para>Die Portnummer des LDAP-Servers; meist 389.</para>
1467 <term><literal>tls</literal></term>
1470 <para>Wenn Verbindungsverschlüsselung gewünscht ist, so diesen
1471 Wert auf ‘<literal>1</literal>’ setzen, andernfalls auf
1472 ‘<literal>0</literal>’ belassen</para>
1477 <term><literal>attribute</literal></term>
1480 <para>Das LDAP-Attribut, in dem der Benutzername steht, den der
1481 Benutzer eingegeben hat. Für Active-Directory-Server ist dies
1482 meist ‘<literal>sAMAccountName</literal>’, für andere
1483 LDAP-Server hingegen ‘<literal>uid</literal>’. Diese Angabe ist
1484 zwingend erforderlich.</para>
1489 <term><literal>base_dn</literal></term>
1492 <para>Der Abschnitt des LDAP-Baumes, der durchsucht werden soll.
1493 Diese Angabe ist zwingend erforderlich.</para>
1498 <term><literal>filter</literal></term>
1501 <para>Ein optionaler LDAP-Filter. Enthält dieser Filter das Wort
1502 <literal><%login%></literal>, so wird dieses durch den vom
1503 Benutzer eingegebenen Benutzernamen ersetzt. Andernfalls wird
1504 der LDAP-Baum nach einem Element durchsucht, bei dem das oben
1505 angegebene Attribut mit dem Benutzernamen identisch ist.</para>
1510 <term><literal>bind_dn</literal> und
1511 <literal>bind_password</literal></term>
1514 <para>Wenn der LDAP-Server eine Anmeldung erfordert, bevor er
1515 durchsucht werden kann (z.B. ist dies bei
1516 Active-Directory-Servern der Fall), so kann diese hier angegeben
1517 werden. Für Active-Directory-Server kann als
1518 ‘<literal>bind_dn</literal>’ entweder eine komplette LDAP-DN wie
1519 z.B. ‘<literal>cn=Martin
1520 Mustermann,cn=Users,dc=firmendomain</literal>’ auch nur der
1521 volle Name des Benutzers eingegeben werden; in diesem Beispiel
1522 also ‘<literal>Martin Mustermann</literal>’.</para>
1528 <sect2 id="Name-des-Session-Cookies">
1529 <title>Name des Session-Cookies</title>
1531 <para>Sollen auf einem Server mehrere kivitendo-Installationen
1532 aufgesetzt werden, so müssen die Namen der Session-Cookies für alle
1533 Installationen unterschiedlich sein. Der Name des Cookies wird mit dem
1534 Parameter <varname>cookie_name</varname> im Abschnitt
1535 <varname>[authentication]</varname>gesetzt.</para>
1537 <para>Diese Angabe ist optional, wenn nur eine Installation auf dem
1538 Server existiert.</para>
1541 <sect2 id="Anlegen-der-Authentifizierungsdatenbank">
1542 <title>Anlegen der Authentifizierungsdatenbank</title>
1544 <para>Nachdem alle Einstellungen in
1545 <filename>config/kivitendo.conf</filename> vorgenommen wurden, muss
1546 kivitendo die Authentifizierungsdatenbank anlegen. Dieses geschieht
1547 automatisch, wenn Sie sich im Administrationsmodul anmelden, das unter
1548 der folgenden URL erreichbar sein sollte:</para>
1551 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
1555 <sect1 id="Benutzer--und-Gruppenverwaltung">
1556 <title>Mandanten-, Benutzer- und Gruppenverwaltung</title>
1558 <para>Nach der Installation müssen Mandanten, Benutzer, Gruppen und
1559 Datenbanken angelegt werden. Dieses geschieht im Administrationsmenü,
1560 das Sie unter folgender URL finden:</para>
1563 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
1565 <para>Verwenden Sie zur Anmeldung das Passwort, das Sie in der Datei
1566 <filename>config/kivitendo.conf</filename> eingetragen haben.</para>
1568 <sect2 id="Zusammenhänge">
1569 <title>Zusammenhänge</title>
1571 <para>kivitendo verwaltet zwei Sets von Daten, die je nach Einrichtung
1572 in einer oder zwei Datenbanken gespeichert werden.</para>
1574 <para>Das erste Set besteht aus Anmeldeinformationen: welche Benutzer
1575 und Mandanten gibt es, welche Gruppen, welche BenutzerIn hat Zugriff
1576 auf welche Mandanten, und welche Gruppe verfügt über welche Rechte.
1577 Diese Informationen werden in der Authentifizierungsdatenbank
1578 gespeichert. Dies ist diejenige Datenbank, deren Verbindungsparameter
1579 in der Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1580 gespeichert werden.</para>
1582 <para>Das zweite Set besteht aus den eigentlichen Verkehrsdaten eines
1583 Mandanten, wie beispielsweise die Stammdaten (Kunden, Lieferanten,
1584 Waren) und Belege (Angebote, Lieferscheine, Rechnungen). Diese werden
1585 in einer Mandantendatenbank gespeichert. Die Verbindungsinformationen
1586 einer solchen Mandantendatenbank werden im Administrationsbereich
1587 konfiguriert, indem man einen Mandanten anlegt und dort die Parameter
1588 einträgt. Dabei hat jeder Mandant eine eigene Datenbank.</para>
1590 <para>Aufgrund des Datenbankdesigns ist es für einfache Fälle möglich,
1591 die Authentifizierungsdatenbank und eine der Mandantendatenbanken in
1592 ein und derselben Datenbank zu speichern. Arbeitet man hingegen mit
1593 mehr als einem Mandanten, wird empfohlen, für die
1594 Authentifizierungsdatenbank eine eigene Datenbank zu verwenden, die
1595 nicht gleichzeitig für einen Mandanten verwendet wird.</para>
1598 <sect2 id="Mandanten-Benutzer-Gruppen">
1599 <title>Mandanten, Benutzer und Gruppen</title>
1601 <para>kivitendos Administration kennt Mandanten, Benutzer und Gruppen,
1602 die sich frei zueinander zuordnen lassen.</para>
1604 <para>kivitendo kann mehrere Mandaten aus einer Installation heraus
1605 verwalten. Welcher Mandant benutzt wird, kann direkt beim Login
1606 ausgewählt werden. Für jeden Mandanten wird ein eindeutiger Name
1607 vergeben, der beim Login angezeigt wird. Weiterhin benötigt der
1608 Mandant Datenbankverbindungsparameter für seine Mandantendatenbank.
1609 Diese sollte über die <link
1610 linkend="Datenbanken-anlegen">Datenbankverwaltung</link>
1613 <para>Ein Benutzer ist eine Person, die Zugriff auf kivitendo erhalten
1614 soll. Sie erhält einen Loginnamen sowie ein Passwort. Weiterhin legt
1615 der Administrator fest, an welchen Mandanten sich ein Benutzer
1616 anmelden kann, was beim Login verifiziert wird.</para>
1618 <para>Gruppen dienen dazu, Benutzern innerhalb eines Mandanten Zugriff
1619 auf bestimmte Funktionen zu geben. Einer Gruppe werden dafür vom
1620 Administrator gewisse Rechte zugeordnet. Weiterhin legt der
1621 Administrator fest, für welche Mandanten eine Gruppe gilt, und welche
1622 Benutzer Mitglieder in dieser Gruppe sind. Meldet sich ein Benutzer
1623 dann an einem Mandanten an, so erhält er alle Rechte von allen
1624 denjenigen Gruppen, die zum Einen dem Mandanten zugeordnet sind und in
1625 denen der Benutzer zum Anderen Mitglied ist,</para>
1627 <para>Die Reihenfolge, in der Datenbanken, Mandanten, Gruppen und
1628 Benutzer angelegt werden, kann im Prinzip beliebig gewählt werden. Die
1629 folgende Reihenfolge beinhaltet die wenigsten Arbeitsschritte:</para>
1631 <orderedlist numeration="arabic">
1633 <para>Datenbank anlegen</para>
1637 <para>Gruppen anlegen</para>
1641 <para>Benutzer anlegen und Gruppen als Mitglied zuordnen</para>
1645 <para>Mandanten anlegen und Gruppen sowie Benutzer zuweisen</para>
1650 <sect2 id="Datenbanken-anlegen">
1651 <title>Datenbanken anlegen</title>
1653 <para>Zuerst muss eine Datenbank angelegt werden. Verwenden Sie für
1654 den Datenbankzugriff den vorhin angelegten Benutzer (in unseren
1655 Beispielen ist dies ‘<literal>kivitendo</literal>’).</para>
1658 <sect2 id="Gruppen-anlegen">
1659 <title>Gruppen anlegen</title>
1661 <para>Eine Gruppe wird in der Gruppenverwaltung angelegt. Ihr muss ein
1662 Name gegeben werden, eine Beschreibung ist hingegen optional. Nach dem
1663 Anlegen können Sie die verschiedenen Bereiche wählen, auf die
1664 Mitglieder dieser Gruppe Zugriff haben sollen.</para>
1666 <para>Benutzergruppen werden zwar in der Authentifizierungsdatenbank
1667 gespeichert, gelten aber nicht automatisch für alle Mandanten. Der
1668 Administrator legt vielmehr fest, für welche Mandanten eine Gruppe
1669 gültig ist. Dies kann entweder beim Bearbeiten der Gruppe geschehen
1670 ("diese Gruppe ist gültig für Mandanten X, Y und Z"), oder aber wenn
1671 man einen Mandanten bearbeitet ("für diesen Mandanten sind die Gruppen
1672 A, B und C gültig").</para>
1674 <para>Wurden bereits Benutzer angelegt, so können hier die Mitglieder
1675 dieser Gruppe festgelegt werden ("in dieser Gruppe sind die Benutzer
1676 X, Y und Z Mitglieder"). Dies kann auch nachträglich beim Bearbeiten
1677 eines Benutzers geschehen ("dieser Benutzer ist Mitglied in den
1678 Gruppen A, B und C").</para>
1681 <sect2 id="Benutzer-anlegen">
1682 <title>Benutzer anlegen</title>
1684 <para>Beim Anlegen von Benutzern werden für viele Parameter
1685 Standardeinstellungen vorgenommen, die den Gepflogenheiten des
1686 deutschen Raumes entsprechen.</para>
1688 <para>Zwingend anzugeben ist der Loginname. Wenn die
1689 Passwortauthentifizierung über die Datenbank eingestellt ist, so kann
1690 hier auch das Benutzerpasswort gesetzt bzw. geändert werden. Ist
1691 hingegen die LDAP-Authentifizierung aktiv, so ist das Passwort-Feld
1694 <para>Hat man bereits Mandanten und Gruppen angelegt, so kann hier
1695 auch konfiguriert werden, auf welche Mandanten der Benutzer Zugriff
1696 hat bzw. in welchen Gruppen er Mitglied ist. Beide Zuweisungen können
1697 sowohl beim Benutzer vorgenommen werden ("dieser Benutzer hat Zugriff
1698 auf Mandanten X, Y, Z" bzw. "dieser Benutzer ist Mitglied in Gruppen
1699 X, Y und Z") als auch beim Mandanten ("auf diesen Mandanten haben
1700 Benutzer A, B und C Zugriff") bzw. bei der Gruppe ("in dieser Gruppe
1701 sind Benutzer A, B und C Mitglieder").</para>
1704 <sect2 id="Mandanten-anlegen">
1705 <title>Mandanten anlegen</title>
1707 <para>Ein Mandant besteht aus Administrationssicht primär aus einem
1708 eindeutigen Namen. Weiterhin wird hier hinterlegt, welche Datenbank
1709 als Mandantendatenbank benutzt wird. Hier müssen die Zugriffsdaten
1710 einer der eben angelegten Datenbanken eingetragen werden.</para>
1712 <para>Hat man bereits Benutzer und Gruppen angelegt, so kann hier auch
1713 konfiguriert werden, welche Benutzer Zugriff auf den Mandanten haben
1714 bzw. welche Gruppen für den Mandanten gültig sind. Beide Zuweisungen
1715 können sowohl beim Mandanten vorgenommen werden ("auf diesen Mandanten
1716 haben Benutzer X, Y und Z Zugriff" bzw. "für diesen Mandanten sind die
1717 Gruppen X, Y und Z gültig") als auch beim Benutzer ("dieser Benutzer
1718 hat Zugriff auf Mandanten A, B und C") bzw. bei der Gruppe ("diese
1719 Gruppe ist für Mandanten A, B und C gültig").</para>
1723 <sect1 id="Drucker--Systemverwaltung">
1724 <title>Drucker- und Systemverwaltung</title>
1726 <para>Im Administrationsmenü gibt es ferner noch die beiden Menüpunkte
1727 Druckeradministration und System.</para>
1729 <sect2 id="Druckeradministration">
1730 <title>Druckeradministration</title>
1732 <para>Unter dem Menüpunkt Druckeradministration lassen sich beliebig
1733 viele "Druckbefehle" im System verwalten. Diese Befehle werden
1734 mandantenweise zugeordnet. Unter Druckerbeschreibung wird der Namen
1735 des Druckbefehls festgelegt, der dann in der Druckerauswahl des Belegs
1736 angezeigt wird.</para>
1738 <para>Unter Druckbefehl definiert man den eigentlichen Druckbefehl,
1739 der direkt auf dem Webserver ausgeführt wird, bspw. 'lpr -P
1740 meinDrucker' oder ein kompletter Pfad zu einem Skript
1741 (/usr/local/src/kivitendo/scripts/pdf_druck_in_verzeichnis.sh). Wird
1742 ferner noch ein optionales Vorlagenkürzel verwendet, wird dieses
1743 Kürzel bei der Auswahl der Druckvorlagendatei mit einem Unterstrich
1744 ergänzt, ist bspw. das Kürzel 'epson_drucker' definiert, so wird beim
1745 Ausdruck eines Angebots folgende Vorlage geparst:
1746 sales_quotation_epson_drucker.tex.</para>
1750 <title>System sperren / entsperren</title>
1752 <para>Unter dem Menüpunkt System gibt es den Eintrag 'Installation
1753 sperren/entsperren'. Setzt man diese Sperre so ist der Zugang zu der
1754 gesamten kivitendo Installation gesperrt.</para>
1756 <para>Falls die Sperre gesetzt ist, erscheint anstelle der
1757 Anmeldemaske die Information: 'kivitendo ist momentan zwecks
1758 Wartungsarbeiten nicht zugänglich.'.</para>
1760 <para>Wichtig zu erwähnen ist hierbei noch, dass sich kivitendo
1761 automatisch 'sperrt', falls es bei einem Versionsupdate zu einem
1762 Datenbankfehler kam. Somit kann hier nicht aus Versehen mit einem
1763 inkonsistenten Datenbestand weitergearbeitet werden.</para>
1767 <sect1 id="config.sending-email"
1768 xreflabel="E-Mail-Versand aus kivitendo heraus">
1769 <title>E-Mail-Versand aus kivitendo heraus</title>
1771 <para>kivitendo kann direkt aus dem Programm heraus E-Mails versenden,
1772 z.B. um ein Angebot direkt an einen Kunden zu verschicken. Damit dies
1773 funktioniert, muss eingestellt werden, über welchen Server die E-Mails
1774 verschickt werden sollen. kivitendo unterstützt dabei zwei Mechanismen:
1775 Versand über einen lokalen E-Mail-Server (z.B. mit
1776 <productname>Postfix</productname> oder <productname>Exim</productname>,
1777 was auch die standardmäßig aktive Methode ist) sowie Versand über einen
1778 SMTP-Server (z.B. der des eigenen Internet-Providers).</para>
1780 <para>Welche Methode und welcher Server verwendet werden, wird über die
1781 Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1782 festgelegt. Dort befinden sich alle Einstellungen zu diesem Thema im
1783 Abschnitt '<literal>[mail_delivery]</literal>'.</para>
1785 <sect2 id="config.sending-email.sendmail"
1786 xreflabel="E-Mail-Versand über lokalen E-Mail-Server">
1787 <title>Versand über lokalen E-Mail-Server</title>
1789 <para>Diese Methode bietet sich an, wenn auf dem Server, auf dem
1790 kivitendo läuft, bereits ein funktionsfähiger E-Mail-Server wie z.B.
1791 <productname>Postfix</productname>, <productname>Exim</productname>
1792 oder <productname>Sendmail</productname> läuft.</para>
1794 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter
1795 '<literal>method = sendmail</literal>' gesetzt sein. Dies ist
1796 gleichzeitig der Standardwert, falls er nicht verändert wird.</para>
1798 <para>Um zu kontrollieren, wie das Programm zum Einliefern gestartet
1799 wird, dient der Parameter '<literal>sendmail = ...</literal>'. Der
1800 Standardwert verweist auf das Programm
1801 <filename>/usr/bin/sendmail</filename>, das bei allen oben genannten
1802 E-Mail-Serverprodukten für diesen Zweck funktionieren sollte.</para>
1804 <para>Die Konfiguration des E-Mail-Servers selber würde den Rahmen
1805 dieses sprengen. Hierfür sei auf die Dokumentation des E-Mail-Servers
1809 <sect2 id="config.sending-email.smtp"
1810 xreflabel="E-Mail-Versand über einen SMTP-Server">
1811 <title>Versand über einen SMTP-Server</title>
1813 <para>Diese Methode bietet sich an, wenn kein lokaler E-Mail-Server
1814 vorhanden oder zwar einer vorhanden, dieser aber nicht konfiguriert
1817 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter
1818 '<literal>method = smtp</literal>' gesetzt sein. Die folgenden
1819 Parameter dienen dabei der weiteren Konfiguration:</para>
1823 <term><varname>hostname</varname></term>
1826 <para>Name oder IP-Adresse des SMTP-Servers. Standardwert:
1827 '<literal>localhost</literal>'</para>
1832 <term><varname>port</varname></term>
1835 <para>Portnummer. Der Standardwert hängt von der verwendeten
1836 Verschlüsselungsmethode ab. Gilt '<literal>security =
1837 none</literal>' oder '<literal>security = tls</literal>', so ist
1838 25 die Standardportnummer. Für '<literal>security =
1839 ssl</literal>' ist 465 die Portnummer. Muss normalerweise nicht
1840 geändert werden.</para>
1845 <term><varname>security</varname></term>
1848 <para>Wahl der zu verwendenden Verschlüsselung der Verbindung
1849 mit dem Server. Standardwert ist '<literal>none</literal>',
1850 wodurch keine Verschlüsselung verwendet wird. Mit
1851 '<literal>tls</literal>' wird TLS-Verschlüsselung eingeschaltet,
1852 und mit '<literal>ssl</literal>' wird Verschlüsselung via SSL
1853 eingeschaltet. Achtung: Für '<literal>tls</literal>' und
1854 '<literal>ssl</literal>' werden zusätzliche Perl-Module benötigt
1855 (siehe unten).</para>
1860 <term><varname>login</varname> und
1861 <varname>password</varname></term>
1864 <para>Falls der E-Mail-Server eine Authentifizierung verlangt,
1865 so können mit diesen zwei Parametern der Benutzername und das
1866 Passwort angegeben werden. Wird Authentifizierung verwendet, so
1867 sollte aus Sicherheitsgründen auch eine Form von Verschlüsselung
1868 aktiviert werden.</para>
1875 <sect1 id="Drucken-mit-kivitendo">
1876 <title>Drucken mit kivitendo</title>
1878 <para>Das Drucksystem von kivitendo benutzt von Haus aus LaTeX-Vorlagen.
1879 Um drucken zu können, braucht der Server ein geeignetes LaTeX System. Am
1880 einfachsten ist dazu eine <literal>texlive</literal> Installation. Unter
1881 debianoiden Betriebssystemen installiert man die Pakete mit:</para>
1883 <para><programlisting>apt-get install texlive-base-bin texlive-latex-recommended texlive-fonts-recommended \
1884 texlive-latex-extra texlive-lang-german texlive-generic-extra</programlisting></para>
1886 <para>Für Fedora benötigen Sie die folgenden Pakete:</para>
1888 <para><programlisting>dnf install texlive-collection-latex texlive-collection-latexextra \
1889 texlive-collection-latexrecommended texlive-collection-langgerman \
1890 texlive-collection-langenglish</programlisting></para>
1892 <para>Für openSUSE benötigen Sie die folgenden Pakete:</para>
1894 <para><programlisting>zypper install texlive-collection-latex texlive-collection-latexextra \
1895 texlive-collection-latexrecommended texlive-collection-langgerman \
1896 texlive-collection-langenglish</programlisting></para>
1898 <para>kivitendo bringt drei alternative Vorlagensätze mit:</para>
1910 <para>rev-odt</para>
1914 <para>Der ehemalige Druckvorlagensatz "Standard" wurde mit der Version
1915 3.3 entfernt, da er nicht mehr gepflegt wurde.</para>
1917 <sect2 id="Vorlagenverzeichnis-anlegen"
1918 xreflabel="Vorlagenverzeichnis anlegen">
1919 <title>Vorlagenverzeichnis anlegen</title>
1921 <para>Es lässt sich ein initialer Vorlagensatz erstellen. Die
1922 LaTeX-System-Abhängigkeiten hierfür kann man prüfen mit:</para>
1924 <programlisting>./scripts/installation_check.pl -lv</programlisting>
1926 <para>Der Angemeldete Benutzer muss in einer Gruppe sein, die über das
1927 Recht "Konfiguration -> Mandantenverwaltung" verfügt. Siehe auch
1928 <xref linkend="Gruppen-anlegen"/>.</para>
1930 <para>Im Userbereich lässt sich unter: "<guimenu>System</guimenu>
1931 -> <guisubmenu>Mandantenverwaltung</guisubmenu> ->
1932 <guimenuitem>Verschiedenes</guimenuitem>" die Option "Neue
1933 Druckvorlagen aus Vorlagensatz erstellen" auswählen.</para>
1937 <para><option>Vorlagen auswählen</option>: Wählen Sie hier den
1938 Vorlagensatz aus, der kopiert werden soll
1939 (<filename>RB</filename>, <filename>f-tex</filename> oder
1940 <filename>odt-rev</filename>.)</para>
1944 <para><option>Neuer Name</option>: Der Verzeichnisname für den
1945 neuen Vorlagensatz. Dieser kann im Rahmen der üblichen Bedingungen
1946 für Verzeichnisnamen frei gewählt werden.</para>
1950 <para>Nach dem Speichern wird das Vorlagenverzeichnis angelegt und ist
1951 für den aktuellen Mandanten ausgewählt. Der gleiche Vorlagensatz kann,
1952 wenn er mal angelegt ist, bei mehreren Mandanten verwendet werden.
1953 Eventuell müssen Anpassungen (Logo, Erscheinungsbild, etc) noch
1954 vorgenommen werden. Den Ordner findet man im Dateisystem unter
1955 <filename>./templates/[Neuer Name]</filename></para>
1958 <sect2 id="Vorlagen-RB">
1959 <title>Der Druckvorlagensatz RB</title>
1961 <para>Hierbei handelt es sich um einen vollständigen LaTeX
1962 Dokumentensatz mit alternativem Design. Die odt oder html-Varianten
1963 sind nicht gepflegt.</para>
1965 <para>Die konzeptionelle Idee der Vorlagen wird <ulink
1966 url="http://www.kivitendo-support.de/vortraege/Lx-Office%20Anwendertreffen%20LaTeX-Druckvorlagen-Teil3-finale.pdf">hier</ulink>
1967 auf Folie 5 bis 10 vorgestellt. Informationen zur Anpassung an die
1968 eigenen Firmendaten finden sich in der Datei Readme.tex im
1969 Vorlagenverzeichnis.</para>
1971 <para>Eine kurze Übersicht der Features:</para>
1975 <para>Mehrsprachenfähig, mit Deutscher und Englischer
1980 <para>Zentrale Konfigurationsdateien, die für alle Belege benutzt
1981 werden, z.B. für Kopf- und Fußzeilen, und Infos wie
1986 <para>mehrere vordefinierte Varianten für
1987 Logos/Hintergrundbilder</para>
1991 <para>Berücksichtigung für Steuerzonen "EU mit USt-ID Nummer" oder
1992 "Außerhalb EU"</para>
1998 <title>f-tex</title>
2000 <para>Ein Vorlagensatz, der in wenigen Minuten alle Dokumente zur
2001 Verfügung stellt.</para>
2003 <sect3 id="f-tex-Feature-Übersicht">
2004 <title>Feature-Übersicht</title>
2008 <para>Keine Redundanz. Es wird ein- und dieselbe LaTeX-Vorlage
2009 für alle briefartigen Dokumente verwendet. Also Angebot,
2010 Rechnung, Proformarechnung, Lieferschein, aber eben nicht für
2011 Paketaufkleber etc.</para>
2015 <para>Leichte Anpassung an das Firmen-Layout durch Verwendung
2016 eines Hintergrund-PDFs. Dieses kann leicht mit dem eigenen
2017 Lieblingsprogramm erstellt werden (Openoffice, Inkscape, Gimp,
2022 <para>Hintergrund-PDF umschaltbar auf "nur erste Seite"
2023 (Standard) oder "alle Seiten" (Option
2024 "<option>bgPdfFirstPageOnly</option>" in Datei
2025 <filename>letter.lco</filename>)</para>
2029 <para>Hintergrund-PDF für Ausdruck auf bereits bedrucktem
2030 Briefpapier abschaltbar. Es wird dann nur bei per E-Mail
2031 versendeten Dokumenten eingebunden (Option
2032 "<option>bgPdfEmailOnly</option>" in Datei
2033 <filename>letter.lco</filename>).</para>
2037 <para>Nutzung der Layout-Funktionen von LaTeX für Seitenumbruch,
2038 Wiederholung von Kopfzeilen, Zwischensummen etc. (danke an
2039 Kai-Martin Knaak für die Vorarbeit)</para>
2043 <para>Anzeige des Empfängerlandes im Adressfeld nur, wenn es vom
2044 Land des eigenen Unternehmens abweicht (also die Rechnung das
2045 Land verlässt).</para>
2049 <para>Multisprachfähig leicht um weitere Sprachen zu erweitern,
2050 alle Übersetzungen in der Datei
2051 <filename>translatinos.tex</filename>.</para>
2055 <para>Auflistung von Bruttopreisen für Endverbraucher.</para>
2060 <sect3 id="f-tex-Installation">
2061 <title>Die Installation</title>
2065 <para>Vorlagenverzeichnis mit Option f-tex anlegen, siehe: <xref
2066 linkend="Vorlagenverzeichnis-anlegen"/>. Das Vorlagensystem
2067 funktioniert jetzt schon, hat allerdings noch einen
2068 Beispiel-Briefkopf.</para>
2072 <para>Erstelle eine pdf-Hintergrund Datei und verlinke sie nach
2073 <filename>./letter_head.pdf</filename>.</para>
2077 <para>Editiere den Bereich "<option>settings</option>" in der
2078 datei <filename>letter.lco</filename>.</para>
2082 <para>oder etwas detaillierter:</para>
2084 <para>Es wird eine Datei <filename>sample.lco</filename> erstellt
2085 und diese nach <filename>letter.lco</filename> verlinkt. Eigentlich
2086 ist dies die Datei die für die firmenspezifischen Anpassungen
2087 gedacht ist. Da die Einstiegshürde in LaTeX nicht ganz niedrig ist,
2088 wird in dieser Datei auf ein Hintergrund-PDF verwiesen. Ich empfehle
2089 über dieses PDF die persönlichen Layoutanpassungen vorzunehmen und
2090 <filename>sample.lco</filename> unverändert zu lassen. Die Anpassung
2091 über eine <filename>*.lco</filename>-Datei, die letztlich auf
2092 <filename>letter.lco</filename> verlinkt ist ist aber auch
2095 <para>Es wird eine Datei <filename>sample_head.pdf</filename> mit
2096 ausgeliefert, diese wird nach <filename>letter_head.pdf</filename>
2097 verlinkt. Damit gibt es schon mal eine funktionsfähige Vorlage.
2098 Schau Dir nach Abschluss der Installation die Datei
2099 <filename>sample_head.pdf</filename> an und erstelle ein
2100 entsprechendes PDF passend zum Briefkopf Deiner Firma, diese dann im
2101 Template Verzeichniss ablegen und statt
2102 <filename>sample_head.pdf</filename> nach
2103 <filename>letter_head.pdf</filename> verlinken.</para>
2105 <para>Letzlich muss <filename>letter_head.pdf</filename> auf das
2106 passende Hintergrund-PDF verweisen, welches gewünschten Briefkopf
2109 <para>Es wird eine Datei <filename>mydata.tex.example</filename>
2110 ausgeliefert, die nach <filename>mytdata.tex</filename> verlinkt
2111 ist. Bei verwendetem Hintergrund-PDF wird nur der Eintrag für das
2112 Land verwendet. Die Datei muss also nicht angefasst werden. Die
2113 anderen Werte sind für das Modul 'lp' (Label Print in erp - zur Zeit
2114 nicht im öffentlichen Zweig).</para>
2116 <para>Alle Anpassungen zum Briefkopf, Fusszeilen, Firmenlogos, etc.
2117 sollten über die Hintergrund-PDF-Datei oder die
2118 <filename>*.lco</filename>-Datei erfolgen.</para>
2121 <sect3 id="f-tex-Funktionsübersicht">
2122 <title>f-tex Funktionsübersicht</title>
2124 <para>Das Konzept von kivitendo sieht vor, für jedes Dokument
2125 (Auftragsbestätigung, Lieferschein, Rechnung, etc.) eine
2126 LaTeX-Vorlage vorzuhalten, dies ist sehr wartungsunfreundlich. Auch
2127 das Einlesen einer einheitlichen Quelle für den Briefkopf bringt nur
2128 bedingte Vorteile, da hier leicht die Pflege der Artikel-Tabellen
2129 aus dem Ruder läuft. Bei dem vorliegenden Ansatz wird für alle
2130 briefartigen Dokumente mit Artikel-Tabellen eine einheitliche
2131 LaTeX-Vorlage verwendet, welche über Codeweichen die Besonderheiten
2132 der jeweiligen Dokumente berücksichtigt:</para>
2136 <para>Tabellen mit oder ohne Preis</para>
2140 <para>Sprache der Tabellenüberschriften etc.</para>
2144 <para>Anpassung der Bezugs-Zeile (z.B. Rechnungsnummer versus
2145 Angebotsnummer)</para>
2149 <para>Darstellung von Brutto oder Netto-Preisen in der
2150 Auflistung (Endverbraucher versus gewerblicher Kunde)</para>
2154 <para>Nachteil:</para>
2156 <para>LaTeX hat ohnehin eine sehr steile Lehrnkurve. Die Datei
2157 <filename>letter.tex</filename> ist sehr komplex und verstärkt damit
2158 diesen Effekt noch einmal erheblich. Wer LaTeX-Erfahrung hat, oder
2159 geübt ist Scriptsparachen nachzuvollziehen kann natürlich auch
2160 innerhalb der Tabellendarstellung gut persönliche Anpassungen
2161 vornehmen. Aber man kann sich hier bei Veränderungen sehr schnell
2162 heftig in den Fuss schiessen.</para>
2164 <para>Wer nicht so tief in die Materie einsteigen will oder leicht
2165 zu frustrieren ist, sollte sein Hintergrund-PDF auf Basis der
2166 mitglieferten Datei <filename>sample_head.pdf</filename> erstellen,
2167 und sich an der Form der dargestellten Tabellen, wie sie
2168 ausgeliefert werden, erfreuen.</para>
2170 <para>Kleiner Tipp: Nicht zu viel auf einmal wollen, lieber kleine,
2171 kontinuierliche Schritte gehen.</para>
2174 <sect3 id="f-tex-Bruttopreise">
2175 <title>Bruttopreise für Endverbraucher</title>
2177 <para>Der auszuweisende Bruttopreis wird innerhalb der
2178 LaTeX-Umgebung berechnet. Es gibt zwar ein Feld, um bei Aufträgen
2179 "alle Preise Brutto" auszuwählen, aber:</para>
2183 <para>hierfür müssen die Preise auch in Brutto in der Datenbank
2184 stehen (ja - das lässt sich über die Preisgruppen und die
2185 Zuordung einer Default-Preisgruppe handhaben)</para>
2189 <para>man darf beim Anlegen des Vorgangs nicht vergessen, dieses
2190 Häkchen zu setzen. (Das ist in der Praxis, wenn man sowohl
2191 Endverbraucher als auch Gewerbekunden beliefert, der eigentliche
2196 <para>Es gibt mit f-tex eine weitere Alternative. Die Information ob
2197 Brutto oder Nettorechnung wird mit den Zahlarten verknüpft.
2198 Zahlarten bei denen Rechnungen, Angebote, etc, in Brutto ausgegeben
2199 werden sollen, enden mit "_E" (für Endverbraucher). Falls identische
2200 Zahlarten für Gewerbekunden und Endverbraucher vorhanden sind, legt
2201 man diese einfach doppelt an (einmal mit der Namensendung "_E").
2206 <para>Die Entscheidung, ob Nettopreise ausgewiesen werden, ist
2207 nicht mehr fix mit einer Preisliste verbunden.</para>
2211 <para>Die Default-Zahlart kann im Kundendatensatz hinterlegt
2212 werden, und man muss nicht mehr daran denken, "alle Preise
2213 Netto" auszuwählen.</para>
2217 <para>Die Entscheidung, ob Netto- oder Bruttopreise ausgewiesen
2218 werden, kann direkt beim Drucken revidiert werden, ohne dass
2219 sich der Auftragswert ändert.</para>
2224 <sect3 id="f-tex-lieferadressen">
2225 <title>Lieferadressen</title>
2227 <para>In Lieferscheinen kommen <varname>shipto*</varname>-Variablen
2228 im Adressfeld zum Einsatz. Wenn die
2229 <varname>shipto*</varname>-Variable leer ist, wird die entsprechende
2230 Adressvariable eingesetzt. Wenn also die Lieferadresse in Straße,
2231 Hausnummer und Ort abweicht, müssen auch nur diese Felder in der
2232 Lieferadresse ausgefüllt werden. Für den Firmenname wird der Wert
2233 der Hauptadresse angezeigt.</para>
2237 <sect2 id="Vorlagen-rev-odt">
2238 <title>Der Druckvorlagensatz rev-odt</title>
2240 <para>Hierbei handelt es sich um einen Dokumentensatz der mit
2241 odt-Vorlagen erstellt wurde. Es gibt in dem Verzeichnis eine
2242 Readme-Datei, die eventuell aktueller als die Dokumentation hier ist.
2243 Die odt-Vorlagen in diesem Verzeichnis "rev-odt" wurden von revamp-it,
2244 Zürich erstellt und werden laufend aktualisiert. Ein paar der
2245 Formulierungen in den Druckvorlagen entsprechen dem Schweizer
2246 Sprachgebrauch, z.B. "Offerte" oder "allfällig".</para>
2248 <para>Hinweis zum Einsatz des Feldes "Land" bei den Stammdaten für
2249 KundInnen und LieferantInnen, sowie bei Lieferadressen: Die in diesem
2250 Vorlagensatz vorhandenen Vorlagen erwarten für "Land" das
2251 entsprechende Kürzel, das in Adressen vor die Postleitzahl gesetzt
2252 wird. Das Feld kann auch komplett leer bleiben. Wer dies anders
2253 handhaben möchte, muss die Vorlagen entsprechend anpassen.</para>
2255 <para>odt-Vorlagen können mit LibreOffice oder OpenOffice editiert und
2256 den eigenen Bedürfnissen angepasst werden. Wichtig beim Editieren von
2257 if-Blöcken ist, dass immer der gesamte Block überschrieben werden muss
2258 und nicht nur Teile davon, da dies sonst oft zu einer odt-Datei führt,
2259 die vom Parser nicht korrekt gelesen werden kann.</para>
2261 <para>Mahnungen können unter folgenden Einschränkungen mit den
2262 odt-Vorlagen im Vorlagensatz rev-odt erzeugt werden:</para>
2266 <para>als Druckoption steht nur 'PDF(OpenDocument/OASIS)' zur
2267 Verfügung, das heisst, die Mahnungen werden als PDF-Datei
2272 <para>für jede Rechnung muss eine eigene Mahnung erzeugt werden
2273 (auch wenn bei einzelnen KundInnen mehrere überfällige Rechnungen
2274 vorhanden sind).</para>
2278 <para>Mehrere Mahnungen für eine Kundin / einen Kunden werden zu einer
2279 PDF-Datei zusammengefasst</para>
2281 <para>Die Vorlagen zahlungserinnerung.odt sowie mahnung.odt sind für
2282 das Erstellen einer Zahlungserinnerung bzw. Mahnung selbst vorgesehen,
2283 die Vorlage mahnung_invoice.odt für das Erstellen einer Rechnung über
2284 die verrechneten Mahngebühren und Verzugszinsen.</para>
2286 <para>Zur Zeit gibt es in kivitendo noch keine Möglichkeit,
2287 odt-Vorlagen bei Briefen und Pflichtenheften einzusetzen.
2288 Entsprechende Vorlagen sind deshalb nicht vorhanden.</para>
2290 <para>Fehlermeldungen, Anregungen und Wünsche bitte senden an:
2291 empfang@revamp-it.ch</para>
2294 <sect2 id="allgemeine-hinweise-zu-latex">
2295 <title>Allgemeine Hinweise zu LaTeX Vorlagen</title>
2297 <para>In den allermeisten Installationen sollte das Drucken jetzt
2298 schon funktionieren. Sollte ein Fehler auftreten, wirft TeX sehr lange
2299 Fehlerbeschreibungen, der eigentliche Fehler ist immer die erste
2300 Zeile, die mit einem Ausrufezeichen anfängt. Häufig auftretende Fehler
2301 sind zum Beispiel:</para>
2305 <para>! LaTeX Error: File `eurosym.sty' not found. Die
2306 entsprechende LaTeX-Bibliothek wurde nicht gefunden. Das tritt vor
2307 allem bei Vorlagen aus der Community auf. Installieren Sie die
2308 entsprechenden Pakete.</para>
2312 <para>! Package inputenc Error: Unicode char \u8:... set up for
2313 use with LaTeX. Dieser Fehler tritt auf, wenn sie versuchen mit
2314 einer Standardinstallation exotische utf8 Zeichen zu drucken.
2315 TeXLive unterstützt von Haus nur romanische Schriften und muss mit
2316 diversen Tricks dazu gebracht werden andere Zeichen zu
2317 akzeptieren. Adere TeX Systeme wie XeTeX schaffen hier
2322 <para>Wird gar kein Fehler angezeigt, sondern nur der Name des
2323 Templates, heißt das normalerweise, dass das LaTeX Binary nicht
2324 gefunden wurde. Prüfen Sie den Namen in der Konfiguration (Standard:
2325 <literal>pdflatex</literal>), und stellen Sie sicher, dass pdflatex
2326 (oder das von Ihnen verwendete System) vom Webserver ausgeführt werden
2329 <para>Wenn sich das Problem nicht auf Grund der Ausgabe im Webbrowser
2330 verifizieren lässt:</para>
2334 <para>editiere [kivitendo-home]/config/kivitendo.conf und ändere
2335 "keep_temp_files" auf 1</para>
2337 <para><programlisting>keep_temp_files = 1;</programlisting></para>
2341 <para>bei fastcgi oder mod_perl den Webserver neu Starten</para>
2345 <para>Nochmal einen Druckversuch im Webfrontend auslösen</para>
2349 <para>wechsel in das users Verzeichnis von kivitendo</para>
2351 <para><programlisting>cd [kivitendo-home]/users</programlisting></para>
2355 <para>LaTeX Suchpfad anpassen:</para>
2357 <para><programlisting>export TEXINPUTS=".:[kivitendo-home]/templates/[aktuelles_template_verzeichniss]:"</programlisting></para>
2361 <para>Finde heraus, welche Datei kivitendo beim letzten Durchlauf
2364 <para><programlisting>ls -lahtr ./1*.tex</programlisting></para>
2366 <para>Es sollte die letzte Datei ganz unten sein</para>
2370 <para>für besseren Hinweis auf Fehler texdatei nochmals
2373 <para><programlisting>pdflatex ./1*.tex</programlisting></para>
2375 <para>in der *.tex datei nach dem Fehler suchen.</para>
2381 <sect1 id="OpenDocument-Vorlagen">
2382 <title>OpenDocument-Vorlagen</title>
2384 <para>kivitendo unterstützt die Verwendung von Vorlagen im
2385 OpenDocument-Format, wie es LibreOffice oder OpenOffice (ab Version 2)
2386 erzeugen. kivitendo kann dabei sowohl neue OpenDocument-Dokumente als
2387 auch aus diesen direkt PDF-Dateien erzeugen. Um die Unterstützung von
2388 OpenDocument-Vorlagen zu aktivieren muss in der Datei
2389 <filename>config/kivitendo.conf</filename> die Variable
2390 <literal>opendocument</literal> im Abschnitt
2391 <literal>print_templates</literal> auf ‘<literal>1</literal>’ stehen.
2392 Dieses ist die Standardeinstellung.</para>
2394 <para>Während die Erzeugung von reinen OpenDocument-Dateien keinerlei
2395 weitere Software benötigt, wird zur Umwandlung dieser Dateien in PDF
2396 LibreOffice oder OpenOffice benötigt. Soll dieses Feature genutzt
2397 werden, so muss neben LibreOffice oder OpenOffice auch der “X virtual
2398 frame buffer” (xvfb) installiert werden. Bei Debian ist er im Paket
2399 “xvfb” enthalten. Andere Distributionen enthalten ihn in anderen
2402 <para>Nach der Installation müssen in der Datei
2403 <filename>config/kivitendo.conf</filename> im Abschnitt
2404 <literal>applications</literal> zwei weitere Variablen angepasst
2407 <para><literal>openofficeorg_writer</literal> muss den vollständigen
2408 Pfad zu LibreOffice oder OpenOffice enthalten. Dabei dürfen keine
2409 Anführungszeichen eingesetzt werden.</para>
2411 <para>Beispiel für Debian oder Ubuntu:</para>
2413 <programlisting>openofficeorg_writer = /usr/bin/libreoffice</programlisting>
2415 <para><literal>xvfb</literal> muss den Pfad zum “X virtual frame buffer”
2418 <para>Zusätzlich gibt es zwei verschiedene Arten, wie kivitendo mit
2419 LibreOffice bzw. OpenOffice kommuniziert. Die erste Variante, die
2420 benutzt wird, wenn die Variable <literal>$openofficeorg_daemon</literal>
2421 gesetzt ist, startet ein LibreOffice oder OpenOffice, das auch nach der
2422 Umwandlung des Dokumentes gestartet bleibt. Bei weiteren Umwandlungen
2423 wird dann diese laufende Instanz benutzt. Der Vorteil ist, dass die Zeit
2424 zur Umwandlung deutlich reduziert wird, weil nicht für jedes Dokument
2425 ein LibreOffice bzw. OpenOffice gestartet werden muss. Der Nachteil ist,
2426 dass diese Methode Python und die Python-UNO-Bindings benötigt, die
2427 Bestandteil von LibreOffice bzw. OpenOffice sind.</para>
2430 <para>Für die Verbindung zu LibreOffice bzw. OpenOffice wird
2431 normalerweise der Python-Interpreter
2432 <filename>/usr/bin/python</filename> benutzt. Sollte dies nicht der
2433 richtige sein, so kann man mit zwei Konfigurationsvariablen
2434 entscheiden, welcher Python-Interpreter genutzt wird. Mit der Option
2435 <literal>python_uno</literal> aus dem Abschnitt
2436 <literal>applications</literal> wird der Interpreter selber
2437 festgelegt; sie steht standardmäßig auf dem eben erwähnten Wert
2438 <literal>/usr/bin/python</literal>.</para>
2440 <para>Zusätzlich ist es möglich, Pfade anzugeben, in denen Python
2441 neben seinen normalen Suchpfaden ebenfalls nach Modulen gesucht wird,
2442 z.B. falls sich diese in einem gesonderten LibreOffice- bzw.
2443 OpenOffice-Verzeichnis befinden. Diese zweite Variable heißt
2444 <literal>python_uno_path</literal> und befindet sich im Abschnitt
2445 <literal>environment</literal>. Sie ist standardmäßig leer. Werden
2446 hier mehrere Pfade angegeben, so müssen diese durch Doppelpunkte
2447 voneinander getrennt werden. Der Inhalt wird an den Python-Interpreter
2448 über die Umgebungsvariable <literal>PYTHONPATH</literal>
2452 <para>Ist <literal>$openofficeorg_daemon</literal> nicht gesetzt, so
2453 wird für jedes Dokument LibreOffice bzw. OpenOffice neu gestartet und
2454 die Konvertierung mit Hilfe eines Makros durchgeführt. Dieses Makro muss
2455 in der Dokumentenvorlage enthalten sein und
2456 “Standard.Conversion.ConvertSelfToPDF()” heißen. Die Beispielvorlage
2457 ‘<literal>templates/print/rev-odt/invoice.odt</literal>’ enthält ein
2458 solches Makro, das in jeder anderen Dokumentenvorlage ebenfalls
2459 enthalten sein muss.</para>
2461 <para>Als letztes muss herausgefunden werden, welchen Namen OpenOffice
2462 bzw. LibreOffice dem Verzeichnis mit den Benutzereinstellungen gibt.
2463 Unter Debian ist dies momentan <literal>~/.config/libreoffice</literal>.
2464 kivitendo verwendet das Verzeichnis
2465 <literal>users/.openoffice.org2</literal>. Eventuell muss dieses
2466 Verzeichnis umbenannt werden.</para>
2468 <para>Dieses Verzeichnis, wie auch das komplette
2469 <literal>users</literal>-Verzeichnis, muss vom Webserver beschreibbar
2470 sein. Dieses wurde bereits erledigt (siehe <xref
2471 linkend="Manuelle-Installation-des-Programmpaketes"/>), kann aber erneut
2472 überprüft werden, wenn die Konvertierung nach PDF fehlschlägt.</para>
2475 <title>OpenDocument (odt) Druckvorlagen mit Makros</title>
2477 <para>OpenDocument Vorlagen können Makros enthalten, welche komplexere
2478 Aufgaben erfüllen.</para>
2480 <para>Der Vorlagensatz "rev-odt" enthält solche Vorlagen mit <emphasis
2481 role="bold">Schweizer Bank-Einzahlungsscheinen (BESR)</emphasis>.
2482 Diese Makros haben die Aufgabe, die in den Einzahlungsscheinen
2483 benötigte Referenznummer und Kodierzeile zu erzeugen. Hier eine kurze
2484 Beschreibung, wie die Makros aufgebaut sind, und was bei ihrer Nutzung
2485 zu beachten ist (<emphasis role="bold">in fett sind nötige einmalige
2486 Anpassungen aufgeführt</emphasis>):</para>
2489 <title>Bezeichnung der Vorlagen</title>
2491 <para>Rechnung: invoice_besr.odt, Auftrag:
2492 sales_order_besr.odt</para>
2496 <title>Vorbereitungen im Adminbereich</title>
2498 <para>Damit beim Erstellen von Rechnungen und Aufträgen neben der
2499 Standardvorlage ohne Einzahlungsschein weitere Vorlagen (z.B. mit
2500 Einzahlungsschein) auswählbar sind, muss für jedes Vorlagen-Suffix
2501 ein Drucker eingerichtet werden:</para>
2505 <para>Druckeradministration → Drucker hinzufügen</para>
2509 <para>Mandant wählen</para>
2513 <para>Druckerbeschreibung → aussagekräftiger Text: wird in der
2514 Auftrags- bzw. Rechnungsmaske als Auswahl angezeigt (z.B. mit
2515 Einzahlungsschein Bank xy)</para>
2519 <para>Druckbefehl → beliebiger Text (hat für das Erzeugen von
2520 Aufträgen oder Rechnungen als odt-Datei keine Bedeutung, darf
2521 aber nicht leer sein)</para>
2525 <para>Vorlagenkürzel → besr bzw. selbst gewähltes Vorlagensuffix
2526 (muss genau der Zeichenfolge entsprechen, die zwischen
2527 "invoice_" bzw. "sales_order_" und ".odt" steht.)</para>
2531 <para>speichern</para>
2537 <title>Benutzereinstellungen</title>
2539 <para>Wer den Ausdruck mit Einzahlungsschein als Standardeinstellung
2540 im Rechnungs- bzw. Auftragsformular angezeigt haben möchte, kann
2541 dies persönlich für sich bei den Benutzereinstellungen
2542 konfigurieren:</para>
2546 <para>Programm → Benutzereinstellungen → Druckoptionen</para>
2550 <para>Standardvorlagenformat → OpenDocument/OASIS</para>
2554 <para>Standardausgabekanal → Bildschirm</para>
2558 <para>Standarddrucker → gewünschte Druckerbeschreibung auswählen
2559 (z.B. mit Einzahlungsschein Bank xy)</para>
2563 <para>Anzahl Kopien → leer</para>
2567 <para>speichern</para>
2573 <title>Aufbau und nötige Anpassungen der Vorlagen</title>
2575 <para>In der Vorlage sind als Modul "BESR" 4 Makros gespeichert, die
2576 aus dem von kivitendo erzeugten odt-Dokument die korrekte
2577 Referenznummer inklusive Prüfziffer sowie die Kodierzeile in
2578 OCRB-Schrift erzeugen und am richtigen Ort ins Dokument
2583 <para>Für den Einzahlungsschein ist die letzte Seite des
2584 Dokuments reserviert</para>
2588 <para>Direkt über dem Einzahlungsschein enthält die Vorlage eine
2589 Zeile mit folgenden Angaben (<emphasis
2590 role="bold">Bank-Konto-Identifikationsnummer und
2591 Postkonto-Nummer der Bank müssen gemäss Angaben der jeweiligen
2592 Bank angepasst werden</emphasis>):<itemizedlist>
2594 <para>DDDREF: 4 Werte zum Bilden der Referenznummer
2595 (jeweils durch einen Leerschlag getrennt): <itemizedlist>
2597 <para>erster Wert: <emphasis
2598 role="bold">Bank-Konto-Identifikation</emphasis>
2599 (nur Ziffern, maximal 6), <emphasis role="bold">muss
2600 angepasst werden</emphasis>.</para>
2604 <para>zweiter Wert: <%customernumber%>
2605 (Kundennummer: nur Ziffern, maximal 6)</para>
2609 <para>dritter Wert: <%ordnumber%>
2610 (Auftragsnummer bei Auftragsvorlage
2611 sales_oder_besr.odt, sonst 0) maximal 7 Ziffern,
2612 führende Buchstaben werden vom Makro entfernt</para>
2616 <para>vierter Wert: <%invnumber%>
2617 (Rechnungsnummer bei Rechnungsvorlage
2618 invoice_besr.odt, sonst 0) maximal 7 Ziffern,
2619 führende Buchstaben werden vom Makro entfernt</para>
2621 </itemizedlist></para>
2625 <para>DDDKONTO: <emphasis role="bold">Postkonto-Nummer der
2626 Bank, muss angepasst werden</emphasis>.</para>
2630 <para>DDDBETRAG: <%total%> Einzahlungsbetrag oder 0,
2631 falls Einzahlungsschein ohne Betrag</para>
2635 <para>DDDEND: muss am Ende der Zeile vorhanden sein</para>
2637 </itemizedlist></para>
2641 <para><emphasis role="bold">Im Einzahlungsschein selbst müssen
2642 der Name und die Adresse der Bank, die Postkonto-Nummer der
2643 Bank, sowie der eigene Firmenname und die Firmenadresse
2644 angepasst werden.</emphasis> Dabei ist darauf zu achten, dass
2645 sich die Positionen der Postkonto-Nummern der Bank, sowie der
2646 Zeichenfolgen dddfr, DDDREF1, DDDREF2, 609, DDDKODIERZEILE nicht
2652 <screeninfo>Rechnungsvorlage Schweizer Bank-Einzahlungsschein - zu
2653 ändernde Einträge in rot</screeninfo>
2657 <imagedata fileref="images/Einzahlungsschein_Makro.png"/>
2664 <title>Auswahl der Druckvorlage in kivitendo beim Erzeugen einer
2665 odt-Rechnung (analog bei Auftrag)</title>
2667 <para>Im Fussbereich der Rechnungsmaske muss neben Rechnung,
2668 OpenDocument/OASIS und Bildschirm die im Adminbereich erstellte
2669 Druckerbeschreibung ausgewählt werden, falls diese nicht bereits bei
2670 den Benutzereinstellungen als persönlicher Standard gewählt
2675 <title>Makroeinstellungen in LibreOffice anpassen</title>
2677 <para>Falls beim Öffnen einer von kivitendo erzeugten odt-Rechnung
2678 die Meldung kommt, dass Makros aus Sicherheitsgründen nicht
2679 ausgeführt werden, so müssen folgende Einstellungen in LibreOffice
2680 angepasst werden:</para>
2684 <para>Extras → Optionen → Sicherheit → Makrosicherheit</para>
2688 <para>Sicherheitslevel auf "Mittel" einstellen (Diese
2689 Einstellung muss auf jedem Computer durchgeführt werden, mit dem
2690 von kivitendo erzeugte odt-Rechnungen oder Aufträge geöffnet
2695 <para>Beim Öffnen einer odt-Rechnung oder eines odt-Auftrags bei
2696 der entsprechenden Nachfrage "Makros ausführen"
2699 <para><emphasis role="bold">Wichtig</emphasis>: die Makros sind
2700 so eingestellt, dass sie beim Öffnen der Vorlagen selbst nicht
2701 ausgeführt werden. Das heisst für das Ansehen und Bearbeiten der
2702 Vorlagen sind keine speziellen Einstellungen in LibreOffice
2710 <sect1 id="nomenclature">
2711 <title>Nomenklatur</title>
2713 <sect2 id="booking.dates">
2714 <title>Datum bei Buchungen</title>
2716 <para>Seit der Version 3.5 werden für Buchungen in kivitendo
2717 einheitlich folgende Bezeichnungen verwendet:</para>
2721 <para><option>Erfassungsdatum</option> (en: <option>Entry
2722 Date</option>, code: <option>Gldate</option>)</para>
2724 <para>bezeichnet das Datum, an dem die Buchung in kivitendo
2725 erfasst wurde.</para>
2729 <para><option>Buchungsdatum</option> (en: <option>Booking
2730 Date</option>, code: <option>Transdate</option>)</para>
2732 <para>bezeichnet das buchhaltungstechnisch für eine Buchung
2733 relevante Datum</para>
2735 <para>Das <option>Rechnungsdatum</option> bei Verkaufs- und
2736 Einkaufsrechnungen entspricht dem Buchungsdatum. Das heisst, in
2737 Berichten wie dem Buchungsjournal, in denen eine Spalte
2738 <option>Buchungsdatum</option> angezeigt werden kann, erscheint
2739 hier im Fall von Rechnungen das Rechnungsdatum.</para>
2743 <para>Bezieht sich ein verbuchter Beleg auf einen Zeitpunkt, der
2744 nicht mit dem Buchungsdatum übereinstimmt, so kann dieses Datum
2745 momentan in kivitendo nur unter Bemerkungen erfasst werden.</para>
2747 <para>Möglicherweise wird für solche Fälle in einer späteren
2748 Version von kivitendo ein dritter Datumswert für Buchungen
2749 erstellt. (Beispiel: Einkaufsbeleg stammt aus einem früheren Jahr,
2750 das bereits buchhaltungstechnisch abgeschlossen wurde, und muss
2751 deshalb später verbucht werden.)</para>
2757 <sect1 id="config.eur">
2758 <title>Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung:
2761 <sect2 id="config.eur.introduction"
2762 xreflabel="Einführung in die Konfiguration zur EUR">
2763 <title>Einführung</title>
2765 <para>kivitendo besaß bis inklusive Version 2.6.3 einen
2766 Konfigurationsparameter namens <varname>eur</varname>, der sich in der
2767 Konfigurationsdatei <filename>config/kivitendo.conf</filename> (damals
2768 noch <filename>config/lx_office.conf</filename>) befand. Somit galt er
2769 für alle Mandanten, die in dieser Installation benutzt wurden.</para>
2771 <para>Mit der nachfolgenden Version wurde der Parameter zum Einen in
2772 die Mandantendatenbank verschoben und dabei auch gleich in drei
2773 Einzelparameter aufgeteilt, mit denen sich das Verhalten genauer
2774 steuern lässt.</para>
2777 <sect2 id="config.eur.parameters"
2778 xreflabel="Konfigurationsparameter für EUR">
2779 <title>Konfigurationsparameter</title>
2781 <para>Es gibt drei Parameter, die die Gewinnermittlungsart,
2782 Versteuerungsart und die Warenbuchungsmethode regeln:</para>
2786 <term><varname>profit_determination</varname></term>
2789 <para>Dieser Parameter legt die Berechnungsmethode für die
2790 Gewinnermittlung fest. Er enthält entweder
2791 <literal>balance</literal> für
2792 Betriebsvermögensvergleich/Bilanzierung oder
2793 <literal>income</literal> für die
2794 Einnahmen-Überschuss-Rechnung.</para>
2799 <term><varname>accounting_method</varname></term>
2802 <para>Dieser Parameter steuert die Buchungs- und
2803 Berechnungsmethoden für die Versteuerungsart. Er enthält
2804 entweder <literal>accrual</literal> für die Soll-Versteuerung
2805 oder <literal>cash</literal> für die Ist-Versteuerung.</para>
2810 <term><varname>inventory_system</varname></term>
2813 <para>Dieser Parameter legt die Warenbuchungsmethode fest. Er
2814 enthält entweder <literal>perpetual</literal> für die
2815 Bestandsmethode oder <literal>periodic</literal> für die
2816 Aufwandsmethode.</para>
2821 <para>Zum Vergleich der Funktionalität bis und nach 2.6.3:
2822 <varname>eur</varname> = 1 bedeutete Einnahmen-Überschuss-Rechnung,
2823 Ist-Versteuerung und Aufwandsmethode. <varname>eur</varname> = 0
2824 bedeutete hingegen Bilanzierung, Soll-Versteuerung und
2825 Bestandsmethode.</para>
2827 <para>Die Konfiguration "<varname>eur</varname>" unter
2828 <varname>[system]</varname> in der <link
2829 linkend="config.config-file">Konfigurationsdatei</link>
2830 <filename>config/kivitendo.conf</filename> wird nun nicht mehr
2831 benötigt und kann entfernt werden. Dies muss manuell geschehen.</para>
2834 <sect2 id="config.eur.setting-parameters">
2835 <title>Festlegen der Parameter</title>
2837 <para>Beim Anlegen eines neuen Mandanten bzw. einer neuen Datenbank in
2838 der Admininstration können diese Optionen nun unabhängig voneinander
2839 eingestellt werden.</para>
2841 <para>Für die Schweiz sind folgende Einstellungen üblich:
2844 <para>Sollversteuerung</para>
2848 <para>Aufwandsmethode</para>
2852 <para>Bilanzierung</para>
2854 </itemizedlist> Diese Einstellungen werden automatisch beim
2855 Erstellen einer neuen Datenbank vorausgewählt, wenn in
2856 <filename>config/kivitendo.conf</filename> unter
2857 <varname>[system]</varname> <literal>default_manager = swiss</literal>
2858 eingestellt ist.</para>
2860 <para>Beim Upgrade bestehender Mandanten wird eur ausgelesen und die
2861 Variablen werden so gesetzt, daß sich an der Funktionalität nichts
2864 <para>Die aktuelle Konfiguration wird unter Nummernkreise und
2865 Standardkonten unter dem neuen Punkt "Einstellungen" (read-only)
2866 angezeigt. Unter <guimenu>System</guimenu> →
2867 <guisubmenu>Mandantenkonfiguration</guisubmenu> können die
2868 Einstellungen auch geändert werden. Dabei ist zu beachten, dass eine
2869 Änderung vorhandene Daten so belässt und damit evtl. die Ergebnisse
2870 verfälscht. Dies gilt vor Allem für die Warenbuchungsmethode (siehe
2871 auch <link linkend="config.eur.inventory-system-perpetual">
2872 Bemerkungen zur Bestandsmethode</link>).</para>
2875 <sect2 id="config.eur.inventory-system-perpetual">
2876 <title>Bemerkungen zur Bestandsmethode</title>
2878 <para>Die Bestandsmethode ist eigentlich eine sehr elegante Methode,
2879 funktioniert in kivitendo aber nur unter bestimmten Bedingungen:
2880 Voraussetzung ist, daß auch immer alle Einkaufsrechnungen gepflegt
2881 werden, und man beim Jahreswechsel nicht mit einer leeren Datenbank
2882 anfängt, da bei jedem Verkauf anhand der gesamten Rechnungshistorie
2883 der Einkaufswert der Ware nach dem FIFO-Prinzip aus den
2884 Einkaufsrechnungen berechnet wird.</para>
2886 <para>Die Bestandsmethode kann vom Prinzip her also nur funktioneren,
2887 wenn man mit den Buchungen bei Null anfängt, und man kann auch nicht
2888 im laufenden Betrieb von der Aufwandsmethode zur Bestandsmethode
2892 <sect2 id="config.eur.knonw-issues">
2893 <title>Bekannte Probleme</title>
2895 <para>Bei bestimmten Berichten kann man derzeit noch inviduell
2896 einstellen, ob man nach Ist- oder Sollversteuerung auswertet, und es
2897 werden im Code Variablen wie $accrual oder $cash gesetzt. Diese
2898 Codestellen wurden noch nicht angepasst, sondern nur die, wo bisher
2899 die Konfigurationsvariable
2900 <varname>$::lx_office_conf{system}->{eur}</varname> ausgewertet
2903 <para>Es fehlen Hilfetext beim Neuanlegen eines Mandanten, was die
2904 Optionen bewirken, z.B. mit zwei Standardfällen.</para>
2908 <sect1 id="config.skr04-update-3804">
2909 <title>SKR04 19% Umstellung für innergemeinschaftlichen Erwerb</title>
2911 <sect2 id="config.skr04-update-3804.introduction">
2912 <title>Einführung</title>
2914 <para>Die Umsatzsteuerumstellung auf 19% für SKR04 für die
2915 Steuerschlüssel "EU ohne USt-ID Nummer" ist erst 2010 erfolgt.
2916 kivitendo beinhaltet ein Upgradeskript, das das Konto 3804 automatisch
2917 erstellt und die Steuereinstellungen korrekt einstellt. Hat der
2918 Benutzer aber schon selber das Konto 3804 angelegt, oder gab es schon
2919 Buchungen im Zeitraum nach dem 01.01.2007 auf das Konto 3803, wird das
2920 Upgradeskript vorsichtshalber nicht ausgeführt, da der Benutzer sich
2921 vielleicht schon selbst geholfen hat und mit seinen Änderungen
2922 zufrieden ist. Die korrekten Einstellungen kann man aber auch per Hand
2923 ausführen. Nachfolgend werden die entsprechenden Schritte anhand von
2924 Screenshots dargestellt.</para>
2926 <para>Für den Fall, daß Buchungen mit der Steuerschlüssel "EU ohne
2927 USt.-IdNr." nach dem 01.01.2007 erfolgt sind, ist davon auszugehen,
2928 dass diese mit dem alten Umsatzsteuersatz von 16% gebucht worden sind,
2929 und diese Buchungen sollten entsprechend kontrolliert werden.</para>
2932 <sect2 id="config.skr04-update-3804.create-chart">
2933 <title>Konto 3804 manuell anlegen</title>
2935 <para>Die folgenden Schritte sind notwendig, um das Konto manuell
2936 anzulegen und zu konfigurieren. Zuerst wird in
2937 <guimenu>System</guimenu> → <guisubmenu>Kontenübersicht</guisubmenu> →
2938 <guimenuitem>Konto erfassen</guimenuitem> das Konto angelegt.</para>
2941 <screeninfo>Konto 3804 erfassen</screeninfo>
2945 <imagedata fileref="images/skr04-update-3804/konto3804.png"/>
2950 <para>Als Zweites muss Steuergruppe 13 für Konto 3803 angepasst
2951 werden. Dazu unter <guimenu>System</guimenu> →
2952 <guisubmenu>Steuern</guisubmenu> →
2953 <guimenuitem>Bearbeiten</guimenuitem> den Eintrag mit Steuerschlüssel
2954 13 auswählen und ihn wie im folgenden Screenshot angezeigt
2958 <screeninfo>Steuerschlüssel 13 für 3803 (16%) anpassen</screeninfo>
2962 <imagedata fileref="images/skr04-update-3804/steuer3803.png"/>
2967 <para>Als Drittes wird ein neuer Eintrag mit Steuerschlüssel 13 für
2968 Konto 3804 (19%) angelegt. Dazu unter <guimenu>System</guimenu> →
2969 <guisubmenu>Steuern</guisubmenu> → <guimenuitem>Erfassen</guimenuitem>
2970 auswählen und die Werte aus dem Screenshot übernehmen.</para>
2973 <screeninfo>Steuerschlüssel 13 für 3804 (19%) anlegen</screeninfo>
2977 <imagedata fileref="images/skr04-update-3804/steuer3804.png"/>
2982 <para>Als Nächstes sind alle Konten anzupassen, die als
2983 Steuerautomatikkonto die 3803 haben, sodass sie ab dem 1.1.2007 auch
2984 Steuerautomatik auf 3804 bekommen. Dies betrifft in der
2985 Standardkonfiguration die Konten 4315 und 4726. Als Beispiel für 4315
2986 müssen Sie dazu unter <guimenu>System</guimenu> →
2987 <guisubmenu>Kontenübersicht</guisubmenu> → <guimenuitem>Konten
2988 anzeigen</guimenuitem> das Konto 4315 anklicken und die Einstellungen
2989 wie im Screenshot gezeigt vornehmen.</para>
2992 <screeninfo>Konto 4315 anpassen</screeninfo>
2996 <imagedata fileref="images/skr04-update-3804/konto4315.png"/>
3001 <para>Als Letztes sollte die Steuerliste unter
3002 <guimenu>System</guimenu> → <guisubmenu>Steuern</guisubmenu> →
3003 <guimenuitem>Bearbeiten</guimenuitem> kontrolliert werden. Zum
3004 Vergleich der Screenshot.</para>
3007 <screeninfo>Steuerliste vergleichen</screeninfo>
3011 <imagedata fileref="images/skr04-update-3804/steuerliste.png"/>
3018 <sect1 id="config.bilanz">
3019 <title>Verhalten des Bilanzberichts</title>
3021 <para>Bis Version 3.0 wurde "closedto" ("Bücher schließen zum") als
3022 Grundlage für das Startdatum benutzt. Schließt man die Bücher allerdings
3023 monatsweise führt dies zu falschen Werten.</para>
3025 <para>In der Mandantenkonfiguration kann man dieses Verhalten genau
3026 einstellen indem man:</para>
3030 <para>weiterhin closed_to benutzt (Default, es ändert sich nichts zu
3035 <para>immer den Jahresanfang nimmt (1.1. relativ zum
3040 <para>immer die letzte Eröffnungsbuchung als Startdatum nimmt</para>
3042 <para>- mit Jahresanfang als Alternative wenn es keine EB-Buchungen
3045 <para>- oder mit "alle Buchungen" als Alternative"</para>
3049 <para>mit Jahresanfang als Alternative wenn es keine EB-Buchungen
3054 <para>immer alle Buchungen seit Beginn der Datenbank nimmt</para>
3058 <para>Folgende Hinweise zu den Optionen: Das "Bücher schließen Datum"
3059 ist sinnvoll, wenn man nur komplette Jahre schließt. Bei Wirtschaftsjahr
3060 = Kalendarjahr entspricht dies aber auch dem Jahresanfang. "Alle
3061 Buchungen" kann z.B. sinnvoll sein wenn man ohne Jahresabschluß
3062 durchbucht. Eröffnungsbuchung mit "alle Buchungen" als Fallback ist z.B.
3063 sinnvoll, wenn man am sich Anfang des zweiten Buchungsjahres befindet,
3064 und noch keinen Jahreswechsel und auch noch keine EB-Buchungen hat. Bei
3065 den Optionen mit EB-Buchungen wird vorausgesetzt, daß diese immer am 1.
3066 Tag des Wirtschaftsjahres gebucht werden. Zur Sicherheit wird das
3067 Startdatum im Bilanzbericht jetzt zusätzlich zum Stichtag mit angezeigt.
3068 Das hilft auch bei der Kontrolle für den Abgleich mit der GuV bzw.
3069 Erfolgsrechnung.</para>
3072 <sect1 id="config.erfolgsrechnung">
3073 <title>Erfolgsrechnung</title>
3075 <para>Seit der Version 3.4.1 existiert in kivitendo der Bericht
3076 <emphasis role="bold"> Erfolgsrechnung</emphasis>.</para>
3078 <para>Die Erfolgsrechnung kann in der Mandantenkonfiguration unter
3079 Features an- oder abgeschaltet werden. Mit der Einstellung
3080 <varname>default_manager = swiss </varname> in der
3081 <filename>config/kivitendo.conf</filename> wird beim neu Erstellen einer
3082 Datenbank automatisch die Anzeige der Erfolgsrechnung im Menü
3083 <guimenu>Berichte </guimenu> ausgewählt und ersetzt dort die GUV.</para>
3085 <para>Im Gegensatz zur GUV werden bei der Erfolgsrechnung sämtliche
3086 Aufwands- und Erlöskonten einzeln aufgelistet (analog zur Bilanz),
3087 sortiert nach ERTRAG und AUFWAND.</para>
3089 <para>Bei den Konteneinstellungen muss bei jedem Konto, das in der
3090 Erfolgsrechnung erscheinen soll, unter <varname>Sonstige
3091 Einstellungen/Erfolgsrechnung</varname> entweder
3092 <literal>01.Ertrag</literal> oder <literal>06.Aufwand</literal>
3093 ausgewählt werden.</para>
3095 <para>Wird bei einem Erlöskonto <literal>06.Aufwand</literal>
3096 ausgewählt, so wird dieses Konto als Aufwandsminderung unter AUFWAND
3099 <para>Wird bei einem Aufwandskonto <literal>01.Ertrag</literal>
3100 ausgewählt, so wird dieses Konto als Ertragsminderung unter ERTRAG
3103 <para>Soll bei einer bereits bestehenden Buchhaltung in Zukunft
3104 zusätzlich die Erfolgsrechnung als Bericht verwendet werden, so müssen
3105 die Einstellungen zu allen Erlös- und Aufwandskonten unter
3106 <varname>Sonstige Einstellungen/Erfolgsrechnung</varname> überprüft und
3107 allenfalls neu gesetzt werden.</para>
3110 <sect1 id="config.rounding">
3111 <title>Rundung in Verkaufsbelegen</title>
3113 <para>In der Schweiz hat die kleinste aktuell benutzte Münze den Wert
3114 von 5 Rappen (0.05 CHF).</para>
3116 <para>Auch wenn im elektronischen Zahlungsverkehr Beträge mit einer
3117 Genauigkeit von 0.01 CHF verwendet werden können, ist es trotzdem nach
3118 wie vor üblich, Rechnungen mit auf 0.05 CHF gerundeten Beträgen
3119 auszustellen.</para>
3121 <para>In kivitendo kann seit der Version 3.4.1 die Einstellung für eine
3122 solche Rundung pro Mandant / Datenbank festgelegt werden.</para>
3124 <para>Die Einstellung wird beim Erstellen der Datenbank bei
3125 <literal>Genauigkeit</literal> festgelegt. Sie kann anschliessend über
3126 das Webinterface von kivitendo nicht mehr verändert werden.</para>
3128 <para>Abhängig vom Wert für <varname>default_manager</varname> in
3129 <filename>config/kivitendo.conf</filename> werden dabei folgende Werte
3130 voreingestellt:</para>
3134 <para>0.05 (default_manager = swiss)</para>
3138 <para>0.01 (default_manager = german)</para>
3142 <para>Der Wert wird in der Datenbank in der Tabelle <varname>defaults
3143 </varname>in der Spalte <varname>precision</varname> gespeichert.</para>
3145 <para>In allen Verkaufsangeboten, Verkaufsaufträgen, Verkaufsrechnungen
3146 und Verkaufsgutschriften wird der Endbetrag inkl. MWST gerundet, wenn
3147 dieser nicht der eingestellten Genauigkeit entspricht.</para>
3149 <para>Beim Buchen einer Verkaufsrechnung wird der Rundungsbetrag
3150 automatisch auf die in der Mandantenkonfiguration festgelegten
3151 Standardkonten für Rundungserträge bzw. Rundungsaufwendungen
3154 <para>(Die berechnete MWST wird durch den Rundungsbetrag nicht mehr
3157 <para>Die in den Druckvorlagen zur Verfügung stehenden Variablen
3158 <varname>quototal</varname>, <varname>ordtotal</varname> bzw.
3159 <varname>invtotal</varname> enthalten den gerundeten Betrag.</para>
3161 <para><emphasis role="bold">Achtung:</emphasis> Werden Verkaufsbelege in
3162 anderen Währungen als der Standardwährung erstellt, so muss in kivitendo
3163 ab Version 3.4.1 die Genauigkeit 0.01 verwendet werden.</para>
3165 <para>Das heisst, Firmen in der Schweiz, die teilweise
3166 Verkaufsrechnungen in Euro oder anderen Währungen erstellen wollen,
3167 müssen beim Erstellen der Datenbank als Genauigkeit 0.01 wählen und
3168 können zur Zeit die 5er Rundung noch nicht nutzen.</para>
3171 <sect1 id="config.client">
3172 <title>Einstellungen pro Mandant</title>
3174 <para>Einige Einstellungen können von einem Benutzer mit dem <link
3175 linkend="Zusammenhänge">Recht</link> "Administration (Für die Verwaltung
3176 der aktuellen Instanz aus einem Userlogin heraus)" gemacht werden. Diese
3177 Einstellungen sind dann für die aktuellen Mandanten-Datenbank gültig.
3178 Die Einstellungen sind unter <guimenu>System</guimenu> →
3179 <guisubmenu>Mandantenkonfiguration</guisubmenu> erreichbar.</para>
3181 <para>Bitte beachten Sie die Hinweise zu den einzelnen Einstellungen.
3182 Einige Einstellungen sollten nicht ohne Weiteres im laufenden Betrieb
3183 geändert werden (siehe auch <link
3184 linkend="config.eur.inventory-system-perpetual">Bemerkungen zu
3185 Bestandsmethode</link>).</para>
3187 <para>Die Einstellungen <literal>show_bestbefore</literal> und
3188 <literal>payments_changeable</literal> aus dem Abschnitt
3189 <literal>features</literal> und die Einstellungen im Abschnitt
3190 <literal>datev_check</literal> (sofern schon vorhanden) der <link
3191 linkend="config.config-file">kivitendo-Konfigurationsdatei</link> werden
3192 bei einem Datenbankupdate einer älteren Version automatisch übernommen.
3193 Diese Einträge können danach aus der Konfigurationsdatei entfernt
3197 <sect1 id="kivitendo-ERP-verwenden">
3198 <title>kivitendo ERP verwenden</title>
3200 <para>Nach erfolgreicher Installation ist der Loginbildschirm unter
3201 folgender URL erreichbar:</para>
3204 url="http://localhost/kivitendo-erp/login.pl">http://localhost/kivitendo-erp/login.pl</ulink></para>
3206 <para>Die Administrationsseite erreichen Sie unter:</para>
3209 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
3213 <chapter id="features" xreflabel="Features und Funktionen">
3214 <title>Features und Funktionen</title>
3216 <sect1 id="features.periodic-invoices"
3217 xreflabel="Wiederkehrende Rechnungen">
3218 <title>Wiederkehrende Rechnungen</title>
3220 <sect2 id="features.periodic-invoices.introduction"
3221 xreflabel="Einführung in wiederkehrende Rechnungen">
3222 <title>Einführung</title>
3224 <para>Wiederkehrende Rechnungen werden als normale Aufträge definiert
3225 und konfiguriert, mit allen dazugehörigen Kunden- und Artikelangaben.
3226 Die konfigurierten Aufträge werden später automatisch in Rechnungen
3227 umgewandelt, so als ob man den Workflow benutzen würde, und auch die
3228 Auftragsnummer wird übernommen, sodass alle wiederkehrenden
3229 Rechnungen, die aus einem Auftrag erstellt wurden, später leicht
3230 wiederzufinden sind.</para>
3233 <sect2 id="features.periodic-invoices.configuration"
3234 xreflabel="Konfiguration von wiederkehrenden Rechnungen">
3235 <title>Konfiguration</title>
3237 <para>Um einen Auftrag für wiederkehrende Rechnung zu konfigurieren,
3238 findet sich beim Bearbeiten des Auftrags ein neuer Knopf
3239 "Konfigurieren", der ein neues Fenster öffnet, in dem man die nötigen
3240 Parameter einstellen kann. Hinter dem Knopf wird außerdem noch
3241 angezeigt, ob der Auftrag als wiederkehrende Rechnung konfiguriert ist
3244 <para>Folgende Parameter kann man konfigurieren:</para>
3251 <para>Bei aktiven Rechnungen wird automatisch eine Rechnung
3252 erstellt, wenn die Periodizität erreicht ist (z.B. am Anfang
3253 eines neuen Monats).</para>
3255 <para>Ist ein Auftrag nicht aktiv, so werden für ihn auch keine
3256 wiederkehrenden Rechnungen erzeugt. Stellt man nach längerer
3257 nicht-aktiver Zeit einen Auftrag wieder auf aktiv, wird beim
3258 nächsten Periodenwechsel für alle Perioden, seit der letzten
3259 aktiven Periode, jeweils eine Rechnung erstellt. Möchte man dies
3260 verhindern, muss man vorher das Startdatum neu setzen.</para>
3262 <para>Für gekündigte Aufträge werden nie mehr Rechnungen
3263 erstellt. Man kann sich diese Aufträge aber gesondert in den
3264 Berichten anzeigen lassen.</para>
3269 <term>Periodizität</term>
3272 <para>Ob monatlich, quartalsweise oder jährlich auf neue
3273 Rechnungen überprüft werden soll. Für jede Periode seit dem
3274 Startdatum wird überprüft, ob für die Periode (beginnend immer
3275 mit dem ersten Tag der Periode) schon eine Rechnung erstellt
3276 wurde. Unter Umständen können bei einem Startdatum in der
3277 Vergangenheit gleich mehrere Rechnungen erstellt werden.</para>
3282 <term>Buchen auf</term>
3285 <para>Das Forderungskonto, in der Regel "Forderungen aus
3286 Lieferungen und Leistungen". Das Gegenkonto ergibt sich aus den
3287 Buchungsgruppen der betreffenden Waren.</para>
3292 <term>Startdatum</term>
3295 <para>ab welchem Datum auf Rechnungserstellung geprüft werden
3301 <term>Enddatum</term>
3304 <para>ab wann keine Rechnungen mehr erstellt werden
3310 <term>Automatische Verlängerung um x Monate</term>
3313 <para>Sollen die wiederkehrenden Rechnungen bei Erreichen des
3314 eingetragenen Enddatums weiterhin erstellt werden, so kann man
3315 hier die Anzahl der Monate eingeben, um die das Enddatum
3316 automatisch nach hinten geschoben wird.</para>
3321 <term>Drucken</term>
3324 <para>Sind Drucker konfiguriert, so kann man sich die erstellten
3325 Rechnungen auch gleich ausdrucken lassen.</para>
3330 <para>Nach Erstellung der Rechnungen kann eine E-Mail mit
3331 Informationen zu den erstellten Rechnungen verschickt werden.
3332 Konfiguriert wird dies in der <link
3333 linkend="config.config-file.sections-parameters">Konfigurationsdatei</link>
3334 <filename>config/kivitendo.conf</filename> im Abschnitt
3335 <varname>[periodic_invoices]</varname>.</para>
3338 <sect2 id="features.periodic-invoices.variables">
3339 <title>Spezielle Variablen</title>
3341 <para>Um die erzeugten Rechnungen individualisieren zu können, werden
3342 beim Umwandeln des Auftrags in eine Rechnung einige speziell
3343 formatierte Variablen durch für die jeweils aktuelle
3344 Abrechnungsperiode gültigen Werte ersetzt. Damit ist es möglich, z.B.
3345 den Abrechnungszeitraum explizit auszuweisen. Eine Variable hat dabei
3346 die Syntax <literal><%variablenname%></literal>.</para>
3348 <para>Sofern es sich um eine Datumsvariable handelt, kann das
3349 Ausgabeformat weiter bestimmt werden, indem an den Variablennamen
3350 Formatoptionen angehängt werden. Die Syntax sieht dabei wie folgt aus:
3351 <literal><%variablenname FORMAT=Formatinformation%></literal>.
3352 Die zur verfügung stehenden Formatinformationen werden unten genauer
3355 <para>Diese Variablen können auch beim automatischen Versand der
3356 erzeugten Rechnungen per E-Mail genutzt werden, indem sie in den
3357 Feldern für den Betreff oder die Nachricht verwendet werden.</para>
3359 <para>Diese Variablen werden in den folgenden Elementen des Auftrags
3364 <para>Bemerkungen</para>
3368 <para>Interne Bemerkungen</para>
3372 <para>Vorgangsbezeichnung</para>
3376 <para>In den Beschreibungs- und Langtextfeldern aller
3381 <para>Die zur Verfügung stehenden Variablen sind die Folgenden:</para>
3385 <term><varname><%current_quarter%></varname>,
3386 <varname><%previous_quarter%></varname>,
3387 <varname><%next_quarter%></varname></term>
3390 <para>Aktuelles, vorheriges und nächstes Quartal als Zahl
3391 zwischen <literal>1</literal> und <literal>4</literal>.</para>
3396 <term><varname><%current_month%></varname>,
3397 <varname><%previous_month%></varname>,
3398 <varname><%next_month%></varname></term>
3401 <para>Aktueller, vorheriger und nächster Monat als Zahl zwischen
3402 <literal>1</literal> und <literal>12</literal>.</para>
3407 <term><varname><%current_month_long%></varname>,
3408 <varname><%previous_month_long%></varname>,
3409 <varname><%next_month_long%></varname></term>
3412 <para>Aktueller, vorheriger und nächster Monat als Name
3413 (<literal>Januar</literal>, <literal>Februar</literal>
3419 <term><varname><%current_year%></varname>,
3420 <varname><%previous_year%></varname>,
3421 <varname><%next_year%></varname></term>
3424 <para>Aktuelles, vorheriges und nächstes Jahr als vierstellige
3425 Jahreszahl (<literal>2013</literal> etc.).</para>
3430 <term><varname><%period_start_date%></varname>,
3431 <varname><%period_end_date%></varname></term>
3434 <para>Formatiertes Datum des ersten und letzten Tages im
3435 Abrechnungszeitraum (z.B. bei quartalsweiser Abrechnung und im
3436 ersten Quartal von 2013 wären dies der
3437 <literal>01.01.2013</literal> und
3438 <literal>31.03.2013</literal>).</para>
3443 <para>Die invidiuellen Formatinformationen bestehen aus Paaren von
3444 Prozentzeichen und einem Buchstaben, welche beide zusammen durch den
3445 dazugehörigen Wert ersetzt werden. So wird z.B. <literal>%Y</literal>
3446 durch das viertstellige Jahr ersetzt. Alle möglichen Platzhalter
3451 <term><varname>%a</varname></term>
3454 <para>Der abgekürzte Wochentagsname.</para>
3459 <term><varname>%A</varname></term>
3462 <para>Der ausgeschriebene Wochentagsname.</para>
3467 <term><varname>%b</varname></term>
3470 <para>Der abgekürzte Monatsname.</para>
3475 <term><varname>%B</varname></term>
3478 <para>Der ausgeschriebene Monatsname.</para>
3483 <term><varname>%C</varname></term>
3486 <para>Das Jahrhundert (Jahr/100) als eine zweistellige
3492 <term><varname>%d</varname></term>
3495 <para>Der Monatstag als Zahl zwischen 01 und 31.</para>
3500 <term><varname>%D</varname></term>
3503 <para>Entspricht %m/%d/%y (amerikanisches Datumsformat).</para>
3508 <term><varname>%e</varname></term>
3511 <para>Wie %d (Monatstag als Zahl zwischen 1 und 31), allerdings
3512 werden führende Nullen durch Leerzeichen ersetzt.</para>
3517 <term><varname>%F</varname></term>
3520 <para>Entspricht %Y-%m-%d (das ISO-8601-Datumsformat).</para>
3525 <term><varname>%j</varname></term>
3528 <para>Der Tag im Jahr als Zahl zwischen 001 und 366
3534 <term><varname>%m</varname></term>
3537 <para>Der Monat als Zahl zwischen 01 und 12 inklusive.</para>
3542 <term><varname>%u</varname></term>
3545 <para>Der Wochentag als Zahl zwischen 1 und 7 inklusive, wobei
3546 die 1 dem Montag entspricht.</para>
3551 <term><varname>%U</varname></term>
3554 <para>Die Wochennummer als Zahl zwischen 00 und 53 inklusive,
3555 wobei der erste Sonntag im Jahr das Startdatum von Woche 01
3561 <term><varname>%V</varname></term>
3564 <para>Die ISO-8601:1988-Wochennummer als Zahl zwischen 01 und 53
3565 inklusive, wobei Woche 01 die erste Woche, von der mindestens
3566 vier Tage im Jahr liegen; Montag ist erster Tag der
3572 <term><varname>%w</varname></term>
3575 <para>Der Wochentag als Zahl zwischen 0 und 6 inklusive, wobei
3576 die 0 dem Sonntag entspricht.</para>
3581 <term><varname>%W</varname></term>
3584 <para>Die Wochennummer als Zahl zwischen 00 und 53 inklusive,
3585 wobei der erste Montag im Jahr das Startdatum von Woche 01
3591 <term><varname>%y</varname></term>
3594 <para>Das Jahr als zweistellige Zahl zwischen 00 und 99
3600 <term><varname>%Y</varname></term>
3603 <para>Das Jahr als vierstellige Zahl.</para>
3608 <term><varname>%%</varname></term>
3611 <para>Das Prozentzeichen selber.</para>
3616 <para>Anwendungsbeispiel für die Ausgabe, von welchem Monat und Jahr
3617 bis zu welchem Monat und Jahr die aktuelle Abrechnungsperiode dauert:
3618 <literal>Abrechnungszeitrum: <%period_start_date FORMAT=%m/%Y%>
3619 bis <%period_end_date FORMAT=%m/%Y%></literal></para>
3622 <sect2 id="features.periodic-invoices.reports">
3623 <title>Auflisten</title>
3625 <para>Unter Verkauf->Berichte->Aufträge finden sich zwei neue
3626 Checkboxen, "Wiederkehrende Rechnungen aktiv" und "Wiederkehrende
3627 Rechnungen inaktiv", mit denen man sich einen Überglick über die
3628 wiederkehrenden Rechnungen verschaffen kann.</para>
3631 <sect2 id="features.periodic-invoices.task-server">
3632 <title>Erzeugung der eigentlichen Rechnungen</title>
3634 <para>Die zeitliche und periodische Überprüfung, ob eine
3635 wiederkehrende Rechnung automatisch erstellt werden soll, geschieht
3636 durch den <link linkend="config.task-server">Taskserver</link>, einen
3637 externen Dienst, der automatisch beim Start des Servers gestartet
3638 werden sollte.</para>
3641 <sect2 id="features.periodic-invoices.create-for-current-month">
3642 <title>Erste Rechnung für aktuellen Monat erstellen</title>
3644 <para>Will man im laufenden Monat eine monatlich wiederkehrende
3645 Rechnung inkl. des laufenden Monats starten, stellt man das Startdatum
3646 auf den Monatsanfang und wartet ein paar Minuten, bis der Taskserver
3647 den neu konfigurieren Auftrag erkennt und daraus eine Rechnung
3648 generiert hat. Alternativ setzt man das Startdatum auf den
3649 Monatsersten des Folgemonats und erstellt die erste Rechnung direkt
3650 manuell über den Workflow.</para>
3654 <sect1 id="features.bank" xreflabel="bankerweiterung">
3655 <title>Bankerweiterung</title>
3657 <sect2 id="features.bank.introduction"
3658 xreflabel="Einführung in die Bankerweiterung">
3659 <title>Einführung</title>
3661 <para>Die Beschreibung der Bankerweiterung befindet sich derzeit noch
3662 im Wiki und soll von dort später hierhin übernommen werden:</para>
3665 url="http://redmine.kivitendo-premium.de/projects/forum/wiki/Bankerweiterung">http://redmine.kivitendo-premium.de/projects/forum/wiki/Bankerweiterung</ulink></para>
3669 <sect1 id="dokumentenvorlagen-und-variablen">
3670 <title>Dokumentenvorlagen und verfügbare Variablen</title>
3672 <sect2 id="dokumentenvorlagen-und-variablen.einführung">
3673 <title>Einführung</title>
3675 <para>Dies ist eine Auflistung der Standard-Dokumentenvorlagen und
3676 aller zur Bearbeitung verfügbaren Variablen. Eine Variable wird in
3677 einer Vorlage durch ihren Inhalt ersetzt, wenn sie in der Form
3678 <function><%variablenname%></function> verwendet wird. Für
3679 LaTeX- und HTML-Vorlagen kann man die Form dieser Tags auch verändern
3681 linkend="dokumentenvorlagen-und-variablen.tag-style"/>).</para>
3683 <para>kivitendo unterstützt LaTeX-, HTML- und OpenDocument-Vorlagen.
3684 Sofern es nicht ausdrücklich eingeschränkt wird, gilt das im Folgenden
3685 gesagte für alle Vorlagenarten.</para>
3687 <para>Insgesamt sind technisch gesehen eine ganze Menge mehr Variablen
3688 verfügbar als hier aufgelistet werden. Die meisten davon können
3689 allerdings innerhalb einer solchen Vorlage nicht sinnvoll verwendet
3690 werden. Wenn eine Auflistung dieser Variablen gewollt ist, so kann
3691 diese wie folgt erhalten werden:</para>
3695 <para><filename>SL/Form.pm</filename> öffnen und am Anfang die
3696 Zeile "<command>use Data::Dumper;</command>" einfügen.</para>
3700 <para>In <filename>Form.pm</filename> die Funktion
3701 <function>parse_template</function> suchen und hier die Zeile
3702 <command>print(STDERR Dumper($self));</command> einfügen.</para>
3706 <para>Einmal per Browser die gewünschte Vorlage "benutzen", z.B.
3707 ein PDF für eine Rechnung erzeugen.</para>
3711 <para>Im <filename>error.log</filename> Apache steht die Ausgabe
3712 der Variablen <varname>$self</varname> in der Form <varname>'key'
3713 => 'value',</varname>. Alle <varname>key</varname>s sind
3719 <sect2 id="dokumentenvorlagen-und-variablen.variablen-ausgeben">
3720 <title>Variablen ausgeben</title>
3722 <para>Um eine Variable auszugeben, müssen sie einfach nur zwischen die
3723 Tags geschrieben werden, also z.B.
3724 <varname><%variablenname%></varname>.</para>
3726 <para>Optional kann man auch mit Leerzeichen getrennte Flags angeben,
3727 die man aber nur selten brauchen wird. Die Syntax sieht also so aus:
3728 <varname><%variablenname FLAG1 FLAG2%></varname>. Momentan
3729 werden die folgenden Flags unterstützt:</para>
3733 <para><option>NOFORMAT</option> gilt nur für Zahlenwerte und gibt
3734 den Wert ohne Formatierung, also ohne Tausendertrennzeichen mit
3735 mit einem Punkt als Dezimaltrennzeichen aus. Nützlich z.B., wenn
3736 damit in der Vorlage z.B. von LaTeX gerechnet werden soll.</para>
3740 <para><option>NOESCAPE</option> unterdrückt das Escapen von
3741 Sonderzeichen für die Vorlagensprache. Wenn also in einer
3742 Variablen bereits gültiger LaTeX-Code steht und dieser von LaTeX
3743 auch ausgewertet und nicht wortwörtlich angezeigt werden soll, so
3744 ist dieses Flag sinnvoll.</para>
3748 <para>Beispiel:</para>
3750 <programlisting><%quototal NOFORMAT%></programlisting>
3753 <sect2 id="dokumentenvorlagen-und-variablen.verwendung-in-druckbefehlen">
3754 <title>Verwendung in Druckbefehlen</title>
3756 <para>In der Admininstration können Drucker definiert werden. Auch im
3757 dort eingebbaren Druckbefehl können die hier aufgelisteten Variablen
3758 und Kontrollstrukturen verwendet werden. Ihr Inhalt wird dabei nach
3759 den Regeln der gängigen Shells formatiert, sodass Sonderzeichen wie
3760 <function>`...`</function> nicht zu unerwünschtem Verhalten
3763 <para>Dies erlaubt z.B. die Definition eines Faxes als Druckerbefehl,
3764 für das die Telefonnummer eines Ansprechpartners als Teil der
3765 Kommandozeile verwendet wird. Für ein fiktives Kommando könnte das
3766 z.B. wie folgt aussehen:</para>
3768 <programlisting>send_fax --number <%if cp_phone2%><%cp_phone2%><%else%><%cp_phone1%><%end%></programlisting>
3771 <sect2 id="dokumentenvorlagen-und-variablen.tag-style"
3772 xreflabel="Anfang und Ende der Tags verändern">
3773 <title>Anfang und Ende der Tags verändern</title>
3775 <para>Der Standardstil für Tags sieht vor, dass ein Tag mit dem
3776 Kleinerzeichen und einem Prozentzeichen beginnt und mit dem
3777 Prozentzeichen und dem Größerzeichen endet, beispielsweise
3778 <function><%customer%></function>. Da diese Form aber z.B. in
3779 LaTeX zu Problemen führen kann, weil das Prozentzeichen dort
3780 Kommentare einleitet, kann pro HTML- oder LaTeX-Dokumentenvorlage der
3781 Stil umgestellt werden.</para>
3783 <para>Dazu werden in die Datei Zeilen geschrieben, die mit dem für das
3784 Format gültigen Kommentarzeichen anfangen, dann
3785 <function>config:</function> enthalten, die entsprechende Option
3786 setzen und bei HTML-Dokumentenvorlagen mit dem Kommentarendzeichen
3787 enden. Beispiel für LaTeX:</para>
3789 <programlisting>% config: tag-style=($ $)</programlisting>
3791 <para>Dies würde kivitendo dazu veranlassen, Variablen zu ersetzen,
3792 wenn sie wie folgt aussehen: <function>($customer$)</function>. Das
3793 äquivalente Beispiel für HTML-Dokumentenvorlagen sieht so aus:</para>
3795 <programlisting><!-- config: tag-style=($ $) --></programlisting>
3798 <sect2 id="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">
3799 <title>Zuordnung von den Dateinamen zu den Funktionen</title>
3801 <para>Diese folgende kurze Auflistung zeigt, welche Vorlage bei
3802 welcher Funktion ausgelesen wird. Dabei ist die Dateiendung
3803 "<filename>.ext</filename>" geeignet zu ersetzen:
3804 "<filename>.tex</filename>" für LaTeX-Vorlagen und
3805 "<filename>.odt</filename>" für OpenDocument-Vorlagen.</para>
3809 <term><filename>bin_list.ext</filename></term>
3812 <para>Lagerliste</para>
3817 <term><filename>check.ext</filename></term>
3825 <term><filename>invoice.ext</filename></term>
3828 <para>Rechnung</para>
3833 <term><filename>packing_list.ext</filename></term>
3836 <para>Packliste</para>
3841 <term><filename>pick_list.ext</filename></term>
3844 <para>Sammelliste</para>
3849 <term><filename>purchase_delivery_order.ext</filename></term>
3852 <para>Lieferschein (Einkauf)</para>
3857 <term><filename>purcharse_order.ext</filename></term>
3860 <para>Bestellung an Lieferanten</para>
3865 <term><filename>request_quotation.ext</filename></term>
3868 <para>Anfrage an Lieferanten</para>
3873 <term><filename>sales_delivery_order.ext</filename></term>
3876 <para>Lieferschein (Verkauf)</para>
3881 <term><filename>sales_order.ext</filename></term>
3884 <para>Bestellung</para>
3889 <term><filename>sales_quotation.ext</filename></term>
3892 <para>Angebot an Kunden</para>
3897 <term><filename>zahlungserinnerung.ext</filename></term>
3900 <para>Mahnung (Dateiname im Programm konfigurierbar)</para>
3905 <term><filename>zahlungserinnerung_invoice.ext</filename></term>
3908 <para>Rechnung über Mahngebühren (Dateiname im Programm
3909 konfigurierbar)</para>
3915 <sect2 id="dokumentenvorlagen-und-variablen.dateinamen-erweitert">
3916 <title>Sprache, Drucker und E-Mail</title>
3918 <para>Angeforderte Sprache und Druckerkürzel in den Dateinamen mit
3919 eingearbeitet. So wird aus der Vorlage
3920 <filename>sales_order.ext</filename> bei Sprache
3921 <function>de</function> und Druckerkürzel <function>lpr2</function>
3922 der Vorlagenname <filename>sales_order_de_lpr2.ext</filename>.
3923 Zusätzlich können für E-Mails andere Vorlagen erstellt werden, diese
3924 bekommen dann noch das Kürzel <filename>_email</filename>, der
3925 vollständige Vorlagenname wäre dann
3926 <filename>sales_order_email_de_lpr2.ext</filename>. In allen Fällen
3927 kann eine Standarddatei <filename>default.ext</filename> hinterlegt
3928 werden. Diese wird verwendet, wenn keine der anderen Varianten
3929 gefunden wird.</para>
3931 <para>Die vollständige Suchreihenfolge für einen Verkaufsauftrag mit
3932 der Sprache "de" und dem Drucker "lpr2", der per E-Mail im Format PDF
3933 verschickt wird, ist:</para>
3937 <para><filename>sales_order_email_de_lpr2.tex</filename></para>
3941 <para><filename>sales_order_de_lpr2.tex</filename></para>
3945 <para><filename>sales_order.tex</filename></para>
3949 <para><filename>default.tex</filename></para>
3953 <para>Die kurzen Varianten dieser Vorlagentitel müssen dann entweder
3954 Standardwerte anzeigen, oder die angeforderten Werte selbst auswerten,
3956 linkend="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"/>.</para>
3959 <sect2 id="dokumentenvorlagen-und-variablen.allgemeine-variablen">
3960 <title>Allgemeine Variablen, die in allen Vorlagen vorhanden
3963 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"
3964 xreflabel="Metainformationen zur angeforderten Vorlage">
3965 <title>Metainformationen zur angeforderten Vorlage</title>
3967 <para>Diese Variablen liefern Informationen darüber welche Variante
3968 einer Vorlage der Benutzer angefragt hat. Sie sind nützlich für
3969 Vorlagenautoren, die aus einer zentralen Layoutvorlage die einzelnen
3970 Formulare einbinden möchten.</para>
3974 <term><varname>template_meta.formname</varname></term>
3977 <para>Basisname der Vorlage. Identisch mit der <link
3978 linkend="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">Zurordnung
3979 zu den Dateinamen</link> ohne die Erweiterung. Ein
3980 Verkaufsauftrag enthält hier
3981 <constant>sales_order</constant>.</para>
3986 <term><varname>template_meta.language.description</varname></term>
3989 <para>Beschreibung der verwendeten Sprache</para>
3994 <term><varname>template_meta.language.template_code</varname></term>
3997 <para>Vorlagenkürzel der verwendeten Sprache, identisch mit
3998 dem Kürzel das im Dateinamen verwendetet wird.</para>
4003 <term><varname>template_meta.language.output_numberformat</varname></term>
4006 <para>Zahlenformat der verwendeten Sprache in der Form
4007 "<constant>1.000,00</constant>". Experimentell! Nur
4008 interessant für Vorlagen die mit unformatierten Werten
4014 <term><varname>template_meta.language.output_dateformat</varname></term>
4017 <para>Datumsformat der verwendeten Sprache in der Form
4018 "<constant>dd.mm.yyyy</constant>". Experimentell! Nur
4019 interessant für Vorlagen die mit unformatierten Werten
4025 <term><varname>template_meta.format</varname></term>
4028 <para>Das angeforderte Format. Kann im Moment die Werte
4029 <constant>pdf</constant>, <constant>postscript</constant>,
4030 <constant>html</constant>, <constant>opendocument</constant>,
4031 <constant>opendocument_pdf</constant> und
4032 <constant>excel</constant> enthalten.</para>
4037 <term><varname>template_meta.extension</varname></term>
4040 <para>Dateierweiterung, wie im Dateinamen. Wird aus
4041 <constant>format</constant> entschieden.</para>
4046 <term><varname>template_meta.media</varname></term>
4049 <para>Ausgabemedium. Kann zur Zeit die Werte
4050 <constant>screen</constant> für Bildschirm,
4051 <constant>email</constant> für E-Mail (triggert das
4052 <constant>_email</constant> Kürzel im Dateinamen),
4053 <constant>printer</constant> für Drucker, und
4054 <constant>queue</constant> für Warteschlange enthalten.</para>
4059 <term><varname>template_meta.printer.description</varname></term>
4062 <para>Beschreibung des ausgewählten Druckers</para>
4067 <term><varname>template_meta.printer.template_code</varname></term>
4070 <para>Vorlagenürzel des ausgewählten Druckers, identisch mit
4071 dem Kürzel das im Dateinamen verwendetet wird.</para>
4076 <term><varname>template_meta.tmpfile</varname></term>
4079 <para>Datei-Prefix für temporäre Dateien.</para>
4085 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.kunden-lieferanten">
4086 <title>Stammdaten von Kunden und Lieferanten</title>
4090 <term><varname>account_number</varname></term>
4093 <para>Kontonummer</para>
4098 <term><varname>bank</varname></term>
4101 <para>Name der Bank</para>
4106 <term><varname>bank_code</varname></term>
4109 <para>Bankleitzahl</para>
4114 <term><varname>bic</varname></term>
4117 <para>Bank-Identifikations-Code (Bank Identifier Code,
4123 <term><varname>business</varname></term>
4126 <para>Kunden-/Lieferantentyp</para>
4131 <term><varname>city</varname></term>
4139 <term><varname>contact</varname></term>
4142 <para>Kontakt</para>
4147 <term><varname>country</varname></term>
4155 <term><varname>c_vendor_id</varname></term>
4158 <para>Lieferantennummer beim Kunden (nur Kunden)</para>
4163 <term><varname>v_customer_id</varname></term>
4166 <para>Kundennummer beim Lieferanten (nur Lieferanten)</para>
4171 <term><varname>cp_email</varname></term>
4174 <para>Email des Ansprechpartners</para>
4179 <term><varname>cp_givenname</varname></term>
4182 <para>Vorname des Ansprechpartners</para>
4187 <term><varname>cp_greeting</varname></term>
4190 <para>Anrede des Ansprechpartners</para>
4195 <term><varname>cp_name</varname></term>
4198 <para>Name des Ansprechpartners</para>
4203 <term><varname>cp_phone1</varname></term>
4206 <para>Telefonnummer 1 des Ansprechpartners</para>
4211 <term><varname>cp_phone2</varname></term>
4214 <para>Telefonnummer 2 des Ansprechpartners</para>
4219 <term><varname>cp_title</varname></term>
4222 <para>Titel des Ansprechpartners</para>
4227 <term><varname>creditlimit</varname></term>
4230 <para>Kreditlimit</para>
4235 <term><varname>customeremail</varname></term>
4238 <para>Email des Kunden; nur für Kunden</para>
4243 <term><varname>customerfax</varname></term>
4246 <para>Faxnummer des Kunden; nur für Kunden</para>
4251 <term><varname>customernotes</varname></term>
4254 <para>Bemerkungen beim Kunden; nur für Kunden</para>
4259 <term><varname>customernumber</varname></term>
4262 <para>Kundennummer; nur für Kunden</para>
4267 <term><varname>customerphone</varname></term>
4270 <para>Telefonnummer des Kunden; nur für Kunden</para>
4275 <term><varname>discount</varname></term>
4283 <term><varname>email</varname></term>
4286 <para>Emailadresse</para>
4291 <term><varname>fax</varname></term>
4294 <para>Faxnummer</para>
4299 <term><varname>gln</varname></term>
4302 <para>GLN (Globale Lokationsnummer)</para>
4307 <term><varname>greeting</varname></term>
4315 <term><varname>homepage</varname></term>
4318 <para>Homepage</para>
4323 <term><varname>iban</varname></term>
4326 <para>Internationale Kontonummer (International Bank Account
4327 Number, IBAN)</para>
4332 <term><varname>language</varname></term>
4335 <para>Sprache</para>
4340 <term><varname>name</varname></term>
4343 <para>Firmenname</para>
4348 <term><varname>payment_description</varname></term>
4351 <para>Name der Zahlart</para>
4356 <term><varname>payment_terms</varname></term>
4359 <para>Zahlungskonditionen</para>
4364 <term><varname>phone</varname></term>
4367 <para>Telefonnummer</para>
4372 <term><varname>shiptocity</varname></term>
4375 <para>Stadt (Lieferadresse) <link
4376 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4381 <term><varname>shiptocontact</varname></term>
4384 <para>Kontakt (Lieferadresse) <link
4385 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4390 <term><varname>shiptocountry</varname></term>
4393 <para>Land (Lieferadresse) <link
4394 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4399 <term><varname>shiptodepartment_1</varname></term>
4402 <para>Abteilung 1 (Lieferadresse) <link
4403 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4408 <term><varname>shiptodepartment_2</varname></term>
4411 <para>Abteilung 2 (Lieferadresse) <link
4412 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4417 <term><varname>shiptoemail</varname></term>
4420 <para>Email (Lieferadresse) <link
4421 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4426 <term><varname>shiptofax</varname></term>
4429 <para>Fax (Lieferadresse) <link
4430 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4435 <term><varname>shiptogln</varname></term>
4438 <para>GLN (Globale Lokationsnummer) (Lieferadresse) <link
4439 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4444 <term><varname>shiptoname</varname></term>
4447 <para>Firmenname (Lieferadresse) <link
4448 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4453 <term><varname>shiptophone</varname></term>
4456 <para>Telefonnummer (Lieferadresse) <link
4457 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4462 <term><varname>shiptostreet</varname></term>
4465 <para>Straße und Hausnummer (Lieferadresse) <link
4466 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4471 <term><varname>shiptozipcode</varname></term>
4474 <para>Postleitzahl (Lieferadresse) <link
4475 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4480 <term><varname>street</varname></term>
4483 <para>Straße und Hausnummer</para>
4488 <term><varname>taxnumber</varname></term>
4491 <para>Steuernummer</para>
4496 <term><varname>ustid</varname></term>
4499 <para>Umsatzsteuer-Identifikationsnummer</para>
4504 <term><varname>vendoremail</varname></term>
4507 <para>Email des Lieferanten; nur für Lieferanten</para>
4512 <term><varname>vendorfax</varname></term>
4515 <para>Faxnummer des Lieferanten; nur für Lieferanten</para>
4520 <term><varname>vendornotes</varname></term>
4523 <para>Bemerkungen beim Lieferanten; nur für Lieferanten</para>
4528 <term><varname>vendornumber</varname></term>
4531 <para>Lieferantennummer; nur für Lieferanten</para>
4536 <term><varname>vendorphone</varname></term>
4539 <para>Telefonnummer des Lieferanten; nur für
4545 <term><varname>zipcode</varname></term>
4548 <para>Postleitzahl</para>
4553 <note id="dokumentenvorlagen-und-variablen.anmerkung-shipto">
4554 <para>Anmerkung: Sind die <varname>shipto*</varname>-Felder in den
4555 Stammdaten nicht eingetragen, so haben die Variablen
4556 <varname>shipto*</varname> den gleichen Wert wie die die
4557 entsprechenden Variablen der Lieferdaten. Das bedeutet, dass sich
4558 einige <varname>shipto*</varname>-Variablen so nicht in den
4559 Stammdaten wiederfinden sondern schlicht Kopien der
4560 Lieferdatenvariablen sind (z.B.
4561 <varname>shiptocontact</varname>).</para>
4565 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-bearbeiter">
4566 <title>Informationen über den Bearbeiter</title>
4570 <term><varname>employee_address</varname></term>
4573 <para>Adressfeld</para>
4578 <term><varname>employee_businessnumber</varname></term>
4581 <para>Firmennummer</para>
4586 <term><varname>employee_company</varname></term>
4589 <para>Firmenname</para>
4594 <term><varname>employee_co_ustid</varname></term>
4597 <para>Usatzsteuer-Identifikationsnummer</para>
4602 <term><varname>employee_duns</varname></term>
4605 <para>DUNS-Nummer</para>
4610 <term><varname>employee_email</varname></term>
4618 <term><varname>employee_fax</varname></term>
4626 <term><varname>employee_name</varname></term>
4629 <para>voller Name</para>
4634 <term><varname>employee_signature</varname></term>
4637 <para>Signatur</para>
4642 <term><varname>employee_taxnumber</varname></term>
4645 <para>Steuernummer</para>
4650 <term><varname>employee_tel</varname></term>
4653 <para>Telefonnummer</para>
4659 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-verkaeufer">
4660 <title>Informationen über den Verkäufer</title>
4664 <term><varname>salesman_address</varname></term>
4667 <para>Adressfeld</para>
4672 <term><varname>salesman_businessnumber</varname></term>
4675 <para>Firmennummer</para>
4680 <term><varname>salesman_company</varname></term>
4683 <para>Firmenname</para>
4688 <term><varname>salesman_co_ustid</varname></term>
4691 <para>Usatzsteuer-Identifikationsnummer</para>
4696 <term><varname>salesman_duns</varname></term>
4699 <para>DUNS-Nummer</para>
4704 <term><varname>salesman_email</varname></term>
4712 <term><varname>salesman_fax</varname></term>
4720 <term><varname>salesman_name</varname></term>
4723 <para>voller Name</para>
4728 <term><varname>salesman_signature</varname></term>
4731 <para>Signatur</para>
4736 <term><varname>salesman_taxnumber</varname></term>
4739 <para>Steuernummer</para>
4744 <term><varname>salesman_tel</varname></term>
4747 <para>Telefonnummer</para>
4753 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-steuern">
4754 <title>Variablen für die einzelnen Steuern</title>
4758 <term><varname>tax</varname></term>
4766 <term><varname>taxbase</varname></term>
4769 <para>zu versteuernder Betrag</para>
4774 <term><varname>taxdescription</varname></term>
4777 <para>Name der Steuer</para>
4782 <term><varname>taxrate</varname></term>
4785 <para>Steuersatz</para>
4791 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-lieferbedingungen">
4792 <title>Variablen für Lieferbedingungen</title>
4796 <term><varname>delivery_term</varname></term>
4799 <para>Datenbank-Objekt der Lieferbedingung</para>
4804 <term><varname>delivery_term.description</varname></term>
4807 <para>Beschreibung der Lieferbedingung</para>
4812 <term><varname>delivery_term.description_long</varname></term>
4815 <para>Langtext bzw. übersetzter Langtext der
4816 Lieferbedingung</para>
4823 <sect2 id="dokumentenvorlagen-und-variablen.invoice">
4824 <title>Variablen in Rechnungen</title>
4826 <sect3 id="dokumentenvorlagen-und-variablen.invoice-allgemein">
4827 <title>Allgemeine Variablen</title>
4831 <term><varname>creditremaining</varname></term>
4834 <para>Verbleibender Kredit</para>
4839 <term><varname>currency</varname></term>
4842 <para>Währung</para>
4847 <term><varname>cusordnumber</varname></term>
4850 <para>Bestellnummer beim Kunden</para>
4855 <term><varname>deliverydate</varname></term>
4858 <para>Lieferdatum</para>
4863 <term><varname>duedate</varname></term>
4866 <para>Fälligkeitsdatum</para>
4871 <term><varname>globalprojectnumber</varname></term>
4874 <para>Projektnummer des ganzen Beleges</para>
4879 <term><varname>globalprojectdescription</varname></term>
4882 <para>Projekbeschreibung des ganzen Beleges</para>
4887 <term><varname>intnotes</varname></term>
4890 <para>Interne Bemerkungen</para>
4895 <term><varname>invdate</varname></term>
4898 <para>Rechnungsdatum</para>
4903 <term><varname>invnumber</varname></term>
4906 <para>Rechnungsnummer</para>
4911 <term><varname>invtotal</varname></term>
4914 <para>gesamter Rechnungsbetrag</para>
4919 <term><varname>notes</varname></term>
4922 <para>Bemerkungen der Rechnung</para>
4927 <term><varname>orddate</varname></term>
4930 <para>Auftragsdatum</para>
4935 <term><varname>ordnumber</varname></term>
4938 <para>Auftragsnummer, wenn die Rechnung aus einem Auftrag
4939 erstellt wurde</para>
4944 <term><varname>payment_description</varname></term>
4947 <para>Name der Zahlart</para>
4952 <term><varname>payment_terms</varname></term>
4955 <para>Zahlungskonditionen</para>
4960 <term><varname>quodate</varname></term>
4963 <para>Angebotsdatum</para>
4968 <term><varname>quonumber</varname></term>
4971 <para>Angebotsnummer</para>
4976 <term><varname>rounding</varname></term>
4979 <para>Betrag, um den <varname>invtotal</varname> gerundet
4980 wurde (kann positiv oder negativ sein)</para>
4985 <term><varname>shippingpoint</varname></term>
4988 <para>Versandort</para>
4993 <term><varname>shipvia</varname></term>
4996 <para>Transportmittel</para>
5001 <term><varname>subtotal</varname></term>
5004 <para>Zwischensumme aller Posten ohne Steuern</para>
5009 <term><varname>total</varname></term>
5012 <para>Restsumme der Rechnung (Summe abzüglich bereits
5013 bezahlter Posten)</para>
5018 <term><varname>transaction_description</varname></term>
5021 <para>Vorgangsbezeichnung</para>
5026 <term><varname>transdate</varname></term>
5029 <para>Auftragsdatum wenn die Rechnung aus einem Auftrag
5030 erstellt wurde</para>
5036 <sect3 id="dokumentenvorlagen-und-variablen.invoice-posten">
5037 <title>Variablen für jeden Posten auf der Rechnung</title>
5041 <term><varname>bin</varname></term>
5044 <para>Stellage</para>
5049 <term><varname>description</varname></term>
5052 <para>Artikelbeschreibung</para>
5057 <term><varname>cusordnumber_oe</varname></term>
5060 <para>Bestellnummer des Kunden aus dem Auftrag, aus dem der
5061 Posten ursprünglich stammt (nur Verkauf)</para>
5066 <term><varname>discount</varname></term>
5069 <para>Rabatt als Betrag</para>
5074 <term><varname>discount_sub</varname></term>
5077 <para>Zwischensumme mit Rabatt</para>
5082 <term><varname>donumber_do</varname></term>
5085 <para>Lieferscheinnummer des Lieferscheins, aus dem die
5086 Position ursprünglich stammt, wenn die Rechnung im Rahmen des
5087 Workflows aus einem Lieferschein erstellt wurde.</para>
5092 <term><varname>drawing</varname></term>
5095 <para>Zeichnung</para>
5100 <term><varname>ean</varname></term>
5103 <para>EAN-Code</para>
5108 <term><varname>image</varname></term>
5116 <term><varname>linetotal</varname></term>
5119 <para>Zeilensumme (Anzahl * Einzelpreis)</para>
5124 <term><varname>longdescription</varname></term>
5127 <para>Langtext</para>
5132 <term><varname>microfiche</varname></term>
5135 <para>Mikrofilm</para>
5140 <term><varname>netprice</varname></term>
5143 <para>Alternative zu <varname>sellprice</varname>, aber
5144 <varname>netprice</varname> entspricht dem effektiven
5145 Einzelpreis und beinhaltet Zeilenrabatt und Preisfaktor.
5146 <varname>netprice</varname> wird rückgerechnet aus Zeilensumme
5147 / Menge. Diese Variable ist nützlich, wenn man den gewährten
5148 Rabatt in der Druckvorlage nicht anzeigen möchte, aber Menge *
5149 Einzelpreis trotzdem die angezeigte Zeilensumme ergeben soll.
5150 <varname>netprice</varname> hat nichts mit Netto/Brutto im
5151 Sinne von Steuern zu tun.</para>
5156 <term><varname>nodiscount_linetotal</varname></term>
5159 <para>Zeilensumme ohne Rabatt</para>
5164 <term><varname>nodiscount_sub</varname></term>
5167 <para>Zwischensumme ohne Rabatt</para>
5172 <term><varname>number</varname></term>
5175 <para>Artikelnummer</para>
5180 <term><varname>ordnumber_oe</varname></term>
5183 <para>Auftragsnummer des Originalauftrags, aus dem der Posten
5184 ursprünglich stammt. Nützlich, wenn die Rechnung aus mehreren
5185 Lieferscheinen zusammengefasst wurde, oder wenn zwischendurch
5186 eine Sammelauftrag aus mehreren Aufträgen erstellt wurde. In
5187 letzterem Fall wird die unsprüngliche Auftragsnummer
5193 <term><varname>p_discount</varname></term>
5196 <para>Rabatt in Prozent</para>
5201 <term><varname>partnotes</varname></term>
5204 <para>Die beim Artikel gespeicherten Bemerkungen</para>
5209 <term><varname>partsgroup</varname></term>
5212 <para>Warengruppe</para>
5217 <term><varname>price_factor</varname></term>
5220 <para>Der Preisfaktor als Zahl, sofern einer eingestellt
5226 <term><varname>price_factor_name</varname></term>
5229 <para>Der Name des Preisfaktors, sofern einer eingestellt
5235 <term><varname>projectnumber</varname></term>
5238 <para>Projektnummer</para>
5243 <term><varname>projectdescription</varname></term>
5246 <para>Projektbeschreibung</para>
5251 <term><varname>qty</varname></term>
5259 <term><varname>reqdate</varname></term>
5262 <para>Lieferdatum</para>
5267 <term><varname>runningnumber</varname></term>
5270 <para>Position auf der Rechnung (1, 2, 3...)</para>
5275 <term><varname>sellprice</varname></term>
5278 <para>Verkaufspreis</para>
5283 <term><varname>serialnumber</varname></term>
5286 <para>Seriennummer</para>
5291 <term><varname>tax_rate</varname></term>
5294 <para>Steuersatz</para>
5299 <term><varname>transdate_do</varname></term>
5302 <para>Datum des Lieferscheins, wenn die Rechnung im Rahmen des
5303 Workflows aus einem Lieferschein stammte.</para>
5308 <term><varname>transdate_oe</varname></term>
5311 <para>Datum des Auftrags, wenn die Rechnung im Rahmen des
5312 Workflows aus einem Auftrag erstellt wurde. Wenn es
5313 Sammelaufträge gab wird das Datum des ursprünglichen Auftrags
5319 <term><varname>transdate_quo</varname></term>
5322 <para>Datum des Angebots, wenn die Position im Rahmen des
5323 Workflows aus einem Angebot stammte.</para>
5328 <term><varname>unit</varname></term>
5331 <para>Einheit</para>
5336 <term><varname>weight</varname></term>
5339 <para>Gewicht</para>
5344 <para>Für jeden Posten gibt es ein Unterarray mit den Informationen
5345 über Lieferanten und Lieferantenartikelnummer. Diese müssen mit
5346 einer <function>foreach</function>-Schleife ausgegeben werden, da
5347 für jeden Artikel mehrere Lieferanteninformationen hinterlegt sein
5348 können. Die Variablen dafür lauten:</para>
5352 <term><varname>make</varname></term>
5355 <para>Lieferant</para>
5360 <term><varname>model</varname></term>
5363 <para>Lieferantenartikelnummer</para>
5369 <sect3 id="dokumentenvorlagen-und-variablen.invoice-zahlungen">
5370 <title>Variablen für die einzelnen Zahlungseingänge</title>
5374 <term><varname>payment</varname></term>
5382 <term><varname>paymentaccount</varname></term>
5390 <term><varname>paymentdate</varname></term>
5398 <term><varname>paymentmemo</varname></term>
5406 <term><varname>paymentsource</varname></term>
5415 <sect3 id="dokumentenvorlagen-und-variablen.benutzerdefinierte-variablen-vc">
5416 <title>Benutzerdefinierte Kunden- und Lieferantenvariablen</title>
5418 <para>Die vom Benutzer definierten Variablen für Kunden und
5419 Lieferanten stehen beim Ausdruck von Einkaufs- und Verkaufsbelegen
5420 ebenfalls zur Verfügung. Ihre Namen setzen sich aus dem Präfix
5421 <varname>vc_cvar_</varname> und dem vom Benutzer festgelegten
5422 Variablennamen zusammen.</para>
5424 <para>Beispiel: Der Benutzer hat eine Variable namens
5425 <varname>number_of_employees</varname> definiert, die die Anzahl der
5426 Mitarbeiter des Unternehmens enthält. Diese Variable steht dann
5427 unter dem Namen <varname>vc_cvar_number_of_employees</varname> zur
5430 <para>Die benutzerdefinierten Variablen der Lieferadressen stehen
5431 unter einem ähnlichen Namensschema zur Verfügung. Hier lautet der
5432 Präfix <varname>shiptocvar_</varname>.</para>
5434 <para>Analog stehen die benutzerdefinierten Variablen für
5435 Ansprechpersonen mit dem Namenspräfix <varname>cp_cvar_</varname>
5436 zur Verfügung.</para>
5440 <sect2 id="dokumentenvorlagen-und-variablen.dunning">
5441 <title>Variablen in Mahnungen und Rechnungen über Mahngebühren</title>
5443 <sect3 id="dokumentenvorlagen-und-variablen.dunning-vorlagennamen">
5444 <title>Namen der Vorlagen</title>
5446 <para>Die Namen der Vorlagen werden im System-Menü vom Benutzer
5447 eingegeben. Wird für ein Mahnlevel die Option zur automatischen
5448 Erstellung einer Rechnung über die Mahngebühren und Zinsen
5449 aktiviert, so wird der Name der Vorlage für diese Rechnung aus dem
5450 Vorlagenname für diese Mahnstufe mit dem Zusatz
5451 <constant>_invoice</constant> gebildet. Weiterhin werden die Kürzel
5452 für die ausgewählte Sprache und den ausgewählten Drucker
5456 <sect3 id="dokumentenvorlagen-und-variablen.dunning-allgemein">
5457 <title>Allgemeine Variablen in Mahnungen</title>
5459 <para>Die Variablen des Bearbeiters, bzw. Verkäufers stehen wie
5460 gewohnt als <varname>employee_...</varname> bzw.
5461 <varname>salesman_...</varname> zur Verfügung. Werden mehrere
5462 Rechnungen in einer Mahnung zusammengefasst, so werden die Metadaten
5463 (Bearbeiter, Abteilung, etc) der ersten angemahnten Rechnung im
5464 Ausdruck genommen.</para>
5466 <para>Die Adressdaten des Kunden stehen als Variablen
5467 <varname>name</varname>, <varname>street</varname>,
5468 <varname>zipcode</varname>, <varname>city</varname>,
5469 <varname>country</varname>, <varname>department_1</varname>,
5470 <varname>department_2</varname>, und <varname>email</varname> zur
5471 Verfügung. Der Ansprechpartner <varname>cp_...</varname> steht auch
5472 zu Verfügung, wird allerdings auch nur von der ersten angemahnten
5473 Rechnung (s.o.) genommen.</para>
5475 <para>Weitere Variablen beinhalten:</para>
5479 <term><varname>dunning_date</varname></term>
5482 <para>Datum der Mahnung</para>
5487 <term><varname>dunning_duedate</varname></term>
5490 <para>Fälligkeitsdatum für diese Mahhnung</para>
5495 <term><varname>dunning_id</varname></term>
5498 <para>Mahnungsnummer</para>
5503 <term><varname>fee</varname></term>
5506 <para>Kumulative Mahngebühren</para>
5511 <term><varname>interest_rate</varname></term>
5514 <para>Zinssatz per anno in Prozent</para>
5519 <term><varname>total_amount</varname></term>
5522 <para>Gesamter noch zu zahlender Betrag als
5523 <function>fee</function> + <function>total_interest</function>
5524 + <function>total_open_amount</function></para>
5529 <term><varname>total_interest</varname></term>
5532 <para>Zinsen per anno über alle Rechnungen</para>
5537 <term><varname>total_open_amount</varname></term>
5540 <para>Summe über alle offene Beträge der Rechnungen</para>
5546 <sect3 id="dokumentenvorlagen-und-variablen.dunning-details">
5547 <title>Variablen für jede gemahnte Rechnung in einer Mahnung</title>
5551 <term><varname>dn_amount</varname></term>
5554 <para>Rechnungssumme (brutto)</para>
5559 <term><varname>dn_duedate</varname></term>
5562 <para>Originales Fälligkeitsdatum der Rechnung</para>
5567 <term><varname>dn_dunning_date</varname></term>
5570 <para>Datum der Mahnung</para>
5575 <term><varname>dn_dunning_duedate</varname></term>
5578 <para>Fälligkeitsdatum der Mahnung</para>
5583 <term><varname>dn_fee</varname></term>
5586 <para>Kummulative Mahngebühr</para>
5591 <term><varname>dn_interest</varname></term>
5594 <para>Zinsen per anno für diese Rechnung</para>
5599 <term><varname>dn_invnumber</varname></term>
5602 <para>Rechnungsnummer</para>
5607 <term><varname>dn_linetotal</varname></term>
5610 <para>Noch zu zahlender Betrag (ergibt sich aus
5611 <varname>dn_open_amount</varname> + <varname>dn_fee</varname>
5612 + <varname>dn_interest</varname>)</para>
5617 <term><varname>dn_netamount</varname></term>
5620 <para>Rechnungssumme (netto)</para>
5625 <term><varname>dn_open_amount</varname></term>
5628 <para>Offener Rechnungsbetrag</para>
5633 <term><varname>dn_ordnumber</varname></term>
5636 <para>Bestellnummer</para>
5641 <term><varname>dn_transdate</varname></term>
5644 <para>Rechnungsdatum</para>
5649 <term><varname>dn_curr</varname></term>
5652 <para>Währung, in der die Rechnung erstellt wurde. (Die
5653 Rechnungsbeträge sind aber immer in der Hauptwährung)</para>
5659 <sect3 id="dokumentenvorlagen-und-variablen.dunning-invoice">
5660 <title>Variablen in automatisch erzeugten Rechnungen über
5661 Mahngebühren</title>
5663 <para>Die Variablen des Verkäufers stehen wie gewohnt als
5664 <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
5665 Kunden stehen als Variablen <varname>name</varname>,
5666 <varname>street</varname>, <varname>zipcode</varname>,
5667 <varname>city</varname>, <varname>country</varname>,
5668 <varname>department_1</varname>, <varname>department_2</varname>,
5669 und <varname>email</varname> zur Verfügung.</para>
5671 <para>Weitere Variablen beinhalten:</para>
5675 <term><varname>duedate</varname></term>
5678 <para>Fälligkeitsdatum der Rechnung</para>
5683 <term><varname>dunning_id</varname></term>
5686 <para>Mahnungsnummer</para>
5691 <term><varname>fee</varname></term>
5694 <para>Mahngebühren</para>
5699 <term><varname>interest</varname></term>
5707 <term><varname>invamount</varname></term>
5710 <para>Rechnungssumme (ergibt sich aus <varname>fee</varname> +
5711 <varname>interest</varname>)</para>
5716 <term><varname>invdate</varname></term>
5719 <para>Rechnungsdatum</para>
5724 <term><varname>invnumber</varname></term>
5727 <para>Rechnungsnummer</para>
5734 <sect2 id="dokumentenvorlagen-und-variablen.andere-vorlagen">
5735 <title>Variablen in anderen Vorlagen</title>
5738 <title>Einführung</title>
5740 <para>Die Variablen in anderen Vorlagen sind ähnlich wie in der
5741 Rechnung. Allerdings heißen die Variablen, die mit
5742 <varname>inv</varname> beginnen, jetzt anders. Bei den Angeboten
5743 fangen sie mit <varname>quo</varname> für "quotation" an:
5744 <varname>quodate</varname> für Angebotsdatum etc. Bei Bestellungen
5745 wiederum fangen sie mit <varname>ord</varname> für "order" an:
5746 <varname>ordnumber</varname> für Bestellnummer etc.</para>
5748 <para>Manche Variablen sind in anderen Vorlagen hingegen gar nicht
5749 vorhanden wie z.B. die für bereits verbuchte Zahlungseingänge. Dies
5750 sind Variablen, die vom Geschäftsablauf her in der entsprechenden
5751 Vorlage keine Bedeutung haben oder noch nicht belegt sein
5754 <para>Im Folgenden werden nur wichtige Unterschiede zu den Variablen
5755 in Rechnungen aufgeführt.</para>
5758 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-quotations">
5759 <title>Angebote und Preisanfragen</title>
5763 <term><varname>quonumber</varname></term>
5766 <para>Angebots- bzw. Anfragenummer</para>
5771 <term><varname>reqdate</varname></term>
5774 <para>Gültigkeitsdatum (bei Angeboten) bzw. Lieferdatum (bei
5775 Preisanfragen)</para>
5780 <term><varname>transdate</varname></term>
5783 <para>Angebots- bzw. Anfragedatum</para>
5789 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-orders">
5790 <title>Auftragsbestätigungen und Lieferantenaufträge</title>
5794 <term><varname>ordnumber</varname></term>
5797 <para>Auftragsnummer</para>
5802 <term><varname>reqdate</varname></term>
5805 <para>Lieferdatum</para>
5810 <term><varname>transdate</varname></term>
5813 <para>Auftragsdatum</para>
5819 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-delivery-orders">
5820 <title>Lieferscheine (Verkauf und Einkauf)</title>
5824 <term><varname>cusordnumber</varname></term>
5827 <para>Bestellnummer des Kunden (im Verkauf) bzw. Bestellnummer
5828 des Lieferanten (im Einkauf)</para>
5833 <term><varname>donumber</varname></term>
5836 <para>Lieferscheinnummer</para>
5841 <term><varname>transdate</varname></term>
5844 <para>Lieferscheindatum</para>
5849 <para>Für jede Position eines Lieferscheines gibt es ein Unterarray
5850 mit den Informationen darüber, von welchem Lager und Lagerplatz aus
5851 die Waren verschickt wurden (Verkaufslieferscheine) bzw. auf welchen
5852 Lagerplatz sie eingelagert wurden. Diese müssen mittels einer
5853 <function>foreach</function>-Schleife ausgegeben werden. Diese
5854 Variablen sind:</para>
5858 <term><varname>si_bin</varname></term>
5861 <para>Lagerplatz</para>
5866 <term><varname>si_chargenumber</varname></term>
5869 <para>Chargennummer</para>
5874 <term><varname>si_bestbefore</varname></term>
5877 <para>Mindesthaltbarkeit</para>
5882 <term><varname>si_number</varname></term>
5885 <para>Artikelnummer</para>
5890 <term><varname>si_qty</varname></term>
5893 <para>Anzahl bzw. Menge</para>
5898 <term><varname>si_runningnumber</varname></term>
5901 <para>Positionsnummer (1, 2, 3 etc)</para>
5906 <term><varname>si_unit</varname></term>
5909 <para>Einheit</para>
5914 <term><varname>si_warehouse</varname></term>
5923 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-statement">
5924 <title>Variablen für Sammelrechnung</title>
5928 <term><varname>c0total</varname></term>
5931 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit < 30
5937 <term><varname>c30total</varname></term>
5940 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 30
5941 und < 60 Tage</para>
5946 <term><varname>c60total</varname></term>
5949 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 60
5950 und < 90 Tage</para>
5955 <term><varname>c90total</varname></term>
5958 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 90
5964 <term><varname>total</varname></term>
5967 <para>Gesamtbetrag aller Rechnungen</para>
5972 <para>Variablen für jede Rechnungsposition in Sammelrechnung:</para>
5976 <term><varname>invnumber</varname></term>
5979 <para>Rechnungsnummer</para>
5984 <term><varname>invdate</varname></term>
5987 <para>Rechnungsdatum</para>
5992 <term><varname>duedate</varname></term>
5995 <para>Fälligkeitsdatum</para>
6000 <term><varname>amount</varname></term>
6003 <para>Summe der Rechnung</para>
6008 <term><varname>open</varname></term>
6011 <para>Noch offener Betrag der Rechnung</para>
6016 <term><varname>c0</varname></term>
6019 <para>Noch offener Rechnungsbetrag mit Fälligkeit < 30
6025 <term><varname>c30</varname></term>
6028 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 30 und
6034 <term><varname>c60</varname></term>
6037 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 60 und
6043 <term><varname>c90</varname></term>
6046 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 90
6054 <sect2 id="dokumentenvorlagen-und-variablen.bloecke">
6055 <title>Blöcke, bedingte Anweisungen und Schleifen</title>
6057 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.einfuehrung">
6058 <title>Einführung</title>
6060 <para>Der Parser kennt neben den Variablen einige weitere
6061 Konstrukte, die gesondert behandelt werden. Diese sind wie
6062 Variablennamen in spezieller Weise markiert:
6063 <command><%anweisung%> ... <%end%></command></para>
6065 <para>Anmerkung zum <command><%end%></command>: Der besseren
6066 Verständlichkeit halber kann man nach dem <command>end</command>
6067 noch beliebig weitere Wörter schreiben, um so zu markieren, welche
6068 Anweisung (z.B. <command>if</command> oder
6069 <command>foreach</command>) damit abgeschlossen wird.</para>
6071 <para>Beispiel: Lautet der Beginn eines Blockes z.B.
6072 <command><%if type == "sales_quotation"%></command>, so könnte
6073 er mit <command><%end%></command> genauso abgeschlossen werden
6074 wie mit <command><%end if%></command> oder auch
6075 <command><%end type == "sales_quotation"%></command>.</para>
6078 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.if">
6079 <title>Der if-Block</title>
6081 <programlisting><%if variablenname%>
6083 <%end%></programlisting>
6085 <para>Eine normale "if-then"-Bedingung. Die Zeilen zwischen dem "if"
6086 und dem "end" werden nur ausgegeben, wenn die Variable
6087 <varname>variablenname</varname> gesetzt und ungleich 0 ist.</para>
6089 <para>Handelt es sich bei der benannten Variable um ein Array, also
6090 um einen Variablennamen, über den man mit <command><%foreach
6091 variablenname%></command> iteriert, so wird mit diesem Konstrukt
6092 darauf getestet, ob das Array Elemente enthält. Somit würde im
6093 folgenden Beispiel nur dann eine Liste von Zahlungseingängen samt
6094 ihrer Überschrift "Zahlungseingänge" ausgegeben, wenn tatsächlich
6095 welche getätigt wurden:</para>
6097 <programlisting><%if payment%>
6099 <%foreach payment%>
6100 Am <%paymentdate%>: <%payment%> €
6101 <%end foreach%>
6102 <%end if%></programlisting>
6104 <para>Die Bedingung kann auch negiert werden, indem das Wort
6105 <function>not</function> nach dem <filename>if</filename> verwendet
6106 wird. Beispiel:</para>
6108 <programlisting><%if not cp_greeting%>
6110 <%end%></programlisting>
6112 <para>Zusätzlich zu dem einfachen Test, ob eine Variable gesetzt ist
6113 oder nicht, bietet dieser Block auch die Möglichkeit, den Inhalt
6114 einer Variablen mit einer festen Zeichenkette oder einer anderen
6115 Variablen zu vergleichen. Ob der Vergleich mit einer Zeichenkette
6116 oder einer anderen Variablen vorgenommen wird, hängt davon ab, ob
6117 die rechte Seite des Vergleichsoperators in Anführungszeichen
6118 gesetzt wird (Vergleich mit Zeichenkette) oder nicht (Vergleich mit
6119 anderer Variablen). Zwei Beispiele, die beide Vergleiche
6122 <programlisting><%if var1 == "Wert"%></programlisting>
6124 <para>Testet die Variable <varname>var1</varname> auf
6125 übereinstimmung mit der Zeichenkette <constant>Wert</constant>.
6126 Mittels <function>!=</function> anstelle von <function>==</function>
6127 würde auf Ungleichheit getestet.</para>
6129 <programlisting><%if var1 == var2%></programlisting>
6131 <para>Testet die Variable <varname>var1</varname> auf
6132 übereinstimmung mit der Variablen <varname>var2</varname>. Mittel
6133 <function>!=</function> anstelle von <function>==</function> würde
6134 auf Ungleichheit getestet.</para>
6136 <para>Erfahrere Benutzer können neben der Tests auf (Un-)Gleichheit
6137 auch Tests auf Übereinstimmung mit regulären Ausdrücken ohne
6138 Berücksichtung der Groß- und Kleinschreibung durchführen. Dazu dient
6139 dieselbe Syntax wie oben nur mit <function>=~</function> und
6140 <function>!~</function> als Vergleichsoperatoren.</para>
6142 <para>Beispiel für einen Test, ob die Variable
6143 <varname>intnotes</varname> (interne Bemerkungen) das Wort
6144 <constant>schwierig</constant> enthält:</para>
6146 <programlisting><%if intnotes =~ "schwierig"%></programlisting>
6149 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.foreach">
6150 <title>Der foreach-Block</title>
6152 <programlisting><%foreach variablenname%>
6154 <%end%></programlisting>
6156 <para>Fügt die Zeilen zwischen den beiden Anweisungen so oft ein,
6157 wie das Perl-Array der Variablen <varname>variablenname</varname>
6158 Elemente enthät. Dieses Konstrukt wird zur Ausgabe der einzelnen
6159 Posten einer Rechnung / eines Angebots sowie zur Ausgabe der Steuern
6160 benutzt. In jedem Durchlauf werden die <link
6161 linkend="dokumentenvorlagen-und-variablen.invoice-posten">zeilenbezogenen
6162 Variablen</link> jeweils auf den Wert für die aktuelle Position
6165 <para>Die Syntax sieht normalerweise wie folgt aus:</para>
6167 <programlisting><%foreach number%>
6168 Position: <%runningnumber%>
6169 Anzahl: <%qty%>
6170 Artikelnummer: <%number%>
6171 Beschreibung: <%description%>
6173 <%end%></programlisting>
6175 <para>Besonderheit in OpenDocument-Vorlagen: Tritt ein
6176 <function><%foreach%></function>-Block innerhalb einer
6177 Tabellenzelle auf, so wird die komplette Tabellenzeile so oft
6178 wiederholt wie notwendig. Tritt er außerhalb auf, so wird nur der
6179 Inhalt zwischen <function><%foreach%></function> und
6180 <function><%end%></function> wiederholt, nicht aber die
6181 komplette Zeile, in der er steht.</para>
6185 <sect2 id="dokumentenvorlagen-und-variablen.markup">
6186 <title>Markup-Code zur Textformatierung innerhalb von
6189 <para>Wenn der Benutzer innhalb von Formularen in kivitendo Text
6190 anders formatiert haben möchte, so ist dies begrenzt möglich.
6191 kivitendo unterstützt die Textformatierung mit HTML-ähnlichen Tags.
6192 Der Benutzer kann z.B. bei der Artikelbeschreibung auf einer Rechnung
6193 Teile des Texts zwischen Start- und Endtags setzen. Dieser Teil wird
6194 dann automatisch in Anweisungen für das ausgewählte Vorlagenformat
6195 (HTML oder PDF über LaTeX) umgesetzt.</para>
6197 <para>Die unterstützen Formatierungen sind:</para>
6201 <term><b>Text</b></term>
6204 <para>Text wird in Fettdruck gesetzt.</para>
6209 <term><i>Text</i></term>
6212 <para>Text wird kursiv gesetzt.</para>
6217 <term><u>Text</u></term>
6220 <para>Text wird unterstrichen.</para>
6225 <term><s>Text</s></term>
6228 <para>Text wird durchgestrichen. Diese Formatierung ist nicht
6229 bei der Ausgabe als PDF über LaTeX verfügbar.</para>
6234 <term><bullet></term>
6237 <para>Erzeugt einen ausgefüllten Kreis für Aufzählungen (siehe
6243 <para>Der Befehl <command><bullet></command> funktioniert
6244 momentan auch nur in Latex-Vorlagen.</para>
6248 <sect1 id="excel-templates">
6249 <title>Excel-Vorlagen</title>
6251 <sect2 id="excel-templates.summary">
6252 <title>Zusammenfassung</title>
6254 <para>Dieses Dokument beschreibt den Mechanismus, mit dem
6255 Exceltemplates abgearbeitet werden, und die Einschränkungen, die damit
6259 <sect2 id="excel-templates.usage">
6260 <title>Bedienung</title>
6262 <para>Der Excel Mechanismus muss in der Konfigurationsdatei aktiviert
6263 werden. Die Konfigurationsoption heißt <varname>excel_templates =
6264 1</varname> im Abschnitt <varname>[print_templates]</varname>.</para>
6266 <para>Eine Excelvorlage kann dann unter dem Namen einer beliebigen
6267 anderen Vorlage mit der Endung <filename>.xls</filename> gespeichert
6268 werden. In den normalen Verkaufsmasken taucht nun
6269 <constant>Excel</constant> als auswählbares Format auf und kann von da
6270 an wie LaTeX- oder OpenOffice-Vorlagen benutzt werden.</para>
6272 <para>Der Sonderfall der Angebote aus der Kundenmaske ist ebenfalls
6273 eine Angebotsvorlage und wird unter dem internen Namen der Angebote
6274 <filename>sales_quotation.xls</filename> gespeichert.</para>
6277 <sect2 id="excel-templates.syntax">
6278 <title>Variablensyntax</title>
6280 <para>Einfache Syntax:
6281 <command><<varname>></command></para>
6283 <para>Dabei sind <constant><<</constant> und
6284 <constant>>></constant> die Delimiter. Da Excel auf festen
6285 Breiten besteht, kann der Tag künstlich verlängert werden, indem
6286 weitere <constant><</constant> oder <constant>></constant>
6287 eingefügt werden. Der Tag muss nicht symmetrisch sein.
6290 <programlisting><<<<<varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
6292 <para>Um die Limitierung der festen Breite zu reduzieren, können
6293 weitere Variablen in einem Block interpoliert werden. Whitespace wird
6294 dazwishen dann erhalten. Beispiel:</para>
6296 <programlisting><<<<<varname1 varname2 varname3>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
6298 <para>Die Variablen werden interpoliert, und linksbündig mit
6299 Leerzeichen auf die gewünschte Länge aufgefüllt. Ist der String zu
6300 lang, werden überzählige Zeichen abgeschnitten.</para>
6302 <para>Es ist ausserdem möglich, Daten rechtsbündig darzustellen, wenn
6303 der Block mit einem Leerzeichen anfängt. Beispiel:</para>
6305 <programlisting><<<<<< varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
6307 <para>Dies würde rechtsbündig triggern. Wenn bei rechtsbündiger
6308 Ausrichtung Text abgeschnitten werden muss, wird er vom linken Ende
6312 <sect2 id="excel-templates.limitations">
6313 <title>Einschränkungen</title>
6315 <para>Das Excelformat bis 2002 ist ein binäres Format, und kann nicht
6316 mit vertretbarem Aufwand editiert werden. Der Templatemechanismus
6317 beschränkt sich daher darauf, Textstellen exakt durch einen anderen
6318 Text zu ersetzen.</para>
6320 <para>Aus dem gleichen Grund sind die Kontrolllstrukturen
6321 <command><%if%></command> und
6322 <command><%foreach%></command> nicht vorhanden. Der Delimiter
6323 <constant><% %></constant> kommt in den Headerinformationen
6324 evtl. vor. Deshalb wurde auf den sichereren Delimiter
6325 <constant><<</constant> und <constant>>></constant>
6330 <sect1 id="features.warehouse">
6331 <title>Mandantenkonfiguration Lager</title>
6333 <para>Die Lagerverwaltung in kivitendo funktioniert standardmässig wie
6334 folgt: Wird ein Lager mit einem Lagerplatz angelegt, so gibt es die
6335 Möglichkeit hier über den Menüpunkt Lager entsprechende Warenbewegungen
6336 durchzuführen. Ferner kann jede Position eines Lieferscheins ein-, bzw.
6337 ausgelagert werden (Einkauf-, bzw. Verkauf). Es können beliebig viele
6338 Lager mit beliebig vielen Lagerplätzen abgebildet werden. Die
6339 Lagerbewegungen über einen Lieferschein erfolgt durch Anklicken jeder
6340 Einzelposition und das Auswählen dieser Position zu einem Lager mit
6341 Lagerplatz. Dieses Verfahren lässt sich schrittweise vereinfachen, je
6342 nachdem wie die Einstellungen in der Mandatenkonfiguration gesetzt
6347 <para><option>Auslagern über Standardlagerplatz</option> Hier wird
6348 ein zusätzlicher Knopf (Auslagern über Standard-Lagerplatz) in dem
6349 Lieferschein-Beleg hinzugefügt, der dann alle Lagerbewegungen über
6350 den Standardlagerplatz (konfigurierbar pro Ware) durchführt.</para>
6354 <para><option>Auslagern ohne Bestandsprüfung</option> Das obige
6355 Auslagern schlägt fehl, wenn die entsprechende Menge für die
6356 Lagerbewegung nicht vorhanden ist, möchte man dies auch ignorieren
6357 und ggf. dann nachpflegen, so kann man eine Negativ-Warenmenge mit
6358 dieser Option erlauben. Hierfür muss ein entsprechender Lagerplatz
6359 (Fehlbestand, o.ä.) konfiguriert sein.</para>
6363 <para>Zusätzliche Funktionshinweise:</para>
6367 <para><option>Standard-Lagerplatz</option> Ist dieser konfiguriert,
6368 wird dies auch als Standard-Voreinstellung bei der Neuerfassung von
6369 Stammdaten → Waren / Dienstleistung / Erzeugnis verwendet.</para>
6373 <para><option>Standard-Lagerplatz verwenden, falls keiner in
6374 Stammdaten definiert</option> Wird beim 'Auslagern über
6375 Standardlagerplatz' keine Standardlagerplatz zu der Ware gefunden,
6376 so wird mit dieser Option einfach der Standardlagerplatz
6382 <sect1 id="features.swiss-charts-of-accounts">
6383 <title>Schweizer Kontenpläne</title>
6385 <para>Seit der Version 3.5 stehen in kivitendo 3 Kontenpläne für den
6386 Einsatz in der Schweiz zur Verfügung, einer für Firmen und
6387 Organisationen, die nicht mehrwertsteuerpflichtig sind, einer für
6388 Firmen, die mehrwertsteuerpflichtig sind und einer speziell für
6391 <para>Die Kontenpläne orientieren sich am in der Schweiz üblicherweise
6392 verwendeten KMU-Kontenrahmen und sind mit der Revision des
6393 Schweizerischen Obligationenrechts (OR) vom 1.1.2013 kompatibel,
6394 insbesondere <literal>Art.957a Abs.2</literal>.</para>
6396 <para>Beim Vereinskontenplan sind standardmässig nur die Konten 1100
6397 (Debitoren CHF) und 1101 (Debitoren EUR) als Buchungskonten im Verkauf
6398 sowie die Konten 2000 (Kreditoren CHF) und 2001 (Kreditoren EUR) als
6399 Buchungskonten im Einkauf vorgesehen. Weitere Konten können bei Bedarf
6400 in den Konto-Detaileinstellungen als Einkaufs- oder Verkaufskonten
6401 konfiguriert werden.</para>
6403 <para>Die Möglichkeit, Saldosteuersätze zu verwenden ist in der
6404 aktuellen Version von kivitendo noch nicht integriert.</para>
6406 <para>Trotzdem können auch Firmen, die per Saldosteuersatz mit der
6407 Eidgenössischen Steuerverwaltung abrechnen, kivitendo bereits nutzen.
6408 Dazu wird der Kontenplan mit MWST ausgewählt. Anschliessend müssen alle
6409 Aufwandskonten editiert werden und dort der Steuersatz auf 0% gesetzt
6412 <para>So werden bei Kreditorenbuchungen keine Vorsteuern
6415 <para>Bezugssteuern für aus dem Ausland bezogene Dienstleistungen müssen
6416 manuell verbucht werden.</para>
6418 <para>Wünsche für Anpassungen an den Schweizer Kontenplänen sowie
6419 Vorschläge für weitere (z.B. branchenspezifische) Kontenpläne bitte an
6420 <literal>empfang@revamp-it.ch</literal> senden.</para>
6423 <sect1 id="features.part_classification">
6424 <title>Artikelklassifizierung</title>
6427 <title>Übersicht</title>
6429 <para>Die Klassifizierung von Artikeln dient einer weiteren
6430 Gliederung, um zum Beispiel den Einkauf vom Verkauf zu trennen,
6431 gekennzeichnet durch eine Beschreibung (z.B. "Einkauf") und ein Kürzel
6432 (z.B. "E"). Für jede Klassifizierung besteht eine Beschreibung und
6433 eine Abkürzung die normalerweise aus einem Zeichen besteht, kann aber
6434 auf mehrere Zeichen erweitert werden, falls zur Unterscheidung
6435 notwendig. Sinnvoll sind jedoch nur maximal 2 Zeichen.</para>
6439 <title>Basisklassifizierung</title>
6441 <para>Als Basisklassifizierungen gibt es</para>
6445 <para>Einkauf</para>
6449 <para>Verkauf</para>
6453 <para>Handelsware</para>
6457 <para>Produktion</para>
6461 <para>- keine - (diese wird bei einer Aktualisierung für alle
6462 existierenden Artikel verwendet und ist gültig für Verkauf und
6467 <para>Es können weitere Klassifizierungen angelegt werden. So kann es
6468 z.B. für separat auszuweisende Artikel folgende Klassen geben:</para>
6472 <para>Lieferung (Logistik, Transport) mit Kürzel L</para>
6476 <para>Material (Verpackungsmaterial) mit Kürzel M</para>
6482 <title>Attribute</title>
6484 <para>Bisher haben die Klassifizierungen folgende Attribute, die auch
6485 alle gleichzeitg gültig sein können</para>
6489 <para>gültig für Verkauf - dieser Artikel kann im Verkauf genutzt
6494 <para>gültig für Einkauf - dieser Artikel kann im Einkauf genutzt
6499 <para>separat ausweisen - hierzu gibt es zur Dokumentengenerierung
6500 (LaTeX) eine zusätzliche Variable</para>
6504 <para>Für das Attribut "separat ausweisen" stehen in den
6505 LaTeX-Vorlagen die Variable <emphasis
6506 role="bold"><%non_separate_subtotal%> </emphasis>zur Verfügung,
6507 die alle nicht separat auszuweisenden Artikelkosten saldiert, sowie
6508 pro separat auszuweisenden Klassifizierungen die Variable<emphasis
6509 role="bold">< %separate_X_subtotal%></emphasis>, wobei X das
6510 Kürzel der Klassifizierung ist.</para>
6512 <para>Im obigen Beispiel wäre das für Lieferkosten <emphasis
6513 role="bold"><%separate_L_subtotal%></emphasis> und für
6514 Verpackungsmaterial <emphasis role="bold">
6515 <%separate_M_subtotal%></emphasis>.</para>
6519 <title>Zwei-Zeichen Abkürzung</title>
6521 <para>Der Typ des Artikels und die Klassifizierung werden durch zwei
6522 Buchstaben dargestellt. Der erste Buchstabe ist eine Lokalisierung des
6523 Artikel-Typs ('P','A','S'), deutsch 'W', 'E', und 'D' für Ware
6524 Erzeugnis oder Dienstleistung und ggf. weiterer Typen.</para>
6526 <para>Der zweite Buchstabe (und ggf. auch ein dritter, falls nötig)
6527 entspricht der lokalisierten Abkürzung der Klassifizierung.</para>
6529 <para>Diese Abkürzung wird überall beim Auflisten von Artikeln zur
6530 Erleichterung mit dargestellt.</para>
6534 <sect1 id="features.file_managment">
6535 <title>Dateiverwaltung (Mini-DMS)</title>
6538 <title>Übersicht</title>
6540 <para>Parallel zum alten WebDAV gibt es ein Datei-Management-System,
6541 das Dateien verschiedenen Typs verwaltet. Dies können</para>
6545 <para>aus ERP-Daten per LaTeX Template erzeugte
6546 PDF-Dokumente,</para>
6550 <para>zu bestimmten ERP-Daten gehörende Anhangdateien
6551 unterschiedlichen Formats,</para>
6555 <para>per Scanner eingelesene PDF-Dateien,</para>
6559 <para>per E-Mail empfangene Dateianhänge unterschiedlichen
6564 <para>sowie speziel für Artikel hochgeladene Bilder sein.</para>
6569 <screeninfo>Übersicht</screeninfo>
6573 <imagedata contentwidth="600" fileref="images/DMS-Overview.png"/>
6580 <title>Struktur</title>
6582 <para>Über eine vom Speichermedium unabhängige Zwischenschicht werden
6583 die Dateien und ihre Versionen in der Datenbank verwaltet. Darunter
6584 können verschiedene Implementierungen (Backends) gleichzeitig
6589 <para>Dateisystem</para>
6597 <para>Schnittstelle zu externen
6598 Dokumenten-Management-Systemen</para>
6602 <para>andere Datenbank</para>
6606 <para>etc ...</para>
6610 <para>Es gibt unterschiedliche Typen von Dateien. Jedem Typ läßt sich
6611 in der Mandantenkonfiguration ein bestimmtes Backend zuordnen.</para>
6615 <para>"document": Das sind entweder generierte, eingescannte oder
6616 hochgeladene PDF-Dateien, die zu bestimmten ERP-Daten
6617 (ERP-Objekte, wie z.B. Rechnung, Lieferschein) gehören.</para>
6621 <para>"attachment": zusätzlich hochgeladene Dokumente, die an
6622 bestimmte ERP-Objekte angehängt werden, z.B. technische
6623 Zeichnungen, Aufmaße. Diese können auch für Artikel, Lieferanten
6624 und Kunden hinterlegt sein.</para>
6628 <para>"image": Bilder für Artikel. Diese können auch verkleinert
6629 in einer Vorschau (Thumbnail) angezeigt werden.</para>
6633 <para>Zusätzlich werden in der Datenbank zu den Dateien neben der
6634 Zuordnung zu ERP-Objekten, Dateityp Dateinamen und Backend, in dem die
6635 Datei gespeichert ist, auch die Quelle der Datei notiert:</para>
6639 <para>"created": vom System erzeugte Dokumente"</para>
6643 <para>"uploaded": hochgeladene Dokumente</para>
6647 <para>"email": vom Mail-System empfangene Dateien</para>
6651 <para>"scanner[1]": von einem oder mehreren Scannern erzeugte
6652 Dateien. Existieren mehrere Scanner, so sind diese durch
6653 unterschiedliche Quellennamen zu definieren.</para>
6657 <para>Je nach Dateityp sind nur bestimmte Quellen zulässig. So gibt es
6658 für "attachment" und "image" nur die Quelle "uploaded". Für "document"
6659 gibt es auf jeden Fall die Quelle "created". Die Quellen "scanner" und
6660 "email" müssen derzeit in der Datenbank konfiguriert werden (siehe
6661 <xref linkend="file_management.dbconfig"/>).</para>
6665 <title>Anwendung</title>
6667 <para>Die Daten werden bei den ERP-Objekten als extra Reiter
6668 dargestellt. Eine Verkaufsrechnung z.B. hat die Reiter "Dokumente" und
6669 "Dateianhänge".</para>
6672 <screeninfo>Reiter "Dateianhänge"</screeninfo>
6676 <imagedata fileref="images/DMS-Anhaenge.png" scale="50"/>
6681 <para>Bei den Dateianhängen wird immer nur die aktuelle Version einer
6682 Datei angezeigt. Wird eine Datei mit gleichem Namen hochgeladen, so
6683 wird eine neue Version der Datei erstellt. Vorher wird der Anwender
6684 durch einen Dialog gefragt, ob er eine neue Version anlegen will oder
6685 ob er die Datei umbenennen will, falls es eine neue Datei sein
6689 <screeninfo>Reiter "Dateianhänge"</screeninfo>
6693 <imagedata contentwidth="40"
6694 fileref="images/DMS-Anhaenge-hochladen.png"
6700 <para>Es können mehrere Dateien gleichzeitig hochgeladen werden,
6701 solange in Summe die maximale Größe nicht überschritten wird (siehe
6702 <xref linkend="file_management.clientconfig"/>).</para>
6705 <screeninfo>Reiter "Dokumente"</screeninfo>
6709 <imagedata fileref="images/DMS-Dokumente.png" width="500"/>
6714 <para>Sind keine weiteren Quellen für Dokumente konfiguriert, so gibt
6715 es nur "erzeugte Dokumente". Es werden alle Versionen der generierten
6716 Datei angezeigt. Für Verkaufsrechnungen kommen keine anderen Quellen
6717 zur Geltung. Werden entsprechend der <xref
6718 linkend="file_management.dbconfig"/> zusätzliche Quellen konfiguriert,
6719 so sind diese z.B. bei Einkaufsrechnungen sichtbar:</para>
6722 <screeninfo>Reiter "Dokumente"</screeninfo>
6726 <imagedata contentwidth="600"
6727 fileref="images/DMS-Dokumente-Scanner.png"/>
6732 <para>Statt des Löschens wird hier die Datei zurück zur Quelle
6733 verschoben. Somit kann die Datei anschließend an ein anderes
6734 ERP-Objekt angehängt werden.</para>
6736 <para>Derzeit sind "Titel" und "Beschreibung" noch nicht genutzt. Sie
6737 sind bisher nur bei Bildern relevant.</para>
6741 <title>Konfigurierung</title>
6743 <sect3 id="file_management.clientconfig"
6744 xreflabel="Mandantenkonfigurierung">
6745 <title>Mandantenkonfiguration</title>
6748 <title>Reiter "Features"</title>
6750 <para>Unter dem Reiter <emphasis role="bold">Features</emphasis>
6751 im Abschnitt Dateimanagement ist neben dem "alten" WebDAV das
6752 Dateimangement generell zu- und abschaltbar, sowie die Zuordnung
6753 der Dateitypen zu Backends. Die Löschbarkeit von Dateien, sowie
6754 die maximale Uploadgröße sind Backend-unabhängig</para>
6757 <screeninfo>Mandantenkonfig Reiter "Features"</screeninfo>
6761 <imagedata fileref="images/DMS-ClientConfig.png" width="500"/>
6766 <para>Die einzelnen Backends sind einzeln einschaltbar.
6767 Spezifische Backend-Konfigurierungen sind hier noch
6772 <title>Reiter "Allgemeine Dokumentenanhänge"</title>
6774 <para>Unter dem Reiter <emphasis role="bold">Allgemeine
6775 Dokumentenanhänge</emphasis> kann für alle ERP-Dokumente (
6776 Angebote, Aufträge, Lieferscheine, Rechnungen im Verkauf und
6777 Einkauf ) allgemeingültige Anhänge hochgeladen werden.</para>
6780 <screeninfo>Mandantenkonfig Reiter "Allgemeine
6781 Dokumentenanhänge"</screeninfo>
6785 <imagedata fileref="images/DMS-Allgemeine-Dokumentenanhaenge.png"
6791 <para>Diese Anhänge werden beim Generieren von PDF-Dateien an die
6792 ERP-Dokumente angehängt, z.B. AGBs oder aktuelle Angebote. Es
6793 werden in dem Fall die Daten kopiert, sodass an den ERP-Dokumenten
6794 immer die Anhänge zum Generierungszeitpunkt eingebettet
6799 <sect3 id="file_management.dbconfig"
6800 xreflabel="Datenbank-Konfigurierung">
6801 <title>Datenbank-Konfigurierung</title>
6803 <para>Die zusätzlichen Quellen für "email" oder ein oder mehrere
6804 Scanner sind derzeit vom Administrator direkt in der
6805 Datenbanktabelle "user_preferences" einzurichten. Die "value" ist im
6806 JSON-Format mit den jeweiligen Werten des Verzeichnisses und der
6807 Beschreibung der Quelle.</para>
6810 id | login | namespace | version | key | value
6811 ----+-----------+--------------+---------+----------+---------------------------
6812 1 | #default# | file_sources | 0.00000 | scanner1 |
6813 {"dir":"/var/tmp/scanner1","desc":"Scanner Einkauf"}
6814 2 | #default# | file_sources | 0.00000 | scanner2 |
6815 {"dir":"/var/tmp/scanner2","desc":"Scanner Verkauf"}
6816 3 | #default# | file_sources | 0.00000 | emails |
6817 {"dir":"/var/tmp/emails","desc":"Empfangene Mails" }
6820 <para>Es ist daran gedacht, statt dem Default-Eintrag später für
6821 bestimmte Benutzer ('login') bestimmte Quellen zuzulassen. Dies wird
6822 nach Bedarf implementiert.</para>
6825 <sect3 id="file_management.kiviconfig"
6826 xreflabel="kivitendo-Konfigurationsdatei">
6827 <title>kivitendo-Konfigurationsdatei</title>
6829 <para>Dort ist im Abschnitt [paths] der relative oder absolute Pfad
6830 zum Dokumentenwurzelverzeichnis einzutragen. Dieser muss für den
6831 Webserver schreib- und lesbar sein, jedoch nicht ausführbar.</para>
6835 document_path = /var/local/kivi_documents
6838 <para>Unter diesem Wurzelverzeichnis wird pro Mandant automatisch
6839 ein Unterverzeichnis mit der ID des Mandanten angelegt.</para>
6845 <title>Webshop-Api</title>
6847 <para>Das Shopmodul bietet die Möglichkeit Onlineshopartikel und
6848 Onlineshopbestellungen zu verwalten und zu bearbeiten.</para>
6850 <para>Es ist Multishopfähig, d.h. Artikel können mehreren oder
6851 unterschiedlichen Shops zugeordnet werden. Bestellungen können aus
6852 mehreren Shops geholt werden.</para>
6854 <para>Zur Zeit bietet das Modul nur einen Connector zur REST-Api von
6855 Shopware. Weitere Connectoren können dazu programmiert und eingerichtet
6859 <title>Installationsempfehlung</title>
6861 <para>Optionale Postgreserweiterung pg_trgm(Trigram)</para>
6863 <para>Die Trigramerweiterung bietet eine Ähnlichkeitsuche. Diese
6864 verwendet das Shopmodul, wenn installiert, beim Bestellimport um zu
6865 entscheiden ob ein Kunde neu angelegt oder als Vorschlag angezeigt
6868 <para>Die Erweiterung wird bisher nur beim Ableich der Straße genutzt,
6869 da hier oft unterschiedliche Schreibweisen vorhanden sind. </para>
6871 <para>z.B Dorfstraße, Dorfstrasse, Dorfstr., Dorf Straße usw.. So wird
6872 vermieden, dass Kunden eventuell doppelt angelegt werden. </para>
6874 <para>Um diese Erweiterung generell in kivitendo zu installieren, um
6875 neuen Mandanten und der kivitendo-Test-Suite zugänglich zu
6878 <para><programlisting>su - postgres
6879 psql template1</programlisting></para>
6881 <para>führen Sie die folgenden Kommandos aus:</para>
6883 <programlisting>CREATE EXTENSION IF NOT EXISTS pg_trgm;
6886 <para>Für bestehende Mandanten-Datenbanken kann die Extension in der
6887 Datenbank angelegt werden:</para>
6889 <programlisting>su - postgres
6890 psql DATENBANKNAME</programlisting>
6892 <programlisting>CREATE EXTENSION IF NOT EXISTS pg_trgm;
6897 <title>Rechte für die Webshopapi</title>
6899 <para>In der Administration können folgende Rechte vergeben
6904 <para>Webshopartikel anlegen und bearbeiten</para>
6908 <para>Shopbestellungen holen und bearbeiten</para>
6912 <para>Shop anlegen und bearbeiten</para>
6918 <title>Konfiguration</title>
6920 <para>Unter System->Webshops können Shops angelegt und konfiguriert
6925 <imagedata contentdepth="500" contentwidth="700"
6926 fileref="images/Shop_Listing.png"/>
6932 <title>Webshopartikel</title>
6935 <title>Shopvariablenreiter in Artikelstammdaten</title>
6937 <para>Mit dem Recht "Shopartikel anlegen und bearbeiten" und des
6938 Markers <emphasis role="bold">"Shopartikel" in den Basisdaten
6939 </emphasis>zeigt sich der Reiter "Shopvariablen" in den
6940 Artikelstammdaten. Hier können jetzt die Artikel mit
6941 unterschiedlichen Beschreibung und/oder Preisen für die
6942 konfigutierten Shops angelegt und bearbeitet werden. An dieser
6943 Stelle können auch beliebig viele Bilder dem Shopartikel zugeordnet
6944 werden. Artikelbilder gelten für alle Shops.</para>
6948 <imagedata contentdepth="500" contentwidth="600"
6949 fileref="images/Shop_Artikel.png"/>
6953 <para>Die Artikelgruppen werden direkt vom Shopsystem geholt somit
6954 ist es möglich einen Artikel auch mehreren Gruppen
6959 <title>Shopartikelliste</title>
6961 <para>Unter dem Menu Webshop->Webshop Artikel hat man nochmal
6962 eine Gesamtübersicht. Von hier aus ist es möglich Artikel im Stapel
6963 unter verschiedenen Kriterien <alles><nur Preis><nur
6964 Bestand><Preis und Bestand> an die jeweiligen Shops
6969 <imagedata fileref="images/Shop_Artikel_Listing.png"/>
6976 <title>Bestellimport</title>
6978 <para>Unter dem Menupunkt Webshop->Webshop Import öffnet sich die
6979 Bestellimportsliste. Hier ist sind Möglichkeiten gegeben Neue
6980 Bestellungen vom Shop abzuholen, geholte Bestellungen im Stapel oder
6981 einzeln als Auftrag zu transferieren. Die Liste kann nach
6982 verschiedenen Kriterien gefiltert werden.</para>
6986 <imagedata fileref="images/Shop_Bestell.png"/>
6990 <para>Bei Einträgen in der Liste.</para>
6994 <para>keine Kundennummer: Es gibt ähnliche Kundendatensätze und
6995 der Datensatz konnte nicht eindeutig zugewiesen werden.</para>
6999 <para>Kundennummer und Rechnungen rot hinterlegt: Der Kunde hat
7000 offene Posten und kann deswegen nicht im Stapel übernommen
7005 <para>Rechnungsadresse grün hinterlegt: Der Kunde konnte eindeutig
7006 einem Datensatz zugeordnet werden. Die Shopbestellung kann im
7007 Stapel mit dem Button "Anwenden" und wenn markiert als Auftrag
7008 übernommen werden.</para>
7012 <para>Kundennummer vorhanden, aber die Checkbox "Auftrag
7013 erstellen" fehlt. Der Kunde hat vermutlich eine
7014 Shopauftragssperre.</para>
7018 <para>Lieferadresse grau hinterlegt: Optische Anzeige, dass es
7019 sich um eine unterschiedliche Lieferadresse handelt.
7020 Lieferadressen werden aber grundsätzlich beim Transferieren zu
7021 Aufträgen mit übernommen.</para>
7025 <para>In der Spalte Positionen/Betrag/Versandkosten zeigt sich ein
7026 tooltip zu den Positionen.</para>
7030 <para>Maske Auftrag erstellen</para>
7032 <para>Viele Shopsysteme haben drei verschieden Adresstypen Kunden-,
7033 Rechnungs-, und Lieferadresse, die sich auch alle unterscheiden
7034 können. Diese werden im oberen Bereich angezeigt. Es ist möglich jede
7035 dieser Adresse einzeln in kivitendo als Kunde zu übernehmen. Es werden
7036 die Werte Formulareingabe übernommen. Es wird bei einer Änderung
7037 allerdings nur diese in die kivitendo Kundenstammdaten übernommen, die
7038 Shopbestellung bleibt bestehen.</para>
7040 <para>Mit der mittleren Adresse(Rechnungsadresse) im oberen Bereich,
7041 kann ich den ausgewählten kivitendodatensatz des mittleren Bereich
7042 überschreiben. Das ist sinnvoll, wenn ich erkenne, das der Kunde z.B.
7043 umgezogen ist.</para>
7045 <para>Im mittleren Bereich das Adresslisting zeigt:</para>
7049 <para>Rot hinterlegt: Kunde hat eine Shopauftragssperre, diese
7050 muss zuerst deaktiviert werden bevor ich diesem Kunden eine
7051 Shopbestellung zuordnen kann.</para>
7055 <para>Kundenname fett und rot: Hier hat der Kunde eine Bemerkung
7056 in den Stammdaten. Ein Tooltip zeigt diese Bemerkung. Das kann dan
7057 auch der Grund für die Auftragssperre sein.</para>
7061 <para>Die Buttons "Auftrag erstellen" und "Kunde mit
7062 Rechnungsadresse überschreiben" zeigen sich erst, wenn ein Kunde
7063 aus dem Listing ausgewählt ist.</para>
7067 <para>Es ist aber möglich die Shopbestellung zu löschen.</para>
7071 <para>Ist eine Bestellung schon übernommen, zeigen sich an dieser
7072 Stelle, die dazugehörigen Belegverknüpfungen.</para>
7078 <title>Mapping der Daten</title>
7080 <para>Das Mapping der kivitendo Daten mit den Shopdaten geschieht in
7081 der Datei SL/ShopConnector/<SHOPCONNECTORNAME>.pm
7082 z.B.:SL/ShopConnector/Shopware.pm</para>
7084 <para>In dieser Datei gibt es einen Bereich wo die Bestellpostionen,
7085 die Bestellkopfdaten und die Artikeldaten gemapt werden. In dieser
7086 Datei kann ein individelles Mapping dann gemacht werden. Zu Shopware
7087 gibt es hier eine sehr gute Dokumentation: <ulink
7088 url="https://developers.shopware.com/developers-guide/rest-api/">https://developers.shopware.com/developers-guide/rest-api/</ulink></para>
7094 <title>Entwicklerdokumentation</title>
7096 <sect1 id="devel.globals" xreflabel="Globale Variablen">
7097 <title>Globale Variablen</title>
7100 <title>Wie sehen globale Variablen in Perl aus?</title>
7102 <para>Globale Variablen liegen in einem speziellen namespace namens
7103 "main", der von überall erreichbar ist. Darüber hinaus sind bareword
7104 globs global und die meisten speziellen Variablen sind...
7107 <para>Daraus ergeben sich folgende Formen:</para>
7111 <term><literal>$main::form</literal></term>
7114 <para>expliziter Namespace "main"</para>
7119 <term><literal>$::form</literal></term>
7122 <para>impliziter Namespace "main"</para>
7127 <term><literal>open FILE, "file.txt"</literal></term>
7130 <para><varname>FILE</varname> ist global</para>
7135 <term><literal>$_</literal></term>
7138 <para>speziell</para>
7143 <para>Im Gegensatz zu <productname>PHP</productname> gibt es kein
7144 Schlüsselwort wie "<function>global</function>", mit dem man
7145 importieren kann. <function>my</function>, <function>our</function>
7146 und <function>local</function> machen was anderes.</para>
7150 <term><literal>my $form</literal></term>
7153 <para>lexikalische Variable, gültig bis zum Ende des
7159 <term><literal>our $form</literal></term>
7162 <para><varname>$form</varname> referenziert ab hier
7163 <varname>$PACKAGE::form</varname>.</para>
7168 <term><literal>local $form</literal></term>
7171 <para>Alle Änderungen an <varname>$form</varname> werden am Ende
7172 des scopes zurückgesetzt</para>
7179 <title>Warum sind globale Variablen ein Problem?</title>
7181 <para>Das erste Problem ist <productname>FCGI</productname>.</para>
7183 <para><productname>SQL-Ledger</productname> hat fast alles im globalen
7184 namespace abgelegt, und erwartet, dass es da auch wiederzufinden ist.
7185 Unter <productname>FCGI</productname> müssen diese Sachen aber wieder
7186 aufgeräumt werden, damit sie nicht in den nächsten Request kommen.
7187 Einige Sachen wiederum sollen nicht gelöscht werden, wie zum Beispiel
7188 Datenbankverbindungen, weil die sehr lange zum Initialisieren
7191 <para>Das zweite Problem ist <function>strict</function>. Unter
7192 <function>strict</function> werden alle Variablen die nicht explizit
7193 mit <function>Package</function>, <function>my</function> oder
7194 <function>our</function> angegeben werden als Tippfehler angemarkert,
7195 dies hat, seit der Einführung, u.a. schon so manche langwierige
7196 Bug-Suche verkürzt. Da globale Variablen aber implizit mit Package
7197 angegeben werden, werden die nicht geprüft, und somit kann sich
7198 schnell ein Tippfehler einschleichen.</para>
7202 <title>Kanonische globale Variablen</title>
7204 <para>Um dieses Problem im Griff zu halten gibt es einige wenige
7205 globale Variablen, die kanonisch sind, d.h. sie haben bestimmte
7206 vorgegebenen Eigenschaften, und alles andere sollte anderweitig
7207 umhergereicht werden.</para>
7209 <para>Diese Variablen sind im Moment die folgenden neun:</para>
7213 <para><varname>$::form</varname></para>
7217 <para><varname>%::myconfig</varname></para>
7221 <para><varname>$::locale</varname></para>
7225 <para><varname>$::lxdebug</varname></para>
7229 <para><varname>$::auth</varname></para>
7233 <para><varname>$::lx_office_conf</varname></para>
7237 <para><varname>$::instance_conf</varname></para>
7241 <para><varname>$::dispatcher</varname></para>
7245 <para><varname>$::request</varname></para>
7249 <para>Damit diese nicht erneut als Müllhalde missbraucht werden, im
7250 Folgenden eine kurze Erläuterung der bestimmten vorgegebenen
7251 Eigenschaften (Konventionen):</para>
7254 <title>$::form</title>
7258 <para>Ist ein Objekt der Klasse
7259 "<classname>Form</classname>"</para>
7263 <para>Wird nach jedem Request gelöscht</para>
7267 <para>Muss auch in Tests und Konsolenscripts vorhanden
7272 <para>Enthält am Anfang eines Requests die Requestparameter vom
7277 <para>Kann zwar intern über Requestgrenzen ein Datenbankhandle
7278 cachen, das wird aber momentan absichtlich zerstört</para>
7282 <para><varname>$::form</varname> wurde unter <productname>SQL
7283 Ledger</productname> als Gottobjekt für alles missbraucht. Sämtliche
7284 alten Funktionen unter SL/ mutieren <varname>$::form</varname>, das
7285 heißt, alles was einem lieb ist (alle Variablen die einem ans Herz
7286 gewachsen sind), sollte man vor einem Aufruf (!) von zum Beispiel
7287 <function>IS->retrieve_customer()</function> in Sicherheit
7290 <para>Z.B. das vom Benutzer eingestellte Zahlenformat, bevor man
7291 Berechnung in einem bestimmten Format durchführt (SL/Form.pm Zeile
7292 3552, Stand version 2.7beta), um dies hinterher wieder auf den
7293 richtigen Wert zu setzen:</para>
7295 <programlisting> my $saved_numberformat = $::myconfig{numberformat};
7296 $::myconfig{numberformat} = $numberformat;
7297 # (...) div Berechnungen
7298 $::myconfig{numberformat} = $saved_numberformat;</programlisting>
7300 <para>Das Objekt der Klasse Form hat leider im Moment noch viele
7301 zentrale Funktionen die vom internen Zustand abhängen, deshalb bitte
7302 nie einfach zerstören oder überschreiben (zumindestens nicht kurz
7303 vor einem Release oder in Absprache über bspw. die devel-Liste ;-).
7304 Es geht ziemlich sicher etwas kaputt.</para>
7306 <para><varname>$::form</varname> ist gleichzeitig der Standard Scope
7307 in den <productname>Template::Toolkit</productname> Templates
7308 außerhalb der Controller: der Ausdruck <function>[% var
7309 %]</function> greift auf <varname>$::form->{var}</varname> zu.
7310 Unter Controllern ist der Standard Scope anders, da lautet der
7311 Zugriff <function>[% FORM.var %]</function>. In Druckvorlagen sind
7312 normale Variablen ebenfall im <varname>$::form</varname> Scope, d.h.
7313 <function><%var%></function> zeigt auf
7314 <varname>$::form->{var}</varname>. Nochmal von der anderen Seite
7315 erläutert, innerhalb von (Web-)Templates sieht man häufiger solche
7318 <programlisting>[%- IF business %]
7319 # (... Zeig die Auswahlliste Kunden-/Lieferantentyp an)
7320 [%- END %]</programlisting>
7322 <para>Entweder wird hier dann $::form->{business} ausgewertet
7323 oder aber der Funktion
7324 <function>$form->parse_html_template</function> wird explizit
7325 noch ein zusätzlicher Hash übergeben, der dann auch in den
7326 (Web-)Templates zu Verfügung steht, bspw. so:</para>
7328 <programlisting>$form->parse_html_template("is/form_header", \%TMPL_VAR);</programlisting>
7330 <para>Innerhalb von Schleifen wird
7331 <varname>$::form->{TEMPLATE_ARRAYS}{var}[$index]</varname>
7332 bevorzugt, wenn vorhanden. Ein Beispiel findet sich in SL/DO.pm,
7333 welches über alle Positionen eines Lieferscheins in Schleife
7336 <programlisting>for $i (1 .. $form->{rowcount}) {
7338 push @{ $form->{TEMPLATE_ARRAYS}{runningnumber} }, $position;
7339 push @{ $form->{TEMPLATE_ARRAYS}{number} }, $form->{"partnumber_$i"};
7340 push @{ $form->{TEMPLATE_ARRAYS}{description} }, $form->{"description_$i"};
7346 <title>%::myconfig</title>
7350 <para>Das einzige Hash unter den globalen Variablen</para>
7354 <para>Wird spätestens benötigt wenn auf die Datenbank
7355 zugegriffen wird</para>
7359 <para>Wird bei jedem Request neu erstellt.</para>
7363 <para>Enthält die Userdaten des aktuellen Logins</para>
7367 <para>Sollte nicht ohne Filterung irgendwo gedumpt werden oder
7368 extern serialisiert werden, weil da auch der Datenbankzugriff
7369 für diesen user drinsteht.</para>
7373 <para>Enthält unter anderem Datumsformat dateformat und
7374 Nummernformat numberformat</para>
7378 <para>Enthält Datenbankzugriffinformationen</para>
7382 <para><varname>%::myconfig</varname> ist im Moment der Ersatz für
7383 ein Userobjekt. Die meisten Funktionen, die etwas anhand des
7384 aktuellen Users entscheiden müssen, befragen
7385 <varname>%::myconfig</varname>. Innerhalb der Anwendungen sind dies
7386 überwiegend die Daten, die sich unter <guimenu>Programm</guimenu>
7387 -> <guimenuitem>Einstellungen</guimenuitem> befinden, bzw. die
7388 Informationen über den Benutzer die über die
7389 Administrator-Schnittstelle eingegeben wurden.</para>
7393 <title>$::locale</title>
7397 <para>Objekt der Klasse "Locale"</para>
7401 <para>Wird pro Request erstellt</para>
7405 <para>Muss auch für Tests und Scripte immer verfügbar
7410 <para>Cached intern über Requestgrenzen hinweg benutzte
7415 <para>Lokalisierung für den aktuellen User. Alle Übersetzungen,
7416 Zahlen- und Datumsformatierungen laufen über dieses Objekt.</para>
7420 <title>$::lxdebug</title>
7424 <para>Objekt der Klasse "LXDebug"</para>
7428 <para>Wird global gecached</para>
7432 <para>Muss immer verfügbar sein, in nahezu allen
7437 <para><varname>$::lxdebug</varname> stellt Debuggingfunktionen
7438 bereit, wie "<function>enter_sub</function>" und
7439 "<function>leave_sub</function>", mit denen in den alten Modulen ein
7440 brauchbares Tracing gebaut ist, "<function>log_time</function>", mit
7441 der man die Wallclockzeit seit Requeststart loggen kann, sowie
7442 "<function>message</function>" und "<function>dump</function>" mit
7443 denen man flott Informationen ins Log (tmp/kivitendo-debug.log)
7446 <para>Beispielsweise so:</para>
7448 <programlisting>$main::lxdebug->message(0, 'Meine Konfig:' . Dumper (%::myconfig));
7449 $main::lxdebug->message(0, 'Wer bin ich? Kunde oder Lieferant:' . $form->{vc});</programlisting>
7453 <title>$::auth</title>
7457 <para>Objekt der Klasse "SL::Auth"</para>
7461 <para>Wird global gecached</para>
7465 <para>Hat eine permanente DB Verbindung zur Authdatenbank</para>
7469 <para>Wird nach jedem Request resettet.</para>
7473 <para><varname>$::auth</varname> stellt Funktionen bereit um die
7474 Rechte des aktuellen Users abzufragen. Obwohl diese Informationen
7475 vom aktuellen User abhängen wird das Objekt aus
7476 Geschwindigkeitsgründen nur einmal angelegt und dann nach jedem
7477 Request kurz resettet.</para>
7479 <para>Dieses Objekt kapselt auch den gerade aktiven Mandanten.
7480 Dessen Einstellungen können über
7481 <literal>$::auth->client</literal> abgefragt werden; Rückgabewert
7482 ist ein Hash mit den Werten aus der Tabelle
7483 <literal>auth.clients</literal>.</para>
7487 <title>$::lx_office_conf</title>
7491 <para>Objekt der Klasse
7492 "<classname>SL::LxOfficeConf</classname>"</para>
7496 <para>Global gecached</para>
7500 <para>Repräsentation der
7501 <filename>config/kivitendo.conf[.default]</filename>-Dateien</para>
7505 <para>Globale Konfiguration. Configdateien werden zum Start gelesen
7506 und danach nicht mehr angefasst. Es ist derzeit nicht geplant, dass
7507 das Programm die Konfiguration ändern kann oder sollte.</para>
7509 <para>Beispielsweise ist über den Konfigurationseintrag [debug] die
7510 Debug- und Trace-Log-Datei wie folgt konfiguriert und
7513 <programlisting>[debug]
7514 file_name = /tmp/kivitendo-debug.log</programlisting>
7516 <para>ist der Key <varname>file</varname> im Programm als
7517 <varname>$::lx_office_conf->{debug}{file}</varname>
7521 <para>Zugriff auf die Konfiguration erfolgt im Moment über
7522 Hashkeys, sind also nicht gegen Tippfehler abgesichert.</para>
7527 <title>$::instance_conf</title>
7531 <para>Objekt der Klasse
7532 "<classname>SL::InstanceConfiguration</classname>"</para>
7536 <para>wird pro Request neu erstellt</para>
7540 <para>Funktioniert wie <varname>$::lx_office_conf</varname>,
7541 speichert aber Daten die von der Instanz abhängig sind. Eine Instanz
7542 ist hier eine Mandantendatenbank. Beispielsweise überprüft
7543 <programlisting>$::instance_conf->get_inventory_system eq 'perpetual'</programlisting>
7544 ob die berüchtigte Bestandsmethode zur Anwendung kommt.</para>
7548 <title>$::dispatcher</title>
7552 <para>Objekt der Klasse
7553 "<varname>SL::Dispatcher</varname>"</para>
7557 <para>wird pro Serverprozess erstellt.</para>
7561 <para>enthält Informationen über die technische Verbindung zum
7566 <para>Der dritte Punkt ist auch der einzige Grund warum das Objekt
7567 global gespeichert wird. Wird vermutlich irgendwann in einem anderen
7568 Objekt untergebracht.</para>
7572 <title>$::request</title>
7576 <para>Hashref (evtl später Objekt)</para>
7580 <para>Wird pro Request neu initialisiert.</para>
7584 <para>Keine Unterstruktur garantiert.</para>
7588 <para><varname>$::request</varname> ist ein generischer Platz um
7589 Daten "für den aktuellen Request" abzulegen. Sollte nicht für action
7590 at a distance benutzt werden, sondern um lokales memoizing zu
7591 ermöglichen, das garantiert am Ende des Requests zerstört
7594 <para>Vieles von dem, was im moment in <varname>$::form</varname>
7595 liegt, sollte eigentlich hier liegen. Die groben
7596 Differentialkriterien sind:</para>
7600 <para>Kommt es vom User, und soll unverändert wieder an den
7601 User? Dann <varname>$::form</varname>, steht da eh schon</para>
7605 <para>Sind es Daten aus der Datenbank, die nur bis zum Ende des
7606 Requests gebraucht werden? Dann
7607 <varname>$::request</varname></para>
7611 <para>Muss ich von anderen Teilen des Programms lesend drauf
7612 zugreifen? Dann <varname>$::request</varname>, aber Zugriff über
7613 Wrappermethode</para>
7620 <title>Ehemalige globale Variablen</title>
7622 <para>Die folgenden Variablen waren einmal im Programm, und wurden
7626 <title>$::cgi</title>
7630 <para>war nötig, weil cookie Methoden nicht als
7631 Klassenfunktionen funktionieren</para>
7635 <para>Aufruf als Klasse erzeugt Dummyobjekt was im
7636 Klassennamespace gehalten wird und über Requestgrenzen
7641 <para>liegt jetzt unter
7642 <varname>$::request->{cgi}</varname></para>
7648 <title>$::all_units</title>
7652 <para>war nötig, weil einige Funktionen in Schleifen zum Teil
7653 ein paar hundert mal pro Request eine Liste der Einheiten
7654 brauchen, und de als Parameter durch einen Riesenstack von
7655 Funktionen geschleift werden müssten.</para>
7659 <para>Liegt jetzt unter
7660 <varname>$::request->{cache}{all_units}</varname></para>
7665 <function>AM->retrieve_all_units()</function> gesetzt oder
7672 <title>%::called_subs</title>
7676 <para>wurde benutzt um callsub deep recursions
7681 <para>Wurde entfernt, weil callsub nur einen Bruchteil der
7682 möglichen Rekursioenen darstellt, und da nie welche
7687 <para>komplette recursion protection wurde entfernt.</para>
7694 <sect1 id="devel.fcgi">
7695 <title>Entwicklung unter FastCGI</title>
7697 <sect2 id="devel.fcgi.general">
7698 <title>Allgemeines</title>
7700 <para>Wenn Änderungen in der Konfiguration von kivitendo gemacht
7701 werden, muss der Webserver neu gestartet werden.</para>
7703 <para>Bei der Entwicklung für FastCGI ist auf ein paar Fallstricke zu
7704 achten. Dadurch, dass das Programm in einer Endlosschleife läuft,
7705 müssen folgende Aspekte beachtet werden.</para>
7708 <sect2 id="devel.fcgi.exiting">
7709 <title>Programmende und Ausnahmen</title>
7711 <para>Betrifft die Funktionen <function>warn</function>,
7712 <function>die</function>, <function>exit</function>,
7713 <function>carp</function> und <function>confess</function>.</para>
7715 <para>Fehler, die dass Programm normalerweise sofort beenden (fatale
7716 Fehler), werden mit dem FastCGI Dispatcher abgefangen, um das Programm
7717 am Laufen zu halten. Man kann mit <function>die</function>,
7718 <function>confess</function> oder <function>carp</function> Fehler
7719 ausgeben, die dann vom Dispatcher angezeigt werden. Die kivitendo
7720 eigene <function>$::form-</function>error()> tut im Prinzip das
7721 Gleiche, mit ein paar Extraoptionen. <function>warn</function> und
7722 <function>exit</function> hingegen werden nicht abgefangen.
7723 <function>warn</function> wird direkt nach STDERR, also in Server Log
7724 eine Nachricht schreiben (sofern in der Konfiguration nicht die
7725 Warnungen in das kivitendo Log umgeleitet wurden), und
7726 <function>exit</function> wird die Ausführung beenden.</para>
7728 <para>Prinzipiell ist es kein Beinbruch, wenn sich der Prozess
7729 beendet, fcgi wird ihn sofort neu starten. Allerdings sollte das die
7730 Ausnahme sein. Quintessenz: Bitte kein <function>exit</function>
7731 benutzen, alle anderen Exceptionmechanismen sind ok.</para>
7734 <sect2 id="devel.fcgi.globals">
7735 <title>Globale Variablen</title>
7737 <para>Um zu vermeiden, dass Informationen von einem Request in einen
7738 anderen gelangen, müssen alle globalen Variablen vor einem Request
7739 sauber initialisiert werden. Das ist besonders wichtig im
7740 <varname>$::cgi</varname> und <varname>$::auth</varname> Objekt, weil
7741 diese nicht gelöscht werden pro Instanz, sondern persistent gehalten
7744 <para>In <classname>SL::Dispatcher</classname> gibt es einen sauber
7745 abgetrennten Block, der alle kanonischen globalen Variablen listet und
7746 erklärt. Bitte keine anderen einführen ohne das sauber zu
7747 dokumentieren.</para>
7749 <para>Datenbankverbindungen wird noch ein Guide verfasst werden, wie
7750 man sicher geht, dass man die richtige erwischt.</para>
7753 <sect2 id="devel.fcgi.performance">
7754 <title>Performance und Statistiken</title>
7756 <para>Die kritischen Pfade des Programms sind die Belegmasken, und
7757 unter diesen ganz besonders die Verkaufsrechnungsmaske. Ein Aufruf der
7758 Rechnungsmaske in kivitendo 2.4.3 stable dauert auf einem Core2duo mit
7759 4GB Arbeitsspeicher und Ubuntu 9.10 eine halbe Sekunde. In der 2.6.0
7760 sind es je nach Menge der definierten Variablen 1-2s. Ab der
7761 Moose/Rose::DB Version sind es 5-6s.</para>
7763 <para>Mit FastCGI ist die neuste Version auf 0,26 Sekunden selbst in
7764 den kritischen Pfaden, unter 0,15 sonst.</para>
7768 <sect1 id="db-upgrade-files" xreflabel="Datenbank-Upgradedateien">
7769 <title>SQL-Upgradedateien</title>
7771 <sect2 id="db-upgrade-files.introduction"
7772 xreflabel="Einführung in die Datenbank-Upgradedateien">
7773 <title>Einführung</title>
7775 <para>Datenbankupgrades werden über einzelne Upgrade-Scripte
7776 gesteuert, die sich im Verzeichnis
7777 <filename>sql/Pg-upgrade2</filename> befinden. In diesem Verzeichnis
7778 muss pro Datenbankupgrade eine Datei existieren, die neben den
7779 eigentlich auszuführenden SQL- oder Perl-Befehlen einige
7780 Kontrollinformationen enthält.</para>
7782 <para>Kontrollinformationen definieren Abhängigkeiten und Prioritäten,
7783 sodass Datenbankscripte zwar in einer sicheren Reihenfolge ausgeführt
7784 werden (z.B. darf ein <literal>ALTER TABLE</literal> erst ausgeführt
7785 werden, wenn die Tabelle mit <literal>CREATE TABLE</literal> angelegt
7786 wurde), diese Reihenfolge aber so flexibel ist, dass man keine
7787 Versionsnummern braucht.</para>
7789 <para>kivitendo merkt sich dabei, welches der Upgradescripte in
7790 <filename>sql/Pg-upgrade2</filename> bereits durchgeführt wurde und
7791 führt diese nicht erneut aus. Dazu dient die Tabelle
7792 "<literal>schema_info</literal>", die bei der Anmeldung automatisch
7793 angelegt wird.</para>
7796 <sect2 id="db-upgrade-files.format"
7797 xreflabel="Format der Upgradedateien">
7798 <title>Format der Kontrollinformationen</title>
7800 <para>Die Kontrollinformationen sollten sich am Anfang der jeweiligen
7801 Upgradedatei befinden. Jede Zeile, die Kontrollinformationen enthält,
7802 hat dabei das folgende Format:</para>
7804 <para>Für SQL-Upgradedateien:</para>
7806 <programlisting>-- @key: value</programlisting>
7808 <para>Für Perl-Upgradedateien:</para>
7810 <programlisting># @key: value</programlisting>
7812 <para>Leerzeichen vor "<varname>value</varname>" werden
7815 <para>Die folgenden Schlüsselworte werden verarbeitet:</para>
7819 <term><varname>tag</varname></term>
7822 <para>Wird zwingend benötigt. Dies ist der "Name" des Upgrades.
7823 Dieser "tag" kann von anderen Kontrolldateien in ihren
7824 Abhängigkeiten verwendet werden (Schlüsselwort
7825 "<varname>depends</varname>"). Der "tag" ist auch der Name, der
7826 in der Datenbank eingetragen wird.</para>
7828 <para>Normalerweise sollte die Kontrolldatei genau so heißen wie
7829 der "tag", nur mit der Endung ".sql" bzw. "pl".</para>
7831 <para>Ein Tag darf nur aus alphanumerischen Zeichen sowie den
7832 Zeichen _ - ( ) bestehen. Insbesondere sind Leerzeichen nicht
7833 erlaubt und sollten stattdessen mit Unterstrichen ersetzt
7839 <term><varname>charset</varname></term>
7842 <para>Empfohlen. Gibt den Zeichensatz an, in dem das Script
7843 geschrieben wurde, z.B. "<literal>UTF-8</literal>". Aus
7844 Kompatibilitätsgründen mit alten Upgrade-Scripten wird bei
7845 Abwesenheit des Tags für SQL-Upgradedateien der Zeichensatz
7846 "<literal>ISO-8859-15</literal>" angenommen. Perl-Upgradescripte
7847 hingegen müssen immer in UTF-8 encodiert sein und sollten
7848 demnach auch ein "<literal>use utf8;</literal>"
7854 <term><varname>description</varname></term>
7857 <para>Benötigt. Eine Beschreibung, was in diesem Update
7858 passiert. Diese wird dem Benutzer beim eigentlichen
7859 Datenbankupdate angezeigt. Während der Tag in Englisch gehalten
7860 sein sollte, sollte die Beschreibung auf Deutsch
7866 <term><varname>depends</varname></term>
7869 <para>Optional. Eine mit Leerzeichen getrennte Liste von "tags",
7870 von denen dieses Upgradescript abhängt. kivitendo stellt sicher,
7871 dass die in dieser Liste aufgeführten Scripte bereits
7872 durchgeführt wurden, bevor dieses Script ausgeführt wird.</para>
7874 <para>Abhängigkeiten werden rekursiv betrachtet. Wenn also ein
7875 Script "b" existiert, das von Änderungen in "a" abhängt, und
7876 eine neue Kontrolldatei für "c" erstellt wird, die von
7877 Änderungen in "a" und "b" abhängt, so genügt es, in "c" nur den
7878 Tag "b" als Abhängigkeit zu definieren.</para>
7880 <para>Es ist nicht erlaubt, sich selbst referenzierende
7881 Abhängigkeiten zu definieren (z.B. "a" -> "b", "b" -> "c"
7882 und "c" -> "a").</para>
7887 <term><varname>priority</varname></term>
7890 <para>Optional. Ein Zahlenwert, der die Reihenfolge bestimmt, in
7891 der Scripte ausgeführt werden, die die gleichen
7892 Abhängigkeitstiefen besitzen. Fehlt dieser Parameter, so wird
7893 der Wert 1000 benutzt.</para>
7895 <para>Dies ist reine Kosmetik. Für echte Reihenfolgen muss
7896 "depends" benutzt werden. kivitendo sortiert die auszuführenden
7897 Scripte zuerst nach der Abhängigkeitstiefe (wenn "z" von "y"
7898 abhängt und "y" von "x", so hat "z" eine Abhängigkeitstiefe von
7899 2, "y" von 1 und "x" von 0. "x" würde hier zuerst ausgeführt,
7900 dann "y", dann "z"), dann nach der Priorität und bei gleicher
7901 Priorität alphabetisch nach dem "tag".</para>
7906 <term><varname>ignore</varname></term>
7909 <para>Optional. Falls der Wert auf 1 (true) steht, wird das
7910 Skript bei der Anmeldung ignoriert und entsprechend nicht
7917 <sect2 id="db-upgrade-files.format-perl-files"
7918 xreflabel="Format von Perl-Upgradedateien">
7919 <title>Format von in Perl geschriebenen
7920 Datenbankupgradescripten</title>
7922 <para>In Perl geschriebene Datenbankscripte werden nicht einfach so
7923 ausgeführt sondern müssen sich an gewisse Konventionen halten. Dafür
7924 bekommen sie aber auch einige Komfortfunktionen bereitgestellt.</para>
7926 <para>Ein Upgradescript stellt dabei eine vollständige Objektklasse
7927 dar, die vom Elternobjekt "<literal>SL::DBUpgrade2::Base</literal>"
7928 erben und eine Funktion namens "<literal>run</literal>" zur Verfügung
7929 stellen muss. Das Script wird ausgeführt, indem eine Instanz dieser
7930 Klasse erzeugt und darauf die erwähnte "<literal>run</literal>"
7931 aufgerufen wird.</para>
7933 <para>Zu beachten ist, dass sich der Paketname der Datei aus dem Wert
7934 für "<literal>@tag</literal>" ableitet. Dabei werden alle Zeichen, die
7935 in Paketnamen ungültig wären (gerade Bindestriche), durch Unterstriche
7936 ersetzt. Insgesamt sieht der Paketname wie folgt aus:
7937 "<literal>SL::DBUpgrade2::tag</literal>".</para>
7939 <para>Welche Komfortfunktionen zur Verfügung stehen, erfahren Sie in
7940 der Perl-Dokumentation zum oben genannten Modul; aufzurufen mit
7941 "<command>perldoc SL/DBUpgrade2/Base.pm</command>".</para>
7943 <para>Ein Mindestgerüst eines gültigen Perl-Upgradescriptes sieht wie
7946 <programlisting># @tag: beispiel-upgrade-file42
7947 # @description: Ein schönes Beispielscript
7948 # @depends: release_3_1_0
7949 package SL::DBUpgrade2::beispiel_upgrade_file42;
7954 use parent qw(SL::DBUpgrade2::Base);
7959 # hier Aktionen ausführen
7968 <sect2 id="db-upgrade-files.dbupgrade-tool"
7969 xreflabel="Hilfsscript dbupgrade2_tool.pl">
7970 <title>Hilfsscript dbupgrade2_tool.pl</title>
7972 <para>Um die Arbeit mit den Abhängigkeiten etwas zu erleichtern,
7973 existiert ein Hilfsscript namens
7974 "<filename>scripts/dbupgrade2_tool.pl</filename>". Es muss aus dem
7975 kivitendo-ERP-Basisverzeichnis heraus aufgerufen werden. Dieses Tool
7976 liest alle Datenbankupgradescripte aus dem Verzeichnis
7977 <filename>sql/Pg-upgrade2</filename> aus. Es benutzt dafür die
7978 gleichen Methoden wie kivitendo selber, sodass alle Fehlersituationen
7979 von der Kommandozeile überprüft werden können.</para>
7981 <para>Wird dem Script kein weiterer Parameter übergeben, so wird nur
7982 eine Überprüfung der Felder und Abhängigkeiten vorgenommen. Man kann
7983 sich aber auch Informationen auf verschiedene Art ausgeben
7988 <para>Listenform: "<command>./scripts/dbupgrade2_tool.pl
7989 --list</command>"</para>
7991 <para>Gibt eine Liste aller Scripte aus. Die Liste ist in der
7992 Reihenfolge sortiert, in der kivitendo die Scripte ausführen
7993 würde. Es werden neben der Listenposition der Tag, die
7994 Abhängigkeitstiefe und die Priorität ausgegeben.</para>
7998 <para>Baumform: "<command>./scripts/dbupgrade2_tool.pl
7999 --tree</command>"</para>
8001 <para>Listet alle Tags in Baumform basierend auf den
8002 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte, von
8003 denen keine anderen abhängen. Die Unterknoten sind Scripte, die
8004 beim übergeordneten Script als Abhängigkeit eingetragen
8008 <listitem id="db-upgrade-files.dbupgrade-tool.reverse-tree">
8009 <para>Umgekehrte Baumform: "<command>./scripts/dbupgrade2_tool.pl
8010 --rtree</command>"</para>
8012 <para>Listet alle Tags in Baumform basierend auf den
8013 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte mit
8014 der geringsten Abhängigkeitstiefe. Die Unterknoten sind Scripte,
8015 die das übergeordnete Script als Abhängigkeit eingetragen
8020 <para>Baumform mit Postscriptausgabe:
8021 "<command>./scripts/dbupgrade2_tool.pl
8022 --graphviz</command>"</para>
8024 <para>Benötigt das Tool "<command>graphviz</command>", um mit
8025 seiner Hilfe die <link
8026 linkend="db-upgrade-files.dbupgrade-tool.reverse-tree">umgekehrte
8027 Baumform</link> in eine Postscriptdatei namens
8028 "<filename>db_dependencies.ps</filename>" auszugeben. Dies ist
8029 vermutlich die übersichtlichste Form, weil hierbei jeder Knoten
8030 nur einmal ausgegeben wird. Bei den Textmodusbaumformen hingegen
8031 können Knoten und all ihre Abhängigkeiten mehrfach ausgegeben
8036 <para>Scripte, von denen kein anderes Script abhängt:
8037 "<command>./scripts/dbupgrade2_tool.pl --nodeps</command>"</para>
8039 <para>Listet die Tags aller Scripte auf, von denen keine anderen
8040 Scripte abhängen.</para>
8046 <sect1 id="translations-languages" xreflabel="Translations and languages">
8047 <title>Translations and languages</title>
8049 <sect2 id="translations-languages.introduction"
8050 xreflabel="Introduction to translations and languages">
8051 <title>Introduction</title>
8054 <para>Dieser Abschnitt ist in Englisch geschrieben, um
8055 internationalen Übersetzern die Arbeit zu erleichtern.</para>
8058 <para>This section describes how localization packages in kivitendo
8059 are built. Currently the only language fully supported is German, and
8060 since most of the internal messages are held in English the English
8061 version is usable too.</para>
8064 <sect2 id="translations-languages.character-set"
8065 xreflabel="Character set">
8066 <title>Character set</title>
8068 <para>All files included in a language pack must use UTF-8 as their
8072 <sect2 id="translations-languages.file-structure"
8073 xreflabel="File structure">
8074 <title>File structure</title>
8076 <para>The structure of locales in kivitendo is:</para>
8078 <programlisting>kivitendo/locale/<langcode>/</programlisting>
8080 <para>where <langcode> stands for an abbreviation of the
8081 language package. The builtin packages use two letter <ulink
8082 url="http://en.wikipedia.org/wiki/ISO_639-1">ISO 639-1</ulink> codes,
8083 but the actual name is not relevant for the program and can easily be
8085 url="http://en.wikipedia.org/wiki/IETF_language_tag">IETF language
8086 tags</ulink> (i.e. "en_GB"). In fact the original language packages
8087 from SQL Ledger are named in this way.</para>
8089 <para>In such a language directory the following files are
8094 <term>LANGUAGE</term>
8097 <para>This file is mandatory.</para>
8099 <para>The <filename>LANGUAGE</filename> file contains the self
8100 descripted name of the language. It should contain a native
8101 representation first, and in parenthesis an english translation
8102 after that. Example:</para>
8104 <programlisting>Deutsch (German)</programlisting>
8112 <para>This file is mandatory.</para>
8114 <para>The central translation file. It is essentially an inline
8115 Perl script autogenerated by <command>locales.pl</command>. To
8116 generate it, generate the directory and the two files mentioned
8117 above, and execute the following command:</para>
8119 <programlisting>scripts/locales.pl <langcode></programlisting>
8121 <para>Otherwise you can simply copy one of the other languages.
8122 You will be told how many are missing like this:</para>
8124 <programlisting>$ scripts/locales.pl en
8125 English - 0.6% - 2015/2028 missing</programlisting>
8127 <para>A file named "<filename>missing</filename>" will be
8128 generated and can be edited. You can also edit the
8129 "<filename>all</filename>" file directly. Edit everything you
8130 like to fit the target language and execute
8131 <command>locales.pl</command> again. See how the missing words
8137 <term>Num2text</term>
8140 <para>Legacy code from SQL Ledger. It provides a means for
8141 numbers to be converted into natural language, like
8142 <literal>1523 => one thousand five hundred twenty
8143 three</literal>. If you want to provide it, it must be inlinable
8144 Perl code which provides a <function>num2text</function> sub. If
8145 an <function>init</function> sub exists it will be executed
8148 <para>Only used in the check and receipt printing module.</para>
8153 <term>special_chars</term>
8156 <para>kivitendo comes with a lot of interfaces to different
8157 formats, some of which are rather picky with their accepted
8158 charset. The <filename>special_chars</filename> file contains a
8159 listing of chars not suited for different file format and
8160 provides substitutions. It is written in "Simple Ini" style,
8161 containing a block for every file format.</para>
8163 <para>First entry should be the order of substitution for
8164 entries as a whitespace separated list. All entries are
8165 interpolated, so <literal>\n</literal>, <literal>\x20</literal>
8166 and <literal>\\</literal> all work.</para>
8168 <para>After that every entry is a special char that should be
8169 translated when writing text into such a file.</para>
8171 <para>Example:</para>
8173 <programlisting>[Template/XML]
8174 order=& < > \n
8178 \n=<br></programlisting>
8180 <para>Note the importance of the order in this example.
8181 Substituting < and > befor & would lead to $gt; become
8184 <para>For a list of valid formats, see the German
8185 <filename>special_chars</filename> entry. As of this writing the
8186 following are recognized:</para>
8188 <programlisting>HTML
8193 Template/OpenDocument
8194 filenames</programlisting>
8196 <para>The last of which is very machine dependant. Remember that
8197 a lot of characters are forbidden by some filesystems, for
8198 example MS Windows doesn't like ':' in its files where Linux
8199 doesn't mind that. If you want the files created with your
8200 language pack to be portable, find all chars that could cause
8206 <term>missing</term>
8209 <para>This file is not a part of the language package
8212 <para>This is a file generated by
8213 <command>scripts/locales.pl</command> while processing your
8214 locales. It's only to have the missing entries singled out and
8215 does not belong to a language package.</para>
8223 <para>This file is not a part of the language package
8226 <para>Another file generated by
8227 <command>scripts/locales.pl</command>. If for any reason a
8228 translation does not appear anymore and can be deleted, it gets
8229 moved here. The last 50 or so entries deleted are saved here in
8230 case you made a typo, so that you don't have to translate
8231 everything again. If a tranlsation is missing, the lost file is
8232 checked first. If you maintain a language package, you might
8233 want to keep this safe somewhere.</para>
8238 <term>more/all</term>
8241 <para>This subdir and file is not a part of the language package
8244 <para>If the directory more exists and contains a file called
8245 all it will be parsed in addition to the mandatory all (see
8246 above). The file is useful if you want to change some
8247 translations for the current installation without conflicting
8248 further upgrades. The file is not autogenerated and has the same
8249 format as the all, but needs another key (more_texts). See the
8250 german translation for an example or copy the following code:
8253 # -*- coding: utf-8; -*-
8258 # These are additional texts for custom translations.
8259 # The format is the same as for the normal file all, only
8260 # with another key (more_texts instead of texts).
8261 # The file has the form of 'english text' => 'foreign text',
8263 $self->{more_texts} = {
8265 'Ship via' => 'Terms of delivery',
8266 'Shipping Point' => 'Delivery time',
8268 </programlisting></para>
8275 <sect1 id="devel.testsuite">
8276 <title>Die kivitendo-Test-Suite</title>
8278 <sect2 id="devel.testsuite.intro">
8279 <title>Einführung</title>
8281 <para>kivitendo enthält eine Suite für automatisierte Tests. Sie
8282 basiert auf dem Standard-Perl-Modul
8283 <literal>Test::More</literal>.</para>
8285 <para>Die grundlegenden Fakten sind:</para>
8289 <para>Alle Tests liegen im Unterverzeichnis
8290 <filename>t/</filename>.</para>
8294 <para>Ein Script (bzw. ein Test) in <filename>t/</filename>
8295 enthält einen oder mehrere Testfälle.</para>
8299 <para>Alle Dateinamen von Tests enden auf <literal>.t</literal>.
8300 Es sind selbstständig ausführbare Perl-Scripte.</para>
8304 <para>Die Test-Suite besteht aus der Gesamtheit aller Tests,
8305 sprich aller Scripte in <filename>t/</filename>, deren Dateiname
8306 auf <literal>.t</literal> endet.</para>
8311 <sect2 id="devel.testsuite.prerequisites">
8312 <title>Voraussetzungen</title>
8314 <para>Für die Ausführung werden neben den für kivitendo eh schon
8315 benötigten Module noch weitere Perl-Module benötigt. Diese
8320 <para><literal>Test::Deep</literal> (Debian-Paketname:
8321 <literal>libtest-deep-perl</literal>; Fedora:
8322 <literal>perl-Test-Deep</literal>; openSUSE:
8323 <literal>perl-Test-Deep</literal>)</para>
8327 <para><literal>Test::Exception</literal> (Debian-Paketname:
8328 <literal>libtest-exception-perl</literal>; Fedora:
8329 <literal>perl-Test-Exception</literal>; openSUSE:
8330 <literal>perl-Test-Exception</literal>)</para>
8334 <para><literal>Test::Output</literal> (Debian-Paketname:
8335 <literal>libtest-output-perl</literal>; Fedora:
8336 <literal>perl-Test-Output</literal>; openSUSE:
8337 <literal>perl-Test-Output</literal>)</para>
8341 <para><literal>Test::Harness</literal> 3.0.0 oder höher. Dieses
8342 Modul ist ab Perl 5.10.1 Bestandteil der Perl-Distribution und
8343 kann für frühere Versionen aus dem <ulink
8344 url="http://www.cpan.org">CPAN</ulink> bezogen werden.</para>
8348 <para><literal>LWP::Simple</literal> aus dem Paket
8349 <literal>libwww-perl</literal> (Debian-Panetname:
8350 <literal>libwww-perl</literal>; Fedora:
8351 <literal>perl-libwww-perl</literal>; openSUSE:
8352 <literal>perl-libwww-perl</literal>)</para>
8356 <para><literal>URI::Find</literal> (Debian-Panetname:
8357 <literal>liburi-find-perl</literal>; Fedora:
8358 <literal>perl-URI-Find</literal>; openSUSE:
8359 <literal>perl-URI-Find</literal>)</para>
8363 <para><literal>Sys::CPU</literal> (Debian-Panetname:
8364 <literal>libsys-cpu-perl</literal>; Fedora und openSUSE: nicht
8369 <para><literal>Thread::Pool::Simple</literal> (Debian-Panetname:
8370 <literal>libthread-pool-simple-perl</literal>; Fedora und
8371 openSUSE: nicht vorhanden)</para>
8375 <para>Weitere Voraussetzung ist, dass die Testsuite ihre eigene
8376 Datenbank anlegen kann, um Produktivdaten nicht zu gefährden. Dazu
8377 müssen in der Konfigurationsdatei im Abschnit
8378 <literal>testing/database</literal> Datenbankverbindungsparameter
8379 angegeben werden. Der hier angegebene Benutzer muss weiterhin das
8380 Recht haben, Datenbanken anzulegen und zu löschen.</para>
8383 <sect2 id="devel.testsuite.execution">
8384 <title>Existierende Tests ausführen</title>
8386 <para>Es gibt mehrere Möglichkeiten zum Ausführen der Tests: entweder,
8387 man lässt alle Tests auf einmal ausführen, oder man führt gezielt
8388 einzelne Scripte aus. Für beide Fälle gibt es das Helferscript
8389 <filename>t/test.pl</filename>.</para>
8391 <para>Will man die komplette Test-Suite ausführen, so muss man einfach
8392 nur <filename>t/test.pl</filename> ohne weitere Parameter aus dem
8393 kivitendo-Basisverzeichnis heraus ausführen.</para>
8395 <para>Um einzelne Test-Scripte auszuführen, übergibt man deren Namen
8396 an <filename>t/test.pl</filename>. Beispielsweise:</para>
8398 <programlisting>t/test.pl t/form/format_amount.t t/background_job/known_jobs.t</programlisting>
8401 <sect2 id="devel.testsuite.meaning_of_scripts">
8402 <title>Bedeutung der verschiedenen Test-Scripte</title>
8404 <para>Die Test-Suite umfasst Tests sowohl für Funktionen als auch für
8405 Programmierstil. Einige besonders zu erwähnende, weil auch während der
8406 Entwicklung nützliche Tests sind:</para>
8410 <para><filename>t/001compile.t</filename> -- compiliert alle
8411 Quelldateien und bricht bei Fehlern sofort ab</para>
8415 <para><filename>t/002goodperl.t</filename> -- überprüft alle
8416 Perl-Dateien auf Anwesenheit von '<literal>use
8417 strict</literal>'-Anweisungen</para>
8421 <para><filename>t/003safesys.t</filename> -- überprüft Aufrufe von
8422 <function>system()</function> und <function>exec()</function> auf
8427 <para><filename>t/005no_tabs.t</filename> -- überprüft, ob Dateien
8428 Tab-Zeichen enthalten</para>
8432 <para><filename>t/006spelling.t</filename> -- sucht nach häufigen
8433 Rechtschreibfehlern</para>
8437 <para><filename>t/011pod.t</filename> -- überprüft die Syntax von
8438 Dokumentation im POD-Format auf Gültigkeit</para>
8442 <para>Weitere Test-Scripte überprüfen primär die Funktionsweise
8443 einzelner Funktionen und Module.</para>
8446 <sect2 id="devel.testsuite.create_new">
8447 <title>Neue Test-Scripte erstellen</title>
8449 <para>Es wird sehr gern gesehen, wenn neue Funktionalität auch gleich
8450 mit einem Test-Script abgesichert wird. Auch bestehende Funktion darf
8451 und soll ausdrücklich nachträglich mit Test-Scripten abgesichert
8454 <sect3 id="devel.testsuite.ideas_for_non_function_tests">
8455 <title>Ideen für neue Test-Scripte, die keine konkreten Funktionen
8458 <para>Ideen, die abgesehen von Funktionen noch nicht umgesetzt
8463 <para>Überprüfung auf fehlende symbolische Links</para>
8467 <para>Suche nach Nicht-ASCII-Zeichen in Perl-Code-Dateien (mit
8468 gewissen Einschränkungen wie das Erlauben von deutschen
8473 <para>Test auf DOS-Zeilenenden (\r\n anstelle von nur \n)</para>
8477 <para>Überprüfung auf Leerzeichen am Ende von Zeilen</para>
8481 <para>Test, ob alle zu übersetzenden Strings in
8482 <filename>locale/de/all</filename> vorhanden sind</para>
8486 <para>Test, ob alle Webseiten-Templates in
8487 <filename>templates/webpages</filename> mit vom Perl-Modul
8488 <literal>Template</literal> compiliert werden können</para>
8493 <sect3 id="devel.testsuite.directory_and_test_names">
8494 <title>Konvention für Verzeichnis- und Dateinamen</title>
8496 <para>Es gibt momentan eine wenige Richtlinien, wie Test-Scripte zu
8497 benennen sind. Bitte die folgenden Punkte als Richtlinie betrachten
8498 und ihnen soweit es geht folgen:</para>
8502 <para>Die Dateiendung muss <filename>.t</filename>
8507 <para>Namen sind englisch, komplett klein geschrieben und
8508 einzelne Wörter mit Unterstrichten getrennt (beispielsweise
8509 <filename>bad_function_params.t</filename>).</para>
8513 <para>Unterverzeichnisse sollten grob nach dem Themenbereich
8514 benannt sein, mit dem sich die Scripte darin befassen
8515 (beispielsweise <filename>background_jobs</filename> für Tests
8516 rund um Hintergrund-Jobs).</para>
8520 <para>Test-Scripte sollten einen überschaubaren Bereich von
8521 Funktionalität testen, der logisch zusammenhängend ist (z.B. nur
8522 Tests für eine einzelne Funktion in einem Modul). Lieber mehrere
8523 Test-Scripte schreiben.</para>
8528 <sect3 id="devel.testsuite.minimal_example">
8529 <title>Minimales Skelett für eigene Scripte</title>
8531 <para>Der folgenden Programmcode enthält das kleinstmögliche
8532 Testscript und kann als Ausgangspunkt für eigene Tests verwendet
8535 <programlisting>use Test::More tests => 0;
8539 use Support::TestSetup;
8541 Support::TestSetup::login();</programlisting>
8543 <para>Wird eine vollständig initialisierte kivitendo-Umgebung
8544 benötigt (Stichwort: alle globalen Variablen wie
8545 <varname>$::auth</varname>, <varname>$::form</varname> oder
8546 <varname>$::lxdebug</varname>), so muss in der Konfigurationsdatei
8547 <filename>config/kivitendo.conf</filename> im Abschnitt
8548 <literal>testing.login</literal> ein gültiger Login-Name eingetragen
8549 sein. Dieser wird für die Datenbankverbindung benötigt.</para>
8551 <para>Wir keine vollständig initialisierte Umgebung benötigt, so
8552 kann die letzte Zeile <programlisting>Support::TestSetup::login();</programlisting>
8553 weggelassen werden, was die Ausführungszeit des Scripts leicht
8559 <sect1 id="devel.style-guide">
8560 <title>Stil-Richtlinien</title>
8562 <para>Die folgenden Regeln haben das Ziel, den Code möglichst gut les-
8563 und wartbar zu machen. Dazu gehört zum Einen, dass der Code einheitlich
8564 eingerückt ist, aber auch, dass Mehrdeutigkeit so weit es geht vermieden
8565 wird (Stichworte "Klammern" oder "Hash-Keys").</para>
8567 <para>Diese Regeln sind keine Schikane sondern erleichtern allen das
8570 <para>Jeder, der einen Patch schickt, sollte seinen Code vorher
8571 überprüfen. Einige der Regeln lassen sich automatisch überprüfen, andere
8576 <para>Es werden keine echten Tabs sondern Leerzeichen
8581 <para>Die Einrückung beträgt zwei Leerzeichen. Beispiel:</para>
8583 <programlisting>foreach my $row (@data) {
8585 # do something with $row
8589 $row->{modules} = MODULE->retrieve(
8590 id => $row->{id},
8591 date => $use_now ? localtime() : $row->{time},
8595 $report->add($row);
8600 <para>Öffnende geschweifte Klammern befinden sich auf der gleichen
8601 Zeile wie der letzte Befehl. Beispiele:</para>
8603 <programlisting>sub debug {
8609 <programlisting>if ($form->{item_rows} > 0) {
8615 <para>Schließende geschweifte Klammern sind so weit eingerückt wie
8616 der Befehl / die öffnende schließende Klammer, die den Block
8617 gestartet hat, und nicht auf der Ebene des Inhalts. Die gleichen
8618 Beispiele wie bei 3. gelten.</para>
8622 <para>Die Wörter "<function>else</function>",
8623 "<function>elsif</function>", "<function>while</function>" befinden
8624 sich auf der gleichen Zeile wie schließende geschweifte Klammern.
8627 <programlisting>if ($form->{sum} > 1000) {
8629 } elsif ($form->{sum} > 0) {
8637 } until ($a > 0);</programlisting>
8641 <para>Parameter von Funktionsaufrufen müssen mit runden Klammern
8642 versehen werden. Davon nicht betroffen sind interne Perl-Funktionen,
8643 und grep-ähnliche Operatoren. Beispiel:</para>
8645 <programlisting>$main::lxdebug->message("Could not find file.");
8646 %options = map { $_ => 1 } grep { !/^#/ } @config_file;</programlisting>
8650 <para>Verschiedene Klammern, Ihre Ausdrücke und Leerzeichen:</para>
8652 <para>Generell gilt: Hashkeys und Arrayindices sollten nicht durch
8653 Leerzeichen abgesetzt werden. Logische Klammerungen ebensowenig,
8654 Blöcke schon. Beispiel:</para>
8656 <programlisting>if (($form->{debug} == 1) && ($form->{sum} - 100 < 0)) {
8661 $form->{sum} += $form->{"row_$i"};
8662 $form->{ $form->{index} } += 1;
8664 map { $form->{sum} += $form->{"row_$_"} } 1..$rowcount;</programlisting>
8668 <para>Mehrzeilige Befehle</para>
8672 <para>Werden die Parameter eines Funktionsaufrufes auf mehrere
8673 Zeilen aufgeteilt, so sollten diese bis zu der Spalte eingerückt
8674 werden, in der die ersten Funktionsparameter in der ersten Zeile
8675 stehen. Beispiel:</para>
8677 <programlisting>$sth = $dbh->prepare("SELECT * FROM some_table WHERE col = ?",
8678 $form->{some_col_value});</programlisting>
8682 <para>Ein Spezialfall ist der ternäre Operator "?:", der am
8683 besten in einer übersichtlichen Tabellenstruktur organisiert
8684 wird. Beispiel:</para>
8686 <programlisting>my $rowcount = $form->{"row_$i"} ? $i
8687 : $form->{oldcount} ? $form->{oldcount} + 1
8688 : $form->{rowcount} - $form->{rowbase};</programlisting>
8694 <para>Kommentare</para>
8698 <para>Kommentare, die alleine in einer Zeile stehen, sollten
8699 soweit wie der Code eingerückt sein.</para>
8703 <para>Seitliche hängende Kommentare sollten einheitlich
8704 formatiert werden.</para>
8708 <para>Sämtliche Kommentare und Sonstiges im Quellcode ist bitte
8709 auf Englisch zu verfassen. So wie ich keine Lust habe,
8710 französischen Quelltext zu lesen, sollte auch der kivitendo
8711 Quelltext für nicht-Deutschsprachige lesbar sein.
8714 <programlisting>my $found = 0;
8722 $i = 0 # initialize $i
8724 $i *= $const; # do something crazy
8725 $i = $n; # recover $i</programlisting>
8731 <para>Hashkeys sollten nur in Anführungszeichen stehen, wenn die
8732 Interpolation gewünscht ist. Beispiel:</para>
8734 <programlisting>$form->{sum} = 0;
8735 $form->{"row_$i"} = $form->{"row_$i"} - 5;
8736 $some_hash{42} = 54;</programlisting>
8740 <para>Die maximale Zeilenlänge ist nicht beschränkt. Zeilenlängen
8741 unterhalb von 79 Zeichen helfen unter bestimmten Bedingungen, aber
8742 wenn die Lesbarkeit unter kurzen Zeilen leidet (wie zum Biespiel in
8743 grossen Tabellen), dann ist Lesbarkeit vorzuziehen.</para>
8745 <para>Als Beispiel sei die Funktion
8746 <function>print_options</function> aus
8747 <filename>bin/mozilla/io.pl</filename> angeführt.</para>
8751 <para>Trailing Whitespace, d.h. Leerzeichen am Ende von Zeilen sind
8752 unerwünscht. Sie führen zu unnötigen Whitespaceänderungen, die diffs
8755 <para>Emacs und vim haben beide recht einfache Methoden zur
8756 Entfernung von trailing whitespace. Emacs kennt das Kommande
8757 <command>nuke-trailing-whitespace</command>, vim macht das gleiche
8758 manuell über <literal>:%s/\s\+$//e</literal> Mit <literal>:au
8759 BufWritePre * :%s/\s\+$//e</literal> wird das an Speichern
8764 <para>Es wird kein <command>perltidy</command> verwendet.</para>
8766 <para>In der Vergangenheit wurde versucht,
8767 <command>perltidy</command> zu verwenden, um einen einheitlichen
8768 Stil zu erlangen. Es hat sich aber gezeigt, dass
8769 <command>perltidy</command>s sehr eigenwilliges Verhalten, was
8770 Zeilenumbrüche angeht, oftmals gut formatierten Code zerstört. Für
8771 den Interessierten sind hier die
8772 <command>perltidy</command>-Optionen, die grob den beschriebenen
8773 Richtlinien entsprechen:</para>
8775 <programlisting>-syn -i=2 -nt -pt=2 -sbt=2 -ci=2 -ibc -hsc -noll -nsts -nsfs -asc -dsm
8776 -aws -bbc -bbs -bbb -mbl=1 -nsob -ce -nbl -nsbl -cti=0 -bbt=0 -bar -l=79
8777 -lp -vt=1 -vtc=1</programlisting>
8781 <para><varname>STDERR</varname> ist tabu. Unkonditionale
8782 Debugmeldungen auch.</para>
8784 <para>kivitendo bietet mit dem Modul <classname>LXDebug</classname>
8785 einen brauchbaren Trace-/Debug-Mechanismus. Es gibt also keinen
8786 Grund, nach <varname>STDERR</varname> zu schreiben.</para>
8788 <para>Die <classname>LXDebug</classname>-Methode
8789 "<function>message</function>" nimmt als ersten Paramter außerdem
8790 eine Flagmaske, für die die Meldung angezeigt wird, wobei "0" immer
8791 angezeigt wird. Solche Meldungen sollten nicht eingecheckt werden
8792 und werden in den meisten Fällen auch vom Repository
8793 zurückgewiesen.</para>
8797 <para>Alle neuen Module müssen use strict verwenden.</para>
8799 <para><varname>$form</varname>, <varname>$auth</varname>,
8800 <varname>$locale</varname>, <varname>$lxdebug</varname> und
8801 <varname>%myconfig</varname> werden derzeit aus dem main package
8802 importiert (siehe <xref linkend="devel.globals"/>. Alle anderen
8803 Konstrukte sollten lexikalisch lokal gehalten werden.</para>
8808 <sect1 id="devel.build-doc" xreflabel="Dokumentation erstellen">
8809 <title>Dokumentation erstellen</title>
8811 <sect2 id="devel.build-doc.introduction">
8812 <title>Einführung</title>
8814 <para>Diese Dokumentation ist in <productname>DocBook</productname>
8815 XML geschrieben. Zum Bearbeiten reicht grundsätzlich ein Text-Editor.
8816 Mehr Komfort bekommt man, wenn man einen dedizierten XML-fähigen
8817 Editor nutzt, der spezielle Unterstützung für
8818 <productname>DocBook</productname> mitbringt. Wir empfehlen dafür den
8819 <ulink url="http://www.xmlmind.com/xmleditor/">XMLmind XML
8820 Editor</ulink>, der bei nicht kommerzieller Nutzung kostenlos
8824 <sect2 id="devel.build-doc.required-software">
8825 <title>Benötigte Software</title>
8827 <para>Bei <productname>DocBook</productname> ist Prinzip, dass
8828 ausschließlich die XML-Quelldatei bearbeitet wird. Aus dieser werden
8829 dann mit entsprechenden Stylesheets andere Formate wie PDF oder HTML
8830 erzeugt. Bei kivitendo übernimmt diese Aufgabe das Shell-Script
8831 <command>scripts/build_doc.sh</command>.</para>
8833 <para>Das Script benötigt zur Konvertierung verschiedene
8834 Softwarekomponenten, die im normalen kivitendo-Betrieb nicht benötigt
8840 url="http://www.oracle.com/technetwork/java/index.html">Java</ulink>
8841 in einer halbwegs aktuellen Version</para>
8845 <para>Das Java-Build-System <ulink
8846 url="http://ant.apache.org/">Apache Ant</ulink></para>
8850 <para>Das Dokumentations-System Dobudish für
8851 <productname>DocBook</productname> 4.5, eine Zusammenstellung
8852 diverser Stylesheets und Grafiken zur Konvertierung von
8853 <productname>DocBook</productname> XML in andere Formate. Das
8854 Paket, das benötigt wird, ist zum Zeitpunkt der
8855 Dokumentationserstellung
8856 <filename>dobudish-nojre-1.1.4.zip</filename>, aus auf <ulink
8857 url="http://code.google.com/p/dobudish/downloads/list">code.google.com</ulink>
8862 <para>Apache Ant sowie ein dazu passendes Java Runtime Environment
8863 sind auf allen gängigen Plattformen verfügbar. Beispiel für
8864 Debian/Ubuntu:</para>
8866 <programlisting>apt-get install ant openjdk-7-jre</programlisting>
8868 <para>Nach dem Download von Dobudish muss Dobudish im Unterverzeichnis
8869 <filename>doc/build</filename> entpackt werden. Beispiel unter der
8870 Annahme, das <productname>Dobudish</productname> in
8871 <filename>$HOME/Downloads</filename> heruntergeladen wurde:</para>
8873 <programlisting>cd doc/build
8874 unzip $HOME/Downloads/dobudish-nojre-1.1.4.zip</programlisting>
8877 <sect2 id="devel.build-doc.build">
8878 <title>PDFs und HTML-Seiten erstellen</title>
8880 <para>Die eigentliche Konvertierung erfolgt nach Installation der
8881 benötigten Software mit einem einfachen Aufruf direkt aus dem
8882 kivitendo-Installationsverzeichnis heraus:</para>
8884 <programlisting>./scripts/build_doc.sh</programlisting>
8887 <sect2 id="devel.build-doc.repository">
8888 <title>Einchecken in das Git-Repository</title>
8890 <para>Sowohl die XML-Datei als auch die erzeugten PDF- und
8891 HTML-Dateien sind Bestandteil des Git-Repositories. Daraus folgt, dass
8892 nach Änderungen am XML die PDF- und HTML-Dokumente ebenfalls gebaut
8893 und alles zusammen in einem Commit eingecheckt werden sollten.</para>
8895 <para>Die "<filename>dobudish</filename>"-Verzeichnisse bzw.
8896 symbolischen Links gehören hingegen nicht in das Repository.</para>