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><literal>Net::SMTP::SSL</literal> (optional, bei
252 E-Mail-Versand über SSL; siehe Abschnitt "<xref
253 linkend="config.sending-email.smtp"/>")</para>
257 <para><literal>Net::SSLGlue</literal> (optional, bei
258 E-Mail-Versand über TLS; siehe Abschnitt "<xref
259 linkend="config.sending-email.smtp"/>")</para>
263 <para><literal>Params::Validate</literal></para>
267 <para><literal>PBKDF2::Tiny</literal></para>
271 <para><literal>PDF::API2</literal></para>
275 <para><literal>Rose::Object</literal></para>
279 <para><literal>Rose::DB</literal></para>
283 <para><literal>Rose::DB::Object</literal> Version 0.788 oder
288 <para><literal>String::ShellQuote</literal></para>
292 <para><literal>Sort::Naturally</literal></para>
296 <para><literal>Template</literal></para>
300 <para><literal>Text::CSV_XS</literal></para>
304 <para><literal>Text::Iconv</literal></para>
308 <para><literal>Text::Unidecode</literal></para>
312 <para><literal>URI</literal></para>
316 <para><literal>XML::Writer</literal></para>
320 <para><literal>YAML</literal></para>
324 <para>Seit Version größer v3.5.0 sind die folgenden Pakete
325 hinzugekommen: <literal>Text::Unidecode</literal></para>
327 <para>Seit Version v3.4.0 sind die folgenden Pakete hinzugekommen:
328 <literal>Algorithm::CheckDigits</literal><literal>PBKDF2::Tiny</literal></para>
330 <para>Seit Version v3.2.0 sind die folgenden Pakete hinzugekommen:
331 <literal>GD</literal>, <literal>HTML::Restrict</literal>,
332 <literal>Image::Info</literal></para>
334 <para>Seit v3.0.0 sind die folgenden Pakete hinzugekommen:
335 <literal>File::Copy::Recursive</literal>.</para>
337 <para>Seit v2.7.0 sind die folgenden Pakete hinzugekommen:
338 <literal>Email::MIME</literal>, <literal>Net::SMTP::SSL</literal>,
339 <literal>Net::SSLGlue</literal>.</para>
341 <para>Gegenüber Version 2.6.0 sind zu dieser Liste 2 Pakete
342 hinzugekommen, <literal>URI</literal> und
343 <literal>XML::Writer</literal> sind notwendig. Ohne startet kivitendo
346 <para>Gegenüber Version 2.6.1 sind <literal>parent</literal>,
347 <literal>DateTime</literal>, <literal>Rose::Object</literal>,
348 <literal>Rose::DB</literal> und <literal>Rose::DB::Object</literal>
349 neu hinzugekommen. <literal>IO::Wrap</literal> wurde entfernt.</para>
351 <para>Gegenüber Version 2.6.3 ist <literal>JSON</literal> neu
352 hinzugekommen.</para>
354 <para><literal>Email::Address</literal> und
355 <literal>List::MoreUtils</literal> sind schon länger feste
356 Abhängigkeiten, wurden aber bisher mit kivitendo mitgeliefert. Beide
357 sind auch in 2.6.1 weiterhin mit ausgeliefert, wurden in einer
358 zukünftigen Version aber aus dem Paket entfernt werden. Es wird
359 empfohlen diese Module zusammen mit den anderen als Bibliotheken zu
363 <title>Debian und Ubuntu</title>
365 <para>Für Debian und Ubuntu stehen die meisten der benötigten
366 Perl-Pakete als Debian-Pakete zur Verfügung. Sie können mit
367 folgendem Befehl installiert werden:</para>
369 <programlisting>apt install apache2 libarchive-zip-perl libclone-perl \
370 libconfig-std-perl libdatetime-perl libdbd-pg-perl libdbi-perl \
371 libemail-address-perl libemail-mime-perl libfcgi-perl libjson-perl \
372 liblist-moreutils-perl libnet-smtp-ssl-perl libnet-sslglue-perl \
373 libparams-validate-perl libpdf-api2-perl librose-db-object-perl \
374 librose-db-perl librose-object-perl libsort-naturally-perl \
375 libstring-shellquote-perl libtemplate-perl libtext-csv-xs-perl \
376 libtext-iconv-perl liburi-perl libxml-writer-perl libyaml-perl \
377 libimage-info-perl libgd-gd2-perl libapache2-mod-fcgid \
378 libfile-copy-recursive-perl postgresql libalgorithm-checkdigits-perl \
379 libcrypt-pbkdf2-perl git libcgi-pm-perl libtext-unidecode-perl
382 <para>Für das Paket HTML::Restrict gibt es kein Debian-Paket, dies
383 muß per CPAN installiert werden. Unter Ubuntu funktioniert das
386 <programlisting>apt-get install build-essential
387 cpan HTML::Restrict</programlisting>
391 <title>Fedora</title>
393 <para>Für Fedora stehen die meisten der benötigten Perl-Pakete als
394 RPM-Pakete zur Verfügung. Sie können mit folgendem Befehl
395 installiert werden:</para>
397 <programlisting>dnf install httpd mod_fcgid perl-Archive-Zip perl-Clone perl-DBD-Pg \
398 perl-DBI perl-DateTime perl-Email-Address perl-Email-MIME perl-FCGI \
399 perl-File-Copy-Recursive perl-JSON perl-List-MoreUtils perl-Net-SMTP-SSL perl-Net-SSLGlue \
400 perl-PDF-API2 perl-Params-Validate perl-Rose-DB perl-Rose-DB-Object \
401 perl-Rose-Object perl-Sort-Naturally perl-String-ShellQuote \
402 perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv perl-URI \
403 perl-XML-Writer perl-YAML perl-parent postgresql-server perl-CPAN \
404 perl-Algorithm-CheckDigits perl-GD perl-Class-XSAccessor perl-Text-Balanced</programlisting>
406 <para>Zusätzlich müssen einige Pakete aus dem CPAN installiert
407 werden. Dazu können Sie die folgenden Befehle nutzen:</para>
409 <programlisting>cpan Config::Std HTML::Restrict</programlisting>
413 <title>openSUSE</title>
415 <para>Für openSUSE stehen die meisten der benötigten Perl-Pakete als
416 RPM-Pakete zur Verfügung. Sie können mit folgendem Befehl
417 installiert werden:</para>
419 <programlisting>zypper install apache2 apache2-mod_fcgid perl-Archive-Zip perl-Clone \
420 perl-Config-Std perl-DBD-Pg perl-DBI perl-DateTime perl-Email-Address \
421 perl-Email-MIME perl-FastCGI perl-File-Copy-Recursive perl-JSON perl-List-MoreUtils \
422 perl-Net-SMTP-SSL perl-Net-SSLGlue perl-PDF-API2 perl-Params-Validate \
423 perl-Sort-Naturally perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv \
424 perl-URI perl-XML-Writer perl-YAML perl-CPAN \
425 perl-Algorithm-CheckDigits perl-GD perl-Class-XSAccessor postgresql-server</programlisting>
427 <para>Zusätzlich müssen einige Pakete aus dem CPAN installiert
428 werden. Dazu können Sie die folgenden Befehle nutzen:</para>
430 <programlisting>cpan Rose::Db::Object</programlisting>
435 <title>Andere Pakete installieren</title>
437 <para>Seit Version v3.4.0 wird für den Bankimport optional das Paket
438 'aqbanking-tools' benötigt.</para>
440 <para>Debian und Ubuntu: <programlisting>apt install aqbanking-tools
441 </programlisting></para>
443 <para>OpenSuSE: <programlisting>zypper install aqbanking-tools</programlisting></para>
445 <para>Seit Version v3.4.1 wird generell zum Feststellen der
446 Seitenanzahl von PDF_Dokumenten 'pdfinfo' benötigt was im Paket
447 'poppler-utils' enthalten ist.</para>
449 <para>Debian und Ubuntu: <programlisting>apt install poppler-utils
450 </programlisting></para>
452 <para>OpenSuSE: <programlisting>zypper install poppler-tools</programlisting></para>
456 <sect1 id="Manuelle-Installation-des-Programmpaketes"
457 xreflabel="Manuelle Installation des Programmpaketes">
458 <title>Manuelle Installation des Programmpaketes</title>
460 <para>Der aktuelle Stable-Release, bzw. beta Release wird bei github
461 gehostet und kann <ulink
462 url="https://github.com/kivitendo/kivitendo-erp/releases">hier</ulink>
463 heruntergeladen werden.</para>
465 <para>Die kivitendo ERP Installationsdatei
466 (<filename>kivitendo-erp-3.4.1.tgz</filename>) wird im
467 Dokumentenverzeichnis des Webservers (z.B.
468 <filename>/var/www/html/</filename>,
469 <filename>/srv/www/htdocs</filename> oder
470 <filename>/var/www/</filename>) entpackt:</para>
472 <programlisting>cd /var/www
473 tar xvzf kivitendo-erp-3.4.1.tgz</programlisting>
475 <para>Wechseln Sie in das entpackte Verzeichnis:</para>
477 <programlisting>cd kivitendo-erp</programlisting>
479 <para>Alternativ können Sie auch einen Alias in der
480 Webserverkonfiguration benutzen, um auf das tatsächliche
481 Installationsverzeichnis zu verweisen.</para>
483 <para>Bei einer Neuinstallation von Version 3.1.0 oder später muß das
484 WebDAV Verzeichnis derzeit manuell angelegt werden:</para>
486 <programlisting>mkdir webdav</programlisting>
488 <para>Die Verzeichnisse <filename>users</filename>,
489 <filename>spool</filename> und <filename>webdav</filename> müssen für
490 den Benutzer beschreibbar sein, unter dem der Webserver läuft. Die
491 restlichen Dateien müssen für diesen Benutzer lesbar sein. Die Benutzer-
492 und Gruppennamen sind bei verschiedenen Distributionen unterschiedlich
493 (z.B. bei Debian/Ubuntu <constant>www-data</constant>, bei Fedora
494 <constant>apache</constant> oder bei OpenSUSE
495 <constant>wwwrun</constant>).</para>
497 <para>Der folgende Befehl ändert den Besitzer für die oben genannten
498 Verzeichnisse auf einem Debian/Ubuntu-System:</para>
500 <programlisting>chown -R www-data users spool webdav</programlisting>
502 <para>Weiterhin muss der Webserver-Benutzer in den Verzeichnissen
503 <filename>templates</filename> und <filename>users</filename>
504 Unterverzeichnisse für jeden neuen Benutzer anlegen dürfen, der in
505 kivitendo angelegt wird:</para>
507 <programlisting>chown www-data templates users</programlisting>
510 <para>Wir empfehlen eine Installation mittels des Versionsmanagager
511 git. Hierfür muss ein git-Client installiert sein. Damit ist man sehr
512 viel flexibler für zukünftige Upgrades. Installations-Anleitung (bitte
513 die Pfade anpassen) bspw. wie folgt: <programlisting>cd /var/www/
514 git clone https://github.com/kivitendo/kivitendo-erp.git
516 git checkout `git tag -l | egrep -ve "(beta|rc)" | tail -1`</programlisting>
517 Erläuterung: Der Befehl wechselt zur letzten Stable-Version (git tag
518 -l listet alle Tags auf, das egrep schmeisst alle Einträge mit beta
519 oder rc raus und das tail gibt davon den obersten Treffer zurück).
520 Sehr sinnvoll ist es, direkt im Anschluss einen eigenen Branch zu
521 erzeugen, um bspw. seine eigenen Druckvorlagen-Anpassungen damit zu
522 verwalten. Hierfür reicht ein simples <programlisting> git checkout -b meine_eigenen_änderungen</programlisting>
523 nach dem letzten Kommando (weiterführende Informationen <ulink
524 url="http://www-cs-students.stanford.edu/~blynn/gitmagic/index.html">
525 Git Magic</ulink>).</para>
527 <para>Ein beispielhafter Workflow für Druckvorlagen-Anpassungen von
528 3.4.1 nach 3.5: <programlisting>
529 $ git clone https://github.com/kivitendo/kivitendo-erp.git
531 $ git checkout release-3.4.1 # das ist der aktuelle release, den wir wollen
532 $ git add templates/fullhouse # das sind unsere druckvorlagen inkl. produktbilder
533 $ git commit -m "juhu tolle ändernungen"
534 [meine_aenderungen 1d89e41] juhu tolle ändernungen
535 4 files changed, 380 insertions(+)
536 create mode 100644 templates/fullhouse/img/webdav/tesla.png
537 create mode 100644 templates/fullhouse/mahnung.tex
538 create mode 100644 templates/fullhouse/zahlungserinnerung_zwei.tex
539 create mode 100644 templates/fullhouse/zahlungserinnerung_zwei_invoice.tex
544 $ git rebase --onto release-3.5.0 release-3.4.1 meine_aenderungen
545 Zunächst wird der Branch zurückgespult, um Ihre Änderungen
546 darauf neu anzuwenden ...
547 Wende an: juhu tolle ändernungen
548 $ service apache2 restart
549 </programlisting></para>
553 <sect1 id="config.config-file">
554 <title>kivitendo-Konfigurationsdatei</title>
556 <sect2 id="config.config-file.introduction"
557 xreflabel="Einführung in die Konfigurationsdatei">
558 <title>Einführung</title>
560 <para>In kivitendo gibt es nur noch eine Konfigurationsdatei, die
561 benötigt wird: <filename>config/kivitendo.conf</filename> (kurz: "die
562 Hauptkonfigurationsdatei"). Diese muss bei der Erstinstallation von
563 kivitendo bzw. der Migration von älteren Versionen angelegt
566 <para>Als Vorlage dient die Datei
567 <filename>config/kivitendo.conf.default</filename> (kurz: "die
568 Default-Datei"):</para>
570 <programlisting>$ cp config/kivitendo.conf.default config/kivitendo.conf</programlisting>
572 <para>Die Default-Datei wird immer zuerst eingelesen. Werte, die in
573 der Hauptkonfigurationsdatei stehen, überschreiben die Werte aus der
574 Default-Datei. Die Hauptkonfigurationsdatei muss also nur die
575 Abschnitte und Werte enthalten, die von denen der Default-Datei
579 <para>Vor der Umbenennung in kivitendo hieß diese Datei noch
580 <filename>config/lx_office.conf</filename>. Aus Gründen der
581 Kompatibilität wird diese Datei eingelesen, sofern die Datei
582 <filename>config/kivitendo.conf</filename> nicht existiert.</para>
585 <para>Diese Hauptkonfigurationsdatei ist dann eine
586 installationsspezifische Datei, d.h. sie enthält bspw. lokale
587 Passwörter und wird auch nicht im Versionsmanagement (git)
590 <para>Die Konfiguration ist ferner serverabhängig, d.h. für alle
591 Mandaten, bzw. Datenbanken gleich.</para>
594 <sect2 id="config.config-file.sections-parameters">
595 <title>Abschnitte und Parameter</title>
597 <para>Die Konfigurationsdatei besteht aus mehreren Teilen, die
598 entsprechend kommentiert sind:</para>
602 <para><literal>authentication</literal> (siehe Abschnitt "<xref
603 linkend="Benutzerauthentifizierung-und-Administratorpasswort"/>"
604 in diesem Kapitel)</para>
608 <para><literal>authentication/database</literal></para>
612 <para><literal>authentication/ldap</literal></para>
616 <para><literal>system</literal></para>
620 <para><literal>paths</literal></para>
624 <para><literal>mail_delivery</literal> (siehe Abschnitt "<xref
625 linkend="config.sending-email.smtp"/>)</para>
629 <para><literal>applications</literal></para>
633 <para><literal>environment</literal></para>
637 <para><literal>print_templates</literal></para>
641 <para><literal>task_server</literal></para>
645 <para><literal>periodic_invoices</literal></para>
649 <para><literal>self_tests</literal></para>
653 <para><literal>console</literal></para>
657 <para><literal>testing</literal></para>
661 <para><literal>testing/database</literal></para>
665 <para><literal>debug</literal></para>
669 <para>Die üblicherweise wichtigsten Parameter, die am Anfang
670 einzustellen oder zu kontrollieren sind, sind:</para>
672 <programlisting>[authentication]
673 admin_password = geheim
675 [authentication/database]
683 default_manager = german</programlisting>
685 <para>Für kivitendo Installationen in der Schweiz sollte hier
686 <varname>german</varname> durch <varname>swiss</varname> ersetzt
689 <para>Die Einstellung <varname>default_manager = swiss</varname>
694 <para>Beim Erstellen einer neuen Datenbank in der kivitendo
695 Administration werden automatisch die Standard-Werte für die
696 Schweiz voreingestellt: Währung CHF, 5er-Rundung, Schweizer
697 KMU-Kontenplan, Sollversteuerung, Aufwandsmethode, Bilanzierung
698 (die Werte können aber manuell angepasst werden).</para>
702 <para>Einstellen der Standardkonten für Rundungserträge und
703 -aufwendungen (unter Mandantenkonfiguration → Standardkonten
708 <para>das verwendete Zahlenformat wird auf
709 <varname>1'000.00</varname> eingestellt (unter Programm →
710 Benutzereinstellungen veränderbar)</para>
714 <para>DATEV-Automatik und UStVA werden nicht angezeigt,
715 Erfolgsrechnung ersetzt GUV ( unter Mandantenkonfiguration →
716 Features veränderbar)</para>
720 <para>Nutzt man wiederkehrende Rechnungen, kann man unter
721 <varname>[periodic_invoices]</varname> den Login eines Benutzers
722 angeben, der nach Erstellung der Rechnungen eine entsprechende E-Mail
723 mit Informationen über die erstellten Rechnungen bekommt.</para>
725 <para>kivitendo bringt eine eigene Komponente zur zeitgesteuerten
726 Ausführung bestimmter Aufgaben mit, den <link
727 linkend="config.task-server">Taskserver</link>. Er wird u.a. für
728 Features wie die <link
729 linkend="features.periodic-invoices">wiederkehrenden Rechnungen</link>
730 benötigt, erledigt aber auch andere erforderliche Aufgaben und muss
731 daher in Betrieb genommen werden. Seine Einrichtung wird im Abschnitt
732 <link linkend="config.task-server">Task-Server</link> genauer
735 <para>Für Entwickler finden sich unter <varname>[debug]</varname>
736 wichtige Funktionen, um die Fehlersuche zu erleichtern.</para>
739 <sect2 id="config.config-file.prior-versions">
740 <title>Versionen vor 2.6.3</title>
742 <para>In älteren kivitendo Versionen gab es im Verzeichnis
743 <filename>config</filename> die Dateien
744 <filename>authentication.pl</filename> und
745 <filename>lx-erp.conf</filename>, die jeweils Perl-Dateien waren. Es
746 gab auch die Möglichkeit, eine lokale Version der Konfigurationsdatei
747 zu erstellen (<filename>lx-erp-local.conf</filename>). Dies ist ab
748 2.6.3 nicht mehr möglich, aber auch nicht mehr nötig.</para>
750 <para>Beim Update von einer kivitendo-Version vor 2.6.3 auf 2.6.3 oder
751 jünger müssen die Einstellungen aus den alten Konfigurationsdateien
752 manuell übertragen und die alten Konfigurationsdateien anschließend
753 gelöscht oder verschoben werden. Ansonsten zeigt kivitendo eine
754 entsprechende Fehlermeldung an.</para>
758 <sect1 id="Anpassung-der-PostgreSQL-Konfiguration">
759 <title>Anpassung der PostgreSQL-Konfiguration</title>
761 <para>PostgreSQL muss auf verschiedene Weisen angepasst werden.</para>
763 <sect2 id="Zeichensätze-die-Verwendung-von-UTF-8">
764 <title>Zeichensätze/die Verwendung von Unicode/UTF-8</title>
766 <para>kivitendo setzt zwingend voraus, dass die Datenbank
767 Unicode/UTF-8 als Encoding einsetzt. Bei aktuellen
768 Serverinstallationen braucht man hier meist nicht einzugreifen.</para>
770 <para>Das Encoding des Datenbankservers kann überprüft werden. Ist das
771 Encoding der Datenbank "template1" "Unicode" bzw. "UTF-8", so braucht
772 man nichts weiteres diesbezüglich unternehmen. Zum Testen:</para>
774 <programlisting>su postgres
776 exit </programlisting>
778 <para>Andernfalls ist es notwendig, einen neuen Datenbankcluster mit
779 Unicode-Encoding anzulegen und diesen zu verwenden. Unter Debian und
780 Ubuntu kann dies z.B. für PostgreSQL 9.3 mit dem folgenden Befehl
783 <programlisting>pg_createcluster --locale=de_DE.UTF-8 --encoding=UTF-8 9.3 clustername</programlisting>
785 <para>Die Datenbankversionsnummer muss an die tatsächlich verwendete
786 Versionsnummer angepasst werden.</para>
788 <para>Unter anderen Distributionen gibt es ähnliche Methoden.</para>
790 <para>Das Encoding einer Datenbank kann in <command>psql</command> mit
791 <literal>\l</literal> geprüft werden.</para>
794 <sect2 id="Änderungen-an-Konfigurationsdateien">
795 <title>Änderungen an Konfigurationsdateien</title>
797 <para>In der Datei <filename>postgresql.conf</filename>, die je nach
798 Distribution in verschiedenen Verzeichnissen liegen kann (z.B.
799 <filename>/var/lib/pgsql/data/</filename> oder
800 <filename>/etc/postgresql/</filename>), muss sichergestellt werden,
801 dass TCP/IP-Verbindungen aktiviert sind. Das Verhalten wird über den
802 Parameter <varname>listen_address</varname> gesteuert. Laufen
803 PostgreSQL und kivitendo auf demselben Rechner, so kann dort der Wert
804 <literal>localhost</literal> verwendet werden. Andernfalls müssen
805 Datenbankverbindungen auch von anderen Rechnern aus zugelassen werden,
806 was mit dem Wert <literal>*</literal> geschieht.</para>
808 <para>In der Datei <filename>pg_hba.conf</filename>, die im gleichen
809 Verzeichnis wie die <filename>postgresql.conf</filename> zu finden
810 sein sollte, müssen die Berechtigungen für den Zugriff geändert
811 werden. Hier gibt es mehrere Möglichkeiten. Sinnvoll ist es nur die
812 nötigen Verbindungen immer zuzulassen, für eine lokal laufende
813 Datenbank zum Beispiel:</para>
815 <programlisting>local all kivitendo password
816 host all kivitendo 127.0.0.1 255.255.255.255 password</programlisting>
819 <sect2 id="Erweiterung-für-servergespeicherte-Prozeduren">
820 <title>Erweiterung für servergespeicherte Prozeduren</title>
822 <para>In der Datenbank <literal>template1</literal> muss die
823 Unterstützung für servergespeicherte Prozeduren eingerichet werden.
824 Melden Sie sich dafür als Benutzer “postgres” an der Datenbank an:
825 <programlisting>su - postgres
826 psql template1</programlisting> führen Sie die folgenden Kommandos aus:</para>
828 <programlisting>CREATE EXTENSION IF NOT EXISTS plpgsql;
832 <para><literal>CREATE EXTENSION</literal> ist seit Version 9.1 die
833 bevorzugte Syntax um die Sprache <literal>plpgsql</literal>
834 anzulegen. In diesen Versionen ist die Extension meist auch schon
835 vorhanden. Sollten Sie eine ältere Version von Postgres haben,
836 benutzen Sie stattdessen den folgenden Befehl.</para>
838 <programlisting>CREATE LANGUAGE 'plpgsql';
843 <sect2 id="Datenbankbenutzer-anlegen">
844 <title>Datenbankbenutzer anlegen</title>
846 <para>Wenn Sie nicht den Datenbanksuperuser “postgres” zum Zugriff
847 benutzen wollen, so sollten Sie bei PostgreSQL einen neuen Benutzer
848 anlegen. Ein Beispiel, wie Sie einen neuen Benutzer anlegen
851 <para>Die Frage, ob der neue User Superuser sein soll, können Sie mit
852 nein beantworten, genauso ist die Berechtigung neue User (Roles) zu
853 generieren nicht nötig.</para>
855 <programlisting>su - postgres
856 createuser -d -P kivitendo
857 exit</programlisting>
859 <para>Wenn Sie später einen Datenbankzugriff konfigurieren, verändern
860 Sie den evtl. voreingestellten Benutzer “postgres” auf “kivitendo”
861 bzw. den hier gewählten Benutzernamen.</para>
865 <sect1 id="Apache-Konfiguration">
866 <title>Webserver-Konfiguration</title>
869 <title>Grundkonfiguration mittels CGI</title>
872 <para>Für einen deutlichen Performanceschub sorgt die Ausführung
873 mittels FastCGI/FCGI. Die Einrichtung wird ausführlich im Abschnitt
874 <xref linkend="Apache-Konfiguration.FCGI"/> beschrieben.</para>
877 <para>Der Zugriff auf das Programmverzeichnis muss in der Apache
878 Webserverkonfigurationsdatei <literal>httpd.conf</literal> eingestellt
879 werden. Fügen Sie den folgenden Abschnitt dieser Datei oder einer
880 anderen Datei hinzu, die beim Starten des Webservers eingelesen
883 <programlisting>AliasMatch ^/kivitendo-erp/[^/]+\.pl /var/www/kivitendo-erp/dispatcher.pl
884 Alias /kivitendo-erp/ /var/www/kivitendo-erp/
886 <Directory /var/www/kivitendo-erp>
887 AddHandler cgi-script .pl
888 Options ExecCGI Includes FollowSymlinks
891 <Directory /var/www/kivitendo-erp/users>
893 </Directory></programlisting>
895 <para>Ersetzen Sie dabei die Pfade durch diejenigen, in die Sie vorher
896 das kivitendo-Archiv entpacket haben.</para>
899 <para>Vor den einzelnen Optionen muss bei einigen Distributionen ein
900 Plus ‘<literal>+</literal>’ gesetzt werden.</para>
902 <para>Bei einigen Distribution (Ubuntu ab 14.04, Debian ab 8.2) muss
903 noch explizit das cgi-Modul mittels <programlisting>a2enmod cgi</programlisting>
904 aktiviert werden.</para>
907 <para>Auf einigen Webservern werden manchmal die Grafiken und
908 Style-Sheets nicht ausgeliefert. In solchen Fällen hat es oft
909 geholfen, die folgende Option in die Konfiguration aufzunehmen:</para>
911 <programlisting>EnableSendfile Off</programlisting>
914 <sect2 id="Apache-Konfiguration.FCGI"
915 xreflabel="Konfiguration für FastCGI/FCGI">
916 <title>Konfiguration für FastCGI/FCGI</title>
918 <sect3 id="Apache-Konfiguration.FCGI.WasIstEs">
919 <title>Was ist FastCGI?</title>
921 <para>Direkt aus <ulink
922 url="http://de.wikipedia.org/wiki/FastCGI">Wikipedia</ulink>
925 <para><citation> FastCGI ist ein Standard für die Einbindung
926 externer Software zur Generierung dynamischer Webseiten in einem
927 Webserver. FastCGI ist vergleichbar zum Common Gateway Interface
928 (CGI), wurde jedoch entwickelt, um dessen Performance-Probleme zu
929 umgehen. </citation></para>
932 <sect3 id="Apache-Konfiguration.FCGI.Warum">
933 <title>Warum FastCGI?</title>
935 <para>Perl Programme (wie kivitendo eines ist) werden nicht statisch
936 kompiliert. Stattdessen werden die Quelldateien bei jedem Start
937 übersetzt, was bei kurzen Laufzeiten einen Großteil der Laufzeit
938 ausmacht. Während SQL Ledger einen Großteil der Funktionalität in
939 einzelne Module kapselt, um immer nur einen kleinen Teil laden zu
940 müssen, ist die Funktionalität von kivitendo soweit gewachsen, dass
941 immer mehr Module auf den Rest des Programms zugreifen. Zusätzlich
942 benutzen wir umfangreiche Bibliotheken um Funktionaltät nicht selber
943 entwickeln zu müssen, die zusätzliche Ladezeit kosten. All dies
944 führt dazu dass ein kivitendo Aufruf der Kernmasken mittlerweile
945 deutlich länger dauert als früher, und dass davon 90% für das Laden
946 der Module verwendet wird.</para>
948 <para>Mit FastCGI werden nun die Module einmal geladen, und danach
949 wird nur die eigentliche Programmlogik ausgeführt.</para>
952 <sect3 id="Apache-Konfiguration.FCGI.WebserverUndPlugin">
953 <title>Getestete Kombinationen aus Webservern und Plugin</title>
955 <para>Folgende Kombinationen sind getestet:</para>
959 <para>Apache 2.2.11 (Ubuntu) und mod_fcgid.</para>
963 <para>Apache 2.2.11 / 2.2.22 (Ubuntu) und mod_fastcgi.</para>
967 <para>Apache 2.4.7 (Ubuntu 14.04.2 LTS) und mod_fcgid.</para>
971 <para>Dabei wird mod_fcgid empfohlen, weil mod_fastcgi seit geraumer
972 Zeit nicht mehr weiter entwickelt wird. Im Folgenden wird auf
973 mod_fastcgi nicht mehr explizit eingegangen.</para>
975 <para>Als Perl Backend wird das Modul <filename>FCGI.pm</filename>
979 <para>FCGI-Versionen ab 0.69 und bis zu 0.71 inklusive sind extrem
980 strict in der Behandlung von Unicode, und verweigern bestimmte
981 Eingaben von kivitendo. Falls es Probleme mit Umlauten in Ihrer
982 Installation gibt, muss zwingend Version 0.68 oder aber Version
983 0.72 und neuer eingesetzt werden.</para>
985 <para>Mit <ulink url="http://www.cpan.org">CPAN</ulink> lässt sie
986 sich die Vorgängerversion wie folgt installieren:</para>
988 <programlisting>force install M/MS/MSTROUT/FCGI-0.68.tar.gz</programlisting>
992 <sect3 id="Apache-Konfiguration.FCGI.Konfiguration">
993 <title>Konfiguration des Webservers</title>
995 <para>Bevor Sie versuchen, eine kivitendo Installation unter FCGI
996 laufen zu lassen, empfiehlt es sich die Installation ersteinmal
997 unter CGI aufzusetzen. FCGI macht es nicht einfach Fehler zu
998 debuggen die beim ersten aufsetzen auftreten können. Sollte die
999 Installation schon funktionieren, lesen Sie weiter.</para>
1001 <para>Zuerst muss das FastCGI-Modul aktiviert werden. Dies kann
1002 unter Debian/Ubuntu z.B. mit folgendem Befehl geschehen:</para>
1004 <programlisting>a2enmod fcgid</programlisting>
1006 <para>Die Konfiguration für die Verwendung von kivitendo mit FastCGI
1007 erfolgt durch Anpassung der vorhandenen <function>Alias</function>-
1008 und <function>Directory</function>-Direktiven. Dabei wird zwischen
1009 dem Installationspfad von kivitendo im Dateisystem
1010 ("<filename>/path/to/kivitendo-erp</filename>") und der URL
1011 unterschieden, unter der kivitendo im Webbrowser erreichbar ist
1012 ("<filename>/url/for/kivitendo-erp</filename>").</para>
1014 <para>Folgender Konfigurationsschnipsel funktioniert mit
1017 <programlisting>AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fcgi
1018 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
1020 <Directory /path/to/kivitendo-erp>
1022 Options ExecCGI Includes FollowSymlinks
1026 <DirectoryMatch /path/to/kivitendo-erp/users>
1028 </DirectoryMatch></programlisting>
1031 <para>Wer einen älteren Apache als Version 2.4 im Einsatz hat,
1032 muss entsprechend die Syntax der Directorydirektiven verändert.
1035 <programlisting>Require all granted</programlisting>
1037 <para>muß man Folgendes einstellen:</para>
1041 Allow from All </programlisting>
1043 <para>und statt</para>
1045 <programlisting>Require all denied</programlisting>
1047 <para>muss stehen:</para>
1051 Deny from All </programlisting>
1054 <para>Seit mod_fcgid-Version 2.3.6 gelten sehr kleine Grenzen für
1055 die maximale Größe eines Requests. Diese sollte wie folgt
1056 hochgesetzt werden:</para>
1058 <programlisting>FcgidMaxRequestLen 10485760</programlisting>
1060 <para>Das Ganze sollte dann so aussehen:</para>
1062 <programlisting>AddHandler fcgid-script .fpl
1063 AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
1064 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
1065 FcgidMaxRequestLen 10485760
1067 <Directory /path/to/kivitendo-erp>
1069 Options ExecCGI Includes FollowSymlinks
1074 <DirectoryMatch /path/to/kivitendo-erp/users>
1077 </DirectoryMatch></programlisting>
1079 <para>Hierdurch wird nur ein zentraler Dispatcher gestartet. Alle
1080 Zugriffe auf die einzelnen Scripte werden auf diesen umgeleitet.
1081 Dadurch, dass zur Laufzeit öfter mal Scripte neu geladen werden,
1082 gibt es hier kleine Performance-Einbußen.</para>
1084 <para>Es ist möglich, die gleiche kivitendo Version parallel unter
1085 CGI und FastCGI zu betreiben. Dafür bleiben die Directorydirektiven
1086 wie oben beschrieben, die URLs werden aber umgeleitet:</para>
1088 <programlisting># Zugriff über CGI
1089 Alias /url/for/kivitendo-erp /path/to/kivitendo-erp
1091 # Zugriff mit mod_fcgid:
1092 AliasMatch ^/url/for/kivitendo-erp-fcgid/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
1093 Alias /url/for/kivitendo-erp-fcgid/ /path/to/kivitendo-erp/</programlisting>
1095 <para>Dann ist unter <filename>/url/for/kivitendo-erp/</filename>
1096 die normale Version erreichbar, und unter
1097 <constant>/url/for/kivitendo-erp-fcgid/</constant> die
1098 FastCGI-Version.</para>
1103 <title>Weitergehende Konfiguration</title>
1105 <para>Für einen deutlichen Sicherheitsmehrwert sorgt die Ausführung
1106 von kivitendo nur über https-verschlüsselten Verbindungen, sowie
1107 weiteren Zusatzmassnahmen, wie beispielsweise Basic Authenticate. Die
1108 Konfigurationsmöglichkeiten sprengen allerdings den Rahmen dieser
1109 Anleitung, hier ein Hinweis auf einen entsprechenden <ulink
1110 url="http://redmine.kivitendo-premium.de/boards/1/topics/142">Foreneintrag
1111 (Stand Sept. 2015)</ulink> und einen aktuellen (Stand Mai 2017) <ulink
1112 url="https://mozilla.github.io/server-side-tls/ssl-config-generator/">
1113 SSL-Konfigurations-Generator</ulink>.</para>
1117 <sect1 id="config.task-server">
1118 <title>Der Task-Server</title>
1120 <para>Der Task-Server ist ein Prozess, der im Hintergrund läuft, in
1121 regelmäßigen Abständen nach abzuarbeitenden Aufgaben sucht und diese zu
1122 festgelegten Zeitpunkten abarbeitet (ähnlich wie Cron). Dieser Prozess
1123 wird u.a. für die Erzeugung der wiederkehrenden Rechnungen und weitere
1124 essenzielle Aufgaben benutzt.</para>
1126 <para>Der Task-Server muss einmalig global in der Konfigurationsdatei
1127 konfiguriert werden. Danach wird er für jeden Mandanten, für den er
1128 laufen soll, in der Adminsitrationsmaske eingeschaltet.</para>
1130 <para>Beachten Sie, dass der Task-Server in den Boot-Vorgang Ihres
1131 Servers integriert werden muss, damit er automatisch gestartet wird.
1132 Dies kann kivitendo nicht für Sie erledigen.</para>
1134 <para>Da der Taskserver als Perlscript läuft, wird Arbeitsspeicher, der
1135 einmal benötigt wurde, nicht mehr an das Betriebssystem zurückgegeben,
1136 solange der Taskserver läuft. Dies kann dazu führen, dass ein länger
1137 laufender Taskserver mit der Zeit immer mehr Arbeitsspeicher für sich
1138 beansprucht. Es ist deshalb sinnvoll, dass der Taskserver in
1139 regelmässigen Abständen neu gestartet wird.</para>
1141 <sect2 id="Konfiguration-des-Task-Servers">
1142 <title>Verfügbare und notwendige Konfigurationsoptionen</title>
1144 <para>Die Konfiguration erfolgt über den Abschnitt
1145 <literal>[task_server]</literal> in der Datei
1146 <filename>config/kivitendo.conf</filename>. Die dort verfügbaren
1147 Optionen sind:</para>
1151 <term><varname>run_as</varname></term>
1154 <para>Wird der Server vom Systembenutzer <literal>root</literal>
1155 gestartet, so wechselt er auf den mit <literal>run_as</literal>
1156 angegebenen Systembenutzer. Der Systembenutzer muss dieselben
1157 Lese- und Schreibrechte haben, wie auch der Webserverbenutzer
1159 linkend="Manuelle-Installation-des-Programmpaketes"/>). Daher
1160 ist es erforderlich, hier denselben Systembenutzer einzutragen,
1161 unter dem auch der Webserver läuft.</para>
1166 <term><varname>debug</varname></term>
1169 <para>Schaltet Debug-Informationen an und aus.</para>
1175 <sect2 id="Konfiguration-der-Mandanten-fuer-den-Task-Servers">
1176 <title>Konfiguration der Mandanten für den Task-Server</title>
1178 <para>Ist der Task-Server grundlegend konfiguriert, so muss
1179 anschließend jeder Mandant, für den der Task-Server laufen soll,
1180 einmalig konfiguriert werden. Dazu kann in der Maske zum Bearbeiten
1181 von Mandanten im Administrationsbereich eine kivitendo-Benutzerkennung
1182 ausgewählt werden, unter der der Task-Server seine Arbeit
1185 <para>Ist in dieser Einstellung keine Benutzerkennung ausgewählt, so
1186 wird der Task-Server für diesen Mandanten keine Aufgaben
1190 <sect2 id="Einbinden-in-den-Boot-Prozess">
1191 <title>Automatisches Starten des Task-Servers beim Booten</title>
1193 <para>Der Task-Server verhält sich von seinen Optionen her wie ein
1194 reguläres SystemV-kompatibles Boot-Script. Außerdem wechselt er beim
1195 Starten automatisch in das kivitendo-Installationsverzeichnis.</para>
1197 <para>Deshalb ist es möglich, ihn durch Setzen eines symbolischen
1198 Links aus einem der Runlevel-Verzeichnisse heraus in den Boot-Prozess
1199 einzubinden. Da das bei neueren Linux-Distributionen aber nicht
1200 zwangsläufig funktioniert, werden auch Start-Scripte mitgeliefert, die
1201 anstelle eines symbolischen Links verwendet werden können.</para>
1204 <title>SystemV-basierende Systeme (z.B. ältere Debian, ältere
1205 OpenSUSE, ältere Fedora)</title>
1207 <para>Kopieren Sie die Datei
1208 <filename>scripts/boot/system-v/kivitendo-task-server</filename>
1209 nach <filename>/etc/init.d/kivitendo-task-server</filename>. Passen
1210 Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
1211 <literal>DAEMON=....</literal>). Binden Sie das Script in den
1212 Boot-Prozess ein. Dies ist distributionsabhängig:</para>
1216 <para>Debian-basierende Systeme:</para>
1218 <programlisting>update-rc.d kivitendo-task-server defaults
1219 insserv kivitendo-task-server</programlisting>
1223 <para>Ältere OpenSUSE und ältere Fedora:</para>
1225 <programlisting>chkconfig --add kivitendo-task-server</programlisting>
1229 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
1232 <programlisting>/etc/init.d/kivitendo-task-server start</programlisting>
1236 <title>Upstart-basierende Systeme (z.B. Ubuntu bis 14.04)</title>
1238 <para>Kopieren Sie die Datei
1239 <filename>scripts/boot/upstart/kivitendo-task-server.conf</filename>
1240 nach <filename>/etc/init/kivitendo-task-server.conf</filename>.
1241 Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
1242 <literal>exec ....</literal>).</para>
1244 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
1247 <programlisting>service kivitendo-task-server start</programlisting>
1251 <title>systemd-basierende Systeme (z.B. neure openSUSE, neuere
1252 Fedora, neuere Ubuntu und neuere Debians)</title>
1254 <para>Kopieren Sie die Datei
1255 <filename>scripts/boot/systemd/kivitendo-task-server.service</filename>
1256 nach <filename>/etc/systemd/system/</filename>. Passen Sie in der
1257 kopierten Datei den Pfad zum Task-Server an (Zeilen
1258 <literal>ExecStart=....</literal> und
1259 <literal>ExecStop=...</literal>).</para>
1261 <para>Machen Sie anschließend das Script systemd bekannt, und binden
1262 Sie es in den Boot-Prozess ein. Dazu führen Sie die folgenden Befehl
1265 <programlisting>systemctl daemon-reload
1266 systemctl enable kivitendo-task-server.service</programlisting>
1268 <para>Wenn Sie den Task-Server jetzt sofort starten möchten, anstatt
1269 den Server neu zu starten, so können Sie das mit dem folgenden
1272 <programlisting>systemctl start kivitendo-task-server.service</programlisting>
1276 <sect2 id="Prozesskontrolle">
1277 <title>Wie der Task-Server gestartet und beendet wird</title>
1279 <para>Der Task-Server wird wie folgt kontrolliert:</para>
1281 <programlisting>./scripts/task_server.pl Befehl</programlisting>
1283 <para><literal>Befehl</literal> ist dabei eine der folgenden
1288 <para><literal>start</literal> startet eine neue Instanz des
1289 Task-Servers. Die Prozess-ID wird innerhalb des
1290 <filename>users</filename>-Verzeichnisses abgelegt.</para>
1294 <para><literal>stop</literal> beendet einen laufenden
1299 <para><literal>restart</literal> beendet und startet ihn
1304 <para><literal>status</literal> berichtet, ob der Task-Server
1309 <para>Der Task-Server wechselt beim Starten automatisch in das
1310 kivitendo-Installationsverzeichnis.</para>
1312 <para>Dieselben Optionen können auch für die SystemV-basierenden
1313 Runlevel-Scripte benutzt werden (siehe oben).</para>
1317 <sect1 id="Benutzerauthentifizierung-und-Administratorpasswort">
1318 <title>Benutzerauthentifizierung und Administratorpasswort</title>
1320 <para>Informationen über die Einrichtung der Benutzerauthentifizierung,
1321 über die Verwaltung von Gruppen und weitere Einstellungen</para>
1323 <sect2 id="Grundlagen-zur-Benutzerauthentifizierung">
1324 <title>Grundlagen zur Benutzerauthentifizierung</title>
1326 <para>kivitendo verwaltet die Benutzerinformationen in einer
1327 Datenbank, die im folgenden “Authentifizierungsdatenbank” genannt
1328 wird. Für jeden Benutzer kann dort eine eigene Datenbank für die
1329 eigentlichen Finanzdaten hinterlegt sein. Diese beiden Datenbanken
1330 können, müssen aber nicht unterschiedlich sein.</para>
1332 <para>Im einfachsten Fall gibt es für kivitendo nur eine einzige
1333 Datenbank, in der sowohl die Benutzerinformationen als auch die Daten
1334 abgelegt werden.</para>
1336 <para>Zusätzlich ermöglicht es kivitendo, dass die Benutzerpasswörter
1337 entweder gegen die Authentifizierungsdatenbank oder gegen einen
1338 LDAP-Server überprüft werden.</para>
1340 <para>Welche Art der Passwortüberprüfung kivitendo benutzt und wie
1341 kivitendo die Authentifizierungsdatenbank erreichen kann, wird in der
1342 Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1343 festgelegt. Diese muss bei der Installation und bei einem Upgrade von
1344 einer Version vor v2.6.0 angelegt werden. Eine
1345 Beispielkonfigurationsdatei
1346 <filename>config/kivitendo.conf.default</filename> existiert, die als
1347 Vorlage benutzt werden kann.</para>
1350 <sect2 id="Administratorpasswort">
1351 <title>Administratorpasswort</title>
1353 <para>Das Passwort, das zum Zugriff auf das Administrationsinterface
1354 von kivitendo benutzt wird, wird ebenfalls in dieser Datei
1355 gespeichert. Es kann auch nur dort und nicht mehr im
1356 Administrationsinterface selber geändert werden. Der Parameter dazu
1357 heißt <varname>admin_password</varname> im Abschnitt
1358 <varname>[authentication]</varname>.</para>
1361 <sect2 id="Authentifizierungsdatenbank">
1362 <title>Authentifizierungsdatenbank</title>
1364 <para>Die Verbindung zur Authentifizierungsdatenbank wird mit den
1365 Parametern in <varname>[authentication/database]</varname>
1366 konfiguriert. Hier sind die folgenden Parameter anzugeben:</para>
1370 <term><literal>host</literal></term>
1373 <para>Der Rechnername oder die IP-Adresse des
1374 Datenbankservers</para>
1379 <term><literal>port</literal></term>
1382 <para>Die Portnummer des Datenbankservers, meist 5432</para>
1387 <term><literal>db</literal></term>
1390 <para>Der Name der Authentifizierungsdatenbank</para>
1395 <term><literal>user</literal></term>
1398 <para>Der Benutzername, mit dem sich kivitendo beim
1399 Datenbankserver anmeldet (z.B.
1400 "<literal>postgres</literal>")</para>
1405 <term><literal>password</literal></term>
1408 <para>Das Passwort für den Datenbankbenutzer</para>
1413 <para>Die Datenbank muss noch nicht existieren. kivitendo kann sie
1414 automatisch anlegen (mehr dazu siehe unten).</para>
1417 <sect2 id="Passwortüberprüfung">
1418 <title>Passwortüberprüfung</title>
1420 <para>kivitendo unterstützt Passwortüberprüfung auf zwei Arten: gegen
1421 die Authentifizierungsdatenbank und gegen einen externen LDAP- oder
1422 Active-Directory-Server. Welche davon benutzt wird, regelt der
1423 Parameter <varname>module</varname> im Abschnitt
1424 <varname>[authentication]</varname>.</para>
1426 <para>Sollen die Benutzerpasswörter in der Authentifizierungsdatenbank
1427 gespeichert werden, so muss der Parameter <varname>module</varname>
1428 den Wert <literal>DB</literal> enthalten. In diesem Fall können sowohl
1429 der Administrator als auch die Benutzer selber ihre Passwörter in
1430 kivitendo ändern.</para>
1432 <para>Soll hingegen ein externer LDAP- oder Active-Directory-Server
1433 benutzt werden, so muss der Parameter <varname>module</varname> auf
1434 <literal>LDAP</literal> gesetzt werden. In diesem Fall müssen
1435 zusätzliche Informationen über den LDAP-Server im Abschnitt
1436 <literal>[authentication/ldap]</literal> angegeben werden:</para>
1440 <term><literal>host</literal></term>
1443 <para>Der Rechnername oder die IP-Adresse des LDAP- oder
1444 Active-Directory-Servers. Diese Angabe ist zwingend
1445 erforderlich.</para>
1450 <term><literal>port</literal></term>
1453 <para>Die Portnummer des LDAP-Servers; meist 389.</para>
1458 <term><literal>tls</literal></term>
1461 <para>Wenn Verbindungsverschlüsselung gewünscht ist, so diesen
1462 Wert auf ‘<literal>1</literal>’ setzen, andernfalls auf
1463 ‘<literal>0</literal>’ belassen</para>
1468 <term><literal>attribute</literal></term>
1471 <para>Das LDAP-Attribut, in dem der Benutzername steht, den der
1472 Benutzer eingegeben hat. Für Active-Directory-Server ist dies
1473 meist ‘<literal>sAMAccountName</literal>’, für andere
1474 LDAP-Server hingegen ‘<literal>uid</literal>’. Diese Angabe ist
1475 zwingend erforderlich.</para>
1480 <term><literal>base_dn</literal></term>
1483 <para>Der Abschnitt des LDAP-Baumes, der durchsucht werden soll.
1484 Diese Angabe ist zwingend erforderlich.</para>
1489 <term><literal>filter</literal></term>
1492 <para>Ein optionaler LDAP-Filter. Enthält dieser Filter das Wort
1493 <literal><%login%></literal>, so wird dieses durch den vom
1494 Benutzer eingegebenen Benutzernamen ersetzt. Andernfalls wird
1495 der LDAP-Baum nach einem Element durchsucht, bei dem das oben
1496 angegebene Attribut mit dem Benutzernamen identisch ist.</para>
1501 <term><literal>bind_dn</literal> und
1502 <literal>bind_password</literal></term>
1505 <para>Wenn der LDAP-Server eine Anmeldung erfordert, bevor er
1506 durchsucht werden kann (z.B. ist dies bei
1507 Active-Directory-Servern der Fall), so kann diese hier angegeben
1508 werden. Für Active-Directory-Server kann als
1509 ‘<literal>bind_dn</literal>’ entweder eine komplette LDAP-DN wie
1510 z.B. ‘<literal>cn=Martin
1511 Mustermann,cn=Users,dc=firmendomain</literal>’ auch nur der
1512 volle Name des Benutzers eingegeben werden; in diesem Beispiel
1513 also ‘<literal>Martin Mustermann</literal>’.</para>
1519 <sect2 id="Name-des-Session-Cookies">
1520 <title>Name des Session-Cookies</title>
1522 <para>Sollen auf einem Server mehrere kivitendo-Installationen
1523 aufgesetzt werden, so müssen die Namen der Session-Cookies für alle
1524 Installationen unterschiedlich sein. Der Name des Cookies wird mit dem
1525 Parameter <varname>cookie_name</varname> im Abschnitt
1526 <varname>[authentication]</varname>gesetzt.</para>
1528 <para>Diese Angabe ist optional, wenn nur eine Installation auf dem
1529 Server existiert.</para>
1532 <sect2 id="Anlegen-der-Authentifizierungsdatenbank">
1533 <title>Anlegen der Authentifizierungsdatenbank</title>
1535 <para>Nachdem alle Einstellungen in
1536 <filename>config/kivitendo.conf</filename> vorgenommen wurden, muss
1537 kivitendo die Authentifizierungsdatenbank anlegen. Dieses geschieht
1538 automatisch, wenn Sie sich im Administrationsmodul anmelden, das unter
1539 der folgenden URL erreichbar sein sollte:</para>
1542 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
1546 <sect1 id="Benutzer--und-Gruppenverwaltung">
1547 <title>Mandanten-, Benutzer- und Gruppenverwaltung</title>
1549 <para>Nach der Installation müssen Mandanten, Benutzer, Gruppen und
1550 Datenbanken angelegt werden. Dieses geschieht im Administrationsmenü,
1551 das Sie unter folgender URL finden:</para>
1554 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
1556 <para>Verwenden Sie zur Anmeldung das Passwort, das Sie in der Datei
1557 <filename>config/kivitendo.conf</filename> eingetragen haben.</para>
1559 <sect2 id="Zusammenhänge">
1560 <title>Zusammenhänge</title>
1562 <para>kivitendo verwaltet zwei Sets von Daten, die je nach Einrichtung
1563 in einer oder zwei Datenbanken gespeichert werden.</para>
1565 <para>Das erste Set besteht aus Anmeldeinformationen: welche Benutzer
1566 und Mandanten gibt es, welche Gruppen, welche BenutzerIn hat Zugriff
1567 auf welche Mandanten, und welche Gruppe verfügt über welche Rechte.
1568 Diese Informationen werden in der Authentifizierungsdatenbank
1569 gespeichert. Dies ist diejenige Datenbank, deren Verbindungsparameter
1570 in der Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1571 gespeichert werden.</para>
1573 <para>Das zweite Set besteht aus den eigentlichen Verkehrsdaten eines
1574 Mandanten, wie beispielsweise die Stammdaten (Kunden, Lieferanten,
1575 Waren) und Belege (Angebote, Lieferscheine, Rechnungen). Diese werden
1576 in einer Mandantendatenbank gespeichert. Die Verbindungsinformationen
1577 einer solchen Mandantendatenbank werden im Administrationsbereich
1578 konfiguriert, indem man einen Mandanten anlegt und dort die Parameter
1579 einträgt. Dabei hat jeder Mandant eine eigene Datenbank.</para>
1581 <para>Aufgrund des Datenbankdesigns ist es für einfache Fälle möglich,
1582 die Authentifizierungsdatenbank und eine der Mandantendatenbanken in
1583 ein und derselben Datenbank zu speichern. Arbeitet man hingegen mit
1584 mehr als einem Mandanten, wird empfohlen, für die
1585 Authentifizierungsdatenbank eine eigene Datenbank zu verwenden, die
1586 nicht gleichzeitig für einen Mandanten verwendet wird.</para>
1589 <sect2 id="Mandanten-Benutzer-Gruppen">
1590 <title>Mandanten, Benutzer und Gruppen</title>
1592 <para>kivitendos Administration kennt Mandanten, Benutzer und Gruppen,
1593 die sich frei zueinander zuordnen lassen.</para>
1595 <para>kivitendo kann mehrere Mandaten aus einer Installation heraus
1596 verwalten. Welcher Mandant benutzt wird, kann direkt beim Login
1597 ausgewählt werden. Für jeden Mandanten wird ein eindeutiger Name
1598 vergeben, der beim Login angezeigt wird. Weiterhin benötigt der
1599 Mandant Datenbankverbindungsparameter für seine Mandantendatenbank.
1600 Diese sollte über die <link
1601 linkend="Datenbanken-anlegen">Datenbankverwaltung</link>
1604 <para>Ein Benutzer ist eine Person, die Zugriff auf kivitendo erhalten
1605 soll. Sie erhält einen Loginnamen sowie ein Passwort. Weiterhin legt
1606 der Administrator fest, an welchen Mandanten sich ein Benutzer
1607 anmelden kann, was beim Login verifiziert wird.</para>
1609 <para>Gruppen dienen dazu, Benutzern innerhalb eines Mandanten Zugriff
1610 auf bestimmte Funktionen zu geben. Einer Gruppe werden dafür vom
1611 Administrator gewisse Rechte zugeordnet. Weiterhin legt der
1612 Administrator fest, für welche Mandanten eine Gruppe gilt, und welche
1613 Benutzer Mitglieder in dieser Gruppe sind. Meldet sich ein Benutzer
1614 dann an einem Mandanten an, so erhält er alle Rechte von allen
1615 denjenigen Gruppen, die zum Einen dem Mandanten zugeordnet sind und in
1616 denen der Benutzer zum Anderen Mitglied ist,</para>
1618 <para>Die Reihenfolge, in der Datenbanken, Mandanten, Gruppen und
1619 Benutzer angelegt werden, kann im Prinzip beliebig gewählt werden. Die
1620 folgende Reihenfolge beinhaltet die wenigsten Arbeitsschritte:</para>
1622 <orderedlist numeration="arabic">
1624 <para>Datenbank anlegen</para>
1628 <para>Gruppen anlegen</para>
1632 <para>Benutzer anlegen und Gruppen als Mitglied zuordnen</para>
1636 <para>Mandanten anlegen und Gruppen sowie Benutzer zuweisen</para>
1641 <sect2 id="Datenbanken-anlegen">
1642 <title>Datenbanken anlegen</title>
1644 <para>Zuerst muss eine Datenbank angelegt werden. Verwenden Sie für
1645 den Datenbankzugriff den vorhin angelegten Benutzer (in unseren
1646 Beispielen ist dies ‘<literal>kivitendo</literal>’).</para>
1649 <sect2 id="Gruppen-anlegen">
1650 <title>Gruppen anlegen</title>
1652 <para>Eine Gruppe wird in der Gruppenverwaltung angelegt. Ihr muss ein
1653 Name gegeben werden, eine Beschreibung ist hingegen optional. Nach dem
1654 Anlegen können Sie die verschiedenen Bereiche wählen, auf die
1655 Mitglieder dieser Gruppe Zugriff haben sollen.</para>
1657 <para>Benutzergruppen werden zwar in der Authentifizierungsdatenbank
1658 gespeichert, gelten aber nicht automatisch für alle Mandanten. Der
1659 Administrator legt vielmehr fest, für welche Mandanten eine Gruppe
1660 gültig ist. Dies kann entweder beim Bearbeiten der Gruppe geschehen
1661 ("diese Gruppe ist gültig für Mandanten X, Y und Z"), oder aber wenn
1662 man einen Mandanten bearbeitet ("für diesen Mandanten sind die Gruppen
1663 A, B und C gültig").</para>
1665 <para>Wurden bereits Benutzer angelegt, so können hier die Mitglieder
1666 dieser Gruppe festgelegt werden ("in dieser Gruppe sind die Benutzer
1667 X, Y und Z Mitglieder"). Dies kann auch nachträglich beim Bearbeiten
1668 eines Benutzers geschehen ("dieser Benutzer ist Mitglied in den
1669 Gruppen A, B und C").</para>
1672 <sect2 id="Benutzer-anlegen">
1673 <title>Benutzer anlegen</title>
1675 <para>Beim Anlegen von Benutzern werden für viele Parameter
1676 Standardeinstellungen vorgenommen, die den Gepflogenheiten des
1677 deutschen Raumes entsprechen.</para>
1679 <para>Zwingend anzugeben ist der Loginname. Wenn die
1680 Passwortauthentifizierung über die Datenbank eingestellt ist, so kann
1681 hier auch das Benutzerpasswort gesetzt bzw. geändert werden. Ist
1682 hingegen die LDAP-Authentifizierung aktiv, so ist das Passwort-Feld
1685 <para>Hat man bereits Mandanten und Gruppen angelegt, so kann hier
1686 auch konfiguriert werden, auf welche Mandanten der Benutzer Zugriff
1687 hat bzw. in welchen Gruppen er Mitglied ist. Beide Zuweisungen können
1688 sowohl beim Benutzer vorgenommen werden ("dieser Benutzer hat Zugriff
1689 auf Mandanten X, Y, Z" bzw. "dieser Benutzer ist Mitglied in Gruppen
1690 X, Y und Z") als auch beim Mandanten ("auf diesen Mandanten haben
1691 Benutzer A, B und C Zugriff") bzw. bei der Gruppe ("in dieser Gruppe
1692 sind Benutzer A, B und C Mitglieder").</para>
1695 <sect2 id="Mandanten-anlegen">
1696 <title>Mandanten anlegen</title>
1698 <para>Ein Mandant besteht aus Administrationssicht primär aus einem
1699 eindeutigen Namen. Weiterhin wird hier hinterlegt, welche Datenbank
1700 als Mandantendatenbank benutzt wird. Hier müssen die Zugriffsdaten
1701 einer der eben angelegten Datenbanken eingetragen werden.</para>
1703 <para>Hat man bereits Benutzer und Gruppen angelegt, so kann hier auch
1704 konfiguriert werden, welche Benutzer Zugriff auf den Mandanten haben
1705 bzw. welche Gruppen für den Mandanten gültig sind. Beide Zuweisungen
1706 können sowohl beim Mandanten vorgenommen werden ("auf diesen Mandanten
1707 haben Benutzer X, Y und Z Zugriff" bzw. "für diesen Mandanten sind die
1708 Gruppen X, Y und Z gültig") als auch beim Benutzer ("dieser Benutzer
1709 hat Zugriff auf Mandanten A, B und C") bzw. bei der Gruppe ("diese
1710 Gruppe ist für Mandanten A, B und C gültig").</para>
1714 <sect1 id="Drucker--Systemverwaltung">
1715 <title>Drucker- und Systemverwaltung</title>
1717 <para>Im Administrationsmenü gibt es ferner noch die beiden Menüpunkte
1718 Druckeradministration und System.</para>
1720 <sect2 id="Druckeradministration">
1721 <title>Druckeradministration</title>
1723 <para>Unter dem Menüpunkt Druckeradministration lassen sich beliebig
1724 viele "Druckbefehle" im System verwalten. Diese Befehle werden
1725 mandantenweise zugeordnet. Unter Druckerbeschreibung wird der Namen
1726 des Druckbefehls festgelegt, der dann in der Druckerauswahl des Belegs
1727 angezeigt wird.</para>
1729 <para>Unter Druckbefehl definiert man den eigentlichen Druckbefehl,
1730 der direkt auf dem Webserver ausgeführt wird, bspw. 'lpr -P
1731 meinDrucker' oder ein kompletter Pfad zu einem Skript
1732 (/usr/local/src/kivitendo/scripts/pdf_druck_in_verzeichnis.sh). Wird
1733 ferner noch ein optionales Vorlagenkürzel verwendet, wird dieses
1734 Kürzel bei der Auswahl der Druckvorlagendatei mit einem Unterstrich
1735 ergänzt, ist bspw. das Kürzel 'epson_drucker' definiert, so wird beim
1736 Ausdruck eines Angebots folgende Vorlage geparst:
1737 sales_quotation_epson_drucker.tex.</para>
1741 <title>System sperren / entsperren</title>
1743 <para>Unter dem Menüpunkt System gibt es den Eintrag 'Installation
1744 sperren/entsperren'. Setzt man diese Sperre so ist der Zugang zu der
1745 gesamten kivitendo Installation gesperrt.</para>
1747 <para>Falls die Sperre gesetzt ist, erscheint anstelle der
1748 Anmeldemaske die Information: 'kivitendo ist momentan zwecks
1749 Wartungsarbeiten nicht zugänglich.'.</para>
1751 <para>Wichtig zu erwähnen ist hierbei noch, dass sich kivitendo
1752 automatisch 'sperrt', falls es bei einem Versionsupdate zu einem
1753 Datenbankfehler kam. Somit kann hier nicht aus Versehen mit einem
1754 inkonsistenten Datenbestand weitergearbeitet werden.</para>
1758 <sect1 id="config.sending-email"
1759 xreflabel="E-Mail-Versand aus kivitendo heraus">
1760 <title>E-Mail-Versand aus kivitendo heraus</title>
1762 <para>kivitendo kann direkt aus dem Programm heraus E-Mails versenden,
1763 z.B. um ein Angebot direkt an einen Kunden zu verschicken. Damit dies
1764 funktioniert, muss eingestellt werden, über welchen Server die E-Mails
1765 verschickt werden sollen. kivitendo unterstützt dabei zwei Mechanismen:
1766 Versand über einen lokalen E-Mail-Server (z.B. mit
1767 <productname>Postfix</productname> oder <productname>Exim</productname>,
1768 was auch die standardmäßig aktive Methode ist) sowie Versand über einen
1769 SMTP-Server (z.B. der des eigenen Internet-Providers).</para>
1771 <para>Welche Methode und welcher Server verwendet werden, wird über die
1772 Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1773 festgelegt. Dort befinden sich alle Einstellungen zu diesem Thema im
1774 Abschnitt '<literal>[mail_delivery]</literal>'.</para>
1776 <sect2 id="config.sending-email.sendmail"
1777 xreflabel="E-Mail-Versand über lokalen E-Mail-Server">
1778 <title>Versand über lokalen E-Mail-Server</title>
1780 <para>Diese Methode bietet sich an, wenn auf dem Server, auf dem
1781 kivitendo läuft, bereits ein funktionsfähiger E-Mail-Server wie z.B.
1782 <productname>Postfix</productname>, <productname>Exim</productname>
1783 oder <productname>Sendmail</productname> läuft.</para>
1785 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter
1786 '<literal>method = sendmail</literal>' gesetzt sein. Dies ist
1787 gleichzeitig der Standardwert, falls er nicht verändert wird.</para>
1789 <para>Um zu kontrollieren, wie das Programm zum Einliefern gestartet
1790 wird, dient der Parameter '<literal>sendmail = ...</literal>'. Der
1791 Standardwert verweist auf das Programm
1792 <filename>/usr/bin/sendmail</filename>, das bei allen oben genannten
1793 E-Mail-Serverprodukten für diesen Zweck funktionieren sollte.</para>
1795 <para>Die Konfiguration des E-Mail-Servers selber würde den Rahmen
1796 dieses sprengen. Hierfür sei auf die Dokumentation des E-Mail-Servers
1800 <sect2 id="config.sending-email.smtp"
1801 xreflabel="E-Mail-Versand über einen SMTP-Server">
1802 <title>Versand über einen SMTP-Server</title>
1804 <para>Diese Methode bietet sich an, wenn kein lokaler E-Mail-Server
1805 vorhanden oder zwar einer vorhanden, dieser aber nicht konfiguriert
1808 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter
1809 '<literal>method = smtp</literal>' gesetzt sein. Die folgenden
1810 Parameter dienen dabei der weiteren Konfiguration:</para>
1814 <term><varname>hostname</varname></term>
1817 <para>Name oder IP-Adresse des SMTP-Servers. Standardwert:
1818 '<literal>localhost</literal>'</para>
1823 <term><varname>port</varname></term>
1826 <para>Portnummer. Der Standardwert hängt von der verwendeten
1827 Verschlüsselungsmethode ab. Gilt '<literal>security =
1828 none</literal>' oder '<literal>security = tls</literal>', so ist
1829 25 die Standardportnummer. Für '<literal>security =
1830 ssl</literal>' ist 465 die Portnummer. Muss normalerweise nicht
1831 geändert werden.</para>
1836 <term><varname>security</varname></term>
1839 <para>Wahl der zu verwendenden Verschlüsselung der Verbindung
1840 mit dem Server. Standardwert ist '<literal>none</literal>',
1841 wodurch keine Verschlüsselung verwendet wird. Mit
1842 '<literal>tls</literal>' wird TLS-Verschlüsselung eingeschaltet,
1843 und mit '<literal>ssl</literal>' wird Verschlüsselung via SSL
1844 eingeschaltet. Achtung: Für '<literal>tls</literal>' und
1845 '<literal>ssl</literal>' werden zusätzliche Perl-Module benötigt
1846 (siehe unten).</para>
1851 <term><varname>login</varname> und
1852 <varname>password</varname></term>
1855 <para>Falls der E-Mail-Server eine Authentifizierung verlangt,
1856 so können mit diesen zwei Parametern der Benutzername und das
1857 Passwort angegeben werden. Wird Authentifizierung verwendet, so
1858 sollte aus Sicherheitsgründen auch eine Form von Verschlüsselung
1859 aktiviert werden.</para>
1866 <sect1 id="Drucken-mit-kivitendo">
1867 <title>Drucken mit kivitendo</title>
1869 <para>Das Drucksystem von kivitendo benutzt von Haus aus LaTeX-Vorlagen.
1870 Um drucken zu können, braucht der Server ein geeignetes LaTeX System. Am
1871 einfachsten ist dazu eine <literal>texlive</literal> Installation. Unter
1872 debianoiden Betriebssystemen installiert man die Pakete mit:</para>
1874 <para><programlisting>apt-get install texlive-base-bin texlive-latex-recommended texlive-fonts-recommended \
1875 texlive-latex-extra texlive-lang-german texlive-generic-extra</programlisting></para>
1877 <para>Für Fedora benötigen Sie die folgenden Pakete:</para>
1879 <para><programlisting>dnf install texlive-collection-latex texlive-collection-latexextra \
1880 texlive-collection-latexrecommended texlive-collection-langgerman \
1881 texlive-collection-langenglish</programlisting></para>
1883 <para>Für openSUSE benötigen Sie die folgenden Pakete:</para>
1885 <para><programlisting>zypper install texlive-collection-latex texlive-collection-latexextra \
1886 texlive-collection-latexrecommended texlive-collection-langgerman \
1887 texlive-collection-langenglish</programlisting></para>
1889 <para>kivitendo bringt drei alternative Vorlagensätze mit:</para>
1901 <para>rev-odt</para>
1905 <para>Der ehemalige Druckvorlagensatz "Standard" wurde mit der Version
1906 3.3 entfernt, da er nicht mehr gepflegt wurde.</para>
1908 <sect2 id="Vorlagenverzeichnis-anlegen"
1909 xreflabel="Vorlagenverzeichnis anlegen">
1910 <title>Vorlagenverzeichnis anlegen</title>
1912 <para>Es lässt sich ein initialer Vorlagensatz erstellen. Die
1913 LaTeX-System-Abhängigkeiten hierfür kann man prüfen mit:</para>
1915 <programlisting>./scripts/installation_check.pl -lv</programlisting>
1917 <para>Der Angemeldete Benutzer muss in einer Gruppe sein, die über das
1918 Recht "Konfiguration -> Mandantenverwaltung" verfügt. Siehe auch
1919 <xref linkend="Gruppen-anlegen"/>.</para>
1921 <para>Im Userbereich lässt sich unter: "<guimenu>System</guimenu>
1922 -> <guisubmenu>Mandantenverwaltung</guisubmenu> ->
1923 <guimenuitem>Verschiedenes</guimenuitem>" die Option "Neue
1924 Druckvorlagen aus Vorlagensatz erstellen" auswählen.</para>
1928 <para><option>Vorlagen auswählen</option>: Wählen Sie hier den
1929 Vorlagensatz aus, der kopiert werden soll
1930 (<filename>RB</filename>, <filename>f-tex</filename> oder
1931 <filename>odt-rev</filename>.)</para>
1935 <para><option>Neuer Name</option>: Der Verzeichnisname für den
1936 neuen Vorlagensatz. Dieser kann im Rahmen der üblichen Bedingungen
1937 für Verzeichnisnamen frei gewählt werden.</para>
1941 <para>Nach dem Speichern wird das Vorlagenverzeichnis angelegt und ist
1942 für den aktuellen Mandanten ausgewählt. Der gleiche Vorlagensatz kann,
1943 wenn er mal angelegt ist, bei mehreren Mandanten verwendet werden.
1944 Eventuell müssen Anpassungen (Logo, Erscheinungsbild, etc) noch
1945 vorgenommen werden. Den Ordner findet man im Dateisystem unter
1946 <filename>./templates/[Neuer Name]</filename></para>
1949 <sect2 id="Vorlagen-RB">
1950 <title>Der Druckvorlagensatz RB</title>
1952 <para>Hierbei handelt es sich um einen vollständigen LaTeX
1953 Dokumentensatz mit alternativem Design. Die odt oder html-Varianten
1954 sind nicht gepflegt.</para>
1956 <para>Die konzeptionelle Idee der Vorlagen wird <ulink
1957 url="http://www.kivitendo-support.de/vortraege/Lx-Office%20Anwendertreffen%20LaTeX-Druckvorlagen-Teil3-finale.pdf">hier</ulink>
1958 auf Folie 5 bis 10 vorgestellt. Informationen zur Anpassung an die
1959 eigenen Firmendaten finden sich in der Datei Readme.tex im
1960 Vorlagenverzeichnis.</para>
1962 <para>Eine kurze Übersicht der Features:</para>
1966 <para>Mehrsprachenfähig, mit Deutscher und Englischer
1971 <para>Zentrale Konfigurationsdateien, die für alle Belege benutzt
1972 werden, z.B. für Kopf- und Fußzeilen, und Infos wie
1977 <para>mehrere vordefinierte Varianten für
1978 Logos/Hintergrundbilder</para>
1982 <para>Berücksichtigung für Steuerzonen "EU mit USt-ID Nummer" oder
1983 "Außerhalb EU"</para>
1989 <title>f-tex</title>
1991 <para>Ein Vorlagensatz, der in wenigen Minuten alle Dokumente zur
1992 Verfügung stellt.</para>
1994 <sect3 id="f-tex-Feature-Übersicht">
1995 <title>Feature-Übersicht</title>
1999 <para>Keine Redundanz. Es wird ein- und dieselbe LaTeX-Vorlage
2000 für alle briefartigen Dokumente verwendet. Also Angebot,
2001 Rechnung, Proformarechnung, Lieferschein, aber eben nicht für
2002 Paketaufkleber etc.</para>
2006 <para>Leichte Anpassung an das Firmen-Layout durch Verwendung
2007 eines Hintergrund-PDFs. Dieses kann leicht mit dem eigenen
2008 Lieblingsprogramm erstellt werden (Openoffice, Inkscape, Gimp,
2013 <para>Hintergrund-PDF umschaltbar auf "nur erste Seite"
2014 (Standard) oder "alle Seiten" (Option
2015 "<option>bgPdfFirstPageOnly</option>" in Datei
2016 <filename>letter.lco</filename>)</para>
2020 <para>Hintergrund-PDF für Ausdruck auf bereits bedrucktem
2021 Briefpapier abschaltbar. Es wird dann nur bei per E-Mail
2022 versendeten Dokumenten eingebunden (Option
2023 "<option>bgPdfEmailOnly</option>" in Datei
2024 <filename>letter.lco</filename>).</para>
2028 <para>Nutzung der Layout-Funktionen von LaTeX für Seitenumbruch,
2029 Wiederholung von Kopfzeilen, Zwischensummen etc. (danke an
2030 Kai-Martin Knaak für die Vorarbeit)</para>
2034 <para>Anzeige des Empfängerlandes im Adressfeld nur, wenn es vom
2035 Land des eigenen Unternehmens abweicht (also die Rechnung das
2036 Land verlässt).</para>
2040 <para>Multisprachfähig leicht um weitere Sprachen zu erweitern,
2041 alle Übersetzungen in der Datei
2042 <filename>translatinos.tex</filename>.</para>
2046 <para>Auflistung von Bruttopreisen für Endverbraucher.</para>
2051 <sect3 id="f-tex-Installation">
2052 <title>Die Installation</title>
2056 <para>Vorlagenverzeichnis mit Option f-tex anlegen, siehe: <xref
2057 linkend="Vorlagenverzeichnis-anlegen"/>. Das Vorlagensystem
2058 funktioniert jetzt schon, hat allerdings noch einen
2059 Beispiel-Briefkopf.</para>
2063 <para>Erstelle eine pdf-Hintergrund Datei und verlinke sie nach
2064 <filename>./letter_head.pdf</filename>.</para>
2068 <para>Editiere den Bereich "<option>settings</option>" in der
2069 datei <filename>letter.lco</filename>.</para>
2073 <para>oder etwas detaillierter:</para>
2075 <para>Es wird eine Datei <filename>sample.lco</filename> erstellt
2076 und diese nach <filename>letter.lco</filename> verlinkt. Eigentlich
2077 ist dies die Datei die für die firmenspezifischen Anpassungen
2078 gedacht ist. Da die Einstiegshürde in LaTeX nicht ganz niedrig ist,
2079 wird in dieser Datei auf ein Hintergrund-PDF verwiesen. Ich empfehle
2080 über dieses PDF die persönlichen Layoutanpassungen vorzunehmen und
2081 <filename>sample.lco</filename> unverändert zu lassen. Die Anpassung
2082 über eine <filename>*.lco</filename>-Datei, die letztlich auf
2083 <filename>letter.lco</filename> verlinkt ist ist aber auch
2086 <para>Es wird eine Datei <filename>sample_head.pdf</filename> mit
2087 ausgeliefert, diese wird nach <filename>letter_head.pdf</filename>
2088 verlinkt. Damit gibt es schon mal eine funktionsfähige Vorlage.
2089 Schau Dir nach Abschluss der Installation die Datei
2090 <filename>sample_head.pdf</filename> an und erstelle ein
2091 entsprechendes PDF passend zum Briefkopf Deiner Firma, diese dann im
2092 Template Verzeichniss ablegen und statt
2093 <filename>sample_head.pdf</filename> nach
2094 <filename>letter_head.pdf</filename> verlinken.</para>
2096 <para>Letzlich muss <filename>letter_head.pdf</filename> auf das
2097 passende Hintergrund-PDF verweisen, welches gewünschten Briefkopf
2100 <para>Es wird eine Datei <filename>mydata.tex.example</filename>
2101 ausgeliefert, die nach <filename>mytdata.tex</filename> verlinkt
2102 ist. Bei verwendetem Hintergrund-PDF wird nur der Eintrag für das
2103 Land verwendet. Die Datei muss also nicht angefasst werden. Die
2104 anderen Werte sind für das Modul 'lp' (Label Print in erp - zur Zeit
2105 nicht im öffentlichen Zweig).</para>
2107 <para>Alle Anpassungen zum Briefkopf, Fusszeilen, Firmenlogos, etc.
2108 sollten über die Hintergrund-PDF-Datei oder die
2109 <filename>*.lco</filename>-Datei erfolgen.</para>
2112 <sect3 id="f-tex-Funktionsübersicht">
2113 <title>f-tex Funktionsübersicht</title>
2115 <para>Das Konzept von kivitendo sieht vor, für jedes Dokument
2116 (Auftragsbestätigung, Lieferschein, Rechnung, etc.) eine
2117 LaTeX-Vorlage vorzuhalten, dies ist sehr wartungsunfreundlich. Auch
2118 das Einlesen einer einheitlichen Quelle für den Briefkopf bringt nur
2119 bedingte Vorteile, da hier leicht die Pflege der Artikel-Tabellen
2120 aus dem Ruder läuft. Bei dem vorliegenden Ansatz wird für alle
2121 briefartigen Dokumente mit Artikel-Tabellen eine einheitliche
2122 LaTeX-Vorlage verwendet, welche über Codeweichen die Besonderheiten
2123 der jeweiligen Dokumente berücksichtigt:</para>
2127 <para>Tabellen mit oder ohne Preis</para>
2131 <para>Sprache der Tabellenüberschriften etc.</para>
2135 <para>Anpassung der Bezugs-Zeile (z.B. Rechnungsnummer versus
2136 Angebotsnummer)</para>
2140 <para>Darstellung von Brutto oder Netto-Preisen in der
2141 Auflistung (Endverbraucher versus gewerblicher Kunde)</para>
2145 <para>Nachteil:</para>
2147 <para>LaTeX hat ohnehin eine sehr steile Lehrnkurve. Die Datei
2148 <filename>letter.tex</filename> ist sehr komplex und verstärkt damit
2149 diesen Effekt noch einmal erheblich. Wer LaTeX-Erfahrung hat, oder
2150 geübt ist Scriptsparachen nachzuvollziehen kann natürlich auch
2151 innerhalb der Tabellendarstellung gut persönliche Anpassungen
2152 vornehmen. Aber man kann sich hier bei Veränderungen sehr schnell
2153 heftig in den Fuss schiessen.</para>
2155 <para>Wer nicht so tief in die Materie einsteigen will oder leicht
2156 zu frustrieren ist, sollte sein Hintergrund-PDF auf Basis der
2157 mitglieferten Datei <filename>sample_head.pdf</filename> erstellen,
2158 und sich an der Form der dargestellten Tabellen, wie sie
2159 ausgeliefert werden, erfreuen.</para>
2161 <para>Kleiner Tipp: Nicht zu viel auf einmal wollen, lieber kleine,
2162 kontinuierliche Schritte gehen.</para>
2165 <sect3 id="f-tex-Bruttopreise">
2166 <title>Bruttopreise für Endverbraucher</title>
2168 <para>Der auszuweisende Bruttopreis wird innerhalb der
2169 LaTeX-Umgebung berechnet. Es gibt zwar ein Feld, um bei Aufträgen
2170 "alle Preise Brutto" auszuwählen, aber:</para>
2174 <para>hierfür müssen die Preise auch in Brutto in der Datenbank
2175 stehen (ja - das lässt sich über die Preisgruppen und die
2176 Zuordung einer Default-Preisgruppe handhaben)</para>
2180 <para>man darf beim Anlegen des Vorgangs nicht vergessen, dieses
2181 Häkchen zu setzen. (Das ist in der Praxis, wenn man sowohl
2182 Endverbraucher als auch Gewerbekunden beliefert, der eigentliche
2187 <para>Es gibt mit f-tex eine weitere Alternative. Die Information ob
2188 Brutto oder Nettorechnung wird mit den Zahlarten verknüpft.
2189 Zahlarten bei denen Rechnungen, Angebote, etc, in Brutto ausgegeben
2190 werden sollen, enden mit "_E" (für Endverbraucher). Falls identische
2191 Zahlarten für Gewerbekunden und Endverbraucher vorhanden sind, legt
2192 man diese einfach doppelt an (einmal mit der Namensendung "_E").
2197 <para>Die Entscheidung, ob Nettopreise ausgewiesen werden, ist
2198 nicht mehr fix mit einer Preisliste verbunden.</para>
2202 <para>Die Default-Zahlart kann im Kundendatensatz hinterlegt
2203 werden, und man muss nicht mehr daran denken, "alle Preise
2204 Netto" auszuwählen.</para>
2208 <para>Die Entscheidung, ob Netto- oder Bruttopreise ausgewiesen
2209 werden, kann direkt beim Drucken revidiert werden, ohne dass
2210 sich der Auftragswert ändert.</para>
2215 <sect3 id="f-tex-lieferadressen">
2216 <title>Lieferadressen</title>
2218 <para>In Lieferscheinen kommen <varname>shipto*</varname>-Variablen
2219 im Adressfeld zum Einsatz. Wenn die
2220 <varname>shipto*</varname>-Variable leer ist, wird die entsprechende
2221 Adressvariable eingesetzt. Wenn also die Lieferadresse in Straße,
2222 Hausnummer und Ort abweicht, müssen auch nur diese Felder in der
2223 Lieferadresse ausgefüllt werden. Für den Firmenname wird der Wert
2224 der Hauptadresse angezeigt.</para>
2228 <sect2 id="Vorlagen-rev-odt">
2229 <title>Der Druckvorlagensatz rev-odt</title>
2231 <para>Hierbei handelt es sich um einen Dokumentensatz der mit
2232 odt-Vorlagen erstellt wurde. Es gibt in dem Verzeichnis eine
2233 Readme-Datei, die eventuell aktueller als die Dokumentation hier ist.
2234 Die odt-Vorlagen in diesem Verzeichnis "rev-odt" wurden von revamp-it,
2235 Zürich erstellt und werden laufend aktualisiert. Ein paar der
2236 Formulierungen in den Druckvorlagen entsprechen dem Schweizer
2237 Sprachgebrauch, z.B. "Offerte" oder "allfällig".</para>
2239 <para>Hinweis zum Einsatz des Feldes "Land" bei den Stammdaten für
2240 KundInnen und LieferantInnen, sowie bei Lieferadressen: Die in diesem
2241 Vorlagensatz vorhandenen Vorlagen erwarten für "Land" das
2242 entsprechende Kürzel, das in Adressen vor die Postleitzahl gesetzt
2243 wird. Das Feld kann auch komplett leer bleiben. Wer dies anders
2244 handhaben möchte, muss die Vorlagen entsprechend anpassen.</para>
2246 <para>odt-Vorlagen können mit LibreOffice oder OpenOffice editiert und
2247 den eigenen Bedürfnissen angepasst werden. Wichtig beim Editieren von
2248 if-Blöcken ist, dass immer der gesamte Block überschrieben werden muss
2249 und nicht nur Teile davon, da dies sonst oft zu einer odt-Datei führt,
2250 die vom Parser nicht korrekt gelesen werden kann.</para>
2252 <para>Mahnungen können unter folgenden Einschränkungen mit den
2253 odt-Vorlagen im Vorlagensatz rev-odt erzeugt werden:</para>
2257 <para>als Druckoption steht nur 'PDF(OpenDocument/OASIS)' zur
2258 Verfügung, das heisst, die Mahnungen werden als PDF-Datei
2263 <para>für jede Rechnung muss eine eigene Mahnung erzeugt werden
2264 (auch wenn bei einzelnen KundInnen mehrere überfällige Rechnungen
2265 vorhanden sind).</para>
2269 <para>Mehrere Mahnungen für eine Kundin / einen Kunden werden zu einer
2270 PDF-Datei zusammengefasst</para>
2272 <para>Die Vorlagen zahlungserinnerung.odt sowie mahnung.odt sind für
2273 das Erstellen einer Zahlungserinnerung bzw. Mahnung selbst vorgesehen,
2274 die Vorlage mahnung_invoice.odt für das Erstellen einer Rechnung über
2275 die verrechneten Mahngebühren und Verzugszinsen.</para>
2277 <para>Zur Zeit gibt es in kivitendo noch keine Möglichkeit,
2278 odt-Vorlagen bei Briefen und Pflichtenheften einzusetzen.
2279 Entsprechende Vorlagen sind deshalb nicht vorhanden.</para>
2281 <para>Fehlermeldungen, Anregungen und Wünsche bitte senden an:
2282 empfang@revamp-it.ch</para>
2285 <sect2 id="allgemeine-hinweise-zu-latex">
2286 <title>Allgemeine Hinweise zu LaTeX Vorlagen</title>
2288 <para>In den allermeisten Installationen sollte das Drucken jetzt
2289 schon funktionieren. Sollte ein Fehler auftreten, wirft TeX sehr lange
2290 Fehlerbeschreibungen, der eigentliche Fehler ist immer die erste
2291 Zeile, die mit einem Ausrufezeichen anfängt. Häufig auftretende Fehler
2292 sind zum Beispiel:</para>
2296 <para>! LaTeX Error: File `eurosym.sty' not found. Die
2297 entsprechende LaTeX-Bibliothek wurde nicht gefunden. Das tritt vor
2298 allem bei Vorlagen aus der Community auf. Installieren Sie die
2299 entsprechenden Pakete.</para>
2303 <para>! Package inputenc Error: Unicode char \u8:... set up for
2304 use with LaTeX. Dieser Fehler tritt auf, wenn sie versuchen mit
2305 einer Standardinstallation exotische utf8 Zeichen zu drucken.
2306 TeXLive unterstützt von Haus nur romanische Schriften und muss mit
2307 diversen Tricks dazu gebracht werden andere Zeichen zu
2308 akzeptieren. Adere TeX Systeme wie XeTeX schaffen hier
2313 <para>Wird gar kein Fehler angezeigt, sondern nur der Name des
2314 Templates, heißt das normalerweise, dass das LaTeX Binary nicht
2315 gefunden wurde. Prüfen Sie den Namen in der Konfiguration (Standard:
2316 <literal>pdflatex</literal>), und stellen Sie sicher, dass pdflatex
2317 (oder das von Ihnen verwendete System) vom Webserver ausgeführt werden
2320 <para>Wenn sich das Problem nicht auf Grund der Ausgabe im Webbrowser
2321 verifizieren lässt:</para>
2325 <para>editiere [kivitendo-home]/config/kivitendo.conf und ändere
2326 "keep_temp_files" auf 1</para>
2328 <para><programlisting>keep_temp_files = 1;</programlisting></para>
2332 <para>bei fastcgi oder mod_perl den Webserver neu Starten</para>
2336 <para>Nochmal einen Druckversuch im Webfrontend auslösen</para>
2340 <para>wechsel in das users Verzeichnis von kivitendo</para>
2342 <para><programlisting>cd [kivitendo-home]/users</programlisting></para>
2346 <para>LaTeX Suchpfad anpassen:</para>
2348 <para><programlisting>export TEXINPUTS=".:[kivitendo-home]/templates/[aktuelles_template_verzeichniss]:"</programlisting></para>
2352 <para>Finde heraus, welche Datei kivitendo beim letzten Durchlauf
2355 <para><programlisting>ls -lahtr ./1*.tex</programlisting></para>
2357 <para>Es sollte die letzte Datei ganz unten sein</para>
2361 <para>für besseren Hinweis auf Fehler texdatei nochmals
2364 <para><programlisting>pdflatex ./1*.tex</programlisting></para>
2366 <para>in der *.tex datei nach dem Fehler suchen.</para>
2372 <sect1 id="OpenDocument-Vorlagen">
2373 <title>OpenDocument-Vorlagen</title>
2375 <para>kivitendo unterstützt die Verwendung von Vorlagen im
2376 OpenDocument-Format, wie es LibreOffice oder OpenOffice (ab Version 2)
2377 erzeugen. kivitendo kann dabei sowohl neue OpenDocument-Dokumente als
2378 auch aus diesen direkt PDF-Dateien erzeugen. Um die Unterstützung von
2379 OpenDocument-Vorlagen zu aktivieren muss in der Datei
2380 <filename>config/kivitendo.conf</filename> die Variable
2381 <literal>opendocument</literal> im Abschnitt
2382 <literal>print_templates</literal> auf ‘<literal>1</literal>’ stehen.
2383 Dieses ist die Standardeinstellung.</para>
2385 <para>Während die Erzeugung von reinen OpenDocument-Dateien keinerlei
2386 weitere Software benötigt, wird zur Umwandlung dieser Dateien in PDF
2387 LibreOffice oder OpenOffice benötigt. Soll dieses Feature genutzt
2388 werden, so muss neben LibreOffice oder OpenOffice auch der “X virtual
2389 frame buffer” (xvfb) installiert werden. Bei Debian ist er im Paket
2390 “xvfb” enthalten. Andere Distributionen enthalten ihn in anderen
2393 <para>Nach der Installation müssen in der Datei
2394 <filename>config/kivitendo.conf</filename> im Abschnitt
2395 <literal>applications</literal> zwei weitere Variablen angepasst
2398 <para><literal>openofficeorg_writer</literal> muss den vollständigen
2399 Pfad zu LibreOffice oder OpenOffice enthalten. Dabei dürfen keine
2400 Anführungszeichen eingesetzt werden.</para>
2402 <para>Beispiel für Debian oder Ubuntu:</para>
2404 <programlisting>openofficeorg_writer = /usr/bin/libreoffice</programlisting>
2406 <para><literal>xvfb</literal> muss den Pfad zum “X virtual frame buffer”
2409 <para>Zusätzlich gibt es zwei verschiedene Arten, wie kivitendo mit
2410 LibreOffice bzw. OpenOffice kommuniziert. Die erste Variante, die
2411 benutzt wird, wenn die Variable <literal>$openofficeorg_daemon</literal>
2412 gesetzt ist, startet ein LibreOffice oder OpenOffice, das auch nach der
2413 Umwandlung des Dokumentes gestartet bleibt. Bei weiteren Umwandlungen
2414 wird dann diese laufende Instanz benutzt. Der Vorteil ist, dass die Zeit
2415 zur Umwandlung deutlich reduziert wird, weil nicht für jedes Dokument
2416 ein LibreOffice bzw. OpenOffice gestartet werden muss. Der Nachteil ist,
2417 dass diese Methode Python und die Python-UNO-Bindings benötigt, die
2418 Bestandteil von LibreOffice bzw. OpenOffice sind.</para>
2421 <para>Für die Verbindung zu LibreOffice bzw. OpenOffice wird
2422 normalerweise der Python-Interpreter
2423 <filename>/usr/bin/python</filename> benutzt. Sollte dies nicht der
2424 richtige sein, so kann man mit zwei Konfigurationsvariablen
2425 entscheiden, welcher Python-Interpreter genutzt wird. Mit der Option
2426 <literal>python_uno</literal> aus dem Abschnitt
2427 <literal>applications</literal> wird der Interpreter selber
2428 festgelegt; sie steht standardmäßig auf dem eben erwähnten Wert
2429 <literal>/usr/bin/python</literal>.</para>
2431 <para>Zusätzlich ist es möglich, Pfade anzugeben, in denen Python
2432 neben seinen normalen Suchpfaden ebenfalls nach Modulen gesucht wird,
2433 z.B. falls sich diese in einem gesonderten LibreOffice- bzw.
2434 OpenOffice-Verzeichnis befinden. Diese zweite Variable heißt
2435 <literal>python_uno_path</literal> und befindet sich im Abschnitt
2436 <literal>environment</literal>. Sie ist standardmäßig leer. Werden
2437 hier mehrere Pfade angegeben, so müssen diese durch Doppelpunkte
2438 voneinander getrennt werden. Der Inhalt wird an den Python-Interpreter
2439 über die Umgebungsvariable <literal>PYTHONPATH</literal>
2443 <para>Ist <literal>$openofficeorg_daemon</literal> nicht gesetzt, so
2444 wird für jedes Dokument LibreOffice bzw. OpenOffice neu gestartet und
2445 die Konvertierung mit Hilfe eines Makros durchgeführt. Dieses Makro muss
2446 in der Dokumentenvorlage enthalten sein und
2447 “Standard.Conversion.ConvertSelfToPDF()” heißen. Die Beispielvorlage
2448 ‘<literal>templates/print/rev-odt/invoice.odt</literal>’ enthält ein
2449 solches Makro, das in jeder anderen Dokumentenvorlage ebenfalls
2450 enthalten sein muss.</para>
2452 <para>Als letztes muss herausgefunden werden, welchen Namen OpenOffice
2453 bzw. LibreOffice dem Verzeichnis mit den Benutzereinstellungen gibt.
2454 Unter Debian ist dies momentan <literal>~/.config/libreoffice</literal>.
2455 kivitendo verwendet das Verzeichnis
2456 <literal>users/.openoffice.org2</literal>. Eventuell muss dieses
2457 Verzeichnis umbenannt werden.</para>
2459 <para>Dieses Verzeichnis, wie auch das komplette
2460 <literal>users</literal>-Verzeichnis, muss vom Webserver beschreibbar
2461 sein. Dieses wurde bereits erledigt (siehe <xref
2462 linkend="Manuelle-Installation-des-Programmpaketes"/>), kann aber erneut
2463 überprüft werden, wenn die Konvertierung nach PDF fehlschlägt.</para>
2466 <title>OpenDocument (odt) Druckvorlagen mit Makros</title>
2468 <para>OpenDocument Vorlagen können Makros enthalten, welche komplexere
2469 Aufgaben erfüllen.</para>
2471 <para>Der Vorlagensatz "rev-odt" enthält solche Vorlagen mit <emphasis
2472 role="bold">Schweizer Bank-Einzahlungsscheinen (BESR)</emphasis>.
2473 Diese Makros haben die Aufgabe, die in den Einzahlungsscheinen
2474 benötigte Referenznummer und Kodierzeile zu erzeugen. Hier eine kurze
2475 Beschreibung, wie die Makros aufgebaut sind, und was bei ihrer Nutzung
2476 zu beachten ist (<emphasis role="bold">in fett sind nötige einmalige
2477 Anpassungen aufgeführt</emphasis>):</para>
2480 <title>Bezeichnung der Vorlagen</title>
2482 <para>Rechnung: invoice_besr.odt, Auftrag:
2483 sales_order_besr.odt</para>
2487 <title>Vorbereitungen im Adminbereich</title>
2489 <para>Damit beim Erstellen von Rechnungen und Aufträgen neben der
2490 Standardvorlage ohne Einzahlungsschein weitere Vorlagen (z.B. mit
2491 Einzahlungsschein) auswählbar sind, muss für jedes Vorlagen-Suffix
2492 ein Drucker eingerichtet werden:</para>
2496 <para>Druckeradministration → Drucker hinzufügen</para>
2500 <para>Mandant wählen</para>
2504 <para>Druckerbeschreibung → aussagekräftiger Text: wird in der
2505 Auftrags- bzw. Rechnungsmaske als Auswahl angezeigt (z.B. mit
2506 Einzahlungsschein Bank xy)</para>
2510 <para>Druckbefehl → beliebiger Text (hat für das Erzeugen von
2511 Aufträgen oder Rechnungen als odt-Datei keine Bedeutung, darf
2512 aber nicht leer sein)</para>
2516 <para>Vorlagenkürzel → besr bzw. selbst gewähltes Vorlagensuffix
2517 (muss genau der Zeichenfolge entsprechen, die zwischen
2518 "invoice_" bzw. "sales_order_" und ".odt" steht.)</para>
2522 <para>speichern</para>
2528 <title>Benutzereinstellungen</title>
2530 <para>Wer den Ausdruck mit Einzahlungsschein als Standardeinstellung
2531 im Rechnungs- bzw. Auftragsformular angezeigt haben möchte, kann
2532 dies persönlich für sich bei den Benutzereinstellungen
2533 konfigurieren:</para>
2537 <para>Programm → Benutzereinstellungen → Druckoptionen</para>
2541 <para>Standardvorlagenformat → OpenDocument/OASIS</para>
2545 <para>Standardausgabekanal → Bildschirm</para>
2549 <para>Standarddrucker → gewünschte Druckerbeschreibung auswählen
2550 (z.B. mit Einzahlungsschein Bank xy)</para>
2554 <para>Anzahl Kopien → leer</para>
2558 <para>speichern</para>
2564 <title>Aufbau und nötige Anpassungen der Vorlagen</title>
2566 <para>In der Vorlage sind als Modul "BESR" 4 Makros gespeichert, die
2567 aus dem von kivitendo erzeugten odt-Dokument die korrekte
2568 Referenznummer inklusive Prüfziffer sowie die Kodierzeile in
2569 OCRB-Schrift erzeugen und am richtigen Ort ins Dokument
2574 <para>Für den Einzahlungsschein ist die letzte Seite des
2575 Dokuments reserviert</para>
2579 <para>Direkt über dem Einzahlungsschein enthält die Vorlage eine
2580 Zeile mit folgenden Angaben (<emphasis
2581 role="bold">Bank-Konto-Identifikationsnummer und
2582 Postkonto-Nummer der Bank müssen gemäss Angaben der jeweiligen
2583 Bank angepasst werden</emphasis>):<itemizedlist>
2585 <para>DDDREF: 4 Werte zum Bilden der Referenznummer
2586 (jeweils durch einen Leerschlag getrennt): <itemizedlist>
2588 <para>erster Wert: <emphasis
2589 role="bold">Bank-Konto-Identifikation</emphasis>
2590 (nur Ziffern, maximal 6), <emphasis role="bold">muss
2591 angepasst werden</emphasis>.</para>
2595 <para>zweiter Wert: <%customernumber%>
2596 (Kundennummer: nur Ziffern, maximal 6)</para>
2600 <para>dritter Wert: <%ordnumber%>
2601 (Auftragsnummer bei Auftragsvorlage
2602 sales_oder_besr.odt, sonst 0) maximal 7 Ziffern,
2603 führende Buchstaben werden vom Makro entfernt</para>
2607 <para>vierter Wert: <%invnumber%>
2608 (Rechnungsnummer bei Rechnungsvorlage
2609 invoice_besr.odt, sonst 0) maximal 7 Ziffern,
2610 führende Buchstaben werden vom Makro entfernt</para>
2612 </itemizedlist></para>
2616 <para>DDDKONTO: <emphasis role="bold">Postkonto-Nummer der
2617 Bank, muss angepasst werden</emphasis>.</para>
2621 <para>DDDBETRAG: <%total%> Einzahlungsbetrag oder 0,
2622 falls Einzahlungsschein ohne Betrag</para>
2626 <para>DDDEND: muss am Ende der Zeile vorhanden sein</para>
2628 </itemizedlist></para>
2632 <para><emphasis role="bold">Im Einzahlungsschein selbst müssen
2633 der Name und die Adresse der Bank, die Postkonto-Nummer der
2634 Bank, sowie der eigene Firmenname und die Firmenadresse
2635 angepasst werden.</emphasis> Dabei ist darauf zu achten, dass
2636 sich die Positionen der Postkonto-Nummern der Bank, sowie der
2637 Zeichenfolgen dddfr, DDDREF1, DDDREF2, 609, DDDKODIERZEILE nicht
2643 <screeninfo>Rechnungsvorlage Schweizer Bank-Einzahlungsschein - zu
2644 ändernde Einträge in rot</screeninfo>
2648 <imagedata fileref="images/Einzahlungsschein_Makro.png"/>
2655 <title>Auswahl der Druckvorlage in kivitendo beim Erzeugen einer
2656 odt-Rechnung (analog bei Auftrag)</title>
2658 <para>Im Fussbereich der Rechnungsmaske muss neben Rechnung,
2659 OpenDocument/OASIS und Bildschirm die im Adminbereich erstellte
2660 Druckerbeschreibung ausgewählt werden, falls diese nicht bereits bei
2661 den Benutzereinstellungen als persönlicher Standard gewählt
2666 <title>Makroeinstellungen in LibreOffice anpassen</title>
2668 <para>Falls beim Öffnen einer von kivitendo erzeugten odt-Rechnung
2669 die Meldung kommt, dass Makros aus Sicherheitsgründen nicht
2670 ausgeführt werden, so müssen folgende Einstellungen in LibreOffice
2671 angepasst werden:</para>
2675 <para>Extras → Optionen → Sicherheit → Makrosicherheit</para>
2679 <para>Sicherheitslevel auf "Mittel" einstellen (Diese
2680 Einstellung muss auf jedem Computer durchgeführt werden, mit dem
2681 von kivitendo erzeugte odt-Rechnungen oder Aufträge geöffnet
2686 <para>Beim Öffnen einer odt-Rechnung oder eines odt-Auftrags bei
2687 der entsprechenden Nachfrage "Makros ausführen"
2690 <para><emphasis role="bold">Wichtig</emphasis>: die Makros sind
2691 so eingestellt, dass sie beim Öffnen der Vorlagen selbst nicht
2692 ausgeführt werden. Das heisst für das Ansehen und Bearbeiten der
2693 Vorlagen sind keine speziellen Einstellungen in LibreOffice
2701 <sect1 id="nomenclature">
2702 <title>Nomenklatur</title>
2704 <sect2 id="booking.dates">
2705 <title>Datum bei Buchungen</title>
2707 <para>Seit der Version 3.5 werden für Buchungen in kivitendo
2708 einheitlich folgende Bezeichnungen verwendet:</para>
2712 <para><option>Erfassungsdatum</option> (en: <option>Entry
2713 Date</option>, code: <option>Gldate</option>)</para>
2715 <para>bezeichnet das Datum, an dem die Buchung in kivitendo
2716 erfasst wurde.</para>
2720 <para><option>Buchungsdatum</option> (en: <option>Booking
2721 Date</option>, code: <option>Transdate</option>)</para>
2723 <para>bezeichnet das buchhaltungstechnisch für eine Buchung
2724 relevante Datum</para>
2726 <para>Das <option>Rechnungsdatum</option> bei Verkaufs- und
2727 Einkaufsrechnungen entspricht dem Buchungsdatum. Das heisst, in
2728 Berichten wie dem Buchungsjournal, in denen eine Spalte
2729 <option>Buchungsdatum</option> angezeigt werden kann, erscheint
2730 hier im Fall von Rechnungen das Rechnungsdatum.</para>
2734 <para>Bezieht sich ein verbuchter Beleg auf einen Zeitpunkt, der
2735 nicht mit dem Buchungsdatum übereinstimmt, so kann dieses Datum
2736 momentan in kivitendo nur unter Bemerkungen erfasst werden.</para>
2738 <para>Möglicherweise wird für solche Fälle in einer späteren
2739 Version von kivitendo ein dritter Datumswert für Buchungen
2740 erstellt. (Beispiel: Einkaufsbeleg stammt aus einem früheren Jahr,
2741 das bereits buchhaltungstechnisch abgeschlossen wurde, und muss
2742 deshalb später verbucht werden.)</para>
2748 <sect1 id="config.eur">
2749 <title>Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung:
2752 <sect2 id="config.eur.introduction"
2753 xreflabel="Einführung in die Konfiguration zur EUR">
2754 <title>Einführung</title>
2756 <para>kivitendo besaß bis inklusive Version 2.6.3 einen
2757 Konfigurationsparameter namens <varname>eur</varname>, der sich in der
2758 Konfigurationsdatei <filename>config/kivitendo.conf</filename> (damals
2759 noch <filename>config/lx_office.conf</filename>) befand. Somit galt er
2760 für alle Mandanten, die in dieser Installation benutzt wurden.</para>
2762 <para>Mit der nachfolgenden Version wurde der Parameter zum Einen in
2763 die Mandantendatenbank verschoben und dabei auch gleich in drei
2764 Einzelparameter aufgeteilt, mit denen sich das Verhalten genauer
2765 steuern lässt.</para>
2768 <sect2 id="config.eur.parameters"
2769 xreflabel="Konfigurationsparameter für EUR">
2770 <title>Konfigurationsparameter</title>
2772 <para>Es gibt drei Parameter, die die Gewinnermittlungsart,
2773 Versteuerungsart und die Warenbuchungsmethode regeln:</para>
2777 <term><varname>profit_determination</varname></term>
2780 <para>Dieser Parameter legt die Berechnungsmethode für die
2781 Gewinnermittlung fest. Er enthält entweder
2782 <literal>balance</literal> für
2783 Betriebsvermögensvergleich/Bilanzierung oder
2784 <literal>income</literal> für die
2785 Einnahmen-Überschuss-Rechnung.</para>
2790 <term><varname>accounting_method</varname></term>
2793 <para>Dieser Parameter steuert die Buchungs- und
2794 Berechnungsmethoden für die Versteuerungsart. Er enthält
2795 entweder <literal>accrual</literal> für die Soll-Versteuerung
2796 oder <literal>cash</literal> für die Ist-Versteuerung.</para>
2801 <term><varname>inventory_system</varname></term>
2804 <para>Dieser Parameter legt die Warenbuchungsmethode fest. Er
2805 enthält entweder <literal>perpetual</literal> für die
2806 Bestandsmethode oder <literal>periodic</literal> für die
2807 Aufwandsmethode.</para>
2812 <para>Zum Vergleich der Funktionalität bis und nach 2.6.3:
2813 <varname>eur</varname> = 1 bedeutete Einnahmen-Überschuss-Rechnung,
2814 Ist-Versteuerung und Aufwandsmethode. <varname>eur</varname> = 0
2815 bedeutete hingegen Bilanzierung, Soll-Versteuerung und
2816 Bestandsmethode.</para>
2818 <para>Die Konfiguration "<varname>eur</varname>" unter
2819 <varname>[system]</varname> in der <link
2820 linkend="config.config-file">Konfigurationsdatei</link>
2821 <filename>config/kivitendo.conf</filename> wird nun nicht mehr
2822 benötigt und kann entfernt werden. Dies muss manuell geschehen.</para>
2825 <sect2 id="config.eur.setting-parameters">
2826 <title>Festlegen der Parameter</title>
2828 <para>Beim Anlegen eines neuen Mandanten bzw. einer neuen Datenbank in
2829 der Admininstration können diese Optionen nun unabhängig voneinander
2830 eingestellt werden.</para>
2832 <para>Für die Schweiz sind folgende Einstellungen üblich:
2835 <para>Sollversteuerung</para>
2839 <para>Aufwandsmethode</para>
2843 <para>Bilanzierung</para>
2845 </itemizedlist> Diese Einstellungen werden automatisch beim
2846 Erstellen einer neuen Datenbank vorausgewählt, wenn in
2847 <filename>config/kivitendo.conf</filename> unter
2848 <varname>[system]</varname> <literal>default_manager = swiss</literal>
2849 eingestellt ist.</para>
2851 <para>Beim Upgrade bestehender Mandanten wird eur ausgelesen und die
2852 Variablen werden so gesetzt, daß sich an der Funktionalität nichts
2855 <para>Die aktuelle Konfiguration wird unter Nummernkreise und
2856 Standardkonten unter dem neuen Punkt "Einstellungen" (read-only)
2857 angezeigt. Unter <guimenu>System</guimenu> →
2858 <guisubmenu>Mandantenkonfiguration</guisubmenu> können die
2859 Einstellungen auch geändert werden. Dabei ist zu beachten, dass eine
2860 Änderung vorhandene Daten so belässt und damit evtl. die Ergebnisse
2861 verfälscht. Dies gilt vor Allem für die Warenbuchungsmethode (siehe
2862 auch <link linkend="config.eur.inventory-system-perpetual">
2863 Bemerkungen zur Bestandsmethode</link>).</para>
2866 <sect2 id="config.eur.inventory-system-perpetual">
2867 <title>Bemerkungen zur Bestandsmethode</title>
2869 <para>Die Bestandsmethode ist eigentlich eine sehr elegante Methode,
2870 funktioniert in kivitendo aber nur unter bestimmten Bedingungen:
2871 Voraussetzung ist, daß auch immer alle Einkaufsrechnungen gepflegt
2872 werden, und man beim Jahreswechsel nicht mit einer leeren Datenbank
2873 anfängt, da bei jedem Verkauf anhand der gesamten Rechnungshistorie
2874 der Einkaufswert der Ware nach dem FIFO-Prinzip aus den
2875 Einkaufsrechnungen berechnet wird.</para>
2877 <para>Die Bestandsmethode kann vom Prinzip her also nur funktioneren,
2878 wenn man mit den Buchungen bei Null anfängt, und man kann auch nicht
2879 im laufenden Betrieb von der Aufwandsmethode zur Bestandsmethode
2883 <sect2 id="config.eur.knonw-issues">
2884 <title>Bekannte Probleme</title>
2886 <para>Bei bestimmten Berichten kann man derzeit noch inviduell
2887 einstellen, ob man nach Ist- oder Sollversteuerung auswertet, und es
2888 werden im Code Variablen wie $accrual oder $cash gesetzt. Diese
2889 Codestellen wurden noch nicht angepasst, sondern nur die, wo bisher
2890 die Konfigurationsvariable
2891 <varname>$::lx_office_conf{system}->{eur}</varname> ausgewertet
2894 <para>Es fehlen Hilfetext beim Neuanlegen eines Mandanten, was die
2895 Optionen bewirken, z.B. mit zwei Standardfällen.</para>
2899 <sect1 id="config.skr04-update-3804">
2900 <title>SKR04 19% Umstellung für innergemeinschaftlichen Erwerb</title>
2902 <sect2 id="config.skr04-update-3804.introduction">
2903 <title>Einführung</title>
2905 <para>Die Umsatzsteuerumstellung auf 19% für SKR04 für die
2906 Steuerschlüssel "EU ohne USt-ID Nummer" ist erst 2010 erfolgt.
2907 kivitendo beinhaltet ein Upgradeskript, das das Konto 3804 automatisch
2908 erstellt und die Steuereinstellungen korrekt einstellt. Hat der
2909 Benutzer aber schon selber das Konto 3804 angelegt, oder gab es schon
2910 Buchungen im Zeitraum nach dem 01.01.2007 auf das Konto 3803, wird das
2911 Upgradeskript vorsichtshalber nicht ausgeführt, da der Benutzer sich
2912 vielleicht schon selbst geholfen hat und mit seinen Änderungen
2913 zufrieden ist. Die korrekten Einstellungen kann man aber auch per Hand
2914 ausführen. Nachfolgend werden die entsprechenden Schritte anhand von
2915 Screenshots dargestellt.</para>
2917 <para>Für den Fall, daß Buchungen mit der Steuerschlüssel "EU ohne
2918 USt.-IdNr." nach dem 01.01.2007 erfolgt sind, ist davon auszugehen,
2919 dass diese mit dem alten Umsatzsteuersatz von 16% gebucht worden sind,
2920 und diese Buchungen sollten entsprechend kontrolliert werden.</para>
2923 <sect2 id="config.skr04-update-3804.create-chart">
2924 <title>Konto 3804 manuell anlegen</title>
2926 <para>Die folgenden Schritte sind notwendig, um das Konto manuell
2927 anzulegen und zu konfigurieren. Zuerst wird in
2928 <guimenu>System</guimenu> → <guisubmenu>Kontenübersicht</guisubmenu> →
2929 <guimenuitem>Konto erfassen</guimenuitem> das Konto angelegt.</para>
2932 <screeninfo>Konto 3804 erfassen</screeninfo>
2936 <imagedata fileref="images/skr04-update-3804/konto3804.png"/>
2941 <para>Als Zweites muss Steuergruppe 13 für Konto 3803 angepasst
2942 werden. Dazu unter <guimenu>System</guimenu> →
2943 <guisubmenu>Steuern</guisubmenu> →
2944 <guimenuitem>Bearbeiten</guimenuitem> den Eintrag mit Steuerschlüssel
2945 13 auswählen und ihn wie im folgenden Screenshot angezeigt
2949 <screeninfo>Steuerschlüssel 13 für 3803 (16%) anpassen</screeninfo>
2953 <imagedata fileref="images/skr04-update-3804/steuer3803.png"/>
2958 <para>Als Drittes wird ein neuer Eintrag mit Steuerschlüssel 13 für
2959 Konto 3804 (19%) angelegt. Dazu unter <guimenu>System</guimenu> →
2960 <guisubmenu>Steuern</guisubmenu> → <guimenuitem>Erfassen</guimenuitem>
2961 auswählen und die Werte aus dem Screenshot übernehmen.</para>
2964 <screeninfo>Steuerschlüssel 13 für 3804 (19%) anlegen</screeninfo>
2968 <imagedata fileref="images/skr04-update-3804/steuer3804.png"/>
2973 <para>Als Nächstes sind alle Konten anzupassen, die als
2974 Steuerautomatikkonto die 3803 haben, sodass sie ab dem 1.1.2007 auch
2975 Steuerautomatik auf 3804 bekommen. Dies betrifft in der
2976 Standardkonfiguration die Konten 4315 und 4726. Als Beispiel für 4315
2977 müssen Sie dazu unter <guimenu>System</guimenu> →
2978 <guisubmenu>Kontenübersicht</guisubmenu> → <guimenuitem>Konten
2979 anzeigen</guimenuitem> das Konto 4315 anklicken und die Einstellungen
2980 wie im Screenshot gezeigt vornehmen.</para>
2983 <screeninfo>Konto 4315 anpassen</screeninfo>
2987 <imagedata fileref="images/skr04-update-3804/konto4315.png"/>
2992 <para>Als Letztes sollte die Steuerliste unter
2993 <guimenu>System</guimenu> → <guisubmenu>Steuern</guisubmenu> →
2994 <guimenuitem>Bearbeiten</guimenuitem> kontrolliert werden. Zum
2995 Vergleich der Screenshot.</para>
2998 <screeninfo>Steuerliste vergleichen</screeninfo>
3002 <imagedata fileref="images/skr04-update-3804/steuerliste.png"/>
3009 <sect1 id="config.bilanz">
3010 <title>Verhalten des Bilanzberichts</title>
3012 <para>Bis Version 3.0 wurde "closedto" ("Bücher schließen zum") als
3013 Grundlage für das Startdatum benutzt. Schließt man die Bücher allerdings
3014 monatsweise führt dies zu falschen Werten.</para>
3016 <para>In der Mandantenkonfiguration kann man dieses Verhalten genau
3017 einstellen indem man:</para>
3021 <para>weiterhin closed_to benutzt (Default, es ändert sich nichts zu
3026 <para>immer den Jahresanfang nimmt (1.1. relativ zum
3031 <para>immer die letzte Eröffnungsbuchung als Startdatum nimmt</para>
3033 <para>- mit Jahresanfang als Alternative wenn es keine EB-Buchungen
3036 <para>- oder mit "alle Buchungen" als Alternative"</para>
3040 <para>mit Jahresanfang als Alternative wenn es keine EB-Buchungen
3045 <para>immer alle Buchungen seit Beginn der Datenbank nimmt</para>
3049 <para>Folgende Hinweise zu den Optionen: Das "Bücher schließen Datum"
3050 ist sinnvoll, wenn man nur komplette Jahre schließt. Bei Wirtschaftsjahr
3051 = Kalendarjahr entspricht dies aber auch dem Jahresanfang. "Alle
3052 Buchungen" kann z.B. sinnvoll sein wenn man ohne Jahresabschluß
3053 durchbucht. Eröffnungsbuchung mit "alle Buchungen" als Fallback ist z.B.
3054 sinnvoll, wenn man am sich Anfang des zweiten Buchungsjahres befindet,
3055 und noch keinen Jahreswechsel und auch noch keine EB-Buchungen hat. Bei
3056 den Optionen mit EB-Buchungen wird vorausgesetzt, daß diese immer am 1.
3057 Tag des Wirtschaftsjahres gebucht werden. Zur Sicherheit wird das
3058 Startdatum im Bilanzbericht jetzt zusätzlich zum Stichtag mit angezeigt.
3059 Das hilft auch bei der Kontrolle für den Abgleich mit der GuV bzw.
3060 Erfolgsrechnung.</para>
3063 <sect1 id="config.erfolgsrechnung">
3064 <title>Erfolgsrechnung</title>
3066 <para>Seit der Version 3.4.1 existiert in kivitendo der Bericht
3067 <emphasis role="bold"> Erfolgsrechnung</emphasis>.</para>
3069 <para>Die Erfolgsrechnung kann in der Mandantenkonfiguration unter
3070 Features an- oder abgeschaltet werden. Mit der Einstellung
3071 <varname>default_manager = swiss </varname> in der
3072 <filename>config/kivitendo.conf</filename> wird beim neu Erstellen einer
3073 Datenbank automatisch die Anzeige der Erfolgsrechnung im Menü
3074 <guimenu>Berichte </guimenu> ausgewählt und ersetzt dort die GUV.</para>
3076 <para>Im Gegensatz zur GUV werden bei der Erfolgsrechnung sämtliche
3077 Aufwands- und Erlöskonten einzeln aufgelistet (analog zur Bilanz),
3078 sortiert nach ERTRAG und AUFWAND.</para>
3080 <para>Bei den Konteneinstellungen muss bei jedem Konto, das in der
3081 Erfolgsrechnung erscheinen soll, unter <varname>Sonstige
3082 Einstellungen/Erfolgsrechnung</varname> entweder
3083 <literal>01.Ertrag</literal> oder <literal>06.Aufwand</literal>
3084 ausgewählt werden.</para>
3086 <para>Wird bei einem Erlöskonto <literal>06.Aufwand</literal>
3087 ausgewählt, so wird dieses Konto als Aufwandsminderung unter AUFWAND
3090 <para>Wird bei einem Aufwandskonto <literal>01.Ertrag</literal>
3091 ausgewählt, so wird dieses Konto als Ertragsminderung unter ERTRAG
3094 <para>Soll bei einer bereits bestehenden Buchhaltung in Zukunft
3095 zusätzlich die Erfolgsrechnung als Bericht verwendet werden, so müssen
3096 die Einstellungen zu allen Erlös- und Aufwandskonten unter
3097 <varname>Sonstige Einstellungen/Erfolgsrechnung</varname> überprüft und
3098 allenfalls neu gesetzt werden.</para>
3101 <sect1 id="config.rounding">
3102 <title>Rundung in Verkaufsbelegen</title>
3104 <para>In der Schweiz hat die kleinste aktuell benutzte Münze den Wert
3105 von 5 Rappen (0.05 CHF).</para>
3107 <para>Auch wenn im elektronischen Zahlungsverkehr Beträge mit einer
3108 Genauigkeit von 0.01 CHF verwendet werden können, ist es trotzdem nach
3109 wie vor üblich, Rechnungen mit auf 0.05 CHF gerundeten Beträgen
3110 auszustellen.</para>
3112 <para>In kivitendo kann seit der Version 3.4.1 die Einstellung für eine
3113 solche Rundung pro Mandant / Datenbank festgelegt werden.</para>
3115 <para>Die Einstellung wird beim Erstellen der Datenbank bei
3116 <literal>Genauigkeit</literal> festgelegt. Sie kann anschliessend über
3117 das Webinterface von kivitendo nicht mehr verändert werden.</para>
3119 <para>Abhängig vom Wert für <varname>default_manager</varname> in
3120 <filename>config/kivitendo.conf</filename> werden dabei folgende Werte
3121 voreingestellt:</para>
3125 <para>0.05 (default_manager = swiss)</para>
3129 <para>0.01 (default_manager = german)</para>
3133 <para>Der Wert wird in der Datenbank in der Tabelle <varname>defaults
3134 </varname>in der Spalte <varname>precision</varname> gespeichert.</para>
3136 <para>In allen Verkaufsangeboten, Verkaufsaufträgen, Verkaufsrechnungen
3137 und Verkaufsgutschriften wird der Endbetrag inkl. MWST gerundet, wenn
3138 dieser nicht der eingestellten Genauigkeit entspricht.</para>
3140 <para>Beim Buchen einer Verkaufsrechnung wird der Rundungsbetrag
3141 automatisch auf die in der Mandantenkonfiguration festgelegten
3142 Standardkonten für Rundungserträge bzw. Rundungsaufwendungen
3145 <para>(Die berechnete MWST wird durch den Rundungsbetrag nicht mehr
3148 <para>Die in den Druckvorlagen zur Verfügung stehenden Variablen
3149 <varname>quototal</varname>, <varname>ordtotal</varname> bzw.
3150 <varname>invtotal</varname> enthalten den gerundeten Betrag.</para>
3152 <para><emphasis role="bold">Achtung:</emphasis> Werden Verkaufsbelege in
3153 anderen Währungen als der Standardwährung erstellt, so muss in kivitendo
3154 ab Version 3.4.1 die Genauigkeit 0.01 verwendet werden.</para>
3156 <para>Das heisst, Firmen in der Schweiz, die teilweise
3157 Verkaufsrechnungen in Euro oder anderen Währungen erstellen wollen,
3158 müssen beim Erstellen der Datenbank als Genauigkeit 0.01 wählen und
3159 können zur Zeit die 5er Rundung noch nicht nutzen.</para>
3162 <sect1 id="config.client">
3163 <title>Einstellungen pro Mandant</title>
3165 <para>Einige Einstellungen können von einem Benutzer mit dem <link
3166 linkend="Zusammenhänge">Recht</link> "Administration (Für die Verwaltung
3167 der aktuellen Instanz aus einem Userlogin heraus)" gemacht werden. Diese
3168 Einstellungen sind dann für die aktuellen Mandanten-Datenbank gültig.
3169 Die Einstellungen sind unter <guimenu>System</guimenu> →
3170 <guisubmenu>Mandantenkonfiguration</guisubmenu> erreichbar.</para>
3172 <para>Bitte beachten Sie die Hinweise zu den einzelnen Einstellungen.
3173 Einige Einstellungen sollten nicht ohne Weiteres im laufenden Betrieb
3174 geändert werden (siehe auch <link
3175 linkend="config.eur.inventory-system-perpetual">Bemerkungen zu
3176 Bestandsmethode</link>).</para>
3178 <para>Die Einstellungen <literal>show_bestbefore</literal> und
3179 <literal>payments_changeable</literal> aus dem Abschnitt
3180 <literal>features</literal> und die Einstellungen im Abschnitt
3181 <literal>datev_check</literal> (sofern schon vorhanden) der <link
3182 linkend="config.config-file">kivitendo-Konfigurationsdatei</link> werden
3183 bei einem Datenbankupdate einer älteren Version automatisch übernommen.
3184 Diese Einträge können danach aus der Konfigurationsdatei entfernt
3188 <sect1 id="kivitendo-ERP-verwenden">
3189 <title>kivitendo ERP verwenden</title>
3191 <para>Nach erfolgreicher Installation ist der Loginbildschirm unter
3192 folgender URL erreichbar:</para>
3195 url="http://localhost/kivitendo-erp/login.pl">http://localhost/kivitendo-erp/login.pl</ulink></para>
3197 <para>Die Administrationsseite erreichen Sie unter:</para>
3200 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
3204 <chapter id="features" xreflabel="Features und Funktionen">
3205 <title>Features und Funktionen</title>
3207 <sect1 id="features.periodic-invoices"
3208 xreflabel="Wiederkehrende Rechnungen">
3209 <title>Wiederkehrende Rechnungen</title>
3211 <sect2 id="features.periodic-invoices.introduction"
3212 xreflabel="Einführung in wiederkehrende Rechnungen">
3213 <title>Einführung</title>
3215 <para>Wiederkehrende Rechnungen werden als normale Aufträge definiert
3216 und konfiguriert, mit allen dazugehörigen Kunden- und Artikelangaben.
3217 Die konfigurierten Aufträge werden später automatisch in Rechnungen
3218 umgewandelt, so als ob man den Workflow benutzen würde, und auch die
3219 Auftragsnummer wird übernommen, sodass alle wiederkehrenden
3220 Rechnungen, die aus einem Auftrag erstellt wurden, später leicht
3221 wiederzufinden sind.</para>
3224 <sect2 id="features.periodic-invoices.configuration"
3225 xreflabel="Konfiguration von wiederkehrenden Rechnungen">
3226 <title>Konfiguration</title>
3228 <para>Um einen Auftrag für wiederkehrende Rechnung zu konfigurieren,
3229 findet sich beim Bearbeiten des Auftrags ein neuer Knopf
3230 "Konfigurieren", der ein neues Fenster öffnet, in dem man die nötigen
3231 Parameter einstellen kann. Hinter dem Knopf wird außerdem noch
3232 angezeigt, ob der Auftrag als wiederkehrende Rechnung konfiguriert ist
3235 <para>Folgende Parameter kann man konfigurieren:</para>
3242 <para>Bei aktiven Rechnungen wird automatisch eine Rechnung
3243 erstellt, wenn die Periodizität erreicht ist (z.B. am Anfang
3244 eines neuen Monats).</para>
3246 <para>Ist ein Auftrag nicht aktiv, so werden für ihn auch keine
3247 wiederkehrenden Rechnungen erzeugt. Stellt man nach längerer
3248 nicht-aktiver Zeit einen Auftrag wieder auf aktiv, wird beim
3249 nächsten Periodenwechsel für alle Perioden, seit der letzten
3250 aktiven Periode, jeweils eine Rechnung erstellt. Möchte man dies
3251 verhindern, muss man vorher das Startdatum neu setzen.</para>
3253 <para>Für gekündigte Aufträge werden nie mehr Rechnungen
3254 erstellt. Man kann sich diese Aufträge aber gesondert in den
3255 Berichten anzeigen lassen.</para>
3260 <term>Periodizität</term>
3263 <para>Ob monatlich, quartalsweise oder jährlich auf neue
3264 Rechnungen überprüft werden soll. Für jede Periode seit dem
3265 Startdatum wird überprüft, ob für die Periode (beginnend immer
3266 mit dem ersten Tag der Periode) schon eine Rechnung erstellt
3267 wurde. Unter Umständen können bei einem Startdatum in der
3268 Vergangenheit gleich mehrere Rechnungen erstellt werden.</para>
3273 <term>Buchen auf</term>
3276 <para>Das Forderungskonto, in der Regel "Forderungen aus
3277 Lieferungen und Leistungen". Das Gegenkonto ergibt sich aus den
3278 Buchungsgruppen der betreffenden Waren.</para>
3283 <term>Startdatum</term>
3286 <para>ab welchem Datum auf Rechnungserstellung geprüft werden
3292 <term>Enddatum</term>
3295 <para>ab wann keine Rechnungen mehr erstellt werden
3301 <term>Automatische Verlängerung um x Monate</term>
3304 <para>Sollen die wiederkehrenden Rechnungen bei Erreichen des
3305 eingetragenen Enddatums weiterhin erstellt werden, so kann man
3306 hier die Anzahl der Monate eingeben, um die das Enddatum
3307 automatisch nach hinten geschoben wird.</para>
3312 <term>Drucken</term>
3315 <para>Sind Drucker konfiguriert, so kann man sich die erstellten
3316 Rechnungen auch gleich ausdrucken lassen.</para>
3321 <para>Nach Erstellung der Rechnungen kann eine E-Mail mit
3322 Informationen zu den erstellten Rechnungen verschickt werden.
3323 Konfiguriert wird dies in der <link
3324 linkend="config.config-file.sections-parameters">Konfigurationsdatei</link>
3325 <filename>config/kivitendo.conf</filename> im Abschnitt
3326 <varname>[periodic_invoices]</varname>.</para>
3329 <sect2 id="features.periodic-invoices.variables">
3330 <title>Spezielle Variablen</title>
3332 <para>Um die erzeugten Rechnungen individualisieren zu können, werden
3333 beim Umwandeln des Auftrags in eine Rechnung einige speziell
3334 formatierte Variablen durch für die jeweils aktuelle
3335 Abrechnungsperiode gültigen Werte ersetzt. Damit ist es möglich, z.B.
3336 den Abrechnungszeitraum explizit auszuweisen. Eine Variable hat dabei
3337 die Syntax <literal><%variablenname%></literal>.</para>
3339 <para>Sofern es sich um eine Datumsvariable handelt, kann das
3340 Ausgabeformat weiter bestimmt werden, indem an den Variablennamen
3341 Formatoptionen angehängt werden. Die Syntax sieht dabei wie folgt aus:
3342 <literal><%variablenname FORMAT=Formatinformation%></literal>.
3343 Die zur verfügung stehenden Formatinformationen werden unten genauer
3346 <para>Diese Variablen können auch beim automatischen Versand der
3347 erzeugten Rechnungen per E-Mail genutzt werden, indem sie in den
3348 Feldern für den Betreff oder die Nachricht verwendet werden.</para>
3350 <para>Diese Variablen werden in den folgenden Elementen des Auftrags
3355 <para>Bemerkungen</para>
3359 <para>Interne Bemerkungen</para>
3363 <para>Vorgangsbezeichnung</para>
3367 <para>In den Beschreibungs- und Langtextfeldern aller
3372 <para>Die zur Verfügung stehenden Variablen sind die Folgenden:</para>
3376 <term><varname><%current_quarter%></varname>,
3377 <varname><%previous_quarter%></varname>,
3378 <varname><%next_quarter%></varname></term>
3381 <para>Aktuelles, vorheriges und nächstes Quartal als Zahl
3382 zwischen <literal>1</literal> und <literal>4</literal>.</para>
3387 <term><varname><%current_month%></varname>,
3388 <varname><%previous_month%></varname>,
3389 <varname><%next_month%></varname></term>
3392 <para>Aktueller, vorheriger und nächster Monat als Zahl zwischen
3393 <literal>1</literal> und <literal>12</literal>.</para>
3398 <term><varname><%current_month_long%></varname>,
3399 <varname><%previous_month_long%></varname>,
3400 <varname><%next_month_long%></varname></term>
3403 <para>Aktueller, vorheriger und nächster Monat als Name
3404 (<literal>Januar</literal>, <literal>Februar</literal>
3410 <term><varname><%current_year%></varname>,
3411 <varname><%previous_year%></varname>,
3412 <varname><%next_year%></varname></term>
3415 <para>Aktuelles, vorheriges und nächstes Jahr als vierstellige
3416 Jahreszahl (<literal>2013</literal> etc.).</para>
3421 <term><varname><%period_start_date%></varname>,
3422 <varname><%period_end_date%></varname></term>
3425 <para>Formatiertes Datum des ersten und letzten Tages im
3426 Abrechnungszeitraum (z.B. bei quartalsweiser Abrechnung und im
3427 ersten Quartal von 2013 wären dies der
3428 <literal>01.01.2013</literal> und
3429 <literal>31.03.2013</literal>).</para>
3434 <para>Die invidiuellen Formatinformationen bestehen aus Paaren von
3435 Prozentzeichen und einem Buchstaben, welche beide zusammen durch den
3436 dazugehörigen Wert ersetzt werden. So wird z.B. <literal>%Y</literal>
3437 durch das viertstellige Jahr ersetzt. Alle möglichen Platzhalter
3442 <term><varname>%a</varname></term>
3445 <para>Der abgekürzte Wochentagsname.</para>
3450 <term><varname>%A</varname></term>
3453 <para>Der ausgeschriebene Wochentagsname.</para>
3458 <term><varname>%b</varname></term>
3461 <para>Der abgekürzte Monatsname.</para>
3466 <term><varname>%B</varname></term>
3469 <para>Der ausgeschriebene Monatsname.</para>
3474 <term><varname>%C</varname></term>
3477 <para>Das Jahrhundert (Jahr/100) als eine zweistellige
3483 <term><varname>%d</varname></term>
3486 <para>Der Monatstag als Zahl zwischen 01 und 31.</para>
3491 <term><varname>%D</varname></term>
3494 <para>Entspricht %m/%d/%y (amerikanisches Datumsformat).</para>
3499 <term><varname>%e</varname></term>
3502 <para>Wie %d (Monatstag als Zahl zwischen 1 und 31), allerdings
3503 werden führende Nullen durch Leerzeichen ersetzt.</para>
3508 <term><varname>%F</varname></term>
3511 <para>Entspricht %Y-%m-%d (das ISO-8601-Datumsformat).</para>
3516 <term><varname>%j</varname></term>
3519 <para>Der Tag im Jahr als Zahl zwischen 001 und 366
3525 <term><varname>%m</varname></term>
3528 <para>Der Monat als Zahl zwischen 01 und 12 inklusive.</para>
3533 <term><varname>%u</varname></term>
3536 <para>Der Wochentag als Zahl zwischen 1 und 7 inklusive, wobei
3537 die 1 dem Montag entspricht.</para>
3542 <term><varname>%U</varname></term>
3545 <para>Die Wochennummer als Zahl zwischen 00 und 53 inklusive,
3546 wobei der erste Sonntag im Jahr das Startdatum von Woche 01
3552 <term><varname>%V</varname></term>
3555 <para>Die ISO-8601:1988-Wochennummer als Zahl zwischen 01 und 53
3556 inklusive, wobei Woche 01 die erste Woche, von der mindestens
3557 vier Tage im Jahr liegen; Montag ist erster Tag der
3563 <term><varname>%w</varname></term>
3566 <para>Der Wochentag als Zahl zwischen 0 und 6 inklusive, wobei
3567 die 0 dem Sonntag entspricht.</para>
3572 <term><varname>%W</varname></term>
3575 <para>Die Wochennummer als Zahl zwischen 00 und 53 inklusive,
3576 wobei der erste Montag im Jahr das Startdatum von Woche 01
3582 <term><varname>%y</varname></term>
3585 <para>Das Jahr als zweistellige Zahl zwischen 00 und 99
3591 <term><varname>%Y</varname></term>
3594 <para>Das Jahr als vierstellige Zahl.</para>
3599 <term><varname>%%</varname></term>
3602 <para>Das Prozentzeichen selber.</para>
3607 <para>Anwendungsbeispiel für die Ausgabe, von welchem Monat und Jahr
3608 bis zu welchem Monat und Jahr die aktuelle Abrechnungsperiode dauert:
3609 <literal>Abrechnungszeitrum: <%period_start_date FORMAT=%m/%Y%>
3610 bis <%period_end_date FORMAT=%m/%Y%></literal></para>
3613 <sect2 id="features.periodic-invoices.reports">
3614 <title>Auflisten</title>
3616 <para>Unter Verkauf->Berichte->Aufträge finden sich zwei neue
3617 Checkboxen, "Wiederkehrende Rechnungen aktiv" und "Wiederkehrende
3618 Rechnungen inaktiv", mit denen man sich einen Überglick über die
3619 wiederkehrenden Rechnungen verschaffen kann.</para>
3622 <sect2 id="features.periodic-invoices.task-server">
3623 <title>Erzeugung der eigentlichen Rechnungen</title>
3625 <para>Die zeitliche und periodische Überprüfung, ob eine
3626 wiederkehrende Rechnung automatisch erstellt werden soll, geschieht
3627 durch den <link linkend="config.task-server">Taskserver</link>, einen
3628 externen Dienst, der automatisch beim Start des Servers gestartet
3629 werden sollte.</para>
3632 <sect2 id="features.periodic-invoices.create-for-current-month">
3633 <title>Erste Rechnung für aktuellen Monat erstellen</title>
3635 <para>Will man im laufenden Monat eine monatlich wiederkehrende
3636 Rechnung inkl. des laufenden Monats starten, stellt man das Startdatum
3637 auf den Monatsanfang und wartet ein paar Minuten, bis der Taskserver
3638 den neu konfigurieren Auftrag erkennt und daraus eine Rechnung
3639 generiert hat. Alternativ setzt man das Startdatum auf den
3640 Monatsersten des Folgemonats und erstellt die erste Rechnung direkt
3641 manuell über den Workflow.</para>
3645 <sect1 id="features.bank" xreflabel="bankerweiterung">
3646 <title>Bankerweiterung</title>
3648 <sect2 id="features.bank.introduction"
3649 xreflabel="Einführung in die Bankerweiterung">
3650 <title>Einführung</title>
3652 <para>Die Beschreibung der Bankerweiterung befindet sich derzeit noch
3653 im Wiki und soll von dort später hierhin übernommen werden:</para>
3656 url="http://redmine.kivitendo-premium.de/projects/forum/wiki/Bankerweiterung">http://redmine.kivitendo-premium.de/projects/forum/wiki/Bankerweiterung</ulink></para>
3660 <sect1 id="dokumentenvorlagen-und-variablen">
3661 <title>Dokumentenvorlagen und verfügbare Variablen</title>
3663 <sect2 id="dokumentenvorlagen-und-variablen.einführung">
3664 <title>Einführung</title>
3666 <para>Dies ist eine Auflistung der Standard-Dokumentenvorlagen und
3667 aller zur Bearbeitung verfügbaren Variablen. Eine Variable wird in
3668 einer Vorlage durch ihren Inhalt ersetzt, wenn sie in der Form
3669 <function><%variablenname%></function> verwendet wird. Für
3670 LaTeX- und HTML-Vorlagen kann man die Form dieser Tags auch verändern
3672 linkend="dokumentenvorlagen-und-variablen.tag-style"/>).</para>
3674 <para>kivitendo unterstützt LaTeX-, HTML- und OpenDocument-Vorlagen.
3675 Sofern es nicht ausdrücklich eingeschränkt wird, gilt das im Folgenden
3676 gesagte für alle Vorlagenarten.</para>
3678 <para>Insgesamt sind technisch gesehen eine ganze Menge mehr Variablen
3679 verfügbar als hier aufgelistet werden. Die meisten davon können
3680 allerdings innerhalb einer solchen Vorlage nicht sinnvoll verwendet
3681 werden. Wenn eine Auflistung dieser Variablen gewollt ist, so kann
3682 diese wie folgt erhalten werden:</para>
3686 <para><filename>SL/Form.pm</filename> öffnen und am Anfang die
3687 Zeile "<command>use Data::Dumper;</command>" einfügen.</para>
3691 <para>In <filename>Form.pm</filename> die Funktion
3692 <function>parse_template</function> suchen und hier die Zeile
3693 <command>print(STDERR Dumper($self));</command> einfügen.</para>
3697 <para>Einmal per Browser die gewünschte Vorlage "benutzen", z.B.
3698 ein PDF für eine Rechnung erzeugen.</para>
3702 <para>Im <filename>error.log</filename> Apache steht die Ausgabe
3703 der Variablen <varname>$self</varname> in der Form <varname>'key'
3704 => 'value',</varname>. Alle <varname>key</varname>s sind
3710 <sect2 id="dokumentenvorlagen-und-variablen.variablen-ausgeben">
3711 <title>Variablen ausgeben</title>
3713 <para>Um eine Variable auszugeben, müssen sie einfach nur zwischen die
3714 Tags geschrieben werden, also z.B.
3715 <varname><%variablenname%></varname>.</para>
3717 <para>Optional kann man auch mit Leerzeichen getrennte Flags angeben,
3718 die man aber nur selten brauchen wird. Die Syntax sieht also so aus:
3719 <varname><%variablenname FLAG1 FLAG2%></varname>. Momentan
3720 werden die folgenden Flags unterstützt:</para>
3724 <para><option>NOFORMAT</option> gilt nur für Zahlenwerte und gibt
3725 den Wert ohne Formatierung, also ohne Tausendertrennzeichen mit
3726 mit einem Punkt als Dezimaltrennzeichen aus. Nützlich z.B., wenn
3727 damit in der Vorlage z.B. von LaTeX gerechnet werden soll.</para>
3731 <para><option>NOESCAPE</option> unterdrückt das Escapen von
3732 Sonderzeichen für die Vorlagensprache. Wenn also in einer
3733 Variablen bereits gültiger LaTeX-Code steht und dieser von LaTeX
3734 auch ausgewertet und nicht wortwörtlich angezeigt werden soll, so
3735 ist dieses Flag sinnvoll.</para>
3739 <para>Beispiel:</para>
3741 <programlisting><%quototal NOFORMAT%></programlisting>
3744 <sect2 id="dokumentenvorlagen-und-variablen.verwendung-in-druckbefehlen">
3745 <title>Verwendung in Druckbefehlen</title>
3747 <para>In der Admininstration können Drucker definiert werden. Auch im
3748 dort eingebbaren Druckbefehl können die hier aufgelisteten Variablen
3749 und Kontrollstrukturen verwendet werden. Ihr Inhalt wird dabei nach
3750 den Regeln der gängigen Shells formatiert, sodass Sonderzeichen wie
3751 <function>`...`</function> nicht zu unerwünschtem Verhalten
3754 <para>Dies erlaubt z.B. die Definition eines Faxes als Druckerbefehl,
3755 für das die Telefonnummer eines Ansprechpartners als Teil der
3756 Kommandozeile verwendet wird. Für ein fiktives Kommando könnte das
3757 z.B. wie folgt aussehen:</para>
3759 <programlisting>send_fax --number <%if cp_phone2%><%cp_phone2%><%else%><%cp_phone1%><%end%></programlisting>
3762 <sect2 id="dokumentenvorlagen-und-variablen.tag-style"
3763 xreflabel="Anfang und Ende der Tags verändern">
3764 <title>Anfang und Ende der Tags verändern</title>
3766 <para>Der Standardstil für Tags sieht vor, dass ein Tag mit dem
3767 Kleinerzeichen und einem Prozentzeichen beginnt und mit dem
3768 Prozentzeichen und dem Größerzeichen endet, beispielsweise
3769 <function><%customer%></function>. Da diese Form aber z.B. in
3770 LaTeX zu Problemen führen kann, weil das Prozentzeichen dort
3771 Kommentare einleitet, kann pro HTML- oder LaTeX-Dokumentenvorlage der
3772 Stil umgestellt werden.</para>
3774 <para>Dazu werden in die Datei Zeilen geschrieben, die mit dem für das
3775 Format gültigen Kommentarzeichen anfangen, dann
3776 <function>config:</function> enthalten, die entsprechende Option
3777 setzen und bei HTML-Dokumentenvorlagen mit dem Kommentarendzeichen
3778 enden. Beispiel für LaTeX:</para>
3780 <programlisting>% config: tag-style=($ $)</programlisting>
3782 <para>Dies würde kivitendo dazu veranlassen, Variablen zu ersetzen,
3783 wenn sie wie folgt aussehen: <function>($customer$)</function>. Das
3784 äquivalente Beispiel für HTML-Dokumentenvorlagen sieht so aus:</para>
3786 <programlisting><!-- config: tag-style=($ $) --></programlisting>
3789 <sect2 id="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">
3790 <title>Zuordnung von den Dateinamen zu den Funktionen</title>
3792 <para>Diese folgende kurze Auflistung zeigt, welche Vorlage bei
3793 welcher Funktion ausgelesen wird. Dabei ist die Dateiendung
3794 "<filename>.ext</filename>" geeignet zu ersetzen:
3795 "<filename>.tex</filename>" für LaTeX-Vorlagen und
3796 "<filename>.odt</filename>" für OpenDocument-Vorlagen.</para>
3800 <term><filename>bin_list.ext</filename></term>
3803 <para>Lagerliste</para>
3808 <term><filename>check.ext</filename></term>
3816 <term><filename>invoice.ext</filename></term>
3819 <para>Rechnung</para>
3824 <term><filename>packing_list.ext</filename></term>
3827 <para>Packliste</para>
3832 <term><filename>pick_list.ext</filename></term>
3835 <para>Sammelliste</para>
3840 <term><filename>purchase_delivery_order.ext</filename></term>
3843 <para>Lieferschein (Einkauf)</para>
3848 <term><filename>purcharse_order.ext</filename></term>
3851 <para>Bestellung an Lieferanten</para>
3856 <term><filename>request_quotation.ext</filename></term>
3859 <para>Anfrage an Lieferanten</para>
3864 <term><filename>sales_delivery_order.ext</filename></term>
3867 <para>Lieferschein (Verkauf)</para>
3872 <term><filename>sales_order.ext</filename></term>
3875 <para>Bestellung</para>
3880 <term><filename>sales_quotation.ext</filename></term>
3883 <para>Angebot an Kunden</para>
3888 <term><filename>zahlungserinnerung.ext</filename></term>
3891 <para>Mahnung (Dateiname im Programm konfigurierbar)</para>
3896 <term><filename>zahlungserinnerung_invoice.ext</filename></term>
3899 <para>Rechnung über Mahngebühren (Dateiname im Programm
3900 konfigurierbar)</para>
3906 <sect2 id="dokumentenvorlagen-und-variablen.dateinamen-erweitert">
3907 <title>Sprache, Drucker und E-Mail</title>
3909 <para>Angeforderte Sprache und Druckerkürzel in den Dateinamen mit
3910 eingearbeitet. So wird aus der Vorlage
3911 <filename>sales_order.ext</filename> bei Sprache
3912 <function>de</function> und Druckerkürzel <function>lpr2</function>
3913 der Vorlagenname <filename>sales_order_de_lpr2.ext</filename>.
3914 Zusätzlich können für E-Mails andere Vorlagen erstellt werden, diese
3915 bekommen dann noch das Kürzel <filename>_email</filename>, der
3916 vollständige Vorlagenname wäre dann
3917 <filename>sales_order_email_de_lpr2.ext</filename>. In allen Fällen
3918 kann eine Standarddatei <filename>default.ext</filename> hinterlegt
3919 werden. Diese wird verwendet, wenn keine der anderen Varianten
3920 gefunden wird.</para>
3922 <para>Die vollständige Suchreihenfolge für einen Verkaufsauftrag mit
3923 der Sprache "de" und dem Drucker "lpr2", der per E-Mail im Format PDF
3924 verschickt wird, ist:</para>
3928 <para><filename>sales_order_email_de_lpr2.tex</filename></para>
3932 <para><filename>sales_order_de_lpr2.tex</filename></para>
3936 <para><filename>sales_order.tex</filename></para>
3940 <para><filename>default.tex</filename></para>
3944 <para>Die kurzen Varianten dieser Vorlagentitel müssen dann entweder
3945 Standardwerte anzeigen, oder die angeforderten Werte selbst auswerten,
3947 linkend="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"/>.</para>
3950 <sect2 id="dokumentenvorlagen-und-variablen.allgemeine-variablen">
3951 <title>Allgemeine Variablen, die in allen Vorlagen vorhanden
3954 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"
3955 xreflabel="Metainformationen zur angeforderten Vorlage">
3956 <title>Metainformationen zur angeforderten Vorlage</title>
3958 <para>Diese Variablen liefern Informationen darüber welche Variante
3959 einer Vorlage der Benutzer angefragt hat. Sie sind nützlich für
3960 Vorlagenautoren, die aus einer zentralen Layoutvorlage die einzelnen
3961 Formulare einbinden möchten.</para>
3965 <term><varname>template_meta.formname</varname></term>
3968 <para>Basisname der Vorlage. Identisch mit der <link
3969 linkend="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">Zurordnung
3970 zu den Dateinamen</link> ohne die Erweiterung. Ein
3971 Verkaufsauftrag enthält hier
3972 <constant>sales_order</constant>.</para>
3977 <term><varname>template_meta.language.description</varname></term>
3980 <para>Beschreibung der verwendeten Sprache</para>
3985 <term><varname>template_meta.language.template_code</varname></term>
3988 <para>Vorlagenkürzel der verwendeten Sprache, identisch mit
3989 dem Kürzel das im Dateinamen verwendetet wird.</para>
3994 <term><varname>template_meta.language.output_numberformat</varname></term>
3997 <para>Zahlenformat der verwendeten Sprache in der Form
3998 "<constant>1.000,00</constant>". Experimentell! Nur
3999 interessant für Vorlagen die mit unformatierten Werten
4005 <term><varname>template_meta.language.output_dateformat</varname></term>
4008 <para>Datumsformat der verwendeten Sprache in der Form
4009 "<constant>dd.mm.yyyy</constant>". Experimentell! Nur
4010 interessant für Vorlagen die mit unformatierten Werten
4016 <term><varname>template_meta.format</varname></term>
4019 <para>Das angeforderte Format. Kann im Moment die Werte
4020 <constant>pdf</constant>, <constant>postscript</constant>,
4021 <constant>html</constant>, <constant>opendocument</constant>,
4022 <constant>opendocument_pdf</constant> und
4023 <constant>excel</constant> enthalten.</para>
4028 <term><varname>template_meta.extension</varname></term>
4031 <para>Dateierweiterung, wie im Dateinamen. Wird aus
4032 <constant>format</constant> entschieden.</para>
4037 <term><varname>template_meta.media</varname></term>
4040 <para>Ausgabemedium. Kann zur Zeit die Werte
4041 <constant>screen</constant> für Bildschirm,
4042 <constant>email</constant> für E-Mail (triggert das
4043 <constant>_email</constant> Kürzel im Dateinamen),
4044 <constant>printer</constant> für Drucker, und
4045 <constant>queue</constant> für Warteschlange enthalten.</para>
4050 <term><varname>template_meta.printer.description</varname></term>
4053 <para>Beschreibung des ausgewählten Druckers</para>
4058 <term><varname>template_meta.printer.template_code</varname></term>
4061 <para>Vorlagenürzel des ausgewählten Druckers, identisch mit
4062 dem Kürzel das im Dateinamen verwendetet wird.</para>
4067 <term><varname>template_meta.tmpfile</varname></term>
4070 <para>Datei-Prefix für temporäre Dateien.</para>
4076 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.kunden-lieferanten">
4077 <title>Stammdaten von Kunden und Lieferanten</title>
4081 <term><varname>account_number</varname></term>
4084 <para>Kontonummer</para>
4089 <term><varname>bank</varname></term>
4092 <para>Name der Bank</para>
4097 <term><varname>bank_code</varname></term>
4100 <para>Bankleitzahl</para>
4105 <term><varname>bic</varname></term>
4108 <para>Bank-Identifikations-Code (Bank Identifier Code,
4114 <term><varname>business</varname></term>
4117 <para>Kunden-/Lieferantentyp</para>
4122 <term><varname>city</varname></term>
4130 <term><varname>contact</varname></term>
4133 <para>Kontakt</para>
4138 <term><varname>country</varname></term>
4146 <term><varname>c_vendor_id</varname></term>
4149 <para>Lieferantennummer beim Kunden (nur Kunden)</para>
4154 <term><varname>v_customer_id</varname></term>
4157 <para>Kundennummer beim Lieferanten (nur Lieferanten)</para>
4162 <term><varname>cp_email</varname></term>
4165 <para>Email des Ansprechpartners</para>
4170 <term><varname>cp_givenname</varname></term>
4173 <para>Vorname des Ansprechpartners</para>
4178 <term><varname>cp_greeting</varname></term>
4181 <para>Anrede des Ansprechpartners</para>
4186 <term><varname>cp_name</varname></term>
4189 <para>Name des Ansprechpartners</para>
4194 <term><varname>cp_phone1</varname></term>
4197 <para>Telefonnummer 1 des Ansprechpartners</para>
4202 <term><varname>cp_phone2</varname></term>
4205 <para>Telefonnummer 2 des Ansprechpartners</para>
4210 <term><varname>cp_title</varname></term>
4213 <para>Titel des Ansprechpartners</para>
4218 <term><varname>creditlimit</varname></term>
4221 <para>Kreditlimit</para>
4226 <term><varname>customeremail</varname></term>
4229 <para>Email des Kunden; nur für Kunden</para>
4234 <term><varname>customerfax</varname></term>
4237 <para>Faxnummer des Kunden; nur für Kunden</para>
4242 <term><varname>customernotes</varname></term>
4245 <para>Bemerkungen beim Kunden; nur für Kunden</para>
4250 <term><varname>customernumber</varname></term>
4253 <para>Kundennummer; nur für Kunden</para>
4258 <term><varname>customerphone</varname></term>
4261 <para>Telefonnummer des Kunden; nur für Kunden</para>
4266 <term><varname>discount</varname></term>
4274 <term><varname>email</varname></term>
4277 <para>Emailadresse</para>
4282 <term><varname>fax</varname></term>
4285 <para>Faxnummer</para>
4290 <term><varname>gln</varname></term>
4293 <para>GLN (Globale Lokationsnummer)</para>
4298 <term><varname>greeting</varname></term>
4306 <term><varname>homepage</varname></term>
4309 <para>Homepage</para>
4314 <term><varname>iban</varname></term>
4317 <para>Internationale Kontonummer (International Bank Account
4318 Number, IBAN)</para>
4323 <term><varname>language</varname></term>
4326 <para>Sprache</para>
4331 <term><varname>name</varname></term>
4334 <para>Firmenname</para>
4339 <term><varname>payment_description</varname></term>
4342 <para>Name der Zahlart</para>
4347 <term><varname>payment_terms</varname></term>
4350 <para>Zahlungskonditionen</para>
4355 <term><varname>phone</varname></term>
4358 <para>Telefonnummer</para>
4363 <term><varname>shiptocity</varname></term>
4366 <para>Stadt (Lieferadresse) <link
4367 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4372 <term><varname>shiptocontact</varname></term>
4375 <para>Kontakt (Lieferadresse) <link
4376 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4381 <term><varname>shiptocountry</varname></term>
4384 <para>Land (Lieferadresse) <link
4385 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4390 <term><varname>shiptodepartment_1</varname></term>
4393 <para>Abteilung 1 (Lieferadresse) <link
4394 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4399 <term><varname>shiptodepartment_2</varname></term>
4402 <para>Abteilung 2 (Lieferadresse) <link
4403 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4408 <term><varname>shiptoemail</varname></term>
4411 <para>Email (Lieferadresse) <link
4412 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4417 <term><varname>shiptofax</varname></term>
4420 <para>Fax (Lieferadresse) <link
4421 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4426 <term><varname>shiptogln</varname></term>
4429 <para>GLN (Globale Lokationsnummer) (Lieferadresse) <link
4430 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4435 <term><varname>shiptoname</varname></term>
4438 <para>Firmenname (Lieferadresse) <link
4439 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4444 <term><varname>shiptophone</varname></term>
4447 <para>Telefonnummer (Lieferadresse) <link
4448 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4453 <term><varname>shiptostreet</varname></term>
4456 <para>Straße und Hausnummer (Lieferadresse) <link
4457 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4462 <term><varname>shiptozipcode</varname></term>
4465 <para>Postleitzahl (Lieferadresse) <link
4466 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4471 <term><varname>street</varname></term>
4474 <para>Straße und Hausnummer</para>
4479 <term><varname>taxnumber</varname></term>
4482 <para>Steuernummer</para>
4487 <term><varname>ustid</varname></term>
4490 <para>Umsatzsteuer-Identifikationsnummer</para>
4495 <term><varname>vendoremail</varname></term>
4498 <para>Email des Lieferanten; nur für Lieferanten</para>
4503 <term><varname>vendorfax</varname></term>
4506 <para>Faxnummer des Lieferanten; nur für Lieferanten</para>
4511 <term><varname>vendornotes</varname></term>
4514 <para>Bemerkungen beim Lieferanten; nur für Lieferanten</para>
4519 <term><varname>vendornumber</varname></term>
4522 <para>Lieferantennummer; nur für Lieferanten</para>
4527 <term><varname>vendorphone</varname></term>
4530 <para>Telefonnummer des Lieferanten; nur für
4536 <term><varname>zipcode</varname></term>
4539 <para>Postleitzahl</para>
4544 <note id="dokumentenvorlagen-und-variablen.anmerkung-shipto">
4545 <para>Anmerkung: Sind die <varname>shipto*</varname>-Felder in den
4546 Stammdaten nicht eingetragen, so haben die Variablen
4547 <varname>shipto*</varname> den gleichen Wert wie die die
4548 entsprechenden Variablen der Lieferdaten. Das bedeutet, dass sich
4549 einige <varname>shipto*</varname>-Variablen so nicht in den
4550 Stammdaten wiederfinden sondern schlicht Kopien der
4551 Lieferdatenvariablen sind (z.B.
4552 <varname>shiptocontact</varname>).</para>
4556 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-bearbeiter">
4557 <title>Informationen über den Bearbeiter</title>
4561 <term><varname>employee_address</varname></term>
4564 <para>Adressfeld</para>
4569 <term><varname>employee_businessnumber</varname></term>
4572 <para>Firmennummer</para>
4577 <term><varname>employee_company</varname></term>
4580 <para>Firmenname</para>
4585 <term><varname>employee_co_ustid</varname></term>
4588 <para>Usatzsteuer-Identifikationsnummer</para>
4593 <term><varname>employee_duns</varname></term>
4596 <para>DUNS-Nummer</para>
4601 <term><varname>employee_email</varname></term>
4609 <term><varname>employee_fax</varname></term>
4617 <term><varname>employee_name</varname></term>
4620 <para>voller Name</para>
4625 <term><varname>employee_signature</varname></term>
4628 <para>Signatur</para>
4633 <term><varname>employee_taxnumber</varname></term>
4636 <para>Steuernummer</para>
4641 <term><varname>employee_tel</varname></term>
4644 <para>Telefonnummer</para>
4650 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-verkaeufer">
4651 <title>Informationen über den Verkäufer</title>
4655 <term><varname>salesman_address</varname></term>
4658 <para>Adressfeld</para>
4663 <term><varname>salesman_businessnumber</varname></term>
4666 <para>Firmennummer</para>
4671 <term><varname>salesman_company</varname></term>
4674 <para>Firmenname</para>
4679 <term><varname>salesman_co_ustid</varname></term>
4682 <para>Usatzsteuer-Identifikationsnummer</para>
4687 <term><varname>salesman_duns</varname></term>
4690 <para>DUNS-Nummer</para>
4695 <term><varname>salesman_email</varname></term>
4703 <term><varname>salesman_fax</varname></term>
4711 <term><varname>salesman_name</varname></term>
4714 <para>voller Name</para>
4719 <term><varname>salesman_signature</varname></term>
4722 <para>Signatur</para>
4727 <term><varname>salesman_taxnumber</varname></term>
4730 <para>Steuernummer</para>
4735 <term><varname>salesman_tel</varname></term>
4738 <para>Telefonnummer</para>
4744 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-steuern">
4745 <title>Variablen für die einzelnen Steuern</title>
4749 <term><varname>tax</varname></term>
4757 <term><varname>taxbase</varname></term>
4760 <para>zu versteuernder Betrag</para>
4765 <term><varname>taxdescription</varname></term>
4768 <para>Name der Steuer</para>
4773 <term><varname>taxrate</varname></term>
4776 <para>Steuersatz</para>
4782 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-lieferbedingungen">
4783 <title>Variablen für Lieferbedingungen</title>
4787 <term><varname>delivery_term</varname></term>
4790 <para>Datenbank-Objekt der Lieferbedingung</para>
4795 <term><varname>delivery_term.description</varname></term>
4798 <para>Beschreibung der Lieferbedingung</para>
4803 <term><varname>delivery_term.description_long</varname></term>
4806 <para>Langtext bzw. übersetzter Langtext der
4807 Lieferbedingung</para>
4814 <sect2 id="dokumentenvorlagen-und-variablen.invoice">
4815 <title>Variablen in Rechnungen</title>
4817 <sect3 id="dokumentenvorlagen-und-variablen.invoice-allgemein">
4818 <title>Allgemeine Variablen</title>
4822 <term><varname>creditremaining</varname></term>
4825 <para>Verbleibender Kredit</para>
4830 <term><varname>currency</varname></term>
4833 <para>Währung</para>
4838 <term><varname>cusordnumber</varname></term>
4841 <para>Bestellnummer beim Kunden</para>
4846 <term><varname>deliverydate</varname></term>
4849 <para>Lieferdatum</para>
4854 <term><varname>duedate</varname></term>
4857 <para>Fälligkeitsdatum</para>
4862 <term><varname>globalprojectnumber</varname></term>
4865 <para>Projektnummer des ganzen Beleges</para>
4870 <term><varname>globalprojectdescription</varname></term>
4873 <para>Projekbeschreibung des ganzen Beleges</para>
4878 <term><varname>intnotes</varname></term>
4881 <para>Interne Bemerkungen</para>
4886 <term><varname>invdate</varname></term>
4889 <para>Rechnungsdatum</para>
4894 <term><varname>invnumber</varname></term>
4897 <para>Rechnungsnummer</para>
4902 <term><varname>invtotal</varname></term>
4905 <para>gesamter Rechnungsbetrag</para>
4910 <term><varname>notes</varname></term>
4913 <para>Bemerkungen der Rechnung</para>
4918 <term><varname>orddate</varname></term>
4921 <para>Auftragsdatum</para>
4926 <term><varname>ordnumber</varname></term>
4929 <para>Auftragsnummer, wenn die Rechnung aus einem Auftrag
4930 erstellt wurde</para>
4935 <term><varname>payment_description</varname></term>
4938 <para>Name der Zahlart</para>
4943 <term><varname>payment_terms</varname></term>
4946 <para>Zahlungskonditionen</para>
4951 <term><varname>quodate</varname></term>
4954 <para>Angebotsdatum</para>
4959 <term><varname>quonumber</varname></term>
4962 <para>Angebotsnummer</para>
4967 <term><varname>rounding</varname></term>
4970 <para>Betrag, um den <varname>invtotal</varname> gerundet
4971 wurde (kann positiv oder negativ sein)</para>
4976 <term><varname>shippingpoint</varname></term>
4979 <para>Versandort</para>
4984 <term><varname>shipvia</varname></term>
4987 <para>Transportmittel</para>
4992 <term><varname>subtotal</varname></term>
4995 <para>Zwischensumme aller Posten ohne Steuern</para>
5000 <term><varname>total</varname></term>
5003 <para>Restsumme der Rechnung (Summe abzüglich bereits
5004 bezahlter Posten)</para>
5009 <term><varname>transaction_description</varname></term>
5012 <para>Vorgangsbezeichnung</para>
5017 <term><varname>transdate</varname></term>
5020 <para>Auftragsdatum wenn die Rechnung aus einem Auftrag
5021 erstellt wurde</para>
5027 <sect3 id="dokumentenvorlagen-und-variablen.invoice-posten">
5028 <title>Variablen für jeden Posten auf der Rechnung</title>
5032 <term><varname>bin</varname></term>
5035 <para>Stellage</para>
5040 <term><varname>description</varname></term>
5043 <para>Artikelbeschreibung</para>
5048 <term><varname>cusordnumber_oe</varname></term>
5051 <para>Bestellnummer des Kunden aus dem Auftrag, aus dem der
5052 Posten ursprünglich stammt (nur Verkauf)</para>
5057 <term><varname>discount</varname></term>
5060 <para>Rabatt als Betrag</para>
5065 <term><varname>discount_sub</varname></term>
5068 <para>Zwischensumme mit Rabatt</para>
5073 <term><varname>donumber_do</varname></term>
5076 <para>Lieferscheinnummer des Lieferscheins, aus dem die
5077 Position ursprünglich stammt, wenn die Rechnung im Rahmen des
5078 Workflows aus einem Lieferschein erstellt wurde.</para>
5083 <term><varname>drawing</varname></term>
5086 <para>Zeichnung</para>
5091 <term><varname>ean</varname></term>
5094 <para>EAN-Code</para>
5099 <term><varname>image</varname></term>
5107 <term><varname>linetotal</varname></term>
5110 <para>Zeilensumme (Anzahl * Einzelpreis)</para>
5115 <term><varname>longdescription</varname></term>
5118 <para>Langtext</para>
5123 <term><varname>microfiche</varname></term>
5126 <para>Mikrofilm</para>
5131 <term><varname>netprice</varname></term>
5134 <para>Alternative zu <varname>sellprice</varname>, aber
5135 <varname>netprice</varname> entspricht dem effektiven
5136 Einzelpreis und beinhaltet Zeilenrabatt und Preisfaktor.
5137 <varname>netprice</varname> wird rückgerechnet aus Zeilensumme
5138 / Menge. Diese Variable ist nützlich, wenn man den gewährten
5139 Rabatt in der Druckvorlage nicht anzeigen möchte, aber Menge *
5140 Einzelpreis trotzdem die angezeigte Zeilensumme ergeben soll.
5141 <varname>netprice</varname> hat nichts mit Netto/Brutto im
5142 Sinne von Steuern zu tun.</para>
5147 <term><varname>nodiscount_linetotal</varname></term>
5150 <para>Zeilensumme ohne Rabatt</para>
5155 <term><varname>nodiscount_sub</varname></term>
5158 <para>Zwischensumme ohne Rabatt</para>
5163 <term><varname>number</varname></term>
5166 <para>Artikelnummer</para>
5171 <term><varname>ordnumber_oe</varname></term>
5174 <para>Auftragsnummer des Originalauftrags, aus dem der Posten
5175 ursprünglich stammt. Nützlich, wenn die Rechnung aus mehreren
5176 Lieferscheinen zusammengefasst wurde, oder wenn zwischendurch
5177 eine Sammelauftrag aus mehreren Aufträgen erstellt wurde. In
5178 letzterem Fall wird die unsprüngliche Auftragsnummer
5184 <term><varname>p_discount</varname></term>
5187 <para>Rabatt in Prozent</para>
5192 <term><varname>partnotes</varname></term>
5195 <para>Die beim Artikel gespeicherten Bemerkungen</para>
5200 <term><varname>partsgroup</varname></term>
5203 <para>Warengruppe</para>
5208 <term><varname>price_factor</varname></term>
5211 <para>Der Preisfaktor als Zahl, sofern einer eingestellt
5217 <term><varname>price_factor_name</varname></term>
5220 <para>Der Name des Preisfaktors, sofern einer eingestellt
5226 <term><varname>projectnumber</varname></term>
5229 <para>Projektnummer</para>
5234 <term><varname>projectdescription</varname></term>
5237 <para>Projektbeschreibung</para>
5242 <term><varname>qty</varname></term>
5250 <term><varname>reqdate</varname></term>
5253 <para>Lieferdatum</para>
5258 <term><varname>runningnumber</varname></term>
5261 <para>Position auf der Rechnung (1, 2, 3...)</para>
5266 <term><varname>sellprice</varname></term>
5269 <para>Verkaufspreis</para>
5274 <term><varname>serialnumber</varname></term>
5277 <para>Seriennummer</para>
5282 <term><varname>tax_rate</varname></term>
5285 <para>Steuersatz</para>
5290 <term><varname>transdate_do</varname></term>
5293 <para>Datum des Lieferscheins, wenn die Rechnung im Rahmen des
5294 Workflows aus einem Lieferschein stammte.</para>
5299 <term><varname>transdate_oe</varname></term>
5302 <para>Datum des Auftrags, wenn die Rechnung im Rahmen des
5303 Workflows aus einem Auftrag erstellt wurde. Wenn es
5304 Sammelaufträge gab wird das Datum des ursprünglichen Auftrags
5310 <term><varname>transdate_quo</varname></term>
5313 <para>Datum des Angebots, wenn die Position im Rahmen des
5314 Workflows aus einem Angebot stammte.</para>
5319 <term><varname>unit</varname></term>
5322 <para>Einheit</para>
5327 <term><varname>weight</varname></term>
5330 <para>Gewicht</para>
5335 <para>Für jeden Posten gibt es ein Unterarray mit den Informationen
5336 über Lieferanten und Lieferantenartikelnummer. Diese müssen mit
5337 einer <function>foreach</function>-Schleife ausgegeben werden, da
5338 für jeden Artikel mehrere Lieferanteninformationen hinterlegt sein
5339 können. Die Variablen dafür lauten:</para>
5343 <term><varname>make</varname></term>
5346 <para>Lieferant</para>
5351 <term><varname>model</varname></term>
5354 <para>Lieferantenartikelnummer</para>
5360 <sect3 id="dokumentenvorlagen-und-variablen.invoice-zahlungen">
5361 <title>Variablen für die einzelnen Zahlungseingänge</title>
5365 <term><varname>payment</varname></term>
5373 <term><varname>paymentaccount</varname></term>
5381 <term><varname>paymentdate</varname></term>
5389 <term><varname>paymentmemo</varname></term>
5397 <term><varname>paymentsource</varname></term>
5406 <sect3 id="dokumentenvorlagen-und-variablen.benutzerdefinierte-variablen-vc">
5407 <title>Benutzerdefinierte Kunden- und Lieferantenvariablen</title>
5409 <para>Die vom Benutzer definierten Variablen für Kunden und
5410 Lieferanten stehen beim Ausdruck von Einkaufs- und Verkaufsbelegen
5411 ebenfalls zur Verfügung. Ihre Namen setzen sich aus dem Präfix
5412 <varname>vc_cvar_</varname> und dem vom Benutzer festgelegten
5413 Variablennamen zusammen.</para>
5415 <para>Beispiel: Der Benutzer hat eine Variable namens
5416 <varname>number_of_employees</varname> definiert, die die Anzahl der
5417 Mitarbeiter des Unternehmens enthält. Diese Variable steht dann
5418 unter dem Namen <varname>vc_cvar_number_of_employees</varname> zur
5421 <para>Die benutzerdefinierten Variablen der Lieferadressen stehen
5422 unter einem ähnlichen Namensschema zur Verfügung. Hier lautet der
5423 Präfix <varname>shiptocvar_</varname>.</para>
5425 <para>Analog stehen die benutzerdefinierten Variablen für
5426 Ansprechpersonen mit dem Namenspräfix <varname>cp_cvar_</varname>
5427 zur Verfügung.</para>
5431 <sect2 id="dokumentenvorlagen-und-variablen.dunning">
5432 <title>Variablen in Mahnungen und Rechnungen über Mahngebühren</title>
5434 <sect3 id="dokumentenvorlagen-und-variablen.dunning-vorlagennamen">
5435 <title>Namen der Vorlagen</title>
5437 <para>Die Namen der Vorlagen werden im System-Menü vom Benutzer
5438 eingegeben. Wird für ein Mahnlevel die Option zur automatischen
5439 Erstellung einer Rechnung über die Mahngebühren und Zinsen
5440 aktiviert, so wird der Name der Vorlage für diese Rechnung aus dem
5441 Vorlagenname für diese Mahnstufe mit dem Zusatz
5442 <constant>_invoice</constant> gebildet. Weiterhin werden die Kürzel
5443 für die ausgewählte Sprache und den ausgewählten Drucker
5447 <sect3 id="dokumentenvorlagen-und-variablen.dunning-allgemein">
5448 <title>Allgemeine Variablen in Mahnungen</title>
5450 <para>Die Variablen des Bearbeiters, bzw. Verkäufers stehen wie
5451 gewohnt als <varname>employee_...</varname> bzw.
5452 <varname>salesman_...</varname> zur Verfügung. Werden mehrere
5453 Rechnungen in einer Mahnung zusammengefasst, so werden die Metadaten
5454 (Bearbeiter, Abteilung, etc) der ersten angemahnten Rechnung im
5455 Ausdruck genommen.</para>
5457 <para>Die Adressdaten des Kunden stehen als Variablen
5458 <varname>name</varname>, <varname>street</varname>,
5459 <varname>zipcode</varname>, <varname>city</varname>,
5460 <varname>country</varname>, <varname>department_1</varname>,
5461 <varname>department_2</varname>, und <varname>email</varname> zur
5462 Verfügung. Der Ansprechpartner <varname>cp_...</varname> steht auch
5463 zu Verfügung, wird allerdings auch nur von der ersten angemahnten
5464 Rechnung (s.o.) genommen.</para>
5466 <para>Weitere Variablen beinhalten:</para>
5470 <term><varname>dunning_date</varname></term>
5473 <para>Datum der Mahnung</para>
5478 <term><varname>dunning_duedate</varname></term>
5481 <para>Fälligkeitsdatum für diese Mahhnung</para>
5486 <term><varname>dunning_id</varname></term>
5489 <para>Mahnungsnummer</para>
5494 <term><varname>fee</varname></term>
5497 <para>Kumulative Mahngebühren</para>
5502 <term><varname>interest_rate</varname></term>
5505 <para>Zinssatz per anno in Prozent</para>
5510 <term><varname>total_amount</varname></term>
5513 <para>Gesamter noch zu zahlender Betrag als
5514 <function>fee</function> + <function>total_interest</function>
5515 + <function>total_open_amount</function></para>
5520 <term><varname>total_interest</varname></term>
5523 <para>Zinsen per anno über alle Rechnungen</para>
5528 <term><varname>total_open_amount</varname></term>
5531 <para>Summe über alle offene Beträge der Rechnungen</para>
5537 <sect3 id="dokumentenvorlagen-und-variablen.dunning-details">
5538 <title>Variablen für jede gemahnte Rechnung in einer Mahnung</title>
5542 <term><varname>dn_amount</varname></term>
5545 <para>Rechnungssumme (brutto)</para>
5550 <term><varname>dn_duedate</varname></term>
5553 <para>Originales Fälligkeitsdatum der Rechnung</para>
5558 <term><varname>dn_dunning_date</varname></term>
5561 <para>Datum der Mahnung</para>
5566 <term><varname>dn_dunning_duedate</varname></term>
5569 <para>Fälligkeitsdatum der Mahnung</para>
5574 <term><varname>dn_fee</varname></term>
5577 <para>Kummulative Mahngebühr</para>
5582 <term><varname>dn_interest</varname></term>
5585 <para>Zinsen per anno für diese Rechnung</para>
5590 <term><varname>dn_invnumber</varname></term>
5593 <para>Rechnungsnummer</para>
5598 <term><varname>dn_linetotal</varname></term>
5601 <para>Noch zu zahlender Betrag (ergibt sich aus
5602 <varname>dn_open_amount</varname> + <varname>dn_fee</varname>
5603 + <varname>dn_interest</varname>)</para>
5608 <term><varname>dn_netamount</varname></term>
5611 <para>Rechnungssumme (netto)</para>
5616 <term><varname>dn_open_amount</varname></term>
5619 <para>Offener Rechnungsbetrag</para>
5624 <term><varname>dn_ordnumber</varname></term>
5627 <para>Bestellnummer</para>
5632 <term><varname>dn_transdate</varname></term>
5635 <para>Rechnungsdatum</para>
5640 <term><varname>dn_curr</varname></term>
5643 <para>Währung, in der die Rechnung erstellt wurde. (Die
5644 Rechnungsbeträge sind aber immer in der Hauptwährung)</para>
5650 <sect3 id="dokumentenvorlagen-und-variablen.dunning-invoice">
5651 <title>Variablen in automatisch erzeugten Rechnungen über
5652 Mahngebühren</title>
5654 <para>Die Variablen des Verkäufers stehen wie gewohnt als
5655 <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
5656 Kunden stehen als Variablen <varname>name</varname>,
5657 <varname>street</varname>, <varname>zipcode</varname>,
5658 <varname>city</varname>, <varname>country</varname>,
5659 <varname>department_1</varname>, <varname>department_2</varname>,
5660 und <varname>email</varname> zur Verfügung.</para>
5662 <para>Weitere Variablen beinhalten:</para>
5666 <term><varname>duedate</varname></term>
5669 <para>Fälligkeitsdatum der Rechnung</para>
5674 <term><varname>dunning_id</varname></term>
5677 <para>Mahnungsnummer</para>
5682 <term><varname>fee</varname></term>
5685 <para>Mahngebühren</para>
5690 <term><varname>interest</varname></term>
5698 <term><varname>invamount</varname></term>
5701 <para>Rechnungssumme (ergibt sich aus <varname>fee</varname> +
5702 <varname>interest</varname>)</para>
5707 <term><varname>invdate</varname></term>
5710 <para>Rechnungsdatum</para>
5715 <term><varname>invnumber</varname></term>
5718 <para>Rechnungsnummer</para>
5725 <sect2 id="dokumentenvorlagen-und-variablen.andere-vorlagen">
5726 <title>Variablen in anderen Vorlagen</title>
5729 <title>Einführung</title>
5731 <para>Die Variablen in anderen Vorlagen sind ähnlich wie in der
5732 Rechnung. Allerdings heißen die Variablen, die mit
5733 <varname>inv</varname> beginnen, jetzt anders. Bei den Angeboten
5734 fangen sie mit <varname>quo</varname> für "quotation" an:
5735 <varname>quodate</varname> für Angebotsdatum etc. Bei Bestellungen
5736 wiederum fangen sie mit <varname>ord</varname> für "order" an:
5737 <varname>ordnumber</varname> für Bestellnummer etc.</para>
5739 <para>Manche Variablen sind in anderen Vorlagen hingegen gar nicht
5740 vorhanden wie z.B. die für bereits verbuchte Zahlungseingänge. Dies
5741 sind Variablen, die vom Geschäftsablauf her in der entsprechenden
5742 Vorlage keine Bedeutung haben oder noch nicht belegt sein
5745 <para>Im Folgenden werden nur wichtige Unterschiede zu den Variablen
5746 in Rechnungen aufgeführt.</para>
5749 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-quotations">
5750 <title>Angebote und Preisanfragen</title>
5754 <term><varname>quonumber</varname></term>
5757 <para>Angebots- bzw. Anfragenummer</para>
5762 <term><varname>reqdate</varname></term>
5765 <para>Gültigkeitsdatum (bei Angeboten) bzw. Lieferdatum (bei
5766 Preisanfragen)</para>
5771 <term><varname>transdate</varname></term>
5774 <para>Angebots- bzw. Anfragedatum</para>
5780 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-orders">
5781 <title>Auftragsbestätigungen und Lieferantenaufträge</title>
5785 <term><varname>ordnumber</varname></term>
5788 <para>Auftragsnummer</para>
5793 <term><varname>reqdate</varname></term>
5796 <para>Lieferdatum</para>
5801 <term><varname>transdate</varname></term>
5804 <para>Auftragsdatum</para>
5810 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-delivery-orders">
5811 <title>Lieferscheine (Verkauf und Einkauf)</title>
5815 <term><varname>cusordnumber</varname></term>
5818 <para>Bestellnummer des Kunden (im Verkauf) bzw. Bestellnummer
5819 des Lieferanten (im Einkauf)</para>
5824 <term><varname>donumber</varname></term>
5827 <para>Lieferscheinnummer</para>
5832 <term><varname>transdate</varname></term>
5835 <para>Lieferscheindatum</para>
5840 <para>Für jede Position eines Lieferscheines gibt es ein Unterarray
5841 mit den Informationen darüber, von welchem Lager und Lagerplatz aus
5842 die Waren verschickt wurden (Verkaufslieferscheine) bzw. auf welchen
5843 Lagerplatz sie eingelagert wurden. Diese müssen mittels einer
5844 <function>foreach</function>-Schleife ausgegeben werden. Diese
5845 Variablen sind:</para>
5849 <term><varname>si_bin</varname></term>
5852 <para>Lagerplatz</para>
5857 <term><varname>si_chargenumber</varname></term>
5860 <para>Chargennummer</para>
5865 <term><varname>si_bestbefore</varname></term>
5868 <para>Mindesthaltbarkeit</para>
5873 <term><varname>si_number</varname></term>
5876 <para>Artikelnummer</para>
5881 <term><varname>si_qty</varname></term>
5884 <para>Anzahl bzw. Menge</para>
5889 <term><varname>si_runningnumber</varname></term>
5892 <para>Positionsnummer (1, 2, 3 etc)</para>
5897 <term><varname>si_unit</varname></term>
5900 <para>Einheit</para>
5905 <term><varname>si_warehouse</varname></term>
5914 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-statement">
5915 <title>Variablen für Sammelrechnung</title>
5919 <term><varname>c0total</varname></term>
5922 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit < 30
5928 <term><varname>c30total</varname></term>
5931 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 30
5932 und < 60 Tage</para>
5937 <term><varname>c60total</varname></term>
5940 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 60
5941 und < 90 Tage</para>
5946 <term><varname>c90total</varname></term>
5949 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 90
5955 <term><varname>total</varname></term>
5958 <para>Gesamtbetrag aller Rechnungen</para>
5963 <para>Variablen für jede Rechnungsposition in Sammelrechnung:</para>
5967 <term><varname>invnumber</varname></term>
5970 <para>Rechnungsnummer</para>
5975 <term><varname>invdate</varname></term>
5978 <para>Rechnungsdatum</para>
5983 <term><varname>duedate</varname></term>
5986 <para>Fälligkeitsdatum</para>
5991 <term><varname>amount</varname></term>
5994 <para>Summe der Rechnung</para>
5999 <term><varname>open</varname></term>
6002 <para>Noch offener Betrag der Rechnung</para>
6007 <term><varname>c0</varname></term>
6010 <para>Noch offener Rechnungsbetrag mit Fälligkeit < 30
6016 <term><varname>c30</varname></term>
6019 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 30 und
6025 <term><varname>c60</varname></term>
6028 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 60 und
6034 <term><varname>c90</varname></term>
6037 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 90
6045 <sect2 id="dokumentenvorlagen-und-variablen.bloecke">
6046 <title>Blöcke, bedingte Anweisungen und Schleifen</title>
6048 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.einfuehrung">
6049 <title>Einführung</title>
6051 <para>Der Parser kennt neben den Variablen einige weitere
6052 Konstrukte, die gesondert behandelt werden. Diese sind wie
6053 Variablennamen in spezieller Weise markiert:
6054 <command><%anweisung%> ... <%end%></command></para>
6056 <para>Anmerkung zum <command><%end%></command>: Der besseren
6057 Verständlichkeit halber kann man nach dem <command>end</command>
6058 noch beliebig weitere Wörter schreiben, um so zu markieren, welche
6059 Anweisung (z.B. <command>if</command> oder
6060 <command>foreach</command>) damit abgeschlossen wird.</para>
6062 <para>Beispiel: Lautet der Beginn eines Blockes z.B.
6063 <command><%if type == "sales_quotation"%></command>, so könnte
6064 er mit <command><%end%></command> genauso abgeschlossen werden
6065 wie mit <command><%end if%></command> oder auch
6066 <command><%end type == "sales_quotation"%></command>.</para>
6069 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.if">
6070 <title>Der if-Block</title>
6072 <programlisting><%if variablenname%>
6074 <%end%></programlisting>
6076 <para>Eine normale "if-then"-Bedingung. Die Zeilen zwischen dem "if"
6077 und dem "end" werden nur ausgegeben, wenn die Variable
6078 <varname>variablenname</varname> gesetzt und ungleich 0 ist.</para>
6080 <para>Handelt es sich bei der benannten Variable um ein Array, also
6081 um einen Variablennamen, über den man mit <command><%foreach
6082 variablenname%></command> iteriert, so wird mit diesem Konstrukt
6083 darauf getestet, ob das Array Elemente enthält. Somit würde im
6084 folgenden Beispiel nur dann eine Liste von Zahlungseingängen samt
6085 ihrer Überschrift "Zahlungseingänge" ausgegeben, wenn tatsächlich
6086 welche getätigt wurden:</para>
6088 <programlisting><%if payment%>
6090 <%foreach payment%>
6091 Am <%paymentdate%>: <%payment%> €
6092 <%end foreach%>
6093 <%end if%></programlisting>
6095 <para>Die Bedingung kann auch negiert werden, indem das Wort
6096 <function>not</function> nach dem <filename>if</filename> verwendet
6097 wird. Beispiel:</para>
6099 <programlisting><%if not cp_greeting%>
6101 <%end%></programlisting>
6103 <para>Zusätzlich zu dem einfachen Test, ob eine Variable gesetzt ist
6104 oder nicht, bietet dieser Block auch die Möglichkeit, den Inhalt
6105 einer Variablen mit einer festen Zeichenkette oder einer anderen
6106 Variablen zu vergleichen. Ob der Vergleich mit einer Zeichenkette
6107 oder einer anderen Variablen vorgenommen wird, hängt davon ab, ob
6108 die rechte Seite des Vergleichsoperators in Anführungszeichen
6109 gesetzt wird (Vergleich mit Zeichenkette) oder nicht (Vergleich mit
6110 anderer Variablen). Zwei Beispiele, die beide Vergleiche
6113 <programlisting><%if var1 == "Wert"%></programlisting>
6115 <para>Testet die Variable <varname>var1</varname> auf
6116 übereinstimmung mit der Zeichenkette <constant>Wert</constant>.
6117 Mittels <function>!=</function> anstelle von <function>==</function>
6118 würde auf Ungleichheit getestet.</para>
6120 <programlisting><%if var1 == var2%></programlisting>
6122 <para>Testet die Variable <varname>var1</varname> auf
6123 übereinstimmung mit der Variablen <varname>var2</varname>. Mittel
6124 <function>!=</function> anstelle von <function>==</function> würde
6125 auf Ungleichheit getestet.</para>
6127 <para>Erfahrere Benutzer können neben der Tests auf (Un-)Gleichheit
6128 auch Tests auf Übereinstimmung mit regulären Ausdrücken ohne
6129 Berücksichtung der Groß- und Kleinschreibung durchführen. Dazu dient
6130 dieselbe Syntax wie oben nur mit <function>=~</function> und
6131 <function>!~</function> als Vergleichsoperatoren.</para>
6133 <para>Beispiel für einen Test, ob die Variable
6134 <varname>intnotes</varname> (interne Bemerkungen) das Wort
6135 <constant>schwierig</constant> enthält:</para>
6137 <programlisting><%if intnotes =~ "schwierig"%></programlisting>
6140 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.foreach">
6141 <title>Der foreach-Block</title>
6143 <programlisting><%foreach variablenname%>
6145 <%end%></programlisting>
6147 <para>Fügt die Zeilen zwischen den beiden Anweisungen so oft ein,
6148 wie das Perl-Array der Variablen <varname>variablenname</varname>
6149 Elemente enthät. Dieses Konstrukt wird zur Ausgabe der einzelnen
6150 Posten einer Rechnung / eines Angebots sowie zur Ausgabe der Steuern
6151 benutzt. In jedem Durchlauf werden die <link
6152 linkend="dokumentenvorlagen-und-variablen.invoice-posten">zeilenbezogenen
6153 Variablen</link> jeweils auf den Wert für die aktuelle Position
6156 <para>Die Syntax sieht normalerweise wie folgt aus:</para>
6158 <programlisting><%foreach number%>
6159 Position: <%runningnumber%>
6160 Anzahl: <%qty%>
6161 Artikelnummer: <%number%>
6162 Beschreibung: <%description%>
6164 <%end%></programlisting>
6166 <para>Besonderheit in OpenDocument-Vorlagen: Tritt ein
6167 <function><%foreach%></function>-Block innerhalb einer
6168 Tabellenzelle auf, so wird die komplette Tabellenzeile so oft
6169 wiederholt wie notwendig. Tritt er außerhalb auf, so wird nur der
6170 Inhalt zwischen <function><%foreach%></function> und
6171 <function><%end%></function> wiederholt, nicht aber die
6172 komplette Zeile, in der er steht.</para>
6176 <sect2 id="dokumentenvorlagen-und-variablen.markup">
6177 <title>Markup-Code zur Textformatierung innerhalb von
6180 <para>Wenn der Benutzer innhalb von Formularen in kivitendo Text
6181 anders formatiert haben möchte, so ist dies begrenzt möglich.
6182 kivitendo unterstützt die Textformatierung mit HTML-ähnlichen Tags.
6183 Der Benutzer kann z.B. bei der Artikelbeschreibung auf einer Rechnung
6184 Teile des Texts zwischen Start- und Endtags setzen. Dieser Teil wird
6185 dann automatisch in Anweisungen für das ausgewählte Vorlagenformat
6186 (HTML oder PDF über LaTeX) umgesetzt.</para>
6188 <para>Die unterstützen Formatierungen sind:</para>
6192 <term><b>Text</b></term>
6195 <para>Text wird in Fettdruck gesetzt.</para>
6200 <term><i>Text</i></term>
6203 <para>Text wird kursiv gesetzt.</para>
6208 <term><u>Text</u></term>
6211 <para>Text wird unterstrichen.</para>
6216 <term><s>Text</s></term>
6219 <para>Text wird durchgestrichen. Diese Formatierung ist nicht
6220 bei der Ausgabe als PDF über LaTeX verfügbar.</para>
6225 <term><bullet></term>
6228 <para>Erzeugt einen ausgefüllten Kreis für Aufzählungen (siehe
6234 <para>Der Befehl <command><bullet></command> funktioniert
6235 momentan auch nur in Latex-Vorlagen.</para>
6239 <sect1 id="excel-templates">
6240 <title>Excel-Vorlagen</title>
6242 <sect2 id="excel-templates.summary">
6243 <title>Zusammenfassung</title>
6245 <para>Dieses Dokument beschreibt den Mechanismus, mit dem
6246 Exceltemplates abgearbeitet werden, und die Einschränkungen, die damit
6250 <sect2 id="excel-templates.usage">
6251 <title>Bedienung</title>
6253 <para>Der Excel Mechanismus muss in der Konfigurationsdatei aktiviert
6254 werden. Die Konfigurationsoption heißt <varname>excel_templates =
6255 1</varname> im Abschnitt <varname>[print_templates]</varname>.</para>
6257 <para>Eine Excelvorlage kann dann unter dem Namen einer beliebigen
6258 anderen Vorlage mit der Endung <filename>.xls</filename> gespeichert
6259 werden. In den normalen Verkaufsmasken taucht nun
6260 <constant>Excel</constant> als auswählbares Format auf und kann von da
6261 an wie LaTeX- oder OpenOffice-Vorlagen benutzt werden.</para>
6263 <para>Der Sonderfall der Angebote aus der Kundenmaske ist ebenfalls
6264 eine Angebotsvorlage und wird unter dem internen Namen der Angebote
6265 <filename>sales_quotation.xls</filename> gespeichert.</para>
6268 <sect2 id="excel-templates.syntax">
6269 <title>Variablensyntax</title>
6271 <para>Einfache Syntax:
6272 <command><<varname>></command></para>
6274 <para>Dabei sind <constant><<</constant> und
6275 <constant>>></constant> die Delimiter. Da Excel auf festen
6276 Breiten besteht, kann der Tag künstlich verlängert werden, indem
6277 weitere <constant><</constant> oder <constant>></constant>
6278 eingefügt werden. Der Tag muss nicht symmetrisch sein.
6281 <programlisting><<<<<varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
6283 <para>Um die Limitierung der festen Breite zu reduzieren, können
6284 weitere Variablen in einem Block interpoliert werden. Whitespace wird
6285 dazwishen dann erhalten. Beispiel:</para>
6287 <programlisting><<<<<varname1 varname2 varname3>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
6289 <para>Die Variablen werden interpoliert, und linksbündig mit
6290 Leerzeichen auf die gewünschte Länge aufgefüllt. Ist der String zu
6291 lang, werden überzählige Zeichen abgeschnitten.</para>
6293 <para>Es ist ausserdem möglich, Daten rechtsbündig darzustellen, wenn
6294 der Block mit einem Leerzeichen anfängt. Beispiel:</para>
6296 <programlisting><<<<<< varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
6298 <para>Dies würde rechtsbündig triggern. Wenn bei rechtsbündiger
6299 Ausrichtung Text abgeschnitten werden muss, wird er vom linken Ende
6303 <sect2 id="excel-templates.limitations">
6304 <title>Einschränkungen</title>
6306 <para>Das Excelformat bis 2002 ist ein binäres Format, und kann nicht
6307 mit vertretbarem Aufwand editiert werden. Der Templatemechanismus
6308 beschränkt sich daher darauf, Textstellen exakt durch einen anderen
6309 Text zu ersetzen.</para>
6311 <para>Aus dem gleichen Grund sind die Kontrolllstrukturen
6312 <command><%if%></command> und
6313 <command><%foreach%></command> nicht vorhanden. Der Delimiter
6314 <constant><% %></constant> kommt in den Headerinformationen
6315 evtl. vor. Deshalb wurde auf den sichereren Delimiter
6316 <constant><<</constant> und <constant>>></constant>
6321 <sect1 id="features.warehouse">
6322 <title>Mandantenkonfiguration Lager</title>
6324 <para>Die Lagerverwaltung in kivitendo funktioniert standardmässig wie
6325 folgt: Wird ein Lager mit einem Lagerplatz angelegt, so gibt es die
6326 Möglichkeit hier über den Menüpunkt Lager entsprechende Warenbewegungen
6327 durchzuführen. Ferner kann jede Position eines Lieferscheins ein-, bzw.
6328 ausgelagert werden (Einkauf-, bzw. Verkauf). Es können beliebig viele
6329 Lager mit beliebig vielen Lagerplätzen abgebildet werden. Die
6330 Lagerbewegungen über einen Lieferschein erfolgt durch Anklicken jeder
6331 Einzelposition und das Auswählen dieser Position zu einem Lager mit
6332 Lagerplatz. Dieses Verfahren lässt sich schrittweise vereinfachen, je
6333 nachdem wie die Einstellungen in der Mandatenkonfiguration gesetzt
6338 <para><option>Auslagern über Standardlagerplatz</option> Hier wird
6339 ein zusätzlicher Knopf (Auslagern über Standard-Lagerplatz) in dem
6340 Lieferschein-Beleg hinzugefügt, der dann alle Lagerbewegungen über
6341 den Standardlagerplatz (konfigurierbar pro Ware) durchführt.</para>
6345 <para><option>Auslagern ohne Bestandsprüfung</option> Das obige
6346 Auslagern schlägt fehl, wenn die entsprechende Menge für die
6347 Lagerbewegung nicht vorhanden ist, möchte man dies auch ignorieren
6348 und ggf. dann nachpflegen, so kann man eine Negativ-Warenmenge mit
6349 dieser Option erlauben. Hierfür muss ein entsprechender Lagerplatz
6350 (Fehlbestand, o.ä.) konfiguriert sein.</para>
6354 <para>Zusätzliche Funktionshinweise:</para>
6358 <para><option>Standard-Lagerplatz</option> Ist dieser konfiguriert,
6359 wird dies auch als Standard-Voreinstellung bei der Neuerfassung von
6360 Stammdaten → Waren / Dienstleistung / Erzeugnis verwendet.</para>
6364 <para><option>Standard-Lagerplatz verwenden, falls keiner in
6365 Stammdaten definiert</option> Wird beim 'Auslagern über
6366 Standardlagerplatz' keine Standardlagerplatz zu der Ware gefunden,
6367 so wird mit dieser Option einfach der Standardlagerplatz
6373 <sect1 id="features.swiss-charts-of-accounts">
6374 <title>Schweizer Kontenpläne</title>
6376 <para>Seit der Version 3.5 stehen in kivitendo 3 Kontenpläne für den
6377 Einsatz in der Schweiz zur Verfügung, einer für Firmen und
6378 Organisationen, die nicht mehrwertsteuerpflichtig sind, einer für
6379 Firmen, die mehrwertsteuerpflichtig sind und einer speziell für
6382 <para>Die Kontenpläne orientieren sich am in der Schweiz üblicherweise
6383 verwendeten KMU-Kontenrahmen und sind mit der Revision des
6384 Schweizerischen Obligationenrechts (OR) vom 1.1.2013 kompatibel,
6385 insbesondere <literal>Art.957a Abs.2</literal>.</para>
6387 <para>Beim Vereinskontenplan sind standardmässig nur die Konten 1100
6388 (Debitoren CHF) und 1101 (Debitoren EUR) als Buchungskonten im Verkauf
6389 sowie die Konten 2000 (Kreditoren CHF) und 2001 (Kreditoren EUR) als
6390 Buchungskonten im Einkauf vorgesehen. Weitere Konten können bei Bedarf
6391 in den Konto-Detaileinstellungen als Einkaufs- oder Verkaufskonten
6392 konfiguriert werden.</para>
6394 <para>Die Möglichkeit, Saldosteuersätze zu verwenden ist in der
6395 aktuellen Version von kivitendo noch nicht integriert.</para>
6397 <para>Trotzdem können auch Firmen, die per Saldosteuersatz mit der
6398 Eidgenössischen Steuerverwaltung abrechnen, kivitendo bereits nutzen.
6399 Dazu wird der Kontenplan mit MWST ausgewählt. Anschliessend müssen alle
6400 Aufwandskonten editiert werden und dort der Steuersatz auf 0% gesetzt
6403 <para>So werden bei Kreditorenbuchungen keine Vorsteuern
6406 <para>Bezugssteuern für aus dem Ausland bezogene Dienstleistungen müssen
6407 manuell verbucht werden.</para>
6409 <para>Wünsche für Anpassungen an den Schweizer Kontenplänen sowie
6410 Vorschläge für weitere (z.B. branchenspezifische) Kontenpläne bitte an
6411 <literal>empfang@revamp-it.ch</literal> senden.</para>
6414 <sect1 id="features.part_classification">
6415 <title>Artikelklassifizierung</title>
6418 <title>Übersicht</title>
6420 <para>Die Klassifizierung von Artikeln dient einer weiteren
6421 Gliederung, um zum Beispiel den Einkauf vom Verkauf zu trennen,
6422 gekennzeichnet durch eine Beschreibung (z.B. "Einkauf") und ein Kürzel
6423 (z.B. "E"). Für jede Klassifizierung besteht eine Beschreibung und
6424 eine Abkürzung die normalerweise aus einem Zeichen besteht, kann aber
6425 auf mehrere Zeichen erweitert werden, falls zur Unterscheidung
6426 notwendig. Sinnvoll sind jedoch nur maximal 2 Zeichen.</para>
6430 <title>Basisklassifizierung</title>
6432 <para>Als Basisklassifizierungen gibt es</para>
6436 <para>Einkauf</para>
6440 <para>Verkauf</para>
6444 <para>Handelsware</para>
6448 <para>Produktion</para>
6452 <para>- keine - (diese wird bei einer Aktualisierung für alle
6453 existierenden Artikel verwendet und ist gültig für Verkauf und
6458 <para>Es können weitere Klassifizierungen angelegt werden. So kann es
6459 z.B. für separat auszuweisende Artikel folgende Klassen geben:</para>
6463 <para>Lieferung (Logistik, Transport) mit Kürzel L</para>
6467 <para>Material (Verpackungsmaterial) mit Kürzel M</para>
6473 <title>Attribute</title>
6475 <para>Bisher haben die Klassifizierungen folgende Attribute, die auch
6476 alle gleichzeitg gültig sein können</para>
6480 <para>gültig für Verkauf - dieser Artikel kann im Verkauf genutzt
6485 <para>gültig für Einkauf - dieser Artikel kann im Einkauf genutzt
6490 <para>separat ausweisen - hierzu gibt es zur Dokumentengenerierung
6491 (LaTeX) eine zusätzliche Variable</para>
6495 <para>Für das Attribut "separat ausweisen" stehen in den
6496 LaTeX-Vorlagen die Variable <emphasis
6497 role="bold"><%non_separate_subtotal%> </emphasis>zur Verfügung,
6498 die alle nicht separat auszuweisenden Artikelkosten saldiert, sowie
6499 pro separat auszuweisenden Klassifizierungen die Variable<emphasis
6500 role="bold">< %separate_X_subtotal%></emphasis>, wobei X das
6501 Kürzel der Klassifizierung ist.</para>
6503 <para>Im obigen Beispiel wäre das für Lieferkosten <emphasis
6504 role="bold"><%separate_L_subtotal%></emphasis> und für
6505 Verpackungsmaterial <emphasis role="bold">
6506 <%separate_M_subtotal%></emphasis>.</para>
6510 <title>Zwei-Zeichen Abkürzung</title>
6512 <para>Der Typ des Artikels und die Klassifizierung werden durch zwei
6513 Buchstaben dargestellt. Der erste Buchstabe ist eine Lokalisierung des
6514 Artikel-Typs ('P','A','S'), deutsch 'W', 'E', und 'D' für Ware
6515 Erzeugnis oder Dienstleistung und ggf. weiterer Typen.</para>
6517 <para>Der zweite Buchstabe (und ggf. auch ein dritter, falls nötig)
6518 entspricht der lokalisierten Abkürzung der Klassifizierung.</para>
6520 <para>Diese Abkürzung wird überall beim Auflisten von Artikeln zur
6521 Erleichterung mit dargestellt.</para>
6525 <sect1 id="features.file_managment">
6526 <title>Dateiverwaltung (Mini-DMS)</title>
6529 <title>Übersicht</title>
6531 <para>Parallel zum alten WebDAV gibt es ein Datei-Management-System,
6532 das Dateien verschiedenen Typs verwaltet. Dies können</para>
6536 <para>aus ERP-Daten per LaTeX Template erzeugte
6537 PDF-Dokumente,</para>
6541 <para>zu bestimmten ERP-Daten gehörende Anhangdateien
6542 unterschiedlichen Formats,</para>
6546 <para>per Scanner eingelesene PDF-Dateien,</para>
6550 <para>per E-Mail empfangene Dateianhänge unterschiedlichen
6555 <para>sowie speziel für Artikel hochgeladene Bilder sein.</para>
6560 <screeninfo>Übersicht</screeninfo>
6564 <imagedata contentwidth="600" fileref="images/DMS-Overview.png"/>
6571 <title>Struktur</title>
6573 <para>Über eine vom Speichermedium unabhängige Zwischenschicht werden
6574 die Dateien und ihre Versionen in der Datenbank verwaltet. Darunter
6575 können verschiedene Implementierungen (Backends) gleichzeitig
6580 <para>Dateisystem</para>
6588 <para>Schnittstelle zu externen
6589 Dokumenten-Management-Systemen</para>
6593 <para>andere Datenbank</para>
6597 <para>etc ...</para>
6601 <para>Es gibt unterschiedliche Typen von Dateien. Jedem Typ läßt sich
6602 in der Mandantenkonfiguration ein bestimmtes Backend zuordnen.</para>
6606 <para>"document": Das sind entweder generierte, eingescannte oder
6607 hochgeladene PDF-Dateien, die zu bestimmten ERP-Daten
6608 (ERP-Objekte, wie z.B. Rechnung, Lieferschein) gehören.</para>
6612 <para>"attachment": zusätzlich hochgeladene Dokumente, die an
6613 bestimmte ERP-Objekte angehängt werden, z.B. technische
6614 Zeichnungen, Aufmaße. Diese können auch für Artikel, Lieferanten
6615 und Kunden hinterlegt sein.</para>
6619 <para>"image": Bilder für Artikel. Diese können auch verkleinert
6620 in einer Vorschau (Thumbnail) angezeigt werden.</para>
6624 <para>Zusätzlich werden in der Datenbank zu den Dateien neben der
6625 Zuordnung zu ERP-Objekten, Dateityp Dateinamen und Backend, in dem die
6626 Datei gespeichert ist, auch die Quelle der Datei notiert:</para>
6630 <para>"created": vom System erzeugte Dokumente"</para>
6634 <para>"uploaded": hochgeladene Dokumente</para>
6638 <para>"email": vom Mail-System empfangene Dateien</para>
6642 <para>"scanner[1]": von einem oder mehreren Scannern erzeugte
6643 Dateien. Existieren mehrere Scanner, so sind diese durch
6644 unterschiedliche Quellennamen zu definieren.</para>
6648 <para>Je nach Dateityp sind nur bestimmte Quellen zulässig. So gibt es
6649 für "attachment" und "image" nur die Quelle "uploaded". Für "document"
6650 gibt es auf jeden Fall die Quelle "created". Die Quellen "scanner" und
6651 "email" müssen derzeit in der Datenbank konfiguriert werden (siehe
6652 <xref linkend="file_management.dbconfig"/>).</para>
6656 <title>Anwendung</title>
6658 <para>Die Daten werden bei den ERP-Objekten als extra Reiter
6659 dargestellt. Eine Verkaufsrechnung z.B. hat die Reiter "Dokumente" und
6660 "Dateianhänge".</para>
6663 <screeninfo>Reiter "Dateianhänge"</screeninfo>
6667 <imagedata fileref="images/DMS-Anhaenge.png" scale="50"/>
6672 <para>Bei den Dateianhängen wird immer nur die aktuelle Version einer
6673 Datei angezeigt. Wird eine Datei mit gleichem Namen hochgeladen, so
6674 wird eine neue Version der Datei erstellt. Vorher wird der Anwender
6675 durch einen Dialog gefragt, ob er eine neue Version anlegen will oder
6676 ob er die Datei umbenennen will, falls es eine neue Datei sein
6680 <screeninfo>Reiter "Dateianhänge"</screeninfo>
6684 <imagedata contentwidth="40"
6685 fileref="images/DMS-Anhaenge-hochladen.png"
6691 <para>Es können mehrere Dateien gleichzeitig hochgeladen werden,
6692 solange in Summe die maximale Größe nicht überschritten wird (siehe
6693 <xref linkend="file_management.clientconfig"/>).</para>
6696 <screeninfo>Reiter "Dokumente"</screeninfo>
6700 <imagedata fileref="images/DMS-Dokumente.png" width="500"/>
6705 <para>Sind keine weiteren Quellen für Dokumente konfiguriert, so gibt
6706 es nur "erzeugte Dokumente". Es werden alle Versionen der generierten
6707 Datei angezeigt. Für Verkaufsrechnungen kommen keine anderen Quellen
6708 zur Geltung. Werden entsprechend der <xref
6709 linkend="file_management.dbconfig"/> zusätzliche Quellen konfiguriert,
6710 so sind diese z.B. bei Einkaufsrechnungen sichtbar:</para>
6713 <screeninfo>Reiter "Dokumente"</screeninfo>
6717 <imagedata contentwidth="600"
6718 fileref="images/DMS-Dokumente-Scanner.png"/>
6723 <para>Statt des Löschens wird hier die Datei zurück zur Quelle
6724 verschoben. Somit kann die Datei anschließend an ein anderes
6725 ERP-Objekt angehängt werden.</para>
6727 <para>Derzeit sind "Titel" und "Beschreibung" noch nicht genutzt. Sie
6728 sind bisher nur bei Bildern relevant.</para>
6732 <title>Konfigurierung</title>
6734 <sect3 id="file_management.clientconfig"
6735 xreflabel="Mandantenkonfigurierung">
6736 <title>Mandantenkonfiguration</title>
6739 <title>Reiter "Features"</title>
6741 <para>Unter dem Reiter <emphasis role="bold">Features</emphasis>
6742 im Abschnitt Dateimanagement ist neben dem "alten" WebDAV das
6743 Dateimangement generell zu- und abschaltbar, sowie die Zuordnung
6744 der Dateitypen zu Backends. Die Löschbarkeit von Dateien, sowie
6745 die maximale Uploadgröße sind Backend-unabhängig</para>
6748 <screeninfo>Mandantenkonfig Reiter "Features"</screeninfo>
6752 <imagedata fileref="images/DMS-ClientConfig.png" width="500"/>
6757 <para>Die einzelnen Backends sind einzeln einschaltbar.
6758 Spezifische Backend-Konfigurierungen sind hier noch
6763 <title>Reiter "Allgemeine Dokumentenanhänge"</title>
6765 <para>Unter dem Reiter <emphasis role="bold">Allgemeine
6766 Dokumentenanhänge</emphasis> kann für alle ERP-Dokumente (
6767 Angebote, Aufträge, Lieferscheine, Rechnungen im Verkauf und
6768 Einkauf ) allgemeingültige Anhänge hochgeladen werden.</para>
6771 <screeninfo>Mandantenkonfig Reiter "Allgemeine
6772 Dokumentenanhänge"</screeninfo>
6776 <imagedata fileref="images/DMS-Allgemeine-Dokumentenanhaenge.png"
6782 <para>Diese Anhänge werden beim Generieren von PDF-Dateien an die
6783 ERP-Dokumente angehängt, z.B. AGBs oder aktuelle Angebote. Es
6784 werden in dem Fall die Daten kopiert, sodass an den ERP-Dokumenten
6785 immer die Anhänge zum Generierungszeitpunkt eingebettet
6790 <sect3 id="file_management.dbconfig"
6791 xreflabel="Datenbank-Konfigurierung">
6792 <title>Datenbank-Konfigurierung</title>
6794 <para>Die zusätzlichen Quellen für "email" oder ein oder mehrere
6795 Scanner sind derzeit vom Administrator direkt in der
6796 Datenbanktabelle "user_preferences" einzurichten. Die "value" ist im
6797 JSON-Format mit den jeweiligen Werten des Verzeichnisses und der
6798 Beschreibung der Quelle.</para>
6801 id | login | namespace | version | key | value
6802 ----+-----------+--------------+---------+----------+---------------------------
6803 1 | #default# | file_sources | 0.00000 | scanner1 |
6804 {"dir":"/var/tmp/scanner1","desc":"Scanner Einkauf"}
6805 2 | #default# | file_sources | 0.00000 | scanner2 |
6806 {"dir":"/var/tmp/scanner2","desc":"Scanner Verkauf"}
6807 3 | #default# | file_sources | 0.00000 | emails |
6808 {"dir":"/var/tmp/emails","desc":"Empfangene Mails" }
6811 <para>Es ist daran gedacht, statt dem Default-Eintrag später für
6812 bestimmte Benutzer ('login') bestimmte Quellen zuzulassen. Dies wird
6813 nach Bedarf implementiert.</para>
6816 <sect3 id="file_management.kiviconfig"
6817 xreflabel="kivitendo-Konfigurationsdatei">
6818 <title>kivitendo-Konfigurationsdatei</title>
6820 <para>Dort ist im Abschnitt [paths] der relative oder absolute Pfad
6821 zum Dokumentenwurzelverzeichnis einzutragen. Dieser muss für den
6822 Webserver schreib- und lesbar sein, jedoch nicht ausführbar.</para>
6826 document_path = /var/local/kivi_documents
6829 <para>Unter diesem Wurzelverzeichnis wird pro Mandant automatisch
6830 ein Unterverzeichnis mit der ID des Mandanten angelegt.</para>
6836 <title>Webshop-Api</title>
6838 <para>Das Shopmodul bietet die Möglichkeit Onlineshopartikel und
6839 Onlineshopbestellungen zu verwalten und zu bearbeiten.</para>
6841 <para>Es ist Multishopfähig, d.h. Artikel können mehreren oder
6842 unterschiedlichen Shops zugeordnet werden. Bestellungen können aus
6843 mehreren Shops geholt werden.</para>
6845 <para>Zur Zeit bietet das Modul nur einen Connector zur REST-Api von
6846 Shopware. Weitere Connectoren können dazu programmiert und eingerichtet
6850 <title>Installationvorraussetzungen</title>
6852 <para>In der Datenbank <literal>template1</literal> muss die
6853 Unterstützung für die trigram-Extension eingerichet werden. Melden Sie
6854 sich dafür als Benutzer “postgres” an der Datenbank an:
6855 <programlisting>su - postgres
6856 psql template1</programlisting></para>
6858 <para>führen Sie die folgenden Kommandos aus:</para>
6860 <programlisting>CREATE EXTENSION IF NOT EXISTS pg_trgm;
6865 <title>Rechte für die Webshopapi</title>
6867 <para>In der Administration können folgende Rechte vergeben
6872 <para>Webshopartikel anlegen und bearbeiten</para>
6876 <para>Shopbestellungen holen und bearbeiten</para>
6880 <para>Shopbestellungen holen und bearbeiten</para>
6886 <title>Konfiguration</title>
6888 <para>Unter System->Webshops können Shops angelegt und konfiguriert
6893 <imagedata contentdepth="500" contentwidth="700"
6894 fileref="images/Shop_Listing.png"/>
6900 <title>Webshopartikel</title>
6903 <title>Shopvariablenreiter in Artikelstammdaten</title>
6905 <para>Mit dem Recht "Shopartikel anlegen und bearbeiten" öffnet sich
6906 der Reiter "Shopvariablen" in den Artikelstammdaten. Hier können
6907 jetzt die Artikel mit unterschiedlichen Beschreibung und/oder
6908 Preisen für die konfigutierten Shops angelegt und bearbeitet werden.
6909 An dieser Stelle können auch beliebig viele Bilder dem Shopartikel
6910 zugeordnet werden. Artikelbilder gelten für alle Shops.</para>
6914 <imagedata contentdepth="500" contentwidth="600"
6915 fileref="images/Shop_Artikel.png"/>
6919 <para>Die Artikelgruppen werden direkt vom Shopsystem geholt somit
6920 ist es möglich einen Artikel auch mehreren Gruppen
6925 <title>Shopartikelliste</title>
6927 <para>Unter dem Menu Webshop->Webshop Artikel hat man nochmal
6928 eine Gesamtübersicht. Von hier aus ist es möglich Artikel im Stapel
6929 unter verschiedenen Kriterien <alles><nur Preis><nur
6930 Bestand><Preis und Bestand> an die jeweiligen Shops
6935 <imagedata fileref="images/Shop_Artikel_Listing.png"/>
6942 <title>Bestellimport</title>
6944 <para>Unter dem Menupunkt Webshop->Webshop Import öffnet sich die
6945 Bestellimportsliste. Hier ist sind Möglichkeiten gegeben Neue
6946 Bestellungen vom Shop abzuholen, geholte Bestellungen im Stapel oder
6947 einzeln als Auftrag zu transferieren. Die Liste kann nach
6948 verschiedenen Kriterien gefiltert werden.</para>
6952 <imagedata fileref="images/Shop_Bestell.png"/>
6956 <para>Bei Einträgen in der Liste.</para>
6960 <para>keine Kundennummer: Es gibt ähnliche Kundendatensätze und
6961 der Datensatz konnte nicht eindeutig zugewiesen werden.</para>
6965 <para>Kundennummer und Rechnungen rot hinterlegt: Der Kunde hat
6966 offene Posten und kann deswegen nicht im Stapel übernommen
6971 <para>Rechnungsadresse grün hinterlegt: Der Kunde konnte eindeutig
6972 einem Datensatz zugeordnet werden. Die Shopbestellung kann im
6973 Stapel mit dem Button "Anwenden" und wenn markiert als Auftrag
6974 übernommen werden.</para>
6978 <para>Kundennummer vorhanden, aber die Checkbox "Auftrag
6979 erstellen" fehlt. Der Kunde hat vermutlich eine
6980 Shopauftragssperre.</para>
6984 <para>Lieferadresse grau hinterlegt: Optische Anzeige, dass es
6985 sich um eine unterschiedliche Lieferadresse handelt.
6986 Lieferadressen werden aber grundsätzlich beim Transferieren zu
6987 Aufträgen mit übernommen.</para>
6991 <para>In der Spalte Positionen/Betrag/Versandkosten zeigt sich ein
6992 tooltip zu den Positionen.</para>
6996 <para>Maske Auftrag erstellen</para>
6998 <para>Viele Shopsysteme haben drei verschieden Adresstypen Kunden-,
6999 Rechnungs-, und Lieferadresse, die sich auch alle unterscheiden
7000 können. Diese werden im oberen Bereich angezeigt. Es ist möglich jede
7001 dieser Adresse einzeln in kivitendo als Kunde zu übernehmen. Es werden
7002 die Werte Formulareingabe übernommen. Es wird bei einer Änderung
7003 allerdings nur diese in die kivitendo Kundenstammdaten übernommen, die
7004 Shopbestellung bleibt bestehen.</para>
7006 <para>Mit der mittleren Adresse(Rechnungsadresse) im oberen Bereich,
7007 kann ich den ausgewählten kivitendodatensatz des mittleren Bereich
7008 überschreiben. Das ist sinnvoll, wenn ich erkenne, das der Kunde z.B.
7009 umgezogen ist.</para>
7011 <para>Im mittleren Bereich das Adresslisting zeigt:</para>
7015 <para>Rot hinterlegt: Kunde hat eine Shopauftragssperre, diese
7016 muss zuerst deaktiviert werden bevor ich diesem Kunden eine
7017 Shopbestellung zuordnen kann.</para>
7021 <para>Kundenname fett und rot: Hier hat der Kunde eine Bemerkung
7022 in den Stammdaten. Ein Tooltip zeigt diese Bemerkung. Das kann dan
7023 auch der Grund für die Auftragssperre sein.</para>
7027 <para>Die Buttons "Auftrag erstellen" und "Kunde mit
7028 Rechnungsadresse überschreiben" zeigen sich erst, wenn ein Kunde
7029 aus dem Listing ausgewählt ist.</para>
7033 <para>Es ist aber möglich die Shopbestellung zu löschen.</para>
7037 <para>Ist eine Bestellung schon übernommen, zeigen sich an dieser
7038 Stelle, die dazugehörigen Belegverknüpfungen.</para>
7044 <title>Mapping der Daten</title>
7046 <para>Das Mapping der kivitendo Daten mit den Shopdaten geschieht in
7047 der Datei SL/ShopConnector/<SHOPCONNECTORNAME>.pm
7048 z.B.:SL/ShopConnector/Shopware.pm</para>
7050 <para>In dieser Datei gibt es einen Bereich wo die Bestellpostionen,
7051 die Bestellkopfdaten und die Artikeldaten gemapt werden. In dieser
7052 Datei kann ein individelles Mapping dann gemacht werden. Zu Shopware
7053 gibt es hier eine sehr gute Dokumentation: <ulink
7054 url="https://developers.shopware.com/developers-guide/rest-api/">https://developers.shopware.com/developers-guide/rest-api/</ulink></para>
7060 <title>Entwicklerdokumentation</title>
7062 <sect1 id="devel.globals" xreflabel="Globale Variablen">
7063 <title>Globale Variablen</title>
7066 <title>Wie sehen globale Variablen in Perl aus?</title>
7068 <para>Globale Variablen liegen in einem speziellen namespace namens
7069 "main", der von überall erreichbar ist. Darüber hinaus sind bareword
7070 globs global und die meisten speziellen Variablen sind...
7073 <para>Daraus ergeben sich folgende Formen:</para>
7077 <term><literal>$main::form</literal></term>
7080 <para>expliziter Namespace "main"</para>
7085 <term><literal>$::form</literal></term>
7088 <para>impliziter Namespace "main"</para>
7093 <term><literal>open FILE, "file.txt"</literal></term>
7096 <para><varname>FILE</varname> ist global</para>
7101 <term><literal>$_</literal></term>
7104 <para>speziell</para>
7109 <para>Im Gegensatz zu <productname>PHP</productname> gibt es kein
7110 Schlüsselwort wie "<function>global</function>", mit dem man
7111 importieren kann. <function>my</function>, <function>our</function>
7112 und <function>local</function> machen was anderes.</para>
7116 <term><literal>my $form</literal></term>
7119 <para>lexikalische Variable, gültig bis zum Ende des
7125 <term><literal>our $form</literal></term>
7128 <para><varname>$form</varname> referenziert ab hier
7129 <varname>$PACKAGE::form</varname>.</para>
7134 <term><literal>local $form</literal></term>
7137 <para>Alle Änderungen an <varname>$form</varname> werden am Ende
7138 des scopes zurückgesetzt</para>
7145 <title>Warum sind globale Variablen ein Problem?</title>
7147 <para>Das erste Problem ist <productname>FCGI</productname>.</para>
7149 <para><productname>SQL-Ledger</productname> hat fast alles im globalen
7150 namespace abgelegt, und erwartet, dass es da auch wiederzufinden ist.
7151 Unter <productname>FCGI</productname> müssen diese Sachen aber wieder
7152 aufgeräumt werden, damit sie nicht in den nächsten Request kommen.
7153 Einige Sachen wiederum sollen nicht gelöscht werden, wie zum Beispiel
7154 Datenbankverbindungen, weil die sehr lange zum Initialisieren
7157 <para>Das zweite Problem ist <function>strict</function>. Unter
7158 <function>strict</function> werden alle Variablen die nicht explizit
7159 mit <function>Package</function>, <function>my</function> oder
7160 <function>our</function> angegeben werden als Tippfehler angemarkert,
7161 dies hat, seit der Einführung, u.a. schon so manche langwierige
7162 Bug-Suche verkürzt. Da globale Variablen aber implizit mit Package
7163 angegeben werden, werden die nicht geprüft, und somit kann sich
7164 schnell ein Tippfehler einschleichen.</para>
7168 <title>Kanonische globale Variablen</title>
7170 <para>Um dieses Problem im Griff zu halten gibt es einige wenige
7171 globale Variablen, die kanonisch sind, d.h. sie haben bestimmte
7172 vorgegebenen Eigenschaften, und alles andere sollte anderweitig
7173 umhergereicht werden.</para>
7175 <para>Diese Variablen sind im Moment die folgenden neun:</para>
7179 <para><varname>$::form</varname></para>
7183 <para><varname>%::myconfig</varname></para>
7187 <para><varname>$::locale</varname></para>
7191 <para><varname>$::lxdebug</varname></para>
7195 <para><varname>$::auth</varname></para>
7199 <para><varname>$::lx_office_conf</varname></para>
7203 <para><varname>$::instance_conf</varname></para>
7207 <para><varname>$::dispatcher</varname></para>
7211 <para><varname>$::request</varname></para>
7215 <para>Damit diese nicht erneut als Müllhalde missbraucht werden, im
7216 Folgenden eine kurze Erläuterung der bestimmten vorgegebenen
7217 Eigenschaften (Konventionen):</para>
7220 <title>$::form</title>
7224 <para>Ist ein Objekt der Klasse
7225 "<classname>Form</classname>"</para>
7229 <para>Wird nach jedem Request gelöscht</para>
7233 <para>Muss auch in Tests und Konsolenscripts vorhanden
7238 <para>Enthält am Anfang eines Requests die Requestparameter vom
7243 <para>Kann zwar intern über Requestgrenzen ein Datenbankhandle
7244 cachen, das wird aber momentan absichtlich zerstört</para>
7248 <para><varname>$::form</varname> wurde unter <productname>SQL
7249 Ledger</productname> als Gottobjekt für alles missbraucht. Sämtliche
7250 alten Funktionen unter SL/ mutieren <varname>$::form</varname>, das
7251 heißt, alles was einem lieb ist (alle Variablen die einem ans Herz
7252 gewachsen sind), sollte man vor einem Aufruf (!) von zum Beispiel
7253 <function>IS->retrieve_customer()</function> in Sicherheit
7256 <para>Z.B. das vom Benutzer eingestellte Zahlenformat, bevor man
7257 Berechnung in einem bestimmten Format durchführt (SL/Form.pm Zeile
7258 3552, Stand version 2.7beta), um dies hinterher wieder auf den
7259 richtigen Wert zu setzen:</para>
7261 <programlisting> my $saved_numberformat = $::myconfig{numberformat};
7262 $::myconfig{numberformat} = $numberformat;
7263 # (...) div Berechnungen
7264 $::myconfig{numberformat} = $saved_numberformat;</programlisting>
7266 <para>Das Objekt der Klasse Form hat leider im Moment noch viele
7267 zentrale Funktionen die vom internen Zustand abhängen, deshalb bitte
7268 nie einfach zerstören oder überschreiben (zumindestens nicht kurz
7269 vor einem Release oder in Absprache über bspw. die devel-Liste ;-).
7270 Es geht ziemlich sicher etwas kaputt.</para>
7272 <para><varname>$::form</varname> ist gleichzeitig der Standard Scope
7273 in den <productname>Template::Toolkit</productname> Templates
7274 außerhalb der Controller: der Ausdruck <function>[% var
7275 %]</function> greift auf <varname>$::form->{var}</varname> zu.
7276 Unter Controllern ist der Standard Scope anders, da lautet der
7277 Zugriff <function>[% FORM.var %]</function>. In Druckvorlagen sind
7278 normale Variablen ebenfall im <varname>$::form</varname> Scope, d.h.
7279 <function><%var%></function> zeigt auf
7280 <varname>$::form->{var}</varname>. Nochmal von der anderen Seite
7281 erläutert, innerhalb von (Web-)Templates sieht man häufiger solche
7284 <programlisting>[%- IF business %]
7285 # (... Zeig die Auswahlliste Kunden-/Lieferantentyp an)
7286 [%- END %]</programlisting>
7288 <para>Entweder wird hier dann $::form->{business} ausgewertet
7289 oder aber der Funktion
7290 <function>$form->parse_html_template</function> wird explizit
7291 noch ein zusätzlicher Hash übergeben, der dann auch in den
7292 (Web-)Templates zu Verfügung steht, bspw. so:</para>
7294 <programlisting>$form->parse_html_template("is/form_header", \%TMPL_VAR);</programlisting>
7296 <para>Innerhalb von Schleifen wird
7297 <varname>$::form->{TEMPLATE_ARRAYS}{var}[$index]</varname>
7298 bevorzugt, wenn vorhanden. Ein Beispiel findet sich in SL/DO.pm,
7299 welches über alle Positionen eines Lieferscheins in Schleife
7302 <programlisting>for $i (1 .. $form->{rowcount}) {
7304 push @{ $form->{TEMPLATE_ARRAYS}{runningnumber} }, $position;
7305 push @{ $form->{TEMPLATE_ARRAYS}{number} }, $form->{"partnumber_$i"};
7306 push @{ $form->{TEMPLATE_ARRAYS}{description} }, $form->{"description_$i"};
7312 <title>%::myconfig</title>
7316 <para>Das einzige Hash unter den globalen Variablen</para>
7320 <para>Wird spätestens benötigt wenn auf die Datenbank
7321 zugegriffen wird</para>
7325 <para>Wird bei jedem Request neu erstellt.</para>
7329 <para>Enthält die Userdaten des aktuellen Logins</para>
7333 <para>Sollte nicht ohne Filterung irgendwo gedumpt werden oder
7334 extern serialisiert werden, weil da auch der Datenbankzugriff
7335 für diesen user drinsteht.</para>
7339 <para>Enthält unter anderem Datumsformat dateformat und
7340 Nummernformat numberformat</para>
7344 <para>Enthält Datenbankzugriffinformationen</para>
7348 <para><varname>%::myconfig</varname> ist im Moment der Ersatz für
7349 ein Userobjekt. Die meisten Funktionen, die etwas anhand des
7350 aktuellen Users entscheiden müssen, befragen
7351 <varname>%::myconfig</varname>. Innerhalb der Anwendungen sind dies
7352 überwiegend die Daten, die sich unter <guimenu>Programm</guimenu>
7353 -> <guimenuitem>Einstellungen</guimenuitem> befinden, bzw. die
7354 Informationen über den Benutzer die über die
7355 Administrator-Schnittstelle eingegeben wurden.</para>
7359 <title>$::locale</title>
7363 <para>Objekt der Klasse "Locale"</para>
7367 <para>Wird pro Request erstellt</para>
7371 <para>Muss auch für Tests und Scripte immer verfügbar
7376 <para>Cached intern über Requestgrenzen hinweg benutzte
7381 <para>Lokalisierung für den aktuellen User. Alle Übersetzungen,
7382 Zahlen- und Datumsformatierungen laufen über dieses Objekt.</para>
7386 <title>$::lxdebug</title>
7390 <para>Objekt der Klasse "LXDebug"</para>
7394 <para>Wird global gecached</para>
7398 <para>Muss immer verfügbar sein, in nahezu allen
7403 <para><varname>$::lxdebug</varname> stellt Debuggingfunktionen
7404 bereit, wie "<function>enter_sub</function>" und
7405 "<function>leave_sub</function>", mit denen in den alten Modulen ein
7406 brauchbares Tracing gebaut ist, "<function>log_time</function>", mit
7407 der man die Wallclockzeit seit Requeststart loggen kann, sowie
7408 "<function>message</function>" und "<function>dump</function>" mit
7409 denen man flott Informationen ins Log (tmp/kivitendo-debug.log)
7412 <para>Beispielsweise so:</para>
7414 <programlisting>$main::lxdebug->message(0, 'Meine Konfig:' . Dumper (%::myconfig));
7415 $main::lxdebug->message(0, 'Wer bin ich? Kunde oder Lieferant:' . $form->{vc});</programlisting>
7419 <title>$::auth</title>
7423 <para>Objekt der Klasse "SL::Auth"</para>
7427 <para>Wird global gecached</para>
7431 <para>Hat eine permanente DB Verbindung zur Authdatenbank</para>
7435 <para>Wird nach jedem Request resettet.</para>
7439 <para><varname>$::auth</varname> stellt Funktionen bereit um die
7440 Rechte des aktuellen Users abzufragen. Obwohl diese Informationen
7441 vom aktuellen User abhängen wird das Objekt aus
7442 Geschwindigkeitsgründen nur einmal angelegt und dann nach jedem
7443 Request kurz resettet.</para>
7445 <para>Dieses Objekt kapselt auch den gerade aktiven Mandanten.
7446 Dessen Einstellungen können über
7447 <literal>$::auth->client</literal> abgefragt werden; Rückgabewert
7448 ist ein Hash mit den Werten aus der Tabelle
7449 <literal>auth.clients</literal>.</para>
7453 <title>$::lx_office_conf</title>
7457 <para>Objekt der Klasse
7458 "<classname>SL::LxOfficeConf</classname>"</para>
7462 <para>Global gecached</para>
7466 <para>Repräsentation der
7467 <filename>config/kivitendo.conf[.default]</filename>-Dateien</para>
7471 <para>Globale Konfiguration. Configdateien werden zum Start gelesen
7472 und danach nicht mehr angefasst. Es ist derzeit nicht geplant, dass
7473 das Programm die Konfiguration ändern kann oder sollte.</para>
7475 <para>Beispielsweise ist über den Konfigurationseintrag [debug] die
7476 Debug- und Trace-Log-Datei wie folgt konfiguriert und
7479 <programlisting>[debug]
7480 file_name = /tmp/kivitendo-debug.log</programlisting>
7482 <para>ist der Key <varname>file</varname> im Programm als
7483 <varname>$::lx_office_conf->{debug}{file}</varname>
7487 <para>Zugriff auf die Konfiguration erfolgt im Moment über
7488 Hashkeys, sind also nicht gegen Tippfehler abgesichert.</para>
7493 <title>$::instance_conf</title>
7497 <para>Objekt der Klasse
7498 "<classname>SL::InstanceConfiguration</classname>"</para>
7502 <para>wird pro Request neu erstellt</para>
7506 <para>Funktioniert wie <varname>$::lx_office_conf</varname>,
7507 speichert aber Daten die von der Instanz abhängig sind. Eine Instanz
7508 ist hier eine Mandantendatenbank. Beispielsweise überprüft
7509 <programlisting>$::instance_conf->get_inventory_system eq 'perpetual'</programlisting>
7510 ob die berüchtigte Bestandsmethode zur Anwendung kommt.</para>
7514 <title>$::dispatcher</title>
7518 <para>Objekt der Klasse
7519 "<varname>SL::Dispatcher</varname>"</para>
7523 <para>wird pro Serverprozess erstellt.</para>
7527 <para>enthält Informationen über die technische Verbindung zum
7532 <para>Der dritte Punkt ist auch der einzige Grund warum das Objekt
7533 global gespeichert wird. Wird vermutlich irgendwann in einem anderen
7534 Objekt untergebracht.</para>
7538 <title>$::request</title>
7542 <para>Hashref (evtl später Objekt)</para>
7546 <para>Wird pro Request neu initialisiert.</para>
7550 <para>Keine Unterstruktur garantiert.</para>
7554 <para><varname>$::request</varname> ist ein generischer Platz um
7555 Daten "für den aktuellen Request" abzulegen. Sollte nicht für action
7556 at a distance benutzt werden, sondern um lokales memoizing zu
7557 ermöglichen, das garantiert am Ende des Requests zerstört
7560 <para>Vieles von dem, was im moment in <varname>$::form</varname>
7561 liegt, sollte eigentlich hier liegen. Die groben
7562 Differentialkriterien sind:</para>
7566 <para>Kommt es vom User, und soll unverändert wieder an den
7567 User? Dann <varname>$::form</varname>, steht da eh schon</para>
7571 <para>Sind es Daten aus der Datenbank, die nur bis zum Ende des
7572 Requests gebraucht werden? Dann
7573 <varname>$::request</varname></para>
7577 <para>Muss ich von anderen Teilen des Programms lesend drauf
7578 zugreifen? Dann <varname>$::request</varname>, aber Zugriff über
7579 Wrappermethode</para>
7586 <title>Ehemalige globale Variablen</title>
7588 <para>Die folgenden Variablen waren einmal im Programm, und wurden
7592 <title>$::cgi</title>
7596 <para>war nötig, weil cookie Methoden nicht als
7597 Klassenfunktionen funktionieren</para>
7601 <para>Aufruf als Klasse erzeugt Dummyobjekt was im
7602 Klassennamespace gehalten wird und über Requestgrenzen
7607 <para>liegt jetzt unter
7608 <varname>$::request->{cgi}</varname></para>
7614 <title>$::all_units</title>
7618 <para>war nötig, weil einige Funktionen in Schleifen zum Teil
7619 ein paar hundert mal pro Request eine Liste der Einheiten
7620 brauchen, und de als Parameter durch einen Riesenstack von
7621 Funktionen geschleift werden müssten.</para>
7625 <para>Liegt jetzt unter
7626 <varname>$::request->{cache}{all_units}</varname></para>
7631 <function>AM->retrieve_all_units()</function> gesetzt oder
7638 <title>%::called_subs</title>
7642 <para>wurde benutzt um callsub deep recursions
7647 <para>Wurde entfernt, weil callsub nur einen Bruchteil der
7648 möglichen Rekursioenen darstellt, und da nie welche
7653 <para>komplette recursion protection wurde entfernt.</para>
7660 <sect1 id="devel.fcgi">
7661 <title>Entwicklung unter FastCGI</title>
7663 <sect2 id="devel.fcgi.general">
7664 <title>Allgemeines</title>
7666 <para>Wenn Änderungen in der Konfiguration von kivitendo gemacht
7667 werden, muss der Webserver neu gestartet werden.</para>
7669 <para>Bei der Entwicklung für FastCGI ist auf ein paar Fallstricke zu
7670 achten. Dadurch, dass das Programm in einer Endlosschleife läuft,
7671 müssen folgende Aspekte beachtet werden.</para>
7674 <sect2 id="devel.fcgi.exiting">
7675 <title>Programmende und Ausnahmen</title>
7677 <para>Betrifft die Funktionen <function>warn</function>,
7678 <function>die</function>, <function>exit</function>,
7679 <function>carp</function> und <function>confess</function>.</para>
7681 <para>Fehler, die dass Programm normalerweise sofort beenden (fatale
7682 Fehler), werden mit dem FastCGI Dispatcher abgefangen, um das Programm
7683 am Laufen zu halten. Man kann mit <function>die</function>,
7684 <function>confess</function> oder <function>carp</function> Fehler
7685 ausgeben, die dann vom Dispatcher angezeigt werden. Die kivitendo
7686 eigene <function>$::form-</function>error()> tut im Prinzip das
7687 Gleiche, mit ein paar Extraoptionen. <function>warn</function> und
7688 <function>exit</function> hingegen werden nicht abgefangen.
7689 <function>warn</function> wird direkt nach STDERR, also in Server Log
7690 eine Nachricht schreiben (sofern in der Konfiguration nicht die
7691 Warnungen in das kivitendo Log umgeleitet wurden), und
7692 <function>exit</function> wird die Ausführung beenden.</para>
7694 <para>Prinzipiell ist es kein Beinbruch, wenn sich der Prozess
7695 beendet, fcgi wird ihn sofort neu starten. Allerdings sollte das die
7696 Ausnahme sein. Quintessenz: Bitte kein <function>exit</function>
7697 benutzen, alle anderen Exceptionmechanismen sind ok.</para>
7700 <sect2 id="devel.fcgi.globals">
7701 <title>Globale Variablen</title>
7703 <para>Um zu vermeiden, dass Informationen von einem Request in einen
7704 anderen gelangen, müssen alle globalen Variablen vor einem Request
7705 sauber initialisiert werden. Das ist besonders wichtig im
7706 <varname>$::cgi</varname> und <varname>$::auth</varname> Objekt, weil
7707 diese nicht gelöscht werden pro Instanz, sondern persistent gehalten
7710 <para>In <classname>SL::Dispatcher</classname> gibt es einen sauber
7711 abgetrennten Block, der alle kanonischen globalen Variablen listet und
7712 erklärt. Bitte keine anderen einführen ohne das sauber zu
7713 dokumentieren.</para>
7715 <para>Datenbankverbindungen wird noch ein Guide verfasst werden, wie
7716 man sicher geht, dass man die richtige erwischt.</para>
7719 <sect2 id="devel.fcgi.performance">
7720 <title>Performance und Statistiken</title>
7722 <para>Die kritischen Pfade des Programms sind die Belegmasken, und
7723 unter diesen ganz besonders die Verkaufsrechnungsmaske. Ein Aufruf der
7724 Rechnungsmaske in kivitendo 2.4.3 stable dauert auf einem Core2duo mit
7725 4GB Arbeitsspeicher und Ubuntu 9.10 eine halbe Sekunde. In der 2.6.0
7726 sind es je nach Menge der definierten Variablen 1-2s. Ab der
7727 Moose/Rose::DB Version sind es 5-6s.</para>
7729 <para>Mit FastCGI ist die neuste Version auf 0,26 Sekunden selbst in
7730 den kritischen Pfaden, unter 0,15 sonst.</para>
7734 <sect1 id="db-upgrade-files" xreflabel="Datenbank-Upgradedateien">
7735 <title>SQL-Upgradedateien</title>
7737 <sect2 id="db-upgrade-files.introduction"
7738 xreflabel="Einführung in die Datenbank-Upgradedateien">
7739 <title>Einführung</title>
7741 <para>Datenbankupgrades werden über einzelne Upgrade-Scripte
7742 gesteuert, die sich im Verzeichnis
7743 <filename>sql/Pg-upgrade2</filename> befinden. In diesem Verzeichnis
7744 muss pro Datenbankupgrade eine Datei existieren, die neben den
7745 eigentlich auszuführenden SQL- oder Perl-Befehlen einige
7746 Kontrollinformationen enthält.</para>
7748 <para>Kontrollinformationen definieren Abhängigkeiten und Prioritäten,
7749 sodass Datenbankscripte zwar in einer sicheren Reihenfolge ausgeführt
7750 werden (z.B. darf ein <literal>ALTER TABLE</literal> erst ausgeführt
7751 werden, wenn die Tabelle mit <literal>CREATE TABLE</literal> angelegt
7752 wurde), diese Reihenfolge aber so flexibel ist, dass man keine
7753 Versionsnummern braucht.</para>
7755 <para>kivitendo merkt sich dabei, welches der Upgradescripte in
7756 <filename>sql/Pg-upgrade2</filename> bereits durchgeführt wurde und
7757 führt diese nicht erneut aus. Dazu dient die Tabelle
7758 "<literal>schema_info</literal>", die bei der Anmeldung automatisch
7759 angelegt wird.</para>
7762 <sect2 id="db-upgrade-files.format"
7763 xreflabel="Format der Upgradedateien">
7764 <title>Format der Kontrollinformationen</title>
7766 <para>Die Kontrollinformationen sollten sich am Anfang der jeweiligen
7767 Upgradedatei befinden. Jede Zeile, die Kontrollinformationen enthält,
7768 hat dabei das folgende Format:</para>
7770 <para>Für SQL-Upgradedateien:</para>
7772 <programlisting>-- @key: value</programlisting>
7774 <para>Für Perl-Upgradedateien:</para>
7776 <programlisting># @key: value</programlisting>
7778 <para>Leerzeichen vor "<varname>value</varname>" werden
7781 <para>Die folgenden Schlüsselworte werden verarbeitet:</para>
7785 <term><varname>tag</varname></term>
7788 <para>Wird zwingend benötigt. Dies ist der "Name" des Upgrades.
7789 Dieser "tag" kann von anderen Kontrolldateien in ihren
7790 Abhängigkeiten verwendet werden (Schlüsselwort
7791 "<varname>depends</varname>"). Der "tag" ist auch der Name, der
7792 in der Datenbank eingetragen wird.</para>
7794 <para>Normalerweise sollte die Kontrolldatei genau so heißen wie
7795 der "tag", nur mit der Endung ".sql" bzw. "pl".</para>
7797 <para>Ein Tag darf nur aus alphanumerischen Zeichen sowie den
7798 Zeichen _ - ( ) bestehen. Insbesondere sind Leerzeichen nicht
7799 erlaubt und sollten stattdessen mit Unterstrichen ersetzt
7805 <term><varname>charset</varname></term>
7808 <para>Empfohlen. Gibt den Zeichensatz an, in dem das Script
7809 geschrieben wurde, z.B. "<literal>UTF-8</literal>". Aus
7810 Kompatibilitätsgründen mit alten Upgrade-Scripten wird bei
7811 Abwesenheit des Tags für SQL-Upgradedateien der Zeichensatz
7812 "<literal>ISO-8859-15</literal>" angenommen. Perl-Upgradescripte
7813 hingegen müssen immer in UTF-8 encodiert sein und sollten
7814 demnach auch ein "<literal>use utf8;</literal>"
7820 <term><varname>description</varname></term>
7823 <para>Benötigt. Eine Beschreibung, was in diesem Update
7824 passiert. Diese wird dem Benutzer beim eigentlichen
7825 Datenbankupdate angezeigt. Während der Tag in Englisch gehalten
7826 sein sollte, sollte die Beschreibung auf Deutsch
7832 <term><varname>depends</varname></term>
7835 <para>Optional. Eine mit Leerzeichen getrennte Liste von "tags",
7836 von denen dieses Upgradescript abhängt. kivitendo stellt sicher,
7837 dass die in dieser Liste aufgeführten Scripte bereits
7838 durchgeführt wurden, bevor dieses Script ausgeführt wird.</para>
7840 <para>Abhängigkeiten werden rekursiv betrachtet. Wenn also ein
7841 Script "b" existiert, das von Änderungen in "a" abhängt, und
7842 eine neue Kontrolldatei für "c" erstellt wird, die von
7843 Änderungen in "a" und "b" abhängt, so genügt es, in "c" nur den
7844 Tag "b" als Abhängigkeit zu definieren.</para>
7846 <para>Es ist nicht erlaubt, sich selbst referenzierende
7847 Abhängigkeiten zu definieren (z.B. "a" -> "b", "b" -> "c"
7848 und "c" -> "a").</para>
7853 <term><varname>priority</varname></term>
7856 <para>Optional. Ein Zahlenwert, der die Reihenfolge bestimmt, in
7857 der Scripte ausgeführt werden, die die gleichen
7858 Abhängigkeitstiefen besitzen. Fehlt dieser Parameter, so wird
7859 der Wert 1000 benutzt.</para>
7861 <para>Dies ist reine Kosmetik. Für echte Reihenfolgen muss
7862 "depends" benutzt werden. kivitendo sortiert die auszuführenden
7863 Scripte zuerst nach der Abhängigkeitstiefe (wenn "z" von "y"
7864 abhängt und "y" von "x", so hat "z" eine Abhängigkeitstiefe von
7865 2, "y" von 1 und "x" von 0. "x" würde hier zuerst ausgeführt,
7866 dann "y", dann "z"), dann nach der Priorität und bei gleicher
7867 Priorität alphabetisch nach dem "tag".</para>
7872 <term><varname>ignore</varname></term>
7875 <para>Optional. Falls der Wert auf 1 (true) steht, wird das
7876 Skript bei der Anmeldung ignoriert und entsprechend nicht
7883 <sect2 id="db-upgrade-files.format-perl-files"
7884 xreflabel="Format von Perl-Upgradedateien">
7885 <title>Format von in Perl geschriebenen
7886 Datenbankupgradescripten</title>
7888 <para>In Perl geschriebene Datenbankscripte werden nicht einfach so
7889 ausgeführt sondern müssen sich an gewisse Konventionen halten. Dafür
7890 bekommen sie aber auch einige Komfortfunktionen bereitgestellt.</para>
7892 <para>Ein Upgradescript stellt dabei eine vollständige Objektklasse
7893 dar, die vom Elternobjekt "<literal>SL::DBUpgrade2::Base</literal>"
7894 erben und eine Funktion namens "<literal>run</literal>" zur Verfügung
7895 stellen muss. Das Script wird ausgeführt, indem eine Instanz dieser
7896 Klasse erzeugt und darauf die erwähnte "<literal>run</literal>"
7897 aufgerufen wird.</para>
7899 <para>Zu beachten ist, dass sich der Paketname der Datei aus dem Wert
7900 für "<literal>@tag</literal>" ableitet. Dabei werden alle Zeichen, die
7901 in Paketnamen ungültig wären (gerade Bindestriche), durch Unterstriche
7902 ersetzt. Insgesamt sieht der Paketname wie folgt aus:
7903 "<literal>SL::DBUpgrade2::tag</literal>".</para>
7905 <para>Welche Komfortfunktionen zur Verfügung stehen, erfahren Sie in
7906 der Perl-Dokumentation zum oben genannten Modul; aufzurufen mit
7907 "<command>perldoc SL/DBUpgrade2/Base.pm</command>".</para>
7909 <para>Ein Mindestgerüst eines gültigen Perl-Upgradescriptes sieht wie
7912 <programlisting># @tag: beispiel-upgrade-file42
7913 # @description: Ein schönes Beispielscript
7914 # @depends: release_3_1_0
7915 package SL::DBUpgrade2::beispiel_upgrade_file42;
7920 use parent qw(SL::DBUpgrade2::Base);
7925 # hier Aktionen ausführen
7934 <sect2 id="db-upgrade-files.dbupgrade-tool"
7935 xreflabel="Hilfsscript dbupgrade2_tool.pl">
7936 <title>Hilfsscript dbupgrade2_tool.pl</title>
7938 <para>Um die Arbeit mit den Abhängigkeiten etwas zu erleichtern,
7939 existiert ein Hilfsscript namens
7940 "<filename>scripts/dbupgrade2_tool.pl</filename>". Es muss aus dem
7941 kivitendo-ERP-Basisverzeichnis heraus aufgerufen werden. Dieses Tool
7942 liest alle Datenbankupgradescripte aus dem Verzeichnis
7943 <filename>sql/Pg-upgrade2</filename> aus. Es benutzt dafür die
7944 gleichen Methoden wie kivitendo selber, sodass alle Fehlersituationen
7945 von der Kommandozeile überprüft werden können.</para>
7947 <para>Wird dem Script kein weiterer Parameter übergeben, so wird nur
7948 eine Überprüfung der Felder und Abhängigkeiten vorgenommen. Man kann
7949 sich aber auch Informationen auf verschiedene Art ausgeben
7954 <para>Listenform: "<command>./scripts/dbupgrade2_tool.pl
7955 --list</command>"</para>
7957 <para>Gibt eine Liste aller Scripte aus. Die Liste ist in der
7958 Reihenfolge sortiert, in der kivitendo die Scripte ausführen
7959 würde. Es werden neben der Listenposition der Tag, die
7960 Abhängigkeitstiefe und die Priorität ausgegeben.</para>
7964 <para>Baumform: "<command>./scripts/dbupgrade2_tool.pl
7965 --tree</command>"</para>
7967 <para>Listet alle Tags in Baumform basierend auf den
7968 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte, von
7969 denen keine anderen abhängen. Die Unterknoten sind Scripte, die
7970 beim übergeordneten Script als Abhängigkeit eingetragen
7974 <listitem id="db-upgrade-files.dbupgrade-tool.reverse-tree">
7975 <para>Umgekehrte Baumform: "<command>./scripts/dbupgrade2_tool.pl
7976 --rtree</command>"</para>
7978 <para>Listet alle Tags in Baumform basierend auf den
7979 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte mit
7980 der geringsten Abhängigkeitstiefe. Die Unterknoten sind Scripte,
7981 die das übergeordnete Script als Abhängigkeit eingetragen
7986 <para>Baumform mit Postscriptausgabe:
7987 "<command>./scripts/dbupgrade2_tool.pl
7988 --graphviz</command>"</para>
7990 <para>Benötigt das Tool "<command>graphviz</command>", um mit
7991 seiner Hilfe die <link
7992 linkend="db-upgrade-files.dbupgrade-tool.reverse-tree">umgekehrte
7993 Baumform</link> in eine Postscriptdatei namens
7994 "<filename>db_dependencies.ps</filename>" auszugeben. Dies ist
7995 vermutlich die übersichtlichste Form, weil hierbei jeder Knoten
7996 nur einmal ausgegeben wird. Bei den Textmodusbaumformen hingegen
7997 können Knoten und all ihre Abhängigkeiten mehrfach ausgegeben
8002 <para>Scripte, von denen kein anderes Script abhängt:
8003 "<command>./scripts/dbupgrade2_tool.pl --nodeps</command>"</para>
8005 <para>Listet die Tags aller Scripte auf, von denen keine anderen
8006 Scripte abhängen.</para>
8012 <sect1 id="translations-languages" xreflabel="Translations and languages">
8013 <title>Translations and languages</title>
8015 <sect2 id="translations-languages.introduction"
8016 xreflabel="Introduction to translations and languages">
8017 <title>Introduction</title>
8020 <para>Dieser Abschnitt ist in Englisch geschrieben, um
8021 internationalen Übersetzern die Arbeit zu erleichtern.</para>
8024 <para>This section describes how localization packages in kivitendo
8025 are built. Currently the only language fully supported is German, and
8026 since most of the internal messages are held in English the English
8027 version is usable too.</para>
8030 <sect2 id="translations-languages.character-set"
8031 xreflabel="Character set">
8032 <title>Character set</title>
8034 <para>All files included in a language pack must use UTF-8 as their
8038 <sect2 id="translations-languages.file-structure"
8039 xreflabel="File structure">
8040 <title>File structure</title>
8042 <para>The structure of locales in kivitendo is:</para>
8044 <programlisting>kivitendo/locale/<langcode>/</programlisting>
8046 <para>where <langcode> stands for an abbreviation of the
8047 language package. The builtin packages use two letter <ulink
8048 url="http://en.wikipedia.org/wiki/ISO_639-1">ISO 639-1</ulink> codes,
8049 but the actual name is not relevant for the program and can easily be
8051 url="http://en.wikipedia.org/wiki/IETF_language_tag">IETF language
8052 tags</ulink> (i.e. "en_GB"). In fact the original language packages
8053 from SQL Ledger are named in this way.</para>
8055 <para>In such a language directory the following files are
8060 <term>LANGUAGE</term>
8063 <para>This file is mandatory.</para>
8065 <para>The <filename>LANGUAGE</filename> file contains the self
8066 descripted name of the language. It should contain a native
8067 representation first, and in parenthesis an english translation
8068 after that. Example:</para>
8070 <programlisting>Deutsch (German)</programlisting>
8078 <para>This file is mandatory.</para>
8080 <para>The central translation file. It is essentially an inline
8081 Perl script autogenerated by <command>locales.pl</command>. To
8082 generate it, generate the directory and the two files mentioned
8083 above, and execute the following command:</para>
8085 <programlisting>scripts/locales.pl <langcode></programlisting>
8087 <para>Otherwise you can simply copy one of the other languages.
8088 You will be told how many are missing like this:</para>
8090 <programlisting>$ scripts/locales.pl en
8091 English - 0.6% - 2015/2028 missing</programlisting>
8093 <para>A file named "<filename>missing</filename>" will be
8094 generated and can be edited. You can also edit the
8095 "<filename>all</filename>" file directly. Edit everything you
8096 like to fit the target language and execute
8097 <command>locales.pl</command> again. See how the missing words
8103 <term>Num2text</term>
8106 <para>Legacy code from SQL Ledger. It provides a means for
8107 numbers to be converted into natural language, like
8108 <literal>1523 => one thousand five hundred twenty
8109 three</literal>. If you want to provide it, it must be inlinable
8110 Perl code which provides a <function>num2text</function> sub. If
8111 an <function>init</function> sub exists it will be executed
8114 <para>Only used in the check and receipt printing module.</para>
8119 <term>special_chars</term>
8122 <para>kivitendo comes with a lot of interfaces to different
8123 formats, some of which are rather picky with their accepted
8124 charset. The <filename>special_chars</filename> file contains a
8125 listing of chars not suited for different file format and
8126 provides substitutions. It is written in "Simple Ini" style,
8127 containing a block for every file format.</para>
8129 <para>First entry should be the order of substitution for
8130 entries as a whitespace separated list. All entries are
8131 interpolated, so <literal>\n</literal>, <literal>\x20</literal>
8132 and <literal>\\</literal> all work.</para>
8134 <para>After that every entry is a special char that should be
8135 translated when writing text into such a file.</para>
8137 <para>Example:</para>
8139 <programlisting>[Template/XML]
8140 order=& < > \n
8144 \n=<br></programlisting>
8146 <para>Note the importance of the order in this example.
8147 Substituting < and > befor & would lead to $gt; become
8150 <para>For a list of valid formats, see the German
8151 <filename>special_chars</filename> entry. As of this writing the
8152 following are recognized:</para>
8154 <programlisting>HTML
8159 Template/OpenDocument
8160 filenames</programlisting>
8162 <para>The last of which is very machine dependant. Remember that
8163 a lot of characters are forbidden by some filesystems, for
8164 example MS Windows doesn't like ':' in its files where Linux
8165 doesn't mind that. If you want the files created with your
8166 language pack to be portable, find all chars that could cause
8172 <term>missing</term>
8175 <para>This file is not a part of the language package
8178 <para>This is a file generated by
8179 <command>scripts/locales.pl</command> while processing your
8180 locales. It's only to have the missing entries singled out and
8181 does not belong to a language package.</para>
8189 <para>This file is not a part of the language package
8192 <para>Another file generated by
8193 <command>scripts/locales.pl</command>. If for any reason a
8194 translation does not appear anymore and can be deleted, it gets
8195 moved here. The last 50 or so entries deleted are saved here in
8196 case you made a typo, so that you don't have to translate
8197 everything again. If a tranlsation is missing, the lost file is
8198 checked first. If you maintain a language package, you might
8199 want to keep this safe somewhere.</para>
8204 <term>more/all</term>
8207 <para>This subdir and file is not a part of the language package
8210 <para>If the directory more exists and contains a file called
8211 all it will be parsed in addition to the mandatory all (see
8212 above). The file is useful if you want to change some
8213 translations for the current installation without conflicting
8214 further upgrades. The file is not autogenerated and has the same
8215 format as the all, but needs another key (more_texts). See the
8216 german translation for an example or copy the following code:
8219 # -*- coding: utf-8; -*-
8224 # These are additional texts for custom translations.
8225 # The format is the same as for the normal file all, only
8226 # with another key (more_texts instead of texts).
8227 # The file has the form of 'english text' => 'foreign text',
8229 $self->{more_texts} = {
8231 'Ship via' => 'Terms of delivery',
8232 'Shipping Point' => 'Delivery time',
8234 </programlisting></para>
8241 <sect1 id="devel.testsuite">
8242 <title>Die kivitendo-Test-Suite</title>
8244 <sect2 id="devel.testsuite.intro">
8245 <title>Einführung</title>
8247 <para>kivitendo enthält eine Suite für automatisierte Tests. Sie
8248 basiert auf dem Standard-Perl-Modul
8249 <literal>Test::More</literal>.</para>
8251 <para>Die grundlegenden Fakten sind:</para>
8255 <para>Alle Tests liegen im Unterverzeichnis
8256 <filename>t/</filename>.</para>
8260 <para>Ein Script (bzw. ein Test) in <filename>t/</filename>
8261 enthält einen oder mehrere Testfälle.</para>
8265 <para>Alle Dateinamen von Tests enden auf <literal>.t</literal>.
8266 Es sind selbstständig ausführbare Perl-Scripte.</para>
8270 <para>Die Test-Suite besteht aus der Gesamtheit aller Tests,
8271 sprich aller Scripte in <filename>t/</filename>, deren Dateiname
8272 auf <literal>.t</literal> endet.</para>
8277 <sect2 id="devel.testsuite.prerequisites">
8278 <title>Voraussetzungen</title>
8280 <para>Für die Ausführung werden neben den für kivitendo eh schon
8281 benötigten Module noch weitere Perl-Module benötigt. Diese
8286 <para><literal>Test::Deep</literal> (Debian-Paketname:
8287 <literal>libtest-deep-perl</literal>; Fedora:
8288 <literal>perl-Test-Deep</literal>; openSUSE:
8289 <literal>perl-Test-Deep</literal>)</para>
8293 <para><literal>Test::Exception</literal> (Debian-Paketname:
8294 <literal>libtest-exception-perl</literal>; Fedora:
8295 <literal>perl-Test-Exception</literal>; openSUSE:
8296 <literal>perl-Test-Exception</literal>)</para>
8300 <para><literal>Test::Output</literal> (Debian-Paketname:
8301 <literal>libtest-output-perl</literal>; Fedora:
8302 <literal>perl-Test-Output</literal>; openSUSE:
8303 <literal>perl-Test-Output</literal>)</para>
8307 <para><literal>Test::Harness</literal> 3.0.0 oder höher. Dieses
8308 Modul ist ab Perl 5.10.1 Bestandteil der Perl-Distribution und
8309 kann für frühere Versionen aus dem <ulink
8310 url="http://www.cpan.org">CPAN</ulink> bezogen werden.</para>
8314 <para><literal>LWP::Simple</literal> aus dem Paket
8315 <literal>libwww-perl</literal> (Debian-Panetname:
8316 <literal>libwww-perl</literal>; Fedora:
8317 <literal>perl-libwww-perl</literal>; openSUSE:
8318 <literal>perl-libwww-perl</literal>)</para>
8322 <para><literal>URI::Find</literal> (Debian-Panetname:
8323 <literal>liburi-find-perl</literal>; Fedora:
8324 <literal>perl-URI-Find</literal>; openSUSE:
8325 <literal>perl-URI-Find</literal>)</para>
8329 <para><literal>Sys::CPU</literal> (Debian-Panetname:
8330 <literal>libsys-cpu-perl</literal>; Fedora und openSUSE: nicht
8335 <para><literal>Thread::Pool::Simple</literal> (Debian-Panetname:
8336 <literal>libthread-pool-simple-perl</literal>; Fedora und
8337 openSUSE: nicht vorhanden)</para>
8341 <para>Weitere Voraussetzung ist, dass die Testsuite ihre eigene
8342 Datenbank anlegen kann, um Produktivdaten nicht zu gefährden. Dazu
8343 müssen in der Konfigurationsdatei im Abschnit
8344 <literal>testing/database</literal> Datenbankverbindungsparameter
8345 angegeben werden. Der hier angegebene Benutzer muss weiterhin das
8346 Recht haben, Datenbanken anzulegen und zu löschen.</para>
8349 <sect2 id="devel.testsuite.execution">
8350 <title>Existierende Tests ausführen</title>
8352 <para>Es gibt mehrere Möglichkeiten zum Ausführen der Tests: entweder,
8353 man lässt alle Tests auf einmal ausführen, oder man führt gezielt
8354 einzelne Scripte aus. Für beide Fälle gibt es das Helferscript
8355 <filename>t/test.pl</filename>.</para>
8357 <para>Will man die komplette Test-Suite ausführen, so muss man einfach
8358 nur <filename>t/test.pl</filename> ohne weitere Parameter aus dem
8359 kivitendo-Basisverzeichnis heraus ausführen.</para>
8361 <para>Um einzelne Test-Scripte auszuführen, übergibt man deren Namen
8362 an <filename>t/test.pl</filename>. Beispielsweise:</para>
8364 <programlisting>t/test.pl t/form/format_amount.t t/background_job/known_jobs.t</programlisting>
8367 <sect2 id="devel.testsuite.meaning_of_scripts">
8368 <title>Bedeutung der verschiedenen Test-Scripte</title>
8370 <para>Die Test-Suite umfasst Tests sowohl für Funktionen als auch für
8371 Programmierstil. Einige besonders zu erwähnende, weil auch während der
8372 Entwicklung nützliche Tests sind:</para>
8376 <para><filename>t/001compile.t</filename> -- compiliert alle
8377 Quelldateien und bricht bei Fehlern sofort ab</para>
8381 <para><filename>t/002goodperl.t</filename> -- überprüft alle
8382 Perl-Dateien auf Anwesenheit von '<literal>use
8383 strict</literal>'-Anweisungen</para>
8387 <para><filename>t/003safesys.t</filename> -- überprüft Aufrufe von
8388 <function>system()</function> und <function>exec()</function> auf
8393 <para><filename>t/005no_tabs.t</filename> -- überprüft, ob Dateien
8394 Tab-Zeichen enthalten</para>
8398 <para><filename>t/006spelling.t</filename> -- sucht nach häufigen
8399 Rechtschreibfehlern</para>
8403 <para><filename>t/011pod.t</filename> -- überprüft die Syntax von
8404 Dokumentation im POD-Format auf Gültigkeit</para>
8408 <para>Weitere Test-Scripte überprüfen primär die Funktionsweise
8409 einzelner Funktionen und Module.</para>
8412 <sect2 id="devel.testsuite.create_new">
8413 <title>Neue Test-Scripte erstellen</title>
8415 <para>Es wird sehr gern gesehen, wenn neue Funktionalität auch gleich
8416 mit einem Test-Script abgesichert wird. Auch bestehende Funktion darf
8417 und soll ausdrücklich nachträglich mit Test-Scripten abgesichert
8420 <sect3 id="devel.testsuite.ideas_for_non_function_tests">
8421 <title>Ideen für neue Test-Scripte, die keine konkreten Funktionen
8424 <para>Ideen, die abgesehen von Funktionen noch nicht umgesetzt
8429 <para>Überprüfung auf fehlende symbolische Links</para>
8433 <para>Suche nach Nicht-ASCII-Zeichen in Perl-Code-Dateien (mit
8434 gewissen Einschränkungen wie das Erlauben von deutschen
8439 <para>Test auf DOS-Zeilenenden (\r\n anstelle von nur \n)</para>
8443 <para>Überprüfung auf Leerzeichen am Ende von Zeilen</para>
8447 <para>Test, ob alle zu übersetzenden Strings in
8448 <filename>locale/de/all</filename> vorhanden sind</para>
8452 <para>Test, ob alle Webseiten-Templates in
8453 <filename>templates/webpages</filename> mit vom Perl-Modul
8454 <literal>Template</literal> compiliert werden können</para>
8459 <sect3 id="devel.testsuite.directory_and_test_names">
8460 <title>Konvention für Verzeichnis- und Dateinamen</title>
8462 <para>Es gibt momentan eine wenige Richtlinien, wie Test-Scripte zu
8463 benennen sind. Bitte die folgenden Punkte als Richtlinie betrachten
8464 und ihnen soweit es geht folgen:</para>
8468 <para>Die Dateiendung muss <filename>.t</filename>
8473 <para>Namen sind englisch, komplett klein geschrieben und
8474 einzelne Wörter mit Unterstrichten getrennt (beispielsweise
8475 <filename>bad_function_params.t</filename>).</para>
8479 <para>Unterverzeichnisse sollten grob nach dem Themenbereich
8480 benannt sein, mit dem sich die Scripte darin befassen
8481 (beispielsweise <filename>background_jobs</filename> für Tests
8482 rund um Hintergrund-Jobs).</para>
8486 <para>Test-Scripte sollten einen überschaubaren Bereich von
8487 Funktionalität testen, der logisch zusammenhängend ist (z.B. nur
8488 Tests für eine einzelne Funktion in einem Modul). Lieber mehrere
8489 Test-Scripte schreiben.</para>
8494 <sect3 id="devel.testsuite.minimal_example">
8495 <title>Minimales Skelett für eigene Scripte</title>
8497 <para>Der folgenden Programmcode enthält das kleinstmögliche
8498 Testscript und kann als Ausgangspunkt für eigene Tests verwendet
8501 <programlisting>use Test::More tests => 0;
8505 use Support::TestSetup;
8507 Support::TestSetup::login();</programlisting>
8509 <para>Wird eine vollständig initialisierte kivitendo-Umgebung
8510 benötigt (Stichwort: alle globalen Variablen wie
8511 <varname>$::auth</varname>, <varname>$::form</varname> oder
8512 <varname>$::lxdebug</varname>), so muss in der Konfigurationsdatei
8513 <filename>config/kivitendo.conf</filename> im Abschnitt
8514 <literal>testing.login</literal> ein gültiger Login-Name eingetragen
8515 sein. Dieser wird für die Datenbankverbindung benötigt.</para>
8517 <para>Wir keine vollständig initialisierte Umgebung benötigt, so
8518 kann die letzte Zeile <programlisting>Support::TestSetup::login();</programlisting>
8519 weggelassen werden, was die Ausführungszeit des Scripts leicht
8525 <sect1 id="devel.style-guide">
8526 <title>Stil-Richtlinien</title>
8528 <para>Die folgenden Regeln haben das Ziel, den Code möglichst gut les-
8529 und wartbar zu machen. Dazu gehört zum Einen, dass der Code einheitlich
8530 eingerückt ist, aber auch, dass Mehrdeutigkeit so weit es geht vermieden
8531 wird (Stichworte "Klammern" oder "Hash-Keys").</para>
8533 <para>Diese Regeln sind keine Schikane sondern erleichtern allen das
8536 <para>Jeder, der einen Patch schickt, sollte seinen Code vorher
8537 überprüfen. Einige der Regeln lassen sich automatisch überprüfen, andere
8542 <para>Es werden keine echten Tabs sondern Leerzeichen
8547 <para>Die Einrückung beträgt zwei Leerzeichen. Beispiel:</para>
8549 <programlisting>foreach my $row (@data) {
8551 # do something with $row
8555 $row->{modules} = MODULE->retrieve(
8556 id => $row->{id},
8557 date => $use_now ? localtime() : $row->{time},
8561 $report->add($row);
8566 <para>Öffnende geschweifte Klammern befinden sich auf der gleichen
8567 Zeile wie der letzte Befehl. Beispiele:</para>
8569 <programlisting>sub debug {
8575 <programlisting>if ($form->{item_rows} > 0) {
8581 <para>Schließende geschweifte Klammern sind so weit eingerückt wie
8582 der Befehl / die öffnende schließende Klammer, die den Block
8583 gestartet hat, und nicht auf der Ebene des Inhalts. Die gleichen
8584 Beispiele wie bei 3. gelten.</para>
8588 <para>Die Wörter "<function>else</function>",
8589 "<function>elsif</function>", "<function>while</function>" befinden
8590 sich auf der gleichen Zeile wie schließende geschweifte Klammern.
8593 <programlisting>if ($form->{sum} > 1000) {
8595 } elsif ($form->{sum} > 0) {
8603 } until ($a > 0);</programlisting>
8607 <para>Parameter von Funktionsaufrufen müssen mit runden Klammern
8608 versehen werden. Davon nicht betroffen sind interne Perl-Funktionen,
8609 und grep-ähnliche Operatoren. Beispiel:</para>
8611 <programlisting>$main::lxdebug->message("Could not find file.");
8612 %options = map { $_ => 1 } grep { !/^#/ } @config_file;</programlisting>
8616 <para>Verschiedene Klammern, Ihre Ausdrücke und Leerzeichen:</para>
8618 <para>Generell gilt: Hashkeys und Arrayindices sollten nicht durch
8619 Leerzeichen abgesetzt werden. Logische Klammerungen ebensowenig,
8620 Blöcke schon. Beispiel:</para>
8622 <programlisting>if (($form->{debug} == 1) && ($form->{sum} - 100 < 0)) {
8627 $form->{sum} += $form->{"row_$i"};
8628 $form->{ $form->{index} } += 1;
8630 map { $form->{sum} += $form->{"row_$_"} } 1..$rowcount;</programlisting>
8634 <para>Mehrzeilige Befehle</para>
8638 <para>Werden die Parameter eines Funktionsaufrufes auf mehrere
8639 Zeilen aufgeteilt, so sollten diese bis zu der Spalte eingerückt
8640 werden, in der die ersten Funktionsparameter in der ersten Zeile
8641 stehen. Beispiel:</para>
8643 <programlisting>$sth = $dbh->prepare("SELECT * FROM some_table WHERE col = ?",
8644 $form->{some_col_value});</programlisting>
8648 <para>Ein Spezialfall ist der ternäre Operator "?:", der am
8649 besten in einer übersichtlichen Tabellenstruktur organisiert
8650 wird. Beispiel:</para>
8652 <programlisting>my $rowcount = $form->{"row_$i"} ? $i
8653 : $form->{oldcount} ? $form->{oldcount} + 1
8654 : $form->{rowcount} - $form->{rowbase};</programlisting>
8660 <para>Kommentare</para>
8664 <para>Kommentare, die alleine in einer Zeile stehen, sollten
8665 soweit wie der Code eingerückt sein.</para>
8669 <para>Seitliche hängende Kommentare sollten einheitlich
8670 formatiert werden.</para>
8674 <para>Sämtliche Kommentare und Sonstiges im Quellcode ist bitte
8675 auf Englisch zu verfassen. So wie ich keine Lust habe,
8676 französischen Quelltext zu lesen, sollte auch der kivitendo
8677 Quelltext für nicht-Deutschsprachige lesbar sein.
8680 <programlisting>my $found = 0;
8688 $i = 0 # initialize $i
8690 $i *= $const; # do something crazy
8691 $i = $n; # recover $i</programlisting>
8697 <para>Hashkeys sollten nur in Anführungszeichen stehen, wenn die
8698 Interpolation gewünscht ist. Beispiel:</para>
8700 <programlisting>$form->{sum} = 0;
8701 $form->{"row_$i"} = $form->{"row_$i"} - 5;
8702 $some_hash{42} = 54;</programlisting>
8706 <para>Die maximale Zeilenlänge ist nicht beschränkt. Zeilenlängen
8707 unterhalb von 79 Zeichen helfen unter bestimmten Bedingungen, aber
8708 wenn die Lesbarkeit unter kurzen Zeilen leidet (wie zum Biespiel in
8709 grossen Tabellen), dann ist Lesbarkeit vorzuziehen.</para>
8711 <para>Als Beispiel sei die Funktion
8712 <function>print_options</function> aus
8713 <filename>bin/mozilla/io.pl</filename> angeführt.</para>
8717 <para>Trailing Whitespace, d.h. Leerzeichen am Ende von Zeilen sind
8718 unerwünscht. Sie führen zu unnötigen Whitespaceänderungen, die diffs
8721 <para>Emacs und vim haben beide recht einfache Methoden zur
8722 Entfernung von trailing whitespace. Emacs kennt das Kommande
8723 <command>nuke-trailing-whitespace</command>, vim macht das gleiche
8724 manuell über <literal>:%s/\s\+$//e</literal> Mit <literal>:au
8725 BufWritePre * :%s/\s\+$//e</literal> wird das an Speichern
8730 <para>Es wird kein <command>perltidy</command> verwendet.</para>
8732 <para>In der Vergangenheit wurde versucht,
8733 <command>perltidy</command> zu verwenden, um einen einheitlichen
8734 Stil zu erlangen. Es hat sich aber gezeigt, dass
8735 <command>perltidy</command>s sehr eigenwilliges Verhalten, was
8736 Zeilenumbrüche angeht, oftmals gut formatierten Code zerstört. Für
8737 den Interessierten sind hier die
8738 <command>perltidy</command>-Optionen, die grob den beschriebenen
8739 Richtlinien entsprechen:</para>
8741 <programlisting>-syn -i=2 -nt -pt=2 -sbt=2 -ci=2 -ibc -hsc -noll -nsts -nsfs -asc -dsm
8742 -aws -bbc -bbs -bbb -mbl=1 -nsob -ce -nbl -nsbl -cti=0 -bbt=0 -bar -l=79
8743 -lp -vt=1 -vtc=1</programlisting>
8747 <para><varname>STDERR</varname> ist tabu. Unkonditionale
8748 Debugmeldungen auch.</para>
8750 <para>kivitendo bietet mit dem Modul <classname>LXDebug</classname>
8751 einen brauchbaren Trace-/Debug-Mechanismus. Es gibt also keinen
8752 Grund, nach <varname>STDERR</varname> zu schreiben.</para>
8754 <para>Die <classname>LXDebug</classname>-Methode
8755 "<function>message</function>" nimmt als ersten Paramter außerdem
8756 eine Flagmaske, für die die Meldung angezeigt wird, wobei "0" immer
8757 angezeigt wird. Solche Meldungen sollten nicht eingecheckt werden
8758 und werden in den meisten Fällen auch vom Repository
8759 zurückgewiesen.</para>
8763 <para>Alle neuen Module müssen use strict verwenden.</para>
8765 <para><varname>$form</varname>, <varname>$auth</varname>,
8766 <varname>$locale</varname>, <varname>$lxdebug</varname> und
8767 <varname>%myconfig</varname> werden derzeit aus dem main package
8768 importiert (siehe <xref linkend="devel.globals"/>. Alle anderen
8769 Konstrukte sollten lexikalisch lokal gehalten werden.</para>
8774 <sect1 id="devel.build-doc" xreflabel="Dokumentation erstellen">
8775 <title>Dokumentation erstellen</title>
8777 <sect2 id="devel.build-doc.introduction">
8778 <title>Einführung</title>
8780 <para>Diese Dokumentation ist in <productname>DocBook</productname>
8781 XML geschrieben. Zum Bearbeiten reicht grundsätzlich ein Text-Editor.
8782 Mehr Komfort bekommt man, wenn man einen dedizierten XML-fähigen
8783 Editor nutzt, der spezielle Unterstützung für
8784 <productname>DocBook</productname> mitbringt. Wir empfehlen dafür den
8785 <ulink url="http://www.xmlmind.com/xmleditor/">XMLmind XML
8786 Editor</ulink>, der bei nicht kommerzieller Nutzung kostenlos
8790 <sect2 id="devel.build-doc.required-software">
8791 <title>Benötigte Software</title>
8793 <para>Bei <productname>DocBook</productname> ist Prinzip, dass
8794 ausschließlich die XML-Quelldatei bearbeitet wird. Aus dieser werden
8795 dann mit entsprechenden Stylesheets andere Formate wie PDF oder HTML
8796 erzeugt. Bei kivitendo übernimmt diese Aufgabe das Shell-Script
8797 <command>scripts/build_doc.sh</command>.</para>
8799 <para>Das Script benötigt zur Konvertierung verschiedene
8800 Softwarekomponenten, die im normalen kivitendo-Betrieb nicht benötigt
8806 url="http://www.oracle.com/technetwork/java/index.html">Java</ulink>
8807 in einer halbwegs aktuellen Version</para>
8811 <para>Das Java-Build-System <ulink
8812 url="http://ant.apache.org/">Apache Ant</ulink></para>
8816 <para>Das Dokumentations-System Dobudish für
8817 <productname>DocBook</productname> 4.5, eine Zusammenstellung
8818 diverser Stylesheets und Grafiken zur Konvertierung von
8819 <productname>DocBook</productname> XML in andere Formate. Das
8820 Paket, das benötigt wird, ist zum Zeitpunkt der
8821 Dokumentationserstellung
8822 <filename>dobudish-nojre-1.1.4.zip</filename>, aus auf <ulink
8823 url="http://code.google.com/p/dobudish/downloads/list">code.google.com</ulink>
8828 <para>Apache Ant sowie ein dazu passendes Java Runtime Environment
8829 sind auf allen gängigen Plattformen verfügbar. Beispiel für
8830 Debian/Ubuntu:</para>
8832 <programlisting>apt-get install ant openjdk-7-jre</programlisting>
8834 <para>Nach dem Download von Dobudish muss Dobudish im Unterverzeichnis
8835 <filename>doc/build</filename> entpackt werden. Beispiel unter der
8836 Annahme, das <productname>Dobudish</productname> in
8837 <filename>$HOME/Downloads</filename> heruntergeladen wurde:</para>
8839 <programlisting>cd doc/build
8840 unzip $HOME/Downloads/dobudish-nojre-1.1.4.zip</programlisting>
8843 <sect2 id="devel.build-doc.build">
8844 <title>PDFs und HTML-Seiten erstellen</title>
8846 <para>Die eigentliche Konvertierung erfolgt nach Installation der
8847 benötigten Software mit einem einfachen Aufruf direkt aus dem
8848 kivitendo-Installationsverzeichnis heraus:</para>
8850 <programlisting>./scripts/build_doc.sh</programlisting>
8853 <sect2 id="devel.build-doc.repository">
8854 <title>Einchecken in das Git-Repository</title>
8856 <para>Sowohl die XML-Datei als auch die erzeugten PDF- und
8857 HTML-Dateien sind Bestandteil des Git-Repositories. Daraus folgt, dass
8858 nach Änderungen am XML die PDF- und HTML-Dokumente ebenfalls gebaut
8859 und alles zusammen in einem Commit eingecheckt werden sollten.</para>
8861 <para>Die "<filename>dobudish</filename>"-Verzeichnisse bzw.
8862 symbolischen Links gehören hingegen nicht in das Repository.</para>